Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "MemoryAnalyzer/Building MAT With Tycho"

m (Proxy Settings)
(24 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
== Introduction ==
 
== Introduction ==
  
This page is describes how Memory Analyzer p2 repository and RCP applications can be built using Maven/Tycho.
+
This page describes how Memory Analyzer can be built using Maven/Tycho. The build will
The job at the Eclise Hudson server that performs this build is https://hudson.eclipse.org/hudson/job/tycho-mat-nightly/  
+
* build all bundles and features
 +
* execute all tests
 +
* (optional) run [http://findbugs.sourceforge.net/ FindBugs] static checks
 +
* produce a p2 repository with MAT features
 +
* produce RCPs for different platforms
 +
* sign and upload the produced artifacts (when executed on the Eclipse Hudson server)
  
 
== Prerequisites ==
 
== 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 ===
 
=== 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.
+
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 [http://maven.apache.org/download.html here].
 +
 
 +
=== SWTBot ===
 +
To build the org.eclipse.mat.ui.rcp.tests project, you will need the [[SWTBot#Update_Sites|SWTBot plugins]] installed. Normally, just add an update site http://download.eclipse.org/technology/swtbot/releases/latest/ and install all the plugins. See the previous link for more installation instructions.
  
 
=== Proxy Settings ===
 
=== Proxy Settings ===
If you need to set proxy for Maven, a snippet like this can be added to the Maven settings file:
+
If you need to set a proxy for Maven, a snippet like this can be added to the Maven settings file:
 +
<source lang="xml">
 
   <proxies>
 
   <proxies>
 
     <proxy>
 
     <proxy>
Line 20: Line 32:
 
     </proxy>
 
     </proxy>
 
   </proxies>
 
   </proxies>
 
+
</source>
 
More information on Maven settings: http://maven.apache.org/ref/3.0.3/maven-settings/settings.html
 
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 ==
 
== Preparation Steps ==
=== What is done ===
+
=== Which preparation steps are performed? ===
 
Parts of MAT depend on the IBM's DTFJ libraries, therefore one needs the libraries during the build.  
 
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:
 
This preparation step will do the following:
 
* download DTFJ (zipped "old" update site)
 
* download DTFJ (zipped "old" update site)
* publish a p2 repository with DTFJ
+
* publish a p2 repository with DTFJ under <src_root>/prepare_build/target/repository
* modify the target platform definition used for the rest of the build
+
  
=== Execution ===
+
=== Execute the preparation step ===
 
* Go in the ''<mat_src>/prepare_build/'' directory
 
* Go in the ''<mat_src>/prepare_build/'' directory
 
* Execute
 
* Execute
 
<pre>mvn clean install</pre>
 
<pre>mvn clean install</pre>
* 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:
+
* This maven build is using the maven-antrun plugin to download the zip containing DTFJ. If you need to set a proxy you can do it using the standard Java settings, i.e. the command line will look like this:
<pre>mvn -Dhttp.proxyHost=myProxyHost -Dhttp.proxyPort=myProxyPort clean install</pre>
+
<pre>mvn -DproxyHost=myProxyHost -DproxyPort=myProxyPort clean install</pre>
  
 
On the Hudson boxes at Eclipse the settings are defined as $ANT_OPTS
 
On the Hudson boxes at Eclipse the settings are defined as $ANT_OPTS
Line 43: Line 70:
 
If the build was successful, then:
 
If the build was successful, then:
 
* ''<mat_src>/prepare_build/target/repository/'' will contain the p2 repository with DTFJ
 
* ''<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 ==
 
== Building MAT ==
Line 49: Line 75:
  
 
=== Execute the build ===
 
=== Execute the build ===
* Go to the root of the sources (there is the parent pom.xml), i.e. ''<mat_src>/pom.xml''
+
* Open a console and go into the ''<mat_src>/parent'' folder (there is the parent pom.xml)
* To simply build MAT execute
+
* To build MAT execute
 
<pre>mvn clean install</pre>
 
<pre>mvn clean install</pre>
* To build MAT and perform findbugs checks execut
+
* To build MAT and perform FindBugs checks execute
 
<pre>mvn clean install findbugs:findbugs</pre>
 
<pre>mvn clean install findbugs:findbugs</pre>
=== Results ===
+
 
 +
=== 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:
 
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>/org.eclipse.mat.updatesite/target/site/'' - it contains a p2 repository with MAT features
* ''<mat_src>/product/target/products/'' - it contains all standalong RCP applications
+
* ''<mat_src>/org.eclipse.mat.product/target/products/'' - it contains all standalone RCP applications
 +
 
 +
== Further Information ==
 +
* The platforms for which RCPs are built are specified in the ''<mat_src>/parent/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 ==
 +
=== 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 Linux 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/.
 +
 
 +
The job is configured to sign the plugins and features in the update site, and to upload all artifacts to the download server.
 +
One can download such nightly/snapshot builds here: http://www.eclipse.org/mat/snapshotBuilds.php
 +
 
 +
Info: Signing is activated by the build-server profile (i.e. with parameter '-P build-server' added to the maven command)
 +
 
 +
[[Category:Memory Analyzer]]

Revision as of 06:10, 7 June 2013

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
  • sign and upload the produced artifacts (when executed on the Eclipse Hudson server)

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.

SWTBot

To build the org.eclipse.mat.ui.rcp.tests project, you will need the SWTBot plugins installed. Normally, just add an update site http://download.eclipse.org/technology/swtbot/releases/latest/ and install all the plugins. See the previous link for more installation instructions.

Proxy Settings

If you need to set a 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 a proxy you can do it using the standard Java settings, i.e. the command line will look like this:
mvn -DproxyHost=myProxyHost -DproxyPort=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

Building MAT

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

Execute the build

  • Open a console and go into the <mat_src>/parent folder (there is the parent pom.xml)
  • To build MAT execute
mvn clean install
  • To build MAT and perform FindBugs checks execute
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>/org.eclipse.mat.product/target/products/ - it contains all standalone RCP applications

Further Information

  • The platforms for which RCPs are built are specified in the <mat_src>/parent/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

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 Linux 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/.

The job is configured to sign the plugins and features in the update site, and to upload all artifacts to the download server. One can download such nightly/snapshot builds here: http://www.eclipse.org/mat/snapshotBuilds.php

Info: Signing is activated by the build-server profile (i.e. with parameter '-P build-server' added to the maven command)

Copyright © Eclipse Foundation, Inc. All Rights Reserved.