Wiki source code of Build Management

Version 16.1 by cds on 2013/04/03 11:25
Show last authors
1 {{warning}}
2 This page is currently being updated as we work on a revised build process, which is to be explained here in detail.
3 {{/warning}}
4
5 In order to keep the KIELER code as stable as possible, we use automatic continuous integration builds. Once you push something into one of the KIELER repositories, you trigger the automatic build process. If the build fails for whatever reason – be it failed unit tests or simply compilation errors – you are notified of the problem.
6
7 This page describes the software and setup we use to implement all of this.
8
9 **Content**
10
11
12
13 {{toc/}}
14
15 = Software We Use =
16
17 To implement our automatic builds, we use the popular [[Maven>>url:http://maven.apache.org/||shape="rect"]] tool in conjunction with [[Tycho>>url:http://eclipse.org/tycho/||shape="rect"]], a set of Maven plug-ins that allow Maven to build Eclipse projects. Our KLay layouters library is built using [[Apache Ant>>url:http://ant.apache.org/||shape="rect"]]. To implement our continuous integration builds, we use [[Atlassian Bamboo>>url:http://www.atlassian.com/software/bamboo/overview||shape="rect"]].
18
19 == Maven / Tycho ==
20
21 Maven is a build tool for Java projects. It takes care of dependency management, including in-build dependencies (the order in which packages are compiled) as well as dependencies to third-party libraries. The latter are automatically fetched from special Maven repositories. Without getting too technical, a Maven build consists of several phases, such as //compile// and //package//. Within each phase, several Maven plug-ins handle different //tasks// (or //goals//, as Maven calls them). The //maven-compile-plugin// for example compiles {{code language="none"}}.java{{/code}} files into {{code language="none"}}.class{{/code}} files.
22
23 To correctly compile a project, Maven needs to be told about the project. While the popular Ant build tool uses {{code language="none"}}build.xml{{/code}} files to describe the steps to be executed for building a project, Maven uses {{code language="none"}}pom.xml{{/code}} files to describe the project and figures out the steps for itself. The POM files may inherit settings from a parent POM file.
24
25 Tycho is a set of Maven plugins that handles compiling and dependency management as well as bundling of Eclipse plug-ins. Tycho understands Eclipse metadata files such as {{code language="none"}}plugin.xml{{/code}} or {{code language="none"}}feature.xml{{/code}}, provides dependency information extracted from those files, and provides an Eclipse instance for compiling and packaging Eclipse bundles.
26
27 == Apache Ant ==
28
29 Ant is a very popular Java build tool. While Maven wants to know metadata about a project and then knows what to do to build it, Ant works by specifying exactly what to do to build a project. These steps are configured in a {{code language="none"}}build.xml{{/code}} file. We try to avoid using Ant, but still have Ant build files around for jobs too specialized to be properly handled by Maven.
30
31 == Bamboo ==
32
33 While Maven and Tycho know how to compile KIELER, Bamboo knows when to compile KIELER and what to do with the compiled project. Bamboo has access to our source code repositories and triggers continuous integration builds every time someone pushes new code into a repository. It also does a full build every night and copies the results onto our nightly build update site to be accessed by people all around the world. And beyond. Tell your friends!
34
35 = The Automatic Build Process =
36
37 This section describes how our POM files are distributed throughout the repository structure, and how you can trigger an automatic build of KIELER.
38
39 == POM Files ==
40
41 The basic structure of the POM files can be seen below:
42
43 [[image:attach:pomfiles.png]]
44
45 Each plug-in and feature has a corresponding (usually rather small) POM file. The POM files in the {{code language="none"}}features{{/code}} and {{code language="none"}}plugins{{/code}} directories know about the different features and plug-ins. The parent POM file, which all other POM files copy basic configuration from, knows about the feature and plug-in POM files. In addition, the {{code language="none"}}build{{/code}} directory also contains a bunch of subdirectories. These also contain POM files specialized for building the P2 repositories necessary to publish our Eclipse features.
46
47 == Using the KIELER Maven Build ==
48
49 Using the KIELER Maven build requires knowledge about two aspects: necessary configuration / required libraries and invoking Maven.
50
51 === Necessary Configuration ===
52
53 KIELER needs to be built against a P2 repository generated from our Eclipse reference installation. The path to this repository is found in the parent POM file and must be changed if the repository location changes. Also, when changing the reference installation, the repository has to be updated using the following magic command (adapted accordingly):
54
55 {{code language="none"}}
56 java -jar eclipse_3.8/plugins/org.eclipse.equinox.launcher_*.jar \
57 -application org.eclipse.equinox.p2.publisher.FeaturesAndBundlesPublisher \
58 -metadataRepository file:/home/java/repository/juno382 \
59 -artifactRepository file:/home/java/repository/juno382 \
60 -source /home/java/eclipse_3.8/ \
61 -publishArtifacts
62 {{/code}}
63
64 === Invoking Maven ===
65
66 To actually build KIELER once all preliminaries are done, navigate to the {{code language="none"}}/build/de.cau.cs.kieler.parent{{/code}} directory and run the following command line:
67
68 {{code language="none"}}
69 mvn clean package -P <profile> # For a list of available profiles, see parent pom.xml
70 {{/code}}
71
72 If you are trying to build KIELER on our server, you first have to setup the Java environment, if you haven't already done so. The command line thus becomes:
73
74 {{code language="none"}}
75 . /home/java/java-env
76 mvn clean package -P <profile> # For a list of available profiles, see parent pom.xml
77 {{/code}}
78
79 Once Maven has finished, the different build artifacts may be found in the {{code language="none"}}/build/de.cau.cs.kieler.*.repository/target{{/code}} directories.
80
81 == What to Be Aware of ==
82
83 There are some things that people need to be aware of to keep the build files in a valid state.
84
85 1. Eclipse metadata and POM files are not synchronized. Thus, if the version of an Eclipse plug-in changes, its {{code language="none"}}pom.xml{{/code}} needs to be updated accordingly.
86 1. The repository POM directories contain product files and product icons. These are copies of the files found in the corresponding branding plug-ing (such as {{code language="none"}}de.cau.cs.kieler.core.product{{/code}}) and have to be manually synchronized.
87
88 == The Curious Case of Building the KLay Library ==
89
90 We distribute our KLay layout algorithms in two library files: one that contains just our algorithms, and another one that also contains dependencies such as required EMF classes. To build the KLay libraries, navigate to the {{code language="none"}}/build/de.cau.cs.kieler.klay.libraries{{/code}} directory and do the following:
91
92 1. Set the {{code language="none"}}PRODUCT{{/code}} environment variable to point to a complete installation of KIELER. You can get one by using the automatic Maven build.
93 1. Run Ant on the {{code language="none"}}build.xml{{/code}} file. This will produce both versions of the KLay layout library.
94
95 = Continuous and Nightly Builds =
96
97 There are basically three different build plans for each of the KIELER projects:
98
99 1. **Continuous Plugins** – Compiles the plug-ins and runs the unit tests on them. None of the compiled artifacts are published anywhere. This plan is triggered by pushing stuff into the repositories, giving early feedback regarding whether committed changes break anything.
100 1. **Nightly Product** – Compiles the plug-ins and assembles distributable product files and update sites. Distributable files are published in the nightly build directory {{code language="none"}}/home/kieler/public_html/files/nightly{{/code}}. Update sites are published in {{code language="none"}}/home/kieler/public_html/updatesite/nightly{{/code}}. This plan is run once every night.
101 1. **Nightly Rating** – Compiles the plug-ins and runs our code quality rating doclet on them. The result is a website published at {{code language="none"}}/home/kieler/public_html/rating{{/code}}. This plan is run once every night.
102
103 == Different Nightly Product Builds ==
104
105 Since KIELER is divided into the //Pragmatics// and //Semantics// parts, the different Nightly Product builds produce different artifacts.
106
107 * KIELER Pragmatics\\
108 ** KLay layout library redistributables
109 ** KWebS redistributables
110 ** Papyrus Layout update site
111 * KIELER Semantics\\
112 ** KIELER redistributables
113 ** KIELER update site

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage