Jump to: navigation, search

MemoryAnalyzer/Building MAT With Tycho

Introduction

This page describes how Memory Analyzer can be built using Maven/Tycho. The build will

  • build all bundles and features
  • execute all tests
  • (optional) run findbugs static checks
  • produce a p2 repository with MAT features
  • produce RCPs for different platforms

Prerequisites

SVN Team Provider Installation

To import MAT sources into the IDE one can use the SVN Team Provider. Have a look at the first several steps here: MemoryAnalyzer/Contributor_Reference#Setup

Maven Installation

The Memory Analyzer build requires a Maven 3.0.* installation. It is already present on the Hudson server at Eclipse. For local build one can download it from here http://maven.apache.org/download.html.

Proxy Settings

If you need to set proxy for Maven, a snippet like this can be added to the Maven settings file:

 <proxies>
   <proxy>
     <active>true</active>
     <protocol>http</protocol>
     <port>8080</port>
     <host>myproxy_host</host>
     <nonProxyHosts>non_proxy_hosts</nonProxyHosts>
   </proxy>
 </proxies>

More information on Maven settings: http://maven.apache.org/ref/3.0.3/maven-settings/settings.html

Checkout MAT Sources from SVN

If you want to use/edit MAT sources in the Eclipse IDE and build the same sources with Maven, then you need to take care that the directory structure is preserverd while importing the MAT projects using the SVN team provider. The following steps describe a way to do this:

  • Open the 'SVN Repository Exploring' perspective
  • Add the MAT Subversion repository at: https://dev.eclipse.org/svnroot/tools/org.eclipse.mat
  • Select 'trunk' and open the context menu
  • Select 'Find/Check Out As' from the context menu
  • Select 'Find projects in the children of the selected resource'
  • Select 'recursively'
  • Press 'Finish'
  • After some time, you'll get a window with the message: 'Following list contains projects that were automatically found on the repository. You can select project set you wish to be checked out into the workspace.'
  • Keep all projects selected
  • Select 'Check out as a projects into workspace'
  • Select 'Respect projects hierarchy'
  • Press 'Finish'

Preparation Steps

Which preparation steps are performed?

Parts of MAT depend on the IBM's DTFJ libraries, therefore one needs the libraries during the build. This preparation step will do the following:

  • download DTFJ (zipped "old" update site)
  • publish a p2 repository with DTFJ under <src_root>/prepare_build/target/repository

Execute the preparation step

  • Go in the <mat_src>/prepare_build/ directory
  • Execute
mvn clean install
  • This maven build is using the maven-antrun plugin to download the zip containing DTFJ. If you need to set proxy you can do it using the standard Java settings, i.e. the command line will look like this:
mvn -Dhttp.proxyHost=myProxyHost -Dhttp.proxyPort=myProxyPort clean install

On the Hudson boxes at Eclipse the settings are defined as $ANT_OPTS

Verify

If the build was successful, then:

  • <mat_src>/prepare_build/target/repository/ will contain the p2 repository with DTFJ
  • <mat_src>/org.eclipse.mat.targetdef/mat-site.target will be modified to point to this repository

Building MAT

Once the #Preparation Steps are done (normally only once) one can run the maven build for MAT.

Execute the build

  • Go to the root of the sources (there is the parent pom.xml), i.e. <mat_src>/pom.xml
  • To simply build MAT execute
mvn clean install
  • To build MAT and perform findbugs checks execut
mvn clean install findbugs:findbugs

Where to find the results?

You can find the results of the build in the corresponding .../target/ directories for each plugin, feature, etc... Of particular interest are:

  • <mat_src>/org.eclipse.mat.updatesite/target/site/ - it contains a p2 repository with MAT features
  • <mat_src>/product/target/products/ - it contains all standalone RCP applications

Further Information

  • The platforms for which RCPs are built are specified in the <mat_src>/pom.xml file
  • There are two script files (build.bat and build.sh) which should combine the preparation steps and the real build. However, both still need some improvements

Known Problems

Can't build RCPs for Mac

The problem is reported here: https://bugs.eclipse.org/bugs/show_bug.cgi?id=313997. Putting a patched o.e.equinox.p2.publisher.jar under <maven_repository>/org/sonatype/tycho/tycho-p2-runtime/0.11.0/eclipse/plugins/ helps for local build.

Wrong file permissions

When building MAT on a Windows box, the RCPs for any other OS will not have the proper permissions (e.g. the executables won't have the x flag). Building under Lunix or other non-Windows OS helps.

Hudson Job at Eclipse

The job at the Eclise Hudson server that performs this build is https://hudson.eclipse.org/hudson/job/tycho-mat-nightly/.

There are still a number of TODOs: