Add dependencies command.
[cdist.git] / cdist
diff --git a/cdist b/cdist
index 9e6be5f10d47b6e9b7779bb7e2621a843fae3fe9..7262702c2258b30e922915b787a0400e8a8621e1 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'),
@@ -256,7 +257,7 @@ def command_and_read(c):
     (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')
@@ -445,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
 
 
@@ -455,17 +456,17 @@ class Target(object):
     def package(self, project, checkout, output_dir, options):
         tree = self.build(project, checkout, options)
         tree.add_defaults(options)
-        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_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)
@@ -479,7 +480,13 @@ class Target(object):
         if self.build_dependencies:
             tree.build_dependencies(options)
         tree.build(options)
-        return tree.call('test', test)
+
+        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)
 
     def set(self, a, b):
         self.variables[a] = b
@@ -541,14 +548,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-%d --mount source=ccache,target=/ccache" % (self.image, os.getuid())
 
         tag = self.image
         if config.has('docker_hub_repository'):
@@ -621,8 +633,6 @@ class WindowsTarget(DockerTarget):
         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.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)
@@ -637,6 +647,15 @@ class WindowsTarget(DockerTarget):
         if environment_version is not None:
             self.image += '_%s' % environment_version
 
+    def setup(self):
+        super().setup()
+        if self.ccache:
+            self.set('CC', '"ccache %s-gcc"' % self.name)
+            self.set('CXX', '"ccache %s-g++"' % self.name)
+        else:
+            self.set('CC', '%s-gcc' % self.name)
+            self.set('CXX', '%s-g++' % self.name)
+
     @property
     def library_prefix(self):
         log_normal('Deprecated property library_prefix: use environment_prefix')
@@ -773,7 +792,7 @@ 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_normal("Deprecated cscript package() method with no options parameter")
@@ -901,7 +920,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
@@ -917,9 +940,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");
@@ -927,7 +960,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)
@@ -952,13 +985,13 @@ class Tree(object):
     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
+        as a tuple of (tree, options, parent_tree).  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:
+        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)
@@ -974,7 +1007,7 @@ class Tree(object):
             dep_options = d[2] if len(d) > 2 else {}
             for i in dep.dependencies(dep_options):
                 yield i
-            yield (dep, dep_options)
+            yield (dep, dep_options, self)
 
     def checkout_dependencies(self, options={}):
         for i in self.dependencies(options):
@@ -1000,7 +1033,7 @@ class Tree(object):
         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')
@@ -1025,7 +1058,8 @@ def main():
         "test": "run the project's unit tests",
         "shell": "build the project then start a shell",
         "checkout": "check out the project",
-        "revision": "print the head git revision number"
+        "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"
@@ -1273,6 +1307,19 @@ def main():
             shutil.copytree('.', args.output)
         target.cleanup()
 
+    elif globals.command == 'dependencies':
+        if args.target is None:
+            raise Error('you must specify -t or --target')
+        if args.checkout is None:
+            raise Error('you must specify -c or --checkout')
+
+        target = target_factory(args)
+        tree = globals.trees.get(args.project, args.checkout, target)
+        print("strict digraph {")
+        for d in list(tree.dependencies({})):
+            print("%s -> %s;" % (d[2].name.replace("-", "-"), d[0].name.replace("-", "_")))
+        print("}")
+
     else:
         raise Error('invalid command %s' % globals.command)