selenium-webdriver 4.8.1 → 4.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9777fa00d3b0216e227ce5194d19da4268b8c7805b27d57782fa33f27d13e66c
-  data.tar.gz: 0c5fa5ecf085aa83a0d2ba6ef690c98a637ee6667656a0e2edb129a2850307a9
+  metadata.gz: c644ddbe5035bb314db11fd26ac707eb3f9aab99175a50b78214b1cafa672808
+  data.tar.gz: 3d037d5e8b6c07c61c484cd45e3065e9e755b6331bfadf9980be54c5c87f262e
 SHA512:
-  metadata.gz: d10526d84df80cd437990f38cb9b4445b19c67141115ba53ae5b300d668f5e8ef87f11b8efa70b231535bc817d2d276e21e83c70564fed3165a6627a08a17abe
-  data.tar.gz: 9175b92a1ca431f2ffde1d1005c2a6e712c7a2c0808c58581f51a440d33e3307fd1693ae8fd098571ddd68d8bc06d5257e9ec3467b071758a25db9aab990232e
+  metadata.gz: 6ed3ac91be70eef9a1e2626ae7d35dece432089a20e3714d79a38c4c1f5944159787f835f42c796df1f528debccd453ec89f8470c655d366b0ca6ea6e9351d11
+  data.tar.gz: a3e49d3f778ec7f26d9d3d5e322cbcf15ada0aa5a2a048efddea90bce06aa1db91996afcb1e077da6bec5d7183c8e61ffa36d785923b3daba518e07eb06052bd

data/CHANGES

@@ -1,3 +1,18 @@
+4.8.3 (2023-03-26)
+=========================
+Ruby:
+  * Still need to use driver finder when using capabilities parameter
+  * Accommodate Driver Finder being sent something other than an Options instance
+
+4.8.2 (2023-03-24)
+=========================
+Ruby:
+  * Ruby driver finder (#11523)
+  * Using json output with Selenium Manager
+
+BiDi:
+  * Released selenium-devtools 0.111.0 (supports CDP v85, v109, v110, v111)
+
 4.8.1 (2023-02-17)
 =========================
 Ruby:

data/lib/selenium/webdriver/chrome/driver.rb

@@ -28,11 +28,10 @@ module Selenium
       #
 
       class Driver < Chromium::Driver
-        def initialize(capabilities: nil, options: nil, service: nil, url: nil, **opts)
-          raise ArgumentError, "Can't initialize #{self.class} with :url" if url
+        include LocalDriver
 
-          caps = process_options(options, capabilities)
-          url = service_url(service || Service.chrome)
+        def initialize(capabilities: nil, options: nil, service: nil, url: nil, **opts)
+          caps, url = initialize_local_driver(capabilities, options, service, url)
           super(caps: caps, url: url, **opts)
         end
 
@@ -45,16 +44,6 @@ module Selenium
         def devtools_address
           "http://#{capabilities['goog:chromeOptions']['debuggerAddress']}"
         end
-
-        def process_options(options, capabilities)
-          if options && !options.is_a?(Options)
-            raise ArgumentError, ":options must be an instance of #{Options}"
-          elsif options.nil? && capabilities.nil?
-            options = Options.new
-          end
-
-          super(options, capabilities)
-        end
       end # Driver
     end # Chrome
   end # WebDriver

data/lib/selenium/webdriver/chrome/service.rb

@@ -25,11 +25,6 @@ module Selenium
       class Service < Chromium::Service
         DEFAULT_PORT = 9515
         EXECUTABLE = 'chromedriver'
-        MISSING_TEXT = <<~ERROR
-          Unable to find chromedriver. Please download the server from
-          https://chromedriver.storage.googleapis.com/index.html and place it somewhere on your PATH.
-          More info at https://www.selenium.dev/documentation/webdriver/getting_started/install_drivers/?language=ruby.
-        ERROR
         SHUTDOWN_SUPPORTED = true
       end # Service
     end # Chrome

data/lib/selenium/webdriver/common/driver.rb

@@ -318,24 +318,6 @@ module Selenium
         end
       end
 
-      def process_options(options, capabilities)
-        if options && capabilities
-          msg = "Don't use both :options and :capabilities when initializing #{self.class}, prefer :options"
-          raise ArgumentError, msg
-        end
-
-        options ? options.as_json : deprecate_capabilities(capabilities)
-      end
-
-      def deprecate_capabilities(capabilities)
-        unless is_a?(Remote::Driver)
-          WebDriver.logger.deprecate("The :capabilities parameter for #{self.class}",
-                                     ":options argument with an instance of #{self.class}",
-                                     id: :capabilities)
-        end
-        generate_capabilities(capabilities)
-      end
-
       def generate_capabilities(capabilities)
         Array(capabilities).map { |cap|
           if cap.is_a? Symbol

data/lib/selenium/webdriver/common/driver_finder.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Selenium
+  module WebDriver
+    class DriverFinder
+      def self.path(options, klass)
+        path = klass.driver_path
+        path = path.call if path.is_a?(Proc)
+        path ||= Platform.find_binary(klass::EXECUTABLE)
+
+        path ||= begin
+          SeleniumManager.driver_path(options)
+        rescue StandardError => e
+          WebDriver.logger.debug("Unable obtain driver using Selenium Manager\n #{e.message}")
+          nil
+        end
+        msg = "Unable to locate the #{klass::EXECUTABLE} executable; for more information on how to install drivers, " \
+              'see https://www.selenium.dev/documentation/webdriver/getting_started/install_drivers/'
+        raise Error::WebDriverError, msg unless path
+
+        Platform.assert_executable path
+        path
+      end
+    end
+  end
+end

data/lib/selenium/webdriver/common/local_driver.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Selenium
+  module WebDriver
+    module LocalDriver
+      def initialize_local_driver(capabilities, options, service, url)
+        raise ArgumentError, "Can't initialize #{self.class} with :url" if url
+
+        service ||= Service.send(browser)
+        caps = process_options(options, capabilities, service)
+        url = service_url(service)
+
+        [caps, url]
+      end
+
+      def process_options(options, capabilities, service)
+        default_options = Options.send(browser)
+
+        if options && capabilities
+          msg = "Don't use both :options and :capabilities when initializing #{self.class}, prefer :options"
+          raise ArgumentError, msg
+        elsif options && !options.is_a?(default_options.class)
+          raise ArgumentError, ":options must be an instance of #{default_options.class}"
+        elsif capabilities
+          WebDriver.logger.deprecate("The :capabilities parameter for #{self.class}",
+                                     ":options argument with an instance of #{self.class}",
+                                     id: :capabilities)
+          service.executable_path ||= WebDriver::DriverFinder.path(capabilities, service.class)
+          generate_capabilities(capabilities)
+        else
+          options ||= default_options
+          service.executable_path ||= WebDriver::DriverFinder.path(options, service.class)
+          options.as_json
+        end
+      end
+    end
+  end
+end

data/lib/selenium/webdriver/common/selenium_manager.rb

@@ -30,15 +30,28 @@ module Selenium
       BIN_PATH = '../../../../../bin'
 
       class << self
-        # @param [String] driver_name which driver to use.
+        # @param [Options] options browser options.
         # @return [String] the path to the correct driver.
-        def driver_path(driver_name)
-          unless %w[chromedriver geckodriver msedgedriver IEDriverServer].include?(driver_name)
-            msg = "Unable to locate driver with name: #{driver_name}"
-            raise Error::WebDriverError, msg
+        def driver_path(options)
+          message = 'applicable driver not found; attempting to install with Selenium Manager'
+          WebDriver.logger.warn(message)
+
+          unless options.is_a?(Options)
+            raise ArgumentError, "SeleniumManager requires a WebDriver::Options instance, not #{options.inspect}"
+          end
+
+          command = [binary, '--browser', options.browser_name, '--output', 'json']
+          if options.browser_version
+            command << '--browser-version'
+            command << options.browser_version
           end
+          if options.respond_to?(:binary) && !options.binary.nil?
+            command << '--browser-path'
+            command << "\"#{options.binary.gsub('\ ', ' ').gsub(' ', '\ ')}\""
+          end
+          command << '--debug' if WebDriver.logger.debug?
 
-          location = run("#{binary} --driver #{driver_name}")
+          location = run(command.join(' '))
           WebDriver.logger.debug("Driver found at #{location}")
           Platform.assert_executable location
 
@@ -73,15 +86,21 @@ module Selenium
 
           begin
             stdout, stderr, status = Open3.capture3(command)
+            json_output = stdout.empty? ? nil : JSON.parse(stdout)
+            result = json_output&.dig('result', 'message')
           rescue StandardError => e
             raise Error::WebDriverError, "Unsuccessful command executed: #{command}", e.message
           end
 
           if status.exitstatus.positive?
-            raise Error::WebDriverError, "Unsuccessful command executed: #{command}\n#{stdout}#{stderr}"
+            raise Error::WebDriverError, "Unsuccessful command executed: #{command}\n#{result}#{stderr}"
+          end
+
+          json_output['logs'].each do |log|
+            WebDriver.logger.send(log['level'].downcase, log['message'])
           end
 
-          stdout.gsub("INFO\t", '').strip
+          result
         end
       end
     end # SeleniumManager

data/lib/selenium/webdriver/common/service.rb

@@ -67,11 +67,10 @@ module Selenium
       #
 
       def initialize(path: nil, port: nil, args: nil)
-        path ||= self.class.driver_path
         port ||= self.class::DEFAULT_PORT
         args ||= []
 
-        @executable_path = binary_path(path)
+        @executable_path = path
         @host = Platform.localhost
         @port = Integer(port)
 
@@ -96,24 +95,6 @@ module Selenium
                                    id: :driver_opts)
         driver_opts.key?(:args) ? driver_opts.delete(:args) : []
       end
-
-      private
-
-      def binary_path(path = nil)
-        path = path.call if path.is_a?(Proc)
-        path ||= Platform.find_binary(self.class::EXECUTABLE)
-
-        begin
-          path ||= SeleniumManager.driver_path(self.class::EXECUTABLE)
-        rescue Error::WebDriverError => e
-          WebDriver.logger.debug("Unable obtain driver using Selenium Manager\n #{e.message}")
-        end
-
-        raise Error::WebDriverError, self.class::MISSING_TEXT unless path
-
-        Platform.assert_executable path
-        path
-      end
     end # Service
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver/common/service_manager.rb

@@ -64,7 +64,7 @@ module Selenium
 
         stop_server
         @process.poll_for_exit STOP_TIMEOUT
-      rescue ChildProcess::TimeoutError
+      rescue ChildProcess::TimeoutError, Errno::ECONNREFUSED
         nil # noop
       ensure
         stop_process

data/lib/selenium/webdriver/common.rb

@@ -18,6 +18,8 @@
 # under the License.
 
 require 'selenium/webdriver/common/error'
+require 'selenium/webdriver/common/local_driver'
+require 'selenium/webdriver/common/driver_finder'
 require 'selenium/webdriver/common/platform'
 require 'selenium/webdriver/common/proxy'
 require 'selenium/webdriver/common/log_entry'

data/lib/selenium/webdriver/edge/driver.rb

@@ -28,11 +28,10 @@ module Selenium
       #
 
       class Driver < Chromium::Driver
-        def initialize(capabilities: nil, options: nil, service: nil, url: nil, **opts)
-          raise ArgumentError, "Can't initialize #{self.class} with :url" if url
+        include LocalDriver
 
-          caps = process_options(options, capabilities)
-          url = service_url(service || Service.edge)
+        def initialize(capabilities: nil, options: nil, service: nil, url: nil, **opts)
+          caps, url = initialize_local_driver(capabilities, options, service, url)
           super(caps: caps, url: url, **opts)
         end
 
@@ -45,16 +44,6 @@ module Selenium
         def devtools_address
           "http://#{capabilities['ms:edgeOptions']['debuggerAddress']}"
         end
-
-        def process_options(options, capabilities)
-          if options && !options.is_a?(Options)
-            raise ArgumentError, ":options must be an instance of #{Options}"
-          elsif options.nil? && capabilities.nil?
-            options = Options.new
-          end
-
-          super(options, capabilities)
-        end
       end # Driver
     end # Edge
   end # WebDriver

data/lib/selenium/webdriver/edge/service.rb

@@ -25,10 +25,6 @@ module Selenium
       class Service < Chromium::Service
         DEFAULT_PORT = 9515
         EXECUTABLE = 'msedgedriver'
-        MISSING_TEXT = <<~ERROR
-          Unable to find msedgedriver. Please download the server from
-          https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/ and place it somewhere on your PATH.
-        ERROR
         SHUTDOWN_SUPPORTED = true
       end # Service
     end # Edge

data/lib/selenium/webdriver/firefox/driver.rb

@@ -36,11 +36,10 @@ module Selenium
                       DriverExtensions::HasWebStorage,
                       DriverExtensions::PrintsPage].freeze
 
-        def initialize(capabilities: nil, options: nil, service: nil, url: nil, **opts)
-          raise ArgumentError, "Can't initialize #{self.class} with :url" if url
+        include LocalDriver
 
-          caps = process_options(options, capabilities)
-          url = service_url(service || Service.firefox)
+        def initialize(capabilities: nil, options: nil, service: nil, url: nil, **opts)
+          caps, url = initialize_local_driver(capabilities, options, service, url)
           super(caps: caps, url: url, **opts)
         end
 
@@ -64,16 +63,6 @@ module Selenium
         def devtools_version
           Firefox::DEVTOOLS_VERSION
         end
-
-        def process_options(options, capabilities)
-          if options && !options.is_a?(Options)
-            raise ArgumentError, ":options must be an instance of #{Options}"
-          elsif options.nil? && capabilities.nil?
-            options = Options.new
-          end
-
-          super(options, capabilities)
-        end
       end # Driver
     end # Firefox
   end # WebDriver

data/lib/selenium/webdriver/firefox/service.rb

@@ -23,11 +23,6 @@ module Selenium
       class Service < WebDriver::Service
         DEFAULT_PORT = 4444
         EXECUTABLE = 'geckodriver'
-        MISSING_TEXT = <<~ERROR
-          Unable to find Mozilla geckodriver. Please download the server from
-          https://github.com/mozilla/geckodriver/releases and place it somewhere on your PATH.
-          More info at https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/WebDriver.
-        ERROR
         SHUTDOWN_SUPPORTED = false
 
         private

data/lib/selenium/webdriver/ie/driver.rb

@@ -29,29 +29,16 @@ module Selenium
       class Driver < WebDriver::Driver
         EXTENSIONS = [DriverExtensions::HasWebStorage].freeze
 
-        def initialize(capabilities: nil, options: nil, service: nil, url: nil, **opts)
-          raise ArgumentError, "Can't initialize #{self.class} with :url" if url
+        include LocalDriver
 
-          caps = process_options(options, capabilities)
-          url = service_url(service || Service.ie)
+        def initialize(capabilities: nil, options: nil, service: nil, url: nil, **opts)
+          caps, url = initialize_local_driver(capabilities, options, service, url)
           super(caps: caps, url: url, **opts)
         end
 
         def browser
           :internet_explorer
         end
-
-        private
-
-        def process_options(options, capabilities)
-          if options && !options.is_a?(Options)
-            raise ArgumentError, ":options must be an instance of #{Options}"
-          elsif options.nil? && capabilities.nil?
-            options = Options.new
-          end
-
-          super(options, capabilities)
-        end
       end # Driver
     end # IE
   end # WebDriver

data/lib/selenium/webdriver/ie/service.rb

@@ -23,11 +23,6 @@ module Selenium
       class Service < WebDriver::Service
         DEFAULT_PORT = 5555
         EXECUTABLE = 'IEDriverServer'
-        MISSING_TEXT = <<~ERROR
-          Unable to find IEDriverServer. Please download the server from
-          https://www.selenium.dev/downloads/ and place it somewhere on your PATH.
-          More info at https://github.com/SeleniumHQ/selenium/wiki/InternetExplorerDriver.
-        ERROR
         SHUTDOWN_SUPPORTED = true
 
         private

data/lib/selenium/webdriver/remote/driver.rb

@@ -50,9 +50,13 @@ module Selenium
         end
 
         def process_options(options, capabilities)
-          raise ArgumentError, "#{self.class} needs :options to be set" if options.nil? && capabilities.nil?
-
-          super(options, capabilities)
+          if options && capabilities
+            msg = "Don't use both :options and :capabilities when initializing #{self.class}, prefer :options"
+            raise ArgumentError, msg
+          elsif options.nil? && capabilities.nil?
+            raise ArgumentError, "#{self.class} needs :options to be set"
+          end
+          options ? options.as_json : generate_capabilities(capabilities)
         end
       end # Driver
     end # Remote

data/lib/selenium/webdriver/safari/driver.rb

@@ -30,29 +30,16 @@ module Selenium
                       DriverExtensions::HasApplePermissions,
                       DriverExtensions::HasWebStorage].freeze
 
-        def initialize(capabilities: nil, options: nil, service: nil, url: nil, **opts)
-          raise ArgumentError, "Can't initialize #{self.class} with :url" if url
+        include LocalDriver
 
-          caps = process_options(options, capabilities)
-          url = service_url(service || Service.safari)
+        def initialize(capabilities: nil, options: nil, service: nil, url: nil, **opts)
+          caps, url = initialize_local_driver(capabilities, options, service, url)
           super(caps: caps, url: url, **opts)
         end
 
         def browser
           :safari
         end
-
-        private
-
-        def process_options(options, capabilities)
-          if options && !options.is_a?(Options)
-            raise ArgumentError, ":options must be an instance of #{Options}"
-          elsif options.nil? && capabilities.nil?
-            options = Options.new
-          end
-
-          super(options, capabilities)
-        end
       end # Driver
     end # Safari
   end # WebDriver

data/lib/selenium/webdriver/safari/service.rb

@@ -23,10 +23,6 @@ module Selenium
       class Service < WebDriver::Service
         DEFAULT_PORT = 7050
         EXECUTABLE = 'safaridriver'
-        MISSING_TEXT = <<~ERROR
-          Unable to find Apple's safaridriver which comes with Safari 10.
-          More info at https://webkit.org/blog/6900/webdriver-support-in-safari-10/
-        ERROR
         SHUTDOWN_SUPPORTED = false
       end # Service
     end # Safari

data/lib/selenium/webdriver/version.rb

@@ -19,6 +19,6 @@
 
 module Selenium
   module WebDriver
-    VERSION = '4.8.1'
+    VERSION = '4.8.3'
   end # WebDriver
 end # Selenium

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: selenium-webdriver
 version: !ruby/object:Gem::Version
-  version: 4.8.1
+  version: 4.8.3
 platform: ruby
 authors:
 - Alex Rodionov
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-17 00:00:00.000000000 Z
+date: 2023-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rexml
@@ -272,6 +272,7 @@ files:
 - lib/selenium/webdriver/common/driver_extensions/has_web_storage.rb
 - lib/selenium/webdriver/common/driver_extensions/prints_page.rb
 - lib/selenium/webdriver/common/driver_extensions/uploads_files.rb
+- lib/selenium/webdriver/common/driver_finder.rb
 - lib/selenium/webdriver/common/element.rb
 - lib/selenium/webdriver/common/error.rb
 - lib/selenium/webdriver/common/file_reaper.rb
@@ -297,6 +298,7 @@ files:
 - lib/selenium/webdriver/common/interactions/wheel_actions.rb
 - lib/selenium/webdriver/common/interactions/wheel_input.rb
 - lib/selenium/webdriver/common/keys.rb
+- lib/selenium/webdriver/common/local_driver.rb
 - lib/selenium/webdriver/common/log_entry.rb
 - lib/selenium/webdriver/common/logger.rb
 - lib/selenium/webdriver/common/logs.rb