Hudson Builds

Hudson manages Virgo CI builds. Committers are notified of build failures caused by their pushes but anyone who wants to know about other build failures should subscribe to virgo-build (this list is not currently in use but can be enabled when needed).

Virgo Runtime Build

Virgo has its own build system known as "Virgo build" which is a collection of Ant/Ivy scripts.

Prerequisites

Make sure you have git, Java 6 or later, and ant 1.8.2 or later installed.

To use any of the Ruby scripts (e.g. update_dependencies.rb or ripplor.rb) then you must install Ruby, RubyGems and Rubygem choice:

Building Virgo Build

Building virgo-build-tools

Virgo Build, as of version 2.15, introduces p2 tools assembly and common targets and properties to make its consumption easy from the git repositories in the build chain. The p2 tools assembly and validation happens as part of a normal build of Virgo Build. In future other tools may be added, which is why the tools assembly carries the generic virgo-build-tools name.

Virgo Build isn't included in the normal build chain, so whenever there are changes to virgo-build-tools a manual rebuild and publish has to be executed, like so:

ant clean clean-integration test test-e2e

These targets assemble and validate virgo-build-tools. The target test-e2e has a dependency to package, so "package" need not be specified. test-e2e stands for end-to-end test execution: it is all performed in ant, because there is a small risk of stumbling into cyclic dependencies if we have a reference from virgo-build to the test framework. Another benefit of testing in ant is that this target exercises the exact same p2-related Ant targets other repositories will call to publish, install and uninstall.

Releasing virgo-build-tools

Virgo Build is not part of the normal release process. It is executed on demand and manually. We don't need to release new version along with the other repositories if there are no changes to virgo-build-tools.

Releasing the tools is really simple and similar to "Releasing a single repository project" described in this page. All you have to do is:

1. Tag the latest commit:

git tag VBT-1.1.0

Use the syntax VBT-x.y.z for the tags.

2. Update the following properties in Virgo Build's build.properties:

version=1.1.0
release.type=release
build.stamp=RELEASE

When making a release the version stays the same - it is incremented after releasing. What's important is to update the other properties.

At this point all repositories consuming the virgo-build-tools assembly can be updated to the newly released version.

Virgo-build-tools prerequisites

VBT released version

requires

1.0.0

2.15 or higher

1.1.0

2.15 or higher

1.2.0

2.19 or higher

1.2.1

2.19 or higher

1.3.0

2.22 or higher

Building Individual Repositories

To build a given git repository, first clone it:

git clone <repository URL>

and then make sure that the Virgo build submodule is correctly initialised by changing directory to the cloned repository and issuing:

git submodule update --init

then change directory into the build-xxx directory and invoke ant with the appropriate targets, usually:

ant clean clean-integration test

This will do a fresh build and run all the unit and integration tests. It will only report "Build successful" if everything compiles cleanly and all the tests pass. The directory build-xxx/target/test-results contains the test results in html and xml formats. You will find the built bundles in the target/artifact directory of each individual project.

Running all tests

Sometimes it is useful to run all the tests even if some fail. You can do this by specifying the property -Dci.build=true on the ant command, for example:

ant -Dci.build=true clean clean-integration test

This will report "Build successful" regardless of test success or failure and you will need to look at the test results to see which tests failed.

Common targets

ant -p displays commonly used targets. Use ant clean-ivy to delete the ivy cache (or use git clean -dfx to get everything back to a reset state, including ditching any changes you haven't committed).

If you simply want to compile the runtime code, you can use ant clean clean-integration jar but that will not compile (or run) the tests.

ant precommit performs more extensive checks including code coverage and "findbugs". (You will need a licence for Clover to perform test coverage analysis.)

Exceptions to the above

Web Server

Building the packaged web server is somewhat different:

ant clean clean-integration jar package smoke-test

Stand-alone Runtime

You can also use the package target in the nano and kernel repositories to build a standalone runtime:

After this has completed successfully, the project org.eclipse.virgo.teststubs.osgi contains the built binary and source jars in its target/artifacts directory.

Configuring p2 Publishing for Individual Repositories

Since version 2.15 Virgo Build has the capability to assemble build-tools that other repositories can use. So far these tools include only various p2 Eclipse applications.

To understand more about the virgo-build synergy with p2 and how we organized our products and packaging repositories look here.

In order to consume these tools there is a prerequisite. You have to include two references in the project's build.versions file. One for the virgo-build-tools and one for the org.eclipse.equinox.launcher used to launch the tools.

org.eclipse.virgo.build.tools=1.2.1.RELEASE

The next step is to fetch virgo-build-tools. You just need to call the predefined target for that. Here's how

<antcall target="fetch-unzipped-virgo-build-tools"/>

This call fetches and unzips the virgo-build-tools of the specified version in the project's "${target.dir}/virgo-build-tools-${org.eclipse.virgo.build.tools}" directory.

Another way to achieve the same results is to add this ant target as a dependency to a target of your choice in which you plan to use any of the virgo-build-tools common targets. Here's how

p2.generate-inf Generates p2.inf-s for all feature directories inside a wrapping 'features' directory.
p2.install-iu Installs one or more IUs to a target p2 installation's profile.
p2.install-virgo-product Installs a Virgo product to a desired destination. Default profile(roaming) is VIRGOProfile, the environment cofigurations are ANY.
p2.mirror-artifacts Mirrors an artifact set of rootIUs from a local or remote p2 repository to a local destination. The artifacts mirror app must be ran after the metadata one.
p2.mirror-metadata Mirrors a metadata set of rootIUs from a local or remote p2 repository to a local destination. The metadata mirror app must be ran first.
p2.publish-binary Publishes a single zipped artifact with unzip instructions to a p2 repository.
p2.publish-binary-chmod Publishes a single zipped artifact with proper unzip and permissions instructions to a p2 repository.
p2.publish-bundles-features Publishes bundles and features located in separate folders in the source location to a p2 repository.
p2.publish-bundles-features-alt Alternative form. Publishes bundles and features passed as separate sources.
p2.publish-category Categorizes features published in a p2 repository.
p2.publish-product Publishes a product to a p2 repository. The publishing uses ANY environment configurations.
p2.uninstall-iu Uninstalls one or more IUs to a target p2 installation's profile.
convert-p2-to-ivy Prepares p2 repository artifacts for Ivy publishing

chmod.args accepts values with file@location#permission syntax. Where location is the path where the file is located relative to the root of the zip. For example if you want to give permissions to a file in the zip's root, location is must be /. Another example is /directory/example.

A real-world example is the build.xml of the Nano repository found here.

Updating Dependencies

In general, dependencies are declared in files named ivy.xml.

Dependencies between Virgo components are a special case of this. The properties file build.versions in the root directory of each git repository defines the versions of the Virgo components that the build will download. Updating any of the versions in build.versions is error-prone as the same values occur in certain other files (which cannot use property substitution). To update a version in build.versions, run the "update dependency" ruby script in the root folder of the git repository, for example:

where <variable> is the relevant property name in build.versions and <new version> is the replacement version. The script will report the changes it makes and may issue warnings, so pay attention to its output.

Please ensure you are running the latest version of update-dependency script by updating web-server git repository.

Updating Eclipse dependencies

Virgo can consume artifacts from both Eclipse p2 repositories and Orbit. The Juno contribution is even required to consume the same artifacts that are present in Orbit and the other Juno-contributed p2 repositories.
As of version 2.22 virgo-build is capable of doing this by introducing new ant targets and a new git repository called "eclipse-mirror".
Building this repository mirrors the artifacts from a specified p2 repository and publishes them to the Ivy repositories at build.eclipse.org. From then on it's business as usual for virgo-build.

Virgo's Eclipse dependencies are updated manually, on-demand, without the update being part of a ripple or a release process.

Here's how to do it:

1. The build.properties file in the eclipse-mirror repository contains two important properties

mirror.source - the URI to the p2 repository from which we will mirror
mirror.ius - a coma-separated list of symbolic names that we want to mirror locally

Prior triggering the update process these properties must be set with the desired values. Note the source bundles need to be described in the IU list as well if they are needed.

Here's an example of both properties:

mirror.ius=\
org.eclipse.osgi,\
org.eclipse.osgi.source

mirror.source=http://download.eclipse.org/releases/juno

Local locations are accepted as well:

mirror.source=file:/<location-to-local-p2-repo>

2. Trigger ant build of the eclipse-mirror repository like this:

ant update-eclipse-artifacts

Even if some versions are already published the process will overwrite them, so it won't fail.
As a result of this operation a new build.versions file is generated that contains the new versions.

3. Trigger a ripple or release to let the scripts propagate the new versions upstream.

Rippling

Since the Virgo components form a directed, acyclic graph, changing the graph to use a new version of a specific component involves not only updating that version throughout the graph, but also updating the versions of the components which have been changed. This is the tedious process known as rippling and so the ripplor ruby script was written to automate it. Essentially, Ripplor handles the most commonly updated components and flattens the dependency graph into a linear sequence. The sequence is (at the time of writing):

So, for example, if you change the kernel and want to produce a package web server containing the updated kernel, you would run:

~/virgo/web-server/scripts/ripplor/ripplor.rb -r kernel

This would build and publish a new version of the kernel, update the dependency of the web layer on the newly built kernel, build and publish a new version of the web layer, update the dependency of the Virgo-supplied applications on the newly built web layer and kernel, and so on until it builds and publishes a new version of the packaged web-server. This is called a ripple from kernel.

Ripplor (after 13May2010) allows a ripple to be executed across a list of repositories some in git.eclipse.org and some in git.springsource.org, though all of them are in git.eclipse.org at the time of writing.

The definitive list of repositories and the order of a ripple is stored in the ripplor.rb ruby script source.

Please ensure you are running the latest version of ripplor script by updating web-server git repository.

When should Ripplor be used?

In general, Ripplor is used any time a change needs to be propagated up the graph of dependent repositories. There are two main cases that cause this to happen.

An external dependency needs to be upgraded in all modules of Virgo

A change has been made to code in a repository (e.g. the kernel) which affects its externally visible behaviour. The code above (e.g. the web layer, Virgo-supplied applications, etc.) needs to be updated to see the changes.

Usage

Usage: ripplor.rb [-rbvmuc]
Required arguments:
-r, --repo=REPO The name of the starting repo
Optional arguments:
-b, --virgo-build-version=VIRGO-BUILD-VERSION
The version to update Virgo Build to
-v, --version=VARIABLE:VERSION[,...]
Versions to substitute during the ripple
-m, --map=REPO-MAP The property file containing a mapping from a repository name to a location
(defaults to ~/repository.map)
-u, --remote-user=REMOTE-USER User id to use for remote repository access
-c, --branch=BRANCH-NAME The branch to be rippled
(defaults to master)
--dry-run Show what would happen but do not actually do anything

Option

Description

-r

The name of the repository you want to start the ripple at. A typical repository name is util or kernel.

-v

When updating a dependency use this flag to describe both the variable to update and the new version to update to. Can be a comma separated list if multiple dependencies need updating at the same time.

-m

The location of the repository map file (see below). By default, this file is found in ~/repository.map, but in cases where you have more than one file (one for simple ripples, one for complex ripples that happen in your working copy) you may need to pass in this value.

-u

The login name used for ssh access to the git.eclipse.org server. By default, this is the local login name.

-c

The branch to be rippled. By default, this is master.

Repository Map

By default, Ripplor checks out each repository working copy to the working directory that it was run from. If you are prepared to run Ripplor in a dedicated working directory, this is fine. However, if you run a ripple from within your development shell environment it can pollute your filesystem. To account for this, Ripplor takes a repository map file. This file tells Ripplor where to checkout a repository working copy to. The file itself is a simple mapping from a repository name to a filesystem location.

Tip: In the repository map file, ~ will be expanded to the current user’s home directory.

Broken Build

Ripplor was smart enough to restart a failed ripple.

[If a ripple fails (due to test or compile failure), simply fix any problems in the working copy that Ripplor is using and restart the ripple at the same location you originally used. Ripplor will bring in any new commits since you last started the ripple and continue up the stack as done previously. This behaviour is very useful if you are rippling a breaking API change and need to fix code as the ripple moves upwards.]

Unfortunately this behaviour is broken, since the version updates (accumulated during the ripple and propagated up) are not correctly restored. Also, when committing the changes (to all the repositories) at the end, after a failure in the middle, not all of the rippled repositories will be committed at the end.

Re-Building

To re-start ripplor and fix a broken build you can use two strategies:

Restart from lowest

The standard solution at the moment is to push the repositories that succeeded by hand and start another ripple, with version updates that are likely to be lost inserted by hand on the ripplor command line. This is not perfect and a repeat of the ripple from the lowest point is safer.

A full ripple of all of the repositories takes an hour and a half or more, even on a high-end Mac.

Safe/Lucky points

Ripplor can be restarted from repository that contains all the version updates so far (this may be called a safe or lucky point). The repositories that contain all version updates:

medic

kernel

web

web-server

For example if the build broke at snaps you can re-start from the last successfully built safe repository. In our example this is the web repo.

Releasing a Single Repository Project

Simply follow these steps to produce a release of a product that is within a single Git repository. The aim is to have a tag of the right name pointing to the codebase at release time and to leave master or the current development branch version at the next version ready for development to continue. Only committers can produce releases.

1. Create a new branch and make sure everything is up to date and clean

2. Update the build.properties file to have the right version, have a release.type of 'release' (or 'milestone' if appropriate), and have a build.stamp with the appropriate version qualifier. For example:

version=1.1.0
release.type=release
build.stamp=RELEASE

Note: if you are releasing bundlor, make sure to update the version of the Maven Bundlor plugin in plugin.xml.

3. Do the build, commit the changes and then tag it with the version and release type appropriate. In order for publishing to eclipse to work you must have your ssh public key registered with the virgoBuild account.

4. After the tag go back to master and delete the release branch. The branch will still be available from the tag.

git checkout master
git branch -D release

5. Back on master the build.properties file needs to be revved up to the following release for development to continue. Ensure the release type is still integration and that the build.stamp property is not present. Set the version to the following version of the product.

version=1.2.0
release.type=integration

6. Finally add, commit and push it all back up to origin. Ensure the new tag is also pushed up.

git add .
git commit
git push origin
git push --tags

Once this is done the usual steps to make the release available on download servers and to make announcements should be followed. For Eclipse, a committer with a full shell should sftp in to download1.eclipse.org and beam the file up. More information available here.

Releasing a Multi Repository Project

This is for any release of the full Virgo Server. It makes use of the Releasolor ruby script. This is very similar to Ripplor but it also performs the steps above for a single repository to all the repositories it visits. Only committers can produce releases.

The usage instructions are:

Usage: releaselor.rb [-vqtnbmurcghjkd]
Required arguments:
-v, --version=VERSION The version number of the release
-q, --build-stamp=BUILD-STAMP The build stamp for the release, e.g. M01, RELEASE
-t, --release-type=RELEASE-TYPE The release type for the release, e.g. milestone, release
-n, --new-version=NEW-VERSION The new version number to be used after the release

Optional arguments:

-b, --virgo-build-version=VIRGO-BUILD-VERSION
The version to update Virgo Build to
-m, --map=REPOSITORY-MAP The property file containing a mapping from a repository name to a location
(defaults to ~/repository.map)
-u, --remote-user=REMOTE-USER User id to use for remote repository access
(defaults to local login id)
-r, --product-release=PRODUCT The product to be released, kernel, web-server, virgo, full-product
(defaults to releasing all the virgo repos)
-c, --branch=BRANCH-NAME The branch to be released
(defaults to master)
-g, --gemini-version=GEMINI-BUILD-VERSION
When producing a full-product build the Gemini version must be given
-h, --gemini-build-stamp=GEMINI-BUILD-STAMP
The build stamp for the Gemini Web release, e.g. M01, RELEASE
-j, --gemini-release-type=GEMINI-RELEASE-TYPE
The release type for the Gemini Web release, e.g. milestone, release
-k, --gemini-new-version=GEMINI-NEW-VERSION
The new Gemini Web version number to be used after the release
-d, --gemini-branch=BRANCH-NAME The Gemini Web branch to be released
(defaults to master)
--dry-run Show what would happen but do not actually do anything

Publishing the Gemini ZipsIf you do a 'full-product' release, Gemini Web will also be released. There will be a manual step to publish the Gemini zips to download.eclipse.org as they need to go in a different directory than the rest of Virgo. The Zips will be built as normal and will be available from the 'build-web-container' directory.

Updating Plan versionsWhen doing a full release there are some plan files that need manually editing.

In addition, the abstract integration test in the web.test project and AdminConsoleAppTests in the system-verification-tests repository (still to be contributed at the time of writing) also need to be updated to use the new version for the tests to pass. Ideally the script that does version updating should cover this but in doing so it would no longer be generic. Ideas welcome.

Add Virgo IDE dependencies to your target platform. The best way to do that is to add the composite update site at http://download.eclipse.org/virgo/snapshot/tooling to your target platform and select the following items only. You'll need to uncheck "Group Items by Category" to see all of these.

All Libra Features

Eclipse Virgo Bundlor

Eclipse Virgo Kernel

Eclipse Virgo Medic

Eclipse Virgo Utils

To launch the Virgo tools, just

Add all features but *..tests to an Eclipse runtime.

Add any WTP or JEE features appropriate for your target environment.

Be sure to select "Add Required Plugins".

Building Documentation

The Eclipse documentation builds from the same documentation source as the rest of the Virgo build, all of which is maintained in the documentation repos. Currently, Eclipse doc builds are invoked manually. See this bug for more information.

Updating Wiki Text Documentation

We are also re-providing this Wiki documentation as part of the Eclipse Virgo feature. Unfortunately, we aren't able to update those documents automatically, as that would require committing changes into git, and resolving ordering issues there. Currently, the process works like this:

Execute ant build.xml in wiki-guide. This:

Causes the Wiki Text to be built for use in the Virgo IDE Documentation.

Builds docbook xml for use in the tooling-guide, and copies the relevant XML to that guide.

Execute the IDE build as described above.

The Virgo documentation will be updated with the tooling guide additions during the next scheduled Virgo docs build.

Editing Media Wiki Documents

Note that there is now mediawiki support for the tooling documentation. This means that you can use mediawiki to write documentation, and we can easily crowd-source the latest documentation from the Virgo wiki pages. You can mix and match mediawiki documentation with ordinary docbook documentation. Just be sure not to edit mediawiki produced docs in the wikixml directory directly as they will be overwritten ! To build the wiki docs, just call:

ant wiki-to-docbook

Each wikitext document is a chapter.

To add a new chapter to the tooling docs, edit src/virgo-tooling-guide and add the chapter to the xi:include entries with the path ../wikixml/your_chapter.xml.

(This is not a build time task, it's simply an aid for creating the entire documentation set.)