Skip to content

Latest commit

 

History

History
109 lines (84 loc) · 4.13 KB

README.md

File metadata and controls

109 lines (84 loc) · 4.13 KB
Raw

Eclipse Ditto™ Testing

This repository contains the "system tests" of Eclipse Ditto.
They ensure that on API level no regressions happen, that APIs stay stable and that added functionality is tested from a user perspective.

How to run tests in IntelliJ

System tests require the following components to run.

  1. Containers required by Ditto stack (MongoDB) and by connectivity tests (Mosquitto, Artemis etc.).
  2. A working Ditto stack, either as docker stack or launched from IntelliJ.
  3. A local authorization server mock.

Start MongoDB and message broker containers

If you want to launch Ditto from IntelliJ, start the MongoDB container:

cd docker
docker-compose up -d mongodb

If you want to run Ditto as a docker stack, simply run docker/start.sh. MongoDB is included.

Connectivity tests require message brokers. Start them thus:

cd docker

# AMQP broker
docker-compose up -d artemis

# MQTT broker
docker-compose up -d mqtt

# Kafka broker
docker-compose up -d kafka

# RabbitMQ broker
docker-compose up -d rabbitmq

The brokers do consume system resources. Start them on a by-need basis.

Run Ditto

To run Ditto as a docker stack, simply execute docker/start.sh. MongoDB is included.

To launch Ditto from IntelliJ, in debug mode for instance, run Policies first and the other required services after. A launch sequence could look like this:

  1. Policies
  2. Things
  3. Search
  4. Connectivity
  5. Gateway

Or, simply make use of the multirun plugin for which a run configuration also is available.

Authorization server mock

Tests authenticate themselves via OAuth against a mock server.
The tests make use of the mock-oauth2-server.

In order to run it, simply start it via compose:

cd docker

# OAuth mock server
docker-compose up -d oauth

Acceptance tests

A subset of the system tests, called Acceptance tests, could be run against remote Ditto deployment. These need some environment variables set before execution, depending on authentication method configured in Ditto deployment. The following variables must be set:

  • for BasicAuth:
      BASIC_AUTH_ENABLED = true     # boolean to configure tests
      DEFAULT_HOSTNAME              # the hostname of the Ditto deployment
      BASIC_AUTH_USERNAME           # Ditto username for basic auth
      BASIC_AUTH_PASSWORD           # the password for the user
  • for OAuth - the tests need an OAuth provider and 4 separate OAuth clients:
      BASIC_AUTH_ENABLED = false  # default value, could be skipped
      DEFAULT_HOSTNAME            # the hostname of the Ditto deployment

      OAUTH_TOKEN_ENDPOINT        # OAuth token endpoint for getting tokens
      OAUTH_ISSUER                # should match the value configured in Ditto

      OAUTH_CLIENT_ID             # main client id
      OAUTH_CLIENT_SECRET         # main client secret
      OAUTH_CLIENT_SCOPE          # main client scope

      OAUTH_CLIENT2_ID            # 2nd client id
      OAUTH_CLIENT2_SECRET        # 2nd client secret
      OAUTH_CLIENT2_SCOPE         # 2nd client scope

      OAUTH_CLIENT3_ID            # 3rd client id
      OAUTH_CLIENT3_SECRET        # 3rd client secret
      OAUTH_CLIENT3_SCOPE         # 3rd client scope

      OAUTH_CLIENT4_ID            # 4th client id
      OAUTH_CLIENT4_SECRET        # 4th client secret
      OAUTH_CLIENT4_SCOPE         # 4th client scope

Run maven with profile acceptance and set property test.environment=deployment, e.g. with the following command:

mvn verify -am -amd --projects=system -Pacceptance -Dtest.environment=deployment -Dtest.timeoutMs=240000 -Dskip.categories=ServiceBus