[CONF] Apache Qpid: Build Creator (page edited)

Fri, 10 Oct 2008 09:27:03 -0700

Page Edited : qpid : Build Creator

Build Creator has been edited by Martin Ritchie (Oct 10, 2008).

(View changes)

Content:

Build Creator

The BuildCreator tool was devised to enable the easy generation of binary packages that include more than one source. The purpose of the build creator is to simplify the building of projects that require the combining of multiple sources. To aid discussion of the tool we shall look at the configuration file combining the Apache Qpid release with that of the BerkeleyDB Store plugin form JBoss. However, the tool is a general binary build tool written in Python.

Command Line arguments

There are various command line arguments, mainly to change the amount of logging the tool generates.

subprocess is required for this tool and is not present in versions prior to 2.4.0
usage: buildCreator.py [options]

options:
  -h, --help            show this help message and exit
  -c, --config=CONFIG
                        set configuration file : default = build.config
  -v, --verbose         enable verbose output
  -d, --debug           enable debug output
  -q, --quiet           Enable quiet ouptut
  -i, --ignore-errors   Ignore errors

File formats

Two files are currently required by the tool the main configuration file and the build file.

Config file

The main configuration file (build.config by default) specifies the various sources, patches and builds that should be utilised.

Limitiations

The build section can only contain <include> values not <build> elements directly

<builder>
    <environment>
        <[variable]>[value]</[variable]>
    </environment>

    <sources>
        <source>
            <name>[source-name]</name>
            <type>[source-type:svn|file|http|ftp]</type>
            <url>[value]</url>
            <path>[root offset, useful if to point the root of the source in to an archive output]</path>
        </source>
    </sources>
    <patches>
        <patch>
            <name>[patch-name]</name>
            <type>[source-type:svn|file|http|ftp]</type>
            <url>[value]</url>
            <source>[source name this patches]</source>
            <prefix>[patch prefix -p value]</prefix>
            <path>[root offset, useful if the base of the patch is not the root of the source]</path>
        </patch>

    </patches>

    <builds>
        <include>[string which is sent to ls to retrieve build include file so 'builds/*.build' works]</include>
    </builds>

</builder>

Build file

The build file contains scripts to perform the building and release of the build.

Limitiations

Each build file can only contain one build

<builds>
    <build>
        <name>[build-name]</name>

        <dependency>
            <source>[source-name]</source>
        </dependency>

        <targets>
            <build>
                <script><![CDATA[
<shell script>
]]>
                </script>
            </build>

            <release>
                <script><![CDATA[
<shell script>
]]>
                </script>
            </release>
        </targets>

    </build>
</builds>

Example Files

<builder>
    <environment>
        <version>M3.0-beta</version>
    </environment>

    <sources>
       <source>
            <name>qpid</name>
            <type>file</type>
            <url>http://people.apache.org/~aidan/qpid/M3-beta/qpid-incubating-M3-beta.tar.gz</url>
            <path>qpid-incubating-M3</path>
        </source>
        <source>
            <name>bdb</name>
            <type>svn</type>
            <url>https://svn.jboss.org/repos/rhmessaging/store/branches/java/broker-queue-refactor/java/bdbstore</url>
        </source>
    </sources>

    <patches>
        <patch>
            <name>BDB-Classpath</name>
            <type>file</type>
            <url>/local/patches/bdb-qpid-run-classpath.diff</url>
            <source>qpid</source>
            <prefix>2</prefix>
            <path>qpid-incubating-M3/qpid/java/<path>
        </patch>

    </patches>

    <builds>
        <include>builds/*.config</include>
    </builds>

</builder>

<builds>
    <build>
        <name>qpid-broker</name>

        <dependency>
            <source>[source-name]</source>
            <source>bdb</source>
        </dependency>

        <targets>
            <build>
                <script><![CDATA[

pushd $qpid/java
ant -Dproject.version=$version build
popd

cp $qpid/java/build/lib/qpid-broker-$version.jar $bdb/lib
cp $qpid/java/build/lib/qpid-broker-test-$version.jar $bdb/lib
cp $qpid/java/build/lib/qpid-common-$version.jar $bdb/lib
cp $qpid/java/build/lib/qpid-systests-$version.jar $bdb/lib
cp $qpid/java/build/lib/qpid-perftests-$version.jar $bdb/lib
cp $qpid/java/build/lib/qpid-junit-toolkit-$version.jar $bdb/lib

cd $bdb
ant build

]]>
                </script>
            </build>

            <release>
                <script><![CDATA[
# Create build package
mkdir -p $release/$build-$version
cp -r $qpid/java/build/* $release/$build-$version
cp $bdb/build/qpid-bdbstore.jar $bdb/lib/je-3.3.62.jar $release/$build-$version/lib
# Build release artifact
cd $release
tar cvzf $build-$version.tgz $build-$version
]]>
                </script>
            </release>
        </targets>

    </build>
</builds>

Powered by Atlassian Confluence (Version: 2.2.9 Build:#527 Sep 07, 2006) - Bug/feature request

Unsubscribe or edit your notifications preferences

Reply via email to