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