Behave better with symlinks; replace them with the actual path at the earliest opport...
[cdist.git] / cdist
diff --git a/cdist b/cdist
index 71ab475e301b50b2f20f0ae56cd61a4a51430258..2474307b0f8397595d5c089fc303531c1cd9c2ef 100755 (executable)
--- a/cdist
+++ b/cdist
@@ -1,4 +1,4 @@
-#!/usr/bin/python
+#!/usr/bin/python3
 
 #    Copyright (C) 2012-2020 Carl Hetherington <cth@carlh.net>
 #
@@ -103,6 +103,7 @@ class Config:
     def __init__(self):
         self.options = [ Option('mxe_prefix'),
                          Option('git_prefix'),
+                         Option('git_reference'),
                          Option('osx_environment_prefix'),
                          Option('osx_sdk_prefix'),
                          Option('osx_sdk'),
@@ -172,10 +173,14 @@ config = Config()
 # Utility bits
 #
 
-def log(m):
+def log_normal(m):
     if not globals.quiet:
         print('\x1b[33m* %s\x1b[0m' % m)
 
+def log_verbose(m):
+    if globals.verbose:
+        print('\x1b[35m* %s\x1b[0m' % m)
+
 def escape_spaces(s):
     return s.replace(' ', '\\ ')
 
@@ -192,14 +197,14 @@ def mv_escape(n):
     return '\"%s\"' % n.substr(' ', '\\ ')
 
 def copytree(a, b):
-    log('copy %s -> %s' % (scp_escape(a), scp_escape(b)))
+    log_normal('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)))
+    log_normal('copy %s -> %s' % (scp_escape(a), scp_escape(b)))
     if b.startswith('s3://'):
         command('s3cmd -P put "%s" "%s"' % (a, b))
     else:
@@ -233,26 +238,26 @@ def makedirs(d):
         command('ssh %s -- mkdir -p %s' % (s[0], s[1]))
 
 def rmdir(a):
-    log('remove %s' % a)
+    log_normal('remove %s' % a)
     os.rmdir(a)
 
 def rmtree(a):
-    log('remove %s' % a)
+    log_normal('remove %s' % a)
     shutil.rmtree(a, ignore_errors=True)
 
 def command(c):
-    log(c)
+    log_normal(c)
     r = os.system(c)
     if (r >> 8):
         raise Error('command %s failed' % c)
 
 def command_and_read(c):
-    log(c)
+    log_normal(c)
     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()
+    return str(out, 'utf-8').splitlines()
 
 def read_wscript_variable(directory, variable):
     f = open('%s/wscript' % directory, 'r')
@@ -291,7 +296,7 @@ def append_version_to_changelog(version):
     try:
         f = open('ChangeLog', 'r')
     except:
-        log('Could not open ChangeLog')
+        log_normal('Could not open ChangeLog')
         return
 
     c = f.read()
@@ -304,7 +309,7 @@ def append_version_to_changelog(version):
 
 def append_version_to_debian_changelog(version):
     if not os.path.exists('debian'):
-        log('Could not find debian directory')
+        log_normal('Could not find debian directory')
         return
 
     command('dch -b -v %s-1 "New upstream release."' % version)
@@ -314,20 +319,22 @@ def devel_to_git(git_commit, filename):
         filename = filename.replace('devel', '-%s' % git_commit)
     return filename
 
-def argument_options(args):
-    opts = dict()
+
+def get_command_line_options(args):
+    """Get the options specified by --option on the command line"""
+    options = 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
+                options[b[0]] = False
             elif b[1] == 'True':
-                opts[b[0]] = True
+                options[b[0]] = True
             else:
-                opts[b[0]] = b[1]
-    return opts
+                options[b[0]] = b[1]
+    return options
 
 
 class TreeDirectory:
@@ -439,7 +446,7 @@ class Target(object):
             self.set('CCACHE_BASEDIR', os.path.realpath(self.directory))
             self.set('CCACHE_NOHASHDIR', '')
         else:
-            self.directory = directory
+            self.directory = os.path.realpath(directory)
             self.rmdir = False
 
 
@@ -447,27 +454,26 @@ class Target(object):
         pass
 
     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:
+        tree = self.build(project, checkout, options)
+        tree.add_defaults(options)
+        if len(inspect.getfullargspec(tree.cscript['package']).args) == 3:
             packages = tree.call('package', tree.version, options)
         else:
-            log("Deprecated cscript package() method with no options parameter")
+            log_normal("Deprecated cscript package() method with no options parameter")
             packages = tree.call('package', tree.version)
 
-        if isinstance(packages, (str, unicode)):
-            copyfile(packages, os.path.join(output_dir, os.path.basename(devel_to_git(tree.git_commit, packages))))
-        else:
+        if isinstance(packages, list):
             for p in packages:
                 copyfile(p, os.path.join(output_dir, os.path.basename(devel_to_git(tree.git_commit, p))))
+        else:
+            copyfile(packages, os.path.join(output_dir, os.path.basename(devel_to_git(tree.git_commit, packages))))
 
     def build(self, project, checkout, options):
         tree = globals.trees.get(project, checkout, self)
         if self.build_dependencies:
             tree.build_dependencies(options)
         tree.build(options)
+        return tree
 
     def test(self, tree, test, options):
         """test is the test case to run, or None"""
@@ -536,14 +542,19 @@ class DockerTarget(Target):
             return ''
         return '-u %s' % getpass.getuser()
 
+    def _mount_option(self, d):
+        return '-v %s:%s ' % (os.path.realpath(d), os.path.realpath(d))
+
     def setup(self):
-        opts = '-v %s:%s ' % (self.directory, self.directory)
+        opts = self._mount_option(self.directory)
         for m in self.mounts:
-            opts += '-v %s:%s ' % (m, m)
+            opts += self._mount_option(m)
+        if config.has('git_reference'):
+            opts += self._mount_option(config.get('git_reference'))
         if self.privileged:
             opts += '--privileged=true '
         if self.ccache:
-            opts += "-e CCACHE_DIR=/ccache --volumes-from ccache-%s" % self.image
+            opts += "-e CCACHE_DIR=/ccache/%s --mount source=ccache,target=/ccache" % self.image
 
         tag = self.image
         if config.has('docker_hub_repository'):
@@ -553,7 +564,8 @@ class DockerTarget(Target):
 
     def command(self, cmd):
         dir = os.path.join(self.directory, os.path.relpath(os.getcwd(), self.directory))
-        command('%s exec %s -t %s /bin/bash -c \'export %s; cd %s; %s\'' % (config.docker(), self._user_tag(), self.container, self.variables_string(), dir, cmd))
+        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()
@@ -633,27 +645,27 @@ class WindowsTarget(DockerTarget):
 
     @property
     def library_prefix(self):
-        log('Deprecated property library_prefix: use environment_prefix')
+        log_normal('Deprecated property library_prefix: use environment_prefix')
         return self.environment_prefix
 
     @property
     def windows_prefix(self):
-        log('Deprecated property windows_prefix: use environment_prefix')
+        log_normal('Deprecated property windows_prefix: use environment_prefix')
         return self.environment_prefix
 
     @property
     def mingw_prefixes(self):
-        log('Deprecated property mingw_prefixes: use environment_prefix')
+        log_normal('Deprecated property mingw_prefixes: use environment_prefix')
         return [self.environment_prefix]
 
     @property
     def mingw_path(self):
-        log('Deprecated property mingw_path: use tool_path')
+        log_normal('Deprecated property mingw_path: use tool_path')
         return self.tool_path
 
     @property
     def mingw_name(self):
-        log('Deprecated property mingw_name: use name')
+        log_normal('Deprecated property mingw_name: use name')
         return self.name
 
 
@@ -701,7 +713,7 @@ class LinuxTarget(DockerTarget):
 
 class AppImageTarget(LinuxTarget):
     def __init__(self, work):
-        super(AppImageTarget, self).__init__('ubuntu', '16.04', 64, work)
+        super(AppImageTarget, self).__init__('ubuntu', '18.04', 64, work)
         self.detail = 'appimage'
         self.privileged = True
 
@@ -767,10 +779,10 @@ class OSXUniversalTarget(OSXTarget):
 
         tree = globals.trees.get(project, checkout, self)
         with TreeDirectory(tree):
-            if len(inspect.getargspec(tree.cscript['package']).args) == 3:
+            if len(inspect.getfullargspec(tree.cscript['package']).args) == 3:
                 packages = tree.call('package', tree.version, options)
             else:
-                log("Deprecated cscript package() method with no options parameter")
+                log_normal("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))))
@@ -781,7 +793,7 @@ class SourceTarget(Target):
         super(SourceTarget, self).__init__('source')
 
     def command(self, c):
-        log('host -> %s' % c)
+        log_normal('host -> %s' % c)
         command('%s %s' % (self.variables_string(), c))
 
     def cleanup(self):
@@ -895,7 +907,11 @@ class Tree(object):
         if globals.quiet:
             flags = '-q'
             redirect = '>/dev/null'
-        command('git clone %s %s/%s.git %s/src/%s' % (flags, config.get('git_prefix'), self.name, target.directory, self.name))
+        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
@@ -911,9 +927,19 @@ class Tree(object):
         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:
-            command('git submodule init --quiet')
-            command('git submodule update --quiet')
+        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):
+                path = path.split(' ')[1]
+                url = url.split(' ')[1]
+            ref = ''
+            if config.has('git_reference'):
+                ref_path = os.path.join(config.get('git_reference'), os.path.basename(url))
+                if os.path.exists(ref_path):
+                    ref = '--reference %s' % ref_path
+            command('git submodule --quiet update %s %s' % (ref, path))
 
         if os.path.exists('%s/wscript' % proj):
             v = read_wscript_variable(proj, "VERSION");
@@ -921,7 +947,7 @@ class Tree(object):
                 try:
                     self.version = Version(v)
                 except:
-                    tag = subprocess.Popen(shlex.split('git -C %s describe --tags' % proj), stdout=subprocess.PIPE).communicate()[0][1:]
+                    tag = command_and_read('git -C %s describe --tags' % proj)[0][1:]
                     self.version = Version.from_git_tag(tag)
 
         os.chdir(cwd)
@@ -931,35 +957,41 @@ class Tree(object):
             return self.cscript[function](self.target, *args)
 
     def add_defaults(self, options):
-        """Add the defaults from this into a dict options"""
+        """Add the defaults from self into a dict options"""
         if 'option_defaults' in self.cscript:
-            for k, v in self.cscript['option_defaults']().items():
+            from_cscript = self.cscript['option_defaults']
+            if isinstance(from_cscript, dict):
+                defaults_dict = from_cscript
+            else:
+                log_normal("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):
+        """
+        yield details of the dependencies of this tree.  Each dependency is returned
+        as a tuple of (tree, options).  The 'options' parameter are the options that
+        we want to force for 'self'.
+        """
         if not 'dependencies' in self.cscript:
             return
 
-        if len(inspect.getargspec(self.cscript['dependencies']).args) == 2:
-            deps = self.call('dependencies', options)
+        if len(inspect.getfullargspec(self.cscript['dependencies']).args) == 2:
+            self_options = copy.copy(options)
+            self.add_defaults(self_options)
+            deps = self.call('dependencies', self_options)
         else:
-            log("Deprecated cscript dependencies() method with no options parameter")
+            log_normal("Deprecated cscript dependencies() method with no options parameter")
             deps = self.call('dependencies')
 
+        # Loop over our immediate 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)
-
+            # deps only get their options from the parent's cscript
+            dep_options = d[2] if len(d) > 2 else {}
             for i in dep.dependencies(dep_options):
                 yield i
             yield (dep, dep_options)
@@ -969,6 +1001,10 @@ class Tree(object):
             pass
 
     def build_dependencies(self, options):
+        """
+        Called on the 'main' project tree (-p on the command line) to build all dependencies.
+        'options' will be the ones from the command line.
+        """
         for i in self.dependencies(options):
             i[0].build(i[1])
 
@@ -976,15 +1012,15 @@ class Tree(object):
         if self.built:
             return
 
+        log_verbose("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:
+            if len(inspect.getfullargspec(self.cscript['build']).args) == 2:
                 self.call('build', options)
             else:
                 self.call('build')
@@ -1003,7 +1039,6 @@ def main():
         "package": "package and build project",
         "release": "release a project using its next version number (changing wscript and tagging)",
         "pot": "build the project's .pot files",
-        "changelog": "generate a simple HTML changelog",
         "manual": "build the project's manual",
         "doxygen": "build the project's Doxygen documentation",
         "latest": "print out the latest version",
@@ -1042,6 +1077,8 @@ def main():
     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
@@ -1067,11 +1104,14 @@ def main():
 
     if args.work is not None:
         args.work = os.path.abspath(args.work)
+        if not os.path.exists(args.work):
+            os.makedirs(args.work)
 
     if args.project is None and args.command != 'shell':
         raise Error('you must specify -p or --project')
 
     globals.quiet = args.quiet
+    globals.verbose = args.verbose
     globals.command = args.command
     globals.dry_run = args.dry_run
 
@@ -1084,7 +1124,7 @@ def main():
             raise Error('you must specify -t or --target')
 
         target = target_factory(args)
-        target.build(args.project, args.checkout, argument_options(args))
+        target.build(args.project, args.checkout, get_command_line_options(args))
         if not args.keep:
             target.cleanup()
 
@@ -1105,13 +1145,7 @@ def main():
                 output_dir = args.output
 
             makedirs(output_dir)
-
-            # 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)
+            target.package(args.project, args.checkout, output_dir, get_command_line_options(args))
         except Error as e:
             if target is not None and not args.keep:
                 target.cleanup()
@@ -1163,52 +1197,6 @@ def main():
 
         target.cleanup()
 
-    elif globals.command == 'changelog':
-        target = SourceTarget()
-        tree = globals.trees.get(args.project, args.checkout, target)
-
-        with TreeDirectory(tree):
-            text = open('ChangeLog', 'r')
-
-        html = tempfile.NamedTemporaryFile()
-        versions = 8
-
-        last = None
-        changes = []
-
-        while True:
-            l = text.readline()
-            if l == '':
-                break
-
-            if len(l) > 0 and l[0] == "\t":
-                s = l.split()
-                if len(s) == 4 and s[1] == "Version" and s[3] == "released.":
-                    v = Version(s[2])
-                    if v.micro == 0:
-                        if last is not None and len(changes) > 0:
-                            print("<h2>Changes between version %s and %s</h2>" % (s[2], last), file=html)
-                            print("<ul>", file=html)
-                            for c in changes:
-                                print("<li>%s" % c, file=html)
-                            print("</ul>", file=html)
-                        last = s[2]
-                        changes = []
-                        versions -= 1
-                        if versions < 0:
-                            break
-                else:
-                    c = l.strip()
-                    if len(c) > 0:
-                        if c[0] == '*':
-                            changes.append(c[2:])
-                        else:
-                            changes[-1] += " " + c
-
-        copyfile(html.file, '%schangelog.html' % args.output)
-        html.close()
-        target.cleanup()
-
     elif globals.command == 'manual':
         target = SourceTarget()
         tree = globals.trees.get(args.project, args.checkout, target)
@@ -1270,7 +1258,7 @@ def main():
             target = target_factory(args)
             tree = globals.trees.get(args.project, args.checkout, target)
             with TreeDirectory(tree):
-                target.test(tree, args.test, argument_options(args))
+                target.test(tree, args.test, get_command_line_options(args))
         except Error as e:
             if target is not None and not args.keep:
                 target.cleanup()