[java] implement chromium driver log level and deprecate chrome driver log level

Author: titusfortner

java/src/org/openqa/selenium/chrome/ChromeDriverLogLevel.java

@@ -18,14 +18,17 @@
 package org.openqa.selenium.chrome;
 
 import com.google.common.collect.ImmutableMap;
+import org.openqa.selenium.chromium.ChromiumDriverLogLevel;
 
 import java.util.Map;
 import java.util.logging.Level;
 
 /**
  * <a href="https://source.chromium.org/chromium/chromium/src/+/master:chrome/test/chromedriver/logging.cc">
  *   Log levels</a> defined by ChromeDriver
+ * @deprecated use {@link ChromiumDriverLogLevel}
  */
+@Deprecated
 public enum ChromeDriverLogLevel {
   ALL,
   INFO,

java/src/org/openqa/selenium/chrome/ChromeDriverService.java

@@ -21,6 +21,7 @@
 
 import org.openqa.selenium.Capabilities;
 import org.openqa.selenium.WebDriverException;
+import org.openqa.selenium.chromium.ChromiumDriverLogLevel;
 import org.openqa.selenium.remote.service.DriverService;
 
 import java.io.File;
@@ -153,12 +154,12 @@ public static ChromeDriverService createDefaultService() {
    * be configured to use a free port on the current system.
    *
    * @return A new ChromeDriverService using the supplied configuration from {@link ChromeOptions}.
-   * @deprecated Use {@link Builder#withLogLevel(ChromeDriverLogLevel)}  }
+   * @deprecated Use {@link Builder#withLogLevel(ChromiumDriverLogLevel)}  }
    */
   @Deprecated
   public static ChromeDriverService createServiceWithConfig(ChromeOptions options) {
     return new Builder()
-      .withLogLevel(options.getLogLevel())
+      .withLogLevel(ChromiumDriverLogLevel.fromString(options.getLogLevel().toString()))
       .build();
   }
 
@@ -176,7 +177,7 @@ public static class Builder extends DriverService.Builder<
     private boolean silent = Boolean.getBoolean(CHROME_DRIVER_SILENT_OUTPUT_PROPERTY);
     private String allowedListIps = System.getProperty(CHROME_DRIVER_ALLOWED_IPS_PROPERTY,
       System.getProperty(CHROME_DRIVER_WHITELISTED_IPS_PROPERTY));
-    private ChromeDriverLogLevel logLevel = ChromeDriverLogLevel.fromString(System.getProperty(CHROME_DRIVER_LOG_LEVEL_PROPERTY));
+    private ChromiumDriverLogLevel logLevel = ChromiumDriverLogLevel.fromString(System.getProperty(CHROME_DRIVER_LOG_LEVEL_PROPERTY));
 
     @Override
     public int score(Capabilities capabilities) {
@@ -218,13 +219,13 @@ public Builder withBuildCheckDisabled(boolean noBuildCheck) {
     /**
      * Configures the driver server verbosity.
      *
-     * @param verbose True for verbose output, false otherwise.
+     * @param verbose Log all output for true, no changes made if false.
      * @return A self reference.
      */
     @SuppressWarnings("UnusedReturnValue")
     public Builder withVerbose(boolean verbose) {
       if (verbose) {
-        this.logLevel = ChromeDriverLogLevel.ALL;
+        this.logLevel = ChromiumDriverLogLevel.ALL;
       }
       this.verbose = false;
       return this;
@@ -235,23 +236,36 @@ public Builder withVerbose(boolean verbose) {
      *
      * @param logLevel {@link ChromeDriverLogLevel} for desired log level output.
      * @return A self reference.
+     * @deprecated use {@link #withLogLevel(ChromiumDriverLogLevel)} instead.
      */
+    @Deprecated
     public Builder withLogLevel(ChromeDriverLogLevel logLevel) {
       this.verbose = false;
       this.silent = false;
+      this.logLevel = ChromiumDriverLogLevel.fromString(logLevel.toString());
+      return this;
+    }
+
+    /**
+     * Configures the driver server verbosity.
+     *
+     * @param logLevel {@link ChromiumDriverLogLevel} for desired log level output.
+     * @return A self reference.
+     */
+    public Builder withLogLevel(ChromiumDriverLogLevel logLevel) {
       this.logLevel = logLevel;
       return this;
     }
 
     /**
      * Configures the driver server for silent output.
      *
-     * @param silent True for silent output, false otherwise.
+     * @param silent Log no output for true, no changes made if false.
      * @return A self reference.
      */
     public Builder withSilent(boolean silent) {
       if (silent) {
-        this.logLevel = ChromeDriverLogLevel.OFF;
+        this.logLevel = ChromiumDriverLogLevel.OFF;
       }
       this.silent = false;
       return this;

java/src/org/openqa/selenium/chrome/ChromeOptions.java

@@ -18,6 +18,7 @@
 package org.openqa.selenium.chrome;
 
 import org.openqa.selenium.Capabilities;
+import org.openqa.selenium.chromium.ChromiumDriverLogLevel;
 import org.openqa.selenium.chromium.ChromiumOptions;
 import org.openqa.selenium.internal.Require;
 import org.openqa.selenium.remote.CapabilityType;
@@ -59,7 +60,7 @@ public ChromeOptions() {
   }
 
   /**
-   * @deprecated Use {@link ChromeDriverService.Builder#withLogLevel(ChromeDriverLogLevel)} to set log level.
+   * @deprecated Use {@link ChromeDriverService.Builder#withLogLevel(ChromiumDriverLogLevel)} to set log level.
    */
   @Deprecated
   public ChromeOptions setLogLevel(ChromeDriverLogLevel logLevel){

java/src/org/openqa/selenium/chromium/ChromiumDriverLogLevel.java

@@ -0,0 +1,68 @@
+// 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.chromium;
+
+import com.google.common.collect.ImmutableMap;
+
+import java.util.Map;
+import java.util.logging.Level;
+
+/**
+ * <a href="https://source.chromium.org/chromium/chromium/src/+/master:chrome/test/chromedriver/logging.cc">
+ *   Log levels</a> defined by ChromeDriver
+ */
+public enum ChromiumDriverLogLevel {
+  ALL,
+  INFO,
+  DEBUG,
+  WARNING,
+  SEVERE,
+  OFF;
+
+  private static final Map<Level, ChromiumDriverLogLevel> logLevelToChromeLevelMap
+    = new ImmutableMap.Builder<Level, ChromiumDriverLogLevel>()
+    .put(Level.ALL, ALL)
+    .put(Level.FINEST, DEBUG)
+    .put(Level.FINER, DEBUG)
+    .put(Level.FINE, DEBUG)
+    .put(Level.INFO, INFO)
+    .put(Level.WARNING, WARNING)
+    .put(Level.SEVERE, SEVERE)
+    .put(Level.OFF, OFF)
+    .build();
+
+  @Override
+  public String toString() {
+    return super.toString().toLowerCase();
+  }
+
+  public static ChromiumDriverLogLevel fromString(String text) {
+    if (text != null) {
+      for (ChromiumDriverLogLevel b : ChromiumDriverLogLevel.values()) {
+        if (text.equalsIgnoreCase(b.toString())) {
+          return b;
+        }
+      }
+    }
+    return null;
+  }
+
+  public static ChromiumDriverLogLevel fromLevel(Level level) {
+    return logLevelToChromeLevelMap.getOrDefault(level, ALL);
+  }
+}

java/test/org/openqa/selenium/chrome/ChromeDriverServiceTest.java

@@ -26,6 +26,7 @@
 
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.Tag;
+import org.openqa.selenium.chromium.ChromiumDriverLogLevel;
 
 import java.io.File;
 import java.time.Duration;
@@ -61,19 +62,19 @@ void logLevelLastWins() {
     doReturn(exe).when(builderMock).findDefaultExecutable();
 
     List<String> silentLast = Arrays.asList("--port=1", "--log-level=OFF");
-    builderMock.withLogLevel(ChromeDriverLogLevel.ALL).usingPort(1).withSilent(true).build();
+    builderMock.withLogLevel(ChromiumDriverLogLevel.ALL).usingPort(1).withSilent(true).build();
     verify(builderMock).createDriverService(any(), anyInt(), any(), eq(silentLast), any());
 
     List<String> silentFirst = Arrays.asList("--port=1", "--log-level=DEBUG");
-    builderMock.withSilent(true).withLogLevel(ChromeDriverLogLevel.DEBUG).usingPort(1).build();
+    builderMock.withSilent(true).withLogLevel(ChromiumDriverLogLevel.DEBUG).usingPort(1).build();
     verify(builderMock).createDriverService(any(), anyInt(), any(), eq(silentFirst), any());
 
     List<String> verboseLast = Arrays.asList("--port=1", "--log-level=ALL");
-    builderMock.withLogLevel(ChromeDriverLogLevel.OFF).usingPort(1).withVerbose(true).build();
+    builderMock.withLogLevel(ChromiumDriverLogLevel.OFF).usingPort(1).withVerbose(true).build();
     verify(builderMock).createDriverService(any(), anyInt(), any(), eq(verboseLast), any());
 
     List<String> verboseFirst = Arrays.asList("--port=1", "--log-level=INFO");
-    builderMock.withVerbose(true).withLogLevel(ChromeDriverLogLevel.INFO).usingPort(1).build();
+    builderMock.withVerbose(true).withLogLevel(ChromiumDriverLogLevel.INFO).usingPort(1).build();
     verify(builderMock).createDriverService(any(), anyInt(), any(), eq(verboseFirst), any());
   }
 
@@ -86,7 +87,7 @@ void ignoreFalseLogging() {
     doReturn(exe).when(builderMock).findDefaultExecutable();
 
     List<String> falseSilent = Arrays.asList("--port=1", "--log-level=DEBUG");
-    builderMock.withLogLevel(ChromeDriverLogLevel.DEBUG).usingPort(1).withSilent(false).build();
+    builderMock.withLogLevel(ChromiumDriverLogLevel.DEBUG).usingPort(1).withSilent(false).build();
     verify(builderMock).createDriverService(any(), anyInt(), any(), eq(falseSilent), any());
   }
 }