X-Git-Url: https://git.ralfj.de/auto-debuild.git/blobdiff_plain/738f8958591a071df1b851088799f3d052784eba..ebe740f9e8f8a803b8873f2a40406828bf308d84:/auto_debuild.py?ds=sidebyside diff --git a/auto_debuild.py b/auto_debuild.py index ab89983..b409bd1 100755 --- a/auto_debuild.py +++ b/auto_debuild.py @@ -1,8 +1,44 @@ #!/usr/bin/python -import os, shutil, stat, time, subprocess, sys +# auto-debuild - Automatic Generation of Debian Packages +# Copyright (C) 2012 Ralf Jung +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# 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 from collections import OrderedDict -# some utility functions +# a dict with some useful additional getters which can convert types and handle one-element lists like their single member +class ConfigDict(dict): + def getstr(self, name, default = None): + if not name in self: return default + val = self[name] + if isinstance(val, list): + if len(val) != 1: raise Exception('%s is a list, but it should not' % name) + return val[0] + else: + return val + + 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: @@ -11,6 +47,35 @@ def safeCall(*args): res += "'"+arg+"'" return res +# Load a section-less config file: maps parameter names to space-separated lists of strings (with shell quotation) +# Lines starting with spaces are continuation lines +def loadConfigFile(file): + # read config file + linenr = 0 + with open(file) as file: + result = ConfigDict() + curKey = None + for line in file: + linenr += 1 + isCont = len(line) and line[0].isspace() # remember if we were a continuation line + if isCont and curKey is None: + raise Exception("Invalid config, line %d: Starting with continuation line" % linenr) + line = line.strip() + if not len(line) or line.startswith("#"): continue # skip empty and comment lines + try: + if isCont: + # continuation line + result[curKey] += shlex.split(line) + else: + # option line + pos = line.index("=") # will raise exception when substring is not found + curKey = line[:pos].strip() + result[curKey] = shlex.split(line[pos+1:]) # shlex.split also strips + except Exception: + raise Exception("Invalid config, line %d: Error parsing line (quoting issue?)" % linenr) + # add some convencience get functions + return result + # representation of a build system class BuildSystem: def __init__(self, ruleMaker, buildDepends = [], binaryDepends = []): @@ -40,7 +105,7 @@ class RulesFile: print >>f, "" 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, "build %:" # need to mention "build" here again explicitly so PHONY takes effect # write proper dh call dh = self.dh if self.dhWith: @@ -55,7 +120,7 @@ class RulesFile: # 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 @@ -95,16 +160,31 @@ def pythonRules(config): ] return r +def makefileRules(config): + r = RulesFile() + r.dh += ["--buildsystem=makefile"] # makefile does the least possible harm + return r + +def noneRules(config): + r = RulesFile() + r.dh += ["--buildsystem=makefile"] # makefile does the least possible harm + r.rules['auto_configure'] = [] + r.rules['auto_build'] = [] + r.rules['auto_clean'] = [] + return r + # build systems buildSystems = { 'cmake': BuildSystem(cmakeRules, ["cmake"]), 'automake': BuildSystem(automakeRules), 'python': BuildSystem(pythonRules, ["python-setuptools"], ["${python:Depends}"]), + 'makefile': BuildSystem(makefileRules), + 'none': BuildSystem(noneRules), } # 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 @@ -121,17 +201,19 @@ def writeDependency(f, name, list): # 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) + if not isinstance(config, ConfigDict): + config = ConfigDict(config) + 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 @@ -161,7 +243,7 @@ def createDebianFiles(config): # 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', [])) @@ -170,19 +252,23 @@ def createDebianFiles(config): print >>f, "Package:",binaryName print >>f, "Architecture:",packageArchitecture if 'binaryMultiArch' in config: - print >>f, "Multi-Arch:",config['binaryMultiArch'] + 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, "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, "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)" @@ -200,9 +286,9 @@ def createDebianFiles(config): print >>f, "#!/bin/sh" print >>f, "set -e" print >>f, 'if [ "$1" = "configure" ]; then' - for alternative in config['alternatives']: - print >>f, safeCall('update-alternatives', '--install', alternative['link'], alternative['name'], alternative['target'], - str(alternative['priority'])) + for alternative in config.get('alternatives'): + alternative = shlex.split(alternative) + print >>f, safeCall('update-alternatives', '--install', alternative[0], alternative[1], alternative[2], alternative[3]) print >>f, 'fi' print >>f, '' print >>f, '#DEBHELPER#' @@ -212,8 +298,9 @@ def createDebianFiles(config): print >>f, "#!/bin/sh" print >>f, "set -e" print >>f, 'if [ "$1" = "remove" ]; then' - for alternative in config['alternatives']: - print >>f, safeCall('update-alternatives', '--remove', alternative['name'], alternative['target']) + for alternative in config.get('alternatives'): + alternative = shlex.split(alternative) + print >>f, safeCall('update-alternatives', '--remove', alternative[1], alternative[2]) print >>f, 'fi' print >>f, '' print >>f, '#DEBHELPER#' @@ -239,13 +326,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) + " && " + - 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? - 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) @@ -255,7 +343,9 @@ def createDebianFiles(config): return files def buildDebianPackage(config): - commands = ['dpkg-checkbuilddeps', 'debian/rules clean', 'debian/rules build', 'fakeroot debian/rules binary', 'debian/rules clean'] + if not isinstance(config, ConfigDict): + config = ConfigDict(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 @@ -264,10 +354,8 @@ def buildDebianPackage(config): # 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') + 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":