tests/common.TestCase

   1 #!/usr/bin/env python3
   2
   3 # http://www.drdobbs.com/testing/unit-testing-with-python/240165163
   4
   5 import inspect
   6 import optparse
   7 import os
   8 import re
   9 import shutil
  10 import sys
  11 import tempfile
  12 import unittest
  13 import textwrap
  14 from zipfile import ZipFile
  15
  16
  17 localmodule = os.path.realpath(
  18     os.path.join(os.path.dirname(inspect.getfile(inspect.currentframe())), '..'))
  19 print('localmodule: ' + localmodule)
  20 if localmodule not in sys.path:
  21     sys.path.insert(0, localmodule)
  22
  23 import fdroidserver.signindex
  24 import fdroidserver.common
  25 import fdroidserver.metadata
  26
  27
  28 class CommonTest(unittest.TestCase):
  29     '''fdroidserver/common.py'''
  30
  31     def _set_build_tools(self):
  32         build_tools = os.path.join(fdroidserver.common.config['sdk_path'], 'build-tools')
  33         if os.path.exists(build_tools):
  34             fdroidserver.common.config['build_tools'] = ''
  35             for f in sorted(os.listdir(build_tools), reverse=True):
  36                 versioned = os.path.join(build_tools, f)
  37                 if os.path.isdir(versioned) \
  38                         and os.path.isfile(os.path.join(versioned, 'aapt')):
  39                     fdroidserver.common.config['build_tools'] = versioned
  40                     break
  41             return True
  42         else:
  43             print('no build-tools found: ' + build_tools)
  44             return False
  45
  46     def _find_all(self):
  47         for cmd in ('aapt', 'adb', 'android', 'zipalign'):
  48             path = fdroidserver.common.find_sdk_tools_cmd(cmd)
  49             if path is not None:
  50                 self.assertTrue(os.path.exists(path))
  51                 self.assertTrue(os.path.isfile(path))
  52
  53     def test_find_sdk_tools_cmd(self):
  54         fdroidserver.common.config = dict()
  55         # TODO add this once everything works without sdk_path set in config
  56         # self._find_all()
  57         sdk_path = os.getenv('ANDROID_HOME')
  58         if os.path.exists(sdk_path):
  59             fdroidserver.common.config['sdk_path'] = sdk_path
  60             if os.path.exists('/usr/bin/aapt'):
  61                 # this test only works when /usr/bin/aapt is installed
  62                 self._find_all()
  63             build_tools = os.path.join(sdk_path, 'build-tools')
  64             if self._set_build_tools():
  65                 self._find_all()
  66             else:
  67                 print('no build-tools found: ' + build_tools)
  68
  69     def testIsApkDebuggable(self):
  70         config = dict()
  71         fdroidserver.common.fill_config_defaults(config)
  72         fdroidserver.common.config = config
  73         self._set_build_tools()
  74         config['aapt'] = fdroidserver.common.find_sdk_tools_cmd('aapt')
  75         # these are set debuggable
  76         testfiles = []
  77         testfiles.append(os.path.join(os.path.dirname(__file__), 'urzip.apk'))
  78         testfiles.append(os.path.join(os.path.dirname(__file__), 'urzip-badsig.apk'))
  79         testfiles.append(os.path.join(os.path.dirname(__file__), 'urzip-badcert.apk'))
  80         for apkfile in testfiles:
  81             debuggable = fdroidserver.common.isApkAndDebuggable(apkfile)
  82             self.assertTrue(debuggable,
  83                             "debuggable APK state was not properly parsed!")
  84         # these are set NOT debuggable
  85         testfiles = []
  86         testfiles.append(os.path.join(os.path.dirname(__file__), 'urzip-release.apk'))
  87         testfiles.append(os.path.join(os.path.dirname(__file__), 'urzip-release-unsigned.apk'))
  88         for apkfile in testfiles:
  89             debuggable = fdroidserver.common.isApkAndDebuggable(apkfile)
  90             self.assertFalse(debuggable,
  91                              "debuggable APK state was not properly parsed!")
  92
  93     def testPackageNameValidity(self):
  94         for name in ["org.fdroid.fdroid",
  95                      "org.f_droid.fdr0ID"]:
  96             self.assertTrue(fdroidserver.common.is_valid_package_name(name),
  97                             "{0} should be a valid package name".format(name))
  98         for name in ["0rg.fdroid.fdroid",
  99                      ".f_droid.fdr0ID",
 100                      "org.fdroid/fdroid",
 101                      "/org.fdroid.fdroid"]:
 102             self.assertFalse(fdroidserver.common.is_valid_package_name(name),
 103                              "{0} should not be a valid package name".format(name))
 104
 105     def test_prepare_sources(self):
 106         testint = 99999999
 107         teststr = 'FAKE_STR_FOR_TESTING'
 108
 109         tmpdir = os.path.join(os.path.dirname(__file__), '..', '.testfiles')
 110         if not os.path.exists(tmpdir):
 111             os.makedirs(tmpdir)
 112         tmptestsdir = tempfile.mkdtemp(prefix='test_prepare_sources', dir=tmpdir)
 113         shutil.copytree(os.path.join(os.path.dirname(__file__), 'source-files'),
 114                         os.path.join(tmptestsdir, 'source-files'))
 115
 116         testdir = os.path.join(tmptestsdir, 'source-files', 'fdroid', 'fdroidclient')
 117
 118         config = dict()
 119         config['sdk_path'] = os.getenv('ANDROID_HOME')
 120         config['ndk_paths'] = {'r10d': os.getenv('ANDROID_NDK_HOME')}
 121         config['build_tools'] = 'FAKE_BUILD_TOOLS_VERSION'
 122         fdroidserver.common.config = config
 123         app = fdroidserver.metadata.App()
 124         app.id = 'org.fdroid.froid'
 125         build = fdroidserver.metadata.Build()
 126         build.commit = 'master'
 127         build.forceversion = True
 128         build.forcevercode = True
 129         build.gradle = ['yes']
 130         build.target = 'android-' + str(testint)
 131         build.versionName = teststr
 132         build.versionCode = testint
 133
 134         class FakeVcs():
 135             # no need to change to the correct commit here
 136             def gotorevision(self, rev, refresh=True):
 137                 pass
 138
 139             # no srclib info needed, but it could be added...
 140             def getsrclib(self):
 141                 return None
 142
 143         fdroidserver.common.prepare_source(FakeVcs(), app, build, testdir, testdir, testdir)
 144
 145         with open(os.path.join(testdir, 'build.gradle'), 'r') as f:
 146             filedata = f.read()
 147         self.assertIsNotNone(re.search("\s+compileSdkVersion %s\s+" % testint, filedata))
 148
 149         with open(os.path.join(testdir, 'AndroidManifest.xml')) as f:
 150             filedata = f.read()
 151         self.assertIsNone(re.search('android:debuggable', filedata))
 152         self.assertIsNotNone(re.search('android:versionName="%s"' % build.versionName, filedata))
 153         self.assertIsNotNone(re.search('android:versionCode="%s"' % build.versionCode, filedata))
 154
 155     def test_fdroid_popen_stderr_redirect(self):
 156         commands = ['sh', '-c', 'echo stdout message && echo stderr message 1>&2']
 157
 158         p = fdroidserver.common.FDroidPopen(commands)
 159         self.assertEqual(p.output, 'stdout message\nstderr message\n')
 160
 161         p = fdroidserver.common.FDroidPopen(commands, stderr_to_stdout=False)
 162         self.assertEqual(p.output, 'stdout message\n')
 163
 164     def test_signjar(self):
 165         fdroidserver.common.config = None
 166         config = fdroidserver.common.read_config(fdroidserver.common.options)
 167         config['jarsigner'] = fdroidserver.common.find_sdk_tools_cmd('jarsigner')
 168         fdroidserver.common.config = config
 169         fdroidserver.signindex.config = config
 170
 171         basedir = os.path.dirname(__file__)
 172         tmpdir = os.path.join(basedir, '..', '.testfiles')
 173         if not os.path.exists(tmpdir):
 174             os.makedirs(tmpdir)
 175         sourcedir = os.path.join(basedir, 'signindex')
 176         testsdir = tempfile.mkdtemp(prefix='test_signjar', dir=tmpdir)
 177         for f in ('testy.jar', 'guardianproject.jar',):
 178             sourcefile = os.path.join(sourcedir, f)
 179             testfile = os.path.join(testsdir, f)
 180             shutil.copy(sourcefile, testsdir)
 181             fdroidserver.signindex.sign_jar(testfile)
 182             # these should be resigned, and therefore different
 183             self.assertNotEqual(open(sourcefile, 'rb').read(), open(testfile, 'rb').read())
 184
 185     def test_verify_apk_signature(self):
 186         fdroidserver.common.config = None
 187         config = fdroidserver.common.read_config(fdroidserver.common.options)
 188         config['jarsigner'] = fdroidserver.common.find_sdk_tools_cmd('jarsigner')
 189         fdroidserver.common.config = config
 190
 191         self.assertTrue(fdroidserver.common.verify_apk_signature('urzip.apk'))
 192         self.assertFalse(fdroidserver.common.verify_apk_signature('urzip-badcert.apk'))
 193         self.assertFalse(fdroidserver.common.verify_apk_signature('urzip-badsig.apk'))
 194         self.assertTrue(fdroidserver.common.verify_apk_signature('urzip-release.apk'))
 195         self.assertFalse(fdroidserver.common.verify_apk_signature('urzip-release-unsigned.apk'))
 196
 197     def test_verify_apks(self):
 198         fdroidserver.common.config = None
 199         config = fdroidserver.common.read_config(fdroidserver.common.options)
 200         config['jarsigner'] = fdroidserver.common.find_sdk_tools_cmd('jarsigner')
 201         fdroidserver.common.config = config
 202
 203         basedir = os.path.dirname(__file__)
 204         sourceapk = os.path.join(basedir, 'urzip.apk')
 205
 206         tmpdir = os.path.join(basedir, '..', '.testfiles')
 207         if not os.path.exists(tmpdir):
 208             os.makedirs(tmpdir)
 209         testdir = tempfile.mkdtemp(prefix='test_verify_apks', dir=tmpdir)
 210         print('testdir', testdir)
 211
 212         copyapk = os.path.join(testdir, 'urzip-copy.apk')
 213         shutil.copy(sourceapk, copyapk)
 214         self.assertTrue(fdroidserver.common.verify_apk_signature(copyapk))
 215         self.assertIsNone(fdroidserver.common.verify_apks(sourceapk, copyapk, tmpdir))
 216
 217         unsignedapk = os.path.join(testdir, 'urzip-unsigned.apk')
 218         with ZipFile(sourceapk, 'r') as apk:
 219             with ZipFile(unsignedapk, 'w') as testapk:
 220                 for info in apk.infolist():
 221                     if not info.filename.startswith('META-INF/'):
 222                         testapk.writestr(info, apk.read(info.filename))
 223         self.assertIsNone(fdroidserver.common.verify_apks(sourceapk, unsignedapk, tmpdir))
 224
 225         twosigapk = os.path.join(testdir, 'urzip-twosig.apk')
 226         otherapk = ZipFile(os.path.join(basedir, 'urzip-release.apk'), 'r')
 227         with ZipFile(sourceapk, 'r') as apk:
 228             with ZipFile(twosigapk, 'w') as testapk:
 229                 for info in apk.infolist():
 230                     testapk.writestr(info, apk.read(info.filename))
 231                     if info.filename.startswith('META-INF/'):
 232                         testapk.writestr(info, otherapk.read(info.filename))
 233         otherapk.close()
 234         self.assertFalse(fdroidserver.common.verify_apk_signature(twosigapk))
 235         self.assertIsNone(fdroidserver.common.verify_apks(sourceapk, twosigapk, tmpdir))
 236
 237     def test_write_to_config(self):
 238         with tempfile.TemporaryDirectory() as tmpPath:
 239             cfgPath = os.path.join(tmpPath, 'config.py')
 240             with open(cfgPath, 'w', encoding='utf-8') as f:
 241                 f.write(textwrap.dedent("""\
 242                     # abc
 243                     # test = 'example value'
 244                     default_me= '%%%'
 245
 246                     # comment
 247                     do_not_touch = "good value"
 248                     default_me="!!!"
 249
 250                     key="123"    # inline"""))
 251
 252             cfg = {'key': '111', 'default_me_orig': 'orig'}
 253             fdroidserver.common.write_to_config(cfg, 'key', config_file=cfgPath)
 254             fdroidserver.common.write_to_config(cfg, 'default_me', config_file=cfgPath)
 255             fdroidserver.common.write_to_config(cfg, 'test', value='test value', config_file=cfgPath)
 256             fdroidserver.common.write_to_config(cfg, 'new_key', value='new', config_file=cfgPath)
 257
 258             with open(cfgPath, 'r', encoding='utf-8') as f:
 259                 self.assertEqual(f.read(), textwrap.dedent("""\
 260                     # abc
 261                     test = 'test value'
 262                     default_me = 'orig'
 263
 264                     # comment
 265                     do_not_touch = "good value"
 266
 267                     key = "111"    # inline
 268
 269                     new_key = "new"
 270                     """))
 271
 272     def test_write_to_config_when_empty(self):
 273         with tempfile.TemporaryDirectory() as tmpPath:
 274             cfgPath = os.path.join(tmpPath, 'config.py')
 275             with open(cfgPath, 'w') as f:
 276                 pass
 277             fdroidserver.common.write_to_config({}, 'key', 'val', cfgPath)
 278             with open(cfgPath, 'r', encoding='utf-8') as f:
 279                 self.assertEqual(f.read(), textwrap.dedent("""\
 280
 281                 key = "val"
 282                 """))
 283
 284     def test_apk_name_regex(self):
 285         good = [
 286             'urzipπÇÇπÇÇ现代汉语通用字българскиعربي1234ö_-123456.apk',
 287             'urzipπÇÇπÇÇ现代汉语通用字българскиعربي1234ö_123456_abcdef0.apk',
 288             'urzip_-123456.apk',
 289             'a0_0.apk',
 290             'Z0_0.apk',
 291             'a0_0_abcdef0.apk',
 292             'a_a_a_a_0_abcdef0.apk',
 293             'a_____0.apk',
 294             'a_____123456_abcdef0.apk',
 295             'org.fdroid.fdroid_123456.apk',
 296             # valid, but "_99999" is part of packageName rather than versionCode
 297             'org.fdroid.fdroid_99999_123456.apk',
 298             # should be valid, but I can't figure out the regex since \w includes digits
 299             # 'πÇÇπÇÇ现代汉语通用字българскиعربي1234ö_0_123bafd.apk',
 300         ]
 301         for name in good:
 302             m = fdroidserver.common.APK_NAME_REGEX.match(name)
 303             self.assertIsNotNone(m)
 304             self.assertIn(m.group(2), ('-123456', '0', '123456'))
 305             self.assertIn(m.group(3), ('abcdef0', None))
 306
 307         bad = [
 308             'urzipπÇÇπÇÇ现代汉语通用字българскиعربي1234ö_123456_abcdefg.apk',
 309             'urzip-_-198274.apk',
 310             'urzip-_0_123bafd.apk',
 311             'no spaces allowed_123.apk',
 312             '0_0.apk',
 313             '0_0_abcdef0.apk',
 314         ]
 315         for name in bad:
 316             self.assertIsNone(fdroidserver.common.APK_NAME_REGEX.match(name))
 317
 318     def test_standard_file_name_regex(self):
 319         good = [
 320             'urzipπÇÇπÇÇ现代汉语通用字българскиعربي1234ö_-123456.mp3',
 321             'urzipπÇÇπÇÇ现代汉语通用字българскиعربي1234ö_123456.mov',
 322             'Document_-123456.pdf',
 323             'WTF_0.MOV',
 324             'Z0_0.ebk',
 325             'a_a_a_a_0.txt',
 326             'org.fdroid.fdroid.privileged.ota_123456.zip',
 327             'πÇÇπÇÇ现代汉语通用字българскиعربي1234ö_0.jpeg',
 328             'a_____0.PNG',
 329             # valid, but "_99999" is part of packageName rather than versionCode
 330             'a_____99999_123456.zip',
 331             'org.fdroid.fdroid_99999_123456.zip',
 332         ]
 333         for name in good:
 334             m = fdroidserver.common.STANDARD_FILE_NAME_REGEX.match(name)
 335             self.assertIsNotNone(m)
 336             self.assertIn(m.group(2), ('-123456', '0', '123456'))
 337
 338         bad = [
 339             'urzipπÇÇπÇÇ现代汉语通用字българскиعربي1234ö_abcdefg.JPEG',
 340             'urzip-_-198274.zip',
 341             'urzip-_123bafd.pdf',
 342             'no spaces allowed_123.foobar',
 343             'a_____0.',
 344         ]
 345         for name in bad:
 346             self.assertIsNone(fdroidserver.common.STANDARD_FILE_NAME_REGEX.match(name))
 347
 348
 349 if __name__ == "__main__":
 350     parser = optparse.OptionParser()
 351     parser.add_option("-v", "--verbose", action="store_true", default=False,
 352                       help="Spew out even more information than normal")
 353     (fdroidserver.common.options, args) = parser.parse_args(['--verbose'])
 354
 355     newSuite = unittest.TestSuite()
 356     newSuite.addTest(unittest.makeSuite(CommonTest))
 357     unittest.main()