pass the rules file to the build system as argument, and pre-fill it with the default...
[auto-debuild.git] / auto_debuild.py
index 7523e537117c824dde3d33fb0f944c35baa92f2f..441302c0f19d6a71670e9850fa0f870ad4dee917 100755 (executable)
@@ -1,5 +1,22 @@
 #!/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 which can convert types and handle one-element lists like their single member
@@ -33,7 +50,6 @@ def safeCall(*args):
 # 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:
@@ -103,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),
@@ -114,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
@@ -132,16 +145,24 @@ def automakeRules(config):
                        safeCall(*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()
+def pythonRules(r, config):
        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(config):
+       r = RulesFile()
+       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
@@ -149,6 +170,8 @@ buildSystems = {
        'cmake': BuildSystem(cmakeRules, ["cmake"]),
        'automake': BuildSystem(automakeRules),
        'python': BuildSystem(pythonRules, ["python-setuptools"], ["${python:Depends}"]),
+       'makefile': BuildSystem(makefileRules),
+       'none': BuildSystem(noneRules),
 }
 
 # utility functions
@@ -256,8 +279,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#'
@@ -268,7 +291,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#'
@@ -276,8 +300,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:
@@ -289,12 +317,10 @@ def createDebianFiles(config):
                        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'] = []
                # 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')))
+                       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')))
                # for debug packages
                if dbgPackage:
                        r.rules['strip'] = [safeCall('dh_strip', '--dbg-package='+binaryName+"-dbg")] # put debug files in appropriate package
@@ -313,7 +339,7 @@ def createDebianFiles(config):
 def buildDebianPackage(config):
        if not isinstance(config, ConfigDict):
                config = ConfigDict(config)
-       commands = ['dpkg-checkbuilddeps', 'debian/rules clean', 'debian/rules build', 'fakeroot debian/rules binary', 'debian/rules clean']
+       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