Difference between revisions of "Common Build Infrastructure/Getting Started/FAQ"

Revision as of 20:56, 3 August 2009

What files do I need to run an Athena build?

In some folder, traditionally called org.eclipse.myproject/releng or org.eclipse.myproject.releng (but really, it can be anything), you need these files:

maps/*.map -- what to build (where to get sources) : can be CVS, SVN, or HTTP (eg., Orbit jars)

build.properties -- how to build

testing.properties -- what tests to run

build.xml -- boilerplate script for running the build in Eclipse, via commandline, or in Hudson

I also recommend having a .launch file which produces a log of your in-Eclipse build attempts so that when that log scrolls off the Console view, you can see what happened in the file.

And, if you want to make it easier for others to get your source, you can include psfs/*.psf files. Better, use build.steps=map2psf in your build.properties to generate .psfs from your map files.

My build complains it can't find java.lang.Object. Seriously, WTF?

Make sure you've set JAVA_HOME to a valid path, as well as these for every Bundle-RequiredExecutionEnvironment ("BREE") defined in your plugins' MAANIFEST.MF files. If all your code is set to BREE 1.4, you only need a JAVA14_HOME; if you have a mix, include all that you use, such as JAVA50_HOME or JAVA60_HOME.

Here are the default values for these server.properties:

JAVA60_HOME=/opt/public/common/ibm-java-jdk-ppc-60
JAVA50_64_HOME=/opt/public/common/ibm-java2-ppc64-50
JAVA50_HOME=/opt/public/common/ibm-java2-ppc-50
JAVA14_HOME=/opt/public/common/ibm-java2-142
JAVA_HOME=${JAVA50_HOME}

JavaSE-1.6=${JAVA60_HOME}/jre/lib/rt.jar:${JAVA60_HOME}/jre/lib/annotation.jar:${JAVA60_HOME}/jre/lib/beans.jar:${JAVA60_HOME}/jre/lib/ibmorbapi.jar:${JAVA60_HOME}/jre/lib/java.util.jar:${JAVA60_HOME}/jre/lib/jlm.jar:${JAVA60_HOME}/jre/lib/logging.jar:${JAVA60_HOME}/jre/lib/resources.jar:${JAVA60_HOME}/jre/lib/rt.jar:${JAVA60_HOME}/jre/lib/security.jar:${JAVA60_HOME}/jre/lib/sql.jar:${JAVA60_HOME}/jre/lib/vm.jar:${JAVA60_HOME}/jre/lib/xmldsigfw.jar:${JAVA60_HOME}/jre/lib/xml.jar:${JAVA60_HOME}/jre/lib/jsse.jar:${JAVA60_HOME}/lib/dt.jar:${JAVA60_HOME}/../Classes/dt.jar:${JAVA60_HOME}/../Classes/classes.jar:${JAVA60_HOME}/../Classes/jsse.jar
J2SE-1.5=${JAVA50_HOME}/jre/lib/rt.jar:${JAVA50_HOME}/jre/lib/vm.jar:${JAVA50_HOME}/jre/lib/core.jar:${JAVA50_HOME}/jre/lib/xml.jar:${JAVA50_HOME}/jre/lib/graphics.jar:${JAVA50_HOME}/jre/lib/server.jar:${JAVA50_HOME}/jre/lib/ibmorbapi.jar:${JAVA50_HOME}/jre/lib/security.jar:${JAVA50_HOME}/jre/lib/classes.jar:${JAVA50_HOME}/jre/lib/jsse.jar:${JAVA50_HOME}/../Classes/dt.jar:${JAVA50_HOME}/../Classes/classes.jar:${JAVA50_HOME}/../Classes/jsse.jar
J2SE-1.4=${JAVA14_HOME}/lib/rt.jar:${JAVA14_HOME}/jre/lib/rt.jar:${JAVA14_HOME}/jre/lib/core.jar:${JAVA14_HOME}/jre/lib/xml.jar:${JAVA14_HOME}/jre/lib/graphics.jar:${JAVA14_HOME}/jre/lib/server.jar:${JAVA14_HOME}/jre/lib/ibmorbapi.jar:${JAVA14_HOME}/jre/lib/security.jar:${JAVA14_HOME}/jre/lib/classes.jar:${JAVA14_HOME}/jre/lib/jsse.jar:${JAVA14_HOME}/../Classes/dt.jar:${JAVA14_HOME}/../Classes/classes.jar:${JAVA14_HOME}/../Classes/jsse.jar

What are buildExtra.xml and testExtra.xml for?

These are optional.

If you have custom runtime requirements which cannot be configured using dependencyURLs or repositoryURLs in your build.properties, you can define additional fetching/unpacking steps here, for building or testing respectively.

If you have custom packaging steps (ie., you ship more than the default set of zips) you can also add packaging steps here.

${org.eclipse.test} not found?

1. Include "org.eclipse.test" and "org.eclipse.ant.optional.junit" plugins in your all-in-one tests feature (or to each test feature). This controls what plugins PDE will build.

<plugin
  id="org.eclipse.test"
  download-size="0" install-size="0" version="0.0.0"/>
 
<plugin
  id="org.eclipse.ant.optional.junit"
  download-size="0" install-size="0" version="0.0.0" fragment="true"/>

2. Add these plugins to your map file (or create a new map file). This controls where PDE will find the Eclipse Test Framework (ETF) sources.

plugin@org.eclipse.test=v20080313,:pserver:anonymous@dev.eclipse.org:/cvsroot/eclipse,
fragment@org.eclipse.ant.optional.junit=v20070202,:pserver:anonymous@dev.eclipse.org:/cvsroot/eclipse,

Do I still need a test.xml in each of my test plugins?

No. In fact, having one there may cause some of your tests to fail. Omit this file and one will be generated for you from this template.

What information do I need to provide to get a new job added to Hudson?

To get added to Hudson, see Build In Hudson.