Implementing enum for FirefoxDriver (geckodriver) log levels, it's not wise to use jul levels because geckodriver has its own set of levels.

Author: barancev

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

@@ -0,0 +1,45 @@
+// 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.firefox;
+
+public enum FirefoxDriverLogLevel {
+  TRACE,
+  DEBUG ,
+  CONFIG,
+  INFO,
+  WARN,
+  ERROR,
+  FATAL;
+
+  @Override
+  public String toString() {
+    return super.toString().toLowerCase();
+  }
+
+  public static FirefoxDriverLogLevel fromString(String text) {
+    if (text != null) {
+      for (FirefoxDriverLogLevel b : FirefoxDriverLogLevel.values()) {
+        if (text.equalsIgnoreCase(b.toString())) {
+          return b;
+        }
+      }
+    }
+    return null;
+  }
+
+}

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

@@ -44,7 +44,6 @@
 import org.openqa.selenium.WebDriverException;
 import org.openqa.selenium.firefox.internal.ProfilesIni;
 import org.openqa.selenium.logging.LoggingPreferences;
-import org.openqa.selenium.remote.BrowserType;
 import org.openqa.selenium.remote.DesiredCapabilities;
 
 import java.io.File;
@@ -88,10 +87,9 @@ public class FirefoxOptions {
   private Map<String, Boolean> booleanPrefs = new HashMap<>();
   private Map<String, Integer> intPrefs = new HashMap<>();
   private Map<String, String> stringPrefs = new HashMap<>();
-  private Level logLevel = null;
+  private FirefoxDriverLogLevel logLevel = null;
   private boolean legacy;
   private DesiredCapabilities desiredCapabilities = new DesiredCapabilities();
-  private boolean headless;
 
   private void amend(Map<String, Object> map) throws IOException {
     if (map.containsKey("binary")) {
@@ -400,7 +398,31 @@ public FirefoxOptions addPreference(String key, String value) {
     return this;
   }
 
+  private Map<Level, FirefoxDriverLogLevel> logLevelToGeckoLevelMap
+      = new ImmutableMap.Builder<Level, FirefoxDriverLogLevel>()
+      .put(Level.ALL, FirefoxDriverLogLevel.TRACE)
+      .put(Level.FINEST, FirefoxDriverLogLevel.TRACE)
+      .put(Level.FINER, FirefoxDriverLogLevel.TRACE)
+      .put(Level.FINE, FirefoxDriverLogLevel.DEBUG)
+      .put(Level.CONFIG, FirefoxDriverLogLevel.CONFIG)
+      .put(Level.INFO, FirefoxDriverLogLevel.INFO)
+      .put(Level.WARNING, FirefoxDriverLogLevel.WARN)
+      .put(Level.SEVERE, FirefoxDriverLogLevel.ERROR)
+      .put(Level.OFF, FirefoxDriverLogLevel.FATAL)
+      .build();
+
+  /**
+   * @deprecated Use {@link #setLogLevel(FirefoxDriverLogLevel)}
+   */
+  @Deprecated
   public FirefoxOptions setLogLevel(Level logLevel) {
+    // levels defined by GeckoDriver
+    // https://github.com/mozilla/geckodriver#log-object
+    this.logLevel = logLevelToGeckoLevelMap.getOrDefault(logLevel, FirefoxDriverLogLevel.DEBUG);
+    return this;
+  }
+
+  public FirefoxOptions setLogLevel(FirefoxDriverLogLevel logLevel) {
     this.logLevel = logLevel;
     return this;
   }
@@ -605,43 +627,14 @@ public Map<String, Object> toJson() throws IOException {
     }
 
     if (logLevel != null) {
-      options.put("log", ImmutableMap.of("level", logLevelToGeckoLevel()));
+      options.put("log", ImmutableMap.of("level", logLevel));
     }
 
     options.put("args", args);
 
     return options.build();
   }
 
-  private String logLevelToGeckoLevel() {
-    // levels defined by GeckoDriver
-    // https://github.com/mozilla/geckodriver#log-object
-    if (logLevel.intValue() < Level.FINE.intValue()) {
-      return "trace";
-    }
-    if (logLevel == Level.FINE) {
-      return "debug";
-    }
-    if (logLevel == Level.CONFIG) {
-      return "config";
-    }
-    if (logLevel == Level.INFO) {
-      return "info";
-    }
-    if (logLevel == Level.WARNING) {
-      return "warn";
-    }
-    if (logLevel == Level.SEVERE) {
-      return "error";
-    }
-    if (logLevel == Level.OFF) {
-      return "fatal";
-    }
-
-    // something else?  ¯\_(ツ)_/¯
-    return "debug";
-  }
-
   @Override
   public String toString() {
     return "{" +

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

@@ -23,13 +23,11 @@
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertSame;
-import static org.junit.Assert.assertThat;
 import static org.junit.Assert.assertTrue;
 import static org.junit.Assert.fail;
 import static org.junit.Assume.assumeNotNull;
 import static org.junit.Assume.assumeThat;
 import static org.openqa.selenium.firefox.FirefoxDriver.MARIONETTE;
-import static org.openqa.selenium.firefox.FirefoxDriver.PROFILE;
 import static org.openqa.selenium.firefox.FirefoxDriver.SystemProperty.BROWSER_BINARY;
 import static org.openqa.selenium.firefox.FirefoxDriver.SystemProperty.BROWSER_PROFILE;
 import static org.openqa.selenium.firefox.FirefoxDriver.SystemProperty.DRIVER_USE_MARIONETTE;
@@ -282,4 +280,16 @@ public void callingToStringWhenTheBinaryDoesNotExistShouldNotCauseAnException()
       fail(Throwables.getStackTraceAsString(e));
     }
   }
+
+  @Test
+  public void logLevelStringRepresentationIsLowercase() {
+    assertEquals(FirefoxDriverLogLevel.DEBUG.toString(), "debug");
+  }
+
+  @Test
+  public void canBuildLogLevelFromStringRepresentation() {
+    assertEquals(FirefoxDriverLogLevel.fromString("warn"), FirefoxDriverLogLevel.WARN);
+    assertEquals(FirefoxDriverLogLevel.fromString("ERROR"), FirefoxDriverLogLevel.ERROR);
+  }
+
 }