GEMOC Studio Documentation
Developer Guide

To do a full build using docker: go to the docker folder (/gemoc-studio/dev_support/full_compilation/docker), then call the command

docker-compose down && docker-compose up

or

docker build -t "gemoc/gemoc-full-compilation:latest" .

Changes commited in master branch are automatically built and deployed on docker hub: https://hub.docker.com/r/gemoc/gemoc-full-compilation

A standard full build is done using the command:

docker run -it -v $PWD/../../../..:/home/jenkins/src -v $PWD/cache-m2:/home/jenkins/.m2 --user 1000 gemoc/gemoc-full-compilation:latest ./build_gemoc.sh

where

note: you must create the $PWD/cache-m2 folder before launching the docker command in order to avoid permission issues.

Once the full compilation has been done at least once (ie. and filled the m2 cache), you can run the system test only using the command

docker-compose run gemoc_full_compilation system_test_only

Or you can run a full build but including only the linux variant using:

docker run -it -v $PWD/../../../..:/home/jenkins/src -v $PWD/cache-m2:/home/jenkins/.m2 --user 1000 gemoc/gemoc-full-compilation:latest ./build_gemoc.sh linux

or

docker-compose run gemoc_full_compilation linux_offline

or

docker-compose run gemoc_full_compilation linux_no_system_test

or

docker-compose run gemoc_full_compilation linux_no_system_test_offline

The Dockerfile defines a docker image based on ubuntu 16.04 with maven, oracle java8, xvfb, and graphviz. It embeds an entrypoint.sh script that calls the maven command. The docker-compose.yml will mount the folder containing all gemoc repositories (ie. the place where you’ve done git clone) It also mounts a cache-m2 folder in order to speed up the compilation.

The docker-compose command is more or less equivalent to:

docker build -t gemoc/gemoc-full-compilation:latest .
docker run -v $PWD/../../../..:/home/jenkins/src -v $PWD/cache-m2:/home/jenkins/.m2 gemoc/gemoc-full-compilation:latest

Then you’ll have to manually prune unused containers after usage.

If for some reason you wish to access it interactively you can use the following command:

docker run -it -v $PWD/../../../..:/home/jenkins/src -v $PWD/cache-m2:/home/jenkins/.m2 --user 1000 gemoc/gemoc-full-compilation:latest /bin/bash

Minimal steps to get an addons:

For a given notification to IEngineAddon (for example aboutToExecuteStep), the order of calls to all registered addons is by default not ensured.

However, an addon can declare some EngineAddonSortingRule in order to indicate if the addon mus be called before or after another addon for a given EngineEvent.

The other addon can be identified either via its id or any tag that has been associated to it.

The implicit GemocDebug addon is in charge to lock the execution when it receives a pause command. Addons that displays some information on the UI may wish to be called before it in order to make sure to provide updated information.

This snippet show how to add a rule that enforce this.

public class MyAddon implements IEngineAddon {

	@Override
	public void aboutToExecuteStep(IExecutionEngine<?> engine, Step<?> logicalStepToApply) {
		// do some refresh action
	}

	@Override
	public List<EngineAddonSortingRule> getAddonSortingRules() {  
		ArrayList<EngineAddonSortingRule> sortingRules = new ArrayList<EngineAddonSortingRule>();
		sortingRules.add(new EngineAddonSortingRule( this,
				EngineAddonSortingRule.EngineEvent.aboutToExecuteStep,
				EngineAddonSortingRule.Priority.BEFORE,
				Arrays.asList(IGemocDebugger.GROUP_TAG))); 
		return sortingRules;
	}
}