auto_debuild.py

   1 #!/usr/bin/python
   2 import os, stat, time, subprocess, sys
   3 from collections import OrderedDict
   4
   5 # abstract representation of rules file
   6 class RulesFile:
   7         def __init__(self):
   8                 self.env = []
   9                 self.dh = []
  10                 self.rules = OrderedDict()
  11
  12         def write(self, f):
  13                 print >>f, "#!/usr/bin/make -f"
  14                 print >>f, ""
  15                 print >>f, "%:"
  16                 print >>f, '\t'+' '.join(self.env)+' dh $@',' '.join(self.dh)
  17                 for rule in self.rules:
  18                         print >>f, ""
  19                         print >>f, "override_dh_"+rule+":"
  20                         for line in self.rules[rule]:
  21                                 print >>f, "\t"+line
  22
  23 # build-system specific part of rules file
  24 def cmakeRules(config):
  25         r = RulesFile()
  26         r.dh += ["--buildsystem=cmake", "--builddirectory=build.dir"] # dh parameters: "build" is not a good idea, as that's also the name of a target...
  27         r.rules['auto_configure'] = [
  28                 'mkdir -p build.dir',
  29                 "cd build.dir && cmake .. -DCMAKE_INSTALL_PREFIX=/usr "+' '.join(config.get('cmakeParameters', []))
  30         ]
  31         r.rules['auto_clean'] = ['rm -f build.dir/CMakeCache.txt'] # clean old cmake cache
  32         return r
  33
  34 def automakeRules(config):
  35         r = RulesFile()
  36         r.dh += ["--buildsystem=autoconf"]
  37         r.rules['auto_configure'] = [
  38                 'BUILD_TYPE=$$(dpkg-architecture -qDEB_BUILD_GNU_TYPE) && ' + # doing the expansion beforehand ensures that we cancel if it fails
  39                 'MULTIARCH=$$(dpkg-architecture -qDEB_BUILD_MULTIARCH) && '+
  40                         './configure --build=$$BUILD_TYPE ' +
  41                         '--prefix=/usr --includedir=/usr/include --mandir=/usr/share/man --infodir=/usr/share/info ' +
  42                         '--libdir=/usr/lib/$$MULTIARCH --libexecdir=/usr/lib/$$MULTIARCH '+
  43                         '--sysconfdir=/etc --localstatedir=/var ' +
  44                         ' '.join(config.get('automakeParameters', []))
  45         ]
  46         r.rules['auto_clean'] = ['rm -f config.status'] # do not re-use old configuration
  47         return r
  48
  49 # utility functions
  50 def commandInBuildEnv(config, command):
  51         schroot = config.get('schroot')
  52         if schroot is not None: command = ['schroot', '-c', schroot, '--'] + command
  53         return command
  54
  55 def getArchitecture(config):
  56         cmd = commandInBuildEnv(config, ['dpkg-architecture', '-qDEB_BUILD_ARCH'])
  57         p = subprocess.Popen(cmd, stdout=subprocess.PIPE)
  58         res = p.communicate()[0] # get only stdout
  59         if p.returncode != 0: raise Exception("Querying dpkg for the architecture failed")
  60         return res[0:len(res)-1] # chop of the \n at the end
  61
  62 def writeDependency(f, name, list):
  63         if len(list):
  64                 print >>f, name+": "+', '.join(list)
  65
  66 # actual work functions
  67 def createDebianFiles(config):
  68         sourceName = config['sourceName']
  69         binaryName = config.get('binaryName', sourceName+'-local')
  70         name = config.get('name', os.getlogin())
  71         email = config.get('email', os.getlogin()+'@'+os.uname()[1]) # user@hostname
  72         debDir = os.path.expanduser(config['debDir'])
  73         buildSystem = config['buildSystem']
  74         version = config['version']
  75         dbgPackage = config.get('dbgPackage', False)
  76         packageArchitecture = config.get('architecture', 'any')
  77         # we return the list of files generated, so we need to know the architecture
  78         arch = getArchitecture(config)
  79         files = []
  80         # source format file
  81         if not os.path.exists('debian/source'): os.mkdir('debian/source')
  82         with open('debian/source/format', 'w') as f:
  83                 print >>f, "3.0 (native)"
  84         # compat file
  85         with open('debian/compat', 'w') as f:
  86                 print >>f, "9"
  87         # copyright file
  88         with open('debian/copyright', 'w') as f:
  89                 print >>f, "Auto-generated by auto-debuild, not suited for distribution"
  90         # changelog file
  91         with open('debian/changelog', 'w') as f:
  92                 print >>f, sourceName,"("+version+")","UNRELEASED; urgency=low"
  93                 print >>f, ""
  94                 print >>f, "  * Auto-generated by auto-debuild"
  95                 print >>f, ""
  96                 print >>f, " --",name,"<"+email+">  "+time.strftime('%a, %d %b %Y %H:%M:%S %z')
  97         # control file
  98         with open('debian/control', 'w') as f:
  99                 print >>f, "Source:",sourceName
 100                 print >>f, "Section:",config.get('section', 'misc')
 101                 print >>f, "Priority: extra"
 102                 print >>f, "Maintainer: %s <%s>" % (name, email)
 103                 writeDependency(f, 'Build-Depends', ["debhelper (>= 9)"] + config.get('buildDepends', []))
 104                 print >>f, "Standards-Version: 3.9.3"
 105                 print >>f, ""
 106                 print >>f, "Package:",binaryName
 107                 print >>f, "Architecture:",packageArchitecture
 108                 writeDependency(f, "Pre-Depends", ["${misc:Pre-Depends}"] + config.get('binaryPreDepends', []))
 109                 writeDependency(f, "Depends", ["${shlibs:Depends}", "${misc:Depends}"] + config.get('binaryDepends', []))
 110                 writeDependency(f, "Recommends", config.get('binaryRecommends', []))
 111                 writeDependency(f, "Provides", config.get('binaryProvides', [sourceName]))
 112                 print >>f, "Description:",sourceName,"(auto-debuild)"
 113                 print >>f, " Package auto-generated by auto-debuild."
 114                 files.append(os.path.join(debDir, "%s_%s_%s.deb" % (binaryName, version, arch)))
 115                 if dbgPackage:
 116                         print >>f, ""
 117                         print >>f, "Package:",binaryName+"-dbg"
 118                         print >>f, "Architecture:",packageArchitecture
 119                         writeDependency(f, "Depends", ["${misc:Depends}", binaryName+" (= ${binary:Version})"])
 120                         print >>f, "Description:",sourceName,"debug smbols (auto-debuild)"
 121                         print >>f, " Package containing debug symbols for "+sourceName+", auto-generated by auto-debuild."
 122                         files.append(os.path.join(debDir, "%s-dbg_%s_%s.deb" % (binaryName, version, arch)))
 123         # rules file: build system specific
 124         with open('debian/rules', 'w') as f:
 125                 # get rule file for build system: may only touch auto_config and auto_clean rules and the dh options
 126                 if buildSystem == 'cmake':
 127                         r = cmakeRules(config)
 128                 elif buildSystem == 'automake':
 129                         r = automakeRules(config)
 130                 else:
 131                         raise Exception("Invalid build system "+buildSystem)
 132                 # global rules
 133                 r.env += ["DEB_BUILD_OPTIONS='parallel=2'"]
 134                 if not dbgPackage: r.env += ["DEB_CFLAGS_APPEND='-g0'", "DEB_CXXFLAGS_APPEND='-g0'"] # disable debug information
 135                 r.dh += ['--parallel']
 136                 r.rules['builddeb'] = ['dh_builddeb --destdir='+debDir] # passing this gobally to dh results in weird problems (like stuff being installed there, and not in the package...)
 137                 r.rules['auto_test'] = []
 138                 r.rules['auto_install'] = ['dh_auto_install --destdir=debian/'+binaryName] # install everything into the binary package
 139                 # for debug packages
 140                 if dbgPackage:
 141                         r.rules['strip'] = ['dh_strip --dbg-package='+binaryName+"-dbg"] # put debug files in appropriate package
 142                         r.rules['installdocs'] = ['dh_installdocs --link-doc='+binaryName] # make the doc folder of the dbg package a symlink
 143                 # dump it to a file
 144                 r.write(f)
 145         mode = os.stat('debian/rules').st_mode
 146         os.chmod('debian/rules', mode | stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH)
 147         # return list of files affected
 148         return files
 149
 150 def buildDebianPackage(config):
 151         commands = ['dpkg-checkbuilddeps', 'debian/rules clean', 'debian/rules build', 'fakeroot debian/rules binary', 'debian/rules clean']
 152         command = ['bash', '-c', ' && '.join(commands)]
 153         subprocess.check_call(commandInBuildEnv(config, command))
 154
 155 # all at once
 156 def createAndInstall(config, overwriteCheck = False):
 157         # generate debian files
 158         files = createDebianFiles(config)
 159         # check if a file is overwritten
 160         if overwriteCheck:
 161                 for file in files:
 162                         if os.path.exists(file):
 163                                 if raw_input("Do you want to overwrite %s (y/N)? " % file).lower() != "y":
 164                                         sys.exit(1)
 165         # run compilation
 166         buildDebianPackage(config)
 167         # install files
 168         print "Installing created deb files..."
 169         subprocess.check_call(['sudo', 'dpkg', '--install'] + files)
 170
 171 # if we are called directly as script
 172 if __name__ == "__main__":
 173         # get config
 174         import imp
 175         config = imp.load_source('config', 'debian/auto-debuild.conf').__dict__
 176         os.remove('debian/auto-debuild.confc')
 177         # and go for it
 178         createAndInstall(config, overwriteCheck=True)