selenium-webdriver 4.5.0 → 4.9.0

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

@@ -42,30 +42,13 @@ module Selenium
       # @return [ActionBuilder] A self reference.
       #
 
-      def initialize(bridge, deprecated_mouse = nil, deprecated_keyboard = nil, deprecated_async = nil,
-                     devices: [], async: false, duration: 250)
+      def initialize(bridge, devices: [], async: false, duration: 250)
         @bridge = bridge
         @duration = duration
-
-        @async = if deprecated_async.nil?
-                   async
-                 else
-                   WebDriver.logger.deprecate('initializing ActionBuilder with async parameter',
-                                              ':async keyword',
-                                              id: :action_async)
-                   deprecated_async
-                 end
-
+        @async = async
         @devices = []
-        if deprecated_keyboard || deprecated_mouse
-          WebDriver.logger.deprecate "initializing ActionBuilder with keyboard and mouse parameters",
-                                     "devices keyword or, even better, Driver#action",
-                                     id: :action_devices
-          add_input(deprecated_mouse)
-          add_input(deprecated_keyboard)
-        else
-          Array(devices).each { |device| add_input(device) }
-        end
+
+        Array(devices).each { |device| add_input(device) }
       end
 
       #
@@ -118,20 +101,6 @@ module Selenium
         add_input(Interactions.wheel(name))
       end
 
-      #
-      # Retrieves the input device for the given name
-      #
-      # @param [String] name name of the input device
-      # @return [Selenium::WebDriver::Interactions::InputDevice] input device with given name
-      #
-
-      def get_device(name)
-        WebDriver.logger.deprecate('#get_device with name parameter',
-                                   '#device with :name or :type keyword',
-                                   id: :get_device)
-        device(name: name)
-      end
-
       #
       # Retrieves the input device for the given name or type
       #
@@ -194,11 +163,9 @@ module Selenium
       # @return [ActionBuilder] A self reference.
       #
 
-      def pause(deprecated_device = nil, deprecated_duration = nil, device: nil, duration: 0)
-        deprecate_method(deprecated_device, deprecated_duration)
-
-        device ||= deprecated_device || pointer_input
-        device.create_pause(deprecated_duration || duration)
+      def pause(device: nil, duration: 0)
+        device ||= pointer_input
+        device.create_pause(duration)
         self
       end
 
@@ -218,13 +185,10 @@ module Selenium
       # @return [ActionBuilder] A self reference.
       #
 
-      def pauses(deprecated_device = nil, deprecated_number = nil, deprecated_duration = nil,
-                 device: nil, number: nil, duration: 0)
-        deprecate_method(deprecated_device, deprecated_duration, deprecated_number, method: :pauses)
-
-        number ||= deprecated_number || 2
-        device ||= deprecated_device || pointer_input
-        duration ||= deprecated_duration || 0
+      def pauses(device: nil, number: nil, duration: 0)
+        number ||= 2
+        device ||= pointer_input
+        duration ||= 0
 
         number.times { device.create_pause(duration) }
         self
@@ -294,7 +258,6 @@ module Selenium
                                    ':device, :duration, :number keywords',
                                    id: method
       end
-
     end # ActionBuilder
   end # WebDriver
 end # Selenium

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

@@ -0,0 +1,124 @@
+# 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
+    #
+    # @api private
+    #
+
+    class ChildProcess
+      TimeoutError = Class.new(StandardError)
+
+      SIGTERM = 'TERM'
+      SIGKILL = 'KILL'
+
+      POLL_INTERVAL = 0.1
+
+      attr_accessor :detach
+      attr_writer :io
+
+      def self.build(*command)
+        new(*command)
+      end
+
+      def initialize(*command)
+        @command = command
+        @detach = false
+        @pid = nil
+        @status = nil
+      end
+
+      def io
+        @io ||= Platform.null_device
+      end
+
+      def start
+        options = {%i[out err] => io}
+        options[:pgroup] = true unless Platform.windows? # NOTE: this is a bug only in Windows 7
+
+        WebDriver.logger.debug("Starting process: #{@command} with #{options}")
+        @pid = Process.spawn(*@command, options)
+        WebDriver.logger.debug("  -> pid: #{@pid}")
+
+        Process.detach(@pid) if detach
+      end
+
+      def stop(timeout = 3)
+        return unless @pid
+        return if exited?
+
+        WebDriver.logger.debug("Sending TERM to process: #{@pid}")
+        terminate(@pid)
+        poll_for_exit(timeout)
+
+        WebDriver.logger.debug("  -> stopped #{@pid}")
+      rescue TimeoutError, Errno::EINVAL
+        WebDriver.logger.debug("    -> sending KILL to process: #{@pid}")
+        kill(@pid)
+        wait
+        WebDriver.logger.debug("      -> killed #{@pid}")
+      end
+
+      def alive?
+        @pid && !exited?
+      end
+
+      def exited?
+        return unless @pid
+
+        WebDriver.logger.debug("Checking if #{@pid} is exited:")
+        _, @status = Process.waitpid2(@pid, Process::WNOHANG | Process::WUNTRACED) if @status.nil?
+        return if @status.nil?
+
+        exit_code = @status.exitstatus || @status.termsig
+        WebDriver.logger.debug("  -> exit code is #{exit_code.inspect}")
+
+        !!exit_code
+      end
+
+      def poll_for_exit(timeout)
+        WebDriver.logger.debug("Polling #{timeout} seconds for exit of #{@pid}")
+
+        end_time = Time.now + timeout
+        sleep POLL_INTERVAL until exited? || Time.now > end_time
+
+        raise TimeoutError, "  ->  #{@pid} still alive after #{timeout} seconds" unless exited?
+      end
+
+      def wait
+        return if exited?
+
+        _, @status = Process.waitpid2(@pid)
+      end
+
+      private
+
+      def terminate(pid)
+        Process.kill(SIGTERM, pid)
+      end
+
+      def kill(pid)
+        Process.kill(SIGKILL, pid)
+      rescue Errno::ECHILD, Errno::ESRCH
+        # already dead
+      end
+    end # ChildProcess
+  end # WebDriver
+end # Selenium

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

@@ -51,7 +51,7 @@ module Selenium
             Safari::Driver.new(**opts)
           when :firefox, :ff
             Firefox::Driver.new(**opts)
-          when :edge
+          when :edge, :microsoftedge, :msedge
             Edge::Driver.new(**opts)
           when :remote
             Remote::Driver.new(**opts)
@@ -69,8 +69,8 @@ module Selenium
       #
 
       def initialize(bridge: nil, listener: nil, **opts)
-        @service = nil
         @devtools = nil
+        @bidi = nil
         bridge ||= create_bridge(**opts)
         add_extensions(bridge.browser)
         @bridge = listener ? Support::EventFiringBridge.new(bridge, listener) : bridge
@@ -127,14 +127,6 @@ module Selenium
         bridge.action(**opts)
       end
 
-      def mouse
-        bridge.mouse
-      end
-
-      def keyboard
-        bridge.keyboard
-      end
-
       #
       # Opens the specified URL in the browser.
       #
@@ -180,8 +172,9 @@ module Selenium
       def quit
         bridge.quit
       ensure
-        @service&.stop
+        @service_manager&.stop
         @devtools&.close
+        @bidi&.close
       end
 
       #
@@ -189,7 +182,10 @@ module Selenium
       #
 
       def close
-        bridge.close
+        # If no top-level browsing contexts are open after calling close,
+        # it indicates that the WebDriver session is closed.
+        # If the WebDriver session is closed, the BiDi session also needs to be closed.
+        bridge.close.tap { |handles| @bidi&.close if handles&.empty? }
       end
 
       #
@@ -263,19 +259,19 @@ module Selenium
       #   driver.first(id: 'foo')
       #
 
-      alias_method :first, :find_element
+      alias first find_element
 
       #
       #   driver.all(class: 'bar') #=> [#<WebDriver::Element:0x1011c3b88, ...]
       #
 
-      alias_method :all, :find_elements
+      alias all find_elements
 
       #
       #   driver.script('function() { ... };')
       #
 
-      alias_method :script, :execute_script
+      alias script execute_script
 
       # Get the first element matching the given selector. If given a
       # String or Symbol, it will be used as the id of the element.
@@ -316,30 +312,27 @@ module Selenium
 
       attr_reader :bridge
 
-      def create_bridge(capabilities: nil, options: nil, url: nil, service: nil, http_client: nil)
-        Remote::Bridge.new(http_client: http_client,
-                           url: url || service_url(service)).tap do |bridge|
-          generated_caps = options ? options.as_json : generate_capabilities(capabilities)
-          bridge.create_session(generated_caps)
+      def create_bridge(caps:, url:, http_client: nil)
+        Remote::Bridge.new(http_client: http_client, url: url).tap do |bridge|
+          bridge.create_session(caps)
         end
       end
 
       def generate_capabilities(capabilities)
         Array(capabilities).map { |cap|
           if cap.is_a? Symbol
-            cap = Remote::Capabilities.send(cap)
+            cap = WebDriver::Options.send(cap)
           elsif !cap.respond_to? :as_json
             msg = ":capabilities parameter only accepts objects responding to #as_json which #{cap.class} does not"
             raise ArgumentError, msg
           end
           cap.as_json
-        }.inject(:merge) || Remote::Capabilities.send(browser || :new)
+        }.inject(:merge)
       end
 
       def service_url(service)
-        service ||= Service.send(browser)
-        @service = service.launch
-        @service.uri
+        @service_manager = service.launch
+        @service_manager.uri
       end
 
       def screenshot
@@ -349,11 +342,13 @@ module Selenium
       def add_extensions(browser)
         extensions = case browser
                      when :chrome, :msedge
-                       Chrome::Driver::EXTENSIONS
+                       Chromium::Driver::EXTENSIONS
                      when :firefox
                        Firefox::Driver::EXTENSIONS
                      when :safari, :safari_technology_preview
                        Safari::Driver::EXTENSIONS
+                     when :ie, :internet_explorer
+                       IE::Driver::EXTENSIONS
                      else
                        []
                      end

data/lib/selenium/webdriver/common/driver_extensions/downloads_files.rb

@@ -21,7 +21,6 @@ module Selenium
   module WebDriver
     module DriverExtensions
       module DownloadsFiles
-
         #
         # Sets download path for Chromium.
         #
@@ -38,7 +37,6 @@ module Selenium
           }
           @bridge.send_command(params)
         end
-
       end # DownloadsFiles
     end # DriverExtensions
   end # WebDriver

data/lib/selenium/webdriver/common/driver_extensions/full_page_screenshot.rb

@@ -36,7 +36,6 @@ module Selenium
         def full_screenshot
           @bridge.full_screenshot
         end
-
       end # FullPageScreenshot
     end # DriverExtensions
   end # WebDriver

data/lib/selenium/webdriver/common/driver_extensions/has_addons.rb

@@ -21,7 +21,6 @@ module Selenium
   module WebDriver
     module DriverExtensions
       module HasAddons
-
         #
         # Installs addon.
         #
@@ -43,7 +42,6 @@ module Selenium
         def uninstall_addon(id)
           @bridge.uninstall_addon(id)
         end
-
       end # HasAddons
     end # DriverExtensions
   end # WebDriver

data/lib/selenium/webdriver/common/driver_extensions/has_apple_permissions.rb

@@ -21,7 +21,6 @@ module Selenium
   module WebDriver
     module DriverExtensions
       module HasApplePermissions
-
         #
         # Returns permissions.
         #
@@ -44,7 +43,6 @@ module Selenium
         def permissions=(permissions)
           @bridge.permissions = permissions
         end
-
       end # HasPermissions
     end # DriverExtensions
   end # WebDriver

data/lib/selenium/webdriver/common/driver_extensions/has_authentication.rb

@@ -21,7 +21,6 @@ module Selenium
   module WebDriver
     module DriverExtensions
       module HasAuthentication
-
         #
         # Registers basic authentication handler which is automatically
         # used whenever browser gets an authentication required response.
@@ -82,7 +81,6 @@ module Selenium
             )
           end
         end
-
       end # HasAuthentication
     end # DriverExtensions
   end # WebDriver

data/lib/selenium/webdriver/common/driver_extensions/has_bidi.rb

@@ -21,7 +21,6 @@ module Selenium
   module WebDriver
     module DriverExtensions
       module HasBiDi
-
         #
         # Retrieves WebDriver BiDi connection.
         #
@@ -31,7 +30,6 @@ module Selenium
         def bidi
           @bidi ||= Selenium::WebDriver::BiDi.new(url: capabilities[:web_socket_url])
         end
-
       end # HasBiDi
     end # DriverExtensions
   end # WebDriver

data/lib/selenium/webdriver/common/driver_extensions/has_casting.rb

@@ -21,7 +21,6 @@ module Selenium
   module WebDriver
     module DriverExtensions
       module HasCasting
-
         #
         # What devices ("sinks") are available to be cast to.
         #

data/lib/selenium/webdriver/common/driver_extensions/has_cdp.rb

@@ -21,7 +21,6 @@ module Selenium
   module WebDriver
     module DriverExtensions
       module HasCDP
-
         #
         # Returns network conditions.
         #
@@ -31,7 +30,6 @@ module Selenium
         def execute_cdp(cmd, **params)
           @bridge.send_command(cmd: cmd, params: params)
         end
-
       end # HasCDP
     end # DriverExtensions
   end # WebDriver

data/lib/selenium/webdriver/common/driver_extensions/has_context.rb

@@ -21,7 +21,6 @@ module Selenium
   module WebDriver
     module DriverExtensions
       module HasContext
-
         #
         # Sets the context that Selenium commands are running in using
         #         a `with` statement. The state of the context on the server is
@@ -37,7 +36,6 @@ module Selenium
         def context
           @bridge.context
         end
-
       end # HasContext
     end # DriverExtensions
   end # WebDriver

data/lib/selenium/webdriver/common/driver_extensions/has_debugger.rb

@@ -21,7 +21,6 @@ module Selenium
   module WebDriver
     module DriverExtensions
       module HasDebugger
-
         #
         # Attaches debugger to session.
         #
@@ -35,7 +34,6 @@ module Selenium
         def attach_debugger
           @bridge.attach_debugger
         end
-
       end # HasDebugger
     end # DriverExtensions
   end # WebDriver

data/lib/selenium/webdriver/common/driver_extensions/has_devtools.rb

@@ -21,7 +21,6 @@ module Selenium
   module WebDriver
     module DriverExtensions
       module HasDevTools
-
         #
         # Retrieves connection to DevTools.
         #
@@ -36,7 +35,6 @@ module Selenium
             Selenium::WebDriver::DevTools.new(url: devtools_url)
           end
         end
-
       end # HasDevTools
     end # DriverExtensions
   end # WebDriver

data/lib/selenium/webdriver/common/driver_extensions/has_launching.rb

@@ -21,7 +21,6 @@ module Selenium
   module WebDriver
     module DriverExtensions
       module HasLaunching
-
         #
         # Launches Chromium app specified by id.
         #
@@ -31,7 +30,6 @@ module Selenium
         def launch_app(id)
           @bridge.launch_app(id)
         end
-
       end # HasLaunching
     end # DriverExtensions
   end # WebDriver

data/lib/selenium/webdriver/common/driver_extensions/has_location.rb

@@ -29,8 +29,7 @@ module Selenium
         def location=(*)
           raise Error::UnsupportedOperationError, 'The W3C standard does not currently support setting location'
         end
-        alias_method :set_location, :location
-
+        alias set_location location
       end # HasLocation
     end # DriverExtensions
   end # WebDriver

data/lib/selenium/webdriver/common/driver_extensions/has_log_events.rb

@@ -137,7 +137,6 @@ module Selenium
         def mutation_listener
           @mutation_listener ||= read_atom(:mutationListener)
         end
-
       end # HasLogEvents
     end # DriverExtensions
   end # WebDriver

data/lib/selenium/webdriver/common/driver_extensions/has_network_conditions.rb

@@ -21,7 +21,6 @@ module Selenium
   module WebDriver
     module DriverExtensions
       module HasNetworkConditions
-
         #
         # Returns network conditions.
         #
@@ -61,7 +60,6 @@ module Selenium
         def delete_network_conditions
           @bridge.delete_network_conditions
         end
-
       end # HasNetworkConditions
     end # DriverExtensions
   end # WebDriver

data/lib/selenium/webdriver/common/driver_extensions/has_network_interception.rb

@@ -21,7 +21,6 @@ module Selenium
   module WebDriver
     module DriverExtensions
       module HasNetworkInterception
-
         #
         # Intercepts requests coming from browser allowing
         # to either pass them through like proxy or provide
@@ -64,7 +63,6 @@ module Selenium
           @interceptor ||= DevTools::NetworkInterceptor.new(devtools)
           @interceptor.intercept(&block)
         end
-
       end # HasNetworkInterception
     end # DriverExtensions
   end # WebDriver

data/lib/selenium/webdriver/common/driver_extensions/has_permissions.rb

@@ -21,7 +21,6 @@ module Selenium
   module WebDriver
     module DriverExtensions
       module HasPermissions
-
         #
         # Set one permission.
         #
@@ -44,7 +43,6 @@ module Selenium
             @bridge.set_permission(key, value)
           end
         end
-
       end # HasPermissions
     end # DriverExtensions
   end # WebDriver

data/lib/selenium/webdriver/common/driver_extensions/has_pinned_scripts.rb

@@ -21,7 +21,6 @@ module Selenium
   module WebDriver
     module DriverExtensions
       module HasPinnedScripts
-
         #
         # Returns the list of all pinned scripts.
         #
@@ -70,7 +69,6 @@ module Selenium
           devtools.page.remove_script_to_evaluate_on_new_document(identifier: script.devtools_identifier)
           pinned_scripts.delete(script)
         end
-
       end # HasPinnedScripts
     end # DriverExtensions
   end # WebDriver

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.warn("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