3 # Copyright (C) 2012-2020 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
37 TEMPORARY_DIRECTORY = '/var/tmp'
39 class Error(Exception):
40 def __init__(self, value):
49 Store for Tree objects which re-uses already-created objects
50 and checks for requests for different versions of the same thing.
56 def get(self, name, specifier, target, required_by=None):
58 if t.name == name and t.specifier == specifier and t.target == target:
60 elif t.name == name and t.specifier != specifier:
61 a = specifier if specifier is not None else "[Any]"
62 if required_by is not None:
63 a += ' by %s' % required_by
64 b = t.specifier if t.specifier is not None else "[Any]"
65 if t.required_by is not None:
66 b += ' by %s' % t.required_by
67 raise Error('conflicting versions of %s required (%s versus %s)' % (name, a, b))
69 nt = Tree(name, specifier, target, required_by)
87 def __init__(self, key, default=None):
91 def offer(self, key, value):
95 class BoolOption(object):
96 def __init__(self, key):
100 def offer(self, key, value):
102 self.value = (value == 'yes' or value == '1' or value == 'true')
106 self.options = [ Option('mxe_prefix'),
107 Option('git_prefix'),
108 Option('git_reference'),
109 Option('osx_environment_prefix'),
110 Option('osx_sdk_prefix'),
112 Option('osx_keychain_file'),
113 Option('osx_keychain_password'),
115 Option('apple_password'),
116 BoolOption('docker_sudo'),
117 BoolOption('docker_no_user'),
118 Option('docker_hub_repository'),
119 Option('flatpak_state_dir'),
120 Option('parallel', multiprocessing.cpu_count()) ]
122 config_dir = '%s/.config' % os.path.expanduser('~')
123 if not os.path.exists(config_dir):
125 config_file = '%s/cdist' % config_dir
126 if not os.path.exists(config_file):
127 f = open(config_file, 'w')
128 for o in self.options:
129 print('# %s ' % o.key, file=f)
131 print('Template config file written to %s; please edit and try again.' % config_file, file=sys.stderr)
135 f = open('%s/.config/cdist' % os.path.expanduser('~'), 'r')
141 if len(l) > 0 and l[0] == '#':
144 s = l.strip().split()
146 for k in self.options:
152 for o in self.options:
153 if o.key == k and o.value is not None:
158 for o in self.options:
161 raise Error('Required setting %s not found' % k)
165 for o in self.options:
169 if self.get('docker_sudo'):
181 if not globals.quiet:
182 print('\x1b[33m* %s\x1b[0m' % m)
186 print('\x1b[35m* %s\x1b[0m' % m)
188 def escape_spaces(s):
189 return s.replace(' ', '\\ ')
192 """Escape a host:filename string for use with an scp command"""
194 assert(len(s) == 1 or len(s) == 2)
196 return '%s:"\'%s\'"' % (s[0], s[1])
198 return '\"%s\"' % s[0]
201 return '\"%s\"' % n.substr(' ', '\\ ')
204 log_normal('copy %s -> %s' % (scp_escape(a), scp_escape(b)))
205 if b.startswith('s3://'):
206 command('s3cmd -P -r put "%s" "%s"' % (a, b))
208 command('scp -r %s %s' % (scp_escape(a), scp_escape(b)))
211 log_normal('copy %s -> %s' % (scp_escape(a), scp_escape(b)))
212 if b.startswith('s3://'):
213 command('s3cmd -P put "%s" "%s"' % (a, b))
219 temp_path = os.path.join(os.path.dirname(path), ".tmp." + os.path.basename(path))
220 command('scp %s %s' % (scp_escape(a), scp_escape(host + ":" + temp_path)))
221 command('ssh %s -- mv "%s" "%s"' % (host, escape_spaces(temp_path), escape_spaces(path)))
223 command('scp %s %s' % (scp_escape(a), scp_escape(b)))
227 Make directories either locally or on a remote host; remotely if
228 d includes a colon, otherwise locally.
230 if d.startswith('s3://'):
231 # No need to create folders on S3
234 if d.find(':') == -1:
242 command('ssh %s -- mkdir -p %s' % (s[0], s[1]))
245 log_normal('remove %s' % a)
249 log_normal('remove %s' % a)
250 shutil.rmtree(a, ignore_errors=True)
256 raise Error('command %s failed' % c)
258 def command_and_read(c):
260 p = subprocess.Popen(c.split(), stdout=subprocess.PIPE, stderr=subprocess.PIPE)
261 (out, err) = p.communicate()
262 if p.returncode != 0:
263 raise Error('command %s failed (%s)' % (c, err))
264 return str(out, 'utf-8').splitlines()
266 def read_wscript_variable(directory, variable):
267 f = open('%s/wscript' % directory, 'r')
274 if len(s) == 3 and s[0] == variable:
281 def set_version_in_wscript(version):
282 f = open('wscript', 'rw')
283 o = open('wscript.tmp', 'w')
290 if len(s) == 3 and s[0] == "VERSION":
291 print("VERSION = '%s'" % version, file=o)
293 print(l, file=o, end="")
297 os.rename('wscript.tmp', 'wscript')
299 def append_version_to_changelog(version):
301 f = open('ChangeLog', 'r')
303 log_normal('Could not open ChangeLog')
309 f = open('ChangeLog', 'w')
310 now = datetime.datetime.now()
311 f.write('%d-%02d-%02d Carl Hetherington <cth@carlh.net>\n\n\t* Version %s released.\n\n' % (now.year, now.month, now.day, version))
314 def append_version_to_debian_changelog(version):
315 if not os.path.exists('debian'):
316 log_normal('Could not find debian directory')
319 command('dch -b -v %s-1 "New upstream release."' % version)
321 def devel_to_git(git_commit, filename):
322 if git_commit is not None:
323 filename = filename.replace('devel', '-%s' % git_commit)
327 def get_command_line_options(args):
328 """Get the options specified by --option on the command line"""
330 if args.option is not None:
331 for o in args.option:
334 raise Error("Bad option `%s'" % o)
336 options[b[0]] = False
345 def __init__(self, tree):
348 self.cwd = os.getcwd()
349 os.chdir('%s/src/%s' % (self.tree.target.directory, self.tree.name))
350 def __exit__(self, type, value, traceback):
358 def __init__(self, s):
361 if s.startswith("'"):
366 if s.endswith('devel'):
370 if s.endswith('pre'):
374 self.major = int(p[0])
375 self.minor = int(p[1])
377 self.micro = int(p[2])
382 def from_git_tag(cls, tag):
383 bits = tag.split('-')
385 if len(bits) > 1 and int(bits[1]) > 0:
389 def bump_minor(self):
393 def bump_micro(self):
399 def to_release(self):
403 s = '%d.%d.%d' % (self.major, self.minor, self.micro)
413 class Target(object):
415 Class representing the target that we are building for. This is exposed to cscripts,
416 though not all of it is guaranteed 'API'. cscripts may expect:
418 platform: platform string (e.g. 'windows', 'linux', 'osx')
419 parallel: number of parallel jobs to run
420 directory: directory to work in
421 variables: dict of environment variables
422 debug: True to build a debug version, otherwise False
423 ccache: True to use ccache, False to not
424 set(a, b): set the value of variable 'a' to 'b'
425 unset(a): unset the value of variable 'a'
426 command(c): run the command 'c' in the build environment
430 def __init__(self, platform, directory=None):
432 platform -- platform string (e.g. 'windows', 'linux', 'osx')
433 directory -- directory to work in; if None we will use a temporary directory
434 Temporary directories will be removed after use; specified directories will not.
436 self.platform = platform
437 self.parallel = int(config.get('parallel'))
439 # Environment variables that we will use when we call cscripts
443 # True to build our dependencies ourselves; False if this is taken care
444 # of in some other way
445 self.build_dependencies = True
447 if directory is None:
448 self.directory = tempfile.mkdtemp('', 'tmp', TEMPORARY_DIRECTORY)
450 self.set('CCACHE_BASEDIR', os.path.realpath(self.directory))
451 self.set('CCACHE_NOHASHDIR', '')
453 self.directory = os.path.realpath(directory)
460 def package(self, project, checkout, output_dir, options):
461 tree = self.build(project, checkout, options)
462 tree.add_defaults(options)
463 if len(inspect.getfullargspec(tree.cscript['package']).args) == 3:
464 packages = tree.call('package', tree.version, options)
466 log_normal("Deprecated cscript package() method with no options parameter")
467 packages = tree.call('package', tree.version)
469 if isinstance(packages, list):
471 copyfile(p, os.path.join(output_dir, os.path.basename(devel_to_git(tree.git_commit, p))))
473 copyfile(packages, os.path.join(output_dir, os.path.basename(devel_to_git(tree.git_commit, packages))))
475 def build(self, project, checkout, options):
476 tree = globals.trees.get(project, checkout, self)
477 if self.build_dependencies:
478 tree.build_dependencies(options)
482 def test(self, tree, test, options):
483 """test is the test case to run, or None"""
484 if self.build_dependencies:
485 tree.build_dependencies(options)
488 tree.add_defaults(options)
489 if len(inspect.getfullargspec(tree.cscript['test']).args) == 3:
490 return tree.call('test', options, test)
492 log_normal('Deprecated cscript test() method with no options parameter')
493 return tree.call('test', test)
496 self.variables[a] = b
499 del(self.variables[a])
502 return self.variables[a]
504 def append(self, k, v, s):
505 if (not k in self.variables) or len(self.variables[k]) == 0:
506 self.variables[k] = '"%s"' % v
508 e = self.variables[k]
509 if e[0] == '"' and e[-1] == '"':
510 self.variables[k] = '"%s%s%s"' % (e[1:-1], s, v)
512 self.variables[k] = '"%s%s%s"' % (e, s, v)
514 def append_with_space(self, k, v):
515 return self.append(k, v, ' ')
517 def append_with_colon(self, k, v):
518 return self.append(k, v, ':')
520 def variables_string(self, escaped_quotes=False):
522 for k, v in self.variables.items():
524 v = v.replace('"', '\\"')
525 e += '%s=%s ' % (k, v)
530 rmtree(self.directory)
544 class DockerTarget(Target):
545 def __init__(self, platform, directory):
546 super(DockerTarget, self).__init__(platform, directory)
548 self.privileged = False
551 if config.get('docker_no_user'):
553 return '-u %s' % getpass.getuser()
555 def _mount_option(self, d):
556 return '-v %s:%s ' % (os.path.realpath(d), os.path.realpath(d))
559 opts = self._mount_option(self.directory)
560 for m in self.mounts:
561 opts += self._mount_option(m)
562 if config.has('git_reference'):
563 opts += self._mount_option(config.get('git_reference'))
565 opts += '--privileged=true '
567 opts += "-e CCACHE_DIR=/ccache/%s-%d --mount source=ccache,target=/ccache" % (self.image, os.getuid())
570 if config.has('docker_hub_repository'):
571 tag = '%s:%s' % (config.get('docker_hub_repository'), tag)
573 self.container = command_and_read('%s run %s %s -itd %s /bin/bash' % (config.docker(), self._user_tag(), opts, tag))[0].strip()
575 def command(self, cmd):
576 dir = os.path.join(self.directory, os.path.relpath(os.getcwd(), self.directory))
577 interactive_flag = '-i ' if sys.stdin.isatty() else ''
578 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))
581 super(DockerTarget, self).cleanup()
582 command('%s kill %s' % (config.docker(), self.container))
585 self.mounts.append(m)
588 class FlatpakTarget(Target):
589 def __init__(self, project, checkout):
590 super(FlatpakTarget, self).__init__('flatpak')
591 self.build_dependencies = False
592 self.project = project
593 self.checkout = checkout
598 def command(self, cmd):
601 def checkout_dependencies(self):
602 tree = globals.trees.get(self.project, self.checkout, self)
603 return tree.checkout_dependencies()
608 def flatpak_builder(self):
609 b = 'flatpak-builder'
610 if config.has('flatpak_state_dir'):
611 b += ' --state-dir=%s' % config.get('flatpak_state_dir')
615 class WindowsTarget(DockerTarget):
617 This target exposes the following additional API:
619 version: Windows version ('xp' or None)
620 bits: bitness of Windows (32 or 64)
621 name: name of our target e.g. x86_64-w64-mingw32.shared
622 environment_prefix: path to Windows environment for the appropriate target (libraries and some tools)
623 tool_path: path to 32- and 64-bit tools
625 def __init__(self, windows_version, bits, directory, environment_version):
626 super(WindowsTarget, self).__init__('windows', directory)
627 self.version = windows_version
630 self.tool_path = '%s/usr/bin' % config.get('mxe_prefix')
632 self.name = 'i686-w64-mingw32.shared'
634 self.name = 'x86_64-w64-mingw32.shared'
635 self.environment_prefix = '%s/usr/%s' % (config.get('mxe_prefix'), self.name)
637 self.set('PKG_CONFIG_LIBDIR', '%s/lib/pkgconfig' % self.environment_prefix)
638 self.set('PKG_CONFIG_PATH', '%s/lib/pkgconfig:%s/bin/pkgconfig' % (self.directory, self.directory))
639 self.set('PATH', '%s/bin:%s:%s' % (self.environment_prefix, self.tool_path, os.environ['PATH']))
640 self.set('LD', '%s-ld' % self.name)
641 self.set('RANLIB', '%s-ranlib' % self.name)
642 self.set('WINRC', '%s-windres' % self.name)
643 cxx = '-I%s/include -I%s/include' % (self.environment_prefix, self.directory)
644 link = '-L%s/lib -L%s/lib' % (self.environment_prefix, self.directory)
645 self.set('CXXFLAGS', '"%s"' % cxx)
646 self.set('CPPFLAGS', '')
647 self.set('LINKFLAGS', '"%s"' % link)
648 self.set('LDFLAGS', '"%s"' % link)
650 self.image = 'windows'
651 if environment_version is not None:
652 self.image += '_%s' % environment_version
657 self.set('CC', '"ccache %s-gcc"' % self.name)
658 self.set('CXX', '"ccache %s-g++"' % self.name)
660 self.set('CC', '%s-gcc' % self.name)
661 self.set('CXX', '%s-g++' % self.name)
664 def library_prefix(self):
665 log_normal('Deprecated property library_prefix: use environment_prefix')
666 return self.environment_prefix
669 def windows_prefix(self):
670 log_normal('Deprecated property windows_prefix: use environment_prefix')
671 return self.environment_prefix
674 def mingw_prefixes(self):
675 log_normal('Deprecated property mingw_prefixes: use environment_prefix')
676 return [self.environment_prefix]
679 def mingw_path(self):
680 log_normal('Deprecated property mingw_path: use tool_path')
681 return self.tool_path
684 def mingw_name(self):
685 log_normal('Deprecated property mingw_name: use name')
689 class LinuxTarget(DockerTarget):
691 Build for Linux in a docker container.
692 This target exposes the following additional API:
694 distro: distribution ('debian', 'ubuntu', 'centos' or 'fedora')
695 version: distribution version (e.g. '12.04', '8', '6.5')
696 bits: bitness of the distribution (32 or 64)
697 detail: None or 'appimage' if we are building for appimage
700 def __init__(self, distro, version, bits, directory=None):
701 super(LinuxTarget, self).__init__('linux', directory)
703 self.version = version
707 self.set('CXXFLAGS', '-I%s/include' % self.directory)
708 self.set('CPPFLAGS', '')
709 self.set('LINKFLAGS', '-L%s/lib' % self.directory)
710 self.set('PKG_CONFIG_PATH',
711 '%s/lib/pkgconfig:%s/lib64/pkgconfig:/usr/local/lib64/pkgconfig:/usr/local/lib/pkgconfig' % (self.directory, self.directory))
712 self.set('PATH', '/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin')
714 if self.version is None:
715 self.image = '%s-%s' % (self.distro, self.bits)
717 self.image = '%s-%s-%s' % (self.distro, self.version, self.bits)
720 super(LinuxTarget, self).setup()
722 self.set('CC', '"ccache gcc"')
723 self.set('CXX', '"ccache g++"')
725 def test(self, tree, test, options):
726 self.append_with_colon('PATH', '%s/bin' % self.directory)
727 self.append_with_colon('LD_LIBRARY_PATH', '%s/lib' % self.directory)
728 super(LinuxTarget, self).test(tree, test, options)
731 class AppImageTarget(LinuxTarget):
732 def __init__(self, work):
733 super(AppImageTarget, self).__init__('ubuntu', '18.04', 64, work)
734 self.detail = 'appimage'
735 self.privileged = True
738 class OSXTarget(Target):
739 def __init__(self, directory=None):
740 super(OSXTarget, self).__init__('osx', directory)
741 self.sdk = config.get('osx_sdk')
742 self.sdk_prefix = config.get('osx_sdk_prefix')
743 self.environment_prefix = config.get('osx_environment_prefix')
744 self.apple_id = config.get('apple_id')
745 self.apple_password = config.get('apple_password')
746 self.osx_keychain_file = config.get('osx_keychain_file')
747 self.osx_keychain_password = config.get('osx_keychain_password')
749 def command(self, c):
750 command('%s %s' % (self.variables_string(False), c))
752 def build(self, *a, **k):
753 self.command('security unlock-keychain -p %s %s' % (self.osx_keychain_password, self.osx_keychain_file))
754 return super().build(*a, **k)
757 class OSXSingleTarget(OSXTarget):
758 def __init__(self, bits, directory=None):
759 super(OSXSingleTarget, self).__init__(directory)
767 flags = '-isysroot %s/MacOSX%s.sdk -arch %s' % (self.sdk_prefix, self.sdk, arch)
768 enviro = '%s/%d' % (config.get('osx_environment_prefix'), bits)
770 # Environment variables
771 self.set('CFLAGS', '"-I%s/include -I%s/include %s"' % (self.directory, enviro, flags))
772 self.set('CPPFLAGS', '')
773 self.set('CXXFLAGS', '"-I%s/include -I%s/include %s"' % (self.directory, enviro, flags))
774 self.set('LDFLAGS', '"-L%s/lib -L%s/lib %s"' % (self.directory, enviro, flags))
775 self.set('LINKFLAGS', '"-L%s/lib -L%s/lib %s"' % (self.directory, enviro, flags))
776 self.set('PKG_CONFIG_PATH', '%s/lib/pkgconfig:%s/lib/pkgconfig:/usr/lib/pkgconfig' % (self.directory, enviro))
777 self.set('PATH', '$PATH:/usr/bin:/sbin:/usr/local/bin:%s/bin' % enviro)
778 self.set('MACOSX_DEPLOYMENT_TARGET', config.get('osx_sdk'))
779 self.set('CCACHE_BASEDIR', self.directory)
781 @Target.ccache.setter
783 Target.ccache.fset(self, v)
785 self.set('CC', '"ccache gcc"')
786 self.set('CXX', '"ccache g++"')
789 class OSXUniversalTarget(OSXTarget):
790 def __init__(self, directory=None):
791 super(OSXUniversalTarget, self).__init__(directory)
794 def package(self, project, checkout, output_dir, options):
797 target = OSXSingleTarget(b, os.path.join(self.directory, '%d' % b))
798 target.ccache = self.ccache
799 tree = globals.trees.get(project, checkout, target)
800 tree.build_dependencies(options)
803 tree = globals.trees.get(project, checkout, self)
804 with TreeDirectory(tree):
805 if len(inspect.getfullargspec(tree.cscript['package']).args) == 3:
806 packages = tree.call('package', tree.version, options)
808 log_normal("Deprecated cscript package() method with no options parameter")
809 packages = tree.call('package', tree.version)
811 copyfile(p, os.path.join(output_dir, os.path.basename(devel_to_git(tree.git_commit, p))))
813 class SourceTarget(Target):
814 """Build a source .tar.bz2"""
816 super(SourceTarget, self).__init__('source')
818 def command(self, c):
819 log_normal('host -> %s' % c)
820 command('%s %s' % (self.variables_string(), c))
823 rmtree(self.directory)
825 def package(self, project, checkout, output_dir, options):
826 tree = globals.trees.get(project, checkout, self)
827 with TreeDirectory(tree):
828 name = read_wscript_variable(os.getcwd(), 'APPNAME')
829 command('./waf dist')
830 p = os.path.abspath('%s-%s.tar.bz2' % (name, tree.version))
831 copyfile(p, os.path.join(output_dir, os.path.basename(devel_to_git(tree.git_commit, p))))
833 # @param s Target string:
835 # or ubuntu-version-{32,64}
836 # or debian-version-{32,64}
837 # or centos-version-{32,64}
838 # or fedora-version-{32,64}
839 # or mageia-version-{32,64}
844 # @param debug True to build with debugging symbols (where possible)
845 def target_factory(args):
848 if s.startswith('windows-'):
851 target = WindowsTarget(None, int(x[1]), args.work, args.environment_version)
853 target = WindowsTarget(x[1], int(x[2]), args.work, args.environment_version)
855 raise Error("Bad Windows target name `%s'")
856 elif s.startswith('ubuntu-') or s.startswith('debian-') or s.startswith('centos-') or s.startswith('fedora-') or s.startswith('mageia-'):
859 raise Error("Bad Linux target name `%s'; must be something like ubuntu-16.04-32 (i.e. distro-version-bits)" % s)
860 target = LinuxTarget(p[0], p[1], int(p[2]), args.work)
861 elif s.startswith('arch-'):
864 raise Error("Bad Arch target name `%s'; must be arch-32 or arch-64")
865 target = LinuxTarget(p[0], None, int(p[1]), args.work)
866 elif s == 'raspbian':
867 target = LinuxTarget(s, None, None, args.work)
868 elif s.startswith('osx-'):
869 target = OSXSingleTarget(int(s.split('-')[1]), args.work)
871 if globals.command == 'build':
872 target = OSXSingleTarget(64, args.work)
874 target = OSXUniversalTarget(args.work)
876 target = SourceTarget()
878 target = FlatpakTarget(args.project, args.checkout)
879 elif s == 'appimage':
880 target = AppImageTarget(args.work)
883 raise Error("Bad target `%s'" % s)
885 target.debug = args.debug
886 target.ccache = args.ccache
888 if args.environment is not None:
889 for e in args.environment:
890 target.set(e, os.environ[e])
892 if args.mount is not None:
905 """Description of a tree, which is a checkout of a project,
906 possibly built. This class is never exposed to cscripts.
908 name -- name of git repository (without the .git)
909 specifier -- git tag or revision to use
910 target -- target object that we are using
911 version -- version from the wscript (if one is present)
912 git_commit -- git revision that is actually being used
913 built -- true if the tree has been built yet in this run
914 required_by -- name of the tree that requires this one
917 def __init__(self, name, specifier, target, required_by):
919 self.specifier = specifier
922 self.git_commit = None
924 self.required_by = required_by
932 redirect = '>/dev/null'
933 if config.has('git_reference'):
934 ref = '--reference-if-able %s/%s.git' % (config.get('git_reference'), self.name)
937 command('git clone %s %s %s/%s.git %s/src/%s' % (flags, ref, config.get('git_prefix'), self.name, target.directory, self.name))
938 os.chdir('%s/src/%s' % (target.directory, self.name))
940 spec = self.specifier
944 command('git checkout %s %s %s' % (flags, spec, redirect))
945 self.git_commit = command_and_read('git rev-parse --short=7 HEAD')[0].strip()
947 proj = '%s/src/%s' % (target.directory, self.name)
950 exec(open('%s/cscript' % proj).read(), self.cscript)
952 # cscript can include submodules = False to stop submodules being fetched
953 if (not 'submodules' in self.cscript or self.cscript['submodules'] == True) and os.path.exists('.gitmodules'):
954 command('git submodule --quiet init')
955 paths = command_and_read('git config --file .gitmodules --get-regexp path')
956 urls = command_and_read('git config --file .gitmodules --get-regexp url')
957 for path, url in zip(paths, urls):
959 if config.has('git_reference'):
960 url = url.split(' ')[1]
961 ref_path = os.path.join(config.get('git_reference'), os.path.basename(url))
962 if os.path.exists(ref_path):
963 ref = '--reference %s' % ref_path
964 path = path.split(' ')[1]
965 command('git submodule --quiet update %s %s' % (ref, path))
967 if os.path.exists('%s/wscript' % proj):
968 v = read_wscript_variable(proj, "VERSION");
971 self.version = Version(v)
973 tag = command_and_read('git -C %s describe --tags' % proj)[0][1:]
974 self.version = Version.from_git_tag(tag)
978 def call(self, function, *args):
979 with TreeDirectory(self):
980 return self.cscript[function](self.target, *args)
982 def add_defaults(self, options):
983 """Add the defaults from self into a dict options"""
984 if 'option_defaults' in self.cscript:
985 from_cscript = self.cscript['option_defaults']
986 if isinstance(from_cscript, dict):
987 defaults_dict = from_cscript
989 log_normal("Deprecated cscript option_defaults method; replace with a dict")
990 defaults_dict = from_cscript()
991 for k, v in defaults_dict.items():
995 def dependencies(self, options):
997 yield details of the dependencies of this tree. Each dependency is returned
998 as a tuple of (tree, options, parent_tree). The 'options' parameter are the options that
999 we want to force for 'self'.
1001 if not 'dependencies' in self.cscript:
1004 if len(inspect.getfullargspec(self.cscript['dependencies']).args) == 2:
1005 self_options = copy.copy(options)
1006 self.add_defaults(self_options)
1007 deps = self.call('dependencies', self_options)
1009 log_normal("Deprecated cscript dependencies() method with no options parameter")
1010 deps = self.call('dependencies')
1012 # Loop over our immediate dependencies
1014 dep = globals.trees.get(d[0], d[1], self.target, self.name)
1016 # deps only get their options from the parent's cscript
1017 dep_options = d[2] if len(d) > 2 else {}
1018 for i in dep.dependencies(dep_options):
1020 yield (dep, dep_options, self)
1022 def checkout_dependencies(self, options={}):
1023 for i in self.dependencies(options):
1026 def build_dependencies(self, options):
1028 Called on the 'main' project tree (-p on the command line) to build all dependencies.
1029 'options' will be the ones from the command line.
1031 for i in self.dependencies(options):
1034 def build(self, options):
1038 log_verbose("Building %s %s %s with %s" % (self.name, self.specifier, self.version, options))
1040 variables = copy.copy(self.target.variables)
1042 options = copy.copy(options)
1043 self.add_defaults(options)
1045 if not globals.dry_run:
1046 if len(inspect.getfullargspec(self.cscript['build']).args) == 2:
1047 self.call('build', options)
1051 self.target.variables = variables
1055 # Command-line parser
1061 "build": "build project",
1062 "package": "build and package project",
1063 "release": "release a project using its next version number (changing wscript and tagging)",
1064 "pot": "build the project's .pot files",
1065 "manual": "build the project's manual",
1066 "doxygen": "build the project's Doxygen documentation",
1067 "latest": "print out the latest version",
1068 "test": "run the project's unit tests",
1069 "shell": "build the project then start a shell",
1070 "checkout": "check out the project",
1071 "revision": "print the head git revision number",
1072 "dependencies" : "print details of the project's dependencies as a .dot file"
1075 one_of = "Command is one of:\n"
1077 for k, v in commands.items():
1078 one_of += "\t%s\t%s\n" % (k, v)
1081 parser = argparse.ArgumentParser()
1082 parser.add_argument('command', help=summary)
1083 parser.add_argument('-p', '--project', help='project name')
1084 parser.add_argument('--minor', help='minor version number bump', action='store_true')
1085 parser.add_argument('--micro', help='micro version number bump', action='store_true')
1086 parser.add_argument('--latest-major', help='major version to return with latest', type=int)
1087 parser.add_argument('--latest-minor', help='minor version to return with latest', type=int)
1088 parser.add_argument('-c', '--checkout', help='string to pass to git for checkout')
1089 parser.add_argument('-o', '--output', help='output directory', default='.')
1090 parser.add_argument('-q', '--quiet', help='be quiet', action='store_true')
1091 parser.add_argument('-t', '--target', help='target', action='append')
1092 parser.add_argument('--environment-version', help='version of environment to use')
1093 parser.add_argument('-k', '--keep', help='keep working tree', action='store_true')
1094 parser.add_argument('--debug', help='build with debugging symbols where possible', action='store_true')
1095 parser.add_argument('-w', '--work', help='override default work directory')
1096 parser.add_argument('-g', '--git-prefix', help='override configured git prefix')
1097 parser.add_argument('--test', help="name of test to run (with `test'), defaults to all")
1098 parser.add_argument('-n', '--dry-run', help='run the process without building anything', action='store_true')
1099 parser.add_argument('-e', '--environment', help='pass the value of the named environment variable into the build', action='append')
1100 parser.add_argument('-m', '--mount', help='mount a given directory in the build environment', action='append')
1101 parser.add_argument('--no-version-commit', help="use just tags for versioning, don't modify wscript, ChangeLog etc.", action='store_true')
1102 parser.add_argument('--option', help='set an option for the build (use --option key:value)', action='append')
1103 parser.add_argument('--ccache', help='use ccache', action='store_true')
1104 parser.add_argument('--verbose', help='be verbose', action='store_true')
1106 args = parser.parse_args()
1108 # Check for incorrect multiple parameters
1109 if args.target is not None:
1110 if len(args.target) > 1:
1111 parser.error('multiple -t options specified')
1114 args.target = args.target[0]
1116 # Override configured stuff
1117 if args.git_prefix is not None:
1118 config.set('git_prefix', args.git_prefix)
1120 if args.output.find(':') == -1:
1121 # This isn't of the form host:path so make it absolute
1122 args.output = os.path.abspath(args.output) + '/'
1124 if args.output[-1] != ':' and args.output[-1] != '/':
1127 # Now, args.output is 'host:', 'host:path/' or 'path/'
1129 if args.work is not None:
1130 args.work = os.path.abspath(args.work)
1131 if not os.path.exists(args.work):
1132 os.makedirs(args.work)
1134 if args.project is None and args.command != 'shell':
1135 raise Error('you must specify -p or --project')
1137 globals.quiet = args.quiet
1138 globals.verbose = args.verbose
1139 globals.command = args.command
1140 globals.dry_run = args.dry_run
1142 if not globals.command in commands:
1143 e = 'command must be one of:\n' + one_of
1144 raise Error('command must be one of:\n%s' % one_of)
1146 if globals.command == 'build':
1147 if args.target is None:
1148 raise Error('you must specify -t or --target')
1150 target = target_factory(args)
1151 target.build(args.project, args.checkout, get_command_line_options(args))
1155 elif globals.command == 'package':
1156 if args.target is None:
1157 raise Error('you must specify -t or --target')
1161 target = target_factory(args)
1163 if target.platform == 'linux' and target.detail != "appimage":
1164 if target.distro != 'arch':
1165 output_dir = os.path.join(args.output, '%s-%s-%d' % (target.distro, target.version, target.bits))
1167 output_dir = os.path.join(args.output, '%s-%d' % (target.distro, target.bits))
1169 output_dir = args.output
1171 makedirs(output_dir)
1172 target.package(args.project, args.checkout, output_dir, get_command_line_options(args))
1174 if target is not None and not args.keep:
1178 if target is not None and not args.keep:
1181 elif globals.command == 'release':
1182 if args.minor is False and args.micro is False:
1183 raise Error('you must specify --minor or --micro')
1185 target = SourceTarget()
1186 tree = globals.trees.get(args.project, args.checkout, target)
1188 version = tree.version
1189 version.to_release()
1191 version.bump_minor()
1193 version.bump_micro()
1195 with TreeDirectory(tree):
1196 if not args.no_version_commit:
1197 set_version_in_wscript(version)
1198 append_version_to_changelog(version)
1199 append_version_to_debian_changelog(version)
1200 command('git commit -a -m "Bump version"')
1202 command('git tag -m "v%s" v%s' % (version, version))
1204 if not args.no_version_commit:
1206 set_version_in_wscript(version)
1207 command('git commit -a -m "Bump version"')
1210 command('git push --tags')
1214 elif globals.command == 'pot':
1215 target = SourceTarget()
1216 tree = globals.trees.get(args.project, args.checkout, target)
1218 pots = tree.call('make_pot')
1220 copyfile(p, '%s%s' % (args.output, os.path.basename(p)))
1224 elif globals.command == 'manual':
1225 target = SourceTarget()
1226 tree = globals.trees.get(args.project, args.checkout, target)
1228 outs = tree.call('make_manual')
1230 if os.path.isfile(o):
1231 copyfile(o, '%s%s' % (args.output, os.path.basename(o)))
1233 copytree(o, '%s%s' % (args.output, os.path.basename(o)))
1237 elif globals.command == 'doxygen':
1238 target = SourceTarget()
1239 tree = globals.trees.get(args.project, args.checkout, target)
1241 dirs = tree.call('make_doxygen')
1242 if hasattr(dirs, 'strip') or (not hasattr(dirs, '__getitem__') and not hasattr(dirs, '__iter__')):
1246 copytree(d, args.output)
1250 elif globals.command == 'latest':
1251 target = SourceTarget()
1252 tree = globals.trees.get(args.project, args.checkout, target)
1254 with TreeDirectory(tree):
1255 f = command_and_read('git log --tags --simplify-by-decoration --pretty="%d"')
1258 while latest is None:
1261 m = re.compile(".*\((.*)\).*").match(t)
1263 tags = m.group(1).split(', ')
1268 if len(t) > 0 and t[0] == 'v':
1270 if (args.latest_major is None or v.major == args.latest_major) and (args.latest_minor is None or v.minor == args.latest_minor):
1276 elif globals.command == 'test':
1277 if args.target is None:
1278 raise Error('you must specify -t or --target')
1282 target = target_factory(args)
1283 tree = globals.trees.get(args.project, args.checkout, target)
1284 with TreeDirectory(tree):
1285 target.test(tree, args.test, get_command_line_options(args))
1287 if target is not None and not args.keep:
1291 if target is not None and not args.keep:
1294 elif globals.command == 'shell':
1295 if args.target is None:
1296 raise Error('you must specify -t or --target')
1298 target = target_factory(args)
1299 target.command('bash')
1301 elif globals.command == 'revision':
1303 target = SourceTarget()
1304 tree = globals.trees.get(args.project, args.checkout, target)
1305 with TreeDirectory(tree):
1306 print(command_and_read('git rev-parse HEAD')[0].strip()[:7])
1309 elif globals.command == 'checkout':
1311 if args.output is None:
1312 raise Error('you must specify -o or --output')
1314 target = SourceTarget()
1315 tree = globals.trees.get(args.project, args.checkout, target)
1316 with TreeDirectory(tree):
1317 shutil.copytree('.', args.output)
1320 elif globals.command == 'dependencies':
1321 if args.target is None:
1322 raise Error('you must specify -t or --target')
1323 if args.checkout is None:
1324 raise Error('you must specify -c or --checkout')
1326 target = target_factory(args)
1327 tree = globals.trees.get(args.project, args.checkout, target)
1328 print("strict digraph {")
1329 for d in list(tree.dependencies({})):
1330 print("%s -> %s;" % (d[2].name.replace("-", "-"), d[0].name.replace("-", "_")))
1334 raise Error('invalid command %s' % globals.command)
1339 print('cdist: %s' % str(e), file=sys.stderr)