selenium-webdriver 3.142.7 → 4.10.0

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

@@ -19,346 +19,236 @@
 
 module Selenium
   module WebDriver
-    #
-    # The ActionBuilder provides the user a way to set up and perform
-    # complex user interactions.
-    #
-    # This class should not be instantiated directly, but is created by Driver#action
-    #
-    # @example
-    #
-    #  driver.action.key_down(:shift).
-    #                click(element).
-    #                click(second_element).
-    #                key_up(:shift).
-    #                drag_and_drop(element, third_element).
-    #                perform
-    #
-
     class ActionBuilder
+      include KeyActions # Actions specific to key inputs
+      include PointerActions # Actions specific to pointer inputs
+      include WheelActions # Actions specific to wheel inputs
+
+      attr_reader :devices
+
       #
-      # @api private
+      # Initialize a W3C Action Builder. Differs from previous by requiring a bridge and allowing asynchronous actions.
+      # The W3C implementation allows asynchronous actions per device. e.g. A key can be pressed at the same time that
+      # the mouse is moving. Keep in mind that pauses must be added for other devices in order to line up the actions
+      # correctly when using asynchronous.
+      #
+      # @param [Selenium::WebDriver::Remote::Bridge] bridge the bridge for the current driver instance.
+      # @param [Selenium::WebDriver::Interactions::PointerInput] deprecated_mouse PointerInput for the mouse.
+      # @param [Selenium::WebDriver::Interactions::KeyInput] deprecated_keyboard KeyInput for the keyboard.
+      # @param [Boolean] deprecated_async Whether to perform the actions asynchronously per device.
+      #   Defaults to false for backwards compatibility.
+      # @param [Array<Selenium::WebDriver::Interactions::InputDevices>] devices list of valid sources of input.
+      # @param [Boolean] async Whether to perform the actions asynchronously per device.
+      # @return [ActionBuilder] A self reference.
       #
 
-      def initialize(mouse, keyboard)
-        @devices = {
-          mouse: mouse,
-          keyboard: keyboard
-        }
+      def initialize(bridge, devices: [], async: false, duration: 250)
+        @bridge = bridge
+        @duration = duration
+        @async = async
+        @devices = []
 
-        @actions = []
+        Array(devices).each { |device| add_input(device) }
       end
 
       #
-      # Performs a modifier key press. Does not release
-      # the modifier key - subsequent interactions may assume it's kept pressed.
-      # Note that the modifier key is never released implicitly - either
-      # #key_up(key) or #send_keys(:null) must be called to release the modifier.
+      # Adds a PointerInput device of the given kind
       #
-      # Equivalent to:
-      #   driver.action.click(element).send_keys(key)
-      #   # or
-      #   driver.action.click.send_keys(key)
+      # @example Add a touch pointer input device
       #
-      # @example Press a key
+      #    builder = device.action
+      #    builder.add_pointer_input('touch', :touch)
       #
-      #    driver.action.key_down(:control).perform
+      # @param [String] name name for the device
+      # @param [Symbol] kind kind of pointer device to create
+      # @return [Interactions::PointerInput] The pointer input added
       #
-      # @example Press a key on an element
       #
-      #    el = driver.find_element(id: "some_id")
-      #    driver.action.key_down(el, :shift).perform
-      #
-      # @overload key_down(key)
-      #   @param [:shift, :alt, :control, :command, :meta] key The modifier key to press
-      # @overload key_down(element, key)
-      #   @param [Element] element An optional element to move to first
-      #   @param [:shift, :alt, :control, :command, :meta] key The modifier key to press
-      # @raise [ArgumentError] if the given key is not a modifier
-      # @return [ActionBuilder] A self reference
-
-      def key_down(*args)
-        @actions << [:mouse, :click, [args.shift]] if args.first.is_a? Element
 
-        @actions << [:keyboard, :press, args]
-        self
+      def add_pointer_input(kind, name)
+        add_input(Interactions.pointer(kind, name: name))
       end
 
       #
-      # Performs a modifier key release.
-      # Releasing a non-depressed modifier key will yield undefined behaviour.
+      # Adds a KeyInput device
       #
-      # @example Release a key
+      # @example Add a key input device
       #
-      #   driver.action.key_up(:shift).perform
+      #    builder = device.action
+      #    builder.add_key_input('keyboard2')
       #
-      # @example Release a key from an element
-      #
-      #   el = driver.find_element(id: "some_id")
-      #   driver.action.key_up(el, :alt).perform
+      # @param [String] name name for the device
+      # @return [Interactions::KeyInput] The key input added
       #
-      # @overload key_up(key)
-      #   @param [:shift, :alt, :control, :command, :meta] key The modifier key to release
-      # @overload key_up(element, key)
-      #   @param [Element] element An optional element to move to first
-      #   @param [:shift, :alt, :control, :command, :meta] key The modifier key to release
-      # @raise [ArgumentError] if the given key is not a modifier
-      # @return [ActionBuilder] A self reference
-      #
-
-      def key_up(*args)
-        @actions << [:mouse, :click, [args.shift]] if args.first.is_a? Element
 
-        @actions << [:keyboard, :release, args]
-        self
+      def add_key_input(name)
+        add_input(Interactions.key(name))
       end
 
       #
-      # Sends keys to the active element. This differs from calling
-      # Element#send_keys(keys) on the active element in two ways:
+      # Adds a WheelInput device
       #
-      # * The modifier keys included in this call are not released.
-      # * There is no attempt to re-focus the element - so send_keys(:tab) for switching elements should work.
+      # @example Add a wheel input device
       #
-      # @example Send the text "help" to an element
+      #    builder = device.action
+      #    builder.add_wheel_input('wheel2')
       #
-      #   el = driver.find_element(id: "some_id")
-      #   driver.action.send_keys(el, "help").perform
+      # @param [String] name name for the device
+      # @return [Interactions::WheelInput] The wheel input added
       #
-      # @example Send the text "help" to the currently focused element
+
+      def add_wheel_input(name)
+        add_input(Interactions.wheel(name))
+      end
+
       #
-      #   driver.action.send_keys("help").perform
+      # Retrieves the input device for the given name or type
       #
-      # @overload send_keys(keys)
-      #   @param [Array, Symbol, String] keys The key(s) to press and release
-      # @overload send_keys(element, keys)
-      #   @param [Element] element An optional element to move to first
-      #   @param [Array, Symbol, String] keys The key(s) to press and release
-      # @return [ActionBuilder] A self reference
+      # @param [String] name name of the input device
+      # @param [String] type name of the input device
+      # @return [Selenium::WebDriver::Interactions::InputDevice] input device with given name or type
       #
 
-      def send_keys(*args)
-        @actions << [:mouse, :click, [args.shift]] if args.first.is_a? Element
+      def device(name: nil, type: nil)
+        input = @devices.find { |device| (device.name == name.to_s || name.nil?) && (device.type == type || type.nil?) }
 
-        @actions << [:keyboard, :send_keys, args]
-        self
+        raise(ArgumentError, "Can not find device: #{name}") if name && input.nil?
+
+        input
       end
 
       #
-      # Clicks (without releasing) in the middle of the given element. This is
-      # equivalent to:
+      # Retrieves the current PointerInput devices
       #
-      #   driver.action.move_to(element).click_and_hold
-      #
-      # @example Clicking and holding on some element
-      #
-      #    el = driver.find_element(id: "some_id")
-      #    driver.action.click_and_hold(el).perform
-      #
-      # @param [Element] element the element to move to and click.
-      # @return [ActionBuilder] A self reference.
+      # @return [Array] array of current PointerInput devices
       #
 
-      def click_and_hold(element = nil)
-        @actions << [:mouse, :down, [element]]
-        self
+      def pointer_inputs
+        @devices.select { |device| device.type == Interactions::POINTER }
       end
 
       #
-      # Releases the depressed left mouse button at the current mouse location.
+      # Retrieves the current KeyInput device
       #
-      # @example Releasing an element after clicking and holding it
-      #
-      #    el = driver.find_element(id: "some_id")
-      #    driver.action.click_and_hold(el).release.perform
-      #
-      # @return [ActionBuilder] A self reference.
+      # @return [Selenium::WebDriver::Interactions::InputDevice] current KeyInput device
       #
 
-      def release(element = nil)
-        @actions << [:mouse, :up, [element]]
-        self
+      def key_inputs
+        @devices.select { |device| device.type == Interactions::KEY }
       end
 
       #
-      # Clicks in the middle of the given element. Equivalent to:
+      # Retrieves the current WheelInput device
       #
-      #   driver.action.move_to(element).click
-      #
-      # When no element is passed, the current mouse position will be clicked.
-      #
-      # @example Clicking on an element
-      #
-      #    el = driver.find_element(id: "some_id")
-      #    driver.action.click(el).perform
-      #
-      # @example Clicking at the current mouse position
-      #
-      #    driver.action.click.perform
-      #
-      # @param [Selenium::WebDriver::Element] element An optional element to click.
-      # @return [ActionBuilder] A self reference.
+      # @return [Selenium::WebDriver::Interactions::InputDevice] current WheelInput devices
       #
 
-      def click(element = nil)
-        @actions << [:mouse, :click, [element]]
-        self
+      def wheel_inputs
+        @devices.select { |device| device.type == Interactions::WHEEL }
       end
 
       #
-      # Performs a double-click at middle of the given element. Equivalent to:
-      #
-      #   driver.action.move_to(element).double_click
+      # Creates a pause for the given device of the given duration. If no duration is given, the pause will only wait
+      # for all actions to complete in that tick.
       #
-      # @example Double click an element
+      # @example Send keys to an element
       #
-      #    el = driver.find_element(id: "some_id")
-      #    driver.action.double_click(el).perform
+      #   action_builder = driver.action
+      #   keyboard = action_builder.key_input
+      #   el = driver.find_element(id: "some_id")
+      #   driver.action.click(el).pause(keyboard).pause(keyboard).pause(keyboard).send_keys('keys').perform
       #
-      # @param [Selenium::WebDriver::Element] element An optional element to move to.
+      # @param [InputDevice] device Input device to pause
+      # @param [Float] duration Duration to pause
       # @return [ActionBuilder] A self reference.
       #
 
-      def double_click(element = nil)
-        @actions << [:mouse, :double_click, [element]]
+      def pause(device: nil, duration: 0)
+        device ||= pointer_input
+        device.create_pause(duration)
         self
       end
 
       #
-      # Moves the mouse to the middle of the given element. The element is scrolled into
-      # view and its location is calculated using getBoundingClientRect.  Then the
-      # mouse is moved to optional offset coordinates from the element.
-      #
-      # Note that when using offsets, both coordinates need to be passed.
-      #
-      # @example Scroll element into view and move the mouse to it
-      #
-      #   el = driver.find_element(id: "some_id")
-      #   driver.action.move_to(el).perform
+      # Creates multiple pauses for the given device of the given duration.
       #
-      # @example
+      # @example Send keys to an element
       #
+      #   action_builder = driver.action
+      #   keyboard = action_builder.key_input
       #   el = driver.find_element(id: "some_id")
-      #   driver.action.move_to(el, 100, 100).perform
+      #   driver.action.click(el).pauses(keyboard, 3).send_keys('keys').perform
       #
-      # @param [Selenium::WebDriver::Element] element to move to.
-      # @param [Integer] right_by Optional offset from the top-left corner. A negative value means
-      #   coordinates right from the element.
-      # @param [Integer] down_by Optional offset from the top-left corner. A negative value means
-      #   coordinates above the element.
+      # @param [InputDevice] device Input device to pause
+      # @param [Integer] number of pauses to add for the device
+      # @param [Float] duration Duration to pause
       # @return [ActionBuilder] A self reference.
       #
 
-      def move_to(element, right_by = nil, down_by = nil)
-        @actions << if right_by && down_by
-                      [:mouse, :move_to, [element, Integer(right_by), Integer(down_by)]]
-                    else
-                      [:mouse, :move_to, [element]]
-                    end
+      def pauses(device: nil, number: nil, duration: 0)
+        number ||= 2
+        device ||= pointer_input
+        duration ||= 0
 
+        number.times { device.create_pause(duration) }
         self
       end
 
       #
-      # Moves the mouse from its current position (or 0,0) by the given offset.
-      # If the coordinates provided are outside the viewport (the mouse will
-      # end up outside the browser window) then the viewport is scrolled to
-      # match.
-      #
-      # @example Move the mouse to a certain offset from its current position
-      #
-      #    driver.action.move_by(100, 100).perform
-      #
-      # @param [Integer] right_by horizontal offset. A negative value means moving the
-      #   mouse left.
-      # @param [Integer] down_by vertical offset. A negative value means moving the mouse
-      #   up.
-      # @return [ActionBuilder] A self reference.
-      # @raise [MoveTargetOutOfBoundsError] if the provided offset is outside
-      #   the document's boundaries.
+      # Executes the actions added to the builder.
       #
 
-      def move_by(right_by, down_by)
-        @actions << [:mouse, :move_by, [Integer(right_by), Integer(down_by)]]
-        self
+      def perform
+        @bridge.send_actions @devices.filter_map(&:encode)
+        clear_all_actions
+        nil
       end
 
       #
-      # Performs a context-click at middle of the given element. First performs
-      # a move_to to the location of the element.
-      #
-      # @example Context-click at middle of given element
-      #
-      #   el = driver.find_element(id: "some_id")
-      #   driver.action.context_click(el).perform
-      #
-      # @param [Selenium::WebDriver::Element] element An element to context click.
-      # @return [ActionBuilder] A self reference.
+      # Clears all actions from the builder.
       #
 
-      def context_click(element = nil)
-        @actions << [:mouse, :context_click, [element]]
-        self
+      def clear_all_actions
+        @devices.each(&:clear_actions)
       end
 
       #
-      # A convenience method that performs click-and-hold at the location of the
-      # source element, moves to the location of the target element, then
-      # releases the mouse.
-      #
-      # @example Drag and drop one element onto another
-      #
-      #   el1 = driver.find_element(id: "some_id1")
-      #   el2 = driver.find_element(id: "some_id2")
-      #   driver.action.drag_and_drop(el1, el2).perform
-      #
-      # @param [Selenium::WebDriver::Element] source element to emulate button down at.
-      # @param [Selenium::WebDriver::Element] target element to move to and release the
-      #   mouse at.
-      # @return [ActionBuilder] A self reference.
+      # Releases all action states from the browser.
       #
 
-      def drag_and_drop(source, target)
-        click_and_hold source
-        move_to        target
-        release
-
-        self
+      def release_actions
+        @bridge.release_actions
       end
 
+      private
+
       #
-      # A convenience method that performs click-and-hold at the location of
-      # the source element, moves by a given offset, then releases the mouse.
-      #
-      # @example Drag and drop an element by offset
-      #
-      #   el = driver.find_element(id: "some_id1")
-      #   driver.action.drag_and_drop_by(el, 100, 100).perform
+      # Adds pauses for all devices but the given devices
       #
-      # @param [Selenium::WebDriver::Element] source Element to emulate button down at.
-      # @param [Integer] right_by horizontal move offset.
-      # @param [Integer] down_by vertical move offset.
-      # @return [ActionBuilder] A self reference.
+      # @param [Array[InputDevice]] action_devices Array of Input Devices performing an action in this tick.
       #
 
-      def drag_and_drop_by(source, right_by, down_by)
-        click_and_hold source
-        move_by        right_by, down_by
-        release
+      def tick(*action_devices)
+        return if @async
 
-        self
+        @devices.each { |device| device.create_pause unless action_devices.include? device }
       end
 
       #
-      # Executes the actions added to the builder.
+      # Adds an InputDevice
       #
 
-      def perform
-        @actions.each do |receiver, method, args|
-          @devices.fetch(receiver).__send__(method, *args)
-        end
+      def add_input(device)
+        device = Interactions.send(device) if device.is_a?(Symbol) && Interactions.respond_to?(device)
 
-        nil
+        raise TypeError, "#{device.inspect} is not a valid InputDevice" unless device.is_a?(Interactions::InputDevice)
+
+        unless @async
+          max_device = @devices.max { |a, b| a.actions.length <=> b.actions.length }
+          pauses(device: device, number: max_device.actions.length) if max_device
+        end
+        @devices << device
+        device
       end
     end # ActionBuilder
   end # WebDriver

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}", id: :process)
+        @pid = Process.spawn(*@command, options)
+        WebDriver.logger.debug("  -> pid: #{@pid}", id: :process)
+
+        Process.detach(@pid) if detach
+      end
+
+      def stop(timeout = 3)
+        return unless @pid
+        return if exited?
+
+        WebDriver.logger.debug("Sending TERM to process: #{@pid}", id: :process)
+        terminate(@pid)
+        poll_for_exit(timeout)
+
+        WebDriver.logger.debug("  -> stopped #{@pid}", id: :process)
+      rescue TimeoutError, Errno::EINVAL
+        WebDriver.logger.debug("    -> sending KILL to process: #{@pid}", id: :process)
+        kill(@pid)
+        wait
+        WebDriver.logger.debug("      -> killed #{@pid}", id: :process)
+      end
+
+      def alive?
+        @pid && !exited?
+      end
+
+      def exited?
+        return unless @pid
+
+        WebDriver.logger.debug("Checking if #{@pid} is exited:", id: :process)
+        _, @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}", id: :process)
+
+        !!exit_code
+      end
+
+      def poll_for_exit(timeout)
+        WebDriver.logger.debug("Polling #{timeout} seconds for exit of #{@pid}", id: :process)
+
+        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