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
30 class CommonTest(unittest.TestCase):
31 '''fdroidserver/common.py'''
34 logging.basicConfig(level=logging.DEBUG)
35 self.basedir = os.path.join(localmodule, 'tests')
36 self.tmpdir = os.path.abspath(os.path.join(self.basedir, '..', '.testfiles'))
37 if not os.path.exists(self.tmpdir):
38 os.makedirs(self.tmpdir)
39 os.chdir(self.basedir)
41 def _set_build_tools(self):
42 build_tools = os.path.join(fdroidserver.common.config['sdk_path'], 'build-tools')
43 if os.path.exists(build_tools):
44 fdroidserver.common.config['build_tools'] = ''
45 for f in sorted(os.listdir(build_tools), reverse=True):
46 versioned = os.path.join(build_tools, f)
47 if os.path.isdir(versioned) \
48 and os.path.isfile(os.path.join(versioned, 'aapt')):
49 fdroidserver.common.config['build_tools'] = versioned
53 print('no build-tools found: ' + build_tools)
57 for cmd in ('aapt', 'adb', 'android', 'zipalign'):
58 path = fdroidserver.common.find_sdk_tools_cmd(cmd)
60 self.assertTrue(os.path.exists(path))
61 self.assertTrue(os.path.isfile(path))
63 def test_find_sdk_tools_cmd(self):
64 fdroidserver.common.config = dict()
65 # TODO add this once everything works without sdk_path set in config
67 sdk_path = os.getenv('ANDROID_HOME')
68 if os.path.exists(sdk_path):
69 fdroidserver.common.config['sdk_path'] = sdk_path
70 if os.path.exists('/usr/bin/aapt'):
71 # this test only works when /usr/bin/aapt is installed
73 build_tools = os.path.join(sdk_path, 'build-tools')
74 if self._set_build_tools():
77 print('no build-tools found: ' + build_tools)
79 def testIsApkDebuggable(self):
81 fdroidserver.common.fill_config_defaults(config)
82 fdroidserver.common.config = config
83 self._set_build_tools()
84 config['aapt'] = fdroidserver.common.find_sdk_tools_cmd('aapt')
85 # these are set debuggable
87 testfiles.append(os.path.join(self.basedir, 'urzip.apk'))
88 testfiles.append(os.path.join(self.basedir, 'urzip-badsig.apk'))
89 testfiles.append(os.path.join(self.basedir, 'urzip-badcert.apk'))
90 for apkfile in testfiles:
91 debuggable = fdroidserver.common.isApkAndDebuggable(apkfile)
92 self.assertTrue(debuggable,
93 "debuggable APK state was not properly parsed!")
94 # these are set NOT debuggable
96 testfiles.append(os.path.join(self.basedir, 'urzip-release.apk'))
97 testfiles.append(os.path.join(self.basedir, 'urzip-release-unsigned.apk'))
98 for apkfile in testfiles:
99 debuggable = fdroidserver.common.isApkAndDebuggable(apkfile)
100 self.assertFalse(debuggable,
101 "debuggable APK state was not properly parsed!")
103 def testPackageNameValidity(self):
104 for name in ["org.fdroid.fdroid",
105 "org.f_droid.fdr0ID"]:
106 self.assertTrue(fdroidserver.common.is_valid_package_name(name),
107 "{0} should be a valid package name".format(name))
108 for name in ["0rg.fdroid.fdroid",
111 "/org.fdroid.fdroid"]:
112 self.assertFalse(fdroidserver.common.is_valid_package_name(name),
113 "{0} should not be a valid package name".format(name))
115 def test_prepare_sources(self):
117 teststr = 'FAKE_STR_FOR_TESTING'
119 tmptestsdir = tempfile.mkdtemp(prefix='test_prepare_sources', dir=self.tmpdir)
120 shutil.copytree(os.path.join(self.basedir, 'source-files'),
121 os.path.join(tmptestsdir, 'source-files'))
123 testdir = os.path.join(tmptestsdir, 'source-files', 'fdroid', 'fdroidclient')
126 config['sdk_path'] = os.getenv('ANDROID_HOME')
127 config['ndk_paths'] = {'r10d': os.getenv('ANDROID_NDK_HOME')}
128 config['build_tools'] = 'FAKE_BUILD_TOOLS_VERSION'
129 fdroidserver.common.config = config
130 app = fdroidserver.metadata.App()
131 app.id = 'org.fdroid.froid'
132 build = fdroidserver.metadata.Build()
133 build.commit = 'master'
134 build.forceversion = True
135 build.forcevercode = True
136 build.gradle = ['yes']
137 build.target = 'android-' + str(testint)
138 build.versionName = teststr
139 build.versionCode = testint
142 # no need to change to the correct commit here
143 def gotorevision(self, rev, refresh=True):
146 # no srclib info needed, but it could be added...
150 fdroidserver.common.prepare_source(FakeVcs(), app, build, testdir, testdir, testdir)
152 with open(os.path.join(testdir, 'build.gradle'), 'r') as f:
154 self.assertIsNotNone(re.search("\s+compileSdkVersion %s\s+" % testint, filedata))
156 with open(os.path.join(testdir, 'AndroidManifest.xml')) as f:
158 self.assertIsNone(re.search('android:debuggable', filedata))
159 self.assertIsNotNone(re.search('android:versionName="%s"' % build.versionName, filedata))
160 self.assertIsNotNone(re.search('android:versionCode="%s"' % build.versionCode, filedata))
162 def test_prepare_sources_refresh(self):
163 packageName = 'org.fdroid.ci.test.app'
164 testdir = tempfile.mkdtemp(prefix='test_verify_apks', dir=self.tmpdir)
165 print('testdir', testdir)
170 # use a local copy if available to avoid hitting the network
171 tmprepo = os.path.join(self.basedir, 'tmp', 'importer')
172 if os.path.exists(tmprepo):
175 git_url = 'https://gitlab.com/fdroid/ci-test-app.git'
178 metadata['Description'] = 'This is just a test app'
179 metadata['RepoType'] = 'git'
180 metadata['Repo'] = git_url
181 with open(os.path.join('metadata', packageName + '.yml'), 'w') as fp:
182 yaml.dump(metadata, fp)
184 gitrepo = os.path.join(testdir, 'build', packageName)
185 vcs0 = fdroidserver.common.getvcs('git', git_url, gitrepo)
186 vcs0.gotorevision('0.3', refresh=True)
187 vcs1 = fdroidserver.common.getvcs('git', git_url, gitrepo)
188 vcs1.gotorevision('0.3', refresh=False)
190 def test_fdroid_popen_stderr_redirect(self):
192 fdroidserver.common.fill_config_defaults(config)
193 fdroidserver.common.config = config
195 commands = ['sh', '-c', 'echo stdout message && echo stderr message 1>&2']
197 p = fdroidserver.common.FDroidPopen(commands)
198 self.assertEqual(p.output, 'stdout message\nstderr message\n')
200 p = fdroidserver.common.FDroidPopen(commands, stderr_to_stdout=False)
201 self.assertEqual(p.output, 'stdout message\n')
203 def test_signjar(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 fdroidserver.signindex.config = config
210 sourcedir = os.path.join(self.basedir, 'signindex')
211 testsdir = tempfile.mkdtemp(prefix='test_signjar', dir=self.tmpdir)
212 for f in ('testy.jar', 'guardianproject.jar',):
213 sourcefile = os.path.join(sourcedir, f)
214 testfile = os.path.join(testsdir, f)
215 shutil.copy(sourcefile, testsdir)
216 fdroidserver.signindex.sign_jar(testfile)
217 # these should be resigned, and therefore different
218 self.assertNotEqual(open(sourcefile, 'rb').read(), open(testfile, 'rb').read())
220 def test_verify_apk_signature(self):
221 fdroidserver.common.config = None
222 config = fdroidserver.common.read_config(fdroidserver.common.options)
223 config['jarsigner'] = fdroidserver.common.find_sdk_tools_cmd('jarsigner')
224 fdroidserver.common.config = config
226 self.assertTrue(fdroidserver.common.verify_apk_signature('urzip.apk'))
227 self.assertFalse(fdroidserver.common.verify_apk_signature('urzip-badcert.apk'))
228 self.assertFalse(fdroidserver.common.verify_apk_signature('urzip-badsig.apk'))
229 self.assertTrue(fdroidserver.common.verify_apk_signature('urzip-release.apk'))
230 self.assertFalse(fdroidserver.common.verify_apk_signature('urzip-release-unsigned.apk'))
232 def test_verify_apks(self):
233 fdroidserver.common.config = None
234 config = fdroidserver.common.read_config(fdroidserver.common.options)
235 config['jarsigner'] = fdroidserver.common.find_sdk_tools_cmd('jarsigner')
236 fdroidserver.common.config = config
238 sourceapk = os.path.join(self.basedir, 'urzip.apk')
240 testdir = tempfile.mkdtemp(prefix='test_verify_apks', dir=self.tmpdir)
241 print('testdir', testdir)
243 copyapk = os.path.join(testdir, 'urzip-copy.apk')
244 shutil.copy(sourceapk, copyapk)
245 self.assertTrue(fdroidserver.common.verify_apk_signature(copyapk))
246 self.assertIsNone(fdroidserver.common.verify_apks(sourceapk, copyapk, self.tmpdir))
248 unsignedapk = os.path.join(testdir, 'urzip-unsigned.apk')
249 with ZipFile(sourceapk, 'r') as apk:
250 with ZipFile(unsignedapk, 'w') as testapk:
251 for info in apk.infolist():
252 if not info.filename.startswith('META-INF/'):
253 testapk.writestr(info, apk.read(info.filename))
254 self.assertIsNone(fdroidserver.common.verify_apks(sourceapk, unsignedapk, self.tmpdir))
256 twosigapk = os.path.join(testdir, 'urzip-twosig.apk')
257 otherapk = ZipFile(os.path.join(self.basedir, 'urzip-release.apk'), 'r')
258 with ZipFile(sourceapk, 'r') as apk:
259 with ZipFile(twosigapk, 'w') as testapk:
260 for info in apk.infolist():
261 testapk.writestr(info, apk.read(info.filename))
262 if info.filename.startswith('META-INF/'):
263 testapk.writestr(info, otherapk.read(info.filename))
265 self.assertFalse(fdroidserver.common.verify_apk_signature(twosigapk))
266 self.assertIsNone(fdroidserver.common.verify_apks(sourceapk, twosigapk, self.tmpdir))
268 def test_write_to_config(self):
269 with tempfile.TemporaryDirectory() as tmpPath:
270 cfgPath = os.path.join(tmpPath, 'config.py')
271 with open(cfgPath, 'w', encoding='utf-8') as f:
272 f.write(textwrap.dedent("""\
274 # test = 'example value'
278 do_not_touch = "good value"
281 key="123" # inline"""))
283 cfg = {'key': '111', 'default_me_orig': 'orig'}
284 fdroidserver.common.write_to_config(cfg, 'key', config_file=cfgPath)
285 fdroidserver.common.write_to_config(cfg, 'default_me', config_file=cfgPath)
286 fdroidserver.common.write_to_config(cfg, 'test', value='test value', config_file=cfgPath)
287 fdroidserver.common.write_to_config(cfg, 'new_key', value='new', config_file=cfgPath)
289 with open(cfgPath, 'r', encoding='utf-8') as f:
290 self.assertEqual(f.read(), textwrap.dedent("""\
296 do_not_touch = "good value"
303 def test_write_to_config_when_empty(self):
304 with tempfile.TemporaryDirectory() as tmpPath:
305 cfgPath = os.path.join(tmpPath, 'config.py')
306 with open(cfgPath, 'w') as f:
308 fdroidserver.common.write_to_config({}, 'key', 'val', cfgPath)
309 with open(cfgPath, 'r', encoding='utf-8') as f:
310 self.assertEqual(f.read(), textwrap.dedent("""\
315 def test_apk_name_regex(self):
317 'urzipπÇÇπÇÇ现代汉语通用字българскиعربي1234ö_-123456.apk',
318 'urzipπÇÇπÇÇ现代汉语通用字българскиعربي1234ö_123456_abcdef0.apk',
323 'a_a_a_a_0_abcdef0.apk',
325 'a_____123456_abcdef0.apk',
326 'org.fdroid.fdroid_123456.apk',
327 # valid, but "_99999" is part of packageName rather than versionCode
328 'org.fdroid.fdroid_99999_123456.apk',
329 # should be valid, but I can't figure out the regex since \w includes digits
330 # 'πÇÇπÇÇ现代汉语通用字българскиعربي1234ö_0_123bafd.apk',
333 m = fdroidserver.common.APK_NAME_REGEX.match(name)
334 self.assertIsNotNone(m)
335 self.assertIn(m.group(2), ('-123456', '0', '123456'))
336 self.assertIn(m.group(3), ('abcdef0', None))
339 'urzipπÇÇπÇÇ现代汉语通用字българскиعربي1234ö_123456_abcdefg.apk',
340 'urzip-_-198274.apk',
341 'urzip-_0_123bafd.apk',
342 'no spaces allowed_123.apk',
347 self.assertIsNone(fdroidserver.common.APK_NAME_REGEX.match(name))
349 def test_standard_file_name_regex(self):
351 'urzipπÇÇπÇÇ现代汉语通用字българскиعربي1234ö_-123456.mp3',
352 'urzipπÇÇπÇÇ现代汉语通用字българскиعربي1234ö_123456.mov',
353 'Document_-123456.pdf',
357 'org.fdroid.fdroid.privileged.ota_123456.zip',
358 'πÇÇπÇÇ现代汉语通用字българскиعربي1234ö_0.jpeg',
360 # valid, but "_99999" is part of packageName rather than versionCode
361 'a_____99999_123456.zip',
362 'org.fdroid.fdroid_99999_123456.zip',
365 m = fdroidserver.common.STANDARD_FILE_NAME_REGEX.match(name)
366 self.assertIsNotNone(m)
367 self.assertIn(m.group(2), ('-123456', '0', '123456'))
370 'urzipπÇÇπÇÇ现代汉语通用字българскиعربي1234ö_abcdefg.JPEG',
371 'urzip-_-198274.zip',
372 'urzip-_123bafd.pdf',
373 'no spaces allowed_123.foobar',
377 self.assertIsNone(fdroidserver.common.STANDARD_FILE_NAME_REGEX.match(name))
379 def test_apk_signer_fingerprint(self):
381 # fingerprints fetched with: keytool -printcert -file ____.RSA
382 testapks = (('repo/obb.main.oldversion_1444412523.apk',
383 '818e469465f96b704e27be2fee4c63ab9f83ddf30e7a34c7371a4728d83b0bc1'),
384 ('repo/obb.main.twoversions_1101613.apk',
385 '32a23624c201b949f085996ba5ed53d40f703aca4989476949cae891022e0ed6'),
386 ('repo/obb.main.twoversions_1101617.apk',
387 '32a23624c201b949f085996ba5ed53d40f703aca4989476949cae891022e0ed6'))
389 for apkfile, keytoolcertfingerprint in testapks:
390 self.assertEqual(keytoolcertfingerprint,
391 fdroidserver.common.apk_signer_fingerprint(apkfile))
394 if __name__ == "__main__":
395 parser = optparse.OptionParser()
396 parser.add_option("-v", "--verbose", action="store_true", default=False,
397 help="Spew out even more information than normal")
398 (fdroidserver.common.options, args) = parser.parse_args(['--verbose'])
400 newSuite = unittest.TestSuite()
401 newSuite.addTest(unittest.makeSuite(CommonTest))