Skip to content

Normalize image names in prefix substitutor #8509

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
findepi wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Normalize image names in prefix substitutor #8509

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
2 changes: 1 addition & 1 deletion core/src/main/java/org/testcontainers/utility/DockerImageName.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ public final class DockerImageName {

private static final Pattern REPO_NAME = Pattern.compile(REPO_NAME_PART + "(/" + REPO_NAME_PART + ")*");

private static final String LIBRARY_PREFIX = "library/";
static final String LIBRARY_PREFIX = "library/";

private final String rawName;

Expand Down
26 changes: 23 additions & 3 deletions core/src/main/java/org/testcontainers/utility/PrefixingImageNameSubstitutor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ final class PrefixingImageNameSubstitutor extends ImageNameSubstitutor {
@VisibleForTesting
static final String PREFIX_PROPERTY_KEY = "hub.image.name.prefix";

@VisibleForTesting
static final String NORMALIZE_PROPERTY_KEY = "hub.image.name.normalize";

private TestcontainersConfiguration configuration = TestcontainersConfiguration.getInstance();

@VisibleForTesting
Expand All @@ -26,6 +29,9 @@ final class PrefixingImageNameSubstitutor extends ImageNameSubstitutor {
@Override
public DockerImageName apply(DockerImageName original) {
final String configuredPrefix = configuration.getEnvVarOrProperty(PREFIX_PROPERTY_KEY, "");
final boolean normalize = Boolean.parseBoolean(
configuration.getEnvVarOrProperty(NORMALIZE_PROPERTY_KEY, "false")
);

if (configuredPrefix.isEmpty()) {
log.debug("No prefix is configured");
Expand All @@ -38,13 +44,27 @@ public DockerImageName apply(DockerImageName original) {
return original;
}

log.debug("Applying changes to image name {}: applying prefix '{}'", original, configuredPrefix);
log.debug(
"Applying changes to image name {}: applying prefix '{}' with normalization: {}",
original,
configuredPrefix,
normalize
);

DockerImageName prefixAsImage = DockerImageName.parse(configuredPrefix);

return original
String repository = original.getRepository();
if (normalize && !repository.contains("/")) {
repository = DockerImageName.LIBRARY_PREFIX + repository;
}

DockerImageName substituted = original
.withRegistry(prefixAsImage.getRegistry())
.withRepository(prefixAsImage.getRepository() + original.getRepository());
.withRepository(prefixAsImage.getRepository() + repository);
if (normalize) {
substituted = substituted.asCompatibleSubstituteFor(original);
}
return substituted;
}

@Override
Expand Down
15 changes: 15 additions & 0 deletions core/src/test/java/org/testcontainers/utility/PrefixingImageNameSubstitutorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,21 @@ public void testHappyPath() {
.isEqualTo("someregistry.com/our-mirror/some/image:tag");
}

@Test
public void testNormalizeToLibraryPath() {
when(mockConfiguration.getEnvVarOrProperty(eq(PrefixingImageNameSubstitutor.PREFIX_PROPERTY_KEY), any()))
.thenReturn("someregistry.com/our-mirror/");
when(mockConfiguration.getEnvVarOrProperty(eq(PrefixingImageNameSubstitutor.NORMALIZE_PROPERTY_KEY), any()))
.thenReturn("true");

final DockerImageName result = underTest.apply(DockerImageName.parse("image:tag"));

assertThat(result.asCanonicalNameString())
.as("The prefix is applied")
.isEqualTo("someregistry.com/our-mirror/library/image:tag");
result.assertCompatibleWith(DockerImageName.parse("image:tag"));
}

@Test
public void hubIoRegistryIsNotChanged() {
when(mockConfiguration.getEnvVarOrProperty(eq(PrefixingImageNameSubstitutor.PREFIX_PROPERTY_KEY), any()))
Expand Down
7 changes: 7 additions & 0 deletions docs/features/image_name_substitution.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,13 @@ Testcontainers will not apply the prefix to:
* non-Hub image names (e.g. where another registry is set)
* Docker Hub image names where the hub registry is explicitly part of the name (i.e. anything with a `docker.io` or `registry.hub.docker.com` host part)

If you want your registry to handle both official Docker Hub images (e.g `postgres`)
as well as images from other registries (e.g `mycompany/postgres`), you can use the
`TESTCONTAINERS_HUB_IMAGE_NAME_NORMALIZE` environment variable or the `hub.image.name.normalize`
configuration option. When set to `true`, Testcontainers will normalize the official Docker Hub
image names to start with `library/`. When this option is used, Testcontainers will additionally
disable image compatibility checks done by some containers, so it the compatibility responsibility
is on the user.


## Developing a custom function for transforming image names on the fly
Expand Down