Better abstract build systems away; add support for python build system
authorRalf Jung <post@ralfj.de>
Fri, 17 Aug 2012 10:39:37 +0000 (12:39 +0200)
committerRalf Jung <post@ralfj.de>
Fri, 17 Aug 2012 10:39:37 +0000 (12:39 +0200)
auto_debuild.py

index 8441f079aeae1fe7c083ad2ea0935f2e75631e32..61d7efc394e38d34e381e06ad3a16efa20012f52 100755 (executable)
@@ -11,11 +11,19 @@ def safeCall(*args):
                res += "'"+arg+"'"
        return res
 
+# representation of a build system
+class BuildSystem:
+       def __init__(self, ruleMaker, buildDepends = [], binaryDepends = []):
+               self.ruleMaker = ruleMaker
+               self.buildDepends = buildDepends
+               self.binaryDepends = binaryDepends
+
 # abstract representation of rules file
 class RulesFile:
        def __init__(self):
                self.env = {}
                self.dh = []
+               self.dhWith = set()
                self.rules = OrderedDict()
        
        def env2str(self):
@@ -33,14 +41,19 @@ class RulesFile:
                print >>f, ".PHONY: build" # there may be a directory called "build"
                print >>f, ""
                print >>f, "build %:" # need to mention "build" here again explicitly
-               print >>f, '\t'+self.env2str()+' dh $@ '+safeCall(*self.dh)
+               # write proper dh call
+               dh = self.dh
+               if self.dhWith:
+                       dh.append('--with='+','.join(self.dhWith))
+               print >>f, '\t'+self.env2str()+' dh $@ '+safeCall(*dh)
+               # write remaining rules
                for rule in self.rules:
                        print >>f, ""
                        print >>f, "override_dh_"+rule+":"
                        for line in self.rules[rule]:
                                print >>f, "\t"+line
 
-# build-system specific part of rules file
+# rule-makers
 def cmakeRules(config):
        buildDir = config.get('buildDir', 'build')
        srcDir = os.getcwd()
@@ -72,6 +85,23 @@ def automakeRules(config):
        r.rules['auto_clean'] = ['rm -f config.status'] # do not re-use old configuration (no need for escaping here, obviously)
        return r
 
+def pythonRules(config):
+       r = RulesFile()
+       r.dh += ["--buildsystem=python_distutils"]
+       r.dhWith.add('python2')
+       r.rules['auto_clean'] = [ # clean properly
+               'dh_auto_clean',
+               'rm -rf build'
+       ]
+       return r
+
+# build systems
+buildSystems = {
+       'cmake': BuildSystem(cmakeRules, ["cmake"]),
+       'automake': BuildSystem(automakeRules, ["automake"]),
+       'python': BuildSystem(pythonRules, ["python-setuptools"], ["${python:Depends}"]),
+}
+
 # utility functions
 def commandInBuildEnv(config, command):
        schroot = config.get('schroot')
@@ -96,12 +126,14 @@ def createDebianFiles(config):
        name = config.get('name', os.getenv('USER')) # os.getlogin() fails in minimal chroots
        email = config.get('email', os.getenv('USER')+'@'+os.uname()[1]) # user@hostname
        debDir = os.path.expanduser(config['debDir'])
-       buildSystem = config['buildSystem']
+       buildSystem = buildSystems[config['buildSystem']] # get the data immediately
        version = config['version']
        dbgPackage = config.get('dbgPackage', False)
        parallelJobs = int(config.get('parallelJobs', 2))
        packageArchitecture = config.get('architecture', 'any')
        withPython2 = config.get('withPython2', False)
+       if withPython2:
+               buildSystem.binaryDepends.append("${python:Depends}") # HACK, but it works: make sure dependencies on binary are added
        # we return the list of files generated, so we need to know the architecture
        arch = getArchitecture(config)
        files = []
@@ -132,13 +164,14 @@ def createDebianFiles(config):
                print >>f, "Section:",config.get('section', 'misc')
                print >>f, "Priority: extra"
                print >>f, "Maintainer: %s <%s>" % (name, email)
-               writeDependency(f, 'Build-Depends', ["debhelper (>= 9)"] + config.get('buildDepends', []))
+               writeDependency(f, 'Build-Depends', ["debhelper (>= 9)"] + buildSystem.buildDepends + config.get('buildDepends', []))
                print >>f, "Standards-Version: 3.9.3"
                print >>f, ""
                print >>f, "Package:",binaryName
                print >>f, "Architecture:",packageArchitecture
                writeDependency(f, "Pre-Depends", ["${misc:Pre-Depends}"] + config.get('binaryPreDepends', []))
-               writeDependency(f, "Depends", ["${shlibs:Depends}", "${misc:Depends}"] + config.get('binaryDepends', []))
+               writeDependency(f, "Depends", ["${shlibs:Depends}", "${misc:Depends}"] + buildSystem.binaryDepends +
+                       config.get('binaryDepends', []))
                writeDependency(f, "Recommends", config.get('binaryRecommends', []))
                writeDependency(f, "Provides", config.get('binaryProvides', [sourceName]))
                writeDependency(f, "Conflicts", config.get('binaryConflicts', []))
@@ -187,12 +220,7 @@ def createDebianFiles(config):
        # rules file: build system specific
        with open('debian/rules', 'w') as f:
                # get rule file for build system: may only touch auto_config and auto_clean rules and the dh options
-               if buildSystem == 'cmake':
-                       r = cmakeRules(config)
-               elif buildSystem == 'automake':
-                       r = automakeRules(config)
-               else:
-                       raise Exception("Invalid build system "+buildSystem)
+               r = buildSystem.ruleMaker(config)
                # global rules
                r.env["DEB_BUILD_OPTIONS"] = 'parallel='+str(parallelJobs)
                if not dbgPackage:
@@ -201,7 +229,7 @@ def createDebianFiles(config):
                        r.env["DEB_CXXFLAGS_APPEND"] = '-g0'
                r.dh += ['--parallel']
                if withPython2:
-                       r.dh += ['--with=python2']
+                       r.dhWith.add('python2')
                        r.rules['python2'] = ['dh_python2 --no-guessing-versions']
                r.rules['builddeb'] = [safeCall('dh_builddeb', "--destdir="+debDir)] # passing this gobally to dh results in weird problems (like stuff being installed there, and not in the package...)
                r.rules['auto_test'] = []