Merge branch 'develop' into update-from-template-merged

Author: xdev-gh-bot

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -15,9 +15,9 @@ body:
     attributes:
       label: "Checklist"
       options:
-        - label: "I am able to reproduce the bug with the [latest version](https://github.com/xdev-software/template-placeholder/releases/latest)"
+        - label: "I am able to reproduce the bug with the [latest version](https://github.com/xdev-software/testcontainers-selenium/releases/latest)"
           required: true
-        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/template-placeholder/issues) or [closed](https://github.com/xdev-software/template-placeholder/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
+        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/testcontainers-selenium/issues) or [closed](https://github.com/xdev-software/testcontainers-selenium/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
           required: true
         - label: "I have taken the time to fill in all the required details. I understand that the bug report will be dismissed otherwise."
           required: true

.github/ISSUE_TEMPLATE/enhancement.yml

@@ -13,7 +13,7 @@ body:
     attributes:
       label: "Checklist"
       options:
-        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/template-placeholder/issues) or [closed](https://github.com/xdev-software/template-placeholder/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
+        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/testcontainers-selenium/issues) or [closed](https://github.com/xdev-software/testcontainers-selenium/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
           required: true
         - label: "I have taken the time to fill in all the required details. I understand that the feature request will be dismissed otherwise."
           required: true

.github/ISSUE_TEMPLATE/question.yml

@@ -12,7 +12,7 @@ body:
     attributes:
       label: "Checklist"
       options:
-        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/template-placeholder/issues) or [closed](https://github.com/xdev-software/template-placeholder/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
+        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/testcontainers-selenium/issues) or [closed](https://github.com/xdev-software/testcontainers-selenium/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
           required: true
         - label: "I have taken the time to fill in all the required details. I understand that the question will be dismissed otherwise."
           required: true

.github/workflows/check-build.yml

@@ -48,7 +48,7 @@ jobs:
           ${{ runner.os }}-mvn-build-
 
     - name: Build with Maven
-      run: ./mvnw -B clean package
+      run: ./mvnw -B clean package -P run-integration-tests
 
     - name: Check for uncommited changes
       run: |
@@ -68,13 +68,6 @@ jobs:
           exit 1
         fi
 
-    - name: Upload demo files
-      uses: actions/upload-artifact@v7
-      with:
-        name: demo-files-java-${{ matrix.java }}
-        path: ${{ env.DEMO_MAVEN_MODULE }}/target/${{ env.DEMO_MAVEN_MODULE }}.jar
-        if-no-files-found: error
-
   checkstyle:
     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="template-placeholder-demo" />
+    <module name="testcontainers-selenium-demo" />
     <option name="WORKING_DIRECTORY" value="$MODULE_DIR$" />
     <extension name="coverage">
       <pattern>

CHANGELOG.md

@@ -0,0 +1,69 @@
+# 2.0.0
+_Major version bump due to default video container format change_
+* Pinned recorder container to `selenium/video:ffmpeg-8.0-20260202` because the currently latest version of the container is not shutting down properly
+* Changed default video container format to `mkv`
+  * This format allows to play the videos even when they are incomplete
+* Update default Selenium version to `4.41.0`
+* Updated dependencies
+
+# 1.5.3
+* Improve error message when browser name can't be matched
+* Updated dependencies
+
+# 1.5.2
+* Updated dependencies
+
+# 1.5.1
+* Slightly increased default recording save wait time a bit
+
+# 1.5.0
+* No longer map timezone into container by default
+  * This should keep tests consistent
+
+# 1.4.0
+* `getNoVncAddress` now returns an auto-login url
+  * The original behavior is still available with `getNoVncAddressRaw`
+
+# 1.3.0
+* Update to Testcontainers v2
+
+# 1.2.5
+* Update default Selenium version to `4.36.0`
+* Updated dependencies
+
+# 1.2.4
+* New option ``beforeRecordingSaveWaitTime`` in ``BrowserWebDriverContainer``
+  * If not ``null``: Waits the amount of specified time before saving the recording
+  * This way no frames showing a test failure might get accidentally lost
+  * Default value is set to ``70ms`` which is 1 full frame when recording at the default 15 FPS
+* Only compute name for recording when required
+
+# 1.2.3
+* Make some constants externally accessible
+* Provide chromium image (Chrome doesn't work on ARM64)
+
+# 1.2.2
+* [Browser] Improve SHM configuration
+
+# 1.2.1
+* Migrated deployment to _Sonatype Maven Central Portal_ [#155](https://github.com/xdev-software/standard-maven-template/issues/155)
+* Updated dependencies
+
+# 1.2.0
+* Remove testcontainer's dependency [onto JUnit 4](https://github.com/xdev-software/testcontainers-junit4-mock/?tab=readme-ov-file)
+* Update default Selenium version to ``4.32.0``
+* Updated dependencies
+
+# 1.1.0
+* Make it easier to use different Selenium images
+* Update default Selenium version to ``4.25.0``
+* Updated dependencies
+
+# 1.0.2
+* Updated dependencies
+
+# 1.0.1
+Rename artifactId from ``testcontainers-java-selenium`` to ``testcontainers-selenium``
+
+# 1.0.0
+<i>Initial release</i>

CONTRIBUTING.md

@@ -34,10 +34,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/template-placeholder/release.yml?branch=master)](https://github.com/xdev-software/template-placeholder/actions/workflows/release.yml)
+## Releasing [![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/testcontainers-selenium/release.yml?branch=master)](https://github.com/xdev-software/testcontainers-selenium/actions/workflows/release.yml)
 
 Before releasing:
-* Consider doing a [test-deployment](https://github.com/xdev-software/template-placeholder/actions/workflows/test-deploy.yml?query=branch%3Adevelop) before actually releasing.
+* Consider doing a [test-deployment](https://github.com/xdev-software/testcontainers-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,11 +1,39 @@
-[![Latest version](https://img.shields.io/maven-central/v/software.xdev/template-placeholder?logo=apache%20maven)](https://mvnrepository.com/artifact/software.xdev/template-placeholder)
-[![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/template-placeholder/check-build.yml?branch=develop)](https://github.com/xdev-software/template-placeholder/actions/workflows/check-build.yml?query=branch%3Adevelop)
+[![Latest version](https://img.shields.io/maven-central/v/software.xdev/testcontainers-selenium?logo=apache%20maven)](https://mvnrepository.com/artifact/software.xdev/testcontainers-selenium)
+[![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/testcontainers-selenium/check-build.yml?branch=develop)](https://github.com/xdev-software/testcontainers-selenium/actions/workflows/check-build.yml?query=branch%3Adevelop)
 
-# template-placeholder
+# <img src="https://raw.githubusercontent.com/SeleniumHQ/seleniumhq.github.io/690acbad7b4bf4656f116274809765db64e6ccf7/website_and_docs/static/images/logos/webdriver.svg" height=24 /> Selenium/WebDriver re-implementation for Testcontainers Java
 
+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 ``mkv`` 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
+* Improved 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
+
+## Usage
+Usage is very similar to [Testcontainers default implementation](https://java.testcontainers.org/modules/webdriver_containers/).
+
+Make sure to remove the original Testcontainer Webdrivers dependency to avert any mix ups while using the library.
+For more information take a look at [our demo](./testcontainers-selenium-demo/src/main/java/software/xdev/Application.java).
+
+### Why are videos recorded as `.mkv` and how can I open them?
+
+In version 2 `.mp4` was replaced with `.mkv` as the default video container format.<br/>
+This was done because `.mp4` requires finalization as otherwise the file/container will be consider corrupt. `.mkv` has no such problems.
+
+[Most video players](https://en.wikipedia.org/wiki/Matroska#Support) (including browsers) can play `.mkv` files out of the box.
 
 ## Installation
-[Installation guide for the latest release](https://github.com/xdev-software/template-placeholder/releases/latest#Installation)
+[Installation guide for the latest release](https://github.com/xdev-software/testcontainers-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).
@@ -14,4 +42,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/template-placeholder/dependencies)
+View the [license of the current project](LICENSE) or the [summary including all dependencies](https://xdev-software.github.io/testcontainers-selenium/dependencies)
+
+<sub>Disclaimer: This is not an official Testcontainers/Selenium product and not associated</sub>

SECURITY.md

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