Changes to Selenium/WebDriver module for ongoing compatibility #4609

rnorth · 2021-10-29T16:37:03Z

Co-authored with @kiview and @GannaChernyshova, this PR started out with some minor (hacky) workarounds but evolved into a rethink of what features are sensible for us to keep on trying to make work given:

existence of Selenium 4.0.0, with some breaking API changes
some mutable tags being used for Selenium Docker images, and the (IMHO correct) recommendations by the Selenium team that more exactly pinnable tags should be used in our use case.

Very WIP - all of this could change. It may be that we're being too opinionated in deprecation of some of our more opinionated features..!

Primary changes:

Selenium 4.0.0 compatibility fixes
- Remove in-code workaround for Chrome GPU issue, which created coupling to a Selenium 3.x API
- Remove support for Selenium 2.x, as supporting 3 major versions of the library becomes infeasible
- Use non-debug docker images automatically for Selenium 4.x, as -debug images are not required (and apparently not available for Firefox)
Remove provided scope dependencies, since we already require some Selenium JARs to be on the classpath. Gradle implementation scope is used despite Selenium classes being in our API - this is a slight and deliberate abuse, but seems better than us potentially forcing an upgrade of Selenium by updating our dependency version.
Steps to phase out implicit docker image detection and to remove API methods that are coupled to Selenium classes
- Deprecate constructors that do not supply a user-pinnable Docker image
- Deprecate constructors/methods that involve Capabilities and RemoteWebDriver
- Suggest alternative approaches for obtaining a WebDriver instance, predicated on future removal of APIs that are coupled to Selenium classes
- Have not deprecated the determineClasspathSeleniumVersion convenience method that can be used to identify Selenium version on the classpath, as this may be something that users want to use
Steps to follow up on in future PR
- TODO: plenty of docs, examples and migration notes
- TODO: specific documentation around best-practices for selecting a pinnable Selenium image
- TODO: phase out implicit use of Chrome

@kiview

…bility Co-authored with @kiview, this PR started out with some minor (hacky) workarounds but evolved into a rethink of what features are sensible for us to keep on trying to make work given: * existence of Selenium 4.0.0, with some breaking API changes * some mutable tags being used for Selenium Docker images, and the (IMHO correct) recommendations by the Selenium team that more exactly pinnable tags should be used in our use case. Very WIP - all of this could change. Primary changes: - Selenium 4.0.0 compatibility fixes - Remove in-code workaround for Chrome GPU issue, which created coupling to a Selenium 3.x API - Remove support for Selenium 2.x, as supporting 3 major versions of the library becomes infeasible - Use non-debug docker images automatically for Selenium 4.x, as `-debug` images are not required (and apparently not available for Firefox) - Remove `provided` scope dependencies, since we already require some Selenium JARs to be on the classpath. Gradle `implementation` scope is used despite Selenium classes being in our API - this is a slight and deliberate abuse, but seems better than us potentially forcing an upgrade of Selenium by updating our dependency version. - TODO: update docs - TODO: further testing of the assumption that this will not have real impacts to users. - Steps to phase out implicit docker image detection and to remove API methods that are coupled to Selenium classes - Deprecate constructors that do not supply a user-pinnable Docker image - Deprecate constructors/methods that involve Capabilities and RemoteWebDriver - Suggest alternative approaches for obtaining a WebDriver instance, predicated on future removal of APIs that are coupled to Selenium classes - Have *not* deprecated the `determineClasspathSeleniumVersion` convenience method that can be used to identify Selenium version on the classpath, as this may be something that users want to use - TODO: plenty of docs, examples and migration notes - TODO: specific documentation around best-practices for selecting a pinnable Selenium image - TODO: phase out implicit use of Chrome

kiview · 2021-12-20T11:46:14Z

Will fix #4593.

Co-authored-by: Anna Chernyshova <anna@atomicjar.com>

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

orange-buffalo

As for the library user, merge request looks good to me. I've tested this branch snapshot on my project. Backwards compatibility is preserved - just upgrading the version works smoothly with Selenium 4.x. After resolving the deprecation warnings everything continues to work.

rnorth · 2022-01-04T09:30:20Z

Thank you @orange-buffalo - we really appreciate you taking the time to try this out and give us feedback.

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

bsideup · 2022-01-05T18:07:06Z

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

+    /**
+     * @deprecated please use {@link BrowserWebDriverContainer#BrowserWebDriverContainer(DockerImageName)}
+     */
+    @Deprecated


note that, if we deprecate this, there are no constructors that would not set recordingMode = SKIP by default.

Isn't this even in line with our current docs?
https://www.testcontainers.org/modules/webdriver_containers/#recording-videos

By default, no videos will be recorded. However, you can instruct Testcontainers to capture videos for all tests or just for failing tests.

the method signature of `ChromeOptions#addArguments` has changed: testcontainers/testcontainers-java#4593 (comment) until testcontainers/testcontainers-java#4609 is merged and released, testcontainers artifacts should be installed from jitpack instead of maven so that changes in this open pull request are included.

rnorth · 2022-01-12T13:51:44Z

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

+
+        if (browserName.equals("chrome")) {
+            if (supportsVncWithoutDebugImage) {
+                return CHROME_IMAGE;


Surely .withTag(...) is missing?

kiview · 2022-01-13T10:13:33Z

With #4914 being merged, this PR acts mostly as a reference for future refactorings and planned deprecations.

kiview mentioned this pull request Dec 13, 2021

Use non debug images if selenium version is 4.x #4686

Closed

kiview and others added 8 commits December 20, 2021 13:19

Remove deprecated API usage from examples.

780b97c

Fix deprecated API usage in Cucumber examples.

e1dd7cb

Co-authored-by: Anna Chernyshova <anna@atomicjar.com>

Start updating the Selenium docs

e6d50d8

Co-authored-by: Anna Chernyshova <anna@atomicjar.com>

Remove deprecated API usage from docs

cbd9426

Co-authored-by: Anna Chernyshova <anna@atomicjar.com>

Merge branch 'master' into selenium-refactoring

3588e21

Update selenium dep in junit4 examples

636e814

Co-authored-by: Anna Chernyshova <anna@atomicjar.com>

Update selenium dep in cucumber examples

5238738

Co-authored-by: Anna Chernyshova <anna@atomicjar.com>

Add deprecation annotation to withCapabilities

aeb092f

Co-authored-by: Anna Chernyshova <anna@atomicjar.com>

kiview marked this pull request as ready for review December 20, 2021 13:54

kiview requested review from bsideup and kiview as code owners December 20, 2021 13:54

kiview changed the title ~~WIP Proposed changes to Selenium/WebDriver module for ongoing compatibility~~ Changes to Selenium/WebDriver module for ongoing compatibility Dec 20, 2021

kiview added modules/selenium type/deprecation Public APIs are being deprecated but not changed yet type/housekeeping labels Dec 20, 2021

Further cleanup

c9049ae

lanwen reviewed Dec 28, 2021

View reviewed changes

modules/selenium/src/main/java/org/testcontainers/containers/BrowserWebDriverContainer.java Show resolved Hide resolved

orange-buffalo previously approved these changes Jan 3, 2022

View reviewed changes

orange-buffalo mentioned this pull request Jan 3, 2022

1.16.1 fails for Selenium 4.0.0 and Chrome browser #4593

Closed

Update deprecation notice in Javadoc for withCapabilities

ef46d9a

bsideup reviewed Jan 4, 2022

View reviewed changes

modules/selenium/src/main/java/org/testcontainers/containers/BrowserWebDriverContainer.java Outdated Show resolved Hide resolved

kiview and others added 2 commits January 4, 2022 16:29

Use ComparableVersion for checking Selenium version

3175141

Merge branch 'master' into selenium-refactoring

706259d

rnorth added this to the next milestone Jan 5, 2022

bsideup reviewed Jan 5, 2022

View reviewed changes

GannaChernyshova added a commit that referenced this pull request Jan 6, 2022

Option to fix #4593 in the context of #4609

4fcc24e

GannaChernyshova mentioned this pull request Jan 12, 2022

Update BrowserWebDriverContainer to add Selenium 4 support, drop Selenium 2 support #4914

Merged

rnorth commented Jan 12, 2022

View reviewed changes

bsideup modified the milestones: 1.16.3, next Jan 18, 2022

kiview removed this from the next milestone Apr 6, 2022

eddumelendez dismissed orange-buffalo’s stale review via 706259d October 29, 2022 16:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Changes to Selenium/WebDriver module for ongoing compatibility #4609

Changes to Selenium/WebDriver module for ongoing compatibility #4609

rnorth commented Oct 29, 2021 •

edited

kiview commented Dec 20, 2021

orange-buffalo left a comment •

edited

rnorth commented Jan 4, 2022

bsideup Jan 5, 2022

kiview Jan 6, 2022

rnorth Jan 12, 2022

kiview commented Jan 13, 2022

Changes to Selenium/WebDriver module for ongoing compatibility #4609

Are you sure you want to change the base?

Changes to Selenium/WebDriver module for ongoing compatibility #4609

Conversation

rnorth commented Oct 29, 2021 • edited

kiview commented Dec 20, 2021

orange-buffalo left a comment • edited

Choose a reason for hiding this comment

rnorth commented Jan 4, 2022

bsideup Jan 5, 2022

Choose a reason for hiding this comment

kiview Jan 6, 2022

Choose a reason for hiding this comment

rnorth Jan 12, 2022

Choose a reason for hiding this comment

kiview commented Jan 13, 2022

rnorth commented Oct 29, 2021 •

edited

orange-buffalo left a comment •

edited