Make OperaOptions a MutableCapability

Author: shs96c

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

@@ -34,6 +34,7 @@ public class MutableCapabilities implements Capabilities, Serializable {
     keys.add("chromeOptions");
     keys.add("edgeOptions");
     keys.add("goog:chromeOptions");
+    keys.add("operaOptions");
     keys.add("se:ieOptions");
     keys.add("safari.options");
     OPTION_KEYS = Collections.unmodifiableSet(keys);

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

@@ -132,7 +132,9 @@ public OperaDriver(OperaDriverService service) {
    *
    * @param capabilities The capabilities required from the OperaDriver.
    * @see #OperaDriver(OperaDriverService, Capabilities)
+   * @deprecated Use {@link OperaDriver(OperaOptions}) instead.
    */
+  @Deprecated
   public OperaDriver(Capabilities capabilities) {
     this(OperaDriverService.createDefaultService(), capabilities);
   }
@@ -155,7 +157,7 @@ public OperaDriver(OperaOptions options) {
    * @param options The options to use.
    */
   public OperaDriver(OperaDriverService service, OperaOptions options) {
-    this(service, options.toCapabilities());
+    this(service, (Capabilities) options);
   }
 
   /**
@@ -164,7 +166,9 @@ public OperaDriver(OperaDriverService service, OperaOptions options) {
    *
    * @param service The service to use.
    * @param capabilities The capabilities required from the OperaDriver.
+   * @deprecated Use {@link OperaDriver(OperaDriverService, OperaOptions)} instead.
    */
+  @Deprecated
   public OperaDriver(OperaDriverService service, Capabilities capabilities) {
     super(new DriverCommandExecutor(service), capabilities);
     locationContext = new RemoteLocationContext(getExecuteMethod());

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

@@ -19,22 +19,24 @@
 
 import static com.google.common.base.Preconditions.checkArgument;
 import static com.google.common.base.Preconditions.checkNotNull;
+import static org.openqa.selenium.remote.BrowserType.OPERA_BLINK;
+import static org.openqa.selenium.remote.CapabilityType.BROWSER_NAME;
 
-import com.google.common.base.Objects;
 import com.google.common.collect.ImmutableList;
 import com.google.common.collect.Lists;
 import com.google.common.collect.Maps;
 import com.google.common.io.Files;
-import com.google.gson.Gson;
-import com.google.gson.JsonElement;
 
-import org.openqa.selenium.remote.DesiredCapabilities;
+import org.openqa.selenium.MutableCapabilities;
+import org.openqa.selenium.WebDriverException;
 
 import java.io.File;
 import java.io.IOException;
 import java.util.Base64;
+import java.util.Collections;
 import java.util.List;
 import java.util.Map;
+import java.util.TreeMap;
 
 /**
  * Class to manage options specific to {@link OperaDriver}.
@@ -48,22 +50,16 @@
  * // For use with OperaDriver:
  * OperaDriver driver = new OperaDriver(options);
  *
- * // or alternatively:
- * DesiredCapabilities capabilities = DesiredCapabilities.opera();
- * capabilities.setCapability(OperaOptions.CAPABILITY, options);
- * OperaDriver driver = new OperaDriver(capabilities);
- *
  * // For use with RemoteWebDriver:
- * DesiredCapabilities capabilities = DesiredCapabilities.opera();
- * capabilities.setCapability(ChromeOptions.CAPABILITY, options);
+ * OperaOptions options = new OperaOptions();
  * RemoteWebDriver driver = new RemoteWebDriver(
- *     new URL("http://localhost:4444/wd/hub"), capabilities);
+ *     new URL("http://localhost:4444/wd/hub"), options);
  * </code></pre>
  */
-public class OperaOptions {
+public class OperaOptions extends MutableCapabilities {
 
   /**
-   * Key used to store a set of OperaOptions in a {@link DesiredCapabilities}
+   * Key used to store a set of OperaOptions in a {@link org.openqa.selenium.Capabilities}
    * object.
    */
   public static final String CAPABILITY = "operaOptions";
@@ -74,6 +70,10 @@ public class OperaOptions {
   private List<String> extensions = Lists.newArrayList();
   private Map<String, Object> experimentalOptions = Maps.newHashMap();
 
+  public OperaOptions() {
+    setCapability(BROWSER_NAME, OPERA_BLINK);
+  }
+
   /**
    * Sets the path to the Opera executable. This path should exist on the
    * machine which will launch Opera. The path should either be absolute or
@@ -190,15 +190,12 @@ public Object getExperimentalOption(String name) {
     return experimentalOptions.get(checkNotNull(name));
   }
 
-  /**
-   * Converts this instance to its JSON representation.
-   *
-   * @return The JSON representation of these options.
-   * @throws IOException If an error occurs while reading the
-   *     {@link #addExtensions(java.util.List) extension files} from disk.
-   */
-  public JsonElement toJson() throws IOException {
-    Map<String, Object> options = Maps.newHashMap();
+  @Override
+  public Map<String, ?> asMap() {
+    Map<String, Object> toReturn = new TreeMap<>();
+    toReturn.putAll(super.asMap());
+
+    Map<String, Object> options = new TreeMap<>();
 
     for (String key : experimentalOptions.keySet()) {
       options.put(key, experimentalOptions.get(key));
@@ -213,44 +210,19 @@ public JsonElement toJson() throws IOException {
     List<String> encoded_extensions = Lists.newArrayListWithExpectedSize(
         extensionFiles.size() + extensions.size());
     for (File path : extensionFiles) {
-      String encoded = Base64.getEncoder().encodeToString(Files.toByteArray(path));
-      encoded_extensions.add(encoded);
+      try {
+        String encoded = Base64.getEncoder().encodeToString(Files.toByteArray(path));
+
+        encoded_extensions.add(encoded);
+      } catch (IOException e) {
+        throw new WebDriverException(e);
+      }
     }
     encoded_extensions.addAll(extensions);
     options.put("extensions", encoded_extensions);
 
-    return new Gson().toJsonTree(options);
-  }
-
-  /**
-   * Returns DesiredCapabilities for Opera with these options included as
-   * capabilities. This does not copy the options. Further changes will be
-   * reflected in the returned capabilities.
-   *
-   * @return DesiredCapabilities for Opera with these options.
-   */
-  DesiredCapabilities toCapabilities() {
-    DesiredCapabilities capabilities = DesiredCapabilities.operaBlink();
-    capabilities.setCapability(CAPABILITY, this);
-    return capabilities;
-  }
-
-  @Override
-  public boolean equals(Object other) {
-    if (!(other instanceof OperaOptions)) {
-      return false;
-    }
-    OperaOptions that = (OperaOptions) other;
-    return Objects.equal(this.binary, that.binary)
-        && Objects.equal(this.args, that.args)
-        && Objects.equal(this.extensionFiles, that.extensionFiles)
-        && Objects.equal(this.experimentalOptions, that.experimentalOptions)
-        && Objects.equal(this.extensions, that.extensions);
-  }
+    toReturn.put(CAPABILITY, options);
 
-  @Override
-  public int hashCode() {
-    return Objects.hashCode(this.binary, this.args, this.extensionFiles, this.experimentalOptions,
-        this.extensions);
+    return Collections.unmodifiableMap(toReturn);
   }
 }

java/client/test/org/openqa/selenium/opera/OperaOptionsFunctionalTest.java

@@ -56,7 +56,7 @@ public void optionsStayEqualAfterSerialization() throws Exception {
     OperaOptions options1 = new OperaOptions();
     OperaOptions options2 = new OperaOptions();
     assertTrue("empty opera options should be equal", options1.equals(options2));
-    options1.toJson();
+    options1.asMap();
     assertTrue("empty opera options after one is .toJson() should be equal",
                options1.equals(options2));
   }