Merge pull request #1 from xdev-software/develop

Release

Author: AB-xdev

.github/workflows/checkBuild.yml

@@ -43,7 +43,7 @@ jobs:
         cache: 'maven'
 
     - name: Build with Maven
-      run: ./mvnw -B clean package
+      run: ./mvnw -B clean package -P run-integration-tests
 
     - name: Check for uncommited changes
       run: |
@@ -63,13 +63,6 @@ jobs:
           exit 1
         fi
 
-    - name: Upload demo files
-      uses: actions/upload-artifact@v4
-      with:
-        name: demo-files-java-${{ matrix.java }}
-        path: ${{ env.DEMO_MAVEN_MODULE }}/target/${{ env.DEMO_MAVEN_MODULE }}.jar
-        if-no-files-found: error
-
   code-style:
     runs-on: ubuntu-latest
     if: ${{ github.event_name != 'pull_request' || !startsWith(github.head_ref, 'renovate/') }}

.run/Run Demo.run.xml

@@ -1,7 +1,7 @@
 <component name="ProjectRunConfigurationManager">
   <configuration default="false" name="Run Demo" type="Application" factoryName="Application">
     <option name="MAIN_CLASS_NAME" value="software.xdev.Application" />
-    <module name="standard-maven-template-demo" />
+    <module name="testcontainers-java-selenium-demo" />
     <option name="WORKING_DIRECTORY" value="$MODULE_DIR$" />
     <extension name="coverage">
       <pattern>

CHANGELOG.md

@@ -0,0 +1,2 @@
+# 1.0.0
+<i>Initial release</i>

CONTRIBUTING.md

@@ -33,10 +33,10 @@ You should have the following things installed:
   * Ensure that the JDK/Java-Version is correct
 
 
-## Releasing [![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/standard-maven-template/release.yml?branch=master)](https://github.com/xdev-software/standard-maven-template/actions/workflows/release.yml)
+## Releasing [![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/testcontainers-java-selenium/release.yml?branch=master)](https://github.com/xdev-software/testcontainers-java-selenium/actions/workflows/release.yml)
 
 Before releasing:
-* Consider doing a [test-deployment](https://github.com/xdev-software/standard-maven-template/actions/workflows/test-deploy.yml?query=branch%3Adevelop) before actually releasing.
+* Consider doing a [test-deployment](https://github.com/xdev-software/testcontainers-java-selenium/actions/workflows/test-deploy.yml?query=branch%3Adevelop) before actually releasing.
 * Check the [changelog](CHANGELOG.md)
 
 If the ``develop`` is ready for release, create a pull request to the ``master``-Branch and merge the changes

LICENSE

@@ -187,6 +187,7 @@
       identification within third-party archives.
 
    Copyright 2024 XDEV Software
+   Copyright 2015-2024 Testcontainers contributors
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

@@ -1,13 +1,27 @@
-[![Latest version](https://img.shields.io/maven-central/v/software.xdev/standard-maven-template?logo=apache%20maven)](https://mvnrepository.com/artifact/software.xdev/standard-maven-template)
-[![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/standard-maven-template/checkBuild.yml?branch=develop)](https://github.com/xdev-software/standard-maven-template/actions/workflows/checkBuild.yml?query=branch%3Adevelop)
-[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=xdev-software_standard-maven-template&metric=alert_status)](https://sonarcloud.io/dashboard?id=xdev-software_standard-maven-template)
+[![Latest version](https://img.shields.io/maven-central/v/software.xdev/testcontainers-java-selenium?logo=apache%20maven)](https://mvnrepository.com/artifact/software.xdev/testcontainers-java-selenium)
+[![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/testcontainers-java-selenium/checkBuild.yml?branch=develop)](https://github.com/xdev-software/testcontainers-java-selenium/actions/workflows/checkBuild.yml?query=branch%3Adevelop)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=xdev-software_testcontainers-java-selenium&metric=alert_status)](https://sonarcloud.io/dashboard?id=xdev-software_testcontainers-java-selenium)
 
-# standard-maven-template
+# <img src="https://raw.githubusercontent.com/SeleniumHQ/seleniumhq.github.io/690acbad7b4bf4656f116274809765db64e6ccf7/website_and_docs/static/images/logos/webdriver.svg" height=24 /> testcontainers-java-selenium
 
+A re-implementation of [Testcontainer Selenium/WebDriver](https://java.testcontainers.org/modules/webdriver_containers/) with the following improvements:
+* It uses [Selenium's video recorder](https://github.com/SeleniumHQ/docker-selenium/blob/trunk/README.md#video-recording)
+  * Doesn't require VNC 
+    * No VNC Server started in the browser container (unless explicitly stated) → Saves memory
+  * Uses [Selenium's implementation](https://github.com/SeleniumHQ/docker-selenium/tree/trunk/Video) and isn't [based](https://github.com/testcontainers/vnc-recorder) on [some python code from 2010](https://pypi.org/project/vnc2flv/#history)
+    * Way more customization options for e.g. ``framerate``, ``codec``, ``preset`` ...
+    * Uses ``mp4`` as default recording format (wider support in comparison to ``flv``)
+    * [Renders while saving the video](https://github.com/SeleniumHQ/docker-selenium/blob/4c572afd1173b5bd49fa2def3b54ea552fccee85/Video/video.sh#L126) (not when finished which takes additional time)
+  * Stops the recorder before saving the file so that there is no way that [it runs forever](https://github.com/testcontainers/testcontainers-java/discussions/6229).
+* Automatically tries to select a alternative Selenium version for the docker image if it [doesn't exist](https://github.com/SeleniumHQ/docker-selenium/issues/1979).
+* Added support for [NoVNC](https://github.com/SeleniumHQ/docker-selenium/blob/trunk/README.md#using-your-browser-no-vnc-client-is-needed) so that no dedicated VNC client is required
+* Improve creation of video filenames
+* Removed hard dependency on Selenium-Java.<br/>Only required when using ``CapabilitiesBrowserWebDriverContainer``
+* Everything can be ``@Override``n if required
+* Caches "Selenium version detection via classpath" so that it's not invoked everytime you build a new container
 
 ## Installation
-[Installation guide for the latest release](https://github.com/xdev-software/standard-maven-template/releases/latest#Installation)
-
+[Installation guide for the latest release](https://github.com/xdev-software/testcontainers-java-selenium/releases/latest#Installation)
 
 ## Support
 If you need support as soon as possible and you can't wait for any pull request, feel free to use [our support](https://xdev.software/en/services/support).
@@ -16,4 +30,6 @@ If you need support as soon as possible and you can't wait for any pull request,
 See the [contributing guide](./CONTRIBUTING.md) for detailed instructions on how to get started with our project.
 
 ## Dependencies and Licenses
-View the [license of the current project](LICENSE) or the [summary including all dependencies](https://xdev-software.github.io/standard-maven-template/dependencies)
+View the [license of the current project](LICENSE) or the [summary including all dependencies](https://xdev-software.github.io/testcontainers-java-selenium/dependencies)
+
+<sub>Disclaimer: This is not an official Testcontainers/Selenium product and not associated with them</sub>

SECURITY.md

@@ -2,4 +2,4 @@
 
 ## Reporting a Vulnerability
 
-Please report a security vulnerability [on GitHub Security Advisories](https://github.com/xdev-software/standard-maven-template/security/advisories/new).
+Please report a security vulnerability [on GitHub Security Advisories](https://github.com/xdev-software/testcontainers-java-selenium/security/advisories/new).

pom.xml

@@ -5,7 +5,7 @@
 	<modelVersion>4.0.0</modelVersion>
 
 	<groupId>software.xdev</groupId>
-	<artifactId>standard-maven-template-root</artifactId>
+	<artifactId>testcontainers-java-selenium-root</artifactId>
 	<version>1.0.0-SNAPSHOT</version>
 	<packaging>pom</packaging>
 
@@ -15,8 +15,8 @@
 	</organization>
 
 	<modules>
-		<module>standard-maven-template</module>
-		<module>standard-maven-template-demo</module>
+		<module>testcontainers-java-selenium</module>
+		<module>testcontainers-java-selenium-demo</module>
 	</modules>
 
 	<licenses>

standard-maven-template-demo/pom.xml testcontainers-java-selenium-demo/pom.xmlstandard-maven-template-demo/pom.xml renamed to testcontainers-java-selenium-demo/pom.xml

@@ -5,7 +5,7 @@
 	<modelVersion>4.0.0</modelVersion>
 
 	<groupId>software.xdev</groupId>
-	<artifactId>standard-maven-template-demo</artifactId>
+	<artifactId>testcontainers-java-selenium-demo</artifactId>
 	<version>1.0.0-SNAPSHOT</version>
 	<packaging>jar</packaging>
 
@@ -24,12 +24,76 @@
 		<mainClass>software.xdev.Application</mainClass>
 	</properties>
 
+	<dependencyManagement>
+		<dependencies>
+			<dependency>
+				<groupId>org.seleniumhq.selenium</groupId>
+				<artifactId>selenium-dependencies-bom</artifactId>
+				<version>4.19.1</version>
+				<type>pom</type>
+				<scope>import</scope>
+			</dependency>
+		</dependencies>
+	</dependencyManagement>
+
 	<dependencies>
 		<dependency>
 			<groupId>software.xdev</groupId>
-			<artifactId>standard-maven-template</artifactId>
+			<artifactId>testcontainers-java-selenium</artifactId>
 			<version>${project.version}</version>
 		</dependency>
+
+		<dependency>
+			<groupId>org.slf4j</groupId>
+			<artifactId>slf4j-simple</artifactId>
+			<version>2.0.13</version>
+		</dependency>
+
+		<dependency>
+			<groupId>org.seleniumhq.selenium</groupId>
+			<artifactId>selenium-remote-driver</artifactId>
+			<exclusions>
+				<!-- Tracing is not needed -->
+				<exclusion>
+					<groupId>io.opentelemetry</groupId>
+					<artifactId>*</artifactId>
+				</exclusion>
+				<!-- No unused, beta-grade, RUST blobs -->
+				<exclusion>
+					<groupId>org.seleniumhq.selenium</groupId>
+					<artifactId>selenium-manager</artifactId>
+				</exclusion>
+			</exclusions>
+		</dependency>
+
+		<dependency>
+			<groupId>org.seleniumhq.selenium</groupId>
+			<artifactId>selenium-support</artifactId>
+		</dependency>
+
+		<dependency>
+			<groupId>org.seleniumhq.selenium</groupId>
+			<artifactId>selenium-firefox-driver</artifactId>
+			<exclusions>
+				<!-- No unused, beta-grade, RUST blobs -->
+				<exclusion>
+					<groupId>org.seleniumhq.selenium</groupId>
+					<artifactId>selenium-manager</artifactId>
+				</exclusion>
+			</exclusions>
+		</dependency>
+
+		<dependency>
+			<groupId>org.seleniumhq.selenium</groupId>
+			<artifactId>selenium-chrome-driver</artifactId>
+			<exclusions>
+				<!-- No unused, beta-grade, RUST blobs -->
+				<exclusion>
+					<groupId>org.seleniumhq.selenium</groupId>
+					<artifactId>selenium-manager</artifactId>
+				</exclusion>
+			</exclusions>
+		</dependency>
 	</dependencies>
 
 	<build>

testcontainers-java-selenium-demo/src/main/java/software/xdev/Application.java

@@ -0,0 +1,79 @@
+package software.xdev;
+
+import java.io.IOException;
+import java.io.UncheckedIOException;
+import java.nio.file.Path;
+import java.util.List;
+import java.util.Optional;
+
+import org.openqa.selenium.By;
+import org.openqa.selenium.Capabilities;
+import org.openqa.selenium.chrome.ChromeOptions;
+import org.openqa.selenium.firefox.FirefoxOptions;
+import org.openqa.selenium.remote.RemoteWebDriver;
+import org.testcontainers.lifecycle.TestDescription;
+
+import software.xdev.testcontainers.selenium.containers.browser.BrowserWebDriverContainer;
+import software.xdev.testcontainers.selenium.containers.browser.CapabilitiesBrowserWebDriverContainer;
+
+
+public final class Application
+{
+	@SuppressWarnings("resource") // It's getting closed...
+	public static void main(final String[] args)
+	{
+		final Path recordingDir = Path.of("target/records");
+		// noinspection ResultOfMethodCallIgnored
+		recordingDir.toFile().mkdirs();
+		
+		for(final Capabilities capabilities : List.of(new ChromeOptions(), new FirefoxOptions()))
+		{
+			try(final var browserContainer = new CapabilitiesBrowserWebDriverContainer<>(capabilities)
+				.withRecordingMode(BrowserWebDriverContainer.RecordingMode.RECORD_ALL)
+				.withRecordingDirectory(recordingDir))
+			{
+				browserContainer.start();
+				final RemoteWebDriver remoteWebDriver =
+					new RemoteWebDriver(browserContainer.getSeleniumAddressURI().toURL(), capabilities, false);
+				
+				remoteWebDriver.manage().window().maximize();
+				
+				remoteWebDriver.get(capabilities instanceof FirefoxOptions ? "about:support" : "chrome://version");
+				Thread.sleep(1000); // Simulate Test work
+				remoteWebDriver.findElements(By.tagName("body"));
+				
+				remoteWebDriver.quit();
+				
+				// Wait a moment until everything is safe on tape
+				Thread.sleep(100);
+				
+				browserContainer.afterTest(new TestDescription()
+				{
+					@Override
+					public String getTestId()
+					{
+						return "demo-" + capabilities.getBrowserName();
+					}
+					
+					@Override
+					public String getFilesystemFriendlyName()
+					{
+						return "demo-" + capabilities.getBrowserName();
+					}
+				}, Optional.empty());
+			}
+			catch(final InterruptedException ite)
+			{
+				Thread.currentThread().interrupt();
+			}
+			catch(final IOException ioe)
+			{
+				throw new UncheckedIOException(ioe);
+			}
+		}
+	}
+	
+	private Application()
+	{
+	}
+}