Rename --latest-major and --latest-minor to --major and --minor.
[cdist.git] / cdist
diff --git a/cdist b/cdist
index bac3f25e40ca67b2130c0f42a46a3dbce90bd1ca..dfada3fd230db224ee448d4b40c9053319c8f954 100755 (executable)
--- a/cdist
+++ b/cdist
@@ -26,6 +26,7 @@ import glob
 import inspect
 import multiprocessing
 import os
+import platform
 import re
 import shlex
 import shutil
@@ -70,6 +71,10 @@ class Trees:
         self.trees.append(nt)
         return nt
 
+    def add_built(self, name, specifier, target):
+        self.trees.append(Tree(name, specifier, target, None, built=True))
+
+
 class Globals:
     quiet = False
     command = None
@@ -278,45 +283,6 @@ def read_wscript_variable(directory, variable):
     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_normal('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_normal('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:
@@ -483,18 +449,17 @@ class Target(object):
         tree.build(options)
         return tree
 
-    def test(self, tree, test, options):
+    def test(self, project, checkout, target, test, options):
         """test is the test case to run, or None"""
-        if self.build_dependencies:
-            tree.build_dependencies(options)
-        tree.build(options)
+        tree = globals.trees.get(project, checkout, target)
 
         tree.add_defaults(options)
-        if len(inspect.getfullargspec(tree.cscript['test']).args) == 3:
-            return tree.call('test', options, test)
-        else:
-            log_normal('Deprecated cscript test() method with no options parameter')
-            return tree.call('test', test)
+        with TreeDirectory(tree):
+            if len(inspect.getfullargspec(tree.cscript['test']).args) == 3:
+                return tree.call('test', options, test)
+            else:
+                log_normal('Deprecated cscript test() method with no options parameter')
+                return tree.call('test', test)
 
     def set(self, a, b):
         self.variables[a] = b
@@ -616,7 +581,7 @@ class FlatpakTarget(Target):
         return b
 
 
-class WindowsTarget(DockerTarget):
+class WindowsDockerTarget(DockerTarget):
     """
     This target exposes the following additional API:
 
@@ -627,7 +592,7 @@ class WindowsTarget(DockerTarget):
     tool_path: path to 32- and 64-bit tools
     """
     def __init__(self, windows_version, bits, directory, environment_version):
-        super(WindowsTarget, self).__init__('windows', directory)
+        super(WindowsDockerTarget, self).__init__('windows', directory)
         self.version = windows_version
         self.bits = bits
 
@@ -690,6 +655,28 @@ class WindowsTarget(DockerTarget):
         return self.name
 
 
+class WindowsNativeTarget(Target):
+    """
+    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)
+    """
+    def __init__(self, directory):
+        super().__init__('windows', directory)
+        self.version = None
+        self.bits = 64
+
+        self.environment_prefix = config.get('windows_native_environmnet_prefix')
+
+        self.set('PATH', '%s/bin:%s' % (self.environment_prefix, os.environ['PATH']))
+
+    def command(self, cmd):
+        command(cmd)
+
+
 class LinuxTarget(DockerTarget):
     """
     Build for Linux in a docker container.
@@ -726,10 +713,10 @@ class LinuxTarget(DockerTarget):
             self.set('CC', '"ccache gcc"')
             self.set('CXX', '"ccache g++"')
 
-    def test(self, tree, test, options):
+    def test(self, project, checkout, target, 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)
+        super(LinuxTarget, self).test(project, checkout, target, test, options)
 
 
 class AppImageTarget(LinuxTarget):
@@ -758,7 +745,7 @@ def notarize(dmg, bundle_id):
 
     for i in range(0, 30):
         print('Checking up on %s' % request_uuid)
-        p = subprocess.run(['xcrun', 'altool', '--notarization-info', request_uuid, '-u', apple_id, '-p', apple_password, '--output-format', 'xml'], capture_output=True)
+        p = subprocess.run(['xcrun', 'altool', '--notarization-info', request_uuid, '-u', config.get('apple_id'), '-p', config.get('apple_password'), '--output-format', 'xml'], capture_output=True)
         status = string_after(p, 'Status')
         print('Got %s' % status)
         if status == 'invalid':
@@ -828,8 +815,8 @@ class OSXSingleTarget(OSXTarget):
         for x in p:
             if not isinstance(x, tuple):
                 raise Error('macOS packages must be returned from cscript as tuples of (dmg-filename, bundle-id)')
-        if not no_notarize:
-            notarize(x[0], x[1])
+            if not no_notarize:
+                notarize(x[0], x[1])
         self._copy_packages(tree, [x[0] for x in p], output_dir)
 
 
@@ -894,12 +881,15 @@ def target_factory(args):
     target = None
     if s.startswith('windows-'):
         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)
+        if platform.system() == "Windows":
+            target = WindowsNativeTarget(args.work)
         else:
-            raise Error("Bad Windows target name `%s'")
+            if len(x) == 2:
+                target = WindowsDockerTarget(None, int(x[1]), args.work, args.environment_version)
+            elif len(x) == 3:
+                target = WindowsDockerTarget(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:
@@ -915,7 +905,7 @@ def target_factory(args):
     elif s.startswith('osx-'):
         target = OSXSingleTarget(int(s.split('-')[1]), args.work)
     elif s == 'osx':
-        if globals.command == 'build':
+        if args.command == 'build':
             target = OSXSingleTarget(64, args.work)
         else:
             target = OSXUniversalTarget(args.work)
@@ -961,55 +951,56 @@ class Tree(object):
            required_by -- name of the tree that requires this one
     """
 
-    def __init__(self, name, specifier, target, required_by):
+    def __init__(self, name, specifier, target, required_by, built=False):
         self.name = name
         self.specifier = specifier
         self.target = target
         self.version = None
         self.git_commit = None
-        self.built = False
+        self.built = built
         self.required_by = required_by
 
         cwd = os.getcwd()
+        proj = '%s/src/%s' % (target.directory, self.name)
 
-        flags = ''
-        redirect = ''
-        if globals.quiet:
-            flags = '-q'
-            redirect = '>/dev/null'
-        if config.has('git_reference'):
-            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))
-        os.chdir('%s/src/%s' % (target.directory, self.name))
-
-        spec = self.specifier
-        if spec is None:
-            spec = 'master'
+        if not built:
+            flags = ''
+            redirect = ''
+            if globals.quiet:
+                flags = '-q'
+                redirect = '>/dev/null'
+            if config.has('git_reference'):
+                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))
+            os.chdir('%s/src/%s' % (target.directory, self.name))
 
-        command('git checkout %s %s %s' % (flags, spec, redirect))
-        self.git_commit = command_and_read('git rev-parse --short=7 HEAD')[0].strip()
+            spec = self.specifier
+            if spec is None:
+                spec = 'master'
 
-        proj = '%s/src/%s' % (target.directory, self.name)
+            command('git checkout %s %s %s' % (flags, spec, redirect))
+            self.git_commit = command_and_read('git rev-parse --short=7 HEAD')[0].strip()
 
         self.cscript = {}
         exec(open('%s/cscript' % proj).read(), self.cscript)
 
-        # cscript can include submodules = False to stop submodules being fetched
-        if (not 'submodules' in self.cscript or self.cscript['submodules'] == True) and os.path.exists('.gitmodules'):
-            command('git submodule --quiet init')
-            paths = command_and_read('git config --file .gitmodules --get-regexp path')
-            urls = command_and_read('git config --file .gitmodules --get-regexp url')
-            for path, url in zip(paths, urls):
-                ref = ''
-                if config.has('git_reference'):
-                    url = url.split(' ')[1]
-                    ref_path = os.path.join(config.get('git_reference'), os.path.basename(url))
-                    if os.path.exists(ref_path):
-                        ref = '--reference %s' % ref_path
-                path = path.split(' ')[1]
-                command('git submodule --quiet update %s %s' % (ref, path))
+        if not built:
+            # cscript can include submodules = False to stop submodules being fetched
+            if (not 'submodules' in self.cscript or self.cscript['submodules'] == True) and os.path.exists('.gitmodules'):
+                command('git submodule --quiet init')
+                paths = command_and_read('git config --file .gitmodules --get-regexp path')
+                urls = command_and_read('git config --file .gitmodules --get-regexp url')
+                for path, url in zip(paths, urls):
+                    ref = ''
+                    if config.has('git_reference'):
+                        url = url.split(' ')[1]
+                        ref_path = os.path.join(config.get('git_reference'), os.path.basename(url))
+                        if os.path.exists(ref_path):
+                            ref = '--reference %s' % ref_path
+                    path = path.split(' ')[1]
+                    command('git submodule --quiet update %s %s' % (ref, path))
 
         if os.path.exists('%s/wscript' % proj):
             v = read_wscript_variable(proj, "VERSION");
@@ -1017,8 +1008,13 @@ class Tree(object):
                 try:
                     self.version = Version(v)
                 except:
-                    tag = command_and_read('git -C %s describe --tags' % proj)[0][1:]
-                    self.version = Version.from_git_tag(tag)
+                    try:
+                        tag = command_and_read('git -C %s describe --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
+                        # Should probably just install git on the Windows VM
+                        pass
 
         os.chdir(cwd)
 
@@ -1098,6 +1094,7 @@ class Tree(object):
         self.target.variables = variables
         self.built = True
 
+
 #
 # Command-line parser
 #
@@ -1106,32 +1103,27 @@ def main():
 
     commands = {
         "build": "build project",
-        "package": "build and package project",
-        "release": "release a project using its next version number (changing wscript and tagging)",
+        "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": "run the project's unit tests",
-        "shell": "build the project then start a shell",
+        "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 = "Command is one of:\n"
+    one_of = ""
     summary = ""
     for k, v in commands.items():
-        one_of += "\t%s\t%s\n" % (k, v)
+        one_of += "\t%s%s\n" % (k.ljust(20), v)
         summary += k + " "
 
     parser = argparse.ArgumentParser()
-    parser.add_argument('command', help=summary)
     parser.add_argument('-p', '--project', help='project name')
-    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('--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')
@@ -1141,15 +1133,34 @@ def main():
     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')
-    parser.add_argument('--no-notarize', help='don\'t notarize .dmg packages', action='store_true')
+
+    subparsers = parser.add_subparsers(help='command to run', dest='command')
+    parser_build = subparsers.add_parser("build", help="build project")
+    parser_package = subparsers.add_parser("package", help="build and package project")
+    parser_package.add_argument('--no-notarize', help='do not notarize .dmg packages', action='store_true')
+    parser_release = subparsers.add_parser("release", help="release a project using its next version number (adding a tag)")
+    parser_release.add_argument('--minor', help='minor version number bump', action='store_true')
+    parser_release.add_argument('--micro', help='micro version number bump', action='store_true')
+    parser_pot = subparsers.add_parser("pot", help="build the project's .pot files")
+    parser_manual = subparsers.add_parser("manual", help="build the project's manual")
+    parser_doxygen = subparsers.add_parser("doxygen", help="build the project's Doxygen documentation")
+    parser_latest = subparsers.add_parser("latest", help="print out the latest version")
+    parser_latest.add_argument('--major', help='major version to return', type=int)
+    parser_latest.add_argument('--minor', help='minor version to return', type=int)
+    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_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")
+
     global args
     args = parser.parse_args()
 
@@ -1184,14 +1195,9 @@ def main():
 
     globals.quiet = args.quiet
     globals.verbose = args.verbose
-    globals.command = args.command
     globals.dry_run = args.dry_run
 
-    if not globals.command in commands:
-        e = 'command must be one of:\n' + one_of
-        raise Error('command must be one of:\n%s' % one_of)
-
-    if globals.command == 'build':
+    if args.command == 'build':
         if args.target is None:
             raise Error('you must specify -t or --target')
 
@@ -1200,7 +1206,7 @@ def main():
         if not args.keep:
             target.cleanup()
 
-    elif globals.command == 'package':
+    elif args.command == 'package':
         if args.target is None:
             raise Error('you must specify -t or --target')
 
@@ -1226,7 +1232,7 @@ def main():
         if target is not None and not args.keep:
             target.cleanup()
 
-    elif globals.command == 'release':
+    elif args.command == 'release':
         if args.minor is False and args.micro is False:
             raise Error('you must specify --minor or --micro')
 
@@ -1241,25 +1247,12 @@ def main():
             version.bump_micro()
 
         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 tag -m "v%s" v%s' % (version, version))
-
-            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':
+    elif args.command == 'pot':
         target = SourceTarget()
         tree = globals.trees.get(args.project, args.checkout, target)
 
@@ -1269,7 +1262,7 @@ def main():
 
         target.cleanup()
 
-    elif globals.command == 'manual':
+    elif args.command == 'manual':
         target = SourceTarget()
         tree = globals.trees.get(args.project, args.checkout, target)
 
@@ -1282,7 +1275,7 @@ def main():
 
         target.cleanup()
 
-    elif globals.command == 'doxygen':
+    elif args.command == 'doxygen':
         target = SourceTarget()
         tree = globals.trees.get(args.project, args.checkout, target)
 
@@ -1295,7 +1288,7 @@ def main():
 
         target.cleanup()
 
-    elif globals.command == 'latest':
+    elif args.command == 'latest':
         target = SourceTarget()
         tree = globals.trees.get(args.project, args.checkout, target)
 
@@ -1315,38 +1308,37 @@ def main():
                             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):
+                            if (args.major is None or v.major == args.major) and (args.minor is None or v.minor == args.minor):
                                 latest = v
 
         print(latest)
         target.cleanup()
 
-    elif globals.command == 'test':
+    elif args.command == 'test':
         if args.target is None:
             raise Error('you must specify -t or --target')
 
         target = None
         try:
             target = target_factory(args)
-            tree = globals.trees.get(args.project, args.checkout, target)
-            with TreeDirectory(tree):
-                target.test(tree, args.test, get_command_line_options(args))
-        except Error as e:
+            options = get_command_line_options(args)
+            if args.no_implicit_build:
+                globals.trees.add_built(args.project, args.checkout, target)
+            else:
+                target.build(args.project, args.checkout, options)
+            target.test(args.project, args.checkout, target, args.test, options)
+        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 globals.command == 'shell':
+    elif args.command == 'shell':
         if args.target is None:
             raise Error('you must specify -t or --target')
 
         target = target_factory(args)
         target.command('bash')
 
-    elif globals.command == 'revision':
+    elif args.command == 'revision':
 
         target = SourceTarget()
         tree = globals.trees.get(args.project, args.checkout, target)
@@ -1354,7 +1346,7 @@ def main():
             print(command_and_read('git rev-parse HEAD')[0].strip()[:7])
         target.cleanup()
 
-    elif globals.command == 'checkout':
+    elif args.command == 'checkout':
 
         if args.output is None:
             raise Error('you must specify -o or --output')
@@ -1365,7 +1357,7 @@ def main():
             shutil.copytree('.', args.output)
         target.cleanup()
 
-    elif globals.command == 'dependencies':
+    elif args.command == 'dependencies':
         if args.target is None:
             raise Error('you must specify -t or --target')
         if args.checkout is None:
@@ -1378,8 +1370,6 @@ def main():
             print("%s -> %s;" % (d[2].name.replace("-", "-"), d[0].name.replace("-", "_")))
         print("}")
 
-    else:
-        raise Error('invalid command %s' % globals.command)
 
 try:
     main()