Merge pull request #70 from nickebbutt/master

Add the ability to configure the log level of the selenium driver
Chorus-bdd · Dec 10, 2023 · abece7b · abece7b
2 parents 62a15af + 3a5ca01
commit abece7b
Show file tree

Hide file tree

Showing 9 changed files with 103 additions and 13 deletions.
diff --git a/...ns/chorus-selenium/src/main/java/org/chorusbdd/chorus/selenium/config/DriverLogLevel.java b/...ns/chorus-selenium/src/main/java/org/chorusbdd/chorus/selenium/config/DriverLogLevel.java
@@ -0,0 +1,33 @@
+/**
+ * MIT License
+ *
+ * Copyright (c) 2023 Chorus BDD Organisation.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+package org.chorusbdd.chorus.selenium.config;
+
+public enum DriverLogLevel {
+    ALL,
+    INFO,
+    DEBUG,
+    WARNING,
+    SEVERE,
+    OFF;
+}
diff --git a/...ns/chorus-selenium/src/main/java/org/chorusbdd/chorus/selenium/config/SeleniumConfig.java b/...ns/chorus-selenium/src/main/java/org/chorusbdd/chorus/selenium/config/SeleniumConfig.java
@@ -49,4 +49,6 @@ public interface SeleniumConfig extends NamedConfigBean {
     String getRemoteWebDriverBrowserType();
 
     String getRemoteWebDriverURL();
+
+    DriverLogLevel getLogLevel();
 }
diff --git a/...horus-selenium/src/main/java/org/chorusbdd/chorus/selenium/config/SeleniumConfigBean.java b/...horus-selenium/src/main/java/org/chorusbdd/chorus/selenium/config/SeleniumConfigBean.java
@@ -44,8 +44,8 @@ public class SeleniumConfigBean implements SeleniumConfig {
     private String chromeArgs;
     private String edgeArgs;
     private String remoteWebDriverURL;
-
     private String remoteWebDriverBrowserType;
+    private DriverLogLevel driverLogLevel;
 
     public String getConfigName() {
         return configName;
@@ -183,6 +183,22 @@ public void checkValid() {
         }
     }
 
+    @Override
+    public DriverLogLevel getLogLevel() {
+        return driverLogLevel;
+    }
+
+    @ConfigProperty(
+            name = "driverLogLevel",
+            description = "Desired log level for the selenium web driver, an attempt will be made to configure this level if the driver supports it",
+            defaultValue = "OFF",
+            mandatory = false,
+            order = 60
+    )
+    public void setDriverLogLevel(DriverLogLevel driverLogLevel) {
+        this.driverLogLevel = driverLogLevel;
+    }
+
     private void checkRemoteWebDriverProperites() {
         checkNotNullAndNotEmpty(remoteWebDriverURL, "remoteWebDriverURL");
         checkNotNullAndNotEmpty(remoteWebDriverBrowserType, "remoteWebDriverBrowserType");

diff --git a/...selenium/src/main/java/org/chorusbdd/chorus/selenium/manager/DefaultWebDriverFactory.java b/...selenium/src/main/java/org/chorusbdd/chorus/selenium/manager/DefaultWebDriverFactory.java
@@ -23,25 +23,35 @@
  */
 package org.chorusbdd.chorus.selenium.manager;
 
+import org.chorusbdd.chorus.logging.ChorusLog;
+import org.chorusbdd.chorus.logging.ChorusLogFactory;
+import org.chorusbdd.chorus.selenium.config.DriverLogLevel;
 import org.chorusbdd.chorus.selenium.config.SeleniumConfig;
 import org.chorusbdd.chorus.util.ChorusException;
 import org.openqa.selenium.Platform;
 import org.openqa.selenium.WebDriver;
 import org.openqa.selenium.chrome.ChromeDriver;
+import org.openqa.selenium.chrome.ChromeDriverService;
 import org.openqa.selenium.chrome.ChromeOptions;
+import org.openqa.selenium.chromium.ChromiumDriverLogLevel;
 import org.openqa.selenium.edge.EdgeDriver;
+import org.openqa.selenium.edge.EdgeDriverService;
 import org.openqa.selenium.edge.EdgeOptions;
 import org.openqa.selenium.remote.DesiredCapabilities;
 import org.openqa.selenium.remote.RemoteWebDriver;
 
 import java.net.MalformedURLException;
 import java.net.URL;
+import java.util.logging.Level;
+
 
 /**
  * Created by nickebbutt on 12/02/2018.
  */
 public class DefaultWebDriverFactory implements WebDriverFactory {
-
+
+    private final ChorusLog log = ChorusLogFactory.getLog(DefaultWebDriverFactory.class);
+
     @Override
     public WebDriver createWebDriver(SeleniumConfig seleniumConfig) {
         WebDriver result;
@@ -54,20 +64,23 @@ public WebDriver createWebDriver(SeleniumConfig seleniumConfig) {
                 // File logFile = new File(feature.getFeatureDir().toString(), "selenium.log");
                 // System.setProperty("webdriver.chrome.logfile",  logFile.toString());
 
-                setSpecialSilenceChromeDriverSysProperty();
+                ChromiumDriverLogLevel chromeLogLevel = getLogLevel(seleniumConfig);
+                ChromeDriverService chromeDriverService = new ChromeDriverService.Builder().withLogLevel(chromeLogLevel).build();
                 ChromeOptions chromeOptions = new ChromeOptions();
-                
+
                 //Setting this prevents 'Error: Loading of unpacked extensions is disabled by the administrator' which pops up a warning dialog
                 //if starting chrome on an OS where the admin has disabled browser plugins/extensions
                 chromeOptions.setExperimentalOption("useAutomationExtension", false);
 
                 seleniumConfig.getChromeArgs().map(s -> s.split(" ")).ifPresent(chromeOptions::addArguments);
-                result = new ChromeDriver(chromeOptions);
+                result = new ChromeDriver(chromeDriverService, chromeOptions);
                 break;
             case EDGE:
+                ChromiumDriverLogLevel edgelogLevel = getLogLevel(seleniumConfig);
+                EdgeDriverService edgeDriverService = new EdgeDriverService.Builder().withLoglevel(edgelogLevel).build();
                 EdgeOptions edgeOptions = new EdgeOptions();
                 seleniumConfig.getEdgeArgs().map(s -> s.split(" ")).ifPresent(edgeOptions::addArguments);
-                result = new EdgeDriver(edgeOptions);
+                result = new EdgeDriver(edgeDriverService, edgeOptions);
                 break;
             case REMOTE_WEB_DRIVER:
                 DesiredCapabilities capabilities = new DesiredCapabilities(
@@ -76,15 +89,40 @@ public WebDriver createWebDriver(SeleniumConfig seleniumConfig) {
                         Platform.ANY  //can't configure platform yet
                 );
                 capabilities.setJavascriptEnabled(true);
+                Level logLevel = getJavaInfoLogLevel(seleniumConfig);
                 URL url = getRemoteWebDriverURL(seleniumConfig.getRemoteWebDriverURL());
-                result = new RemoteWebDriver(url, capabilities);;
+                RemoteWebDriver remoteWebDriver = new RemoteWebDriver(url, capabilities);
+                remoteWebDriver.setLogLevel(logLevel);
+                result = remoteWebDriver;;
                 break;
             default:
                 throw new ChorusException("SeleniumDriverType " + seleniumConfig.getDriverType() + " is not supported");
         }
         return result;
     }
 
+    private Level getJavaInfoLogLevel(SeleniumConfig seleniumConfig) {
+        DriverLogLevel logLevel = seleniumConfig.getLogLevel();
+        Level level;
+        try {
+            level = Level.parse(logLevel.name());
+        } catch (IllegalArgumentException e) {
+            log.warn("The log level " + logLevel + " was not supported by the selenium driver, will be defaulted to OFF");
+            level = Level.OFF;
+        }
+        return level;
+    }
+
+    private ChromiumDriverLogLevel getLogLevel(SeleniumConfig seleniumConfig) {
+        DriverLogLevel logLevel = seleniumConfig.getLogLevel();
+        ChromiumDriverLogLevel result = ChromiumDriverLogLevel.fromString(logLevel.name());
+        if (result == null) {
+            log.warn("The log level " + logLevel + " was not supported by the selenium driver, will be defaulted to OFF");
+            result = ChromiumDriverLogLevel.OFF;
+        }
+        return result;
+    }
+
     private URL getRemoteWebDriverURL(String url) {
         try {
             return new URL(url);
@@ -93,8 +131,4 @@ private URL getRemoteWebDriverURL(String url) {
         }
     }
 
-    //Before creating a ChromeDriver set this to silence the verbose output
-    private void setSpecialSilenceChromeDriverSysProperty() {
-        System.setProperty("webdriver.chrome.silentOutput", "true");
-    }
 }
diff --git a/...st/src/test/java/org/chorusbdd/chorus/selftest/selenium/chromedriver/chromeDriver.feature b/...st/src/test/java/org/chorusbdd/chorus/selftest/selenium/chromedriver/chromeDriver.feature
@@ -9,5 +9,6 @@ Uses: Selenium
       And I set the chorus context variable pathToTestHtmlFile
       When I navigate to ${pathToTestHtmlFile}
       Then the url is ${pathToTestHtmlFile}
+      And I close the browser
 
 
diff --git a/integrationtest/src/test/java/org/chorusbdd/chorus/selftest/selenium/chromedriver/stdout.txt b/integrationtest/src/test/java/org/chorusbdd/chorus/selftest/selenium/chromedriver/stdout.txt
@@ -6,8 +6,9 @@ Chorus --> INFO    - Processing scenario: I can open Chrome and navigate to a pa
     And I set the chorus context variable pathToTestHtmlFile                                 PASSED  
     When I navigate to REPLACED PASSED  
     Then the url is REPLACED PASSED  
+    And I close the browser                                                                  PASSED  
 
 
 Features  (total:1) (passed:1) (failed:0)
 Scenarios (total:1) (passed:1) (failed:0)
-Steps     (total:4) (passed:4) (failed:0) (undefined:0) (pending:0) (skipped:0)
+Steps     (total:5) (passed:5) (failed:0) (undefined:0) (pending:0) (skipped:0)
diff --git a/...ontest/src/test/java/org/chorusbdd/chorus/selftest/selenium/edgedriver/edgeDriver.feature b/...ontest/src/test/java/org/chorusbdd/chorus/selftest/selenium/edgedriver/edgeDriver.feature
@@ -9,5 +9,6 @@ Uses: Selenium
       And I set the chorus context variable pathToTestHtmlFile
       When I navigate to ${pathToTestHtmlFile}
       Then the url is ${pathToTestHtmlFile}
+      And I close the browser
 
 
diff --git a/...est/src/test/java/org/chorusbdd/chorus/selftest/selenium/edgedriver/edgeDriver.properties b/...est/src/test/java/org/chorusbdd/chorus/selftest/selenium/edgedriver/edgeDriver.properties
@@ -1,3 +1,4 @@
 
 selenium.EDGE.driverType=EDGE
+selenium.EDGE.driverLogLevel=OFF
 
diff --git a/integrationtest/src/test/java/org/chorusbdd/chorus/selftest/selenium/edgedriver/stdout.txt b/integrationtest/src/test/java/org/chorusbdd/chorus/selftest/selenium/edgedriver/stdout.txt
@@ -6,8 +6,9 @@ Chorus --> INFO    - Processing scenario: I can open Edge and navigate to a page
     And I set the chorus context variable pathToTestHtmlFile                                 PASSED  
     When I navigate to REPLACED PASSED  
     Then the url is REPLACED PASSED  
+    And I close the browser                                                                  PASSED  
 
 
 Features  (total:1) (passed:1) (failed:0)
 Scenarios (total:1) (passed:1) (failed:0)
-Steps     (total:4) (passed:4) (failed:0) (undefined:0) (pending:0) (skipped:0)
+Steps     (total:5) (passed:5) (failed:0) (undefined:0) (pending:0) (skipped:0)
Original file line number	Diff line number	Diff line change
		@@ -1,3 +1,4 @@

		selenium.EDGE.driverType=EDGE
		selenium.EDGE.driverLogLevel=OFF