selenium-webdriver 3.0.0.beta4.0 → 4.0.0.alpha5

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

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# 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
@@ -36,9 +36,7 @@ module Selenium
         end
 
         def add_extension(path)
-          unless File.file?(path)
-            raise Error::WebDriverError, "could not find extension at #{path.inspect}"
-          end
+          raise Error::WebDriverError, "could not find extension at #{path.inspect}" unless File.file?(path)
 
           @extensions << path
         end
@@ -79,8 +77,8 @@ module Selenium
 
           extensions.concat(@encoded_extensions)
 
-          opts = {directory: @directory || layout_on_disk}
-          opts[:extensions] = extensions if extensions
+          opts = {'directory' => directory || layout_on_disk}
+          opts['extensions'] = extensions if extensions.any?
           opts
         end
 
@@ -99,6 +97,7 @@ module Selenium
 
         def read_model_prefs
           return {} unless @model
+
           JSON.parse File.read(prefs_file_for(@model))
         end
 

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

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# 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
@@ -20,29 +20,29 @@
 module Selenium
   module WebDriver
     module Chrome
-      #
-      # @api private
-      #
-
       class Service < WebDriver::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://github.com/SeleniumHQ/selenium/wiki/ChromeDriver.
+        ERROR
+        SHUTDOWN_SUPPORTED = true
 
         private
 
-        def start_process
-          server_command = [@executable_path, "--port=#{@port}", *@extra_args]
-          @process       = ChildProcess.build(*server_command)
-
-          @process.io.inherit! if $DEBUG
-          @process.start
-        end
-
-        def stop_server
-          connect_to_server { |http| http.get('/shutdown') }
-        end
-
-        def cannot_connect_error_text
-          "unable to connect to chromedriver #{@host}:#{@port}"
+        # Note: This processing is deprecated
+        def extract_service_args(driver_opts)
+          driver_args = super
+          driver_opts = driver_opts.dup
+          driver_args << "--log-path=#{driver_opts.delete(:log_path)}" if driver_opts.key?(:log_path)
+          driver_args << "--url-base=#{driver_opts.delete(:url_base)}" if driver_opts.key?(:url_base)
+          driver_args << "--port-server=#{driver_opts.delete(:port_server)}" if driver_opts.key?(:port_server)
+          driver_args << "--whitelisted-ips=#{driver_opts.delete(:whitelisted_ips)}" if driver_opts.key?(:whitelisted_ips)
+          driver_args << "--verbose" if driver_opts.key?(:verbose)
+          driver_args << "--silent" if driver_opts.key?(:silent)
+          driver_args
         end
       end # Service
     end # Chrome

data/lib/selenium/webdriver/common.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# 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
@@ -17,7 +17,6 @@
 # specific language governing permissions and limitations
 # under the License.
 
-require 'selenium/webdriver/common/w3c_error'
 require 'selenium/webdriver/common/error'
 require 'selenium/webdriver/common/platform'
 require 'selenium/webdriver/common/proxy'
@@ -30,33 +29,42 @@ require 'selenium/webdriver/common/port_prober'
 require 'selenium/webdriver/common/zipper'
 require 'selenium/webdriver/common/wait'
 require 'selenium/webdriver/common/alert'
-require 'selenium/webdriver/common/mouse'
-require 'selenium/webdriver/common/keyboard'
-require 'selenium/webdriver/common/touch_screen'
 require 'selenium/webdriver/common/target_locator'
 require 'selenium/webdriver/common/navigation'
 require 'selenium/webdriver/common/timeouts'
 require 'selenium/webdriver/common/window'
+require 'selenium/webdriver/common/logger'
 require 'selenium/webdriver/common/logs'
-require 'selenium/webdriver/common/options'
+require 'selenium/webdriver/common/manager'
 require 'selenium/webdriver/common/search_context'
+require 'selenium/webdriver/common/interactions/key_actions'
+require 'selenium/webdriver/common/interactions/pointer_actions'
+require 'selenium/webdriver/common/interactions/interactions'
+require 'selenium/webdriver/common/interactions/input_device'
+require 'selenium/webdriver/common/interactions/interaction'
+require 'selenium/webdriver/common/interactions/none_input'
+require 'selenium/webdriver/common/interactions/key_input'
+require 'selenium/webdriver/common/interactions/pointer_input'
 require 'selenium/webdriver/common/action_builder'
-require 'selenium/webdriver/common/touch_action_builder'
 require 'selenium/webdriver/common/html5/shared_web_storage'
 require 'selenium/webdriver/common/html5/local_storage'
 require 'selenium/webdriver/common/html5/session_storage'
 require 'selenium/webdriver/common/driver_extensions/takes_screenshot'
 require 'selenium/webdriver/common/driver_extensions/rotatable'
-require 'selenium/webdriver/common/driver_extensions/has_input_devices'
 require 'selenium/webdriver/common/driver_extensions/has_web_storage'
+require 'selenium/webdriver/common/driver_extensions/downloads_files'
 require 'selenium/webdriver/common/driver_extensions/has_location'
 require 'selenium/webdriver/common/driver_extensions/has_session_id'
-require 'selenium/webdriver/common/driver_extensions/has_touch_screen'
 require 'selenium/webdriver/common/driver_extensions/has_remote_status'
+require 'selenium/webdriver/common/driver_extensions/has_network_conditions'
 require 'selenium/webdriver/common/driver_extensions/has_network_connection'
+require 'selenium/webdriver/common/driver_extensions/has_permissions'
+require 'selenium/webdriver/common/driver_extensions/has_debugger'
 require 'selenium/webdriver/common/driver_extensions/uploads_files'
+require 'selenium/webdriver/common/driver_extensions/has_addons'
+require 'selenium/webdriver/common/driver_extensions/has_devtools'
 require 'selenium/webdriver/common/keys'
-require 'selenium/webdriver/common/bridge_helper'
 require 'selenium/webdriver/common/profile_helper'
+require 'selenium/webdriver/common/options'
 require 'selenium/webdriver/common/driver'
 require 'selenium/webdriver/common/element'

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

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# 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
@@ -19,342 +19,194 @@
 
 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
-    # Selenium::WebDriver::DriverExtensions::HasInputDevices#action, which
-    # is available on Driver instances that support the user interaction API.
-    #
-    # @example
-    #
-    #  driver.action.key_down(:shift).
-    #                click(element).
-    #                click(second_element).
-    #                key_up(:shift).
-    #                drag_and_drop(element, third_element).
-    #                perform
-    #
-
     class ActionBuilder
-      #
-      # @api private
-      #
+      include KeyActions # Actions specific to key inputs
+      include PointerActions # Actions specific to pointer inputs
 
-      def initialize(mouse, keyboard)
-        @devices = {
-          mouse: mouse,
-          keyboard: keyboard
-        }
+      attr_reader :devices
 
-        @actions = []
-      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.
-      #
-      # Equivalent to:
-      #   driver.action.click(element).send_keys(key)
-      #   # or
-      #   driver.action.click.send_keys(key)
-      #
-      # @example Press a key
       #
-      #    driver.action.key_down(:control).perform
+      # 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.
       #
-      # @example Press a key on an element
-      #
-      #    el = driver.find_element(id: "some_id")
-      #    driver.action.key_down(el, :shift).perform
-      #
-      # @param [:shift, :alt, :control, :command, :meta] The key to press.
-      # @param [Selenium::WebDriver::Element] element An optional element
-      # @raise [ArgumentError] if the given key is not a modifier
+      # @param [Selenium::WebDriver::Remote::Bridge] bridge the bridge for the current driver instance
+      # @param [Selenium::WebDriver::Interactions::PointerInput] mouse PointerInput for the mouse.
+      # @param [Selenium::WebDriver::Interactions::KeyInput] keyboard KeyInput for the keyboard.
+      # @param [Boolean] async Whether to perform the actions asynchronously per device. Defaults to false for
+      #   backwards compatibility.
       # @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 initialize(bridge, mouse, keyboard, async = false)
+        # For backwards compatibility, automatically include mouse & keyboard
+        @bridge = bridge
+        @devices = [mouse, keyboard]
+        @async = async
       end
 
       #
-      # Performs a modifier key release.
-      # Releasing a non-depressed modifier key will yield undefined behaviour.
-      #
-      # @example Release a key
+      # Adds a PointerInput device of the given kind
       #
-      #   driver.action.key_up(:shift).perform
+      # @example Add a touch pointer input device
       #
-      # @example Release a key from an element
+      #    builder = device.action
+      #    builder.add_pointer_input('touch', :touch)
       #
-      #   el = driver.find_element(id: "some_id")
-      #   driver.action.key_up(el, :alt).perform
+      # @param [String] name name for the device
+      # @param [Symbol] kind kind of pointer device to create
+      # @return [Interactions::PointerInput] The pointer input added
       #
-      # @param [:shift, :alt, :control, :command, :meta] The modifier key to release.
-      # @param [Selenium::WebDriver::Element] element An optional element
-      # @raise [ArgumentError] if the given key is not a modifier key
-      # @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_pointer_input(kind, name)
+        new_input = Interactions.pointer(kind, name: name)
+        add_input(new_input)
+        new_input
       end
 
       #
-      # Sends keys to the active element. This differs from calling
-      # Element#send_keys(keys) on the active element in two ways:
-      #
-      # * 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.
+      # Adds a KeyInput device
       #
-      # @example Send the text "help" to an element
+      # @example Add a key input device
       #
-      #   el = driver.find_element(id: "some_id")
-      #   driver.action.send_keys(el, "help").perform
-      #
-      # @example Send the text "help" to the currently focused element
+      #    builder = device.action
+      #    builder.add_key_input('keyboard2')
       #
-      #   driver.action.send_keys("help").perform
+      # @param [String] name name for the device
+      # @return [Interactions::KeyInput] The key input added
       #
-      # @param [Selenium::WebDriver::Element] element An optional element
-      # @param [String] keys The keys to be sent.
-      # @return [ActionBuilder] A self reference.
-      #
-
-      def send_keys(*args)
-        @actions << [:mouse, :click, [args.shift]] if args.first.is_a? Element
 
-        @actions << [:keyboard, :send_keys, args]
-        self
+      def add_key_input(name)
+        new_input = Interactions.key(name)
+        add_input(new_input)
+        new_input
       end
 
       #
-      # Clicks (without releasing) in the middle of the given element. This is
-      # equivalent to:
-      #
-      #   driver.action.move_to(element).click_and_hold
-      #
-      # @example Clicking and holding on some element
+      # Retrieves the input device for the given name
       #
-      #    el = driver.find_element(id: "some_id")
-      #    driver.action.click_and_hold(el).perform
-      #
-      # @param [Selenium::WebDriver::Element] element the element to move to and click.
-      # @return [ActionBuilder] A self reference.
+      # @param [String] name name of the input device
+      # @return [Selenium::WebDriver::Interactions::InputDevice] input device with given name
       #
 
-      def click_and_hold(element = nil)
-        @actions << [:mouse, :down, [element]]
-        self
+      def get_device(name)
+        @devices.find { |device| device.name == name.to_s }
       end
 
       #
-      # Releases the depressed left mouse button at the current mouse location.
-      #
-      # @example Releasing an element after clicking and holding it
+      # Retrieves the current PointerInput devices
       #
-      #    el = driver.find_element(id: "some_id")
-      #    driver.action.click_and_hold(el).release.perform
-      #
-      # @return [ActionBuilder] A self reference.
+      # @return [Array] array of current PointerInput devices
       #
 
-      def release(element = nil)
-        @actions << [:mouse, :up, [element]]
-        self
+      def pointer_inputs
+        @devices.select { |device| device.type == Interactions::POINTER }
       end
 
       #
-      # Clicks in the middle of the given element. Equivalent to:
-      #
-      #   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
+      # Retrieves the current KeyInput device
       #
-      #    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 KeyInput device
       #
 
-      def click(element = nil)
-        @actions << [:mouse, :click, [element]]
-        self
+      def key_inputs
+        @devices.select { |device| device.type == Interactions::KEY }
       end
 
       #
-      # Performs a double-click at middle of the given element. Equivalent to:
+      # 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.
       #
-      #   driver.action.move_to(element).double_click
+      # @example Send keys to an element
       #
-      # @example Double click 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, duration = nil)
+        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.
+      # Creates multiple pauses for the given device of the given duration.
       #
-      # Note that when using offsets, both coordinates need to be passed.
-      #
-      # @example Scroll element into view and move the mouse to it
+      # @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).perform
-      #
-      # @example
+      #   driver.action.click(el).pauses(keyboard, 3).send_keys('keys').perform
       #
-      #   el = driver.find_element(id: "some_id")
-      #   driver.action.move_to(el, 100, 100).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, number, duration = nil)
+        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.map(&:encode).compact
+        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        target
-
-        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
+      # Adds pauses for all devices but the given devices
       #
-      #   el = driver.find_element(id: "some_id1")
-      #   driver.action.drag_and_drop_by(el, 100, 100).perform
-      #
-      # @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.
-      # @param [Selenium::WebDriver::Element] target Element to move to and release the
-      #   mouse at.
-      # @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)
+      def add_input(device)
+        unless @async
+          max_device = @devices.max { |a, b| a.actions.length <=> b.actions.length }
+          pauses(device, max_device.actions.length)
         end
-
-        nil
+        @devices << device
       end
     end # ActionBuilder
   end # WebDriver