Expose some more stuff to OSXTarget.
[cdist.git] / cdist
diff --git a/cdist b/cdist
index 703b1ba5e651d950b25193de75b3944d0e44e3ac..3bf9460a9690dcda316e339e2f8cecc6e568004f 100755 (executable)
--- a/cdist
+++ b/cdist
@@ -1,6 +1,6 @@
 #!/usr/bin/python
 
-#    Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
+#    Copyright (C) 2012-2015 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
@@ -28,13 +28,7 @@ import re
 import copy
 import inspect
 
-TEMPORARY_DIRECTORY = '/tmp'
-
-class Globals:
-    quiet = False
-    command = None
-
-globals = Globals()
+TEMPORARY_DIRECTORY = '/var/tmp'
 
 class Error(Exception):
     def __init__(self, value):
@@ -44,27 +38,32 @@ class Error(Exception):
     def __repr__(self):
         return str(self)
 
-class Projects:
+class Trees:
     """
-    Store for Project objects which re-uses already-created objects
+    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.projects = []
+        self.trees = []
 
     def get(self, name, specifier, target):
-        for p in self.projects:
-            if p.name == name and p.specifier == specifier:
-                return p
-            elif p.name == name and p.specifier != p.specifier:
-                raise Error('conflicting versions of %s requested (%s and %s)' % (name, specifier, p.specifier))
+        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:
+                raise Error('conflicting versions of %s requested (%s and %s)' % (name, specifier, t.specifier))
 
-        np = Project(name, specifier, target)
-        self.projects.append(np)
-        return np
+        nt = Tree(name, specifier, target)
+        self.trees.append(nt)
+        return nt
 
-projects = Projects()
+class Globals:
+    quiet = False
+    command = None
+    trees = Trees()
+
+globals = Globals()
 
 
 #
@@ -125,11 +124,15 @@ class Config:
 
         raise Error('Required setting %s not found' % k)
 
+    def set(self, k, v):
+        for o in self.options:
+            o.offer(k, v)
+
 config = Config()
 
 #
 # Utility bits
-# 
+#
 
 def log(m):
     if not globals.quiet:
@@ -184,7 +187,7 @@ def read_wscript_variable(directory, variable):
         l = f.readline()
         if l == '':
             break
-        
+
         s = l.split()
         if len(s) == 3 and s[0] == variable:
             f.close()
@@ -234,18 +237,17 @@ def append_version_to_debian_changelog(version):
 
     command('dch -b -v %s-1 "New upstream release."' % version)
 
-def devel_to_git(project, filename):
-    if project.git_commit is not None:
-        filename = filename.replace('devel', '-%s' % project.git_commit)
+def devel_to_git(git_commit, filename):
+    if git_commit is not None:
+        filename = filename.replace('devel', '-%s' % git_commit)
     return filename
 
-class ProjectDirectory:
-    def __init__(self, target, project):
-        self.target = target
-        self.project = project
+class TreeDirectory:
+    def __init__(self, tree):
+        self.tree = tree
     def __enter__(self):
         self.cwd = os.getcwd()
-        os.chdir('%s/src/%s' % (self.target.directory, self.project.name))
+        os.chdir('%s/src/%s' % (self.tree.target.directory, self.tree.name))
     def __exit__(self, type, value, traceback):
         os.chdir(self.cwd)
 
@@ -261,7 +263,7 @@ class Version:
             s = s[1:]
         if s.endswith("'"):
             s = s[0:-1]
-        
+
         if s.endswith('devel'):
             s = s[0:-5]
             self.devel = True
@@ -323,47 +325,16 @@ class Target(object):
         self.variables = {}
         self.debug = False
 
-    def build_dependencies(self, project):
-        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 = projects.get(d[0], d[1], 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 build(self, project, options=None):
-        if project.built:
-            return
-
-        variables = copy.copy(self.variables)
-
-        if len(inspect.getargspec(project.cscript['build']).args) == 2:
-            project.call(self, 'build', options)
-        else:
-            project.call(self, 'build')
-        
-        self.variables = variables
-        project.built = True
+    def package(self, project, checkout):
+        tree = globals.trees.get(project, checkout, self)
+        tree.build_dependencies()
+        tree.build(tree)
+        return tree.call('package', tree.version), tree.git_commit
 
-    def package(self, project):
-        self.build_dependencies(project)
-        self.build(project)
-        return project.call(self, 'package', project.version)
-
-    def test(self, project):
-        self.build_dependencies(project)
-        self.build(project)
-        return project.call(self, 'test')
+    def test(self, tree):
+        tree.build_dependencies()
+        tree.build()
+        return tree.call('test')
 
     def set(self, a, b):
         self.variables[a] = b
@@ -375,10 +346,14 @@ class Target(object):
         return self.variables[a]
 
     def append_with_space(self, k, v):
-        if not k in self.variables:
-            self.variables[k] = v
+        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"' % (e[1:-1], v)
+            else:
+                self.variables[k] = '"%s %s"' % (e, v)
 
     def variables_string(self, escaped_quotes=False):
         e = ''
@@ -392,7 +367,7 @@ class Target(object):
         if self.rmdir:
             rmtree(self.directory)
 
-# 
+#
 # Windows
 #
 
@@ -404,7 +379,7 @@ class WindowsTarget(Target):
         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)
-            
+
         if self.bits == 32:
             self.mingw_name = 'i686'
         else:
@@ -429,35 +404,50 @@ class WindowsTarget(Target):
         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))
 
-#
-# Linux
-#
-
 class LinuxTarget(Target):
+    """Parent for Linux targets"""
     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.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('PATH', '/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin')
+
+class ChrootTarget(LinuxTarget):
+    """Build in a chroot"""
+    def __init__(self, distro, version, bits, directory=None):
+        super(ChrootTarget, self).__init__(distro, version, bits, directory)
+        # e.g. ubuntu-14.04-64
+        if self.version is not None and self.bits is not None:
+            self.chroot = '%s-%s-%d' % (self.distro, self.version, self.bits)
+        else:
+            self.chroot = self.distro
+        # e.g. /home/carl/Environments/ubuntu-14.04-64
+        self.chroot_prefix = '%s/%s' % (config.get('linux_chroot_prefix'), self.chroot)
 
     def command(self, c):
         command('%s schroot -c %s -p -- %s' % (self.variables_string(), self.chroot, c))
 
+
+class HostTarget(LinuxTarget):
+    """Build directly on the host"""
+    def __init__(self, distro, version, bits, directory=None):
+        super(HostTarget, self).__init__(distro, version, bits, directory)
+
+    def command(self, c):
+        command('%s %s' % (self.variables_string(), c))
+
 #
 # OS X
 #
@@ -465,6 +455,8 @@ class LinuxTarget(Target):
 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')
 
     def command(self, c):
         command('%s %s' % (self.variables_string(False), c))
@@ -480,7 +472,7 @@ class OSXSingleTarget(OSXTarget):
         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.osx_sdk, arch)
         enviro = '%s/%d' % (config.get('osx_environment_prefix'), bits)
 
         # Environment variables
@@ -493,30 +485,28 @@ class OSXSingleTarget(OSXTarget):
         self.set('PATH', '$PATH:/usr/bin:/sbin:/usr/local/bin:%s/bin' % enviro)
         self.set('MACOSX_DEPLOYMENT_TARGET', config.get('osx_sdk'))
 
-    def package(self, project):
+    def package(self, project, checkout):
         raise Error('cannot package non-universal OS X versions')
 
 
 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')))
 
-    def package(self, project):
-        for p in self.parts:
-            p.build_dependencies(project)
-            p.build(project)
+    def package(self, project, checkout):
 
-        project.call(self, 'package', project.version)
-    
+        for b in [32, 64]:
+            target = OSXSingleTarget(b, os.path.join(self.directory, '%d' % b))
+            tree = globals.trees.get(project, checkout, target)
+            tree.build_dependencies()
+            tree.build()
 
-#
-# Source
-#
+        tree = globals.trees.get(project, checkout, self)
+        with TreeDirectory(tree):
+            return tree.call('package', tree.version), tree.git_commit
 
 class SourceTarget(Target):
+    """Build a source .tar.bz2"""
     def __init__(self):
         super(SourceTarget, self).__init__('source')
 
@@ -527,10 +517,12 @@ class SourceTarget(Target):
     def cleanup(self):
         rmtree(self.directory)
 
-    def package(self, project):
-        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):
+        tree = globals.trees.get(project, checkout, self)
+        with TreeDirectory(tree):
+            name = read_wscript_variable(os.getcwd(), 'APPNAME')
+            command('./waf dist')
+            return os.path.abspath('%s-%s.tar.bz2' % (name, tree.version)), tree.git_commit
 
 
 # @param s Target string:
@@ -539,7 +531,7 @@ class SourceTarget(Target):
 #    or debian-version-{32,64}
 #    or centos-version-{32,64}
 #    or osx-{32,64}
-#    or source      
+#    or source
 # @param debug True to build with debugging symbols (where possible)
 def target_factory(s, debug, work):
     target = None
@@ -548,9 +540,21 @@ def target_factory(s, debug, work):
     elif s.startswith('ubuntu-') or s.startswith('debian-') or s.startswith('centos-'):
         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-12.04-32 (i.e. distro-version-bits)" % s)
+        target = ChrootTarget(p[0], p[1], int(p[2]), work)
+    elif s == 'raspbian':
+        target = ChrootTarget(s, None, None, work)
+    elif s == 'host':
+        try:
+            f = open('/etc/fedora-release', 'r')
+            l = f.readline().strip().split()
+            if command_and_read('uname -m').read().strip() == 'x86_64':
+                bits = 64
+            else:
+                bits = 32
+            target = HostTarget("fedora", l[2], bits, work)
+        except Exception as e:
+            raise Error("could not identify distribution for `host' target (%s)" % e)
     elif s.startswith('osx-'):
         target = OSXSingleTarget(int(s.split('-')[1]), work)
     elif s == 'osx':
@@ -561,25 +565,27 @@ def target_factory(s, debug, work):
     elif s == 'source':
         target = SourceTarget()
 
-    if target is not None:
-        target.debug = debug
+    if target is None:
+        raise Error("Bad target `%s'" % s)
 
+    target.debug = debug
     return target
 
 
 #
-# Project
+# Tree
 #
-class Project(object):
-    """Description of a project.  This class is never exposed to cscripts.
+
+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 project has been built yet in this run
+           built --- true if the tree has been built yet in this run
     """
 
     def __init__(self, name, specifier, target):
@@ -621,9 +627,41 @@ class Project(object):
 
         os.chdir(cwd)
 
-    def call(self, target, function, *args):
-        with ProjectDirectory(target, self):
-            return self.cscript[function](target, *args)
+    def call(self, function, *args):
+        with TreeDirectory(self):
+            return self.cscript[function](self.target, *args)
+
+    def build_dependencies(self):
+        if 'dependencies' in self.cscript:
+            for d in self.cscript['dependencies'](self.target):
+                log('Building dependency %s %s of %s' % (d[0], d[1], self.name))
+                dep = globals.trees.get(d[0], d[1], self.target)
+                dep.build_dependencies()
+
+                # 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
+
+                dep.build(options)
+
+    def build(self, options=None):
+        if self.built:
+            return
+
+        variables = copy.copy(self.target.variables)
+
+        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
@@ -642,6 +680,7 @@ def main():
         "latest": "print out the latest version",
         "test": "run the project's unit tests",
         "shell": "build the project then start a shell in its chroot",
+        "checkout": "check out the project",
         "revision": "print the head git revision number"
     }
 
@@ -664,8 +703,13 @@ def main():
     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')
     args = parser.parse_args()
 
+    # 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) + '/'
@@ -680,7 +724,7 @@ def main():
 
     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
 
@@ -693,9 +737,9 @@ def main():
             raise Error('you must specify -t or --target')
 
         target = target_factory(args.target, args.debug, args.work)
-        project = projects.get(args.project, args.checkout, target)
-        target.build_dependencies(project)
-        target.build(project)
+        tree = globals.trees.get(args.project, args.checkout, target)
+        tree.build_dependencies()
+        tree.build()
         if not args.keep:
             target.cleanup()
 
@@ -704,9 +748,7 @@ def main():
             raise Error('you must specify -t or --target')
 
         target = target_factory(args.target, args.debug, args.work)
-        project = projects.get(args.project, args.checkout, target)
-
-        packages = target.package(project)
+        packages, git_commit = target.package(args.project, args.checkout)
         if hasattr(packages, 'strip') or (not hasattr(packages, '__getitem__') and not hasattr(packages, '__iter__')):
             packages = [packages]
 
@@ -717,14 +759,14 @@ def main():
             except:
                 pass
             for p in packages:
-                copyfile(p, '%s/%s' % (out, os.path.basename(devel_to_git(project, p))))
+                copyfile(p, '%s/%s' % (out, os.path.basename(devel_to_git(git_commit, p))))
         else:
             try:
                 makedirs(args.output)
             except:
                 pass
             for p in packages:
-                copyfile(p, '%s%s' % (args.output, os.path.basename(devel_to_git(project, p))))
+                copyfile(p, '%s%s' % (args.output, os.path.basename(devel_to_git(git_commit, p))))
 
         if not args.keep:
             target.cleanup()
@@ -734,9 +776,9 @@ def main():
             raise Error('you must specify --minor or --micro')
 
         target = SourceTarget()
-        project = projects.get(args.project, args.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()
@@ -760,9 +802,9 @@ def main():
 
     elif globals.command == 'pot':
         target = SourceTarget()
-        project = projects.get(args.project, args.checkout, target)
+        tree = globals.trees.get(args.project, args.checkout, target)
 
-        pots = project.call(target, 'make_pot')
+        pots = tree.call('make_pot')
         for p in pots:
             copyfile(p, '%s%s' % (args.output, os.path.basename(p)))
 
@@ -770,9 +812,9 @@ def main():
 
     elif globals.command == 'changelog':
         target = SourceTarget()
-        project = projects.get(args.project, args.checkout, target)
+        tree = globals.trees.get(args.project, args.checkout, target)
 
-        with ProjectDirectory(target, project):
+        with TreeDirectory(tree):
             text = open('ChangeLog', 'r')
 
         html = tempfile.NamedTemporaryFile()
@@ -816,9 +858,9 @@ def main():
 
     elif globals.command == 'manual':
         target = SourceTarget()
-        project = projects.get(args.project, args.checkout, target)
+        tree = globals.trees.get(args.project, args.checkout, target)
 
-        outs = project.call(target, 'make_manual')
+        outs = tree.call('make_manual')
         for o in outs:
             if os.path.isfile(o):
                 copyfile(o, '%s%s' % (args.output, os.path.basename(o)))
@@ -829,22 +871,22 @@ def main():
 
     elif globals.command == 'doxygen':
         target = SourceTarget()
-        project = projects.get(args.project, args.checkout, target)
+        tree = globals.trees.get(args.project, args.checkout, target)
 
-        dirs = project.call(target, 'make_doxygen')
+        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 = projects.get(args.project, args.checkout, target)
+        tree = globals.trees.get(args.project, args.checkout, target)
 
-        with ProjectDirectory(target, project):
+        with TreeDirectory(tree):
             f = command_and_read('git log --tags --simplify-by-decoration --pretty="%d"')
             latest = None
             while latest is None:
@@ -871,9 +913,9 @@ def main():
         target = None
         try:
             target = target_factory(args.target, args.debug, args.work)
-            project = projects.get(args.project, args.checkout, target)
-            with ProjectDirectory(target, project):
-                target.test(project)
+            tree = globals.trees.get(args.project, args.checkout, target)
+            with TreeDirectory(tree):
+                target.test(tree)
         except Error as e:
             if target is not None:
                 target.cleanup()
@@ -892,11 +934,22 @@ def main():
     elif globals.command == 'revision':
 
         target = SourceTarget()
-        project = projects.get(args.project, args.checkout, target)
-        with ProjectDirectory(target, project):
+        tree = globals.trees.get(args.project, args.checkout, target)
+        with TreeDirectory(tree):
             print command_and_read('git rev-parse HEAD').readline().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:
         raise Error('invalid command %s' % globals.command)