Add signal query argument for Restart Container command (#2186)

Co-authored-by: Eddú Meléndez Gonzales <eddu.melendez@gmail.com>

Author: dmmax

docker-java-api/src/main/java/com/github/dockerjava/api/command/RestartContainerCmd.java

@@ -8,9 +8,8 @@
 /**
  * Restart a running container.
  *
- * @param timeout
- *            - Timeout in seconds before killing the container. Defaults to 10 seconds.
- *
+ * @param signal  - Signal to send to the container as an integer or string (e.g. SIGINT).
+ * @param timeout - Timeout in seconds before killing the container. Defaults to 10 seconds.
  */
 public interface RestartContainerCmd extends SyncDockerCmd<Void> {
 
@@ -20,6 +19,12 @@ public interface RestartContainerCmd extends SyncDockerCmd<Void> {
     @CheckForNull
     Integer getTimeout();
 
+    /**
+     * @since {@link com.github.dockerjava.core.RemoteApiVersion#VERSION_1_42}
+     */
+    @CheckForNull
+    String getSignal();
+
     RestartContainerCmd withContainerId(@Nonnull String containerId);
 
     /**
@@ -32,9 +37,10 @@ default RestartContainerCmd withtTimeout(Integer timeout) {
 
     RestartContainerCmd withTimeout(Integer timeout);
 
+    RestartContainerCmd withSignal(String signal);
+
     /**
-     * @throws NotFoundException
-     *             No such container
+     * @throws NotFoundException No such container
      */
     @Override
     Void exec() throws NotFoundException;

docker-java-core/src/main/java/com/github/dockerjava/core/RemoteApiVersion.java

@@ -91,6 +91,8 @@ public class RemoteApiVersion implements Serializable {
     public static final RemoteApiVersion VERSION_1_37 = RemoteApiVersion.create(1, 37);
     public static final RemoteApiVersion VERSION_1_38 = RemoteApiVersion.create(1, 38);
     public static final RemoteApiVersion VERSION_1_40 = RemoteApiVersion.create(1, 40);
+    public static final RemoteApiVersion VERSION_1_41 = RemoteApiVersion.create(1, 41);
+    public static final RemoteApiVersion VERSION_1_42 = RemoteApiVersion.create(1, 42);
 
 
     /**

docker-java-core/src/main/java/com/github/dockerjava/core/command/RestartContainerCmdImpl.java

@@ -7,19 +7,22 @@
 import com.github.dockerjava.api.command.RestartContainerCmd;
 import com.github.dockerjava.api.exception.NotFoundException;
 
+import javax.annotation.CheckForNull;
+
 /**
  * Restart a running container.
  *
- * @param timeout
- *            - Timeout in seconds before killing the container. Defaults to 10 seconds.
- *
+ * @param signal  - Signal to send to the container as an integer or string (e.g. SIGINT).
+ * @param timeout - Timeout in seconds before killing the container. Defaults to 10 seconds.
  */
 public class RestartContainerCmdImpl extends AbstrDockerCmd<RestartContainerCmd, Void> implements RestartContainerCmd {
 
     private String containerId;
 
     private Integer timeout = 10;
 
+    private String signal;
+
     public RestartContainerCmdImpl(RestartContainerCmd.Exec exec, String containerId) {
         super(exec);
         withContainerId(containerId);
@@ -35,6 +38,15 @@ public Integer getTimeout() {
         return timeout;
     }
 
+    /**
+     * @since {@link com.github.dockerjava.core.RemoteApiVersion#VERSION_1_42}
+     */
+    @CheckForNull
+    @Override
+    public String getSignal() {
+        return signal;
+    }
+
     @Override
     public RestartContainerCmd withContainerId(String containerId) {
         Objects.requireNonNull(containerId, "containerId was not specified");
@@ -50,9 +62,15 @@ public RestartContainerCmd withTimeout(Integer timeout) {
         return this;
     }
 
+    @Override
+    public RestartContainerCmd withSignal(String signal) {
+        Objects.requireNonNull(signal, "signal was not specified");
+        this.signal = signal;
+        return this;
+    }
+
     /**
-     * @throws NotFoundException
-     *             No such container
+     * @throws NotFoundException No such container
      */
     @Override
     public Void exec() throws NotFoundException {

docker-java-core/src/main/java/com/github/dockerjava/core/exec/RestartContainerCmdExec.java

@@ -24,6 +24,10 @@ protected Void execute(RestartContainerCmd command) {
         WebTarget webResource = getBaseResource().path("/containers/{id}/restart").resolveTemplate("id",
                 command.getContainerId());
 
+        if (command.getSignal() != null) {
+            webResource = webResource.queryParam("signal", command.getSignal());
+        }
+
         if (command.getTimeout() != null) {
             webResource = webResource.queryParam("t", String.valueOf(command.getTimeout()));
         }

docker-java/src/test/java/com/github/dockerjava/cmd/RestartContainerCmdImplIT.java

@@ -1,18 +1,24 @@
 package com.github.dockerjava.cmd;
 
+import com.github.dockerjava.api.DockerClient;
 import com.github.dockerjava.api.command.CreateContainerResponse;
 import com.github.dockerjava.api.command.InspectContainerResponse;
 import com.github.dockerjava.api.exception.DockerException;
 import com.github.dockerjava.api.exception.NotFoundException;
+import com.github.dockerjava.core.DefaultDockerClientConfig;
+import com.github.dockerjava.core.RemoteApiVersion;
 import org.junit.Test;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import static com.github.dockerjava.core.DockerRule.DEFAULT_IMAGE;
+import static com.github.dockerjava.junit.DockerMatchers.isGreaterOrEqual;
 import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.emptyString;
 import static org.hamcrest.Matchers.equalTo;
 import static org.hamcrest.Matchers.is;
-import static org.hamcrest.Matchers.emptyString;
 import static org.hamcrest.Matchers.not;
+import static org.junit.Assume.assumeThat;
 
 public class RestartContainerCmdImplIT extends CmdIT {
     public static final Logger LOG = LoggerFactory.getLogger(RestartContainerCmdImplIT.class);
@@ -44,6 +50,41 @@ public void restartContainer() throws DockerException {
         dockerRule.getClient().killContainerCmd(container.getId()).exec();
     }
 
+    @Test
+    public void restartContainerWithSignal() throws Exception {
+        assumeThat("API version should be >= 1.42", dockerRule, isGreaterOrEqual(RemoteApiVersion.VERSION_1_42));
+
+        DefaultDockerClientConfig dockerClientConfig = DefaultDockerClientConfig.createDefaultConfigBuilder()
+            .withApiVersion(RemoteApiVersion.VERSION_1_42)
+            .withRegistryUrl("https://index.docker.io/v1/")
+            .build();
+        try (DockerClient dockerClient = createDockerClient(dockerClientConfig)) {
+            String expectedUserSignal = "10";
+            String initialCommandWithTrap = "trap 'echo \"exit trapped\"' %s; sleep 9999;";
+            final String containerId = dockerClient
+                .createContainerCmd(DEFAULT_IMAGE)
+                .withCmd(
+                    "/bin/sh",
+                    "-c",
+                    String.format(initialCommandWithTrap, expectedUserSignal))
+                .exec()
+                .getId();
+            assertThat(containerId, not(is(emptyString())));
+            dockerClient.startContainerCmd(containerId).exec();
+
+            // Restart container without signal
+            dockerClient.restartContainerCmd(containerId).exec();
+            String log = dockerRule.containerLog(containerId);
+            assertThat(log.trim(), emptyString());
+
+            dockerClient.restartContainerCmd(containerId).withSignal(expectedUserSignal).exec();
+            log = dockerRule.containerLog(containerId);
+            assertThat(log.trim(), is("exit trapped"));
+
+            dockerClient.removeContainerCmd(containerId).withForce(true).withRemoveVolumes(true).exec();
+        }
+    }
+
     @Test(expected = NotFoundException.class)
     public void restartNonExistingContainer() throws DockerException {