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 logging
   7 import optparse
   8 import os
   9 import re
  10 import shutil
  11 import sys
  12 import tempfile
  13 import unittest
  14 import textwrap
  15 import yaml
  16 from zipfile import ZipFile
  17
  18
  19 localmodule = os.path.realpath(
  20     os.path.join(os.path.dirname(inspect.getfile(inspect.currentframe())), '..'))
  21 print('localmodule: ' + localmodule)
  22 if localmodule not in sys.path:
  23     sys.path.insert(0, localmodule)
  24
  25 import fdroidserver.signindex
  26 import fdroidserver.common
  27 import fdroidserver.metadata
  28 from fdroidserver.exception import FDroidException
  29
  30
  31 class CommonTest(unittest.TestCase):
  32     '''fdroidserver/common.py'''
  33
  34     def setUp(self):
  35         logging.basicConfig(level=logging.DEBUG)
  36         self.basedir = os.path.join(localmodule, 'tests')
  37         self.tmpdir = os.path.abspath(os.path.join(self.basedir, '..', '.testfiles'))
  38         if not os.path.exists(self.tmpdir):
  39             os.makedirs(self.tmpdir)
  40         os.chdir(self.basedir)
  41
  42     def _set_build_tools(self):
  43         build_tools = os.path.join(fdroidserver.common.config['sdk_path'], 'build-tools')
  44         if os.path.exists(build_tools):
  45             fdroidserver.common.config['build_tools'] = ''
  46             for f in sorted(os.listdir(build_tools), reverse=True):
  47                 versioned = os.path.join(build_tools, f)
  48                 if os.path.isdir(versioned) \
  49                         and os.path.isfile(os.path.join(versioned, 'aapt')):
  50                     fdroidserver.common.config['build_tools'] = versioned
  51                     break
  52             return True
  53         else:
  54             print('no build-tools found: ' + build_tools)
  55             return False
  56
  57     def _find_all(self):
  58         for cmd in ('aapt', 'adb', 'android', 'zipalign'):
  59             path = fdroidserver.common.find_sdk_tools_cmd(cmd)
  60             if path is not None:
  61                 self.assertTrue(os.path.exists(path))
  62                 self.assertTrue(os.path.isfile(path))
  63
  64     def test_find_sdk_tools_cmd(self):
  65         fdroidserver.common.config = dict()
  66         # TODO add this once everything works without sdk_path set in config
  67         # self._find_all()
  68         sdk_path = os.getenv('ANDROID_HOME')
  69         if os.path.exists(sdk_path):
  70             fdroidserver.common.config['sdk_path'] = sdk_path
  71             if os.path.exists('/usr/bin/aapt'):
  72                 # this test only works when /usr/bin/aapt is installed
  73                 self._find_all()
  74             build_tools = os.path.join(sdk_path, 'build-tools')
  75             if self._set_build_tools():
  76                 self._find_all()
  77             else:
  78                 print('no build-tools found: ' + build_tools)
  79
  80     def testIsApkDebuggable(self):
  81         config = dict()
  82         fdroidserver.common.fill_config_defaults(config)
  83         fdroidserver.common.config = config
  84         self._set_build_tools()
  85         config['aapt'] = fdroidserver.common.find_sdk_tools_cmd('aapt')
  86         # these are set debuggable
  87         testfiles = []
  88         testfiles.append(os.path.join(self.basedir, 'urzip.apk'))
  89         testfiles.append(os.path.join(self.basedir, 'urzip-badsig.apk'))
  90         testfiles.append(os.path.join(self.basedir, 'urzip-badcert.apk'))
  91         for apkfile in testfiles:
  92             debuggable = fdroidserver.common.isApkAndDebuggable(apkfile)
  93             self.assertTrue(debuggable,
  94                             "debuggable APK state was not properly parsed!")
  95         # these are set NOT debuggable
  96         testfiles = []
  97         testfiles.append(os.path.join(self.basedir, 'urzip-release.apk'))
  98         testfiles.append(os.path.join(self.basedir, 'urzip-release-unsigned.apk'))
  99         for apkfile in testfiles:
 100             debuggable = fdroidserver.common.isApkAndDebuggable(apkfile)
 101             self.assertFalse(debuggable,
 102                              "debuggable APK state was not properly parsed!")
 103
 104     def testPackageNameValidity(self):
 105         for name in ["org.fdroid.fdroid",
 106                      "org.f_droid.fdr0ID"]:
 107             self.assertTrue(fdroidserver.common.is_valid_package_name(name),
 108                             "{0} should be a valid package name".format(name))
 109         for name in ["0rg.fdroid.fdroid",
 110                      ".f_droid.fdr0ID",
 111                      "org.fdroid/fdroid",
 112                      "/org.fdroid.fdroid"]:
 113             self.assertFalse(fdroidserver.common.is_valid_package_name(name),
 114                              "{0} should not be a valid package name".format(name))
 115
 116     def test_prepare_sources(self):
 117         testint = 99999999
 118         teststr = 'FAKE_STR_FOR_TESTING'
 119
 120         tmptestsdir = tempfile.mkdtemp(prefix='test_prepare_sources', dir=self.tmpdir)
 121         shutil.copytree(os.path.join(self.basedir, 'source-files'),
 122                         os.path.join(tmptestsdir, 'source-files'))
 123
 124         testdir = os.path.join(tmptestsdir, 'source-files', 'fdroid', 'fdroidclient')
 125
 126         config = dict()
 127         config['sdk_path'] = os.getenv('ANDROID_HOME')
 128         config['ndk_paths'] = {'r10d': os.getenv('ANDROID_NDK_HOME')}
 129         config['build_tools'] = 'FAKE_BUILD_TOOLS_VERSION'
 130         fdroidserver.common.config = config
 131         app = fdroidserver.metadata.App()
 132         app.id = 'org.fdroid.froid'
 133         build = fdroidserver.metadata.Build()
 134         build.commit = 'master'
 135         build.forceversion = True
 136         build.forcevercode = True
 137         build.gradle = ['yes']
 138         build.target = 'android-' + str(testint)
 139         build.versionName = teststr
 140         build.versionCode = testint
 141
 142         class FakeVcs():
 143             # no need to change to the correct commit here
 144             def gotorevision(self, rev, refresh=True):
 145                 pass
 146
 147             # no srclib info needed, but it could be added...
 148             def getsrclib(self):
 149                 return None
 150
 151         fdroidserver.common.prepare_source(FakeVcs(), app, build, testdir, testdir, testdir)
 152
 153         with open(os.path.join(testdir, 'build.gradle'), 'r') as f:
 154             filedata = f.read()
 155         self.assertIsNotNone(re.search("\s+compileSdkVersion %s\s+" % testint, filedata))
 156
 157         with open(os.path.join(testdir, 'AndroidManifest.xml')) as f:
 158             filedata = f.read()
 159         self.assertIsNone(re.search('android:debuggable', filedata))
 160         self.assertIsNotNone(re.search('android:versionName="%s"' % build.versionName, filedata))
 161         self.assertIsNotNone(re.search('android:versionCode="%s"' % build.versionCode, filedata))
 162
 163     def test_prepare_sources_refresh(self):
 164         packageName = 'org.fdroid.ci.test.app'
 165         testdir = tempfile.mkdtemp(prefix='test_verify_apks', dir=self.tmpdir)
 166         print('testdir', testdir)
 167         os.chdir(testdir)
 168         os.mkdir('build')
 169         os.mkdir('metadata')
 170
 171         # use a local copy if available to avoid hitting the network
 172         tmprepo = os.path.join(self.basedir, 'tmp', 'importer')
 173         if os.path.exists(tmprepo):
 174             git_url = tmprepo
 175         else:
 176             git_url = 'https://gitlab.com/fdroid/ci-test-app.git'
 177
 178         metadata = dict()
 179         metadata['Description'] = 'This is just a test app'
 180         metadata['RepoType'] = 'git'
 181         metadata['Repo'] = git_url
 182         with open(os.path.join('metadata', packageName + '.yml'), 'w') as fp:
 183             yaml.dump(metadata, fp)
 184
 185         gitrepo = os.path.join(testdir, 'build', packageName)
 186         vcs0 = fdroidserver.common.getvcs('git', git_url, gitrepo)
 187         vcs0.gotorevision('0.3', refresh=True)
 188         vcs1 = fdroidserver.common.getvcs('git', git_url, gitrepo)
 189         vcs1.gotorevision('0.3', refresh=False)
 190
 191     def test_fdroid_popen_stderr_redirect(self):
 192         config = dict()
 193         fdroidserver.common.fill_config_defaults(config)
 194         fdroidserver.common.config = config
 195
 196         commands = ['sh', '-c', 'echo stdout message && echo stderr message 1>&2']
 197
 198         p = fdroidserver.common.FDroidPopen(commands)
 199         self.assertEqual(p.output, 'stdout message\nstderr message\n')
 200
 201         p = fdroidserver.common.FDroidPopen(commands, stderr_to_stdout=False)
 202         self.assertEqual(p.output, 'stdout message\n')
 203
 204     def test_signjar(self):
 205         fdroidserver.common.config = None
 206         config = fdroidserver.common.read_config(fdroidserver.common.options)
 207         config['jarsigner'] = fdroidserver.common.find_sdk_tools_cmd('jarsigner')
 208         fdroidserver.common.config = config
 209         fdroidserver.signindex.config = config
 210
 211         sourcedir = os.path.join(self.basedir, 'signindex')
 212         testsdir = tempfile.mkdtemp(prefix='test_signjar', dir=self.tmpdir)
 213         for f in ('testy.jar', 'guardianproject.jar',):
 214             sourcefile = os.path.join(sourcedir, f)
 215             testfile = os.path.join(testsdir, f)
 216             shutil.copy(sourcefile, testsdir)
 217             fdroidserver.signindex.sign_jar(testfile)
 218             # these should be resigned, and therefore different
 219             self.assertNotEqual(open(sourcefile, 'rb').read(), open(testfile, 'rb').read())
 220
 221     def test_verify_apk_signature(self):
 222         fdroidserver.common.config = None
 223         config = fdroidserver.common.read_config(fdroidserver.common.options)
 224         config['jarsigner'] = fdroidserver.common.find_sdk_tools_cmd('jarsigner')
 225         fdroidserver.common.config = config
 226
 227         self.assertTrue(fdroidserver.common.verify_apk_signature('urzip.apk'))
 228         self.assertFalse(fdroidserver.common.verify_apk_signature('urzip-badcert.apk'))
 229         self.assertFalse(fdroidserver.common.verify_apk_signature('urzip-badsig.apk'))
 230         self.assertTrue(fdroidserver.common.verify_apk_signature('urzip-release.apk'))
 231         self.assertFalse(fdroidserver.common.verify_apk_signature('urzip-release-unsigned.apk'))
 232
 233     def test_verify_apks(self):
 234         fdroidserver.common.config = None
 235         config = fdroidserver.common.read_config(fdroidserver.common.options)
 236         config['jarsigner'] = fdroidserver.common.find_sdk_tools_cmd('jarsigner')
 237         fdroidserver.common.config = config
 238
 239         sourceapk = os.path.join(self.basedir, 'urzip.apk')
 240
 241         testdir = tempfile.mkdtemp(prefix='test_verify_apks', dir=self.tmpdir)
 242         print('testdir', testdir)
 243
 244         copyapk = os.path.join(testdir, 'urzip-copy.apk')
 245         shutil.copy(sourceapk, copyapk)
 246         self.assertTrue(fdroidserver.common.verify_apk_signature(copyapk))
 247         self.assertIsNone(fdroidserver.common.verify_apks(sourceapk, copyapk, self.tmpdir))
 248
 249         unsignedapk = os.path.join(testdir, 'urzip-unsigned.apk')
 250         with ZipFile(sourceapk, 'r') as apk:
 251             with ZipFile(unsignedapk, 'w') as testapk:
 252                 for info in apk.infolist():
 253                     if not info.filename.startswith('META-INF/'):
 254                         testapk.writestr(info, apk.read(info.filename))
 255         self.assertIsNone(fdroidserver.common.verify_apks(sourceapk, unsignedapk, self.tmpdir))
 256
 257         twosigapk = os.path.join(testdir, 'urzip-twosig.apk')
 258         otherapk = ZipFile(os.path.join(self.basedir, 'urzip-release.apk'), 'r')
 259         with ZipFile(sourceapk, 'r') as apk:
 260             with ZipFile(twosigapk, 'w') as testapk:
 261                 for info in apk.infolist():
 262                     testapk.writestr(info, apk.read(info.filename))
 263                     if info.filename.startswith('META-INF/'):
 264                         testapk.writestr(info, otherapk.read(info.filename))
 265         otherapk.close()
 266         self.assertFalse(fdroidserver.common.verify_apk_signature(twosigapk))
 267         self.assertIsNone(fdroidserver.common.verify_apks(sourceapk, twosigapk, self.tmpdir))
 268
 269     def test_write_to_config(self):
 270         with tempfile.TemporaryDirectory() as tmpPath:
 271             cfgPath = os.path.join(tmpPath, 'config.py')
 272             with open(cfgPath, 'w', encoding='utf-8') as f:
 273                 f.write(textwrap.dedent("""\
 274                     # abc
 275                     # test = 'example value'
 276                     default_me= '%%%'
 277
 278                     # comment
 279                     do_not_touch = "good value"
 280                     default_me="!!!"
 281
 282                     key="123"    # inline"""))
 283
 284             cfg = {'key': '111', 'default_me_orig': 'orig'}
 285             fdroidserver.common.write_to_config(cfg, 'key', config_file=cfgPath)
 286             fdroidserver.common.write_to_config(cfg, 'default_me', config_file=cfgPath)
 287             fdroidserver.common.write_to_config(cfg, 'test', value='test value', config_file=cfgPath)
 288             fdroidserver.common.write_to_config(cfg, 'new_key', value='new', config_file=cfgPath)
 289
 290             with open(cfgPath, 'r', encoding='utf-8') as f:
 291                 self.assertEqual(f.read(), textwrap.dedent("""\
 292                     # abc
 293                     test = 'test value'
 294                     default_me = 'orig'
 295
 296                     # comment
 297                     do_not_touch = "good value"
 298
 299                     key = "111"    # inline
 300
 301                     new_key = "new"
 302                     """))
 303
 304     def test_write_to_config_when_empty(self):
 305         with tempfile.TemporaryDirectory() as tmpPath:
 306             cfgPath = os.path.join(tmpPath, 'config.py')
 307             with open(cfgPath, 'w') as f:
 308                 pass
 309             fdroidserver.common.write_to_config({}, 'key', 'val', cfgPath)
 310             with open(cfgPath, 'r', encoding='utf-8') as f:
 311                 self.assertEqual(f.read(), textwrap.dedent("""\
 312
 313                 key = "val"
 314                 """))
 315
 316     def test_apk_name_regex(self):
 317         good = [
 318             'urzipπÇÇπÇÇ现代汉语通用字българскиعربي1234ö_-123456.apk',
 319             'urzipπÇÇπÇÇ现代汉语通用字българскиعربي1234ö_123456_abcdef0.apk',
 320             'urzip_-123456.apk',
 321             'a0_0.apk',
 322             'Z0_0.apk',
 323             'a0_0_abcdef0.apk',
 324             'a_a_a_a_0_abcdef0.apk',
 325             'a_____0.apk',
 326             'a_____123456_abcdef0.apk',
 327             'org.fdroid.fdroid_123456.apk',
 328             # valid, but "_99999" is part of packageName rather than versionCode
 329             'org.fdroid.fdroid_99999_123456.apk',
 330             # should be valid, but I can't figure out the regex since \w includes digits
 331             # 'πÇÇπÇÇ现代汉语通用字българскиعربي1234ö_0_123bafd.apk',
 332         ]
 333         for name in good:
 334             m = fdroidserver.common.APK_NAME_REGEX.match(name)
 335             self.assertIsNotNone(m)
 336             self.assertIn(m.group(2), ('-123456', '0', '123456'))
 337             self.assertIn(m.group(3), ('abcdef0', None))
 338
 339         bad = [
 340             'urzipπÇÇπÇÇ现代汉语通用字българскиعربي1234ö_123456_abcdefg.apk',
 341             'urzip-_-198274.apk',
 342             'urzip-_0_123bafd.apk',
 343             'no spaces allowed_123.apk',
 344             '0_0.apk',
 345             '0_0_abcdef0.apk',
 346         ]
 347         for name in bad:
 348             self.assertIsNone(fdroidserver.common.APK_NAME_REGEX.match(name))
 349
 350     def test_standard_file_name_regex(self):
 351         good = [
 352             'urzipπÇÇπÇÇ现代汉语通用字българскиعربي1234ö_-123456.mp3',
 353             'urzipπÇÇπÇÇ现代汉语通用字българскиعربي1234ö_123456.mov',
 354             'Document_-123456.pdf',
 355             'WTF_0.MOV',
 356             'Z0_0.ebk',
 357             'a_a_a_a_0.txt',
 358             'org.fdroid.fdroid.privileged.ota_123456.zip',
 359             'πÇÇπÇÇ现代汉语通用字българскиعربي1234ö_0.jpeg',
 360             'a_____0.PNG',
 361             # valid, but "_99999" is part of packageName rather than versionCode
 362             'a_____99999_123456.zip',
 363             'org.fdroid.fdroid_99999_123456.zip',
 364         ]
 365         for name in good:
 366             m = fdroidserver.common.STANDARD_FILE_NAME_REGEX.match(name)
 367             self.assertIsNotNone(m)
 368             self.assertIn(m.group(2), ('-123456', '0', '123456'))
 369
 370         bad = [
 371             'urzipπÇÇπÇÇ现代汉语通用字българскиعربي1234ö_abcdefg.JPEG',
 372             'urzip-_-198274.zip',
 373             'urzip-_123bafd.pdf',
 374             'no spaces allowed_123.foobar',
 375             'a_____0.',
 376         ]
 377         for name in bad:
 378             self.assertIsNone(fdroidserver.common.STANDARD_FILE_NAME_REGEX.match(name))
 379
 380     def test_apk_signer_fingerprint(self):
 381
 382         # fingerprints fetched with: keytool -printcert -file ____.RSA
 383         testapks = (('repo/obb.main.oldversion_1444412523.apk',
 384                      '818e469465f96b704e27be2fee4c63ab9f83ddf30e7a34c7371a4728d83b0bc1'),
 385                     ('repo/obb.main.twoversions_1101613.apk',
 386                      '32a23624c201b949f085996ba5ed53d40f703aca4989476949cae891022e0ed6'),
 387                     ('repo/obb.main.twoversions_1101617.apk',
 388                      '32a23624c201b949f085996ba5ed53d40f703aca4989476949cae891022e0ed6'))
 389
 390         for apkfile, keytoolcertfingerprint in testapks:
 391             self.assertEqual(keytoolcertfingerprint,
 392                              fdroidserver.common.apk_signer_fingerprint(apkfile))
 393
 394     def test_apk_signer_fingerprint_short(self):
 395
 396         # fingerprints fetched with: keytool -printcert -file ____.RSA
 397         testapks = (('repo/obb.main.oldversion_1444412523.apk', '818e469'),
 398                     ('repo/obb.main.twoversions_1101613.apk', '32a2362'),
 399                     ('repo/obb.main.twoversions_1101617.apk', '32a2362'))
 400
 401         for apkfile, keytoolcertfingerprint in testapks:
 402             self.assertEqual(keytoolcertfingerprint,
 403                              fdroidserver.common.apk_signer_fingerprint_short(apkfile))
 404
 405     def test_get_api_id_aapt(self):
 406
 407         config = dict()
 408         fdroidserver.common.fill_config_defaults(config)
 409         fdroidserver.common.config = config
 410         self._set_build_tools()
 411         config['aapt'] = fdroidserver.common.find_sdk_tools_cmd('aapt')
 412
 413         appid, vercode, vername = fdroidserver.common.get_apk_id_aapt('repo/obb.main.twoversions_1101613.apk')
 414         self.assertEqual('obb.main.twoversions', appid)
 415         self.assertEqual('1101613', vercode)
 416         self.assertEqual('0.1', vername)
 417
 418         with self.assertRaises(FDroidException):
 419             fdroidserver.common.get_apk_id_aapt('nope')
 420
 421     def test_apk_release_name(self):
 422         appid, vercode, sigfp = fdroidserver.common.apk_parse_release_filename('com.serwylo.lexica_905.apk')
 423         self.assertEqual(appid, 'com.serwylo.lexica')
 424         self.assertEqual(vercode, '905')
 425         self.assertEqual(sigfp, None)
 426
 427         appid, vercode, sigfp = fdroidserver.common.apk_parse_release_filename('com.serwylo.lexica_905_c82e0f6.apk')
 428         self.assertEqual(appid, 'com.serwylo.lexica')
 429         self.assertEqual(vercode, '905')
 430         self.assertEqual(sigfp, 'c82e0f6')
 431
 432         appid, vercode, sigfp = fdroidserver.common.apk_parse_release_filename('beverly_hills-90210.apk')
 433         self.assertEqual(appid, None)
 434         self.assertEqual(vercode, None)
 435         self.assertEqual(sigfp, None)
 436
 437     def test_metadata_find_developer_signature(self):
 438         sig = fdroidserver.common.metadata_find_developer_signature('org.smssecure.smssecure')
 439         self.assertEqual('b30bb971af0d134866e158ec748fcd553df97c150f58b0a963190bbafbeb0868', sig)
 440
 441
 442 if __name__ == "__main__":
 443     parser = optparse.OptionParser()
 444     parser.add_option("-v", "--verbose", action="store_true", default=False,
 445                       help="Spew out even more information than normal")
 446     (fdroidserver.common.options, args) = parser.parse_args(['--verbose'])
 447
 448     newSuite = unittest.TestSuite()
 449     newSuite.addTest(unittest.makeSuite(CommonTest))
 450     unittest.main()