Refactor to use DockerImageName instead of String image names

Author: rnorth

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

@@ -25,6 +25,7 @@
 import org.testcontainers.dockerclient.TransportConfig;
 import org.testcontainers.images.TimeLimitedLoggedPullImageResultCallback;
 import org.testcontainers.utility.ComparableVersion;
+import org.testcontainers.utility.DockerImageName;
 import org.testcontainers.utility.MountableFile;
 import org.testcontainers.utility.ResourceReaper;
 import org.testcontainers.utility.TestcontainersConfiguration;
@@ -323,10 +324,12 @@ private boolean checkMountableFile() {
    * Check whether the image is available locally and pull it otherwise
    */
     @SneakyThrows
-    public void checkAndPullImage(DockerClient client, String image) {
-        List<Image> images = client.listImagesCmd().withImageNameFilter(image).exec();
+    public void checkAndPullImage(DockerClient client, DockerImageName dockerImageName) {
+        List<Image> images = client.listImagesCmd().withImageNameFilter(dockerImageName.asCanonicalNameString()).exec();
         if (images.isEmpty()) {
-            client.pullImageCmd(image).exec(new TimeLimitedLoggedPullImageResultCallback(log , image)).awaitCompletion();
+            client.pullImageCmd(dockerImageName.asCanonicalNameString())
+                .exec(new TimeLimitedLoggedPullImageResultCallback(log , dockerImageName))
+                .awaitCompletion();
         }
     }
 
@@ -343,7 +346,7 @@ public <T> T runInsideDocker(Consumer<CreateContainerCmd> createContainerCmdCons
     }
 
     private <T> T runInsideDocker(DockerClient client, Consumer<CreateContainerCmd> createContainerCmdConsumer, BiFunction<DockerClient, String, T> block) {
-        checkAndPullImage(client, TINY_IMAGE);
+        checkAndPullImage(client, DockerImageName.parse(TINY_IMAGE));
         CreateContainerCmd createContainerCmd = client.createContainerCmd(TINY_IMAGE)
                 .withLabels(DEFAULT_LABELS);
         createContainerCmdConsumer.accept(createContainerCmd);

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

@@ -3,12 +3,17 @@
 import com.github.dockerjava.api.command.PullImageResultCallback;
 import com.github.dockerjava.api.model.PullResponseItem;
 import org.slf4j.Logger;
+import org.testcontainers.utility.DockerImageName;
 import org.testcontainers.utility.ImagePullCountLogger;
 
 import java.io.Closeable;
 import java.time.Duration;
 import java.time.Instant;
-import java.util.*;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.Map;
+import java.util.Objects;
+import java.util.Set;
 
 import static java.lang.String.format;
 import static org.apache.commons.io.FileUtils.byteCountToDisplaySize;
@@ -18,7 +23,7 @@
  */
 class LoggedPullImageResultCallback extends PullImageResultCallback {
     private final Logger logger;
-    private final String canonicalImageName;
+    private final DockerImageName dockerImageName;
 
     private final Set<String> allLayers = new HashSet<>();
     private final Set<String> downloadedLayers = new HashSet<>();
@@ -28,9 +33,9 @@ class LoggedPullImageResultCallback extends PullImageResultCallback {
     private boolean completed;
     private Instant start;
 
-    LoggedPullImageResultCallback(final Logger logger, final String canonicalImageName) {
+    LoggedPullImageResultCallback(final Logger logger, final DockerImageName dockerImageName) {
         this.logger = logger;
-        this.canonicalImageName = canonicalImageName;
+        this.dockerImageName = dockerImageName;
     }
 
     @Override
@@ -113,7 +118,7 @@ public void onComplete() {
                 byteCountToDisplaySize(downloadedLayerSize / duration));
         }
 
-        ImagePullCountLogger.instance().recordPull(canonicalImageName);
+        ImagePullCountLogger.instance().recordPull(dockerImageName);
     }
 
     private long downloadedLayerSize() {

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

@@ -77,7 +77,7 @@ protected final String resolve() {
                     dockerClient
                         .pullImageCmd(imageName.getUnversionedPart())
                         .withTag(imageName.getVersionPart())
-                        .exec(new TimeLimitedLoggedPullImageResultCallback(logger, imageName.asCanonicalNameString()))
+                        .exec(new TimeLimitedLoggedPullImageResultCallback(logger, imageName))
                         .awaitCompletion();
 
                     LocalImagesCache.INSTANCE.refreshCache(imageName);

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

@@ -3,6 +3,7 @@
 import com.github.dockerjava.api.command.PullImageResultCallback;
 import com.github.dockerjava.api.model.PullResponseItem;
 import org.slf4j.Logger;
+import org.testcontainers.utility.DockerImageName;
 import org.testcontainers.utility.TestcontainersConfiguration;
 
 import java.io.Closeable;
@@ -41,7 +42,7 @@ public class TimeLimitedLoggedPullImageResultCallback extends LoggedPullImageRes
     // All threads that are 'awaiting' this pull
     private final Set<Thread> waitingThreads = new HashSet<>();
 
-    public TimeLimitedLoggedPullImageResultCallback(Logger logger, final String canonicalImageName) {
+    public TimeLimitedLoggedPullImageResultCallback(Logger logger, final DockerImageName canonicalImageName) {
         super(logger, canonicalImageName);
         this.logger = logger;
     }

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

@@ -15,7 +15,7 @@
 public class ImagePullCountLogger {
 
     private static ImagePullCountLogger instance;
-    private final Map<String, AtomicInteger> pullCounters = new ConcurrentHashMap<>();
+    private final Map<DockerImageName, AtomicInteger> pullCounters = new ConcurrentHashMap<>();
 
     public synchronized static ImagePullCountLogger instance() {
         if (instance == null) {
@@ -34,7 +34,7 @@ public synchronized static ImagePullCountLogger instance() {
     public void logStatistics() {
         if (pullCounters.size() > 0) {
             final String summary = pullCounters.entrySet().stream()
-                .map(it -> it.getKey() + (it.getValue().intValue() > 1 ? " (" + it.getValue() + " times)" : ""))
+                .map(it -> it.getKey().asCanonicalNameString() + (it.getValue().intValue() > 1 ? " (" + it.getValue() + " times)" : ""))
                 .sorted()
                 .collect(Collectors.joining("\n    ", "\n    ", "\n"));
 
@@ -44,7 +44,7 @@ public void logStatistics() {
         }
     }
 
-    public void recordPull(final String image) {
+    public void recordPull(final DockerImageName image) {
         pullCounters.computeIfAbsent(image, __ -> new AtomicInteger()).incrementAndGet();
     }
 }

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

@@ -31,10 +31,10 @@ public void setUp() throws Exception {
     public void testPullCountsLogged() {
         underTest = new ImagePullCountLogger();
 
-        underTest.recordPull("imageA");
-        underTest.recordPull("imageA");
-        underTest.recordPull("imageB");
-        underTest.recordPull("imageC");
+        underTest.recordPull(DockerImageName.parse("imageA"));
+        underTest.recordPull(DockerImageName.parse("imageA"));
+        underTest.recordPull(DockerImageName.parse("imageB"));
+        underTest.recordPull(DockerImageName.parse("imageC"));
 
         underTest.logStatistics();