Chapter 1: Introduction to YugabyteDB and Spring Boot

In this guide, we will illustrate how to set up a straightforward integration testing environment for YugabyteDB using Spring Boot and Testcontainers. Testcontainers is an innovative tool that simplifies the process of creating Docker images specifically for testing, with a focus on its use for testing interactions with the Yugabyte database.

The DBConnectionProvider Class

The DBConnectionProvider.java class is responsible for managing database connections and implements the DbConnection interface:

public class DBConnectionProvider implements DBConnection {

private final String url;

private final String username;

private final String password;

public DBConnectionProvider(String url, String username, String password) {

this.url = url;

this.username = username;

this.password = password;

}

@Override

public Connection getConnection() {

try {

return DriverManager.getConnection(url, username, password);

} catch (Exception e) {

throw new RuntimeException(e);

}

}

}

The CustomerService Class

The Customer.java class defines a Customer object, while CustomerService.java manages customer-related operations. The CustomerService constructor takes an instance of DbConnection, which is assigned to a private variable:

public CustomerService(DBConnection dbConnection) {

this.dbConnection = dbConnection;

}

The methods getCustomer() and createCustomer() utilize the Connection object to select and insert data into the Customer table, respectively.

The Tests

The CustomerServiceTest class contains three tests. Here, we use several annotations:

@SpringBootTest

@Testcontainers

@TestMethodOrder(MethodOrderer.MethodName.class)

class CustomerServiceTest {

The @SpringBootTest annotation enables Spring Boot's testing support, while @Testcontainers integrates Testcontainers for managing Docker containers during tests. The @TestMethodOrder(MethodOrderer.MethodName.class) annotation ensures that tests run in alphabetical order based on their method names.

We also initialize some variables:

static YugabyteDBYSQLContainer yugabyteDBYSQLContainer = new YugabyteDBYSQLContainer("yugabytedb/yugabyte:latest")

.waitingFor(Wait.defaultWaitStrategy());

This establishes a static variable representing a YugabyteDBYSQLContainer instance from Testcontainers.

Running the Tests

To build the project without executing tests, run the following command in the project directory:

mvn clean spring-boot:run -DskipTests

The anticipated output will be:

[INFO] ------------------------------------------------------------------------

[INFO] BUILD SUCCESS

[INFO] ------------------------------------------------------------------------

[INFO] Total time: 4.265 s

[INFO] Finished at: 2024-03-23T14:35:00Z

[INFO] ------------------------------------------------------------------------

Now, let's run just the tests:

mvn test -Dtest="CustomerServiceTest"

Expected output:

[INFO] Tests run: 3, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 16.86 s -- in com.example.yugabytedbtestcontainersspringboot.CustomerServiceTest

[INFO]

[INFO] Results:

[INFO]

[INFO] Tests run: 3, Failures: 0, Errors: 0, Skipped: 0

[INFO] ------------------------------------------------------------------------

[INFO] BUILD SUCCESS

[INFO] ------------------------------------------------------------------------

[INFO] Total time: 18.925 s

[INFO] Finished at: 2024-03-23T14:36:14Z

[INFO] ------------------------------------------------------------------------

Observing the Logs

Monitor the logs carefully to follow the process, including compatibility checks for the Docker version and the container's readiness:

14:36:00.027 [main] INFO org.testcontainers.utility.RyukResourceReaper -- Ryuk started - will monitor and terminate Testcontainers containers on JVM exit

...

Running the Tests with Docker

To simultaneously build and run the tests, execute:

mvn clean package

Chapter 2: Video Demonstrations

This video titled "Spring Boot Testcontainers - Integration Testing made easy!" provides a practical overview of using Testcontainers for integration testing with Spring Boot.

The second video, "Spring Boot Testing part 2: Integration Testing with Testcontainers," delves deeper into effective testing strategies with Spring Boot and Testcontainers.