#!/usr/bin/python
-# Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
+# Copyright (C) 2012-2020 Carl Hetherington <cth@carlh.net>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# along with this program; if not, write to the Free Software
# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+from __future__ import print_function
import os
import sys
import shutil
import re
import copy
import inspect
+import getpass
+import shlex
+import multiprocessing
-TEMPORARY_DIRECTORY = '/tmp'
-
-class Globals:
- quiet = False
- command = None
-
-globals = Globals()
+TEMPORARY_DIRECTORY = '/var/tmp'
class Error(Exception):
def __init__(self, value):
def __repr__(self):
return str(self)
+class Trees:
+ """
+ Store for Tree objects which re-uses already-created objects
+ and checks for requests for different versions of the same thing.
+ """
+
+ def __init__(self):
+ self.trees = []
+
+ def get(self, name, specifier, target, required_by=None):
+ for t in self.trees:
+ if t.name == name and t.specifier == specifier and t.target == target:
+ return t
+ elif t.name == name and t.specifier != specifier:
+ a = specifier if specifier is not None else "[Any]"
+ if required_by is not None:
+ a += ' by %s' % required_by
+ b = t.specifier if t.specifier is not None else "[Any]"
+ if t.required_by is not None:
+ b += ' by %s' % t.required_by
+ raise Error('conflicting versions of %s required (%s versus %s)' % (name, a, b))
+
+ nt = Tree(name, specifier, target, required_by)
+ self.trees.append(nt)
+ return nt
+
+class Globals:
+ quiet = False
+ command = None
+ dry_run = False
+ trees = Trees()
+
+globals = Globals()
+
+
#
# Configuration
#
class Config:
def __init__(self):
- self.options = [ Option('linux_chroot_prefix'),
- Option('windows_environment_prefix'),
- Option('mingw_prefix'),
+ self.options = [ Option('mxe_prefix'),
Option('git_prefix'),
- Option('osx_build_host'),
Option('osx_environment_prefix'),
Option('osx_sdk_prefix'),
Option('osx_sdk'),
- Option('parallel', 4) ]
+ Option('apple_id'),
+ Option('apple_password'),
+ BoolOption('docker_sudo'),
+ BoolOption('docker_no_user'),
+ Option('docker_hub_repository'),
+ Option('flatpak_state_dir'),
+ Option('parallel', multiprocessing.cpu_count()) ]
+
+ config_dir = '%s/.config' % os.path.expanduser('~')
+ if not os.path.exists(config_dir):
+ os.mkdir(config_dir)
+ config_file = '%s/cdist' % config_dir
+ if not os.path.exists(config_file):
+ f = open(config_file, 'w')
+ for o in self.options:
+ print('# %s ' % o.key, file=f)
+ f.close()
+ print('Template config file written to %s; please edit and try again.' % config_file, file=sys.stderr)
+ sys.exit(1)
try:
f = open('%s/.config/cdist' % os.path.expanduser('~'), 'r')
except:
raise
+ def has(self, k):
+ for o in self.options:
+ if o.key == k and o.value is not None:
+ return True
+ return False
+
def get(self, k):
for o in self.options:
if o.key == k:
+ if o.value is None:
+ raise Error('Required setting %s not found' % k)
return o.value
- raise Error('Required setting %s not found' % k)
+ def set(self, k, v):
+ for o in self.options:
+ o.offer(k, v)
+
+ def docker(self):
+ if self.get('docker_sudo'):
+ return 'sudo docker'
+ else:
+ return 'docker'
config = Config()
#
# Utility bits
-#
+#
def log(m):
if not globals.quiet:
- print '\x1b[33m* %s\x1b[0m' % m
+ print('\x1b[33m* %s\x1b[0m' % m)
+
+def escape_spaces(s):
+ return s.replace(' ', '\\ ')
def scp_escape(n):
+ """Escape a host:filename string for use with an scp command"""
s = n.split(':')
assert(len(s) == 1 or len(s) == 2)
if len(s) == 2:
else:
return '\"%s\"' % s[0]
-def command(c):
- if os.system(c) != 0:
- raise Error('%s failed' % c)
+def mv_escape(n):
+ return '\"%s\"' % n.substr(' ', '\\ ')
def copytree(a, b):
- log('copy %s -> %s' % (scp_escape(b), scp_escape(b)))
- command('scp -r %s %s' % (scp_escape(a), scp_escape(b)))
+ log('copy %s -> %s' % (scp_escape(a), scp_escape(b)))
+ if b.startswith('s3://'):
+ command('s3cmd -P -r put "%s" "%s"' % (a, b))
+ else:
+ command('scp -r %s %s' % (scp_escape(a), scp_escape(b)))
def copyfile(a, b):
log('copy %s -> %s' % (scp_escape(a), scp_escape(b)))
- command('scp %s %s' % (scp_escape(a), scp_escape(b)))
+ if b.startswith('s3://'):
+ command('s3cmd -P put "%s" "%s"' % (a, b))
+ else:
+ bc = b.find(":")
+ if bc != -1:
+ host = b[:bc]
+ path = b[bc+1:]
+ temp_path = os.path.join(os.path.dirname(path), ".tmp." + os.path.basename(path))
+ command('scp %s %s' % (scp_escape(a), scp_escape(host + ":" + temp_path)))
+ command('ssh %s -- mv "%s" "%s"' % (host, escape_spaces(temp_path), escape_spaces(path)))
+ else:
+ command('scp %s %s' % (scp_escape(a), scp_escape(b)))
def makedirs(d):
+ """
+ Make directories either locally or on a remote host; remotely if
+ d includes a colon, otherwise locally.
+ """
+ if d.startswith('s3://'):
+ # No need to create folders on S3
+ return
+
if d.find(':') == -1:
- os.makedirs(d)
+ try:
+ os.makedirs(d)
+ except OSError as e:
+ if e.errno != 17:
+ raise e
else:
s = d.split(':')
command('ssh %s -- mkdir -p %s' % (s[0], s[1]))
log('remove %s' % a)
shutil.rmtree(a, ignore_errors=True)
-def command(c, can_fail=False):
+def command(c):
log(c)
r = os.system(c)
- if (r >> 8) and not can_fail:
+ if (r >> 8):
raise Error('command %s failed' % c)
def command_and_read(c):
log(c)
- p = subprocess.Popen(c.split(), stdout=subprocess.PIPE)
- f = os.fdopen(os.dup(p.stdout.fileno()))
- return f
+ p = subprocess.Popen(c.split(), stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+ (out, err) = p.communicate()
+ if p.returncode != 0:
+ raise Error('command %s failed (%s)' % (c, err))
+ return out.splitlines()
def read_wscript_variable(directory, variable):
f = open('%s/wscript' % directory, 'r')
l = f.readline()
if l == '':
break
-
+
s = l.split()
if len(s) == 3 and s[0] == variable:
f.close()
f.close()
return None
+def set_version_in_wscript(version):
+ f = open('wscript', 'rw')
+ o = open('wscript.tmp', 'w')
+ while True:
+ l = f.readline()
+ if l == '':
+ break
+
+ s = l.split()
+ if len(s) == 3 and s[0] == "VERSION":
+ print("VERSION = '%s'" % version, file=o)
+ else:
+ print(l, file=o, end="")
+ f.close()
+ o.close()
+
+ os.rename('wscript.tmp', 'wscript')
+
+def append_version_to_changelog(version):
+ try:
+ f = open('ChangeLog', 'r')
+ except:
+ log('Could not open ChangeLog')
+ return
+
+ c = f.read()
+ f.close()
+
+ f = open('ChangeLog', 'w')
+ now = datetime.datetime.now()
+ 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))
+ f.write(c)
+
+def append_version_to_debian_changelog(version):
+ if not os.path.exists('debian'):
+ log('Could not find debian directory')
+ return
+
+ command('dch -b -v %s-1 "New upstream release."' % version)
+
+def devel_to_git(git_commit, filename):
+ if git_commit is not None:
+ filename = filename.replace('devel', '-%s' % git_commit)
+ return filename
+
+def argument_options(args):
+ opts = dict()
+ if args.option is not None:
+ for o in args.option:
+ b = o.split(':')
+ if len(b) != 2:
+ raise Error("Bad option `%s'" % o)
+ if b[1] == 'False':
+ opts[b[0]] = False
+ elif b[1] == 'True':
+ opts[b[0]] = True
+ else:
+ opts[b[0]] = b[1]
+ return opts
+
+
+class TreeDirectory:
+ def __init__(self, tree):
+ self.tree = tree
+ def __enter__(self):
+ self.cwd = os.getcwd()
+ os.chdir('%s/src/%s' % (self.tree.target.directory, self.tree.name))
+ def __exit__(self, type, value, traceback):
+ os.chdir(self.cwd)
+
#
# Version
#
s = s[1:]
if s.endswith("'"):
s = s[0:-1]
-
+
if s.endswith('devel'):
s = s[0:-5]
self.devel = True
else:
self.micro = 0
+ @classmethod
+ def from_git_tag(cls, tag):
+ bits = tag.split('-')
+ c = cls(bits[0])
+ if len(bits) > 1 and int(bits[1]) > 0:
+ c.devel = True
+ return c
+
def bump_minor(self):
self.minor += 1
self.micro = 0
#
class Target(object):
- # @param directory directory to work in; if None we will use a temporary directory
- # Temporary directories will be removed after use; specified directories will not
+ """
+ Class representing the target that we are building for. This is exposed to cscripts,
+ though not all of it is guaranteed 'API'. cscripts may expect:
+
+ platform: platform string (e.g. 'windows', 'linux', 'osx')
+ parallel: number of parallel jobs to run
+ directory: directory to work in
+ variables: dict of environment variables
+ debug: True to build a debug version, otherwise False
+ ccache: True to use ccache, False to not
+ set(a, b): set the value of variable 'a' to 'b'
+ unset(a): unset the value of variable 'a'
+ command(c): run the command 'c' in the build environment
+
+ """
+
def __init__(self, platform, directory=None):
+ """
+ platform -- platform string (e.g. 'windows', 'linux', 'osx')
+ directory -- directory to work in; if None we will use a temporary directory
+ Temporary directories will be removed after use; specified directories will not.
+ """
self.platform = platform
self.parallel = int(config.get('parallel'))
+ # Environment variables that we will use when we call cscripts
+ self.variables = {}
+ self.debug = False
+ self._ccache = False
+ # True to build our dependencies ourselves; False if this is taken care
+ # of in some other way
+ self.build_dependencies = True
+
if directory is None:
self.directory = tempfile.mkdtemp('', 'tmp', TEMPORARY_DIRECTORY)
self.rmdir = True
+ self.set('CCACHE_BASEDIR', os.path.realpath(self.directory))
+ self.set('CCACHE_NOHASHDIR', '')
else:
self.directory = directory
self.rmdir = False
- # Environment variables that we will use when we call cscripts
- self.variables = {}
- self.debug = False
- def build_dependencies(self, project):
- cwd = os.getcwd()
- if 'dependencies' in project.cscript:
- for d in project.cscript['dependencies'](self):
- log('Building dependency %s %s of %s' % (d[0], d[1], project.name))
- dep = Project(d[0], '.', d[1])
- dep.checkout(self)
- self.build_dependencies(dep)
-
- # Make the options to pass in from the option_defaults of the thing
- # we are building and any options specified by the parent.
- options = {}
- if 'option_defaults' in dep.cscript:
- options = dep.cscript['option_defaults']()
- if len(d) > 2:
- for k, v in d[2].iteritems():
- options[k] = v
-
- self.build(dep, options)
+ def setup(self):
+ pass
- os.chdir(cwd)
+ def package(self, project, checkout, output_dir, options):
+ tree = globals.trees.get(project, checkout, self)
+ if self.build_dependencies:
+ tree.build_dependencies(options)
+ tree.build(options)
+ if len(inspect.getargspec(tree.cscript['package']).args) == 3:
+ packages = tree.call('package', tree.version, options)
+ else:
+ log("Deprecated cscript package() method with no options parameter")
+ packages = tree.call('package', tree.version)
- def build(self, project, options=None):
- variables = copy.copy(self.variables)
- if len(inspect.getargspec(project.cscript['build']).args) == 2:
- project.cscript['build'](self, options)
+ if isinstance(packages, (str, unicode)):
+ copyfile(packages, os.path.join(output_dir, os.path.basename(devel_to_git(tree.git_commit, packages))))
else:
- project.cscript['build'](self)
- self.variables = variables
+ for p in packages:
+ copyfile(p, os.path.join(output_dir, os.path.basename(devel_to_git(tree.git_commit, p))))
- def package(self, project):
- project.checkout(self)
- self.build_dependencies(project)
- self.build(project)
- return project.cscript['package'](self, project.version)
+ def build(self, project, checkout, options):
+ tree = globals.trees.get(project, checkout, self)
+ if self.build_dependencies:
+ tree.build_dependencies(options)
+ tree.build(options)
- def test(self, project):
- project.checkout(self)
- self.build_dependencies(project)
- self.build(project)
- return project.cscript['test'](self)
+ def test(self, tree, test, options):
+ """test is the test case to run, or None"""
+ if self.build_dependencies:
+ tree.build_dependencies(options)
+ tree.build(options)
+ return tree.call('test', test)
def set(self, a, b):
self.variables[a] = b
def get(self, a):
return self.variables[a]
- def append_with_space(self, k, v):
- if not k in self.variables:
- self.variables[k] = v
+ def append(self, k, v, s):
+ if (not k in self.variables) or len(self.variables[k]) == 0:
+ self.variables[k] = '"%s"' % v
else:
- self.variables[k] = '%s %s' % (self.variables[k], v)
+ e = self.variables[k]
+ if e[0] == '"' and e[-1] == '"':
+ self.variables[k] = '"%s%s%s"' % (e[1:-1], s, v)
+ else:
+ self.variables[k] = '"%s%s%s"' % (e, s, v)
+
+ def append_with_space(self, k, v):
+ return self.append(k, v, ' ')
+
+ def append_with_colon(self, k, v):
+ return self.append(k, v, ':')
def variables_string(self, escaped_quotes=False):
e = ''
- for k, v in self.variables.iteritems():
+ for k, v in self.variables.items():
if escaped_quotes:
v = v.replace('"', '\\"')
e += '%s=%s ' % (k, v)
if self.rmdir:
rmtree(self.directory)
-#
-# Windows
-#
+ def mount(self, m):
+ pass
-class WindowsTarget(Target):
- def __init__(self, bits, directory=None):
+ @property
+ def ccache(self):
+ return self._ccache
+
+ @ccache.setter
+ def ccache(self, v):
+ self._ccache = v
+
+
+class DockerTarget(Target):
+ def __init__(self, platform, directory):
+ super(DockerTarget, self).__init__(platform, directory)
+ self.mounts = []
+ self.privileged = False
+
+ def _user_tag(self):
+ if config.get('docker_no_user'):
+ return ''
+ return '-u %s' % getpass.getuser()
+
+ def setup(self):
+ opts = '-v %s:%s ' % (self.directory, self.directory)
+ for m in self.mounts:
+ opts += '-v %s:%s ' % (m, m)
+ if self.privileged:
+ opts += '--privileged=true '
+ if self.ccache:
+ opts += "-e CCACHE_DIR=/ccache --volumes-from ccache-%s" % self.image
+
+ tag = self.image
+ if config.has('docker_hub_repository'):
+ tag = '%s:%s' % (config.get('docker_hub_repository'), tag)
+
+ self.container = command_and_read('%s run %s %s -itd %s /bin/bash' % (config.docker(), self._user_tag(), opts, tag))[0].strip()
+
+ def command(self, cmd):
+ dir = os.path.join(self.directory, os.path.relpath(os.getcwd(), self.directory))
+ interactive_flag = '-i ' if sys.stdin.isatty() else ''
+ 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))
+
+ def cleanup(self):
+ super(DockerTarget, self).cleanup()
+ command('%s kill %s' % (config.docker(), self.container))
+
+ def mount(self, m):
+ self.mounts.append(m)
+
+
+class FlatpakTarget(Target):
+ def __init__(self, project, checkout):
+ super(FlatpakTarget, self).__init__('flatpak')
+ self.build_dependencies = False
+ self.project = project
+ self.checkout = checkout
+
+ def setup(self):
+ pass
+
+ def command(self, cmd):
+ command(cmd)
+
+ def checkout_dependencies(self):
+ tree = globals.trees.get(self.project, self.checkout, self)
+ return tree.checkout_dependencies()
+
+ def flatpak(self):
+ return 'flatpak'
+
+ def flatpak_builder(self):
+ b = 'flatpak-builder'
+ if config.has('flatpak_state_dir'):
+ b += ' --state-dir=%s' % config.get('flatpak_state_dir')
+ return b
+
+
+class WindowsTarget(DockerTarget):
+ """
+ This target exposes the following additional API:
+
+ version: Windows version ('xp' or None)
+ bits: bitness of Windows (32 or 64)
+ name: name of our target e.g. x86_64-w64-mingw32.shared
+ environment_prefix: path to Windows environment for the appropriate target (libraries and some tools)
+ tool_path: path to 32- and 64-bit tools
+ """
+ def __init__(self, windows_version, bits, directory, environment_version):
super(WindowsTarget, self).__init__('windows', directory)
+ self.version = windows_version
self.bits = bits
- self.windows_prefix = '%s/%d' % (config.get('windows_environment_prefix'), self.bits)
- if not os.path.exists(self.windows_prefix):
- raise Error('windows prefix %s does not exist' % self.windows_prefix)
-
+ self.tool_path = '%s/usr/bin' % config.get('mxe_prefix')
if self.bits == 32:
- self.mingw_name = 'i686'
+ self.name = 'i686-w64-mingw32.shared'
else:
- self.mingw_name = 'x86_64'
+ self.name = 'x86_64-w64-mingw32.shared'
+ self.environment_prefix = '%s/usr/%s' % (config.get('mxe_prefix'), self.name)
- mingw_path = '%s/%d/bin' % (config.get('mingw_prefix'), self.bits)
- self.mingw_prefixes = ['/%s/%d' % (config.get('mingw_prefix'), self.bits), '%s/%d/%s-w64-mingw32' % (config.get('mingw_prefix'), bits, self.mingw_name)]
-
- self.set('PKG_CONFIG_LIBDIR', '%s/lib/pkgconfig' % self.windows_prefix)
+ self.set('PKG_CONFIG_LIBDIR', '%s/lib/pkgconfig' % self.environment_prefix)
self.set('PKG_CONFIG_PATH', '%s/lib/pkgconfig:%s/bin/pkgconfig' % (self.directory, self.directory))
- self.set('PATH', '%s/bin:%s:%s' % (self.windows_prefix, mingw_path, os.environ['PATH']))
- self.set('CC', '%s-w64-mingw32-gcc' % self.mingw_name)
- self.set('CXX', '%s-w64-mingw32-g++' % self.mingw_name)
- self.set('LD', '%s-w64-mingw32-ld' % self.mingw_name)
- self.set('RANLIB', '%s-w64-mingw32-ranlib' % self.mingw_name)
- self.set('WINRC', '%s-w64-mingw32-windres' % self.mingw_name)
- cxx = '-I%s/include -I%s/include' % (self.windows_prefix, self.directory)
- link = '-L%s/lib -L%s/lib' % (self.windows_prefix, self.directory)
- for p in self.mingw_prefixes:
- cxx += ' -I%s/include' % p
- link += ' -L%s/lib' % p
+ self.set('PATH', '%s/bin:%s:%s' % (self.environment_prefix, self.tool_path, os.environ['PATH']))
+ self.set('CC', '%s-gcc' % self.name)
+ self.set('CXX', '%s-g++' % self.name)
+ self.set('LD', '%s-ld' % self.name)
+ self.set('RANLIB', '%s-ranlib' % self.name)
+ self.set('WINRC', '%s-windres' % self.name)
+ cxx = '-I%s/include -I%s/include' % (self.environment_prefix, self.directory)
+ link = '-L%s/lib -L%s/lib' % (self.environment_prefix, self.directory)
self.set('CXXFLAGS', '"%s"' % cxx)
self.set('CPPFLAGS', '')
self.set('LINKFLAGS', '"%s"' % link)
+ self.set('LDFLAGS', '"%s"' % link)
- def command(self, c):
- log('host -> %s' % c)
- command('%s %s' % (self.variables_string(), c))
+ self.image = 'windows'
+ if environment_version is not None:
+ self.image += '_%s' % environment_version
-#
-# Linux
-#
+ @property
+ def library_prefix(self):
+ log('Deprecated property library_prefix: use environment_prefix')
+ return self.environment_prefix
+
+ @property
+ def windows_prefix(self):
+ log('Deprecated property windows_prefix: use environment_prefix')
+ return self.environment_prefix
+
+ @property
+ def mingw_prefixes(self):
+ log('Deprecated property mingw_prefixes: use environment_prefix')
+ return [self.environment_prefix]
+
+ @property
+ def mingw_path(self):
+ log('Deprecated property mingw_path: use tool_path')
+ return self.tool_path
+
+ @property
+ def mingw_name(self):
+ log('Deprecated property mingw_name: use name')
+ return self.name
+
+
+class LinuxTarget(DockerTarget):
+ """
+ Build for Linux in a docker container.
+ This target exposes the following additional API:
+
+ distro: distribution ('debian', 'ubuntu', 'centos' or 'fedora')
+ version: distribution version (e.g. '12.04', '8', '6.5')
+ bits: bitness of the distribution (32 or 64)
+ detail: None or 'appimage' if we are building for appimage
+ """
-class LinuxTarget(Target):
def __init__(self, distro, version, bits, directory=None):
super(LinuxTarget, self).__init__('linux', directory)
self.distro = distro
self.version = version
self.bits = bits
- # e.g. ubuntu-14.04-64
- self.chroot = '%s-%s-%d' % (self.distro, self.version, self.bits)
- # e.g. /home/carl/Environments/ubuntu-14.04-64
- self.chroot_prefix = '%s/%s' % (config.get('linux_chroot_prefix'), self.chroot)
+ self.detail = None
self.set('CXXFLAGS', '-I%s/include' % self.directory)
self.set('CPPFLAGS', '')
self.set('LINKFLAGS', '-L%s/lib' % self.directory)
- self.set('PKG_CONFIG_PATH', '%s/lib/pkgconfig:/usr/local/lib/pkgconfig' % self.directory)
- self.set('PATH', '%s:/usr/local/bin' % (os.environ['PATH']))
+ self.set('PKG_CONFIG_PATH',
+ '%s/lib/pkgconfig:%s/lib64/pkgconfig:/usr/local/lib64/pkgconfig:/usr/local/lib/pkgconfig' % (self.directory, self.directory))
+ self.set('PATH', '/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin')
- def command(self, c):
- command('%s schroot -c %s -p -- %s' % (self.variables_string(), self.chroot, c))
+ if self.version is None:
+ self.image = '%s-%s' % (self.distro, self.bits)
+ else:
+ self.image = '%s-%s-%s' % (self.distro, self.version, self.bits)
+
+ def setup(self):
+ super(LinuxTarget, self).setup()
+ if self.ccache:
+ self.set('CC', '"ccache gcc"')
+ self.set('CXX', '"ccache g++"')
+
+ def test(self, tree, test, options):
+ self.append_with_colon('PATH', '%s/bin' % self.directory)
+ self.append_with_colon('LD_LIBRARY_PATH', '%s/lib' % self.directory)
+ super(LinuxTarget, self).test(tree, test, options)
+
+
+class AppImageTarget(LinuxTarget):
+ def __init__(self, work):
+ super(AppImageTarget, self).__init__('ubuntu', '16.04', 64, work)
+ self.detail = 'appimage'
+ self.privileged = True
-#
-# OS X
-#
class OSXTarget(Target):
def __init__(self, directory=None):
super(OSXTarget, self).__init__('osx', directory)
+ self.sdk = config.get('osx_sdk')
+ self.sdk_prefix = config.get('osx_sdk_prefix')
+ self.environment_prefix = config.get('osx_environment_prefix')
+ self.apple_id = config.get('apple_id')
+ self.apple_password = config.get('apple_password')
def command(self, c):
command('%s %s' % (self.variables_string(False), c))
else:
arch = 'x86_64'
- flags = '-isysroot %s/MacOSX%s.sdk -arch %s' % (config.get('osx_sdk_prefix'), config.get('osx_sdk'), arch)
+ flags = '-isysroot %s/MacOSX%s.sdk -arch %s' % (self.sdk_prefix, self.sdk, arch)
enviro = '%s/%d' % (config.get('osx_environment_prefix'), bits)
# Environment variables
self.set('PKG_CONFIG_PATH', '%s/lib/pkgconfig:%s/lib/pkgconfig:/usr/lib/pkgconfig' % (self.directory, enviro))
self.set('PATH', '$PATH:/usr/bin:/sbin:/usr/local/bin:%s/bin' % enviro)
self.set('MACOSX_DEPLOYMENT_TARGET', config.get('osx_sdk'))
+ self.set('CCACHE_BASEDIR', self.directory)
- def package(self, project):
- raise Error('cannot package non-universal OS X versions')
+ @Target.ccache.setter
+ def ccache(self, v):
+ Target.ccache.fset(self, v)
+ if v:
+ self.set('CC', '"ccache gcc"')
+ self.set('CXX', '"ccache g++"')
class OSXUniversalTarget(OSXTarget):
def __init__(self, directory=None):
super(OSXUniversalTarget, self).__init__(directory)
- self.parts = []
- self.parts.append(OSXSingleTarget(32, os.path.join(self.directory, '32')))
- self.parts.append(OSXSingleTarget(64, os.path.join(self.directory, '64')))
+ self.bits = None
- def package(self, project):
- for p in self.parts:
- project.checkout(p)
- p.build_dependencies(project)
- p.build(project)
+ def package(self, project, checkout, output_dir, options):
- return project.cscript['package'](self, project.version)
-
+ for b in [32, 64]:
+ target = OSXSingleTarget(b, os.path.join(self.directory, '%d' % b))
+ target.ccache = self.ccache
+ tree = globals.trees.get(project, checkout, target)
+ tree.build_dependencies(options)
+ tree.build(options)
-#
-# Source
-#
+ tree = globals.trees.get(project, checkout, self)
+ with TreeDirectory(tree):
+ if len(inspect.getargspec(tree.cscript['package']).args) == 3:
+ packages = tree.call('package', tree.version, options)
+ else:
+ log("Deprecated cscript package() method with no options parameter")
+ packages = tree.call('package', tree.version)
+ for p in packages:
+ copyfile(p, os.path.join(output_dir, os.path.basename(devel_to_git(tree.git_commit, p))))
class SourceTarget(Target):
+ """Build a source .tar.bz2"""
def __init__(self):
super(SourceTarget, self).__init__('source')
def cleanup(self):
rmtree(self.directory)
- def package(self, project):
- project.checkout(self)
- name = read_wscript_variable(os.getcwd(), 'APPNAME')
- command('./waf dist')
- return os.path.abspath('%s-%s.tar.bz2' % (name, project.version))
-
+ def package(self, project, checkout, output_dir, options):
+ tree = globals.trees.get(project, checkout, self)
+ with TreeDirectory(tree):
+ name = read_wscript_variable(os.getcwd(), 'APPNAME')
+ command('./waf dist')
+ p = os.path.abspath('%s-%s.tar.bz2' % (name, tree.version))
+ copyfile(p, os.path.join(output_dir, os.path.basename(devel_to_git(tree.git_commit, p))))
# @param s Target string:
# windows-{32,64}
# or ubuntu-version-{32,64}
# or debian-version-{32,64}
# or centos-version-{32,64}
+# or fedora-version-{32,64}
+# or mageia-version-{32,64}
# or osx-{32,64}
-# or source
+# or source
+# or flatpak
+# or appimage
# @param debug True to build with debugging symbols (where possible)
-def target_factory(s, debug, work):
+def target_factory(args):
+ s = args.target
target = None
if s.startswith('windows-'):
- target = WindowsTarget(int(s.split('-')[1]), work)
- elif s.startswith('ubuntu-') or s.startswith('debian-') or s.startswith('centos-'):
+ x = s.split('-')
+ if len(x) == 2:
+ target = WindowsTarget(None, int(x[1]), args.work, args.environment_version)
+ elif len(x) == 3:
+ target = WindowsTarget(x[1], int(x[2]), args.work, args.environment_version)
+ else:
+ raise Error("Bad Windows target name `%s'")
+ elif s.startswith('ubuntu-') or s.startswith('debian-') or s.startswith('centos-') or s.startswith('fedora-') or s.startswith('mageia-'):
p = s.split('-')
if len(p) != 3:
- print >>sys.stderr,"Bad Linux target name `%s'; must be something like ubuntu-12.04-32 (i.e. distro-version-bits)" % s
- sys.exit(1)
- target = LinuxTarget(p[0], p[1], int(p[2]), work)
+ raise Error("Bad Linux target name `%s'; must be something like ubuntu-16.04-32 (i.e. distro-version-bits)" % s)
+ target = LinuxTarget(p[0], p[1], int(p[2]), args.work)
+ elif s.startswith('arch-'):
+ p = s.split('-')
+ if len(p) != 2:
+ raise Error("Bad Arch target name `%s'; must be arch-32 or arch-64")
+ target = LinuxTarget(p[0], None, int(p[1]), args.work)
+ elif s == 'raspbian':
+ target = LinuxTarget(s, None, None, args.work)
elif s.startswith('osx-'):
- target = OSXSingleTarget(int(s.split('-')[1]), work)
+ target = OSXSingleTarget(int(s.split('-')[1]), args.work)
elif s == 'osx':
if globals.command == 'build':
- target = OSXSingleTarget(64, work)
+ target = OSXSingleTarget(64, args.work)
else:
- target = OSXUniversalTarget(work)
+ target = OSXUniversalTarget(args.work)
elif s == 'source':
target = SourceTarget()
+ elif s == 'flatpak':
+ target = FlatpakTarget(args.project, args.checkout)
+ elif s == 'appimage':
+ target = AppImageTarget(args.work)
+
+ if target is None:
+ raise Error("Bad target `%s'" % s)
- if target is not None:
- target.debug = debug
+ target.debug = args.debug
+ target.ccache = args.ccache
+ if args.environment is not None:
+ for e in args.environment:
+ target.set(e, os.environ[e])
+
+ if args.mount is not None:
+ for m in args.mount:
+ target.mount(m)
+
+ target.setup()
return target
#
-# Project
+# Tree
#
-
-class Project(object):
- def __init__(self, name, directory, specifier=None):
+
+class Tree(object):
+ """Description of a tree, which is a checkout of a project,
+ possibly built. This class is never exposed to cscripts.
+ Attributes:
+ name -- name of git repository (without the .git)
+ specifier -- git tag or revision to use
+ target -- target object that we are using
+ version -- version from the wscript (if one is present)
+ git_commit -- git revision that is actually being used
+ built -- true if the tree has been built yet in this run
+ required_by -- name of the tree that requires this one
+ """
+
+ def __init__(self, name, specifier, target, required_by):
self.name = name
- self.directory = directory
- self.version = None
self.specifier = specifier
+ self.target = target
+ self.version = None
self.git_commit = None
- if self.specifier is None:
- self.specifier = 'master'
+ self.built = False
+ self.required_by = required_by
+
+ cwd = os.getcwd()
- def checkout(self, target):
flags = ''
redirect = ''
if globals.quiet:
redirect = '>/dev/null'
command('git clone %s %s/%s.git %s/src/%s' % (flags, config.get('git_prefix'), self.name, target.directory, self.name))
os.chdir('%s/src/%s' % (target.directory, self.name))
- command('git checkout %s %s %s' % (flags, self.specifier, redirect))
- self.git_commit = command_and_read('git rev-parse --short=7 HEAD').readline().strip()
- command('git submodule init --quiet')
- command('git submodule update --quiet')
- os.chdir(self.directory)
- proj = '%s/src/%s/%s' % (target.directory, self.name, self.directory)
-
- self.read_cscript('%s/cscript' % proj)
-
- if os.path.exists('%s/wscript' % proj):
- v = read_wscript_variable(proj, "VERSION");
- if v is not None:
- self.version = Version(v)
-
- def read_cscript(self, s):
- self.cscript = {}
- execfile(s, self.cscript)
-
-def set_version_in_wscript(version):
- f = open('wscript', 'rw')
- o = open('wscript.tmp', 'w')
- while True:
- l = f.readline()
- if l == '':
- break
+ spec = self.specifier
+ if spec is None:
+ spec = 'master'
- s = l.split()
- if len(s) == 3 and s[0] == "VERSION":
- print "Writing %s" % version
- print >>o,"VERSION = '%s'" % version
- else:
- print >>o,l,
- f.close()
- o.close()
+ command('git checkout %s %s %s' % (flags, spec, redirect))
+ self.git_commit = command_and_read('git rev-parse --short=7 HEAD')[0].strip()
- os.rename('wscript.tmp', 'wscript')
+ proj = '%s/src/%s' % (target.directory, self.name)
-def append_version_to_changelog(version):
- try:
- f = open('ChangeLog', 'r')
- except:
- log('Could not open ChangeLog')
- return
+ self.cscript = {}
+ exec(open('%s/cscript' % proj).read(), self.cscript)
- c = f.read()
- f.close()
+ # cscript can include submodules = False to stop submodules being fetched
+ if not 'submodules' in self.cscript or self.cscript['submodules'] == True:
+ command('git submodule init --quiet')
+ command('git submodule update --quiet')
- f = open('ChangeLog', 'w')
- now = datetime.datetime.now()
- 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))
- f.write(c)
+ if os.path.exists('%s/wscript' % proj):
+ v = read_wscript_variable(proj, "VERSION");
+ if v is not None:
+ try:
+ self.version = Version(v)
+ except:
+ tag = subprocess.Popen(shlex.split('git -C %s describe --tags' % proj), stdout=subprocess.PIPE).communicate()[0][1:]
+ self.version = Version.from_git_tag(tag)
-def append_version_to_debian_changelog(version):
- if not os.path.exists('debian'):
- log('Could not find debian directory')
- return
+ os.chdir(cwd)
- command('dch -b -v %s-1 "New upstream release."' % version)
+ def call(self, function, *args):
+ with TreeDirectory(self):
+ return self.cscript[function](self.target, *args)
-def devel_to_git(project, filename):
- if project.git_commit is not None:
- filename = filename.replace('devel', '-%s' % project.git_commit)
- return filename
+ def add_defaults(self, options):
+ """Add the defaults from this into a dict options"""
+ if 'option_defaults' in self.cscript:
+ from_cscript = self.cscript['option_defaults']
+ if isinstance(from_cscript, dict):
+ defaults_dict = from_cscript
+ else:
+ log("Deprecated cscript option_defaults method; replace with a dict")
+ defaults_dict = from_cscript()
+ for k, v in defaults_dict.items():
+ if not k in options:
+ options[k] = v
+
+ def dependencies(self, options):
+ if not 'dependencies' in self.cscript:
+ return
+
+ if len(inspect.getargspec(self.cscript['dependencies']).args) == 2:
+ deps = self.call('dependencies', options)
+ else:
+ log("Deprecated cscript dependencies() method with no options parameter")
+ deps = self.call('dependencies')
+
+ for d in deps:
+ dep = globals.trees.get(d[0], d[1], self.target, self.name)
+
+ # Start with the options passed in
+ dep_options = copy.copy(options)
+ # Add things specified by the parent
+ if len(d) > 2:
+ for k, v in d[2].items():
+ if not k in dep_options:
+ dep_options[k] = v
+ # Then fill in the dependency's defaults
+ dep.add_defaults(dep_options)
+
+ for i in dep.dependencies(dep_options):
+ yield i
+ yield (dep, dep_options)
+
+ def checkout_dependencies(self, options={}):
+ for i in self.dependencies(options):
+ pass
+
+ def build_dependencies(self, options):
+ for i in self.dependencies(options):
+ global args
+ if args.verbose:
+ print('Building a dependency of %s %s %s with %s' % (self.name, self.specifier, self.version, options))
+ i[0].build(i[1])
+
+ def build(self, options):
+ if self.built:
+ return
+
+ global args
+ if args.verbose:
+ print("* Building %s %s %s with %s" % (self.name, self.specifier, self.version, options))
+
+ variables = copy.copy(self.target.variables)
+
+ # Start with the options passed in
+ options = copy.copy(options)
+ # Fill in the defaults
+ self.add_defaults(options)
+
+ if not globals.dry_run:
+ if len(inspect.getargspec(self.cscript['build']).args) == 2:
+ self.call('build', options)
+ else:
+ self.call('build')
+ self.target.variables = variables
+ self.built = True
#
# Command-line parser
"doxygen": "build the project's Doxygen documentation",
"latest": "print out the latest version",
"test": "run the project's unit tests",
- "shell": "build the project then start a shell in its chroot",
+ "shell": "build the project then start a shell",
+ "checkout": "check out the project",
"revision": "print the head git revision number"
}
one_of = "Command is one of:\n"
summary = ""
- for k, v in commands.iteritems():
+ for k, v in commands.items():
one_of += "\t%s\t%s\n" % (k, v)
summary += k + " "
parser = argparse.ArgumentParser()
parser.add_argument('command', help=summary)
parser.add_argument('-p', '--project', help='project name')
- parser.add_argument('-d', '--directory', help='directory within project repo', default='.')
parser.add_argument('--minor', help='minor version number bump', action='store_true')
parser.add_argument('--micro', help='micro version number bump', action='store_true')
- parser.add_argument('--major', help='major version to return with latest', type=int)
+ parser.add_argument('--latest-major', help='major version to return with latest', type=int)
+ parser.add_argument('--latest-minor', help='minor version to return with latest', type=int)
parser.add_argument('-c', '--checkout', help='string to pass to git for checkout')
parser.add_argument('-o', '--output', help='output directory', default='.')
parser.add_argument('-q', '--quiet', help='be quiet', action='store_true')
- parser.add_argument('-t', '--target', help='target')
+ parser.add_argument('-t', '--target', help='target', action='append')
+ parser.add_argument('--environment-version', help='version of environment to use')
parser.add_argument('-k', '--keep', help='keep working tree', action='store_true')
parser.add_argument('--debug', help='build with debugging symbols where possible', action='store_true')
parser.add_argument('-w', '--work', help='override default work directory')
+ parser.add_argument('-g', '--git-prefix', help='override configured git prefix')
+ parser.add_argument('--test', help="name of test to run (with `test'), defaults to all")
+ parser.add_argument('-n', '--dry-run', help='run the process without building anything', action='store_true')
+ parser.add_argument('-e', '--environment', help='pass the value of the named environment variable into the build', action='append')
+ parser.add_argument('-m', '--mount', help='mount a given directory in the build environment', action='append')
+ parser.add_argument('--no-version-commit', help="use just tags for versioning, don't modify wscript, ChangeLog etc.", action='store_true')
+ parser.add_argument('--option', help='set an option for the build (use --option key:value)', action='append')
+ parser.add_argument('--ccache', help='use ccache', action='store_true')
+ parser.add_argument('--verbose', help='be verbose', action='store_true')
+ global args
args = parser.parse_args()
+ # Check for incorrect multiple parameters
+ if args.target is not None:
+ if len(args.target) > 1:
+ parser.error('multiple -t options specified')
+ sys.exit(1)
+ else:
+ args.target = args.target[0]
+
+ # Override configured stuff
+ if args.git_prefix is not None:
+ config.set('git_prefix', args.git_prefix)
+
if args.output.find(':') == -1:
# This isn't of the form host:path so make it absolute
args.output = os.path.abspath(args.output) + '/'
if args.project is None and args.command != 'shell':
raise Error('you must specify -p or --project')
-
+
globals.quiet = args.quiet
globals.command = args.command
-
- project = Project(args.project, args.directory, args.checkout)
+ globals.dry_run = args.dry_run
if not globals.command in commands:
e = 'command must be one of:\n' + one_of
if args.target is None:
raise Error('you must specify -t or --target')
- target = target_factory(args.target, args.debug, args.work)
- project.checkout(target)
- target.build_dependencies(project)
- target.build(project)
+ target = target_factory(args)
+ target.build(args.project, args.checkout, argument_options(args))
if not args.keep:
target.cleanup()
if args.target is None:
raise Error('you must specify -t or --target')
- target = target_factory(args.target, args.debug, args.work)
+ target = None
+ try:
+ target = target_factory(args)
- packages = target.package(project)
- if hasattr(packages, 'strip') or (not hasattr(packages, '__getitem__') and not hasattr(packages, '__iter__')):
- packages = [packages]
+ if target.platform == 'linux' and target.detail != "appimage":
+ if target.distro != 'arch':
+ output_dir = os.path.join(args.output, '%s-%s-%d' % (target.distro, target.version, target.bits))
+ else:
+ output_dir = os.path.join(args.output, '%s-%d' % (target.distro, target.bits))
+ else:
+ output_dir = args.output
- if target.platform == 'linux':
- out = '%s%s-%s-%d' % (args.output, target.distro, target.version, target.bits)
- try:
- makedirs(out)
- except:
- pass
- for p in packages:
- copyfile(p, '%s/%s' % (out, os.path.basename(devel_to_git(project, p))))
- else:
- for p in packages:
- copyfile(p, '%s%s' % (args.output, os.path.basename(devel_to_git(project, p))))
+ makedirs(output_dir)
- if not args.keep:
+ # Start with the options passed on the command line
+ options = copy.copy(argument_options(args))
+ # Fill in the defaults
+ tree = globals.trees.get(args.project, args.checkout, target)
+ tree.add_defaults(options)
+ target.package(args.project, args.checkout, output_dir, options)
+ except Error as e:
+ if target is not None and not args.keep:
+ target.cleanup()
+ raise
+
+ if target is not None and not args.keep:
target.cleanup()
elif globals.command == 'release':
raise Error('you must specify --minor or --micro')
target = SourceTarget()
- project.checkout(target)
+ tree = globals.trees.get(args.project, args.checkout, target)
- version = project.version
+ version = tree.version
version.to_release()
if args.minor:
version.bump_minor()
else:
version.bump_micro()
- set_version_in_wscript(version)
- append_version_to_changelog(version)
- append_version_to_debian_changelog(version)
+ with TreeDirectory(tree):
+ if not args.no_version_commit:
+ set_version_in_wscript(version)
+ append_version_to_changelog(version)
+ append_version_to_debian_changelog(version)
+ command('git commit -a -m "Bump version"')
- command('git commit -a -m "Bump version"')
- command('git tag -m "v%s" v%s' % (version, version))
+ command('git tag -m "v%s" v%s' % (version, version))
- version.to_devel()
- set_version_in_wscript(version)
- command('git commit -a -m "Bump version"')
- command('git push')
- command('git push --tags')
+ if not args.no_version_commit:
+ version.to_devel()
+ set_version_in_wscript(version)
+ command('git commit -a -m "Bump version"')
+ command('git push')
+
+ command('git push --tags')
target.cleanup()
elif globals.command == 'pot':
target = SourceTarget()
- project.checkout(target)
+ tree = globals.trees.get(args.project, args.checkout, target)
- pots = project.cscript['make_pot'](target)
+ pots = tree.call('make_pot')
for p in pots:
copyfile(p, '%s%s' % (args.output, os.path.basename(p)))
elif globals.command == 'changelog':
target = SourceTarget()
- project.checkout(target)
+ tree = globals.trees.get(args.project, args.checkout, target)
+
+ with TreeDirectory(tree):
+ text = open('ChangeLog', 'r')
- text = open('ChangeLog', 'r')
html = tempfile.NamedTemporaryFile()
versions = 8
v = Version(s[2])
if v.micro == 0:
if last is not None and len(changes) > 0:
- print >>html,"<h2>Changes between version %s and %s</h2>" % (s[2], last)
- print >>html,"<ul>"
+ print("<h2>Changes between version %s and %s</h2>" % (s[2], last), file=html)
+ print("<ul>", file=html)
for c in changes:
- print >>html,"<li>%s" % c
- print >>html,"</ul>"
+ print("<li>%s" % c, file=html)
+ print("</ul>", file=html)
last = s[2]
changes = []
versions -= 1
elif globals.command == 'manual':
target = SourceTarget()
- project.checkout(target)
+ tree = globals.trees.get(args.project, args.checkout, target)
- outs = project.cscript['make_manual'](target)
+ outs = tree.call('make_manual')
for o in outs:
if os.path.isfile(o):
copyfile(o, '%s%s' % (args.output, os.path.basename(o)))
elif globals.command == 'doxygen':
target = SourceTarget()
- project.checkout(target)
+ tree = globals.trees.get(args.project, args.checkout, target)
- dirs = project.cscript['make_doxygen'](target)
+ dirs = tree.call('make_doxygen')
if hasattr(dirs, 'strip') or (not hasattr(dirs, '__getitem__') and not hasattr(dirs, '__iter__')):
dirs = [dirs]
for d in dirs:
- copytree(d, '%s%s' % (args.output, 'doc'))
+ copytree(d, args.output)
target.cleanup()
elif globals.command == 'latest':
target = SourceTarget()
- project.checkout(target)
-
- f = command_and_read('git log --tags --simplify-by-decoration --pretty="%d"')
- latest = None
- while latest is None:
- t = f.readline()
- m = re.compile(".*\((.*)\).*").match(t)
- if m:
- tags = m.group(1).split(', ')
- for t in tags:
- s = t.split()
- if len(s) > 1:
- t = s[1]
- if len(t) > 0 and t[0] == 'v':
- v = Version(t[1:])
- if args.major is None or v.major == args.major:
- latest = v
-
- print latest
+ tree = globals.trees.get(args.project, args.checkout, target)
+
+ with TreeDirectory(tree):
+ f = command_and_read('git log --tags --simplify-by-decoration --pretty="%d"')
+ latest = None
+ line = 0
+ while latest is None:
+ t = f[line]
+ line += 1
+ m = re.compile(".*\((.*)\).*").match(t)
+ if m:
+ tags = m.group(1).split(', ')
+ for t in tags:
+ s = t.split()
+ if len(s) > 1:
+ t = s[1]
+ if len(t) > 0 and t[0] == 'v':
+ v = Version(t[1:])
+ if (args.latest_major is None or v.major == args.latest_major) and (args.latest_minor is None or v.minor == args.latest_minor):
+ latest = v
+
+ print(latest)
target.cleanup()
elif globals.command == 'test':
target = None
try:
- target = target_factory(args.target, args.debug, args.work)
- target.test(project)
+ target = target_factory(args)
+ tree = globals.trees.get(args.project, args.checkout, target)
+ with TreeDirectory(tree):
+ target.test(tree, args.test, argument_options(args))
except Error as e:
- if target is not None:
+ if target is not None and not args.keep:
target.cleanup()
raise
- if target is not None:
+ if target is not None and not args.keep:
target.cleanup()
elif globals.command == 'shell':
if args.target is None:
raise Error('you must specify -t or --target')
- target = target_factory(args.target, args.debug, args.work)
+ target = target_factory(args)
target.command('bash')
elif globals.command == 'revision':
target = SourceTarget()
- project.checkout(target)
- print command_and_read('git rev-parse HEAD').readline().strip()[:7]
+ tree = globals.trees.get(args.project, args.checkout, target)
+ with TreeDirectory(tree):
+ print(command_and_read('git rev-parse HEAD')[0].strip()[:7])
+ target.cleanup()
+
+ elif globals.command == 'checkout':
+
+ if args.output is None:
+ raise Error('you must specify -o or --output')
+
+ target = SourceTarget()
+ tree = globals.trees.get(args.project, args.checkout, target)
+ with TreeDirectory(tree):
+ shutil.copytree('.', args.output)
target.cleanup()
else:
try:
main()
except Error as e:
- print >>sys.stderr,'cdist: %s' % str(e)
+ print('cdist: %s' % str(e), file=sys.stderr)
sys.exit(1)