Fixing Proxy to match W3C Editor Draft

Author: barancev

java/client/src/org/openqa/selenium/Proxy.java

@@ -53,7 +53,7 @@ public enum ProxyType {
   private String noProxy;
   private String sslProxy;
   private String socksProxy;
-  private String socksVersion;
+  private Integer socksVersion;
   private String socksUsername;
   private String socksPassword;
   private String proxyAutoconfigUrl;
@@ -82,7 +82,7 @@ public Proxy(Map<String, ?> raw) {
       setSocksProxy((String) raw.get("socksProxy"));
     }
     if (raw.containsKey("socksVersion") && raw.get("socksVersion") != null) {
-      setSocksProxy((String) raw.get("socksVersion"));
+      setSocksVersion((Integer) raw.get("socksVersion"));
     }
     if (raw.containsKey("socksUsername") && raw.get("socksUsername") != null) {
       setSocksUsername((String) raw.get("socksUsername"));
@@ -120,7 +120,7 @@ public Map<String, Object> toJson() {
       m.put("socksProxy", socksProxy);
     }
     if (socksVersion != null) {
-      m.put("socksProxyVersion", socksVersion);
+      m.put("socksVersion", socksVersion);
     }
     if (socksUsername != null) {
       m.put("socksUsername", socksUsername);
@@ -305,7 +305,7 @@ public Proxy setSocksProxy(String socksProxy) {
    *
    * @return the SOCKS version if present, null otherwise
    */
-  public String getSocksVersion() {
+  public Integer getSocksVersion() {
     return socksVersion;
   }
 
@@ -315,7 +315,7 @@ public String getSocksVersion() {
    * @param socksVersion SOCKS version, 4 or 5
    * @return reference to self
    */
-  public Proxy setSocksVersion(String socksVersion) {
+  public Proxy setSocksVersion(Integer socksVersion) {
     verifyProxyTypeCompatibility(ProxyType.MANUAL);
     this.proxyType = ProxyType.MANUAL;
     this.socksVersion = socksVersion;

java/client/test/org/openqa/selenium/ProxyTest.java

@@ -52,6 +52,7 @@ public void testNotInitializedProxy() {
     assertNull(proxy.getHttpProxy());
     assertNull(proxy.getSslProxy());
     assertNull(proxy.getSocksProxy());
+    assertNull(proxy.getSocksVersion());
     assertNull(proxy.getSocksUsername());
     assertNull(proxy.getSocksPassword());
     assertNull(proxy.getNoProxy());
@@ -99,6 +100,9 @@ public void testCanNotChangeAlreadyInitializedProxyType() {
 
     Throwable t11 = catchThrowable(() -> proxy2.setProxyType(ProxyType.SYSTEM));
     assertThat(t11, instanceOf(IllegalStateException.class));
+
+    Throwable t12 = catchThrowable(() -> proxy.setSocksVersion(5));
+    assertThat(t12, instanceOf(IllegalStateException.class));
   }
 
   @Test
@@ -111,6 +115,7 @@ public void testManualProxy() {
         setSslProxy("ssl.proxy").
         setNoProxy("localhost,127.0.0.*").
         setSocksProxy("socks.proxy:65555").
+        setSocksVersion(5).
         setSocksUsername("test1").
         setSocksPassword("test2");
 
@@ -119,6 +124,7 @@ public void testManualProxy() {
     assertEquals("http.proxy:1234", proxy.getHttpProxy());
     assertEquals("ssl.proxy", proxy.getSslProxy());
     assertEquals("socks.proxy:65555", proxy.getSocksProxy());
+    assertEquals(Integer.valueOf(5), proxy.getSocksVersion());
     assertEquals("test1", proxy.getSocksUsername());
     assertEquals("test2", proxy.getSocksPassword());
     assertEquals("localhost,127.0.0.*", proxy.getNoProxy());
@@ -139,6 +145,7 @@ public void testPACProxy() {
     assertNull(proxy.getHttpProxy());
     assertNull(proxy.getSslProxy());
     assertNull(proxy.getSocksProxy());
+    assertNull(proxy.getSocksVersion());
     assertNull(proxy.getSocksUsername());
     assertNull(proxy.getSocksPassword());
     assertNull(proxy.getNoProxy());
@@ -157,6 +164,7 @@ public void testAutodetectProxy() {
     assertNull(proxy.getHttpProxy());
     assertNull(proxy.getSslProxy());
     assertNull(proxy.getSocksProxy());
+    assertNull(proxy.getSocksVersion());
     assertNull(proxy.getSocksUsername());
     assertNull(proxy.getSocksPassword());
     assertNull(proxy.getNoProxy());
@@ -166,13 +174,14 @@ public void testAutodetectProxy() {
 
   @Test
   public void manualProxyFromMap() {
-    Map<String, String> proxyData = new HashMap<>();
+    Map<String, Object> proxyData = new HashMap<>();
     proxyData.put("proxyType", "manual");
     proxyData.put("httpProxy", "http.proxy:1234");
     proxyData.put("ftpProxy", "ftp.proxy");
     proxyData.put("sslProxy", "ssl.proxy");
     proxyData.put("noProxy", "localhost,127.0.0.*");
     proxyData.put("socksProxy", "socks.proxy:65555");
+    proxyData.put("socksVersion", 5);
     proxyData.put("socksUsername", "test1");
     proxyData.put("socksPassword", "test2");
 
@@ -183,6 +192,7 @@ public void manualProxyFromMap() {
     assertEquals("http.proxy:1234", proxy.getHttpProxy());
     assertEquals("ssl.proxy", proxy.getSslProxy());
     assertEquals("socks.proxy:65555", proxy.getSocksProxy());
+    assertEquals(Integer.valueOf(5), proxy.getSocksVersion());
     assertEquals("test1", proxy.getSocksUsername());
     assertEquals("test2", proxy.getSocksPassword());
     assertEquals("localhost,127.0.0.*", proxy.getNoProxy());
@@ -200,6 +210,7 @@ public void manualProxyToJson() {
     proxy.setSslProxy("ssl.proxy");
     proxy.setNoProxy("localhost,127.0.0.*");
     proxy.setSocksProxy("socks.proxy:65555");
+    proxy.setSocksVersion(5);
     proxy.setSocksUsername("test1");
     proxy.setSocksPassword("test2");
 
@@ -210,10 +221,11 @@ public void manualProxyToJson() {
     assertEquals("http.proxy:1234", json.get("httpProxy"));
     assertEquals("ssl.proxy", json.get("sslProxy"));
     assertEquals("socks.proxy:65555", json.get("socksProxy"));
+    assertEquals(5, json.get("socksVersion"));
     assertEquals("test1", json.get("socksUsername"));
     assertEquals("test2", json.get("socksPassword"));
     assertEquals("localhost,127.0.0.*", json.get("noProxy"));
-    assertEquals(8, json.entrySet().size());
+    assertEquals(9, json.entrySet().size());
   }
 
   @Test
@@ -231,6 +243,7 @@ public void pacProxyFromMap() {
     assertNull(proxy.getHttpProxy());
     assertNull(proxy.getSslProxy());
     assertNull(proxy.getSocksProxy());
+    assertNull(proxy.getSocksVersion());
     assertNull(proxy.getSocksUsername());
     assertNull(proxy.getSocksPassword());
     assertNull(proxy.getNoProxy());
@@ -265,6 +278,7 @@ public void autodetectProxyFromMap() {
     assertNull(proxy.getHttpProxy());
     assertNull(proxy.getSslProxy());
     assertNull(proxy.getSocksProxy());
+    assertNull(proxy.getSocksVersion());
     assertNull(proxy.getSocksUsername());
     assertNull(proxy.getSocksPassword());
     assertNull(proxy.getNoProxy());
@@ -297,6 +311,7 @@ public void systemProxyFromMap() {
     assertNull(proxy.getHttpProxy());
     assertNull(proxy.getSslProxy());
     assertNull(proxy.getSocksProxy());
+    assertNull(proxy.getSocksVersion());
     assertNull(proxy.getSocksUsername());
     assertNull(proxy.getSocksPassword());
     assertNull(proxy.getNoProxy());
@@ -328,6 +343,7 @@ public void directProxyFromMap() {
     assertNull(proxy.getHttpProxy());
     assertNull(proxy.getSslProxy());
     assertNull(proxy.getSocksProxy());
+    assertNull(proxy.getSocksVersion());
     assertNull(proxy.getSocksUsername());
     assertNull(proxy.getSocksPassword());
     assertNull(proxy.getNoProxy());