Fix --docdir in automake; remove python build system; do not attempt to fix python...
[auto-debuild.git] / auto_debuild.py
index f9f0672244dde929712cb789ba8da3f8a33f6ea8..f1a3e84856e4edfe3e0340b1747749e50fd837cf 100755 (executable)
@@ -1,14 +1,34 @@
 #!/usr/bin/python
-import os, shutil, stat, time, subprocess, sys
+# auto-debuild - Automatic Generation of Debian Packages
+# Copyright (C) 2012 Ralf Jung <post@ralfj.de>
+#
+# 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
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+
+import os, shutil, stat, time, subprocess, sys, shlex
 from collections import OrderedDict
 
-# a dict with some useful additional getters
-class AdvancedDict(dict):
+# a dict with some useful additional getters which can convert types and handle one-element lists like their single member
+class ConfigDict(dict):
        def getstr(self, name, default = None):
                if not name in self: return default
                val = self[name]
-               if len(val) != 1: raise Exception('%s is a list, but it should not' % name)
-               return val[0]
+               if isinstance(val, list):
+                       if len(val) != 1: raise Exception('%s is a list, but it should not' % name)
+                       return val[0]
+               else:
+                       return val
        
        def getint(self, name, default = None):
                return int(self.getstr(name, default))
@@ -27,14 +47,13 @@ def safeCall(*args):
                res += "'"+arg+"'"
        return res
 
-# Load a section-less config file: maps parameter names to strings or lists of strings (which are comma-separated or in separate lines)
+# Load a section-less config file: maps parameter names to space-separated lists of strings (with shell quotation)
 # Lines starting with spaces are continuation lines
 def loadConfigFile(file):
-       import shlex
        # read config file
        linenr = 0
        with open(file) as file:
-               result = AdvancedDict()
+               result = ConfigDict()
                curKey = None
                for line in file:
                        linenr += 1
@@ -51,8 +70,7 @@ def loadConfigFile(file):
                                        # option line
                                        pos = line.index("=") # will raise exception when substring is not found
                                        curKey = line[:pos].strip()
-                                       value = line[pos+1:]
-                                       result[curKey] = shlex.split(value)
+                                       result[curKey] = shlex.split(line[pos+1:]) # shlex.split also strips
                        except Exception:
                                raise Exception("Invalid config, line %d: Error parsing line (quoting issue?)" % linenr)
        # add some convencience get functions
@@ -101,10 +119,9 @@ class RulesFile:
                                print >>f, "\t"+line
 
 # rule-makers
-def cmakeRules(config):
+def cmakeRules(r, config):
        buildDir = config.getstr('buildDir', 'build')
        srcDir = os.getcwd()
-       r = RulesFile()
        r.dh += ["--buildsystem=cmake", "--builddirectory="+buildDir] # dh parameters
        r.rules['auto_configure'] = [
                safeCall("mkdir", "-p", buildDir),
@@ -112,13 +129,11 @@ def cmakeRules(config):
                  safeCall("cmake", srcDir, "-DCMAKE_INSTALL_PREFIX=/usr", *config.get('cmakeParameters', []))
        ]
        r.rules['auto_clean'] = [safeCall('rm', '-f', os.path.join(buildDir, 'CMakeCache.txt'))] # clean old cmake cache
-       return r
 
-def automakeRules(config):
+def automakeRules(r, config):
        # "build" is what we are building *on*, and "host" is what we are building *for* (and GNU is weird...)
        # also, we don't really support cross-building... ;-) (to do, we'd have to write shell code that checks whether BUILD_GNU_TYPE
        #  and HOST_GNU_TYPE are equal, and if they are not, add a --host parameter)
-       r = RulesFile()
        r.dh += ["--buildsystem=autoconf"]
        r.rules['auto_configure'] = [
                'BUILD_TYPE=$$(dpkg-architecture -qDEB_BUILD_GNU_TYPE) && ' + # doing the expansion beforehand ensures that we cancel if it fails
@@ -126,27 +141,26 @@ def automakeRules(config):
                        './configure --build=$$BUILD_TYPE '+ # do the escape manually here so we can use the variables (there's no user-controlled string in here anyway)
                        '--prefix=/usr --includedir=/usr/include --mandir=/usr/share/man --infodir=/usr/share/info '+
                        '--libdir=/usr/lib/$$MULTIARCH --libexecdir=/usr/lib/$$MULTIARCH '+
-                       '--sysconfdir=/etc --localstatedir=/var '+
-                       safeCall(*config.get('automakeParameters', []))
+                       safeCall('--docdir=/usr/share/doc/'+config['binaryName'], '--sysconfdir=/etc', '--localstatedir=/var', *config.get('automakeParameters', []))
        ]
        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'
-       ]
+def makefileRules(r, config):
+       r.dh += ["--buildsystem=makefile"]
+
+def noneRules(r, config):
+       r.dh += ["--buildsystem=makefile"] # makefile does the least possible harm
+       r.rules['auto_configure'] = []
+       r.rules['auto_build'] = []
+       r.rules['auto_clean'] = []
        return r
 
 # build systems
 buildSystems = {
        'cmake': BuildSystem(cmakeRules, ["cmake"]),
        'automake': BuildSystem(automakeRules),
-       'python': BuildSystem(pythonRules, ["python-setuptools"], ["${python:Depends}"]),
+       'makefile': BuildSystem(makefileRules),
+       'none': BuildSystem(noneRules),
 }
 
 # utility functions
@@ -168,19 +182,27 @@ def writeDependency(f, name, list):
 
 # actual work functions
 def createDebianFiles(config):
+       if not isinstance(config, ConfigDict):
+               config = ConfigDict(config)
        sourceName = config.getstr('sourceName')
        binaryName = config.getstr('binaryName', sourceName+'-local')
+       config['binaryName'] = binaryName # make it usable by build systems
        name = config.getstr('name', os.getenv('USER')) # os.getlogin() fails in minimal chroots
        email = config.getstr('email', os.getenv('USER')+'@'+os.uname()[1]) # user@hostname
        debDir = os.path.expanduser(config.getstr('debDir'))
        buildSystem = buildSystems[config.getstr('buildSystem')] # get the data immediately
-       version = config.getstr('version')
+       version = config.getstr('version') # version name excluding epoch (used for filenames)
+       fullVersion = str(config.getint('epoch'))+':'+version if 'epoch' in config else version # version name including epoch
        dbgPackage = config.getbool('dbgPackage', False)
        parallelJobs = config.getint('parallelJobs', 2)
        packageArchitecture = config.getstr('architecture', 'any')
        withPython2 = config.getbool('withPython2', False)
+       withAutoreconf = config.getbool('withAutoreconf', False)
+       # add some build dependencies (a bit hacky adding it to the build system...)
        if withPython2:
-               buildSystem.binaryDepends.append("${python:Depends}") # HACK, but it works: make sure dependencies on binary are added
+               buildSystem.binaryDepends.append("${python:Depends}")
+       if withAutoreconf:
+               buildSystem.binaryDepends.append("dh-autoreconf")
        # we return the list of files generated, so we need to know the architecture
        arch = getArchitecture(config)
        files = []
@@ -200,19 +222,21 @@ def createDebianFiles(config):
                print >>f, "Auto-generated by auto-debuild, not suited for distribution"
        # changelog file
        with open('debian/changelog', 'w') as f:
-               print >>f, sourceName,"("+version+")","UNRELEASED; urgency=low"
+               print >>f, sourceName,"("+fullVersion+")","UNRELEASED; urgency=low"
                print >>f, ""
                print >>f, "  * Auto-generated by auto-debuild"
                print >>f, ""
                print >>f, " --",name,"<"+email+">  "+time.strftime('%a, %d %b %Y %H:%M:%S %z')
        # control file
        with open('debian/control', 'w') as f:
+               # source package
                print >>f, "Source:",sourceName
                print >>f, "Section:",config.getstr('section', 'misc')
                print >>f, "Priority: extra"
                print >>f, "Maintainer: %s <%s>" % (name, email)
                writeDependency(f, 'Build-Depends', ["debhelper (>= 9)"] + buildSystem.buildDepends + config.get('buildDepends', []))
                print >>f, "Standards-Version: 3.9.3"
+               # main binary package
                print >>f, ""
                print >>f, "Package:",binaryName
                print >>f, "Architecture:",packageArchitecture
@@ -229,6 +253,7 @@ def createDebianFiles(config):
                print >>f, "Description:",sourceName,"(auto-debuild)"
                print >>f, " Package auto-generated by auto-debuild."
                files.append(os.path.join(debDir, "%s_%s_%s.deb" % (binaryName, version, arch)))
+               # debug package
                if dbgPackage:
                        print >>f, ""
                        print >>f, "Package:",binaryName+"-dbg"
@@ -239,6 +264,17 @@ def createDebianFiles(config):
                        print >>f, "Description:",sourceName,"debug smbols (auto-debuild)"
                        print >>f, " Package containing debug symbols for "+sourceName+", auto-generated by auto-debuild."
                        files.append(os.path.join(debDir, "%s-dbg_%s_%s.deb" % (binaryName, version, arch)))
+               # shim packages
+               for shim in config.get('binaryShims', []):
+                       print >>f, ""
+                       print >>f, "Package:",shim
+                       print >>f, "Section:",config.getstr('section', 'misc')
+                       print >>f, "Priority: extra"
+                       print >>f, "Architecture:",packageArchitecture
+                       writeDependency(f, "Depends", ["${misc:Depends}", binaryName+" (= ${binary:Version})"])
+                       print >>f, "Description:",sourceName,"shim for",shim,"(auto-debuild)"
+                       print >>f, " Package pretending to be "+shim+", auto-generated by auto-debuild."
+                       files.append(os.path.join(debDir, "%s_%s_%s.deb" % (shim, version, arch)))
        # install file
        with open('debian/'+binaryName+'.install', 'w') as f:
                for line in config.get('binaryInstallFiles', []):
@@ -252,8 +288,8 @@ def createDebianFiles(config):
                        print >>f, "set -e"
                        print >>f, 'if [ "$1" = "configure" ]; then'
                        for alternative in config.get('alternatives'):
-                               print >>f, safeCall('update-alternatives', '--install', alternative['link'], alternative['name'], alternative['target'],
-                                       str(alternative['priority']))
+                               alternative = shlex.split(alternative)
+                               print >>f, safeCall('update-alternatives', '--install', alternative[0], alternative[1], alternative[2], alternative[3])
                        print >>f, 'fi'
                        print >>f, ''
                        print >>f, '#DEBHELPER#'
@@ -264,7 +300,8 @@ def createDebianFiles(config):
                        print >>f, "set -e"
                        print >>f, 'if [ "$1" = "remove" ]; then'
                        for alternative in config.get('alternatives'):
-                               print >>f, safeCall('update-alternatives', '--remove', alternative['name'], alternative['target'])
+                               alternative = shlex.split(alternative)
+                               print >>f, safeCall('update-alternatives', '--remove', alternative[1], alternative[2])
                        print >>f, 'fi'
                        print >>f, ''
                        print >>f, '#DEBHELPER#'
@@ -272,8 +309,12 @@ def createDebianFiles(config):
                        print >>f, 'exit 0'
        # 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
-               r = buildSystem.ruleMaker(config)
+               # pre-fill rule file with our global defaults
+               r = RulesFile()
+               r.rules['auto_test'] = []
+               r.rules['auto_install'] = [safeCall('dh_auto_install', '--destdir=debian/'+binaryName)] # install everything into the binary package
+               # patch rule file for build system: may only touch auto_* rules and the dh options
+               buildSystem.ruleMaker(r, config)
                # global rules
                r.env["DEB_BUILD_OPTIONS"] = 'parallel='+str(parallelJobs)
                if not dbgPackage:
@@ -283,18 +324,19 @@ def createDebianFiles(config):
                r.dh += ['--parallel']
                if withPython2:
                        r.dhWith.add('python2')
-                       r.rules['python2'] = ['dh_python2 --no-guessing-versions']
+                       r.rules['python2'] = ['dh_python2 --no-guessing-versions --no-shebang-rewrite']
+               if withAutoreconf:
+                       r.dhWith.add('autoreconf')
                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'] = []
                # installation rule
-               r.rules['auto_install'] = [safeCall('dh_auto_install', '--destdir=debian/'+binaryName)] # install everything into the binary package
                if 'binarySkipFiles' in config:
-                       r.rules['auto_install'].append(safeCall('cd', 'debian/'+binaryName) + " && " +
-                               safeCall('rm', *config.get('binarySkipFiles')))
-               # for debug packages
+                       if not 'auto_install' in r.rules: r.rules['auto_install'] = ['dh_auto_install'] # make sure there is an override
+                       r.rules['auto_install'].append(safeCall('cd', 'debian/'+binaryName) + " && " + safeCall('rm', *config.get('binarySkipFiles')))
+               # debug packages
                if dbgPackage:
                        r.rules['strip'] = [safeCall('dh_strip', '--dbg-package='+binaryName+"-dbg")] # put debug files in appropriate package
-                       r.rules['installdocs'] = [safeCall('dh_installdocs', '--link-doc='+binaryName)] # make the doc folder of the dbg package a symlink
+               # make the doc folder of the other packages a symlink (dbg, shims)
+               r.rules['installdocs'] = [safeCall('dh_installdocs', '--link-doc='+binaryName)]
                # wait after configuration?
                if config.getbool('waitAfterConfig', False):
                        if not 'auto_configure' in r.rules: r.rules['auto_configure'] = ['dh_auto_configure'] # make sure there is an override
@@ -307,10 +349,12 @@ def createDebianFiles(config):
        return files
 
 def buildDebianPackage(config):
-       commands = ['dpkg-checkbuilddeps', 'debian/rules clean', 'debian/rules build', 'fakeroot debian/rules binary', 'debian/rules clean']
+       if not isinstance(config, ConfigDict):
+               config = ConfigDict(config)
+       commands = ['dpkg-checkbuilddeps', 'debian/rules clean', 'debian/rules build', 'fakeroot debian/rules binary']
        command = ['bash', '-c', ' && '.join(commands)] # make it all one command, so we don't have to open and close the chroot too often
        subprocess.check_call(commandInBuildEnv(config, command))
-       shutil.rmtree('debian') # it only contains what we just created
+       shutil.rmtree('debian') # cleanup: the debian folder only contains what we just created
 
 ###################################################################
 # if we are called directly as script