View source for SMILA/Documentation/HowTo/Howto 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 an 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 3.5 for your operating system: We recommend installing a second Eclipse instance independently from the one you are using as your IDE so that additional installed Eclipse plugins you use in your work do not 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/ http://download.eclipse.org/eclipse/downloads/]. This How-to was tested with [http://download.eclipse.org/eclipse/downloads/drops/R-3.5-200906111540/index.php Eclipse Classic SDK 3.5].
 
*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/ http://download.eclipse.org/eclipse/downloads/]. Install it by unpacking it into you Eclipse SDK installation. This How-to was tested with [http://download.eclipse.org/eclipse/downloads/drops/R-3.5-200906111540/index.php#DeltaPack DeltaPack 3.5].
 
*Sun Java Development Kit: You need a full JDK, version 6, to build SMILA, not just a JRE. You can get it at [http://java.sun.com/javase/downloads/index.jsp]
 
*Apache Ant: The build process is executed by Ant, which you can download here: [http://ant.apache.org/ 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).

<source lang="text">
lib/
   ant-contrib/
      ant-contrib-1.0b1.jar
   checkstyle/
      checkstyle-all-4.3.jar
   emma/
      emma.jar, emma_ant.jar
   pmd/
      asm-3.1.jar, jaxen-1.1.1.jar, pmd-4.1.jar
</source>
 

**ant-contrib: This is required to run the build. You may download it from: [http://sourceforge.net/projects/ant-contrib ant-contrib].
 
**Furthermore our build process optionally generates reports for checkstyle, emma (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: 
 
***[http://checkstyle.sourceforge.net/ checkstyle] (use Checkstyle 4.x. The current rules do not work with 5.0) 
 
***[http://emma.sourceforge.net/ emma] 
 
***[http://pmd.sourceforge.net/ pmd].

==== Configuring the Build  ====

The folder <tt>SMILA.builder</tt> contains everything needed to build SMILA and/or run all tests locally. The default settings are set to build against Eclipse 3.5 and build a product for Win 32bit and Linux 32bit. But it is also possible to build other platforms.
&nbsp;

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

===== Setting the Target Build Platform  =====

Independent of which way you are going to build, you must set the <tt>configs</tt> property in the <tt>build.properties</tt> file to your setup.
 

{|
|+ 
|-
! Windows 32bit
 
| {{Codeblock|<PRE>...
configs=win32,win32,x86 
# ... </PRE>
}}
|-
! Windows 64bit
 
| {{Codeblock|<PRE>...
configs=win32,win32,x86_64 
# ... </PRE>
}}
|-
! Linux 32bit
 
| {{Codeblock|<PRE>...
configs=linux,gtk,x86
# ... </PRE>
}}
|-
! Linux 64bit
 
| {{Codeblock|<PRE>...
configs=linux, gtk, x86_64
# ... </PRE>
}}
|-
! Solaris SPARC
 
| {{Codeblock|<PRE>...
configs=solaris, gtk, sparc
# ... </PRE>
}}
|}

If you want to provide several distributions e.g one for windows 32bit and one for linux 32bit (default build plan), you have to string together the config values. 
 

{|
|-
! Example:
 
| {{Codeblock|<PRE>configs=win32, win32, x86 & \
 linux, gtk, x86 </PRE>
}}
|}

The application distribution archive files will be created in subdirectory <tt>Application</tt> of the specified build directory (see below). For each <tt>configs</tt> entry <tt>$os, $ws, $arch</tt> a ZIP file named <tt>SMILA-incubation-$os.$ws.$arch.zip</tt> will be created.
 

===== Setting Build Properties  =====

These are the main properties that can be used to configure the build process executed by <tt>make.xml</tt>. If you run the build from within Eclipse you must add them to the Ant launch configuration (see [[#Executing_make.xml_from_within_eclipse|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|Executing make.xml from command line]] below).

{| border="1" cellspacing="0" cellpadding="5"
|-
! Property
! Default
! Comment
|-
| buildDirectory
| &lt;SMILA_HOME&gt;/eclipse.build
| directory where build output will be created. This should be always a subdirectory of SMILA_HOME. The application distribution ZIP files will be created in subdirectory <tt>Application</tt> of this directory.
|-
| builder
| &lt;SMILA_HOME&gt;/SMILA.builder
| directory where <tt>make.xml</tt> is located
|-
| eclipse.home
| &lt;ECLIPSE_HOME&gt;
| the location of the [[#Build_Requirements|eclipse instance]] used to build SMILA
|-
| lib.dir
| &lt;SMILA_HOME&gt;/lib
| location of the additional build libs (ant-contrib, etc.)
|-
| pdeBuildPluginVersion
| 3.5.0.v20090527-1800
| 3.5.0.v20090527-1800 (for build with Eclipse 3.5)
|-
| equinoxLauncherPluginVersion
| 1.0.200.v20090520
| 1.0.200.v20090520 (for build with Eclipse 3.5)
|-
| os
| win32
| rowspan="3" | these merely control under which platform the test will run. It must be one of the [[#Setting_the_Target_Build_Platform|target platforms]] you have build.
|-
| ws
| win32
|-
| arch
| x86
|-
| test.java.home
| &lt;JAVA_HOME&gt;
| &nbsp;a java 1.6 SDK instance
|}

==== Executing the make.xml ====
[[Image:Smila.build.all.png|thumb|right| <tt>all</tt> dependency graph]]

The default target is <tt>all</tt>. This will by default build the application and run all unit tests. Note that this can take quite a while. To build the distribution archives only, use targets <tt>clean</tt> and <tt>final-application</tt>. The [[:image:Smila.build.all.png|dependency graph]] will explain what will happen and shows the relevant targets you may call instead.


===== Executing make.xml from within eclipse  =====

Steps:

#set up devolopment environment see: [[SMILA/Development Guidelines/Howto set up dev environment|How to set up dev environment]]
#select the SMILA.builder bundle
#open External Tools Configuration dialog (in Toolbar or Run -&gt; External Tools submenu)
#create a new "Ant build" configuration or choose your configuration if exists
#set the "Buildfile" field to ${workspace_loc:/SMILA.builder/make.xml}
#set the "Base directory" field to ${workspace_loc:/SMILA.builder}
#insert all properties from above into the arguments input field (and adapt these to your setup) but prepend each with <tt>-D</tt> so each is passed into <tt>ant</tt> as a property (note that buildDirectory should be a subdirectory of your SMILA workspace directory), e.g. when using Eclipse 3.5 to build:
#:-DbuildDirectory=D:/workspace/SMILA/eclipse.build 
#:&nbsp;-Declipse.home=D:/eclipse35
#:-Dbuilder=D:/workspace/SMILA/SMILA.builder 
#:-Declipse.running=true 
#:-DpdeBuildPluginVersion=3.5.0.v20090527-1800
#:-DequinoxLauncherPluginVersion=1.0.200.v20090520
#:-Dos=win32 -Dws=win32 -Darch=x86
#:-Dlib.dir=D:/workspace/SMILA/lib

#Apply, and run SMILA.builder with this external tool configuration

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 (or .sh) is just a shell script to set the properties that are needed for the ant script. These files exist only as templates in SVN with <tt>.#~#~#</tt> appended to denote their template nature. Copy one of them matching your system, but the names <tt>make.bat</tt> and <tt>make.sh</tt> is already in the svn:ignore to prevent it 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:

{| border="1" cellspacing="0" cellpadding="5" valign=top
! Variable !! Comment 
|-
| SMILA_HOME || location of your SVN working copy. Can be derived automatically in <tt>.sh</tt> script, in the batch file, you must set it yourself. 
|-
| ECLIPSE_HOME || the location of the [[#Build Requirements |eclipse instance]] used to build SMILA 
|-
| ARCH || operating system and platform settings for running the tests. See description of <tt>os</tt>, <tt>ws</tt> and <tt>arch</tt> properties above. 
|-
| JAVA_HOME || location of the JDK to build and run tests in. Must match the ARCH setting
|- 
| 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 <tt>libDir</tt> setting in the next line.
|-
| buildOpts ||  choose the line matching your Eclipse installation or adapt them if you have another version installed.
|-
|}

Usually you don't need to change anything after the line setting <tt>buildOpts</tt>.

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

<source lang="text">
make
</source>

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

<source lang="text">
make build
</source>

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

<source lang="text">
make clean final-application
</source>

In Windows you will not see much output in the command prompt window, because the batch file redirects it to a logfile (named <tt>log.make</tt>, if the batch file is <tt>make.bat</tt>) so that you can check for error details after the build. You can install the [http://gnuwin32.sourceforge.net/ GnuWin32] or [http://www.cygwin.com/ Cygwin] tools and use <tt>tee</tt> 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.

[[Category:SMILA]]