SMILA/Documentation/HowTo/Howto build a SMILA-Distribution

This HowTo describes how to build a SMILA distribution.

Build Requirements

The build process uses Eclipse's PDE Build tools to build all the bundles, run all unit tests, and create a ZIP archive with a complete SMILA application that can be installed and run independently from any development environment. To run this build process, you should first install the following software:

• Eclipse SDK 4.4.2 for your operating system: We recommend installing a fresh Eclipse instance independently from the one you might already be using and use this solely for the purpose of building SMILA. This makes sure that any potential additional Eclipse plugins installed on your existing installation won't interfere with the build process (this shouldn't happen, usually - but just to be safe). You can find the download on http://download.eclipse.org/eclipse/downloads/. This HowTo was tested with Eclipse Classic SDK 4.4.2.

• DeltaPack matching your Eclipse version: The DeltaPack contains some additional bundles needed in the build, mainly for creating the SMILA executable for different platforms. You'll find the download on http://download.eclipse.org/eclipse/downloads/. Install it by unpacking it into you Eclipse SDK installation. This HowTo was tested with DeltaPack 4.4.2.

• Sun Java Development Kit: You need a full JDK, version 7, to build SMILA, not just a JRE. You can get it at [1]

• Apache Ant: The build process is executed by Ant, which you can download here: http://ant.apache.org/. At least version 1.7 is needed (and tested).

• Additional Libraries for building which are not included in SMILA repository. The build scripts assume the following directory structure for these libraries. You can either create this structure in your working copy of the SMILA repository next to all the SMILA bundles, or somewhere else on your hard disk and configure the build process to find them there (see below). For your convenience, we have put together a package with current versions of these libraries for download: smila-build-libraries-1.3.0.zip. The structure of this package is:

lib/
   ant-contrib/
      ant-contrib-1.x.jar
   checkstyle/
      checkstyle-all-5.x.jar
   jacoco/
      jacocoagent.jar, jacocoant.jar
   pmd/
      asm-3.2.jar, jaxen-1.1.1.jar, pmd-4.3.jar
   xjc/
      InterfacesXJCPlugin.jar, jaxb-api.jar, jaxb-impl.jar, jaxb-xjc.jar

• • ant-contrib: This is required to run the build. You may download it from: ant-contrib. You can use the binary versions available there. (Tested with ant-contrib 1.0b3)
  • Furthermore our build process optionally generates reports for checkstyle, jacoco (code coverage) and pmd (static code analysis) if these libraries are present. The build is configured to run without these libraries and will just not create the respective reports, but everything else will be OK. To generate these reports you may download these files from:
    • checkstyle (use Checkstyle 5.5 or higher, older versions will not handle Java-7 source code correctly).
    • jacoco. (Tested with jacoco 0.7.4 and higher)
    • pmd. (Tested with pmd 4.3)
  • xjc: is only needed if you need to generate JAXB classes from an XML schema, see SMILA/Development Guidelines/Setup for JAXB code generation for details.

Configuring the Build

The folder SMILA.builder contains everything needed to build SMILA and/or run all tests locally. The default settings are set to build against Eclipse 4.2 and build a product for Win 32bit and 64bit, Linux 32bit and 64bit as well as MacOS x86 64bit. But it is also possible to build other platforms.  

Whether you build from command line or from Eclipse, in both cases the make.xml ant script is executed. Before execution certain properties need to be set to meet the local setup.

Setting the Target Build Platform

First, setup a development environment. When finished copy the file SMILA.builder/build.properties.template to SMILA.builder/build.properties and adapt the copied file: Add the platforms that you want to build as value triplets to the configs property and comment out or remove those that you don't need. The available platform triplets are:

Windows 32bit	... configs=win32,win32,x86 # ...
Windows 64bit	... configs=win32,win32,x86_64 # ...
Linux 32bit	... configs=linux,gtk,x86 # ...
Linux 64bit	... configs=linux, gtk, x86_64 # ...
Solaris SPARC	... configs=solaris, gtk, sparc # ...

If you want to provide several distributions at once e.g one for Windows 32bit and one for Linux 32bit (default build plan), concatenate the platform triplets with the '&' character:

Example:	configs=win32, win32, x86 & \ linux, gtk, x86

The archive files of the application distribution are created in the Application directory below the specified build directory (see below). For each platform triplet in the configs property ($os, $ws, $arch) a ZIP file named SMILA-incubation-$os.$ws.$arch.zip is built.

Setting Build Properties

These are the main properties that can be used to configure the build process executed by make.xml. If you run the build from within Eclipse you must add them to the Ant launch configuration (see Executing make.xml from within Eclipse below), for running from command line we have included templates that you can adapt to your local setup (see Executing make.xml from command line below).

Note: When using linux, make sure not to use paths containing softlinks, because they may not be correctly resolved during the build process. Use the full qualified path instead. 

Property	Default	Comment
buildDirectory	<SMILA_HOME>/smila.build	Directory where built output will be created. This should be always a subdirectory of <SMILA_HOME>. The application distribution's ZIP files will be created in the subdirectory Application of this directory.
builder	<SMILA_HOME>/SMILA.builder	Directory where make.xml is locate.
eclipse.home	<ECLIPSE_HOME>	Location of the Eclipse instance used to build SMILA.
lib.dir	<SMILA_HOME>/lib	Location of the additional build libs (ant-contrib, etc.).
os	win32	These properties merely control under which platform the test will run. It must be one of the target platforms you have built.
ws	win32
arch	x86
test.java.home	<JAVA_HOME>	A Java 1.7 SDK instance.

Executing the make.xml

The default target is all, building the application and running all unit tests. Note that this can take quite a while. To build the distribution archives only, use the targets clean and final-application. See Introduction to make.xml for more details.

Executing make.xml from within Eclipse

Steps:

1. Select the SMILA.builder bundle.
2. Open the External Tools Configuration dialog (select Run -> External Tools -> External Tools Configuration).
3. Create a new Ant Build configuration.
4. In the Buildfile field, enter: ${workspace_loc:/SMILA.builder/make.xml}.
5. In the Base Directory field, enter: ${workspace_loc:/SMILA.builder}.
6. Add all properties from above into the Arguments field (and adapt them to meet your setup) but prepend each with -D so each is passed into ant as a property (note that buildDirectory should be a subdirectory of your SMILA workspace directory), e.g. when using Eclipse 3.7.2 to build:

   -DbuildDirectory=D:/workspace/SMILA/smila.build

    -Declipse.home=D:/eclipse442

   -Dbuilder=D:/workspace/SMILA/SMILA.builder

   -Declipse.running=true

   -Dos=win32 -Dws=win32 -Darch=x86

   -Dlib.dir=D:/workspace/SMILA/lib

7. Apply, and run the Ant build.
   Note: To start another than the default target select the targets of your choice on the Targets tab.

Executing make.xml from command line

The make.bat and make.sh files are just shell scripts setting the properties that are needed for the Ant script. These files exist only as templates in the repository with .#~#~# appended to denote their template nature. Copy one of them matching your system and rename them as you like, but note that the names make.bat and make.sh are already in the repository's ignore list to prevent them from beeing committed accidentally, so it is recommended to use them.

Both scripts are very similar, they start with setting some environment variables which are then used to create the build configuration properties and eventually feed them into an Ant call. There are the variables you usually need to check and adapt:

Variable	Comment
SMILA_HOME	Location of your working copy, i.e. the absolute of your org.eclipse.smila.core/core/<tt> directory. May be derived automatically in the <tt>.sh script, in the batch file, however, you must set it yourself.
ECLIPSE_HOME	Location of the Eclipse instance used to build SMILA.
ARCH	Operating system and platform settings for running the tests. See description of os, ws and arch properties above.
JAVA_HOME	Location of the JDK to build and run tests in. Must match the ARCH setting. Tip: If your compile log complaints about a non-1.6 compatible JVM despite the correct settings, you must also add the JAVA_HOME location to the ECLIPSE_HOME/eclipse.ini like so: -vm <JAVA_HOME>\bin
ANT_HOME	Location of your ANT installation.
BUILDLIB_DIR	Location of your build files. If you placed them in the SMILA_HOME you can leave this untouched and comment out the libDir setting in the next line.
buildOpts	Use the default buildOpts for Eclipse pdebuild or adapt them if you have another version installed.

Usually you don't need to change anything below the line setting buildOpts.

To run a build with the default target (all), open a command prompt or shell in the SMILA.builder directory and just enter.

make

To execute another than the default target, just pass it (or them) as an argument:

make build

For example, to build the application distribution ZIPs without running the tests (which can take quite long), you can use:

make clean final-application

In Windows you will not see much output in the command prompt window, because the batch file redirects it to a logfile (named log.make, if the batch file is make.bat) so that you can check for error details after the build. You can install the GnuWin32 or Cygwin tools and use tee to have the output written to both console and logfile. The template contains the changed ANT call as a comment quite at the end of the script.