2 # -*- coding: utf-8 -*-
4 # build.py - part of the FDroid server tools
5 # Copyright (C) 2010-2014, Ciaran Gultnieks, ciaran@ciarang.com
6 # Copyright (C) 2013-2014 Daniel Martà <mvdan@mvdan.cc>
8 # This program is free software: you can redistribute it and/or modify
9 # it under the terms of the GNU Affero General Public License as published by
10 # the Free Software Foundation, either version 3 of the License, or
11 # (at your option) any later version.
13 # This program is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU Affero General Public License for more details.
18 # You should have received a copy of the GNU Affero General Public License
19 # along with this program. If not, see <http://www.gnu.org/licenses/>.
31 from ConfigParser import ConfigParser
32 from optparse import OptionParser, OptionError
33 from distutils.version import LooseVersion
38 from common import FDroidException, BuildException, VCSException, FDroidPopen, SilentPopen
46 def get_builder_vm_id():
47 vd = os.path.join('builder', '.vagrant')
49 # Vagrant 1.2 (and maybe 1.1?) it's a directory tree...
50 with open(os.path.join(vd, 'machines', 'default',
51 'virtualbox', 'id')) as vf:
55 # Vagrant 1.0 - it's a json file...
56 with open(os.path.join('builder', '.vagrant')) as vf:
58 return v['active']['default']
61 def got_valid_builder_vm():
62 """Returns True if we have a valid-looking builder vm
64 if not os.path.exists(os.path.join('builder', 'Vagrantfile')):
66 vd = os.path.join('builder', '.vagrant')
67 if not os.path.exists(vd):
69 if not os.path.isdir(vd):
70 # Vagrant 1.0 - if the directory is there, it's valid...
72 # Vagrant 1.2 - the directory can exist, but the id can be missing...
73 if not os.path.exists(os.path.join(vd, 'machines', 'default',
79 def vagrant(params, cwd=None, printout=False):
80 """Run a vagrant command.
82 :param: list of parameters to pass to vagrant
83 :cwd: directory to run in, or None for current directory
84 :returns: (ret, out) where ret is the return code, and out
85 is the stdout (and stderr) from vagrant
87 p = FDroidPopen(['vagrant'] + params, cwd=cwd)
88 return (p.returncode, p.output)
91 def get_vagrant_sshinfo():
92 """Get ssh connection info for a vagrant VM
94 :returns: A dictionary containing 'hostname', 'port', 'user'
97 if subprocess.call('vagrant ssh-config >sshconfig',
98 cwd='builder', shell=True) != 0:
99 raise BuildException("Error getting ssh config")
100 vagranthost = 'default' # Host in ssh config file
101 sshconfig = paramiko.SSHConfig()
102 sshf = open('builder/sshconfig', 'r')
103 sshconfig.parse(sshf)
105 sshconfig = sshconfig.lookup(vagranthost)
106 idfile = sshconfig['identityfile']
107 if isinstance(idfile, list):
109 elif idfile.startswith('"') and idfile.endswith('"'):
110 idfile = idfile[1:-1]
111 return {'hostname': sshconfig['hostname'],
112 'port': int(sshconfig['port']),
113 'user': sshconfig['user'],
117 def get_clean_vm(reset=False):
118 """Get a clean VM ready to do a buildserver build.
120 This might involve creating and starting a new virtual machine from
121 scratch, or it might be as simple (unless overridden by the reset
122 parameter) as re-using a snapshot created previously.
124 A BuildException will be raised if anything goes wrong.
126 :reset: True to force creating from scratch.
127 :returns: A dictionary containing 'hostname', 'port', 'user'
130 # Reset existing builder machine to a clean state if possible.
133 logging.info("Checking for valid existing build server")
135 if got_valid_builder_vm():
136 logging.info("...VM is present")
137 p = FDroidPopen(['VBoxManage', 'snapshot',
138 get_builder_vm_id(), 'list',
139 '--details'], cwd='builder')
140 if 'fdroidclean' in p.output:
141 logging.info("...snapshot exists - resetting build server to "
143 retcode, output = vagrant(['status'], cwd='builder')
145 if 'running' in output:
146 logging.info("...suspending")
147 vagrant(['suspend'], cwd='builder')
148 logging.info("...waiting a sec...")
150 p = FDroidPopen(['VBoxManage', 'snapshot', get_builder_vm_id(),
151 'restore', 'fdroidclean'],
154 if p.returncode == 0:
155 logging.info("...reset to snapshot - server is valid")
156 retcode, output = vagrant(['up'], cwd='builder')
158 raise BuildException("Failed to start build server")
159 logging.info("...waiting a sec...")
161 sshinfo = get_vagrant_sshinfo()
164 logging.info("...failed to reset to snapshot")
166 logging.info("...snapshot doesn't exist - "
167 "VBoxManage snapshot list:\n" + p.output)
169 # If we can't use the existing machine for any reason, make a
170 # new one from scratch.
172 if os.path.exists('builder'):
173 logging.info("Removing broken/incomplete/unwanted build server")
174 vagrant(['destroy', '-f'], cwd='builder')
175 shutil.rmtree('builder')
178 p = subprocess.Popen('vagrant --version', shell=True,
179 stdout=subprocess.PIPE)
180 vver = p.communicate()[0]
181 if vver.startswith('Vagrant version 1.2'):
182 with open('builder/Vagrantfile', 'w') as vf:
183 vf.write('Vagrant.configure("2") do |config|\n')
184 vf.write('config.vm.box = "buildserver"\n')
187 with open('builder/Vagrantfile', 'w') as vf:
188 vf.write('Vagrant::Config.run do |config|\n')
189 vf.write('config.vm.box = "buildserver"\n')
192 logging.info("Starting new build server")
193 retcode, _ = vagrant(['up'], cwd='builder')
195 raise BuildException("Failed to start build server")
197 # Open SSH connection to make sure it's working and ready...
198 logging.info("Connecting to virtual machine...")
199 sshinfo = get_vagrant_sshinfo()
200 sshs = paramiko.SSHClient()
201 sshs.set_missing_host_key_policy(paramiko.AutoAddPolicy())
202 sshs.connect(sshinfo['hostname'], username=sshinfo['user'],
203 port=sshinfo['port'], timeout=300,
205 key_filename=sshinfo['idfile'])
208 logging.info("Saving clean state of new build server")
209 retcode, _ = vagrant(['suspend'], cwd='builder')
211 raise BuildException("Failed to suspend build server")
212 logging.info("...waiting a sec...")
214 p = FDroidPopen(['VBoxManage', 'snapshot', get_builder_vm_id(),
215 'take', 'fdroidclean'],
217 if p.returncode != 0:
218 raise BuildException("Failed to take snapshot")
219 logging.info("...waiting a sec...")
221 logging.info("Restarting new build server")
222 retcode, _ = vagrant(['up'], cwd='builder')
224 raise BuildException("Failed to start build server")
225 logging.info("...waiting a sec...")
227 # Make sure it worked...
228 p = FDroidPopen(['VBoxManage', 'snapshot', get_builder_vm_id(),
229 'list', '--details'],
231 if 'fdroidclean' not in p.output:
232 raise BuildException("Failed to take snapshot.")
238 """Release the VM previously started with get_clean_vm().
240 This should always be called.
242 logging.info("Suspending build server")
243 subprocess.call(['vagrant', 'suspend'], cwd='builder')
246 # Note that 'force' here also implies test mode.
247 def build_server(app, thisbuild, vcs, build_dir, output_dir, force):
248 """Do a build on the build server."""
253 raise BuildException("Paramiko is required to use the buildserver")
255 logging.getLogger("paramiko").setLevel(logging.DEBUG)
257 logging.getLogger("paramiko").setLevel(logging.WARN)
259 sshinfo = get_clean_vm()
263 # Open SSH connection...
264 logging.info("Connecting to virtual machine...")
265 sshs = paramiko.SSHClient()
266 sshs.set_missing_host_key_policy(paramiko.AutoAddPolicy())
267 sshs.connect(sshinfo['hostname'], username=sshinfo['user'],
268 port=sshinfo['port'], timeout=300,
269 look_for_keys=False, key_filename=sshinfo['idfile'])
271 homedir = '/home/' + sshinfo['user']
273 # Get an SFTP connection...
274 ftp = sshs.open_sftp()
275 ftp.get_channel().settimeout(15)
277 # Put all the necessary files in place...
280 # Helper to copy the contents of a directory to the server...
282 root = os.path.dirname(path)
283 main = os.path.basename(path)
285 for r, d, f in os.walk(path):
286 rr = os.path.relpath(r, root)
291 lfile = os.path.join(root, rr, ff)
292 if not os.path.islink(lfile):
294 ftp.chmod(ff, os.stat(lfile).st_mode)
295 for i in range(len(rr.split('/'))):
299 logging.info("Preparing server for build...")
300 serverpath = os.path.abspath(os.path.dirname(__file__))
301 ftp.put(os.path.join(serverpath, 'build.py'), 'build.py')
302 ftp.put(os.path.join(serverpath, 'common.py'), 'common.py')
303 ftp.put(os.path.join(serverpath, 'metadata.py'), 'metadata.py')
304 ftp.put(os.path.join(serverpath, '..', 'buildserver',
305 'config.buildserver.py'), 'config.py')
306 ftp.chmod('config.py', 0o600)
308 # Copy over the ID (head commit hash) of the fdroidserver in use...
309 subprocess.call('git rev-parse HEAD >' +
310 os.path.join(os.getcwd(), 'tmp', 'fdroidserverid'),
311 shell=True, cwd=serverpath)
312 ftp.put('tmp/fdroidserverid', 'fdroidserverid')
314 # Copy the metadata - just the file for this app...
315 ftp.mkdir('metadata')
317 ftp.chdir('metadata')
318 ftp.put(os.path.join('metadata', app['id'] + '.txt'),
320 # And patches if there are any...
321 if os.path.exists(os.path.join('metadata', app['id'])):
322 send_dir(os.path.join('metadata', app['id']))
325 # Create the build directory...
330 # Copy any extlibs that are required...
331 if thisbuild['extlibs']:
332 ftp.chdir(homedir + '/build/extlib')
333 for lib in thisbuild['extlibs']:
335 libsrc = os.path.join('build/extlib', lib)
336 if not os.path.exists(libsrc):
337 raise BuildException("Missing extlib {0}".format(libsrc))
340 if d not in ftp.listdir():
343 ftp.put(libsrc, lp[-1])
346 # Copy any srclibs that are required...
348 if thisbuild['srclibs']:
349 for lib in thisbuild['srclibs']:
351 common.getsrclib(lib, 'build/srclib', srclibpaths,
352 basepath=True, prepare=False))
354 # If one was used for the main source, add that too.
355 basesrclib = vcs.getsrclib()
357 srclibpaths.append(basesrclib)
358 for name, number, lib in srclibpaths:
359 logging.info("Sending srclib '%s'" % lib)
360 ftp.chdir(homedir + '/build/srclib')
361 if not os.path.exists(lib):
362 raise BuildException("Missing srclib directory '" + lib + "'")
363 fv = '.fdroidvcs-' + name
364 ftp.put(os.path.join('build/srclib', fv), fv)
366 # Copy the metadata file too...
367 ftp.chdir(homedir + '/srclibs')
368 ftp.put(os.path.join('srclibs', name + '.txt'),
370 # Copy the main app source code
371 # (no need if it's a srclib)
372 if (not basesrclib) and os.path.exists(build_dir):
373 ftp.chdir(homedir + '/build')
374 fv = '.fdroidvcs-' + app['id']
375 ftp.put(os.path.join('build', fv), fv)
378 # Execute the build script...
379 logging.info("Starting build...")
380 chan = sshs.get_transport().open_session()
382 cmdline = 'python build.py --on-server'
384 cmdline += ' --force --test'
386 cmdline += ' --verbose'
387 cmdline += " %s:%s" % (app['id'], thisbuild['vercode'])
388 chan.exec_command('bash -c ". ~/.bsenv && ' + cmdline + '"')
390 while not chan.exit_status_ready():
391 while chan.recv_ready():
392 output += chan.recv(1024)
394 logging.info("...getting exit status")
395 returncode = chan.recv_exit_status()
397 get = chan.recv(1024)
402 raise BuildException(
403 "Build.py failed on server for {0}:{1}".format(
404 app['id'], thisbuild['version']), output)
406 # Retrieve the built files...
407 logging.info("Retrieving build output...")
409 ftp.chdir(homedir + '/tmp')
411 ftp.chdir(homedir + '/unsigned')
412 apkfile = common.getapkname(app, thisbuild)
413 tarball = common.getsrcname(app, thisbuild)
415 ftp.get(apkfile, os.path.join(output_dir, apkfile))
416 if not options.notarball:
417 ftp.get(tarball, os.path.join(output_dir, tarball))
419 raise BuildException(
420 "Build failed for %s:%s - missing output files".format(
421 app['id'], thisbuild['version']), output)
426 # Suspend the build server.
430 def adapt_gradle(build_dir):
431 for root, dirs, files in os.walk(build_dir):
432 if 'build.gradle' in files:
433 path = os.path.join(root, 'build.gradle')
434 logging.debug("Adapting build.gradle at %s" % path)
436 FDroidPopen(['sed', '-i',
437 r's@buildToolsVersion\([ =]*\)["\'][0-9\.]*["\']@buildToolsVersion\1"'
438 + config['build_tools'] + '"@g', path])
441 def build_local(app, thisbuild, vcs, build_dir, output_dir, srclib_dir, extlib_dir, tmp_dir, force, onserver):
442 """Do a build locally."""
444 if thisbuild['buildjni'] and thisbuild['buildjni'] != ['no']:
445 if not config['ndk_path']:
446 logging.critical("$ANDROID_NDK is not set!")
448 elif not os.path.isdir(config['sdk_path']):
449 logging.critical("$ANDROID_NDK points to a non-existing directory!")
452 # Prepare the source code...
453 root_dir, srclibpaths = common.prepare_source(vcs, app, thisbuild,
454 build_dir, srclib_dir,
455 extlib_dir, onserver)
457 # We need to clean via the build tool in case the binary dirs are
458 # different from the default ones
460 if thisbuild['type'] == 'maven':
461 logging.info("Cleaning Maven project...")
462 cmd = [config['mvn3'], 'clean', '-Dandroid.sdk.path=' + config['sdk_path']]
464 if '@' in thisbuild['maven']:
465 maven_dir = os.path.join(root_dir, thisbuild['maven'].split('@', 1)[1])
466 maven_dir = os.path.normpath(maven_dir)
470 p = FDroidPopen(cmd, cwd=maven_dir)
472 elif thisbuild['type'] == 'gradle':
474 logging.info("Cleaning Gradle project...")
475 cmd = [config['gradle'], 'clean']
477 adapt_gradle(build_dir)
478 for name, number, libpath in srclibpaths:
479 adapt_gradle(libpath)
481 p = FDroidPopen(cmd, cwd=root_dir)
483 elif thisbuild['type'] == 'kivy':
486 elif thisbuild['type'] == 'ant':
487 logging.info("Cleaning Ant project...")
488 p = FDroidPopen(['ant', 'clean'], cwd=root_dir)
490 if p is not None and p.returncode != 0:
491 raise BuildException("Error cleaning %s:%s" %
492 (app['id'], thisbuild['version']), p.output)
494 for root, dirs, files in os.walk(build_dir):
495 # Don't remove possibly necessary 'gradle' dirs if 'gradlew' is not there
496 if 'gradlew' in files:
497 logging.debug("Getting rid of Gradle wrapper stuff in %s" % root)
498 os.remove(os.path.join(root, 'gradlew'))
499 if 'gradlew.bat' in files:
500 os.remove(os.path.join(root, 'gradlew.bat'))
502 shutil.rmtree(os.path.join(root, 'gradle'))
504 if not options.skipscan:
505 # Scan before building...
506 logging.info("Scanning source for common problems...")
507 count = common.scan_source(build_dir, root_dir, thisbuild)
510 logging.warn('Scanner found %d problems:' % count)
512 raise BuildException("Can't build due to %d errors while scanning" % count)
514 if not options.notarball:
515 # Build the source tarball right before we build the release...
516 logging.info("Creating source tarball...")
517 tarname = common.getsrcname(app, thisbuild)
518 tarball = tarfile.open(os.path.join(tmp_dir, tarname), "w:gz")
521 return any(f.endswith(s) for s in ['.svn', '.git', '.hg', '.bzr'])
522 tarball.add(build_dir, tarname, exclude=tarexc)
526 manifest = os.path.join(root_dir, 'AndroidManifest.xml')
527 if os.path.exists(manifest):
528 homedir = os.path.expanduser('~')
529 with open(os.path.join(homedir, 'buildserverid'), 'r') as f:
530 buildserverid = f.read()
531 with open(os.path.join(homedir, 'fdroidserverid'), 'r') as f:
532 fdroidserverid = f.read()
533 with open(manifest, 'r') as f:
534 manifestcontent = f.read()
535 manifestcontent = manifestcontent.replace('</manifest>',
536 '<fdroid buildserverid="'
537 + buildserverid + '"'
538 + ' fdroidserverid="'
539 + fdroidserverid + '"'
541 with open(manifest, 'w') as f:
542 f.write(manifestcontent)
544 # Run a build command if one is required...
545 if thisbuild['build']:
546 logging.info("Running 'build' commands in %s" % root_dir)
547 cmd = common.replace_config_vars(thisbuild['build'])
549 # Substitute source library paths into commands...
550 for name, number, libpath in srclibpaths:
551 libpath = os.path.relpath(libpath, root_dir)
552 cmd = cmd.replace('$$' + name + '$$', libpath)
554 p = FDroidPopen(['bash', '-x', '-c', cmd], cwd=root_dir)
556 if p.returncode != 0:
557 raise BuildException("Error running build command for %s:%s" %
558 (app['id'], thisbuild['version']), p.output)
560 # Build native stuff if required...
561 if thisbuild['buildjni'] and thisbuild['buildjni'] != ['no']:
562 logging.info("Building the native code")
563 jni_components = thisbuild['buildjni']
565 if jni_components == ['yes']:
566 jni_components = ['']
567 cmd = [os.path.join(config['ndk_path'], "ndk-build"), "-j1"]
568 for d in jni_components:
570 logging.info("Building native code in '%s'" % d)
572 logging.info("Building native code in the main project")
573 manifest = root_dir + '/' + d + '/AndroidManifest.xml'
574 if os.path.exists(manifest):
575 # Read and write the whole AM.xml to fix newlines and avoid
576 # the ndk r8c or later 'wordlist' errors. The outcome of this
577 # under gnu/linux is the same as when using tools like
578 # dos2unix, but the native python way is faster and will
579 # work in non-unix systems.
580 manifest_text = open(manifest, 'U').read()
581 open(manifest, 'w').write(manifest_text)
582 # In case the AM.xml read was big, free the memory
584 p = FDroidPopen(cmd, cwd=os.path.join(root_dir, d))
585 if p.returncode != 0:
586 raise BuildException("NDK build failed for %s:%s" % (app['id'], thisbuild['version']), p.output)
589 # Build the release...
590 if thisbuild['type'] == 'maven':
591 logging.info("Building Maven project...")
593 if '@' in thisbuild['maven']:
594 maven_dir = os.path.join(root_dir, thisbuild['maven'].split('@', 1)[1])
598 mvncmd = [config['mvn3'], '-Dandroid.sdk.path=' + config['sdk_path'],
599 '-Dmaven.jar.sign.skip=true', '-Dmaven.test.skip=true',
600 '-Dandroid.sign.debug=false', '-Dandroid.release=true',
602 if thisbuild['target']:
603 target = thisbuild["target"].split('-')[1]
604 FDroidPopen(['sed', '-i',
605 's@<platform>[0-9]*</platform>@<platform>'
606 + target + '</platform>@g',
609 if '@' in thisbuild['maven']:
610 FDroidPopen(['sed', '-i',
611 's@<platform>[0-9]*</platform>@<platform>'
612 + target + '</platform>@g',
616 p = FDroidPopen(mvncmd, cwd=maven_dir)
618 bindir = os.path.join(root_dir, 'target')
620 elif thisbuild['type'] == 'kivy':
621 logging.info("Building Kivy project...")
623 spec = os.path.join(root_dir, 'buildozer.spec')
624 if not os.path.exists(spec):
625 raise BuildException("Expected to find buildozer-compatible spec at {0}"
628 defaults = {'orientation': 'landscape', 'icon': '',
629 'permissions': '', 'android.api': "18"}
630 bconfig = ConfigParser(defaults, allow_no_value=True)
633 distdir = 'python-for-android/dist/fdroid'
634 if os.path.exists(distdir):
635 shutil.rmtree(distdir)
637 modules = bconfig.get('app', 'requirements').split(',')
639 cmd = 'ANDROIDSDK=' + config['sdk_path']
640 cmd += ' ANDROIDNDK=' + config['ndk_path']
641 cmd += ' ANDROIDNDKVER=r9'
642 cmd += ' ANDROIDAPI=' + str(bconfig.get('app', 'android.api'))
643 cmd += ' VIRTUALENV=virtualenv'
644 cmd += ' ./distribute.sh'
645 cmd += ' -m ' + "'" + ' '.join(modules) + "'"
647 p = FDroidPopen(cmd, cwd='python-for-android', shell=True)
648 if p.returncode != 0:
649 raise BuildException("Distribute build failed")
651 cid = bconfig.get('app', 'package.domain') + '.' + bconfig.get('app', 'package.name')
653 raise BuildException("Package ID mismatch between metadata and spec")
655 orientation = bconfig.get('app', 'orientation', 'landscape')
656 if orientation == 'all':
657 orientation = 'sensor'
661 '--name', bconfig.get('app', 'title'),
662 '--package', app['id'],
663 '--version', bconfig.get('app', 'version'),
664 '--orientation', orientation
667 perms = bconfig.get('app', 'permissions')
668 for perm in perms.split(','):
669 cmd.extend(['--permission', perm])
671 if config.get('app', 'fullscreen') == 0:
672 cmd.append('--window')
674 icon = bconfig.get('app', 'icon.filename')
676 cmd.extend(['--icon', os.path.join(root_dir, icon)])
678 cmd.append('release')
679 p = FDroidPopen(cmd, cwd=distdir)
681 elif thisbuild['type'] == 'gradle':
682 logging.info("Building Gradle project...")
683 flavours = thisbuild['gradle'].split(',')
685 if len(flavours) == 1 and flavours[0] in ['main', 'yes', '']:
688 commands = [config['gradle']]
689 if thisbuild['preassemble']:
690 commands += thisbuild['preassemble'].split()
692 flavours_cmd = ''.join(flavours)
694 flavours_cmd = flavours_cmd[0].upper() + flavours_cmd[1:]
696 commands += ['assemble' + flavours_cmd + 'Release']
698 # Avoid having to use lintOptions.abortOnError false
699 if thisbuild['gradlepluginver'] >= LooseVersion('0.7'):
700 with open(os.path.join(root_dir, 'build.gradle'), "a") as f:
701 f.write("\nandroid { lintOptions { checkReleaseBuilds false } }\n")
703 p = FDroidPopen(commands, cwd=root_dir)
705 elif thisbuild['type'] == 'ant':
706 logging.info("Building Ant project...")
708 if thisbuild['antcommand']:
709 cmd += [thisbuild['antcommand']]
712 p = FDroidPopen(cmd, cwd=root_dir)
714 bindir = os.path.join(root_dir, 'bin')
716 if p is not None and p.returncode != 0:
717 raise BuildException("Build failed for %s:%s" % (app['id'], thisbuild['version']), p.output)
718 logging.info("Successfully built version " + thisbuild['version'] + ' of ' + app['id'])
720 if thisbuild['type'] == 'maven':
721 stdout_apk = '\n'.join([
722 line for line in p.output.splitlines() if any(a in line for a in ('.apk', '.ap_'))])
723 m = re.match(r".*^\[INFO\] .*apkbuilder.*/([^/]*)\.apk",
724 stdout_apk, re.S | re.M)
726 m = re.match(r".*^\[INFO\] Creating additional unsigned apk file .*/([^/]+)\.apk[^l]",
727 stdout_apk, re.S | re.M)
729 m = re.match(r'.*^\[INFO\] [^$]*aapt \[package,[^$]*' + bindir + r'/([^/]+)\.ap[_k][,\]]',
730 stdout_apk, re.S | re.M)
732 raise BuildException('Failed to find output')
734 src = os.path.join(bindir, src) + '.apk'
735 elif thisbuild['type'] == 'kivy':
736 src = 'python-for-android/dist/default/bin/{0}-{1}-release.apk'.format(
737 bconfig.get('app', 'title'), bconfig.get('app', 'version'))
738 elif thisbuild['type'] == 'gradle':
740 if thisbuild['gradlepluginver'] >= LooseVersion('0.11'):
741 apks_dir = os.path.join(root_dir, 'build', 'outputs', 'apk')
743 apks_dir = os.path.join(root_dir, 'build', 'apk')
745 apks = glob.glob(os.path.join(apks_dir, '*-release-unsigned.apk'))
747 raise BuildException('More than one resulting apks found in %s' % apks_dir,
750 raise BuildException('Failed to find gradle output in %s' % apks_dir)
752 elif thisbuild['type'] == 'ant':
753 stdout_apk = '\n'.join([
754 line for line in p.output.splitlines() if '.apk' in line])
755 src = re.match(r".*^.*Creating (.+) for release.*$.*", stdout_apk,
756 re.S | re.M).group(1)
757 src = os.path.join(bindir, src)
758 elif thisbuild['type'] == 'raw':
759 src = os.path.join(root_dir, thisbuild['output'])
760 src = os.path.normpath(src)
762 # Make sure it's not debuggable...
763 if common.isApkDebuggable(src, config):
764 raise BuildException("APK is debuggable")
766 # By way of a sanity check, make sure the version and version
767 # code in our new apk match what we expect...
768 logging.debug("Checking " + src)
769 if not os.path.exists(src):
770 raise BuildException("Unsigned apk is not at expected location of " + src)
772 p = SilentPopen([config['aapt'], 'dump', 'badging', src])
778 for line in p.output.splitlines():
779 if line.startswith("package:"):
780 pat = re.compile(".*name='([a-zA-Z0-9._]*)'.*")
784 pat = re.compile(".*versionCode='([0-9]*)'.*")
788 pat = re.compile(".*versionName='([^']*)'.*")
792 elif line.startswith("native-code:"):
793 nativecode = line[12:]
795 # Ignore empty strings or any kind of space/newline chars that we don't
797 if nativecode is not None:
798 nativecode = nativecode.strip()
799 nativecode = None if not nativecode else nativecode
801 if thisbuild['buildjni'] and thisbuild['buildjni'] != ['no']:
802 if nativecode is None:
803 raise BuildException("Native code should have been built but none was packaged")
804 if thisbuild['novcheck']:
805 vercode = thisbuild['vercode']
806 version = thisbuild['version']
807 if not version or not vercode:
808 raise BuildException("Could not find version information in build in output")
810 raise BuildException("Could not find package ID in output")
811 if foundid != app['id']:
812 raise BuildException("Wrong package ID - build " + foundid + " but expected " + app['id'])
814 # Some apps (e.g. Timeriffic) have had the bonkers idea of
815 # including the entire changelog in the version number. Remove
816 # it so we can compare. (TODO: might be better to remove it
817 # before we compile, in fact)
818 index = version.find(" //")
820 version = version[:index]
822 if (version != thisbuild['version'] or
823 vercode != thisbuild['vercode']):
824 raise BuildException(("Unexpected version/version code in output;"
825 " APK: '%s' / '%s', "
826 " Expected: '%s' / '%s'")
827 % (version, str(vercode), thisbuild['version'],
828 str(thisbuild['vercode']))
831 # Copy the unsigned apk to our destination directory for further
832 # processing (by publish.py)...
833 dest = os.path.join(output_dir, common.getapkname(app, thisbuild))
834 shutil.copyfile(src, dest)
836 # Move the source tarball into the output directory...
837 if output_dir != tmp_dir and not options.notarball:
838 shutil.move(os.path.join(tmp_dir, tarname),
839 os.path.join(output_dir, tarname))
842 def trybuild(app, thisbuild, build_dir, output_dir, also_check_dir, srclib_dir, extlib_dir,
843 tmp_dir, repo_dir, vcs, test, server, force, onserver):
845 Build a particular version of an application, if it needs building.
847 :param output_dir: The directory where the build output will go. Usually
848 this is the 'unsigned' directory.
849 :param repo_dir: The repo directory - used for checking if the build is
851 :paaram also_check_dir: An additional location for checking if the build
852 is necessary (usually the archive repo)
853 :param test: True if building in test mode, in which case the build will
854 always happen, even if the output already exists. In test mode, the
855 output directory should be a temporary location, not any of the real
858 :returns: True if the build was done, False if it wasn't necessary.
861 dest_apk = common.getapkname(app, thisbuild)
863 dest = os.path.join(output_dir, dest_apk)
864 dest_repo = os.path.join(repo_dir, dest_apk)
867 if os.path.exists(dest) or os.path.exists(dest_repo):
871 dest_also = os.path.join(also_check_dir, dest_apk)
872 if os.path.exists(dest_also):
875 if thisbuild['disable']:
878 logging.info("Building version %s (%s) of %s" % (
879 thisbuild['version'], thisbuild['vercode'], app['id']))
882 # When using server mode, still keep a local cache of the repo, by
883 # grabbing the source now.
884 vcs.gotorevision(thisbuild['commit'])
886 build_server(app, thisbuild, vcs, build_dir, output_dir, force)
888 build_local(app, thisbuild, vcs, build_dir, output_dir, srclib_dir, extlib_dir, tmp_dir, force, onserver)
892 def parse_commandline():
893 """Parse the command line. Returns options, args."""
895 parser = OptionParser(usage="Usage: %prog [options] [APPID[:VERCODE] [APPID[:VERCODE] ...]]")
896 parser.add_option("-v", "--verbose", action="store_true", default=False,
897 help="Spew out even more information than normal")
898 parser.add_option("-q", "--quiet", action="store_true", default=False,
899 help="Restrict output to warnings and errors")
900 parser.add_option("-l", "--latest", action="store_true", default=False,
901 help="Build only the latest version of each package")
902 parser.add_option("-s", "--stop", action="store_true", default=False,
903 help="Make the build stop on exceptions")
904 parser.add_option("-t", "--test", action="store_true", default=False,
905 help="Test mode - put output in the tmp directory only, and always build, even if the output already exists.")
906 parser.add_option("--server", action="store_true", default=False,
907 help="Use build server")
908 parser.add_option("--resetserver", action="store_true", default=False,
909 help="Reset and create a brand new build server, even if the existing one appears to be ok.")
910 parser.add_option("--on-server", dest="onserver", action="store_true", default=False,
911 help="Specify that we're running on the build server")
912 parser.add_option("--skip-scan", dest="skipscan", action="store_true", default=False,
913 help="Skip scanning the source code for binaries and other problems")
914 parser.add_option("--no-tarball", dest="notarball", action="store_true", default=False,
915 help="Don't create a source tarball, useful when testing a build")
916 parser.add_option("-f", "--force", action="store_true", default=False,
917 help="Force build of disabled apps, and carries on regardless of scan problems. Only allowed in test mode.")
918 parser.add_option("-a", "--all", action="store_true", default=False,
919 help="Build all applications available")
920 parser.add_option("-w", "--wiki", default=False, action="store_true",
921 help="Update the wiki")
922 options, args = parser.parse_args()
924 # Force --stop with --on-server to get correct exit code
928 if options.force and not options.test:
929 raise OptionError("Force is only allowed in test mode", "force")
939 global options, config
941 options, args = parse_commandline()
942 if not args and not options.all:
943 raise OptionError("If you really want to build all the apps, use --all", "all")
945 config = common.read_config(options)
947 if config['build_server_always']:
948 options.server = True
949 if options.resetserver and not options.server:
950 raise OptionError("Using --resetserver without --server makes no sense", "resetserver")
953 if not os.path.isdir(log_dir):
954 logging.info("Creating log directory")
958 if not os.path.isdir(tmp_dir):
959 logging.info("Creating temporary directory")
965 output_dir = 'unsigned'
966 if not os.path.isdir(output_dir):
967 logging.info("Creating output directory")
968 os.makedirs(output_dir)
970 if config['archive_older'] != 0:
971 also_check_dir = 'archive'
973 also_check_dir = None
978 if not os.path.isdir(build_dir):
979 logging.info("Creating build directory")
980 os.makedirs(build_dir)
981 srclib_dir = os.path.join(build_dir, 'srclib')
982 extlib_dir = os.path.join(build_dir, 'extlib')
984 # Read all app and srclib metadata
985 allapps = metadata.read_metadata(xref=not options.onserver)
987 apps = common.read_app_args(args, allapps, True)
988 apps = [app for app in apps if (options.force or not app['Disabled']) and
989 len(app['Repo Type']) > 0 and len(app['builds']) > 0]
992 raise FDroidException("No apps to process.")
996 for build in reversed(app['builds']):
999 app['builds'] = [build]
1004 site = mwclient.Site((config['wiki_protocol'], config['wiki_server']),
1005 path=config['wiki_path'])
1006 site.login(config['wiki_user'], config['wiki_password'])
1008 # Build applications...
1010 build_succeeded = []
1015 for thisbuild in app['builds']:
1019 # For the first build of a particular app, we need to set up
1020 # the source repo. We can reuse it on subsequent builds, if
1023 if app['Repo Type'] == 'srclib':
1024 build_dir = os.path.join('build', 'srclib', app['Repo'])
1026 build_dir = os.path.join('build', app['id'])
1028 # Set up vcs interface and make sure we have the latest code...
1029 logging.debug("Getting {0} vcs interface for {1}"
1030 .format(app['Repo Type'], app['Repo']))
1031 vcs = common.getvcs(app['Repo Type'], app['Repo'], build_dir)
1035 logging.debug("Checking " + thisbuild['version'])
1036 if trybuild(app, thisbuild, build_dir, output_dir,
1037 also_check_dir, srclib_dir, extlib_dir,
1038 tmp_dir, repo_dir, vcs, options.test,
1039 options.server, options.force,
1041 build_succeeded.append(app)
1042 wikilog = "Build succeeded"
1043 except BuildException as be:
1044 logfile = open(os.path.join(log_dir, app['id'] + '.log'), 'a+')
1045 logfile.write(str(be))
1047 print("Could not build app %s due to BuildException: %s" % (app['id'], be))
1050 failed_apps[app['id']] = be
1051 wikilog = be.get_wikitext()
1052 except VCSException as vcse:
1053 reason = str(vcse).split('\n', 1)[0] if options.verbose else str(vcse)
1054 logging.error("VCS error while building app %s: %s" % (
1058 failed_apps[app['id']] = vcse
1060 except Exception as e:
1061 logging.error("Could not build app %s due to unknown error: %s" % (
1062 app['id'], traceback.format_exc()))
1065 failed_apps[app['id']] = e
1068 if options.wiki and wikilog:
1070 # Write a page with the last build log for this version code
1071 lastbuildpage = app['id'] + '/lastbuild_' + thisbuild['vercode']
1072 newpage = site.Pages[lastbuildpage]
1073 txt = "Build completed at " + time.strftime("%Y-%m-%d %H:%M:%SZ", time.gmtime()) + "\n\n" + wikilog
1074 newpage.save(txt, summary='Build log')
1075 # Redirect from /lastbuild to the most recent build log
1076 newpage = site.Pages[app['id'] + '/lastbuild']
1077 newpage.save('#REDIRECT [[' + lastbuildpage + ']]', summary='Update redirect')
1079 logging.error("Error while attempting to publish build log")
1081 for app in build_succeeded:
1082 logging.info("success: %s" % (app['id']))
1084 if not options.verbose:
1085 for fa in failed_apps:
1086 logging.info("Build for app %s failed:\n%s" % (fa, failed_apps[fa]))
1088 logging.info("Finished.")
1089 if len(build_succeeded) > 0:
1090 logging.info(str(len(build_succeeded)) + ' builds succeeded')
1091 if len(failed_apps) > 0:
1092 logging.info(str(len(failed_apps)) + ' builds failed')
1096 if __name__ == "__main__":