[jboss-dev-forums] [JBoss Tools Development] - How to Build JBoss Tools 4.0 with Maven 3

Wednesday, 13 March 2013

Mickael Istria [https://community.jboss.org/people/mickael_istria] modified the document:

"How to Build JBoss Tools 4.0 with Maven 3"

To view the document, visit: https://community.jboss.org/docs/DOC-47936

--------------------------------------------------------------
** 
 #Environment_Setup Environment Setup

*** 
 #Prerequisistes Prerequisistes

*** 
 #Maven_and_Java Maven and Java

*** 
 #Maven_settings Maven settings

*** 
 #Maven__Java_Memory_Configuration Maven & Java Memory Configuration

** 
 #Verify_or_Install Verify or Install?

** 
 #About_Target_Platform_and_related_profiles About Target Platform and related profiles

*** 
 #Using_published_Target_Platform_definition_Recommended Using published Target Platform
definition (Recommended)

*** 
 #Or_getting_a_local_copy_of_the_Target_Platform Or, getting a local copy of the Target
Platform

**** 
 #Get_it Get it

***** 
 #_Download_TP_as_a_zip_and_install_it_by_yourself  Download TP as a zip and install it by
yourself

***** 
 #OR_use_Maven_to_build_it OR, use Maven to build it

**** 
 #Use_it_as_a_Maven_mirror Use it as a Maven mirror

** 
 #Optional_Build_parent_and_target_platform (Optional) Build parent and target platform

** 
 #Building_Individual_Components_Locally_Via_Commandline Building Individual Components
Locally Via Commandline

*** 

#Build_a_component_resolving_to_a_recent_aggregation_build_for_other_JBT_dependencies_Recommanded
Build a component resolving to a recent aggregation build for other JBT dependencies
(Recommanded)

*** 
 #Build_a_component_resolving_to_the_latest_CI_builds_for_other_JBT_dependencies Build a
component resolving to the latest CI builds for other JBT dependencies

*** 
 #Build_a_component_along_with_all_its_dependencies_from_sources_bootstrap_build Build a
component along with all its dependencies from sources ("bootstrap" build)

** 
 #Building_Everything_In_One_Build_Locally_Via_Commandline Building Everything In One
Build Locally Via Commandline

** 
 #Building_Locally_In_Eclipse Building Locally In Eclipse

** 
 #Installation_Testing__making_sure_your_stuff_can_be_installed_ Installation Testing -
making sure your stuff can be installed 

** 
 #Adding_a_new_feature_or_plugin_to_an_existing_component Adding a new feature or plugin
to an existing component

** 
 #Dealing_with_timeouts_for_tests Dealing with timeouts for tests

** 
 #Tips_and_tricks_for_making_BOTH_PDE_UI_and_headless_Maven_builds_happy Tips and tricks
for making BOTH PDE UI and headless Maven builds happy

*** 
 #Check_your_buildproperties Check your build.properties

*** 
 #Check_your_manifestmf_dependencies Check your manifest.mf dependencies

*This article is a replacement for its precursor, 
https://community.jboss.org/docs/DOC-16604 How to Build JBoss Tools 3.3 with Maven 3.* 

*Note that this article only discusses building from trunk. To work with another branch,
see  http://learn.github.com/p/branching.html Learn.GitHub - Branching and Merging.*

*Looking for how to build our documentation? See 
https://community.jboss.org/docs/DOC-13341 Building JBoss Tools Documentation.*

h2. Environment Setup
h3. Prerequisistes
1. Java 1.6 SDK
2. Maven 3.0.3
3. About 6 GB of free disk space if you want to run all integration tests for (JBoss AS,
Seam and Web Services Tools) - *requires VPN access*
4. subversion client 1.6.X  (should work with lower version as well, but newer versions
may not work as expected)
h3. Maven and Java
Make sure your maven 3 is available by default and Java 1.6 is used.

 mvn -version

should  print out something like

*Apache Maven 3.0.3* (r1075438; 2011-02-28 12:31:09-0500)
*Java version: 1.6.0_25*, vendor: Sun Microsystems Inc.
*Java home: /usr/java/jdk1.6.0_25/jre*
Default locale: en_US, platform encoding: UTF-8
OS name: "linux", version: "2.6.42.3-2.fc15.x86_64", arch:
"amd64", family: "unix"

h3. Maven settings
Follow https://community.jboss.org/docs/DOC-15170  these instructions to add reference to
JBoss Repositories into your settings.xml. You'll also probably need access to the
SNAPSHOT repository. So here is what you should see in your ~/.m2/settings.xml

<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
http://maven.apache.org/xsd/settings-1.0.0.xsd">
   ....
    <profiles>
        ....
        <profile>
            <id>jboss-default</id>
            <repositories>
                
                <repository>
                    <id>jboss-public-repository-group</id>
                    <name>JBoss Public Repository Group</name>

<url>http://repository.jboss.org/nexus/content/groups/public/</url>
                </repository>
                <repository>
                    <id>jboss-snapshots-repository</id>
                    <name>JBoss Snapshots Repository</name>

<url>https://repository.jboss.org/nexus/content/repositories/snapshots/...
                </repository>
            </repositories>

            <pluginRepositories>
                        <!-- To resolve parent artifact -->
                        <pluginRepository>
                                <id>jboss-public-repository-group</id>
                                <name>JBoss Public Repository Group</name>

<url>http://repository.jboss.org/nexus/content/groups/public/</url>
                        </pluginRepository>
                        <pluginRepository>
                                <id>jboss-snapshots-repository</id>
                                <name>JBoss Snapshots Repository</name>

<url>https://repository.jboss.org/nexus/content/repositories/snapshots/...
                        </pluginRepository>
                </pluginRepositories>
        </profile>
    </profiles>

    <activeProfiles>
        <activeProfile>jboss-default</activeProfile>
        ...
    </activeProfiles>
</settings>

#

h3. Maven & Java Memory Configuration

To configure the amount of memory used by Maven, you can define MVN_OPTS as follows,
either in the mvn / mvn.bat script you use to run Maven, or set as global environment
variables. Here's how to do so for 
http://forums.fedoraforum.org/showthread.php?t=262465 Fedora, 
https://help.ubuntu.com/community/EnvironmentVariables Ubuntu, 
http://forums.techarena.in/windows-xp-support/1152405.htm Windows, 
http://www.digitaledgesw.com/node/31 OSX.

{code}
set MAVEN_OPTS=-Xms512m -Xmx1024m -XX:PermSize=128m -XX:MaxPermSize=256m
{code}

h2. Verify or Install?
mvn verify will perform all build and test steps, but it won't install the bundles in
your local repository. mvn install does install in you local repository. When an
eclipse-plugin is installed in your repo, it is always used as default when resolving
dependency. It is not possible to roll-back a local installation of a bundle, so in most
cases, mvn verify is to be prefered to mvn install. However, if you want to build stuff
sequentially through several maven invocations, and you want to resolve against just-built
stuff, you'll need to use mvn install.
In this page, we'll encourage people to use *mvn verify* as much as possible to ensure
*isolation*; but you can mvn install the same way if your use-case requires it.

+*What if I've already built something locally, but I want to build against the server
version instead of my local repo?*+

There are  http://wiki.eclipse.org/Tycho/Target_Platform#Locally_built_artifacts two
approaches that work here:

a) override temporarily when building, using -Dtycho.localArtifacts=ignore

b) delete ~/.m2/repository/.meta/p2-local-metadata.properties

h2. About Target Platform and related profiles
The target platform (TP) lists all dependencies (coming from Eclipse.or and other
3rd-party update sites) that are used by JBoss Tools. This target platform is materialized
as an Eclipse p2 repository (formerly update-site) that is used during build to resolve
dependencies. Target Platform is managed by JBoss Tools people, and only dependencies from
this TP are allowed to be used in code.
If you need a new dependency in the TP, feel free to 
https://issues.jboss.org/secure/CreateIssueDetails!init.jspa?pid=10020&am...
open a ticket to request it.

Here are several ways to build locally using this target platform. It's up to you to
choose the one that match your needs:
h3. Using published Target Platform definition (Recommended)
unified.target refers to the dependency as published in the Target Platform repository. 
* Pros:* No additional thing to do than invoking Maven
* Always up-to-date

* Cons: Speed - (to evaluate)
Consume it by adding *-Punified.target* to you Maven invocation command-line
h3. Or, getting a local copy of the Target Platform
* Pros: Speed +++
* Cons: Step to be repeated whenever 
https://github.com/jbosstools/jbosstools-build/tree/master/target-platforms target
platforms change
h4. Get it
h5.  Download TP as a zip and install it by yourself

You can either download the TP as a zip and unpack it into some folder on your disk. Just
remember to update your  #settings.xml settings.xml file to point at the location where
you unpacked it.

You can get it with a browser or a command line tool such as wget or curl at the following
url: 

 http://download.jboss.org/jbosstools/updates/juno/SR0c/
http://download.jboss.org/jbosstools/updates/juno/SR0c/
http://download.jboss.org/jbosstools/updates/juno/SR0c/e420-wtp340.target...
e420-wtp340.target.zip (current minimum TP)
 http://download.jboss.org/jbosstools/updates/juno/SR1a/
http://download.jboss.org/jbosstools/updates/juno/SR1a/
http://download.jboss.org/jbosstools/updates/juno/SR1a/e421-wtp341.target...
e421-wtp341.target.zip (current maximum TP)

and then unzip it :

unzip *.target.zip -d
/path/to/jbosstools-build/target-platforms/jbosstools-JunoSR0c/multiple/target/multiple.target.repo/
  or
unzip *.target.zip -d
/path/to/jbosstools-build/target-platforms/jbosstools-JunoSR1a/multiple/target/multiple.target.repo/

h5. OR, use Maven to build it
See  #maven-nexus-resolution-problems Building Parent Pom & Target Platforms Locally
 #maven-nexus-resolution-problems  #
h4. Use it as a Maven mirror
Once you get the target platform available locally, you can use it instead of the remote
sites to save time. For this, we can simply use Tycho target-platform mirroring: 
http://wiki.eclipse.org/Tycho/Target_Platform/Authentication_and_Mirrors#...
http://wiki.eclipse.org/Tycho/Target_Platform/Authentication_and_Mirrors#...
As example, you can simply edit to your ~/.m2/settings.xml the definition of the
repositories to mirror: (replace /home/hudson/static_build_env/jbds/.... by a path where
your local repository actuaaly stands)

<settings>
     <mirrors>

        <mirror>
            <id>jenkins.jbosstools-JunoSR0c</id>

<mirrorOf>http://download.jboss.org/jbosstools/updates/juno/SR0c/REPO&l...

<url>file:///home/hudson/static_build_env/jbds/target-platform_4.0.juno.SR0c/e420-wtp340.target/</url>
            <layout>p2</layout>
            <mirrorOfLayouts>p2</mirrorOfLayouts>
        </mirror>
        <mirror>
            <id>jenkins.jbosstools-JunoSR1a</id>

<mirrorOf>http://download.jboss.org/jbosstools/updates/juno/SR1a/REPO&l...

<url>file:///home/hudson/static_build_env/jbds/target-platform_4.0.juno.SR1a/e421-wtp341.target/</url>
            <layout>p2</layout>
            <mirrorOfLayouts>p2</mirrorOfLayouts>
        </mirror>
        <mirror>
            <id>jenkins.jbdevstudio-JunoSR0c</id>

<mirrorOf>http://www.qa.jboss.com/binaries/RHDS/updates/jbds-target-pla...

<url>file:///home/hudson/static_build_env/jbds/jbds-target-platform_4.0.juno.SR0c/jbds600-e420-wtp340.target/</url>
            <layout>p2</layout>
            <mirrorOfLayouts>p2</mirrorOfLayouts>
        </mirror>
        <mirror>
            <id>jenkins.jbdevstudio-JunoSR1a</id>

<mirrorOf>http://www.qa.jboss.com/binaries/RHDS/updates/jbds-target-pla...

<url>file:///home/hudson/static_build_env/jbds/jbds-target-platform_4.0.juno.SR1a/jbds600-e421-wtp341.target/</url>
            <layout>p2</layout>
            <mirrorOfLayouts>p2</mirrorOfLayouts>
        </mirror>
    </mirrors>
</settings>

h2. (Optional) Build parent and target platform
This step is only useful if you are actually working on the parent or the target platforms
and want to test local changes. Otherwise, Maven will simply retrieve parent and TP
definitions from 
*https://repository.jboss.org/nexus/content/repositories/snapshots/org/jboss/tools/ JBoss
Nexus* to perform your build.
See  #maven-nexus-resolution-problems Building Parent Pom & Target Platforms Locally

Sometimes, Maven can't find the upstream artifacts - parent pom, tycho plugins,
minimum (Juno SR0) or maximum (Juno SR1 or later) target platforms. Or maybe you want to
build them locally in order to see how Tycho builds them, or contribute a fix. To work
around resolution problems, just build locally:

{code}
cd /tmp; git clone  https://github.com/jbosstools/jbosstools-maven-plugins git clone
git://github.com/jbosstools/jbosstools-maven-plugins.git
cd /tmp; git clone  https://github.com/jbosstools/jbosstools-build git clone
git://github.com/jbosstools/jbosstools-build.git
cd jbosstools-maven-plugins/tycho-plugins; mvn install; cd -
cd jbosstools-build/parent;  mvn install; cd -
cd jbosstools-build/target-platforms; mvn install -Pjbosstools-minimum,jbosstools-maximum
{code}

h2. Building Individual Components Locally Via Commandline
h3. Build a component resolving to a recent aggregation build for other JBT dependencies
(Recommanded)
* Pros:* You build only your component
* You only need source for your component
* Speed to resolve deps: +
* You get generally the latest build for you component

* Cons:* Takes some time to resolve dependencies on other component
* Can sometimes be out of sync if no build occured recently for a component you rely on
and had some important change. More risk to get out of sync than with the staging site.

Tracked by  https://issues.jboss.org/browse/JBIDE-11516
https://issues.jboss.org/browse/JBIDE-11516

example:
 *cd jbosstools-server*
 mvn verify -P unified.target *-Pjbosstools-staging-aggregate*
h3. Build a component resolving to the latest CI builds for other JBT dependencies
* Pros:* You build only your component
* You only need source for your component
* You get generally the latest build for you component

* Cons* Takes some time to resolve dependencies on other component
* Can sometimes be out of sync if no build occured recently for a component you rely on
and had some important change
* Speed to resolve deps: -

This profile is the one use for CI builds on Hudson.

 *cd jbosstools-server*
 mvn verify -P unified.target *-Pjbosstools-nightly-staging-composite*

h3. Build a component along with all its dependencies from sources ("bootstrap"
build)
This will build exactly what you have locally
* Pros:* You are sure of the version of sources that is used for your JBT dependencies
* You don't loose time in resolving your JBT deps

* Cons:* You need sources for your dependencies too
* You often build more stuff that what you really want to test

cd ~/trunk/jbosstools-server
mvn verify  -P unified.target -*Pbootstrap*
h2. Building Everything In One Build Locally Via Commandline

 *LINUX / MAC USERS*

cd jbosstools-build
 mvn clean install -gs ~/.m2/settings.xml | tee build.all.log.txt

(tee is a program that pipes console output to BOTH console and a file so you can watch
the build AND keep a log.)

*WINDOWS USERS*

cd c:\trunk\jbosstools-build
mvn3 clean verify -gs file:///${user.home}/.m2/settings.xml
   or
mvn3 clean verify -gs file:///${user.home}/.m2/settings.xml > build.all.log.txt

Remember to adjust your  #settings.xml settings.xml file to specify where you have your
local target platform mirror built (or where you downloaded & unpacked a target
platform zip. Windows users, if you don't have a .m2 folder, see 
http://stackoverflow.com/questions/6081617/missing-maven-m2-folder this article.

h2. Building Locally In Eclipse

First, you must have installed m2eclipse into your Eclipse (or JBDS). You can install the
currently supported version from this update site:

 http://download.jboss.org/jbosstools/updates/juno/
http://download.jboss.org/jbosstools/updates/juno/

Next, start up Eclipse or JBDS and do *File > Import* to import the project(s) you
already checked out from SVN above into your workspace.