Skip to main content
Jump to: navigation, search

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

(Prerequisites)
m (Install and Configure Maven)
 
(18 intermediate revisions by 2 users not shown)
Line 2: Line 2:
  
 
This page describes how Memory Analyzer can be built using Maven/Tycho. The build will
 
This page describes how Memory Analyzer can be built using Maven/Tycho. The build will
* build all bundles and features
+
* build all MAT bundles
 
* execute all tests
 
* execute all tests
 
* (optional) run [http://findbugs.sourceforge.net/ FindBugs] static checks
 
* (optional) run [http://findbugs.sourceforge.net/ FindBugs] static checks
* produce a p2 repository with MAT features
+
* build eclipse features containing the MAT plugins and produce an update site (p2 repository) with them
* produce RCPs for different platforms
+
* produce standalone (Eclipse RCP based) products for different OS platforms
* sign and upload the produced artifacts (when executed on the Eclipse Hudson server)
+
* sign and upload the produced artifacts (when executed on the Eclipse Jenkins server)
  
 
== Prerequisites ==
 
== Prerequisites ==
  
=== Git ===
+
=== Clone the Source Code from Git ===
MAT sources are in a Git repository, therefore you need a git client. Have a look at [[MemoryAnalyzer/Contributor_Reference#Get the Source]]
+
MAT sources are in a Git repository, therefore you need a git client. Have a look at [[MemoryAnalyzer/Contributor_Reference#Get the source]]
  
=== Maven Installation ===
+
=== Use Java 1.8 for the Build ===
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].
+
The MAT build has to be run with Java 1.8. Make sure the JAVA_HOME environment variable is set to point to a JDK 1.8 installation.
 +
 
 +
=== Install and Configure Maven ===
 +
The Memory Analyzer build requires a Maven 3.0.* installation. It is already present on the Jenkins server at Eclipse. For local build one can download it from [http://maven.apache.org/download.html here].
  
=== Proxy Settings ===
 
 
If you need to set a 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">
 
<source lang="xml">
Line 32: Line 34:
 
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 ==
+
== Building MAT from Sources ==
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'
+
 
+
== Building MAT ==
+
  
 
=== Execute the build ===
 
=== Execute the build ===
* Open a console and go into the ''<mat_src>/parent'' folder (there is the parent pom.xml)
+
* Open a console and go into the ''<mat_src>/parent'' folder (it contains the parent pom.xml)
* To build MAT execute
+
* To build MAT with the default profile (build-snapshot) simply execute
 
<pre>mvn clean install</pre>
 
<pre>mvn clean install</pre>
* To build MAT and perform FindBugs checks execute
+
* This will cause a fresh build of all bundles, execute tests, build eclipse features, an update site (p2 repository) and standalone products
 +
* If you want to also FindBugs checks are performed as part of the build, then execute
 
<pre>mvn clean install findbugs:findbugs</pre>
 
<pre>mvn clean install findbugs:findbugs</pre>
  
Line 61: Line 48:
 
* ''<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>/org.eclipse.mat.product/target/products/'' - it contains all standalone RCP applications
 
* ''<mat_src>/org.eclipse.mat.product/target/products/'' - it contains all standalone RCP applications
 +
 +
== Building MAT Standalone RCPs from an Existing MAT Update Site ==
 +
 +
=== Configure and execute the build ===
 +
* Open a console and go into the ''<mat_src>/parent'' folder (it contains the parent pom.xml)
 +
* To produce only the standalone products, using an already existing MAT repository (i.e. without building the bundles again) specify that the ''build-release-rcp'' profile is used when you start maven:
 +
<pre>mvn clean install -P build-release-rcp</pre>
 +
* It will take the already existing MAT plugins/features from the repository specified by the ''mat-release-repo-url'' property in ''<mat_src>/parent/pom.xml''. One can overwrite this location when calling maven. For example, to build products with the older 1.5.0 release, use:
 +
<pre>mvn clean install -P build-release-rcp -Dmat-release-repo-url=http://download.eclipse.org/mat/1.5/update-site/</pre>
 +
 +
=== Where to find the results? ===
 +
You can find the standalone products under ''<mat_src>/org.eclipse.mat.product/target/products/''
  
 
== Further Information ==
 
== Further Information ==
 
* The platforms for which RCPs are built are specified in the ''<mat_src>/parent/pom.xml'' file
 
* 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 ==
 
== Known Problems ==
Line 70: Line 68:
 
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.
 
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 ==
+
== Jenkins 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 Jenkins continuous integration instance of the Memory Analyzer Project at the Eclipse is https://ci.eclipse.org/mat/.
  
The job is configured to sign the plugins and features in the update site, and to upload all artifacts to the download server.
+
=== Snapshot / Nightly builds ===
 +
The [https://ci.eclipse.org/mat/job/tycho-mat-nightly/ ''tycho-mat-nightly''] job checks regularly for changes to the Git repository and produces a snapshot build (see Building MAT from Sources) above. [2018,2019: Currently the automatic detection of changes is not working so it is necessary to trigger a manual build.]
 +
 
 +
The job is additionally 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
 
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)
 
Info: Signing is activated by the build-server profile (i.e. with parameter '-P build-server' added to the maven command)
 +
 +
=== Release Builds ===
 +
The job ''mat-standalone-packages'' can only be triggered manually to build the MAT standalone packages/products using an already existing MAT update site. This can be used in the following scenario - MAT has contributed its bundles and features to the simultaneous Eclipse release as part of a milestone or a release candidate. After the simultaneous release is complete, we would like to have exactly these bundles also packed in the standalone packages, potentially including also the final version of the dependencies (part of the same simultaneous release).
 +
 +
The job is configured to use the ''build-release-rcp'' profile when calling maven.
  
 
[[Category:Memory Analyzer]]
 
[[Category:Memory Analyzer]]

Latest revision as of 02:33, 6 September 2019

Introduction

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

  • build all MAT bundles
  • execute all tests
  • (optional) run FindBugs static checks
  • build eclipse features containing the MAT plugins and produce an update site (p2 repository) with them
  • produce standalone (Eclipse RCP based) products for different OS platforms
  • sign and upload the produced artifacts (when executed on the Eclipse Jenkins server)

Prerequisites

Clone the Source Code from Git

MAT sources are in a Git repository, therefore you need a git client. Have a look at MemoryAnalyzer/Contributor_Reference#Get the source

Use Java 1.8 for the Build

The MAT build has to be run with Java 1.8. Make sure the JAVA_HOME environment variable is set to point to a JDK 1.8 installation.

Install and Configure Maven

The Memory Analyzer build requires a Maven 3.0.* installation. It is already present on the Jenkins server at Eclipse. For local build one can download it from here.

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

Building MAT from Sources

Execute the build

  • Open a console and go into the <mat_src>/parent folder (it contains the parent pom.xml)
  • To build MAT with the default profile (build-snapshot) simply execute
mvn clean install
  • This will cause a fresh build of all bundles, execute tests, build eclipse features, an update site (p2 repository) and standalone products
  • If you want to also FindBugs checks are performed as part of the build, then 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

Building MAT Standalone RCPs from an Existing MAT Update Site

Configure and execute the build

  • Open a console and go into the <mat_src>/parent folder (it contains the parent pom.xml)
  • To produce only the standalone products, using an already existing MAT repository (i.e. without building the bundles again) specify that the build-release-rcp profile is used when you start maven:
mvn clean install -P build-release-rcp
  • It will take the already existing MAT plugins/features from the repository specified by the mat-release-repo-url property in <mat_src>/parent/pom.xml. One can overwrite this location when calling maven. For example, to build products with the older 1.5.0 release, use:
mvn clean install -P build-release-rcp -Dmat-release-repo-url=http://download.eclipse.org/mat/1.5/update-site/

Where to find the results?

You can find the standalone products under <mat_src>/org.eclipse.mat.product/target/products/

Further Information

  • The platforms for which RCPs are built are specified in the <mat_src>/parent/pom.xml file

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.

Jenkins Job at Eclipse

The Jenkins continuous integration instance of the Memory Analyzer Project at the Eclipse is https://ci.eclipse.org/mat/.

Snapshot / Nightly builds

The tycho-mat-nightly job checks regularly for changes to the Git repository and produces a snapshot build (see Building MAT from Sources) above. [2018,2019: Currently the automatic detection of changes is not working so it is necessary to trigger a manual build.]

The job is additionally 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)

Release Builds

The job mat-standalone-packages can only be triggered manually to build the MAT standalone packages/products using an already existing MAT update site. This can be used in the following scenario - MAT has contributed its bundles and features to the simultaneous Eclipse release as part of a milestone or a release candidate. After the simultaneous release is complete, we would like to have exactly these bundles also packed in the standalone packages, potentially including also the final version of the dependencies (part of the same simultaneous release).

The job is configured to use the build-release-rcp profile when calling maven.

Back to the top