Skip to content

Ignore container_name in docker-compose files instead of throwing exception #11376

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

Open
ranjitm2001 wants to merge 1 commit into
base: main
Choose a base branch
from
+20 −22
Open

Ignore container_name in docker-compose files instead of throwing exception #11376

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
11 changes: 5 additions & 6 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 @@ -131,12 +131,11 @@ 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
)
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
31 changes: 15 additions & 16 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 @@ -22,36 +22,35 @@ class ParsedDockerComposeFileValidationTest {
public Path temporaryFolder;

@Test
void shouldValidate() {
void shouldIgnoreContainerNameV1() {
File file = new File("src/test/resources/docker-compose-container-name-v1.yml");
assertThatThrownBy(() -> {
new ParsedDockerComposeFile(file);
})
.hasMessageContaining(file.getAbsolutePath())
.hasMessageContaining("'container_name' property set for service 'redis'");
// container_name should be ignored (with a warning log) instead of throwing an exception
assertThatNoException().isThrownBy(() -> new ParsedDockerComposeFile(file));
}

@Test
void shouldRejectContainerNameV1() {
assertThatThrownBy(() -> {
new ParsedDockerComposeFile(ImmutableMap.of("redis", ImmutableMap.of("container_name", "redis")));
})
.hasMessageContaining("'container_name' property set for service 'redis'");
void shouldIgnoreContainerNameInMapV1() {
// container_name should be ignored (with a warning log) instead of throwing an exception
assertThatNoException()
.isThrownBy(() ->
new ParsedDockerComposeFile(ImmutableMap.of("redis", ImmutableMap.of("container_name", "redis")))
);
}

@Test
void shouldRejectContainerNameV2() {
assertThatThrownBy(() -> {
void shouldIgnoreContainerNameV2() {
// container_name should be ignored (with a warning log) instead of throwing an exception
assertThatNoException()
.isThrownBy(() ->
new ParsedDockerComposeFile(
ImmutableMap.of(
"version",
"2",
"services",
ImmutableMap.of("redis", ImmutableMap.of("container_name", "redis"))
)
);
})
.hasMessageContaining("'container_name' property set for service 'redis'");
)
);
}

@Test
Expand Down