Test containers for database testing in JUnit - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a test container in database testing?

A test container is a lightweight, disposable instance of a database or service that runs in a container during tests. It helps create a real environment for testing without affecting the developer's machine or production data.

intermediate

Why use test containers instead of an in-memory database for testing?

Test containers run the actual database software in a container, providing a more realistic environment. In-memory databases may behave differently from real databases, so test containers catch issues that only appear in real setups.

intermediate

How do you start a PostgreSQL test container in JUnit 5?

You use the @Testcontainers annotation on the test class and define a static PostgreSQLContainer<?> field with @Container. The container starts before tests and stops after.

beginner

What is the benefit of using @Container annotation in JUnit tests?

The @Container annotation manages the lifecycle of the container automatically, starting it before tests and stopping it after, so you don't have to write manual setup or teardown code.

advanced

What should you consider about test container resource usage?

Test containers use system resources like CPU, memory, and disk. Running many containers or large databases can slow tests. It's good to reuse containers or limit parallel tests to keep tests fast.

What does a test container provide in database testing?

A A mock object for database calls

B An in-memory database simulation

C A real database instance running in a container

D A cloud-hosted database service

Test containers run the actual database software inside a container, providing a real instance for testing.

Which annotation in JUnit 5 is used to mark a test container field?

A @Container

B @TestContainer

C @Testcontainers

D @BeforeAll

The @Container annotation marks a container field to be managed by JUnit 5 lifecycle.

Why might test containers be preferred over in-memory databases?

A They use less memory

B They provide a real database environment

C They are faster to run

D They require no setup

Test containers run the real database software, giving a more accurate test environment.

What happens to a test container after the tests finish?

A It remains running for reuse

B It is converted to a permanent database

C It crashes intentionally

D It is stopped and removed automatically

Test containers are stopped and removed automatically to keep the environment clean.

Which of these is a common database supported by test containers?

A PostgreSQL

B Oracle Database

C Microsoft Access

D SQLite

PostgreSQL is widely supported and commonly used with test containers.

Explain how test containers improve database testing compared to traditional methods.

Think about how real environment and isolation help testing.

Describe the steps to set up a PostgreSQL test container in a JUnit 5 test class.

Focus on annotations and container lifecycle.

Practice

1. What is the main advantage of using Testcontainers for database testing in JUnit?

easy

A. It provides a real database environment isolated for each test run.

B. It replaces the need for any database in tests with mocks.

C. It automatically writes test cases for database queries.

D. It speeds up tests by using in-memory databases only.

Solution

1. Step 1: Understand what Testcontainers provide

   Testcontainers run real database instances inside containers, giving a fresh environment for each test.

2. Step 2: Compare with other options

   Mocks or in-memory databases do not provide real database behavior, and Testcontainers do not auto-generate tests.

3. Final Answer:

   It provides a real database environment isolated for each test run. -> Option A

4. Quick Check:

   Real isolated DB environment = A [OK]

Hint: Testcontainers run real DBs isolated per test [OK]

Common Mistakes:

• Thinking Testcontainers use mocks instead of real DBs
• Confusing Testcontainers with in-memory databases
• Believing Testcontainers auto-generate tests

2. Which of the following is the correct way to start a PostgreSQL container using Testcontainers in a JUnit test?

easy

A. PostgreSQLContainer postgres = new PostgreSQLContainer("latest:postgres").launch();

B. PostgreSQLContainer postgres = new PostgreSQLContainer("postgres:latest").run();

C. PostgreSQLContainer postgres = new PostgreSQLContainer("postgres").begin();

D. PostgreSQLContainer postgres = new PostgreSQLContainer<>("postgres:latest").start();

Solution

1. Step 1: Check the correct constructor and method

   The correct constructor uses the image name string and the generic type, and the container is started with start().

2. Step 2: Validate method names and image format

   Methods like run(), begin(), or launch() do not exist. The image name format must be "postgres:latest".

3. Final Answer:

   PostgreSQLContainer postgres = new PostgreSQLContainer<>("postgres:latest").start(); -> Option D

4. Quick Check:

   Use start() with correct image name [OK]

Hint: Use start() method with correct image name [OK]

Common Mistakes:

• Using wrong method names like run(), begin(), or launch()
• Incorrect image name format
• Omitting generic type parameter

3. Given the following JUnit test snippet using Testcontainers, what will be the output of System.out.println(postgres.getJdbcUrl());?

PostgreSQLContainer postgres = new PostgreSQLContainer<>("postgres:13-alpine").start();
System.out.println(postgres.getJdbcUrl());
postgres.stop();

medium

A. The literal string "postgres:13-alpine"

B. An error because getJdbcUrl() is not available

C. A JDBC URL string like jdbc:postgresql://localhost:randomPort/test

D. Null, because the container is stopped immediately

Solution

1. Step 1: Understand what getJdbcUrl() returns

   After starting, getJdbcUrl() returns the connection URL to the running container database.

2. Step 2: Check container lifecycle and output

   The container is started before printing, so the URL is valid. The container stops after printing, so output is not null or error.

3. Final Answer:

   A JDBC URL string like jdbc:postgresql://localhost:randomPort/test -> Option C

4. Quick Check:

   getJdbcUrl() after start() returns valid URL [OK]

Hint: Call getJdbcUrl() only after container start() [OK]

Common Mistakes:

• Calling getJdbcUrl() before start()
• Expecting literal image name as URL
• Assuming output is null after stop() immediately

4. Identify the error in this JUnit test using Testcontainers for MySQL:

@Test
void testDbConnection() {
  MySQLContainer mysql = new MySQLContainer("mysql:8.0");
  mysql.start();
  String url = mysql.getJdbcUrl();
  // Use url to connect
  mysql.stop();
  mysql.stop();
}

medium

A. Calling mysql.stop() twice causes an error.

B. Missing generic type parameter in MySQLContainer declaration.

C. Container must be started with run() instead of start().

D. The image name "mysql:8.0" is invalid.

Solution

1. Step 1: Check MySQLContainer declaration

   MySQLContainer is a generic class and should be declared with a wildcard: MySQLContainer<?>.

2. Step 2: Verify other parts

   Calling stop() twice is safe (idempotent). start() is correct method. Image name "mysql:8.0" is valid.

3. Final Answer:

   Missing generic type parameter in MySQLContainer declaration. -> Option B

4. Quick Check:

   Use MySQLContainer to avoid raw type warning [OK]

Hint: Always use generic type with Testcontainers classes [OK]

Common Mistakes:

• Calling stop() multiple times causes error
• Using run() instead of start()
• Incorrect image name format

5. You want to write a JUnit test that uses a PostgreSQL Testcontainer and runs a SQL script to initialize the database before tests. Which approach correctly achieves this?

hard

A. Use withInitScript("init.sql") on the PostgreSQLContainer instance before starting it.

B. Manually connect after start() and run the SQL script using JDBC in each test method.

C. Include the SQL script inside the Docker image and use a custom image name.

D. Start the container, then copy the SQL file into the container using copyFileToContainer() and run it manually.

Solution

1. Step 1: Identify Testcontainers feature for init scripts

   Testcontainers provide withInitScript() method to run SQL scripts automatically on container startup.

2. Step 2: Compare alternatives

   Manual JDBC execution or copying files is more complex and error-prone. Custom images are possible but not necessary for simple init scripts.

3. Final Answer:

   Use withInitScript("init.sql") on the PostgreSQLContainer instance before starting it. -> Option A

4. Quick Check:

   Use withInitScript() for automatic DB initialization [OK]

Hint: Use withInitScript() to auto-run SQL on container start [OK]

Common Mistakes:

• Running SQL manually in each test instead of init script
• Modifying Docker images unnecessarily
• Copying files manually instead of using built-in methods