Accept image names with library/ prefix as a valid substitute (#6174)

Docker official images can be pulled with or without `library/` prefix as part of the image name. For example, `mysql` or `library/mysql`. This is explicit when using private repositories. Co-authored-by: Kevin Wittek <[email protected]>
testcontainers · Dec 14, 2022 · 3b24a7d · 3b24a7d
1 parent 221a8da
commit 3b24a7d
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 2 deletions.
diff --git a/core/src/main/java/org/testcontainers/utility/DockerImageName.java b/core/src/main/java/org/testcontainers/utility/DockerImageName.java
@@ -26,6 +26,8 @@ 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/";
+
     private final String rawName;
 
     @With
@@ -231,8 +233,15 @@ public DockerImageName asCompatibleSubstituteFor(DockerImageName otherImageName)
      * @return whether this image has declared compatibility.
      */
     public boolean isCompatibleWith(DockerImageName other) {
-        // is this image already the same or equivalent?
-        if (other.equals(this)) {
+        // Make sure we always compare against a version of the image name containing the LIBRARY_PREFIX
+        String finalImageName;
+        if (this.repository.startsWith(LIBRARY_PREFIX)) {
+            finalImageName = this.repository;
+        } else {
+            finalImageName = LIBRARY_PREFIX + this.repository;
+        }
+        DockerImageName imageWithLibraryPrefix = DockerImageName.parse(finalImageName);
+        if (other.equals(this) || imageWithLibraryPrefix.equals(this)) {
             return true;
         }
 

diff --git a/core/src/test/java/org/testcontainers/utility/DockerImageNameCompatibilityTest.java b/core/src/test/java/org/testcontainers/utility/DockerImageNameCompatibilityTest.java
@@ -91,6 +91,12 @@ public void testAssertMethodAcceptsCompatible() {
         subject.assertCompatibleWith(DockerImageName.parse("bar"));
     }
 
+    @Test
+    public void testAssertMethodAcceptsCompatibleLibraryPrefix() {
+        DockerImageName subject = DockerImageName.parse("library/foo");
+        subject.assertCompatibleWith(DockerImageName.parse("foo"));
+    }
+
     @Test
     public void testAssertMethodRejectsIncompatible() {
         DockerImageName subject = DockerImageName.parse("foo");