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