3 # Copyright (C) 2012-2022 Carl Hetherington <cth@carlh.net>
5 # This program is free software; you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 2 of the License, or
8 # (at your option) any later version.
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with this program; if not, write to the Free Software
17 # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19 from __future__ import print_function
27 import multiprocessing
29 from pathlib import Path
40 class Error(Exception):
41 def __init__(self, value):
50 Store for Tree objects which re-uses already-created objects
51 and checks for requests for different versions of the same thing.
57 def get(self, name, commit_ish, target, required_by=None):
59 if t.name == name and t.commit_ish == commit_ish and t.target == target:
61 elif t.name == name and t.commit_ish != commit_ish:
62 a = commit_ish if commit_ish is not None else "[Any]"
63 if required_by is not None:
64 a += ' by %s' % required_by
65 b = t.commit_ish if t.commit_ish is not None else "[Any]"
66 if t.required_by is not None:
67 b += ' by %s' % t.required_by
68 raise Error('conflicting versions of %s required (%s versus %s)' % (name, a, b))
70 nt = Tree(name, commit_ish, target, required_by)
74 def add_built(self, name, commit_ish, target):
75 self.trees.append(Tree(name, commit_ish, target, None, built=True))
82 use_git_reference = True
93 def __init__(self, key, default=None):
97 def offer(self, key, value):
102 def __init__(self, key):
106 def offer(self, key, value):
108 self.value = value in ['yes', '1', 'true']
112 self.options = [ Option('mxe_prefix'),
113 Option('git_prefix'),
114 Option('git_reference'),
115 Option('osx_environment_prefix'),
116 Option('osx_sdk_prefix'),
118 Option('osx_intel_deployment'),
119 Option('osx_arm_deployment'),
120 Option('osx_old_deployment'),
121 Option('osx_keychain_file'),
122 Option('osx_keychain_password'),
124 Option('apple_password'),
125 Option('apple_team_id'),
126 BoolOption('docker_sudo'),
127 BoolOption('docker_no_user'),
128 Option('docker_hub_repository'),
129 Option('flatpak_state_dir'),
130 Option('parallel', multiprocessing.cpu_count()),
131 Option('temp', '/var/tmp'),
132 Option('osx_notarytool', ['xcrun', 'notarytool'])]
134 config_dir = '%s/.config' % os.path.expanduser('~')
135 if not os.path.exists(config_dir):
137 config_file = '%s/cdist' % config_dir
138 if not os.path.exists(config_file):
139 f = open(config_file, 'w')
140 for o in self.options:
141 print('# %s ' % o.key, file=f)
143 print('Template config file written to %s; please edit and try again.' % config_file, file=sys.stderr)
146 f = open('%s/.config/cdist' % os.path.expanduser('~'), 'r')
152 if len(l) > 0 and l[0] == '#':
155 s = l.strip().split()
157 for k in self.options:
160 if not isinstance(self.get('osx_notarytool'), list):
161 self.set('osx_notarytool', [self.get('osx_notarytool')])
165 for o in self.options:
166 if o.key == k and o.value is not None:
171 for o in self.options:
174 raise Error('Required setting %s not found' % k)
178 for o in self.options:
182 if self.get('docker_sudo'):
194 if not globals.quiet:
195 print('\x1b[33m* %s\x1b[0m' % m)
199 print('\x1b[35m* %s\x1b[0m' % m)
201 def escape_spaces(s):
202 return s.replace(' ', '\\ ')
205 """Escape a host:filename string for use with an scp command"""
207 assert(len(s) == 1 or len(s) == 2)
209 return '%s:"\'%s\'"' % (s[0], s[1])
211 return '\"%s\"' % s[0]
214 return '\"%s\"' % n.substr(' ', '\\ ')
217 log_normal('copy %s -> %s' % (scp_escape(a), scp_escape(b)))
218 if b.startswith('s3://'):
219 command('s3cmd -P -r put "%s" "%s"' % (a, b))
221 command('scp -r %s %s' % (scp_escape(a), scp_escape(b)))
224 log_normal('copy %s -> %s with cwd %s' % (scp_escape(a), scp_escape(b), os.getcwd()))
225 if b.startswith('s3://'):
226 command('s3cmd -P put "%s" "%s"' % (a, b))
232 temp_path = os.path.join(os.path.dirname(path), ".tmp." + os.path.basename(path))
233 command('scp %s %s' % (scp_escape(a), scp_escape(host + ":" + temp_path)))
234 command('ssh %s -- mv "%s" "%s"' % (host, escape_spaces(temp_path), escape_spaces(path)))
236 command('scp %s %s' % (scp_escape(a), scp_escape(b)))
240 Make directories either locally or on a remote host; remotely if
241 d includes a colon, otherwise locally.
243 if d.startswith('s3://'):
244 # No need to create folders on S3
247 if d.find(':') == -1:
255 command('ssh %s -- mkdir -p %s' % (s[0], s[1]))
258 log_normal('remove %s' % a)
262 log_normal('remove %s' % a)
263 shutil.rmtree(a, ignore_errors=True)
268 r = subprocess.run(c, shell=True)
269 if r.returncode != 0:
270 raise Error('command %s failed (%d)' % (c, r.returncode))
271 except Exception as e:
272 raise Error('command %s failed (%s)' % (c, e))
274 def command_and_read(c):
276 p = subprocess.Popen(c.split(), stdout=subprocess.PIPE, stderr=subprocess.PIPE)
277 (out, err) = p.communicate()
278 if p.returncode != 0:
279 raise Error('command %s failed (%s)' % (c, err))
280 return str(out, 'utf-8').splitlines()
282 def read_wscript_variable(directory, variable):
283 f = open('%s/wscript' % directory, 'r')
290 if len(s) == 3 and s[0] == variable:
298 def devel_to_git(git_commit, filename):
299 if git_commit is not None:
300 filename = filename.replace('devel', '-%s' % git_commit)
304 def get_command_line_options(args):
305 """Get the options specified by --option on the command line"""
307 if args.option is not None:
308 for o in args.option:
311 raise Error("Bad option `%s'" % o)
313 options[b[0]] = False
322 def __init__(self, tree):
325 self.cwd = os.getcwd()
326 os.chdir('%s/src/%s' % (self.tree.target.directory, self.tree.name))
327 def __exit__(self, type, value, traceback):
335 def __init__(self, s):
338 if s.startswith("'"):
343 if s.endswith('devel'):
347 if s.endswith('pre'):
351 self.major = int(p[0])
352 self.minor = int(p[1])
354 self.micro = int(p[2])
359 def from_git_tag(cls, tag):
360 bits = tag.split('-')
362 if len(bits) > 1 and int(bits[1]) > 0:
366 def bump_minor(self):
370 def bump_micro(self):
376 def to_release(self):
380 s = '%d.%d.%d' % (self.major, self.minor, self.micro)
392 Class representing the target that we are building for. This is exposed to cscripts,
393 though not all of it is guaranteed 'API'. cscripts may expect:
395 platform: platform string (e.g. 'windows', 'linux', 'osx')
396 parallel: number of parallel jobs to run
397 directory: directory to work in
398 variables: dict of environment variables
399 debug: True to build a debug version, otherwise False
400 ccache: True to use ccache, False to not
401 set(a, b): set the value of variable 'a' to 'b'
402 unset(a): unset the value of variable 'a'
403 command(c): run the command 'c' in the build environment
407 def __init__(self, platform, directory=None):
409 platform -- platform string (e.g. 'windows', 'linux', 'osx')
410 directory -- directory to work in; if None we will use a temporary directory
411 Temporary directories will be removed after use; specified directories will not.
413 self.platform = platform
414 self.parallel = int(config.get('parallel'))
416 # Environment variables that we will use when we call cscripts
420 # True to build our dependencies ourselves; False if this is taken care
421 # of in some other way
422 self.build_dependencies = True
424 if directory is None:
426 os.makedirs(config.get('temp'))
430 self.directory = tempfile.mkdtemp('', 'tmp', config.get('temp'))
432 self.set('CCACHE_BASEDIR', os.path.realpath(self.directory))
433 self.set('CCACHE_NOHASHDIR', '')
435 self.directory = os.path.realpath(directory)
442 def _cscript_package(self, tree, options):
444 Call package() in the cscript and return what it returns, except that
445 anything not in a list will be put into one.
447 if len(inspect.getfullargspec(tree.cscript['package']).args) == 3:
448 packages = tree.call('package', tree.version, options)
450 log_normal("Deprecated cscript package() method with no options parameter")
451 packages = tree.call('package', tree.version)
453 return packages if isinstance(packages, list) else [packages]
455 def _copy_packages(self, tree, packages, output_dir):
457 copyfile(p, os.path.join(output_dir, os.path.basename(devel_to_git(tree.commit, p))))
459 def package(self, project, checkout, output_dir, options, notarize):
460 tree = self.build(project, checkout, options, for_package=True)
461 tree.add_defaults(options)
462 p = self._cscript_package(tree, options)
463 self._copy_packages(tree, p, output_dir)
465 def build(self, project, checkout, options, for_package=False):
466 tree = globals.trees.get(project, checkout, self)
467 if self.build_dependencies:
468 tree.build_dependencies(options)
469 tree.build(options, for_package=for_package)
472 def test(self, project, checkout, target, test, options):
473 """test is the test case to run, or None"""
474 tree = globals.trees.get(project, checkout, target)
476 tree.add_defaults(options)
477 with TreeDirectory(tree):
478 if len(inspect.getfullargspec(tree.cscript['test']).args) == 3:
479 return tree.call('test', options, test)
481 log_normal('Deprecated cscript test() method with no options parameter')
482 return tree.call('test', test)
485 self.variables[a] = b
488 del(self.variables[a])
491 return self.variables[a]
493 def append(self, k, v, s):
494 if (not k in self.variables) or len(self.variables[k]) == 0:
495 self.variables[k] = '"%s"' % v
497 e = self.variables[k]
498 if e[0] == '"' and e[-1] == '"':
499 self.variables[k] = '"%s%s%s"' % (e[1:-1], s, v)
501 self.variables[k] = '"%s%s%s"' % (e, s, v)
503 def append_with_space(self, k, v):
504 return self.append(k, v, ' ')
506 def append_with_colon(self, k, v):
507 return self.append(k, v, ':')
509 def variables_string(self, escaped_quotes=False):
511 for k, v in self.variables.items():
513 v = v.replace('"', '\\"')
514 e += '%s=%s ' % (k, v)
519 rmtree(self.directory)
533 class DockerTarget(Target):
534 def __init__(self, platform, directory):
535 super(DockerTarget, self).__init__(platform, directory)
537 self.privileged = False
540 if config.get('docker_no_user'):
542 return '-u %s' % getpass.getuser()
544 def _mount_option(self, d):
545 return '-v %s:%s ' % (os.path.realpath(d), os.path.realpath(d))
548 opts = self._mount_option(self.directory)
549 for m in self.mounts:
550 opts += self._mount_option(m)
551 if config.has('git_reference'):
552 opts += self._mount_option(config.get('git_reference'))
554 opts += '--privileged=true '
556 opts += "-e CCACHE_DIR=/ccache/%s-%d --mount source=ccache,target=/ccache " % (self.image, os.getuid())
560 if config.has('docker_hub_repository'):
561 tag = '%s:%s' % (config.get('docker_hub_repository'), tag)
563 def signal_handler(signum, frame):
564 raise Error('Killed')
565 signal.signal(signal.SIGTERM, signal_handler)
567 self.container = command_and_read('%s run %s %s -itd %s /bin/bash' % (config.docker(), self._user_tag(), opts, tag))[0].strip()
569 def command(self, cmd):
570 dir = os.path.join(self.directory, os.path.relpath(os.getcwd(), self.directory))
571 interactive_flag = '-i ' if sys.stdin.isatty() else ''
572 command('%s exec %s %s -t %s /bin/bash -c \'export %s; cd %s; %s\'' % (config.docker(), self._user_tag(), interactive_flag, self.container, self.variables_string(), dir, cmd))
575 super(DockerTarget, self).cleanup()
576 command('%s kill %s' % (config.docker(), self.container))
579 self.mounts.append(m)
582 class WindowsDockerTarget(DockerTarget):
584 This target exposes the following additional API:
586 version: Windows version ('xp' or None)
587 bits: bitness of Windows (32 or 64)
588 name: name of our target e.g. x86_64-w64-mingw32.shared
589 environment_prefix: path to Windows environment for the appropriate target (libraries and some tools)
590 tool_path: path to 32- and 64-bit tools
592 def __init__(self, windows_version, bits, directory, environment_version):
593 super(WindowsDockerTarget, self).__init__('windows', directory)
594 self.version = windows_version
597 self.tool_path = '%s/usr/bin' % config.get('mxe_prefix')
599 self.name = 'i686-w64-mingw32.shared'
601 self.name = 'x86_64-w64-mingw32.shared'
602 self.environment_prefix = '%s/usr/%s' % (config.get('mxe_prefix'), self.name)
604 self.set('PKG_CONFIG_LIBDIR', '%s/lib/pkgconfig' % self.environment_prefix)
605 self.set('PKG_CONFIG_PATH', '%s/lib/pkgconfig:%s/bin/pkgconfig' % (self.directory, self.directory))
606 self.set('PATH', '%s/bin:%s:%s' % (self.environment_prefix, self.tool_path, os.environ['PATH']))
607 self.set('LD', '%s-ld' % self.name)
608 self.set('RANLIB', '%s-ranlib' % self.name)
609 self.set('WINRC', '%s-windres' % self.name)
610 cxx = '-I%s/include -I%s/include' % (self.environment_prefix, self.directory)
611 link = '-L%s/lib -L%s/lib' % (self.environment_prefix, self.directory)
612 self.set('CXXFLAGS', '"%s"' % cxx)
613 self.set('CPPFLAGS', '')
614 self.set('LINKFLAGS', '"%s"' % link)
615 self.set('LDFLAGS', '"%s"' % link)
617 self.image = 'windows'
618 if environment_version is not None:
619 self.image += '_%s' % environment_version
624 self.set('CC', '"ccache %s-gcc"' % self.name)
625 self.set('CXX', '"ccache %s-g++"' % self.name)
627 self.set('CC', '%s-gcc' % self.name)
628 self.set('CXX', '%s-g++' % self.name)
631 def library_prefix(self):
632 log_normal('Deprecated property library_prefix: use environment_prefix')
633 return self.environment_prefix
636 def windows_prefix(self):
637 log_normal('Deprecated property windows_prefix: use environment_prefix')
638 return self.environment_prefix
641 def mingw_prefixes(self):
642 log_normal('Deprecated property mingw_prefixes: use environment_prefix')
643 return [self.environment_prefix]
646 def mingw_path(self):
647 log_normal('Deprecated property mingw_path: use tool_path')
648 return self.tool_path
651 def mingw_name(self):
652 log_normal('Deprecated property mingw_name: use name')
656 class WindowsNativeTarget(Target):
658 This target exposes the following additional API:
660 version: Windows version ('xp' or None)
661 bits: bitness of Windows (32 or 64)
662 name: name of our target e.g. x86_64-w64-mingw32.shared
663 environment_prefix: path to Windows environment for the appropriate target (libraries and some tools)
665 def __init__(self, directory):
666 super().__init__('windows', directory)
670 self.environment_prefix = config.get('windows_native_environmnet_prefix')
672 self.set('PATH', '%s/bin:%s' % (self.environment_prefix, os.environ['PATH']))
674 def command(self, cmd):
678 class LinuxTarget(DockerTarget):
680 Build for Linux in a docker container.
681 This target exposes the following additional API:
683 distro: distribution ('debian', 'ubuntu', 'centos' or 'fedora')
684 version: distribution version (e.g. '12.04', '8', '6.5')
685 bits: bitness of the distribution (32 or 64)
686 detail: None or 'appimage' if we are building for appimage
689 def __init__(self, distro, version, bits, directory=None):
690 super(LinuxTarget, self).__init__('linux', directory)
692 self.version = version
696 self.set('CXXFLAGS', '-I%s/include' % self.directory)
697 self.set('CPPFLAGS', '')
698 self.set('LINKFLAGS', '-L%s/lib' % self.directory)
699 self.set('PKG_CONFIG_PATH',
700 '%s/lib/pkgconfig:%s/lib64/pkgconfig:/usr/local/lib64/pkgconfig:/usr/local/lib/pkgconfig' % (self.directory, self.directory))
701 self.set('PATH', '/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin')
703 if self.version is None:
704 self.image = '%s-%s' % (self.distro, self.bits)
706 self.image = '%s-%s-%s' % (self.distro, self.version, self.bits)
709 super(LinuxTarget, self).setup()
711 self.set('CC', '"ccache gcc"')
712 self.set('CXX', '"ccache g++"')
714 def test(self, project, checkout, target, test, options):
715 self.append_with_colon('PATH', '%s/bin' % self.directory)
716 self.append_with_colon('LD_LIBRARY_PATH', '%s/lib' % self.directory)
717 super(LinuxTarget, self).test(project, checkout, target, test, options)
720 class AppImageTarget(LinuxTarget):
721 def __init__(self, work):
722 super(AppImageTarget, self).__init__('ubuntu', '18.04', 64, work)
723 self.detail = 'appimage'
724 self.privileged = True
727 class FlatpakTarget(LinuxTarget):
728 def __init__(self, project, checkout, work):
729 super(FlatpakTarget, self).__init__('ubuntu', '22.04', 64, work)
730 self.platform = 'flatpak'
731 self.privileged = True
732 self.build_dependencies = False
733 self.project = project
734 self.checkout = checkout
735 # If we use git references we end up with a checkout in one mount trying
736 # to link to the git reference repo in other, which doesn't work.
737 globals.use_git_reference = False
738 if config.has('flatpak_state_dir'):
739 self.mount(config.get('flatpak_state_dir'))
743 globals.trees.get(self.project, self.checkout, self).checkout_dependencies()
748 def flatpak_builder(self):
749 b = 'flatpak-builder'
750 if config.has('flatpak_state_dir'):
751 b += ' --state-dir=%s' % config.get('flatpak_state_dir')
755 def notarize_dmg(dmg):
757 config.get('osx_notarytool') + [
760 config.get('apple_id'),
762 config.get('apple_password'),
764 config.get('apple_team_id'),
767 ], capture_output=True)
769 last_line = [x.strip() for x in p.stdout.decode('utf-8').splitlines() if x.strip()][-1]
770 if last_line != 'status: Accepted':
771 print("Could not understand notarytool response")
773 print(f"Last line: {last_line}")
774 raise Error('Notarization failed')
776 subprocess.run(['xcrun', 'stapler', 'staple', dmg])
779 class OSXTarget(Target):
780 def __init__(self, directory=None):
781 super(OSXTarget, self).__init__('osx', directory)
782 self.sdk_prefix = config.get('osx_sdk_prefix')
783 self.environment_prefix = config.get('osx_environment_prefix')
784 self.apple_id = config.get('apple_id')
785 self.apple_password = config.get('apple_password')
786 self.osx_keychain_file = config.get('osx_keychain_file')
787 self.osx_keychain_password = config.get('osx_keychain_password')
789 def command(self, c):
790 command('%s %s' % (self.variables_string(False), c))
792 def unlock_keychain(self):
793 self.command('security unlock-keychain -p %s %s' % (self.osx_keychain_password, self.osx_keychain_file))
795 def package(self, project, checkout, output_dir, options, notarize):
796 self.unlock_keychain()
797 tree = globals.trees.get(project, checkout, self)
798 with TreeDirectory(tree):
799 p = self._cscript_package_and_notarize(tree, options, self.can_notarize and notarize)
800 self._copy_packages(tree, p, output_dir)
802 def _copy_packages(self, tree, packages, output_dir):
804 dest = os.path.join(output_dir, os.path.basename(devel_to_git(tree.commit, p)))
807 def _cscript_package_and_notarize(self, tree, options, notarize):
809 Call package() in the cscript and notarize the .dmgs that are returned, if notarize == True
812 for x in self._cscript_package(tree, options):
813 # Some older cscripts give us the DMG filename and the bundle ID, even though
814 # (since using notarytool instead of altool for notarization) the bundle ID
815 # is no longer necessary. Cope with either type of cscript.
816 dmg = x[0] if isinstance(x, tuple) else x
823 class OSXSingleTarget(OSXTarget):
824 def __init__(self, arch, sdk, deployment, directory=None, can_notarize=True):
825 super(OSXSingleTarget, self).__init__(directory)
828 self.deployment = deployment
829 self.can_notarize = can_notarize
830 self.sub_targets = [self]
832 flags = '-isysroot %s/MacOSX%s.sdk -arch %s' % (self.sdk_prefix, sdk, arch)
834 host_enviro = '%s/x86_64/%s' % (config.get('osx_environment_prefix'), deployment)
836 host_enviro = '%s/x86_64/10.10' % config.get('osx_environment_prefix')
837 target_enviro = '%s/%s/%s' % (config.get('osx_environment_prefix'), arch, deployment)
839 self.bin = '%s/bin' % target_enviro
841 # Environment variables
842 self.set('CFLAGS', '"-I%s/include -I%s/include %s"' % (self.directory, target_enviro, flags))
843 self.set('CPPFLAGS', '')
844 self.set('CXXFLAGS', '"-I%s/include -I%s/include -stdlib=libc++ %s"' % (self.directory, target_enviro, flags))
845 self.set('LDFLAGS', '"-L%s/lib -L%s/lib -stdlib=libc++ %s"' % (self.directory, target_enviro, flags))
846 self.set('LINKFLAGS', '"-L%s/lib -L%s/lib %s"' % (self.directory, target_enviro, flags))
847 self.set('PKG_CONFIG_PATH', '%s/lib/pkgconfig:%s/lib/pkgconfig:/usr/lib/pkgconfig' % (self.directory, target_enviro))
848 self.set('PATH', '$PATH:/usr/bin:/sbin:/usr/local/bin:%s/bin' % host_enviro)
849 self.set('MACOSX_DEPLOYMENT_TARGET', self.deployment)
850 self.set('CCACHE_BASEDIR', self.directory)
852 @Target.ccache.setter
854 Target.ccache.fset(self, v)
856 self.set('CC', '"ccache gcc"')
857 self.set('CXX', '"ccache g++"')
859 def package(self, project, checkout, output_dir, options, notarize):
860 tree = self.build(project, checkout, options, for_package=True)
861 tree.add_defaults(options)
863 super().package(project, checkout, output_dir, options, notarize)
866 class OSXUniversalTarget(OSXTarget):
867 def __init__(self, directory=None):
868 super(OSXUniversalTarget, self).__init__(directory)
869 self.sdk = config.get('osx_sdk')
870 self.sub_targets = []
871 for arch, deployment in (('x86_64', config.get('osx_intel_deployment')), ('arm64', config.get('osx_arm_deployment'))):
872 target = OSXSingleTarget(arch, self.sdk, deployment, os.path.join(self.directory, arch, deployment))
873 target.ccache = self.ccache
874 self.sub_targets.append(target)
875 self.can_notarize = True
877 def package(self, project, checkout, output_dir, options, notarize):
878 for target in self.sub_targets:
879 tree = globals.trees.get(project, checkout, target)
880 tree.build_dependencies(options)
881 tree.build(options, for_package=True)
883 super().package(project, checkout, output_dir, options, notarize)
886 class SourceTarget(Target):
887 """Build a source .tar.bz2 and .zst"""
889 super(SourceTarget, self).__init__('source')
891 def command(self, c):
892 log_normal('host -> %s' % c)
893 command('%s %s' % (self.variables_string(), c))
896 rmtree(self.directory)
898 def package(self, project, checkout, output_dir, options, notarize):
899 tree = globals.trees.get(project, checkout, self)
900 with TreeDirectory(tree):
901 name = read_wscript_variable(os.getcwd(), 'APPNAME')
902 command('./waf dist')
903 bz2 = os.path.abspath('%s-%s.tar.bz2' % (name, tree.version))
904 copyfile(bz2, os.path.join(output_dir, os.path.basename(devel_to_git(tree.commit, bz2))))
905 command('tar xjf %s' % bz2)
906 command('tar --zstd -cf %s-%s.tar.zst %s-%s' % (name, tree.version, name, tree.version))
907 zstd = os.path.abspath('%s-%s.tar.zst' % (name, tree.version))
908 copyfile(zstd, os.path.join(output_dir, os.path.basename(devel_to_git(tree.commit, zstd))))
910 # @param s Target string:
912 # or ubuntu-version-{32,64}
913 # or debian-version-{32,64}
914 # or centos-version-{32,64}
915 # or fedora-version-{32,64}
916 # or mageia-version-{32,64}
921 def target_factory(args):
924 if s.startswith('windows-'):
926 if platform.system() == "Windows":
927 target = WindowsNativeTarget(args.work)
930 target = WindowsDockerTarget(None, int(x[1]), args.work, args.environment_version)
932 target = WindowsDockerTarget(x[1], int(x[2]), args.work, args.environment_version)
934 raise Error("Bad Windows target name `%s'")
935 elif s.startswith('ubuntu-') or s.startswith('debian-') or s.startswith('centos-') or s.startswith('fedora-') or s.startswith('mageia-'):
938 raise Error("Bad Linux target name `%s'; must be something like ubuntu-16.04-32 (i.e. distro-version-bits)" % s)
939 target = LinuxTarget(p[0], p[1], int(p[2]), args.work)
940 elif s.startswith('arch-'):
943 raise Error("Bad Arch target name `%s'; must be arch-32 or arch-64")
944 target = LinuxTarget(p[0], None, int(p[1]), args.work)
945 elif s == 'raspbian':
946 target = LinuxTarget(s, None, None, args.work)
948 target = OSXUniversalTarget(args.work)
949 elif s == 'osx-intel':
950 target = OSXSingleTarget('x86_64', config.get('osx_sdk'), config.get('osx_intel_deployment'), args.work)
952 target = OSXSingleTarget('x86_64', config.get('osx_sdk'), config.get('osx_old_deployment'), args.work, False)
954 target = SourceTarget()
956 target = FlatpakTarget(args.project, args.checkout, args.work)
957 elif s == 'appimage':
958 target = AppImageTarget(args.work)
961 raise Error("Bad target `%s'" % s)
963 target.debug = args.debug
964 target.ccache = args.ccache
966 if args.environment is not None:
967 for e in args.environment:
968 target.set(e, os.environ[e])
970 if args.mount is not None:
983 """Description of a tree, which is a checkout of a project,
984 possibly built. This class is never exposed to cscripts.
986 name -- name of git repository (without the .git)
987 commit_ish -- git tag or revision to use
988 target -- target object that we are using
989 version -- version from the wscript (if one is present)
990 commit -- git revision that is actually being used
991 built -- true if the tree has been built yet in this run
992 required_by -- name of the tree that requires this one
995 def __init__(self, name, commit_ish, target, required_by, built=False):
997 self.commit_ish = commit_ish
1002 self.required_by = required_by
1005 proj = '%s/src/%s' % (target.directory, self.name)
1012 redirect = '>/dev/null'
1013 if config.has('git_reference') and globals.use_git_reference:
1014 ref = '--reference-if-able %s/%s.git' % (config.get('git_reference'), self.name)
1017 command('git -c protocol.file.allow=always clone %s %s %s/%s.git %s/src/%s' % (flags, ref, config.get('git_prefix'), self.name, target.directory, self.name))
1018 os.chdir('%s/src/%s' % (target.directory, self.name))
1020 if self.commit_ish is not None:
1021 command('git checkout %s %s %s' % (flags, self.commit_ish, redirect))
1022 self.commit = command_and_read('git rev-parse --short=7 HEAD')[0].strip()
1025 exec(open('%s/cscript' % proj).read(), self.cscript)
1028 # cscript can include submodules = False to stop submodules being fetched
1029 if (not 'submodules' in self.cscript or self.cscript['submodules'] == True) and os.path.exists('.gitmodules'):
1030 command('git submodule --quiet init')
1031 paths = command_and_read('git config --file .gitmodules --get-regexp path')
1032 urls = command_and_read('git config --file .gitmodules --get-regexp url')
1033 for path, url in zip(paths, urls):
1035 if config.has('git_reference') and globals.use_git_reference:
1036 url = url.split(' ')[1]
1037 ref_path = os.path.join(config.get('git_reference'), os.path.basename(url))
1038 if os.path.exists(ref_path):
1039 ref = '--reference %s' % ref_path
1040 path = path.split(' ')[1]
1041 command('git -c protocol.file.allow=always submodule --quiet update %s %s' % (ref, path))
1043 if os.path.exists('%s/wscript' % proj):
1044 v = read_wscript_variable(proj, "VERSION");
1047 self.version = Version(v)
1050 tag = command_and_read('git -C %s describe --match v* --tags' % proj)[0][1:]
1051 self.version = Version.from_git_tag(tag)
1053 # We'll leave version as None if we can't read it; maybe this is a bad idea
1054 # Should probably just install git on the Windows VM
1059 def call(self, function, *args):
1060 with TreeDirectory(self):
1061 return self.cscript[function](self.target, *args)
1063 def add_defaults(self, options):
1064 """Add the defaults from self into a dict options"""
1065 if 'option_defaults' in self.cscript:
1066 from_cscript = self.cscript['option_defaults']
1067 if isinstance(from_cscript, dict):
1068 defaults_dict = from_cscript
1070 log_normal("Deprecated cscript option_defaults method; replace with a dict")
1071 defaults_dict = from_cscript()
1072 for k, v in defaults_dict.items():
1073 if not k in options:
1076 def dependencies(self, options):
1078 yield details of the dependencies of this tree. Each dependency is returned
1079 as a tuple of (tree, options, parent_tree). The 'options' parameter are the options that
1080 we want to force for 'self'.
1082 if not 'dependencies' in self.cscript:
1085 if len(inspect.getfullargspec(self.cscript['dependencies']).args) == 2:
1086 self_options = copy.copy(options)
1087 self.add_defaults(self_options)
1088 deps = self.call('dependencies', self_options)
1090 log_normal("Deprecated cscript dependencies() method with no options parameter")
1091 deps = self.call('dependencies')
1093 # Loop over our immediate dependencies
1095 dep = globals.trees.get(d[0], d[1], self.target, self.name)
1097 # deps only get their options from the parent's cscript
1098 dep_options = d[2] if len(d) > 2 else {}
1099 for i in dep.dependencies(dep_options):
1101 yield (dep, dep_options, self)
1103 def checkout_dependencies(self, options={}):
1104 for i in self.dependencies(options):
1107 def build_dependencies(self, options):
1109 Called on the 'main' project tree (-p on the command line) to build all dependencies.
1110 'options' will be the ones from the command line.
1112 for i in self.dependencies(options):
1115 def build(self, options, for_package=False):
1119 log_verbose("Building %s %s %s with %s" % (self.name, self.commit_ish, self.version, options))
1121 variables = copy.copy(self.target.variables)
1123 options = copy.copy(options)
1124 self.add_defaults(options)
1126 if not globals.dry_run:
1127 num_args = len(inspect.getfullargspec(self.cscript['build']).args)
1129 self.call('build', options, for_package)
1131 self.call('build', options)
1135 self.target.variables = variables
1140 # Command-line parser
1144 parser = argparse.ArgumentParser()
1145 parser.add_argument('-p', '--project', help='project name')
1146 parser.add_argument('-c', '--checkout', help='string to pass to git for checkout')
1147 parser.add_argument('-o', '--output', help='output directory', default='.')
1148 parser.add_argument('-q', '--quiet', help='be quiet', action='store_true')
1149 parser.add_argument('-t', '--target', help='target', action='append')
1150 parser.add_argument('--environment-version', help='version of environment to use')
1151 parser.add_argument('-k', '--keep', help='keep working tree', action='store_true')
1152 parser.add_argument('--debug', help='build with debugging symbols where possible', action='store_true')
1153 parser.add_argument('-w', '--work', help='override default work directory')
1154 parser.add_argument('-g', '--git-prefix', help='override configured git prefix')
1155 parser.add_argument('-n', '--dry-run', help='run the process without building anything', action='store_true')
1156 parser.add_argument('-e', '--environment', help='pass the value of the named environment variable into the build', action='append')
1157 parser.add_argument('-m', '--mount', help='mount a given directory in the build environment', action='append')
1158 parser.add_argument('--option', help='set an option for the build (use --option key:value)', action='append')
1159 parser.add_argument('--ccache', help='use ccache', action='store_true')
1160 parser.add_argument('--verbose', help='be verbose', action='store_true')
1162 subparsers = parser.add_subparsers(help='command to run', dest='command')
1163 parser_build = subparsers.add_parser("build", help="build project")
1164 parser_package = subparsers.add_parser("package", help="build and package project")
1165 parser_package.add_argument('--no-notarize', help='do not notarize .dmg packages', action='store_true')
1166 parser_release = subparsers.add_parser("release", help="release a project using its next version number (adding a tag)")
1167 parser_release.add_argument('--minor', help='minor version number bump', action='store_true')
1168 parser_release.add_argument('--micro', help='micro version number bump', action='store_true')
1169 parser_pot = subparsers.add_parser("pot", help="build the project's .pot files")
1170 parser_manual = subparsers.add_parser("manual", help="build the project's manual")
1171 parser_doxygen = subparsers.add_parser("doxygen", help="build the project's Doxygen documentation")
1172 parser_latest = subparsers.add_parser("latest", help="print out the latest version")
1173 parser_latest.add_argument('--major', help='major version to return', type=int)
1174 parser_latest.add_argument('--minor', help='minor version to return', type=int)
1175 parser_test = subparsers.add_parser("test", help="build the project and run its unit tests")
1176 parser_test.add_argument('--no-implicit-build', help='do not build first', action='store_true')
1177 parser_test.add_argument('--test', help="name of test to run, defaults to all")
1178 parser_shell = subparsers.add_parser("shell", help="start a shell in the project's work directory")
1179 parser_checkout = subparsers.add_parser("checkout", help="check out the project")
1180 parser_revision = subparsers.add_parser("revision", help="print the head git revision number")
1181 parser_dependencies = subparsers.add_parser("dependencies", help="print details of the project's dependencies as a .dot file")
1182 parser_notarize = subparsers.add_parser("notarize", help="notarize .dmgs in a directory")
1183 parser_notarize.add_argument('--dmgs', help='directory containing *.dmg')
1186 args = parser.parse_args()
1188 # Check for incorrect multiple parameters
1189 if args.target is not None:
1190 if len(args.target) > 1:
1191 parser.error('multiple -t options specified')
1194 args.target = args.target[0]
1196 # Override configured stuff
1197 if args.git_prefix is not None:
1198 config.set('git_prefix', args.git_prefix)
1200 if args.output.find(':') == -1:
1201 # This isn't of the form host:path so make it absolute
1202 args.output = os.path.abspath(args.output) + '/'
1204 if args.output[-1] != ':' and args.output[-1] != '/':
1207 # Now, args.output is 'host:', 'host:path/' or 'path/'
1209 if args.work is not None:
1210 args.work = os.path.abspath(args.work)
1211 if not os.path.exists(args.work):
1212 os.makedirs(args.work)
1214 if args.project is None and not args.command in ['shell', 'notarize']:
1215 raise Error('you must specify -p or --project')
1217 globals.quiet = args.quiet
1218 globals.verbose = args.verbose
1219 globals.dry_run = args.dry_run
1221 if args.command == 'build':
1222 if args.target is None:
1223 raise Error('you must specify -t or --target')
1225 target = target_factory(args)
1227 target.build(args.project, args.checkout, get_command_line_options(args))
1232 elif args.command == 'package':
1233 if args.target is None:
1234 raise Error('you must specify -t or --target')
1238 target = target_factory(args)
1240 if target.platform == 'linux' and target.detail != "appimage":
1241 if target.distro != 'arch':
1242 output_dir = os.path.join(args.output, '%s-%s-%d' % (target.distro, target.version, target.bits))
1244 output_dir = os.path.join(args.output, '%s-%d' % (target.distro, target.bits))
1246 output_dir = args.output
1248 makedirs(output_dir)
1249 target.package(args.project, args.checkout, output_dir, get_command_line_options(args), not args.no_notarize)
1251 if target is not None and not args.keep:
1254 elif args.command == 'release':
1255 if args.minor is False and args.micro is False:
1256 raise Error('you must specify --minor or --micro')
1258 target = SourceTarget()
1259 tree = globals.trees.get(args.project, args.checkout, target)
1261 version = tree.version
1262 version.to_release()
1264 version.bump_minor()
1266 version.bump_micro()
1268 with TreeDirectory(tree):
1269 command('git tag -m "v%s" v%s' % (version, version))
1270 command('git push --tags')
1274 elif args.command == 'pot':
1275 target = SourceTarget()
1276 tree = globals.trees.get(args.project, args.checkout, target)
1278 pots = tree.call('make_pot')
1280 copyfile(p, '%s%s' % (args.output, os.path.basename(p)))
1284 elif args.command == 'manual':
1285 target = SourceTarget()
1286 tree = globals.trees.get(args.project, args.checkout, target)
1287 tree.checkout_dependencies()
1289 outs = tree.call('make_manual')
1291 if os.path.isfile(o):
1292 copyfile(o, '%s%s' % (args.output, os.path.basename(o)))
1294 copytree(o, '%s%s' % (args.output, os.path.basename(o)))
1298 elif args.command == 'doxygen':
1299 target = SourceTarget()
1300 tree = globals.trees.get(args.project, args.checkout, target)
1302 dirs = tree.call('make_doxygen')
1303 if hasattr(dirs, 'strip') or (not hasattr(dirs, '__getitem__') and not hasattr(dirs, '__iter__')):
1307 copytree(d, args.output)
1311 elif args.command == 'latest':
1312 target = SourceTarget()
1313 tree = globals.trees.get(args.project, args.checkout, target)
1315 with TreeDirectory(tree):
1316 f = command_and_read('git log --tags --simplify-by-decoration --pretty="%d"')
1319 while latest is None:
1322 m = re.compile(".*\((.*)\).*").match(t)
1324 tags = m.group(1).split(', ')
1329 if len(t) > 0 and t[0] == 'v':
1331 if (args.major is None or v.major == args.major) and (args.minor is None or v.minor == args.minor):
1337 elif args.command == 'test':
1338 if args.target is None:
1339 raise Error('you must specify -t or --target')
1343 target = target_factory(args)
1344 options = get_command_line_options(args)
1345 if args.no_implicit_build:
1346 globals.trees.add_built(args.project, args.checkout, target)
1348 target.build(args.project, args.checkout, options)
1349 target.test(args.project, args.checkout, target, args.test, options)
1351 if target is not None and not args.keep:
1354 elif args.command == 'shell':
1355 if args.target is None:
1356 raise Error('you must specify -t or --target')
1358 target = target_factory(args)
1359 target.command('bash')
1361 elif args.command == 'revision':
1363 target = SourceTarget()
1364 tree = globals.trees.get(args.project, args.checkout, target)
1365 with TreeDirectory(tree):
1366 print(command_and_read('git rev-parse HEAD')[0].strip()[:7])
1369 elif args.command == 'checkout':
1371 if args.output is None:
1372 raise Error('you must specify -o or --output')
1374 target = SourceTarget()
1375 tree = globals.trees.get(args.project, args.checkout, target)
1376 with TreeDirectory(tree):
1377 shutil.copytree('.', args.output)
1380 elif args.command == 'dependencies':
1381 if args.target is None:
1382 raise Error('you must specify -t or --target')
1383 if args.checkout is None:
1384 raise Error('you must specify -c or --checkout')
1386 target = target_factory(args)
1387 tree = globals.trees.get(args.project, args.checkout, target)
1388 print("strict digraph {")
1389 for d in list(tree.dependencies({})):
1390 print("%s -> %s;" % (d[2].name.replace("-", "-"), d[0].name.replace("-", "_")))
1393 elif args.command == 'notarize':
1394 if args.dmgs is None:
1395 raise Error('you must specify ---dmgs')
1397 for dmg in Path(args.dmgs).glob('*.dmg'):
1403 print('cdist: %s' % str(e), file=sys.stderr)