Merge pull request #115 from aquality-automation/feature/support-logging-preferences

Support logging preferences from settings.json

Author: aqualityAutomation

.gitignore

@@ -1,5 +1,6 @@
 # Build results
 target
+downloads
 
 # Log file
 *.log

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2022 Aquality Automation
+   Copyright 2023 Aquality Automation
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>com.github.aquality-automation</groupId>
     <artifactId>aquality-selenium</artifactId>
-    <version>3.1.0</version>
+    <version>3.2.0</version>
     <packaging>jar</packaging>
     <name>Aquality Selenium</name>
     <description>Library around Selenium WebDriver</description>
@@ -81,19 +81,19 @@
         <dependency>
             <groupId>com.github.aquality-automation</groupId>
             <artifactId>aquality-selenium-core</artifactId>
-            <version>2.0.4</version>
+            <version>2.0.5</version>
         </dependency>
 
         <dependency>
             <groupId>io.github.bonigarcia</groupId>
             <artifactId>webdrivermanager</artifactId>
-            <version>5.3.0</version>
+            <version>5.3.1</version>
         </dependency>
 
         <dependency>
             <groupId>com.fasterxml.jackson.core</groupId>
             <artifactId>jackson-databind</artifactId>
-            <version>2.13.4</version>
+            <version>2.14.1</version>
         </dependency>
 
         <dependency>

src/main/java/aquality/selenium/browser/devtools/NetworkHandling.java

@@ -313,4 +313,32 @@ public NetworkInterceptor addResponseHandler(Predicate<HttpResponse> responseMat
     public void clearNetworkInterceptor() {
         resetNetworkFilter();
     }
+
+    /**
+     * Activates emulation of network conditions.
+     * @param offline True to emulate internet disconnection.
+     * @param latency Minimum latency from request sent to response headers received (ms).
+     * @param downloadThroughput Maximal aggregated download throughput (bytes/sec). -1 disables download throttling.
+     * @param uploadThroughput Maximal aggregated upload throughput (bytes/sec). -1 disables upload throttling.
+     */
+    public void emulateConditions(Boolean offline, Number latency, Number downloadThroughput, Number uploadThroughput) {
+        tools.sendCommand(enable(Optional.empty(), Optional.empty(), Optional.empty()));
+        tools.sendCommand(emulateNetworkConditions(offline, latency, downloadThroughput, uploadThroughput, Optional.empty()));
+    }
+
+    /**
+     * Activates emulation of network conditions.
+     * @param offline True to emulate internet disconnection.
+     * @param latency Minimum latency from request sent to response headers received (ms).
+     * @param downloadThroughput Maximal aggregated download throughput (bytes/sec). -1 disables download throttling.
+     * @param uploadThroughput Maximal aggregated upload throughput (bytes/sec). -1 disables upload throttling.
+     * @param connectionType Connection type if known.
+     *                       Possible values: "none", "cellular2g", "cellular3g", "cellular4g", "bluetooth", "ethernet",
+     *                       "wifi", "wimax", "other".
+     */
+    public void emulateConditions(Boolean offline, Number latency, Number downloadThroughput, Number uploadThroughput, String connectionType) {
+        tools.sendCommand(enable(Optional.empty(), Optional.empty(), Optional.empty()));
+        tools.sendCommand(emulateNetworkConditions(offline, latency, downloadThroughput, uploadThroughput,
+                Optional.of(ConnectionType.fromString(connectionType))));
+    }
 }

src/main/java/aquality/selenium/configuration/ITimeoutConfiguration.java

@@ -8,14 +8,14 @@
 public interface ITimeoutConfiguration extends aquality.selenium.core.configurations.ITimeoutConfiguration {
 
     /**
-     * Gets WedDriver AsynchronousJavaScript timeout.
+     * Gets WebDriver AsynchronousJavaScript timeout.
      *
      * @return AsynchronousJavaScript timeout.
      */
     Duration getScript();
 
     /**
-     * Gets WedDriver PageLoad timeout.
+     * Gets WebDriver PageLoad timeout.
      *
      * @return PageLoad timeout.
      */

src/main/java/aquality/selenium/configuration/driversettings/ChromeSettings.java

@@ -21,6 +21,7 @@ public AbstractDriverOptions<?> getDriverOptions() {
         setCapabilities(chromeOptions);
         setChromeArgs(chromeOptions);
         chromeOptions.setPageLoadStrategy(getPageLoadStrategy());
+        setLoggingPreferences(chromeOptions, ChromeOptions.LOGGING_PREFS);
         return chromeOptions;
     }
 

src/main/java/aquality/selenium/configuration/driversettings/DriverSettings.java

@@ -8,19 +8,23 @@
 import org.apache.commons.lang3.StringUtils;
 import org.openqa.selenium.MutableCapabilities;
 import org.openqa.selenium.PageLoadStrategy;
+import org.openqa.selenium.logging.LoggingPreferences;
+
 import java.io.File;
 import java.io.IOException;
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.List;
 import java.util.Map;
+import java.util.logging.Level;
 import java.util.stream.Collectors;
 
 abstract class DriverSettings implements IDriverSettings {
 
     private final ISettingsFile settingsFile;
     private Map<String, Object> options;
     private Map<String, Object> capabilities;
+    private Map<String, Level> loggingPreferences;
     private List<String> startArguments;
 
     protected DriverSettings(ISettingsFile settingsFile) {
@@ -45,6 +49,15 @@ protected Map<String, Object> getBrowserCapabilities() {
         return capabilities;
     }
 
+    protected Map<String, Level> getLoggingPreferences() {
+        if (loggingPreferences == null) {
+            loggingPreferences = getMapOrEmpty(CapabilityType.LOGGING_PREFERENCES).entrySet().stream().collect(
+                    Collectors.toMap(entry -> entry.getKey().toLowerCase(),
+                            pair -> Level.parse(pair.getValue().toString().toUpperCase())));
+        }
+        return loggingPreferences;
+    }
+
     private Map<String, Object> getMapOrEmpty(CapabilityType capabilityType) {
         String path = getDriverSettingsPath(capabilityType);
         Map<String, Object> map = getSettingsFile().isValuePresent(path) ? getSettingsFile().getMap(path) : Collections.emptyMap();
@@ -123,6 +136,14 @@ void setCapabilities(MutableCapabilities options) {
         getBrowserCapabilities().forEach(options::setCapability);
     }
 
+    void setLoggingPreferences(MutableCapabilities options, String capabilityKey) {
+        if (!getLoggingPreferences().isEmpty()) {
+            LoggingPreferences logs = new LoggingPreferences();
+            getLoggingPreferences().forEach(logs::enable);
+            options.setCapability(capabilityKey, logs);
+        }
+    }
+
     @Override
     public String getDownloadDir() {
         Map<String, Object> browserOptions = getBrowserOptions();
@@ -136,7 +157,10 @@ public String getDownloadDir() {
     }
 
     private enum CapabilityType {
-        CAPABILITIES("capabilities"), OPTIONS("options"), START_ARGS("startArguments");
+        CAPABILITIES("capabilities"),
+        OPTIONS("options"),
+        START_ARGS("startArguments"),
+        LOGGING_PREFERENCES("loggingPreferences");
 
         private final String key;
 

src/main/java/aquality/selenium/configuration/driversettings/EdgeSettings.java

@@ -2,7 +2,6 @@
 
 import aquality.selenium.browser.BrowserName;
 import aquality.selenium.core.utilities.ISettingsFile;
-import org.openqa.selenium.chrome.ChromeOptions;
 import org.openqa.selenium.edge.EdgeOptions;
 import org.openqa.selenium.remote.AbstractDriverOptions;
 
@@ -22,6 +21,7 @@ public AbstractDriverOptions<?> getDriverOptions() {
         setPrefs(edgeOptions);
         getBrowserStartArguments().forEach(edgeOptions::addArguments);
         edgeOptions.setPageLoadStrategy(getPageLoadStrategy());
+        setLoggingPreferences(edgeOptions, EdgeOptions.LOGGING_PREFS);
         return edgeOptions;
     }
 

src/main/java/aquality/selenium/elements/actions/JsActions.java

@@ -140,7 +140,9 @@ public boolean isElementOnScreen() {
      */
     public String getElementText() {
         logElementAction("loc.get.text.js");
-        return (String) executeScript(JavaScript.GET_ELEMENT_TEXT);
+        String value = (String) executeScript(JavaScript.GET_ELEMENT_TEXT);
+        logElementAction("loc.text.value", value);
+        return value;
     }
 
     /**

src/main/java/aquality/selenium/elements/actions/MouseActions.java

@@ -1,7 +1,6 @@
 package aquality.selenium.elements.actions;
 
 import aquality.selenium.browser.AqualityServices;
-import aquality.selenium.browser.Browser;
 import aquality.selenium.core.utilities.IElementActionRetrier;
 import aquality.selenium.elements.interfaces.IElement;
 import org.openqa.selenium.interactions.Actions;
@@ -51,8 +50,10 @@ public void moveMouseToElement() {
      */
     public void moveMouseFromElement() {
         infoLoc("loc.movingFrom");
-        performAction(actions -> actions.moveToElement(element.getElement(),
-                -element.getElement().getSize().width / 2, -element.getElement().getSize().height / 2));
+        AqualityServices.get(IElementActionRetrier.class).doWithRetry(() ->
+                new Actions(getBrowser().getDriver())
+                        .moveToElement(element.getElement(), -element.getElement().getSize().width, -element.getElement().getSize().height)
+                        .build().perform());
     }
 
     /**