If you develop services using Spring Boot and maybe Spring Cloud and you domedium sized tests during build process, then this set ofSpring Boot auto-configurations might be handy. By adding module into classpath, you will get stateful service,like Couchbase or Kafka, auto-started and available for connection from your application service w/o wiring anyadditional code. Docker and TestContainers are used tobootstrap stateful service using Spring Cloud bootstrap phase.Usage of Spring Cloud in your production code is optional, but you will need it in tests. See How to use below.

1. Install Docker on your machine

2. Make sure you have Spring Boot and Spring Cloud in classpath of your tests.In case if you need to pick version.

   pom.xml

   <project>
   ...
         <dependency>
               <groupId>org.springframework.cloud</groupId>
               <artifactId>spring-cloud-starter-bootstrap</artifactId>
               <!-- https://mvnrepository.com/artifact/org.springframework.cloud/spring-cloud-starter-bootstrap -->
               <version>[pick version]</version>
           </dependency>
   ...
   </project>

   Note

   testcontainers-spring-boot project migrated to Spring Boot 2.4 in 2.0.0 version.Please note, that in order to use this project with Spring Boot 2.4, you need to use spring-cloud-starter-bootstrap dependency.For earlier Spring Boot (prior to 2.4) users — you need to use spring-cloud-starter dependency instead.

3. If you do not use Spring Cloud - make it work for tests only:

   pom.xml

   <project>
   ...
           <dependency>
               <groupId>org.springframework.boot</groupId>
               <artifactId>spring-boot-starter</artifactId>
               <!-- https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter -->
               <version>[pick version]</version>
           </dependency>
           <dependency>
               <groupId>org.springframework.cloud</groupId>
               <artifactId>spring-cloud-starter-bootstrap</artifactId>
               <!-- https://mvnrepository.com/artifact/org.springframework.cloud/spring-cloud-starter-bootstrap -->
               <version>[pick version]</version>
               <scope>test</scope>
           </dependency>
   ...
   </project>

4. Add data service library:

   pom.xml

   <project>
   ...
           <dependency>
               <groupId>com.playtika.testcontainers</groupId>
               <artifactId>embedded-kafka</artifactId>
               <!-- https://mvnrepository.com/artifact/com.playtika.testcontainers/ -->
               <version>[pick version]</version>
               <scope>test</scope>
           </dependency>
   ...
   </project>

5. Use produced properties in your configuration.

   Example:

   /src/test/resources/application.properties

   spring.kafka.bootstrap-servers=${embedded.kafka.brokerList}

   /src/test/resources/bootstrap.properties

   embedded.kafka.topicsToCreate=some_topic

• Testing Strategies in a Microservice Architecture

• Functional Testing in Spring Boot Using Docker in Tests

• Functional tests best practices sample repo

• Spring Boot Microservices Integration Testing

• Easy Integration Testing With Testcontainers

• SpringBoot Integration Testing using TestContainers Starter

• Easy way to test Spring Boot microservices

Shutdown of embedded containers on spring application shutdown immediately

embedded.containers.forceShutdown=true //default is false

Disables all embedded containers

embedded.containers.enabled=true //default is true

Other specific container related properties

embedded.redis.filesToInclude:
  classpathResource: "/my_local_file.txt"
  containerPath: "/etc/path_in_container.txt"

embedded.postgresql.mountVolumes:
  hostPath: "pgdata"
  containerPath: "/var/lib/postgresql/data"
  mode: READ_WRITE

embedded-mariadb

embedded-couchbase

embedded-kafka

embedded-rabbitmq

embedded-aerospike

embedded-memsql

embedded-redis

embedded-neo4j

embedded-postgresql

embedded-elasticsearch

embedded-dynamodb

embedded-voltdb

embedded-minio

embedded-mongodb

embedded-google-pubsub

embedded-keycloak

embedded-influxdb

embedded-vault

embedded-oracle-xe

embedded-mysql

embedded-localstack

embedded-cassandra

embedded-clickhouse

embedded-pulsar

embedded-vertica

embedded-prometheus

embedded-grafana

embedded-consul

embedded-artifactory

Flow

Checklist for contributing new module

• Release build is done using gitflow-maven-plugin

• Release is done per each major change, critical bug

• Release can be done by contributor request

• Contacts to start release:

  • obevzenko@playtika.com

  • ivasylyev@playtika.com

  • asmirnova@playtika.com