org.testcontainers.utility.PrefixingImageNameSubstitutor Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of testcontainers Show documentation

Isolated container management for Java code testing

The newest version!

package org.testcontainers.utility;

import com.google.common.annotations.VisibleForTesting;
import lombok.NoArgsConstructor;
import lombok.extern.slf4j.Slf4j;

/**
 * An {@link ImageNameSubstitutor} which applies a prefix to all image names, e.g. a private registry host and path.
 * The prefix may be set via an environment variable (TESTCONTAINERS_HUB_IMAGE_NAME_PREFIX) or an equivalent
 * configuration file entry (see {@link TestcontainersConfiguration}).
 */
@NoArgsConstructor
@Slf4j
final class PrefixingImageNameSubstitutor extends ImageNameSubstitutor {

    @VisibleForTesting
    static final String PREFIX_PROPERTY_KEY = "hub.image.name.prefix";

    private TestcontainersConfiguration configuration = TestcontainersConfiguration.getInstance();

    @VisibleForTesting
    PrefixingImageNameSubstitutor(final TestcontainersConfiguration configuration) {
        this.configuration = configuration;
    }

    @Override
    public DockerImageName apply(DockerImageName original) {
        final String configuredPrefix = configuration.getEnvVarOrProperty(PREFIX_PROPERTY_KEY, "");

        if (configuredPrefix.isEmpty()) {
            log.debug("No prefix is configured");
            return original;
        }

        boolean isAHubImage = original.getRegistry().isEmpty();
        if (!isAHubImage) {
            log.debug("Image {} is not a Docker Hub image - not applying registry/repository change", original);
            return original;
        }

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

        DockerImageName prefixAsImage = DockerImageName.parse(configuredPrefix);

        return original
            .withRegistry(prefixAsImage.getRegistry())
            .withRepository(prefixAsImage.getRepository() + original.getRepository());
    }

    @Override
    protected String getDescription() {
        return getClass().getSimpleName();
    }
}