maven-waf branch
This article depends on the maven-waf branch
Maven uses the notion of a build life-cycle to which plugins can attach. Plugins are similar to Ant tasks. When a Maven build is invoked, we specify a point in the life-cycle up to which the build should proceed. The compile phase comes before test, and test comes before package, and package comes before install. Once we have Maven setup, we can invoke the Struts build, and specify which phase the build should use.
Get Maven binary: http://maven.apache.org/download.html
For Mac and Linux:
Extract the latest stable binary release to /usr/local/maven
Add following to your .zshrc/.bashrc/.aliasrc:
export M2_HOME=/usr/local/maven export PATH=${M2_HOME}/bin:${PATH}
*For Windows: *
Right click on my computer and click on Properties Click on Advanced system settings Click on Environment Variables Click on New... under System variables Add M2_HOME to Variable name and /usr/local/maven to Variable value Find Path and click Edit... Add ;%M2_HOME%/bin at the end Click OK, OK, and close to get out of all the dialogues Locate a copy of genosimage.exe. It comes with cygwin and can be copied from %CYGWIN_HOME%\bin copy %CYGWIN_HOME%\bin\genosimage.exe %SOURCE_HOME%\mkisofs
POMs are top level build configuration files.
To debug POMs, read through the effective POM:
$ mvn help:effective-pom
Running mvn in source root will download and setup dependency jars in ~/.m2/repository.
$ mvn $ mvn -P deps # or, explicitly specify the profile
Some modules require dependencies that are not freely available or have an incompatible license. These dependencies you need to donwload yourself. See to following instructions to add them to your maven repository.
1. Download the following jars and put them in the deps directory:
2. Go into the deps directory and run install-non-oss.sh
$ cd deps $ ./install-non-oss.sh
Running the maven command in the top directory of the CloudStack sources will compile all sources for CloudStack and run the unittests. The resulting jar files will be in the directory target in the subdirectory for a particular module. The default build will have all components that depends on non OpenSource libraries disabled. If you want to enable this, just add -D nonoss to the mvn command line.
$ mvn [-D nonoss]
# This is a WIP feature $ mvn -P developer -pl developer -Ddeploydb
This build process is based on ant, waf and maven. In future, we'll try to have maven do everything for us.
$ rm -fr ~/.m2 #optional $ cd incubator-cloudstack $ mvn -P deps # gets $ ant clean-all build-all $ ant deploy-server # ant deploy-server before you deploydb $ ant deploydb # checkout how to deploy db with mvn above; usual ant stuff :)
To buid with nonoss plugins we need to apply a patch and copy nonoss libs (cloud-iControl.jar, cloud-netscaler.jar, cloud-netscaler-sdx.jar, cloud-manageontap.jar, vmware-vim.jar,vmware-vim25.jar, vmware-apputils.jar) to /deps:
$ wget http://bhaisaab.org/patches/cloudstack/0001-BUILD-Make-CloudStack-buildable-with-nonoss-libs.patch $ git pull <branch; master> $ git am <patch> $ mvn -P deps $ ./waf rpm # or, do ant build-all etc.
Use waf to build packages for linux systems that use rpms, like RedHat, CentOS and fedora.
prerelease flag
This flag is required as this makes the RPM use the SNAPSHOT versions.
$ waf --package-version=4.0.0 --prerelease=rc1 --build-number=1 --oss rpm
$ mvn install -P deps && ./waf rpm
On Master:
$ mvn install -P deps && dpkg-buildpackage
Package using deb profile (feature under development uses jdeb plugin, in https://github.com/bhaisaab/incubator-cloudstack/tree/debs-maven debs-maven branch):
$ mvn package -P deb
This replaces the old ant debug, but you still have to deploy the database using 'ant deploydb' for now.
Under development
This feature is still being developed and tested, might not work as expected
$ mvn -P client -pl client jetty:run
Zsh/Bash/Emacs/Vim/Grep/Sed/Awk/Javac...
$ sh deps/install-non-oss.sh $ mvn -Dnonoss install $ ant debug # Good ol' way of doing things
FIXME: Add on how to use IntelliJ IDEA with CS, building, debugging, editing, git checkouts
FIXME: Add on how to use Eclipse with CS, building, debugging, editing, git checkouts
$ mvn --projects='org.apache.cloudstack:cloudstack' org.apache.rat:apache-rat-plugin:0.8:check
The output file is in $
/rat.txt, by default in target/rat.txt
$ mvn site
$ mvn -o -Pextras,plugins,xwork
// Bash export MAVEN_OPTS=-Xmx512m // Windows set MAVEN_OPTS=-Xmx512m