change default cmake build directory to 'build', after I figured out how to make...

[auto-debuild.git] / auto_debuild.py

diff --git a/auto_debuild.py b/auto_debuild.py
index f8ff6419255c39784c9a9ff21254629b36b67440..c827a12fcb41428a0fb0bfabc947e61097c1b9e2 100755 (executable)
--- a/auto_debuild.py
+++ b/auto_debuild.py
@@ -1,57 +1,115 @@
 #!/usr/bin/python
 #!/usr/bin/python

-import os, stat, time, subprocess, sys
+import os, shutil, stat, time, subprocess, sys

 from collections import OrderedDict
 
 from collections import OrderedDict
 

+# some utility functions
+def safeCall(*args):
+       res = ""
+       for arg in args:
+               assert arg.find("'") < 0 # ' is not supported
+               if len(res): res += " "
+               res += "'"+arg+"'"
+       return res
+
+# abstract representation of rules file

 class RulesFile:
        def __init__(self):
 class RulesFile:
        def __init__(self):

-               self.buildOptions = ''
+               self.env = {}

                self.dh = []
                self.rules = OrderedDict()
        
                self.dh = []
                self.rules = OrderedDict()
        

+       def env2str(self):
+               res = ""
+               for name in self.env: # we rely on the name being sane (i.e., no special characters)
+                       val = self.env[name]
+                       assert val.find("'") < 0 # ' is not supported
+                       if len(res): res += " "
+                       res += name+"='"+val+"'"
+               return res
+

        def write(self, f):
                print >>f, "#!/usr/bin/make -f"
                print >>f, ""
        def write(self, f):
                print >>f, "#!/usr/bin/make -f"
                print >>f, ""

-               print >>f, "%:"
-               print >>f, '\tDEB_BUILD_OPTIONS="'+self.buildOptions+'" dh $@',' '.join(self.dh)
+               print >>f, ".PHONY: build" # there may be a directory called "build"
+               print >>f, ""
+               print >>f, "build %:" # need to mention "build" here again explicitly
+               print >>f, '\t'+self.env2str()+' dh $@ '+safeCall(*self.dh)

                for rule in self.rules:
                        print >>f, ""
                        print >>f, "override_dh_"+rule+":"
                        for line in self.rules[rule]:
                                print >>f, "\t"+line
 
                for rule in self.rules:
                        print >>f, ""
                        print >>f, "override_dh_"+rule+":"
                        for line in self.rules[rule]:
                                print >>f, "\t"+line
 

-def getArchitecture():
-       p = subprocess.Popen(['dpkg-architecture', '-qDEB_BUILD_ARCH'], stdout=subprocess.PIPE)
-       res = p.communicate()[0] # get only stdout
-       if p.returncode != 0: raise Exception("Querying dpkg for the architecture failed")
-       return res[0:len(res)-1] # chop of the \n at the end
-

 # build-system specific part of rules file
 def cmakeRules(config):
 # build-system specific part of rules file
 def cmakeRules(config):

+       buildDir = config.get('buildDir', 'build')
+       srcDir = os.getcwd()

        r = RulesFile()
        r = RulesFile()

-       r.dh += ["--buildsystem=cmake", "--builddirectory=build.dir"] # dh parameters: "build" is not a good idea, as that's also the name of a target...
+       r.dh += ["--buildsystem=cmake", "--builddirectory="+buildDir] # dh parameters

        r.rules['auto_configure'] = [
        r.rules['auto_configure'] = [

-               'mkdir -p build.dir',
-               "cd build.dir && cmake .. "+' '.join(['-DCMAKE_INSTALL_PREFIX=/usr', '-DCMAKE_BUILD_TYPE=Release'] + config.get('cmakeParameters', []))
+               safeCall("mkdir", "-p", buildDir),
+               safeCall("cd", buildDir) + " && " +
+                 safeCall("cmake", srcDir, "-DCMAKE_INSTALL_PREFIX=/usr", *config.get('cmakeParameters', []))

        ]
        ]

-       r.rules['auto_clean'] = ['rm -f build.dir/CMakeCache.txt'] # clean old cmake cache
+       r.rules['auto_clean'] = [safeCall('rm', '-f', os.path.join(buildDir, 'CMakeCache.txt'))] # clean old cmake cache

        return r
 
        return r
 

-def writeDebList(list):
-       return ', '.join(list)
+def automakeRules(config):
+       # "build" is what we are building *on*, and "host" is what we are building *for* (and GNU is weird...)
+       # also, we don't really support cross-building... ;-) (to do, we'd have to write shell code that checks whether BUILD_GNU_TYPE
+       #  and HOST_GNU_TYPE are equal, and if they are not, add a --host parameter)
+       r = RulesFile()
+       r.dh += ["--buildsystem=autoconf"]
+       r.rules['auto_configure'] = [
+               'BUILD_TYPE=$$(dpkg-architecture -qDEB_BUILD_GNU_TYPE) && ' + # doing the expansion beforehand ensures that we cancel if it fails
+               'MULTIARCH=$$(dpkg-architecture -qDEB_HOST_MULTIARCH) && '+
+                       './configure --build=$$BUILD_TYPE '+ # do the escape manually here so we can use the variables (there's no user-controlled string in here anyway)
+                       '--prefix=/usr --includedir=/usr/include --mandir=/usr/share/man --infodir=/usr/share/info '+
+                       '--libdir=/usr/lib/$$MULTIARCH --libexecdir=/usr/lib/$$MULTIARCH '+
+                       '--sysconfdir=/etc --localstatedir=/var '+
+                       safeCall(*config.get('automakeParameters', []))
+       ]
+       r.rules['auto_clean'] = ['rm -f config.status'] # do not re-use old configuration (no need for escaping here, obviously)
+       return r

 
 

+# utility functions
+def commandInBuildEnv(config, command):
+       schroot = config.get('schroot')
+       if schroot is not None: command = ['schroot', '-c', schroot, '--'] + command
+       return command
+
+def getArchitecture(config):
+       cmd = commandInBuildEnv(config, ['dpkg-architecture', '-qDEB_HOST_ARCH'])
+       p = subprocess.Popen(cmd, stdout=subprocess.PIPE)
+       res = p.communicate()[0] # get only stdout
+       if p.returncode != 0: raise Exception("Querying dpkg for the architecture failed")
+       return res[0:len(res)-1] # chop of the \n at the end
+
+def writeDependency(f, name, list):
+       if len(list):
+               print >>f, name+": "+', '.join(list)
+
+# actual work functions

 def createDebianFiles(config):
        sourceName = config['sourceName']
        binaryName = config.get('binaryName', sourceName+'-local')
 def createDebianFiles(config):
        sourceName = config['sourceName']
        binaryName = config.get('binaryName', sourceName+'-local')

-       name = config.get('name', os.getlogin())
-       email = config.get('email', os.getlogin()+'@'+os.uname()[1])
+       name = config.get('name', os.getenv('USER')) # os.getlogin() fails in minimal chroots
+       email = config.get('email', os.getenv('USER')+'@'+os.uname()[1]) # user@hostname

        debDir = os.path.expanduser(config['debDir'])
        buildSystem = config['buildSystem']
        version = config['version']
        debDir = os.path.expanduser(config['debDir'])
        buildSystem = config['buildSystem']
        version = config['version']

-       # we return the list of files generated
-       arch = getArchitecture()
+       dbgPackage = config.get('dbgPackage', False)
+       parallelJobs = int(config.get('parallelJobs', 2))
+       packageArchitecture = config.get('architecture', 'any')
+       # we return the list of files generated, so we need to know the architecture
+       arch = getArchitecture(config)

        files = []
        files = []

+       # create folders
+       if os.path.exists('debian'): raise Exception('debian folder already exists?')
+       os.mkdir('debian')
+       os.mkdir('debian/source')
+       if not os.path.exists(debDir): os.mkdir(debDir)

        # source format file
        # source format file

-       if not os.path.exists('debian/source'): os.mkdir('debian/source')

        with open('debian/source/format', 'w') as f:
                print >>f, "3.0 (native)"
        # compat file
        with open('debian/source/format', 'w') as f:
                print >>f, "3.0 (native)"
        # compat file


@@ -73,57 +131,95 @@ def createDebianFiles(config):
                print >>f, "Section:",config.get('section', 'misc')
                print >>f, "Priority: extra"
                print >>f, "Maintainer: %s <%s>" % (name, email)
                print >>f, "Section:",config.get('section', 'misc')
                print >>f, "Priority: extra"
                print >>f, "Maintainer: %s <%s>" % (name, email)

-               print >>f, "Build-Depends:",writeDebList(["debhelper (>= 9)"] + config.get('buildDepends', []))
+               writeDependency(f, 'Build-Depends', ["debhelper (>= 9)"] + config.get('buildDepends', []))

                print >>f, "Standards-Version: 3.9.3"
                print >>f, ""
                print >>f, "Package:",binaryName
                print >>f, "Standards-Version: 3.9.3"
                print >>f, ""
                print >>f, "Package:",binaryName

-               print >>f, "Architecture:",config.get('architecture', 'any')
-               print >>f, "Depends:",writeDebList(["${shlibs:Depends}", "${misc:Depends}"] + config.get('binaryDepends', []))
-               print >>f, "Provides:",writeDebList(config.get('binaryProvides', [sourceName]))
+               print >>f, "Architecture:",packageArchitecture
+               writeDependency(f, "Pre-Depends", ["${misc:Pre-Depends}"] + config.get('binaryPreDepends', []))
+               writeDependency(f, "Depends", ["${shlibs:Depends}", "${misc:Depends}"] + config.get('binaryDepends', []))
+               writeDependency(f, "Recommends", config.get('binaryRecommends', []))
+               writeDependency(f, "Provides", config.get('binaryProvides', [sourceName]))

                print >>f, "Description:",sourceName,"(auto-debuild)"
                print >>f, "Description:",sourceName,"(auto-debuild)"

-               print >>f, " Package auto-generated by auto-debuild"
+               print >>f, " Package auto-generated by auto-debuild."

                files.append(os.path.join(debDir, "%s_%s_%s.deb" % (binaryName, version, arch)))
                files.append(os.path.join(debDir, "%s_%s_%s.deb" % (binaryName, version, arch)))

+               if dbgPackage:
+                       print >>f, ""
+                       print >>f, "Package:",binaryName+"-dbg"
+                       print >>f, "Architecture:",packageArchitecture
+                       writeDependency(f, "Depends", ["${misc:Depends}", binaryName+" (= ${binary:Version})"])
+                       print >>f, "Description:",sourceName,"debug smbols (auto-debuild)"
+                       print >>f, " Package containing debug symbols for "+sourceName+", auto-generated by auto-debuild."
+                       files.append(os.path.join(debDir, "%s-dbg_%s_%s.deb" % (binaryName, version, arch)))
+       # install file
+       with open('debian/'+binaryName+'.install', 'w') as f:
+               for line in config.get('binaryInstallFiles', []):
+                       if line.startswith('/'): # a file from within the package, not from the source tree
+                               line = 'debian/'+binaryName+line
+                       print >>f, line

        # rules file: build system specific
        with open('debian/rules', 'w') as f:
        # rules file: build system specific
        with open('debian/rules', 'w') as f:

-               # get rule file for build system
+               # get rule file for build system: may only touch auto_config and auto_clean rules and the dh options

                if buildSystem == 'cmake':
                        r = cmakeRules(config)
                if buildSystem == 'cmake':
                        r = cmakeRules(config)

+               elif buildSystem == 'automake':
+                       r = automakeRules(config)

                else:
                        raise Exception("Invalid build system "+buildSystem)
                # global rules
                else:
                        raise Exception("Invalid build system "+buildSystem)
                # global rules

-               r.buildOptions = "parallel=2"
+               r.env["DEB_BUILD_OPTIONS"] = 'parallel='+str(parallelJobs)
+               if not dbgPackage:
+                       # disable debug information
+                       r.env["DEB_CFLAGS_APPEND"] = '-g0'
+                       r.env["DEB_CXXFLAGS_APPEND"] = '-g0'

                r.dh += ['--parallel']
                r.dh += ['--parallel']

-               if not 'builddeb' in r.rules:
-                       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...)
-               else:
-                       print "WARNING: Build system messes with global rules"
-               if not 'auto_test' in r.rules: # unless the build system has something in mind for this
-                       r.rules['auto_test'] = []
+               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...)
+               r.rules['auto_test'] = []
+               # installation rule
+               r.rules['auto_install'] = [safeCall('dh_auto_install', '--destdir=debian/'+binaryName)] # install everything into the binary package
+               if 'binarySkipFiles' in config:
+                       r.rules['auto_install'].append(safeCall('cd', 'debian/'+binaryName) + " && " +
+                               safeCall('rm', *config['binarySkipFiles']))
+               # for debug packages
+               if dbgPackage:
+                       r.rules['strip'] = [safeCall('dh_strip', '--dbg-package='+binaryName+"-dbg")] # put debug files in appropriate package
+                       r.rules['installdocs'] = [safeCall('dh_installdocs', '--link-doc='+binaryName)] # make the doc folder of the dbg package a symlink
+               # wait after configuration?
+               if config.get('waitAfterConfig', False):
+                       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...

                # dump it to a file
                r.write(f)
        mode = os.stat('debian/rules').st_mode
        os.chmod('debian/rules', mode | stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH)
                # dump it to a file
                r.write(f)
        mode = os.stat('debian/rules').st_mode
        os.chmod('debian/rules', mode | stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH)

-       # return list of files affected
+       # return list of files that will be created

        return files
 
        return files
 

-def buildDebianPackage():
-       subprocess.check_call(['dpkg-checkbuilddeps'])
-       subprocess.check_call(['debian/rules', 'clean'])
-       subprocess.check_call(['debian/rules', 'build'])
-       subprocess.check_call(['fakeroot', 'debian/rules', 'binary'])
-       subprocess.check_call(['debian/rules', 'clean'])
+def buildDebianPackage(config):
+       commands = ['dpkg-checkbuilddeps', 'debian/rules clean', 'debian/rules build', 'fakeroot debian/rules binary', 'debian/rules clean']
+       command = ['bash', '-c', ' && '.join(commands)] # make it all one command, so we don't have to open and close the chroot too often
+       subprocess.check_call(commandInBuildEnv(config, command))
+       shutil.rmtree('debian') # it only contains what we just created

 
 

+###################################################################

 # if we are called directly as script
 if __name__ == "__main__":
 # if we are called directly as script
 if __name__ == "__main__":

-       # generate debian files

        import imp
        import imp

-       config = imp.load_source('config', 'debian/auto-debuild.conf')
-       os.remove('debian/auto-debuild.confc')
-       files = createDebianFiles(config.__dict__)
+       # get config
+       config = imp.load_source('config', 'auto-debuild.conf').__dict__
+       os.remove('auto-debuild.confc')
+       # generate debian files
+       if os.path.exists('debian'):
+               if raw_input("A debian folder already exists, to you want to remove it (y/N)? ").lower() != "y":
+                       sys.exit(1)
+               shutil.rmtree('debian')
+       files = createDebianFiles(config)

        # check if a file is overwritten
        for file in files:
                if os.path.exists(file):
                        if raw_input("Do you want to overwrite %s (y/N)? " % file).lower() != "y":
                                sys.exit(1)
        # run compilation
        # check if a file is overwritten
        for file in files:
                if os.path.exists(file):
                        if raw_input("Do you want to overwrite %s (y/N)? " % file).lower() != "y":
                                sys.exit(1)
        # run compilation

-       buildDebianPackage()
+       buildDebianPackage(config)
+       # install files
+       print "Installing created deb files..."
+       subprocess.check_call(['sudo', 'dpkg', '--install'] + files)