HACKING.md

Building EnMasse

Prerequisites

To build EnMasse, you need

• JDK >= 1.8
• Apache Maven >= 3.0
• Python
• Docker
• GNU Make
• Node.js >= 6 (only for node.js unit tests)
• Npm >= 3 (only for node.js unit tests)
• GNU GCC C++ (to build jsonnet tool)
• Asciidoctor (optional, only required for docs)
• Python Pip (optional, only required for systemtests)

The EnMasse java modules are built using maven. Node.js modules are built using make. All docker images are built using make.

Note: asciidoctor, node.js and npm are optional. asciidoctor is only required to build the help pages for the console. node.js and npm are only required to run the unit tests for ragent, console and subserv.

Check out submodules

jsonnet is required to build templates. It is configured as a submodule that can be initialized:

git submodule update --init

Building

Pre-installation

The following node.js modules are required for the ragent, agent and subserv unit tests to work:

npm install -g mocha-junit-reporter
npm install -g rhea
npm install -g debug

Note: Make sure docker daemon is in running state.

Doing a full build, run unit tests and build docker images:

make

This can be run at the top level or within each module. You can also run the 'build', 'test', and 'package' targets individually. This builds all modules including java.

Tagging and push images to a docker registry

export DOCKER_ORG=myorg
export DOCKER_REGISTRY=docker.io
#optional parameters
export COMMIT=v.1.0.3 #for specific version of your image

docker login -u myuser -p mypassword $DOCKER_REGISTRY

# To generate templates to pull images from your docker hub org
make -C templates

make docker_tag
make docker_push

Note: If you are using OpenShift and 'oc cluster up', you can push images directly to the builtin registry by setting DOCKER_ORG=myproject and DOCKER_REGISTRY=172.30.1.1:5000 instead.

Deploying to an OpenShift instance assuming already logged in

make deploy

Running smoketests against a deployed instance

make SYSTEMTEST_ARGS=SmokeTest systemtests

Running full systemtest suite

Install client dependencies

make client_install

Running the systemtests

make systemtests

Run single system test

make SYSTEMTEST_ARGS="io.enmasse.systemtest.standard.QueueTest#testCreateDeleteQueue" systemtests

Reference

This is a reference of the different make targets and options that can be set when building an individual module:

Make targets

• build - build
• test - run tests
• package - create artifact bundle
• docker_build - build docker image
• docker_tag - tag docker image
• docker_push - push docker image
• deploy - deploys the built templates to OpenShift. The images referenced by the template must be available in a docker registry
• systemtests - run systemtests

Some of these tasks can be configured using environment variables as listed below.

Environment variables

There are several environment variables that control the behavior of the build. Some of them are only consumed by some tasks:

• OPENSHIFT_MASTER - URL to OpenShift master. Consumed by deploy and systemtests targets
• OPENSHIFT_USER - OpenShift user. Consumed by deploy target
• OPENSHIFT_PASSWD - OpenShift password. Consumed by deploy target
• OPENSHIFT_TOKEN - OpenShift token. Consumed by systemtests target
• OPENSHIFT_PROJECT - OpenShift project for EnMasse. Consumed by deploy and systemtests targets
• DOCKER_ORG - Docker organization for EnMasse images. Consumed by build, package, docker* targets. tasks. Defaults to enmasseproject
• DOCKER_REGISTRY - Docker registry for EnMasse images. Consumed by build, package, docker_tag and docker_push targets. Defaults to docker.io
• TAG - Tag used as docker image tag in snapshots and in the generated templates. Consumed by build, package, docker_tag and docker_push targets.