[java] Removing setLegacy from Firefox

This has been deprecated for a while.

Author: diemol

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

@@ -86,11 +86,6 @@ public class FirefoxDriver extends RemoteWebDriver
    */
   @Deprecated
   public static final String PROFILE = Capability.PROFILE;
-  /**
-   * @deprecated Use {@link Capability#MARIONETTE}
-   */
-  @Deprecated
-  public static final String MARIONETTE = Capability.MARIONETTE;
   private final Capabilities capabilities;
   private final RemoteWebStorage webStorage;
   private final HasExtensions extensions;
@@ -300,29 +295,12 @@ public static final class SystemProperty {
      */
     public static final String BROWSER_LOGFILE = "webdriver.firefox.logfile";
 
-    /**
-     * System property that defines the additional library path (Linux only).
-     */
-    public static final String BROWSER_LIBRARY_PATH = "webdriver.firefox.library.path";
-
     /**
      * System property that defines the profile that should be used as a template.
      * When the driver starts, it will make a copy of the profile it is using,
      * rather than using that profile directly.
      */
     public static final String BROWSER_PROFILE = "webdriver.firefox.profile";
-
-    /**
-     * System property that defines the location of the webdriver.xpi browser extension to install
-     * in the browser. If not set, the prebuilt extension bundled with this class will be used.
-     */
-    public static final String DRIVER_XPI_PROPERTY = "webdriver.firefox.driver";
-
-    /**
-     * Boolean system property that instructs FirefoxDriver to use Marionette backend,
-     * overrides any capabilities specified by the user
-     */
-    public static final String DRIVER_USE_MARIONETTE = "webdriver.firefox.marionette";
   }
 
   public static final class Capability {

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

@@ -19,7 +19,6 @@
 
 import static java.util.stream.Collectors.toMap;
 import static org.openqa.selenium.firefox.FirefoxDriver.Capability.BINARY;
-import static org.openqa.selenium.firefox.FirefoxDriver.Capability.MARIONETTE;
 import static org.openqa.selenium.firefox.FirefoxDriver.Capability.PROFILE;
 import static org.openqa.selenium.remote.Browser.FIREFOX;
 
@@ -61,7 +60,6 @@ public class FirefoxOptions extends AbstractDriverOptions<FirefoxOptions> {
   public static final String FIREFOX_OPTIONS = "moz:firefoxOptions";
 
   private Map<String, Object> firefoxOptions = Collections.unmodifiableMap(new TreeMap<>());
-  private boolean legacy;
 
   public FirefoxOptions() {
     setCapability(CapabilityType.BROWSER_NAME, FIREFOX.browserName());
@@ -99,10 +97,6 @@ public FirefoxOptions(Capabilities source) {
 
         this.firefoxOptions = Collections.unmodifiableMap(options);
       }
-
-      if (source.getCapability(MARIONETTE) == Boolean.FALSE) {
-        this.legacy = true;
-      }
     }
   }
 
@@ -117,7 +111,6 @@ private void mirror(FirefoxOptions that) {
     }
 
     this.firefoxOptions = Collections.unmodifiableMap(newOptions);
-    this.legacy = that.legacy;
   }
 
   /**
@@ -150,20 +143,6 @@ public FirefoxOptions configureFromEnv() {
       setProfile(profile);
     }
 
-    String forceMarionette = System.getProperty(FirefoxDriver.SystemProperty.DRIVER_USE_MARIONETTE);
-    if (forceMarionette != null && !Boolean.getBoolean(FirefoxDriver.SystemProperty.DRIVER_USE_MARIONETTE)) {
-      setLegacy(true);
-    }
-
-    return this;
-  }
-
-  /**
-   * @deprecated This method will be deleted and will not be replaced.
-   */
-  @Deprecated
-  public FirefoxOptions setLegacy(boolean legacy) {
-    setCapability(MARIONETTE, !legacy);
     return this;
   }
 
@@ -334,12 +313,6 @@ public void setCapability(String key, Object value) {
         }
         break;
 
-      case MARIONETTE:
-        if (value instanceof Boolean) {
-          legacy = !(Boolean) value;
-        }
-        break;
-
       case PROFILE:
         if (value instanceof FirefoxProfile) {
           setProfile((FirefoxProfile) value);
@@ -380,9 +353,6 @@ protected Set<String> getExtraCapabilityNames() {
     Set<String> names = new TreeSet<>();
 
     names.add(FIREFOX_OPTIONS);
-    if (legacy) {
-      names.add(MARIONETTE);
-    }
 
     return Collections.unmodifiableSet(names);
   }
@@ -391,16 +361,10 @@ protected Set<String> getExtraCapabilityNames() {
   protected Object getExtraCapability(String capabilityName) {
     Require.nonNull("Capability name", capabilityName);
 
-    switch (capabilityName) {
-      case FIREFOX_OPTIONS:
-        return Collections.unmodifiableMap(firefoxOptions);
-
-      case MARIONETTE:
-        return !legacy;
-
-      default:
-        return null;
+    if (FIREFOX_OPTIONS.equals(capabilityName)) {
+      return Collections.unmodifiableMap(firefoxOptions);
     }
+    return null;
   }
 
   @Override

java/src/org/openqa/selenium/server/htmlrunner/HTMLLauncher.java

@@ -17,13 +17,17 @@
 
 package org.openqa.selenium.server.htmlrunner;
 
+import static java.util.concurrent.TimeUnit.SECONDS;
+
+import com.google.common.collect.ImmutableMap;
+
 import com.beust.jcommander.JCommander;
 import com.beust.jcommander.Parameter;
 import com.beust.jcommander.ParameterException;
 import com.beust.jcommander.internal.Console;
-import com.google.common.collect.ImmutableMap;
 import com.thoughtworks.selenium.Selenium;
 import com.thoughtworks.selenium.webdriven.WebDriverBackedSelenium;
+
 import org.openqa.selenium.By;
 import org.openqa.selenium.WebDriver;
 import org.openqa.selenium.WebElement;
@@ -58,8 +62,6 @@
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
-import static java.util.concurrent.TimeUnit.SECONDS;
-
 /**
  * Runs HTML Selenium test suites.
  */
@@ -72,6 +74,100 @@ public class HTMLLauncher {
 
   private Server<?> server;
 
+  private static String printUsage(JCommander commander) {
+    StringBuilder usage = new StringBuilder();
+    commander.setConsole(new Console() {
+      @Override
+      public void print(String msg) {
+        usage.append(msg);
+      }
+
+      @Override
+      public void println(String msg) {
+        usage.append(msg).append("\n");
+      }
+
+      @Override
+      public char[] readPassword(boolean echoInput) {
+        throw new UnsupportedOperationException("readPassword");
+      }
+    });
+    commander.usage();
+
+    return usage.toString();
+  }
+
+  public static int mainInt(String... args) throws Exception {
+    Args processed = new Args();
+    JCommander jCommander = new JCommander(processed);
+    jCommander.setCaseSensitiveOptions(false);
+    try {
+      jCommander.parse(args);
+    } catch (ParameterException ex) {
+      System.err.print(ex.getMessage() + "\n" + printUsage(jCommander));
+      return 0;
+    }
+
+    if (processed.help) {
+      System.err.print(printUsage(jCommander));
+      return 0;
+    }
+
+    warnAboutLegacyOptions(processed);
+
+    Path resultsPath = Paths.get(processed.htmlSuite.get(3));
+    Files.createDirectories(resultsPath);
+
+    String suite = processed.htmlSuite.get(2);
+    String startURL = processed.htmlSuite.get(1);
+    String[] browsers = new String[] {processed.htmlSuite.get(0)};
+
+    HTMLLauncher launcher = new HTMLLauncher();
+
+    boolean passed = true;
+    for (String browser : browsers) {
+      // Turns out that Windows doesn't like "*" in a path name
+      String reportFileName = browser.contains(" ") ? browser.substring(0, browser.indexOf(' ')) : browser;
+      File results = resultsPath.resolve(reportFileName.substring(1) + ".results.html").toFile();
+      String result = "FAILED";
+
+      try {
+        long timeout;
+        try {
+          timeout = Long.parseLong(processed.timeout);
+        } catch (NumberFormatException e) {
+          System.err.println("Timeout does not appear to be a number: " + processed.timeout);
+          return -2;
+        }
+        result = launcher.runHTMLSuite(browser, startURL, suite, results, timeout, processed.userExtensions);
+        passed &= "PASSED".equals(result);
+      } catch (Throwable e) {
+        log.log(Level.WARNING, "Test of browser failed: " + browser, e);
+        passed = false;
+      }
+    }
+
+    return passed ? 1 : 0;
+  }
+
+  private static void warnAboutLegacyOptions(Args processed) {
+    if (processed.multiWindow) {
+      System.err.println("Multi-window mode is no longer used as an option and will be ignored.");
+    }
+
+    if (processed.port != 0) {
+      System.err.println("Port is no longer used as an option and will be ignored.");
+    }
+
+    if (processed.trustAllSSLCertificates) {
+      System.err.println("Trusting all ssl certificates is no longer a user-settable option.");
+    }
+  }
+
+  public static void main(String[] args) throws Exception {
+    System.exit(mainInt(args));
+  }
+
   /**
    * Launches a single HTML Selenium test suite.
    *
@@ -193,100 +289,6 @@ private URL verifySuiteUrl(URL url) throws IOException {
     return url;
  }
 
-  private static String printUsage(JCommander commander) {
-    StringBuilder usage = new StringBuilder();
-    commander.setConsole(new Console() {
-      @Override
-      public void print(String msg) {
-        usage.append(msg);
-      }
-
-      @Override
-      public void println(String msg) {
-        usage.append(msg).append("\n");
-      }
-
-      @Override
-      public char[] readPassword(boolean echoInput) {
-        throw new UnsupportedOperationException("readPassword");
-      }
-    });
-    commander.usage();
-
-    return usage.toString();
-  }
-
-  public static int mainInt(String... args) throws Exception {
-    Args processed = new Args();
-    JCommander jCommander = new JCommander(processed);
-    jCommander.setCaseSensitiveOptions(false);
-    try {
-      jCommander.parse(args);
-    } catch (ParameterException ex) {
-      System.err.print(ex.getMessage() + "\n" + printUsage(jCommander));
-      return 0;
-    }
-
-    if (processed.help) {
-      System.err.print(printUsage(jCommander));
-      return 0;
-    }
-
-    warnAboutLegacyOptions(processed);
-
-    Path resultsPath = Paths.get(processed.htmlSuite.get(3));
-    Files.createDirectories(resultsPath);
-
-    String suite = processed.htmlSuite.get(2);
-    String startURL = processed.htmlSuite.get(1);
-    String[] browsers = new String[] {processed.htmlSuite.get(0)};
-
-    HTMLLauncher launcher = new HTMLLauncher();
-
-    boolean passed = true;
-    for (String browser : browsers) {
-      // Turns out that Windows doesn't like "*" in a path name
-      String reportFileName = browser.contains(" ") ? browser.substring(0, browser.indexOf(' ')) : browser;
-      File results = resultsPath.resolve(reportFileName.substring(1) + ".results.html").toFile();
-      String result = "FAILED";
-
-      try {
-        long timeout;
-        try {
-          timeout = Long.parseLong(processed.timeout);
-        } catch (NumberFormatException e) {
-          System.err.println("Timeout does not appear to be a number: " + processed.timeout);
-          return -2;
-        }
-        result = launcher.runHTMLSuite(browser, startURL, suite, results, timeout, processed.userExtensions);
-        passed &= "PASSED".equals(result);
-      } catch (Throwable e) {
-        log.log(Level.WARNING, "Test of browser failed: " + browser, e);
-        passed = false;
-      }
-    }
-
-    return passed ? 1 : 0;
-  }
-
-  private static void warnAboutLegacyOptions(Args processed) {
-    if (processed.multiWindow) {
-      System.err.println("Multi-window mode is no longer used as an option and will be ignored.");
-    }
-
-    if (processed.port != 0) {
-      System.err.println("Port is no longer used as an option and will be ignored.");
-    }
-
-    if (processed.trustAllSSLCertificates) {
-      System.err.println("Trusting all ssl certificates is no longer a user-settable option.");
-    }
-  }
-
-  public static void main(String[] args) throws Exception {
-    System.exit(mainInt(args));
-  }
-
   private WebDriver createDriver(String browser) {
     String[] parts = browser.split(" ", 2);
     browser = parts[0];
@@ -296,7 +298,7 @@ private WebDriver createDriver(String browser) {
       case "*firefoxproxy":
       case "*firefoxchrome":
       case "*pifirefox":
-        FirefoxOptions options = new FirefoxOptions().setLegacy(false);
+        FirefoxOptions options = new FirefoxOptions();
         if (parts.length > 1) {
           options.setBinary(parts[1]);
         }

java/test/org/openqa/selenium/firefox/FirefoxOptionsTest.java

@@ -264,7 +264,6 @@ public void canConvertOptionsWithBinaryToCapabilitiesAndRestoreBack() throws IOE
   @Test
   public void roundTrippingToCapabilitiesAndBackWorks() {
     FirefoxOptions expected = new FirefoxOptions()
-      .setLegacy(true)
       .addPreference("cake", "walk");
 
     // Convert to a Map so we can create a standalone capabilities instance, which we then use to