Docs + Cleanup

Author: AB-xdev

CHANGELOG.md

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

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

@@ -4,11 +4,25 @@
 
 # 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 on [some python code from 2010](https://www.unixuser.org/~euske/python/vnc2flv/index.html)
+    * 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 automatic Selenium version detection via classpath
 
 ## 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).
 

testcontainers-java-selenium/src/main/java/software/xdev/testcontainers/selenium/containers/browser/BrowserWebDriverContainer.java

@@ -48,6 +48,9 @@
 import software.xdev.testcontainers.selenium.containers.recorder.SeleniumRecordingContainer;
 
 
+/**
+ * A chrome/firefox/custom container based on SeleniumHQ's standalone container sets.
+ */
 @SuppressWarnings({"java:S119", "java:S2160"})
 public class BrowserWebDriverContainer<SELF extends BrowserWebDriverContainer<SELF>>
 	extends GenericContainer<SELF>
@@ -308,13 +311,13 @@ protected void validateImage()
 		// In this case try to look for alternative images
 		try
 		{
-			final Field imageField = GenericContainer.class.getDeclaredField("image");
-			imageField.setAccessible(true);
-			final RemoteDockerImage remoteDockerImage = (RemoteDockerImage)imageField.get(this);
+			final Field fImage = GenericContainer.class.getDeclaredField("image");
+			fImage.setAccessible(true);
+			final RemoteDockerImage remoteDockerImage = (RemoteDockerImage)fImage.get(this);
 
-			final Method getImageNameMethod = RemoteDockerImage.class.getDeclaredMethod("getImageName");
-			getImageNameMethod.setAccessible(true);
-			final DockerImageName currentImage = (DockerImageName)getImageNameMethod.invoke(remoteDockerImage);
+			final Method mGetImageName = RemoteDockerImage.class.getDeclaredMethod("getImageName");
+			mGetImageName.setAccessible(true);
+			final DockerImageName currentImage = (DockerImageName)mGetImageName.invoke(remoteDockerImage);
 
 			this.setDockerImageName(WORKING_BROWSER_IMAGES_TRANSLATION.computeIfAbsent(
 				currentImage,
@@ -494,8 +497,8 @@ public interface TestRecordingFileNameFactory
 	public static class DefaultTestRecordingFileNameFactory implements TestRecordingFileNameFactory
 	{
 		public static final DateTimeFormatter DTF = DateTimeFormatter.ofPattern("yyyyMMdd-HHmmss");
-		public static final String PASSED = "PASSED";
 
+		public static final String PASSED = "PASSED";
 		public static final String FAILED = "FAILED";
 
 		@Override