Skip to content

Ensure graceful shutdown in GenericContainer.stop() (#10365) #11350

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
taole33 wants to merge 1 commit into
base: main
Choose a base branch
from
+46 −1
Draft

Ensure graceful shutdown in GenericContainer.stop() (#10365) #11350

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion core/src/main/java/org/testcontainers/containers/GenericContainer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -647,7 +647,11 @@ public void stop() {
} catch (Exception e) {
imageName = "<unknown>";
}

try {
dockerClient.stopContainerCmd(containerId).exec();
} catch (Exception e) {
logger().warn("Failed to stop container gracefully: {}", e.getMessage());
}
containerIsStopping(containerInfo);
ResourceReaper.instance().stopAndRemoveContainer(containerId, imageName);
containerIsStopped(containerInfo);
Expand Down
41 changes: 41 additions & 0 deletions core/src/test/java/org/testcontainers/containers/GenericContainerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
import org.rnorth.ducttape.unreliables.Unreliables;
import org.testcontainers.DockerClientFactory;
import org.testcontainers.TestImages;
import org.testcontainers.containers.output.ToStringConsumer;
import org.testcontainers.containers.startupcheck.StartupCheckStrategy;
import org.testcontainers.containers.wait.strategy.AbstractWaitStrategy;
import org.testcontainers.containers.wait.strategy.LogMessageWaitStrategy;
Expand Down Expand Up @@ -336,6 +337,46 @@ private static Optional<String> reportLeakedContainers() {
);
}

@Test
public void testPostHookExecutionOnStop() {
String scriptContent =
"#!/bin/bash\n" +
"function on_shutdown() {\n" +
" echo 'HOOK_TRIGGERED'\n" +
"}\n" +
"trap on_shutdown SIGTERM SIGINT EXIT\n" +
"echo 'CONTAINER_STARTED'\n" +
"while true; do sleep 1; done\n";

ToStringConsumer logConsumer = new ToStringConsumer();

try (
GenericContainer<?> container = new GenericContainer<>(
new ImageFromDockerfile()
.withFileFromString("entrypoint.sh", scriptContent)
.withDockerfileFromBuilder(builder -> {
builder
.from("alpine:3.18")
.run("apk add --no-cache tini bash")
.copy("entrypoint.sh", "/entrypoint.sh")
.run("chmod +x /entrypoint.sh")
.entryPoint("/sbin/tini", "--", "/entrypoint.sh")
.build();
})
)
.withLogConsumer(logConsumer)
.waitingFor(Wait.forLogMessage(".*CONTAINER_STARTED.*", 1))
) {
container.start();

container.stop();

assertThat(logConsumer.toUtf8String())
.as("The shutdown hook defined in 'trap' should be executed upon container stop")
.contains("HOOK_TRIGGERED");
}
}

static class NoopStartupCheckStrategy extends StartupCheckStrategy {

@Override
Expand Down