Implemented tests for Performance metrics, user agent override, device emulation and emulation domain. Implemented additional methods, fixed performance metrics logging.

Author: mialeska

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

@@ -97,6 +97,17 @@ public DevTools getDevToolsSession(String windowHandle) {
         return session;
     }
 
+    /**
+     * Gets a value indicating whether a DevTools session is active.
+     * @return true if there is an active session, false otherwise.
+     */
+    public boolean hasActiveDevToolsSession() {
+        logger.info("loc.browser.devtools.session.isactive");
+        boolean result = devToolsProvider.getDevTools().getCdpSession() != null;
+        logger.info("loc.browser.devtools.session.isactive.result", result);
+        return result;
+    }
+
     /**
      * Closes a DevTools session.
      */
@@ -218,7 +229,11 @@ public void enablePerformanceMonitoring() {
      * @return Current values for run-time metrics
      */
     public Map<String, Number> getPerformanceMetrics() {
-        List<Metric> metrics = sendCommand(Performance.getMetrics());
-        return metrics.stream().collect(Collectors.toMap(Metric::getName, Metric::getValue));
+        Command<List<Metric>> command = Performance.getMetrics();
+        logCommand(command.getMethod(), command.getParams());
+        List<Metric> metrics = getDevToolsSession().send(command);
+        Map<String, Number> result = metrics.stream().collect(Collectors.toMap(Metric::getName, Metric::getValue));
+        logCommandResult(result.isEmpty() ? "empty" : result);
+        return result;
     }
 }

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

@@ -206,8 +206,19 @@ public void setEmulatedMedia(Map<String, Object> params) {
      * @param mediaFeatures Media features to emulate.
      */
     public void setEmulatedMedia(String media, Map<String, String> mediaFeatures) {
-        List<MediaFeature> featureList = mediaFeatures.entrySet().stream().map((Map.Entry<String, String> entry) -> new MediaFeature(entry.getKey(), entry.getValue())).collect(Collectors.toList());
-        tools.sendCommand(Emulation.setEmulatedMedia(Optional.of(media), Optional.of(featureList)));
+        setEmulatedMedia(Optional.of(media), Optional.of(mediaFeatures));
+    }
+
+    /**
+     * Emulates the given media type or media feature for CSS media queries.
+     * @param media Media type to emulate. Empty string disables the override.
+     *              Possible values: braille, embossed, handheld, print, projection, screen, speech, tty, tv.
+     * @param mediaFeatures Media features to emulate.
+     */
+    public void setEmulatedMedia(Optional<String> media, Optional<Map<String, String>> mediaFeatures) {
+        List<MediaFeature> featureList = mediaFeatures.orElse(Collections.emptyMap()).entrySet().stream()
+                .map((Map.Entry<String, String> entry) -> new MediaFeature(entry.getKey(), entry.getValue())).collect(Collectors.toList());
+        tools.sendCommand(Emulation.setEmulatedMedia(media, Optional.of(featureList)));
     }
 
     /**

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

@@ -29,6 +29,7 @@
  * For more information, see {@link org.openqa.selenium.devtools.v85.network.Network} and {@link Network}.
  */
 public class NetworkHandling {
+    public static final String LOC_NETWORK_INTERCEPTOR_START = "loc.browser.network.interceptor.start";
     private final DevToolsHandling tools;
     private final Network<?, ?> network;
     private final ILocalizedLogger logger = AqualityServices.getLocalizedLogger();
@@ -46,15 +47,15 @@ public NetworkHandling(DevToolsHandling tools) {
     /**
      * Starts network monitoring.
      */
-    public void prepareToInterceptTraffic() {
+    public void startMonitoring() {
         logger.info("loc.browser.network.monitoring.start");
         network.prepareToInterceptTraffic();
     }
 
     /**
      * Stops network monitoring.
      */
-    public void disable() {
+    public void stopMonitoring() {
         logger.info("loc.browser.network.monitoring.stop");
         network.disable();
     }
@@ -102,7 +103,7 @@ public void addBasicAuthentication(String hostPart, String username, String pass
      */
     public void clearBasicAuthentication() {
         logger.info("loc.browser.network.authentication.clear");
-        disable();
+        stopMonitoring();
     }
 
     /**
@@ -223,7 +224,7 @@ public void enableHttpExchangeLogging(HttpExchangeLoggingOptions loggingOptions)
      * @return an instance of {@link NetworkInterceptor}.
      */
     public NetworkInterceptor startNetworkInterceptor(HttpHandler httpHandler) {
-        logger.info("loc.browser.network.interceptor.start");
+        logger.info(LOC_NETWORK_INTERCEPTOR_START);
         return new NetworkInterceptor(getBrowser().getDriver(), httpHandler);
     }
 
@@ -233,7 +234,7 @@ public NetworkInterceptor startNetworkInterceptor(HttpHandler httpHandler) {
      * @return an instance of {@link NetworkInterceptor}.
      */
     public NetworkInterceptor startNetworkInterceptor(Filter filter) {
-        logger.info("loc.browser.network.interceptor.start");
+        logger.info(LOC_NETWORK_INTERCEPTOR_START);
         return new NetworkInterceptor(getBrowser().getDriver(), filter);
     }
 
@@ -243,7 +244,7 @@ public NetworkInterceptor startNetworkInterceptor(Filter filter) {
      * @return an instance of {@link NetworkInterceptor}.
      */
     public NetworkInterceptor startNetworkInterceptor(Routable routable) {
-        logger.info("loc.browser.network.interceptor.start");
+        logger.info(LOC_NETWORK_INTERCEPTOR_START);
         return new NetworkInterceptor(getBrowser().getDriver(), routable);
     }
 

src/main/resources/localization/be.json

@@ -79,6 +79,8 @@
   "loc.browser.get.tab.handle": "Атрыманне дэскрыптара бягучай укладкі",
   "loc.browser.tab.open.new": "Адкрыццё новай укладкі",
   "loc.browser.tab.close": "Закрыццё ўкладкі",
+  "loc.browser.devtools.session.isactive": "Правяраем, ці актыўная DevTools сэсія",
+  "loc.browser.devtools.session.isactive.result": "Ці актыўная DevTools сэсія: [%1$s]",
   "loc.browser.devtools.session.close": "Завяршаем сэсію DevTools",
   "loc.browser.devtools.session.get": "Атрымліваем сэсію DevTools з дэскрыптарам ўкладкі '%1$s'",
   "loc.browser.devtools.command.execute": "Выконваем DevTools каманду [%1$s]",

src/main/resources/localization/en.json

@@ -79,6 +79,8 @@
   "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.devtools.session.isactive": "Checking if DevTools session is active",
+  "loc.browser.devtools.session.isactive.result": "Is DevTools session active: [%1$s]",
   "loc.browser.devtools.session.close": "Closing DevTools session",
   "loc.browser.devtools.session.get": "Getting DevTools session by tab handle '%1$s'",
   "loc.browser.devtools.command.execute": "Executing DevTools command [%1$s]",

src/main/resources/localization/ru.json

@@ -79,6 +79,8 @@
   "loc.browser.get.tab.handle": "Получение дескриптора текущей вкладки",
   "loc.browser.tab.open.new": "Открытие новой вкладки",
   "loc.browser.tab.close": "Закрытие вкладки",
+  "loc.browser.devtools.session.isactive": "Проверка, активна ли сессия DevTools",
+  "loc.browser.devtools.session.isactive.result": "Активна ли DevTools сессия: [%1$s]",
   "loc.browser.devtools.session.close": "Завершение DevTools сессии",
   "loc.browser.devtools.session.get": "Получение DevTools сессии с дескриптором вкладки '%1$s'",
   "loc.browser.devtools.command.execute": "Исполняем DevTools команду [%1$s]",

src/test/java/manytools/BrowserLanguageForm.java

@@ -0,0 +1,12 @@
+package manytools;
+
+public class BrowserLanguageForm extends ManyToolsForm<BrowserLanguageForm> {
+    public BrowserLanguageForm() {
+        super("Browser language");
+    }
+
+    @Override
+    protected String getUrlPart() {
+        return "http-html-text/browser-language/";
+    }
+}

src/test/java/manytools/ManyToolsForm.java

@@ -0,0 +1,28 @@
+package manytools;
+
+import aquality.selenium.browser.AqualityServices;
+import aquality.selenium.elements.interfaces.ILabel;
+import aquality.selenium.forms.Form;
+import org.openqa.selenium.By;
+
+public abstract class ManyToolsForm<T extends ManyToolsForm<T>> extends Form {
+    private static final String BASE_URL = "https://manytools.org/";
+    private final ILabel lblValue = getFormLabel().findChildElement(By.xpath(".//code"), getName(), ILabel.class);
+
+    protected ManyToolsForm(String name) {
+        super(By.id("maincontent"), name);
+    }
+
+    protected abstract String getUrlPart();
+
+    @SuppressWarnings("unchecked")
+    public T open() {
+        AqualityServices.getBrowser().goTo(BASE_URL + getUrlPart());
+        AqualityServices.getBrowser().waitForPageToLoad();
+        return (T) this;
+    }
+
+    public String getValue() {
+        return lblValue.getText();
+    }
+}

src/test/java/manytools/UserAgentForm.java

@@ -0,0 +1,12 @@
+package manytools;
+
+public class UserAgentForm extends ManyToolsForm<UserAgentForm> {
+    public UserAgentForm() {
+        super("User agent");
+    }
+
+    @Override
+    protected String getUrlPart() {
+        return "http-html-text/user-agent-string/";
+    }
+}

src/test/java/tests/BaseTest.java

@@ -8,6 +8,10 @@
 import org.testng.annotations.BeforeMethod;
 import theinternet.TheInternetPage;
 
+import java.io.IOException;
+
+import static utils.FileUtil.getResourceFileByName;
+
 public abstract class BaseTest {
     private static final String DEFAULT_URL = TheInternetPage.LOGIN.getAddress();
 
@@ -38,4 +42,13 @@ protected void navigate(TheInternetPage page) {
     protected Browser getBrowser() {
         return AqualityServices.getBrowser();
     }
+
+    @SuppressWarnings("unchecked")
+    protected <T> T getScriptResultOrDefault(String scriptName, T defaultValue) {
+        try {
+            return ((T) getBrowser().executeScript(getResourceFileByName(scriptName)));
+        } catch (IOException e) {
+            return defaultValue;
+        }
+    }
 }