Add load async operation (docker-java#1982)

eddumelendez · web-flow · commit 9b7adaeb0c7d · 2022-11-22T09:15:10.000-08:00
diff --git a/docker-java-api/src/main/java/com/github/dockerjava/api/DockerClient.java b/docker-java-api/src/main/java/com/github/dockerjava/api/DockerClient.java
@@ -42,6 +42,7 @@
 import com.github.dockerjava.api.command.ListSwarmNodesCmd;
 import com.github.dockerjava.api.command.ListTasksCmd;
 import com.github.dockerjava.api.command.ListVolumesCmd;
+import com.github.dockerjava.api.command.LoadImageAsyncCmd;
 import com.github.dockerjava.api.command.LoadImageCmd;
 import com.github.dockerjava.api.command.LogContainerCmd;
 import com.github.dockerjava.api.command.LogSwarmObjectCmd;
@@ -131,6 +132,8 @@ public interface DockerClient extends Closeable {
      */
     LoadImageCmd loadImageCmd(@Nonnull InputStream imageStream);
 
+    LoadImageAsyncCmd loadImageAsyncCmd(@Nonnull InputStream imageStream);
+
     SearchImagesCmd searchImagesCmd(@Nonnull String term);
 
     RemoveImageCmd removeImageCmd(@Nonnull String imageId);
diff --git a/docker-java-api/src/main/java/com/github/dockerjava/api/DockerClientDelegate.java b/docker-java-api/src/main/java/com/github/dockerjava/api/DockerClientDelegate.java
@@ -42,6 +42,7 @@
 import com.github.dockerjava.api.command.ListSwarmNodesCmd;
 import com.github.dockerjava.api.command.ListTasksCmd;
 import com.github.dockerjava.api.command.ListVolumesCmd;
+import com.github.dockerjava.api.command.LoadImageAsyncCmd;
 import com.github.dockerjava.api.command.LoadImageCmd;
 import com.github.dockerjava.api.command.LogContainerCmd;
 import com.github.dockerjava.api.command.LogSwarmObjectCmd;
@@ -153,6 +154,11 @@ public LoadImageCmd loadImageCmd(@Nonnull InputStream imageStream) {
         return getDockerClient().loadImageCmd(imageStream);
     }
 
+    @Override
+    public LoadImageAsyncCmd loadImageAsyncCmd(@Nonnull InputStream imageStream) {
+        return getDockerClient().loadImageAsyncCmd(imageStream);
+    }
+
     @Override
     public SearchImagesCmd searchImagesCmd(@Nonnull String term) {
         return getDockerClient().searchImagesCmd(term);
diff --git a/docker-java-api/src/main/java/com/github/dockerjava/api/command/DelegatingDockerCmdExecFactory.java b/docker-java-api/src/main/java/com/github/dockerjava/api/command/DelegatingDockerCmdExecFactory.java
@@ -75,6 +75,11 @@ public LoadImageCmd.Exec createLoadImageCmdExec() {
         return getDockerCmdExecFactory().createLoadImageCmdExec();
     }
 
+    @Override
+    public LoadImageAsyncCmd.Exec createLoadImageAsyncCmdExec() {
+        return getDockerCmdExecFactory().createLoadImageAsyncCmdExec();
+    }
+
     @Override
     public SearchImagesCmd.Exec createSearchImagesCmdExec() {
         return getDockerCmdExecFactory().createSearchImagesCmdExec();
diff --git a/docker-java-api/src/main/java/com/github/dockerjava/api/command/DockerCmdExecFactory.java b/docker-java-api/src/main/java/com/github/dockerjava/api/command/DockerCmdExecFactory.java
@@ -27,6 +27,8 @@ public interface DockerCmdExecFactory extends Closeable {
 
     LoadImageCmd.Exec createLoadImageCmdExec();
 
+    LoadImageAsyncCmd.Exec createLoadImageAsyncCmdExec();
+
     SearchImagesCmd.Exec createSearchImagesCmdExec();
 
     RemoveImageCmd.Exec createRemoveImageCmdExec();
diff --git a/docker-java-api/src/main/java/com/github/dockerjava/api/command/LoadImageAsyncCmd.java b/docker-java-api/src/main/java/com/github/dockerjava/api/command/LoadImageAsyncCmd.java
@@ -0,0 +1,22 @@
+package com.github.dockerjava.api.command;
+
+import com.github.dockerjava.api.model.LoadResponseItem;
+
+import java.io.InputStream;
+
+public interface LoadImageAsyncCmd extends AsyncDockerCmd<LoadImageAsyncCmd, LoadResponseItem> {
+    InputStream getImageStream();
+
+    /**
+     * @param imageStream the InputStream of the tar file
+     */
+    LoadImageAsyncCmd withImageStream(InputStream imageStream);
+
+    @Override
+    default LoadImageCallback start() {
+        return exec(new LoadImageCallback());
+    }
+
+    interface Exec extends DockerCmdAsyncExec<LoadImageAsyncCmd, LoadResponseItem> {
+    }
+}
diff --git a/docker-java-api/src/main/java/com/github/dockerjava/api/command/LoadImageCallback.java b/docker-java-api/src/main/java/com/github/dockerjava/api/command/LoadImageCallback.java
@@ -0,0 +1,49 @@
+package com.github.dockerjava.api.command;
+
+import com.github.dockerjava.api.async.ResultCallbackTemplate;
+import com.github.dockerjava.api.exception.DockerClientException;
+import com.github.dockerjava.api.model.LoadResponseItem;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class LoadImageCallback extends ResultCallbackTemplate<LoadImageCallback, LoadResponseItem> {
+
+    private static final Logger LOGGER = LoggerFactory.getLogger(LoadImageCallback.class);
+
+    private String message;
+
+    private String error;
+
+    @Override
+    public void onNext(LoadResponseItem item) {
+        if (item.isBuildSuccessIndicated()) {
+            this.message = item.getMessage();
+        } else if (item.isErrorIndicated()) {
+            this.error = item.getError();
+        }
+
+        LOGGER.debug(item.toString());
+    }
+
+    public String awaitMessage() {
+        try {
+            awaitCompletion();
+        } catch (InterruptedException e) {
+            throw new DockerClientException("", e);
+        }
+
+        return getMessage();
+    }
+
+    private String getMessage() {
+        if (this.message != null) {
+            return this.message;
+        }
+
+        if (this.error == null) {
+            throw new DockerClientException("Could not build image");
+        }
+
+        throw new DockerClientException("Could not build image: " + this.error);
+    }
+}
diff --git a/docker-java-api/src/main/java/com/github/dockerjava/api/model/LoadResponseItem.java b/docker-java-api/src/main/java/com/github/dockerjava/api/model/LoadResponseItem.java
@@ -0,0 +1,33 @@
+package com.github.dockerjava.api.model;
+
+import com.fasterxml.jackson.annotation.JsonIgnore;
+
+public class LoadResponseItem extends ResponseItem {
+
+    private static final long serialVersionUID = 1L;
+
+    private static final String IMPORT_SUCCESS = "Loaded image:";
+
+    /**
+     * Returns whether the stream field indicates a successful build operation
+     */
+    @JsonIgnore
+    public boolean isBuildSuccessIndicated() {
+        if (isErrorIndicated() || getStream() == null) {
+            return false;
+        }
+
+        return getStream().contains(IMPORT_SUCCESS);
+    }
+
+    @JsonIgnore
+    public String getMessage() {
+        if (!isBuildSuccessIndicated()) {
+            return null;
+        } else if (getStream().contains(IMPORT_SUCCESS)) {
+            return getStream();
+        }
+
+        return null;
+    }
+}
diff --git a/docker-java-core/src/main/java/com/github/dockerjava/core/AbstractDockerCmdExecFactory.java b/docker-java-core/src/main/java/com/github/dockerjava/core/AbstractDockerCmdExecFactory.java
@@ -44,6 +44,7 @@
 import com.github.dockerjava.api.command.ListSwarmNodesCmd;
 import com.github.dockerjava.api.command.ListTasksCmd;
 import com.github.dockerjava.api.command.ListVolumesCmd;
+import com.github.dockerjava.api.command.LoadImageAsyncCmd;
 import com.github.dockerjava.api.command.LoadImageCmd;
 import com.github.dockerjava.api.command.LogContainerCmd;
 import com.github.dockerjava.api.command.LogSwarmObjectCmd;
@@ -101,6 +102,7 @@
 import com.github.dockerjava.core.exec.ExecStartCmdExec;
 import com.github.dockerjava.core.exec.InspectConfigCmdExec;
 import com.github.dockerjava.core.exec.ListConfigsCmdExec;
+import com.github.dockerjava.core.exec.LoadImageAsyncCmdExec;
 import com.github.dockerjava.core.exec.RemoveConfigCmdExec;
 import com.github.dockerjava.core.exec.ResizeContainerCmdExec;
 import com.github.dockerjava.core.exec.ResizeExecCmdExec;
@@ -255,6 +257,11 @@ public LoadImageCmd.Exec createLoadImageCmdExec() {
         return new LoadImageCmdExec(getBaseResource(), getDockerClientConfig());
     }
 
+    @Override
+    public LoadImageAsyncCmd.Exec createLoadImageAsyncCmdExec() {
+        return new LoadImageAsyncCmdExec(getBaseResource(), getDockerClientConfig());
+    }
+
     @Override
     public SearchImagesCmd.Exec createSearchImagesCmdExec() {
         return new SearchImagesCmdExec(getBaseResource(), getDockerClientConfig());
diff --git a/docker-java-core/src/main/java/com/github/dockerjava/core/DockerClientImpl.java b/docker-java-core/src/main/java/com/github/dockerjava/core/DockerClientImpl.java
@@ -44,6 +44,7 @@
 import com.github.dockerjava.api.command.ListSwarmNodesCmd;
 import com.github.dockerjava.api.command.ListTasksCmd;
 import com.github.dockerjava.api.command.ListVolumesCmd;
+import com.github.dockerjava.api.command.LoadImageAsyncCmd;
 import com.github.dockerjava.api.command.LoadImageCmd;
 import com.github.dockerjava.api.command.LogContainerCmd;
 import com.github.dockerjava.api.command.LogSwarmObjectCmd;
@@ -127,6 +128,7 @@
 import com.github.dockerjava.core.command.ListSwarmNodesCmdImpl;
 import com.github.dockerjava.core.command.ListTasksCmdImpl;
 import com.github.dockerjava.core.command.ListVolumesCmdImpl;
+import com.github.dockerjava.core.command.LoadImageAsyncCmdImpl;
 import com.github.dockerjava.core.command.LoadImageCmdImpl;
 import com.github.dockerjava.core.command.LogContainerCmdImpl;
 import com.github.dockerjava.core.command.LogSwarmObjectImpl;
@@ -350,6 +352,11 @@ public LoadImageCmd loadImageCmd(@Nonnull InputStream imageStream) {
         return new LoadImageCmdImpl(getDockerCmdExecFactory().createLoadImageCmdExec(), imageStream);
     }
 
+    @Override
+    public LoadImageAsyncCmd loadImageAsyncCmd(@Nonnull InputStream imageStream) {
+        return new LoadImageAsyncCmdImpl(getDockerCmdExecFactory().createLoadImageAsyncCmdExec(), imageStream);
+    }
+
     @Override
     public SearchImagesCmd searchImagesCmd(String term) {
         return new SearchImagesCmdImpl(getDockerCmdExecFactory().createSearchImagesCmdExec(), term);
diff --git a/docker-java-core/src/main/java/com/github/dockerjava/core/command/LoadImageAsyncCmdImpl.java b/docker-java-core/src/main/java/com/github/dockerjava/core/command/LoadImageAsyncCmdImpl.java
@@ -0,0 +1,42 @@
+package com.github.dockerjava.core.command;
+
+import com.github.dockerjava.api.command.LoadImageAsyncCmd;
+import com.github.dockerjava.api.model.LoadResponseItem;
+
+import java.io.IOException;
+import java.io.InputStream;
+
+import static com.google.common.base.Preconditions.checkNotNull;
+
+public class LoadImageAsyncCmdImpl extends AbstrAsyncDockerCmd<LoadImageAsyncCmd, LoadResponseItem> implements LoadImageAsyncCmd {
+
+    private InputStream inputStream;
+
+    public LoadImageAsyncCmdImpl(LoadImageAsyncCmd.Exec exec, InputStream inputStream) {
+        super(exec);
+        this.inputStream = inputStream;
+    }
+
+    @Override
+    public InputStream getImageStream() {
+        return this.inputStream;
+    }
+
+    @Override
+    public LoadImageAsyncCmd withImageStream(InputStream imageStream) {
+        checkNotNull(imageStream, "imageStream was not specified");
+        this.inputStream = imageStream;
+        return this;
+    }
+
+    @Override
+    public void close() {
+        super.close();
+
+        try {
+            this.inputStream.close();
+        } catch (IOException e) {
+            throw new RuntimeException(e);
+        }
+    }
+}
diff --git a/docker-java-core/src/main/java/com/github/dockerjava/core/exec/LoadImageAsyncCmdExec.java b/docker-java-core/src/main/java/com/github/dockerjava/core/exec/LoadImageAsyncCmdExec.java
@@ -0,0 +1,30 @@
+package com.github.dockerjava.core.exec;
+
+import com.fasterxml.jackson.core.type.TypeReference;
+import com.github.dockerjava.api.async.ResultCallback;
+import com.github.dockerjava.api.command.LoadImageAsyncCmd;
+import com.github.dockerjava.api.model.LoadResponseItem;
+import com.github.dockerjava.core.DockerClientConfig;
+import com.github.dockerjava.core.WebTarget;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class LoadImageAsyncCmdExec extends AbstrAsyncDockerCmdExec<LoadImageAsyncCmd, LoadResponseItem> implements LoadImageAsyncCmd.Exec {
+
+    private static final Logger LOGGER = LoggerFactory.getLogger(LoadImageAsyncCmdExec.class);
+
+    public LoadImageAsyncCmdExec(WebTarget baseResource, DockerClientConfig dockerClientConfig) {
+        super(baseResource, dockerClientConfig);
+    }
+
+    @Override
+    protected Void execute0(LoadImageAsyncCmd command, ResultCallback<LoadResponseItem> resultCallback) {
+        WebTarget webTarget = getBaseResource().path("/images/load");
+
+        LOGGER.trace("POST: {}", webTarget);
+
+        webTarget.request().post(new TypeReference<LoadResponseItem>() { }, resultCallback, command.getImageStream());
+
+        return null;
+    }
+}
diff --git a/docker-java/src/test/java/com/github/dockerjava/cmd/LoadImageCmdIT.java b/docker-java/src/test/java/com/github/dockerjava/cmd/LoadImageCmdIT.java
@@ -1,5 +1,6 @@
 package com.github.dockerjava.cmd;
 
+import com.github.dockerjava.api.command.LoadImageCallback;
 import com.github.dockerjava.api.model.Image;
 import com.github.dockerjava.utils.TestResources;
 import net.jcip.annotations.NotThreadSafe;
@@ -53,6 +54,19 @@ public void loadImageFromTar() throws Exception {
                 asList(image.getRepoTags()), equalTo(singletonList("docker-java/load:1.0")));
     }
 
+    @Test
+    public void loadImageFromTarAsync() throws Exception {
+        try (InputStream uploadStream = Files.newInputStream(TestResources.getApiImagesLoadTestTarball())) {
+            dockerRule.getClient().loadImageAsyncCmd(uploadStream).exec(new LoadImageCallback()).awaitMessage();
+        }
+
+        final Image image = findImageWithId(expectedImageId, dockerRule.getClient().listImagesCmd().exec());
+
+        assertThat("Can't find expected image after loading from a tar archive!", image, notNullValue());
+        assertThat("Image after loading from a tar archive has wrong tags!",
+                   asList(image.getRepoTags()), equalTo(singletonList("docker-java/load:1.0")));
+    }
+
     private Image findImageWithId(final String id, final List<Image> images) {
         for (Image image : images) {
             if (id.equals(image.getId())) {
