added geolocation emulation, basic authentication, request \ response handlers, network interception;

Dmitry Kravchenko · Dmitry Kravchenko · commit 5469f99ea007 · 2022-02-14T14:55:08.000+03:00
diff --git a/pom.xml b/pom.xml
@@ -117,8 +117,8 @@
                 <artifactId>maven-compiler-plugin</artifactId>
                 <version>3.1</version>
                 <configuration>
-                    <source>1.8</source>
-                    <target>1.8</target>
+                    <source>9</source>
+                    <target>9</target>
                 </configuration>
             </plugin>
             <plugin>
diff --git a/src/main/java/aquality/selenium/browser/Browser.java b/src/main/java/aquality/selenium/browser/Browser.java
@@ -1,5 +1,6 @@
 package aquality.selenium.browser;
 
+import aquality.selenium.browser.devtools.BrowserDevTools;
 import aquality.selenium.configuration.IBrowserProfile;
 import aquality.selenium.configuration.ITimeoutConfiguration;
 import aquality.selenium.core.applications.IApplication;
@@ -20,7 +21,6 @@
 import java.io.IOException;
 import java.nio.charset.StandardCharsets;
 import java.time.Duration;
-import java.util.concurrent.TimeUnit;
 import java.util.function.Supplier;
 
 public class Browser implements IApplication {
@@ -368,4 +368,8 @@ public final BrowserName getBrowserName() {
     private Duration getImplicitWaitTimeout() {
         return implicitTimeout;
     }
+
+    public BrowserDevTools devTools() {
+        return new BrowserDevTools(getDriver(), browserProfile);
+    }
 }
diff --git a/src/main/java/aquality/selenium/browser/devtools/BrowserDevTools.java b/src/main/java/aquality/selenium/browser/devtools/BrowserDevTools.java
@@ -0,0 +1,23 @@
+package aquality.selenium.browser.devtools;
+
+import aquality.selenium.configuration.IBrowserProfile;
+import org.openqa.selenium.WebDriver;
+import org.openqa.selenium.devtools.DevTools;
+
+public class BrowserDevTools {
+
+    DevTools tools;
+
+    public BrowserDevTools(WebDriver driver, IBrowserProfile browserProfile) {
+        tools = DevToolsFactory.getDevTools(driver, browserProfile);
+        tools.createSessionIfThereIsNotOne();
+    }
+
+    public EmulationTools emulation() {
+        return new EmulationTools(tools);
+    }
+
+    public NetworkTools network() {
+        return new NetworkTools(tools);
+    }
+}
diff --git a/src/main/java/aquality/selenium/browser/devtools/DevToolsFactory.java b/src/main/java/aquality/selenium/browser/devtools/DevToolsFactory.java
@@ -0,0 +1,19 @@
+package aquality.selenium.browser.devtools;
+
+import aquality.selenium.configuration.IBrowserProfile;
+import org.openqa.selenium.WebDriver;
+import org.openqa.selenium.devtools.DevTools;
+import org.openqa.selenium.devtools.HasDevTools;
+
+public class DevToolsFactory {
+
+    public static DevTools getDevTools(WebDriver driver, IBrowserProfile browserProfile) {
+        DevTools tools;
+        try {
+            tools = ((HasDevTools)driver).getDevTools();
+        } catch (ClassCastException e) {
+            throw new IllegalArgumentException(String.format("Browser [%s] is not supported.", browserProfile.getBrowserName()));
+        }
+        return tools;
+    }
+}
diff --git a/src/main/java/aquality/selenium/browser/devtools/EmulationTools.java b/src/main/java/aquality/selenium/browser/devtools/EmulationTools.java
@@ -0,0 +1,34 @@
+package aquality.selenium.browser.devtools;
+
+import aquality.selenium.browser.AqualityServices;
+import aquality.selenium.core.localization.ILocalizedLogger;
+import org.openqa.selenium.devtools.DevTools;
+import org.openqa.selenium.devtools.v96.emulation.Emulation;
+
+import java.util.Optional;
+
+public class EmulationTools {
+
+    private final DevTools tools;
+    private final ILocalizedLogger localizedLogger = AqualityServices.getLocalizedLogger();
+
+    public EmulationTools(DevTools tools) {
+        this.tools = tools;
+    }
+
+
+    public void setGeolocationOverride(double lat, double lng, int accuracy) {
+        localizedLogger.info("loc.browser.emulation.geolocation.set");
+        tools.send(Emulation.setGeolocationOverride(Optional.of(lat), Optional.of(lng), Optional.of(accuracy)));
+    }
+
+    public void setGeolocationOverride(double lat, double lng) {
+        localizedLogger.info("loc.browser.emulation.geolocation.set");
+        setGeolocationOverride(lat, lng, 0);
+    }
+
+    public void clearGeolocationOverride() {
+        localizedLogger.info("loc.browser.emulation.geolocation.clear");
+        tools.send(Emulation.clearGeolocationOverride());
+    }
+}
diff --git a/src/main/java/aquality/selenium/browser/devtools/NetworkTools.java b/src/main/java/aquality/selenium/browser/devtools/NetworkTools.java
@@ -0,0 +1,67 @@
+package aquality.selenium.browser.devtools;
+
+import aquality.selenium.browser.AqualityServices;
+import aquality.selenium.core.localization.ILocalizedLogger;
+import org.openqa.selenium.UsernameAndPassword;
+import org.openqa.selenium.devtools.DevTools;
+import org.openqa.selenium.devtools.NetworkInterceptor;
+import org.openqa.selenium.devtools.v96.network.Network;
+import org.openqa.selenium.devtools.v96.network.model.RequestWillBeSent;
+import org.openqa.selenium.devtools.v96.network.model.ResponseReceived;
+import org.openqa.selenium.remote.http.HttpResponse;
+import org.openqa.selenium.remote.http.Route;
+
+import java.net.URI;
+import java.util.Optional;
+import java.util.function.Consumer;
+import java.util.function.Predicate;
+
+import static aquality.selenium.browser.AqualityServices.getBrowser;
+
+public class NetworkTools {
+
+    private final DevTools tools;
+    private final ILocalizedLogger localizedLogger = AqualityServices.getLocalizedLogger();
+
+    public NetworkTools(DevTools tools) {
+        this.tools = tools;
+    }
+
+    public void addBasicAuthentication(String hostPart, String username, String password) {
+        localizedLogger.info("loc.browser.network.authentication.add");
+        Predicate<URI> uriPredicate = uri -> uri.getHost().contains(hostPart);
+        tools.getDomains().network().addAuthHandler(uriPredicate, UsernameAndPassword.of(username, password));
+    }
+
+    public void clearBasicAuthentication() {
+        localizedLogger.info("loc.browser.network.authentication.clear");
+        tools.getDomains().network().disable();
+    }
+
+    public void addRequestHandler(Consumer<RequestWillBeSent> handler) {
+        localizedLogger.info("loc.browser.network.event.requestsent.add");
+        tools.send(Network.enable(Optional.empty(), Optional.empty(), Optional.empty()));
+        tools.addListener(Network.requestWillBeSent(), handler);
+    }
+
+    public void addResponseHandler(Consumer<ResponseReceived> handler) {
+        localizedLogger.info("loc.browser.network.event.responsereceived.add");
+        tools.send(Network.enable(Optional.empty(), Optional.empty(), Optional.empty()));
+        tools.addListener(Network.responseReceived(), handler);
+    }
+
+    public void clearHandlers() {
+        tools.clearListeners();
+    }
+
+    public NetworkInterceptor startNetworkInterceptor(HttpResponse response) {
+        return new NetworkInterceptor(
+                getBrowser().getDriver(),
+                Route.matching(req -> true)
+                        .to(() -> req -> response));
+    }
+
+    public void closeNetworkInterceptor(NetworkInterceptor interceptor) {
+        interceptor.close();
+    }
+}
diff --git a/src/main/resources/localization/be.json b/src/main/resources/localization/be.json
@@ -78,5 +78,12 @@
   "loc.browser.get.tab.handles": "Атрыманне спісу дэскрыптараў адкрытых укладак",
   "loc.browser.get.tab.handle": "Атрыманне дэскрыптара бягучай укладкі",
   "loc.browser.tab.open.new": "Адкрыццё новай укладкі",
-  "loc.browser.tab.close": "Закрыццё ўкладкі"
+  "loc.browser.tab.close": "Закрыццё ўкладкі",
+  "loc.browser.network.authentication.add": "Дадаем апрацоўшчык базавай аўтэнтыфікацыі",
+  "loc.browser.network.authentication.clear": "Ачысика апрацоўшчыка базавай аўтэнтыфікацыі",
+  "loc.browser.emulation.geolocation.set": "Дадаем перавызначэнне геалакацыі",
+  "loc.browser.emulation.geolocation.clear": "Ачыстка перавызначэння геалакацыі",
+  "loc.browser.network.event.requestsent.add": "Падпісваемся на падзею адпраўкі сеткавага запыта",
+  "loc.browser.network.event.responsereceived.add": "Падпісваемся на падзею атрымання сеткавага адказа",
+  "loc.browser.network.event.listeners.clear": "Ачыстка спіса адсочваных падзей"
 }
diff --git a/src/main/resources/localization/en.json b/src/main/resources/localization/en.json
@@ -78,5 +78,12 @@
   "loc.browser.get.tab.handles": "Getting tab handles",
   "loc.browser.get.tab.handle": "Getting current tab handle",
   "loc.browser.tab.open.new": "Opening new tab",
-  "loc.browser.tab.close": "Closing tab"
+  "loc.browser.tab.close": "Closing tab",
+  "loc.browser.network.authentication.add": "Adding Basic Authentication handler",
+  "loc.browser.network.authentication.clear": "Clearing Basic Authentication handlers",
+  "loc.browser.emulation.geolocation.set": "Setting Geolocation override",
+  "loc.browser.emulation.geolocation.clear": "Clearing Geolocation override",
+  "loc.browser.network.event.requestsent.add": "Subscribing to Network Request Sent event",
+  "loc.browser.network.event.responsereceived.add": "Subscribing to Network Response Received event",
+  "loc.browser.network.event.listeners.clear": "Clearing event listeners"
 }
diff --git a/src/main/resources/localization/ru.json b/src/main/resources/localization/ru.json
@@ -78,5 +78,12 @@
   "loc.browser.get.tab.handles": "Получение списка дескрипторов открытых вкладок",
   "loc.browser.get.tab.handle": "Получение дескриптора текущей вкладки",
   "loc.browser.tab.open.new": "Открытие новой вкладки",
-  "loc.browser.tab.close": "Закрытие вкладки"
+  "loc.browser.tab.close": "Закрытие вкладки",
+  "loc.browser.network.authentication.add": "Добавление обработчика базовой аутентификации",
+  "loc.browser.network.authentication.clear": "Очистка обработчиков базовой аутентификации",
+  "loc.browser.emulation.geolocation.set": "Установка переопределения геолокации",
+  "loc.browser.emulation.geolocation.clear": "Сброс переопределения геолокации",
+  "loc.browser.network.event.requestsent.add": "Подписываемся на событие отправки сетевого запроса",
+  "loc.browser.network.event.responsereceived.add": "Подписываемся на событие получения сетевого ответа",
+  "loc.browser.network.event.listeners.clear": "Очистка списка отслеживаемых событий"
 }
diff --git a/src/main/resources/log4j.properties b/src/main/resources/log4j.properties
diff --git a/src/main/resources/log4j2.properties b/src/main/resources/log4j2.properties
@@ -0,0 +1,28 @@
+status = info
+rootLogger.level = debug
+property.filepath = ./target/log/
+property.filename = log.log
+appenders = file, console
+
+appender.console.type = Console
+appender.console.name = STDOUT
+appender.console.layout.type = PatternLayout
+appender.console.layout.pattern =%d{yyyy-MM-dd HH:mm:ss} %-5p - %m%n
+appender.console.filter.threshold.type = ThresholdFilter
+appender.console.filter.threshold.level = info
+
+appender.file.type = RollingFile
+appender.file.name = File
+appender.file.fileName = ${filepath}${filename}
+appender.file.filePattern = ${filepath}${filename}.%i
+appender.file.layout.type = PatternLayout
+appender.file.layout.pattern =%d{yyyy-MM-dd HH:mm:ss} %-5p - %m%n
+appender.file.policies.type = Policies
+appender.file.policies.size.type = SizeBasedTriggeringPolicy
+appender.file.policies.size.size=10MB
+appender.file.filter.threshold.type = ThresholdFilter
+appender.file.filter.threshold.level = debug
+
+rootLogger.appenderRefs = file, console
+rootLogger.appenderRef.console.ref = STDOUT
+rootLogger.appenderRef.file.ref = File
diff --git a/src/test/java/automationpractice/Constants.java b/src/test/java/automationpractice/Constants.java
@@ -5,4 +5,5 @@ private Constants(){
     }
 
     public static final String URL_AUTOMATIONPRACTICE = "http://automationpractice.com/index.php";
+    public static final String URL_MYLOCATIONORG = "https://my-location.org";
 }
diff --git a/src/test/java/forms/MyLocationForm.java b/src/test/java/forms/MyLocationForm.java
@@ -0,0 +1,23 @@
+package forms;
+
+import aquality.selenium.elements.interfaces.ILabel;
+import aquality.selenium.forms.Form;
+import org.openqa.selenium.By;
+
+public class MyLocationForm extends Form {
+
+    private final ILabel lblLatitude = getElementFactory().getLabel(By.id("latitude"), "Latitude");
+    private final ILabel lblLongitude = getElementFactory().getLabel(By.id("longitude"), "Longitude");
+
+    public MyLocationForm() {
+        super(By.xpath("//h1[contains(text(),'My Location')]"), "My Location");
+    }
+
+    public double getLatitude() {
+       return Double.parseDouble(lblLatitude.getText());
+    }
+
+    public double getLongitude() {
+        return Double.parseDouble(lblLongitude.getText());
+    }
+}
diff --git a/src/test/java/tests/usecases/devtools/NetworkInterceptionTest.java b/src/test/java/tests/usecases/devtools/NetworkInterceptionTest.java
@@ -0,0 +1,34 @@
+package tests.usecases.devtools;
+
+import com.google.common.net.MediaType;
+import org.apache.hc.core5.http.HttpStatus;
+import org.openqa.selenium.devtools.NetworkInterceptor;
+import org.openqa.selenium.remote.http.HttpResponse;
+import org.testng.Assert;
+import org.testng.annotations.Test;
+import tests.BaseTest;
+import theinternet.forms.FormAuthenticationForm;
+import theinternet.forms.WelcomeForm;
+
+import static org.openqa.selenium.remote.http.Contents.utf8String;
+
+public class NetworkInterceptionTest extends BaseTest {
+
+    private static final String SOME_PHRASE = "Creamy, delicious cheese!";
+
+    @Test
+    public void RegisterBasicAuth() {
+        WelcomeForm welcomeForm = new WelcomeForm();
+
+        NetworkInterceptor interceptor = getBrowser().devTools().network().startNetworkInterceptor(new HttpResponse()
+                .setStatus(HttpStatus.SC_OK)
+                .addHeader("Content-Type", MediaType.HTML_UTF_8.toString())
+                .setContent(utf8String(SOME_PHRASE)));
+        getBrowser().goTo(welcomeForm.getUrl());
+        Assert.assertTrue(getBrowser().getDriver().getPageSource().contains(SOME_PHRASE));
+
+        getBrowser().devTools().network().closeNetworkInterceptor(interceptor);
+        getBrowser().goTo(welcomeForm.getUrl());
+        Assert.assertFalse(getBrowser().getDriver().getPageSource().contains(SOME_PHRASE));
+    }
+}
diff --git a/src/test/java/tests/usecases/devtools/OverrideGeolocationTest.java b/src/test/java/tests/usecases/devtools/OverrideGeolocationTest.java
@@ -0,0 +1,37 @@
+package tests.usecases.devtools;
+
+import aquality.selenium.browser.AqualityServices;
+import forms.MyLocationForm;
+import org.testng.Assert;
+import org.testng.annotations.Test;
+import tests.BaseTest;
+
+import static automationpractice.Constants.URL_MYLOCATIONORG;
+
+public class OverrideGeolocationTest extends BaseTest {
+
+    private static final double LAT_FOR_OVERRIDE = 53.90772672521578;
+    private static final double LNG_FOR_OVERRIDE = 27.458060411865375;
+
+    @Test
+    public void overrideGeolocationTest() {
+
+        AqualityServices.getBrowser().goTo(URL_MYLOCATIONORG);
+        MyLocationForm form = new MyLocationForm();
+        Assert.assertTrue(form.state().waitForDisplayed());
+        double latDefault = form.getLatitude();
+        double lngDefault = form.getLongitude();
+
+        AqualityServices.getBrowser().devTools().emulation().setGeolocationOverride(LAT_FOR_OVERRIDE, LNG_FOR_OVERRIDE);
+        AqualityServices.getBrowser().refresh();
+
+        Assert.assertEquals(form.getLatitude(), LAT_FOR_OVERRIDE);
+        Assert.assertEquals(form.getLongitude(), LNG_FOR_OVERRIDE);
+
+        AqualityServices.getBrowser().devTools().emulation().clearGeolocationOverride();
+        AqualityServices.getBrowser().refresh();
+
+        Assert.assertEquals(form.getLatitude(), latDefault);
+        Assert.assertEquals(form.getLongitude(), lngDefault);
+    }
+}
diff --git a/src/test/java/tests/usecases/devtools/RegisterBasicAuthTest.java b/src/test/java/tests/usecases/devtools/RegisterBasicAuthTest.java
diff --git a/src/test/java/theinternet/forms/BasicAuthForm.java b/src/test/java/theinternet/forms/BasicAuthForm.java
