Add tests for starting firefox remotely

I can't believe how much chaos this is causing us. Fixing
these tests revealed a flaw in how we were setting the
legacy flag.

Author: shs96c

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

@@ -273,7 +273,10 @@ private static FirefoxOptions getFirefoxOptions(Capabilities capabilities) {
       options = (FirefoxOptions) rawOptions;
     }
 
-    options.setLegacy(!capabilities.is(MARIONETTE));
+    Object marionette = capabilities.getCapability(MARIONETTE);
+    if (marionette instanceof Boolean) {
+      options.setLegacy(!(Boolean) marionette);
+    }
     return options;
   }
 

java/client/test/org/openqa/selenium/remote/BUCK

@@ -58,10 +58,13 @@ java_test(name = 'remote-driver-tests',
 
 java_library(name = 'remote-driver-test-lib',
   srcs = [
+    'RemoteSpecificTests.java',
     'RemoteWebDriverScreenshotTest.java',
+    'StartingFirefoxRemotelyTest.java',
   ],
   deps = [
     '//java/client/src/org/openqa/selenium:selenium',
+    '//java/client/src/org/openqa/selenium/firefox:firefox',
     '//java/client/src/org/openqa/selenium/remote:remote',
     '//java/client/test/org/openqa/selenium/testing:test-base',
     '//java/client/test/org/openqa/selenium/testing/drivers:drivers',

java/client/test/org/openqa/selenium/remote/RemoteSpecificTests.java

@@ -0,0 +1,29 @@
+// Licensed to the Software Freedom Conservancy (SFC) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The SFC licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+package org.openqa.selenium.remote;
+
+import org.junit.runner.RunWith;
+import org.junit.runners.Suite;
+
+@RunWith(Suite.class)
+@Suite.SuiteClasses({
+    RemoteWebDriverScreenshotTest.class,
+    StartingFirefoxRemotelyTest.class
+})
+public class RemoteSpecificTests {
+}

java/client/test/org/openqa/selenium/remote/RemoteWebDriverTests.java

@@ -24,7 +24,7 @@
 @RunWith(Suite.class)
 @Suite.SuiteClasses({
     StandardSeleniumTests.class,
-    RemoteWebDriverScreenshotTest.class
+    RemoteSpecificTests.class
 })
 public class RemoteWebDriverTests {
 }

java/client/test/org/openqa/selenium/remote/StartingFirefoxRemotelyTest.java

@@ -0,0 +1,112 @@
+// Licensed to the Software Freedom Conservancy (SFC) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The SFC licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+package org.openqa.selenium.remote;
+
+import static org.junit.Assert.assertEquals;
+
+import org.junit.After;
+import org.junit.Assume;
+import org.junit.Before;
+import org.junit.BeforeClass;
+import org.junit.Test;
+import org.openqa.selenium.WebDriver;
+import org.openqa.selenium.firefox.FirefoxDriver;
+import org.openqa.selenium.firefox.FirefoxOptions;
+import org.openqa.selenium.firefox.FirefoxProfile;
+import org.openqa.selenium.testing.JUnit4TestBase;
+
+import java.net.URL;
+
+public class StartingFirefoxRemotelyTest extends JUnit4TestBase {
+
+  private URL remoteUrl;
+  private WebDriver localDriver;
+
+  @BeforeClass
+  public static void ensureTestingFirefox() {
+    Assume.assumeTrue("ff".equals(System.getProperty("selenium.browser")));
+  }
+
+  @Before
+  public void getRemoteServerUrl() {
+    CommandExecutor executor = ((RemoteWebDriver) driver).getCommandExecutor();
+    Assume.assumeTrue(executor instanceof HttpCommandExecutor);
+
+    remoteUrl = ((HttpCommandExecutor) executor).getAddressOfRemoteServer();
+  }
+
+  @After
+  public void quiteDriver() {
+    if (localDriver != null) {
+      localDriver.quit();
+    }
+  }
+
+  @Test
+  public void canSetProfileThroughDesiredCapabilities() {
+    DesiredCapabilities caps = new DesiredCapabilities();
+    caps.setBrowserName(DesiredCapabilities.firefox().getBrowserName());
+    caps.setCapability(FirefoxDriver.PROFILE, new FirefoxProfile());
+    caps.setCapability(FirefoxDriver.MARIONETTE, true);
+
+    localDriver = new RemoteWebDriver(remoteUrl, caps);
+    localDriver.get(pages.xhtmlTestPage);
+    assertEquals("XHTML Test Page", localDriver.getTitle());
+  }
+
+  @Test
+  public void canSetProfileThroughFirefoxOptions() {
+    DesiredCapabilities caps = new DesiredCapabilities();
+    caps.setBrowserName(DesiredCapabilities.firefox().getBrowserName());
+
+    FirefoxOptions options = new FirefoxOptions();
+    options.setProfile(new FirefoxProfile());
+    caps.setCapability(FirefoxOptions.FIREFOX_OPTIONS, options);
+
+    localDriver = new RemoteWebDriver(remoteUrl, caps);
+    localDriver.get(pages.xhtmlTestPage);
+    assertEquals("XHTML Test Page", localDriver.getTitle());
+  }
+
+  @Test
+  public void shouldBeAbleToMergeDesiredOptionsIntoFirefoxOptions() {
+    DesiredCapabilities caps = new DesiredCapabilities();
+    caps.setBrowserName(DesiredCapabilities.firefox().getBrowserName());
+
+    FirefoxOptions options = new FirefoxOptions();
+    options.setProfile(new FirefoxProfile());
+    options.addDesiredCapabilities(caps);
+
+    localDriver = new RemoteWebDriver(remoteUrl, options.toDesiredCapabilities());
+    localDriver.get(pages.xhtmlTestPage);
+    assertEquals("XHTML Test Page", localDriver.getTitle());
+  }
+
+  @Test
+  public void canStartFirefoxWithoutAnyConfigurationOptions() {
+    DesiredCapabilities caps = new DesiredCapabilities();
+    caps.setBrowserName(DesiredCapabilities.firefox().getBrowserName());
+
+    FirefoxOptions options = new FirefoxOptions();
+    options.addDesiredCapabilities(caps);
+
+    localDriver = new RemoteWebDriver(remoteUrl, options.toDesiredCapabilities());
+    localDriver.get(pages.xhtmlTestPage);
+    assertEquals("XHTML Test Page", localDriver.getTitle());
+  }
+}