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/>.
32 from configparser import ConfigParser
33 from argparse import ArgumentParser
35 from gettext import ngettext
40 from . import metadata
43 from .common import FDroidPopen, SdkToolsPopen
44 from .exception import FDroidException, BuildException, VCSException
52 # Note that 'force' here also implies test mode.
53 def build_server(app, build, vcs, build_dir, output_dir, log_dir, force):
54 """Do a build on the builder vm.
56 :param app: app metadata dict
58 :param vcs: version control system controller object
59 :param build_dir: local source-code checkout of app
60 :param output_dir: target folder for the build result
69 raise BuildException("Paramiko is required to use the buildserver")
71 logging.getLogger("paramiko").setLevel(logging.INFO)
73 logging.getLogger("paramiko").setLevel(logging.WARN)
75 sshinfo = vmtools.get_clean_builder('builder')
79 buildserverid = subprocess.check_output(['vagrant', 'ssh', '-c',
80 'cat /home/vagrant/buildserverid'],
81 cwd='builder').rstrip()
83 # Open SSH connection...
84 logging.info("Connecting to virtual machine...")
85 sshs = paramiko.SSHClient()
86 sshs.set_missing_host_key_policy(paramiko.AutoAddPolicy())
87 sshs.connect(sshinfo['hostname'], username=sshinfo['user'],
88 port=sshinfo['port'], timeout=300,
89 look_for_keys=False, key_filename=sshinfo['idfile'])
91 homedir = '/home/' + sshinfo['user']
93 # Get an SFTP connection...
94 ftp = sshs.open_sftp()
95 ftp.get_channel().settimeout(60)
97 # Put all the necessary files in place...
100 # Helper to copy the contents of a directory to the server...
102 logging.debug("rsyncing " + path + " to " + ftp.getcwd())
103 # TODO this should move to `vagrant rsync` from >= v1.5
105 subprocess.check_output(['rsync', '--recursive', '--perms', '--links', '--quiet', '--rsh=' +
106 'ssh -o StrictHostKeyChecking=no' +
107 ' -o UserKnownHostsFile=/dev/null' +
108 ' -o LogLevel=FATAL' +
109 ' -o IdentitiesOnly=yes' +
110 ' -o PasswordAuthentication=no' +
111 ' -p ' + str(sshinfo['port']) +
112 ' -i ' + sshinfo['idfile'],
114 sshinfo['user'] + "@" + sshinfo['hostname'] + ":" + ftp.getcwd()],
115 stderr=subprocess.STDOUT)
116 except subprocess.CalledProcessError as e:
117 raise FDroidException(str(e), e.output.decode())
119 logging.info("Preparing server for build...")
120 serverpath = os.path.abspath(os.path.dirname(__file__))
121 ftp.mkdir('fdroidserver')
122 ftp.chdir('fdroidserver')
123 ftp.put(os.path.join(serverpath, '..', 'fdroid'), 'fdroid')
124 ftp.chmod('fdroid', 0o755)
125 send_dir(os.path.join(serverpath))
128 ftp.put(os.path.join(serverpath, '..', 'buildserver',
129 'config.buildserver.py'), 'config.py')
130 ftp.chmod('config.py', 0o600)
132 # Copy over the ID (head commit hash) of the fdroidserver in use...
133 subprocess.call('git rev-parse HEAD >' +
134 os.path.join(os.getcwd(), 'tmp', 'fdroidserverid'),
135 shell=True, cwd=serverpath)
136 ftp.put('tmp/fdroidserverid', 'fdroidserverid')
138 # Copy the metadata - just the file for this app...
139 ftp.mkdir('metadata')
141 ftp.chdir('metadata')
142 ftp.put(app.metadatapath, os.path.basename(app.metadatapath))
144 # And patches if there are any...
145 if os.path.exists(os.path.join('metadata', app.id)):
146 send_dir(os.path.join('metadata', app.id))
149 # Create the build directory...
154 # Copy any extlibs that are required...
156 ftp.chdir(homedir + '/build/extlib')
157 for lib in build.extlibs:
159 libsrc = os.path.join('build/extlib', lib)
160 if not os.path.exists(libsrc):
161 raise BuildException("Missing extlib {0}".format(libsrc))
164 if d not in ftp.listdir():
167 ftp.put(libsrc, lp[-1])
168 for _ignored in lp[:-1]:
170 # Copy any srclibs that are required...
173 for lib in build.srclibs:
175 common.getsrclib(lib, 'build/srclib', basepath=True, prepare=False))
177 # If one was used for the main source, add that too.
178 basesrclib = vcs.getsrclib()
180 srclibpaths.append(basesrclib)
181 for name, number, lib in srclibpaths:
182 logging.info("Sending srclib '%s'" % lib)
183 ftp.chdir(homedir + '/build/srclib')
184 if not os.path.exists(lib):
185 raise BuildException("Missing srclib directory '" + lib + "'")
186 fv = '.fdroidvcs-' + name
187 ftp.put(os.path.join('build/srclib', fv), fv)
189 # Copy the metadata file too...
190 ftp.chdir(homedir + '/srclibs')
191 ftp.put(os.path.join('srclibs', name + '.txt'),
193 # Copy the main app source code
194 # (no need if it's a srclib)
195 if (not basesrclib) and os.path.exists(build_dir):
196 ftp.chdir(homedir + '/build')
197 fv = '.fdroidvcs-' + app.id
198 ftp.put(os.path.join('build', fv), fv)
201 # Execute the build script...
202 logging.info("Starting build...")
203 chan = sshs.get_transport().open_session()
205 cmdline = os.path.join(homedir, 'fdroidserver', 'fdroid')
206 cmdline += ' build --on-server'
208 cmdline += ' --force --test'
210 cmdline += ' --verbose'
212 cmdline += ' --skip-scan'
213 cmdline += " %s:%s" % (app.id, build.versionCode)
214 chan.exec_command('bash --login -c "' + cmdline + '"')
216 # Fetch build process output ...
218 cmd_stdout = chan.makefile('rb', 1024)
220 output += get_android_tools_version_log(build.ndk_path()).encode()
221 while not chan.exit_status_ready():
222 line = cmd_stdout.readline()
225 logging.debug("buildserver > " + str(line, 'utf-8').rstrip())
229 for line in cmd_stdout.readlines():
231 logging.debug("buildserver > " + str(line, 'utf-8').rstrip())
236 # Check build process exit status ...
237 logging.info("...getting exit status")
238 returncode = chan.recv_exit_status()
240 raise BuildException(
241 "Build.py failed on server for {0}:{1}".format(
242 app.id, build.versionName), None if options.verbose else str(output, 'utf-8'))
245 toolsversion_log = common.get_toolsversion_logname(app, build)
247 ftp.chdir(os.path.join(homedir, log_dir))
248 ftp.get(toolsversion_log, os.path.join(log_dir, toolsversion_log))
249 logging.debug('retrieved %s', toolsversion_log)
250 except Exception as e:
251 logging.warn('could not get %s from builder vm: %s' % (toolsversion_log, e))
253 # Retrieve the built files...
254 logging.info("Retrieving build output...")
256 ftp.chdir(homedir + '/tmp')
258 ftp.chdir(homedir + '/unsigned')
259 apkfile = common.get_release_filename(app, build)
260 tarball = common.getsrcname(app, build)
262 ftp.get(apkfile, os.path.join(output_dir, apkfile))
263 if not options.notarball:
264 ftp.get(tarball, os.path.join(output_dir, tarball))
266 raise BuildException(
267 "Build failed for {0}:{1} - missing output files".format(
268 app.id, build.versionName), None if options.verbose else str(output, 'utf-8'))
272 # Suspend the build server.
273 vm = vmtools.get_build_vm('builder')
277 def force_gradle_build_tools(build_dir, build_tools):
278 for root, dirs, files in os.walk(build_dir):
279 for filename in files:
280 if not filename.endswith('.gradle'):
282 path = os.path.join(root, filename)
283 if not os.path.isfile(path):
285 logging.debug("Forcing build-tools %s in %s" % (build_tools, path))
286 common.regsub_file(r"""(\s*)buildToolsVersion([\s=]+).*""",
287 r"""\1buildToolsVersion\2'%s'""" % build_tools,
291 def transform_first_char(string, method):
292 """Uses method() on the first character of string."""
296 return method(string)
297 return method(string[0]) + string[1:]
300 def has_native_code(apkobj):
301 """aapt checks if there are architecture folders under the lib/ folder
302 so we are simulating the same behaviour"""
303 arch_re = re.compile("^lib/(.*)/.*$")
304 arch = [file for file in apkobj.get_files() if arch_re.match(file)]
305 return False if not arch else True
308 def get_apk_metadata_aapt(apkfile):
309 """aapt function to extract versionCode, versionName, packageName and nativecode"""
315 p = SdkToolsPopen(['aapt', 'dump', 'badging', apkfile], output=False)
317 for line in p.output.splitlines():
318 if line.startswith("package:"):
319 pat = re.compile(".*name='([a-zA-Z0-9._]*)'.*")
323 pat = re.compile(".*versionCode='([0-9]*)'.*")
327 pat = re.compile(".*versionName='([^']*)'.*")
331 elif line.startswith("native-code:"):
332 nativecode = line[12:]
334 return vercode, version, foundid, nativecode
337 def get_apk_metadata_androguard(apkfile):
338 """androguard function to extract versionCode, versionName, packageName and nativecode"""
340 from androguard.core.bytecodes.apk import APK
341 apkobject = APK(apkfile)
343 raise BuildException("androguard library is not installed and aapt binary not found")
344 except FileNotFoundError:
345 raise BuildException("Could not open apk file for metadata analysis")
347 if not apkobject.is_valid_APK():
348 raise BuildException("Invalid APK provided")
350 foundid = apkobject.get_package()
351 vercode = apkobject.get_androidversion_code()
352 version = apkobject.get_androidversion_name()
353 nativecode = has_native_code(apkobject)
355 return vercode, version, foundid, nativecode
358 def get_metadata_from_apk(app, build, apkfile):
359 """get the required metadata from the built APK"""
361 if common.SdkToolsPopen(['aapt', 'version'], output=False):
362 vercode, version, foundid, nativecode = get_apk_metadata_aapt(apkfile)
364 vercode, version, foundid, nativecode = get_apk_metadata_androguard(apkfile)
366 # Ignore empty strings or any kind of space/newline chars that we don't
368 if nativecode is not None:
369 nativecode = nativecode.strip()
370 nativecode = None if not nativecode else nativecode
372 if build.buildjni and build.buildjni != ['no']:
373 if nativecode is None:
374 raise BuildException("Native code should have been built but none was packaged")
376 vercode = build.versionCode
377 version = build.versionName
378 if not version or not vercode:
379 raise BuildException("Could not find version information in build in output")
381 raise BuildException("Could not find package ID in output")
382 if foundid != app.id:
383 raise BuildException("Wrong package ID - build " + foundid + " but expected " + app.id)
385 return vercode, version
388 def build_local(app, build, vcs, build_dir, output_dir, log_dir, srclib_dir, extlib_dir, tmp_dir, force, onserver, refresh):
389 """Do a build locally."""
390 ndk_path = build.ndk_path()
391 if build.ndk or (build.buildjni and build.buildjni != ['no']):
393 logging.critical("Android NDK version '%s' could not be found!" % build.ndk or 'r12b')
394 logging.critical("Configured versions:")
395 for k, v in config['ndk_paths'].items():
396 if k.endswith("_orig"):
398 logging.critical(" %s: %s" % (k, v))
399 raise FDroidException()
400 elif not os.path.isdir(ndk_path):
401 logging.critical("Android NDK '%s' is not a directory!" % ndk_path)
402 raise FDroidException()
404 common.set_FDroidPopen_env(build)
406 # create ..._toolsversion.log when running in builder vm
408 # before doing anything, run the sudo commands to setup the VM
410 logging.info("Running 'sudo' commands in %s" % os.getcwd())
412 p = FDroidPopen(['sudo', 'bash', '-x', '-c', build.sudo])
413 if p.returncode != 0:
414 raise BuildException("Error running sudo command for %s:%s" %
415 (app.id, build.versionName), p.output)
417 p = FDroidPopen(['sudo', 'passwd', '--lock', 'root'])
418 if p.returncode != 0:
419 raise BuildException("Error locking root account for %s:%s" %
420 (app.id, build.versionName), p.output)
422 p = FDroidPopen(['sudo', 'SUDO_FORCE_REMOVE=yes', 'dpkg', '--purge', 'sudo'])
423 if p.returncode != 0:
424 raise BuildException("Error removing sudo for %s:%s" %
425 (app.id, build.versionName), p.output)
427 log_path = os.path.join(log_dir,
428 common.get_toolsversion_logname(app, build))
429 with open(log_path, 'w') as f:
430 f.write(get_android_tools_version_log(build.ndk_path()))
433 logging.warning('%s:%s runs this on the buildserver with sudo:\n\t%s'
434 % (app.id, build.versionName, build.sudo))
436 # Prepare the source code...
437 root_dir, srclibpaths = common.prepare_source(vcs, app, build,
438 build_dir, srclib_dir,
439 extlib_dir, onserver, refresh)
441 # We need to clean via the build tool in case the binary dirs are
442 # different from the default ones
445 bmethod = build.build_method()
446 if bmethod == 'maven':
447 logging.info("Cleaning Maven project...")
448 cmd = [config['mvn3'], 'clean', '-Dandroid.sdk.path=' + config['sdk_path']]
450 if '@' in build.maven:
451 maven_dir = os.path.join(root_dir, build.maven.split('@', 1)[1])
452 maven_dir = os.path.normpath(maven_dir)
456 p = FDroidPopen(cmd, cwd=maven_dir)
458 elif bmethod == 'gradle':
460 logging.info("Cleaning Gradle project...")
462 if build.preassemble:
463 gradletasks += build.preassemble
465 flavours = build.gradle
466 if flavours == ['yes']:
469 flavours_cmd = ''.join([transform_first_char(flav, str.upper) for flav in flavours])
471 gradletasks += ['assemble' + flavours_cmd + 'Release']
473 if config['force_build_tools']:
474 force_gradle_build_tools(build_dir, config['build_tools'])
475 for name, number, libpath in srclibpaths:
476 force_gradle_build_tools(libpath, config['build_tools'])
478 cmd = [config['gradle']]
479 if build.gradleprops:
480 cmd += ['-P' + kv for kv in build.gradleprops]
484 p = FDroidPopen(cmd, cwd=root_dir)
486 elif bmethod == 'kivy':
489 elif bmethod == 'buildozer':
492 elif bmethod == 'ant':
493 logging.info("Cleaning Ant project...")
494 p = FDroidPopen(['ant', 'clean'], cwd=root_dir)
496 if p is not None and p.returncode != 0:
497 raise BuildException("Error cleaning %s:%s" %
498 (app.id, build.versionName), p.output)
500 for root, dirs, files in os.walk(build_dir):
505 shutil.rmtree(os.path.join(root, d))
510 os.remove(os.path.join(root, f))
512 if any(f in files for f in ['build.gradle', 'settings.gradle']):
513 # Even when running clean, gradle stores task/artifact caches in
514 # .gradle/ as binary files. To avoid overcomplicating the scanner,
515 # manually delete them, just like `gradle clean` should have removed
517 del_dirs(['build', '.gradle'])
518 del_files(['gradlew', 'gradlew.bat'])
520 if 'pom.xml' in files:
523 if any(f in files for f in ['ant.properties', 'project.properties', 'build.xml']):
524 del_dirs(['bin', 'gen'])
531 raise BuildException("Refusing to skip source scan since scandelete is present")
533 # Scan before building...
534 logging.info("Scanning source for common problems...")
535 count = scanner.scan_source(build_dir, build)
538 logging.warning(ngettext('Scanner found {} problem',
539 'Scanner found {} problems', count).format(count))
541 raise BuildException(ngettext(
542 "Can't build due to {} error while scanning",
543 "Can't build due to {} errors while scanning", count).format(count))
545 if not options.notarball:
546 # Build the source tarball right before we build the release...
547 logging.info("Creating source tarball...")
548 tarname = common.getsrcname(app, build)
549 tarball = tarfile.open(os.path.join(tmp_dir, tarname), "w:gz")
552 return any(f.endswith(s) for s in ['.svn', '.git', '.hg', '.bzr'])
553 tarball.add(build_dir, tarname, exclude=tarexc)
556 # Run a build command if one is required...
558 logging.info("Running 'build' commands in %s" % root_dir)
559 cmd = common.replace_config_vars(build.build, build)
561 # Substitute source library paths into commands...
562 for name, number, libpath in srclibpaths:
563 libpath = os.path.relpath(libpath, root_dir)
564 cmd = cmd.replace('$$' + name + '$$', libpath)
566 p = FDroidPopen(['bash', '-x', '-c', cmd], cwd=root_dir)
568 if p.returncode != 0:
569 raise BuildException("Error running build command for %s:%s" %
570 (app.id, build.versionName), p.output)
572 # Build native stuff if required...
573 if build.buildjni and build.buildjni != ['no']:
574 logging.info("Building the native code")
575 jni_components = build.buildjni
577 if jni_components == ['yes']:
578 jni_components = ['']
579 cmd = [os.path.join(ndk_path, "ndk-build"), "-j1"]
580 for d in jni_components:
582 logging.info("Building native code in '%s'" % d)
584 logging.info("Building native code in the main project")
585 manifest = os.path.join(root_dir, d, 'AndroidManifest.xml')
586 if os.path.exists(manifest):
587 # Read and write the whole AM.xml to fix newlines and avoid
588 # the ndk r8c or later 'wordlist' errors. The outcome of this
589 # under gnu/linux is the same as when using tools like
590 # dos2unix, but the native python way is faster and will
591 # work in non-unix systems.
592 manifest_text = open(manifest, 'U').read()
593 open(manifest, 'w').write(manifest_text)
594 # In case the AM.xml read was big, free the memory
596 p = FDroidPopen(cmd, cwd=os.path.join(root_dir, d))
597 if p.returncode != 0:
598 raise BuildException("NDK build failed for %s:%s" % (app.id, build.versionName), p.output)
601 # Build the release...
602 if bmethod == 'maven':
603 logging.info("Building Maven project...")
605 if '@' in build.maven:
606 maven_dir = os.path.join(root_dir, build.maven.split('@', 1)[1])
610 mvncmd = [config['mvn3'], '-Dandroid.sdk.path=' + config['sdk_path'],
611 '-Dmaven.jar.sign.skip=true', '-Dmaven.test.skip=true',
612 '-Dandroid.sign.debug=false', '-Dandroid.release=true',
615 target = build.target.split('-')[1]
616 common.regsub_file(r'<platform>[0-9]*</platform>',
617 r'<platform>%s</platform>' % target,
618 os.path.join(root_dir, 'pom.xml'))
619 if '@' in build.maven:
620 common.regsub_file(r'<platform>[0-9]*</platform>',
621 r'<platform>%s</platform>' % target,
622 os.path.join(maven_dir, 'pom.xml'))
624 p = FDroidPopen(mvncmd, cwd=maven_dir)
626 bindir = os.path.join(root_dir, 'target')
628 elif bmethod == 'kivy':
629 logging.info("Building Kivy project...")
631 spec = os.path.join(root_dir, 'buildozer.spec')
632 if not os.path.exists(spec):
633 raise BuildException("Expected to find buildozer-compatible spec at {0}"
636 defaults = {'orientation': 'landscape', 'icon': '',
637 'permissions': '', 'android.api': "18"}
638 bconfig = ConfigParser(defaults, allow_no_value=True)
641 distdir = os.path.join('python-for-android', 'dist', 'fdroid')
642 if os.path.exists(distdir):
643 shutil.rmtree(distdir)
645 modules = bconfig.get('app', 'requirements').split(',')
647 cmd = 'ANDROIDSDK=' + config['sdk_path']
648 cmd += ' ANDROIDNDK=' + ndk_path
649 cmd += ' ANDROIDNDKVER=' + build.ndk
650 cmd += ' ANDROIDAPI=' + str(bconfig.get('app', 'android.api'))
651 cmd += ' VIRTUALENV=virtualenv'
652 cmd += ' ./distribute.sh'
653 cmd += ' -m ' + "'" + ' '.join(modules) + "'"
655 p = subprocess.Popen(cmd, cwd='python-for-android', shell=True)
656 if p.returncode != 0:
657 raise BuildException("Distribute build failed")
659 cid = bconfig.get('app', 'package.domain') + '.' + bconfig.get('app', 'package.name')
661 raise BuildException("Package ID mismatch between metadata and spec")
663 orientation = bconfig.get('app', 'orientation', 'landscape')
664 if orientation == 'all':
665 orientation = 'sensor'
669 '--name', bconfig.get('app', 'title'),
671 '--version', bconfig.get('app', 'version'),
672 '--orientation', orientation
675 perms = bconfig.get('app', 'permissions')
676 for perm in perms.split(','):
677 cmd.extend(['--permission', perm])
679 if config.get('app', 'fullscreen') == 0:
680 cmd.append('--window')
682 icon = bconfig.get('app', 'icon.filename')
684 cmd.extend(['--icon', os.path.join(root_dir, icon)])
686 cmd.append('release')
687 p = FDroidPopen(cmd, cwd=distdir)
689 elif bmethod == 'buildozer':
690 logging.info("Building Kivy project using buildozer...")
692 # parse buildozer.spez
693 spec = os.path.join(root_dir, 'buildozer.spec')
694 if not os.path.exists(spec):
695 raise BuildException("Expected to find buildozer-compatible spec at {0}"
697 defaults = {'orientation': 'landscape', 'icon': '',
698 'permissions': '', 'android.api': "19"}
699 bconfig = ConfigParser(defaults, allow_no_value=True)
702 # update spec with sdk and ndk locations to prevent buildozer from
704 loc_ndk = common.env['ANDROID_NDK']
705 loc_sdk = common.env['ANDROID_SDK']
706 if loc_ndk == '$ANDROID_NDK':
707 loc_ndk = loc_sdk + '/ndk-bundle'
712 bc_ndk = bconfig.get('app', 'android.sdk_path')
716 bc_sdk = bconfig.get('app', 'android.ndk_path')
721 bconfig.set('app', 'android.sdk_path', loc_sdk)
723 bconfig.set('app', 'android.ndk_path', loc_ndk)
725 fspec = open(spec, 'w')
729 logging.info("sdk_path = %s" % loc_sdk)
730 logging.info("ndk_path = %s" % loc_ndk)
734 cmd = ['buildozer', 'android', 'release']
736 p = FDroidPopen(cmd, cwd=root_dir)
740 # buidozer not installed ? clone repo and run
741 if (p is None or p.returncode != 0):
742 cmd = ['git', 'clone', 'https://github.com/kivy/buildozer.git']
743 p = subprocess.Popen(cmd, cwd=root_dir, shell=False)
745 if p.returncode != 0:
746 raise BuildException("Distribute build failed")
748 cmd = ['python', 'buildozer/buildozer/scripts/client.py', 'android', 'release']
749 p = FDroidPopen(cmd, cwd=root_dir)
752 # Signing will fail if not set by environnment vars (cf. p4a docs).
753 # But the unsigned apk will be ok.
756 elif bmethod == 'gradle':
757 logging.info("Building Gradle project...")
759 cmd = [config['gradle']]
760 if build.gradleprops:
761 cmd += ['-P' + kv for kv in build.gradleprops]
765 p = FDroidPopen(cmd, cwd=root_dir)
767 elif bmethod == 'ant':
768 logging.info("Building Ant project...")
770 if build.antcommands:
771 cmd += build.antcommands
774 p = FDroidPopen(cmd, cwd=root_dir)
776 bindir = os.path.join(root_dir, 'bin')
778 if p is not None and p.returncode != 0:
779 raise BuildException("Build failed for %s:%s" % (app.id, build.versionName), p.output)
780 logging.info("Successfully built version " + build.versionName + ' of ' + app.id)
782 omethod = build.output_method()
783 if omethod == 'maven':
784 stdout_apk = '\n'.join([
785 line for line in p.output.splitlines() if any(
786 a in line for a in ('.apk', '.ap_', '.jar'))])
787 m = re.match(r".*^\[INFO\] .*apkbuilder.*/([^/]*)\.apk",
788 stdout_apk, re.S | re.M)
790 m = re.match(r".*^\[INFO\] Creating additional unsigned apk file .*/([^/]+)\.apk[^l]",
791 stdout_apk, re.S | re.M)
793 m = re.match(r'.*^\[INFO\] [^$]*aapt \[package,[^$]*' + bindir + r'/([^/]+)\.ap[_k][,\]]',
794 stdout_apk, re.S | re.M)
797 m = re.match(r".*^\[INFO\] Building jar: .*/" + bindir + r"/(.+)\.jar",
798 stdout_apk, re.S | re.M)
800 raise BuildException('Failed to find output')
802 src = os.path.join(bindir, src) + '.apk'
803 elif omethod == 'kivy':
804 src = os.path.join('python-for-android', 'dist', 'default', 'bin',
805 '{0}-{1}-release.apk'.format(
806 bconfig.get('app', 'title'),
807 bconfig.get('app', 'version')))
809 elif omethod == 'buildozer':
812 os.path.join(root_dir, '.buildozer', 'android', 'platform', 'build', 'dists', bconfig.get('app', 'title'), 'bin'),
814 for apkglob in ['*-release-unsigned.apk', '*-unsigned.apk', '*.apk']:
815 apks = glob.glob(os.path.join(apks_dir, apkglob))
818 raise BuildException('More than one resulting apks found in %s' % apks_dir,
827 raise BuildException('Failed to find any output apks')
829 elif omethod == 'gradle':
832 # gradle plugin >= 3.0
833 os.path.join(root_dir, 'build', 'outputs', 'apk', 'release'),
834 # gradle plugin < 3.0 and >= 0.11
835 os.path.join(root_dir, 'build', 'outputs', 'apk'),
837 os.path.join(root_dir, 'build', 'apk'),
839 # If we build with gradle flavours with gradle plugin >= 3.0 the apk will be in
840 # a subdirectory corresponding to the flavour command used, but with different
843 apk_dirs.append(os.path.join(root_dir, 'build', 'outputs', 'apk', transform_first_char(flavours_cmd, str.lower), 'release'))
844 for apks_dir in apk_dirs:
845 for apkglob in ['*-release-unsigned.apk', '*-unsigned.apk', '*.apk']:
846 apks = glob.glob(os.path.join(apks_dir, apkglob))
849 raise BuildException('More than one resulting apks found in %s' % apks_dir,
858 raise BuildException('Failed to find any output apks')
860 elif omethod == 'ant':
861 stdout_apk = '\n'.join([
862 line for line in p.output.splitlines() if '.apk' in line])
863 src = re.match(r".*^.*Creating (.+) for release.*$.*", stdout_apk,
864 re.S | re.M).group(1)
865 src = os.path.join(bindir, src)
866 elif omethod == 'raw':
867 output_path = common.replace_build_vars(build.output, build)
868 globpath = os.path.join(root_dir, output_path)
869 apks = glob.glob(globpath)
871 raise BuildException('Multiple apks match %s' % globpath, '\n'.join(apks))
873 raise BuildException('No apks match %s' % globpath)
874 src = os.path.normpath(apks[0])
876 # Make sure it's not debuggable...
877 if common.isApkAndDebuggable(src):
878 raise BuildException("APK is debuggable")
880 # By way of a sanity check, make sure the version and version
881 # code in our new apk match what we expect...
882 logging.debug("Checking " + src)
883 if not os.path.exists(src):
884 raise BuildException("Unsigned apk is not at expected location of " + src)
886 if common.get_file_extension(src) == 'apk':
887 vercode, version = get_metadata_from_apk(app, build, src)
888 if (version != build.versionName or vercode != build.versionCode):
889 raise BuildException(("Unexpected version/version code in output;"
890 " APK: '%s' / '%s', "
891 " Expected: '%s' / '%s'")
892 % (version, str(vercode), build.versionName,
893 str(build.versionCode)))
895 vercode = build.versionCode
896 version = build.versionName
898 # Add information for 'fdroid verify' to be able to reproduce the build
901 metadir = os.path.join(tmp_dir, 'META-INF')
902 if not os.path.exists(metadir):
904 homedir = os.path.expanduser('~')
905 for fn in ['buildserverid', 'fdroidserverid']:
906 shutil.copyfile(os.path.join(homedir, fn),
907 os.path.join(metadir, fn))
908 subprocess.call(['jar', 'uf', os.path.abspath(src),
909 'META-INF/' + fn], cwd=tmp_dir)
911 # Copy the unsigned apk to our destination directory for further
912 # processing (by publish.py)...
913 dest = os.path.join(output_dir, common.get_release_filename(app, build))
914 shutil.copyfile(src, dest)
916 # Move the source tarball into the output directory...
917 if output_dir != tmp_dir and not options.notarball:
918 shutil.move(os.path.join(tmp_dir, tarname),
919 os.path.join(output_dir, tarname))
922 def trybuild(app, build, build_dir, output_dir, log_dir, also_check_dir,
923 srclib_dir, extlib_dir, tmp_dir, repo_dir, vcs, test,
924 server, force, onserver, refresh):
926 Build a particular version of an application, if it needs building.
928 :param output_dir: The directory where the build output will go. Usually
929 this is the 'unsigned' directory.
930 :param repo_dir: The repo directory - used for checking if the build is
932 :param also_check_dir: An additional location for checking if the build
933 is necessary (usually the archive repo)
934 :param test: True if building in test mode, in which case the build will
935 always happen, even if the output already exists. In test mode, the
936 output directory should be a temporary location, not any of the real
939 :returns: True if the build was done, False if it wasn't necessary.
942 dest_file = common.get_release_filename(app, build)
944 dest = os.path.join(output_dir, dest_file)
945 dest_repo = os.path.join(repo_dir, dest_file)
948 if os.path.exists(dest) or os.path.exists(dest_repo):
952 dest_also = os.path.join(also_check_dir, dest_file)
953 if os.path.exists(dest_also):
956 if build.disable and not options.force:
959 logging.info("Building version %s (%s) of %s" % (
960 build.versionName, build.versionCode, app.id))
963 # When using server mode, still keep a local cache of the repo, by
964 # grabbing the source now.
965 vcs.gotorevision(build.commit, refresh)
967 build_server(app, build, vcs, build_dir, output_dir, log_dir, force)
969 build_local(app, build, vcs, build_dir, output_dir, log_dir, srclib_dir, extlib_dir, tmp_dir, force, onserver, refresh)
973 def get_android_tools_versions(ndk_path=None):
974 '''get a list of the versions of all installed Android SDK/NDK components'''
977 sdk_path = config['sdk_path']
978 if sdk_path[-1] != '/':
982 ndk_release_txt = os.path.join(ndk_path, 'RELEASE.TXT')
983 if os.path.isfile(ndk_release_txt):
984 with open(ndk_release_txt, 'r') as fp:
985 components.append((os.path.basename(ndk_path), fp.read()[:-1]))
987 pattern = re.compile('^Pkg.Revision=(.+)', re.MULTILINE)
988 for root, dirs, files in os.walk(sdk_path):
989 if 'source.properties' in files:
990 source_properties = os.path.join(root, 'source.properties')
991 with open(source_properties, 'r') as fp:
992 m = pattern.search(fp.read())
994 components.append((root[len(sdk_path):], m.group(1)))
999 def get_android_tools_version_log(ndk_path):
1000 '''get a list of the versions of all installed Android SDK/NDK components'''
1001 log = '== Installed Android Tools ==\n\n'
1002 components = get_android_tools_versions(ndk_path)
1003 for name, version in sorted(components):
1004 log += '* ' + name + ' (' + version + ')\n'
1009 def parse_commandline():
1010 """Parse the command line. Returns options, parser."""
1012 parser = ArgumentParser(usage="%(prog)s [options] [APPID[:VERCODE] [APPID[:VERCODE] ...]]")
1013 common.setup_global_opts(parser)
1014 parser.add_argument("appid", nargs='*', help=_("applicationId with optional versionCode in the form APPID[:VERCODE]"))
1015 parser.add_argument("-l", "--latest", action="store_true", default=False,
1016 help=_("Build only the latest version of each package"))
1017 parser.add_argument("-s", "--stop", action="store_true", default=False,
1018 help=_("Make the build stop on exceptions"))
1019 parser.add_argument("-t", "--test", action="store_true", default=False,
1020 help=_("Test mode - put output in the tmp directory only, and always build, even if the output already exists."))
1021 parser.add_argument("--server", action="store_true", default=False,
1022 help=_("Use build server"))
1023 parser.add_argument("--resetserver", action="store_true", default=False,
1024 help=_("Reset and create a brand new build server, even if the existing one appears to be ok."))
1025 parser.add_argument("--on-server", dest="onserver", action="store_true", default=False,
1026 help=_("Specify that we're running on the build server"))
1027 parser.add_argument("--skip-scan", dest="skipscan", action="store_true", default=False,
1028 help=_("Skip scanning the source code for binaries and other problems"))
1029 parser.add_argument("--dscanner", action="store_true", default=False,
1030 help=_("Setup an emulator, install the APK on it and perform a Drozer scan"))
1031 parser.add_argument("--no-tarball", dest="notarball", action="store_true", default=False,
1032 help=_("Don't create a source tarball, useful when testing a build"))
1033 parser.add_argument("--no-refresh", dest="refresh", action="store_false", default=True,
1034 help=_("Don't refresh the repository, useful when testing a build with no internet connection"))
1035 parser.add_argument("-f", "--force", action="store_true", default=False,
1036 help=_("Force build of disabled apps, and carries on regardless of scan problems. Only allowed in test mode."))
1037 parser.add_argument("-a", "--all", action="store_true", default=False,
1038 help=_("Build all applications available"))
1039 parser.add_argument("-w", "--wiki", default=False, action="store_true",
1040 help=_("Update the wiki"))
1041 metadata.add_metadata_arguments(parser)
1042 options = parser.parse_args()
1043 metadata.warnings_action = options.W
1045 # Force --stop with --on-server to get correct exit code
1046 if options.onserver:
1049 if options.force and not options.test:
1050 parser.error("option %s: Force is only allowed in test mode" % "force")
1052 return options, parser
1057 buildserverid = None
1062 global options, config, buildserverid
1064 options, parser = parse_commandline()
1066 # The defaults for .fdroid.* metadata that is included in a git repo are
1067 # different than for the standard metadata/ layout because expectations
1068 # are different. In this case, the most common user will be the app
1069 # developer working on the latest update of the app on their own machine.
1070 local_metadata_files = common.get_local_metadata_files()
1071 if len(local_metadata_files) == 1: # there is local metadata in an app's source
1072 config = dict(common.default_config)
1073 # `fdroid build` should build only the latest version by default since
1074 # most of the time the user will be building the most recent update
1076 options.latest = True
1077 elif len(local_metadata_files) > 1:
1078 raise FDroidException("Only one local metadata file allowed! Found: "
1079 + " ".join(local_metadata_files))
1081 if not os.path.isdir('metadata') and len(local_metadata_files) == 0:
1082 raise FDroidException("No app metadata found, nothing to process!")
1083 if not options.appid and not options.all:
1084 parser.error("option %s: If you really want to build all the apps, use --all" % "all")
1086 config = common.read_config(options)
1088 if config['build_server_always']:
1089 options.server = True
1090 if options.resetserver and not options.server:
1091 parser.error("option %s: Using --resetserver without --server makes no sense" % "resetserver")
1094 if not os.path.isdir(log_dir):
1095 logging.info("Creating log directory")
1096 os.makedirs(log_dir)
1099 if not os.path.isdir(tmp_dir):
1100 logging.info("Creating temporary directory")
1101 os.makedirs(tmp_dir)
1104 output_dir = tmp_dir
1106 output_dir = 'unsigned'
1107 if not os.path.isdir(output_dir):
1108 logging.info("Creating output directory")
1109 os.makedirs(output_dir)
1111 if config['archive_older'] != 0:
1112 also_check_dir = 'archive'
1114 also_check_dir = None
1119 if not os.path.isdir(build_dir):
1120 logging.info("Creating build directory")
1121 os.makedirs(build_dir)
1122 srclib_dir = os.path.join(build_dir, 'srclib')
1123 extlib_dir = os.path.join(build_dir, 'extlib')
1125 # Read all app and srclib metadata
1126 pkgs = common.read_pkg_args(options.appid, True)
1127 allapps = metadata.read_metadata(not options.onserver, pkgs, options.refresh, sort_by_time=True)
1128 apps = common.read_app_args(options.appid, allapps, True)
1130 for appid, app in list(apps.items()):
1131 if (app.Disabled and not options.force) or not app.RepoType or not app.builds:
1135 raise FDroidException("No apps to process.")
1137 # make sure enough open files are allowed to process everything
1138 soft, hard = resource.getrlimit(resource.RLIMIT_NOFILE)
1139 if len(apps) > soft:
1141 soft = len(apps) * 2
1144 resource.setrlimit(resource.RLIMIT_NOFILE, (soft, hard))
1145 logging.debug(_('Set open file limit to {integer}')
1146 .format(integer=soft))
1147 except (OSError, ValueError) as e:
1148 logging.warning(_('Setting open file limit failed: ') + str(e))
1151 for app in apps.values():
1152 for build in reversed(app.builds):
1153 if build.disable and not options.force:
1155 app.builds = [build]
1160 site = mwclient.Site((config['wiki_protocol'], config['wiki_server']),
1161 path=config['wiki_path'])
1162 site.login(config['wiki_user'], config['wiki_password'])
1164 # Build applications...
1166 build_succeeded = []
1167 max_apps_per_run = 10
1168 for appid, app in apps.items():
1169 max_apps_per_run -= 1
1170 if max_apps_per_run < 1:
1175 for build in app.builds:
1177 tools_version_log = ''
1178 if not options.onserver:
1179 tools_version_log = get_android_tools_version_log(build.ndk_path())
1182 # For the first build of a particular app, we need to set up
1183 # the source repo. We can reuse it on subsequent builds, if
1186 vcs, build_dir = common.setup_vcs(app)
1189 logging.info("Using %s" % vcs.clientversion())
1190 logging.debug("Checking " + build.versionName)
1191 if trybuild(app, build, build_dir, output_dir, log_dir,
1192 also_check_dir, srclib_dir, extlib_dir,
1193 tmp_dir, repo_dir, vcs, options.test,
1194 options.server, options.force,
1195 options.onserver, options.refresh):
1196 toolslog = os.path.join(log_dir,
1197 common.get_toolsversion_logname(app, build))
1198 if not options.onserver and os.path.exists(toolslog):
1199 with open(toolslog, 'r') as f:
1200 tools_version_log = ''.join(f.readlines())
1203 if app.Binaries is not None:
1204 # This is an app where we build from source, and
1205 # verify the apk contents against a developer's
1206 # binary. We get that binary now, and save it
1207 # alongside our built one in the 'unsigend'
1210 url = url.replace('%v', build.versionName)
1211 url = url.replace('%c', str(build.versionCode))
1212 logging.info("...retrieving " + url)
1213 of = re.sub(r'.apk$', '.binary.apk', common.get_release_filename(app, build))
1214 of = os.path.join(output_dir, of)
1216 net.download_file(url, local_filename=of)
1217 except requests.exceptions.HTTPError as e:
1218 raise FDroidException(
1219 'Downloading Binaries from %s failed. %s' % (url, e))
1221 # Now we check weather the build can be verified to
1222 # match the supplied binary or not. Should the
1223 # comparison fail, we mark this build as a failure
1224 # and remove everything from the unsigend folder.
1225 with tempfile.TemporaryDirectory() as tmpdir:
1227 common.get_release_filename(app, build)
1229 os.path.join(output_dir, unsigned_apk)
1231 common.verify_apks(of, unsigned_apk, tmpdir)
1233 logging.debug('removing %s', unsigned_apk)
1234 os.remove(unsigned_apk)
1235 logging.debug('removing %s', of)
1237 compare_result = compare_result.split('\n')
1238 line_count = len(compare_result)
1239 compare_result = compare_result[:299]
1240 if line_count > len(compare_result):
1242 line_count - len(compare_result)
1243 compare_result.append('%d more lines ...' %
1245 compare_result = '\n'.join(compare_result)
1246 raise FDroidException('compared built binary '
1247 'to supplied reference '
1248 'binary but failed',
1251 logging.info('compared built binary to '
1252 'supplied reference binary '
1255 build_succeeded.append(app)
1256 wikilog = "Build succeeded"
1258 except VCSException as vcse:
1259 reason = str(vcse).split('\n', 1)[0] if options.verbose else str(vcse)
1260 logging.error("VCS error while building app %s: %s" % (
1263 logging.debug("Error encoutered, stopping by user request.")
1265 failed_apps[appid] = vcse
1267 except FDroidException as e:
1268 with open(os.path.join(log_dir, appid + '.log'), 'a+') as f:
1269 f.write('\n\n============================================================\n')
1270 f.write('versionCode: %s\nversionName: %s\ncommit: %s\n' %
1271 (build.versionCode, build.versionName, build.commit))
1272 f.write('Build completed at '
1273 + time.strftime("%Y-%m-%d %H:%M:%SZ", time.gmtime()) + '\n')
1274 f.write('\n' + tools_version_log + '\n')
1276 logging.error("Could not build app %s: %s" % (appid, e))
1278 logging.debug("Error encoutered, stopping by user request.")
1280 failed_apps[appid] = e
1281 wikilog = e.get_wikitext()
1282 except Exception as e:
1283 logging.error("Could not build app %s due to unknown error: %s" % (
1284 appid, traceback.format_exc()))
1286 logging.debug("Error encoutered, stopping by user request.")
1288 failed_apps[appid] = e
1291 if options.wiki and wikilog:
1293 # Write a page with the last build log for this version code
1294 lastbuildpage = appid + '/lastbuild_' + build.versionCode
1295 newpage = site.Pages[lastbuildpage]
1296 with open(os.path.join('tmp', 'fdroidserverid')) as fp:
1297 fdroidserverid = fp.read().rstrip()
1298 txt = "* build completed at " + time.strftime("%Y-%m-%d %H:%M:%SZ", time.gmtime()) + '\n' \
1299 + '* fdroidserverid: [https://gitlab.com/fdroid/fdroidserver/commit/' \
1300 + fdroidserverid + ' ' + fdroidserverid + ']\n\n'
1301 if options.onserver:
1302 txt += '* buildserverid: [https://gitlab.com/fdroid/fdroidserver/commit/' \
1303 + buildserverid + ' ' + buildserverid + ']\n\n'
1304 txt += tools_version_log + '\n\n'
1305 txt += '== Build Log ==\n\n' + wikilog
1306 newpage.save(txt, summary='Build log')
1307 # Redirect from /lastbuild to the most recent build log
1308 newpage = site.Pages[appid + '/lastbuild']
1309 newpage.save('#REDIRECT [[' + lastbuildpage + ']]', summary='Update redirect')
1310 except Exception as e:
1311 logging.error("Error while attempting to publish build log: %s" % e)
1313 for app in build_succeeded:
1314 logging.info("success: %s" % (app.id))
1316 if not options.verbose:
1317 for fa in failed_apps:
1318 logging.info("Build for app %s failed:\n%s" % (fa, failed_apps[fa]))
1320 # perform a drozer scan of all successful builds
1321 if options.dscanner and build_succeeded:
1322 from .dscanner import DockerDriver
1324 docker = DockerDriver()
1327 for app in build_succeeded:
1329 logging.info("Need to sign the app before we can install it.")
1330 subprocess.call("fdroid publish {0}".format(app.id), shell=True)
1334 for f in os.listdir(repo_dir):
1335 if f.endswith('.apk') and f.startswith(app.id):
1336 apk_path = os.path.join(repo_dir, f)
1340 raise Exception("No signed APK found at path: {path}".format(path=apk_path))
1342 if not os.path.isdir(repo_dir):
1343 logging.critical("directory does not exists '{path}'".format(path=repo_dir))
1346 logging.info("Performing Drozer scan on {0}.".format(app))
1347 docker.perform_drozer_scan(apk_path, app.id, repo_dir)
1348 except Exception as e:
1349 logging.error(str(e))
1350 logging.error("An exception happened. Making sure to clean up")
1352 logging.info("Scan succeeded.")
1354 logging.info("Cleaning up after ourselves.")
1357 logging.info(_("Finished"))
1358 if len(build_succeeded) > 0:
1359 logging.info(ngettext("{} build succeeded",
1360 "{} builds succeeded", len(build_succeeded)).format(len(build_succeeded)))
1361 if len(failed_apps) > 0:
1362 logging.info(ngettext("{} build failed",
1363 "{} builds failed", len(failed_apps)).format(len(failed_apps)))
1365 # hack to ensure this exits, even is some threads are still running
1371 if __name__ == "__main__":