Use subprocess.check_call
[mass-build.git] / build_system.py
index f56c54679a717610e62fbfeae638b6181a1fd708..9dceb7df7e689e7782a69ef3fa9462f2ff5e953e 100644 (file)
@@ -1,6 +1,23 @@
-import os, shutil, subprocess
+# mass-build - Easily Build Software Involving a Large Amount of Source Repositories
+# Copyright (C) 2012-2013 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 must have a "build" method with an optional "reconfigure" parameter.'''
+import os, shutil, subprocess, multiprocessing
+
+'''A build system must have a "build" method with parameters "reconfigure" and "waitAfterConfig".'''
 
 # Compile, build, and install cmake projects:
 class CMake:
@@ -9,25 +26,53 @@ class CMake:
                self.buildFolder = os.path.abspath(buildFolder)
                self.config = config
        
-       def build(self, reconfigure=False):
+       def setEnv(self, name, val):
+               '''Set the given environment variable, return old value'''
+               oldVal = os.getenv(name)
+               os.putenv(name, val)
+               return oldVal
+       
+       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 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)
                # 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
-               os.putenv('PKG_CONFIG_PATH', os.path.join(self.config['installDir'], 'lib', 'pkgconfig')) # I found no way to do this within cmake
+               # 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', []))
-               os.unsetenv('PKG_CONFIG_PATH')
+               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 self.config['waitAfterConfig']:
-                       raw_input('Configuration done. Hit "Enter" to build the project. ')
+               if waitAfterConfig:
+                       input('Configuration done. Hit "Enter" to build the project. ')
                # run compilation
-               subprocess.check_call(self.config['buildCmdPrefix'] + ['make', '-j'+str(self.config['jobs'])])
+               jobs = multiprocessing.cpu_count()+1
+               subprocess.check_call(self.config.get('buildCmdPrefix', []) + ['make', '-j'+str(jobs)])
                # run installation
-               subprocess.check_call(self.config['installCmdPrefix'] + ['make', 'install'])
+               subprocess.check_call(self.config.get('installCmdPrefix', []) + ['make', 'install', '-j'+str((jobs+1)//2)]) # jobs/2, rounded up
 
 # if auto-debuild is available, provide a wrapper for it
 try:
@@ -40,9 +85,12 @@ try:
                        self.config = config
                        self.vcs = vcs
 
-               def build(self, reconfigure=False): # reconfigure is ignored (we always do a reconfiguration)
-                       # create auto-debuild configuration
+               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'],
@@ -50,14 +98,12 @@ try:
                                'buildDir': self.buildFolder,
                                'name': self.config['debName'],
                                'email': self.config['debEMail'],
-                               'parallelJobs': self.config['jobs'],
-                               'version': versionName,
+                               'version': versionName + self.config.get('versionSuffix', ''),
+                               'waitAfterConfig': waitAfterConfig,
                        }
-                       if autoDebuildConfig['version'] is None:
-                               raise Exception("VCS did not provide us with a proper version number, please fix this")
                        # copy some more optional configuration
-                       for option in ('waitAfterConfig',  'dbgPackage', 'section', 'withPython2', 'binarySkipFiles', 'binaryInstallFiles',
-                                       'buildDepends', 'binaryDepends', 'binaryRecommends', 'binaryProvides', 'binaryConflicts', 'binaryBreaks',
+                       for option in ('epoch', 'dbgPackage', 'section', 'withPython2', 'withSIP', 'binarySkipFiles', 'binaryInstallFiles',
+                                       'buildDepends', 'binaryDepends', 'binaryShims', 'binaryRecommends', 'binaryProvides', 'binaryConflicts', 'binaryBreaks',
                                        'binaryReplaces', 'binaryBreaksReplaces',
                                        'alternatives', 'cmakeParameters', 'automakeParameters'):
                                if option in self.config: