3 # build.py - part of the FDroid server tools
4 # Copyright (C) 2010-2014, Ciaran Gultnieks, ciaran@ciarang.com
5 # Copyright (C) 2013-2014 Daniel Martà <mvdan@mvdan.cc>
7 # This program is free software: you can redistribute it and/or modify
8 # it under the terms of the GNU Affero General Public License as published by
9 # the Free Software Foundation, either version 3 of the License, or
10 # (at your option) any later version.
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU Affero General Public License for more details.
17 # You should have received a copy of the GNU Affero General Public License
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
31 from configparser import ConfigParser
32 from argparse import ArgumentParser
37 from . import metadata
40 from .common import FDroidPopen, SdkToolsPopen
41 from .exception import FDroidException, BuildException, VCSException
49 # Note that 'force' here also implies test mode.
50 def build_server(app, build, vcs, build_dir, output_dir, log_dir, force):
51 """Do a build on the builder vm.
53 :param app: app metadata dict
55 :param vcs: version control system controller object
56 :param build_dir: local source-code checkout of app
57 :param output_dir: target folder for the build result
66 raise BuildException("Paramiko is required to use the buildserver")
68 logging.getLogger("paramiko").setLevel(logging.INFO)
70 logging.getLogger("paramiko").setLevel(logging.WARN)
72 sshinfo = vmtools.get_clean_builder('builder')
76 buildserverid = subprocess.check_output(['vagrant', 'ssh', '-c',
77 'cat /home/vagrant/buildserverid'],
78 cwd='builder').rstrip()
80 # Open SSH connection...
81 logging.info("Connecting to virtual machine...")
82 sshs = paramiko.SSHClient()
83 sshs.set_missing_host_key_policy(paramiko.AutoAddPolicy())
84 sshs.connect(sshinfo['hostname'], username=sshinfo['user'],
85 port=sshinfo['port'], timeout=300,
86 look_for_keys=False, key_filename=sshinfo['idfile'])
88 homedir = '/home/' + sshinfo['user']
90 # Get an SFTP connection...
91 ftp = sshs.open_sftp()
92 ftp.get_channel().settimeout(60)
94 # Put all the necessary files in place...
97 # Helper to copy the contents of a directory to the server...
99 root = os.path.dirname(path)
100 main = os.path.basename(path)
102 for r, d, f in os.walk(path):
103 rr = os.path.relpath(r, root)
108 lfile = os.path.join(root, rr, ff)
109 if not os.path.islink(lfile):
111 ftp.chmod(ff, os.stat(lfile).st_mode)
112 for i in range(len(rr.split('/'))):
116 logging.info("Preparing server for build...")
117 serverpath = os.path.abspath(os.path.dirname(__file__))
118 ftp.mkdir('fdroidserver')
119 ftp.chdir('fdroidserver')
120 ftp.put(os.path.join(serverpath, '..', 'fdroid'), 'fdroid')
121 ftp.chmod('fdroid', 0o755)
122 send_dir(os.path.join(serverpath))
125 ftp.put(os.path.join(serverpath, '..', 'buildserver',
126 'config.buildserver.py'), 'config.py')
127 ftp.chmod('config.py', 0o600)
129 # Copy over the ID (head commit hash) of the fdroidserver in use...
130 subprocess.call('git rev-parse HEAD >' +
131 os.path.join(os.getcwd(), 'tmp', 'fdroidserverid'),
132 shell=True, cwd=serverpath)
133 ftp.put('tmp/fdroidserverid', 'fdroidserverid')
135 # Copy the metadata - just the file for this app...
136 ftp.mkdir('metadata')
138 ftp.chdir('metadata')
139 ftp.put(app.metadatapath, os.path.basename(app.metadatapath))
141 # And patches if there are any...
142 if os.path.exists(os.path.join('metadata', app.id)):
143 send_dir(os.path.join('metadata', app.id))
146 # Create the build directory...
151 # Copy any extlibs that are required...
153 ftp.chdir(homedir + '/build/extlib')
154 for lib in build.extlibs:
156 libsrc = os.path.join('build/extlib', lib)
157 if not os.path.exists(libsrc):
158 raise BuildException("Missing extlib {0}".format(libsrc))
161 if d not in ftp.listdir():
164 ftp.put(libsrc, lp[-1])
167 # Copy any srclibs that are required...
170 for lib in build.srclibs:
172 common.getsrclib(lib, 'build/srclib', basepath=True, prepare=False))
174 # If one was used for the main source, add that too.
175 basesrclib = vcs.getsrclib()
177 srclibpaths.append(basesrclib)
178 for name, number, lib in srclibpaths:
179 logging.info("Sending srclib '%s'" % lib)
180 ftp.chdir(homedir + '/build/srclib')
181 if not os.path.exists(lib):
182 raise BuildException("Missing srclib directory '" + lib + "'")
183 fv = '.fdroidvcs-' + name
184 ftp.put(os.path.join('build/srclib', fv), fv)
186 # Copy the metadata file too...
187 ftp.chdir(homedir + '/srclibs')
188 ftp.put(os.path.join('srclibs', name + '.txt'),
190 # Copy the main app source code
191 # (no need if it's a srclib)
192 if (not basesrclib) and os.path.exists(build_dir):
193 ftp.chdir(homedir + '/build')
194 fv = '.fdroidvcs-' + app.id
195 ftp.put(os.path.join('build', fv), fv)
198 # Execute the build script...
199 logging.info("Starting build...")
200 chan = sshs.get_transport().open_session()
202 cmdline = os.path.join(homedir, 'fdroidserver', 'fdroid')
203 cmdline += ' build --on-server'
205 cmdline += ' --force --test'
207 cmdline += ' --verbose'
209 cmdline += ' --skip-scan'
210 cmdline += " %s:%s" % (app.id, build.versionCode)
211 chan.exec_command('bash --login -c "' + cmdline + '"')
214 output += get_android_tools_version_log(build.ndk_path()).encode()
215 while not chan.exit_status_ready():
216 while chan.recv_ready():
217 output += chan.recv(1024)
219 logging.info("...getting exit status")
220 returncode = chan.recv_exit_status()
222 get = chan.recv(1024)
227 raise BuildException(
228 "Build.py failed on server for {0}:{1}".format(
229 app.id, build.versionName), str(output, 'utf-8'))
232 toolsversion_log = common.get_toolsversion_logname(app, build)
234 ftp.chdir(os.path.join(homedir, log_dir))
235 ftp.get(toolsversion_log, os.path.join(log_dir, toolsversion_log))
236 logging.debug('retrieved %s', toolsversion_log)
237 except Exception as e:
238 logging.warn('could not get %s from builder vm: %s' % (toolsversion_log, e))
240 # Retrieve the built files...
241 logging.info("Retrieving build output...")
243 ftp.chdir(homedir + '/tmp')
245 ftp.chdir(homedir + '/unsigned')
246 apkfile = common.get_release_filename(app, build)
247 tarball = common.getsrcname(app, build)
249 ftp.get(apkfile, os.path.join(output_dir, apkfile))
250 if not options.notarball:
251 ftp.get(tarball, os.path.join(output_dir, tarball))
253 raise BuildException(
254 "Build failed for %s:%s - missing output files".format(
255 app.id, build.versionName), output)
259 # Suspend the build server.
260 vm = vmtools.get_build_vm('builder')
264 def force_gradle_build_tools(build_dir, build_tools):
265 for root, dirs, files in os.walk(build_dir):
266 for filename in files:
267 if not filename.endswith('.gradle'):
269 path = os.path.join(root, filename)
270 if not os.path.isfile(path):
272 logging.debug("Forcing build-tools %s in %s" % (build_tools, path))
273 common.regsub_file(r"""(\s*)buildToolsVersion([\s=]+).*""",
274 r"""\1buildToolsVersion\2'%s'""" % build_tools,
278 def capitalize_intact(string):
279 """Like str.capitalize(), but leave the rest of the string intact without
280 switching it to lowercase."""
284 return string.upper()
285 return string[0].upper() + string[1:]
288 def has_native_code(apkobj):
289 """aapt checks if there are architecture folders under the lib/ folder
290 so we are simulating the same behaviour"""
291 arch_re = re.compile("^lib/(.*)/.*$")
292 arch = [file for file in apkobj.get_files() if arch_re.match(file)]
293 return False if not arch else True
296 def get_apk_metadata_aapt(apkfile):
297 """aapt function to extract versionCode, versionName, packageName and nativecode"""
303 p = SdkToolsPopen(['aapt', 'dump', 'badging', apkfile], output=False)
305 for line in p.output.splitlines():
306 if line.startswith("package:"):
307 pat = re.compile(".*name='([a-zA-Z0-9._]*)'.*")
311 pat = re.compile(".*versionCode='([0-9]*)'.*")
315 pat = re.compile(".*versionName='([^']*)'.*")
319 elif line.startswith("native-code:"):
320 nativecode = line[12:]
322 return vercode, version, foundid, nativecode
325 def get_apk_metadata_androguard(apkfile):
326 """androguard function to extract versionCode, versionName, packageName and nativecode"""
328 from androguard.core.bytecodes.apk import APK
329 apkobject = APK(apkfile)
331 raise BuildException("androguard library is not installed and aapt binary not found")
332 except FileNotFoundError:
333 raise BuildException("Could not open apk file for metadata analysis")
335 if not apkobject.is_valid_APK():
336 raise BuildException("Invalid APK provided")
338 foundid = apkobject.get_package()
339 vercode = apkobject.get_androidversion_code()
340 version = apkobject.get_androidversion_name()
341 nativecode = has_native_code(apkobject)
343 return vercode, version, foundid, nativecode
346 def get_metadata_from_apk(app, build, apkfile):
347 """get the required metadata from the built APK"""
349 if common.SdkToolsPopen(['aapt', 'version'], output=False):
350 vercode, version, foundid, nativecode = get_apk_metadata_aapt(apkfile)
352 vercode, version, foundid, nativecode = get_apk_metadata_androguard(apkfile)
354 # Ignore empty strings or any kind of space/newline chars that we don't
356 if nativecode is not None:
357 nativecode = nativecode.strip()
358 nativecode = None if not nativecode else nativecode
360 if build.buildjni and build.buildjni != ['no']:
361 if nativecode is None:
362 raise BuildException("Native code should have been built but none was packaged")
364 vercode = build.versionCode
365 version = build.versionName
366 if not version or not vercode:
367 raise BuildException("Could not find version information in build in output")
369 raise BuildException("Could not find package ID in output")
370 if foundid != app.id:
371 raise BuildException("Wrong package ID - build " + foundid + " but expected " + app.id)
373 return vercode, version
376 def build_local(app, build, vcs, build_dir, output_dir, log_dir, srclib_dir, extlib_dir, tmp_dir, force, onserver, refresh):
377 """Do a build locally."""
378 ndk_path = build.ndk_path()
379 if build.ndk or (build.buildjni and build.buildjni != ['no']):
381 logging.critical("Android NDK version '%s' could not be found!" % build.ndk or 'r12b')
382 logging.critical("Configured versions:")
383 for k, v in config['ndk_paths'].items():
384 if k.endswith("_orig"):
386 logging.critical(" %s: %s" % (k, v))
387 raise FDroidException()
388 elif not os.path.isdir(ndk_path):
389 logging.critical("Android NDK '%s' is not a directory!" % ndk_path)
390 raise FDroidException()
392 common.set_FDroidPopen_env(build)
394 # create ..._toolsversion.log when running in builder vm
396 # before doing anything, run the sudo commands to setup the VM
398 logging.info("Running 'sudo' commands in %s" % os.getcwd())
400 p = FDroidPopen(['sudo', 'bash', '-x', '-c', build.sudo])
401 if p.returncode != 0:
402 raise BuildException("Error running sudo command for %s:%s" %
403 (app.id, build.versionName), p.output)
405 log_path = os.path.join(log_dir,
406 common.get_toolsversion_logname(app, build))
407 with open(log_path, 'w') as f:
408 f.write(get_android_tools_version_log(build.ndk_path()))
411 logging.warning('%s:%s runs this on the buildserver with sudo:\n\t%s'
412 % (app.id, build.versionName, build.sudo))
414 # Prepare the source code...
415 root_dir, srclibpaths = common.prepare_source(vcs, app, build,
416 build_dir, srclib_dir,
417 extlib_dir, onserver, refresh)
419 # We need to clean via the build tool in case the binary dirs are
420 # different from the default ones
423 bmethod = build.build_method()
424 if bmethod == 'maven':
425 logging.info("Cleaning Maven project...")
426 cmd = [config['mvn3'], 'clean', '-Dandroid.sdk.path=' + config['sdk_path']]
428 if '@' in build.maven:
429 maven_dir = os.path.join(root_dir, build.maven.split('@', 1)[1])
430 maven_dir = os.path.normpath(maven_dir)
434 p = FDroidPopen(cmd, cwd=maven_dir)
436 elif bmethod == 'gradle':
438 logging.info("Cleaning Gradle project...")
440 if build.preassemble:
441 gradletasks += build.preassemble
443 flavours = build.gradle
444 if flavours == ['yes']:
447 flavours_cmd = ''.join([capitalize_intact(flav) for flav in flavours])
449 gradletasks += ['assemble' + flavours_cmd + 'Release']
451 if config['force_build_tools']:
452 force_gradle_build_tools(build_dir, config['build_tools'])
453 for name, number, libpath in srclibpaths:
454 force_gradle_build_tools(libpath, config['build_tools'])
456 cmd = [config['gradle']]
457 if build.gradleprops:
458 cmd += ['-P' + kv for kv in build.gradleprops]
462 p = FDroidPopen(cmd, cwd=root_dir)
464 elif bmethod == 'kivy':
467 elif bmethod == 'buildozer':
470 elif bmethod == 'ant':
471 logging.info("Cleaning Ant project...")
472 p = FDroidPopen(['ant', 'clean'], cwd=root_dir)
474 if p is not None and p.returncode != 0:
475 raise BuildException("Error cleaning %s:%s" %
476 (app.id, build.versionName), p.output)
478 for root, dirs, files in os.walk(build_dir):
483 shutil.rmtree(os.path.join(root, d))
488 os.remove(os.path.join(root, f))
490 if 'build.gradle' in files:
491 # Even when running clean, gradle stores task/artifact caches in
492 # .gradle/ as binary files. To avoid overcomplicating the scanner,
493 # manually delete them, just like `gradle clean` should have removed
495 del_dirs(['build', '.gradle'])
496 del_files(['gradlew', 'gradlew.bat'])
498 if 'pom.xml' in files:
501 if any(f in files for f in ['ant.properties', 'project.properties', 'build.xml']):
502 del_dirs(['bin', 'gen'])
509 raise BuildException("Refusing to skip source scan since scandelete is present")
511 # Scan before building...
512 logging.info("Scanning source for common problems...")
513 count = scanner.scan_source(build_dir, build)
516 logging.warn('Scanner found %d problems' % count)
518 raise BuildException("Can't build due to %d errors while scanning" % count)
520 if not options.notarball:
521 # Build the source tarball right before we build the release...
522 logging.info("Creating source tarball...")
523 tarname = common.getsrcname(app, build)
524 tarball = tarfile.open(os.path.join(tmp_dir, tarname), "w:gz")
527 return any(f.endswith(s) for s in ['.svn', '.git', '.hg', '.bzr'])
528 tarball.add(build_dir, tarname, exclude=tarexc)
531 # Run a build command if one is required...
533 logging.info("Running 'build' commands in %s" % root_dir)
534 cmd = common.replace_config_vars(build.build, build)
536 # Substitute source library paths into commands...
537 for name, number, libpath in srclibpaths:
538 libpath = os.path.relpath(libpath, root_dir)
539 cmd = cmd.replace('$$' + name + '$$', libpath)
541 p = FDroidPopen(['bash', '-x', '-c', cmd], cwd=root_dir)
543 if p.returncode != 0:
544 raise BuildException("Error running build command for %s:%s" %
545 (app.id, build.versionName), p.output)
547 # Build native stuff if required...
548 if build.buildjni and build.buildjni != ['no']:
549 logging.info("Building the native code")
550 jni_components = build.buildjni
552 if jni_components == ['yes']:
553 jni_components = ['']
554 cmd = [os.path.join(ndk_path, "ndk-build"), "-j1"]
555 for d in jni_components:
557 logging.info("Building native code in '%s'" % d)
559 logging.info("Building native code in the main project")
560 manifest = os.path.join(root_dir, d, 'AndroidManifest.xml')
561 if os.path.exists(manifest):
562 # Read and write the whole AM.xml to fix newlines and avoid
563 # the ndk r8c or later 'wordlist' errors. The outcome of this
564 # under gnu/linux is the same as when using tools like
565 # dos2unix, but the native python way is faster and will
566 # work in non-unix systems.
567 manifest_text = open(manifest, 'U').read()
568 open(manifest, 'w').write(manifest_text)
569 # In case the AM.xml read was big, free the memory
571 p = FDroidPopen(cmd, cwd=os.path.join(root_dir, d))
572 if p.returncode != 0:
573 raise BuildException("NDK build failed for %s:%s" % (app.id, build.versionName), p.output)
576 # Build the release...
577 if bmethod == 'maven':
578 logging.info("Building Maven project...")
580 if '@' in build.maven:
581 maven_dir = os.path.join(root_dir, build.maven.split('@', 1)[1])
585 mvncmd = [config['mvn3'], '-Dandroid.sdk.path=' + config['sdk_path'],
586 '-Dmaven.jar.sign.skip=true', '-Dmaven.test.skip=true',
587 '-Dandroid.sign.debug=false', '-Dandroid.release=true',
590 target = build.target.split('-')[1]
591 common.regsub_file(r'<platform>[0-9]*</platform>',
592 r'<platform>%s</platform>' % target,
593 os.path.join(root_dir, 'pom.xml'))
594 if '@' in build.maven:
595 common.regsub_file(r'<platform>[0-9]*</platform>',
596 r'<platform>%s</platform>' % target,
597 os.path.join(maven_dir, 'pom.xml'))
599 p = FDroidPopen(mvncmd, cwd=maven_dir)
601 bindir = os.path.join(root_dir, 'target')
603 elif bmethod == 'kivy':
604 logging.info("Building Kivy project...")
606 spec = os.path.join(root_dir, 'buildozer.spec')
607 if not os.path.exists(spec):
608 raise BuildException("Expected to find buildozer-compatible spec at {0}"
611 defaults = {'orientation': 'landscape', 'icon': '',
612 'permissions': '', 'android.api': "18"}
613 bconfig = ConfigParser(defaults, allow_no_value=True)
616 distdir = os.path.join('python-for-android', 'dist', 'fdroid')
617 if os.path.exists(distdir):
618 shutil.rmtree(distdir)
620 modules = bconfig.get('app', 'requirements').split(',')
622 cmd = 'ANDROIDSDK=' + config['sdk_path']
623 cmd += ' ANDROIDNDK=' + ndk_path
624 cmd += ' ANDROIDNDKVER=' + build.ndk
625 cmd += ' ANDROIDAPI=' + str(bconfig.get('app', 'android.api'))
626 cmd += ' VIRTUALENV=virtualenv'
627 cmd += ' ./distribute.sh'
628 cmd += ' -m ' + "'" + ' '.join(modules) + "'"
630 p = subprocess.Popen(cmd, cwd='python-for-android', shell=True)
631 if p.returncode != 0:
632 raise BuildException("Distribute build failed")
634 cid = bconfig.get('app', 'package.domain') + '.' + bconfig.get('app', 'package.name')
636 raise BuildException("Package ID mismatch between metadata and spec")
638 orientation = bconfig.get('app', 'orientation', 'landscape')
639 if orientation == 'all':
640 orientation = 'sensor'
644 '--name', bconfig.get('app', 'title'),
646 '--version', bconfig.get('app', 'version'),
647 '--orientation', orientation
650 perms = bconfig.get('app', 'permissions')
651 for perm in perms.split(','):
652 cmd.extend(['--permission', perm])
654 if config.get('app', 'fullscreen') == 0:
655 cmd.append('--window')
657 icon = bconfig.get('app', 'icon.filename')
659 cmd.extend(['--icon', os.path.join(root_dir, icon)])
661 cmd.append('release')
662 p = FDroidPopen(cmd, cwd=distdir)
664 elif bmethod == 'buildozer':
665 logging.info("Building Kivy project using buildozer...")
667 # parse buildozer.spez
668 spec = os.path.join(root_dir, 'buildozer.spec')
669 if not os.path.exists(spec):
670 raise BuildException("Expected to find buildozer-compatible spec at {0}"
672 defaults = {'orientation': 'landscape', 'icon': '',
673 'permissions': '', 'android.api': "19"}
674 bconfig = ConfigParser(defaults, allow_no_value=True)
677 # update spec with sdk and ndk locations to prevent buildozer from
679 loc_ndk = common.env['ANDROID_NDK']
680 loc_sdk = common.env['ANDROID_SDK']
681 if loc_ndk == '$ANDROID_NDK':
682 loc_ndk = loc_sdk + '/ndk-bundle'
687 bc_ndk = bconfig.get('app', 'android.sdk_path')
691 bc_sdk = bconfig.get('app', 'android.ndk_path')
696 bconfig.set('app', 'android.sdk_path', loc_sdk)
698 bconfig.set('app', 'android.ndk_path', loc_ndk)
700 fspec = open(spec, 'w')
704 logging.info("sdk_path = %s" % loc_sdk)
705 logging.info("ndk_path = %s" % loc_ndk)
709 cmd = ['buildozer', 'android', 'release']
711 p = FDroidPopen(cmd, cwd=root_dir)
715 # buidozer not installed ? clone repo and run
716 if (p is None or p.returncode != 0):
717 cmd = ['git', 'clone', 'https://github.com/kivy/buildozer.git']
718 p = subprocess.Popen(cmd, cwd=root_dir, shell=False)
720 if p.returncode != 0:
721 raise BuildException("Distribute build failed")
723 cmd = ['python', 'buildozer/buildozer/scripts/client.py', 'android', 'release']
724 p = FDroidPopen(cmd, cwd=root_dir)
727 # Signing will fail if not set by environnment vars (cf. p4a docs).
728 # But the unsigned apk will be ok.
731 elif bmethod == 'gradle':
732 logging.info("Building Gradle project...")
734 cmd = [config['gradle']]
735 if build.gradleprops:
736 cmd += ['-P' + kv for kv in build.gradleprops]
740 p = FDroidPopen(cmd, cwd=root_dir)
742 elif bmethod == 'ant':
743 logging.info("Building Ant project...")
745 if build.antcommands:
746 cmd += build.antcommands
749 p = FDroidPopen(cmd, cwd=root_dir)
751 bindir = os.path.join(root_dir, 'bin')
753 if p is not None and p.returncode != 0:
754 raise BuildException("Build failed for %s:%s" % (app.id, build.versionName), p.output)
755 logging.info("Successfully built version " + build.versionName + ' of ' + app.id)
757 omethod = build.output_method()
758 if omethod == 'maven':
759 stdout_apk = '\n'.join([
760 line for line in p.output.splitlines() if any(
761 a in line for a in ('.apk', '.ap_', '.jar'))])
762 m = re.match(r".*^\[INFO\] .*apkbuilder.*/([^/]*)\.apk",
763 stdout_apk, re.S | re.M)
765 m = re.match(r".*^\[INFO\] Creating additional unsigned apk file .*/([^/]+)\.apk[^l]",
766 stdout_apk, re.S | re.M)
768 m = re.match(r'.*^\[INFO\] [^$]*aapt \[package,[^$]*' + bindir + r'/([^/]+)\.ap[_k][,\]]',
769 stdout_apk, re.S | re.M)
772 m = re.match(r".*^\[INFO\] Building jar: .*/" + bindir + r"/(.+)\.jar",
773 stdout_apk, re.S | re.M)
775 raise BuildException('Failed to find output')
777 src = os.path.join(bindir, src) + '.apk'
778 elif omethod == 'kivy':
779 src = os.path.join('python-for-android', 'dist', 'default', 'bin',
780 '{0}-{1}-release.apk'.format(
781 bconfig.get('app', 'title'),
782 bconfig.get('app', 'version')))
784 elif omethod == 'buildozer':
787 os.path.join(root_dir, '.buildozer', 'android', 'platform', 'build', 'dists', bconfig.get('app', 'title'), 'bin'),
789 for apkglob in ['*-release-unsigned.apk', '*-unsigned.apk', '*.apk']:
790 apks = glob.glob(os.path.join(apks_dir, apkglob))
793 raise BuildException('More than one resulting apks found in %s' % apks_dir,
802 raise BuildException('Failed to find any output apks')
804 elif omethod == 'gradle':
807 os.path.join(root_dir, 'build', 'outputs', 'apk', 'release'),
808 os.path.join(root_dir, 'build', 'outputs', 'apk'),
809 os.path.join(root_dir, 'build', 'apk'),
811 for apkglob in ['*-release-unsigned.apk', '*-unsigned.apk', '*.apk']:
812 apks = glob.glob(os.path.join(apks_dir, apkglob))
815 raise BuildException('More than one resulting apks found in %s' % apks_dir,
824 raise BuildException('Failed to find any output apks')
826 elif omethod == 'ant':
827 stdout_apk = '\n'.join([
828 line for line in p.output.splitlines() if '.apk' in line])
829 src = re.match(r".*^.*Creating (.+) for release.*$.*", stdout_apk,
830 re.S | re.M).group(1)
831 src = os.path.join(bindir, src)
832 elif omethod == 'raw':
833 output_path = common.replace_build_vars(build.output, build)
834 globpath = os.path.join(root_dir, output_path)
835 apks = glob.glob(globpath)
837 raise BuildException('Multiple apks match %s' % globpath, '\n'.join(apks))
839 raise BuildException('No apks match %s' % globpath)
840 src = os.path.normpath(apks[0])
842 # Make sure it's not debuggable...
843 if common.isApkAndDebuggable(src):
844 raise BuildException("APK is debuggable")
846 # By way of a sanity check, make sure the version and version
847 # code in our new apk match what we expect...
848 logging.debug("Checking " + src)
849 if not os.path.exists(src):
850 raise BuildException("Unsigned apk is not at expected location of " + src)
852 if common.get_file_extension(src) == 'apk':
853 vercode, version = get_metadata_from_apk(app, build, src)
854 if (version != build.versionName or vercode != build.versionCode):
855 raise BuildException(("Unexpected version/version code in output;"
856 " APK: '%s' / '%s', "
857 " Expected: '%s' / '%s'")
858 % (version, str(vercode), build.versionName,
859 str(build.versionCode)))
861 vercode = build.versionCode
862 version = build.versionName
864 # Add information for 'fdroid verify' to be able to reproduce the build
867 metadir = os.path.join(tmp_dir, 'META-INF')
868 if not os.path.exists(metadir):
870 homedir = os.path.expanduser('~')
871 for fn in ['buildserverid', 'fdroidserverid']:
872 shutil.copyfile(os.path.join(homedir, fn),
873 os.path.join(metadir, fn))
874 subprocess.call(['jar', 'uf', os.path.abspath(src),
875 'META-INF/' + fn], cwd=tmp_dir)
877 # Copy the unsigned apk to our destination directory for further
878 # processing (by publish.py)...
879 dest = os.path.join(output_dir, common.get_release_filename(app, build))
880 shutil.copyfile(src, dest)
882 # Move the source tarball into the output directory...
883 if output_dir != tmp_dir and not options.notarball:
884 shutil.move(os.path.join(tmp_dir, tarname),
885 os.path.join(output_dir, tarname))
888 def trybuild(app, build, build_dir, output_dir, log_dir, also_check_dir,
889 srclib_dir, extlib_dir, tmp_dir, repo_dir, vcs, test,
890 server, force, onserver, refresh):
892 Build a particular version of an application, if it needs building.
894 :param output_dir: The directory where the build output will go. Usually
895 this is the 'unsigned' directory.
896 :param repo_dir: The repo directory - used for checking if the build is
898 :param also_check_dir: An additional location for checking if the build
899 is necessary (usually the archive repo)
900 :param test: True if building in test mode, in which case the build will
901 always happen, even if the output already exists. In test mode, the
902 output directory should be a temporary location, not any of the real
905 :returns: True if the build was done, False if it wasn't necessary.
908 dest_file = common.get_release_filename(app, build)
910 dest = os.path.join(output_dir, dest_file)
911 dest_repo = os.path.join(repo_dir, dest_file)
914 if os.path.exists(dest) or os.path.exists(dest_repo):
918 dest_also = os.path.join(also_check_dir, dest_file)
919 if os.path.exists(dest_also):
922 if build.disable and not options.force:
925 logging.info("Building version %s (%s) of %s" % (
926 build.versionName, build.versionCode, app.id))
929 # When using server mode, still keep a local cache of the repo, by
930 # grabbing the source now.
931 vcs.gotorevision(build.commit)
933 build_server(app, build, vcs, build_dir, output_dir, log_dir, force)
935 build_local(app, build, vcs, build_dir, output_dir, log_dir, srclib_dir, extlib_dir, tmp_dir, force, onserver, refresh)
939 def get_android_tools_versions(ndk_path=None):
940 '''get a list of the versions of all installed Android SDK/NDK components'''
943 sdk_path = config['sdk_path']
944 if sdk_path[-1] != '/':
948 ndk_release_txt = os.path.join(ndk_path, 'RELEASE.TXT')
949 if os.path.isfile(ndk_release_txt):
950 with open(ndk_release_txt, 'r') as fp:
951 components.append((os.path.basename(ndk_path), fp.read()[:-1]))
953 pattern = re.compile('^Pkg.Revision=(.+)', re.MULTILINE)
954 for root, dirs, files in os.walk(sdk_path):
955 if 'source.properties' in files:
956 source_properties = os.path.join(root, 'source.properties')
957 with open(source_properties, 'r') as fp:
958 m = pattern.search(fp.read())
960 components.append((root[len(sdk_path):], m.group(1)))
965 def get_android_tools_version_log(ndk_path):
966 '''get a list of the versions of all installed Android SDK/NDK components'''
967 log = '== Installed Android Tools ==\n\n'
968 components = get_android_tools_versions(ndk_path)
969 for name, version in sorted(components):
970 log += '* ' + name + ' (' + version + ')\n'
975 def parse_commandline():
976 """Parse the command line. Returns options, parser."""
978 parser = ArgumentParser(usage="%(prog)s [options] [APPID[:VERCODE] [APPID[:VERCODE] ...]]")
979 common.setup_global_opts(parser)
980 parser.add_argument("appid", nargs='*', help="app-id with optional versionCode in the form APPID[:VERCODE]")
981 parser.add_argument("-l", "--latest", action="store_true", default=False,
982 help="Build only the latest version of each package")
983 parser.add_argument("-s", "--stop", action="store_true", default=False,
984 help="Make the build stop on exceptions")
985 parser.add_argument("-t", "--test", action="store_true", default=False,
986 help="Test mode - put output in the tmp directory only, and always build, even if the output already exists.")
987 parser.add_argument("--server", action="store_true", default=False,
988 help="Use build server")
989 parser.add_argument("--resetserver", action="store_true", default=False,
990 help="Reset and create a brand new build server, even if the existing one appears to be ok.")
991 parser.add_argument("--on-server", dest="onserver", action="store_true", default=False,
992 help="Specify that we're running on the build server")
993 parser.add_argument("--skip-scan", dest="skipscan", action="store_true", default=False,
994 help="Skip scanning the source code for binaries and other problems")
995 parser.add_argument("--dscanner", action="store_true", default=False,
996 help="Setup an emulator, install the apk on it and perform a drozer scan")
997 parser.add_argument("--no-tarball", dest="notarball", action="store_true", default=False,
998 help="Don't create a source tarball, useful when testing a build")
999 parser.add_argument("--no-refresh", dest="refresh", action="store_false", default=True,
1000 help="Don't refresh the repository, useful when testing a build with no internet connection")
1001 parser.add_argument("-f", "--force", action="store_true", default=False,
1002 help="Force build of disabled apps, and carries on regardless of scan problems. Only allowed in test mode.")
1003 parser.add_argument("-a", "--all", action="store_true", default=False,
1004 help="Build all applications available")
1005 parser.add_argument("-w", "--wiki", default=False, action="store_true",
1006 help="Update the wiki")
1007 metadata.add_metadata_arguments(parser)
1008 options = parser.parse_args()
1009 metadata.warnings_action = options.W
1011 # Force --stop with --on-server to get correct exit code
1012 if options.onserver:
1015 if options.force and not options.test:
1016 parser.error("option %s: Force is only allowed in test mode" % "force")
1018 return options, parser
1023 buildserverid = None
1028 global options, config, buildserverid
1030 options, parser = parse_commandline()
1032 # The defaults for .fdroid.* metadata that is included in a git repo are
1033 # different than for the standard metadata/ layout because expectations
1034 # are different. In this case, the most common user will be the app
1035 # developer working on the latest update of the app on their own machine.
1036 local_metadata_files = common.get_local_metadata_files()
1037 if len(local_metadata_files) == 1: # there is local metadata in an app's source
1038 config = dict(common.default_config)
1039 # `fdroid build` should build only the latest version by default since
1040 # most of the time the user will be building the most recent update
1042 options.latest = True
1043 elif len(local_metadata_files) > 1:
1044 raise FDroidException("Only one local metadata file allowed! Found: "
1045 + " ".join(local_metadata_files))
1047 if not os.path.isdir('metadata') and len(local_metadata_files) == 0:
1048 raise FDroidException("No app metadata found, nothing to process!")
1049 if not options.appid and not options.all:
1050 parser.error("option %s: If you really want to build all the apps, use --all" % "all")
1052 config = common.read_config(options)
1054 if config['build_server_always']:
1055 options.server = True
1056 if options.resetserver and not options.server:
1057 parser.error("option %s: Using --resetserver without --server makes no sense" % "resetserver")
1060 if not os.path.isdir(log_dir):
1061 logging.info("Creating log directory")
1062 os.makedirs(log_dir)
1065 if not os.path.isdir(tmp_dir):
1066 logging.info("Creating temporary directory")
1067 os.makedirs(tmp_dir)
1070 output_dir = tmp_dir
1072 output_dir = 'unsigned'
1073 if not os.path.isdir(output_dir):
1074 logging.info("Creating output directory")
1075 os.makedirs(output_dir)
1077 if config['archive_older'] != 0:
1078 also_check_dir = 'archive'
1080 also_check_dir = None
1085 if not os.path.isdir(build_dir):
1086 logging.info("Creating build directory")
1087 os.makedirs(build_dir)
1088 srclib_dir = os.path.join(build_dir, 'srclib')
1089 extlib_dir = os.path.join(build_dir, 'extlib')
1091 # Read all app and srclib metadata
1092 pkgs = common.read_pkg_args(options.appid, True)
1093 allapps = metadata.read_metadata(not options.onserver, pkgs)
1094 apps = common.read_app_args(options.appid, allapps, True)
1096 for appid, app in list(apps.items()):
1097 if (app.Disabled and not options.force) or not app.RepoType or not app.builds:
1101 raise FDroidException("No apps to process.")
1104 for app in apps.values():
1105 for build in reversed(app.builds):
1106 if build.disable and not options.force:
1108 app.builds = [build]
1113 site = mwclient.Site((config['wiki_protocol'], config['wiki_server']),
1114 path=config['wiki_path'])
1115 site.login(config['wiki_user'], config['wiki_password'])
1117 # Build applications...
1119 build_succeeded = []
1120 for appid, app in apps.items():
1124 for build in app.builds:
1126 tools_version_log = ''
1127 if not options.onserver:
1128 tools_version_log = get_android_tools_version_log(build.ndk_path())
1131 # For the first build of a particular app, we need to set up
1132 # the source repo. We can reuse it on subsequent builds, if
1135 vcs, build_dir = common.setup_vcs(app)
1138 logging.debug("Checking " + build.versionName)
1139 if trybuild(app, build, build_dir, output_dir, log_dir,
1140 also_check_dir, srclib_dir, extlib_dir,
1141 tmp_dir, repo_dir, vcs, options.test,
1142 options.server, options.force,
1143 options.onserver, options.refresh):
1144 toolslog = os.path.join(log_dir,
1145 common.get_toolsversion_logname(app, build))
1146 if not options.onserver and os.path.exists(toolslog):
1147 with open(toolslog, 'r') as f:
1148 tools_version_log = ''.join(f.readlines())
1151 if app.Binaries is not None:
1152 # This is an app where we build from source, and
1153 # verify the apk contents against a developer's
1154 # binary. We get that binary now, and save it
1155 # alongside our built one in the 'unsigend'
1158 url = url.replace('%v', build.versionName)
1159 url = url.replace('%c', str(build.versionCode))
1160 logging.info("...retrieving " + url)
1161 of = re.sub(r'.apk$', '.binary.apk', common.get_release_filename(app, build))
1162 of = os.path.join(output_dir, of)
1164 net.download_file(url, local_filename=of)
1165 except requests.exceptions.HTTPError as e:
1166 raise FDroidException(
1167 'Downloading Binaries from %s failed. %s' % (url, e))
1169 # Now we check weather the build can be verified to
1170 # match the supplied binary or not. Should the
1171 # comparison fail, we mark this build as a failure
1172 # and remove everything from the unsigend folder.
1173 with tempfile.TemporaryDirectory() as tmpdir:
1175 common.get_release_filename(app, build)
1177 os.path.join(output_dir, unsigned_apk)
1179 common.verify_apks(of, unsigned_apk, tmpdir)
1181 logging.debug('removing %s', unsigned_apk)
1182 os.remove(unsigned_apk)
1183 logging.debug('removing %s', of)
1185 compare_result = compare_result.split('\n')
1186 line_count = len(compare_result)
1187 compare_result = compare_result[:299]
1188 if line_count > len(compare_result):
1190 line_count - len(compare_result)
1191 compare_result.append('%d more lines ...' %
1193 compare_result = '\n'.join(compare_result)
1194 raise FDroidException('compared built binary '
1195 'to supplied reference '
1196 'binary but failed',
1199 logging.info('compared built binary to '
1200 'supplied reference binary '
1203 build_succeeded.append(app)
1204 wikilog = "Build succeeded"
1206 except VCSException as vcse:
1207 reason = str(vcse).split('\n', 1)[0] if options.verbose else str(vcse)
1208 logging.error("VCS error while building app %s: %s" % (
1212 failed_apps[appid] = vcse
1214 except FDroidException as e:
1215 with open(os.path.join(log_dir, appid + '.log'), 'a+') as f:
1216 f.write('\n\n============================================================\n')
1217 f.write('versionCode: %s\nversionName: %s\ncommit: %s\n' %
1218 (build.versionCode, build.versionName, build.commit))
1219 f.write('Build completed at '
1220 + time.strftime("%Y-%m-%d %H:%M:%SZ", time.gmtime()) + '\n')
1221 f.write('\n' + tools_version_log + '\n')
1223 logging.error("Could not build app %s: %s" % (appid, e))
1226 failed_apps[appid] = e
1227 wikilog = e.get_wikitext()
1228 except Exception as e:
1229 logging.error("Could not build app %s due to unknown error: %s" % (
1230 appid, traceback.format_exc()))
1233 failed_apps[appid] = e
1236 if options.wiki and wikilog:
1238 # Write a page with the last build log for this version code
1239 lastbuildpage = appid + '/lastbuild_' + build.versionCode
1240 newpage = site.Pages[lastbuildpage]
1241 with open(os.path.join('tmp', 'fdroidserverid')) as fp:
1242 fdroidserverid = fp.read().rstrip()
1243 txt = "* build completed at " + time.strftime("%Y-%m-%d %H:%M:%SZ", time.gmtime()) + '\n' \
1244 + '* fdroidserverid: [https://gitlab.com/fdroid/fdroidserver/commit/' \
1245 + fdroidserverid + ' ' + fdroidserverid + ']\n\n'
1246 if options.onserver:
1247 txt += '* buildserverid: [https://gitlab.com/fdroid/fdroidserver/commit/' \
1248 + buildserverid + ' ' + buildserverid + ']\n\n'
1249 txt += tools_version_log + '\n\n'
1250 txt += '== Build Log ==\n\n' + wikilog
1251 newpage.save(txt, summary='Build log')
1252 # Redirect from /lastbuild to the most recent build log
1253 newpage = site.Pages[appid + '/lastbuild']
1254 newpage.save('#REDIRECT [[' + lastbuildpage + ']]', summary='Update redirect')
1255 except Exception as e:
1256 logging.error("Error while attempting to publish build log: %s" % e)
1258 for app in build_succeeded:
1259 logging.info("success: %s" % (app.id))
1261 if not options.verbose:
1262 for fa in failed_apps:
1263 logging.info("Build for app %s failed:\n%s" % (fa, failed_apps[fa]))
1265 # perform a drozer scan of all successful builds
1266 if options.dscanner and build_succeeded:
1267 from .dscanner import DockerDriver
1269 docker = DockerDriver()
1272 for app in build_succeeded:
1274 logging.info("Need to sign the app before we can install it.")
1275 subprocess.call("fdroid publish {0}".format(app.id), shell=True)
1279 for f in os.listdir(repo_dir):
1280 if f.endswith('.apk') and f.startswith(app.id):
1281 apk_path = os.path.join(repo_dir, f)
1285 raise Exception("No signed APK found at path: {0}".format(apk_path))
1287 if not os.path.isdir(repo_dir):
1290 logging.info("Performing Drozer scan on {0}.".format(app))
1291 docker.perform_drozer_scan(apk_path, app.id, repo_dir)
1292 except Exception as e:
1293 logging.error(str(e))
1294 logging.error("An exception happened. Making sure to clean up")
1296 logging.info("Scan succeeded.")
1298 logging.info("Cleaning up after ourselves.")
1301 logging.info("Finished.")
1302 if len(build_succeeded) > 0:
1303 logging.info(str(len(build_succeeded)) + ' builds succeeded')
1304 if len(failed_apps) > 0:
1305 logging.info(str(len(failed_apps)) + ' builds failed')
1310 if __name__ == "__main__":