- 1 Setup your environment
- 2 Building and Testing
- 3 Debugging
- 4 Advanced Topics
Setup your environment
Using the Eclipse Installer (Oomph)
Step by step instructions:
- Download the Eclipse Installer.
- Start the installer using the eclipse-inst executable.
- On the first page (product selection), click the preference button in the top-right corner and select the Advanced Mode.
- If you are behind a proxy, at this point you might want to double check your network settings by clicking in the "Network Proxy Settings" at the bottom.
- Select Eclipse IDE for Eclipse Committers. Click Next.
- Under Eclipse.org, double-click on Tycho (single click is not enough!). Make sure that Tycho is shown in the table on the bottom. Click Next.
- You can edit the Installation Folder, but you do not have to select the Target Platform here, this will be set later automatically. By choosing Show all variables at the bottom of the page, you are able to change other values as well but you do not have to. Click Next.
- Press Finished on the Confirmation page will start the installation process.
- The installer will download the selected Eclipse version, starts Eclipse and will perform all the additional steps (cloning the git repos, etc...). When the downloaded Eclispe started, the progress bar in the status bar shows the progress of the overall setup.
- Once the Executing startup tasks job is finished you should have all the Tycho and Tycho Extras projects imported into 2 working sets called Tycho and Tycho Extras.
- Some Projects might sill have errors. Select them (or all) and choose Maven->Update Project.. from the context menu. De-select Clean projects in the shown dialog and press OK to update the projects. After that, no more error should be there.
Manually setup (Deprecated)
Prefered and easier way is to follow the instructions above, but you could also setup your environment manually:
- Get an Eclipse IDE with a recent version of the Maven integration for Eclipse (m2eclipse) and Eclipse PDE installed. m2eclipse is included in various Eclipse packages, e.g. the "Eclipse IDE for Eclipse Committers" package. To add m2eclipse to your existing Eclipse installation, install it from the release train p2 repository or from the m2eclipse update site.
- Install Maven version 3.0 or later
- If your Internet connection uses a proxy, make sure that you have the proxy configured in your Maven settings.xml
- Get the Tycho sources from eclipse.org; there are different ways to do this:
- In EGit, open the Git Repositories view, select Clone a Git Repository and clone from the location https://git.eclipse.org/r/tycho/org.eclipse.tycho for Tycho and https://git.eclipse.org/r/tycho/org.eclipse.tycho.extras for Tycho Extras.
- In a shell, execute git clone https://git.eclipse.org/r/tycho/org.eclipse.tycho for Tycho and git clone https://git.eclipse.org/r/tycho/org.eclipse.tycho.extras for Tycho Extras.
- In Eclipse, use File > Import > Existing Maven Projects, select the root directory of the sources, and import all projects. If prompted by m2eclipse, install the proposed project configurators and restart Eclipse.
- For Tycho only: Configure the target platform: Open the file tycho-bundles-target/tycho-bundles-target.target and click on Set as Target Platform in the upper right corner of the target definition editor.
The result should be an Eclipse workspace without build errors. m2eclipse may take some time to download required libraries from Maven central.
- If there are compile errors in the projects org.eclipse.tycho.surefire.junit, org.eclipse.tycho.surefire.junit4, org.eclipse.tycho.surefire.junit47, or org.eclipse.tycho.surefire.osgibooter, just select these projects and manually trigger an update via Maven > Update project... from the context menu.
- If there are compile errors in the project tycho-p2-director-plugin, right-click on the project and go to Build Path > Configure Build Path... and change the JRE System Library to JavaSE-1.7. Then revert the changes that the PDE does to the file tycho-p2-director-plugin/.settings/org.eclipse.jdt.core.prefs. (Background: The project optionally uses classes from the Java 7 library, so it needs to compile with a Java 7 JDK.)
Building and Testing
To build Tycho/Tycho Extras from source, executed mvn clean install in the source root. This also runs the unit tests.
Tycho integration tests
The Tycho integration tests are located in the project tycho-its. To run all Tycho integration tests, execute mvn clean install -f tycho-its/pom.xml. To run a single integration test, select the test class in Eclipse and run it as JUnit Test.
Background information on the Tycho integration tests
The integration tests trigger sample builds that use Tycho. These builds expect that Tycho has been installed to the local Maven repository. This is why you need to build Tycho through a mvn install before you can run the integration tests.
Alternatively, e.g. if you are only interested in modifying an integration test and do not want to patch Tycho itself, you can configure the integration tests to download the current Tycho snapshot produced by the Tycho CI builds. To do this, you need to edit the Maven settings stored in tycho-its/settings.xml and add the tycho-snapshots repository as described in Getting Tycho. (Advanced note: The integration tests can also be pointed to a different settings.xml with the system property tycho.testSettings.)
Tycho Extras integration tests
Each Tycho Extras project does have its own integration tests located in the subdirectory it within the project (e.g. tycho-eclipserun-plugin/src/it). To run the tests use the maven profile its, run mvn integration-test -Pits either within the Tycho Extras source folder to run all Tycho Extras integration tests or within a Tycho Extras plugin directory to run only the integration tests of that project.
Background information on the Tycho Extras integration tests
Tycho Extras and Tycho are developed and released in parallel and will use the snapshot version of Tycho from the repository https://repo.eclipse.org/content/repositories/tycho-snapshots/. If you want to run the tests with a specific version of Tycho use the tycho-version system property, e.g. mvn integration-test -Pits -Dtycho-version=0.22.0. To use a different Tycho snapshot repository use the system property tycho-snapshots-url, e.g. mvn integration-test -Pits -Dtycho-snapshots-url=file:/path/to/repo
In order to debug Tycho/Tycho Extras plugins inside Eclipse:
- Get the Tycho/Tycho Extras sources in Eclipse
- Create/get a project that highlights the bug
- Run the project with mvnDebug clean install
- Go into your Eclipse, use Debug > Remote Java Application, select port 8000
Writing Tycho integration tests
The hardest part for writing Tycho integration tests is the naming. While names are mostly important for readability, there were also cases where the ID "feature" was used multiple times and hence a test used the build result of a different integration test.
Therefore, here are a few tips for writing good integration tests:
- Test project name: Although many existing test have a bug number in the name, this is not the recommended naming scheme. Since integration test can take some time to execute, it may be a good idea to test related things in one test.
So name the test projects in a way that they can be found, and that related tests are sorted next to each other, e.g. in the form <component>.<aspect>.
- Package: Should be org.eclipse.tycho.test.<component> (without the aspect so that we don't get an excessive number of packages)
- Test project groupIds: Should be tycho-its-project.<component>.<aspect> plus a segment for the reactor in case of multi-reactor tests. The groupId is particularly important if the test project is installed to the local Maven repository. (Avoid install; use verify if possible.)
- Test project artifactIds: Have to be the same as the ID of the feature/bundle; need to start with something unique, e.g. the first letters of each segment of the project name.
Building Tycho against a locally built version of p2
Tycho makes heavy use of p2 functionality. Therefore it may be useful to try out patches to p2 without waiting for a new p2 release, or even just the next nightly build. With the following steps it is possible to build Tycho against a locally built version of p2.
- Get the p2 sources (see p2 project information)
- Make changes in the p2 sources
- Build the changed p2 bundles individually with mvn clean install -Pbuild-individual-bundles (see Equinox/p2/Build for more information)
- Build at least the Tycho module tycho-bundles-external with mvn clean install - you should see a warning that the locally built p2 bundles have been used.
Then the locally built Tycho SNAPSHOT includes the patched p2 version.
Note: Tycho always allows references to locally built artifacts, even if they are not part of the target platform. Therefore you may want to clear the list of locally built artifacts (in the local Maven repository in .meta/p2-local-metadata.properties) after you have finished your trials with the patched p2 version.
Updating the Equinox and JDT dependencies of Tycho
Tycho has Maven dependencies to Equinox and JDT, so these artifact need to be available in a Maven repository. Currently, the authors don't provide these artifacts in Maven central, so we deploy them ourselves (with the groupId org.eclipse.tycho). See tycho-releng/pom.xml for the technical details on how this is done.
If we want to use a new version of these dependencies in a Tycho snapshot, we can also deploy snapshot versions of these dependencies alongside with the Tycho snapshots. This is how this is done:
- Update the p2 repository in tycho-releng/pom.xml
- Update the versions in the parent POM so that they match the versions available in the p2 repository. Add the -SNAPSHOT suffix to the Maven version properties.
- Commit and upload the change to Gerrit. The Gerrit build will fail with a dependency resolution error.
- Trigger the job tycho-deploy-dependencies and make it build the proposed change
- Re-trigger the voter job for the Gerrit change. The build should now pass.