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 from zipfile import ZipFile
  14
  15 import fdroidserver.signindex
  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.common
  24 import fdroidserver.metadata
  25
  26
  27 class CommonTest(unittest.TestCase):
  28     '''fdroidserver/common.py'''
  29
  30     def _set_build_tools(self):
  31         build_tools = os.path.join(fdroidserver.common.config['sdk_path'], 'build-tools')
  32         if os.path.exists(build_tools):
  33             fdroidserver.common.config['build_tools'] = ''
  34             for f in sorted(os.listdir(build_tools), reverse=True):
  35                 versioned = os.path.join(build_tools, f)
  36                 if os.path.isdir(versioned) \
  37                         and os.path.isfile(os.path.join(versioned, 'aapt')):
  38                     fdroidserver.common.config['build_tools'] = versioned
  39                     break
  40             return True
  41         else:
  42             print('no build-tools found: ' + build_tools)
  43             return False
  44
  45     def _find_all(self):
  46         for cmd in ('aapt', 'adb', 'android', 'zipalign'):
  47             path = fdroidserver.common.find_sdk_tools_cmd(cmd)
  48             if path is not None:
  49                 self.assertTrue(os.path.exists(path))
  50                 self.assertTrue(os.path.isfile(path))
  51
  52     def test_find_sdk_tools_cmd(self):
  53         fdroidserver.common.config = dict()
  54         # TODO add this once everything works without sdk_path set in config
  55         # self._find_all()
  56         sdk_path = os.getenv('ANDROID_HOME')
  57         if os.path.exists(sdk_path):
  58             fdroidserver.common.config['sdk_path'] = sdk_path
  59             if os.path.exists('/usr/bin/aapt'):
  60                 # this test only works when /usr/bin/aapt is installed
  61                 self._find_all()
  62             build_tools = os.path.join(sdk_path, 'build-tools')
  63             if self._set_build_tools():
  64                 self._find_all()
  65             else:
  66                 print('no build-tools found: ' + build_tools)
  67
  68     def testIsApkDebuggable(self):
  69         config = dict()
  70         fdroidserver.common.fill_config_defaults(config)
  71         fdroidserver.common.config = config
  72         self._set_build_tools()
  73         config['aapt'] = fdroidserver.common.find_sdk_tools_cmd('aapt')
  74         # these are set debuggable
  75         testfiles = []
  76         testfiles.append(os.path.join(os.path.dirname(__file__), 'urzip.apk'))
  77         testfiles.append(os.path.join(os.path.dirname(__file__), 'urzip-badsig.apk'))
  78         testfiles.append(os.path.join(os.path.dirname(__file__), 'urzip-badcert.apk'))
  79         for apkfile in testfiles:
  80             debuggable = fdroidserver.common.isApkAndDebuggable(apkfile, config)
  81             self.assertTrue(debuggable,
  82                             "debuggable APK state was not properly parsed!")
  83         # these are set NOT debuggable
  84         testfiles = []
  85         testfiles.append(os.path.join(os.path.dirname(__file__), 'urzip-release.apk'))
  86         testfiles.append(os.path.join(os.path.dirname(__file__), 'urzip-release-unsigned.apk'))
  87         for apkfile in testfiles:
  88             debuggable = fdroidserver.common.isApkAndDebuggable(apkfile, config)
  89             self.assertFalse(debuggable,
  90                              "debuggable APK state was not properly parsed!")
  91
  92     def testPackageNameValidity(self):
  93         for name in ["org.fdroid.fdroid",
  94                      "org.f_droid.fdr0ID"]:
  95             self.assertTrue(fdroidserver.common.is_valid_package_name(name),
  96                             "{0} should be a valid package name".format(name))
  97         for name in ["0rg.fdroid.fdroid",
  98                      ".f_droid.fdr0ID",
  99                      "org.fdroid/fdroid",
 100                      "/org.fdroid.fdroid"]:
 101             self.assertFalse(fdroidserver.common.is_valid_package_name(name),
 102                              "{0} should not be a valid package name".format(name))
 103
 104     def test_prepare_sources(self):
 105         testint = 99999999
 106         teststr = 'FAKE_STR_FOR_TESTING'
 107
 108         tmpdir = os.path.join(os.path.dirname(__file__), '..', '.testfiles')
 109         if not os.path.exists(tmpdir):
 110             os.makedirs(tmpdir)
 111         tmptestsdir = tempfile.mkdtemp(prefix='test_prepare_sources', dir=tmpdir)
 112         shutil.copytree(os.path.join(os.path.dirname(__file__), 'source-files'),
 113                         os.path.join(tmptestsdir, 'source-files'))
 114
 115         testdir = os.path.join(tmptestsdir, 'source-files', 'fdroid', 'fdroidclient')
 116
 117         config = dict()
 118         config['sdk_path'] = os.getenv('ANDROID_HOME')
 119         config['ndk_paths'] = {'r10d': os.getenv('ANDROID_NDK_HOME')}
 120         config['build_tools'] = 'FAKE_BUILD_TOOLS_VERSION'
 121         fdroidserver.common.config = config
 122         app = fdroidserver.metadata.App()
 123         app.id = 'org.fdroid.froid'
 124         build = fdroidserver.metadata.Build()
 125         build.commit = 'master'
 126         build.forceversion = True
 127         build.forcevercode = True
 128         build.gradle = ['yes']
 129         build.target = 'android-' + str(testint)
 130         build.versionName = teststr
 131         build.versionCode = testint
 132
 133         class FakeVcs():
 134             # no need to change to the correct commit here
 135             def gotorevision(self, rev, refresh=True):
 136                 pass
 137
 138             # no srclib info needed, but it could be added...
 139             def getsrclib(self):
 140                 return None
 141
 142         fdroidserver.common.prepare_source(FakeVcs(), app, build, testdir, testdir, testdir)
 143
 144         with open(os.path.join(testdir, 'build.gradle'), 'r') as f:
 145             filedata = f.read()
 146         self.assertIsNotNone(re.search("\s+compileSdkVersion %s\s+" % testint, filedata))
 147
 148         with open(os.path.join(testdir, 'AndroidManifest.xml')) as f:
 149             filedata = f.read()
 150         self.assertIsNone(re.search('android:debuggable', filedata))
 151         self.assertIsNotNone(re.search('android:versionName="%s"' % build.versionName, filedata))
 152         self.assertIsNotNone(re.search('android:versionCode="%s"' % build.versionCode, filedata))
 153
 154     def test_fdroid_popen_stderr_redirect(self):
 155         commands = ['sh', '-c', 'echo stdout message && echo stderr message 1>&2']
 156
 157         p = fdroidserver.common.FDroidPopen(commands)
 158         self.assertEqual(p.output, 'stdout message\nstderr message\n')
 159
 160         p = fdroidserver.common.FDroidPopen(commands, stderr_to_stdout=False)
 161         self.assertEqual(p.output, 'stdout message\n')
 162
 163     def test_signjar(self):
 164         fdroidserver.common.config = None
 165         config = fdroidserver.common.read_config(fdroidserver.common.options)
 166         config['jarsigner'] = fdroidserver.common.find_sdk_tools_cmd('jarsigner')
 167         fdroidserver.common.config = config
 168         fdroidserver.signindex.config = config
 169
 170         basedir = os.path.dirname(__file__)
 171         tmpdir = os.path.join(basedir, '..', '.testfiles')
 172         if not os.path.exists(tmpdir):
 173             os.makedirs(tmpdir)
 174         sourcedir = os.path.join(basedir, 'signindex')
 175         testsdir = tempfile.mkdtemp(prefix='test_signjar', dir=tmpdir)
 176         for f in ('testy.jar', 'guardianproject.jar',):
 177             sourcefile = os.path.join(sourcedir, f)
 178             testfile = os.path.join(testsdir, f)
 179             shutil.copy(sourcefile, testsdir)
 180             fdroidserver.signindex.sign_jar(testfile)
 181             # these should be resigned, and therefore different
 182             self.assertNotEqual(open(sourcefile, 'rb').read(), open(testfile, 'rb').read())
 183
 184     def test_verify_apk_signature(self):
 185         fdroidserver.common.config = None
 186         config = fdroidserver.common.read_config(fdroidserver.common.options)
 187         config['jarsigner'] = fdroidserver.common.find_sdk_tools_cmd('jarsigner')
 188         fdroidserver.common.config = config
 189
 190         self.assertTrue(fdroidserver.common.verify_apk_signature('urzip.apk'))
 191         self.assertFalse(fdroidserver.common.verify_apk_signature('urzip-badcert.apk'))
 192         self.assertFalse(fdroidserver.common.verify_apk_signature('urzip-badsig.apk'))
 193         self.assertTrue(fdroidserver.common.verify_apk_signature('urzip-release.apk'))
 194         self.assertFalse(fdroidserver.common.verify_apk_signature('urzip-release-unsigned.apk'))
 195
 196     def test_verify_apks(self):
 197         fdroidserver.common.config = None
 198         config = fdroidserver.common.read_config(fdroidserver.common.options)
 199         config['jarsigner'] = fdroidserver.common.find_sdk_tools_cmd('jarsigner')
 200         fdroidserver.common.config = config
 201
 202         basedir = os.path.dirname(__file__)
 203         sourceapk = os.path.join(basedir, 'urzip.apk')
 204
 205         tmpdir = os.path.join(basedir, '..', '.testfiles')
 206         if not os.path.exists(tmpdir):
 207             os.makedirs(tmpdir)
 208         testdir = tempfile.mkdtemp(prefix='test_verify_apks', dir=tmpdir)
 209         print('testdir', testdir)
 210
 211         copyapk = os.path.join(testdir, 'urzip-copy.apk')
 212         shutil.copy(sourceapk, copyapk)
 213         self.assertTrue(fdroidserver.common.verify_apk_signature(copyapk))
 214         self.assertIsNone(fdroidserver.common.verify_apks(sourceapk, copyapk, tmpdir))
 215
 216         unsignedapk = os.path.join(testdir, 'urzip-unsigned.apk')
 217         with ZipFile(sourceapk, 'r') as apk:
 218             with ZipFile(unsignedapk, 'w') as testapk:
 219                 for info in apk.infolist():
 220                     if not info.filename.startswith('META-INF/'):
 221                         testapk.writestr(info, apk.read(info.filename))
 222         self.assertIsNone(fdroidserver.common.verify_apks(sourceapk, unsignedapk, tmpdir))
 223
 224         twosigapk = os.path.join(testdir, 'urzip-twosig.apk')
 225         otherapk = ZipFile(os.path.join(basedir, 'urzip-release.apk'), 'r')
 226         with ZipFile(sourceapk, 'r') as apk:
 227             with ZipFile(twosigapk, 'w') as testapk:
 228                 for info in apk.infolist():
 229                     testapk.writestr(info, apk.read(info.filename))
 230                     if info.filename.startswith('META-INF/'):
 231                         testapk.writestr(info, otherapk.read(info.filename))
 232         otherapk.close()
 233         self.assertFalse(fdroidserver.common.verify_apk_signature(twosigapk))
 234         self.assertIsNone(fdroidserver.common.verify_apks(sourceapk, twosigapk, tmpdir))
 235
 236
 237 if __name__ == "__main__":
 238     parser = optparse.OptionParser()
 239     parser.add_option("-v", "--verbose", action="store_true", default=False,
 240                       help="Spew out even more information than normal")
 241     (fdroidserver.common.options, args) = parser.parse_args(['--verbose'])
 242
 243     newSuite = unittest.TestSuite()
 244     newSuite.addTest(unittest.makeSuite(CommonTest))
 245     unittest.main()