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))
92 def __init__(self, key, default=None):
96 def offer(self, key, value):
101 def __init__(self, key):
105 def offer(self, key, value):
107 self.value = value in ['yes', '1', 'true']
111 self.options = [ Option('mxe_prefix'),
112 Option('git_prefix'),
113 Option('git_reference'),
114 Option('osx_environment_prefix'),
115 Option('osx_sdk_prefix'),
117 Option('osx_intel_deployment'),
118 Option('osx_arm_deployment'),
119 Option('osx_old_deployment'),
120 Option('osx_keychain_file'),
121 Option('osx_keychain_password'),
123 Option('apple_password'),
124 Option('apple_team_id'),
125 BoolOption('docker_sudo'),
126 BoolOption('docker_no_user'),
127 Option('docker_hub_repository'),
128 Option('flatpak_state_dir'),
129 Option('parallel', multiprocessing.cpu_count()),
130 Option('temp', '/var/tmp'),
131 Option('osx_notarytool', ['xcrun', 'notarytool'])]
133 config_dir = '%s/.config' % os.path.expanduser('~')
134 if not os.path.exists(config_dir):
136 config_file = '%s/cdist' % config_dir
137 if not os.path.exists(config_file):
138 f = open(config_file, 'w')
139 for o in self.options:
140 print('# %s ' % o.key, file=f)
142 print('Template config file written to %s; please edit and try again.' % config_file, file=sys.stderr)
145 f = open('%s/.config/cdist' % os.path.expanduser('~'), 'r')
151 if len(l) > 0 and l[0] == '#':
154 s = l.strip().split()
156 for k in self.options:
159 if not isinstance(self.get('osx_notarytool'), list):
160 self.set('osx_notarytool', [self.get('osx_notarytool')])
164 for o in self.options:
165 if o.key == k and o.value is not None:
170 for o in self.options:
173 raise Error('Required setting %s not found' % k)
177 for o in self.options:
181 if self.get('docker_sudo'):
193 if not globals.quiet:
194 print('\x1b[33m* %s\x1b[0m' % m)
198 print('\x1b[35m* %s\x1b[0m' % m)
200 def escape_spaces(s):
201 return s.replace(' ', '\\ ')
204 """Escape a host:filename string for use with an scp command"""
206 assert(len(s) == 1 or len(s) == 2)
208 return '%s:"\'%s\'"' % (s[0], s[1])
210 return '\"%s\"' % s[0]
213 return '\"%s\"' % n.substr(' ', '\\ ')
216 log_normal('copy %s -> %s' % (scp_escape(a), scp_escape(b)))
217 if b.startswith('s3://'):
218 command('s3cmd -P -r put "%s" "%s"' % (a, b))
220 command('scp -r %s %s' % (scp_escape(a), scp_escape(b)))
223 log_normal('copy %s -> %s with cwd %s' % (scp_escape(a), scp_escape(b), os.getcwd()))
224 if b.startswith('s3://'):
225 command('s3cmd -P put "%s" "%s"' % (a, b))
231 temp_path = os.path.join(os.path.dirname(path), ".tmp." + os.path.basename(path))
232 command('scp %s %s' % (scp_escape(a), scp_escape(host + ":" + temp_path)))
233 command('ssh %s -- mv "%s" "%s"' % (host, escape_spaces(temp_path), escape_spaces(path)))
235 command('scp %s %s' % (scp_escape(a), scp_escape(b)))
239 Make directories either locally or on a remote host; remotely if
240 d includes a colon, otherwise locally.
242 if d.startswith('s3://'):
243 # No need to create folders on S3
246 if d.find(':') == -1:
254 command('ssh %s -- mkdir -p %s' % (s[0], s[1]))
257 log_normal('remove %s' % a)
261 log_normal('remove %s' % a)
262 shutil.rmtree(a, ignore_errors=True)
267 r = subprocess.run(c, shell=True)
268 if r.returncode != 0:
269 raise Error('command %s failed (%d)' % (c, r.returncode))
270 except Exception as e:
271 raise Error('command %s failed (%s)' % (c, e))
273 def command_and_read(c):
275 p = subprocess.Popen(c.split(), stdout=subprocess.PIPE, stderr=subprocess.PIPE)
276 (out, err) = p.communicate()
277 if p.returncode != 0:
278 raise Error('command %s failed (%s)' % (c, err))
279 return str(out, 'utf-8').splitlines()
281 def read_wscript_variable(directory, variable):
282 f = open('%s/wscript' % directory, 'r')
289 if len(s) == 3 and s[0] == variable:
297 def devel_to_git(git_commit, filename):
298 if git_commit is not None:
299 filename = filename.replace('devel', '-%s' % git_commit)
303 def get_command_line_options(args):
304 """Get the options specified by --option on the command line"""
306 if args.option is not None:
307 for o in args.option:
310 raise Error("Bad option `%s'" % o)
312 options[b[0]] = False
321 def __init__(self, tree):
324 self.cwd = os.getcwd()
325 os.chdir('%s/src/%s' % (self.tree.target.directory, self.tree.name))
326 def __exit__(self, type, value, traceback):
334 def __init__(self, s):
337 if s.startswith("'"):
342 if s.endswith('devel'):
346 if s.endswith('pre'):
350 self.major = int(p[0])
351 self.minor = int(p[1])
353 self.micro = int(p[2])
358 def from_git_tag(cls, tag):
359 bits = tag.split('-')
361 if len(bits) > 1 and int(bits[1]) > 0:
365 def bump_minor(self):
369 def bump_micro(self):
375 def to_release(self):
379 s = '%d.%d.%d' % (self.major, self.minor, self.micro)
391 Class representing the target that we are building for. This is exposed to cscripts,
392 though not all of it is guaranteed 'API'. cscripts may expect:
394 platform: platform string (e.g. 'windows', 'linux', 'osx')
395 parallel: number of parallel jobs to run
396 directory: directory to work in
397 variables: dict of environment variables
398 debug: True to build a debug version, otherwise False
399 ccache: True to use ccache, False to not
400 set(a, b): set the value of variable 'a' to 'b'
401 unset(a): unset the value of variable 'a'
402 command(c): run the command 'c' in the build environment
406 def __init__(self, platform, directory=None):
408 platform -- platform string (e.g. 'windows', 'linux', 'osx')
409 directory -- directory to work in; if None we will use a temporary directory
410 Temporary directories will be removed after use; specified directories will not.
412 self.platform = platform
413 self.parallel = int(config.get('parallel'))
415 # Environment variables that we will use when we call cscripts
419 # True to build our dependencies ourselves; False if this is taken care
420 # of in some other way
421 self.build_dependencies = True
423 if directory is None:
424 self.directory = tempfile.mkdtemp('', 'tmp', config.get('temp'))
426 self.set('CCACHE_BASEDIR', os.path.realpath(self.directory))
427 self.set('CCACHE_NOHASHDIR', '')
429 self.directory = os.path.realpath(directory)
436 def _cscript_package(self, tree, options):
438 Call package() in the cscript and return what it returns, except that
439 anything not in a list will be put into one.
441 if len(inspect.getfullargspec(tree.cscript['package']).args) == 3:
442 packages = tree.call('package', tree.version, options)
444 log_normal("Deprecated cscript package() method with no options parameter")
445 packages = tree.call('package', tree.version)
447 return packages if isinstance(packages, list) else [packages]
449 def _copy_packages(self, tree, packages, output_dir):
451 copyfile(p, os.path.join(output_dir, os.path.basename(devel_to_git(tree.commit, p))))
453 def package(self, project, checkout, output_dir, options, notarize):
454 tree = self.build(project, checkout, options, for_package=True)
455 tree.add_defaults(options)
456 p = self._cscript_package(tree, options)
457 self._copy_packages(tree, p, output_dir)
459 def build(self, project, checkout, options, for_package=False):
460 tree = globals.trees.get(project, checkout, self)
461 if self.build_dependencies:
462 tree.build_dependencies(options)
463 tree.build(options, for_package=for_package)
466 def test(self, project, checkout, target, test, options):
467 """test is the test case to run, or None"""
468 tree = globals.trees.get(project, checkout, target)
470 tree.add_defaults(options)
471 with TreeDirectory(tree):
472 if len(inspect.getfullargspec(tree.cscript['test']).args) == 3:
473 return tree.call('test', options, test)
475 log_normal('Deprecated cscript test() method with no options parameter')
476 return tree.call('test', test)
479 self.variables[a] = b
482 del(self.variables[a])
485 return self.variables[a]
487 def append(self, k, v, s):
488 if (not k in self.variables) or len(self.variables[k]) == 0:
489 self.variables[k] = '"%s"' % v
491 e = self.variables[k]
492 if e[0] == '"' and e[-1] == '"':
493 self.variables[k] = '"%s%s%s"' % (e[1:-1], s, v)
495 self.variables[k] = '"%s%s%s"' % (e, s, v)
497 def append_with_space(self, k, v):
498 return self.append(k, v, ' ')
500 def append_with_colon(self, k, v):
501 return self.append(k, v, ':')
503 def variables_string(self, escaped_quotes=False):
505 for k, v in self.variables.items():
507 v = v.replace('"', '\\"')
508 e += '%s=%s ' % (k, v)
513 rmtree(self.directory)
527 class DockerTarget(Target):
528 def __init__(self, platform, directory):
529 super(DockerTarget, self).__init__(platform, directory)
531 self.privileged = False
534 if config.get('docker_no_user'):
536 return '-u %s' % getpass.getuser()
538 def _mount_option(self, d):
539 return '-v %s:%s ' % (os.path.realpath(d), os.path.realpath(d))
542 opts = self._mount_option(self.directory)
543 for m in self.mounts:
544 opts += self._mount_option(m)
545 if config.has('git_reference'):
546 opts += self._mount_option(config.get('git_reference'))
548 opts += '--privileged=true '
550 opts += "-e CCACHE_DIR=/ccache/%s-%d --mount source=ccache,target=/ccache " % (self.image, os.getuid())
554 if config.has('docker_hub_repository'):
555 tag = '%s:%s' % (config.get('docker_hub_repository'), tag)
557 def signal_handler(signum, frame):
558 raise Error('Killed')
559 signal.signal(signal.SIGTERM, signal_handler)
561 self.container = command_and_read('%s run %s %s -itd %s /bin/bash' % (config.docker(), self._user_tag(), opts, tag))[0].strip()
563 def command(self, cmd):
564 dir = os.path.join(self.directory, os.path.relpath(os.getcwd(), self.directory))
565 interactive_flag = '-i ' if sys.stdin.isatty() else ''
566 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))
569 super(DockerTarget, self).cleanup()
570 command('%s kill %s' % (config.docker(), self.container))
573 self.mounts.append(m)
576 class FlatpakTarget(Target):
577 def __init__(self, project, checkout):
578 super(FlatpakTarget, self).__init__('flatpak')
579 self.build_dependencies = False
580 self.project = project
581 self.checkout = checkout
586 def command(self, cmd):
589 def checkout_dependencies(self):
590 tree = globals.trees.get(self.project, self.checkout, self)
591 return tree.checkout_dependencies()
596 def flatpak_builder(self):
597 b = 'flatpak-builder'
598 if config.has('flatpak_state_dir'):
599 b += ' --state-dir=%s' % config.get('flatpak_state_dir')
603 class WindowsDockerTarget(DockerTarget):
605 This target exposes the following additional API:
607 version: Windows version ('xp' or None)
608 bits: bitness of Windows (32 or 64)
609 name: name of our target e.g. x86_64-w64-mingw32.shared
610 environment_prefix: path to Windows environment for the appropriate target (libraries and some tools)
611 tool_path: path to 32- and 64-bit tools
613 def __init__(self, windows_version, bits, directory, environment_version):
614 super(WindowsDockerTarget, self).__init__('windows', directory)
615 self.version = windows_version
618 self.tool_path = '%s/usr/bin' % config.get('mxe_prefix')
620 self.name = 'i686-w64-mingw32.shared'
622 self.name = 'x86_64-w64-mingw32.shared'
623 self.environment_prefix = '%s/usr/%s' % (config.get('mxe_prefix'), self.name)
625 self.set('PKG_CONFIG_LIBDIR', '%s/lib/pkgconfig' % self.environment_prefix)
626 self.set('PKG_CONFIG_PATH', '%s/lib/pkgconfig:%s/bin/pkgconfig' % (self.directory, self.directory))
627 self.set('PATH', '%s/bin:%s:%s' % (self.environment_prefix, self.tool_path, os.environ['PATH']))
628 self.set('LD', '%s-ld' % self.name)
629 self.set('RANLIB', '%s-ranlib' % self.name)
630 self.set('WINRC', '%s-windres' % self.name)
631 cxx = '-I%s/include -I%s/include' % (self.environment_prefix, self.directory)
632 link = '-L%s/lib -L%s/lib' % (self.environment_prefix, self.directory)
633 self.set('CXXFLAGS', '"%s"' % cxx)
634 self.set('CPPFLAGS', '')
635 self.set('LINKFLAGS', '"%s"' % link)
636 self.set('LDFLAGS', '"%s"' % link)
638 self.image = 'windows'
639 if environment_version is not None:
640 self.image += '_%s' % environment_version
645 self.set('CC', '"ccache %s-gcc"' % self.name)
646 self.set('CXX', '"ccache %s-g++"' % self.name)
648 self.set('CC', '%s-gcc' % self.name)
649 self.set('CXX', '%s-g++' % self.name)
652 def library_prefix(self):
653 log_normal('Deprecated property library_prefix: use environment_prefix')
654 return self.environment_prefix
657 def windows_prefix(self):
658 log_normal('Deprecated property windows_prefix: use environment_prefix')
659 return self.environment_prefix
662 def mingw_prefixes(self):
663 log_normal('Deprecated property mingw_prefixes: use environment_prefix')
664 return [self.environment_prefix]
667 def mingw_path(self):
668 log_normal('Deprecated property mingw_path: use tool_path')
669 return self.tool_path
672 def mingw_name(self):
673 log_normal('Deprecated property mingw_name: use name')
677 class WindowsNativeTarget(Target):
679 This target exposes the following additional API:
681 version: Windows version ('xp' or None)
682 bits: bitness of Windows (32 or 64)
683 name: name of our target e.g. x86_64-w64-mingw32.shared
684 environment_prefix: path to Windows environment for the appropriate target (libraries and some tools)
686 def __init__(self, directory):
687 super().__init__('windows', directory)
691 self.environment_prefix = config.get('windows_native_environmnet_prefix')
693 self.set('PATH', '%s/bin:%s' % (self.environment_prefix, os.environ['PATH']))
695 def command(self, cmd):
699 class LinuxTarget(DockerTarget):
701 Build for Linux in a docker container.
702 This target exposes the following additional API:
704 distro: distribution ('debian', 'ubuntu', 'centos' or 'fedora')
705 version: distribution version (e.g. '12.04', '8', '6.5')
706 bits: bitness of the distribution (32 or 64)
707 detail: None or 'appimage' if we are building for appimage
710 def __init__(self, distro, version, bits, directory=None):
711 super(LinuxTarget, self).__init__('linux', directory)
713 self.version = version
717 self.set('CXXFLAGS', '-I%s/include' % self.directory)
718 self.set('CPPFLAGS', '')
719 self.set('LINKFLAGS', '-L%s/lib' % self.directory)
720 self.set('PKG_CONFIG_PATH',
721 '%s/lib/pkgconfig:%s/lib64/pkgconfig:/usr/local/lib64/pkgconfig:/usr/local/lib/pkgconfig' % (self.directory, self.directory))
722 self.set('PATH', '/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin')
724 if self.version is None:
725 self.image = '%s-%s' % (self.distro, self.bits)
727 self.image = '%s-%s-%s' % (self.distro, self.version, self.bits)
730 super(LinuxTarget, self).setup()
732 self.set('CC', '"ccache gcc"')
733 self.set('CXX', '"ccache g++"')
735 def test(self, project, checkout, target, test, options):
736 self.append_with_colon('PATH', '%s/bin' % self.directory)
737 self.append_with_colon('LD_LIBRARY_PATH', '%s/lib' % self.directory)
738 super(LinuxTarget, self).test(project, checkout, target, test, options)
741 class AppImageTarget(LinuxTarget):
742 def __init__(self, work):
743 super(AppImageTarget, self).__init__('ubuntu', '18.04', 64, work)
744 self.detail = 'appimage'
745 self.privileged = True
748 def notarize_dmg(dmg):
750 config.get('osx_notarytool') + [
753 config.get('apple_id'),
755 config.get('apple_password'),
757 config.get('apple_team_id'),
760 ], capture_output=True)
762 last_line = [x.strip() for x in p.stdout.decode('utf-8').splitlines() if x.strip()][-1]
763 if last_line != 'status: Accepted':
764 print("Could not understand notarytool response")
766 print(f"Last line: {last_line}")
767 raise Error('Notarization failed')
769 subprocess.run(['xcrun', 'stapler', 'staple', dmg])
772 class OSXTarget(Target):
773 def __init__(self, directory=None):
774 super(OSXTarget, self).__init__('osx', directory)
775 self.sdk_prefix = config.get('osx_sdk_prefix')
776 self.environment_prefix = config.get('osx_environment_prefix')
777 self.apple_id = config.get('apple_id')
778 self.apple_password = config.get('apple_password')
779 self.osx_keychain_file = config.get('osx_keychain_file')
780 self.osx_keychain_password = config.get('osx_keychain_password')
782 def command(self, c):
783 command('%s %s' % (self.variables_string(False), c))
785 def unlock_keychain(self):
786 self.command('security unlock-keychain -p %s %s' % (self.osx_keychain_password, self.osx_keychain_file))
788 def _copy_packages(self, tree, packages, output_dir):
790 dest = os.path.join(output_dir, os.path.basename(devel_to_git(tree.commit, p)))
793 def _cscript_package_and_notarize(self, tree, options, notarize):
795 Call package() in the cscript and notarize the .dmgs that are returned, if notarize == True
798 for x in self._cscript_package(tree, options):
799 # Some older cscripts give us the DMG filename and the bundle ID, even though
800 # (since using notarytool instead of altool for notarization) the bundle ID
801 # is no longer necessary. Cope with either type of cscript.
802 dmg = x[0] if isinstance(x, tuple) else x
809 class OSXSingleTarget(OSXTarget):
810 def __init__(self, arch, sdk, deployment, directory=None, can_notarize=True):
811 super(OSXSingleTarget, self).__init__(directory)
814 self.deployment = deployment
815 self.can_notarize = can_notarize
816 self.sub_targets = [self]
818 flags = '-isysroot %s/MacOSX%s.sdk -arch %s' % (self.sdk_prefix, sdk, arch)
820 host_enviro = '%s/x86_64/%s' % (config.get('osx_environment_prefix'), deployment)
822 host_enviro = '%s/x86_64/10.10' % config.get('osx_environment_prefix')
823 target_enviro = '%s/%s/%s' % (config.get('osx_environment_prefix'), arch, deployment)
825 self.bin = '%s/bin' % target_enviro
827 # Environment variables
828 self.set('CFLAGS', '"-I%s/include -I%s/include %s"' % (self.directory, target_enviro, flags))
829 self.set('CPPFLAGS', '')
830 self.set('CXXFLAGS', '"-I%s/include -I%s/include -stdlib=libc++ %s"' % (self.directory, target_enviro, flags))
831 self.set('LDFLAGS', '"-L%s/lib -L%s/lib -stdlib=libc++ %s"' % (self.directory, target_enviro, flags))
832 self.set('LINKFLAGS', '"-L%s/lib -L%s/lib %s"' % (self.directory, target_enviro, flags))
833 self.set('PKG_CONFIG_PATH', '%s/lib/pkgconfig:%s/lib/pkgconfig:/usr/lib/pkgconfig' % (self.directory, target_enviro))
834 self.set('PATH', '$PATH:/usr/bin:/sbin:/usr/local/bin:%s/bin' % host_enviro)
835 self.set('MACOSX_DEPLOYMENT_TARGET', self.deployment)
836 self.set('CCACHE_BASEDIR', self.directory)
838 @Target.ccache.setter
840 Target.ccache.fset(self, v)
842 self.set('CC', '"ccache gcc"')
843 self.set('CXX', '"ccache g++"')
845 def package(self, project, checkout, output_dir, options, notarize):
846 tree = self.build(project, checkout, options, for_package=True)
847 tree.add_defaults(options)
848 self.unlock_keychain()
849 p = self._cscript_package_and_notarize(tree, options, self.can_notarize and notarize)
850 self._copy_packages(tree, p, output_dir)
853 class OSXUniversalTarget(OSXTarget):
854 def __init__(self, directory=None):
855 super(OSXUniversalTarget, self).__init__(directory)
856 self.sdk = config.get('osx_sdk')
857 self.sub_targets = []
858 for arch, deployment in (('x86_64', config.get('osx_intel_deployment')), ('arm64', config.get('osx_arm_deployment'))):
859 target = OSXSingleTarget(arch, self.sdk, deployment, os.path.join(self.directory, arch, deployment))
860 target.ccache = self.ccache
861 self.sub_targets.append(target)
863 def package(self, project, checkout, output_dir, options, notarize):
864 for target in self.sub_targets:
865 tree = globals.trees.get(project, checkout, target)
866 tree.build_dependencies(options)
867 tree.build(options, for_package=True)
869 self.unlock_keychain()
870 tree = globals.trees.get(project, checkout, self)
871 with TreeDirectory(tree):
872 p = self._cscript_package_and_notarize(tree, options, notarize)
873 self._copy_packages(tree, p, output_dir)
875 class SourceTarget(Target):
876 """Build a source .tar.bz2 and .zst"""
878 super(SourceTarget, self).__init__('source')
880 def command(self, c):
881 log_normal('host -> %s' % c)
882 command('%s %s' % (self.variables_string(), c))
885 rmtree(self.directory)
887 def package(self, project, checkout, output_dir, options, notarize):
888 tree = globals.trees.get(project, checkout, self)
889 with TreeDirectory(tree):
890 name = read_wscript_variable(os.getcwd(), 'APPNAME')
891 command('./waf dist')
892 bz2 = os.path.abspath('%s-%s.tar.bz2' % (name, tree.version))
893 copyfile(bz2, os.path.join(output_dir, os.path.basename(devel_to_git(tree.commit, bz2))))
894 command('tar xjf %s' % bz2)
895 command('tar --zstd -cf %s-%s.tar.zst %s-%s' % (name, tree.version, name, tree.version))
896 zstd = os.path.abspath('%s-%s.tar.zst' % (name, tree.version))
897 copyfile(zstd, os.path.join(output_dir, os.path.basename(devel_to_git(tree.commit, zstd))))
899 # @param s Target string:
901 # or ubuntu-version-{32,64}
902 # or debian-version-{32,64}
903 # or centos-version-{32,64}
904 # or fedora-version-{32,64}
905 # or mageia-version-{32,64}
910 def target_factory(args):
913 if s.startswith('windows-'):
915 if platform.system() == "Windows":
916 target = WindowsNativeTarget(args.work)
919 target = WindowsDockerTarget(None, int(x[1]), args.work, args.environment_version)
921 target = WindowsDockerTarget(x[1], int(x[2]), args.work, args.environment_version)
923 raise Error("Bad Windows target name `%s'")
924 elif s.startswith('ubuntu-') or s.startswith('debian-') or s.startswith('centos-') or s.startswith('fedora-') or s.startswith('mageia-'):
927 raise Error("Bad Linux target name `%s'; must be something like ubuntu-16.04-32 (i.e. distro-version-bits)" % s)
928 target = LinuxTarget(p[0], p[1], int(p[2]), args.work)
929 elif s.startswith('arch-'):
932 raise Error("Bad Arch target name `%s'; must be arch-32 or arch-64")
933 target = LinuxTarget(p[0], None, int(p[1]), args.work)
934 elif s == 'raspbian':
935 target = LinuxTarget(s, None, None, args.work)
937 target = OSXUniversalTarget(args.work)
938 elif s == 'osx-intel':
939 target = OSXSingleTarget('x86_64', config.get('osx_sdk'), config.get('osx_intel_deployment'), args.work)
941 target = OSXSingleTarget('x86_64', config.get('osx_sdk'), config.get('osx_old_deployment'), args.work, False)
943 target = SourceTarget()
945 target = FlatpakTarget(args.project, args.checkout)
946 elif s == 'appimage':
947 target = AppImageTarget(args.work)
950 raise Error("Bad target `%s'" % s)
952 target.debug = args.debug
953 target.ccache = args.ccache
955 if args.environment is not None:
956 for e in args.environment:
957 target.set(e, os.environ[e])
959 if args.mount is not None:
972 """Description of a tree, which is a checkout of a project,
973 possibly built. This class is never exposed to cscripts.
975 name -- name of git repository (without the .git)
976 commit_ish -- git tag or revision to use
977 target -- target object that we are using
978 version -- version from the wscript (if one is present)
979 commit -- git revision that is actually being used
980 built -- true if the tree has been built yet in this run
981 required_by -- name of the tree that requires this one
984 def __init__(self, name, commit_ish, target, required_by, built=False):
986 self.commit_ish = commit_ish
991 self.required_by = required_by
994 proj = '%s/src/%s' % (target.directory, self.name)
1001 redirect = '>/dev/null'
1002 if config.has('git_reference'):
1003 ref = '--reference-if-able %s/%s.git' % (config.get('git_reference'), self.name)
1006 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))
1007 os.chdir('%s/src/%s' % (target.directory, self.name))
1009 if self.commit_ish is not None:
1010 command('git checkout %s %s %s' % (flags, self.commit_ish, redirect))
1011 self.commit = command_and_read('git rev-parse --short=7 HEAD')[0].strip()
1014 exec(open('%s/cscript' % proj).read(), self.cscript)
1017 # cscript can include submodules = False to stop submodules being fetched
1018 if (not 'submodules' in self.cscript or self.cscript['submodules'] == True) and os.path.exists('.gitmodules'):
1019 command('git submodule --quiet init')
1020 paths = command_and_read('git config --file .gitmodules --get-regexp path')
1021 urls = command_and_read('git config --file .gitmodules --get-regexp url')
1022 for path, url in zip(paths, urls):
1024 if config.has('git_reference'):
1025 url = url.split(' ')[1]
1026 ref_path = os.path.join(config.get('git_reference'), os.path.basename(url))
1027 if os.path.exists(ref_path):
1028 ref = '--reference %s' % ref_path
1029 path = path.split(' ')[1]
1030 command('git -c protocol.file.allow=always submodule --quiet update %s %s' % (ref, path))
1032 if os.path.exists('%s/wscript' % proj):
1033 v = read_wscript_variable(proj, "VERSION");
1036 self.version = Version(v)
1039 tag = command_and_read('git -C %s describe --match v* --tags' % proj)[0][1:]
1040 self.version = Version.from_git_tag(tag)
1042 # We'll leave version as None if we can't read it; maybe this is a bad idea
1043 # Should probably just install git on the Windows VM
1048 def call(self, function, *args):
1049 with TreeDirectory(self):
1050 return self.cscript[function](self.target, *args)
1052 def add_defaults(self, options):
1053 """Add the defaults from self into a dict options"""
1054 if 'option_defaults' in self.cscript:
1055 from_cscript = self.cscript['option_defaults']
1056 if isinstance(from_cscript, dict):
1057 defaults_dict = from_cscript
1059 log_normal("Deprecated cscript option_defaults method; replace with a dict")
1060 defaults_dict = from_cscript()
1061 for k, v in defaults_dict.items():
1062 if not k in options:
1065 def dependencies(self, options):
1067 yield details of the dependencies of this tree. Each dependency is returned
1068 as a tuple of (tree, options, parent_tree). The 'options' parameter are the options that
1069 we want to force for 'self'.
1071 if not 'dependencies' in self.cscript:
1074 if len(inspect.getfullargspec(self.cscript['dependencies']).args) == 2:
1075 self_options = copy.copy(options)
1076 self.add_defaults(self_options)
1077 deps = self.call('dependencies', self_options)
1079 log_normal("Deprecated cscript dependencies() method with no options parameter")
1080 deps = self.call('dependencies')
1082 # Loop over our immediate dependencies
1084 dep = globals.trees.get(d[0], d[1], self.target, self.name)
1086 # deps only get their options from the parent's cscript
1087 dep_options = d[2] if len(d) > 2 else {}
1088 for i in dep.dependencies(dep_options):
1090 yield (dep, dep_options, self)
1092 def checkout_dependencies(self, options={}):
1093 for i in self.dependencies(options):
1096 def build_dependencies(self, options):
1098 Called on the 'main' project tree (-p on the command line) to build all dependencies.
1099 'options' will be the ones from the command line.
1101 for i in self.dependencies(options):
1104 def build(self, options, for_package=False):
1108 log_verbose("Building %s %s %s with %s" % (self.name, self.commit_ish, self.version, options))
1110 variables = copy.copy(self.target.variables)
1112 options = copy.copy(options)
1113 self.add_defaults(options)
1115 if not globals.dry_run:
1116 num_args = len(inspect.getfullargspec(self.cscript['build']).args)
1118 self.call('build', options, for_package)
1120 self.call('build', options)
1124 self.target.variables = variables
1129 # Command-line parser
1133 parser = argparse.ArgumentParser()
1134 parser.add_argument('-p', '--project', help='project name')
1135 parser.add_argument('-c', '--checkout', help='string to pass to git for checkout')
1136 parser.add_argument('-o', '--output', help='output directory', default='.')
1137 parser.add_argument('-q', '--quiet', help='be quiet', action='store_true')
1138 parser.add_argument('-t', '--target', help='target', action='append')
1139 parser.add_argument('--environment-version', help='version of environment to use')
1140 parser.add_argument('-k', '--keep', help='keep working tree', action='store_true')
1141 parser.add_argument('--debug', help='build with debugging symbols where possible', action='store_true')
1142 parser.add_argument('-w', '--work', help='override default work directory')
1143 parser.add_argument('-g', '--git-prefix', help='override configured git prefix')
1144 parser.add_argument('-n', '--dry-run', help='run the process without building anything', action='store_true')
1145 parser.add_argument('-e', '--environment', help='pass the value of the named environment variable into the build', action='append')
1146 parser.add_argument('-m', '--mount', help='mount a given directory in the build environment', action='append')
1147 parser.add_argument('--option', help='set an option for the build (use --option key:value)', action='append')
1148 parser.add_argument('--ccache', help='use ccache', action='store_true')
1149 parser.add_argument('--verbose', help='be verbose', action='store_true')
1151 subparsers = parser.add_subparsers(help='command to run', dest='command')
1152 parser_build = subparsers.add_parser("build", help="build project")
1153 parser_package = subparsers.add_parser("package", help="build and package project")
1154 parser_package.add_argument('--no-notarize', help='do not notarize .dmg packages', action='store_true')
1155 parser_release = subparsers.add_parser("release", help="release a project using its next version number (adding a tag)")
1156 parser_release.add_argument('--minor', help='minor version number bump', action='store_true')
1157 parser_release.add_argument('--micro', help='micro version number bump', action='store_true')
1158 parser_pot = subparsers.add_parser("pot", help="build the project's .pot files")
1159 parser_manual = subparsers.add_parser("manual", help="build the project's manual")
1160 parser_doxygen = subparsers.add_parser("doxygen", help="build the project's Doxygen documentation")
1161 parser_latest = subparsers.add_parser("latest", help="print out the latest version")
1162 parser_latest.add_argument('--major', help='major version to return', type=int)
1163 parser_latest.add_argument('--minor', help='minor version to return', type=int)
1164 parser_test = subparsers.add_parser("test", help="build the project and run its unit tests")
1165 parser_test.add_argument('--no-implicit-build', help='do not build first', action='store_true')
1166 parser_test.add_argument('--test', help="name of test to run, defaults to all")
1167 parser_shell = subparsers.add_parser("shell", help="start a shell in the project's work directory")
1168 parser_checkout = subparsers.add_parser("checkout", help="check out the project")
1169 parser_revision = subparsers.add_parser("revision", help="print the head git revision number")
1170 parser_dependencies = subparsers.add_parser("dependencies", help="print details of the project's dependencies as a .dot file")
1171 parser_notarize = subparsers.add_parser("notarize", help="notarize .dmgs in a directory")
1172 parser_notarize.add_argument('--dmgs', help='directory containing *.dmg')
1175 args = parser.parse_args()
1177 # Check for incorrect multiple parameters
1178 if args.target is not None:
1179 if len(args.target) > 1:
1180 parser.error('multiple -t options specified')
1183 args.target = args.target[0]
1185 # Override configured stuff
1186 if args.git_prefix is not None:
1187 config.set('git_prefix', args.git_prefix)
1189 if args.output.find(':') == -1:
1190 # This isn't of the form host:path so make it absolute
1191 args.output = os.path.abspath(args.output) + '/'
1193 if args.output[-1] != ':' and args.output[-1] != '/':
1196 # Now, args.output is 'host:', 'host:path/' or 'path/'
1198 if args.work is not None:
1199 args.work = os.path.abspath(args.work)
1200 if not os.path.exists(args.work):
1201 os.makedirs(args.work)
1203 if args.project is None and not args.command in ['shell', 'notarize']:
1204 raise Error('you must specify -p or --project')
1206 globals.quiet = args.quiet
1207 globals.verbose = args.verbose
1208 globals.dry_run = args.dry_run
1210 if args.command == 'build':
1211 if args.target is None:
1212 raise Error('you must specify -t or --target')
1214 target = target_factory(args)
1216 target.build(args.project, args.checkout, get_command_line_options(args))
1221 elif args.command == 'package':
1222 if args.target is None:
1223 raise Error('you must specify -t or --target')
1227 target = target_factory(args)
1229 if target.platform == 'linux' and target.detail != "appimage":
1230 if target.distro != 'arch':
1231 output_dir = os.path.join(args.output, '%s-%s-%d' % (target.distro, target.version, target.bits))
1233 output_dir = os.path.join(args.output, '%s-%d' % (target.distro, target.bits))
1235 output_dir = args.output
1237 makedirs(output_dir)
1238 target.package(args.project, args.checkout, output_dir, get_command_line_options(args), not args.no_notarize)
1240 if target is not None and not args.keep:
1243 elif args.command == 'release':
1244 if args.minor is False and args.micro is False:
1245 raise Error('you must specify --minor or --micro')
1247 target = SourceTarget()
1248 tree = globals.trees.get(args.project, args.checkout, target)
1250 version = tree.version
1251 version.to_release()
1253 version.bump_minor()
1255 version.bump_micro()
1257 with TreeDirectory(tree):
1258 command('git tag -m "v%s" v%s' % (version, version))
1259 command('git push --tags')
1263 elif args.command == 'pot':
1264 target = SourceTarget()
1265 tree = globals.trees.get(args.project, args.checkout, target)
1267 pots = tree.call('make_pot')
1269 copyfile(p, '%s%s' % (args.output, os.path.basename(p)))
1273 elif args.command == 'manual':
1274 target = SourceTarget()
1275 tree = globals.trees.get(args.project, args.checkout, target)
1276 tree.checkout_dependencies()
1278 outs = tree.call('make_manual')
1280 if os.path.isfile(o):
1281 copyfile(o, '%s%s' % (args.output, os.path.basename(o)))
1283 copytree(o, '%s%s' % (args.output, os.path.basename(o)))
1287 elif args.command == 'doxygen':
1288 target = SourceTarget()
1289 tree = globals.trees.get(args.project, args.checkout, target)
1291 dirs = tree.call('make_doxygen')
1292 if hasattr(dirs, 'strip') or (not hasattr(dirs, '__getitem__') and not hasattr(dirs, '__iter__')):
1296 copytree(d, args.output)
1300 elif args.command == 'latest':
1301 target = SourceTarget()
1302 tree = globals.trees.get(args.project, args.checkout, target)
1304 with TreeDirectory(tree):
1305 f = command_and_read('git log --tags --simplify-by-decoration --pretty="%d"')
1308 while latest is None:
1311 m = re.compile(".*\((.*)\).*").match(t)
1313 tags = m.group(1).split(', ')
1318 if len(t) > 0 and t[0] == 'v':
1320 if (args.major is None or v.major == args.major) and (args.minor is None or v.minor == args.minor):
1326 elif args.command == 'test':
1327 if args.target is None:
1328 raise Error('you must specify -t or --target')
1332 target = target_factory(args)
1333 options = get_command_line_options(args)
1334 if args.no_implicit_build:
1335 globals.trees.add_built(args.project, args.checkout, target)
1337 target.build(args.project, args.checkout, options)
1338 target.test(args.project, args.checkout, target, args.test, options)
1340 if target is not None and not args.keep:
1343 elif args.command == 'shell':
1344 if args.target is None:
1345 raise Error('you must specify -t or --target')
1347 target = target_factory(args)
1348 target.command('bash')
1350 elif args.command == 'revision':
1352 target = SourceTarget()
1353 tree = globals.trees.get(args.project, args.checkout, target)
1354 with TreeDirectory(tree):
1355 print(command_and_read('git rev-parse HEAD')[0].strip()[:7])
1358 elif args.command == 'checkout':
1360 if args.output is None:
1361 raise Error('you must specify -o or --output')
1363 target = SourceTarget()
1364 tree = globals.trees.get(args.project, args.checkout, target)
1365 with TreeDirectory(tree):
1366 shutil.copytree('.', args.output)
1369 elif args.command == 'dependencies':
1370 if args.target is None:
1371 raise Error('you must specify -t or --target')
1372 if args.checkout is None:
1373 raise Error('you must specify -c or --checkout')
1375 target = target_factory(args)
1376 tree = globals.trees.get(args.project, args.checkout, target)
1377 print("strict digraph {")
1378 for d in list(tree.dependencies({})):
1379 print("%s -> %s;" % (d[2].name.replace("-", "-"), d[0].name.replace("-", "_")))
1382 elif args.command == 'notarize':
1383 if args.dmgs is None:
1384 raise Error('you must specify ---dmgs')
1386 for dmg in Path(args.dmgs).glob('*.dmg'):
1392 print('cdist: %s' % str(e), file=sys.stderr)