Skip to content

fix: ignore container_name instead of failing #11940

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

Closed
ST-DDT wants to merge 1 commit into from
+23 −22
Closed

fix: ignore container_name instead of failing #11940

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
13 changes: 6 additions & 7 deletions core/src/main/java/org/testcontainers/containers/ParsedDockerComposeFile.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,13 +130,12 @@ private void parseAndValidate() {
}

private void validateNoContainerNameSpecified(String serviceName, Map<String, ?> serviceDefinitionMap) {
if (serviceDefinitionMap.containsKey("container_name")) {
throw new IllegalStateException(
String.format(
"Compose file %s has 'container_name' property set for service '%s' but this property is not supported by Testcontainers, consider removing it",
composeFileName,
serviceName
)
if (serviceDefinitionMap.remove("container_name") != null) {
log.warn(
"Compose file {} has 'container_name' property set for service '{}'. " +
"This property is not supported by Testcontainers and will be ignored.",
composeFileName,
serviceName
);
}
}
Expand Down
32 changes: 17 additions & 15 deletions core/src/test/java/org/testcontainers/containers/ParsedDockerComposeFileValidationTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
import java.io.PrintWriter;
import java.nio.file.Path;
import java.util.Collections;
import java.util.HashMap;

import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatNoException;
Expand All @@ -22,36 +23,37 @@ class ParsedDockerComposeFileValidationTest {
public Path temporaryFolder;

@Test
void shouldValidate() {
void shouldIgnoreContainerNameV1() {
File file = new File("src/test/resources/docker-compose-container-name-v1.yml");
assertThatThrownBy(() -> {
assertThatNoException()
.isThrownBy(() -> {
new ParsedDockerComposeFile(file);
})
.hasMessageContaining(file.getAbsolutePath())
.hasMessageContaining("'container_name' property set for service 'redis'");
});
}

@Test
void shouldRejectContainerNameV1() {
assertThatThrownBy(() -> {
new ParsedDockerComposeFile(ImmutableMap.of("redis", ImmutableMap.of("container_name", "redis")));
})
.hasMessageContaining("'container_name' property set for service 'redis'");
void shouldIgnoreContainerNameInMapV1() {
assertThatNoException()
.isThrownBy(() -> {
new ParsedDockerComposeFile(
ImmutableMap.of("redis", new HashMap<>(ImmutableMap.of("container_name", "redis")))
);
});
}

@Test
void shouldRejectContainerNameV2() {
assertThatThrownBy(() -> {
void shouldIgnoreContainerNameV2() {
assertThatNoException()
.isThrownBy(() -> {
new ParsedDockerComposeFile(
ImmutableMap.of(
"version",
"2",
"services",
ImmutableMap.of("redis", ImmutableMap.of("container_name", "redis"))
ImmutableMap.of("redis", new HashMap<>(ImmutableMap.of("container_name", "redis")))
)
);
})
.hasMessageContaining("'container_name' property set for service 'redis'");
});
}

@Test
Expand Down