Gazelle documentation

Introduction

The purpose of this document is to provide a comprehensive guide for the installation of the Test Execution application.

Minimal requirements

  • Java virtual machine : JDK 21
  • Application server : Quarkus 3.27
  • Docker 20.10.0 or higher

Build from sources

The sources are available on the INRIA’s Gitlab:

git clone https://gitlab.inria.fr/gazelle/public/core/test-execution.git

It requires jdk21 and maven to build and run.

cd test-execution
mvn clean install

The docker image is directly built (can be disabled).

Environment requirements

To work properly, the Test Execution application requires the following applications to be installed and configured:

  • User Management 4.6.0 or higher
  • Maestro 1.1.1 or higher
  • Service Registry 2.0.0 or higher
  • Mosquitto 2.0.22 or higher
  • Postgresql 14 or higher
  • Test Model Repository 1.0.0 or higher
  • Test Management 11.3.0 or higher
  • User interface 3.5.0 or higher
  • Admin interface 2.4.0 or higher

Run

Start the Test Execution application using Java:

java -jar test-execution/target/quarkus-app/quarkus-run.jar 

or by using Docker:

docker run -p 127.0.0.1:8090:8090 rg.fr-par.scw.cloud/gazelle-snapshot/test-execution:X.X.X-SNAPSHOT

The application requires many environment variables to be set, you can find the list below :

Name Description Example value
GZL_MAESTRO_WEBSOCKET_URL The Maestro WebSocket URL wss://preprod.ihe-europe.net/maestro
GZL_TEST_MODEL_REPOSITORY_URL The Test Model Repository URL https://preprod.ihe-europe.net/test-model-repository
GZL_SVS_URL The SVS Simulator application URL (for value sets resolution) https://preprod.ihe-europe.net/SVSSimulator/rest
DB_USER The database user test_model_repository_user
DB_PASSWORD The database password test_model_repository_password
DB_HOST The database host localhost
DB_PORT The database port 5432
DB_NAME The database name test_model_repository
MQTT_HOST The MQTT broker host localhost
MQTT_PORT The MQTT broker port 1883
MQTT_USERNAME The MQTT username test_model_repository
MQTT_PASSWORD The MQTT password test_model_repository_password

Exposed endpoints

Once running, Test Execution exposes the following endpoints:

REST API

A swagger is available to explore all the REST endpoints at : http://localhost:8090/test-execution/swagger-ui

You can access to metadata of the application here : http://localhost:8090/test-execution/metadata

You can check the health of the application here : http://localhost:8090/test-execution/health

WebSockets API

ws://localhost:8090/test-execution/v1/test-stream/run/{testRunExecutionId}