auto_debuild.py

   1 #!/usr/bin/env python3
   2 # auto-debuild - Automatic Generation of Debian Packages
   3 # Copyright (C) 2012 Ralf Jung <post@ralfj.de>
   4 #
   5 # This program is free software; you can redistribute it and/or modify
   6 # it under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation; either version 2 of the License, or
   8 # (at your option) any later version.
   9 #
  10 # This program is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with this program; if not, write to the Free Software
  17 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18
  19 import os, shutil, stat, time, subprocess, sys, shlex, tempfile, argparse, multiprocessing
  20 from collections import OrderedDict
  21
  22 # a dict with some useful additional getters which can convert types and handle one-element lists like their single member
  23 class ConfigDict(dict):
  24         def getstr(self, name, default = None):
  25                 if not name in self: return default
  26                 val = self[name]
  27                 if isinstance(val, list):
  28                         if len(val) != 1: raise Exception('%s is a list, but it should not' % name)
  29                         return val[0]
  30                 else:
  31                         return val
  32
  33         def getint(self, name, default = None):
  34                 return int(self.getstr(name, default))
  35
  36         def getbool(self, name, default = None):
  37                 val = self.getstr(name, default)
  38                 if isinstance(val, bool): return val # already a bool
  39                 return val.lower() in ('true', 'yes', 'on', '1')
  40
  41 # create a safe-to-call shell command from the array
  42 def safeCall(*args):
  43         res = ""
  44         for arg in args:
  45                 assert arg.find("'") < 0 # ' is not supported
  46                 if len(res): res += " "
  47                 res += "'"+arg+"'"
  48         return res
  49
  50 # Load a section-less config file: maps parameter names to space-separated lists of strings (with shell quotation)
  51 # Lines starting with spaces are continuation lines
  52 def loadConfigFile(file):
  53         # read config file
  54         linenr = 0
  55         with open(file) as file:
  56                 result = ConfigDict()
  57                 curKey = None
  58                 for line in file:
  59                         linenr += 1
  60                         isCont = len(line) and line[0].isspace() # remember if we were a continuation line
  61                         if isCont and curKey is None:
  62                                 raise Exception("Invalid config, line %d: Starting with continuation line" % linenr)
  63                         line = line.strip()
  64                         if not len(line) or line.startswith("#"): continue # skip empty and comment lines
  65                         try:
  66                                 if isCont:
  67                                         # continuation line
  68                                         result[curKey] += shlex.split(line)
  69                                 else:
  70                                         # option line
  71                                         pos = line.index("=") # will raise exception when substring is not found
  72                                         curKey = line[:pos].strip()
  73                                         result[curKey] = shlex.split(line[pos+1:]) # shlex.split also strips
  74                         except Exception:
  75                                 raise Exception("Invalid config, line %d: Error parsing line (quoting issue?)" % linenr)
  76         # add some convencience get functions
  77         return result
  78
  79 # representation of a build system
  80 class BuildSystem:
  81         def __init__(self, ruleMaker, buildDepends = [], binaryDepends = []):
  82                 self.ruleMaker = ruleMaker
  83                 self.buildDepends = buildDepends
  84                 self.binaryDepends = binaryDepends
  85
  86 # abstract representation of rules file
  87 class RulesFile:
  88         def __init__(self):
  89                 self.env = {}
  90                 self.dh = []
  91                 self.dhWith = set()
  92                 self.rules = OrderedDict()
  93
  94         def env2str(self):
  95                 res = ""
  96                 for name in self.env: # we rely on the name being sane (i.e., no special characters)
  97                         val = self.env[name]
  98                         assert val.find("'") < 0 # ' is not supported
  99                         if len(res): res += " "
 100                         res += name+"='"+val+"'"
 101                 return res
 102
 103         def write(self, f):
 104                 print("#!/usr/bin/make -f", file=f)
 105                 print(file=f)
 106                 print(".PHONY: build", file=f) # there may be a directory called "build"
 107                 print(file=f)
 108                 print("%:", file=f)
 109                 # write proper dh call
 110                 dh = self.dh
 111                 if self.dhWith:
 112                         dh.append('--with='+','.join(self.dhWith))
 113                 print('\t'+self.env2str()+' dh $@ '+safeCall(*dh), file=f)
 114                 # write remaining rules
 115                 for rule in self.rules:
 116                         print(file=f)
 117                         print("override_dh_"+rule+":", file=f)
 118                         for line in self.rules[rule]:
 119                                 print("\t"+line, file=f)
 120
 121 # rule-makers
 122 def cmakeRules(r, config):
 123         buildDir = config.getstr('buildDir', 'build')
 124         srcDir = os.getcwd()
 125         r.dh += ["--buildsystem=cmake", "--builddirectory="+buildDir] # dh parameters
 126         r.rules['auto_configure'] = [
 127                 safeCall("mkdir", "-p", buildDir),
 128                 safeCall("cd", buildDir) + " && " +
 129                   safeCall("cmake", srcDir, "-DCMAKE_INSTALL_PREFIX=/usr", *config.get('cmakeParameters', []))
 130         ]
 131         r.rules['auto_clean'] = [safeCall('rm', '-f', os.path.join(buildDir, 'CMakeCache.txt'))] # clean old cmake cache
 132
 133 def automakeRules(r, config):
 134         buildDir = config.getstr('buildDir', 'build')
 135         srcDir = os.getcwd()
 136         # "build" is what we are building *on*, and "host" is what we are building *for* (and GNU is weird...)
 137         # also, we don't really support cross-building... ;-) (to do so, we'd have to write shell code that checks whether BUILD_GNU_TYPE
 138         #  and HOST_GNU_TYPE are equal, and if they are not, add a --host parameter)
 139         r.dh += ["--buildsystem=autoconf", "--builddirectory="+config.getstr('buildDir')]
 140         r.rules['auto_configure'] = [
 141         (safeCall(*config['autogen']) + " && " if 'autogen' in config else '') +
 142                 safeCall("mkdir", "-p", buildDir),
 143                 safeCall("cd", buildDir) + " && " +
 144                 'BUILD_TYPE=$$(dpkg-architecture -qDEB_BUILD_GNU_TYPE) && ' + # doing the expansion beforehand ensures that we cancel if it fails
 145                 'MULTIARCH=$$(dpkg-architecture -qDEB_HOST_MULTIARCH) && '+
 146                 safeCall(srcDir+"/configure") +
 147                         ' --build=$$BUILD_TYPE '+ # do the escape manually here so we can use the variables (there's no user-controlled string in here anyway)
 148                         '--prefix=/usr --includedir=/usr/include --mandir=/usr/share/man --infodir=/usr/share/info '+
 149                         '--libdir=/usr/lib/$$MULTIARCH --libexecdir=/usr/lib/$$MULTIARCH '+
 150                         safeCall('--docdir=/usr/share/doc/'+config['binaryName'], '--sysconfdir=/etc', '--localstatedir=/var', *config.get('automakeParameters', []))
 151         ]
 152         r.rules['auto_clean'] = [safeCall("rm", "-f", "--", buildDir+"/config.status")] # do not re-use old configuration
 153
 154 def makefileRules(r, config):
 155         r.dh += ["--buildsystem=makefile"]
 156         r.rules['auto_configure'] = []
 157
 158 def noneRules(r, config):
 159         r.dh += ["--buildsystem=makefile"] # makefile does the least possible harm
 160         r.rules['auto_configure'] = []
 161         r.rules['auto_build'] = []
 162         r.rules['auto_clean'] = []
 163         return r
 164
 165 # build systems
 166 buildSystems = {
 167         'cmake': BuildSystem(cmakeRules, ["cmake"]),
 168         'automake': BuildSystem(automakeRules),
 169         'makefile': BuildSystem(makefileRules),
 170         'none': BuildSystem(noneRules),
 171 }
 172
 173 # utility functions
 174 def commandInBuildEnv(config, command):
 175         schroot = config.getstr('schroot')
 176         if schroot is not None: command = ['schroot', '-c', schroot, '--'] + command
 177         return command
 178
 179 def getArchitecture(config):
 180         cmd = commandInBuildEnv(config, ['dpkg-architecture', '-qDEB_HOST_ARCH'])
 181         output = subprocess.check_output(cmd)
 182         return output.decode('utf-8').strip('\n') # chop off the \n at the end
 183
 184 def writeDependency(f, name, list):
 185         if len(list):
 186                 print(name+": "+', '.join(list), file=f)
 187
 188 # actual work functions
 189 def deleteDebianFolder():
 190         if os.path.islink('debian'):
 191                 target = os.readlink('debian')
 192                 if os.path.exists(target):
 193                         shutil.rmtree(target)
 194                 os.remove('debian')
 195         elif os.path.exists('debian'):
 196                 shutil.rmtree('debian')
 197
 198 def createDebianFiles(config):
 199         if not isinstance(config, ConfigDict):
 200                 config = ConfigDict(config)
 201         sourceName = config.getstr('sourceName')
 202         binaryName = config.getstr('binaryName', sourceName+'-local')
 203         config['binaryName'] = binaryName # make it usable by build systems
 204         name = config.getstr('name', os.getenv('USER')) # os.getlogin() fails in minimal chroots
 205         email = config.getstr('email', os.getenv('USER')+'@'+os.uname()[1]) # user@hostname
 206         debDir = os.path.expanduser(config.getstr('debDir'))
 207         buildSystem = buildSystems[config.getstr('buildSystem')] # get the data immediately
 208         version = config.getstr('version') # version name excluding epoch (used for filenames)
 209         fullVersion = str(config.getint('epoch'))+':'+version if 'epoch' in config else version # version name including epoch
 210         dbgPackage = config.getbool('dbgPackage', False)
 211         parallelJobs = config.getint('parallelJobs', multiprocessing.cpu_count()+1)
 212         packageArchitecture = config.getstr('architecture', 'any')
 213         withPython2 = config.getbool('withPython2', False)
 214         withSIP = config.getbool('withSIP', False)
 215         withAutoreconf = config.getbool('withAutoreconf', False)
 216         # add some build dependencies (a bit hacky adding it to the build system...)
 217         if withSIP:
 218                 withPython2 = True
 219                 buildSystem.buildDepends.append("python-sip")
 220                 buildSystem.binaryDepends.append("${sip:Depends}")
 221         if withPython2:
 222                 buildSystem.buildDepends.append("python")
 223                 buildSystem.binaryDepends.append("${python:Depends}")
 224         if withAutoreconf:
 225                 buildSystem.buildDepends.append("dh-autoreconf")
 226         # we return the list of files generated, so we need to know the architecture
 227         arch = getArchitecture(config)
 228         files = []
 229         # create folders
 230         if os.path.exists('debian') or os.path.islink('debian'): raise Exception('debian folder already exists?')
 231         if config.getbool('useTmp', True):
 232                 tempdir = tempfile.mkdtemp(prefix='auto-debuild-')
 233                 os.symlink(tempdir, 'debian')
 234         else:
 235                 os.mkdir('debian')
 236         if not os.path.exists(debDir): os.makedirs(debDir)
 237         # source format file
 238         os.mkdir('debian/source')
 239         with open('debian/source/format', 'w') as f:
 240                 print("3.0 (native)", file=f)
 241         # compat file
 242         with open('debian/compat', 'w') as f:
 243                 print("9", file=f)
 244         # copyright file
 245         with open('debian/copyright', 'w') as f:
 246                 print("Auto-generated by auto-debuild, not suited for distribution", file=f)
 247         # changelog file
 248         with open('debian/changelog', 'w') as f:
 249                 print(sourceName,"("+fullVersion+")","UNRELEASED; urgency=low", file=f)
 250                 print(file=f)
 251                 print("  * Auto-generated by auto-debuild", file=f)
 252                 print(file=f)
 253                 print(" --",name,"<"+email+">  "+time.strftime('%a, %d %b %Y %H:%M:%S %z'), file=f)
 254         # control file
 255         with open('debian/control', 'w') as f:
 256                 # source package
 257                 print("Source:",sourceName, file=f)
 258                 print("Section:",config.getstr('section', 'misc'), file=f)
 259                 print("Priority: extra", file=f)
 260                 print("Maintainer: %s <%s>" % (name, email), file=f)
 261                 writeDependency(f, 'Build-Depends', ["debhelper (>= 9)"] + buildSystem.buildDepends + config.get('buildDepends', []))
 262                 print("Standards-Version: 3.9.3", file=f)
 263                 # main binary package
 264                 print(file=f)
 265                 print("Package:",binaryName, file=f)
 266                 print("Architecture:",packageArchitecture, file=f)
 267                 if 'binaryMultiArch' in config:
 268                         print("Multi-Arch:",config.getstr('binaryMultiArch'), file=f)
 269                 writeDependency(f, "Pre-Depends", ["${misc:Pre-Depends}"] + config.get('binaryPreDepends', []))
 270                 writeDependency(f, "Depends", ["${shlibs:Depends}", "${misc:Depends}"] + buildSystem.binaryDepends +
 271                         config.get('binaryDepends', []))
 272                 writeDependency(f, "Recommends", config.get('binaryRecommends', []))
 273                 writeDependency(f, "Provides", config.get('binaryProvides', [sourceName]))
 274                 writeDependency(f, "Conflicts", config.get('binaryConflicts', []))
 275                 writeDependency(f, "Breaks", config.get('binaryBreaks', []) + config.get('binaryBreaksReplaces', []))
 276                 writeDependency(f, "Replaces", config.get('binaryReplaces', []) + config.get('binaryBreaksReplaces', []))
 277                 print("Description:",sourceName,"(auto-debuild)", file=f)
 278                 print(" Package auto-generated by auto-debuild.", file=f)
 279                 files.append(os.path.join(debDir, "%s_%s_%s.deb" % (binaryName, version, arch)))
 280                 # debug package
 281                 if dbgPackage:
 282                         print(file=f)
 283                         print("Package:",binaryName+"-dbg", file=f)
 284                         print("Section: debug", file=f)
 285                         print("Priority: extra", file=f)
 286                         print("Architecture:",packageArchitecture, file=f)
 287                         writeDependency(f, "Depends", ["${misc:Depends}", binaryName+" (= ${binary:Version})"])
 288                         print("Description:",sourceName,"debug smbols (auto-debuild)", file=f)
 289                         print(" Package containing debug symbols for "+sourceName+", auto-generated by auto-debuild.", file=f)
 290                         files.append(os.path.join(debDir, "%s-dbg_%s_%s.deb" % (binaryName, version, arch)))
 291                 # shim packages
 292                 for shim in config.get('binaryShims', []):
 293                         print(file=f)
 294                         print("Package:",shim, file=f)
 295                         print("Section:",config.getstr('section', 'misc'), file=f)
 296                         print("Priority: extra", file=f)
 297                         print("Architecture:",packageArchitecture, file=f)
 298                         writeDependency(f, "Depends", ["${misc:Depends}", binaryName+" (= ${binary:Version})"])
 299                         print("Description:",sourceName,"shim for",shim,"(auto-debuild)", file=f)
 300                         print(" Package pretending to be "+shim+", auto-generated by auto-debuild.", file=f)
 301                         files.append(os.path.join(debDir, "%s_%s_%s.deb" % (shim, version, arch)))
 302         # install file
 303         with open('debian/'+binaryName+'.install', 'w') as f:
 304                 for line in config.get('binaryInstallFiles', []):
 305                         if line.startswith('/'): # a file from within the package, not from the source tree
 306                                 line = 'debian/'+binaryName+line
 307                         print(line, file=f)
 308         # maintainer scripts for alternatives
 309         if 'alternatives' in config:
 310                 with open('debian/'+binaryName+'.postinst', 'w') as f:
 311                         print("#!/bin/sh", file=f)
 312                         print("set -e", file=f)
 313                         print('if [ "$1" = "configure" ]; then', file=f)
 314                         for alternative in config.get('alternatives'):
 315                                 alternative = shlex.split(alternative)
 316                                 print(safeCall('update-alternatives', '--install', alternative[0], alternative[1], alternative[2], alternative[3]), file=f)
 317                         print('fi', file=f)
 318                         print(file=f)
 319                         print('#DEBHELPER#', file=f)
 320                         print(file=f)
 321                         print('exit 0', file=f)
 322                 with open('debian/'+binaryName+'.prerm', 'w') as f:
 323                         print("#!/bin/sh", file=f)
 324                         print("set -e", file=f)
 325                         print('if [ "$1" = "remove" ]; then', file=f)
 326                         for alternative in config.get('alternatives'):
 327                                 alternative = shlex.split(alternative)
 328                                 print(safeCall('update-alternatives', '--remove', alternative[1], alternative[2]), file=f)
 329                         print('fi', file=f)
 330                         print(file=f)
 331                         print('#DEBHELPER#', file=f)
 332                         print(file=f)
 333                         print('exit 0', file=f)
 334         # rules file: build system specific
 335         with open('debian/rules', 'w') as f:
 336                 # pre-fill rule file with our global defaults
 337                 r = RulesFile()
 338                 r.rules['auto_test'] = []
 339                 r.rules['auto_install'] = [safeCall('dh_auto_install', '--destdir=debian/'+binaryName)] # install everything into the binary package
 340                 r.rules['auto_configure'] = ['dh_auto_configure'] # make sure there is an override (we may just append to it later)
 341                 # patch rule file for build system: may only touch auto_* rules and the dh options
 342                 buildSystem.ruleMaker(r, config)
 343                 # global rules
 344                 r.env["DEB_BUILD_OPTIONS"] = 'parallel='+str(parallelJobs)
 345                 if not dbgPackage:
 346                         # disable debug information
 347                         r.env["DEB_CFLAGS_APPEND"] = '-g0'
 348                         r.env["DEB_CXXFLAGS_APPEND"] = '-g0'
 349                 r.dh += ['--parallel']
 350                 if withPython2:
 351                         r.dhWith.add('python2')
 352                         r.rules['python2'] = ['dh_python2 --no-guessing-versions --no-shebang-rewrite']
 353                         if withSIP:
 354                                 r.rules['python2'].append(safeCall('dh_sip', '-p'+binaryName))
 355                 if withAutoreconf:
 356                         r.dhWith.add('autoreconf')
 357                 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...)
 358                 # installation rule
 359                 if 'binarySkipFiles' in config:
 360                         r.rules['auto_install'].append(safeCall('cd', 'debian/'+binaryName) + " && " + safeCall('rm', *config.get('binarySkipFiles')))
 361                 # debug packages
 362                 if dbgPackage:
 363                         r.rules['strip'] = [safeCall('dh_strip', '--dbg-package='+binaryName+"-dbg")] # put debug files in appropriate package
 364                 # make the doc folder of the other packages a symlink (dbg, shims)
 365                 r.rules['installdocs'] = [safeCall('dh_installdocs', '--link-doc='+binaryName)]
 366                 # wait after configuration?
 367                 if config.getbool('waitAfterConfig', False):
 368                         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...
 369                 # dump it to a file
 370                 r.write(f)
 371         mode = os.stat('debian/rules').st_mode
 372         os.chmod('debian/rules', mode | stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH)
 373         # return list of files that will be created
 374         return files
 375
 376 def buildDebianPackage(config):
 377         if not isinstance(config, ConfigDict):
 378                 config = ConfigDict(config)
 379         commands = ['dpkg-checkbuilddeps', 'debian/rules clean', 'debian/rules build', 'fakeroot debian/rules binary']
 380         command = ['bash', '-c', ' && '.join(commands)] # make it all one command, so we don't have to open and close the chroot too often
 381         subprocess.check_call(commandInBuildEnv(config, command))
 382         deleteDebianFolder() # cleanup: the debian folder only contains what we just created
 383
 384 ###################################################################
 385 # if we are called directly as script
 386 if __name__ == "__main__":
 387         try:
 388                 # read command-line arguments
 389                 parser = argparse.ArgumentParser(description='Automatic Generation of Debian Packages')
 390                 parser.add_argument("-w", "--wait-after-config",
 391                                                         action="store_true", dest="wait_after_config",
 392                                                         help="Wait for user confirmation after configuration is finished")
 393                 args = parser.parse_args()
 394                 # get config
 395                 config = loadConfigFile('auto-debuild.conf')
 396                 config['waitAfterConfig'] = args.wait_after_config
 397                 # generate debian files
 398                 if os.path.exists('debian') or os.path.islink('debian'):
 399                         if input("A debian folder already exists, do you want to remove it and whatever it links to (y/N)? ").lower() != "y":
 400                                 sys.exit(1)
 401                         deleteDebianFolder()
 402                 files = createDebianFiles(config)
 403                 # check if a file is overwritten
 404                 for file in files:
 405                         if os.path.exists(file):
 406                                 if input("Do you want to overwrite %s (y/N)? " % file).lower() != "y":
 407                                         sys.exit(1)
 408                 # run compilation
 409                 buildDebianPackage(config)
 410                 # install files
 411                 print("Installing created deb files...")
 412                 subprocess.check_call(['sudo', 'dpkg', '--install'] + files)
 413         except (subprocess.CalledProcessError, KeyboardInterrupt) as e: # for some exceptions, a stackrace is usually pointless
 414                 print(file=sys.stderr)
 415                 print(file=sys.stderr)
 416                 if isinstance(e, KeyboardInterrupt): # str(e) would be the empty string
 417                         print("Interruped by user", file=sys.stderr)
 418                 else:
 419                         print("Error during package creation: %s" % str(e), file=sys.stderr)
 420                 print(file=sys.stderr)
 421                 sys.exit(1)