update example code to 4.17 (#1563)

titusfortner · diemol · web-flow · commit c9fbf270c2a5 · 2024-01-29T14:10:51.000-06:00
* update example code to 4.17

* Updating gemfile.lock

* Bumping CDP version in tests

* Bumping python

* Bumping to 4.17.2

* Running tests with Java 11

* Sorting them to avoid differences when comparing the files

* update docs to reflect example line changes

---------

Co-authored-by: Diego Molina &lt;diemol@gmail.com&gt;
diff --git a/.github/workflows/kotlin-examples.yml b/.github/workflows/kotlin-examples.yml
@@ -81,7 +81,7 @@ jobs:
       uses: actions/setup-java@v2
       with:
         distribution: 'temurin'
-        java-version: 8
+        java-version: 11
     - name: Run tests
       uses: nick-invision/retry@v2.8.3
       with:
diff --git a/examples/dotnet/SeleniumDocs/Bidirectional/ChromeDevtools/CdpApiTest.cs b/examples/dotnet/SeleniumDocs/Bidirectional/ChromeDevtools/CdpApiTest.cs
@@ -5,8 +5,8 @@
 using Microsoft.VisualStudio.TestTools.UnitTesting;
 using OpenQA.Selenium;
 using OpenQA.Selenium.DevTools;
-using OpenQA.Selenium.DevTools.V118.Network;
-using OpenQA.Selenium.DevTools.V118.Performance;
+using OpenQA.Selenium.DevTools.V121.Network;
+using OpenQA.Selenium.DevTools.V121.Performance;
 
 namespace SeleniumDocs.Bidirectional.ChromeDevtools
 {
@@ -16,15 +16,15 @@ public class CdpApiTest : BaseTest
         [TestInitialize]
         public void Startup()
         {
-            StartDriver("118");
+            StartDriver("121");
         }
 
         [TestMethod]
         public async Task SetCookie()
         {
             var session = ((IDevTools)driver).GetDevToolsSession();
-            var domains = session.GetVersionSpecificDomains<OpenQA.Selenium.DevTools.V118.DevToolsSessionDomains>();
-            await domains.Network.Enable(new OpenQA.Selenium.DevTools.V118.Network.EnableCommandSettings());
+            var domains = session.GetVersionSpecificDomains<OpenQA.Selenium.DevTools.V121.DevToolsSessionDomains>();
+            await domains.Network.Enable(new OpenQA.Selenium.DevTools.V121.Network.EnableCommandSettings());
 
             var cookieCommandSettings = new SetCookieCommandSettings
             {
@@ -47,8 +47,8 @@ public async Task PerformanceMetrics()
             driver.Url = "https://www.selenium.dev/selenium/web/frameset.html";
 
             var session = ((IDevTools)driver).GetDevToolsSession();
-            var domains = session.GetVersionSpecificDomains<OpenQA.Selenium.DevTools.V118.DevToolsSessionDomains>();
-            await domains.Performance.Enable(new OpenQA.Selenium.DevTools.V118.Performance.EnableCommandSettings());
+            var domains = session.GetVersionSpecificDomains<OpenQA.Selenium.DevTools.V121.DevToolsSessionDomains>();
+            await domains.Performance.Enable(new OpenQA.Selenium.DevTools.V121.Performance.EnableCommandSettings());
 
             var metricsResponse =
                 await session.SendCommand<GetMetricsCommandSettings, GetMetricsCommandResponse>(
@@ -68,8 +68,8 @@ await session.SendCommand<GetMetricsCommandSettings, GetMetricsCommandResponse>(
         public async Task BasicAuth()
         {
             var session = ((IDevTools)driver).GetDevToolsSession();
-            var domains = session.GetVersionSpecificDomains<OpenQA.Selenium.DevTools.V118.DevToolsSessionDomains>();
-            await domains.Network.Enable(new OpenQA.Selenium.DevTools.V118.Network.EnableCommandSettings());
+            var domains = session.GetVersionSpecificDomains<OpenQA.Selenium.DevTools.V121.DevToolsSessionDomains>();
+            await domains.Network.Enable(new OpenQA.Selenium.DevTools.V121.Network.EnableCommandSettings());
 
             var encodedAuth = Convert.ToBase64String(Encoding.Default.GetBytes("admin:admin"));
             var headerSettings = new SetExtraHTTPHeadersCommandSettings
diff --git a/examples/dotnet/SeleniumDocs/SeleniumDocs.csproj b/examples/dotnet/SeleniumDocs/SeleniumDocs.csproj
@@ -10,8 +10,8 @@
       <PackageReference Include="Microsoft.IdentityModel.Tokens" Version="6.23.1" />
       <PackageReference Include="MSTest.TestAdapter" Version="2.2.10" />
       <PackageReference Include="MSTest.TestFramework" Version="2.2.10" />
-      <PackageReference Include="Selenium.Support" Version="4.16.2" />
-      <PackageReference Include="Selenium.WebDriver" Version="4.16.2" />
+      <PackageReference Include="Selenium.Support" Version="4.17.0" />
+      <PackageReference Include="Selenium.WebDriver" Version="4.17.0" />
     </ItemGroup>
 
     <ItemGroup>
diff --git a/examples/java/build.gradle b/examples/java/build.gradle
@@ -10,7 +10,7 @@ repositories {
 }
 
 dependencies {
-    testImplementation 'org.seleniumhq.selenium:selenium-java:4.16.1'
+    testImplementation 'org.seleniumhq.selenium:selenium-java:4.17.0'
     testImplementation 'org.junit.jupiter:junit-jupiter-engine:5.10.0'
 }
 
diff --git a/examples/java/pom.xml b/examples/java/pom.xml
@@ -29,12 +29,12 @@
         <dependency>
             <groupId>org.seleniumhq.selenium</groupId>
             <artifactId>selenium-java</artifactId>
-            <version>4.16.1</version>
+            <version>4.17.0</version>
         </dependency>
         <dependency>
             <groupId>org.seleniumhq.selenium</groupId>
             <artifactId>selenium-grid</artifactId>
-            <version>4.16.1</version>
+            <version>4.17.0</version>
         </dependency>
         <dependency>
             <groupId>org.junit.jupiter</groupId>
diff --git a/examples/java/src/test/java/dev/selenium/bidirectional/chrome_devtools/CdpApiTest.java b/examples/java/src/test/java/dev/selenium/bidirectional/chrome_devtools/CdpApiTest.java
@@ -23,12 +23,12 @@
 import org.openqa.selenium.chrome.ChromeOptions;
 import org.openqa.selenium.devtools.DevTools;
 import org.openqa.selenium.devtools.HasDevTools;
-import org.openqa.selenium.devtools.v118.browser.Browser;
-import org.openqa.selenium.devtools.v118.network.Network;
-import org.openqa.selenium.devtools.v118.network.model.Headers;
-import org.openqa.selenium.devtools.v118.performance.Performance;
-import org.openqa.selenium.devtools.v118.performance.model.Metric;
-import org.openqa.selenium.devtools.v118.runtime.Runtime;
+import org.openqa.selenium.devtools.v121.browser.Browser;
+import org.openqa.selenium.devtools.v121.network.Network;
+import org.openqa.selenium.devtools.v121.network.model.Headers;
+import org.openqa.selenium.devtools.v121.performance.Performance;
+import org.openqa.selenium.devtools.v121.performance.model.Metric;
+import org.openqa.selenium.devtools.v121.runtime.Runtime;
 import org.openqa.selenium.support.ui.WebDriverWait;
 
 public class CdpApiTest extends BaseTest {
@@ -37,7 +37,7 @@ public class CdpApiTest extends BaseTest {
   @BeforeEach
   public void createSession() {
     ChromeOptions options = new ChromeOptions();
-    options.setBrowserVersion("118");
+    options.setBrowserVersion("121");
     driver = new ChromeDriver(options);
     wait = new WebDriverWait(driver, Duration.ofSeconds(10));
   }
diff --git a/examples/java/src/test/java/dev/selenium/drivers/RemoteWebDriverTest.java b/examples/java/src/test/java/dev/selenium/drivers/RemoteWebDriverTest.java
@@ -8,6 +8,7 @@
 import java.nio.file.Path;
 import java.time.Duration;
 import java.util.ArrayList;
+import java.util.Comparator;
 import java.util.List;
 import java.util.Map;
 import org.junit.jupiter.api.Assertions;
@@ -71,6 +72,10 @@ public void downloads() throws IOException {
 
     List<String> files = ((HasDownloads) driver).getDownloadableFiles();
 
+    // Sorting them to avoid differences when comparing the files
+    fileNames.sort(Comparator.naturalOrder());
+    files.sort(Comparator.naturalOrder());
+    
     Assertions.assertEquals(fileNames, files);
     String downloadableFile = files.get(0);
     Path targetDirectory = Files.createTempDirectory("download");
diff --git a/examples/javascript/package-lock.json b/examples/javascript/package-lock.json
diff --git a/examples/javascript/package.json b/examples/javascript/package.json
@@ -8,7 +8,7 @@
     "license": "Apache-2.0",
     "dependencies": {
         "assert": "^2.1.0",
-        "selenium-webdriver": "^4.16.0"
+        "selenium-webdriver": "^4.17.0"
     },
     "devDependencies": {
         "mocha": "^10.2.0"
diff --git a/examples/kotlin/pom.xml b/examples/kotlin/pom.xml
@@ -20,7 +20,7 @@
         <maven-surefire-plugin.version>3.2.2</maven-surefire-plugin.version>
 
         <java.version>1.8</java.version>
-        <selenium.version>4.16.0</selenium.version>
+        <selenium.version>4.17.0</selenium.version>
 
         <maven.compiler.target>${java.version}</maven.compiler.target>
         <maven.compiler.source>${java.version}</maven.compiler.source>
diff --git a/examples/python/requirements.txt b/examples/python/requirements.txt
@@ -1,4 +1,4 @@
-selenium==4.16.0
+selenium==4.17.2
 pytest
 trio
 pytest-trio
diff --git a/examples/python/tests/bidirectional/chrome_devtools/test_cdp_api.py b/examples/python/tests/bidirectional/chrome_devtools/test_cdp_api.py
@@ -2,7 +2,7 @@
 
 import pytest
 from selenium.webdriver.common.by import By
-from selenium.webdriver.common.devtools.v118.network import Headers
+from selenium.webdriver.common.devtools.v121.network import Headers
 
 
 @pytest.mark.trio
diff --git a/examples/ruby/Gemfile b/examples/ruby/Gemfile
@@ -12,8 +12,8 @@ gem 'selenium-devtools', '~> 0.119'
 if ENV['SE_NIGHTLY']
   source 'https://rubygems.pkg.github.com/seleniumhq' do
     selenium = 'selenium-webdriver'
-    gem selenium, '~> 4.17.0.nightly'
+    gem selenium, '~> 4.18.0.nightly'
   end
 else
-  gem 'selenium-webdriver', '= 4.16.0'
+  gem 'selenium-webdriver', '= 4.17.0'
 end
diff --git a/examples/ruby/Gemfile.lock b/examples/ruby/Gemfile.lock
@@ -2,18 +2,18 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    base64 (0.1.1)
+    base64 (0.2.0)
     diff-lcs (1.5.0)
-    json (2.6.3)
+    json (2.7.1)
     language_server-protocol (3.17.0.3)
-    parallel (1.23.0)
-    parser (3.2.2.3)
+    parallel (1.24.0)
+    parser (3.3.0.5)
       ast (~> 2.4.1)
       racc
-    racc (1.7.1)
+    racc (1.7.3)
     rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.8.1)
+    rake (13.1.0)
+    regexp_parser (2.9.0)
     rexml (3.2.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
@@ -28,37 +28,37 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.1)
-    rubocop (1.56.3)
-      base64 (~> 0.1.1)
+    rubocop (1.60.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.2.3)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.1, < 2.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.29.0)
+    rubocop-ast (1.30.0)
       parser (>= 3.2.1.0)
-    rubocop-capybara (2.19.0)
+    rubocop-capybara (2.20.0)
       rubocop (~> 1.41)
-    rubocop-factory_bot (2.24.0)
-      rubocop (~> 1.33)
-    rubocop-rspec (2.24.1)
-      rubocop (~> 1.33)
+    rubocop-factory_bot (2.25.1)
+      rubocop (~> 1.41)
+    rubocop-rspec (2.26.1)
+      rubocop (~> 1.40)
       rubocop-capybara (~> 2.17)
       rubocop-factory_bot (~> 2.22)
     ruby-progressbar (1.13.0)
     rubyzip (2.3.2)
-    selenium-devtools (0.119.0)
+    selenium-devtools (0.121.0)
       selenium-webdriver (~> 4.2)
-    selenium-webdriver (4.16.0)
+    selenium-webdriver (4.17.0)
+      base64 (~> 0.2)
       rexml (~> 3.2, >= 3.2.5)
       rubyzip (>= 1.2.2, < 3.0)
       websocket (~> 1.0)
-    unicode-display_width (2.4.2)
+    unicode-display_width (2.5.0)
     websocket (1.2.10)
 
 PLATFORMS
@@ -74,7 +74,7 @@ DEPENDENCIES
   rubocop (~> 1.35)
   rubocop-rspec (~> 2.12)
   selenium-devtools (~> 0.119)
-  selenium-webdriver (= 4.16.0)
+  selenium-webdriver (= 4.17.0)
 
 BUNDLED WITH
-   2.3.11
+   2.5.4
diff --git a/website_and_docs/content/documentation/webdriver/drivers/remote_webdriver.en.md b/website_and_docs/content/documentation/webdriver/drivers/remote_webdriver.en.md
@@ -25,7 +25,7 @@ and an options instance are both required.
 
 {{< tabpane text=true >}}
 {{< tab header="Java" >}}
-{{< gh-codeblock path="examples/java/src/test/java/dev/selenium/drivers/RemoteWebDriverTest.java#L37-L38" >}}
+{{< gh-codeblock path="examples/java/src/test/java/dev/selenium/drivers/RemoteWebDriverTest.java#L38-L39" >}}
 {{< /tab >}}
 {{% tab header="Python" %}}
 {{< gh-codeblock path="examples/python/tests/drivers/test_remote_webdriver.py#L10-L11" >}}
@@ -58,7 +58,7 @@ for a custom file detector.
 {{< tabpane text=true >}}
 {{< tab header="Java" >}}
 Java does not include a Local File Detector by default, so you must always add one to do uploads.
-{{< gh-codeblock path="examples/java/src/test/java/dev/selenium/drivers/RemoteWebDriverTest.java#L48-L51" >}}
+{{< gh-codeblock path="examples/java/src/test/java/dev/selenium/drivers/RemoteWebDriverTest.java#L49-L52" >}}
 {{< /tab >}}
 {{% tab header="Python" %}}
 Python adds a local file detector to remote webdriver instances by default, but you can also create your own class.
@@ -102,7 +102,7 @@ Each of the bindings have a method in the options class to set this.
 
 {{< tabpane text=true >}}
 {{< tab header="Java" >}}
-{{< gh-codeblock path="examples/java/src/test/java/dev/selenium/drivers/RemoteWebDriverTest.java#L59-L61" >}}
+{{< gh-codeblock path="examples/java/src/test/java/dev/selenium/drivers/RemoteWebDriverTest.java#L60-L62" >}}
 {{< /tab >}}
 {{% tab header="Python" %}}
 {{< gh-codeblock path="examples/python/tests/drivers/test_remote_webdriver.py#L37-L39" >}}
@@ -128,7 +128,7 @@ so the list is an immediate snapshot of what file names are currently in the dir
 
 {{< tabpane text=true >}}
 {{< tab header="Java" >}}
-{{< gh-codeblock path="examples/java/src/test/java/dev/selenium/drivers/RemoteWebDriverTest.java#L72" >}}
+{{< gh-codeblock path="examples/java/src/test/java/dev/selenium/drivers/RemoteWebDriverTest.java#L73" >}}
 {{< /tab >}}
 {{% tab header="Python" %}}
 {{< gh-codeblock path="examples/python/tests/drivers/test_remote_webdriver.py#L47" >}}
@@ -153,7 +153,7 @@ Selenium looks for the name of the provided file in the list and downloads it to
 
 {{< tabpane text=true >}}
 {{< tab header="Java" >}}
-{{< gh-codeblock path="examples/java/src/test/java/dev/selenium/drivers/RemoteWebDriverTest.java#L79" >}}
+{{< gh-codeblock path="examples/java/src/test/java/dev/selenium/drivers/RemoteWebDriverTest.java#L83" >}}
 {{< /tab >}}
 {{% tab header="Python" %}}
 {{< gh-codeblock path="examples/python/tests/drivers/test_remote_webdriver.py#L53" >}}
@@ -179,7 +179,7 @@ but you can also delete all files during the session.
 
 {{< tabpane text=true >}}
 {{< tab header="Java" >}}
-{{< gh-codeblock path="examples/java/src/test/java/dev/selenium/drivers/RemoteWebDriverTest.java#L83" >}}
+{{< gh-codeblock path="examples/java/src/test/java/dev/selenium/drivers/RemoteWebDriverTest.java#L88" >}}
 {{< /tab >}}
 {{% tab header="Python" %}}
 {{< gh-codeblock path="examples/python/tests/drivers/test_remote_webdriver.py#L59" >}}
@@ -208,12 +208,12 @@ Each of the Selenium bindings has implemented a different way to use those featu
 {{% tab header="Java" %}}
 Java requires you to use the Augmenter class, which allows it to automatically pull in implementations for
 all interfaces that match the capabilities used with the RemoteWebDriver
-{{< gh-codeblock path="examples/java/src/test/java/dev/selenium/drivers/RemoteWebDriverTest.java#L93" >}}
+{{< gh-codeblock path="examples/java/src/test/java/dev/selenium/drivers/RemoteWebDriverTest.java#L98" >}}
 
 Of interest, using the `RemoteWebDriverBuilder` automatically augments the driver, so it is a great way
 to get all the functionality by default:
 
-{{< gh-codeblock path="examples/java/src/test/java/dev/selenium/drivers/RemoteWebDriverTest.java#L100-L106" >}}
+{{< gh-codeblock path="examples/java/src/test/java/dev/selenium/drivers/RemoteWebDriverTest.java#L106-L111" >}}
 {{% /tab %}}
 {{% tab header="Python" %}}
 {{< badge-implementation >}}
diff --git a/website_and_docs/content/documentation/webdriver/drivers/remote_webdriver.ja.md b/website_and_docs/content/documentation/webdriver/drivers/remote_webdriver.ja.md
diff --git a/website_and_docs/content/documentation/webdriver/drivers/remote_webdriver.pt-br.md b/website_and_docs/content/documentation/webdriver/drivers/remote_webdriver.pt-br.md
diff --git a/website_and_docs/content/documentation/webdriver/drivers/remote_webdriver.zh-cn.md b/website_and_docs/content/documentation/webdriver/drivers/remote_webdriver.zh-cn.md

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ repositories {`
`10`	`10`	`}`
`11`	`11`
`12`	`12`	`dependencies {`
`13`		`- testImplementation 'org.seleniumhq.selenium:selenium-java:4.16.1'`
	`13`	`+ testImplementation 'org.seleniumhq.selenium:selenium-java:4.17.0'`
`14`	`14`	`testImplementation 'org.junit.jupiter:junit-jupiter-engine:5.10.0'`
`15`	`15`	`}`
`16`	`16`