Merge pull request #339 from iExecBlockchainComputing/feature/docker-image-name

Normalize docker image name

Author: zguesmi

gradle.properties

@@ -1,4 +1,4 @@
-version=5.0.1-rc1
+version=5.0.1-rc2
 iexecCommonVersion=5.0.1-rc1
 nexusUser=fake
 nexusPassword=fake

src/main/java/com/iexec/worker/docker/DockerClientService.java

@@ -108,6 +108,8 @@ public boolean pullImage(String imageName) {
         NameParser.ReposTag repoAndTag = NameParser.parseRepositoryTag(imageName);
         if (StringUtils.isEmpty(repoAndTag.repos)
                 || StringUtils.isEmpty(repoAndTag.tag)) {
+            Exception e = new Exception("Error parsing image name");
+            logError("pull image", imageName, "", e);
             return false;
         }
         try (PullImageCmd pullImageCmd =
@@ -125,17 +127,18 @@ public boolean pullImage(String imageName) {
     }
 
     public String getImageId(String imageName) {
-        if (StringUtils.isEmpty(imageName)) {
+        String normalizedImageName = normalizeImageName(imageName);
+        if (StringUtils.isEmpty(normalizedImageName)) {
             return "";
         }
         try (ListImagesCmd listImagesCmd = getClient().listImagesCmd()) {
             return listImagesCmd
                     .withDanglingFilter(false)
-                    .withImageNameFilter(imageName)
+                    .withImageNameFilter(normalizedImageName)
                     .exec()
                     .stream()
                     .filter(image -> !StringUtils.isEmpty(image.getRepoTags()))
-                    .filter(image -> Arrays.asList(image.getRepoTags()).contains(imageName))
+                    .filter(image -> Arrays.asList(image.getRepoTags()).contains(normalizedImageName))
                     .map(Image::getId)
                     .findFirst()
                     .orElse("");
@@ -395,6 +398,32 @@ DockerClient getClient() {
         return dockerConnectorService.getClient();
     }
 
+    /**
+     * Docker image names have the form:
+     * registry-url/namespace/image:tag
+     * Since the registry-url is optional
+     * we need to remove it to have a
+     * predictable format.
+     * 
+     * @param imageName
+     * @return imageName without registry url
+     */
+    public String normalizeImageName(String imageName) {
+        // TODO: check image tag here.
+        if (StringUtils.isEmpty(imageName)) {
+            return "";
+        }
+        String[] parts = imageName.split("/");
+        int n = parts.length;
+        if (n == 1) {
+            // official images do not have namespaces
+            return imageName;
+        }
+        // We are not sure if the registry url can
+        // contain slashes so we anticipate that case.
+        return parts[n-2] + "/" + parts[n-1];
+    }
+
     private void logInfo(String infoMessage, String name, String id) {
         log.info("{} [name:'{}', id:'{}']", infoMessage, name, id);
     }

src/test/java/com/iexec/worker/docker/DockerClientServiceTests.java

@@ -40,7 +40,6 @@
 
 import static com.iexec.worker.docker.DockerClientService.WORKER_DOCKER_NETWORK;
 import static org.assertj.core.api.Assertions.assertThat;
-import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.Mockito.*;
 
 
@@ -628,6 +627,30 @@ public void shouldNotRemoveContainerSinceDockerCmdException() {
         assertThat(dockerClientService.removeContainer(getRandomString())).isFalse();
     }
 
+    @Test
+    public void shouldRemoveRegistryUrlFromImageName() {
+        assertThat(
+                dockerClientService
+                        .normalizeImageName("registry/namespace/image:tag")
+        ).isEqualTo("namespace/image:tag");
+    }
+
+    @Test
+    public void shouldAcceptImageNameWithoutRegistryUrl() {
+        assertThat(
+                dockerClientService
+                        .normalizeImageName("namespace/image:tag")
+        ).isEqualTo("namespace/image:tag");
+    }
+
+    @Test
+    public void ShouldAcceptOfficialImageName() {
+        assertThat(
+                dockerClientService
+                        .normalizeImageName("official:tag")
+        ).isEqualTo("official:tag");
+    }
+
     private String getRandomString() {
         return RandomStringUtils.randomAlphanumeric(20);
     }