mirror of
https://github.com/docker/docs.git
synced 2026-03-27 14:28:47 +07:00
## Description Migrate 17 Testcontainers guides from testcontainers.com into the Docker docs site, covering Java (14 guides), .NET (2 guides), and Node.js (1 guide). This follows up on PR #24450 which added the initial Go and Python guides. Each guide is converted from AsciiDoc to Hugo Markdown, split into multi-chapter stepper navigation, updated to the latest Testcontainers API, and verified with passing tests running in containers. Java guides use testcontainers-java 2.0.4 with the new 2.x Maven coordinates and package names (e.g., `testcontainers-postgresql`, `org.testcontainers.postgresql.PostgreSQLContainer`). The Quarkus guide uses Quarkus 3.22.3 with TC 1.x managed by the Quarkus BOM, since no released Quarkus version ships TC 2.x yet. ## How to test All code snippets have been verified by running each guide's source repository tests inside Docker containers with the Docker socket mounted. To re-run the verification, use the `/testcontainers-guides-migrator` skill included in this PR (`.claude/skills/testcontainers-guides-migrator/SKILL.md`). The skill's Step 6 documents the exact container commands and macOS Docker Desktop workarounds (host override, docker-java API version, etc.) needed to run each language's tests: ``` /testcontainers-guides-migrator I want you to verify all the guides in this branch. Do a full review, verifying that all code snippets compile, the code is executable, and ALL the tests pass. Run them as docker containers, never locally. ``` ## Related issues or tickets Supersedes #24450 (expanded from 2 guides to all 19) ## Reviews - [ ] Technical review - [ ] Editorial review - [ ] Product review --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
93 lines
2.8 KiB
Markdown
93 lines
2.8 KiB
Markdown
---
|
|
title: JUnit 5 lifecycle callbacks
|
|
linkTitle: Lifecycle callbacks
|
|
description: Manage Testcontainers container lifecycle using JUnit 5 @BeforeAll and @AfterAll callbacks.
|
|
weight: 20
|
|
---
|
|
|
|
When testing with Testcontainers, you want to start the required containers
|
|
before executing any tests and remove them afterwards. You can use JUnit 5
|
|
`@BeforeAll` and `@AfterAll` lifecycle callback methods for this:
|
|
|
|
```java
|
|
package com.testcontainers.demo;
|
|
|
|
import static org.junit.jupiter.api.Assertions.assertEquals;
|
|
import static org.junit.jupiter.api.Assertions.assertTrue;
|
|
|
|
import java.util.List;
|
|
import java.util.Optional;
|
|
import org.junit.jupiter.api.AfterAll;
|
|
import org.junit.jupiter.api.BeforeAll;
|
|
import org.junit.jupiter.api.BeforeEach;
|
|
import org.junit.jupiter.api.Test;
|
|
import org.testcontainers.postgresql.PostgreSQLContainer;
|
|
|
|
class CustomerServiceWithLifeCycleCallbacksTest {
|
|
|
|
static PostgreSQLContainer postgres = new PostgreSQLContainer(
|
|
"postgres:16-alpine"
|
|
);
|
|
|
|
CustomerService customerService;
|
|
|
|
@BeforeAll
|
|
static void startContainers() {
|
|
postgres.start();
|
|
}
|
|
|
|
@AfterAll
|
|
static void stopContainers() {
|
|
postgres.stop();
|
|
}
|
|
|
|
@BeforeEach
|
|
void setUp() {
|
|
customerService =
|
|
new CustomerService(
|
|
postgres.getJdbcUrl(),
|
|
postgres.getUsername(),
|
|
postgres.getPassword()
|
|
);
|
|
customerService.deleteAllCustomers();
|
|
}
|
|
|
|
@Test
|
|
void shouldCreateCustomer() {
|
|
customerService.createCustomer(new Customer(1L, "George"));
|
|
|
|
Optional<Customer> customer = customerService.getCustomer(1L);
|
|
assertTrue(customer.isPresent());
|
|
assertEquals(1L, customer.get().id());
|
|
assertEquals("George", customer.get().name());
|
|
}
|
|
|
|
@Test
|
|
void shouldGetCustomers() {
|
|
customerService.createCustomer(new Customer(1L, "George"));
|
|
customerService.createCustomer(new Customer(2L, "John"));
|
|
|
|
List<Customer> customers = customerService.getAllCustomers();
|
|
assertEquals(2, customers.size());
|
|
}
|
|
}
|
|
```
|
|
|
|
Here's what the code does:
|
|
|
|
- `PostgreSQLContainer` is declared as a **static field**. The container starts
|
|
before all tests and stops after all tests in this class.
|
|
- `@BeforeAll` starts the container, `@AfterAll` stops it.
|
|
- `@BeforeEach` initializes `CustomerService` with the container's JDBC
|
|
parameters and deletes all rows to give each test a clean database.
|
|
|
|
Key observations:
|
|
|
|
- Because the container is a **static field**, it's shared across all test
|
|
methods in the class. You can declare it as a non-static field and use
|
|
`@BeforeEach`/`@AfterEach` to start a new container per test, but this
|
|
isn't recommended as it's resource-intensive.
|
|
- Even without explicitly stopping the container in `@AfterAll`, Testcontainers
|
|
uses the [Ryuk container](https://github.com/testcontainers/moby-ryuk) to
|
|
clean up containers automatically when the JVM exits.
|