Replace deprecated checkAndPullImage with RemoteDockerImage (#5148)

* Replace deprecated `checkAndPullImage` with `RemoteDockerImage`

* fix `runCommandInsideDockerShouldNotFailIfImageDoesNotExistsLocally`

* Remove `LoggerFactory` usage

* avoid name substitution in `DockerComposeContainer`/`ImageFromDockerfile`

* fix `AuthenticatedImagePullTest`

* remove accidential `@Ignore`

* fix indentation

* put `clearCache` after `catch()`

Author: bsideup

core/src/main/java/org/testcontainers/DockerClientFactory.java

@@ -25,10 +25,10 @@
 import org.testcontainers.dockerclient.DockerClientProviderStrategy;
 import org.testcontainers.dockerclient.DockerMachineClientProviderStrategy;
 import org.testcontainers.dockerclient.TransportConfig;
+import org.testcontainers.images.RemoteDockerImage;
 import org.testcontainers.images.TimeLimitedLoggedPullImageResultCallback;
 import org.testcontainers.utility.ComparableVersion;
 import org.testcontainers.utility.DockerImageName;
-import org.testcontainers.utility.ImageNameSubstitutor;
 import org.testcontainers.utility.MountableFile;
 import org.testcontainers.utility.ResourceReaper;
 import org.testcontainers.utility.RyukResourceReaper;
@@ -236,7 +236,6 @@ public void close() {
                     checkDiskSpace(client, ryukContainerId);
                 } else {
                     runInsideDocker(
-                        client,
                         createContainerCmd -> {
                             createContainerCmd.withName("testcontainers-checks-" + SESSION_ID);
                             createContainerCmd.getHostConfig().withAutoRemove(true);
@@ -335,9 +334,12 @@ private boolean checkMountableFile() {
     }
 
     /**
-   * Check whether the image is available locally and pull it otherwise
-   */
+     * Check whether the image is available locally and pull it otherwise
+     *
+     * @deprecated use {@link RemoteDockerImage}
+     */
     @SneakyThrows
+    @Deprecated
     public void checkAndPullImage(DockerClient client, String image) {
         try {
             client.inspectImageCmd(image).exec();
@@ -363,18 +365,14 @@ public String dockerHostIpAddress() {
     }
 
     public <T> T runInsideDocker(Consumer<CreateContainerCmd> createContainerCmdConsumer, BiFunction<DockerClient, String, T> block) {
-        // We can't use client() here because it might create an infinite loop
-        return runInsideDocker(getOrInitializeStrategy().getDockerClient(), createContainerCmdConsumer, block);
+        return runInsideDocker(TINY_IMAGE, createContainerCmdConsumer, block);
     }
 
-    private <T> T runInsideDocker(DockerClient client, Consumer<CreateContainerCmd> createContainerCmdConsumer, BiFunction<DockerClient, String, T> block) {
-
-        final String tinyImage = ImageNameSubstitutor.instance().apply(TINY_IMAGE).asCanonicalNameString();
-
-        checkAndPullImage(client, tinyImage);
+    <T> T runInsideDocker(DockerImageName imageName, Consumer<CreateContainerCmd> createContainerCmdConsumer, BiFunction<DockerClient, String, T> block) {
+        RemoteDockerImage dockerImage = new RemoteDockerImage(imageName);
         HashMap<String, String> labels = new HashMap<>(DEFAULT_LABELS);
         labels.putAll(ResourceReaper.instance().getLabels());
-        CreateContainerCmd createContainerCmd = client.createContainerCmd(tinyImage)
+        CreateContainerCmd createContainerCmd = client.createContainerCmd(dockerImage.get())
                 .withLabels(labels);
         createContainerCmdConsumer.accept(createContainerCmd);
         String id = createContainerCmd.exec().getId();

core/src/main/java/org/testcontainers/containers/DockerComposeContainer.java

@@ -25,12 +25,14 @@
 import org.testcontainers.containers.wait.strategy.WaitAllStrategy;
 import org.testcontainers.containers.wait.strategy.WaitStrategy;
 import org.testcontainers.dockerclient.TransportConfig;
+import org.testcontainers.images.RemoteDockerImage;
 import org.testcontainers.lifecycle.Startable;
 import org.testcontainers.utility.AuditLogger;
 import org.testcontainers.utility.Base58;
 import org.testcontainers.utility.CommandLine;
 import org.testcontainers.utility.DockerImageName;
 import org.testcontainers.utility.DockerLoggerFactory;
+import org.testcontainers.utility.ImageNameSubstitutor;
 import org.testcontainers.utility.LogUtils;
 import org.testcontainers.utility.MountableFile;
 import org.testcontainers.utility.PathUtils;
@@ -186,7 +188,9 @@ private void pullImages() {
             .forEach(imageName -> {
                 try {
                     log.info("Preemptively checking local images for '{}', referenced via a compose file or transitive Dockerfile. If not available, it will be pulled.", imageName);
-                    DockerClientFactory.instance().checkAndPullImage(dockerClient, imageName);
+                    new RemoteDockerImage(DockerImageName.parse(imageName))
+                        .withImageNameSubstitutor(ImageNameSubstitutor.noop())
+                        .get();
                 } catch (Exception e) {
                     log.warn("Unable to pre-fetch an image ({}) depended upon by Docker Compose build - startup will continue but may fail. Exception message was: {}", imageName, e.getMessage());
                 }

core/src/main/java/org/testcontainers/images/LocalImagesCache.java

@@ -21,7 +21,8 @@
 enum LocalImagesCache {
     INSTANCE;
 
-    private final AtomicBoolean initialized = new AtomicBoolean(false);
+    @VisibleForTesting
+    final AtomicBoolean initialized = new AtomicBoolean(false);
 
     @VisibleForTesting
     final Map<DockerImageName, ImageData> cache = new ConcurrentHashMap<>();

core/src/main/java/org/testcontainers/images/RemoteDockerImage.java

@@ -10,7 +10,7 @@
 import lombok.NonNull;
 import lombok.SneakyThrows;
 import lombok.ToString;
-import lombok.experimental.Wither;
+import lombok.With;
 import org.slf4j.Logger;
 import org.testcontainers.DockerClientFactory;
 import org.testcontainers.containers.ContainerFetchException;
@@ -34,9 +34,12 @@ public class RemoteDockerImage extends LazyFuture<String> {
     @ToString.Exclude
     private Future<DockerImageName> imageNameFuture;
 
-    @Wither
+    @With
     private ImagePullPolicy imagePullPolicy = PullPolicy.defaultPolicy();
 
+    @With
+    private ImageNameSubstitutor imageNameSubstitutor = ImageNameSubstitutor.instance();
+
     @ToString.Exclude
     private DockerClient dockerClient = DockerClientFactory.lazyClient();
 
@@ -115,7 +118,7 @@ private DockerImageName getImageName() throws InterruptedException, ExecutionExc
         final DockerImageName specifiedImageName = imageNameFuture.get();
 
         // Allow the image name to be substituted
-        return ImageNameSubstitutor.instance().apply(specifiedImageName);
+        return imageNameSubstitutor.apply(specifiedImageName);
     }
 
     @ToString.Include(name = "imageName", rank = 1)

core/src/main/java/org/testcontainers/images/builder/ImageFromDockerfile.java

@@ -13,13 +13,16 @@
 import org.slf4j.Logger;
 import org.testcontainers.DockerClientFactory;
 import org.testcontainers.images.ParsedDockerfile;
+import org.testcontainers.images.RemoteDockerImage;
 import org.testcontainers.images.builder.traits.BuildContextBuilderTrait;
 import org.testcontainers.images.builder.traits.ClasspathTrait;
 import org.testcontainers.images.builder.traits.DockerfileTrait;
 import org.testcontainers.images.builder.traits.FilesTrait;
 import org.testcontainers.images.builder.traits.StringsTrait;
 import org.testcontainers.utility.Base58;
+import org.testcontainers.utility.DockerImageName;
 import org.testcontainers.utility.DockerLoggerFactory;
+import org.testcontainers.utility.ImageNameSubstitutor;
 import org.testcontainers.utility.LazyFuture;
 import org.testcontainers.utility.ResourceReaper;
 
@@ -172,7 +175,9 @@ private void prePullDependencyImages(Set<String> imagesToPull) {
         imagesToPull.forEach(imageName -> {
             try {
                 log.info("Pre-emptively checking local images for '{}', referenced via a Dockerfile. If not available, it will be pulled.", imageName);
-                DockerClientFactory.instance().checkAndPullImage(dockerClient, imageName);
+                new RemoteDockerImage(DockerImageName.parse(imageName))
+                    .withImageNameSubstitutor(ImageNameSubstitutor.noop())
+                    .get();
             } catch (Exception e) {
                 log.warn("Unable to pre-fetch an image ({}) depended upon by Dockerfile - image build will continue but may fail. Exception message was: {}", imageName, e.getMessage());
             }

core/src/main/java/org/testcontainers/utility/ImageNameSubstitutor.java

@@ -53,6 +53,10 @@ public synchronized static ImageNameSubstitutor instance() {
         return instance;
     }
 
+    public static ImageNameSubstitutor noop() {
+        return new NoopImageNameSubstitutor();
+    }
+
     private static ImageNameSubstitutor wrapWithLogging(final ImageNameSubstitutor wrappedInstance) {
         return new LogWrappedImageNameSubstitutor(wrappedInstance);
     }
@@ -127,4 +131,17 @@ protected String getDescription() {
             );
         }
     }
+
+    private static class NoopImageNameSubstitutor extends ImageNameSubstitutor {
+
+        @Override
+        public DockerImageName apply(DockerImageName original) {
+            return original;
+        }
+
+        @Override
+        protected String getDescription() {
+            return "No-op substitutor";
+        }
+    }
 }

core/src/main/java/org/testcontainers/utility/RyukResourceReaper.java

@@ -17,6 +17,7 @@
 import org.rnorth.ducttape.ratelimits.RateLimiterBuilder;
 import org.testcontainers.DockerClientFactory;
 import org.testcontainers.containers.ContainerState;
+import org.testcontainers.images.RemoteDockerImage;
 
 import java.io.IOException;
 import java.net.InetSocketAddress;
@@ -85,16 +86,13 @@ private synchronized void maybeStart() {
             return;
         }
         DockerClient client = DockerClientFactory.lazyClient();
-        String ryukImage = ImageNameSubstitutor.instance()
-            .apply(DockerImageName.parse("testcontainers/ryuk:0.3.3"))
-            .asCanonicalNameString();
-        DockerClientFactory.instance().checkAndPullImage(client, ryukImage);
+        RemoteDockerImage ryukImage = new RemoteDockerImage(DockerImageName.parse("testcontainers/ryuk:0.3.3"));
 
         List<Bind> binds = new ArrayList<>();
         binds.add(new Bind(DockerClientFactory.instance().getRemoteDockerUnixSocketPath(), new Volume("/var/run/docker.sock")));
 
         ExposedPort ryukExposedPort = ExposedPort.tcp(8080);
-        containerId = client.createContainerCmd(ryukImage)
+        containerId = client.createContainerCmd(ryukImage.get())
             .withHostConfig(
                 new HostConfig()
                     .withAutoRemove(true)

core/src/test/java/org/testcontainers/DockerClientFactoryTest.java

@@ -2,14 +2,15 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.assertThatThrownBy;
-import static org.testcontainers.TestImages.TINY_IMAGE;
 
 import com.github.dockerjava.api.exception.NotFoundException;
 import org.junit.Rule;
 import org.junit.Test;
 import org.rnorth.visibleassertions.VisibleAssertions;
 import org.testcontainers.DockerClientFactory.DiskSpaceUsage;
 import org.testcontainers.dockerclient.LogToStringContainerCallback;
+import org.testcontainers.images.LocalImagesCacheAccessor;
+import org.testcontainers.utility.DockerImageName;
 import org.testcontainers.utility.MockTestcontainersConfigurationRule;
 
 /**
@@ -24,16 +25,21 @@ public class DockerClientFactoryTest {
     public void runCommandInsideDockerShouldNotFailIfImageDoesNotExistsLocally() {
 
         final DockerClientFactory dockFactory = DockerClientFactory.instance();
+
+        DockerImageName imageName = DockerImageName.parse("testcontainers/helloworld:1.1.0");
+
         try {
             //remove tiny image, so it will be pulled during next command run
             dockFactory.client()
-                    .removeImageCmd(TINY_IMAGE.asCanonicalNameString())
+                    .removeImageCmd(imageName.asCanonicalNameString())
                     .withForce(true).exec();
         } catch (NotFoundException ignored) {
             // Do not fail if it's not pulled yet
         }
+        LocalImagesCacheAccessor.clearCache();
 
         dockFactory.runInsideDocker(
+                imageName,
                 cmd -> cmd.withCmd("sh", "-c", "echo 'SUCCESS'"),
                 (client, id) ->
                         client.logContainerCmd(id)

core/src/test/java/org/testcontainers/images/LocalImagesCacheAccessor.java

@@ -0,0 +1,9 @@
+package org.testcontainers.images;
+
+public final class LocalImagesCacheAccessor {
+
+    public static synchronized void clearCache() {
+        LocalImagesCache.INSTANCE.cache.clear();
+        LocalImagesCache.INSTANCE.initialized.set(false);
+    }
+}

core/src/test/java/org/testcontainers/utility/AuthenticatedImagePullTest.java

@@ -17,6 +17,7 @@
 import org.testcontainers.containers.ContainerState;
 import org.testcontainers.containers.DockerComposeContainer;
 import org.testcontainers.containers.GenericContainer;
+import org.testcontainers.images.LocalImagesCacheAccessor;
 import org.testcontainers.images.builder.ImageFromDockerfile;
 
 import java.io.IOException;
@@ -93,6 +94,7 @@ public void removeImageFromLocalDocker() {
         } catch (NotFoundException ignored) {
 
         }
+        LocalImagesCacheAccessor.clearCache();
     }
 
     @AfterClass