add support for specifying conflicts

[auto-debuild.git] / auto_debuild.py

diff --git a/auto_debuild.py b/auto_debuild.py
index 57ee13bb86854d9134be05ac90583d39ff6329d4..c7a762854abff687b89a5a24a8b1a28ed45411df 100755 (executable)
--- a/auto_debuild.py
+++ b/auto_debuild.py
@@ -3,7 +3,7 @@ import os, shutil, stat, time, subprocess, sys
 from collections import OrderedDict
 
 # some utility functions
 from collections import OrderedDict
 
 # some utility functions

-def safeCall(args):
+def safeCall(*args):

        res = ""
        for arg in args:
                assert arg.find("'") < 0 # ' is not supported
        res = ""
        for arg in args:
                assert arg.find("'") < 0 # ' is not supported


@@ -30,8 +30,10 @@ class RulesFile:
        def write(self, f):
                print >>f, "#!/usr/bin/make -f"
                print >>f, ""
        def write(self, f):
                print >>f, "#!/usr/bin/make -f"
                print >>f, ""

-               print >>f, "%:"
-               print >>f, '\t'+self.env2str()+' dh $@ '+safeCall(self.dh)
+               print >>f, ".PHONY: build" # there may be a directory called "build"
+               print >>f, ""
+               print >>f, "build %:" # need to mention "build" here again explicitly
+               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+":"


@@ -40,29 +42,32 @@ 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...
+       buildDir = config.get('buildDir', 'build')

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

-               safeCall(["mkdir", "-p", buildDir]),
-               safeCall(["cd", buildDir]) + " && " +
-                 safeCall(["cmake", srcDir, "-DCMAKE_INSTALL_PREFIX=/usr"] + config.get('cmakeParameters', []))
+               safeCall("mkdir", "-p", buildDir),
+               safeCall("cd", buildDir) + " && " +
+                 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
+       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):

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

-               'MULTIARCH=$$(dpkg-architecture -qDEB_BUILD_MULTIARCH) && '+
+               'MULTIARCH=$$(dpkg-architecture -qDEB_HOST_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 '+
                        './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(*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
        ]
        r.rules['auto_clean'] = ['rm -f config.status'] # do not re-use old configuration (no need for escaping here, obviously)
        return r


@@ -74,7 +79,7 @@ def commandInBuildEnv(config, command):
        return command
 
 def getArchitecture(config):
        return command
 
 def getArchitecture(config):

-       cmd = commandInBuildEnv(config, ['dpkg-architecture', '-qDEB_BUILD_ARCH'])
+       cmd = commandInBuildEnv(config, ['dpkg-architecture', '-qDEB_HOST_ARCH'])

        p = subprocess.Popen(cmd, stdout=subprocess.PIPE)
        res = p.communicate()[0] # get only stdout
        if p.returncode != 0: raise Exception("Querying dpkg for the architecture failed")
        p = subprocess.Popen(cmd, stdout=subprocess.PIPE)
        res = p.communicate()[0] # get only stdout
        if p.returncode != 0: raise Exception("Querying dpkg for the architecture failed")


@@ -88,14 +93,15 @@ def writeDependency(f, name, list):
 def createDebianFiles(config):
        sourceName = config['sourceName']
        binaryName = config.get('binaryName', sourceName+'-local')
 def createDebianFiles(config):
        sourceName = config['sourceName']
        binaryName = config.get('binaryName', sourceName+'-local')

-       name = config.get('name', os.getlogin())
-       email = config.get('email', os.getlogin()+'@'+os.uname()[1]) # user@hostname
+       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 = config['buildSystem']
        version = config['version']
        dbgPackage = config.get('dbgPackage', False)
        parallelJobs = int(config.get('parallelJobs', 2))
        packageArchitecture = config.get('architecture', 'any')
        debDir = os.path.expanduser(config['debDir'])
        buildSystem = config['buildSystem']
        version = config['version']
        dbgPackage = config.get('dbgPackage', False)
        parallelJobs = int(config.get('parallelJobs', 2))
        packageArchitecture = config.get('architecture', 'any')

+       withPython2 = config.get('withPython2', False)

        # we return the list of files generated, so we need to know the architecture
        arch = getArchitecture(config)
        files = []
        # we return the list of files generated, so we need to know the architecture
        arch = getArchitecture(config)
        files = []


@@ -135,6 +141,7 @@ def createDebianFiles(config):
                writeDependency(f, "Depends", ["${shlibs:Depends}", "${misc:Depends}"] + config.get('binaryDepends', []))
                writeDependency(f, "Recommends", config.get('binaryRecommends', []))
                writeDependency(f, "Provides", config.get('binaryProvides', [sourceName]))
                writeDependency(f, "Depends", ["${shlibs:Depends}", "${misc:Depends}"] + config.get('binaryDepends', []))
                writeDependency(f, "Recommends", config.get('binaryRecommends', []))
                writeDependency(f, "Provides", config.get('binaryProvides', [sourceName]))

+               writeDependency(f, "Conflicts", config.get('binaryConflicts', []))

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


@@ -146,6 +153,12 @@ 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('binaryInstallFiles', []):
+                       if line.startswith('/'): # a file from within the package, not from the source tree
+                               line = 'debian/'+binaryName+line
+                       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


@@ -162,51 +175,66 @@ def createDebianFiles(config):
                        r.env["DEB_CFLAGS_APPEND"] = '-g0'
                        r.env["DEB_CXXFLAGS_APPEND"] = '-g0'
                r.dh += ['--parallel']
                        r.env["DEB_CFLAGS_APPEND"] = '-g0'
                        r.env["DEB_CXXFLAGS_APPEND"] = '-g0'
                r.dh += ['--parallel']

-               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...)
+               if withPython2:
+                       r.dh += ['--with=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_test'] = []
                # installation rule

-               r.rules['auto_install'] = [safeCall(['dh_auto_install', '--destdir=debian/'+binaryName])] # install everything into the binary package
+               r.rules['auto_install'] = [safeCall('dh_auto_install', '--destdir=debian/'+binaryName)] # install everything into the binary package

                if 'binarySkipFiles' in config:
                if 'binarySkipFiles' in config:

-                       r.rules['auto_install'].append(safeCall(['cd', 'debian/'+binaryName]) + " && " +
-                               safeCall(['rm'] + config['binarySkipFiles']))
+                       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'] = [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
+                       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):
+                       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)
        mode = os.stat('debian/rules').st_mode
        os.chmod('debian/rules', mode | stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH)
                # dump it to a file
                r.write(f)
        mode = os.stat('debian/rules').st_mode
        os.chmod('debian/rules', mode | stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH)

-       # return list of files affected
+       # return list of files that will be created

        return files
 
 def buildDebianPackage(config):
        commands = ['dpkg-checkbuilddeps', 'debian/rules clean', 'debian/rules build', 'fakeroot debian/rules binary', 'debian/rules clean']
        return files
 
 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)]
+       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
 
        subprocess.check_call(commandInBuildEnv(config, command))
        shutil.rmtree('debian') # it only contains what we just created
 

-# all at once
-def createAndInstall(config, overwriteCheck = False):
-       # generate debian files
-       files = createDebianFiles(config)
-       # check if a file is overwritten
-       if overwriteCheck:
+###################################################################
+# if we are called directly as script
+if __name__ == "__main__":
+       try:
+               import imp
+               # get config
+               config = imp.load_source('config', 'auto-debuild.conf').__dict__
+               os.remove('auto-debuild.confc')
+               # 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

                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)
-
-# 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)
+               # run compilation
+               buildDebianPackage(config)
+               # install files
+               print "Installing created deb files..."
+               subprocess.check_call(['sudo', 'dpkg', '--install'] + files)
+       except (subprocess.CalledProcessError, KeyboardInterrupt) as e: # for some exceptions, a stackrace is usually pointless
+               print >> sys.stderr
+               print >> sys.stderr
+               if isinstance(e, KeyboardInterrupt): # str(e) would be the empty string
+                       print >> sys.stderr, "Interruped by user"
+               else:
+                       print >> sys.stderr, "Error during package creation: %s" % str(e)
+               print >> sys.stderr
+               sys.exit(1)