[grid] Moving to Docker API 1.41

diemol · diemol · commit fb4d7143dc5f · 2021-06-04T15:07:43.000+02:00
diff --git a/java/server/src/org/openqa/selenium/docker/VersionCommand.java b/java/server/src/org/openqa/selenium/docker/VersionCommand.java
@@ -17,12 +17,9 @@
 
 package org.openqa.selenium.docker;
 
-import static org.openqa.selenium.json.Json.MAP_TYPE;
-import static org.openqa.selenium.remote.http.HttpMethod.GET;
-
 import com.google.common.collect.ImmutableMap;
 
-import org.openqa.selenium.docker.v1_40.V140Docker;
+import org.openqa.selenium.docker.v1_41.V141Docker;
 import org.openqa.selenium.internal.Require;
 import org.openqa.selenium.json.Json;
 import org.openqa.selenium.json.JsonException;
@@ -36,12 +33,15 @@
 import java.util.Optional;
 import java.util.function.Function;
 
+import static org.openqa.selenium.json.Json.MAP_TYPE;
+import static org.openqa.selenium.remote.http.HttpMethod.GET;
+
 class VersionCommand {
 
   private static final Json JSON = new Json();
   // Insertion order matters, and is preserved by ImmutableMap.
-  private static final Map<Version, Function<HttpHandler, DockerProtocol>> SUPPORTED_VERSIONS = ImmutableMap.of(
-    new Version("1.40"), V140Docker::new);
+  private static final Map<Version, Function<HttpHandler, DockerProtocol>>
+    SUPPORTED_VERSIONS = ImmutableMap.of(new Version("1.40"), V141Docker::new);
 
   private final HttpHandler handler;
 
diff --git a/java/server/src/org/openqa/selenium/docker/v1_41/CreateContainer.java b/java/server/src/org/openqa/selenium/docker/v1_41/CreateContainer.java
@@ -15,7 +15,7 @@
 // specific language governing permissions and limitations
 // under the License.
 
-package org.openqa.selenium.docker.v1_40;
+package org.openqa.selenium.docker.v1_41;
 
 import org.openqa.selenium.docker.Container;
 import org.openqa.selenium.docker.ContainerConfig;
@@ -35,6 +35,7 @@
 import java.util.logging.Logger;
 import java.util.stream.Collectors;
 
+import static org.openqa.selenium.docker.v1_41.V141Docker.DOCKER_API_VERSION;
 import static org.openqa.selenium.json.Json.JSON_UTF_8;
 import static org.openqa.selenium.json.Json.MAP_TYPE;
 import static org.openqa.selenium.remote.http.Contents.asJson;
@@ -54,7 +55,7 @@ public CreateContainer(DockerProtocol protocol, HttpHandler client) {
   public Container apply(ContainerConfig info) {
     HttpResponse res = DockerMessages.throwIfNecessary(
       client.execute(
-        new HttpRequest(POST, "/v1.40/containers/create")
+        new HttpRequest(POST, String.format("/v%s/containers/create", DOCKER_API_VERSION))
           .addHeader("Content-Type", JSON_UTF_8)
           .setContent(asJson(info))),
       "Unable to create container: ",
diff --git a/java/server/src/org/openqa/selenium/docker/v1_41/DockerMessages.java b/java/server/src/org/openqa/selenium/docker/v1_41/DockerMessages.java
@@ -15,7 +15,7 @@
 // specific language governing permissions and limitations
 // under the License.
 
-package org.openqa.selenium.docker.v1_40;
+package org.openqa.selenium.docker.v1_41;
 
 import org.openqa.selenium.docker.DockerException;
 import org.openqa.selenium.internal.Require;
diff --git a/java/server/src/org/openqa/selenium/docker/v1_41/GetContainerLogs.java b/java/server/src/org/openqa/selenium/docker/v1_41/GetContainerLogs.java
@@ -15,10 +15,7 @@
 // specific language governing permissions and limitations
 // under the License.
 
-package org.openqa.selenium.docker.v1_40;
-
-import static java.net.HttpURLConnection.HTTP_OK;
-import static org.openqa.selenium.remote.http.HttpMethod.GET;
+package org.openqa.selenium.docker.v1_41;
 
 import org.openqa.selenium.docker.ContainerId;
 import org.openqa.selenium.docker.ContainerLogs;
@@ -32,7 +29,12 @@
 import java.util.List;
 import java.util.logging.Logger;
 
+import static java.net.HttpURLConnection.HTTP_OK;
+import static org.openqa.selenium.docker.v1_41.V141Docker.DOCKER_API_VERSION;
+import static org.openqa.selenium.remote.http.HttpMethod.GET;
+
 class GetContainerLogs {
+
   private static final Logger LOG = Logger.getLogger(GetContainerLogs.class.getName());
   private final HttpHandler client;
 
@@ -44,7 +46,7 @@ public ContainerLogs apply(ContainerId id) {
     Require.nonNull("Container id", id);
 
     String requestUrl =
-      String.format("/v1.40/containers/%s/logs?stdout=true&stderr=true", id);
+      String.format("/v%s/containers/%s/logs?stdout=true&stderr=true", DOCKER_API_VERSION, id);
 
     HttpResponse res = client.execute(
       new HttpRequest(GET, requestUrl)
diff --git a/java/server/src/org/openqa/selenium/docker/v1_41/InspectContainer.java b/java/server/src/org/openqa/selenium/docker/v1_41/InspectContainer.java
@@ -15,7 +15,7 @@
 // specific language governing permissions and limitations
 // under the License.
 
-package org.openqa.selenium.docker.v1_40;
+package org.openqa.selenium.docker.v1_41;
 
 import org.openqa.selenium.docker.ContainerId;
 import org.openqa.selenium.docker.ContainerInfo;
@@ -33,6 +33,7 @@
 import java.util.stream.Collectors;
 
 import static java.net.HttpURLConnection.HTTP_OK;
+import static org.openqa.selenium.docker.v1_41.V141Docker.DOCKER_API_VERSION;
 import static org.openqa.selenium.json.Json.MAP_TYPE;
 import static org.openqa.selenium.remote.http.HttpMethod.GET;
 
@@ -50,7 +51,7 @@ public ContainerInfo apply(ContainerId id) {
     Require.nonNull("Container id", id);
 
     HttpResponse res = client.execute(
-      new HttpRequest(GET, String.format("/v1.40/containers/%s/json", id))
+      new HttpRequest(GET, String.format("/v%s/containers/%s/json", DOCKER_API_VERSION, id))
         .addHeader("Content-Length", "0")
         .addHeader("Content-Type", "text/plain"));
     if (res.getStatus() != HTTP_OK) {
diff --git a/java/server/src/org/openqa/selenium/docker/v1_41/IsContainerPresent.java b/java/server/src/org/openqa/selenium/docker/v1_41/IsContainerPresent.java
@@ -15,14 +15,15 @@
 // specific language governing permissions and limitations
 // under the License.
 
-package org.openqa.selenium.docker.v1_40;
+package org.openqa.selenium.docker.v1_41;
 
 import org.openqa.selenium.docker.ContainerId;
 import org.openqa.selenium.internal.Require;
 import org.openqa.selenium.remote.http.HttpHandler;
 import org.openqa.selenium.remote.http.HttpRequest;
 import org.openqa.selenium.remote.http.HttpResponse;
 
+import static org.openqa.selenium.docker.v1_41.V141Docker.DOCKER_API_VERSION;
 import static org.openqa.selenium.remote.http.HttpMethod.GET;
 
 class IsContainerPresent {
@@ -36,7 +37,7 @@ public boolean apply(ContainerId id) {
     Require.nonNull("Container id", id);
 
     HttpResponse res = client.execute(
-      new HttpRequest(GET, String.format("/v1.40/containers/%s/json", id))
+      new HttpRequest(GET, String.format("/v%s/containers/%s/json", DOCKER_API_VERSION, id))
         .addHeader("Content-Length", "0")
         .addHeader("Content-Type", "text/plain"));
 
diff --git a/java/server/src/org/openqa/selenium/docker/v1_41/ListImages.java b/java/server/src/org/openqa/selenium/docker/v1_41/ListImages.java
@@ -15,9 +15,10 @@
 // specific language governing permissions and limitations
 // under the License.
 
-package org.openqa.selenium.docker.v1_40;
+package org.openqa.selenium.docker.v1_41;
 
 import com.google.common.collect.ImmutableMap;
+
 import org.openqa.selenium.docker.Image;
 import org.openqa.selenium.docker.internal.ImageSummary;
 import org.openqa.selenium.docker.internal.Reference;
@@ -33,6 +34,7 @@
 import java.util.Set;
 
 import static com.google.common.collect.ImmutableSet.toImmutableSet;
+import static org.openqa.selenium.docker.v1_41.V141Docker.DOCKER_API_VERSION;
 import static org.openqa.selenium.json.Json.JSON_UTF_8;
 import static org.openqa.selenium.remote.http.Contents.string;
 import static org.openqa.selenium.remote.http.HttpMethod.GET;
@@ -54,15 +56,15 @@ public Set<Image> apply(Reference reference) {
     String familiarName = reference.getFamiliarName();
     Map<String, Object> filters = ImmutableMap.of("reference", ImmutableMap.of(familiarName, true));
 
-    // https://docs.docker.com/engine/api/v1.40/#operation/ImageList
-    HttpRequest req = new HttpRequest(GET, "/v1.40/images/json")
+    // https://docs.docker.com/engine/api/v1.41/#operation/ImageList
+    HttpRequest req = new HttpRequest(GET, String.format("/v%s/images/json", DOCKER_API_VERSION))
       .addHeader("Content-Length", "0")
       .addHeader("Content-Type", JSON_UTF_8)
       .addQueryParameter("filters", JSON.toJson(filters));
 
     HttpResponse response = DockerMessages.throwIfNecessary(
       client.execute(req),
-    "Unable to list images for %s", reference);
+      "Unable to list images for %s", reference);
 
     Set<ImageSummary> images =
       JSON.toType(string(response), SET_OF_IMAGE_SUMMARIES);
diff --git a/java/server/src/org/openqa/selenium/docker/v1_41/PullImage.java b/java/server/src/org/openqa/selenium/docker/v1_41/PullImage.java
@@ -15,7 +15,7 @@
 // specific language governing permissions and limitations
 // under the License.
 
-package org.openqa.selenium.docker.v1_40;
+package org.openqa.selenium.docker.v1_41;
 
 import org.openqa.selenium.docker.DockerException;
 import org.openqa.selenium.docker.internal.Reference;
@@ -29,6 +29,7 @@
 import java.util.Map;
 import java.util.logging.Logger;
 
+import static org.openqa.selenium.docker.v1_41.V141Docker.DOCKER_API_VERSION;
 import static org.openqa.selenium.json.Json.JSON_UTF_8;
 import static org.openqa.selenium.json.Json.MAP_TYPE;
 import static org.openqa.selenium.remote.http.HttpMethod.POST;
@@ -48,7 +49,7 @@ public void apply(Reference ref) {
     LOG.info("Pulling " + ref);
 
     String image = String.format("%s/%s", ref.getDomain(), ref.getName());
-    HttpRequest req = new HttpRequest(POST, "/v1.40/images/create")
+    HttpRequest req = new HttpRequest(POST, String.format("/v%s/images/create", DOCKER_API_VERSION))
       .addHeader("Content-Type", JSON_UTF_8)
       .addHeader("Content-Length", "0")
       .addQueryParameter("fromImage", image);
diff --git a/java/server/src/org/openqa/selenium/docker/v1_41/StartContainer.java b/java/server/src/org/openqa/selenium/docker/v1_41/StartContainer.java
@@ -15,14 +15,15 @@
 // specific language governing permissions and limitations
 // under the License.
 
-package org.openqa.selenium.docker.v1_40;
+package org.openqa.selenium.docker.v1_41;
 
 import org.openqa.selenium.docker.ContainerId;
 import org.openqa.selenium.internal.Require;
 import org.openqa.selenium.remote.http.HttpHandler;
 import org.openqa.selenium.remote.http.HttpRequest;
 
-import static org.openqa.selenium.docker.v1_40.DockerMessages.throwIfNecessary;
+import static org.openqa.selenium.docker.v1_41.DockerMessages.throwIfNecessary;
+import static org.openqa.selenium.docker.v1_41.V141Docker.DOCKER_API_VERSION;
 import static org.openqa.selenium.remote.http.HttpMethod.POST;
 
 class StartContainer {
@@ -37,7 +38,7 @@ public void apply(ContainerId id) {
 
     throwIfNecessary(
       client.execute(
-        new HttpRequest(POST, String.format("/v1.40/containers/%s/start", id))
+        new HttpRequest(POST, String.format("/v%s/containers/%s/start", DOCKER_API_VERSION, id))
           .addHeader("Content-Length", "0")
           .addHeader("Content-Type", "text/plain")),
       "Unable to start container: %s",
diff --git a/java/server/src/org/openqa/selenium/docker/v1_41/StopContainer.java b/java/server/src/org/openqa/selenium/docker/v1_41/StopContainer.java
@@ -15,7 +15,7 @@
 // specific language governing permissions and limitations
 // under the License.
 
-package org.openqa.selenium.docker.v1_40;
+package org.openqa.selenium.docker.v1_41;
 
 import org.openqa.selenium.docker.ContainerId;
 import org.openqa.selenium.internal.Require;
@@ -24,7 +24,8 @@
 
 import java.time.Duration;
 
-import static org.openqa.selenium.docker.v1_40.DockerMessages.throwIfNecessary;
+import static org.openqa.selenium.docker.v1_41.DockerMessages.throwIfNecessary;
+import static org.openqa.selenium.docker.v1_41.V141Docker.DOCKER_API_VERSION;
 import static org.openqa.selenium.remote.http.HttpMethod.POST;
 
 class StopContainer {
@@ -40,7 +41,8 @@ public void apply(ContainerId id, Duration timeout) {
 
     String seconds = String.valueOf(timeout.toMillis() / 1000);
 
-    HttpRequest request = new HttpRequest(POST, String.format("/v1.40/containers/%s/stop", id))
+    String requestUrl = String.format("/v%s/containers/%s/stop", DOCKER_API_VERSION, id);
+    HttpRequest request = new HttpRequest(POST, requestUrl)
       .addHeader("Content-Length", "0")
       .addHeader("Content-Type", "text/plain")
       .addQueryParameter("t", seconds);
diff --git a/java/server/src/org/openqa/selenium/docker/v1_41/V141Docker.java b/java/server/src/org/openqa/selenium/docker/v1_41/V141Docker.java
@@ -15,7 +15,7 @@
 // specific language governing permissions and limitations
 // under the License.
 
-package org.openqa.selenium.docker.v1_40;
+package org.openqa.selenium.docker.v1_41;
 
 import org.openqa.selenium.docker.Container;
 import org.openqa.selenium.docker.ContainerConfig;
@@ -33,34 +33,35 @@
 import java.util.Set;
 import java.util.logging.Logger;
 
-public class V140Docker implements DockerProtocol {
+public class V141Docker implements DockerProtocol {
 
-  private static final Logger LOG = Logger.getLogger(V140Docker.class.getName());
-  private final ListImages listImages;
+  static final String DOCKER_API_VERSION = "1.41";
+  private static final Logger LOG = Logger.getLogger(V141Docker.class.getName());
+  private final org.openqa.selenium.docker.v1_41.ListImages listImages;
   private final PullImage pullImage;
-  private final CreateContainer createContainer;
+  private final org.openqa.selenium.docker.v1_41.CreateContainer createContainer;
   private final StartContainer startContainer;
   private final StopContainer stopContainer;
   private final IsContainerPresent isContainerPresent;
-  private final InspectContainer inspectContainer;
-  private final GetContainerLogs containerLogs;
+  private final org.openqa.selenium.docker.v1_41.InspectContainer inspectContainer;
+  private final org.openqa.selenium.docker.v1_41.GetContainerLogs containerLogs;
 
-  public V140Docker(HttpHandler client) {
+  public V141Docker(HttpHandler client) {
     Require.nonNull("HTTP client", client);
-    listImages = new ListImages(client);
+    listImages = new org.openqa.selenium.docker.v1_41.ListImages(client);
     pullImage = new PullImage(client);
 
-    createContainer = new CreateContainer(this, client);
+    createContainer = new org.openqa.selenium.docker.v1_41.CreateContainer(this, client);
     startContainer = new StartContainer(client);
     stopContainer = new StopContainer(client);
     isContainerPresent = new IsContainerPresent(client);
-    inspectContainer = new InspectContainer(client);
-    containerLogs = new GetContainerLogs(client);
+    inspectContainer = new org.openqa.selenium.docker.v1_41.InspectContainer(client);
+    containerLogs = new org.openqa.selenium.docker.v1_41.GetContainerLogs(client);
   }
 
   @Override
   public String version() {
-    return "1.40";
+    return DOCKER_API_VERSION;
   }
 
   @Override
diff --git a/java/server/test/org/openqa/selenium/docker/BootstrapTest.java b/java/server/test/org/openqa/selenium/docker/BootstrapTest.java
@@ -72,10 +72,10 @@ public void shouldReportDockerIsUnsupportIfRequestCausesAnIoException() {
   @Test
   public void shouldComplainBitterlyIfNoSupportedVersionOfDockerProtocolIsFound() {
     HttpHandler client = req -> new HttpResponse()
-        .setStatus(HTTP_BAD_REQUEST)
-        .setHeader("Content-Type", "application/json")
-        .setContent(utf8String(
-          "{\"message\":\"client version 1.50 is too new. Maximum supported API version is 1.40\"}"));
+      .setStatus(HTTP_BAD_REQUEST)
+      .setHeader("Content-Type", "application/json")
+      .setContent(utf8String(
+        "{\"message\":\"client version 1.50 is too new. Maximum supported API version is 1.41\"}"));
 
     boolean isSupported = new Docker(client).isSupported();
 
diff --git a/java/server/test/org/openqa/selenium/docker/VersionCommandTest.java b/java/server/test/org/openqa/selenium/docker/VersionCommandTest.java
@@ -29,7 +29,7 @@
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.openqa.selenium.remote.http.Contents.utf8String;
 
-// https://docs.docker.com/engine/api/v1.40/#operation/SystemVersion
+// https://docs.docker.com/engine/api/v1.41/#operation/SystemVersion
 public class VersionCommandTest {
 
   @Test
@@ -79,11 +79,11 @@ public void shouldReturnADockerInstanceIfTheVersionOfTheApiSupportedIsOneSeleniu
     HttpHandler handler = req -> new HttpResponse()
       .addHeader("Content-Type", "application/json")
       // Note: the version here does not exactly match any we claim to provide
-      .setContent(utf8String("{\"ApiVersion\":\"1.41\",\"MinAPIVersion\":\"1.12\"}"));
+      .setContent(utf8String("{\"ApiVersion\":\"1.42\",\"MinAPIVersion\":\"1.12\"}"));
 
     Optional<DockerProtocol> maybeDocker = new VersionCommand(handler).getDockerProtocol();
 
     assertThat(maybeDocker).isNotEqualTo(Optional.empty());
-    assertThat(maybeDocker.get().version()).isEqualTo("1.40");
+    assertThat(maybeDocker.get().version()).isEqualTo("1.41");
   }
 }
diff --git a/java/server/test/org/openqa/selenium/docker/v1_41/ListImagesTest.java b/java/server/test/org/openqa/selenium/docker/v1_41/ListImagesTest.java
@@ -15,7 +15,7 @@
 // specific language governing permissions and limitations
 // under the License.
 
-package org.openqa.selenium.docker.v1_40;
+package org.openqa.selenium.docker.v1_41;
 
 import org.junit.Test;
 import org.openqa.selenium.docker.Image;
