include image name in RemoteDockerImage.toString() to fix #2443

testcontainers · Mar 17, 2020 · dc4a5c8 · dc4a5c8
1 parent 410e96e
commit dc4a5c8
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 3 deletions.
diff --git a/core/src/main/java/org/testcontainers/images/RemoteDockerImage.java b/core/src/main/java/org/testcontainers/images/RemoteDockerImage.java
@@ -28,6 +28,7 @@ public class RemoteDockerImage extends LazyFuture<String> {
 
     private static final Duration PULL_RETRY_TIME_LIMIT = Duration.ofMinutes(2);
 
+    @ToString.Exclude
     private Future<DockerImageName> imageNameFuture;
 
     @Wither
@@ -54,9 +55,8 @@ protected DockerImageName resolve() {
     }
 
     @Override
-    @SneakyThrows({InterruptedException.class, ExecutionException.class})
     protected final String resolve() {
-        final DockerImageName imageName = imageNameFuture.get();
+        final DockerImageName imageName = getImageName();
         Logger logger = DockerLoggerFactory.getLogger(imageName.toString());
         try {
             if (!imagePullPolicy.shouldPull(imageName)) {
@@ -95,4 +95,10 @@ protected final String resolve() {
             throw new ContainerFetchException("Failed to get Docker client for " + imageName, e);
         }
     }
+
+    @ToString.Include(name = "imageName", rank = 1)
+    @SneakyThrows({InterruptedException.class, ExecutionException.class})
+    DockerImageName getImageName() {
+       return imageNameFuture.get();
+    }
 }
diff --git a/core/src/test/java/org/testcontainers/containers/GenericContainerTest.java b/core/src/test/java/org/testcontainers/containers/GenericContainerTest.java
@@ -2,7 +2,6 @@
 
 import com.github.dockerjava.api.DockerClient;
 import com.github.dockerjava.api.command.InspectContainerResponse.ContainerState;
-import com.github.dockerjava.api.model.HostConfig;
 import lombok.RequiredArgsConstructor;
 import lombok.SneakyThrows;
 import lombok.experimental.FieldDefaults;
@@ -54,6 +53,19 @@ public void shouldReportErrorAfterWait() {
         }
     }
 
+    @Test
+    public void shouldLogImageNameWhenGetDockerImageNameFails() {
+        // A docker image that doesn't exist is enough.  The NotFoundException
+        // that the ContainerFetchException wraps may contain the image name.
+        // This test verifies that the ContainerFetchException itself does.
+        String imageName = "doesNotExist";
+        try(GenericContainer container = new GenericContainer<>(imageName)) {
+            assertThatThrownBy(container::getDockerImageName)
+                .isInstanceOf(ContainerFetchException.class)
+                .hasMessageContaining(imageName);
+        }
+    }
+
     static class NoopStartupCheckStrategy extends StartupCheckStrategy {
 
         @Override