Use 'git describe' to get current version number in checkVersions()

[mass-build.git] / build_system.py

diff --git a/build_system.py b/build_system.py
index 6e72e71e9b8eed6713bc5a3a789133f5a9deee6a..4658f4a5fd08fc6a2fe7b352a32e8cb0d0d41da0 100644 (file)
--- a/build_system.py
+++ b/build_system.py
@@ -1,90 +1,124 @@
-import os, subprocess
+# mass-build - Easily Build Software Involving a Large Amount of Source Repositories
+# Copyright (C) 2012 Ralf Jung <post@ralfj.de>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

 
 

-'''A build system has three methods: "configure" (with optionak "force" parameter), "build" and "install"'''
+import os, shutil, subprocess
+
+'''A build system must have a "build" method with parameters "reconfigure" and "waitAfterConfig".'''

 
 # Compile, build, and install cmake projects:
 class CMake:
 
 # Compile, build, and install cmake projects:
 class CMake:

-       def __init__(self, sourceFolder, buildFolder, module, config):
+       def __init__(self, sourceFolder, buildFolder, config):

                self.sourceFolder = os.path.abspath(sourceFolder)
                self.buildFolder = os.path.abspath(buildFolder)
                self.sourceFolder = os.path.abspath(sourceFolder)
                self.buildFolder = os.path.abspath(buildFolder)

-               self.installDir = config['installDir']
-               self.buildType = config['buildType']
-               self.jobs = config['jobs']
-               self.buildCmdPrefix = config['buildCmdPrefix']
-               self.installCmdPrefix = config['installCmdPrefix']
-               self.cmakeParameters = module.get('cmakeParameters', [])
+               self.config = config

        
        

-       def configure(self, force=False):
-               if not os.path.exists(self.buildFolder): os.makedirs(self.buildFolder)
-               os.chdir(self.buildFolder)
-               # check if we actually need to work
-               cacheFile = 'CMakeCache.txt'
-               if os.path.exists(cacheFile) and os.path.exists('Makefile') and not force: return
-               # yes we do! make sure we start clean, and then go ahead
-               if os.path.exists(cacheFile): os.remove(cacheFile)
-               os.putenv('PKG_CONFIG_PATH', os.path.join(self.installDir, 'lib', 'pkgconfig')) # I found no way to do this within cmake
-               subprocess.check_call(['cmake', self.sourceFolder, '-DCMAKE_BUILD_TYPE='+self.buildType,
-                       '-DCMAKE_INSTALL_PREFIX='+self.installDir]+self.cmakeParameters)
-               os.unsetenv('PKG_CONFIG_PATH')
+       def setEnv(self, name, val):
+               '''Set the given environment variable, return old value'''
+               oldVal = os.getenv(name)
+               os.putenv(name, val)
+               return oldVal

        
        

-       def build(self):
-               os.chdir(self.buildFolder)
-               subprocess.check_call(self.buildCmdPrefix + ['make', '-j'+str(self.jobs)])
+       def prependDirToEnv(self, name, dir, default):
+               '''Prepends the given directory to the environment variable. If the variable is empty, dir isprepended to the default.
+                  Returns the old value.'''
+               oldVal = os.getenv(name)
+               oldPaths = default if oldVal is None else oldVal
+               os.putenv(name, dir+':'+oldPaths)
+               return oldVal
+       
+       def restoreEnv(self, name, oldVal):
+               '''Restore environment variable to previous value'''
+               if oldVal is None:
+                       os.unsetenv(name)
+               else:
+                       os.putenv(name, oldVal)

        
        

-       def install(self):
+       def build(self, reconfigure, waitAfterConfig):
+               # Make sure we have a build directory
+               if not os.path.exists(self.buildFolder): os.makedirs(self.buildFolder)

                os.chdir(self.buildFolder)
                os.chdir(self.buildFolder)

-               subprocess.check_call(self.installCmdPrefix + ['make', 'install'])
+               # In case of reconfiguration, delete cache file if it exists
+               cacheFile = 'CMakeCache.txt'
+               if os.path.exists(cacheFile) and reconfigure: os.remove(cacheFile)
+               # Run cmake, in the proper environment, then restore old environment
+               oldPKGConfigPath = self.setEnv('PKG_CONFIG_PATH', os.path.join(self.config['installDir'], 'lib', 'pkgconfig'))
+               oldCMakePrefixPath = self.setEnv('CMAKE_PREFIX_PATH', self.config['installDir'])
+               oldXDGDataDirs = self.prependDirToEnv('XDG_DATA_DIRS', os.path.join(self.config['installDir'], 'share'), '/usr/share')
+               oldXDGConfigDirs = self.prependDirToEnv('XDG_CONFIG_DIRS', os.path.join(self.config['installDir'], 'etc', 'xdg'), '/etc/xdg')
+               subprocess.check_call(['cmake', self.sourceFolder, '-DCMAKE_BUILD_TYPE='+self.config['buildType'],
+                       '-DCMAKE_INSTALL_PREFIX='+self.config['installDir']]+self.config.get('cmakeParameters', []))
+               self.restoreEnv('PKG_CONFIG_PATH', oldPKGConfigPath)
+               self.restoreEnv('CMAKE_PREFIX_PATH', oldCMakePrefixPath)
+               self.restoreEnv('XDG_DATA_DIRS', oldXDGDataDirs)
+               self.restoreEnv('XDG_CONFIG_DIRS', oldXDGConfigDirs)
+               # if asked to do so, wait
+               if waitAfterConfig:
+                       raw_input('Configuration done. Hit "Enter" to build the project. ')
+               # run compilation
+               subprocess.check_call(self.config.get('buildCmdPrefix', []) + ['make', '-j'+str(self.config['jobs'])])
+               # run installation
+               subprocess.check_call(self.config.get('installCmdPrefix', []) + ['make', 'install'])

 
 # if auto-debuild is available, provide a wrapper for it
 try:
        import auto_debuild
        class AutoDebuild:
 
 # if auto-debuild is available, provide a wrapper for it
 try:
        import auto_debuild
        class AutoDebuild:

-               def __init__(self, sourceFolder, buildFolder, module, vcs, config):
+               def __init__(self, sourceFolder, buildFolder, config, vcs):

                        self.sourceFolder = os.path.abspath(sourceFolder)
                        self.sourceFolder = os.path.abspath(sourceFolder)

-                       buildSystem = module.get('build-system', 'cmake')
-                       self.autoDebuildConfig = {
-                               'sourceName': module['name'],
-                               'debDir': os.path.abspath(config['debDir']),
-                               'buildSystem': buildSystem,
-                               'buildDir': os.path.abspath(buildFolder),
-                               'name': config['debName'],
-                               'email': config['debEMail'],
-                       }
-                       self.copyOption(config, 'jobs', 'parallelJobs')
-                       self.copyOption(module, 'dbgPackage')
-                       self.copyOption(module, 'skipFiles', 'binarySkipFiles')
-                       self.copyOption(module, 'installFiles', 'binaryInstall')
-                       self.copyOption(module, 'buildDepends')
-                       self.copyOption(module, 'binaryDepends')
-                       self.copyOption(module, 'binaryRecommends')
-                       if buildSystem == 'cmake':
-                               self.copyOption(module, 'cmakeParameters')
+                       self.buildFolder = os.path.abspath(buildFolder)
+                       self.debFolder = os.path.abspath(config['debDir'])
+                       self.config = config

                        self.vcs = vcs
                        self.vcs = vcs

-                       self.configured = False # make sure configure is called before build/install

 
 

-               def copyOption(self, src, name, dstName = None):
-                       if dstName is None: dstName = name # per default, stick with original name
-                       if name in src:
-                               self.autoDebuildConfig[dstName] = src[name]
-
-               def configure(self, force=False): # force is ignored
-                       self.autoDebuildConfig['version'] = self.vcs.version() # by now, data has been fetched, so this is possible
-                       if self.autoDebuildConfig['version'] is None:
-                               raise Exception("VCS did not provide us with a proper version, please fix this")
-                       os.chdir(self.sourceFolder)
-                       #print self.autoDebuildConfig
-                       self.files = auto_debuild.createDebianFiles(self.autoDebuildConfig)
-                       self.configured = True
-
-               def build(self):
-                       if not self.configured: self.configure()
+               def build(self, reconfigure, waitAfterConfig): # reconfigure is ignored (we always do a reconfiguration)
+                       # get version name
+                       versionName = self.config['versionName'] if 'versionName' in self.config else self.vcs.version()
+                       if versionName is None:
+                               raise Exception("VCS did not provide us with a proper version number, please provide one manually")
+                       # create auto-debuild configuration
+                       autoDebuildConfig = {
+                               'sourceName': self.config['name'],
+                               'buildSystem': self.config['buildSystem'],
+                               'debDir': self.debFolder,
+                               'buildDir': self.buildFolder,
+                               'name': self.config['debName'],
+                               'email': self.config['debEMail'],
+                               'parallelJobs': self.config['jobs'],
+                               'version': versionName,
+                               'waitAfterConfig': waitAfterConfig,
+                       }
+                       # copy some more optional configuration
+                       for option in ('epoch', 'dbgPackage', 'section', 'withPython2', 'binarySkipFiles', 'binaryInstallFiles',
+                                       'buildDepends', 'binaryDepends', 'binaryShims', 'binaryRecommends', 'binaryProvides', 'binaryConflicts', 'binaryBreaks',
+                                       'binaryReplaces', 'binaryBreaksReplaces',
+                                       'alternatives', 'cmakeParameters', 'automakeParameters'):
+                               if option in self.config:
+                                       autoDebuildConfig[option] = self.config[option]
+                       # create Debian files

                        os.chdir(self.sourceFolder)
                        os.chdir(self.sourceFolder)

-                       auto_debuild.buildDebianPackage(self.autoDebuildConfig)
+                       if os.path.isdir('debian'): # clean previous build attempts
+                               shutil.rmtree('debian')
+                       files = auto_debuild.createDebianFiles(autoDebuildConfig)
+                       # build package(s)
+                       auto_debuild.buildDebianPackage(autoDebuildConfig)
+                       # install package(s)
+                       if self.config.get('debInstall', True):
+                               subprocess.check_call(['sudo', 'dpkg', '--install'] + files)

 
 

-               def install(self):
-                       if not self.configured: self.configure()
-                       os.chdir(self.sourceFolder)
-                       subprocess.check_call(['sudo', 'dpkg', '--install'] + self.files)

 except ImportError:
 except ImportError:

-       print "auto_debuild not found, disabling auto-debuild system"
+       #print "auto_debuild not found, disabling auto-debuild system"

        pass
        pass