selenium-webdriver 3.141.0 → 3.142.7

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

@@ -1,3 +1,5 @@
+# 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
@@ -23,25 +25,10 @@ module Selenium
         port
       end
 
-      def self.random
-        # TODO: Avoid this
-        #
-        # (a) should pick a port that's guaranteed to be free on all interfaces
-        # (b) should pick a random port outside the ephemeral port range
-        #
-        WebDriver.logger.deprecate 'PortProber.random', 'PortProber.above(port)'
-
-        server = TCPServer.new(Platform.localhost, 0)
-        port   = server.addr[1]
-        server.close
-
-        port
-      end
-
-      IGNORED_ERRORS = [Errno::EADDRNOTAVAIL, Errno::EAFNOSUPPORT]
-      IGNORED_ERRORS << Errno::EBADF if Platform.cygwin?
-      IGNORED_ERRORS << Errno::EACCES if Platform.windows?
-      IGNORED_ERRORS.freeze
+      IGNORED_ERRORS = [Errno::EADDRNOTAVAIL, Errno::EAFNOSUPPORT].tap { |arr|
+        arr << Errno::EBADF if Platform.cygwin?
+        arr << Errno::EACCES if Platform.windows?
+      }.freeze
 
       def self.free?(port)
         Platform.interfaces.each do |host|

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

@@ -1,3 +1,5 @@
+# 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

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

@@ -1,3 +1,5 @@
+# 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
@@ -35,7 +37,8 @@ module Selenium
                  auto_detect: 'autodetect',
                  socks: 'socksProxy',
                  socks_username: 'socksUsername',
-                 socks_password: 'socksPassword'}.freeze
+                 socks_password: 'socksPassword',
+                 socks_version: 'socksVersion'}.freeze
 
       ALLOWED.each_key { |t| attr_reader t }
 
@@ -64,6 +67,7 @@ module Selenium
         end
 
         return if not_allowed.empty?
+
         raise ArgumentError, "unknown option#{'s' if not_allowed.size != 1}: #{not_allowed.inspect}"
       end
 
@@ -117,10 +121,13 @@ module Selenium
         @socks_password = value
       end
 
+      def socks_version=(value)
+        self.type = :manual
+        @socks_version = value
+      end
+
       def type=(type)
-        unless TYPES.key? type
-          raise ArgumentError, "invalid proxy type: #{type.inspect}, expected one of #{TYPES.keys.inspect}"
-        end
+        raise ArgumentError, "invalid proxy type: #{type.inspect}, expected one of #{TYPES.keys.inspect}" unless TYPES.key? type
 
         if defined?(@type) && type != @type
           raise ArgumentError, "incompatible proxy type #{type.inspect} (already set to #{@type.inspect})"
@@ -140,7 +147,8 @@ module Selenium
           'autodetect' => auto_detect,
           'socksProxy' => socks,
           'socksUsername' => socks_username,
-          'socksPassword' => socks_password
+          'socksPassword' => socks_password,
+          'socksVersion' => socks_version
         }.delete_if { |_k, v| v.nil? }
 
         json_result if json_result.length > 1

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

@@ -1,3 +1,5 @@
+# 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
@@ -58,7 +60,7 @@ module Selenium
         raise ArgumentError, "cannot find element by #{how.inspect}" unless by
 
         bridge.find_element_by by, what.to_s, ref
-      rescue Selenium::WebDriver::Error::TimeOutError
+      rescue Selenium::WebDriver::Error::TimeoutError
         # Implicit Wait times out in Edge
         raise Selenium::WebDriver::Error::NoSuchElementError
       end
@@ -76,7 +78,7 @@ module Selenium
         raise ArgumentError, "cannot find elements by #{how.inspect}" unless by
 
         bridge.find_elements_by by, what.to_s, ref
-      rescue Selenium::WebDriver::Error::TimeOutError
+      rescue Selenium::WebDriver::Error::TimeoutError
         # Implicit Wait times out in Edge
         []
       end
@@ -90,15 +92,11 @@ module Selenium
         when 1
           arg = args.first
 
-          unless arg.respond_to?(:shift)
-            raise ArgumentError, "expected #{arg.inspect}:#{arg.class} to respond to #shift"
-          end
+          raise ArgumentError, "expected #{arg.inspect}:#{arg.class} to respond to #shift" unless arg.respond_to?(:shift)
 
           # this will be a single-entry hash, so use #shift over #first or #[]
           arr = arg.dup.shift
-          unless arr.size == 2
-            raise ArgumentError, "expected #{arr.inspect} to have 2 elements"
-          end
+          raise ArgumentError, "expected #{arr.inspect} to have 2 elements" unless arr.size == 2
 
           arr
         else

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

@@ -1,3 +1,5 @@
+# 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
@@ -21,50 +23,87 @@ module Selenium
     # Base class implementing default behavior of service object,
     # responsible for starting and stopping driver implementations.
     #
-    # Subclasses must implement the following private methods:
-    #   * #start_process
-    #   * #stop_server
-    #   * #cannot_connect_error_text
-    #
-    # @api private
-    #
 
     class Service
-      START_TIMEOUT       = 20
+      START_TIMEOUT = 20
       SOCKET_LOCK_TIMEOUT = 45
-      STOP_TIMEOUT        = 20
+      STOP_TIMEOUT = 20
 
+      @default_port = nil
+      @driver_path = nil
       @executable = nil
       @missing_text = nil
 
       class << self
-        attr_reader :executable, :missing_text
+        attr_reader :default_port, :driver_path, :executable, :missing_text, :shutdown_supported
+
+        def chrome(**opts)
+          Chrome::Service.new(**opts)
+        end
+
+        def firefox(**opts)
+          binary_path = Firefox::Binary.path
+          args = opts.delete(:args)
+          case args
+          when Hash
+            args[:binary] ||= binary_path
+            opts[:args] = args
+          when Array
+            opts[:args] = ["--binary=#{binary_path}"]
+            opts[:args] += args
+          else
+            opts[:args] = ["--binary=#{binary_path}"]
+          end
+
+          Firefox::Service.new(**opts)
+        end
+
+        def ie(**opts)
+          IE::Service.new(**opts)
+        end
+        alias_method :internet_explorer, :ie
+
+        def edge(**opts)
+          Edge::Service.new(**opts)
+        end
+
+        def safari(**opts)
+          Safari::Service.new(**opts)
+        end
+
+        def driver_path=(path)
+          Platform.assert_executable path if path.is_a?(String)
+          @driver_path = path
+        end
       end
 
       attr_accessor :host
+      attr_reader :executable_path
 
-      def initialize(executable_path, port, driver_opts)
-        @executable_path = binary_path(executable_path)
-        @host            = Platform.localhost
-        @port            = Integer(port)
-        @extra_args      = extract_service_args(driver_opts)
+      #
+      # End users should use a class method for the desired driver, rather than using this directly.
+      #
+      # @api private
+      #
 
-        raise Error::WebDriverError, "invalid port: #{@port}" if @port < 1
-      end
+      def initialize(path: nil, port: nil, args: nil)
+        path ||= self.class.driver_path
+        port ||= self.class.default_port
+        args ||= []
 
-      def binary_path(path)
-        path = Platform.find_binary(self.class.executable) if path.nil?
-        raise Error::WebDriverError, self.class.missing_text unless path
-        Platform.assert_executable path
-        path
+        @executable_path = binary_path(path)
+        @host = Platform.localhost
+        @port = Integer(port)
+
+        @extra_args = args.is_a?(Hash) ? extract_service_args(args) : args
+
+        raise Error::WebDriverError, "invalid port: #{@port}" if @port < 1
       end
 
       def start
-        if process_running?
-          raise "already started: #{uri.inspect} #{@executable_path.inspect}"
-        end
+        raise "already started: #{uri.inspect} #{@executable_path.inspect}" if process_running?
 
-        Platform.exit_hook { stop } # make sure we don't leave the server running
+        Platform.exit_hook(&method(:stop)) # make sure we don't leave the server running
 
         socket_lock.locked do
           find_free_port
@@ -74,9 +113,12 @@ module Selenium
       end
 
       def stop
+        return unless self.class.shutdown_supported
+
         stop_server
         @process.poll_for_exit STOP_TIMEOUT
       rescue ChildProcess::TimeoutError
+        nil # noop
       ensure
         stop_process
       end
@@ -87,6 +129,16 @@ module Selenium
 
       private
 
+      def binary_path(path = nil)
+        path = path.call if path.is_a?(Proc)
+        path ||= Platform.find_binary(self.class.executable)
+
+        raise Error::WebDriverError, self.class.missing_text unless path
+
+        Platform.assert_executable path
+        path
+      end
+
       def build_process(*command)
         WebDriver.logger.debug("Executing Process #{command}")
         @process = ChildProcess.build(*command)
@@ -114,22 +166,27 @@ module Selenium
       end
 
       def start_process
-        raise NotImplementedError, 'subclass responsibility'
+        @process = build_process(@executable_path, "--port=#{@port}", *@extra_args)
+        # Note: this is a bug only in Windows 7
+        @process.leader = true unless Platform.windows?
+        @process.start
       end
 
       def stop_process
         return if process_exited?
+
         @process.stop STOP_TIMEOUT
         @process.io.stdout.close if Platform.jruby? && !WebDriver.logger.debug?
       end
 
       def stop_server
         return if process_exited?
+
         connect_to_server { |http| http.get('/shutdown') }
       end
 
       def process_running?
-        defined?(@process) && @process && @process.alive?
+        defined?(@process) && @process&.alive?
       end
 
       def process_exited?
@@ -139,11 +196,12 @@ module Selenium
       def connect_until_stable
         socket_poller = SocketPoller.new @host, @port, START_TIMEOUT
         return if socket_poller.connected?
+
         raise Error::WebDriverError, cannot_connect_error_text
       end
 
       def cannot_connect_error_text
-        raise NotImplementedError, 'subclass responsibility'
+        "unable to connect to #{self.class.executable} #{@host}:#{@port}"
       end
 
       def socket_lock

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

@@ -1,3 +1,5 @@
+# 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
@@ -45,16 +47,21 @@ module Selenium
       private
 
       def lock
-        max_time = Time.now + @timeout
+        max_time = current_time + @timeout
 
-        sleep 0.1 until can_lock? || Time.now >= max_time
+        sleep 0.1 until can_lock? || current_time >= max_time
 
         return if did_lock?
+
         raise Error::WebDriverError, "unable to bind to locking port #{@port} within #{@timeout} seconds"
       end
 
+      def current_time
+        Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      end
+
       def release
-        @server && @server.close
+        @server&.close
       end
 
       def can_lock?

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

@@ -1,3 +1,5 @@
+# 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
@@ -54,12 +56,14 @@ module Selenium
 
       CONNECT_TIMEOUT = 5
 
-      NOT_CONNECTED_ERRORS = [Errno::ECONNREFUSED, Errno::ENOTCONN, SocketError]
-      NOT_CONNECTED_ERRORS << Errno::EPERM if Platform.cygwin?
+      NOT_CONNECTED_ERRORS = [Errno::ECONNREFUSED, Errno::ENOTCONN, SocketError].tap { |arr|
+        arr << Errno::EPERM if Platform.cygwin?
+      }.freeze
 
-      CONNECTED_ERRORS = [Errno::EISCONN]
-      CONNECTED_ERRORS << Errno::EINVAL if Platform.windows?
-      CONNECTED_ERRORS << Errno::EALREADY if Platform.wsl?
+      CONNECTED_ERRORS = [Errno::EISCONN].tap { |arr|
+        arr << Errno::EINVAL if Platform.windows?
+        arr << Errno::EALREADY if Platform.wsl?
+      }.freeze
 
       if Platform.jruby?
         # we use a plain TCPSocket here since JRuby has issues select()ing on a connecting socket
@@ -79,7 +83,7 @@ module Selenium
           begin
             sock.connect_nonblock sockaddr
           rescue Errno::EINPROGRESS
-            retry if IO.select(nil, [sock], nil, CONNECT_TIMEOUT)
+            retry if socket_writable?(sock) && conn_completed?(sock)
             raise Errno::ECONNREFUSED
           rescue *CONNECTED_ERRORS
             # yay!
@@ -88,30 +92,34 @@ module Selenium
           sock.close
           true
         rescue *NOT_CONNECTED_ERRORS
-          sock.close if sock
+          sock&.close
           WebDriver.logger.debug("polling for socket on #{[@host, @port].inspect}")
           false
         end
       end
 
+      def socket_writable?(sock)
+        IO.select(nil, [sock], nil, CONNECT_TIMEOUT)
+      end
+
+      def conn_completed?(sock)
+        sock.getsockopt(Socket::SOL_SOCKET, Socket::SO_ERROR).int.zero?
+      end
+
       def with_timeout
-        max_time = time_now + @timeout
+        max_time = current_time + @timeout
 
-        (
+        until current_time > max_time
           return true if yield
-          wait
-        ) until time_now > max_time
 
-        false
-      end
+          sleep @interval
+        end
 
-      def wait
-        sleep @interval
+        false
       end
 
-      # for testability
-      def time_now
-        Time.now
+      def current_time
+        Process.clock_gettime(Process::CLOCK_MONOTONIC)
       end
     end # SocketPoller
   end # WebDriver

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

@@ -1,3 +1,5 @@
+# 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
@@ -55,10 +57,10 @@ module Selenium
       def window(id)
         if block_given?
           original = begin
-            @bridge.window_handle
-          rescue Error::NoSuchWindowError
-            nil
-          end
+                       @bridge.window_handle
+                     rescue Error::NoSuchWindowError
+                       nil
+                     end
 
           unless @bridge.window_handles.include? id
             raise Error::NoSuchWindowError, "The specified identifier '#{id}' is not found in the window handle list"

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

@@ -1,3 +1,5 @@
+# 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

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

@@ -1,3 +1,5 @@
+# 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
@@ -23,23 +25,20 @@ module Selenium
       #
 
       def initialize(mouse, keyboard, touch_screen)
+        WebDriver.logger.deprecate(self.class.name)
         super(mouse, keyboard)
         @devices[:touch_screen] = touch_screen
       end
 
       def scroll(*args)
-        unless [2, 3].include? args.size
-          raise ArgumentError, "wrong number of arguments, expected 2..3, got #{args.size}"
-        end
+        raise ArgumentError, "wrong number of arguments, expected 2..3, got #{args.size}" unless [2, 3].include? args.size
 
         @actions << [:touch_screen, :scroll, args]
         self
       end
 
       def flick(*args)
-        unless [2, 4].include? args.size
-          raise ArgumentError, "wrong number of arguments, expected 2 or 4, got #{args.size}"
-        end
+        raise ArgumentError, "wrong number of arguments, expected 2 or 4, got #{args.size}" unless [2, 4].include? args.size
 
         @actions << [:touch_screen, :flick, args]
         self

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

@@ -1,3 +1,5 @@
+# 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
@@ -82,7 +84,7 @@ module Selenium
 
           assert_element element
 
-          if (speed.is_a?(String) || speed.is_a?(Symbol)) && FLICK_SPEED.keys.include?(speed.to_sym)
+          if (speed.is_a?(String) || speed.is_a?(Symbol)) && FLICK_SPEED.key?(speed.to_sym)
             WebDriver.logger.deprecate "Passing #{speed.inspect} speed",
                                        "Integer or Selenium::WebDriver::TouchScreen::FLICK_SPEED[:#{speed}]"
             speed = FLICK_SPEED[speed.to_sym]
@@ -113,6 +115,7 @@ module Selenium
 
       def assert_element(element)
         return if element.is_a? Element
+
         raise TypeError, "expected #{Element}, got #{element.inspect}:#{element.class}"
       end
     end # TouchScreen

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

@@ -1,3 +1,5 @@
+# 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
@@ -190,6 +192,7 @@ module Selenium
 
       def tick(*action_devices)
         return if @async
+
         @devices.each { |device| device.create_pause unless action_devices.include? device }
       end
 

data/lib/selenium/webdriver/common/{w3c_options.rb → w3c_manager.rb}

@@ -1,3 +1,5 @@
+# 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 +19,7 @@
 
 module Selenium
   module WebDriver
-    class W3COptions < Options
+    class W3CManager < Manager
 
       #
       # Get the cookie with the given name

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

@@ -1,3 +1,5 @@
+# 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
@@ -41,15 +43,15 @@ module Selenium
       #
       # Wait until the given block returns a true value.
       #
-      # @raise [Error::TimeOutError]
+      # @raise [Error::TimeoutError]
       # @return [Object] the result of the block
       #
 
       def until
-        end_time = Time.now + @timeout
+        end_time = current_time + @timeout
         last_error = nil
 
-        until Time.now > end_time
+        until current_time > end_time
           begin
             result = yield
             return result if result
@@ -63,12 +65,18 @@ module Selenium
         msg = if @message
                 @message.dup
               else
-                "timed out after #{@timeout} seconds"
+                +"timed out after #{@timeout} seconds"
               end
 
         msg << " (#{last_error.message})" if last_error
 
-        raise Error::TimeOutError, msg
+        raise Error::TimeoutError, msg
+      end
+
+      private
+
+      def current_time
+        Process.clock_gettime(Process::CLOCK_MONOTONIC)
       end
     end # Wait
   end # WebDriver

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

@@ -1,3 +1,5 @@
+# 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

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

@@ -1,3 +1,5 @@
+# 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
@@ -50,9 +52,7 @@ module Selenium
         def zip(path)
           with_tmp_zip do |zip|
             ::Find.find(path) do |file|
-              unless File.directory?(file)
-                add_zip_entry zip, file, file.sub("#{path}/", '')
-              end
+              add_zip_entry zip, file, file.sub("#{path}/", '') unless File.directory?(file)
             end
 
             zip.commit

data/lib/selenium/webdriver/common.rb

@@ -1,3 +1,5 @@
+# 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,8 +38,8 @@ 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/manager'
+require 'selenium/webdriver/common/w3c_manager'
 require 'selenium/webdriver/common/search_context'
 require 'selenium/webdriver/common/action_builder'
 require 'selenium/webdriver/common/interactions/key_actions'
@@ -70,5 +72,6 @@ require 'selenium/webdriver/common/interactions/pointer_input'
 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/edge/bridge.rb

@@ -1,3 +1,5 @@
+# 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