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
38 from . import metadata
40 from .common import FDroidException, BuildException, VCSException, FDroidPopen, SdkToolsPopen
48 def get_builder_vm_id():
49 vd = os.path.join('builder', '.vagrant')
51 # Vagrant 1.2 (and maybe 1.1?) it's a directory tree...
52 with open(os.path.join(vd, 'machines', 'default',
53 'virtualbox', 'id')) as vf:
57 # Vagrant 1.0 - it's a json file...
58 with open(os.path.join('builder', '.vagrant')) as vf:
60 return v['active']['default']
63 def got_valid_builder_vm():
64 """Returns True if we have a valid-looking builder vm
66 if not os.path.exists(os.path.join('builder', 'Vagrantfile')):
68 vd = os.path.join('builder', '.vagrant')
69 if not os.path.exists(vd):
71 if not os.path.isdir(vd):
72 # Vagrant 1.0 - if the directory is there, it's valid...
74 # Vagrant 1.2 - the directory can exist, but the id can be missing...
75 if not os.path.exists(os.path.join(vd, 'machines', 'default',
81 def vagrant(params, cwd=None, printout=False):
82 """Run a vagrant command.
84 :param: list of parameters to pass to vagrant
85 :cwd: directory to run in, or None for current directory
86 :returns: (ret, out) where ret is the return code, and out
87 is the stdout (and stderr) from vagrant
89 p = FDroidPopen(['vagrant'] + params, cwd=cwd)
90 return (p.returncode, p.output)
93 def get_vagrant_sshinfo():
94 """Get ssh connection info for a vagrant VM
96 :returns: A dictionary containing 'hostname', 'port', 'user'
99 if subprocess.call('vagrant ssh-config >sshconfig',
100 cwd='builder', shell=True) != 0:
101 raise BuildException("Error getting ssh config")
102 vagranthost = 'default' # Host in ssh config file
103 sshconfig = paramiko.SSHConfig()
104 sshf = open(os.path.join('builder', 'sshconfig'), 'r')
105 sshconfig.parse(sshf)
107 sshconfig = sshconfig.lookup(vagranthost)
108 idfile = sshconfig['identityfile']
109 if isinstance(idfile, list):
111 elif idfile.startswith('"') and idfile.endswith('"'):
112 idfile = idfile[1:-1]
113 return {'hostname': sshconfig['hostname'],
114 'port': int(sshconfig['port']),
115 'user': sshconfig['user'],
119 def get_clean_vm(reset=False):
120 """Get a clean VM ready to do a buildserver build.
122 This might involve creating and starting a new virtual machine from
123 scratch, or it might be as simple (unless overridden by the reset
124 parameter) as re-using a snapshot created previously.
126 A BuildException will be raised if anything goes wrong.
128 :reset: True to force creating from scratch.
129 :returns: A dictionary containing 'hostname', 'port', 'user'
132 # Reset existing builder machine to a clean state if possible.
135 logging.info("Checking for valid existing build server")
137 if got_valid_builder_vm():
138 logging.info("...VM is present")
139 p = FDroidPopen(['VBoxManage', 'snapshot',
140 get_builder_vm_id(), 'list',
141 '--details'], cwd='builder')
142 if 'fdroidclean' in p.output:
143 logging.info("...snapshot exists - resetting build server to "
145 retcode, output = vagrant(['status'], cwd='builder')
147 if 'running' in output:
148 logging.info("...suspending")
149 vagrant(['suspend'], cwd='builder')
150 logging.info("...waiting a sec...")
152 p = FDroidPopen(['VBoxManage', 'snapshot', get_builder_vm_id(),
153 'restore', 'fdroidclean'],
156 if p.returncode == 0:
157 logging.info("...reset to snapshot - server is valid")
158 retcode, output = vagrant(['up'], cwd='builder')
160 raise BuildException("Failed to start build server")
161 logging.info("...waiting a sec...")
163 sshinfo = get_vagrant_sshinfo()
166 logging.info("...failed to reset to snapshot")
168 logging.info("...snapshot doesn't exist - "
169 "VBoxManage snapshot list:\n" + p.output)
171 # If we can't use the existing machine for any reason, make a
172 # new one from scratch.
174 if os.path.exists('builder'):
175 logging.info("Removing broken/incomplete/unwanted build server")
176 vagrant(['destroy', '-f'], cwd='builder')
177 shutil.rmtree('builder')
180 p = subprocess.Popen(['vagrant', '--version'],
181 universal_newlines=True,
182 stdout=subprocess.PIPE)
183 vver = p.communicate()[0].strip().split(' ')[1]
184 if vver.split('.')[0] != '1' or int(vver.split('.')[1]) < 4:
185 raise BuildException("Unsupported vagrant version {0}".format(vver))
187 with open(os.path.join('builder', 'Vagrantfile'), 'w') as vf:
188 vf.write('Vagrant.configure("2") do |config|\n')
189 vf.write('config.vm.box = "buildserver"\n')
190 vf.write('config.vm.synced_folder ".", "/vagrant", disabled: true\n')
193 logging.info("Starting new build server")
194 retcode, _ = vagrant(['up'], cwd='builder')
196 raise BuildException("Failed to start build server")
198 # Open SSH connection to make sure it's working and ready...
199 logging.info("Connecting to virtual machine...")
200 sshinfo = get_vagrant_sshinfo()
201 sshs = paramiko.SSHClient()
202 sshs.set_missing_host_key_policy(paramiko.AutoAddPolicy())
203 sshs.connect(sshinfo['hostname'], username=sshinfo['user'],
204 port=sshinfo['port'], timeout=300,
206 key_filename=sshinfo['idfile'])
209 logging.info("Saving clean state of new build server")
210 retcode, _ = vagrant(['suspend'], cwd='builder')
212 raise BuildException("Failed to suspend build server")
213 logging.info("...waiting a sec...")
215 p = FDroidPopen(['VBoxManage', 'snapshot', get_builder_vm_id(),
216 'take', 'fdroidclean'],
218 if p.returncode != 0:
219 raise BuildException("Failed to take snapshot")
220 logging.info("...waiting a sec...")
222 logging.info("Restarting new build server")
223 retcode, _ = vagrant(['up'], cwd='builder')
225 raise BuildException("Failed to start build server")
226 logging.info("...waiting a sec...")
228 # Make sure it worked...
229 p = FDroidPopen(['VBoxManage', 'snapshot', get_builder_vm_id(),
230 'list', '--details'],
232 if 'fdroidclean' not in p.output:
233 raise BuildException("Failed to take snapshot.")
239 """Release the VM previously started with get_clean_vm().
241 This should always be called.
243 logging.info("Suspending build server")
244 subprocess.call(['vagrant', 'suspend'], cwd='builder')
247 # Note that 'force' here also implies test mode.
248 def build_server(app, build, vcs, build_dir, output_dir, log_dir, force):
249 """Do a build on the builder vm.
251 :param app: app metadata dict
253 :param vcs: version control system controller object
254 :param build_dir: local source-code checkout of app
255 :param output_dir: target folder for the build result
264 raise BuildException("Paramiko is required to use the buildserver")
266 logging.getLogger("paramiko").setLevel(logging.INFO)
268 logging.getLogger("paramiko").setLevel(logging.WARN)
270 sshinfo = get_clean_vm()
273 if not buildserverid:
274 buildserverid = subprocess.check_output(['vagrant', 'ssh', '-c',
275 'cat /home/vagrant/buildserverid'],
276 cwd='builder').rstrip()
278 # Open SSH connection...
279 logging.info("Connecting to virtual machine...")
280 sshs = paramiko.SSHClient()
281 sshs.set_missing_host_key_policy(paramiko.AutoAddPolicy())
282 sshs.connect(sshinfo['hostname'], username=sshinfo['user'],
283 port=sshinfo['port'], timeout=300,
284 look_for_keys=False, key_filename=sshinfo['idfile'])
286 homedir = '/home/' + sshinfo['user']
288 # Get an SFTP connection...
289 ftp = sshs.open_sftp()
290 ftp.get_channel().settimeout(60)
292 # Put all the necessary files in place...
295 # Helper to copy the contents of a directory to the server...
297 root = os.path.dirname(path)
298 main = os.path.basename(path)
300 for r, d, f in os.walk(path):
301 rr = os.path.relpath(r, root)
306 lfile = os.path.join(root, rr, ff)
307 if not os.path.islink(lfile):
309 ftp.chmod(ff, os.stat(lfile).st_mode)
310 for i in range(len(rr.split('/'))):
314 logging.info("Preparing server for build...")
315 serverpath = os.path.abspath(os.path.dirname(__file__))
316 ftp.mkdir('fdroidserver')
317 ftp.chdir('fdroidserver')
318 ftp.put(os.path.join(serverpath, '..', 'fdroid'), 'fdroid')
319 ftp.chmod('fdroid', 0o755)
320 send_dir(os.path.join(serverpath))
323 ftp.put(os.path.join(serverpath, '..', 'buildserver',
324 'config.buildserver.py'), 'config.py')
325 ftp.chmod('config.py', 0o600)
327 # Copy over the ID (head commit hash) of the fdroidserver in use...
328 subprocess.call('git rev-parse HEAD >' +
329 os.path.join(os.getcwd(), 'tmp', 'fdroidserverid'),
330 shell=True, cwd=serverpath)
331 ftp.put('tmp/fdroidserverid', 'fdroidserverid')
333 # Copy the metadata - just the file for this app...
334 ftp.mkdir('metadata')
336 ftp.chdir('metadata')
337 ftp.put(os.path.join('metadata', app.id + '.txt'),
339 # And patches if there are any...
340 if os.path.exists(os.path.join('metadata', app.id)):
341 send_dir(os.path.join('metadata', app.id))
344 # Create the build directory...
349 # Copy any extlibs that are required...
351 ftp.chdir(homedir + '/build/extlib')
352 for lib in build.extlibs:
354 libsrc = os.path.join('build/extlib', lib)
355 if not os.path.exists(libsrc):
356 raise BuildException("Missing extlib {0}".format(libsrc))
359 if d not in ftp.listdir():
362 ftp.put(libsrc, lp[-1])
365 # Copy any srclibs that are required...
368 for lib in build.srclibs:
370 common.getsrclib(lib, 'build/srclib', basepath=True, prepare=False))
372 # If one was used for the main source, add that too.
373 basesrclib = vcs.getsrclib()
375 srclibpaths.append(basesrclib)
376 for name, number, lib in srclibpaths:
377 logging.info("Sending srclib '%s'" % lib)
378 ftp.chdir(homedir + '/build/srclib')
379 if not os.path.exists(lib):
380 raise BuildException("Missing srclib directory '" + lib + "'")
381 fv = '.fdroidvcs-' + name
382 ftp.put(os.path.join('build/srclib', fv), fv)
384 # Copy the metadata file too...
385 ftp.chdir(homedir + '/srclibs')
386 ftp.put(os.path.join('srclibs', name + '.txt'),
388 # Copy the main app source code
389 # (no need if it's a srclib)
390 if (not basesrclib) and os.path.exists(build_dir):
391 ftp.chdir(homedir + '/build')
392 fv = '.fdroidvcs-' + app.id
393 ftp.put(os.path.join('build', fv), fv)
396 # Execute the build script...
397 logging.info("Starting build...")
398 chan = sshs.get_transport().open_session()
400 cmdline = os.path.join(homedir, 'fdroidserver', 'fdroid')
401 cmdline += ' build --on-server'
403 cmdline += ' --force --test'
405 cmdline += ' --verbose'
407 cmdline += ' --skip-scan'
408 cmdline += " %s:%s" % (app.id, build.versionCode)
409 chan.exec_command('bash --login -c "' + cmdline + '"')
412 output += get_android_tools_version_log(build.ndk_path()).encode()
413 while not chan.exit_status_ready():
414 while chan.recv_ready():
415 output += chan.recv(1024)
417 logging.info("...getting exit status")
418 returncode = chan.recv_exit_status()
420 get = chan.recv(1024)
425 raise BuildException(
426 "Build.py failed on server for {0}:{1}".format(
427 app.id, build.versionName), str(output, 'utf-8'))
430 toolsversion_log = common.get_toolsversion_logname(app, build)
432 ftp.chdir(os.path.join(homedir, log_dir))
433 ftp.get(toolsversion_log, os.path.join(log_dir, toolsversion_log))
434 logging.debug('retrieved %s', toolsversion_log)
435 except Exception as e:
436 logging.warn('could not get %s from builder vm: %s' % (toolsversion_log, e))
438 # Retrieve the built files...
439 logging.info("Retrieving build output...")
441 ftp.chdir(homedir + '/tmp')
443 ftp.chdir(homedir + '/unsigned')
444 apkfile = common.get_release_filename(app, build)
445 tarball = common.getsrcname(app, build)
447 ftp.get(apkfile, os.path.join(output_dir, apkfile))
448 if not options.notarball:
449 ftp.get(tarball, os.path.join(output_dir, tarball))
451 raise BuildException(
452 "Build failed for %s:%s - missing output files".format(
453 app.id, build.versionName), output)
458 # Suspend the build server.
462 def force_gradle_build_tools(build_dir, build_tools):
463 for root, dirs, files in os.walk(build_dir):
464 for filename in files:
465 if not filename.endswith('.gradle'):
467 path = os.path.join(root, filename)
468 if not os.path.isfile(path):
470 logging.debug("Forcing build-tools %s in %s" % (build_tools, path))
471 common.regsub_file(r"""(\s*)buildToolsVersion([\s=]+).*""",
472 r"""\1buildToolsVersion\2'%s'""" % build_tools,
476 def capitalize_intact(string):
477 """Like str.capitalize(), but leave the rest of the string intact without
478 switching it to lowercase."""
482 return string.upper()
483 return string[0].upper() + string[1:]
486 def get_metadata_from_apk(app, build, apkfile):
487 """get the required metadata from the built APK"""
489 p = SdkToolsPopen(['aapt', 'dump', 'badging', apkfile], output=False)
495 for line in p.output.splitlines():
496 if line.startswith("package:"):
497 pat = re.compile(".*name='([a-zA-Z0-9._]*)'.*")
501 pat = re.compile(".*versionCode='([0-9]*)'.*")
505 pat = re.compile(".*versionName='([^']*)'.*")
509 elif line.startswith("native-code:"):
510 nativecode = line[12:]
512 # Ignore empty strings or any kind of space/newline chars that we don't
514 if nativecode is not None:
515 nativecode = nativecode.strip()
516 nativecode = None if not nativecode else nativecode
518 if build.buildjni and build.buildjni != ['no']:
519 if nativecode is None:
520 raise BuildException("Native code should have been built but none was packaged")
522 vercode = build.versionCode
523 version = build.versionName
524 if not version or not vercode:
525 raise BuildException("Could not find version information in build in output")
527 raise BuildException("Could not find package ID in output")
528 if foundid != app.id:
529 raise BuildException("Wrong package ID - build " + foundid + " but expected " + app.id)
531 return vercode, version
534 def build_local(app, build, vcs, build_dir, output_dir, log_dir, srclib_dir, extlib_dir, tmp_dir, force, onserver, refresh):
535 """Do a build locally."""
537 ndk_path = build.ndk_path()
538 if build.ndk or (build.buildjni and build.buildjni != ['no']):
540 logging.critical("Android NDK version '%s' could not be found!" % build.ndk or 'r12b')
541 logging.critical("Configured versions:")
542 for k, v in config['ndk_paths'].items():
543 if k.endswith("_orig"):
545 logging.critical(" %s: %s" % (k, v))
547 elif not os.path.isdir(ndk_path):
548 logging.critical("Android NDK '%s' is not a directory!" % ndk_path)
551 common.set_FDroidPopen_env(build)
553 # create ..._toolsversion.log when running in builder vm
555 log_path = os.path.join(log_dir,
556 common.get_toolsversion_logname(app, build))
557 with open(log_path, 'w') as f:
558 f.write(get_android_tools_version_log(build.ndk_path()))
560 # Prepare the source code...
561 root_dir, srclibpaths = common.prepare_source(vcs, app, build,
562 build_dir, srclib_dir,
563 extlib_dir, onserver, refresh)
565 # We need to clean via the build tool in case the binary dirs are
566 # different from the default ones
569 bmethod = build.build_method()
570 if bmethod == 'maven':
571 logging.info("Cleaning Maven project...")
572 cmd = [config['mvn3'], 'clean', '-Dandroid.sdk.path=' + config['sdk_path']]
574 if '@' in build.maven:
575 maven_dir = os.path.join(root_dir, build.maven.split('@', 1)[1])
576 maven_dir = os.path.normpath(maven_dir)
580 p = FDroidPopen(cmd, cwd=maven_dir)
582 elif bmethod == 'gradle':
584 logging.info("Cleaning Gradle project...")
586 if build.preassemble:
587 gradletasks += build.preassemble
589 flavours = build.gradle
590 if flavours == ['yes']:
593 flavours_cmd = ''.join([capitalize_intact(flav) for flav in flavours])
595 gradletasks += ['assemble' + flavours_cmd + 'Release']
597 if config['force_build_tools']:
598 force_gradle_build_tools(build_dir, config['build_tools'])
599 for name, number, libpath in srclibpaths:
600 force_gradle_build_tools(libpath, config['build_tools'])
602 cmd = [config['gradle']]
603 if build.gradleprops:
604 cmd += ['-P' + kv for kv in build.gradleprops]
608 p = FDroidPopen(cmd, cwd=root_dir)
610 elif bmethod == 'kivy':
613 elif bmethod == 'ant':
614 logging.info("Cleaning Ant project...")
615 p = FDroidPopen(['ant', 'clean'], cwd=root_dir)
617 if p is not None and p.returncode != 0:
618 raise BuildException("Error cleaning %s:%s" %
619 (app.id, build.versionName), p.output)
621 for root, dirs, files in os.walk(build_dir):
626 shutil.rmtree(os.path.join(root, d))
631 os.remove(os.path.join(root, f))
633 if 'build.gradle' in files:
634 # Even when running clean, gradle stores task/artifact caches in
635 # .gradle/ as binary files. To avoid overcomplicating the scanner,
636 # manually delete them, just like `gradle clean` should have removed
638 del_dirs(['build', '.gradle'])
639 del_files(['gradlew', 'gradlew.bat'])
641 if 'pom.xml' in files:
644 if any(f in files for f in ['ant.properties', 'project.properties', 'build.xml']):
645 del_dirs(['bin', 'gen'])
652 raise BuildException("Refusing to skip source scan since scandelete is present")
654 # Scan before building...
655 logging.info("Scanning source for common problems...")
656 count = scanner.scan_source(build_dir, root_dir, build)
659 logging.warn('Scanner found %d problems' % count)
661 raise BuildException("Can't build due to %d errors while scanning" % count)
663 if not options.notarball:
664 # Build the source tarball right before we build the release...
665 logging.info("Creating source tarball...")
666 tarname = common.getsrcname(app, build)
667 tarball = tarfile.open(os.path.join(tmp_dir, tarname), "w:gz")
670 return any(f.endswith(s) for s in ['.svn', '.git', '.hg', '.bzr'])
671 tarball.add(build_dir, tarname, exclude=tarexc)
674 # Run a build command if one is required...
676 logging.info("Running 'build' commands in %s" % root_dir)
677 cmd = common.replace_config_vars(build.build, build)
679 # Substitute source library paths into commands...
680 for name, number, libpath in srclibpaths:
681 libpath = os.path.relpath(libpath, root_dir)
682 cmd = cmd.replace('$$' + name + '$$', libpath)
684 p = FDroidPopen(['bash', '-x', '-c', cmd], cwd=root_dir)
686 if p.returncode != 0:
687 raise BuildException("Error running build command for %s:%s" %
688 (app.id, build.versionName), p.output)
690 # Build native stuff if required...
691 if build.buildjni and build.buildjni != ['no']:
692 logging.info("Building the native code")
693 jni_components = build.buildjni
695 if jni_components == ['yes']:
696 jni_components = ['']
697 cmd = [os.path.join(ndk_path, "ndk-build"), "-j1"]
698 for d in jni_components:
700 logging.info("Building native code in '%s'" % d)
702 logging.info("Building native code in the main project")
703 manifest = os.path.join(root_dir, d, 'AndroidManifest.xml')
704 if os.path.exists(manifest):
705 # Read and write the whole AM.xml to fix newlines and avoid
706 # the ndk r8c or later 'wordlist' errors. The outcome of this
707 # under gnu/linux is the same as when using tools like
708 # dos2unix, but the native python way is faster and will
709 # work in non-unix systems.
710 manifest_text = open(manifest, 'U').read()
711 open(manifest, 'w').write(manifest_text)
712 # In case the AM.xml read was big, free the memory
714 p = FDroidPopen(cmd, cwd=os.path.join(root_dir, d))
715 if p.returncode != 0:
716 raise BuildException("NDK build failed for %s:%s" % (app.id, build.versionName), p.output)
719 # Build the release...
720 if bmethod == 'maven':
721 logging.info("Building Maven project...")
723 if '@' in build.maven:
724 maven_dir = os.path.join(root_dir, build.maven.split('@', 1)[1])
728 mvncmd = [config['mvn3'], '-Dandroid.sdk.path=' + config['sdk_path'],
729 '-Dmaven.jar.sign.skip=true', '-Dmaven.test.skip=true',
730 '-Dandroid.sign.debug=false', '-Dandroid.release=true',
733 target = build.target.split('-')[1]
734 common.regsub_file(r'<platform>[0-9]*</platform>',
735 r'<platform>%s</platform>' % target,
736 os.path.join(root_dir, 'pom.xml'))
737 if '@' in build.maven:
738 common.regsub_file(r'<platform>[0-9]*</platform>',
739 r'<platform>%s</platform>' % target,
740 os.path.join(maven_dir, 'pom.xml'))
742 p = FDroidPopen(mvncmd, cwd=maven_dir)
744 bindir = os.path.join(root_dir, 'target')
746 elif bmethod == 'kivy':
747 logging.info("Building Kivy project...")
749 spec = os.path.join(root_dir, 'buildozer.spec')
750 if not os.path.exists(spec):
751 raise BuildException("Expected to find buildozer-compatible spec at {0}"
754 defaults = {'orientation': 'landscape', 'icon': '',
755 'permissions': '', 'android.api': "18"}
756 bconfig = ConfigParser(defaults, allow_no_value=True)
759 distdir = os.path.join('python-for-android', 'dist', 'fdroid')
760 if os.path.exists(distdir):
761 shutil.rmtree(distdir)
763 modules = bconfig.get('app', 'requirements').split(',')
765 cmd = 'ANDROIDSDK=' + config['sdk_path']
766 cmd += ' ANDROIDNDK=' + ndk_path
767 cmd += ' ANDROIDNDKVER=' + build.ndk
768 cmd += ' ANDROIDAPI=' + str(bconfig.get('app', 'android.api'))
769 cmd += ' VIRTUALENV=virtualenv'
770 cmd += ' ./distribute.sh'
771 cmd += ' -m ' + "'" + ' '.join(modules) + "'"
773 p = subprocess.Popen(cmd, cwd='python-for-android', shell=True)
774 if p.returncode != 0:
775 raise BuildException("Distribute build failed")
777 cid = bconfig.get('app', 'package.domain') + '.' + bconfig.get('app', 'package.name')
779 raise BuildException("Package ID mismatch between metadata and spec")
781 orientation = bconfig.get('app', 'orientation', 'landscape')
782 if orientation == 'all':
783 orientation = 'sensor'
787 '--name', bconfig.get('app', 'title'),
789 '--version', bconfig.get('app', 'version'),
790 '--orientation', orientation
793 perms = bconfig.get('app', 'permissions')
794 for perm in perms.split(','):
795 cmd.extend(['--permission', perm])
797 if config.get('app', 'fullscreen') == 0:
798 cmd.append('--window')
800 icon = bconfig.get('app', 'icon.filename')
802 cmd.extend(['--icon', os.path.join(root_dir, icon)])
804 cmd.append('release')
805 p = FDroidPopen(cmd, cwd=distdir)
807 elif bmethod == 'gradle':
808 logging.info("Building Gradle project...")
810 cmd = [config['gradle']]
811 if build.gradleprops:
812 cmd += ['-P' + kv for kv in build.gradleprops]
816 p = FDroidPopen(cmd, cwd=root_dir)
818 elif bmethod == 'ant':
819 logging.info("Building Ant project...")
821 if build.antcommands:
822 cmd += build.antcommands
825 p = FDroidPopen(cmd, cwd=root_dir)
827 bindir = os.path.join(root_dir, 'bin')
829 if p is not None and p.returncode != 0:
830 raise BuildException("Build failed for %s:%s" % (app.id, build.versionName), p.output)
831 logging.info("Successfully built version " + build.versionName + ' of ' + app.id)
833 omethod = build.output_method()
834 if omethod == 'maven':
835 stdout_apk = '\n'.join([
836 line for line in p.output.splitlines() if any(
837 a in line for a in ('.apk', '.ap_', '.jar'))])
838 m = re.match(r".*^\[INFO\] .*apkbuilder.*/([^/]*)\.apk",
839 stdout_apk, re.S | re.M)
841 m = re.match(r".*^\[INFO\] Creating additional unsigned apk file .*/([^/]+)\.apk[^l]",
842 stdout_apk, re.S | re.M)
844 m = re.match(r'.*^\[INFO\] [^$]*aapt \[package,[^$]*' + bindir + r'/([^/]+)\.ap[_k][,\]]',
845 stdout_apk, re.S | re.M)
848 m = re.match(r".*^\[INFO\] Building jar: .*/" + bindir + r"/(.+)\.jar",
849 stdout_apk, re.S | re.M)
851 raise BuildException('Failed to find output')
853 src = os.path.join(bindir, src) + '.apk'
854 elif omethod == 'kivy':
855 src = os.path.join('python-for-android', 'dist', 'default', 'bin',
856 '{0}-{1}-release.apk'.format(
857 bconfig.get('app', 'title'),
858 bconfig.get('app', 'version')))
859 elif omethod == 'gradle':
862 os.path.join(root_dir, 'build', 'outputs', 'apk'),
863 os.path.join(root_dir, 'build', 'apk'),
865 for apkglob in ['*-release-unsigned.apk', '*-unsigned.apk', '*.apk']:
866 apks = glob.glob(os.path.join(apks_dir, apkglob))
869 raise BuildException('More than one resulting apks found in %s' % apks_dir,
878 raise BuildException('Failed to find any output apks')
880 elif omethod == 'ant':
881 stdout_apk = '\n'.join([
882 line for line in p.output.splitlines() if '.apk' in line])
883 src = re.match(r".*^.*Creating (.+) for release.*$.*", stdout_apk,
884 re.S | re.M).group(1)
885 src = os.path.join(bindir, src)
886 elif omethod == 'raw':
887 output_path = common.replace_build_vars(build.output, build)
888 globpath = os.path.join(root_dir, output_path)
889 apks = glob.glob(globpath)
891 raise BuildException('Multiple apks match %s' % globpath, '\n'.join(apks))
893 raise BuildException('No apks match %s' % globpath)
894 src = os.path.normpath(apks[0])
896 # Make sure it's not debuggable...
897 if common.isApkAndDebuggable(src, config):
898 raise BuildException("APK is debuggable")
900 # By way of a sanity check, make sure the version and version
901 # code in our new apk match what we expect...
902 logging.debug("Checking " + src)
903 if not os.path.exists(src):
904 raise BuildException("Unsigned apk is not at expected location of " + src)
906 if common.get_file_extension(src) == 'apk':
907 vercode, version = get_metadata_from_apk(app, build, src)
908 if (version != build.versionName or vercode != build.versionCode):
909 raise BuildException(("Unexpected version/version code in output;"
910 " APK: '%s' / '%s', "
911 " Expected: '%s' / '%s'")
912 % (version, str(vercode), build.versionName,
913 str(build.versionCode)))
915 vercode = build.versionCode
916 version = build.versionName
918 # Add information for 'fdroid verify' to be able to reproduce the build
921 metadir = os.path.join(tmp_dir, 'META-INF')
922 if not os.path.exists(metadir):
924 homedir = os.path.expanduser('~')
925 for fn in ['buildserverid', 'fdroidserverid']:
926 shutil.copyfile(os.path.join(homedir, fn),
927 os.path.join(metadir, fn))
928 subprocess.call(['jar', 'uf', os.path.abspath(src),
929 'META-INF/' + fn], cwd=tmp_dir)
931 # Copy the unsigned apk to our destination directory for further
932 # processing (by publish.py)...
933 dest = os.path.join(output_dir, common.get_release_filename(app, build))
934 shutil.copyfile(src, dest)
936 # Move the source tarball into the output directory...
937 if output_dir != tmp_dir and not options.notarball:
938 shutil.move(os.path.join(tmp_dir, tarname),
939 os.path.join(output_dir, tarname))
942 def trybuild(app, build, build_dir, output_dir, log_dir, also_check_dir,
943 srclib_dir, extlib_dir, tmp_dir, repo_dir, vcs, test,
944 server, force, onserver, refresh):
946 Build a particular version of an application, if it needs building.
948 :param output_dir: The directory where the build output will go. Usually
949 this is the 'unsigned' directory.
950 :param repo_dir: The repo directory - used for checking if the build is
952 :paaram also_check_dir: An additional location for checking if the build
953 is necessary (usually the archive repo)
954 :param test: True if building in test mode, in which case the build will
955 always happen, even if the output already exists. In test mode, the
956 output directory should be a temporary location, not any of the real
959 :returns: True if the build was done, False if it wasn't necessary.
962 dest_file = common.get_release_filename(app, build)
964 dest = os.path.join(output_dir, dest_file)
965 dest_repo = os.path.join(repo_dir, dest_file)
968 if os.path.exists(dest) or os.path.exists(dest_repo):
972 dest_also = os.path.join(also_check_dir, dest_file)
973 if os.path.exists(dest_also):
976 if build.disable and not options.force:
979 logging.info("Building version %s (%s) of %s" % (
980 build.versionName, build.versionCode, app.id))
983 # When using server mode, still keep a local cache of the repo, by
984 # grabbing the source now.
985 vcs.gotorevision(build.commit)
987 build_server(app, build, vcs, build_dir, output_dir, log_dir, force)
989 build_local(app, build, vcs, build_dir, output_dir, log_dir, srclib_dir, extlib_dir, tmp_dir, force, onserver, refresh)
993 def get_android_tools_versions(ndk_path=None):
994 '''get a list of the versions of all installed Android SDK/NDK components'''
997 sdk_path = config['sdk_path']
998 if sdk_path[-1] != '/':
1002 ndk_release_txt = os.path.join(ndk_path, 'RELEASE.TXT')
1003 if os.path.isfile(ndk_release_txt):
1004 with open(ndk_release_txt, 'r') as fp:
1005 components.append((os.path.basename(ndk_path), fp.read()[:-1]))
1007 pattern = re.compile('^Pkg.Revision=(.+)', re.MULTILINE)
1008 for root, dirs, files in os.walk(sdk_path):
1009 if 'source.properties' in files:
1010 source_properties = os.path.join(root, 'source.properties')
1011 with open(source_properties, 'r') as fp:
1012 m = pattern.search(fp.read())
1014 components.append((root[len(sdk_path):], m.group(1)))
1019 def get_android_tools_version_log(ndk_path):
1020 '''get a list of the versions of all installed Android SDK/NDK components'''
1021 log = '== Installed Android Tools ==\n\n'
1022 components = get_android_tools_versions(ndk_path)
1023 for name, version in sorted(components):
1024 log += '* ' + name + ' (' + version + ')\n'
1029 def parse_commandline():
1030 """Parse the command line. Returns options, parser."""
1032 parser = ArgumentParser(usage="%(prog)s [options] [APPID[:VERCODE] [APPID[:VERCODE] ...]]")
1033 common.setup_global_opts(parser)
1034 parser.add_argument("appid", nargs='*', help="app-id with optional versionCode in the form APPID[:VERCODE]")
1035 parser.add_argument("-l", "--latest", action="store_true", default=False,
1036 help="Build only the latest version of each package")
1037 parser.add_argument("-s", "--stop", action="store_true", default=False,
1038 help="Make the build stop on exceptions")
1039 parser.add_argument("-t", "--test", action="store_true", default=False,
1040 help="Test mode - put output in the tmp directory only, and always build, even if the output already exists.")
1041 parser.add_argument("--server", action="store_true", default=False,
1042 help="Use build server")
1043 parser.add_argument("--resetserver", action="store_true", default=False,
1044 help="Reset and create a brand new build server, even if the existing one appears to be ok.")
1045 parser.add_argument("--on-server", dest="onserver", action="store_true", default=False,
1046 help="Specify that we're running on the build server")
1047 parser.add_argument("--skip-scan", dest="skipscan", action="store_true", default=False,
1048 help="Skip scanning the source code for binaries and other problems")
1049 parser.add_argument("--dscanner", action="store_true", default=False,
1050 help="Setup an emulator, install the apk on it and perform a drozer scan")
1051 parser.add_argument("--no-tarball", dest="notarball", action="store_true", default=False,
1052 help="Don't create a source tarball, useful when testing a build")
1053 parser.add_argument("--no-refresh", dest="refresh", action="store_false", default=True,
1054 help="Don't refresh the repository, useful when testing a build with no internet connection")
1055 parser.add_argument("-f", "--force", action="store_true", default=False,
1056 help="Force build of disabled apps, and carries on regardless of scan problems. Only allowed in test mode.")
1057 parser.add_argument("-a", "--all", action="store_true", default=False,
1058 help="Build all applications available")
1059 parser.add_argument("-w", "--wiki", default=False, action="store_true",
1060 help="Update the wiki")
1061 metadata.add_metadata_arguments(parser)
1062 options = parser.parse_args()
1063 metadata.warnings_action = options.W
1065 # Force --stop with --on-server to get correct exit code
1066 if options.onserver:
1069 if options.force and not options.test:
1070 parser.error("option %s: Force is only allowed in test mode" % "force")
1072 return options, parser
1077 buildserverid = None
1082 global options, config, buildserverid
1084 options, parser = parse_commandline()
1086 # The defaults for .fdroid.* metadata that is included in a git repo are
1087 # different than for the standard metadata/ layout because expectations
1088 # are different. In this case, the most common user will be the app
1089 # developer working on the latest update of the app on their own machine.
1090 local_metadata_files = common.get_local_metadata_files()
1091 if len(local_metadata_files) == 1: # there is local metadata in an app's source
1092 config = dict(common.default_config)
1093 # `fdroid build` should build only the latest version by default since
1094 # most of the time the user will be building the most recent update
1096 options.latest = True
1097 elif len(local_metadata_files) > 1:
1098 raise FDroidException("Only one local metadata file allowed! Found: "
1099 + " ".join(local_metadata_files))
1101 if not os.path.isdir('metadata') and len(local_metadata_files) == 0:
1102 raise FDroidException("No app metadata found, nothing to process!")
1103 if not options.appid and not options.all:
1104 parser.error("option %s: If you really want to build all the apps, use --all" % "all")
1106 config = common.read_config(options)
1108 if config['build_server_always']:
1109 options.server = True
1110 if options.resetserver and not options.server:
1111 parser.error("option %s: Using --resetserver without --server makes no sense" % "resetserver")
1114 if not os.path.isdir(log_dir):
1115 logging.info("Creating log directory")
1116 os.makedirs(log_dir)
1119 if not os.path.isdir(tmp_dir):
1120 logging.info("Creating temporary directory")
1121 os.makedirs(tmp_dir)
1124 output_dir = tmp_dir
1126 output_dir = 'unsigned'
1127 if not os.path.isdir(output_dir):
1128 logging.info("Creating output directory")
1129 os.makedirs(output_dir)
1131 if config['archive_older'] != 0:
1132 also_check_dir = 'archive'
1134 also_check_dir = None
1139 if not os.path.isdir(build_dir):
1140 logging.info("Creating build directory")
1141 os.makedirs(build_dir)
1142 srclib_dir = os.path.join(build_dir, 'srclib')
1143 extlib_dir = os.path.join(build_dir, 'extlib')
1145 # Read all app and srclib metadata
1146 pkgs = common.read_pkg_args(options.appid, True)
1147 allapps = metadata.read_metadata(not options.onserver, pkgs)
1148 apps = common.read_app_args(options.appid, allapps, True)
1150 for appid, app in list(apps.items()):
1151 if (app.Disabled and not options.force) or not app.RepoType or not app.builds:
1155 raise FDroidException("No apps to process.")
1158 for app in apps.values():
1159 for build in reversed(app.builds):
1160 if build.disable and not options.force:
1162 app.builds = [build]
1167 site = mwclient.Site((config['wiki_protocol'], config['wiki_server']),
1168 path=config['wiki_path'])
1169 site.login(config['wiki_user'], config['wiki_password'])
1171 # Build applications...
1173 build_succeeded = []
1174 for appid, app in apps.items():
1178 for build in app.builds:
1180 tools_version_log = ''
1181 if not options.onserver:
1182 tools_version_log = get_android_tools_version_log(build.ndk_path())
1185 # For the first build of a particular app, we need to set up
1186 # the source repo. We can reuse it on subsequent builds, if
1189 vcs, build_dir = common.setup_vcs(app)
1192 logging.debug("Checking " + build.versionName)
1193 if trybuild(app, build, build_dir, output_dir, log_dir,
1194 also_check_dir, srclib_dir, extlib_dir,
1195 tmp_dir, repo_dir, vcs, options.test,
1196 options.server, options.force,
1197 options.onserver, options.refresh):
1198 toolslog = os.path.join(log_dir,
1199 common.get_toolsversion_logname(app, build))
1200 if not options.onserver and os.path.exists(toolslog):
1201 with open(toolslog, 'r') as f:
1202 tools_version_log = ''.join(f.readlines())
1205 if app.Binaries is not None:
1206 # This is an app where we build from source, and
1207 # verify the apk contents against a developer's
1208 # binary. We get that binary now, and save it
1209 # alongside our built one in the 'unsigend'
1212 url = url.replace('%v', build.versionName)
1213 url = url.replace('%c', str(build.versionCode))
1214 logging.info("...retrieving " + url)
1215 of = common.get_release_filename(app, build) + '.binary'
1216 of = os.path.join(output_dir, of)
1218 net.download_file(url, local_filename=of)
1219 except requests.exceptions.HTTPError as e:
1220 raise FDroidException('downloading Binaries from %s failed' % url) from e
1222 # Now we check weather the build can be verified to
1223 # match the supplied binary or not. Should the
1224 # comparison fail, we mark this build as a failure
1225 # and remove everything from the unsigend folder.
1226 with tempfile.TemporaryDirectory() as tmpdir:
1228 common.get_release_filename(app, build)
1230 os.path.join(output_dir, unsigned_apk)
1232 common.verify_apks(of, unsigned_apk, tmpdir)
1234 logging.debug('removing %s', unsigned_apk)
1235 os.remove(unsigned_apk)
1236 logging.debug('removing %s', of)
1238 compare_result = compare_result.split('\n')
1239 line_count = len(compare_result)
1240 compare_result = compare_result[:299]
1241 if line_count > len(compare_result):
1243 line_count - len(compare_result)
1244 compare_result.append('%d more lines ...' %
1246 compare_result = '\n'.join(compare_result)
1247 raise FDroidException('compared built binary '
1248 'to supplied reference '
1249 'binary but failed',
1252 logging.info('compared built binary to '
1253 'supplied reference binary '
1256 build_succeeded.append(app)
1257 wikilog = "Build succeeded"
1259 except VCSException as vcse:
1260 reason = str(vcse).split('\n', 1)[0] if options.verbose else str(vcse)
1261 logging.error("VCS error while building app %s: %s" % (
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))
1279 failed_apps[appid] = e
1280 wikilog = e.get_wikitext()
1281 except Exception as e:
1282 logging.error("Could not build app %s due to unknown error: %s" % (
1283 appid, traceback.format_exc()))
1286 failed_apps[appid] = e
1289 if options.wiki and wikilog:
1291 # Write a page with the last build log for this version code
1292 lastbuildpage = appid + '/lastbuild_' + build.versionCode
1293 newpage = site.Pages[lastbuildpage]
1294 with open(os.path.join('tmp', 'fdroidserverid')) as fp:
1295 fdroidserverid = fp.read().rstrip()
1296 txt = "* build completed at " + time.strftime("%Y-%m-%d %H:%M:%SZ", time.gmtime()) + '\n' \
1297 + '* fdroidserverid: [https://gitlab.com/fdroid/fdroidserver/commit/' \
1298 + fdroidserverid + ' ' + fdroidserverid + ']\n\n'
1299 if options.onserver:
1300 txt += '* buildserverid: [https://gitlab.com/fdroid/fdroidserver/commit/' \
1301 + buildserverid + ' ' + buildserverid + ']\n\n'
1302 txt += tools_version_log + '\n\n'
1303 txt += '== Build Log ==\n\n' + wikilog
1304 newpage.save(txt, summary='Build log')
1305 # Redirect from /lastbuild to the most recent build log
1306 newpage = site.Pages[appid + '/lastbuild']
1307 newpage.save('#REDIRECT [[' + lastbuildpage + ']]', summary='Update redirect')
1308 except Exception as e:
1309 logging.error("Error while attempting to publish build log: %s" % e)
1311 for app in build_succeeded:
1312 logging.info("success: %s" % (app.id))
1314 if not options.verbose:
1315 for fa in failed_apps:
1316 logging.info("Build for app %s failed:\n%s" % (fa, failed_apps[fa]))
1318 # perform a drozer scan of all successful builds
1319 if options.dscanner and build_succeeded:
1320 from .dscanner import DockerDriver
1322 docker = DockerDriver()
1325 for app in build_succeeded:
1327 logging.info("Need to sign the app before we can install it.")
1328 subprocess.call("fdroid publish {0}".format(app.id), shell=True)
1332 for f in os.listdir(repo_dir):
1333 if f.endswith('.apk') and f.startswith(app.id):
1334 apk_path = os.path.join(repo_dir, f)
1338 raise Exception("No signed APK found at path: {0}".format(apk_path))
1340 if not os.path.isdir(repo_dir):
1343 logging.info("Performing Drozer scan on {0}.".format(app))
1344 docker.perform_drozer_scan(apk_path, app.id, repo_dir)
1345 except Exception as e:
1346 logging.error(str(e))
1347 logging.error("An exception happened. Making sure to clean up")
1349 logging.info("Scan succeeded.")
1351 logging.info("Cleaning up after ourselves.")
1354 logging.info("Finished.")
1355 if len(build_succeeded) > 0:
1356 logging.info(str(len(build_succeeded)) + ' builds succeeded')
1357 if len(failed_apps) > 0:
1358 logging.info(str(len(failed_apps)) + ' builds failed')
1363 if __name__ == "__main__":