java: Gathering all Firefox-specific magic system property names to a single interface

Author: barancev

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

@@ -29,6 +29,8 @@
 import com.google.common.collect.Maps;
 import com.google.common.collect.Sets;
 
+import com.sun.javafx.runtime.SystemProperties;
+
 import org.openqa.selenium.Capabilities;
 import org.openqa.selenium.OutputType;
 import org.openqa.selenium.Platform;
@@ -71,6 +73,26 @@
  * profile directly. This allows multiple instances of firefox to be started.
  */
 public class FirefoxDriver extends RemoteWebDriver implements Killable {
+
+  public interface SystemProperty {
+    String BROWSER_BINARY = "webdriver.firefox.bin";
+    String BROWSER_LOGFILE = "webdriver.firefox.logfile";
+    String BROWSER_LIBRARY_PATH = "webdriver.firefox.library.path";
+    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
+     * instead.
+     */
+    String DRIVER_XPI_PROPERTY = "webdriver.firefox.driver";
+
+    /**
+     * Boolean system property that instructs FirefoxDriver to use Marionette backend.
+     */
+    String DRIVER_USE_MARIONETTE = "webdriver.firefox.marionette";
+  }
+
   public static final String BINARY = "firefox_binary";
   public static final String PROFILE = "firefox_profile";
 
@@ -79,7 +101,7 @@ public class FirefoxDriver extends RemoteWebDriver implements Killable {
 
   // For now, only enable native events on Windows
   public static final boolean USE_MARIONETTE = Boolean.parseBoolean(
-      System.getProperty("webdriver.firefox.marionette"));
+      System.getProperty(SystemProperty.DRIVER_USE_MARIONETTE));
 
   // Accept untrusted SSL certificates.
   @Deprecated
@@ -100,18 +122,18 @@ public FirefoxDriver(FirefoxProfile profile) {
   }
 
   public FirefoxDriver(Capabilities desiredCapabilities) {
-    this(getBinary(desiredCapabilities), extractProfile(desiredCapabilities, null), 
+    this(getBinary(desiredCapabilities), extractProfile(desiredCapabilities, null),
         desiredCapabilities);
   }
-  
+
   public FirefoxDriver(Capabilities desiredCapabilities, Capabilities requiredCapabilities) {
-    this(getBinary(desiredCapabilities), extractProfile(desiredCapabilities, requiredCapabilities), 
+    this(getBinary(desiredCapabilities), extractProfile(desiredCapabilities, requiredCapabilities),
         desiredCapabilities, requiredCapabilities);
   }
 
-  private static FirefoxProfile extractProfile(Capabilities desiredCapabilities, 
+  private static FirefoxProfile extractProfile(Capabilities desiredCapabilities,
       Capabilities requiredCapabilities) {
-    
+
     FirefoxProfile profile = null;
     Object raw = null;
     if (desiredCapabilities != null && desiredCapabilities.getCapability(PROFILE) != null) {
@@ -132,10 +154,10 @@ private static FirefoxProfile extractProfile(Capabilities desiredCapabilities,
       }
     }
     profile = getProfile(profile);
-    
+
     populateProfile(profile, desiredCapabilities);
     populateProfile(profile, requiredCapabilities);
-    
+
     return profile;
   }
 
@@ -152,10 +174,10 @@ static void populateProfile(FirefoxProfile profile, Capabilities capabilities) {
       profile.setAcceptUntrustedCertificates(acceptCerts);
     }
     if (capabilities.getCapability(LOGGING_PREFS) != null) {
-      LoggingPreferences logsPrefs = 
+      LoggingPreferences logsPrefs =
           (LoggingPreferences) capabilities.getCapability(LOGGING_PREFS);
       for (String logtype : logsPrefs.getEnabledLogTypes()) {
-        profile.setPreference("webdriver.log." + logtype, 
+        profile.setPreference("webdriver.log." + logtype,
             logsPrefs.getLevel(logtype).intValue());
       }
     }
@@ -185,8 +207,8 @@ public FirefoxDriver(FirefoxBinary binary, FirefoxProfile profile) {
   public FirefoxDriver(FirefoxBinary binary, FirefoxProfile profile, Capabilities capabilities) {
     this(binary, profile, capabilities, null);
   }
-  
-  public FirefoxDriver(FirefoxBinary binary, FirefoxProfile profile, 
+
+  public FirefoxDriver(FirefoxBinary binary, FirefoxProfile profile,
       Capabilities desiredCapabilities, Capabilities requiredCapabilities) {
     super(new LazyCommandExecutor(binary, profile),
           dropCapabilities(desiredCapabilities, BINARY, PROFILE),
@@ -251,12 +273,13 @@ protected void startClient() {
 
   private static FirefoxProfile getProfile(FirefoxProfile profile) {
     FirefoxProfile profileToUse = profile;
-    String suggestedProfile = System.getProperty("webdriver.firefox.profile");
+    String suggestedProfile = System.getProperty(SystemProperty.BROWSER_PROFILE);
     if (profileToUse == null && suggestedProfile != null) {
       profileToUse = new ProfilesIni().getProfile(suggestedProfile);
       if (profileToUse == null) {
-        throw new WebDriverException("Firefox profile '" + suggestedProfile
-            + "' named in system property 'webdriver.firefox.profile' not found");
+        throw new WebDriverException(String.format(
+            "Firefox profile '%s' named in system property '%s' not found",
+            suggestedProfile, SystemProperty.BROWSER_PROFILE));
       }
     } else if (profileToUse == null) {
       profileToUse = new FirefoxProfile();
@@ -292,7 +315,7 @@ protected void stopClient() {
 
   /**
    * Drops capabilities that we shouldn't send over the wire.
-   * 
+   *
    * Used for capabilities which aren't BeanToJson-convertable, and are only used by the local
    * launcher.
    */

java/client/src/org/openqa/selenium/firefox/internal/Executable.java

@@ -22,6 +22,7 @@
 
 import org.openqa.selenium.Platform;
 import org.openqa.selenium.WebDriverException;
+import org.openqa.selenium.firefox.FirefoxDriver;
 import org.openqa.selenium.os.CommandLine;
 import org.openqa.selenium.os.WindowsUtils;
 import org.openqa.selenium.remote.internal.CircularOutputStream;
@@ -101,7 +102,7 @@ public void setLibraryPath(CommandLine command, final Map<String, String> extraE
     // Last, add the contents of the specified system property, defaulting to the binary's path.
 
     // On Snow Leopard, beware of problems the sqlite library
-    String firefoxLibraryPath = System.getProperty("webdriver.firefox.library.path",
+    String firefoxLibraryPath = System.getProperty(FirefoxDriver.SystemProperty.BROWSER_LIBRARY_PATH,
         binary.getAbsoluteFile().getParentFile().getAbsolutePath());
     if (Platform.getCurrent().is(Platform.MAC) && Platform.getCurrent().getMinorVersion() > 5) {
       libraryPath.append(libraryPath).append(File.pathSeparator);
@@ -118,7 +119,7 @@ public void setLibraryPath(CommandLine command, final Map<String, String> extraE
    * be found.
    */
   private static File locateFirefoxBinaryFromSystemProperty() {
-    String binaryName = System.getProperty("webdriver.firefox.bin");
+    String binaryName = System.getProperty(FirefoxDriver.SystemProperty.BROWSER_BINARY);
     if (binaryName == null)
       return null;
 
@@ -142,11 +143,8 @@ private static File locateFirefoxBinaryFromSystemProperty() {
       return binary;
 
     throw new WebDriverException(
-        String
-            .format(
-                "\"webdriver.firefox.bin\" property set, but unable to locate the requested binary: %s",
-                binaryName
-            ));
+        String.format("'%s' property set, but unable to locate the requested binary: %s",
+                      FirefoxDriver.SystemProperty.BROWSER_BINARY, binaryName));
   }
 
   /**
@@ -209,7 +207,7 @@ private static String getEnvVar(String name, String defaultValue) {
   }
 
   public OutputStream getDefaultOutputStream() {
-    String firefoxLogFile = System.getProperty("webdriver.firefox.logfile");
+    String firefoxLogFile = System.getProperty(FirefoxDriver.SystemProperty.BROWSER_LOGFILE);
     if ("/dev/stdout".equals(firefoxLogFile)) {
       return System.out;
     }

java/client/src/org/openqa/selenium/firefox/internal/MarionetteConnection.java

@@ -26,6 +26,7 @@
 import org.openqa.selenium.WebElement;
 import org.openqa.selenium.firefox.ExtensionConnection;
 import org.openqa.selenium.firefox.FirefoxBinary;
+import org.openqa.selenium.firefox.FirefoxDriver;
 import org.openqa.selenium.firefox.FirefoxProfile;
 import org.openqa.selenium.internal.Lock;
 import org.openqa.selenium.logging.LocalLogs;
@@ -108,7 +109,7 @@ public void start() throws IOException {
 
       process.clean(profile, profileDir);
 
-      String firefoxLogFile = System.getProperty("webdriver.firefox.logfile");
+      String firefoxLogFile = System.getProperty(FirefoxDriver.SystemProperty.BROWSER_LOGFILE);
 
       if (firefoxLogFile !=  null) {
         if ("/dev/stdout".equals(firefoxLogFile)) {

java/client/src/org/openqa/selenium/firefox/internal/NewProfileExtensionConnection.java

@@ -22,6 +22,7 @@
 import org.openqa.selenium.WebDriverException;
 import org.openqa.selenium.firefox.ExtensionConnection;
 import org.openqa.selenium.firefox.FirefoxBinary;
+import org.openqa.selenium.firefox.FirefoxDriver;
 import org.openqa.selenium.firefox.FirefoxProfile;
 import org.openqa.selenium.firefox.NotConnectedException;
 import org.openqa.selenium.internal.Lock;
@@ -49,8 +50,11 @@ public class NewProfileExtensionConnection implements ExtensionConnection, Needs
    * 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
    * instead.
+   *
+   * @deprecated Use FirefoxDriver.SystemProperty.DRIVER_XPI_PROPERTY instead
    */
-  public static final String FIREFOX_DRIVER_XPI_PROPERTY = "webdriver.firefox.driver";
+  @Deprecated
+  public static final String FIREFOX_DRIVER_XPI_PROPERTY = FirefoxDriver.SystemProperty.DRIVER_XPI_PROPERTY;
 
   private final static int BUFFER_SIZE = 4096;
 
@@ -92,7 +96,7 @@ public void start() throws IOException {
 
       delegate = new HttpCommandExecutor(buildUrl(host, port));
       delegate.setLocalLogs(logs);
-      String firefoxLogFile = System.getProperty("webdriver.firefox.logfile");
+      String firefoxLogFile = System.getProperty(FirefoxDriver.SystemProperty.BROWSER_LOGFILE);
 
       if (firefoxLogFile !=  null) {
         if ("/dev/stdout".equals(firefoxLogFile)) {
@@ -149,8 +153,9 @@ protected void addWebDriverExtensionIfNeeded() {
   }
 
   private static Optional<Extension> loadCustomExtension() {
-    if (System.getProperty(FIREFOX_DRIVER_XPI_PROPERTY) != null) {
-      File xpi = new File(System.getProperty(FIREFOX_DRIVER_XPI_PROPERTY));
+    String xpiProperty = System.getProperty(FirefoxDriver.SystemProperty.DRIVER_XPI_PROPERTY);
+    if (xpiProperty != null) {
+      File xpi = new File(xpiProperty);
       return Optional.of((Extension) new FileExtension(xpi));
     }
     return Optional.absent();
@@ -205,7 +210,7 @@ public void quit() {
   /**
    * Builds the URL for the Firefox extension running on the given host and port. If the host is
    * {@code localhost}, an attempt will be made to find the correct loopback address.
-   * 
+   *
    * @param host The hostname the extension is running on.
    * @param port The port the extension is listening on.
    * @return The URL of the Firefox extension.