Support Docker module ID with slash (#666)

Author: yahavi

Diff for: build-info-extractor-docker/src/main/java/org/jfrog/build/extractor/docker/DockerUtils.java

@@ -12,6 +12,7 @@
 import java.util.ArrayList;
 import java.util.List;
 
+import static org.apache.commons.lang3.StringUtils.*;
 import static org.jfrog.build.extractor.BuildInfoExtractorUtils.createMapper;
 
 public class DockerUtils {
@@ -285,6 +286,21 @@ public static List<String> getArtManifestPath(String imagePath, String repo, Com
         return paths;
     }
 
+    /**
+     * Calculate the module ID from the image tag and the target repository.
+     *
+     * @param imageTag   - The image tag
+     * @param targetRepo - The target repository
+     * @return the module ID.
+     */
+    public static String calculateModuleId(String imageTag, String targetRepo) {
+        String targetRepoWrap = String.format("/%s/", targetRepo);
+        if (contains(imageTag, targetRepoWrap)) {
+            return substringAfterLast(imageTag, targetRepoWrap);
+        }
+        return substringAfter(imageTag, "/");
+    }
+
     public enum CommandType {
         Push,
         Pull

Diff for: build-info-extractor-docker/src/main/java/org/jfrog/build/extractor/docker/types/DockerImage.java

@@ -25,6 +25,7 @@
 
 import static org.apache.commons.lang3.StringUtils.*;
 import static org.jfrog.build.client.DownloadResponse.SHA256_HEADER_NAME;
+import static org.jfrog.build.extractor.docker.DockerUtils.calculateModuleId;
 
 public class DockerImage implements Serializable {
     private String imageId;
@@ -228,7 +229,7 @@ public Module generateBuildInfoModule(Log logger, DockerUtils.CommandType cmdTyp
         try (ArtifactoryManager artifactoryManager = artifactoryManagerBuilder.build()) {
             ModuleBuilder moduleBuilder = new ModuleBuilder()
                     .type(ModuleType.DOCKER)
-                    .id(substringAfterLast(imageTag, "/"))
+                    .id(calculateModuleId(imageTag, targetRepo))
                     .repository(targetRepo);
             try {
                 findAndSetManifestFromArtifactory(artifactoryManager, logger, cmdType);

Diff for: build-info-extractor-docker/src/test/java/org/jfrog/build/extractor/docker/DockerUtilsTest.java

@@ -0,0 +1,59 @@
+package org.jfrog.build.extractor.docker;
+
+import org.testng.annotations.DataProvider;
+import org.testng.annotations.Test;
+
+import java.util.List;
+import java.util.stream.Stream;
+
+import static org.jfrog.build.extractor.docker.DockerUtils.calculateModuleId;
+import static org.jfrog.build.extractor.docker.DockerUtils.getArtManifestPath;
+import static org.testng.Assert.assertEquals;
+import static org.testng.Assert.assertEqualsNoOrder;
+
+@Test
+public class DockerUtilsTest {
+    @Test
+    public void getArtManifestPathTest() {
+        String imagePath = "hello-world:latest";
+        String repository = "docker-local";
+        DockerUtils.CommandType cmdType = DockerUtils.CommandType.Push;
+        List<String> results = getArtManifestPath(imagePath, repository, cmdType);
+        assertEqualsNoOrder(results.toArray(), Stream.of("docker-local/hello-world:latest", "hello-world:latest").toArray());
+
+        cmdType = DockerUtils.CommandType.Pull;
+        imagePath = "docker-local/hello-world:latest";
+        results = getArtManifestPath(imagePath, repository, cmdType);
+        assertEqualsNoOrder(results.toArray(), Stream.of("docker-local/docker-local/hello-world:latest", "docker-local/hello-world:latest", "docker-local/library/docker-local/hello-world:latest", "docker-local/library/hello-world:latest").toArray());
+    }
+
+    @DataProvider
+    private Object[][] moduleIdsProvider() {
+        return new String[][]{
+                // imageTag, targetRepo, expectedModuleId
+                {"acme-docker-local.jfrog.io/image-tag", "docker-repo", "image-tag"},
+                {"acme-docker-local.jfrog.io/image-tag:1", "docker-repo", "image-tag:1"},
+                {"acme-docker-local.jfrog.io/image/tag", "docker-repo", "image/tag"},
+                {"acme-docker-local.jfrog.io/image/tag:1", "docker-repo", "image/tag:1"},
+                {"acme-docker-local.jfrog.io/image-tag", "other-docker-repo", "image-tag"},
+                {"acme-docker-local.jfrog.io/image-tag:1", "other-docker-repo", "image-tag:1"},
+                {"acme-docker-local.jfrog.io/image/tag", "other-docker-repo", "image/tag"},
+                {"acme-docker-local.jfrog.io/image/tag:1", "other-docker-repo", "image/tag:1"},
+
+                {"acme.jfrog.io/docker-repo/image-tag", "docker-repo", "image-tag"},
+                {"acme.jfrog.io/docker-repo/image-tag:1", "docker-repo", "image-tag:1"},
+                {"acme.jfrog.io/docker-repo/image/tag", "docker-repo", "image/tag"},
+                {"acme.jfrog.io/docker-repo/image/tag:1", "docker-repo", "image/tag:1"},
+                // Edge cases - we have no choice but to add the docker-repo to the module id
+                {"acme.jfrog.io/docker-repo/image-tag", "other-docker-repo", "docker-repo/image-tag"},
+                {"acme.jfrog.io/docker-repo/image-tag:1", "other-docker-repo", "docker-repo/image-tag:1"},
+                {"acme.jfrog.io/docker-repo/image/tag", "other-docker-repo", "docker-repo/image/tag"},
+                {"acme.jfrog.io/docker-repo/image/tag:1", "other-docker-repo", "docker-repo/image/tag:1"},
+        };
+    }
+
+    @Test(dataProvider = "moduleIdsProvider")
+    public void calculateModuleIdTest(String imageTag, String targetRepo, String expectedModuleId) {
+        assertEquals(calculateModuleId(imageTag, targetRepo), expectedModuleId);
+    }
+}