java: Adding getters to FirefoxProfile to allow reading preset preference values

Author: barancev

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

@@ -70,7 +70,7 @@ public FirefoxProfile() {
    * Constructs a firefox profile from an existing profile directory.
    * <p>
    * Users who need this functionality should consider using a named profile.
-   * 
+   *
    * @param profileDir The profile directory to use as a model.
    */
   public FirefoxProfile(File profileDir) {
@@ -143,10 +143,26 @@ private boolean getBooleanPreference(Preferences prefs, String key, boolean defa
     throw new WebDriverException("Expected boolean value is not a boolean. It is: " + value);
   }
 
+  public String getStringPreference(String key, String defaultValue) {
+    Object preference = additionalPrefs.getPreference(key);
+    if(preference != null && preference instanceof String){
+      return (String) preference;
+    }
+    return defaultValue;
+  }
+
   public int getIntegerPreference(String key, int defaultValue) {
-    Object preference=additionalPrefs.getPreference(key);
-    if(preference!=null && preference instanceof Integer){
-      return (Integer)preference;
+    Object preference = additionalPrefs.getPreference(key);
+    if(preference != null && preference instanceof Integer){
+      return (Integer) preference;
+    }
+    return defaultValue;
+  }
+
+  public boolean getBooleanPreference(String key, boolean defaultValue) {
+    Object preference = additionalPrefs.getPreference(key);
+    if(preference != null && preference instanceof Boolean){
+      return (Boolean) preference;
     }
     return defaultValue;
   }
@@ -184,7 +200,7 @@ public void addExtension(Class<?> loadResourcesUsing, String loadFrom) throws IO
 
   /**
    * Attempt to add an extension to install into this instance.
-   * 
+   *
    * @param extensionToInstall
    * @throws IOException
    */
@@ -210,7 +226,7 @@ private String deriveExtensionName(String originalName) {
    * Note that if a value looks as if it is a quoted string (that is, starts with a quote character
    * and ends with one too) an IllegalArgumentException is thrown: Firefox fails to start properly
    * when some values are set to this.
-   * 
+   *
    * @param key The key
    * @param value The new value.
    */
@@ -220,7 +236,7 @@ public void setPreference(String key, String value) {
 
   /**
    * Set a preference for this particular profile.
-   * 
+   *
    * @param key The key
    * @param value The new value.
    */
@@ -230,7 +246,7 @@ public void setPreference(String key, boolean value) {
 
   /**
    * Set a preference for this particular profile.
-   * 
+   *
    * @param key The key
    * @param value The new value.
    */
@@ -315,7 +331,7 @@ public void setEnableNativeEvents(boolean enableNativeEvents) {
   /**
    * Returns whether the no focus library should be loaded for Firefox profiles launched on Linux,
    * even if native events are disabled.
-   * 
+   *
    * @return Whether the no focus library should always be loaded for Firefox on Linux.
    */
   public boolean shouldLoadNoFocusLib() {
@@ -324,7 +340,7 @@ public boolean shouldLoadNoFocusLib() {
 
   /**
    * Sets whether the no focus library should always be loaded on Linux.
-   * 
+   *
    * @param loadNoFocusLib Whether to always load the no focus library.
    */
   public void setAlwaysLoadNoFocusLib(boolean loadNoFocusLib) {
@@ -334,7 +350,7 @@ public void setAlwaysLoadNoFocusLib(boolean loadNoFocusLib) {
   /**
    * Sets whether Firefox should accept SSL certificates which have expired, signed by an unknown
    * authority or are generally untrusted. This is set to true by default.
-   * 
+   *
    * @param acceptUntrustedSsl Whether untrusted SSL certificates should be accepted.
    */
 
@@ -353,7 +369,7 @@ public void setAcceptUntrustedCertificates(boolean acceptUntrustedSsl) {
    * If you are receive an "untrusted site" prompt on Firefox when using a certificate that was
    * issued by valid issuer, but has expired or is being served served for a different host (e.g.
    * production certificate served in a testing environment) set this to false.
-   * 
+   *
    * @param untrustedIssuer whether to assume untrusted issuer or not.
    */
   public void setAssumeUntrustedCertificateIssuer(boolean untrustedIssuer) {
@@ -386,10 +402,10 @@ protected void cleanTemporaryModel() {
    * Call this to cause the current profile to be written to disk. The profile directory is
    * returned. Note that this profile directory is a temporary one and will be deleted when the JVM
    * exists (at the latest)
-   * 
+   *
    * This method should be called immediately before starting to use the profile and should only be
    * called once per instance of the {@link org.openqa.selenium.firefox.FirefoxDriver}.
-   * 
+   *
    * @return The directory containing the profile.
    */
   public File layoutOnDisk() {

java/client/test/org/openqa/selenium/firefox/FirefoxProfileTest.java

@@ -57,30 +57,32 @@ public void setUp() throws Exception {
   public void shouldQuoteStringsWhenSettingStringProperties() throws Exception {
     profile.setPreference("cheese", "brie");
 
-    List<String> props = readGeneratedProperties(profile);
-    boolean seenCheese = false;
-    for (String line : props) {
-      if (line.contains("cheese") && line.contains("\"brie\"")) {
-        seenCheese = true;
-      }
-    }
+    assertPreferenceValueEquals("cheese", "\"brie\"");
+  }
 
-    assertTrue(seenCheese);
+  @Test
+  public void getStringPreferenceShouldReturnUserSuppliedValueWhenSet() throws Exception {
+    String key = "cheese";
+    String value = "brie";
+    profile.setPreference(key, value);
+
+    String defaultValue = "edam";
+    assertEquals(value, profile.getStringPreference(key, defaultValue));
+  }
+
+  @Test
+  public void getStringPreferenceShouldReturnDefaultValueWhenSet() throws Exception {
+    String key = "cheese";
+
+    String defaultValue = "brie";
+    assertEquals(defaultValue, profile.getStringPreference(key, defaultValue));
   }
 
   @Test
   public void shouldSetIntegerPreferences() throws Exception {
     profile.setPreference("cheese", 1234);
 
-    List<String> props = readGeneratedProperties(profile);
-    boolean seenCheese = false;
-    for (String line : props) {
-      if (line.contains("cheese") && line.contains(", 1234)")) {
-        seenCheese = true;
-      }
-    }
-
-    assertTrue("Did not see integer value being set correctly", seenCheese);
+    assertPreferenceValueEquals("cheese", 1234);
   }
 
   @Test
@@ -108,6 +110,24 @@ public void shouldSetBooleanPreferences() throws Exception {
     assertPreferenceValueEquals("cheese", false);
   }
 
+  @Test
+  public void getBooleanPreferenceShouldReturnUserSuppliedValueWhenSet() throws Exception {
+    String key = "cheese";
+    boolean value = true;
+    profile.setPreference(key, value);
+
+    boolean defaultValue = false;
+    assertEquals(value, profile.getBooleanPreference(key, defaultValue));
+  }
+
+  @Test
+  public void getBooleanPreferenceShouldReturnDefaultValueWhenSet() throws Exception {
+    String key = "cheese";
+
+    boolean defaultValue = true;
+    assertEquals(defaultValue, profile.getBooleanPreference(key, defaultValue));
+  }
+
   @Test
   public void shouldSetDefaultPreferences() throws Exception {
     assertPreferenceValueEquals("network.http.phishy-userpass-length", 255);