b409bd1733fb6404380b649f06a824387f037fc0
[auto-debuild.git] / auto_debuild.py
1 #!/usr/bin/python
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
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 >>f, "#!/usr/bin/make -f"
105                 print >>f, ""
106                 print >>f, ".PHONY: build" # there may be a directory called "build"
107                 print >>f, ""
108                 print >>f, "build %:" # need to mention "build" here again explicitly so PHONY takes effect
109                 # write proper dh call
110                 dh = self.dh
111                 if self.dhWith:
112                         dh.append('--with='+','.join(self.dhWith))
113                 print >>f, '\t'+self.env2str()+' dh $@ '+safeCall(*dh)
114                 # write remaining rules
115                 for rule in self.rules:
116                         print >>f, ""
117                         print >>f, "override_dh_"+rule+":"
118                         for line in self.rules[rule]:
119                                 print >>f, "\t"+line
120
121 # rule-makers
122 def cmakeRules(config):
123         buildDir = config.getstr('buildDir', 'build')
124         srcDir = os.getcwd()
125         r = RulesFile()
126         r.dh += ["--buildsystem=cmake", "--builddirectory="+buildDir] # dh parameters
127         r.rules['auto_configure'] = [
128                 safeCall("mkdir", "-p", buildDir),
129                 safeCall("cd", buildDir) + " && " +
130                   safeCall("cmake", srcDir, "-DCMAKE_INSTALL_PREFIX=/usr", *config.get('cmakeParameters', []))
131         ]
132         r.rules['auto_clean'] = [safeCall('rm', '-f', os.path.join(buildDir, 'CMakeCache.txt'))] # clean old cmake cache
133         return r
134
135 def automakeRules(config):
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, 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 = RulesFile()
140         r.dh += ["--buildsystem=autoconf"]
141         r.rules['auto_configure'] = [
142                 'BUILD_TYPE=$$(dpkg-architecture -qDEB_BUILD_GNU_TYPE) && ' + # doing the expansion beforehand ensures that we cancel if it fails
143                 'MULTIARCH=$$(dpkg-architecture -qDEB_HOST_MULTIARCH) && '+
144                         './configure --build=$$BUILD_TYPE '+ # do the escape manually here so we can use the variables (there's no user-controlled string in here anyway)
145                         '--prefix=/usr --includedir=/usr/include --mandir=/usr/share/man --infodir=/usr/share/info '+
146                         '--libdir=/usr/lib/$$MULTIARCH --libexecdir=/usr/lib/$$MULTIARCH '+
147                         '--sysconfdir=/etc --localstatedir=/var '+
148                         safeCall(*config.get('automakeParameters', []))
149         ]
150         r.rules['auto_clean'] = ['rm -f config.status'] # do not re-use old configuration (no need for escaping here, obviously)
151         return r
152
153 def pythonRules(config):
154         r = RulesFile()
155         r.dh += ["--buildsystem=python_distutils"]
156         r.dhWith.add('python2')
157         r.rules['auto_clean'] = [ # clean properly
158                 'dh_auto_clean',
159                 'rm -rf build'
160         ]
161         return r
162
163 def makefileRules(config):
164         r = RulesFile()
165         r.dh += ["--buildsystem=makefile"] # makefile does the least possible harm
166         return r
167
168 def noneRules(config):
169         r = RulesFile()
170         r.dh += ["--buildsystem=makefile"] # makefile does the least possible harm
171         r.rules['auto_configure'] = []
172         r.rules['auto_build'] = []
173         r.rules['auto_clean'] = []
174         return r
175
176 # build systems
177 buildSystems = {
178         'cmake': BuildSystem(cmakeRules, ["cmake"]),
179         'automake': BuildSystem(automakeRules),
180         'python': BuildSystem(pythonRules, ["python-setuptools"], ["${python:Depends}"]),
181         'makefile': BuildSystem(makefileRules),
182         'none': BuildSystem(noneRules),
183 }
184
185 # utility functions
186 def commandInBuildEnv(config, command):
187         schroot = config.getstr('schroot')
188         if schroot is not None: command = ['schroot', '-c', schroot, '--'] + command
189         return command
190
191 def getArchitecture(config):
192         cmd = commandInBuildEnv(config, ['dpkg-architecture', '-qDEB_HOST_ARCH'])
193         p = subprocess.Popen(cmd, stdout=subprocess.PIPE)
194         res = p.communicate()[0] # get only stdout
195         if p.returncode != 0: raise Exception("Querying dpkg for the architecture failed")
196         return res[0:len(res)-1] # chop of the \n at the end
197
198 def writeDependency(f, name, list):
199         if len(list):
200                 print >>f, name+": "+', '.join(list)
201
202 # actual work functions
203 def createDebianFiles(config):
204         if not isinstance(config, ConfigDict):
205                 config = ConfigDict(config)
206         sourceName = config.getstr('sourceName')
207         binaryName = config.getstr('binaryName', sourceName+'-local')
208         name = config.getstr('name', os.getenv('USER')) # os.getlogin() fails in minimal chroots
209         email = config.getstr('email', os.getenv('USER')+'@'+os.uname()[1]) # user@hostname
210         debDir = os.path.expanduser(config.getstr('debDir'))
211         buildSystem = buildSystems[config.getstr('buildSystem')] # get the data immediately
212         version = config.getstr('version')
213         dbgPackage = config.getbool('dbgPackage', False)
214         parallelJobs = config.getint('parallelJobs', 2)
215         packageArchitecture = config.getstr('architecture', 'any')
216         withPython2 = config.getbool('withPython2', False)
217         if withPython2:
218                 buildSystem.binaryDepends.append("${python:Depends}") # HACK, but it works: make sure dependencies on binary are added
219         # we return the list of files generated, so we need to know the architecture
220         arch = getArchitecture(config)
221         files = []
222         # create folders
223         if os.path.exists('debian'): raise Exception('debian folder already exists?')
224         os.mkdir('debian')
225         os.mkdir('debian/source')
226         if not os.path.exists(debDir): os.makedirs(debDir)
227         # source format file
228         with open('debian/source/format', 'w') as f:
229                 print >>f, "3.0 (native)"
230         # compat file
231         with open('debian/compat', 'w') as f:
232                 print >>f, "9"
233         # copyright file
234         with open('debian/copyright', 'w') as f:
235                 print >>f, "Auto-generated by auto-debuild, not suited for distribution"
236         # changelog file
237         with open('debian/changelog', 'w') as f:
238                 print >>f, sourceName,"("+version+")","UNRELEASED; urgency=low"
239                 print >>f, ""
240                 print >>f, "  * Auto-generated by auto-debuild"
241                 print >>f, ""
242                 print >>f, " --",name,"<"+email+">  "+time.strftime('%a, %d %b %Y %H:%M:%S %z')
243         # control file
244         with open('debian/control', 'w') as f:
245                 print >>f, "Source:",sourceName
246                 print >>f, "Section:",config.getstr('section', 'misc')
247                 print >>f, "Priority: extra"
248                 print >>f, "Maintainer: %s <%s>" % (name, email)
249                 writeDependency(f, 'Build-Depends', ["debhelper (>= 9)"] + buildSystem.buildDepends + config.get('buildDepends', []))
250                 print >>f, "Standards-Version: 3.9.3"
251                 print >>f, ""
252                 print >>f, "Package:",binaryName
253                 print >>f, "Architecture:",packageArchitecture
254                 if 'binaryMultiArch' in config:
255                         print >>f, "Multi-Arch:",config.getstr('binaryMultiArch')
256                 writeDependency(f, "Pre-Depends", ["${misc:Pre-Depends}"] + config.get('binaryPreDepends', []))
257                 writeDependency(f, "Depends", ["${shlibs:Depends}", "${misc:Depends}"] + buildSystem.binaryDepends +
258                         config.get('binaryDepends', []))
259                 writeDependency(f, "Recommends", config.get('binaryRecommends', []))
260                 writeDependency(f, "Provides", config.get('binaryProvides', [sourceName]))
261                 writeDependency(f, "Conflicts", config.get('binaryConflicts', []))
262                 writeDependency(f, "Breaks", config.get('binaryBreaks', []) + config.get('binaryBreaksReplaces', []))
263                 writeDependency(f, "Replaces", config.get('binaryReplaces', []) + config.get('binaryBreaksReplaces', []))
264                 print >>f, "Description:",sourceName,"(auto-debuild)"
265                 print >>f, " Package auto-generated by auto-debuild."
266                 files.append(os.path.join(debDir, "%s_%s_%s.deb" % (binaryName, version, arch)))
267                 if dbgPackage:
268                         print >>f, ""
269                         print >>f, "Package:",binaryName+"-dbg"
270                         print >>f, "Section: debug"
271                         print >>f, "Priority: extra"
272                         print >>f, "Architecture:",packageArchitecture
273                         writeDependency(f, "Depends", ["${misc:Depends}", binaryName+" (= ${binary:Version})"])
274                         print >>f, "Description:",sourceName,"debug smbols (auto-debuild)"
275                         print >>f, " Package containing debug symbols for "+sourceName+", auto-generated by auto-debuild."
276                         files.append(os.path.join(debDir, "%s-dbg_%s_%s.deb" % (binaryName, version, arch)))
277         # install file
278         with open('debian/'+binaryName+'.install', 'w') as f:
279                 for line in config.get('binaryInstallFiles', []):
280                         if line.startswith('/'): # a file from within the package, not from the source tree
281                                 line = 'debian/'+binaryName+line
282                         print >>f, line
283         # maintainer scripts for alternatives
284         if 'alternatives' in config:
285                 with open('debian/'+binaryName+'.postinst', 'w') as f:
286                         print >>f, "#!/bin/sh"
287                         print >>f, "set -e"
288                         print >>f, 'if [ "$1" = "configure" ]; then'
289                         for alternative in config.get('alternatives'):
290                                 alternative = shlex.split(alternative)
291                                 print >>f, safeCall('update-alternatives', '--install', alternative[0], alternative[1], alternative[2], alternative[3])
292                         print >>f, 'fi'
293                         print >>f, ''
294                         print >>f, '#DEBHELPER#'
295                         print >>f, ''
296                         print >>f, 'exit 0'
297                 with open('debian/'+binaryName+'.prerm', 'w') as f:
298                         print >>f, "#!/bin/sh"
299                         print >>f, "set -e"
300                         print >>f, 'if [ "$1" = "remove" ]; then'
301                         for alternative in config.get('alternatives'):
302                                 alternative = shlex.split(alternative)
303                                 print >>f, safeCall('update-alternatives', '--remove', alternative[1], alternative[2])
304                         print >>f, 'fi'
305                         print >>f, ''
306                         print >>f, '#DEBHELPER#'
307                         print >>f, ''
308                         print >>f, 'exit 0'
309         # rules file: build system specific
310         with open('debian/rules', 'w') as f:
311                 # get rule file for build system: may only touch auto_config and auto_clean rules and the dh options
312                 r = buildSystem.ruleMaker(config)
313                 # global rules
314                 r.env["DEB_BUILD_OPTIONS"] = 'parallel='+str(parallelJobs)
315                 if not dbgPackage:
316                         # disable debug information
317                         r.env["DEB_CFLAGS_APPEND"] = '-g0'
318                         r.env["DEB_CXXFLAGS_APPEND"] = '-g0'
319                 r.dh += ['--parallel']
320                 if withPython2:
321                         r.dhWith.add('python2')
322                         r.rules['python2'] = ['dh_python2 --no-guessing-versions']
323                 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...)
324                 r.rules['auto_test'] = []
325                 # installation rule
326                 r.rules['auto_install'] = [safeCall('dh_auto_install', '--destdir=debian/'+binaryName)] # install everything into the binary package
327                 if 'binarySkipFiles' in config:
328                         r.rules['auto_install'].append(safeCall('cd', 'debian/'+binaryName) + " && " +
329                                 safeCall('rm', *config.get('binarySkipFiles')))
330                 # for debug packages
331                 if dbgPackage:
332                         r.rules['strip'] = [safeCall('dh_strip', '--dbg-package='+binaryName+"-dbg")] # put debug files in appropriate package
333                         r.rules['installdocs'] = [safeCall('dh_installdocs', '--link-doc='+binaryName)] # make the doc folder of the dbg package a symlink
334                 # wait after configuration?
335                 if config.getbool('waitAfterConfig', False):
336                         if not 'auto_configure' in r.rules: r.rules['auto_configure'] = ['dh_auto_configure'] # make sure there is an override
337                         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...
338                 # dump it to a file
339                 r.write(f)
340         mode = os.stat('debian/rules').st_mode
341         os.chmod('debian/rules', mode | stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH)
342         # return list of files that will be created
343         return files
344
345 def buildDebianPackage(config):
346         if not isinstance(config, ConfigDict):
347                 config = ConfigDict(config)
348         commands = ['dpkg-checkbuilddeps', 'debian/rules clean', 'debian/rules build', 'fakeroot debian/rules binary']
349         command = ['bash', '-c', ' && '.join(commands)] # make it all one command, so we don't have to open and close the chroot too often
350         subprocess.check_call(commandInBuildEnv(config, command))
351         shutil.rmtree('debian') # it only contains what we just created
352
353 ###################################################################
354 # if we are called directly as script
355 if __name__ == "__main__":
356         try:
357                 # get config
358                 config = loadConfigFile('auto-debuild.conf')
359                 # generate debian files
360                 if os.path.exists('debian'):
361                         if raw_input("A debian folder already exists, to you want to remove it (y/N)? ").lower() != "y":
362                                 sys.exit(1)
363                         shutil.rmtree('debian')
364                 files = createDebianFiles(config)
365                 # check if a file is overwritten
366                 for file in files:
367                         if os.path.exists(file):
368                                 if raw_input("Do you want to overwrite %s (y/N)? " % file).lower() != "y":
369                                         sys.exit(1)
370                 # run compilation
371                 buildDebianPackage(config)
372                 # install files
373                 print "Installing created deb files..."
374                 subprocess.check_call(['sudo', 'dpkg', '--install'] + files)
375         except (subprocess.CalledProcessError, KeyboardInterrupt) as e: # for some exceptions, a stackrace is usually pointless
376                 print >> sys.stderr
377                 print >> sys.stderr
378                 if isinstance(e, KeyboardInterrupt): # str(e) would be the empty string
379                         print >> sys.stderr, "Interruped by user"
380                 else:
381                         print >> sys.stderr, "Error during package creation: %s" % str(e)
382                 print >> sys.stderr
383                 sys.exit(1)