Modeling Project Releng

This document is directed to the Eclipse Modeling Framework Technologies (EMFT) [1] component owners and was created help them to set up and run their builds. It describes the existing procedures that all EMFT components are required to adopt, describing, for example, how the files should be organized, what the build files are, and the Integration and Milestone release process.

Note that many of the tips and tricks described herein apply to EMF, MDT, and M2T builds as well.

Throughout this document are references to releng (Release Engineering) files which need to be configured along the way. When a project is first starting, these steps are normally skipped until after all the plugin content is in CVS. Then, and only then, the Modeling Project Releng Module can be created for the new project, and builds can begin.

---

Overwhelmed yet?

Well, you're in luck. As of 2006-07-12, there is a new module template which can be used as a starting point. For more on creating and configuring a Modeling Project Releng Module, see Modeling Project Releng Module. Go there, start with that, then come back here for tips and tricks if necessary.

---

This is a live document! We will be enriching it as questions are raised.

Plugin and Feature Files

The contents of your features and plugins directories should mimic what is available in the EMF and UML2 projects. Although this section tries to summarize the important points, "learning by example" is the recommended approach.

Directory Structure

<example>

We will ask you to organize your files as we've done for EMF and UML2. Basically you will need to create the following directory structure for each subdirectory you own under the EMFT module:

OLD Style -- features intermixed			NEW Style -- features separated
Old EMFT project (/cvsroot/technology) emft/[subproject]/ plugins doc tests examples	- or -	New EMFT project (/cvsroot/modeling/) org.eclipse.*/org.eclipse.*.[subproject]/ plugins doc tests examples	Old EMFT project (/cvsroot/technology) emft/[subproject]/ plugins doc tests examples features	- or -	New EMFT project (/cvsroot/modeling/) org.eclipse.*/org.eclipse.*.[subproject]/ plugins doc tests examples features
plugins: the plugins that provide the function the features that include these plugins + the branding plugins for these features the SDK feature (to generate a bundle that includes source + the plugins) doc: the doc plugins (with the build scripts) the features that include these plugins + the branding plugins for these features tests: the test plugins (with the Eclipse test framework artifacts - such as this one) the features that include these plugins + the branding plugins for these features examples: any plugin you want to use as example the features that include these plugins + the branding plugins for these features			plugins: the plugins that provide the function doc: the doc plugins (with the build scripts) tests: the test plugins (with the Eclipse test framework artifacts - such as this one) examples: any plugin you want to use as example features: the SDK feature (to generate a bundle that includes source + the plugins) all main, source, test, doc, and example features

The directories containing features and fragments must be suffixed by -feature and -fragment respectively.

If you want source plugins and features, you will have to create them.

General Recommendations

• Each feature and plugin directory should be also an Eclipse project, containing all the necessary files such as, for example, .project.
• The .project must only refer to builders available to the open-source community. Also, since Eclipse 3M2, it should not refer to other plugin projects. <example>
• We use CVS to backup the files, so...
  • You can, and probably should, use the $Id$ CVS tag. For more details and other tags read the CVS documentation
  • Add a .cvsignore file to keep unnecessary files (such as the output directory) out of CVS. <example>
• Don't add unnecessary files to your plugins and features. If you use a "non-Eclipse standard" file, please ensure that it has a purpose and that that purpose is clear.
• All plugins should provide the following files:
  • META-INF/MANIFEST.MF <example>
  • plugin.xml <example>
  • plugin.properties <example>
  • build.properties <example>
  • about.html <example>
• The build.properties file is extremely important and must be accurate to allow PDE to build your plugins and features. Please review the EMF build.properties files for plugins with code, documentation and branding plugins, and features.

Features <example>

• The PDE build process is based on features, so all your plugins must be referenced by a feature.
• A feature directory can contain the definition of other features and plugins. As you can see in the example, we use this to define "derived" elements, like EMF's SDK feature, source feature and source plugin.
• A feature's build.properties file can specify that the source plugin and feature should be generated. In EMF, this is done in the SDK feature's build.properties.

Qualifiers (1.0.0.qualifier)

• To add qualifiers to features and plugins, you must have 4 pieces set up correctly.
  

1. Plugins <example>

• Append .qualifier as the 4th field of the plugin version in every MANIFEST.MF file.
  

2. Features <example>

• Append .qualifier as the 4th field of the feature version in every feature.xml file.
• Ensure that if you have comments before the <feature> tag, they do NOT include the word "feature". If they do, 1.0.0.qualifier will not be replaced by PDE with the build's timestamp/id. This is documented in bug 129868.
• Change the versions in all plugins included in feature.xml files to 0.0.0. PDE will replace 0.0.0 by the appropriate version during the build.
  

3. Doc

• Ensure that org.eclipse.[subproject].doc/build.xml uses ${pluginVersion}.${forceContextQualifier} instead of ${pluginVersion} or a hard-coded version like 1.0.0. You may need to add a new property. <example>

<property name="pluginVersion" value="1.0.0"/>

• Add these lines to the end of the gather.bin.parts target in org.eclipse.[subproject].doc/build.xml (line break added in path attribute). <example>

<eclipse.versionReplacer
  path="${destination.temp.folder}/org.eclipse.[subproject].doc_\
    ${pluginVersion}.${forceContextQualifier}"
  version="${pluginVersion}.${forceContextQualifier}"/>

4. Releng

• Add the following lines to the create.label.properties target of releng/[subproject]/buildAll.xml. <example>

<property name="forceContextQualifier" value="v${timestamp}"/>

<echo file="${buildDirectory}/label.properties" append="true" >
 forceContextQualifier=${forceContextQualifier}
</echo>

• OPTIONAL: If you would like your features' versions to be suffixed with a dash followed by a random string of letters and numbers, you must also add a line to your build.properties files. Why would you want this? It is apparently calculated from the CVS tags to ensure that the version for the features will change if the source changes in the build.
  

5. Releng

• Add generateFeatureVersionSuffix=true to all build.properties files in every releng/[subproject]/builder/ directory. <example>
• If available, add generateFeatureVersionSuffix=true to any build.properties.template files in releng/[subproject]/templateFiles/. <example>

Tip: due to property file parser limitations in Eclipse, it is recommended that you always leave an empty line at the end of .properties (and .properties.template) files.

• For more on plugin versioning, see http://www.eclipse.org/equinox/documents/plugin-versioning.html.

Branding Icon In About Eclipse Dialog

If you want to use the Eclipse Modeling icon in the About Eclipse dialog, you must reference it correctly in ALL your about.ini files, eg:

• org.eclipse.xsd.doc/about.ini
• org.eclipse.xsd/about.ini
• org.eclipse.xsd.sdk-feature/sourceTemplatePlugin/about.ini

# Property "featureImage" contains path to feature image (32x32)
featureImage=modeling32.png

Note that the latest Eclipse Modeling icon is modeling32.png, as decided by bug 154906. You can copy this new icon from here: modeling32.png

Branding Plugin <example>

• The "branding plugin" is the plugin that provides specific files to describe a feature - check the example to see what these files are.
• It is recommended that the branding plugin be given the same name and id as the feature it describes.
• The "branding plugin" may also contain source, so you don't need to create an additional plugin just to hold the branding files.

Core Plugins & Features <example>

Core Plugins

For plugins with code:

• The EMF artifacts and model specifications (XML schema, for example) should be located in a models directory in the root of the plugin. Don't forget to include the genmodel to allow users to regenerate your code.
• DO commit all generated code. This makes it easier to run your plugin from the workspace.
• The source files should be placed in "source folders" and each "source folder" should have a different "output folder".
• The plugins with code should be deployed as jarred plugins. In order to tip the PDE build to jar a plugin, you need to set the MANIFEST.MF's Bundle-ClassPath attribute to . and use . in the build.properties file. As an example, look at the ecore's manifest and build.properties mentally replacing ecore.jar by ..

Right now you are probably asking yourself why the ecore files are declaring a jar instead of using .. To make a long story short, this is necessary for EMF to bootstrap itself during development (required when you use EMF to develop EMF). When developing, we can easily zip the contents of the output folder into the appropriate jar and restart Eclipse. Our build "fixes" the files before the plugins are packaged. Btw, to jar your plugin, you will also need to add unpack="false" to the plugin reference in your feature. <example>

• Almost all files should have a copyright. This is what is used for the Java files in EMF (please check the other types of files in the example):

/**
 * <copyright>
 *
 * Copyright (c) 2005 IBM Corporation and others.
 * All rights reserved.   This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors: 
 *   IBM - Initial API and implementation
 *
 * </copyright>
 */

• The META-INF/MANIFEST.MF must end with an empty line. Also, don't forget to add the following line to the manifest to ensure the plugin classes are properly initialized:

Eclipse-LazyStart: true

• The .classpath files should only contain references to the JDK and PDE container and the definition of the source and output folders.
• In order to ensure that your plugin.properties files can be translated, you will need to add the following "directives" to them. All strings after a given directive are supposed to conform to its rules:

NLS_MESSAGEFORMAT_ALL	Each string is assumed to be processed by the MessageFormat class (single quote must be coded as 2 consecutive single quotes '').
NLS_MESSAGEFORMAT_NONE	All strings are assumed to NOT be processed by the MessageFormat class (single quote must be coded as 1 single quote ').
NLS_MESSAGEFORMAT_VAR	Strings which contain replacement variables are processed by the MessageFormat class (single quote must be coded as 2 consecutive single quotes ''). Strings which do NOT contain replacement variables are NOT processed by the MessageFormat class (single quote must be coded as 1 single quote ').

• Add a schema for each extension point you define in your plugin. <example>

Core Features

This is a stub. Contribute to this wiki by adding content here.

Documentation Plugin & Feature <example>

• While the PDE build is able to automatically create the Ant build script for the plugins with source code, you will need to hard code and maintain the script for the documentation plugins. The easiest way of creating the script (called build.xml) is:
  1. After adding all the files to the plugin directory and configuring the build.properties file, right click the plugin.xml file and select PDE Tools->Create Ant Build File.
  2. Open the build.xml file and delete the tasks in the gather.bin.parts; target.
  3. In the build.jars, use the zip ant tasks to zip up the content of the plugin - this is required since Eclipse expects the documentation files to be in an archive file.
  4. Open the build.properties editor and select the "Custom Build" check box at the top of the page
  5. Every time you start code a new release, you will need to manually update this build script. See the "Release Process" section for more details on new releases.

Javadoc <example>

• Creating javadoc in your plugin requires a number of files & folders:
  1. build.xml (including all source), or
     build.xml (excluding internal packages & classes)
  2. plugin.xml
  3. toc.xml (table of contents)
  4. build.properties
  5. build/antJavadoc.sh
  6. build/javadoc.xml.template
  7. build/overview.html
  8. images/ (folder, ref'd in build.xml#build.jars)
  9. references/ (folder, ref'd in build.xml#build.jars)
  10. tutorials/ (folder, ref'd in build.xml#build.jars)

• Note that unless you have images, references, or tutorials at the time you're creating these files, you'll have to toss a placeholder into them so they won't be pruned (ignored) when extracting from CVS. A simple (blank) .cvsignore file will do nicely.

Javadoc Indexed By Eclipse Help

To get Eclipse to index your javadoc in the Help system, you must revise the following files (see also bug 142558):

1. Specify where extra topics_*.xml files are attached to the main table of contents entry: toc.xml

<topic label="Reference">
  <link toc="topics_Reference.xml"/>
</topic>

2. Specify which files to include in the doc plugin (custom build script, not PDE-generated): build.xml

 <target name="gather.bin.parts" depends="init" if="destination.temp.folder">
   ...
   <fileset dir="${build.result.folder}" 
     includes="about.*,eclipse*.gif,eclipse*.png,eclipse*.jpg,plugin.*,toc*.xml,topics_*.xml,doc.zip,index/**,META-INF/**"/>
   ...
 </target>

3. UPDATED Configure javadoc.xml.template, if required. Doclet is no longer used; instead, generation is done simply in antJavadoc.sh

<target name="javadoc" depends="extractPlatformJavadoc">
...
<javadoc ...>
  <arg value="-J-Xmx256m"/>
  ...
</javadoc>
...

4. Define extension points to allow extra topics_*.xml files to be seen in Eclipse Help: plugin.xml

 <!-- ============================= -->
 <!-- Define TOCs                   -->
 <!-- ============================= -->

 <extension point="org.eclipse.help.toc">
   <toc file="topics_Reference.xml" />
 </extension>

 <!-- ============================= -->
 <!-- Define Javadoc locations      -->
 <!-- ============================= -->
  <extension point="org.eclipse.pde.core.javadoc">
      <javadoc path="references/javadoc"> <!-- defaults to reference/api -->
      </javadoc>
  </extension>

Tests Plugin & Feature

This is a stub. Contribute to this wiki by adding content here.

Examples Plugin & Feature

This is a stub. Contribute to this wiki by adding content here.

SDK Feature

This is a stub. Contribute to this wiki by adding content here.

Source Plugin & Feature <example>

• To create a source plugin and feature, you must have 5 pieces set up correctly.
  

1. org.eclipse.[subproject]-feature/feature.xml <example>

This will define which *src.zip files will be created - one per plugin include in the feature. If you want source for your examples, do the same in your [subproject].examples-feature.

[update] NOTE: you must include your branding plugin (eg., org.eclipse.net4j) in your branding feature (eg., org.eclipse.net4j-feature/feature.xml), even if it contains NO source, in order to properly suppress unpacking src/* in the .source plugin. Ensure that you've set that plugin to be unpack="false":

<plugin
  id="org.eclipse.net4j"
  download-size="0"
  install-size="0"
  version="0.0.0"
  unpack="false"/>

2. org.eclipse.[subproject]-feature/sourceTemplateFeature/* <example>

3. org.eclipse.[subproject]-feature/sourceTemplatePlugin/* <example>

These define the contents that will go into your source feature(s) and plugin(s).

4. org.eclipse.[subproject]-feature/org.eclipse.[subproject].sdk/feature.xml <example>

<includes
  id="org.eclipse.[subproject].source"
  version="1.0.0"
  match="compatible"/> 

This connects your SDK to your .source plugins/features so that they will be included in the SDK. For more on match rules, see Matching Rules.

5. org.eclipse.[subproject].*/build.properties (for ALL applicable plugins) <example>

Bundle-ClassPath With Dot RECOMMENDED: jarred plugins w/ org/eclipse/.../*.class files		Bundle-ClassPath With Jar NOT RECOMMENDED: jarred plugins with nested jars
# NLS_MESSAGEFORMAT_VAR source.. = src/ output.. = bin/ src.includes = about.html bin.includes = plugin.xml,\ plugin.properties,\ icons/,\ .,\ META-INF/ Use . instead of a jar name; repeat in MANIFEST.MF files: Bundle-ClassPath: .		# NLS_MESSAGEFORMAT_VAR source.[Bundle-ClassPath] = src/ output.[Bundle-ClassPath] = bin/ src.includes = about.html bin.includes = plugin.xml,\ plugin.properties,\ icons/,\ [Bundle-ClassPath],\ META-INF/ Note that [Bundle-ClassPath] is the jar name defined in the matching MANIFEST.MF, such as: Bundle-ClassPath: eodmeditor.jar

These define what gets packaged in the *src.zip files. You should NOT use src.includes = src/ unless you want your source plugin to include BOTH a *src.zip (containing *.java source files) and the unpacked *.java source files themselves.

Multiple Namespaces

• If you want to contribute sources to your SDK, you must create a source plugin and feature for every feature that will contribute source. If you only have one main feature, eg, org.eclipse.emf.[subproject]-feature, there will be one src.zip created for every plugin listed in that feature's feature.xml. If you have more than one, as in the case with org.eclipse.emf.transaction, containing both org.eclipse.emf.transaction-feature and org.eclipse.emf.workspace-feature, each must contain its own sourceTemplateFeature and sourceTemplatePlugin. (???)

• You can also use the generate.feature directive in your SDK's build.properties, if you have source for more than one namespace. (???)

Building Zips & Jars

• We use the Eclipse build process which relies on PDE. See this article if you are interested in the details. It also covers the JUnit automated tests that can be run during the build.
• You can use PDE to configure what will appear in your zips.

Incubation Status

In order to comply with Eclipse.org's Incubation Rules, EMFT components must adhere to these 3 rules.

For example, here are the changes required to make EMF Compare compliant: Search CVS results

1. All downloadable zip files for builds and milestones must include the word incubation in the filename. For example, emft-compare-SDK-incubation-N200708031343.zip. The jar files in the download zip file are NOT required (bug 178944) to contain the word incubation in the filename.

To change your build to provide -incubation in the zip names, search your .releng project for ".zip" and fix all files accordingly. Releng Example

• Building: customTargets.xml (all versions of this file)
• Testing: relengbuildgtk.sh, testManifest.xml, testManifest.xml.template, testing.properties, readme.html
• Promoting: promoteToEclipse.*.properties

2. All Bundle-Names must include the world incubation. Note that Bundle-SymbolicNames should not include incubation because the Bundle-SymbolicName is a technical namespace, not a user namespace. For example, Bundle-Name: Foo Plug-in (Incubation).

Update all your component's MANIFEST.MF and/or plugin.properties files, including tests, examples, and doc (which file to edit depends on where "Bundle-Name" strings are located). MANIFEST.MF Example

Bundle-Name: %pluginName (Incubation) [2]

3. The names for update manager features must include the word incubation. For example, EMF Compare Documentation (Incubation).

Update all your component's feature.xml and/or feature.properties files, including tests, examples, doc, and SDK features. Add (Incubation) to both the feature label and the feature description. Feature.* Example

<feature
     id="org.eclipse.emf.compare.sdk"
     label="EMF Compare SDK (Incubation)"
     version="0.7.0.qualifier"
     provider-name="Eclipse.org">

  <description>
     EMF Compare SDK includes runtime, source, and documentation (Incubation)
  </description> [3]

When a project exits incubation, above changes should be reversed to remove the incubation identifiers from features, plugins, and zip file names.

Customizing Zip Bundles

In the event that you have plugins or features that PDE will not normally bundle together, such as .ui plugins in the runtime zip, you will need to adjust the way PDE behaves in order to ensure all your plugins/features appear in your zips as you need them. If you need a custom zip, like EMF has for Models or Standalone, this is also how you can accomplish this.

There's two ways to customize what gets put into a zip bundle by PDE: the correct way (a) and the shortcut (b)

Option A

The first method involves creating a feature which sets up the included features/plugins that have to be in there, as with .sdk features in the EMFT subprojects (ocl, query, validation, transaction). See details in CVS. An example of this is org.eclipse.emf-feature/org.eclipse.emf.sdk. It is nested (rather than being its own org.eclipse.emf.[subproject].[bundlename]-feature) for cosmetic reasons (it looks in the file system).

When creating a new org.eclipse.emf.[subproject]-feature/org.eclipse.emf.[subproject].[bundlename] (or org.eclipse.emf.[subproject].[bundlename]-feature), you will need to ensure it's properly connected to the build harness in 3 ways:

1. First, you'll need a folder under your builder/ directory for the feature build, such as:

org.eclipse.emft/releng/validation/builder/sdk/

Into this folder must go a customTargets.xml and a build.properties file. Then make sure that customTargets.xml refers to the feature correctly, as in customTargets.xml. (Search for "sdk" on lines 9, 20, 187.)

2. Then, the buildAll.xml script must be told how to build the new zip, eg, buildAll.xml (line 139):

<target name="buildAll" depends="init">
  <ant antfile="build.xml" target="main">
    <property name="component" value="builder/sdk"/>
  </ant>
  ...
</target>

3. And finally, you need to add the custom feature to the mapfile & mapfile template, since it won't be generated by PDE into the mapfile automagically. Examples: org.eclipse.emft/releng/validation/maps/validation.map
org.eclipse.emft/releng/validation/templateFiles/validation.map.template

Add an entry such as (line break added for clarity):
feature@org.eclipse.emf.validation.sdk=@cvsTag@,@cvsRoot1@,,org.eclipse.emft/validation/plugins/ org.eclipse.emf.validation-feature/org.eclipse.emf.validation.sdk

Option B (or adding an optional dependency)

The second method is faster (and, arguably, more hackish). This is also a valid method for adding an optional dependency, like for example adding optional support for OCL.

Instead of one feature per zip, as above, you can have custom instructions/rules in the buildAll.xml script which allow you to copy extra files that would normally be excluded from the zip to clean up missing content. These instructions are kept in one place (ie., only one ant script), so maintenance is easier, but this solution should only be used to add files to existing bundles, not to create new, custom ones.

For example, there's a validation.ocl plugin which must be included in the validation runtime, but since the validation-feature makes no mention of it, it's excluded. So, to work around this, once the SDK is built, copy the validaton.ocl plugin & feature from the SDK zip to the runtime zip after its assembly. This is done in the org.eclipse.emft/releng/validation/buildAll.xml script:

<target name="buildAll" depends="init">
  <ant antfile="build.xml" target="main">
    <property name="component" value="builder/sdk" />
  </ant>
  
  <ant antfile="build.xml" target="main">
    <property name="component" value="builder/runtime" />
  </ant>
  ...
  
  <!-- add .ocl feature + plugin from SDK to runtime -->
  <zip update="true"
    destfile="${buildDirectory}/${buildLabel}/emft-${subprojectName}-runtime-${buildAlias}.zip">
    <zipfileset 
      src="${buildDirectory}/${buildLabel}/emft-${subprojectName}-SDK-${buildAlias}.zip">
      <include name="**/org.eclipse.emf.${subprojectName}.ocl*"/>
      <include name="**/org.eclipse.emf.${subprojectName}.ocl*/*"/>
    </zipfileset>
  </zip>
  ...
</target>

Bear in mind that you must ensure that everything you need to compile is available. You will need to edit all the customTargets.xml files that are used to build code which depends on the new reqiurement. See target "postSetup".

<ant target="getDependency" antfile="${getDeps.xml}">
   <property name="url" value="${oclURL}"/>
   <property name="file" value="${oclFile}"/>
   <property name="isUnpackedFile" value="${buildDirectory}/plugins/org.eclipse.emf.ocl/plugin.xml"/>
</ant>

If your tests require addtional plugins in order to compile or run, be sure to add them to your test.xml file. See target "setup".

Using Third Party Jars

You want to use third party jars during your build, but don't want to ship them due to licensing or other reasons? Here's how:

• First, add the jars to your build or test environment. org.eclipse.emft/releng/cdo/builder/tests/customTargets.xml

<target name="postFetch">
  <replace dir="${buildDirectory}/plugins" value="${timestamp}" token="@buildid@">
    <include name="**/about.mappings" />
  </replace>

  <echo message="Copy hsqldb.jar into plugins/org.eclipse.emf.cdo.jdbc.hsqldb/lib ..."/>
  <copy 
    todir="${buildDirectory}/plugins/org.eclipse.emf.cdo.jdbc.hsqldb/lib" 
    file="${buildDirectory}/../../../../../../../downloads/hsqldb.jar" failonerror="true"/>

  <echo message="Copy mysql-connector-java-3.1.12-bin.jar into plugins/org.eclipse.emf.cdo.jdbc.mysql/lib ..."/>
  <copy 
    todir="${buildDirectory}/plugins/org.eclipse.emf.cdo.jdbc.mysql/lib" 
    file="${buildDirectory}/../../../../../../../downloads/mysql-connector-java-3.1.12-bin.jar" failonerror="true"/>
</target>

• Then, remove the jars from your SDK, Runtime, or test zips if they were added by PDE. org.eclipse.emft/releng/cdo/buildAll.xml

<echo message="Repack zip w/ exclusion filter"/>
<zip destfile="${buildDirectory}/${buildLabel}/emft-${subprojectName}-SDK-${buildAlias}.zip_" update="true">
  <zipfileset src="${buildDirectory}/${buildLabel}/emft-${subprojectName}-SDK-${buildAlias}.zip">
    <exclude name="**/lib/hsqldb.jar"/>
    <exclude name="**/lib/mysql-connector-java-3.1.12-bin.jar"/>
  </zipfileset>
</zip>

<echo message="Remove orig. zip and rename new one"/>
<delete file="${buildDirectory}/${buildLabel}/emft-${subprojectName}-SDK-${buildAlias}.zip"/>
<move file="${buildDirectory}/${buildLabel}/emft-${subprojectName}-SDK-${buildAlias}.zip_" 
  tofile="${buildDirectory}/${buildLabel}/emft-${subprojectName}-SDK-${buildAlias}.zip"/>

Standalone Zip Bundles

Building a Standalone Zip allows you to provide code for use outside Eclipse. This is not very well documented (yet), but to get a feel for how to build a Standalone bundle, have a look at the following EMF examples:

Build

org.eclipse.emf.releng.build/zips/standalone/
org.eclipse.emf.releng.build/buildAll.xml
org.eclipse.emf.releng.build/zips/build.xml
  (line 14, target "standalone")

Test

org.eclipse.emf.releng.build/testManifest.xml
org.eclipse.emf.releng.build/templateFiles/testManifest.xml.template
org.eclipse.emf.releng.build/tests/configs/local/customTest.xml

Build Server Directory Structure

Here's a quick snapshot of the directory structure used on the emft build server, so that you can reproduce it elsewhere.

The emft build server (emf.torolab) is running Debian 3.0 (Woody), kernel 2.4.25, with dual 2G AMD Opteron processors, 3G RAM, 1.5G swap, and 33G HD.

Path	Purpose/Description
/var/www/emft/	internal web paths (build.php)
/var/www/technology/emft/	external web path mirrored to download.eclipse (downloads, etc.)
/var/www/technology/emft/build.options.txt	file used by both build.php and downloads/index.php to display only those builds specified
/var/www/technology/emft/downloads/index.php	where to download project zips
/var/www/technology/emft/[subproject]/downloads/	symlink to /home/www-data/build/emft/[subproject]/downloads/ (so that the downloads page can find the zips)
/home/www-data/build/emft/scripts/	build path to where shell scripts are initiated by the web (the apache1.3 user is www-data)
/home/www-data/build/emft/requests/	build path to where build.php's data (URLs and log of requests for builds) is stored
/home/www-data/build/emft/[subproject]/downloads/	where required .zips are downloaded prior to building (eg., Eclipse SDK, EMF SDK)
/home/www-data/build/emft/[subproject]/downloads/drops/	where [subproject] is built (all versions here, including any NLS zip, once available (if any))
/home/www-data/build/emft/[subproject]/downloads/drops/1.0.0/	where [subproject] v1.0.0 is built
/home/www-data/build/emft/[subproject]/downloads/drops/1.0.0/ [type][yyyymmddHHMM]/	a specific build's folder, including zips, test results, docs
/opt/ibm-java2-1.4 -> /opt/ibm-java2-ws-sdk-pj9xia32142-20050609	default build JDK / used for JUnit tests
/opt/sun-java2-1.4 -> /opt/j2sdk1.4.2_03	optional build JDK / used for EMF JDK tests
/opt/sun-java2-5.0 -> /opt/jdk1.5.0_03	optional build JDK / used for EMF JDK tests
/opt/ibm-java2-1.3 -> /opt/IBMJava2-131	used to test EMF 2.0.x ONLY
/opt/apache-ant-1.6.1 (or newer)	build & utility scripts
/usr/bin/php4 (4.1.2 or newer)	both Apache module and CLI (command line interface) modules required

Testing & Diagnosing Builds

To determine what's wrong with your build, make sure you're building in debug mode. eg., [4] or [5]. Then set the following parameters:

 Build Type: N (Nightly)
 Tag Build: No
 Run Tests: JUnit
 debug java home: /opt/ibm-java2-ws-sdk-pj9xia32142-20050609
 debug noclean: Y

Then, you can use the following shell commands:

# shortcut to builds folder
alias odd=' cd /home/www-data/build/emft/ocl/downloads/drops/1.0.0'

# shortcut to LATEST build folder
alias lastfolder='cd `find . -maxdepth 1 -type d -not -name \
  "." -exec date -r {} +%s\ {} \; | sort | tail -1 | \
  sed -e "s/[0-9]\+\ \.\///g"`'

alias oddl='odd; lastfolder'

# check build log
oddl; tail -60 buildlog.txt

# check JUnit test console log
oddl; cd testing/*/testing/; tail linux.gtk_consolelog.txt

# check JUnit test eclipse workspace error log
oddl; cd testing/*/testing/eclipse/workspace/.metadata/; less .log

Suppressing Compiler Warnings

After 3.2M6, PDE will now report compilation warnings in its JUnit test results page.

You can either fix your code to remove these warnings, or suppress the warnings themselves. See /org.eclipse.emft/releng/jet/buildAll.xml, for an example of how to suppress these warnings.

<echo message="Set compilerArgs = '-enableJavadoc -encoding ISO-8859-1 -warn:-serial'"/>
<property name="compilerArg" value="-enableJavadoc -encoding ISO-8859-1 -warn:-serial" />

For a complete list of supported warning flags in 3.1 - 3.3, go here: http://help.eclipse.org/help33/index.jsp?topic=/org.eclipse.jdt.doc.isv/guide/jdt_api_compile.htm (see Warning Options).

You can also bring up that same help page in Eclipse's built-in help (JDT Plug-in Developer Guide > Programmer's Guide > JDT Core > Compiling Java code) for the 3.2 version, which adds a couple other options to the list.

Heterogeneous Compiler Source/Target Levels

If your project has plug-ins that have different requirements for the compiler source and target compliance level, the PDE's build.properties file can be used to specify these on a plug-in by plug-in basis. For a plug-in that supports J2SE 1.4 and above, just add:

javacSource = 1.4
javacTarget = 1.4

in that plug-in's build.properties. For a plug-in that uses J2SE 5.0 language capabilities, just add:

javacSource = 1.5
javacTarget = 1.5

and similarly for 6.0, 7.0, ... For an example, see the validation.ocl plug-in, which differs from the other validation plug-ins in requiring J2SE 5.0.

You may already have an EMFT releng system that forces 1.4 source and target in the buildAll.xml file. Simply remove that and the javacSource=1.4 entries from the build.properties files in each builder/* folder. For example, see in the Query component's releng:

• before & after buildAll.xml
• before & after builder/sdk/build.properties.

Build Problems & Solutions

In no particular order, here are some lessons learned from setting up the various EMFT builds:

Error Message	Fix
eclipse/test.assembly/eclipse/ plugins/${org.eclipse.test} not found.	Add the "org.eclipse.test" and "org.eclipse.ant.optional.junit" plugins to each test feature. The task creates one property for each test plugin (the property name is the plugin name minus the version). Only plugins referenced by features are downloaded, and, if a plugin has to be downloaded, the map file has to describe how to do it. Thus this information must appear in two places: tests/customTargets.xml and *.tests-feature/feature.xml. Since "org.eclipse.test" is not listed on the tests feature, it is not being downloaded - regardless of it being listed in the map file. If you have added this to your mapfile and features, and you're still having problems, verify your mapfile has the right tag for org.eclipse.test. If you have checked all these conditions and still get an error, make sure your test feature specifies version="0.0.0" for the org.eclipse.test plugin so that PDE can calculate the version for you. This problem manifests with releng.basebuilder versions after M4_33, as discussed in bugs 190834 and 192231. Additionally, good hygiene suggests that all your features should have the correct builder/nature in their .project files. This will ensure that when you're manipulating your features in Eclipse, PDE will report problems (eg., typos) as they happen rather than during a build. <buildSpec> <buildCommand> <name>org.eclipse.pde.FeatureBuilder</name> <arguments/> </buildCommand> </buildSpec> <natures> <nature>org.eclipse.pde.FeatureNature</nature> </natures>
SomeBundleOrClass cannot be resolved (compilation failed).	Check your feature.xml files. PDE will build features in the order they're listed. See also bug 140745.
[exec] -cp org.eclipse.equinox.launcher.Main ... [exec] Unrecognized option: -ws [exec] Could not create the Java virtual machine.	Check relengbuildgtk.sh, and make sure the $cp or $cpAndMain variable is being set correctly. Also, make sure that if you're building with Eclipse 3.2 you use org.eclipse.core.launcher.Main instead of Eclipse 3.3's org.eclipse.equinox.launcher.Main. See also Running Eclipse and PDE JUnit Testing.
org.eclipse.emft.ocl.releng/ builder/sdk/customTargets.xml -> eclipse/assemble.org.eclipse.emf.ocl.sdk.xml -> eclipse/tmp/eclipse/plugins/ org.eclipse.emf.ocl.doc_1.0.0.200602231606 not found	This could be a number of problems, but the most likely is that org.eclipse.emft/ocl/doc/org.eclipse.emf.ocl.doc/build.xml needs to have the correct value for pluginVersion set or is missing this property entirely. <property name="pluginVersion" value="1.0.0"/> If that doesn't solve the problem, run a debug build with the -noclean flag checked to see what's in the eclipse/tmp/eclipse/plugins/ folder. For the case of the above build, the folder created was called org.eclipse.emf.ocl.doc_${pluginVersion}.200602231617 instead of org.eclipse.emf.ocl.doc_1.0.0.200602231617, since the property was not defined.
java.io.FileNotFoundException: testing/target/eclipse/ plugins/org.eclipse.emf.ocl.tests_1.0.0/ (Plugin is a jar, not a folder)	If your test plugin is compiled as a jar, not a folder, you need to fix your feature.xml. Remove the attribute unpack="false" from the org.eclipse.emf.*.tests plugin: <plugin id="org.eclipse.emf.ocl.tests" download-size="0" install-size="0" unpack="false" version="1.0.0"/>
java.io.FileNotFoundException: testing/target/eclipse/ plugins/org.eclipse.emf.ocl.tests_1.0.0/ test.xml (No such file or directory)	Add a "test.xml" script to each test plugin, in tests/org.eclipse.emf.*/test.xml. If this file already exists, verify in releng/ [subproject]/ builder/ tests/ scripts/ test.xml that target runtests knows whether your tests plugin is jarred or not. Comment/uncomment out test.xml script accordingly.
java.io.FileNotFoundException: eclipse/fetch_org.eclipse.emft.ocl.sdk.xml (No such file or directory)	Either the feature doesn't exist (and must be added), or the feature is misreferenced. Make sure that you do not have any scripts referring to, say, plugins or features called org.eclipse.emft.ocl.sdk, but rather org.eclipse.emf.ocl.sdk. The org.eclipse.emft namespace is only for the CVS module; everywhere else, you should use org.eclipse.emf when referencing plugins and features.
JUnits tests not appearing on testResults.php page	Add an entry for the missing tests into org.eclipse.emft/releng/[subproject]/ templateFiles/testManifest.xml.template and org.eclipse.emft/releng/[subproject]/ testManifest.xml, eg: <logFile name="org.eclipse.emf.query.ocl.tests_linux.gtk.xml"> <effectedFile id="SDK"></effectedFile> <effectedFile id="projRUN"></effectedFile> </logFile>
Failure to download and unzip one of the SDKs that your project depends on	You probably have a typo in the URL that you entered into the "New URLs" field. Try the following to get the correct URL every time: Surf to your dependency's downloads page on eclipse.org. Navigate to the build that you need. Click the download link for the all-encompassing SDK ZIP. When the "blah now downloading, if it doesn't start immediately, click here" message appears, right-click on the "click here" link and select "Copy Link Location" (or the equivalent action in your browser or choice). You now have in your cut buffer the exact link to the file that you need. Depending on your configuration, you may have an extra navigation to a mirror site in the above sequence.
Build is ok, everything compiles, but plugins are missing from the SDK!	Check the MANIFEST.MF for the plugins that aren't appearing. Ensure all properties files and MANIFEST.MF files have a trailing newline at the end of the file. Ensure all plugins are contained in some feature or other, and that those containing features are themselves contained in your SDK feature or other composite feature (like tests or examples). Eg., plugin org.eclipse.emf.cdo.utilities.migrator is included in org.eclipse.emf.cdo.utilities-feature/feature.xml, which is included in org.eclipse.emf.cdo-feature/org.eclipse.emf.cdo.sdk/feature.xml
Build is ok, everything compiles, but SDK includes BOTH unpacked source files and packed src.zip files.	Verify that you have included your branding plugin (eg., org.eclipse.net4j) in your branding feature (eg., org.eclipse.net4j-feature/feature.xml), even if it contains NO source and that you've set that plugin to be unpack="false": <plugin id="org.eclipse.net4j" download-size="0" install-size="0" version="0.0.0" unpack="false"/>
[185001] Plugin jars contain nested jars instead of class files.	See Bundle-ClassPath With Dot.
External jar files (like log4j) are not included in the plugin when building and zipping the plugins	Ensure that the Bundle-ClassPath in the MANIFEST.MF contains the dot (.) for example: Bundle-ClassPath: .,commons-logging.jar,log4j-1.2.8.jar
publish.xml fails to generate build artefacts!	This has been deprecated in the latest org.eclipse.releng.basebuilder. For the solution, see details in bug 165698.
Need to update your build to EMF 2.3 and J2SDK 5.0.	That's a pretty big subject. See EMF 2.3 Adoption for details.
java.lang.NoClassDefFoundError: org/eclipse/core/launcher/Main	You need to upgrade to the Equinox Launcher. See Automated PDE JUnit Testing With Eclipse for details on how to fix this problem.