Microservice testing tool for doing system-level testing with applications using microservice architecture. Created for M.Sc. thesis at University of Helsinki.
The tool uses Testcontainers library to run the containers containing the microservices. Testcontainers uses Docker as its container engine, which means that Docker must be available on the environment that runs the tests.
This microservice testing tool can be used either as a library to add tests to an existing repository or it can be used to build standalone JAR files that can run the tests in CI/CD pipelines, for example.
In both cases, the tool must be included as a dependency in the project which contains the test code. The tool is published with GitHub packages. Using GitHub Packages requires authentication with a token that needs to be configured to be used with Maven or Gradle.
- Include the package as a test dependency, for example with Gradle:
testImplementation 'xyz.malkki:microservice-testing-tool:1.0.0' - Create a test class that includes the following function (example in Kotlin):
@TestFactory
fun `Test microservices`(): Collection<DynamicTest> {
return TestSuiteRunner.generateDynamicTests()
}- Write test configuration and test steps
- Include the package as a dependency, for example with Gradle:
implementation 'xyz.malkki:microservice-testing-tool:1.0.0' - Create a main function that includes the following:
MicroserviceTestExecutor.runMicroserviceTests()- Write test configuration and test steps
- (optional) Create a runnable JAR file so that the tests can be run in CI/CD pipelines
For complete example, see transitdata-tests repository.
- Create
.ymlfile tomicroservices/resource directory which lists available services
- Only
idandcontainerfields are required in the configuration
services:
- id: mosquitto
container: eclipse-mosquitto:1.6.3 #Docker image
ports: #List of open ports
- 1883
volumes: #List of volumes used
- type: RESOURCE #Either RESOURCE or FILESYSTEM
hostPath: mosquitto.conf #Refers to either a resource or a file in the filesystem depending on the value of type
containerPath: /mosquitto/config/mosquitto.conf #Path where the volume will be mounted on the container
waitStrategy:
type: LOG #Either LOG, PORT or HEALTHCHECK
logMessage: ".*Opening ipv4 listen socket on port 1883.*" #Log message to wait for if LOG wait strategy is used
- id: postgres
container: postgres:14-alpine
ports:
- 5432
environment: #Environment variables in the container
POSTGRES_PASSWORD: test
- id: pulsar
container: apachepulsar/pulsar
startupTimeout: 90 #Timeout in seconds to wait for the service to start
waitStrategy:
type: PORT #Waits until first of the ports accepts connections
cmd: bin/pulsar standalone #Command that is run in the container
ports:
- 6650
- dependencies: #List of services that must be started before this service
- redis- Create
.ymlfile tosteps/resource directory which lists available test steps
idandclassare required fields. It is also highly recommended to specify timeout withtimeoutto avoid tests getting stuck infinitely
- id: start-mqtt
class: xyz.malkki.microservicetest.steps.StartMqttStepCode
timeout: 15 #Timeout in seconds
- id: stop-mqtt
class: xyz.malkki.microservicetest.steps.StopMqttStepCode #Full class name. The class must implement xyz.malkki.microservicetest.testexecution.TestStepCode
timeout: 15
- id: create-database-table
class: xyz.malkki.microservicetest.teststeps.ExecuteSqlTestStep
timeout: 30
parameters: #Parameters for the test if using ParametrizedTestStepCode
connectionString: jdbc:postgresql://postgres:5432/?user=postgres&password=test
sqlResource: create_db.sql- Write code for test steps. Test steps must implement
xyz.malkki.microservicetest.testexecution.TestStepCodeinterface - Create
.ymlfile totestsuites/resource directory which lists available tests
test-suites:
- id: mosquitto
name: Test Mosquitto
dependencies: #List IDs of the services that are needed for the test
- mosquitto
steps: #Steps that the test uses. Steps are executed in the order that they are listed
- start-mqtt
- stop-mqttParametrized test steps help reusing code for commong operations such as executing SQL files. Parametrized test steps can be created by implementing xyz.malkki.microservicetest.testexecution.ParametrizedTestStepCode interface. Parameters can be set in the test step YAML-file with the parameters object.
There are currently two parametrized test steps included with the tool:
xyz.malkki.microservicetest.teststeps.ExecuteSqlTestStep- Executes SQL code from resource
- Parameters:
connectionString: connection string to the database. Hostname and port are automatically changed to use the hostname and the port of the container.sqlResource: name of the resource, which contains the SQL code
xyz.malkki.microservicetest.teststeps.WaitTestStep- Waits the specified amount of time
- Parameters:
millis: Amount of milliseconds to wait