2 # auto-debuild - Automatic Generation of Debian Packages
3 # Copyright (C) 2012 Ralf Jung <post@ralfj.de>
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.
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.
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.
19 import os, shutil, stat, time, subprocess, sys, shlex, tempfile, argparse, multiprocessing
20 from collections import OrderedDict
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
27 if isinstance(val, list):
28 if len(val) != 1: raise Exception('%s is a list, but it should not' % name)
33 def getint(self, name, default = None):
34 return int(self.getstr(name, default))
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')
41 # create a safe-to-call shell command from the array
45 assert arg.find("'") < 0 # ' is not supported
46 if len(res): res += " "
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):
55 with open(file) as file:
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)
64 if not len(line) or line.startswith("#"): continue # skip empty and comment lines
68 result[curKey] += shlex.split(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
75 raise Exception("Invalid config, line %d: Error parsing line (quoting issue?)" % linenr)
76 # add some convencience get functions
79 # representation of a build system
81 def __init__(self, ruleMaker, buildDepends = [], binaryDepends = []):
82 self.ruleMaker = ruleMaker
83 self.buildDepends = buildDepends
84 self.binaryDepends = binaryDepends
86 # abstract representation of rules file
92 self.rules = OrderedDict()
96 for name in self.env: # we rely on the name being sane (i.e., no special characters)
98 assert val.find("'") < 0 # ' is not supported
99 if len(res): res += " "
100 res += name+"='"+val+"'"
104 print("#!/usr/bin/make -f", file=f)
106 print(".PHONY: build", file=f) # there may be a directory called "build"
109 # write proper dh call
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:
117 print("override_dh_"+rule+":", file=f)
118 for line in self.rules[rule]:
119 print("\t"+line, file=f)
122 def cmakeRules(r, config):
123 buildDir = config.getstr('buildDir', 'build')
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', []))
131 r.rules['auto_clean'] = [safeCall('rm', '-f', os.path.join(buildDir, 'CMakeCache.txt'))] # clean old cmake cache
133 def automakeRules(r, config):
134 buildDir = config.getstr('buildDir', 'build')
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', []))
152 r.rules['auto_clean'] = [safeCall("rm", "-f", "--", buildDir+"/config.status")] # do not re-use old configuration
154 def makefileRules(r, config):
155 r.dh += ["--buildsystem=makefile"]
156 r.rules['auto_configure'] = []
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'] = []
167 'cmake': BuildSystem(cmakeRules, ["cmake"]),
168 'automake': BuildSystem(automakeRules),
169 'makefile': BuildSystem(makefileRules),
170 'none': BuildSystem(noneRules),
174 def commandInBuildEnv(config, command):
175 schroot = config.getstr('schroot')
176 if schroot is not None: command = ['schroot', '-c', schroot, '--'] + command
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
184 def writeDependency(f, name, list):
186 print(name+": "+', '.join(list), file=f)
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)
195 elif os.path.exists('debian'):
196 shutil.rmtree('debian')
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 parallelJobs = config.getint('parallelJobs', multiprocessing.cpu_count()+1)
211 packageArchitecture = config.getstr('architecture', 'any')
212 withPython2 = config.getbool('withPython2', False)
213 withSIP = config.getbool('withSIP', False)
214 withAutoreconf = config.getbool('withAutoreconf', False)
215 # add some build dependencies (a bit hacky adding it to the build system...)
218 buildSystem.buildDepends.append("python-sip")
219 buildSystem.binaryDepends.append("${sip:Depends}")
221 buildSystem.buildDepends.append("python")
222 buildSystem.binaryDepends.append("${python:Depends}")
224 buildSystem.buildDepends.append("dh-autoreconf")
225 # we return the list of files generated, so we need to know the architecture
226 arch = getArchitecture(config)
229 if os.path.exists('debian') or os.path.islink('debian'): raise Exception('debian folder already exists?')
230 if config.getbool('useTmp', True):
231 tempdir = tempfile.mkdtemp(prefix='auto-debuild-')
232 os.symlink(tempdir, 'debian')
235 if not os.path.exists(debDir): os.makedirs(debDir)
237 os.mkdir('debian/source')
238 with open('debian/source/format', 'w') as f:
239 print("3.0 (native)", file=f)
241 with open('debian/compat', 'w') as f:
244 with open('debian/copyright', 'w') as f:
245 print("Auto-generated by auto-debuild, not suited for distribution", file=f)
247 with open('debian/changelog', 'w') as f:
248 print(sourceName,"("+fullVersion+")","UNRELEASED; urgency=low", file=f)
250 print(" * Auto-generated by auto-debuild", file=f)
252 print(" --",name,"<"+email+"> "+time.strftime('%a, %d %b %Y %H:%M:%S %z'), file=f)
254 with open('debian/control', 'w') as f:
256 print("Source:",sourceName, file=f)
257 print("Section:",config.getstr('section', 'misc'), file=f)
258 print("Priority: extra", file=f)
259 print("Maintainer: %s <%s>" % (name, email), file=f)
260 writeDependency(f, 'Build-Depends', ["debhelper (>= 9)"] + buildSystem.buildDepends + config.get('buildDepends', []))
261 print("Standards-Version: 3.9.3", file=f)
262 # main binary package
264 print("Package:",binaryName, file=f)
265 print("Architecture:",packageArchitecture, file=f)
266 if 'binaryMultiArch' in config:
267 print("Multi-Arch:",config.getstr('binaryMultiArch'), file=f)
268 writeDependency(f, "Pre-Depends", ["${misc:Pre-Depends}"] + config.get('binaryPreDepends', []))
269 writeDependency(f, "Depends", ["${shlibs:Depends}", "${misc:Depends}"] + buildSystem.binaryDepends +
270 config.get('binaryDepends', []))
271 writeDependency(f, "Recommends", config.get('binaryRecommends', []))
272 writeDependency(f, "Provides", config.get('binaryProvides', [sourceName]))
273 writeDependency(f, "Conflicts", config.get('binaryConflicts', []))
274 writeDependency(f, "Breaks", config.get('binaryBreaks', []) + config.get('binaryBreaksReplaces', []))
275 writeDependency(f, "Replaces", config.get('binaryReplaces', []) + config.get('binaryBreaksReplaces', []))
276 print("Description:",sourceName,"(auto-debuild)", file=f)
277 print(" Package auto-generated by auto-debuild.", file=f)
278 files.append(os.path.join(debDir, "{}_{}_{}.deb".format(binaryName, version, arch)))
279 files.append(os.path.join(debDir, "{}-dbgsym_{}_{}.deb".format(binaryName, version, arch)))
281 for shim in config.get('binaryShims', []):
283 print("Package:",shim, file=f)
284 print("Section:",config.getstr('section', 'misc'), 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,"shim for",shim,"(auto-debuild)", file=f)
289 print(" Package pretending to be "+shim+", auto-generated by auto-debuild.", file=f)
290 files.append(os.path.join(debDir, "{}_{}_{}.deb".format(shim, version, arch)))
292 with open('debian/'+binaryName+'.install', 'w') as f:
293 for line in config.get('binaryInstallFiles', []):
294 if line.startswith('/'): # a file from within the package, not from the source tree
295 line = 'debian/'+binaryName+line
297 # maintainer scripts for alternatives
298 if 'alternatives' in config:
299 with open('debian/'+binaryName+'.postinst', 'w') as f:
300 print("#!/bin/sh", file=f)
301 print("set -e", file=f)
302 print('if [ "$1" = "configure" ]; then', file=f)
303 for alternative in config.get('alternatives'):
304 alternative = shlex.split(alternative)
305 print(safeCall('update-alternatives', '--install', alternative[0], alternative[1], alternative[2], alternative[3]), file=f)
308 print('#DEBHELPER#', file=f)
310 print('exit 0', file=f)
311 with open('debian/'+binaryName+'.prerm', 'w') as f:
312 print("#!/bin/sh", file=f)
313 print("set -e", file=f)
314 print('if [ "$1" = "remove" ]; then', file=f)
315 for alternative in config.get('alternatives'):
316 alternative = shlex.split(alternative)
317 print(safeCall('update-alternatives', '--remove', alternative[1], alternative[2]), file=f)
320 print('#DEBHELPER#', file=f)
322 print('exit 0', file=f)
323 # rules file: build system specific
324 with open('debian/rules', 'w') as f:
325 # pre-fill rule file with our global defaults
327 r.rules['auto_test'] = []
328 r.rules['auto_install'] = [safeCall('dh_auto_install', '--destdir=debian/'+binaryName)] # install everything into the binary package
329 r.rules['auto_configure'] = ['dh_auto_configure'] # make sure there is an override (we may just append to it later)
330 # patch rule file for build system: may only touch auto_* rules and the dh options
331 buildSystem.ruleMaker(r, config)
333 r.env["DEB_BUILD_OPTIONS"] = 'parallel='+str(parallelJobs)
334 r.dh += ['--parallel']
336 r.dhWith.add('python2')
337 r.rules['python2'] = ['dh_python2 --no-guessing-versions --no-shebang-rewrite']
339 r.rules['python2'].append(safeCall('dh_sip', '-p'+binaryName))
341 r.dhWith.add('autoreconf')
342 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...)
344 if 'binarySkipFiles' in config:
345 r.rules['auto_install'].append(safeCall('cd', 'debian/'+binaryName) + " && " + safeCall('rm', *config.get('binarySkipFiles')))
346 # make the doc folder of the other packages a symlink (dbg, shims)
347 r.rules['installdocs'] = [safeCall('dh_installdocs', '--link-doc='+binaryName)]
348 # wait after configuration?
349 if config.getbool('waitAfterConfig', False):
350 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...
353 mode = os.stat('debian/rules').st_mode
354 os.chmod('debian/rules', mode | stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH)
355 # return list of files that will be created
358 def buildDebianPackage(config):
359 if not isinstance(config, ConfigDict):
360 config = ConfigDict(config)
361 commands = ['dpkg-checkbuilddeps', 'debian/rules clean', 'debian/rules build', 'fakeroot debian/rules binary']
362 command = ['bash', '-c', ' && '.join(commands)] # make it all one command, so we don't have to open and close the chroot too often
363 subprocess.check_call(commandInBuildEnv(config, command))
364 deleteDebianFolder() # cleanup: the debian folder only contains what we just created
366 ###################################################################
367 # if we are called directly as script
368 if __name__ == "__main__":
370 # read command-line arguments
371 parser = argparse.ArgumentParser(description='Automatic Generation of Debian Packages')
372 parser.add_argument("-w", "--wait-after-config",
373 action="store_true", dest="wait_after_config",
374 help="Wait for user confirmation after configuration is finished")
375 args = parser.parse_args()
377 config = loadConfigFile('auto-debuild.conf')
378 config['waitAfterConfig'] = args.wait_after_config
379 # generate debian files
380 if os.path.exists('debian') or os.path.islink('debian'):
381 if input("A debian folder already exists, do you want to remove it and whatever it links to (y/N)? ").lower() != "y":
384 files = createDebianFiles(config)
385 # check if a file is overwritten
386 overwritten_files = list(filter(lambda file: os.path.exists(file), files))
387 if overwritten_files:
388 if input("Do you want to overwrite {} (y/N)? ".format(', '.join(overwritten_files))).lower() != "y":
391 buildDebianPackage(config)
393 print("Installing created deb files...")
394 subprocess.check_call(['sudo', 'dpkg', '--install'] + files)
395 except (subprocess.CalledProcessError, KeyboardInterrupt) as e: # for some exceptions, a stackrace is usually pointless
396 print(file=sys.stderr)
397 print(file=sys.stderr)
398 if isinstance(e, KeyboardInterrupt): # str(e) would be the empty string
399 print("Interruped by user", file=sys.stderr)
401 print("Error during package creation: %s" % str(e), file=sys.stderr)
402 print(file=sys.stderr)