playtikaoss/testcontainers-spring-boot

The module supports both Jedis and Lettuce drivers. Spring Boot will automatically configure the connection factory based on which driver is present on your classpath:

1. Jedis: Synchronous client. Selected by default if Jedis is on the classpath.
2. Lettuce: Asynchronous/reactive client. Supports cluster mode.

To explicitly force the use of Lettuce, set the following property: spring.data.redis.client-type=lettuce.

The module ensures that LettuceConnectionFactory and JedisConnectionFactory beans are correctly ordered to depend on the embedded Redis container startup.

This module enforces the use of Durable Deletes to prevent 'zombie records' (records that reappear after a reboot because they were removed from the index but not from the disk).

To achieve this, the module configures the Aerospike server with the disallow-expunge option.

Consequence for Developers: If your client code attempts a delete operation without explicitly setting WritePolicy.durableDeletes to true, the operation will fail with Aerospike Error 22 (forbidden).

The browser used is determined by the Docker image specified in embedded.selenium.docker-image. Use the corresponding standalone image for your required browser:

|= | Browser | Image | Chrome | selenium/standalone-chrome:4.x.x | Firefox | selenium/standalone-firefox:4.x.x | Edge | selenium/standalone-edge:4.x.x |=

If you enable embedded.toxiproxy.proxies.mariadb.enabled, the module will create a ToxiProxy TCP proxy for the MariaDB container. This allows you to simulate network latency, jitter, or connection failures in your tests.

In addition to the properties listed in the reference guide, the module provides a Spring Bean of type ToxiproxyClientProxy named mariadbContainerProxy which you can inject into your tests to manipulate the proxy.

By default, NATS runs without security. To enable features like JetStream or specific authentication, you have two options:

1. Via Properties: Use embedded.nats.command to pass flags directly to the NATS binary (e.g., embedded.nats.command=--jetstream).
2. Via Bean Customization: Inject the NatsContainer bean and configure it before the Spring context starts.

If you enable embedded.toxiproxy.proxies.db2.enabled, the library will create a container with a ToxiProxy TCP proxy and provide a proxy to the embedded-db2 container. This allows you to simulate network latency or failures.

In addition to the properties listed above, a bean of type ToxiproxyClientProxy named db2ContainerProxy will be available in the Spring context.

To use the embedded DB2 Testcontainer support in your Spring Boot project, add the following dependency to your pom.xml with test scope:

<dependency>
    <groupId>com.playtika.testcontainers</groupId>
    <artifactId>embedded-db2</artifactId>
    <scope>test</scope>
</dependency>

To use the embedded Artifactory module in your Spring Boot tests, add the following dependency to your pom.xml with test scope:

<dependency>
    <groupId>com.playtika.testcontainers</groupId>
    <artifactId>embedded-artifactory</artifactId>
    <scope>test</scope>
</dependency>

To use the embedded K3s functionality in your Spring Boot tests, add the embedded-k3s artifact to your pom.xml with test scope.

<dependency>
    <groupId>com.playtika.testcontainers</groupId>
    <artifactId>embedded-k3s</artifactId>
    <scope>test</scope>
</dependency>

To use the embedded Vault functionality in your tests, add the embedded-vault dependency to your pom.xml with test scope.

<dependency>
    <groupId>com.playtika.testcontainers</groupId>
    <artifactId>embedded-vault</artifactId>
    <scope>test</scope>
</dependency>

To use the embedded NATS container in your Spring Boot tests, add the following dependency to your pom.xml with test scope:

<dependency>
    <groupId>com.playtika.testcontainers</groupId>
    <artifactId>embedded-nats</artifactId>
    <scope>test</scope>
</dependency>

Use embedded.grafana.filesToInclude to copy classpath resources into the container at startup. This is the standard way to provision custom datasources, dashboards, or alert rules.

Each entry requires a classpathResource (the source in your project) and a containerPath (the destination inside the Grafana container).

embedded:
  grafana:
    filesToInclude:
      - classpathResource: /embedded/grafana/provisioning/datasources/my-datasource.yml
        containerPath: /etc/grafana/provisioning/datasources/my-datasource.yml