Bump to WebDriverManager 6.1.0 and update BrowserWatcher features

Author: bonigarcia

pom.xml

@@ -1,4 +1,6 @@
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
 
     <groupId>io.github.bonigarcia</groupId>
@@ -8,7 +10,7 @@
     <properties>
         <!-- Compile dependencies -->
         <slf4j.version>2.0.17</slf4j.version>
-        <webdrivermanager.version>6.0.1</webdrivermanager.version>
+        <webdrivermanager.version>6.1.0</webdrivermanager.version>
 
         <!-- Provided dependencies -->
         <junit.jupiter.version>5.12.2</junit.jupiter.version>

src/doc/asciidoc/index.adoc

@@ -161,8 +161,8 @@ TIP: Notice that the previous example also uses the attributes `lang` and `timez
 .Example of noVNC session using Chrome in Docker
 image::seljup-vnc.png[scaledwidth=100%]
 
-==== Recordings
-The following related feature is the recording of the remote session of a dockerized browser. To enable it, we need to set to `true` the attribute `recording` of `@DockerBrowser`. Internally, Selenium-Jupiter starts another Docker container using https://ffmpeg.org/[FFmpeg] to record the browser session. At the end of the test, we can find the recording in MP4, by default, in the same folder of the project root. The following example shows a simple using this feature.
+==== Video Recording
+The following related feature is recording the desktop session of a dockerized browser. To enable it, we need to set to `true` the attribute `recording` of `@DockerBrowser`. Internally, Selenium-Jupiter starts another Docker container using https://ffmpeg.org/[FFmpeg] to record the browser session. At the end of the test, we can find the recording in MP4, by default, in the same folder of the project root. The following example shows a simple using this feature.
 
 [source,java]
 ----
@@ -210,8 +210,7 @@ TIP: You can use the capabilities annotations also for browsers in Docker (see h
 === Template tests
 Selenium-Jupiter uses a standard feature of JUnit 5 called http://junit.org/junit5/docs/current/user-guide/#writing-tests-test-templates[test templates]. Test templates are a special kind of test in which the same test logic is executed several times according to some custom data. In Selenium-Jupiter, the data to feed a test template is known as _browser scenario_.
 
-The following example shows a test using this feature. 
-Notice that instead of declaring the method with the usual `@Test` annotation, we use the JUnit 5's `@TestTemplate`. Then, the parameter type of the test template method is `WebDriver`. This type is the generic interface of Selenium WebDriver, and the concise type (i.e. `ChromeDriver,` `FirefoxDriver,` etc.) is determined by Selenium-Jupiter in runtime. The `@BrowserScenarioTest` annotation can be used for more control over the test names generated by the template tests.
+The following example shows a test using this feature. Notice that instead of declaring the method with the usual `@Test` annotation, we use the JUnit 5's `@TestTemplate`. Then, the parameter type of the test template method is `WebDriver`. This type is the generic interface of Selenium WebDriver, and the concise type (i.e. `ChromeDriver,` `FirefoxDriver,` etc.) is determined by Selenium-Jupiter in runtime. Also, the `@BrowserScenarioTest` annotation can be used for more control over the test names generated by the template tests.
 
 [source,java]
 ----
@@ -260,7 +259,7 @@ In addition to log gathering, BrowserWatcher allows displaying the console logs
 
 [source,java]
 ----
-include::../../test/java/io/github/bonigarcia/seljup/test/watcher/DisplayLogsChromeTest.java[tags=snippet-in-doc,indent=0]
+include::../../test/java/io/github/bonigarcia/seljup/test/watcher/DisplayLogsFirefoxTest.java[tags=snippet-in-doc,indent=0]
 ----
 
 The following picture shows an example of these notifications:
@@ -270,15 +269,17 @@ The following picture shows an example of these notifications:
 .Display logs example
 image::display-console-logs-example-v3.png[scaledwidth=100%]
 
-==== Tab Recording
-BrowserWatcher allows recording a browser tab. This feature requires a page loaded in the current tab (in other words, it cannot record empty or configuration pages). Then, the recording is started using the method `startRecording()` and stopped with `stopRecording()`, for instance, as follows:
+WARNING: This feature is not available for BrowserWatcher 2.x (i.e., based on manifest v3 -MV3-). Therefore, this feature is currently only available for Firefox.
+
+==== Video Recording
+BrowserWatcher (MV3) allows recording the current browser tab (i.e., the browser viewport). This feature requires a page loaded in the current tab (in other words, it cannot record empty or configuration pages). Then, the recording is started using the method `startRecording()` and stopped with `stopRecording()`. After stopping, the video recording will be automatically downloaded by the browser, and the recording (a webm file) will be stored in the downloads folder. You can discover the path of this recording using the method `getRecordingPath()`. The following test illustrates this feature:
 
 [source,java]
 ----
-include::../../test/java/io/github/bonigarcia/seljup/test/watcher/RecordEdgeTest.java[tags=snippet-in-doc,indent=0]
+include::../../test/java/io/github/bonigarcia/seljup/test/watcher/RecordChromeTest.java[tags=snippet-in-doc,indent=0]
 ----
 
-WARNING: This feature is based on the API https://developer.chrome.com/docs/extensions/reference/tabCapture/[tabCapture]. Therefore, this feature is not available in Firefox since this API is not implemented by Firefox yet.
+WARNING: This feature is based on the https://developer.chrome.com/docs/extensions/reference/tabCapture/[tabCapture API]. Therefore, it is only available in Chromium-based browsers (e.g., Chrome and Edge).
 
 ==== Disabling CSP
 https://content-security-policy.com/[Content Security Policy (CSP)] is the name of an HTTP response header that browsers use to improve the security of web pages. CSP helps to protect from attacks such as cross-site scripting (XSS). Nevertheless, developers might want to disable the CSP headers received from the server for testing purposes. For this reason, BrowserWatcher allows bypassing these CSP headers. This feature (i.e., disabling CSP headers) can be enabled in WebDriverManager using the property `disableCsp`, as follows:

src/main/java/io/github/bonigarcia/seljup/SeleniumJupiter.java

@@ -557,13 +557,15 @@ public Stream<TestTemplateInvocationContext> provideTestTemplateInvocationContex
             if (!browserJsonContent.isEmpty()) {
                 return new Gson()
                         .fromJson(browserJsonContent, BrowsersTemplate.class)
-                        .getStream().map(b -> invocationContext(b, this, extensionContext));
+                        .getStream()
+                        .map(b -> invocationContext(b, this, extensionContext));
             }
 
             if (browserListMap != null) {
                 List<Browser> browsers = browserListMap.get(contextId);
                 if (browsers != null) {
-                    return Stream.of(invocationContext(browsers, this, extensionContext));
+                    return Stream.of(invocationContext(browsers, this,
+                            extensionContext));
                 } else {
                     return Stream.empty();
                 }
@@ -578,17 +580,20 @@ public Stream<TestTemplateInvocationContext> provideTestTemplateInvocationContex
     }
 
     private synchronized TestTemplateInvocationContext invocationContext(
-            List<Browser> template, SeleniumJupiter parent, ExtensionContext extensionContext) {
+            List<Browser> template, SeleniumJupiter parent,
+            ExtensionContext extensionContext) {
         return new TestTemplateInvocationContext() {
             @Override
             public String getDisplayName(int invocationIndex) {
-                return AnnotationSupport.findAnnotation(
-                        extensionContext.getRequiredTestMethod(), BrowserScenarioTest.class)
-                    .map(annotation -> BrowserScenarioTest.NameFormatter.format(
-                            annotation.name(),
-                            extensionContext.getDisplayName(),
-                            template.get(0))
-                    ).orElse(template.toString());
+                return AnnotationSupport
+                        .findAnnotation(
+                                extensionContext.getRequiredTestMethod(),
+                                BrowserScenarioTest.class)
+                        .map(annotation -> BrowserScenarioTest.NameFormatter
+                                .format(annotation.name(),
+                                        extensionContext.getDisplayName(),
+                                        template.get(0)))
+                        .orElse(template.toString());
             }
 
             @Override
@@ -659,7 +664,8 @@ public void putBrowserList(String key, List<Browser> browserList) {
     }
 
     private boolean isTestTemplate(ExtensionContext extensionContext) {
-        return AnnotationSupport.isAnnotated(extensionContext.getTestMethod(), TestTemplate.class);
+        return AnnotationSupport.isAnnotated(extensionContext.getTestMethod(),
+                TestTemplate.class);
     }
 
     private boolean isGeneric(Class<?> type) {
@@ -824,6 +830,10 @@ public List<Map<String, Object>> getLogs(WebDriver driver) {
         return invokeWdm(driver, "getLogs");
     }
 
+    public void startRecording() {
+        invokeWdm("startRecording");
+    }
+
     public void startRecording(String recFilename) {
         invokeWdm("startRecording", recFilename);
     }
@@ -840,6 +850,14 @@ public void stopRecording(WebDriver driver) {
         invokeWdm(driver, "stopRecording");
     }
 
+    public Path getRecordingPath() {
+        return invokeWdm("getRecordingPath");
+    }
+
+    public Path getRecordingPath(WebDriver driver) {
+        return invokeWdm(driver, "getRecordingPath");
+    }
+
     @SuppressWarnings("unchecked")
     public <T> T invokeWdm(String method, Object... params) {
         T out = null;

src/test/java/io/github/bonigarcia/seljup/test/watcher/DisableCspFirefoxTest.java

@@ -22,15 +22,13 @@
 import java.util.List;
 import java.util.Map;
 
-import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.RegisterExtension;
 import org.openqa.selenium.firefox.FirefoxDriver;
 
 import io.github.bonigarcia.seljup.SeleniumJupiter;
 import io.github.bonigarcia.seljup.Watch;
 
-@Disabled
 class DisableCspFirefoxTest {
 
     @RegisterExtension

src/test/java/io/github/bonigarcia/seljup/test/watcher/DisplayLogsChromeTest.java renamed to src/test/java/io/github/bonigarcia/seljup/test/watcher/DisplayLogsFirefoxTest.java

@@ -26,17 +26,15 @@
 import java.util.Map;
 
 import org.junit.jupiter.api.AfterEach;
-import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.RegisterExtension;
-import org.openqa.selenium.chrome.ChromeDriver;
+import org.openqa.selenium.firefox.FirefoxDriver;
 import org.slf4j.Logger;
 
 import io.github.bonigarcia.seljup.SeleniumJupiter;
 import io.github.bonigarcia.seljup.Watch;
 
-@Disabled
-class DisplayLogsChromeTest {
+class DisplayLogsFirefoxTest {
 
     static final Logger log = getLogger(lookup().lookupClass());
 
@@ -50,7 +48,7 @@ void teardown() throws InterruptedException {
     }
 
     @Test
-    void test(@Watch(display = true) ChromeDriver driver) {
+    void test(@Watch(display = true) FirefoxDriver driver) {
         driver.get(
                 "https://bonigarcia.dev/selenium-webdriver-java/console-logs.html");
 

src/test/java/io/github/bonigarcia/seljup/test/watcher/GatherLogsFirefoxTest.java

@@ -24,7 +24,6 @@
 import java.util.List;
 import java.util.Map;
 
-import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.RegisterExtension;
 import org.openqa.selenium.firefox.FirefoxDriver;
@@ -33,7 +32,6 @@
 import io.github.bonigarcia.seljup.SeleniumJupiter;
 import io.github.bonigarcia.seljup.Watch;
 
-@Disabled
 class GatherLogsFirefoxTest {
 
     static final Logger log = getLogger(lookup().lookupClass());

src/test/java/io/github/bonigarcia/seljup/test/watcher/RecordEdgeTest.java renamed to src/test/java/io/github/bonigarcia/seljup/test/watcher/RecordChromeTest.java

@@ -18,52 +18,36 @@
 
 //tag::snippet-in-doc[]
 import static java.lang.invoke.MethodHandles.lookup;
-import static org.assertj.core.api.Assertions.fail;
+import static org.assertj.core.api.Assertions.assertThat;
 import static org.slf4j.LoggerFactory.getLogger;
 
-import java.io.File;
+import java.nio.file.Path;
 import java.time.Duration;
-import java.util.concurrent.TimeUnit;
 
-import org.junit.jupiter.api.BeforeEach;
-import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.RegisterExtension;
 import org.openqa.selenium.By;
-import org.openqa.selenium.edge.EdgeDriver;
+import org.openqa.selenium.chrome.ChromeDriver;
 import org.openqa.selenium.support.ui.ExpectedConditions;
 import org.openqa.selenium.support.ui.WebDriverWait;
 import org.slf4j.Logger;
 
 import io.github.bonigarcia.seljup.SeleniumJupiter;
 import io.github.bonigarcia.seljup.Watch;
 
-@Disabled
-class RecordEdgeTest {
+class RecordChromeTest {
 
     static final Logger log = getLogger(lookup().lookupClass());
 
-    static final int REC_TIMEOUT_SEC = 10;
-    static final int POLL_TIME_MSEC = 100;
-    static final String REC_FILENAME = "myRecordingEdge";
-    static final String REC_EXT = ".webm";
-
     @RegisterExtension
     static SeleniumJupiter seleniumJupiter = new SeleniumJupiter();
 
-    File targetFolder;
-
-    @BeforeEach
-    void setup() {
-        targetFolder = new File(System.getProperty("user.home"), "Downloads");
-    }
-
     @Test
-    void test(@Watch EdgeDriver driver) throws InterruptedException {
+    void test(@Watch ChromeDriver driver) throws InterruptedException {
         driver.get(
                 "https://bonigarcia.dev/selenium-webdriver-java/slow-calculator.html");
 
-        seleniumJupiter.startRecording(REC_FILENAME);
+        seleniumJupiter.startRecording();
 
         // 1 + 3
         driver.findElement(By.xpath("//span[text()='1']")).click();
@@ -77,22 +61,10 @@ void test(@Watch EdgeDriver driver) throws InterruptedException {
 
         seleniumJupiter.stopRecording();
 
-        long timeoutMs = System.currentTimeMillis()
-                + TimeUnit.SECONDS.toMillis(REC_TIMEOUT_SEC);
-
-        File recFile;
-        do {
-            recFile = new File(targetFolder, REC_FILENAME + REC_EXT);
-            if (System.currentTimeMillis() > timeoutMs) {
-                fail("Timeout of " + REC_TIMEOUT_SEC
-                        + " seconds waiting for recording " + recFile);
-                break;
-            }
-            Thread.sleep(POLL_TIME_MSEC);
-
-        } while (!recFile.exists());
+        Path recordingPath = seleniumJupiter.getRecordingPath();
+        assertThat(recordingPath).exists();
 
-        log.debug("Recording available at {}", recFile);
+        log.debug("Recording available at {}", recordingPath);
     }
 
 }

src/test/resources/browsers.json

@@ -15,11 +15,7 @@
       [
          {
             "type": "chrome-in-docker",
-            "version": "beta",
-            "arguments": [
-               "--disable-gpu",
-               "--no-sandbox"
-            ]
+            "version": "beta"
          }
       ],
       [