Improve selenium module (#6204)

* Remove usage of `org.openqa.selenium.remote.BrowserType`, it was
removed in 4.x
* Upgrade to selenium 4.6.0
* Deprecate getWebDriver()

Co-authored-by: Kevin Wittek <[email protected]>

Author: eddumelendez

docs/examples/junit4/generic/build.gradle

@@ -7,6 +7,6 @@ dependencies {
     testImplementation project(":mysql")
 
     testImplementation 'mysql:mysql-connector-java:8.0.31'
-    testImplementation "org.seleniumhq.selenium:selenium-api:3.141.59"
+    testImplementation "org.seleniumhq.selenium:selenium-api:4.6.0"
     testImplementation 'org.assertj:assertj-core:3.15.0'
 }

docs/examples/junit4/generic/src/test/java/generic/HostPortExposedTest.java

@@ -50,14 +50,15 @@ public static void tearDown() throws Exception {
     }
 
     @Rule
-    public BrowserWebDriverContainer browser = new BrowserWebDriverContainer().withCapabilities(new ChromeOptions());
+    public BrowserWebDriverContainer<?> browser = new BrowserWebDriverContainer<>()
+        .withCapabilities(new ChromeOptions());
 
     @Test
     public void testContainerRunningAgainstExposedHostPort() {
         // useHostExposedPort {
         final String rootUrl = String.format("http://host.testcontainers.internal:%d/", localServerPort);
 
-        final RemoteWebDriver webDriver = browser.getWebDriver();
+        final RemoteWebDriver webDriver = new RemoteWebDriver(this.browser.getSeleniumAddress(), new ChromeOptions());
         webDriver.get(rootUrl);
         // }
 

examples/cucumber/src/test/java/org/testcontainers/examples/Stepdefs.java

@@ -6,6 +6,7 @@
 import io.cucumber.java.en.Given;
 import io.cucumber.java.en.Then;
 import io.cucumber.java.en.When;
+import org.openqa.selenium.By;
 import org.openqa.selenium.WebElement;
 import org.openqa.selenium.chrome.ChromeOptions;
 import org.openqa.selenium.remote.RemoteWebDriver;
@@ -59,9 +60,9 @@ public void locationIs(String location) throws Exception {
 
     @When("^I ask is it possible to search here$")
     public void iAskIsItPossibleToSearchHere() throws Exception {
-        RemoteWebDriver driver = container.getWebDriver();
+        RemoteWebDriver driver = new RemoteWebDriver(container.getSeleniumAddress(), new ChromeOptions());
         driver.get(location);
-        List<WebElement> searchInputs = driver.findElementsByTagName("input");
+        List<WebElement> searchInputs = driver.findElements(By.tagName("input"));
         answer = searchInputs != null && searchInputs.size() > 0 ? "YES" : "NOPE";
     }
 

examples/selenium-container/src/test/java/SeleniumContainerTest.java

@@ -20,6 +20,7 @@
 
 import java.io.File;
 import java.util.List;
+import java.util.concurrent.TimeUnit;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
@@ -41,7 +42,8 @@ public class SeleniumContainerTest {
 
     @Test
     public void simplePlainSeleniumTest() {
-        RemoteWebDriver driver = chrome.getWebDriver();
+        RemoteWebDriver driver = new RemoteWebDriver(chrome.getSeleniumAddress(), new ChromeOptions());
+        driver.manage().timeouts().implicitlyWait(30, TimeUnit.SECONDS);
 
         driver.get("http://host.testcontainers.internal:" + port + "/foo.html");
         List<WebElement> hElement = driver.findElements(By.tagName("h"));

modules/selenium/build.gradle

@@ -3,10 +3,10 @@ description = "Testcontainers :: Selenium"
 dependencies {
     api project(':testcontainers')
 
-    provided 'org.seleniumhq.selenium:selenium-remote-driver:3.141.59'
-    provided 'org.seleniumhq.selenium:selenium-chrome-driver:3.141.59'
-    testImplementation 'org.seleniumhq.selenium:selenium-firefox-driver:3.141.59'
-    testImplementation 'org.seleniumhq.selenium:selenium-support:3.141.59'
+    provided 'org.seleniumhq.selenium:selenium-remote-driver:4.6.0'
+    provided 'org.seleniumhq.selenium:selenium-chrome-driver:4.6.0'
+    testImplementation 'org.seleniumhq.selenium:selenium-firefox-driver:4.6.0'
+    testImplementation 'org.seleniumhq.selenium:selenium-support:4.6.0'
 
     testImplementation 'org.mortbay.jetty:jetty:6.1.26'
     testImplementation project(':nginx')

modules/selenium/src/main/java/org/testcontainers/containers/BrowserWebDriverContainer.java

@@ -11,7 +11,6 @@
 import org.jetbrains.annotations.Nullable;
 import org.openqa.selenium.Capabilities;
 import org.openqa.selenium.chrome.ChromeOptions;
-import org.openqa.selenium.remote.BrowserType;
 import org.openqa.selenium.remote.DesiredCapabilities;
 import org.openqa.selenium.remote.RemoteWebDriver;
 import org.rnorth.ducttape.timeouts.Timeouts;
@@ -312,7 +311,9 @@ protected void containerIsStarted(InspectContainerResponse containerInfo) {
      * class (if used as a @ClassRule)
      *
      * @return a new Remote Web Driver instance
+     * @deprecated use {@link #getSeleniumAddress()} instead
      */
+    @Deprecated
     public synchronized RemoteWebDriver getWebDriver() {
         if (driver == null) {
             if (capabilities == null) {
@@ -437,4 +438,11 @@ public enum VncRecordingMode {
         RECORD_ALL,
         RECORD_FAILING,
     }
+
+    private static class BrowserType {
+
+        private static final String CHROME = "chrome";
+
+        private static final String FIREFOX = "firefox";
+    }
 }

modules/selenium/src/test/java/org/testcontainers/junit/BaseWebDriverContainerTest.java

@@ -2,7 +2,10 @@
 
 import org.junit.ClassRule;
 import org.openqa.selenium.By;
+import org.openqa.selenium.Capabilities;
 import org.openqa.selenium.WebElement;
+import org.openqa.selenium.chrome.ChromeOptions;
+import org.openqa.selenium.firefox.FirefoxOptions;
 import org.openqa.selenium.remote.RemoteWebDriver;
 import org.testcontainers.containers.BrowserWebDriverContainer;
 import org.testcontainers.containers.GenericContainer;
@@ -31,8 +34,9 @@ public class BaseWebDriverContainerTest {
         .withExposedPorts(8080, 8081)
         .waitingFor(new HttpWaitStrategy());
 
-    protected static void doSimpleExplore(BrowserWebDriverContainer<?> rule) {
-        RemoteWebDriver driver = setupDriverFromRule(rule);
+    protected static void doSimpleExplore(BrowserWebDriverContainer<?> rule, Capabilities capabilities) {
+        RemoteWebDriver driver = new RemoteWebDriver(rule.getSeleniumAddress(), capabilities);
+        driver.manage().timeouts().implicitlyWait(30, TimeUnit.SECONDS);
         System.out.println("Selenium remote URL is: " + rule.getSeleniumAddress());
         System.out.println("VNC URL is: " + rule.getVncAddress());
 
@@ -42,17 +46,15 @@ protected static void doSimpleExplore(BrowserWebDriverContainer<?> rule) {
         assertThat(title.getText().trim())
             .as("the index page contains the title 'Hello world'")
             .isEqualTo("Hello world");
+        driver.quit();
     }
 
     protected void assertBrowserNameIs(BrowserWebDriverContainer<?> rule, String expectedName) {
-        RemoteWebDriver driver = setupDriverFromRule(rule);
+        Capabilities capabilities = ("chrome".equals(expectedName)) ? new ChromeOptions() : new FirefoxOptions();
+        RemoteWebDriver driver = new RemoteWebDriver(rule.getSeleniumAddress(), capabilities);
+        driver.manage().timeouts().implicitlyWait(30, TimeUnit.SECONDS);
         String actual = driver.getCapabilities().getBrowserName();
         assertThat(actual).as(String.format("actual browser name is %s", actual)).isEqualTo(expectedName);
-    }
-
-    private static RemoteWebDriver setupDriverFromRule(BrowserWebDriverContainer<?> rule) {
-        RemoteWebDriver driver = rule.getWebDriver();
-        driver.manage().timeouts().implicitlyWait(30, TimeUnit.SECONDS);
-        return driver;
+        driver.quit();
     }
 }

modules/selenium/src/test/java/org/testcontainers/junit/ChromeRecordingWebDriverContainerTest.java

@@ -64,7 +64,7 @@ private File[] runSimpleExploreInContainer(BrowserWebDriverContainer<?> containe
             container.start();
 
             TimeUnit.MILLISECONDS.sleep(MINIMUM_VIDEO_DURATION_MILLISECONDS);
-            doSimpleExplore(container);
+            doSimpleExplore(container, new ChromeOptions());
             container.afterTest(
                 new TestDescription() {
                     @Override
@@ -178,7 +178,7 @@ public void recordingTestThatShouldBeRecordedButNotPersisted() {
             ) {
                 chrome.start();
 
-                doSimpleExplore(chrome);
+                doSimpleExplore(chrome, new ChromeOptions());
             }
         }
 
@@ -198,7 +198,7 @@ public void recordingTestThatShouldBeRecordedAndRetained() throws InterruptedExc
                 chrome.start();
 
                 TimeUnit.MILLISECONDS.sleep(MINIMUM_VIDEO_DURATION_MILLISECONDS);
-                doSimpleExplore(chrome);
+                doSimpleExplore(chrome, new ChromeOptions());
                 chrome.afterTest(
                     new TestDescription() {
                         @Override

modules/selenium/src/test/java/org/testcontainers/junit/ChromeWebDriverContainerTest.java

@@ -25,6 +25,6 @@ public void checkBrowserIsIndeedChrome() {
 
     @Test
     public void simpleExploreTest() {
-        doSimpleExplore(chrome);
+        doSimpleExplore(chrome, new ChromeOptions());
     }
 }

modules/selenium/src/test/java/org/testcontainers/junit/ContainerWithoutCapabilitiesTest.java

@@ -2,6 +2,7 @@
 
 import org.junit.Rule;
 import org.junit.Test;
+import org.openqa.selenium.chrome.ChromeOptions;
 import org.testcontainers.containers.BrowserWebDriverContainer;
 
 public class ContainerWithoutCapabilitiesTest extends BaseWebDriverContainerTest {
@@ -16,6 +17,6 @@ public void chromeIsStartedIfNoCapabilitiesProvided() {
 
     @Test
     public void simpleExploreTestWhenNoCapabilitiesProvided() {
-        doSimpleExplore(chrome);
+        doSimpleExplore(chrome, new ChromeOptions());
     }
 }