auto_debuild.py

   1 #!/usr/bin/python
   2 import os, shutil, stat, time, subprocess, sys
   3 from collections import OrderedDict
   4
   5 # some utility functions
   6 def safeCall(*args):
   7         res = ""
   8         for arg in args:
   9                 assert arg.find("'") < 0 # ' is not supported
  10                 if len(res): res += " "
  11                 res += "'"+arg+"'"
  12         return res
  13
  14 # abstract representation of rules file
  15 class RulesFile:
  16         def __init__(self):
  17                 self.env = {}
  18                 self.dh = []
  19                 self.rules = OrderedDict()
  20
  21         def env2str(self):
  22                 res = ""
  23                 for name in self.env: # we rely on the name being sane (i.e., no special characters)
  24                         val = self.env[name]
  25                         assert val.find("'") < 0 # ' is not supported
  26                         if len(res): res += " "
  27                         res += name+"='"+val+"'"
  28                 return res
  29
  30         def write(self, f):
  31                 print >>f, "#!/usr/bin/make -f"
  32                 print >>f, ""
  33                 print >>f, ".PHONY: build" # there may be a directory called "build"
  34                 print >>f, ""
  35                 print >>f, "build %:" # need to mention "build" here again explicitly
  36                 print >>f, '\t'+self.env2str()+' dh $@ '+safeCall(*self.dh)
  37                 for rule in self.rules:
  38                         print >>f, ""
  39                         print >>f, "override_dh_"+rule+":"
  40                         for line in self.rules[rule]:
  41                                 print >>f, "\t"+line
  42
  43 # build-system specific part of rules file
  44 def cmakeRules(config):
  45         buildDir = config.get('buildDir', 'build')
  46         srcDir = os.getcwd()
  47         r = RulesFile()
  48         r.dh += ["--buildsystem=cmake", "--builddirectory="+buildDir] # dh parameters
  49         r.rules['auto_configure'] = [
  50                 safeCall("mkdir", "-p", buildDir),
  51                 safeCall("cd", buildDir) + " && " +
  52                   safeCall("cmake", srcDir, "-DCMAKE_INSTALL_PREFIX=/usr", *config.get('cmakeParameters', []))
  53         ]
  54         r.rules['auto_clean'] = [safeCall('rm', '-f', os.path.join(buildDir, 'CMakeCache.txt'))] # clean old cmake cache
  55         return r
  56
  57 def automakeRules(config):
  58         # "build" is what we are building *on*, and "host" is what we are building *for* (and GNU is weird...)
  59         # also, we don't really support cross-building... ;-) (to do, we'd have to write shell code that checks whether BUILD_GNU_TYPE
  60         #  and HOST_GNU_TYPE are equal, and if they are not, add a --host parameter)
  61         r = RulesFile()
  62         r.dh += ["--buildsystem=autoconf"]
  63         r.rules['auto_configure'] = [
  64                 'BUILD_TYPE=$$(dpkg-architecture -qDEB_BUILD_GNU_TYPE) && ' + # doing the expansion beforehand ensures that we cancel if it fails
  65                 'MULTIARCH=$$(dpkg-architecture -qDEB_HOST_MULTIARCH) && '+
  66                         './configure --build=$$BUILD_TYPE '+ # do the escape manually here so we can use the variables (there's no user-controlled string in here anyway)
  67                         '--prefix=/usr --includedir=/usr/include --mandir=/usr/share/man --infodir=/usr/share/info '+
  68                         '--libdir=/usr/lib/$$MULTIARCH --libexecdir=/usr/lib/$$MULTIARCH '+
  69                         '--sysconfdir=/etc --localstatedir=/var '+
  70                         safeCall(*config.get('automakeParameters', []))
  71         ]
  72         r.rules['auto_clean'] = ['rm -f config.status'] # do not re-use old configuration (no need for escaping here, obviously)
  73         return r
  74
  75 # utility functions
  76 def commandInBuildEnv(config, command):
  77         schroot = config.get('schroot')
  78         if schroot is not None: command = ['schroot', '-c', schroot, '--'] + command
  79         return command
  80
  81 def getArchitecture(config):
  82         cmd = commandInBuildEnv(config, ['dpkg-architecture', '-qDEB_HOST_ARCH'])
  83         p = subprocess.Popen(cmd, stdout=subprocess.PIPE)
  84         res = p.communicate()[0] # get only stdout
  85         if p.returncode != 0: raise Exception("Querying dpkg for the architecture failed")
  86         return res[0:len(res)-1] # chop of the \n at the end
  87
  88 def writeDependency(f, name, list):
  89         if len(list):
  90                 print >>f, name+": "+', '.join(list)
  91
  92 # actual work functions
  93 def createDebianFiles(config):
  94         sourceName = config['sourceName']
  95         binaryName = config.get('binaryName', sourceName+'-local')
  96         name = config.get('name', os.getenv('USER')) # os.getlogin() fails in minimal chroots
  97         email = config.get('email', os.getenv('USER')+'@'+os.uname()[1]) # user@hostname
  98         debDir = os.path.expanduser(config['debDir'])
  99         buildSystem = config['buildSystem']
 100         version = config['version']
 101         dbgPackage = config.get('dbgPackage', False)
 102         parallelJobs = int(config.get('parallelJobs', 2))
 103         packageArchitecture = config.get('architecture', 'any')
 104         # we return the list of files generated, so we need to know the architecture
 105         arch = getArchitecture(config)
 106         files = []
 107         # create folders
 108         if os.path.exists('debian'): raise Exception('debian folder already exists?')
 109         os.mkdir('debian')
 110         os.mkdir('debian/source')
 111         if not os.path.exists(debDir): os.mkdir(debDir)
 112         # source format file
 113         with open('debian/source/format', 'w') as f:
 114                 print >>f, "3.0 (native)"
 115         # compat file
 116         with open('debian/compat', 'w') as f:
 117                 print >>f, "9"
 118         # copyright file
 119         with open('debian/copyright', 'w') as f:
 120                 print >>f, "Auto-generated by auto-debuild, not suited for distribution"
 121         # changelog file
 122         with open('debian/changelog', 'w') as f:
 123                 print >>f, sourceName,"("+version+")","UNRELEASED; urgency=low"
 124                 print >>f, ""
 125                 print >>f, "  * Auto-generated by auto-debuild"
 126                 print >>f, ""
 127                 print >>f, " --",name,"<"+email+">  "+time.strftime('%a, %d %b %Y %H:%M:%S %z')
 128         # control file
 129         with open('debian/control', 'w') as f:
 130                 print >>f, "Source:",sourceName
 131                 print >>f, "Section:",config.get('section', 'misc')
 132                 print >>f, "Priority: extra"
 133                 print >>f, "Maintainer: %s <%s>" % (name, email)
 134                 writeDependency(f, 'Build-Depends', ["debhelper (>= 9)"] + config.get('buildDepends', []))
 135                 print >>f, "Standards-Version: 3.9.3"
 136                 print >>f, ""
 137                 print >>f, "Package:",binaryName
 138                 print >>f, "Architecture:",packageArchitecture
 139                 writeDependency(f, "Pre-Depends", ["${misc:Pre-Depends}"] + config.get('binaryPreDepends', []))
 140                 writeDependency(f, "Depends", ["${shlibs:Depends}", "${misc:Depends}"] + config.get('binaryDepends', []))
 141                 writeDependency(f, "Recommends", config.get('binaryRecommends', []))
 142                 writeDependency(f, "Provides", config.get('binaryProvides', [sourceName]))
 143                 print >>f, "Description:",sourceName,"(auto-debuild)"
 144                 print >>f, " Package auto-generated by auto-debuild."
 145                 files.append(os.path.join(debDir, "%s_%s_%s.deb" % (binaryName, version, arch)))
 146                 if dbgPackage:
 147                         print >>f, ""
 148                         print >>f, "Package:",binaryName+"-dbg"
 149                         print >>f, "Architecture:",packageArchitecture
 150                         writeDependency(f, "Depends", ["${misc:Depends}", binaryName+" (= ${binary:Version})"])
 151                         print >>f, "Description:",sourceName,"debug smbols (auto-debuild)"
 152                         print >>f, " Package containing debug symbols for "+sourceName+", auto-generated by auto-debuild."
 153                         files.append(os.path.join(debDir, "%s-dbg_%s_%s.deb" % (binaryName, version, arch)))
 154         # install file
 155         with open('debian/'+binaryName+'.install', 'w') as f:
 156                 for line in config.get('binaryInstallFiles', []):
 157                         if line.startswith('/'): # a file from within the package, not from the source tree
 158                                 line = 'debian/'+binaryName+line
 159                         print >>f, line
 160         # rules file: build system specific
 161         with open('debian/rules', 'w') as f:
 162                 # get rule file for build system: may only touch auto_config and auto_clean rules and the dh options
 163                 if buildSystem == 'cmake':
 164                         r = cmakeRules(config)
 165                 elif buildSystem == 'automake':
 166                         r = automakeRules(config)
 167                 else:
 168                         raise Exception("Invalid build system "+buildSystem)
 169                 # global rules
 170                 r.env["DEB_BUILD_OPTIONS"] = 'parallel='+str(parallelJobs)
 171                 if not dbgPackage:
 172                         # disable debug information
 173                         r.env["DEB_CFLAGS_APPEND"] = '-g0'
 174                         r.env["DEB_CXXFLAGS_APPEND"] = '-g0'
 175                 r.dh += ['--parallel']
 176                 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...)
 177                 r.rules['auto_test'] = []
 178                 # installation rule
 179                 r.rules['auto_install'] = [safeCall('dh_auto_install', '--destdir=debian/'+binaryName)] # install everything into the binary package
 180                 if 'binarySkipFiles' in config:
 181                         r.rules['auto_install'].append(safeCall('cd', 'debian/'+binaryName) + " && " +
 182                                 safeCall('rm', *config['binarySkipFiles']))
 183                 # for debug packages
 184                 if dbgPackage:
 185                         r.rules['strip'] = [safeCall('dh_strip', '--dbg-package='+binaryName+"-dbg")] # put debug files in appropriate package
 186                         r.rules['installdocs'] = [safeCall('dh_installdocs', '--link-doc='+binaryName)] # make the doc folder of the dbg package a symlink
 187                 # wait after configuration?
 188                 if config.get('waitAfterConfig', False):
 189                         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...
 190                 # dump it to a file
 191                 r.write(f)
 192         mode = os.stat('debian/rules').st_mode
 193         os.chmod('debian/rules', mode | stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH)
 194         # return list of files that will be created
 195         return files
 196
 197 def buildDebianPackage(config):
 198         commands = ['dpkg-checkbuilddeps', 'debian/rules clean', 'debian/rules build', 'fakeroot debian/rules binary', 'debian/rules clean']
 199         command = ['bash', '-c', ' && '.join(commands)] # make it all one command, so we don't have to open and close the chroot too often
 200         subprocess.check_call(commandInBuildEnv(config, command))
 201         shutil.rmtree('debian') # it only contains what we just created
 202
 203 ###################################################################
 204 # if we are called directly as script
 205 if __name__ == "__main__":
 206         try:
 207                 import imp
 208                 # get config
 209                 config = imp.load_source('config', 'auto-debuild.conf').__dict__
 210                 os.remove('auto-debuild.confc')
 211                 # generate debian files
 212                 if os.path.exists('debian'):
 213                         if raw_input("A debian folder already exists, to you want to remove it (y/N)? ").lower() != "y":
 214                                 sys.exit(1)
 215                         shutil.rmtree('debian')
 216                 files = createDebianFiles(config)
 217                 # check if a file is overwritten
 218                 for file in files:
 219                         if os.path.exists(file):
 220                                 if raw_input("Do you want to overwrite %s (y/N)? " % file).lower() != "y":
 221                                         sys.exit(1)
 222                 # run compilation
 223                 buildDebianPackage(config)
 224                 # install files
 225                 print "Installing created deb files..."
 226                 subprocess.check_call(['sudo', 'dpkg', '--install'] + files)
 227         except (subprocess.CalledProcessError, KeyboardInterrupt) as e: # for some exceptions, a stackrace is usually pointless
 228                 print >> sys.stderr
 229                 print >> sys.stderr
 230                 if isinstance(e, KeyboardInterrupt): # str(e) would be the empty string
 231                         print >> sys.stderr, "Interruped by user"
 232                 else:
 233                         print >> sys.stderr, "Error during package creation: %s" % str(e)
 234                 print >> sys.stderr
 235                 sys.exit(1)