3 # http://www.drdobbs.com/testing/unit-testing-with-python/240165163
16 from zipfile import ZipFile
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)
25 import fdroidserver.signindex
26 import fdroidserver.common
27 import fdroidserver.metadata
28 from testcommon import TmpCwd
29 from fdroidserver.exception import FDroidException
32 class CommonTest(unittest.TestCase):
33 '''fdroidserver/common.py'''
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)
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({})
48 with tempfile.TemporaryDirectory() as tmpdir, TmpCwd(tmpdir):
49 c = {'repo_keyalias': 'localhost',
50 'keystore': 'keystore.jks',
51 'keystorepass': '12345',
53 with open('keystore.jks', 'w'):
55 fdroidserver.common.assert_config_keystore(c)
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
69 print('no build-tools found: ' + build_tools)
73 for cmd in ('aapt', 'adb', 'android', 'zipalign'):
74 path = fdroidserver.common.find_sdk_tools_cmd(cmd)
76 self.assertTrue(os.path.exists(path))
77 self.assertTrue(os.path.isfile(path))
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
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
89 build_tools = os.path.join(sdk_path, 'build-tools')
90 if self._set_build_tools():
93 print('no build-tools found: ' + build_tools)
95 def test_find_java_root_path(self):
96 tmptestsdir = tempfile.mkdtemp(prefix='test_find_java_root_path', dir=self.tmpdir)
101 '/usr/lib/jvm/java-1.5.0-gcj-5-amd64',
102 '/usr/lib/jvm/java-8-openjdk-amd64',
103 '/usr/lib/jvm/java-1.8.0-openjdk-amd64',
104 ], '/usr/lib/jvm/java-8-openjdk-amd64'),
106 '/Library/Java/JavaVirtualMachines/jdk1.8.0_131.jdk',
107 '/Library/Java/JavaVirtualMachines/jdk1.8.0_45.jdk',
108 '/System/Library/Java/JavaVirtualMachines/jdk1.7.0_45.jdk',
109 ], '/Library/Java/JavaVirtualMachines/jdk1.8.0_131.jdk'),
112 for pathlist, choice in all_pathlists:
113 # strip leading / to make relative paths to test without root
114 pathlist = [p[1:] for p in pathlist]
116 # create test file used in common._add_java_paths_to_config()
118 if p.startswith('/System') or p.startswith('/Library'):
119 basedir = os.path.join(p, 'Contents', 'Home', 'bin')
121 basedir = os.path.join(p, 'bin')
123 open(os.path.join(basedir, 'javac'), 'w').close()
126 config['java_paths'] = dict()
127 fdroidserver.common._add_java_paths_to_config(pathlist, config)
128 self.assertEqual(config['java_paths']['8'], choice[1:])
130 def testIsApkDebuggable(self):
132 fdroidserver.common.fill_config_defaults(config)
133 fdroidserver.common.config = config
134 self._set_build_tools()
135 config['aapt'] = fdroidserver.common.find_sdk_tools_cmd('aapt')
136 # these are set debuggable
138 testfiles.append(os.path.join(self.basedir, 'urzip.apk'))
139 testfiles.append(os.path.join(self.basedir, 'urzip-badsig.apk'))
140 testfiles.append(os.path.join(self.basedir, 'urzip-badcert.apk'))
141 for apkfile in testfiles:
142 debuggable = fdroidserver.common.isApkAndDebuggable(apkfile)
143 self.assertTrue(debuggable,
144 "debuggable APK state was not properly parsed!")
145 # these are set NOT debuggable
147 testfiles.append(os.path.join(self.basedir, 'urzip-release.apk'))
148 testfiles.append(os.path.join(self.basedir, 'urzip-release-unsigned.apk'))
149 for apkfile in testfiles:
150 debuggable = fdroidserver.common.isApkAndDebuggable(apkfile)
151 self.assertFalse(debuggable,
152 "debuggable APK state was not properly parsed!")
154 def testPackageNameValidity(self):
155 for name in ["org.fdroid.fdroid",
156 "org.f_droid.fdr0ID"]:
157 self.assertTrue(fdroidserver.common.is_valid_package_name(name),
158 "{0} should be a valid package name".format(name))
159 for name in ["0rg.fdroid.fdroid",
162 "/org.fdroid.fdroid"]:
163 self.assertFalse(fdroidserver.common.is_valid_package_name(name),
164 "{0} should not be a valid package name".format(name))
166 def test_prepare_sources(self):
168 teststr = 'FAKE_STR_FOR_TESTING'
170 tmptestsdir = tempfile.mkdtemp(prefix='test_prepare_sources', dir=self.tmpdir)
171 shutil.copytree(os.path.join(self.basedir, 'source-files'),
172 os.path.join(tmptestsdir, 'source-files'))
174 testdir = os.path.join(tmptestsdir, 'source-files', 'fdroid', 'fdroidclient')
177 config['sdk_path'] = os.getenv('ANDROID_HOME')
178 config['ndk_paths'] = {'r10d': os.getenv('ANDROID_NDK_HOME')}
179 config['build_tools'] = 'FAKE_BUILD_TOOLS_VERSION'
180 fdroidserver.common.config = config
181 app = fdroidserver.metadata.App()
182 app.id = 'org.fdroid.froid'
183 build = fdroidserver.metadata.Build()
184 build.commit = 'master'
185 build.forceversion = True
186 build.forcevercode = True
187 build.gradle = ['yes']
188 build.target = 'android-' + str(testint)
189 build.versionName = teststr
190 build.versionCode = testint
193 # no need to change to the correct commit here
194 def gotorevision(self, rev, refresh=True):
197 # no srclib info needed, but it could be added...
201 fdroidserver.common.prepare_source(FakeVcs(), app, build, testdir, testdir, testdir)
203 with open(os.path.join(testdir, 'build.gradle'), 'r') as f:
205 self.assertIsNotNone(re.search("\s+compileSdkVersion %s\s+" % testint, filedata))
207 with open(os.path.join(testdir, 'AndroidManifest.xml')) as f:
209 self.assertIsNone(re.search('android:debuggable', filedata))
210 self.assertIsNotNone(re.search('android:versionName="%s"' % build.versionName, filedata))
211 self.assertIsNotNone(re.search('android:versionCode="%s"' % build.versionCode, filedata))
213 def test_prepare_sources_refresh(self):
214 packageName = 'org.fdroid.ci.test.app'
215 testdir = tempfile.mkdtemp(prefix='test_prepare_sources_refresh', dir=self.tmpdir)
216 print('testdir', testdir)
221 # use a local copy if available to avoid hitting the network
222 tmprepo = os.path.join(self.basedir, 'tmp', 'importer')
223 if os.path.exists(tmprepo):
226 git_url = 'https://gitlab.com/fdroid/ci-test-app.git'
229 metadata['Description'] = 'This is just a test app'
230 metadata['RepoType'] = 'git'
231 metadata['Repo'] = git_url
232 with open(os.path.join('metadata', packageName + '.yml'), 'w') as fp:
233 yaml.dump(metadata, fp)
235 gitrepo = os.path.join(testdir, 'build', packageName)
236 vcs0 = fdroidserver.common.getvcs('git', git_url, gitrepo)
237 vcs0.gotorevision('0.3', refresh=True)
238 vcs1 = fdroidserver.common.getvcs('git', git_url, gitrepo)
239 vcs1.gotorevision('0.3', refresh=False)
241 def test_fdroid_popen_stderr_redirect(self):
243 fdroidserver.common.fill_config_defaults(config)
244 fdroidserver.common.config = config
246 commands = ['sh', '-c', 'echo stdout message && echo stderr message 1>&2']
248 p = fdroidserver.common.FDroidPopen(commands)
249 self.assertEqual(p.output, 'stdout message\nstderr message\n')
251 p = fdroidserver.common.FDroidPopen(commands, stderr_to_stdout=False)
252 self.assertEqual(p.output, 'stdout message\n')
254 def test_signjar(self):
255 fdroidserver.common.config = None
256 config = fdroidserver.common.read_config(fdroidserver.common.options)
257 config['jarsigner'] = fdroidserver.common.find_sdk_tools_cmd('jarsigner')
258 fdroidserver.common.config = config
259 fdroidserver.signindex.config = config
261 sourcedir = os.path.join(self.basedir, 'signindex')
262 testsdir = tempfile.mkdtemp(prefix='test_signjar', dir=self.tmpdir)
263 for f in ('testy.jar', 'guardianproject.jar',):
264 sourcefile = os.path.join(sourcedir, f)
265 testfile = os.path.join(testsdir, f)
266 shutil.copy(sourcefile, testsdir)
267 fdroidserver.signindex.sign_jar(testfile)
268 # these should be resigned, and therefore different
269 self.assertNotEqual(open(sourcefile, 'rb').read(), open(testfile, 'rb').read())
271 def test_verify_apk_signature(self):
272 fdroidserver.common.config = None
273 config = fdroidserver.common.read_config(fdroidserver.common.options)
274 config['jarsigner'] = fdroidserver.common.find_sdk_tools_cmd('jarsigner')
275 fdroidserver.common.config = config
277 self.assertTrue(fdroidserver.common.verify_apk_signature('urzip.apk'))
278 self.assertFalse(fdroidserver.common.verify_apk_signature('urzip-badcert.apk'))
279 self.assertFalse(fdroidserver.common.verify_apk_signature('urzip-badsig.apk'))
280 self.assertTrue(fdroidserver.common.verify_apk_signature('urzip-release.apk'))
281 self.assertFalse(fdroidserver.common.verify_apk_signature('urzip-release-unsigned.apk'))
283 def test_verify_apks(self):
284 fdroidserver.common.config = None
285 config = fdroidserver.common.read_config(fdroidserver.common.options)
286 config['jarsigner'] = fdroidserver.common.find_sdk_tools_cmd('jarsigner')
287 fdroidserver.common.config = config
289 sourceapk = os.path.join(self.basedir, 'urzip.apk')
291 testdir = tempfile.mkdtemp(prefix='test_verify_apks', dir=self.tmpdir)
292 print('testdir', testdir)
294 copyapk = os.path.join(testdir, 'urzip-copy.apk')
295 shutil.copy(sourceapk, copyapk)
296 self.assertTrue(fdroidserver.common.verify_apk_signature(copyapk))
297 self.assertIsNone(fdroidserver.common.verify_apks(sourceapk, copyapk, self.tmpdir))
299 unsignedapk = os.path.join(testdir, 'urzip-unsigned.apk')
300 with ZipFile(sourceapk, 'r') as apk:
301 with ZipFile(unsignedapk, 'w') as testapk:
302 for info in apk.infolist():
303 if not info.filename.startswith('META-INF/'):
304 testapk.writestr(info, apk.read(info.filename))
305 self.assertIsNone(fdroidserver.common.verify_apks(sourceapk, unsignedapk, self.tmpdir))
307 twosigapk = os.path.join(testdir, 'urzip-twosig.apk')
308 otherapk = ZipFile(os.path.join(self.basedir, 'urzip-release.apk'), 'r')
309 with ZipFile(sourceapk, 'r') as apk:
310 with ZipFile(twosigapk, 'w') as testapk:
311 for info in apk.infolist():
312 testapk.writestr(info, apk.read(info.filename))
313 if info.filename.startswith('META-INF/'):
314 testapk.writestr(info, otherapk.read(info.filename))
316 self.assertFalse(fdroidserver.common.verify_apk_signature(twosigapk))
317 self.assertIsNone(fdroidserver.common.verify_apks(sourceapk, twosigapk, self.tmpdir))
319 def test_write_to_config(self):
320 with tempfile.TemporaryDirectory() as tmpPath:
321 cfgPath = os.path.join(tmpPath, 'config.py')
322 with open(cfgPath, 'w', encoding='utf-8') as f:
323 f.write(textwrap.dedent("""\
325 # test = 'example value'
329 do_not_touch = "good value"
332 key="123" # inline"""))
334 cfg = {'key': '111', 'default_me_orig': 'orig'}
335 fdroidserver.common.write_to_config(cfg, 'key', config_file=cfgPath)
336 fdroidserver.common.write_to_config(cfg, 'default_me', config_file=cfgPath)
337 fdroidserver.common.write_to_config(cfg, 'test', value='test value', config_file=cfgPath)
338 fdroidserver.common.write_to_config(cfg, 'new_key', value='new', config_file=cfgPath)
340 with open(cfgPath, 'r', encoding='utf-8') as f:
341 self.assertEqual(f.read(), textwrap.dedent("""\
347 do_not_touch = "good value"
354 def test_write_to_config_when_empty(self):
355 with tempfile.TemporaryDirectory() as tmpPath:
356 cfgPath = os.path.join(tmpPath, 'config.py')
357 with open(cfgPath, 'w') as f:
359 fdroidserver.common.write_to_config({}, 'key', 'val', cfgPath)
360 with open(cfgPath, 'r', encoding='utf-8') as f:
361 self.assertEqual(f.read(), textwrap.dedent("""\
366 def test_apk_name_regex(self):
368 'urzipπÇÇπÇÇ现代汉语通用字българскиعربي1234ö_-123456.apk',
369 'urzipπÇÇπÇÇ现代汉语通用字българскиعربي1234ö_123456_abcdef0.apk',
374 'a_a_a_a_0_abcdef0.apk',
376 'a_____123456_abcdef0.apk',
377 'org.fdroid.fdroid_123456.apk',
378 # valid, but "_99999" is part of packageName rather than versionCode
379 'org.fdroid.fdroid_99999_123456.apk',
380 # should be valid, but I can't figure out the regex since \w includes digits
381 # 'πÇÇπÇÇ现代汉语通用字българскиعربي1234ö_0_123bafd.apk',
384 m = fdroidserver.common.APK_NAME_REGEX.match(name)
385 self.assertIsNotNone(m)
386 self.assertIn(m.group(2), ('-123456', '0', '123456'))
387 self.assertIn(m.group(3), ('abcdef0', None))
390 'urzipπÇÇπÇÇ现代汉语通用字българскиعربي1234ö_123456_abcdefg.apk',
391 'urzip-_-198274.apk',
392 'urzip-_0_123bafd.apk',
393 'no spaces allowed_123.apk',
398 self.assertIsNone(fdroidserver.common.APK_NAME_REGEX.match(name))
400 def test_standard_file_name_regex(self):
402 'urzipπÇÇπÇÇ现代汉语通用字българскиعربي1234ö_-123456.mp3',
403 'urzipπÇÇπÇÇ现代汉语通用字българскиعربي1234ö_123456.mov',
404 'Document_-123456.pdf',
408 'org.fdroid.fdroid.privileged.ota_123456.zip',
409 'πÇÇπÇÇ现代汉语通用字българскиعربي1234ö_0.jpeg',
411 # valid, but "_99999" is part of packageName rather than versionCode
412 'a_____99999_123456.zip',
413 'org.fdroid.fdroid_99999_123456.zip',
416 m = fdroidserver.common.STANDARD_FILE_NAME_REGEX.match(name)
417 self.assertIsNotNone(m)
418 self.assertIn(m.group(2), ('-123456', '0', '123456'))
421 'urzipπÇÇπÇÇ现代汉语通用字българскиعربي1234ö_abcdefg.JPEG',
422 'urzip-_-198274.zip',
423 'urzip-_123bafd.pdf',
424 'no spaces allowed_123.foobar',
428 self.assertIsNone(fdroidserver.common.STANDARD_FILE_NAME_REGEX.match(name))
430 def test_apk_signer_fingerprint(self):
432 # fingerprints fetched with: keytool -printcert -file ____.RSA
433 testapks = (('repo/obb.main.oldversion_1444412523.apk',
434 '818e469465f96b704e27be2fee4c63ab9f83ddf30e7a34c7371a4728d83b0bc1'),
435 ('repo/obb.main.twoversions_1101613.apk',
436 '32a23624c201b949f085996ba5ed53d40f703aca4989476949cae891022e0ed6'),
437 ('repo/obb.main.twoversions_1101617.apk',
438 '32a23624c201b949f085996ba5ed53d40f703aca4989476949cae891022e0ed6'))
440 for apkfile, keytoolcertfingerprint in testapks:
441 self.assertEqual(keytoolcertfingerprint,
442 fdroidserver.common.apk_signer_fingerprint(apkfile))
444 def test_apk_signer_fingerprint_short(self):
446 # fingerprints fetched with: keytool -printcert -file ____.RSA
447 testapks = (('repo/obb.main.oldversion_1444412523.apk', '818e469'),
448 ('repo/obb.main.twoversions_1101613.apk', '32a2362'),
449 ('repo/obb.main.twoversions_1101617.apk', '32a2362'))
451 for apkfile, keytoolcertfingerprint in testapks:
452 self.assertEqual(keytoolcertfingerprint,
453 fdroidserver.common.apk_signer_fingerprint_short(apkfile))
455 def test_get_api_id_aapt(self):
458 fdroidserver.common.fill_config_defaults(config)
459 fdroidserver.common.config = config
460 self._set_build_tools()
461 config['aapt'] = fdroidserver.common.find_sdk_tools_cmd('aapt')
463 appid, vercode, vername = fdroidserver.common.get_apk_id_aapt('repo/obb.main.twoversions_1101613.apk')
464 self.assertEqual('obb.main.twoversions', appid)
465 self.assertEqual('1101613', vercode)
466 self.assertEqual('0.1', vername)
468 with self.assertRaises(FDroidException):
469 fdroidserver.common.get_apk_id_aapt('nope')
471 def test_apk_release_name(self):
472 appid, vercode, sigfp = fdroidserver.common.apk_parse_release_filename('com.serwylo.lexica_905.apk')
473 self.assertEqual(appid, 'com.serwylo.lexica')
474 self.assertEqual(vercode, '905')
475 self.assertEqual(sigfp, None)
477 appid, vercode, sigfp = fdroidserver.common.apk_parse_release_filename('com.serwylo.lexica_905_c82e0f6.apk')
478 self.assertEqual(appid, 'com.serwylo.lexica')
479 self.assertEqual(vercode, '905')
480 self.assertEqual(sigfp, 'c82e0f6')
482 appid, vercode, sigfp = fdroidserver.common.apk_parse_release_filename('beverly_hills-90210.apk')
483 self.assertEqual(appid, None)
484 self.assertEqual(vercode, None)
485 self.assertEqual(sigfp, None)
487 def test_metadata_find_developer_signature(self):
488 sig = fdroidserver.common.metadata_find_developer_signature('org.smssecure.smssecure')
489 self.assertEqual('b30bb971af0d134866e158ec748fcd553df97c150f58b0a963190bbafbeb0868', sig)
492 if __name__ == "__main__":
493 parser = optparse.OptionParser()
494 parser.add_option("-v", "--verbose", action="store_true", default=False,
495 help="Spew out even more information than normal")
496 (fdroidserver.common.options, args) = parser.parse_args(['--verbose'])
498 newSuite = unittest.TestSuite()
499 newSuite.addTest(unittest.makeSuite(CommonTest))
500 unittest.main(failfast=False)