Don't permanently create debian/ folder, and move auto-debuild.conf out of it

[auto-debuild.git] / auto_debuild.py

diff --git a/auto_debuild.py b/auto_debuild.py
index 0db538871e70e43fb814c2bfcb0c506ffff05c87..57ee13bb86854d9134be05ac90583d39ff6329d4 100755 (executable)
--- a/auto_debuild.py
+++ b/auto_debuild.py
@@ -1,19 +1,37 @@
 #!/usr/bin/python
 #!/usr/bin/python

-import os, stat, time, subprocess, sys
+import os, shutil, stat, time, subprocess, sys

 from collections import OrderedDict
 
 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,29 +40,31 @@ 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):
        r = RulesFile()
        r.dh += ["--buildsystem=autoconf"]
        r.rules['auto_configure'] = [
        return r
 
 def automakeRules(config):
        r = RulesFile()
        r.dh += ["--buildsystem=autoconf"]
        r.rules['auto_configure'] = [

-               '@dpkg-architecture -qDEB_BUILD_GNU_TYPE > /dev/null', # make sure this command runs successfully (and hope it does so again)
-               '@dpkg-architecture -qDEB_BUILD_MULTIARCH > /dev/null', # make sure this command runs successfully (and hope it does so again)
-               './configure --build=$$(dpkg-architecture -qDEB_BUILD_GNU_TYPE) ' +
-                       '--prefix=/usr --includedir=/usr/include --mandir=/usr/share/man --infodir=/usr/share/info ' +
-                       '--libdir=/usr/lib/$$(dpkg-architecture -qDEB_BUILD_MULTIARCH) '+
-                       '--libexecdir=/usr/lib/$$(dpkg-architecture -qDEB_BUILD_MULTIARCH) '+
-                       '--sysconfdir=/etc --localstatedir=/var ' +
-                       ' '.join(config.get('automakeParameters', []))
+               '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 '+ # 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', []))

        ]
        ]

-       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


@@ -60,8 +80,9 @@ def getArchitecture(config):
        if p.returncode != 0: raise Exception("Querying dpkg for the architecture failed")
        return res[0:len(res)-1] # chop of the \n at the end
 
        if p.returncode != 0: raise Exception("Querying dpkg for the architecture failed")
        return res[0:len(res)-1] # chop of the \n at the end
 

-def writeDebList(list):
-       return ', '.join(list)
+def writeDependency(f, name, list):
+       if len(list):
+               print >>f, name+": "+', '.join(list)

 
 # actual work functions
 def createDebianFiles(config):
 
 # actual work functions
 def createDebianFiles(config):


@@ -73,12 +94,17 @@ 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')
        packageArchitecture = config.get('architecture', 'any')

-       # we return the list of files generated
+       # we return the list of files generated, so we need to know the architecture

        arch = getArchitecture(config)
        files = []
        arch = getArchitecture(config)
        files = []

+       # create folders
+       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
        # source format file

-       if not os.path.exists('debian/source'): os.mkdir('debian/source')

        with open('debian/source/format', 'w') as f:
                print >>f, "3.0 (native)"
        # compat file
        with open('debian/source/format', 'w') as f:
                print >>f, "3.0 (native)"
        # compat file


@@ -100,13 +126,15 @@ def createDebianFiles(config):
                print >>f, "Section:",config.get('section', 'misc')
                print >>f, "Priority: extra"
                print >>f, "Maintainer: %s <%s>" % (name, email)
                print >>f, "Section:",config.get('section', 'misc')
                print >>f, "Priority: extra"
                print >>f, "Maintainer: %s <%s>" % (name, email)

-               print >>f, "Build-Depends:",writeDebList(["debhelper (>= 9)"] + config.get('buildDepends', []))
+               writeDependency(f, 'Build-Depends', ["debhelper (>= 9)"] + config.get('buildDepends', []))

                print >>f, "Standards-Version: 3.9.3"
                print >>f, ""
                print >>f, "Package:",binaryName
                print >>f, "Architecture:",packageArchitecture
                print >>f, "Standards-Version: 3.9.3"
                print >>f, ""
                print >>f, "Package:",binaryName
                print >>f, "Architecture:",packageArchitecture

-               print >>f, "Depends:",writeDebList(["${shlibs:Depends}", "${misc:Depends}"] + config.get('binaryDepends', []))
-               print >>f, "Provides:",writeDebList(config.get('binaryProvides', [sourceName]))
+               writeDependency(f, "Pre-Depends", ["${misc:Pre-Depends}"] + config.get('binaryPreDepends', []))
+               writeDependency(f, "Depends", ["${shlibs:Depends}", "${misc:Depends}"] + config.get('binaryDepends', []))
+               writeDependency(f, "Recommends", config.get('binaryRecommends', []))
+               writeDependency(f, "Provides", config.get('binaryProvides', [sourceName]))

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


@@ -114,7 +142,7 @@ def createDebianFiles(config):
                        print >>f, ""
                        print >>f, "Package:",binaryName+"-dbg"
                        print >>f, "Architecture:",packageArchitecture
                        print >>f, ""
                        print >>f, "Package:",binaryName+"-dbg"
                        print >>f, "Architecture:",packageArchitecture

-                       print >>f, "Depends:",writeDebList(["${misc:Depends}", binaryName+" (= ${binary:Version})"])
+                       writeDependency(f, "Depends", ["${misc:Depends}", binaryName+" (= ${binary:Version})"])

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


@@ -128,16 +156,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"]
-                       r.rules['installdocs'] = ['dh_installdocs --link-doc='+binaryName]
+                       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


@@ -147,22 +182,31 @@ def createDebianFiles(config):
 
 def buildDebianPackage(config):
        commands = ['dpkg-checkbuilddeps', 'debian/rules clean', 'debian/rules build', 'fakeroot debian/rules binary', 'debian/rules clean']
 
 def buildDebianPackage(config):
        commands = ['dpkg-checkbuilddeps', 'debian/rules clean', 'debian/rules build', 'fakeroot debian/rules binary', 'debian/rules clean']

-       command = ['bash', '-c', ' && '.join(commands)]
+       command = ['nice', 'bash', '-c', ' && '.join(commands)]

        subprocess.check_call(commandInBuildEnv(config, command))
        subprocess.check_call(commandInBuildEnv(config, command))

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

 
 

-# if we are called directly as script
-if __name__ == "__main__":
+# all at once
+def createAndInstall(config, overwriteCheck = False):

        # generate debian files
        # generate debian files

-       import imp
-       config = imp.load_source('config', 'debian/auto-debuild.conf').__dict__
-       os.remove('debian/auto-debuild.confc')

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

-       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)
+       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)

        # run compilation
        buildDebianPackage(config)
        # install files
        # run compilation
        buildDebianPackage(config)
        # install files

+       print "Installing created deb files..."

        subprocess.check_call(['sudo', 'dpkg', '--install'] + 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', 'auto-debuild.conf').__dict__
+       os.remove('auto-debuild.confc')
+       # and go for it
+       createAndInstall(config, overwriteCheck=True)