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 tools = ['aapt', 'adb', 'zipalign']
74 if os.path.exists(os.path.join(os.getenv('ANDROID_HOME'), 'tools', 'android')):
75 tools.append('android')
77 path = fdroidserver.common.find_sdk_tools_cmd(cmd)
79 self.assertTrue(os.path.exists(path))
80 self.assertTrue(os.path.isfile(path))
82 def test_find_sdk_tools_cmd(self):
83 fdroidserver.common.config = dict()
84 # TODO add this once everything works without sdk_path set in config
86 sdk_path = os.getenv('ANDROID_HOME')
87 if os.path.exists(sdk_path):
88 fdroidserver.common.config['sdk_path'] = sdk_path
89 if os.path.exists('/usr/bin/aapt'):
90 # this test only works when /usr/bin/aapt is installed
92 build_tools = os.path.join(sdk_path, 'build-tools')
93 if self._set_build_tools():
96 print('no build-tools found: ' + build_tools)
98 def test_find_java_root_path(self):
99 testdir = tempfile.mkdtemp(prefix=inspect.currentframe().f_code.co_name, dir=self.tmpdir)
104 '/usr/lib/jvm/java-1.5.0-gcj-5-amd64',
105 '/usr/lib/jvm/java-8-openjdk-amd64',
106 '/usr/lib/jvm/java-1.8.0-openjdk-amd64',
107 ], '/usr/lib/jvm/java-8-openjdk-amd64'),
109 '/Library/Java/JavaVirtualMachines/jdk1.8.0_131.jdk',
110 '/Library/Java/JavaVirtualMachines/jdk1.8.0_45.jdk',
111 '/System/Library/Java/JavaVirtualMachines/jdk1.7.0_45.jdk',
112 ], '/Library/Java/JavaVirtualMachines/jdk1.8.0_131.jdk'),
115 for pathlist, choice in all_pathlists:
116 # strip leading / to make relative paths to test without root
117 pathlist = [p[1:] for p in pathlist]
119 # create test file used in common._add_java_paths_to_config()
121 if p.startswith('/System') or p.startswith('/Library'):
122 basedir = os.path.join(p, 'Contents', 'Home', 'bin')
124 basedir = os.path.join(p, 'bin')
126 open(os.path.join(basedir, 'javac'), 'w').close()
129 config['java_paths'] = dict()
130 fdroidserver.common._add_java_paths_to_config(pathlist, config)
131 self.assertEqual(config['java_paths']['8'], choice[1:])
133 def testIsApkDebuggable(self):
135 fdroidserver.common.fill_config_defaults(config)
136 fdroidserver.common.config = config
137 self._set_build_tools()
138 config['aapt'] = fdroidserver.common.find_sdk_tools_cmd('aapt')
139 # these are set debuggable
141 testfiles.append(os.path.join(self.basedir, 'urzip.apk'))
142 testfiles.append(os.path.join(self.basedir, 'urzip-badsig.apk'))
143 testfiles.append(os.path.join(self.basedir, 'urzip-badcert.apk'))
144 for apkfile in testfiles:
145 debuggable = fdroidserver.common.isApkAndDebuggable(apkfile)
146 self.assertTrue(debuggable,
147 "debuggable APK state was not properly parsed!")
148 # these are set NOT debuggable
150 testfiles.append(os.path.join(self.basedir, 'urzip-release.apk'))
151 testfiles.append(os.path.join(self.basedir, 'urzip-release-unsigned.apk'))
152 for apkfile in testfiles:
153 debuggable = fdroidserver.common.isApkAndDebuggable(apkfile)
154 self.assertFalse(debuggable,
155 "debuggable APK state was not properly parsed!")
157 def testPackageNameValidity(self):
158 for name in ["org.fdroid.fdroid",
159 "org.f_droid.fdr0ID"]:
160 self.assertTrue(fdroidserver.common.is_valid_package_name(name),
161 "{0} should be a valid package name".format(name))
162 for name in ["0rg.fdroid.fdroid",
165 "/org.fdroid.fdroid"]:
166 self.assertFalse(fdroidserver.common.is_valid_package_name(name),
167 "{0} should not be a valid package name".format(name))
169 def test_prepare_sources(self):
171 teststr = 'FAKE_STR_FOR_TESTING'
173 testdir = tempfile.mkdtemp(prefix=inspect.currentframe().f_code.co_name, dir=self.tmpdir)
174 shutil.copytree(os.path.join(self.basedir, 'source-files'),
175 os.path.join(testdir, 'source-files'))
177 fdroidclient_testdir = os.path.join(testdir, 'source-files', 'fdroid', 'fdroidclient')
180 config['sdk_path'] = os.getenv('ANDROID_HOME')
181 config['ndk_paths'] = {'r10d': os.getenv('ANDROID_NDK_HOME')}
182 config['build_tools'] = 'FAKE_BUILD_TOOLS_VERSION'
183 fdroidserver.common.config = config
184 app = fdroidserver.metadata.App()
185 app.id = 'org.fdroid.froid'
186 build = fdroidserver.metadata.Build()
187 build.commit = 'master'
188 build.forceversion = True
189 build.forcevercode = True
190 build.gradle = ['yes']
191 build.target = 'android-' + str(testint)
192 build.versionName = teststr
193 build.versionCode = testint
196 # no need to change to the correct commit here
197 def gotorevision(self, rev, refresh=True):
200 # no srclib info needed, but it could be added...
204 fdroidserver.common.prepare_source(FakeVcs(), app, build,
205 fdroidclient_testdir, fdroidclient_testdir, fdroidclient_testdir)
207 with open(os.path.join(fdroidclient_testdir, 'build.gradle'), 'r') as f:
209 self.assertIsNotNone(re.search("\s+compileSdkVersion %s\s+" % testint, filedata))
211 with open(os.path.join(fdroidclient_testdir, 'AndroidManifest.xml')) as f:
213 self.assertIsNone(re.search('android:debuggable', filedata))
214 self.assertIsNotNone(re.search('android:versionName="%s"' % build.versionName, filedata))
215 self.assertIsNotNone(re.search('android:versionCode="%s"' % build.versionCode, filedata))
217 def test_prepare_sources_refresh(self):
218 packageName = 'org.fdroid.ci.test.app'
219 testdir = tempfile.mkdtemp(prefix=inspect.currentframe().f_code.co_name, dir=self.tmpdir)
220 print('testdir', testdir)
225 # use a local copy if available to avoid hitting the network
226 tmprepo = os.path.join(self.basedir, 'tmp', 'importer')
227 if os.path.exists(tmprepo):
230 git_url = 'https://gitlab.com/fdroid/ci-test-app.git'
233 metadata['Description'] = 'This is just a test app'
234 metadata['RepoType'] = 'git'
235 metadata['Repo'] = git_url
236 with open(os.path.join('metadata', packageName + '.yml'), 'w') as fp:
237 yaml.dump(metadata, fp)
239 gitrepo = os.path.join(testdir, 'build', packageName)
240 vcs0 = fdroidserver.common.getvcs('git', git_url, gitrepo)
241 vcs0.gotorevision('0.3', refresh=True)
242 vcs1 = fdroidserver.common.getvcs('git', git_url, gitrepo)
243 vcs1.gotorevision('0.3', refresh=False)
245 def test_fdroid_popen_stderr_redirect(self):
247 fdroidserver.common.fill_config_defaults(config)
248 fdroidserver.common.config = config
250 commands = ['sh', '-c', 'echo stdout message && echo stderr message 1>&2']
252 p = fdroidserver.common.FDroidPopen(commands)
253 self.assertEqual(p.output, 'stdout message\nstderr message\n')
255 p = fdroidserver.common.FDroidPopen(commands, stderr_to_stdout=False)
256 self.assertEqual(p.output, 'stdout message\n')
258 def test_signjar(self):
259 fdroidserver.common.config = None
260 config = fdroidserver.common.read_config(fdroidserver.common.options)
261 config['jarsigner'] = fdroidserver.common.find_sdk_tools_cmd('jarsigner')
262 fdroidserver.common.config = config
263 fdroidserver.signindex.config = config
265 sourcedir = os.path.join(self.basedir, 'signindex')
266 testsdir = tempfile.mkdtemp(prefix=inspect.currentframe().f_code.co_name, dir=self.tmpdir)
267 for f in ('testy.jar', 'guardianproject.jar',):
268 sourcefile = os.path.join(sourcedir, f)
269 testfile = os.path.join(testsdir, f)
270 shutil.copy(sourcefile, testsdir)
271 fdroidserver.signindex.sign_jar(testfile)
272 # these should be resigned, and therefore different
273 self.assertNotEqual(open(sourcefile, 'rb').read(), open(testfile, 'rb').read())
275 def test_verify_apk_signature(self):
276 fdroidserver.common.config = None
277 config = fdroidserver.common.read_config(fdroidserver.common.options)
278 config['jarsigner'] = fdroidserver.common.find_sdk_tools_cmd('jarsigner')
279 fdroidserver.common.config = config
281 self.assertTrue(fdroidserver.common.verify_apk_signature('urzip.apk'))
282 self.assertFalse(fdroidserver.common.verify_apk_signature('urzip-badcert.apk'))
283 self.assertFalse(fdroidserver.common.verify_apk_signature('urzip-badsig.apk'))
284 self.assertTrue(fdroidserver.common.verify_apk_signature('urzip-release.apk'))
285 self.assertFalse(fdroidserver.common.verify_apk_signature('urzip-release-unsigned.apk'))
287 def test_verify_apks(self):
288 fdroidserver.common.config = None
289 config = fdroidserver.common.read_config(fdroidserver.common.options)
290 config['jarsigner'] = fdroidserver.common.find_sdk_tools_cmd('jarsigner')
291 fdroidserver.common.config = config
293 sourceapk = os.path.join(self.basedir, 'urzip.apk')
295 testdir = tempfile.mkdtemp(prefix=inspect.currentframe().f_code.co_name, dir=self.tmpdir)
296 print('testdir', testdir)
298 copyapk = os.path.join(testdir, 'urzip-copy.apk')
299 shutil.copy(sourceapk, copyapk)
300 self.assertTrue(fdroidserver.common.verify_apk_signature(copyapk))
301 self.assertIsNone(fdroidserver.common.verify_apks(sourceapk, copyapk, self.tmpdir))
303 unsignedapk = os.path.join(testdir, 'urzip-unsigned.apk')
304 with ZipFile(sourceapk, 'r') as apk:
305 with ZipFile(unsignedapk, 'w') as testapk:
306 for info in apk.infolist():
307 if not info.filename.startswith('META-INF/'):
308 testapk.writestr(info, apk.read(info.filename))
309 self.assertIsNone(fdroidserver.common.verify_apks(sourceapk, unsignedapk, self.tmpdir))
311 twosigapk = os.path.join(testdir, 'urzip-twosig.apk')
312 otherapk = ZipFile(os.path.join(self.basedir, 'urzip-release.apk'), 'r')
313 with ZipFile(sourceapk, 'r') as apk:
314 with ZipFile(twosigapk, 'w') as testapk:
315 for info in apk.infolist():
316 testapk.writestr(info, apk.read(info.filename))
317 if info.filename.startswith('META-INF/'):
318 testapk.writestr(info, otherapk.read(info.filename))
320 self.assertFalse(fdroidserver.common.verify_apk_signature(twosigapk))
321 self.assertIsNone(fdroidserver.common.verify_apks(sourceapk, twosigapk, self.tmpdir))
323 def test_write_to_config(self):
324 with tempfile.TemporaryDirectory() as tmpPath:
325 cfgPath = os.path.join(tmpPath, 'config.py')
326 with open(cfgPath, 'w', encoding='utf-8') as f:
327 f.write(textwrap.dedent("""\
329 # test = 'example value'
333 do_not_touch = "good value"
336 key="123" # inline"""))
338 cfg = {'key': '111', 'default_me_orig': 'orig'}
339 fdroidserver.common.write_to_config(cfg, 'key', config_file=cfgPath)
340 fdroidserver.common.write_to_config(cfg, 'default_me', config_file=cfgPath)
341 fdroidserver.common.write_to_config(cfg, 'test', value='test value', config_file=cfgPath)
342 fdroidserver.common.write_to_config(cfg, 'new_key', value='new', config_file=cfgPath)
344 with open(cfgPath, 'r', encoding='utf-8') as f:
345 self.assertEqual(f.read(), textwrap.dedent("""\
351 do_not_touch = "good value"
358 def test_write_to_config_when_empty(self):
359 with tempfile.TemporaryDirectory() as tmpPath:
360 cfgPath = os.path.join(tmpPath, 'config.py')
361 with open(cfgPath, 'w') as f:
363 fdroidserver.common.write_to_config({}, 'key', 'val', cfgPath)
364 with open(cfgPath, 'r', encoding='utf-8') as f:
365 self.assertEqual(f.read(), textwrap.dedent("""\
370 def test_apk_name_regex(self):
372 'urzipπÇÇπÇÇ现代汉语通用字българскиعربي1234ö_-123456.apk',
373 'urzipπÇÇπÇÇ现代汉语通用字българскиعربي1234ö_123456_abcdef0.apk',
378 'a_a_a_a_0_abcdef0.apk',
380 'a_____123456_abcdef0.apk',
381 'org.fdroid.fdroid_123456.apk',
382 # valid, but "_99999" is part of packageName rather than versionCode
383 'org.fdroid.fdroid_99999_123456.apk',
384 # should be valid, but I can't figure out the regex since \w includes digits
385 # 'πÇÇπÇÇ现代汉语通用字българскиعربي1234ö_0_123bafd.apk',
388 m = fdroidserver.common.APK_NAME_REGEX.match(name)
389 self.assertIsNotNone(m)
390 self.assertIn(m.group(2), ('-123456', '0', '123456'))
391 self.assertIn(m.group(3), ('abcdef0', None))
394 'urzipπÇÇπÇÇ现代汉语通用字българскиعربي1234ö_123456_abcdefg.apk',
395 'urzip-_-198274.apk',
396 'urzip-_0_123bafd.apk',
397 'no spaces allowed_123.apk',
402 self.assertIsNone(fdroidserver.common.APK_NAME_REGEX.match(name))
404 def test_standard_file_name_regex(self):
406 'urzipπÇÇπÇÇ现代汉语通用字българскиعربي1234ö_-123456.mp3',
407 'urzipπÇÇπÇÇ现代汉语通用字българскиعربي1234ö_123456.mov',
408 'Document_-123456.pdf',
412 'org.fdroid.fdroid.privileged.ota_123456.zip',
413 'πÇÇπÇÇ现代汉语通用字българскиعربي1234ö_0.jpeg',
415 # valid, but "_99999" is part of packageName rather than versionCode
416 'a_____99999_123456.zip',
417 'org.fdroid.fdroid_99999_123456.zip',
420 m = fdroidserver.common.STANDARD_FILE_NAME_REGEX.match(name)
421 self.assertIsNotNone(m)
422 self.assertIn(m.group(2), ('-123456', '0', '123456'))
425 'urzipπÇÇπÇÇ现代汉语通用字българскиعربي1234ö_abcdefg.JPEG',
426 'urzip-_-198274.zip',
427 'urzip-_123bafd.pdf',
428 'no spaces allowed_123.foobar',
432 self.assertIsNone(fdroidserver.common.STANDARD_FILE_NAME_REGEX.match(name))
434 def test_apk_signer_fingerprint(self):
436 # fingerprints fetched with: keytool -printcert -file ____.RSA
437 testapks = (('repo/obb.main.oldversion_1444412523.apk',
438 '818e469465f96b704e27be2fee4c63ab9f83ddf30e7a34c7371a4728d83b0bc1'),
439 ('repo/obb.main.twoversions_1101613.apk',
440 '32a23624c201b949f085996ba5ed53d40f703aca4989476949cae891022e0ed6'),
441 ('repo/obb.main.twoversions_1101617.apk',
442 '32a23624c201b949f085996ba5ed53d40f703aca4989476949cae891022e0ed6'))
444 for apkfile, keytoolcertfingerprint in testapks:
445 self.assertEqual(keytoolcertfingerprint,
446 fdroidserver.common.apk_signer_fingerprint(apkfile))
448 def test_apk_signer_fingerprint_short(self):
450 # fingerprints fetched with: keytool -printcert -file ____.RSA
451 testapks = (('repo/obb.main.oldversion_1444412523.apk', '818e469'),
452 ('repo/obb.main.twoversions_1101613.apk', '32a2362'),
453 ('repo/obb.main.twoversions_1101617.apk', '32a2362'))
455 for apkfile, keytoolcertfingerprint in testapks:
456 self.assertEqual(keytoolcertfingerprint,
457 fdroidserver.common.apk_signer_fingerprint_short(apkfile))
459 def test_get_api_id_aapt(self):
462 fdroidserver.common.fill_config_defaults(config)
463 fdroidserver.common.config = config
464 self._set_build_tools()
465 config['aapt'] = fdroidserver.common.find_sdk_tools_cmd('aapt')
467 appid, vercode, vername = fdroidserver.common.get_apk_id_aapt('repo/obb.main.twoversions_1101613.apk')
468 self.assertEqual('obb.main.twoversions', appid)
469 self.assertEqual('1101613', vercode)
470 self.assertEqual('0.1', vername)
472 with self.assertRaises(FDroidException):
473 fdroidserver.common.get_apk_id_aapt('nope')
475 def test_apk_release_name(self):
476 appid, vercode, sigfp = fdroidserver.common.apk_parse_release_filename('com.serwylo.lexica_905.apk')
477 self.assertEqual(appid, 'com.serwylo.lexica')
478 self.assertEqual(vercode, '905')
479 self.assertEqual(sigfp, None)
481 appid, vercode, sigfp = fdroidserver.common.apk_parse_release_filename('com.serwylo.lexica_905_c82e0f6.apk')
482 self.assertEqual(appid, 'com.serwylo.lexica')
483 self.assertEqual(vercode, '905')
484 self.assertEqual(sigfp, 'c82e0f6')
486 appid, vercode, sigfp = fdroidserver.common.apk_parse_release_filename('beverly_hills-90210.apk')
487 self.assertEqual(appid, None)
488 self.assertEqual(vercode, None)
489 self.assertEqual(sigfp, None)
491 def test_metadata_find_developer_signature(self):
492 sig = fdroidserver.common.metadata_find_developer_signature('org.smssecure.smssecure')
493 self.assertEqual('b30bb971af0d134866e158ec748fcd553df97c150f58b0a963190bbafbeb0868', sig)
495 def test_parse_androidmanifests(self):
496 source_files_dir = os.path.join(os.path.dirname(__file__), 'source-files')
497 app = fdroidserver.metadata.App()
498 app.id = 'org.fdroid.fdroid'
500 os.path.join(source_files_dir, 'fdroid', 'fdroidclient', 'AndroidManifest.xml'),
501 os.path.join(source_files_dir, 'fdroid', 'fdroidclient', 'build.gradle'),
504 self.assertTrue(os.path.isfile(path))
505 self.assertEqual(('0.94-test', '940', 'org.fdroid.fdroid'),
506 fdroidserver.common.parse_androidmanifests(paths, app))
508 def test_parse_androidmanifests_with_flavor(self):
509 source_files_dir = os.path.join(os.path.dirname(__file__), 'source-files')
510 app = fdroidserver.metadata.App()
511 build = fdroidserver.metadata.Build()
512 build.gradle = ['devVersion']
514 app.id = 'org.fdroid.fdroid.dev'
516 os.path.join(source_files_dir, 'fdroid', 'fdroidclient', 'AndroidManifest.xml'),
517 os.path.join(source_files_dir, 'fdroid', 'fdroidclient', 'build.gradle'),
520 self.assertTrue(os.path.isfile(path))
521 self.assertEqual(('0.95-dev', '949', 'org.fdroid.fdroid.dev'),
522 fdroidserver.common.parse_androidmanifests(paths, app))
525 if __name__ == "__main__":
526 parser = optparse.OptionParser()
527 parser.add_option("-v", "--verbose", action="store_true", default=False,
528 help="Spew out even more information than normal")
529 (fdroidserver.common.options, args) = parser.parse_args(['--verbose'])
531 newSuite = unittest.TestSuite()
532 newSuite.addTest(unittest.makeSuite(CommonTest))
533 unittest.main(failfast=False)