Skip to content

Latest commit

 

History

History
157 lines (97 loc) · 4.65 KB

readme-build.md

File metadata and controls

157 lines (97 loc) · 4.65 KB

Modules

By default Fabric8 builds the set of modules required by the karaf distribution and runs the associated integration tests. There are two main build targets associated with corresponding maven profiles

  • tomcat: Fabric8 on Tomcat
  • wildfly: Fabric8 on WildFly

Build examples are below

Committers

Be sure to check out the committer instructions on how to fork this repo and submit Pull Requests

Building Fabric8

First of all, the Fabric8 build process needs, most of the time, more memory than the default allocated to the maven process. Therefore, ensure to set the MAVEN_OPTS system property with the following settings before starting

> MAVEN_OPTS="-Xmx1024m -XX:MaxPermSize=512m"

Build Fabric8 and run the associated smoke tests

> mvn clean install

Build Fabric8 Tomcat and run the associated tests

> mvn clean install -Ptomcat

Build Fabric8 WildFly and run the associated tests

> mvn clean install -Pwildfly

Build Fabric8 using latest hawtio Snapshot and run the associated tests

> mvn -Phawtio-snapshot clean install

Note, to avoid getting prompted for a gpg key add -Dgpg.skip=true

Quick Builds

You can do quick builds by appending -DskipTests

Build Fabric8 and skip tests

> mvn clean install -DskipTests

Build fabric8 with all modules and skip tests

Test Profiles

Fabric8 tests are seperated in serveral dedicated tests profiles

  • ts.smoke: Smoke tests
  • ts.basic: Basic integration tests
  • ts.all: All of the above

Examples

Build Fabric8 and run the smoke and basic integration tests

> mvn clean install -Dts.basic

Build Fabric8 and run all tests

> mvn clean install -Dts.all

License check

The source code uses the license header from the file fabric-license-header.txt in the root directory.

You can check for missing licenses in the source code, by enabling the license profile and run the following goal from the root directory. Notice this will check all the source code:

> mvn license:check -Plicense -Dlicense.header=fabric-license-header.txt

And from any sub module, you need to refer to the license file using a relative path:

   > cd fabric
   > cd fabric-agent
   > mvn license:check -Plicense -Dlicense.header=../../fabric-license-header.txt

You can update the license headers in the source code using the format goal, for example:

> mvn license:format -Plicense -Dlicense.header=../../fabric-license-header.txt

GitBook

The documentation is compiled into a book using GitBook.

First install gitbook using npm

npm install -g gitbook

And then install the anchor plugin

sudo npm install -g gitbook-plugin-anchors

Note on osx you may need to run these commands with sudo

And then build the book locally using

cd docs
gitbook serve ./

And access the book from a web browser at

http://localhost:4000

To add new sections into the gitbook, ecit the docs/SUMMARY.md file.

Tests stability checks

When testing stability, it's useful to have full logs available after tests are run. I was running series of smoke/karaf integration tests using the following script:

for n in `seq 10 100`; do
  nn=`printf '%02d' $n`;
  echo $nn;
  pkill -f karaf;
  mvn clean test -f itests/smoke/karaf/pom.xml;
  cp -fv itests/smoke/karaf/target/fabric8-karaf-1.2.0.redhat-630-SNAPSHOT/data/log/fuse.log /tmp/fuse-$nn.log;
  mv itests/smoke/karaf/target/fabric8-karaf-1.2.0.redhat-630-SNAPSHOT/instances/ /tmp/instances-$nn;
done | tee /tmp/fuse-all-tests.txt

and in separate shell:

tail -f /tmp/fuse-all-tests.txt | grep "Tests run\|BUILD\|^[0-9][0-9]$"

to see nice:

01
Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.457 sec - in io.fabric8.itests.common.BootstrapServiceTest
Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 11.716 sec - in io.fabric8.itests.common.ContainerStartupTest
Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 13.801 sec - in io.fabric8.itests.common.FabricCreateCommandTest
Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.98 sec - in io.fabric8.itests.common.ManagedContainerTest
Tests run: 5, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 7.668 sec - in io.fabric8.itests.common.ProfileManagementJolokiaTest
Tests run: 5, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 3.322 sec - in io.fabric8.itests.common.ProfileManagementProxyTest
Tests run: 14, Failures: 0, Errors: 0, Skipped: 0
[INFO] BUILD SUCCESS
...