JarCastingquarkus-testcontainers
Quarkus Testcontainers extension
Build and tests
- Build project, run the unit test and build:
- mvn clean package (1)
- Build the docker image
- docker build
- Run the integration test
- mvn failsafe:integration-test failsafe:verify
- Push the docker image
- docker push
(1) build native image with a docker image or with install GraalVM
- mvn clean package -Pnative -Dquarkus.native.container-build=true
- mvn clean package -Pnative
How to write the tests
Add this maven test dependency to the project.
<dependency>
<groupId>org.lorislab.quarkus</groupId>
<artifactId>quarkus-testcontainers</artifactId>
<version>0.9.0</version>
<scope>test</scope>
</dependency>
Create abstract test class which will set up the docker test environment. The default location of the docker compose file is src/test/resources/docker-compose.yaml For example:
version: "2"
services:
quarkus-postgres:
container_name: quarkus-postgres
image: postgres:10.5
environment:
POSTGRES_DB: "test"
POSTGRES_USER: "test"
POSTGRES_PASSWORD: "test"
labels:
- "test.Wait.forLogMessage.regex=.*database system is ready to accept connections.*\\s"
- "test.Wait.forLogMessage.times=2"
- "test.log=true"
- "test.property.quarkus.datasource.url=jdbc:postgresql://$${host:quarkus-postgres}:$${port:quarkus-postgres:5432}/p6?sslmode=disable"
ports:
- "5432:5432"
networks:
- test
quarkus-test:
container_name: quarkus-test
image: quarkus-test:latest
ports:
- "8080:8080"
labels:
- "test.unit=false"
- "test.priority=101"
- "test.image.pull=DEFAULT"
- "test.property.quarkus.http.test-port=$${port:quarkus-test:8080}"
- "test.env.QUARKUS_DATASOURCE_URL=jdbc:postgresql://quarkus-postgres:5432/test?sslmode=disable"
networks:
- test
networks:
test:
For integration test we set up quarkus.http.test-port=$${port:quarkus-test:8080} the Quarkus test port.
Java code
We need to add these annotations to the AbstractTest class:
@QuarkusTestResource(DockerComposeTestResource.class)this annotation will start the docker test environment for unit tests.@QuarkusTestcontainersthis annotation will start the docker test environment and disable start of the native image for integration test@NativeImageTest.
import io.quarkus.test.common.QuarkusTestResource;
import io.restassured.RestAssured;
import org.junit.jupiter.api.BeforeEach;
import org.lorislab.quarkus.testcontainers.DockerComposeService;
import org.lorislab.quarkus.testcontainers.DockerService;
import org.lorislab.quarkus.testcontainers.DockerComposeTestResource;
import org.lorislab.quarkus.testcontainers.QuarkusTestcontainers;
@QuarkusTestcontainers
@QuarkusTestResource(DockerComposeTestResource.class)
public abstract class AbstractTest {
}
Unit test
@QuarkusTest
public class DeploymentRestControllerTest extends AbstractTest {
@Test public void unitTest() { }
}
Integration test
import org.lorislab.quarkus.testcontainers.DockerComposeTest;
@NativeImageTest
public class DeploymentRestControllerTestIT extends DeploymentRestControllerTest {
@Test public void integrationTest() { }
}
Maven setup
Unit and integration test maven plugin
<plugin>
<artifactId>maven-surefire-plugin</artifactId>
<version>${surefire-plugin.version}</version>
<configuration>
<systemProperties>
<java.util.logging.manager>org.jboss.logmanager.LogManager</java.util.logging.manager>
</systemProperties>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-failsafe-plugin</artifactId>
<version>${surefire-plugin.version}</version>
</plugin>
Docker labels
| label | values | default | description |
|---|---|---|---|
| test.integration=true | boolean |
true |
enable the docker for the integration test |
| test.unit=true | boolean |
true |
enable the docker for the unit test |
| test.image.pull=DEFAULT | string |
DEFAULT,ALWAYS,MAX_AGE |
pull docker image before test |
| test.image.pull.max_age | string |
PT10 |
only for the MAX_AGE pull docker image before test if older than duration. Default: 10s |
| test.Wait.forLogMessage.regex= | string |
null |
regex of the WaitStrategy for log messages |
| test.Wait.forLogMessage.times=1 | int |
1 |
the number of times the pattern is expected in the WaitStrategy |
| test.Log=true | boolean |
true |
enabled log of the docker container |
| test.priority=100 | int |
100 |
start priority |
| test.property.{name}={value} | string |
null |
set the system property with and in the tests |
| test.env.{name}={value} | string |
null |
set the environment variable with and in the docker container |
The value of the test.property.* or test.env.* supported this syntax:
- simple value:
123result: 123 - host of the service:
$${host:<service>}the host of the service<service> - port of the service:
$${port:<service>:<port>}the port number of the<port>of the<service>service - url of the service:
$${url:<service>:<port>}the url of the servicehttp://<service>:<port> - system property:
$${prop:<name>} - environment variable:
${env:<name>}
Example:
test.property.quarkus.datasource.url=jdbc:postgresql://$${host:postgres}:$${port:postgres:5432}/p6?sslmode=disable
The system property quarkus.datasource.url will be set to jdbc:postgresql://localhost:125432/p6?sslmode=disable if the docker image host of the postgres is localhost and tet containers dynamic port ot the container port 5432 is set to 125432 value.
Docker test environment API
Docker test environment Java API
@DockerService("quarkus-test")
protected DockerComposeService app;
@BeforeEach
public void init() {
if (app != null) {
RestAssured.port = app.getPort(8080);
}
}
Deprecated setup 0.8.0 <=
import io.quarkus.test.common.QuarkusTestResource;
import io.restassured.RestAssured;
import org.junit.jupiter.api.BeforeEach;
import org.lorislab.quarkus.testcontainers.DockerComposeService;
import org.lorislab.quarkus.testcontainers.DockerService;
import org.lorislab.quarkus.testcontainers.DockerComposeTestResource;
@QuarkusTestResource(DockerComposeTestResource.class)
public abstract class AbstractTest {
@DockerService("quarkus-test")
protected DockerComposeService app;
@BeforeEach
public void init() {
if (app != null) {
RestAssured.port = app.getPort(8080);
}
}
}
Create a common test for unit and integration test
public class DeploymentRestControllerT extends AbstractTest {
@Test
public void deploymentTest() {
// ...
}
}
Unit test
@QuarkusTest
public class DeploymentRestControllerTest extends DeploymentRestControllerT {
}
Integration test
import org.lorislab.quarkus.testcontainers.DockerComposeTest;
@DockerComposeTest
public class DeploymentRestControllerTestIT extends DeploymentRestControllerT {
}
Maven settings
Unit test maven plugin
<plugin>
<artifactId>maven-surefire-plugin</artifactId>
<version>${surefire-plugin.version}</version>
<configuration>
<systemProperties>
<java.util.logging.manager>org.jboss.logmanager.LogManager</java.util.logging.manager>
</systemProperties>
</configuration>
</plugin>
Integration test maven plugin
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-failsafe-plugin</artifactId>
<version>${surefire-plugin.version}</version>
<executions>
<execution>
<id>native</id>
<goals>
<goal>integration-test</goal>
<goal>verify</goal>
</goals>
<phase>integration-test</phase>
</execution>
</executions>
<configuration>
<systemPropertyVariables>
<test.integration>true</test.integration>
</systemPropertyVariables>
</configuration>
</plugin>
The system property <test.integration>true</test.integration> activate the integration test.
How to release this project
Create new release run
mvn semver-release:release-create
Create new patch branch run
mvn semver-release:patch-create -DpatchVersion=X.X.0
