add support for installing additional files

[auto-debuild.git] / auto_debuild.py

diff --git a/auto_debuild.py b/auto_debuild.py
index eda72e3a5f366b478077c42a1b07907f8ad87933..c2744125659bf3071c6bbbb6e97767f97989b835 100755 (executable)
--- a/auto_debuild.py
+++ b/auto_debuild.py
@@ -2,18 +2,36 @@
 import os, stat, time, subprocess, sys
 from collections import OrderedDict
 
 import os, stat, time, subprocess, sys
 from collections import OrderedDict
 

+# some utility functions
+def safeCall(args):
+       res = ""
+       for arg in args:
+               assert arg.find("'") < 0 # ' is not supported
+               if len(res): res += " "
+               res += "'"+arg+"'"
+       return res
+

 # abstract representation of rules file
 class RulesFile:
        def __init__(self):
 # abstract representation of rules file
 class RulesFile:
        def __init__(self):

-               self.env = []
+               self.env = {}

                self.dh = []
                self.rules = OrderedDict()
        
                self.dh = []
                self.rules = OrderedDict()
        

+       def env2str(self):
+               res = ""
+               for name in self.env: # we rely on the name being sane (i.e., no special characters)
+                       val = self.env[name]
+                       assert val.find("'") < 0 # ' is not supported
+                       if len(res): res += " "
+                       res += name+"='"+val+"'"
+               return res
+

        def write(self, f):
                print >>f, "#!/usr/bin/make -f"
                print >>f, ""
                print >>f, "%:"
        def write(self, f):
                print >>f, "#!/usr/bin/make -f"
                print >>f, ""
                print >>f, "%:"

-               print >>f, '\t'+' '.join(self.env)+' dh $@',' '.join(self.dh)
+               print >>f, '\t'+self.env2str()+' dh $@ '+safeCall(self.dh)

                for rule in self.rules:
                        print >>f, ""
                        print >>f, "override_dh_"+rule+":"
                for rule in self.rules:
                        print >>f, ""
                        print >>f, "override_dh_"+rule+":"


@@ -22,13 +40,16 @@ class RulesFile:
 
 # build-system specific part of rules file
 def cmakeRules(config):
 
 # build-system specific part of rules file
 def cmakeRules(config):

+       buildDir = config.get('buildDir', 'build.dir') # "build" is not a good idea, as that's also the name of a target...
+       srcDir = os.getcwd()

        r = RulesFile()
        r = RulesFile()

-       r.dh += ["--buildsystem=cmake", "--builddirectory=build.dir"] # dh parameters: "build" is not a good idea, as that's also the name of a target...
+       r.dh += ["--buildsystem=cmake", "--builddirectory="+buildDir] # dh parameters

        r.rules['auto_configure'] = [
        r.rules['auto_configure'] = [

-               'mkdir -p build.dir',
-               "cd build.dir && cmake .. -DCMAKE_INSTALL_PREFIX=/usr "+' '.join(config.get('cmakeParameters', []))
+               safeCall(["mkdir", "-p", buildDir]),
+               safeCall(["cd", buildDir]) + " && " +
+                 safeCall(["cmake", srcDir, "-DCMAKE_INSTALL_PREFIX=/usr"] + config.get('cmakeParameters', []))

        ]
        ]

-       r.rules['auto_clean'] = ['rm -f build.dir/CMakeCache.txt'] # clean old cmake cache
+       r.rules['auto_clean'] = [safeCall(['rm', '-f', os.path.join(buildDir, 'CMakeCache.txt')])] # clean old cmake cache

        return r
 
 def automakeRules(config):
        return r
 
 def automakeRules(config):


@@ -37,13 +58,13 @@ def automakeRules(config):
        r.rules['auto_configure'] = [
                'BUILD_TYPE=$$(dpkg-architecture -qDEB_BUILD_GNU_TYPE) && ' + # doing the expansion beforehand ensures that we cancel if it fails
                'MULTIARCH=$$(dpkg-architecture -qDEB_BUILD_MULTIARCH) && '+
        r.rules['auto_configure'] = [
                'BUILD_TYPE=$$(dpkg-architecture -qDEB_BUILD_GNU_TYPE) && ' + # doing the expansion beforehand ensures that we cancel if it fails
                'MULTIARCH=$$(dpkg-architecture -qDEB_BUILD_MULTIARCH) && '+

-                       './configure --build=$$BUILD_TYPE ' +
-                       '--prefix=/usr --includedir=/usr/include --mandir=/usr/share/man --infodir=/usr/share/info ' +
+                       './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 '+
                        '--libdir=/usr/lib/$$MULTIARCH --libexecdir=/usr/lib/$$MULTIARCH '+

-                       '--sysconfdir=/etc --localstatedir=/var ' +
-                       ' '.join(config.get('automakeParameters', []))
+                       '--sysconfdir=/etc --localstatedir=/var '+
+                       safeCall(config.get('automakeParameters', []))

        ]
        ]

-       r.rules['auto_clean'] = ['rm -f config.status'] # do not re-use old configuration
+       r.rules['auto_clean'] = ['rm -f config.status'] # do not re-use old configuration (no need for escaping here, obviously)

        return r
 
 # utility functions
        return r
 
 # utility functions


@@ -73,13 +94,15 @@ def createDebianFiles(config):
        buildSystem = config['buildSystem']
        version = config['version']
        dbgPackage = config.get('dbgPackage', False)
        buildSystem = config['buildSystem']
        version = config['version']
        dbgPackage = config.get('dbgPackage', False)

+       parallelJobs = int(config.get('parallelJobs', 2))

        packageArchitecture = config.get('architecture', 'any')
        # we return the list of files generated, so we need to know the architecture
        arch = getArchitecture(config)
        files = []
        # create folders
        packageArchitecture = config.get('architecture', 'any')
        # we return the list of files generated, so we need to know the architecture
        arch = getArchitecture(config)
        files = []
        # create folders

-       if not os.path.exists('debian'): os.mkdir('debian')
-       if not os.path.exists('debian/source'): os.mkdir('debian/source')
+       if os.path.exists('debian'): raise Exception('debian folder already exists?')
+       os.mkdir('debian')
+       os.mkdir('debian/source')

        if not os.path.exists(debDir): os.mkdir(debDir)
        # source format file
        with open('debian/source/format', 'w') as f:
        if not os.path.exists(debDir): os.mkdir(debDir)
        # source format file
        with open('debian/source/format', 'w') as f:


@@ -123,6 +146,10 @@ 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)))
                        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)))

+       # install file
+       with open('debian/'+binaryName+'.install', 'w') as f:
+               for line in config.get('binaryInstall', []):
+                       print >>f, line

        # 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
        # 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


@@ -133,16 +160,23 @@ def createDebianFiles(config):
                else:
                        raise Exception("Invalid build system "+buildSystem)
                # global rules
                else:
                        raise Exception("Invalid build system "+buildSystem)
                # global rules

-               r.env += ["DEB_BUILD_OPTIONS='parallel=2'"]
-               if not dbgPackage: r.env += ["DEB_CFLAGS_APPEND='-g0'", "DEB_CXXFLAGS_APPEND='-g0'"] # disable debug information
+               r.env["DEB_BUILD_OPTIONS"] = 'parallel='+str(parallelJobs)
+               if not dbgPackage:
+                       # disable debug information
+                       r.env["DEB_CFLAGS_APPEND"] = '-g0'
+                       r.env["DEB_CXXFLAGS_APPEND"] = '-g0'

                r.dh += ['--parallel']
                r.dh += ['--parallel']

-               r.rules['builddeb'] = ['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['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'] = []
                r.rules['auto_test'] = []

-               r.rules['auto_install'] = ['dh_auto_install --destdir=debian/'+binaryName] # install everything into the binary package
+               # 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['binarySkipFiles']))

                # for debug packages
                if dbgPackage:
                # for debug packages
                if dbgPackage:

-                       r.rules['strip'] = ['dh_strip --dbg-package='+binaryName+"-dbg"] # put debug files in appropriate package
-                       r.rules['installdocs'] = ['dh_installdocs --link-doc='+binaryName] # make the doc folder of the dbg package a symlink
+                       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

                # dump it to a file
                r.write(f)
        mode = os.stat('debian/rules').st_mode
                # dump it to a file
                r.write(f)
        mode = os.stat('debian/rules').st_mode


@@ -154,28 +188,28 @@ def buildDebianPackage(config):
        commands = ['dpkg-checkbuilddeps', 'debian/rules clean', 'debian/rules build', 'fakeroot debian/rules binary', 'debian/rules clean']
        command = ['nice', 'bash', '-c', ' && '.join(commands)]
        subprocess.check_call(commandInBuildEnv(config, command))
        commands = ['dpkg-checkbuilddeps', 'debian/rules clean', 'debian/rules build', 'fakeroot debian/rules binary', 'debian/rules clean']
        command = ['nice', 'bash', '-c', ' && '.join(commands)]
        subprocess.check_call(commandInBuildEnv(config, command))

+       shutil.rmtree('debian') # it only contains what we just created

 
 

-# all at once
-def createAndInstall(config, overwriteCheck = False):
+###################################################################
+# if we are called directly as script
+if __name__ == "__main__":
+       import imp, shutil
+       # get config
+       config = imp.load_source('config', 'auto-debuild.conf').__dict__
+       os.remove('auto-debuild.confc')

        # generate debian files
        # 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":
+                       sys.exit(1)
+               shutil.rmtree('debian')

        files = createDebianFiles(config)
        # check if a file is overwritten
        files = createDebianFiles(config)
        # check if a file is overwritten

-       if overwriteCheck:
-               for file in files:
-                       if os.path.exists(file):
-                               if raw_input("Do you want to overwrite %s (y/N)? " % file).lower() != "y":
-                                       sys.exit(1)
+       for file in files:
+               if os.path.exists(file):
+                       if raw_input("Do you want to overwrite %s (y/N)? " % file).lower() != "y":
+                               sys.exit(1)

        # run compilation
        buildDebianPackage(config)
        # install files
        print "Installing created deb files..."
        subprocess.check_call(['sudo', 'dpkg', '--install'] + files)
        # run compilation
        buildDebianPackage(config)
        # install files
        print "Installing created deb files..."
        subprocess.check_call(['sudo', 'dpkg', '--install'] + files)

-
-# if we are called directly as script
-if __name__ == "__main__":
-       # get config
-       import imp
-       config = imp.load_source('config', 'debian/auto-debuild.conf').__dict__
-       os.remove('debian/auto-debuild.confc')
-       # and go for it
-       createAndInstall(config, overwriteCheck=True)