SCTP Support (#1341)

elliotsayes · Elliot Sayes · web-flow · commit 472f9275c44a · 2020-03-06T14:57:16.000+03:00
* Add SCTP as InternetProtocol

* Add SCTP as ExposedPort

* Fix documentation in InternetProtocol

* Change import format to how it was previously

* Fixed test failing as JSON mapper uses alphabetical order.

* Tests now use "arrayContainingInAnyOrder" instead of "arrayContaining". Casting test/expected JSON to Map for unordered comparison rather than strict text comparison

* Changed to cast to generic JsonNode class, can then compare entries as arrays

Co-authored-by: Elliot Sayes &lt;Elliot.Sayes@mbie.govt.nz&gt;
diff --git a/docker-java-api/src/main/java/com/github/dockerjava/api/model/ExposedPort.java b/docker-java-api/src/main/java/com/github/dockerjava/api/model/ExposedPort.java
@@ -2,6 +2,7 @@
 
 import static com.github.dockerjava.api.model.InternetProtocol.TCP;
 import static com.github.dockerjava.api.model.InternetProtocol.UDP;
+import static com.github.dockerjava.api.model.InternetProtocol.SCTP;
 
 import java.io.Serializable;
 
@@ -50,7 +51,7 @@ public ExposedPort(int port) {
      * Creates an {@link ExposedPort} for the given parameters.
      *
      * @param scheme
-     *            the {@link #getScheme() scheme}, <code>tcp</code> or <code>udp</code>
+     *            the {@link #getScheme() scheme}, <code>tcp</code>, <code>udp</code> or <code>sctp</code>
      * @param port
      *            the {@link #getPort() port number}
      * @deprecated use {@link #ExposedPort(int, InternetProtocol)}
@@ -68,7 +69,7 @@ public InternetProtocol getProtocol() {
     }
 
     /**
-     * @return the scheme (internet protocol), <code>tcp</code> or <code>udp</code>
+     * @return the scheme (internet protocol), <code>tcp</code>, <code>udp</code> or <code>sctp</code>
      * @deprecated use {@link #getProtocol()}
      */
     @Deprecated
@@ -97,6 +98,14 @@ public static ExposedPort udp(int port) {
         return new ExposedPort(port, UDP);
     }
 
+    /**
+     * Creates an {@link ExposedPort} for {@link InternetProtocol#SCTP}. This is a shortcut for
+     * <code>new ExposedPort(port, {@link InternetProtocol#SCTP})</code>
+     */
+    public static ExposedPort sctp(int port) {
+        return new ExposedPort(port, SCTP);
+    }
+
     /**
      * Parses a textual port specification (as used by the Docker CLI) to an {@link ExposedPort}.
      *
diff --git a/docker-java-api/src/main/java/com/github/dockerjava/api/model/InternetProtocol.java b/docker-java-api/src/main/java/com/github/dockerjava/api/model/InternetProtocol.java
@@ -5,6 +5,7 @@
  *
  * @see #TCP
  * @see #UDP
+ * @see #SCTP
  */
 public enum InternetProtocol {
     /**
@@ -15,7 +16,12 @@ public enum InternetProtocol {
     /**
      * The <i>User Datagram Protocol</i>
      */
-    UDP;
+    UDP,
+
+    /**
+     * The <i>Stream Control Transmission Protocol</i>
+     */
+    SCTP;
 
     /**
      * The default {@link InternetProtocol}: {@link #TCP}
diff --git a/docker-java-api/src/main/java/com/github/dockerjava/api/model/PortConfigProtocol.java b/docker-java-api/src/main/java/com/github/dockerjava/api/model/PortConfigProtocol.java
@@ -11,6 +11,9 @@ public enum PortConfigProtocol {
     TCP,
 
     @JsonProperty("udp")
-    UDP
+    UDP,
+
+    @JsonProperty("sctp")
+    SCTP
 
 }
diff --git a/docker-java/src/test/java/com/github/dockerjava/api/model/ExposedPortsTest.java b/docker-java/src/test/java/com/github/dockerjava/api/model/ExposedPortsTest.java
@@ -1,10 +1,15 @@
 package com.github.dockerjava.api.model;
 
+import com.fasterxml.jackson.databind.JsonNode;
 import com.github.dockerjava.test.serdes.JSONTestHelper;
+import org.apache.commons.compress.utils.Lists;
 import org.junit.Test;
 
-import static org.hamcrest.Matchers.arrayContaining;
-import static org.hamcrest.Matchers.is;
+import java.io.IOException;
+import java.util.List;
+import java.util.Map.Entry;
+
+import static org.hamcrest.Matchers.arrayContainingInAnyOrder;
 import static org.hamcrest.Matchers.notNullValue;
 import static org.junit.Assert.assertThat;
 
@@ -14,21 +19,32 @@ public class ExposedPortsTest {
     public void usesToJson() throws Exception {
         ExposedPorts ports = new ExposedPorts(
                 new ExposedPort(80),
-                new ExposedPort(123, InternetProtocol.UDP)
+                new ExposedPort(123, InternetProtocol.UDP),
+                new ExposedPort(3868, InternetProtocol.SCTP)
         );
         String json = JSONTestHelper.getMapper().writeValueAsString(ports);
+        List<Entry<String, JsonNode>> jsonEntries = getJsonEntries(json);
+
+        String jsonExpected = "{\"80/tcp\":{},\"123/udp\":{},\"3868/sctp\":{}}";
+        List<Entry<String, JsonNode>> jsonEntriesExpected = getJsonEntries(jsonExpected);
+
+        assertThat(jsonEntries.toArray(), arrayContainingInAnyOrder(jsonEntriesExpected.toArray()));
+    }
 
-        assertThat(json, is("{\"80/tcp\":{},\"123/udp\":{}}"));
+    private List<Entry<String, JsonNode>> getJsonEntries(String json) throws Exception {
+        JsonNode jsonNode = JSONTestHelper.getMapper().readValue(json, JsonNode.class);
+        return Lists.newArrayList(jsonNode.fields());
     }
 
     @Test
     public void usesFromJson() throws Exception {
-        ExposedPorts ports = JSONTestHelper.getMapper().readValue("{\"80/tcp\":{},\"123/udp\":{}}", ExposedPorts.class);
+        ExposedPorts ports = JSONTestHelper.getMapper().readValue("{\"80/tcp\":{},\"123/udp\":{},\"3868/sctp\":{}}", ExposedPorts.class);
 
         assertThat(ports, notNullValue());
-        assertThat(ports.getExposedPorts(), arrayContaining(
+        assertThat(ports.getExposedPorts(), arrayContainingInAnyOrder(
                 new ExposedPort(80),
-                new ExposedPort(123, InternetProtocol.UDP)
+                new ExposedPort(123, InternetProtocol.UDP),
+                new ExposedPort(3868, InternetProtocol.SCTP)
         ));
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,9 @@ public enum PortConfigProtocol {`
`11`	`11`	`TCP,`
`12`	`12`
`13`	`13`	`@JsonProperty("udp")`
`14`		`- UDP`
	`14`	`+ UDP,`
	`15`	`+`
	`16`	`+ @JsonProperty("sctp")`
	`17`	`+ SCTP`
`15`	`18`
`16`	`19`	`}`