#!/usr/bin/python3
-# Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
+# Copyright (C) 2012-2022 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
from pathlib import Path
import platform
import re
+import signal
import shlex
import shutil
import subprocess
def __init__(self):
self.trees = []
- def get(self, name, specifier, target, required_by=None):
+ def get(self, name, commit_ish, target, required_by=None):
for t in self.trees:
- if t.name == name and t.specifier == specifier and t.target == target:
+ if t.name == name and t.commit_ish == commit_ish and t.target == target:
return t
- elif t.name == name and t.specifier != specifier:
- a = specifier if specifier is not None else "[Any]"
+ elif t.name == name and t.commit_ish != commit_ish:
+ a = commit_ish if commit_ish 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]"
+ b = t.commit_ish if t.commit_ish 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)
+ nt = Tree(name, commit_ish, target, required_by)
self.trees.append(nt)
return nt
- def add_built(self, name, specifier, target):
- self.trees.append(Tree(name, specifier, target, None, built=True))
+ def add_built(self, name, commit_ish, target):
+ self.trees.append(Tree(name, commit_ish, target, None, built=True))
class Globals:
# Configuration
#
-class Option(object):
+class Option:
def __init__(self, key, default=None):
self.key = key
self.value = default
if key == self.key:
self.value = value
-class BoolOption(object):
+class BoolOption:
def __init__(self, key):
self.key = key
self.value = False
def offer(self, key, value):
if key == self.key:
- self.value = (value == 'yes' or value == '1' or value == 'true')
+ self.value = value in ['yes', '1', 'true']
class Config:
def __init__(self):
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')
- while True:
- l = f.readline()
- if l == '':
- break
-
- if len(l) > 0 and l[0] == '#':
- continue
-
- s = l.strip().split()
- if len(s) == 2:
- for k in self.options:
- k.offer(s[0], s[1])
- except:
- raise
+ f = open('%s/.config/cdist' % os.path.expanduser('~'), 'r')
+ while True:
+ l = f.readline()
+ if l == '':
+ break
+
+ if len(l) > 0 and l[0] == '#':
+ continue
+
+ s = l.strip().split()
+ if len(s) == 2:
+ for k in self.options:
+ k.offer(s[0], s[1])
def has(self, k):
for o in self.options:
# Targets
#
-class Target(object):
+class Target:
"""
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:
def _copy_packages(self, tree, packages, output_dir):
for p in packages:
- copyfile(p, os.path.join(output_dir, os.path.basename(devel_to_git(tree.git_commit, p))))
+ copyfile(p, os.path.join(output_dir, os.path.basename(devel_to_git(tree.commit, p))))
def package(self, project, checkout, output_dir, options, notarize):
- tree = self.build(project, checkout, options)
+ tree = self.build(project, checkout, options, for_package=True)
tree.add_defaults(options)
p = self._cscript_package(tree, options)
self._copy_packages(tree, p, output_dir)
- def build(self, project, checkout, options):
+ def build(self, project, checkout, options, for_package=False):
tree = globals.trees.get(project, checkout, self)
if self.build_dependencies:
tree.build_dependencies(options)
- tree.build(options)
+ tree.build(options, for_package=for_package)
return tree
def test(self, project, checkout, target, test, options):
if self.privileged:
opts += '--privileged=true '
if self.ccache:
- opts += "-e CCACHE_DIR=/ccache/%s-%d --mount source=ccache,target=/ccache" % (self.image, os.getuid())
+ opts += "-e CCACHE_DIR=/ccache/%s-%d --mount source=ccache,target=/ccache " % (self.image, os.getuid())
+ opts += "--rm "
tag = self.image
if config.has('docker_hub_repository'):
tag = '%s:%s' % (config.get('docker_hub_repository'), tag)
+ def signal_handler(signum, frame):
+ raise Error('Killed')
+ signal.signal(signal.SIGTERM, signal_handler)
+
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):
def _copy_packages(self, tree, packages, output_dir):
for p in packages:
- dest = os.path.join(output_dir, os.path.basename(devel_to_git(tree.git_commit, p)))
+ dest = os.path.join(output_dir, os.path.basename(devel_to_git(tree.commit, p)))
copyfile(p, dest)
if os.path.exists(p + ".id"):
copyfile(p + ".id", dest + ".id")
self.set('CXX', '"ccache g++"')
def package(self, project, checkout, output_dir, options, notarize):
- tree = self.build(project, checkout, options)
+ tree = self.build(project, checkout, options, for_package=True)
tree.add_defaults(options)
self.unlock_keychain()
p = self._cscript_package_and_notarize(tree, options, self.can_notarize and notarize)
for target in self.sub_targets:
tree = globals.trees.get(project, checkout, target)
tree.build_dependencies(options)
- tree.build(options)
+ tree.build(options, for_package=True)
self.unlock_keychain()
tree = globals.trees.get(project, checkout, self)
self._copy_packages(tree, p, output_dir)
class SourceTarget(Target):
- """Build a source .tar.bz2"""
+ """Build a source .tar.bz2 and .zst"""
def __init__(self):
super(SourceTarget, self).__init__('source')
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))))
+ bz2 = os.path.abspath('%s-%s.tar.bz2' % (name, tree.version))
+ copyfile(bz2, os.path.join(output_dir, os.path.basename(devel_to_git(tree.commit, bz2))))
+ command('tar xjf %s' % bz2)
+ command('tar --zstd -cf %s-%s.tar.zst %s-%s' % (name, tree.version, name, tree.version))
+ zstd = os.path.abspath('%s-%s.tar.zst' % (name, tree.version))
+ copyfile(zstd, os.path.join(output_dir, os.path.basename(devel_to_git(tree.commit, zstd))))
# @param s Target string:
# windows-{32,64}
# or source
# or flatpak
# or appimage
-# @param debug True to build with debugging symbols (where possible)
def target_factory(args):
s = args.target
target = None
# Tree
#
-class Tree(object):
+class Tree:
"""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
+ commit_ish -- 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
+ 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, built=False):
+ def __init__(self, name, commit_ish, target, required_by, built=False):
self.name = name
- self.specifier = specifier
+ self.commit_ish = commit_ish
self.target = target
self.version = None
- self.git_commit = None
+ self.commit = None
self.built = built
self.required_by = required_by
ref = '--reference-if-able %s/%s.git' % (config.get('git_reference'), self.name)
else:
ref = ''
- command('git clone %s %s %s/%s.git %s/src/%s' % (flags, ref, config.get('git_prefix'), self.name, target.directory, self.name))
+ 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))
os.chdir('%s/src/%s' % (target.directory, self.name))
- spec = self.specifier
- if spec is None:
- spec = 'master'
-
- command('git checkout %s %s %s' % (flags, spec, redirect))
- self.git_commit = command_and_read('git rev-parse --short=7 HEAD')[0].strip()
+ if self.commit_ish is not None:
+ command('git checkout %s %s %s' % (flags, self.commit_ish, redirect))
+ self.commit = command_and_read('git rev-parse --short=7 HEAD')[0].strip()
self.cscript = {}
exec(open('%s/cscript' % proj).read(), self.cscript)
if os.path.exists(ref_path):
ref = '--reference %s' % ref_path
path = path.split(' ')[1]
- command('git submodule --quiet update %s %s' % (ref, path))
+ command('git -c protocol.file.allow=always submodule --quiet update %s %s' % (ref, path))
if os.path.exists('%s/wscript' % proj):
v = read_wscript_variable(proj, "VERSION");
self.version = Version(v)
except:
try:
- tag = command_and_read('git -C %s describe --tags' % proj)[0][1:]
+ tag = command_and_read('git -C %s describe --match v* --tags' % proj)[0][1:]
self.version = Version.from_git_tag(tag)
except:
# We'll leave version as None if we can't read it; maybe this is a bad idea
for i in self.dependencies(options):
i[0].build(i[1])
- def build(self, options):
+ def build(self, options, for_package=False):
if self.built:
return
- log_verbose("Building %s %s %s with %s" % (self.name, self.specifier, self.version, options))
+ log_verbose("Building %s %s %s with %s" % (self.name, self.commit_ish, self.version, options))
variables = copy.copy(self.target.variables)
self.add_defaults(options)
if not globals.dry_run:
- if len(inspect.getfullargspec(self.cscript['build']).args) == 2:
+ num_args = len(inspect.getfullargspec(self.cscript['build']).args)
+ if num_args == 3:
+ self.call('build', options, for_package)
+ elif num_args == 2:
self.call('build', options)
else:
self.call('build')
#
def main():
-
- commands = {
- "build": "build project",
- "package": "build and package the project",
- "release": "release a project using its next version number (adding a tag)",
- "pot": "build the project's .pot files",
- "manual": "build the project's manual",
- "doxygen": "build the project's Doxygen documentation",
- "latest": "print out the latest version",
- "test": "build the project and run its unit tests",
- "shell": "start a shell in the project''s work directory",
- "checkout": "check out the project",
- "revision": "print the head git revision number",
- "dependencies" : "print details of the project's dependencies as a .dot file"
- }
-
- one_of = ""
- summary = ""
- for k, v in commands.items():
- one_of += "\t%s%s\n" % (k.ljust(20), v)
- summary += k + " "
-
parser = argparse.ArgumentParser()
parser.add_argument('-p', '--project', help='project name')
parser.add_argument('-c', '--checkout', help='string to pass to git for checkout')
parser_test = subparsers.add_parser("test", help="build the project and run its unit tests")
parser_test.add_argument('--no-implicit-build', help='do not build first', action='store_true')
parser_test.add_argument('--test', help="name of test to run, defaults to all")
- parser_shell = subparsers.add_parser("shell", help="build the project then start a shell")
+ parser_shell = subparsers.add_parser("shell", help="start a shell in the project's work directory")
parser_checkout = subparsers.add_parser("checkout", help="check out the project")
parser_revision = subparsers.add_parser("revision", help="print the head git revision number")
parser_dependencies = subparsers.add_parser("dependencies", help="print details of the project's dependencies as a .dot file")
raise Error('you must specify -t or --target')
target = target_factory(args)
- target.build(args.project, args.checkout, get_command_line_options(args))
- if not args.keep:
- target.cleanup()
+ try:
+ target.build(args.project, args.checkout, get_command_line_options(args))
+ finally:
+ if not args.keep:
+ target.cleanup()
elif args.command == 'package':
if args.target is None:
makedirs(output_dir)
target.package(args.project, args.checkout, output_dir, get_command_line_options(args), not args.no_notarize)
- except Error as e:
+ finally:
if target is not None and not args.keep:
target.cleanup()
- raise
-
- if target is not None and not args.keep:
- target.cleanup()
elif args.command == 'release':
if args.minor is False and args.micro is False:
projects / cdist.git / blobdiff