[rb] improve selenium manager testing

.github/workflows/ci-ruby.yml

@@ -4,6 +4,9 @@ on:
   workflow_call:
   workflow_dispatch:
 
+permissions:
+  contents: read
+
 jobs:
   build:
     name: Build
@@ -55,26 +58,23 @@ jobs:
         //rb/spec/...
 
   integration-tests-local:
-    name: Local Tests
+    name: Integration Tests
     needs: build
     uses: ./.github/workflows/bazel.yml
     strategy:
       fail-fast: false
       matrix:
-        browser:
-          - chrome
-          - edge
-          - firefox
-        os:
-          - windows
-          - macos
-        exclude:
-          - browser: edge
+        browser: ['chrome', 'edge', 'firefox']
+        os: ['windows']
+        include:
+          - browser: edge-remote
             os: macos
+            java-version: 17
     with:
-      name: Local Tests (${{ matrix.browser }}, ${{ matrix.os }})
+      name: Integration (${{ matrix.browser }}, ${{ matrix.os }})
       browser: ${{ matrix.browser }}
       cache-key: rb-${{ matrix.browser }}-${{ matrix.os }}-test
+      java-version: ${{ matrix.java-version }}
       os: ${{ matrix.os }}
       run: >
         bazel test
@@ -86,28 +86,30 @@ jobs:
         --test_tag_filters ${{ matrix.browser }}
         //rb/spec/...
 
-  integration-tests-remote:
-    name: Remote Tests
+  selenium-manager-tests:
+    name: Selenium Manager Tests
     needs: build
     uses: ./.github/workflows/bazel.yml
     strategy:
       fail-fast: false
       matrix:
-        include:
-          - browser: edge
-            os: macos
+        os:
+          - windows
+          - macos
+          - ubuntu
     with:
-      name: Remote Tests (${{ matrix.browser }}, ${{ matrix.os }})
-      browser: ${{ matrix.browser }}
-      cache-key: rb-remote-${{ matrix.browser }}-${{ matrix.os }}-test
+      name: Manager Tests (${{ matrix.os }})
+      cache-key: rb-manager-${{ matrix.os }}-test
       os: ${{ matrix.os }}
-      java-version: 17
       run: >
         bazel test
         --keep_going
         --build_tests_only
         --flaky_test_attempts 3
         --local_test_jobs 1
-        --test_size_filters large
-        --test_tag_filters ${{ matrix.browser }}-remote
+        --test_size_filters medium
+        --pin_browsers=false
+        --test_tag_filters="manager,-safari,-ie"
+        --test_env=SE_FORCE_BROWSER_DOWNLOAD=true
+        --test_env=SE_SKIP_DRIVER_IN_PATH=true
         //rb/spec/...

.skipped-tests

@@ -23,14 +23,6 @@
 -//javascript/selenium-webdriver:test-builder-test.js-chrome
 -//javascript/selenium-webdriver:test-chrome-devtools-test.js-chrome
 -//javascript/selenium-webdriver:test-firefox-options-test.js-firefox
--//rb/spec/integration/selenium/webdriver/chrome:service-chrome
--//rb/spec/integration/selenium/webdriver/chrome:service-chrome-remote
--//rb/spec/integration/selenium/webdriver/edge:service-edge
--//rb/spec/integration/selenium/webdriver/edge:service-edge-remote
--//rb/spec/integration/selenium/webdriver/firefox:service-firefox
--//rb/spec/integration/selenium/webdriver/firefox:service-firefox-beta
--//rb/spec/integration/selenium/webdriver/firefox:service-firefox-beta-remote
--//rb/spec/integration/selenium/webdriver/firefox:service-firefox-remote
 -//rb/spec/integration/selenium/webdriver/remote:driver-chrome-remote
 -//rb/spec/integration/selenium/webdriver/remote:driver-edge-remote
 -//rb/spec/integration/selenium/webdriver/remote:driver-firefox-beta-remote

rb/lib/selenium/webdriver/common/platform.rb

@@ -17,6 +17,7 @@
 # specific language governing permissions and limitations
 # under the License.
 
+require 'pathname'
 require 'rbconfig'
 require 'socket'
 
@@ -119,13 +120,20 @@ def cygwin_path(path, only_cygwin: false, **opts)
       end
 
       def unix_path(path)
-        path.tr(File::ALT_SEPARATOR, File::SEPARATOR)
+        File::ALT_SEPARATOR.nil? ? path : path.tr(File::ALT_SEPARATOR, File::SEPARATOR)
       end
 
       def windows_path(path)
         path.tr(File::SEPARATOR, File::ALT_SEPARATOR)
       end
 
+      def includes_path?(path, root)
+        path_name = unix_path(path)
+        root_name = unix_path(root)
+        WebDriver.logger.debug("Checking if #{path_name} includes #{root_name}", id: :platform)
+        unix_path(path).include?("/#{unix_path(root)}/")
+      end
+
       def make_writable(file)
         File.chmod 0o766, file
       end

rb/sig/lib/selenium/webdriver/common/options.rbs

@@ -33,7 +33,7 @@ module Selenium
 
       attr_accessor options: Hash[String | Symbol, String | Numeric | bool?]
 
-      def initialize: (Hash[String | Symbol, String | Numeric | bool] opts) -> void
+      def initialize: ?(Hash[String | Symbol, String | Numeric | bool] opts) -> void
 
       def add_option: (String | Symbol name, String | Numeric | bool? value) -> (String | Numeric | bool)?
 

rb/sig/lib/selenium/webdriver/support/guards.rbs

@@ -20,7 +20,7 @@ module Selenium
 
         def initialize: (untyped example, ?bug_tracker: String, ?conditions: untyped?) -> void
 
-        def add_condition: (untyped name, ?untyped? condition) { () -> untyped } -> untyped
+        def add_condition: (untyped name, ?untyped? condition) ?{ () -> untyped } -> untyped
 
         def add_message: (untyped name, untyped message) -> untyped
 

rb/spec/integration/selenium/webdriver/chrome/BUILD.bazel

@@ -11,5 +11,18 @@ load("//rb/spec:tests.bzl", "rb_integration_test")
         ],
         data = ["//common/extensions"],
     )
-    for file in glob(["*_spec.rb"])
+    for file in glob(
+        ["*_spec.rb"],
+        exclude = ["service_spec.rb"],
+    )
 ]
+
+rb_integration_test(
+    name = "service",
+    srcs = ["service_spec.rb"],
+    browsers = [
+        "chrome",
+        "chrome-beta",
+    ],
+    tags = ["manager"],
+)

rb/spec/integration/selenium/webdriver/chrome/service_spec.rb

@@ -27,16 +27,22 @@ module Chrome
                 exclusive: [{bidi: false, reason: 'Not yet implemented with BiDi'}, {browser: :chrome}]} do
         let(:service) { described_class.new }
         let(:service_manager) { service.launch }
+        let(:cache_dir) { ENV['SE_CACHE'] || File.join('.cache', 'selenium') }
 
         after { service_manager.stop }
 
-        it 'auto uses chromedriver' do
-          service.executable_path = DriverFinder.new(Options.new, described_class.new).driver_path
+        it 'selenium manager gets browser and driver', exclusive: {manager: true} do
+          driver_finder = DriverFinder.new(Options.new, service)
+          driver_path = driver_finder.driver_path
+          browser_path = driver_finder.browser_path
 
-          expect(service_manager.uri).to be_a(URI)
-        end
+          expect { Platform.assert_executable(driver_path) }.not_to raise_error
+          expect { Platform.assert_executable(browser_path) }.not_to raise_error
+          expect(Platform.includes_path?(browser_path, cache_dir)).to be(true)
+          expect(Platform.includes_path?(driver_path, cache_dir)).to be(true)
+
+          service.executable_path = driver_path
 
-        it 'can be started outside driver' do
           expect(service_manager.uri).to be_a(URI)
         end
       end

rb/spec/integration/selenium/webdriver/edge/BUILD.bazel

@@ -6,5 +6,15 @@ load("//rb/spec:tests.bzl", "rb_integration_test")
         srcs = [file],
         browsers = ["edge"],  # No need to run in other browsers.
     )
-    for file in glob(["*_spec.rb"])
+    for file in glob(
+        ["*_spec.rb"],
+        exclude = ["service_spec.rb"],
+    )
 ]
+
+rb_integration_test(
+    name = "service",
+    srcs = ["service_spec.rb"],
+    browsers = ["edge"],
+    tags = ["manager"],
+)

rb/spec/integration/selenium/webdriver/edge/service_spec.rb

@@ -27,16 +27,22 @@ module Edge
                 exclusive: [{bidi: false, reason: 'Not yet implemented with BiDi'}, {browser: :edge}]} do
         let(:service) { described_class.new }
         let(:service_manager) { service.launch }
+        let(:cache_dir) { ENV['SE_CACHE'] || File.join('.cache', 'selenium') }
 
         after { service_manager.stop }
 
-        it 'auto uses edgedriver' do
-          service.executable_path = DriverFinder.new(Options.new, described_class.new).driver_path
+        it 'selenium manager gets browser and driver', exclusive: {manager: true} do
+          driver_finder = DriverFinder.new(Options.new, service)
+          driver_path = driver_finder.driver_path
+          browser_path = driver_finder.browser_path
 
-          expect(service_manager.uri).to be_a(URI)
-        end
+          expect { Platform.assert_executable(driver_path) }.not_to raise_error
+          expect { Platform.assert_executable(browser_path) }.not_to raise_error
+          expect(Platform.includes_path?(driver_path, cache_dir)).to be(true)
+          expect(Platform.includes_path?(browser_path, cache_dir)).to be(true)
+
+          service.executable_path = driver_path
 
-        it 'can be started outside driver' do
           expect(service_manager.uri).to be_a(URI)
         end
       end

rb/spec/integration/selenium/webdriver/firefox/BUILD.bazel

@@ -11,5 +11,18 @@ load("//rb/spec:tests.bzl", "rb_integration_test")
         ],
         data = ["//common/extensions"],
     )
-    for file in glob(["*_spec.rb"])
+    for file in glob(
+        ["*_spec.rb"],
+        exclude = ["service_spec.rb"],
+    )
 ]
+
+rb_integration_test(
+    name = "service",
+    srcs = ["service_spec.rb"],
+    browsers = [
+        "firefox",
+        "firefox-beta",
+    ],
+    tags = ["manager"],
+)

rb/spec/integration/selenium/webdriver/firefox/service_spec.rb

@@ -27,16 +27,22 @@ module Firefox
                 exclusive: [{bidi: false, reason: 'Not yet implemented with BiDi'}, {browser: :firefox}]} do
         let(:service) { described_class.new }
         let(:service_manager) { service.launch }
+        let(:cache_dir) { ENV['SE_CACHE'] || File.join('.cache', 'selenium') }
 
         after { service_manager.stop }
 
-        it 'auto uses geckodriver' do
-          service.executable_path = DriverFinder.new(Options.new, described_class.new).driver_path
+        it 'selenium manager gets browser and driver', exclusive: {manager: true} do
+          driver_finder = DriverFinder.new(Options.new, service)
+          driver_path = driver_finder.driver_path
+          browser_path = driver_finder.browser_path
 
-          expect(service_manager.uri).to be_a(URI)
-        end
+          expect { Platform.assert_executable(driver_path) }.not_to raise_error
+          expect { Platform.assert_executable(browser_path) }.not_to raise_error
+          expect(Platform.includes_path?(browser_path, cache_dir)).to be(true)
+          expect(Platform.includes_path?(driver_path, cache_dir)).to be(true)
+
+          service.executable_path = driver_path
 
-        it 'can be started outside driver' do
           expect(service_manager.uri).to be_a(URI)
         end
       end

rb/spec/integration/selenium/webdriver/ie/BUILD.bazel

@@ -0,0 +1,8 @@
+load("//rb/spec:tests.bzl", "rb_integration_test")
+
+rb_integration_test(
+    name = "service",
+    srcs = ["service_spec.rb"],
+    browsers = ["ie"],
+    tags = ["manager"],
+)

rb/spec/integration/selenium/webdriver/ie/service_spec.rb

@@ -27,16 +27,19 @@ module IE
                 exclusive: [{bidi: false, reason: 'Not yet implemented with BiDi'}, {browser: :ie}]} do
         let(:service) { described_class.new }
         let(:service_manager) { service.launch }
+        let(:cache_dir) { ENV['SE_CACHE'] || File.join('.cache', 'selenium') }
 
         after { service_manager.stop }
 
-        it 'auto uses iedriver' do
-          service.executable_path = DriverFinder.new(Options.new, described_class.new).driver_path
+        it 'selenium manager gets browser and driver', exclusive: {manager: true} do
+          driver_finder = DriverFinder.new(Options.new, service)
+          driver_path = driver_finder.driver_path
 
-          expect(service_manager.uri).to be_a(URI)
-        end
+          expect { Platform.assert_executable(driver_path) }.not_to raise_error
+          expect(Platform.includes_path?(driver_path, cache_dir)).to be(true)
+
+          service.executable_path = driver_path
 
-        it 'can be started outside driver' do
           expect(service_manager.uri).to be_a(URI)
         end
       end

rb/spec/integration/selenium/webdriver/safari/BUILD.bazel

@@ -10,5 +10,15 @@ load("//rb/spec:tests.bzl", "rb_integration_test")
             "safari-preview",
         ],
     )
-    for file in glob(["*_spec.rb"])
+    for file in glob(
+        ["*_spec.rb"],
+        exclude = ["service_spec.rb"],
+    )
 ]
+
+rb_integration_test(
+    name = "service",
+    srcs = ["service_spec.rb"],
+    browsers = ["safari"],
+    tags = ["manager"],
+)

rb/spec/integration/selenium/webdriver/safari/service_spec.rb

@@ -27,16 +27,20 @@ module Safari
                 exclusive: [{bidi: false, reason: 'Not yet implemented with BiDi'}, {browser: :safari}]} do
         let(:service) { described_class.new }
         let(:service_manager) { service.launch }
+        let(:cache_dir) { ENV['SE_CACHE'] || File.join('.cache', 'selenium') }
 
         after { service_manager.stop }
 
-        it 'auto uses safaridriver' do
-          service.executable_path = DriverFinder.new(Options.new, described_class.new).driver_path
+        it 'selenium manager gets browser and driver' do
+          driver_finder = DriverFinder.new(Options.new, service)
+          driver_path = driver_finder.driver_path
+          browser_path = driver_finder.browser_path
 
-          expect(service_manager.uri).to be_a(URI)
-        end
+          expect { Platform.assert_executable(driver_path) }.not_to raise_error
+          expect { Platform.assert_executable(browser_path) }.not_to raise_error
+
+          service.executable_path = driver_path
 
-        it 'can be started outside driver' do
           expect(service_manager.uri).to be_a(URI)
         end
       end

rb/spec/integration/selenium/webdriver/spec_helper.rb

@@ -73,6 +73,7 @@ def example_finished(notification)
     guards.add_condition(:bidi, !ENV['WEBDRIVER_BIDI'].nil?)
     guards.add_condition(:rbe, GlobalTestEnv.rbe?)
     guards.add_condition(:version, GlobalTestEnv.browser_version)
+    guards.add_condition(:manager, !ENV['SE_FORCE_BROWSER_DOWNLOAD'].nil?)
 
     results = guards.disposition
     send(*results) if results