selenium-webdriver 2.53.4 → 3.8.0

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

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # 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,107 +18,42 @@
 module Selenium
   module WebDriver
     module Chrome
-
       #
       # @api private
       #
 
-      class Service
-        START_TIMEOUT       = 20
-        SOCKET_LOCK_TIMEOUT = 45
-        STOP_TIMEOUT        = 5
-        DEFAULT_PORT        = 9515
-        MISSING_TEXT        = "Unable to find the chromedriver executable. Please download the server from http://chromedriver.storage.googleapis.com/index.html and place it somewhere on your PATH. More info at https://github.com/SeleniumHQ/selenium/wiki/ChromeDriver."
-
-        def self.executable_path
-          @executable_path ||= (
-            path = Platform.find_binary "chromedriver"
-            path or raise Error::WebDriverError, MISSING_TEXT
-            Platform.assert_executable path
-
-            path
-          )
-        end
-
-        def self.executable_path=(path)
-          Platform.assert_executable path
-          @executable_path = path
-        end
-
-        def self.default_service(*extra_args)
-          new executable_path, DEFAULT_PORT, *extra_args
-        end
-
-        def initialize(executable_path, port, *extra_args)
-          @executable_path = executable_path
-          @host            = Platform.localhost
-          @port            = Integer(port)
-
-          raise Error::WebDriverError, "invalid port: #{@port}" if @port < 1
-
-          @extra_args = extra_args
-        end
-
-        def start
-          Platform.exit_hook { stop } # make sure we don't leave the server running
-
-          socket_lock.locked do
-            find_free_port
-            start_process
-            connect_until_stable
-          end
-        end
-
-        def stop
-          return if @process.nil? || @process.exited?
-
-          Net::HTTP.start(@host, @port) do |http|
-            http.open_timeout = STOP_TIMEOUT / 2
-            http.read_timeout = STOP_TIMEOUT / 2
-
-            http.get("/shutdown")
-          end
-        ensure
-          stop_process
-        end
-
-        def uri
-          URI.parse "http://#{@host}:#{@port}"
-        end
+      class Service < WebDriver::Service
+        DEFAULT_PORT = 9515
+        @executable = 'chromedriver'.freeze
+        @missing_text = <<-ERROR.gsub(/\n +| {2,}/, ' ').freeze
+          Unable to find chromedriver. Please download the server from
+          http://chromedriver.storage.googleapis.com/index.html and place it somewhere on your PATH.
+          More info at https://github.com/SeleniumHQ/selenium/wiki/ChromeDriver.
+        ERROR
 
         private
 
-        def find_free_port
-          @port = PortProber.above @port
-        end
-
         def start_process
-          server_command = [@executable_path, "--port=#{@port}", *@extra_args]
-          @process       = ChildProcess.build(*server_command)
-
-          @process.io.inherit! if $DEBUG == true
+          @process = build_process(@executable_path, "--port=#{@port}", *@extra_args)
+          @process.leader = true unless Platform.windows?
           @process.start
         end
 
-        def stop_process
-          @process.poll_for_exit STOP_TIMEOUT
-        rescue ChildProcess::TimeoutError
-          @process.stop STOP_TIMEOUT
+        def cannot_connect_error_text
+          "unable to connect to chromedriver #{@host}:#{@port}"
         end
 
-        def connect_until_stable
-          socket_poller = SocketPoller.new @host, @port, START_TIMEOUT
-
-          unless socket_poller.connected?
-            raise Error::WebDriverError, "unable to connect to chromedriver #{@host}:#{@port}"
-          end
+        def extract_service_args(driver_opts)
+          driver_args = super
+          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
-
-        def socket_lock
-          @socket_lock ||= SocketLock.new(@port - 1, SOCKET_LOCK_TIMEOUT)
-        end
-
       end # Service
     end # Chrome
   end # WebDriver
-end # Service
+end # Selenium

data/lib/selenium/webdriver/common.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # 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,14 +15,12 @@
 # specific language governing permissions and limitations
 # under the License.
 
-require 'selenium/webdriver/common/core_ext/dir'
-require 'selenium/webdriver/common/core_ext/base64'
-require 'selenium/webdriver/common/w3c_error'
 require 'selenium/webdriver/common/error'
 require 'selenium/webdriver/common/platform'
 require 'selenium/webdriver/common/proxy'
 require 'selenium/webdriver/common/log_entry'
 require 'selenium/webdriver/common/file_reaper'
+require 'selenium/webdriver/common/service'
 require 'selenium/webdriver/common/socket_lock'
 require 'selenium/webdriver/common/socket_poller'
 require 'selenium/webdriver/common/port_prober'
@@ -38,17 +34,21 @@ 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/w3c_options'
 require 'selenium/webdriver/common/search_context'
 require 'selenium/webdriver/common/action_builder'
+require 'selenium/webdriver/common/interactions/key_actions'
+require 'selenium/webdriver/common/interactions/pointer_actions'
+require 'selenium/webdriver/common/w3c_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/has_location'
 require 'selenium/webdriver/common/driver_extensions/has_session_id'
@@ -56,6 +56,13 @@ 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_connection'
 require 'selenium/webdriver/common/driver_extensions/uploads_files'
+require 'selenium/webdriver/common/driver_extensions/has_addons'
+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/keys'
 require 'selenium/webdriver/common/bridge_helper'
 require 'selenium/webdriver/common/profile_helper'

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

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # 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,14 +17,11 @@
 
 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.
+    # This class should not be instantiated directly, but is created by Driver#action
     #
     # @example
     #
@@ -39,18 +34,17 @@ module Selenium
     #
 
     class ActionBuilder
-
       #
       # @api private
       #
 
       def initialize(mouse, keyboard)
-        @devices    = {
-          :mouse    => mouse,
-          :keyboard => keyboard
+        @devices = {
+          mouse: mouse,
+          keyboard: keyboard
         }
 
-        @actions  = []
+        @actions = []
       end
 
       #
@@ -70,19 +64,19 @@ module Selenium
       #
       # @example Press a key on an element
       #
-      #    el = driver.find_element(:id, "some_id")
+      #    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
+      # @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.
-      #
+      # @return [ActionBuilder] A self reference
 
       def key_down(*args)
-        if args.first.kind_of? Element
-          @actions << [:mouse, :click, [args.shift]]
-        end
+        @actions << [:mouse, :click, [args.shift]] if args.first.is_a? Element
 
         @actions << [:keyboard, :press, args]
         self
@@ -98,19 +92,20 @@ module Selenium
       #
       # @example Release a key from an element
       #
-      #   el = driver.find_element(:id, "some_id")
+      #   el = driver.find_element(id: "some_id")
       #   driver.action.key_up(el, :alt).perform
       #
-      # @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.
+      # @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)
-        if args.first.kind_of? Element
-          @actions << [:mouse, :click, [args.shift]]
-        end
+        @actions << [:mouse, :click, [args.shift]] if args.first.is_a? Element
 
         @actions << [:keyboard, :release, args]
         self
@@ -125,22 +120,23 @@ module Selenium
       #
       # @example Send the text "help" to an element
       #
-      #   el = driver.find_element(:id, "some_id")
+      #   el = driver.find_element(id: "some_id")
       #   driver.action.send_keys(el, "help").perform
       #
       # @example Send the text "help" to the currently focused element
       #
       #   driver.action.send_keys("help").perform
       #
-      # @param [Selenium::WebDriver::Element] element An optional element
-      # @param [String] keys The keys to be sent.
-      # @return [ActionBuilder] A self reference.
+      # @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
       #
 
       def send_keys(*args)
-        if args.first.kind_of? Element
-          @actions << [:mouse, :click, [args.shift]]
-        end
+        @actions << [:mouse, :click, [args.shift]] if args.first.is_a? Element
 
         @actions << [:keyboard, :send_keys, args]
         self
@@ -154,10 +150,10 @@ module Selenium
       #
       # @example Clicking and holding on some element
       #
-      #    el = driver.find_element(:id, "some_id")
+      #    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.
+      # @param [Element] element the element to move to and click.
       # @return [ActionBuilder] A self reference.
       #
 
@@ -171,7 +167,7 @@ module Selenium
       #
       # @example Releasing an element after clicking and holding it
       #
-      #    el = driver.find_element(:id, "some_id")
+      #    el = driver.find_element(id: "some_id")
       #    driver.action.click_and_hold(el).release.perform
       #
       # @return [ActionBuilder] A self reference.
@@ -191,7 +187,7 @@ module Selenium
       #
       # @example Clicking on an element
       #
-      #    el = driver.find_element(:id, "some_id")
+      #    el = driver.find_element(id: "some_id")
       #    driver.action.click(el).perform
       #
       # @example Clicking at the current mouse position
@@ -214,7 +210,7 @@ module Selenium
       #
       # @example Double click an element
       #
-      #    el = driver.find_element(:id, "some_id")
+      #    el = driver.find_element(id: "some_id")
       #    driver.action.double_click(el).perform
       #
       # @param [Selenium::WebDriver::Element] element An optional element to move to.
@@ -235,12 +231,12 @@ module Selenium
       #
       # @example Scroll element into view and move the mouse to it
       #
-      #   el = driver.find_element(:id, "some_id")
+      #   el = driver.find_element(id: "some_id")
       #   driver.action.move_to(el).perform
       #
       # @example
       #
-      #   el = driver.find_element(:id, "some_id")
+      #   el = driver.find_element(id: "some_id")
       #   driver.action.move_to(el, 100, 100).perform
       #
       # @param [Selenium::WebDriver::Element] element to move to.
@@ -252,11 +248,11 @@ module Selenium
       #
 
       def move_to(element, right_by = nil, down_by = nil)
-        if right_by && down_by
-          @actions << [:mouse, :move_to, [element, right_by, down_by]]
-        else
-          @actions << [:mouse, :move_to, [element]]
-        end
+        @actions << if right_by && down_by
+                      [:mouse, :move_to, [element, Integer(right_by), Integer(down_by)]]
+                    else
+                      [:mouse, :move_to, [element]]
+                    end
 
         self
       end
@@ -281,7 +277,7 @@ module Selenium
       #
 
       def move_by(right_by, down_by)
-        @actions << [:mouse, :move_by, [right_by, down_by]]
+        @actions << [:mouse, :move_by, [Integer(right_by), Integer(down_by)]]
         self
       end
 
@@ -291,7 +287,7 @@ module Selenium
       #
       # @example Context-click at middle of given element
       #
-      #   el = driver.find_element(:id, "some_id")
+      #   el = driver.find_element(id: "some_id")
       #   driver.action.context_click(el).perform
       #
       # @param [Selenium::WebDriver::Element] element An element to context click.
@@ -310,8 +306,8 @@ module Selenium
       #
       # @example Drag and drop one element onto another
       #
-      #   el1 = driver.find_element(:id, "some_id1")
-      #   el2 = driver.find_element(:id, "some_id2")
+      #   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.
@@ -334,14 +330,12 @@ module Selenium
       #
       # @example Drag and drop an element by offset
       #
-      #   el = driver.find_element(:id, "some_id1")
+      #   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.
       #
 
@@ -353,19 +347,17 @@ module Selenium
         self
       end
 
-
       #
       # Executes the actions added to the builder.
       #
 
       def perform
-        @actions.each { |receiver, method, args|
+        @actions.each do |receiver, method, args|
           @devices.fetch(receiver).__send__(method, *args)
-        }
+        end
 
         nil
       end
-
     end # ActionBuilder
   end # WebDriver
 end # Selenium