slapos.recipe.build 0.12 (experimental)

Flexible software building recipe.

Basic example

Here is example to install one or several modules:

[buildout]
parts = perl-modules

[perl-modules]
recipe = slapos.recipe.build:cpan
modules =
  Class::Date
  Other::Module
# Optional argument specifying perl buildout part, if existing.
# If specified, recipe will use the perl installed by buildout.
# If not specified, will take the globally available perl executable.
perl = perl

Specific version

Note that cpan won't allow you to specify version and will always take latest version available. To choose a specific version, you will need to specify the full path in cpan like in

[buildout]
parts = perl-modules

[perl-modules]
recipe = slapos.recipe.build:cpan
modules =
  D/DL/DLUX/Class-Date-1.1.10.tar.gz
perl = perl

Simple clone

Only repository parameter is required. For each buildout run, the recipe will pick up the latest commit on the remote master branch:

>>> write(sample_buildout, 'buildout.cfg',
... """
... [buildout]
... parts = git-clone
...
... [git-clone]
... recipe = slapos.recipe.build:gitclone
... repository = http://git.erp5.org/repos/slapos.recipe.build.git
... use-cache = true
... """)

This will clone the git repository in parts/git-clone directory. Then let's run the buildout:

>>> print system(buildout)
Installing git-clone.
Cloning into '/sample-buildout/parts/git-clone'...

Let's take a look at the buildout parts directory now:

>>> ls(sample_buildout, 'parts')
d git-clone

When updating, it will do a "git fetch; git reset @{upstream}":

>>> print system(buildout)
Updating git-clone.
Fetching origin
HEAD is now at ...

Specific branch

You can specify a specific branch using branch option. For each run it will take the latest commit on this remote branch:

>>> write(sample_buildout, 'buildout.cfg',
... """
... [buildout]
... parts = git-clone
...
... [git-clone]
... recipe = slapos.recipe.build:gitclone
... repository = http://git.erp5.org/repos/slapos.recipe.build.git
... branch = build
... """)

Then let's run the buildout:

>>> print system(buildout)
Uninstalling git-clone.
Installing git-clone.
Cloning into '/sample-buildout/parts/git-clone'...

Let's take a look at the buildout parts directory now:

>>> ls(sample_buildout, 'parts')
d git-clone

And let's see that current branch is "build"::

>>> import subprocess
>>> cd('parts', 'git-clone')
>>> subprocess.check_output(['git', 'branch'])
'* build\n'

When updating, it will do a "git fetch; git reset build":

>>> cd(sample_buildout)
>>> print system(buildout)
Updating git-clone.
Fetching origin
HEAD is now at ...

Specific revision

You can specify a specific commit hash or tag using revision option. This option is not compatible with "branch" option:

>>> cd(sample_buildout)
>>> write(sample_buildout, 'buildout.cfg',
... """
... [buildout]
... parts = git-clone
...
... [git-clone]
... recipe = slapos.recipe.build:gitclone
... repository = http://git.erp5.org/repos/slapos.recipe.build.git
... revision = 2566127
... """)

Then let's run the buildout:

>>> print system(buildout)
Uninstalling git-clone.
Installing git-clone.
Cloning into '/sample-buildout/parts/git-clone'...

Let's take a look at the buildout parts directory now:

>>> ls(sample_buildout, 'parts')
d git-clone

And let's see that current branch is "gitclone":

>>> import subprocess
>>> cd(sample_buildout, 'parts', 'git-clone')
>>> subprocess.check_output(['git', 'rev-parse', '--short', 'HEAD'])
'2566127\n'

When updating, it will do a "git fetch; git reset revision":

>>> cd(sample_buildout)
>>> print system(buildout)
Updating git-clone.
Fetching origin
HEAD is now at ...

Specific git binary

The default git command is git, if for a any reason you don't have git in your path, you can specify git binary path with git-command option:

[buildout]
parts = git-clone

[git-clone]
recipe = slapos.recipe.build:gitclone
repository = http://example.net/example.git/
git-executable = /usr/local/git/bin/git

Ignore SSL certificate

By default, when remote server use SSL protocol git checks if the SSL certificate of the remote server is valid before executing commands. You can force git to ignore this check using ignore-ssl-certificate boolean option:

[buildout]
parts = git-clone

[git-clone]
recipe = slapos.recipe.build:gitclone
repository = https://example.net/example.git/
ignore-ssl-certificate = true

Full example

[buildout]
parts = git-clone

[git-binary]
recipe = hexagonit.recipe.cmmi
url = http://git-core.googlecode.com/files/git-1.7.12.tar.gz

[git-clone]
recipe = slapos.recipe.build:gitclone
repository = http://example.net/example.git/
git-command = ${git-binary:location}/bin/git
revision = 0123456789abcdef

Basic example

Here is example to install one or several modules:

[buildout]
parts = node-package

[node-package]
recipe = slapos.recipe.build:npm
modules =
  colors
  express

# Optional argument specifying perl buildout part, if existing.
# If specified, recipe will use the perl installed by buildout.
# If not specified, will take the globally available perl executable.
node = node-0.6

Specific version

[buildout]
parts = node-package

[node-package]
recipe = slapos.recipe.build:cpan
modules =
  express@1.0.2
node = node-0.6

Notes

This recipe suffers from buildout download utility issue, which will do not try to redownload resource with wrong md5sum.

0.12 (2013-09-05)

• gitclone: Do not upload to cache by default. 'use-cache' option replaces

System Message: WARNING/2 (<string>, line 412)

Bullet list ends without a blank line; unexpected unindent.

'forbid-download-cache' and must be explicitely set in order to use cache.

System Message: WARNING/2 (<string>, line 413)

Block quote ends without a blank line; unexpected unindent.

• gitclone: Do not cache working copy, which just duplicate .git folder.
• gitclone: do not force to use 'master' branch when not specified.
• gitclone: add git 'ignore-ssl-certificate' option.
• gitclone: if directory is no longer present, install, never update.

0.11.6 (2013-02-25)

• Cleanup pyc and pyo files when updating git repository [Sebastien Robin]

0.11.5 (2012-10-01)

• Use @{upstream} git magic value, allow to fix update bugs. [Cedric de Saint Martin]

0.11.4 (2012-09-11)

• libnetworkcache is added back as a dependency. gitclone has no sense without it in SlapOS context. [Cedric de Saint Martin]

0.11.3 (2012-09-10)

• Removed explicit dependency of slapos.libnetworkcache. If not present, it will gracefully degrade. [Cedric de Saint Martin]

0.11.2 (2012-09-05)

• Add location to Buildout "options" dict, so that it is exposed to other Buildout parts. [Cedric de Saint Martin]

0.11.1 (2012-09-05)

• Add forbid-download-cache parameter, forbidding to fetch git from cache. [Cedric de Saint Martin]
• Sanitize instance attributes. [Cedric de Saint Martin]

0.11 (2012-09-04)

• Add slapos.recipe.build:gitclone recipe. [Cedric de Saint Martin]

0.10.2 (2012-08-02)

• Update manifest to include readme.rst [Cedric de Saint Martin]

0.10.1 (2012-08-02)

• Minor fix in ReST documentation formatting. [Cedric de Saint Martin]

0.10 (2012-07-02)

• Add format = yes|no option. [Antoine Catton]

0.9 (2012-06-07)

• Revert accidental release about upcoming version of slapos.recipe.build

0.8 (2012-06-07)

• Add support for "path" argument [Cedric de Saint Martin]
• Cleanup of download entry point [Vincent Pelletier]
• Add npm and cpan entry points [Cedric de Saint Martin]

0.7 (2011-11-8)

• Generic: Remove directory when needed, and only if it is wanted. [Cedric de Saint Martin]
• Add slapos.recipe.downloadunpacked script [Alain Takoudjou]

0.6 (2011-09-08)

• Cmmi: Support more compatibility with other recipes to build, especially hexagonit.recipe.cmmi. [Łukasz Nowak]
• Generic: A lot of small improvements (like supporting values with = in environment) [Łukasz Nowak]
• Generic: Use shlex to parse some options. [Antoine Catton]
• Generic: Fix patch, it was not working, as not using stdin. [Antoine Catton]

0.5 (2011-09-06)

• Download: Expose location too for compatiblity. [Łukasz Nowak]

0.4 (2011-09-06)

• Cmmi: Provide more features to control build process. [Łukasz Nowak]

0.3 (2011-09-05)

• Provide slapos.recipe.build:download utility. [Łukasz Nowak]

0.2 (2011-09-05)

• Bugfix: Support buildout's download cache during downlading. [Łukasz Nowak]
• Bugfix: Honour correctly passed md5sum to download method. [Łukasz Nowak]
• Feature: Utility methods pipeCommand and failIfPathExists. [Łukasz Nowak]
• Bugfix: Rename promisee to promise. [Łukasz Nowak]
• Feature: Allow to define update_script and slapos_update_promise [Łukasz Nowak]
• Feature: Just warn in case of lack of promise. [Łukasz Nowak]

0.1 (2011-08-26)

• Add copyTree method to recursively copy [Cedric de Saint Martin]
• add guessPlatform function to guess architecture in case of multi-architecture installation [Cedric de Saint Martin]