Also pass firefox profile to options on start up

Author: shs96c

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

@@ -18,6 +18,7 @@
 package org.openqa.selenium.firefox;
 
 import static org.openqa.selenium.Platform.WINDOWS;
+import static org.openqa.selenium.firefox.FirefoxOptions.FIREFOX_OPTIONS;
 import static org.openqa.selenium.remote.CapabilityType.ACCEPT_SSL_CERTS;
 import static org.openqa.selenium.remote.CapabilityType.HAS_NATIVE_EVENTS;
 import static org.openqa.selenium.remote.CapabilityType.LOGGING_PREFS;
@@ -192,6 +193,21 @@ static void populateProfile(FirefoxProfile profile, Capabilities capabilities) {
       Boolean nativeEventsEnabled = (Boolean) capabilities.getCapability(HAS_NATIVE_EVENTS);
       profile.setEnableNativeEvents(nativeEventsEnabled);
     }
+
+    Object rawOptions = capabilities.getCapability(FIREFOX_OPTIONS);
+    if (rawOptions != null && !(rawOptions instanceof FirefoxOptions)) {
+      throw new WebDriverException("Firefox option was set, but is not a FirefoxOption: " + rawOptions);
+    }
+    FirefoxOptions options = (FirefoxOptions) rawOptions;
+    if (options == null) {
+      options = new FirefoxOptions();
+    }
+    options.setProfileSafely(profile);
+
+    DesiredCapabilities toReturn = capabilities instanceof DesiredCapabilities ?
+                                   (DesiredCapabilities) capabilities :
+                                   new DesiredCapabilities(capabilities);
+    toReturn.setCapability(FIREFOX_OPTIONS, options);
   }
 
   private static FirefoxBinary getBinary(Capabilities capabilities) {

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

@@ -21,6 +21,7 @@
 import static org.openqa.selenium.firefox.FirefoxDriver.BINARY;
 import static org.openqa.selenium.firefox.FirefoxDriver.PROFILE;
 
+import com.google.common.base.Preconditions;
 import com.google.common.collect.ImmutableList;
 import com.google.gson.JsonArray;
 import com.google.gson.JsonElement;
@@ -53,6 +54,8 @@
  */
 public class FirefoxOptions {
 
+  public final static String FIREFOX_OPTIONS = "firefoxOptions";
+
   private String binary;
   private FirefoxProfile profile;
   private List<String> args = new ArrayList<>();
@@ -74,6 +77,14 @@ public FirefoxOptions setProfile(FirefoxProfile profile) {
     return this;
   }
 
+  // Confusing API. Keeping package visible only
+  FirefoxOptions setProfileSafely(FirefoxProfile profile) {
+    Preconditions.checkState(
+      this.profile == null || this.profile.equals(profile),
+      "Profile passed to options is different from existing profile that has been set.");
+    return setProfile(profile);
+  }
+
   public FirefoxOptions addArguments(String... arguments) {
     addArguments(ImmutableList.copyOf(arguments));
     return this;
@@ -120,7 +131,7 @@ public DesiredCapabilities addTo(DesiredCapabilities capabilities) {
       }
     }
 
-    capabilities.setCapability("firefoxOptions", this);
+    capabilities.setCapability(FIREFOX_OPTIONS, this);
 
     if (binary != null) {
       FirefoxBinary actualBinary = new FirefoxBinary(new File(binary));