use a little configfile-parser instead of running it as python script

[auto-debuild.git] / auto_debuild.py

diff --git a/auto_debuild.py b/auto_debuild.py
index 61d7efc394e38d34e381e06ad3a16efa20012f52..b921d7cded6d5634a24ece1eb8081de4601a1a15 100755 (executable)
--- a/auto_debuild.py
+++ b/auto_debuild.py
@@ -2,7 +2,23 @@
 import os, shutil, stat, time, subprocess, sys
 from collections import OrderedDict
 
 import os, shutil, stat, time, subprocess, sys
 from collections import OrderedDict
 

-# some utility functions
+# a dict with some useful additional getters
+class AdvancedDict(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]
+       
+       def getint(self, name, default = None):
+               return int(self.getstr(name, default))
+       
+       def getbool(self, name, default = None):
+               val = self.getstr(name, default)
+               if isinstance(val, bool): return val # already a bool
+               return val.lower() in ('true', 'yes', 'on', '1')
+
+# create a safe-to-call shell command from the array

 def safeCall(*args):
        res = ""
        for arg in args:
 def safeCall(*args):
        res = ""
        for arg in args:


@@ -11,6 +27,32 @@ def safeCall(*args):
                res += "'"+arg+"'"
        return res
 
                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)
+# Lines starting with spaces are continuation lines
+def loadConfigFile(file):
+       import shlex
+       # read config file
+       with open(file) as file:
+               result = AdvancedDict()
+               curKey = None
+               for line in file:
+                       isCont = len(line) and line[0].isspace() # remember if we were a continuation line
+                       if isCont and curKey is None:
+                               raise Exception("Invalid config: Starting with continuation line")
+                       line = line.strip()
+                       if not len(line) or line.startswith("#"): continue # skip empty and comment lines
+                       if isCont:
+                               # continuation line
+                               result[curKey].append(shlex.split(line))
+                       else:
+                               # 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)
+       # add some convencience get functions
+       return result
+

 # representation of a build system
 class BuildSystem:
        def __init__(self, ruleMaker, buildDepends = [], binaryDepends = []):
 # representation of a build system
 class BuildSystem:
        def __init__(self, ruleMaker, buildDepends = [], binaryDepends = []):


@@ -55,7 +97,7 @@ class RulesFile:
 
 # rule-makers
 def cmakeRules(config):
 
 # rule-makers
 def cmakeRules(config):

-       buildDir = config.get('buildDir', 'build')
+       buildDir = config.getstr('buildDir', 'build')

        srcDir = os.getcwd()
        r = RulesFile()
        r.dh += ["--buildsystem=cmake", "--builddirectory="+buildDir] # dh parameters
        srcDir = os.getcwd()
        r = RulesFile()
        r.dh += ["--buildsystem=cmake", "--builddirectory="+buildDir] # dh parameters


@@ -98,13 +140,13 @@ def pythonRules(config):
 # build systems
 buildSystems = {
        'cmake': BuildSystem(cmakeRules, ["cmake"]),
 # build systems
 buildSystems = {
        'cmake': BuildSystem(cmakeRules, ["cmake"]),

-       'automake': BuildSystem(automakeRules, ["automake"]),
+       'automake': BuildSystem(automakeRules),

        'python': BuildSystem(pythonRules, ["python-setuptools"], ["${python:Depends}"]),
 }
 
 # utility functions
 def commandInBuildEnv(config, command):
        'python': BuildSystem(pythonRules, ["python-setuptools"], ["${python:Depends}"]),
 }
 
 # utility functions
 def commandInBuildEnv(config, command):

-       schroot = config.get('schroot')
+       schroot = config.getstr('schroot')

        if schroot is not None: command = ['schroot', '-c', schroot, '--'] + command
        return command
 
        if schroot is not None: command = ['schroot', '-c', schroot, '--'] + command
        return command
 


@@ -121,17 +163,17 @@ def writeDependency(f, name, list):
 
 # actual work functions
 def createDebianFiles(config):
 
 # actual work functions
 def createDebianFiles(config):

-       sourceName = config['sourceName']
-       binaryName = config.get('binaryName', sourceName+'-local')
-       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 = 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)
+       sourceName = config.getstr('sourceName')
+       binaryName = config.getstr('binaryName', sourceName+'-local')
+       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')
+       dbgPackage = config.getbool('dbgPackage', False)
+       parallelJobs = config.getint('parallelJobs', 2)
+       packageArchitecture = config.getstr('architecture', 'any')
+       withPython2 = config.getbool('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
        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


@@ -161,7 +203,7 @@ def createDebianFiles(config):
        # control file
        with open('debian/control', 'w') as f:
                print >>f, "Source:",sourceName
        # control file
        with open('debian/control', 'w') as f:
                print >>f, "Source:",sourceName

-               print >>f, "Section:",config.get('section', 'misc')
+               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, "Priority: extra"
                print >>f, "Maintainer: %s <%s>" % (name, email)
                writeDependency(f, 'Build-Depends', ["debhelper (>= 9)"] + buildSystem.buildDepends + config.get('buildDepends', []))


@@ -169,18 +211,24 @@ def createDebianFiles(config):
                print >>f, ""
                print >>f, "Package:",binaryName
                print >>f, "Architecture:",packageArchitecture
                print >>f, ""
                print >>f, "Package:",binaryName
                print >>f, "Architecture:",packageArchitecture

+               if 'binaryMultiArch' in config:
+                       print >>f, "Multi-Arch:",config.getstr('binaryMultiArch')

                writeDependency(f, "Pre-Depends", ["${misc:Pre-Depends}"] + config.get('binaryPreDepends', []))
                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', []))
                writeDependency(f, "Pre-Depends", ["${misc:Pre-Depends}"] + config.get('binaryPreDepends', []))
                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', []))

+               writeDependency(f, "Breaks", config.get('binaryBreaks', []) + config.get('binaryBreaksReplaces', []))
+               writeDependency(f, "Replaces", config.get('binaryReplaces', []) + config.get('binaryBreaksReplaces', []))

                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)))
                if dbgPackage:
                        print >>f, ""
                        print >>f, "Package:",binaryName+"-dbg"
                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)))
                if dbgPackage:
                        print >>f, ""
                        print >>f, "Package:",binaryName+"-dbg"

+                       print >>f, "Section: debug"
+                       print >>f, "Priority: extra"

                        print >>f, "Architecture:",packageArchitecture
                        writeDependency(f, "Depends", ["${misc:Depends}", binaryName+" (= ${binary:Version})"])
                        print >>f, "Description:",sourceName,"debug smbols (auto-debuild)"
                        print >>f, "Architecture:",packageArchitecture
                        writeDependency(f, "Depends", ["${misc:Depends}", binaryName+" (= ${binary:Version})"])
                        print >>f, "Description:",sourceName,"debug smbols (auto-debuild)"


@@ -198,7 +246,7 @@ def createDebianFiles(config):
                        print >>f, "#!/bin/sh"
                        print >>f, "set -e"
                        print >>f, 'if [ "$1" = "configure" ]; then'
                        print >>f, "#!/bin/sh"
                        print >>f, "set -e"
                        print >>f, 'if [ "$1" = "configure" ]; then'

-                       for alternative in config['alternatives']:
+                       for alternative in config.get('alternatives'):

                                print >>f, safeCall('update-alternatives', '--install', alternative['link'], alternative['name'], alternative['target'],
                                        str(alternative['priority']))
                        print >>f, 'fi'
                                print >>f, safeCall('update-alternatives', '--install', alternative['link'], alternative['name'], alternative['target'],
                                        str(alternative['priority']))
                        print >>f, 'fi'


@@ -210,7 +258,7 @@ def createDebianFiles(config):
                        print >>f, "#!/bin/sh"
                        print >>f, "set -e"
                        print >>f, 'if [ "$1" = "remove" ]; then'
                        print >>f, "#!/bin/sh"
                        print >>f, "set -e"
                        print >>f, 'if [ "$1" = "remove" ]; then'

-                       for alternative in config['alternatives']:
+                       for alternative in config.get('alternatives'):

                                print >>f, safeCall('update-alternatives', '--remove', alternative['name'], alternative['target'])
                        print >>f, 'fi'
                        print >>f, ''
                                print >>f, safeCall('update-alternatives', '--remove', alternative['name'], alternative['target'])
                        print >>f, 'fi'
                        print >>f, ''


@@ -237,13 +285,14 @@ def createDebianFiles(config):
                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) + " && " +
                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['binarySkipFiles']))
+                               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
                        r.rules['installdocs'] = [safeCall('dh_installdocs', '--link-doc='+binaryName)] # make the doc folder of the dbg package a symlink
                # wait after configuration?
                # for 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
                # wait after configuration?

-               if config.get('waitAfterConfig', False):
+               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

                        r.rules['auto_configure'].append("@"+safeCall('read', '-p', 'Configuration done. Hit "Enter" to build the package. ', 'DUMMY_VAR')) # if we run in dash, we need to tell it which variable to use for the result...
                # dump it to a file
                r.write(f)
                        r.rules['auto_configure'].append("@"+safeCall('read', '-p', 'Configuration done. Hit "Enter" to build the package. ', 'DUMMY_VAR')) # if we run in dash, we need to tell it which variable to use for the result...
                # dump it to a file
                r.write(f)


@@ -262,10 +311,8 @@ def buildDebianPackage(config):
 # if we are called directly as script
 if __name__ == "__main__":
        try:
 # if we are called directly as script
 if __name__ == "__main__":
        try:

-               import imp

                # get config
                # get config

-               config = imp.load_source('config', 'auto-debuild.conf').__dict__
-               os.remove('auto-debuild.confc')
+               config = loadConfigFile('auto-debuild.conf')

                # generate debian files
                if os.path.exists('debian'):
                        if raw_input("A debian folder already exists, to you want to remove it (y/N)? ").lower() != "y":
                # generate debian files
                if os.path.exists('debian'):
                        if raw_input("A debian folder already exists, to you want to remove it (y/N)? ").lower() != "y":