control "waitAfterConfig" via command-line switch
[auto-debuild.git] / auto_debuild.py
index 441302c0f19d6a71670e9850fa0f870ad4dee917..8dfdef58622bc0aef33379770ac2727c8bfcee4b 100755 (executable)
@@ -16,7 +16,7 @@
 # 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
+import os, shutil, stat, time, subprocess, sys, shlex, tempfile, argparse
 from collections import OrderedDict
 
 # a dict with some useful additional getters which can convert types and handle one-element lists like their single member
@@ -131,34 +131,30 @@ def cmakeRules(r, config):
        r.rules['auto_clean'] = [safeCall('rm', '-f', os.path.join(buildDir, 'CMakeCache.txt'))] # clean old cmake cache
 
 def automakeRules(r, config):
+       buildDir = config.getstr('buildDir', 'build')
+       srcDir = os.getcwd()
        # "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
+       # also, we don't really support cross-building... ;-) (to do so, 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.dh += ["--buildsystem=autoconf"]
+       r.dh += ["--buildsystem=autoconf", "--builddirectory="+config.getstr('buildDir')]
        r.rules['auto_configure'] = [
+               safeCall("mkdir", "-p", buildDir),
+               safeCall("cd", buildDir) + " && " +
                'BUILD_TYPE=$$(dpkg-architecture -qDEB_BUILD_GNU_TYPE) && ' + # doing the expansion beforehand ensures that we cancel if it fails
                '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)
+               safeCall(srcDir+"/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 (no need for escaping here, obviously)
-
-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'
+                       safeCall('--docdir=/usr/share/doc/'+config['binaryName'], '--sysconfdir=/etc', '--localstatedir=/var', *config.get('automakeParameters', []))
        ]
+       r.rules['auto_clean'] = [safeCall("rm", "-f", "--", buildDir+"/config.status")] # do not re-use old configuration
 
 def makefileRules(r, config):
        r.dh += ["--buildsystem=makefile"]
+       r.rules['auto_configure'] = []
 
-def noneRules(config):
-       r = RulesFile()
+def noneRules(r, config):
        r.dh += ["--buildsystem=makefile"] # makefile does the least possible harm
        r.rules['auto_configure'] = []
        r.rules['auto_build'] = []
@@ -169,7 +165,6 @@ def noneRules(config):
 buildSystems = {
        'cmake': BuildSystem(cmakeRules, ["cmake"]),
        'automake': BuildSystem(automakeRules),
-       'python': BuildSystem(pythonRules, ["python-setuptools"], ["${python:Depends}"]),
        'makefile': BuildSystem(makefileRules),
        'none': BuildSystem(noneRules),
 }
@@ -191,32 +186,57 @@ def writeDependency(f, name, list):
        if len(list):
                print >>f, name+": "+', '.join(list)
 
+def deleteDebianFolder():
+       if os.path.islink('debian'):
+               target = os.readlink('debian')
+               if os.path.exists(target):
+                       shutil.rmtree(target)
+               os.remove('debian')
+       else:
+               shutil.rmtree('debian')
+
 # actual work functions
 def createDebianFiles(config):
        if not isinstance(config, ConfigDict):
                config = ConfigDict(config)
        sourceName = config.getstr('sourceName')
        binaryName = config.getstr('binaryName', sourceName+'-local')
+       config['binaryName'] = binaryName # make it usable by build systems
        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')
+       version = config.getstr('version') # version name excluding epoch (used for filenames)
+       fullVersion = str(config.getint('epoch'))+':'+version if 'epoch' in config else version # version name including epoch
        dbgPackage = config.getbool('dbgPackage', False)
        parallelJobs = config.getint('parallelJobs', 2)
        packageArchitecture = config.getstr('architecture', 'any')
        withPython2 = config.getbool('withPython2', False)
+       withSIP = config.getbool('withSIP', False)
+       withAutoreconf = config.getbool('withAutoreconf', False)
+       # add some build dependencies (a bit hacky adding it to the build system...)
+       if withSIP:
+               withPython2 = True
+               buildSystem.buildDepends.append("python-sip")
+               buildSystem.binaryDepends.append("${sip:Depends}")
        if withPython2:
-               buildSystem.binaryDepends.append("${python:Depends}") # HACK, but it works: make sure dependencies on binary are added
+               buildSystem.buildDepends.append("python")
+               buildSystem.binaryDepends.append("${python:Depends}")
+       if withAutoreconf:
+               buildSystem.buildDepends.append("dh-autoreconf")
        # we return the list of files generated, so we need to know the architecture
        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 os.path.exists('debian') or os.path.islink('debian'): raise Exception('debian folder already exists?')
+       if config.getbool('useTmp', True):
+               tempdir = tempfile.mkdtemp(prefix='auto-debuild-')
+               os.symlink(tempdir, 'debian')
+       else:
+               os.mkdir('debian')
        if not os.path.exists(debDir): os.makedirs(debDir)
        # source format file
+       os.mkdir('debian/source')
        with open('debian/source/format', 'w') as f:
                print >>f, "3.0 (native)"
        # compat file
@@ -227,19 +247,21 @@ def createDebianFiles(config):
                print >>f, "Auto-generated by auto-debuild, not suited for distribution"
        # changelog file
        with open('debian/changelog', 'w') as f:
-               print >>f, sourceName,"("+version+")","UNRELEASED; urgency=low"
+               print >>f, sourceName,"("+fullVersion+")","UNRELEASED; urgency=low"
                print >>f, ""
                print >>f, "  * Auto-generated by auto-debuild"
                print >>f, ""
                print >>f, " --",name,"<"+email+">  "+time.strftime('%a, %d %b %Y %H:%M:%S %z')
        # control file
        with open('debian/control', 'w') as f:
+               # source package
                print >>f, "Source:",sourceName
                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, "Standards-Version: 3.9.3"
+               # main binary package
                print >>f, ""
                print >>f, "Package:",binaryName
                print >>f, "Architecture:",packageArchitecture
@@ -256,6 +278,7 @@ def createDebianFiles(config):
                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)))
+               # debug package
                if dbgPackage:
                        print >>f, ""
                        print >>f, "Package:",binaryName+"-dbg"
@@ -266,6 +289,17 @@ 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)))
+               # shim packages
+               for shim in config.get('binaryShims', []):
+                       print >>f, ""
+                       print >>f, "Package:",shim
+                       print >>f, "Section:",config.getstr('section', 'misc')
+                       print >>f, "Priority: extra"
+                       print >>f, "Architecture:",packageArchitecture
+                       writeDependency(f, "Depends", ["${misc:Depends}", binaryName+" (= ${binary:Version})"])
+                       print >>f, "Description:",sourceName,"shim for",shim,"(auto-debuild)"
+                       print >>f, " Package pretending to be "+shim+", auto-generated by auto-debuild."
+                       files.append(os.path.join(debDir, "%s_%s_%s.deb" % (shim, version, arch)))
        # install file
        with open('debian/'+binaryName+'.install', 'w') as f:
                for line in config.get('binaryInstallFiles', []):
@@ -304,6 +338,7 @@ def createDebianFiles(config):
                r = RulesFile()
                r.rules['auto_test'] = []
                r.rules['auto_install'] = [safeCall('dh_auto_install', '--destdir=debian/'+binaryName)] # install everything into the binary package
+               r.rules['auto_configure'] = ['dh_auto_configure'] # make sure there is an override (we may just append to it later)
                # patch rule file for build system: may only touch auto_* rules and the dh options
                buildSystem.ruleMaker(r, config)
                # global rules
@@ -315,19 +350,22 @@ def createDebianFiles(config):
                r.dh += ['--parallel']
                if withPython2:
                        r.dhWith.add('python2')
-                       r.rules['python2'] = ['dh_python2 --no-guessing-versions']
+                       r.rules['python2'] = ['dh_python2 --no-guessing-versions --no-shebang-rewrite']
+                       if withSIP:
+                               r.rules['python2'].append(safeCall('dh_sip', '-p'+binaryName))
+               if withAutoreconf:
+                       r.dhWith.add('autoreconf')
                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...)
                # installation rule
                if 'binarySkipFiles' in config:
-                       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
+               # 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
+               # make the doc folder of the other packages a symlink (dbg, shims)
+               r.rules['installdocs'] = [safeCall('dh_installdocs', '--link-doc='+binaryName)]
                # wait after configuration?
                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)
@@ -342,19 +380,26 @@ def buildDebianPackage(config):
        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
+       deleteDebianFolder() # cleanup: the debian folder only contains what we just created
 
 ###################################################################
 # if we are called directly as script
 if __name__ == "__main__":
        try:
+               # read command-line arguments
+               parser = argparse.ArgumentParser(description='Automatic Generation of Debian Packages')
+               parser.add_argument("-w", "--wait-after-config",
+                                                       action="store_true", dest="wait_after_config",
+                                                       help="Wait for user confirmation after configuration is finished")
+               args = parser.parse_args()
                # get config
                config = loadConfigFile('auto-debuild.conf')
+               config['waitAfterConfig'] = args.wait_after_config
                # 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":
+               if os.path.exists('debian') or os.path.islink('debian'):
+                       if raw_input("A debian folder already exists, do you want to remove it and whatever it links to (y/N)? ").lower() != "y":
                                sys.exit(1)
-                       shutil.rmtree('debian')
+                       deleteDebianFolder()
                files = createDebianFiles(config)
                # check if a file is overwritten
                for file in files: