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