Support for custom --prefix and better control over environment variables during execution.

CHANGES.txt

 Change History
 **************
 
+1.3.0 (xxxx-xx-xx)
+==================
+
+  - Added new options ``environment-section`` and ``environment`` to control
+    environment variables before executing the recipe.
+
+  - Added new option ``prefix`` to override the installation prefix. Defaults
+    to the previously hardcoded value of the part location.
+
 1.2.0
 =====
 

README.txt

@@ -9,4 +9,8 @@ distributions using ``configure`` and ``make``. It is inspired by the
 zc.recipe.cmmi_ recipe but provides more control over the build
 process.
 
+Repository: http://github.com/hexagonit/hexagonit.recipe.cmmi
+
+Clone URL: git clone git://github.com/hexagonit/hexagonit.recipe.cmmi.git
+
 .. _zc.recipe.cmmi : http://pypi.python.org/pypi/zc.recipe.cmmi

hexagonit/recipe/cmmi/README.txt

 Supported options
 =================
 
-url
+``url``
     URL to the package that will be downloaded and extracted. The
     supported package formats are .tar.gz, .tar.bz2, and .zip. The
     value must be a full URL,
     e.g. http://python.org/ftp/python/2.4.4/Python-2.4.4.tgz. The
     ``path`` option can not be used at the same time with ``url``.
 
-path
+``path``
     Path to a local directory containing the source code to be built
     and installed. The directory must contain the ``configure``
     script. The ``url`` option can not be used at the same time with
     ``path``.
 
-md5sum
+``prefix``
+    Custom installation prefix passed to the ``--prefix`` option of the
+    ``configure`` script. Defaults to the location of the part.
+
+``md5sum``
     MD5 checksum for the package file. If available the MD5
     checksum of the downloaded package will be compared to this value
     and if the values do not match the execution of the recipe will
     fail.
 
-make-binary
+``make-binary``
     Path to the ``make`` program. Defaults to 'make' which
     should work on any system that has the ``make`` program available
     in the system ``PATH``.
 
-make-targets
+``make-targets``
     Targets for the ``make`` command. Defaults to 'install'
     which will be enough to install most software packages. You only
     need to use this if you want to build alternate targets. Each
     target must be given on a separate line.
 
-configure-command
+``configure-command``
     Name of the configure command that will be run to generate the Makefile.
     This defaults to ``./configure`` which is fine for packages that come with
     a configure script. You may wish to change this when compiling packages
     with a different set up. See the ``Compiling a Perl package`` section for
     an example.
 
-configure-options
+``configure-options``
     Extra options to be given to the ``configure`` script. By default
     only the ``--prefix`` option is passed which is set to the part
-    directory. Each option must be given on a separate line. Note that
-    in addition to configure options you can also pass in environment
-    variables such as ``CFLAGS`` and ``LDFLAGS`` to control the build
-    process.
+    directory. Each option must be given on a separate line.
 
-patch-binary
+``patch-binary``
     Path to the ``patch`` program. Defaults to 'patch' which should
     work on any system that has the ``patch`` program available in the
     system ``PATH``.
 
-patch-options
+``patch-options``
     Options passed to the ``patch`` program. Defaults to ``-p0``.
 
-patches
+``patches``
     List of patch files to the applied to the extracted source. Each
     file should be given on a separate line.
 
-pre-configure-hook
+``pre-configure-hook``
     Custom python script that will be executed before running the
     ``configure`` script. The format of the options is::
 
@@ -70,17 +71,17 @@ pre-configure-hook
     ``options`` dictionary from the recipe and the global ``buildout``
     dictionary. The callable is not expected to return anything.
 
-pre-make-hook
+``pre-make-hook``
     Custom python script that will be executed before running
     ``make``. The format and semantics are the same as with the
     ``pre-configure-hook`` option.
 
-post-make-hook
+``post-make-hook``
     Custom python script that will be executed after running
     ``make``. The format and semantics are the same as with the
     ``pre-configure-hook`` option.
 
-keep-compile-dir
+``keep-compile-dir``
     Switch to optionally keep the temporary directory where the
     package was compiled. This is mostly useful for other recipes that
     use this recipe to compile a software but wish to do some
@@ -88,6 +89,33 @@ keep-compile-dir
     compile directory is stored in ``options['compile-directory']``.
     Accepted values are 'true' or 'false', defaults to 'false'.
 
+``environment-section``
+
+    Name of a section that provides environment variables that will be used to
+    update ``os.environ`` before executing the recipe.
+    
+    The values of the environment variables may contain references to other
+    existing environment variables (including themselves) in the form of
+    Python string interpolation variables using the dictionary notation. These
+    references will be expanded before ``os.environ`` is updated. This can be
+    used, for example, to append to the ``PATH`` variable, e.g.::
+        
+        [component]
+        recipe = hexagonit.recipe.cmmi
+        environment = environment
+        
+        [environment]
+        PATH = %(PATH)s:${buildout:directory}/bin
+
+``environment``
+
+  A sequence of ``KEY=VALUE`` pairs separated by newlines that define
+  additional environment variables used to update ``os.environ`` before
+  executing the recipe.
+  
+  The semantics of this option are the same as ``environment-section``. If
+  both ``environment-section`` and ``environment`` are provided the values from
+  the former will be overridden by the latter allowing per-part customization.
 
 Additionally, the recipe honors the ``download-cache`` option set
 in the ``[buildout]`` section and stores the downloaded files under
@@ -234,11 +262,13 @@ more. Let's try again with a new buildout and provide more options.
     ... recipe = hexagonit.recipe.cmmi
     ... url = file://%(src)s/package-0.0.0.tar.gz
     ... md5sum = 6b94295c042a91ea3203857326bc9209
+    ... prefix = /somewhere/else
+    ... environment =
+    ...     CFLAGS=-I/sw/include
+    ...     LDFLAGS=-L/sw/lib
     ... configure-options =
     ...     --with-threads
     ...     --without-foobar
-    ...     CFLAGS=-I/sw/include
-    ...     LDFLAGS=-L/sw/lib
     ... make-targets =
     ...     install
     ...     install-lib
@@ -247,19 +277,22 @@ more. Let's try again with a new buildout and provide more options.
     ...     patches/Makefile.dist.patch
     ... """ % dict(src=src))
 
-This configuration uses custom configure options, multiple make
-targets and also patches the source code before the scripts are run.
+This configuration uses custom configure options, custom environment, custom
+prefix, multiple make targets and also patches the source code before the
+scripts are run.
 
     >>> print system(buildout)
     Uninstalling package.
     Installing package.
+    package: [ENV] LDFLAGS = -L/sw/lib
+    package: [ENV] CFLAGS = -I/sw/include
     package: Using a cached copy from /sample_buildout/downloads/package-0.0.0.tar.gz
     package: MD5 checksum OK
     package: Extracting package to /sample_buildout/parts/package__compile__
     package: Applying patches
     patching file configure
     patching file Makefile.dist
-    patched-configure --prefix=/sample_buildout/parts/package --with-threads --without-foobar CFLAGS=-I/sw/include LDFLAGS=-L/sw/lib
+    patched-configure --prefix=/somewhere/else --with-threads --without-foobar
     building patched package
     installing patched package
     installing patched package-lib

hexagonit/recipe/cmmi/__init__.py

@@ -5,7 +5,7 @@ import os
 import shutil
 import zc.buildout
 
-class Recipe:
+class Recipe(object):
     """zc.buildout recipe for compiling and installing software"""
 
     def __init__(self, buildout, name, options):
@@ -18,7 +18,7 @@ class Recipe:
         options['location'] = os.path.join(
             buildout['buildout']['parts-directory'],
             self.name)
-        options['prefix'] = options['location']
+        options['prefix'] = options.get('prefix', options['location'])
         options['url'] = options.get('url', '').strip()
         options['path'] = options.get('path', '').strip()
 
@@ -32,6 +32,21 @@ class Recipe:
         else:
             options['compile-directory'] = options['path']
         
+        self.environ = {}
+        environment_section = self.options.get('environment-section', '').strip()
+        if environment_section and environment_section in buildout:
+            # Use environment variables from the designated config section.
+            self.environ.update(buildout[environment_section])
+        for variable in self.options.get('environment', '').splitlines():
+            if variable.strip():
+                try:
+                    key, value = variable.split('=', 1)
+                    self.environ[key.strip()] = value
+                except ValueError:
+                    raise zc.buildout.UserError('Invalid environment variable definition: %s', variable)
+        for key in self.environ:
+            self.environ[key] = self.environ[key] % os.environ
+
     def update(self):
         pass
 
@@ -70,6 +85,11 @@ class Recipe:
         patch_options = ' '.join(self.options.get('patch-options', '-p0').split())
         patches = self.options.get('patches', '').split()
         
+        if self.environ:
+            for key, value in self.environ.items():
+                log.info('[ENV] %s = %s', key, value)
+            os.environ.update(self.environ)
+
         # Download the source using hexagonit.recipe.download
         if self.options['url']:
             compile_dir = self.options['compile-directory']

setup.py

 from setuptools import setup, find_packages
 import os
 
-version = '1.2.0'
+version = '1.3.0'
 name = 'hexagonit.recipe.cmmi'
 
 def read(*rnames):
@@ -33,7 +33,7 @@ setup(name=name,
       keywords='development buildout recipe',
       author='Kai Lautaportti',
       author_email='kai.lautaportti@hexagonit.fi',
-      url='http://cheeseshop.python.org/pypi/%s' % name,
+      url='http://github.com/hexagonit/hexagonit.recipe.cmmi',
       license='GPL',
       packages=find_packages(exclude=['ez_setup']),
       namespace_packages=['hexagonit', 'hexagonit.recipe'],