[java] Making merge method in classes that implement Capabilities to return a new instance as specified in the Capabilities interface.

Author: barancev

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

@@ -100,7 +100,7 @@ public void setCapability(String key, Object value) {
     // and this is no longer needed as options are capabilities. There will be a large amount of
     // legacy code that will always try and follow this pattern, however.
     if (OPTION_KEYS.contains(key) && value instanceof Capabilities) {
-      merge((Capabilities) value);
+      ((Capabilities) value).asMap().forEach(this::setCapability);
       return;
     }
 

java/client/src/org/openqa/selenium/chrome/ChromeOptions.java

@@ -62,8 +62,15 @@ public ChromeOptions setLogLevel(ChromeDriverLogLevel logLevel){
     return this;
   }
 
+  @Override
+  public ChromeOptions merge(Capabilities extraCapabilities) {
+    ChromeOptions newInstance = new ChromeOptions();
+    this.asMap().forEach(newInstance::setCapability);
+    extraCapabilities.asMap().forEach(newInstance::setCapability);
+    return newInstance;
+  }
+
   public ChromeDriverLogLevel getLogLevel(){
     return logLevel;
   }
-
 }

java/client/src/org/openqa/selenium/chromium/ChromiumOptions.java

@@ -74,12 +74,6 @@ public ChromiumOptions(String capabilityType, String browserType, String capabil
     setCapability(capabilityType, browserType);
   }
 
-  @Override
-  public T merge(Capabilities extraCapabilities) {
-    super.merge(extraCapabilities);
-    return (T) this;
-  }
-
   /**
    * Sets the path to the Chrome executable. This path should exist on the
    * machine which will launch Chrome. The path should either be absolute or

java/client/src/org/openqa/selenium/edge/EdgeOptions.java

@@ -17,6 +17,7 @@
 package org.openqa.selenium.edge;
 
 import org.openqa.selenium.Capabilities;
+import org.openqa.selenium.chrome.ChromeOptions;
 import org.openqa.selenium.chromium.ChromiumOptions;
 import org.openqa.selenium.remote.BrowserType;
 import org.openqa.selenium.remote.CapabilityType;
@@ -56,4 +57,12 @@ public class EdgeOptions extends ChromiumOptions<EdgeOptions> {
   public EdgeOptions() {
     super(CapabilityType.BROWSER_NAME, BrowserType.EDGE, CAPABILITY);
   }
+
+  @Override
+  public EdgeOptions merge(Capabilities extraCapabilities) {
+    EdgeOptions newInstance = new EdgeOptions();
+    this.asMap().forEach(newInstance::setCapability);
+    extraCapabilities.asMap().forEach(newInstance::setCapability);
+    return newInstance;
+  }
 }

java/client/src/org/openqa/selenium/edgehtml/EdgeHtmlOptions.java

@@ -19,6 +19,7 @@
 import static org.openqa.selenium.remote.CapabilityType.BROWSER_NAME;
 
 import org.openqa.selenium.Capabilities;
+import org.openqa.selenium.edge.EdgeOptions;
 import org.openqa.selenium.remote.AbstractDriverOptions;
 import org.openqa.selenium.remote.BrowserType;
 
@@ -59,7 +60,9 @@ public EdgeHtmlOptions() {
 
   @Override
   public EdgeHtmlOptions merge(Capabilities extraCapabilities) {
-    super.merge(extraCapabilities);
-    return this;
+    EdgeHtmlOptions newInstance = new EdgeHtmlOptions();
+    this.asMap().forEach(newInstance::setCapability);
+    extraCapabilities.asMap().forEach(newInstance::setCapability);
+    return newInstance;
   }
 }

java/client/src/org/openqa/selenium/firefox/FirefoxOptions.java

@@ -325,11 +325,13 @@ public Map<String, Object> asMap() {
 
   @Override
   public FirefoxOptions merge(Capabilities capabilities) {
-    super.merge(capabilities);
+    FirefoxOptions newInstance = new FirefoxOptions();
+    this.asMap().forEach(newInstance::setCapability);
+    capabilities.asMap().forEach(newInstance::setCapability);
     if (capabilities instanceof FirefoxOptions) {
-      mirror((FirefoxOptions) capabilities);
+      newInstance.mirror((FirefoxOptions) capabilities);
     }
-    return this;
+    return newInstance;
   }
 
   @Override

java/client/src/org/openqa/selenium/ie/InternetExplorerOptions.java

@@ -32,6 +32,7 @@
 import static org.openqa.selenium.ie.InternetExplorerDriver.REQUIRE_WINDOW_FOCUS;
 import static org.openqa.selenium.remote.CapabilityType.BROWSER_NAME;
 
+import org.openqa.selenium.edgehtml.EdgeHtmlOptions;
 import org.openqa.selenium.internal.Require;
 import org.openqa.selenium.remote.AbstractDriverOptions;
 import org.openqa.selenium.Beta;
@@ -98,8 +99,10 @@ public InternetExplorerOptions(Capabilities source) {
 
   @Override
   public InternetExplorerOptions merge(Capabilities extraCapabilities) {
-    super.merge(extraCapabilities);
-    return this;
+    InternetExplorerOptions newInstance = new InternetExplorerOptions();
+    this.asMap().forEach(newInstance::setCapability);
+    extraCapabilities.asMap().forEach(newInstance::setCapability);
+    return newInstance;
   }
 
   public InternetExplorerOptions withAttachTimeout(long duration, TimeUnit unit) {

java/client/src/org/openqa/selenium/opera/OperaOptions.java

@@ -22,6 +22,7 @@
 import static org.openqa.selenium.remote.BrowserType.OPERA_BLINK;
 import static org.openqa.selenium.remote.CapabilityType.BROWSER_NAME;
 
+import org.openqa.selenium.edge.EdgeOptions;
 import org.openqa.selenium.internal.Require;
 import org.openqa.selenium.remote.AbstractDriverOptions;
 import org.openqa.selenium.Capabilities;
@@ -76,8 +77,10 @@ public OperaOptions() {
 
   @Override
   public OperaOptions merge(Capabilities extraCapabilities) {
-    super.merge(extraCapabilities);
-    return this;
+    OperaOptions newInstance = new OperaOptions();
+    this.asMap().forEach(newInstance::setCapability);
+    extraCapabilities.asMap().forEach(newInstance::setCapability);
+    return newInstance;
   }
 
   /**

java/client/src/org/openqa/selenium/safari/SafariOptions.java

@@ -21,6 +21,7 @@
 import static org.openqa.selenium.remote.CapabilityType.BROWSER_NAME;
 
 import org.openqa.selenium.MutableCapabilities;
+import org.openqa.selenium.edge.EdgeOptions;
 import org.openqa.selenium.remote.AbstractDriverOptions;
 import org.openqa.selenium.Capabilities;
 import org.openqa.selenium.WebDriverException;
@@ -87,8 +88,10 @@ public SafariOptions(Capabilities source) {
 
   @Override
   public SafariOptions merge(Capabilities extraCapabilities) {
-    super.merge(extraCapabilities);
-    return this;
+    SafariOptions newInstance = new SafariOptions();
+    this.asMap().forEach(newInstance::setCapability);
+    extraCapabilities.asMap().forEach(newInstance::setCapability);
+    return newInstance;
   }
 
   /**

java/client/test/org/openqa/selenium/testing/drivers/TestChromeDriver.java

@@ -76,7 +76,7 @@ private static ChromeOptions chromeWithCustomCapabilities(Capabilities originalC
     }
 
     if (originalCapabilities != null) {
-      options.merge(originalCapabilities);
+      options = options.merge(originalCapabilities);
     }
 
     return options;