selenium-webdriver 3.12.0 → 3.142.7

data/lib/selenium/webdriver/remote/response.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
@@ -20,7 +22,7 @@ module Selenium
     module Remote
       # @api private
       class Response
-        STACKTRACE_KEY = 'stackTrace'.freeze
+        STACKTRACE_KEY = 'stackTrace'
 
         attr_reader :code, :payload
         attr_writer :payload
@@ -49,6 +51,7 @@ module Selenium
           when Hash
             msg = val['message']
             return 'unknown error' unless msg
+
             msg << ": #{val['alert']['text'].inspect}" if val['alert'].is_a?(Hash) && val['alert']['text']
             msg << " (#{val['class']})" if val['class']
             msg
@@ -69,12 +72,15 @@ module Selenium
           e = error
           raise e if e
           return unless @code.nil? || @code >= 400
+
           raise Error::ServerError, self
         end
 
         def add_backtrace(ex)
           return unless error_payload.is_a?(Hash)
 
+          # Legacy Firefox returns String in ['value'], while we expect Hash.
+          # Use #dig when Firefox legacy is removed (4.0).
           server_trace = error_payload[STACKTRACE_KEY] ||
                          error_payload[STACKTRACE_KEY.downcase] ||
                          (error_payload['value'] && error_payload['value'][STACKTRACE_KEY])
@@ -91,7 +97,7 @@ module Selenium
         end
 
         def backtrace_from_remote(server_trace)
-          server_trace.map do |frame|
+          server_trace.map { |frame|
             next unless frame.is_a?(Hash)
 
             file = frame['fileName']
@@ -104,7 +110,7 @@ module Selenium
             meth = 'unknown' if meth.nil? || meth.empty?
 
             "[remote server] #{file}:#{line}:in `#{meth}'"
-          end.compact
+          }.compact
         end
 
         def error_payload
@@ -115,11 +121,13 @@ module Selenium
 
         def status
           return unless error_payload.is_a? Hash
+
           @status ||= error_payload['status'] || error_payload['error']
         end
 
         def value
           return unless error_payload.is_a? Hash
+
           @value ||= error_payload['value'] || error_payload['message']
         end
       end # Response

data/lib/selenium/webdriver/remote/server_error.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/remote/w3c/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
@@ -42,7 +44,7 @@ module Selenium
 
           def commands(command)
             case command
-            when :status, :is_element_displayed
+            when :status
               Remote::OSS::Bridge::COMMANDS[command]
             else
               COMMANDS[command]
@@ -116,6 +118,20 @@ module Selenium
                               'return source;')
           end
 
+          #
+          # Create a new top-level browsing context
+          # https://w3c.github.io/webdriver/#new-window
+          # @param type [String] Supports two values: 'tab' and 'window'.
+          #  Use 'tab' if you'd like the new window to share an OS-level window
+          #  with the current browsing context.
+          #  Use 'window' otherwise
+          # @return [Hash] Containing 'handle' with the value of the window handle
+          #  and 'type' with the value of the created window type
+          #
+          def new_window(type)
+            execute :new_window, {}, {type: type}
+          end
+
           def switch_to_window(name)
             execute :switch_to_window, {}, {handle: name}
           end
@@ -162,16 +178,14 @@ module Selenium
           end
 
           def resize_window(width, height, handle = :current)
-            unless handle == :current
-              raise Error::WebDriverError, 'Switch to desired window before changing its size'
-            end
+            raise Error::WebDriverError, 'Switch to desired window before changing its size' unless handle == :current
+
             set_window_rect(width: width, height: height)
           end
 
           def window_size(handle = :current)
-            unless handle == :current
-              raise Error::UnsupportedOperationError, 'Switch to desired window before getting its size'
-            end
+            raise Error::UnsupportedOperationError, 'Switch to desired window before getting its size' unless handle == :current
+
             data = execute :get_window_rect
 
             Dimension.new data['width'], data['height']
@@ -182,9 +196,8 @@ module Selenium
           end
 
           def maximize_window(handle = :current)
-            unless handle == :current
-              raise Error::UnsupportedOperationError, 'Switch to desired window before changing its size'
-            end
+            raise Error::UnsupportedOperationError, 'Switch to desired window before changing its size' unless handle == :current
+
             execute :maximize_window
           end
 
@@ -203,7 +216,7 @@ module Selenium
 
           def set_window_rect(x: nil, y: nil, width: nil, height: nil)
             params = {x: x, y: y, width: width, height: height}
-            params.update(params) { |k, v| Integer(v) unless v.nil? }
+            params.update(params) { |_k, v| Integer(v) unless v.nil? }
             execute :set_window_rect, {}, params
           end
 
@@ -302,8 +315,8 @@ module Selenium
           # cookies
           #
 
-          def options
-            @options ||= WebDriver::W3COptions.new(self)
+          def manage
+            @manage ||= WebDriver::W3CManager.new(self)
           end
 
           def add_cookie(cookie)
@@ -358,13 +371,30 @@ module Selenium
             execute :element_click, id: element
           end
 
-          # TODO: - Implement file verification
           def send_keys_to_element(element, keys)
+            # TODO: rework file detectors before Selenium 4.0
+            if @file_detector
+              local_files = keys.first.split("\n").map { |key| @file_detector.call(Array(key)) }.compact
+              if local_files.any?
+                keys = local_files.map { |local_file| upload(local_file) }
+                keys = Array(keys.join("\n"))
+              end
+            end
+
             # Keep .split(//) for backward compatibility for now
             text = keys.join('')
             execute :element_send_keys, {id: element}, {value: text.split(//), text: text}
           end
 
+          def upload(local_file)
+            unless File.file?(local_file)
+              WebDriver.logger.debug("File detector only works with files. #{local_file.inspect} isn`t a file!")
+              raise Error::WebDriverError, "You are trying to work with something that isn't a file."
+            end
+
+            execute :upload_file, {}, {file: Zipper.zip_file(local_file)}
+          end
+
           def clear_element(element)
             execute :element_clear, id: element
           end
@@ -442,6 +472,7 @@ module Selenium
           end
 
           def element_attribute(element, name)
+            WebDriver.logger.info "Using script for :getAttribute of #{name}"
             execute_atom :getAttribute, element, name
           end
 
@@ -489,7 +520,8 @@ module Selenium
           end
 
           def element_displayed?(element)
-            execute :is_element_displayed, id: element
+            WebDriver.logger.info 'Using script for :isDisplayed'
+            execute_atom :isDisplayed, element
           end
 
           def element_value_of_css_property(element, prop)
@@ -552,7 +584,7 @@ module Selenium
             [how, what]
           end
 
-          ESCAPE_CSS_REGEXP = /(['"\\#.:;,!?+<>=~*^$|%&@`{}\-\[\]\(\)])/
+          ESCAPE_CSS_REGEXP = /(['"\\#.:;,!?+<>=~*^$|%&@`{}\-\[\]\(\)])/.freeze
           UNICODE_CODE_POINT = 30
 
           # Escapes invalid characters in CSS selector.

data/lib/selenium/webdriver/remote/w3c/capabilities.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
@@ -29,7 +31,7 @@ module Selenium
 
         class Capabilities
 
-          EXTENSION_CAPABILITY_PATTERN = /\A[\w-]+:.*\z/
+          EXTENSION_CAPABILITY_PATTERN = /\A[\w-]+:.*\z/.freeze
 
           KNOWN = [
             :browser_name,
@@ -41,18 +43,19 @@ module Selenium
             :set_window_rect,
             :timeouts,
             :unhandled_prompt_behavior,
+            :strict_file_interactability,
 
             # remote-specific
             :remote_session_id,
 
-            # TODO (alex): deprecate in favor of Firefox::Options?
+            # TODO: (alex) deprecate in favor of Firefox::Options?
             :accessibility_checks,
             :device,
 
-            # TODO (alex): deprecate compatibility with OSS-capabilities
+            # TODO: (alex) deprecate compatibility with OSS-capabilities
             :implicit_timeout,
             :page_load_timeout,
-            :script_timeout,
+            :script_timeout
           ].freeze
 
           KNOWN.each do |key|
@@ -60,7 +63,15 @@ module Selenium
               @capabilities.fetch(key)
             end
 
+            next if key == :proxy
+
             define_method "#{key}=" do |value|
+              case key
+              when :accessibility_checks
+                WebDriver.logger.deprecate(":accessibility_checks capability")
+              when :device
+                WebDriver.logger.deprecate(":device capability")
+              end
               @capabilities[key] = value
             end
           end
@@ -80,20 +91,15 @@ module Selenium
 
           class << self
             def edge(opts = {})
-              new({
-                browser_name: 'MicrosoftEdge',
-                platform: :windows
-              }.merge(opts))
+              WebDriver.logger.deprecate('Selenium::WebDriver::Remote::W3C::Capabilities.edge',
+                                         'Selenium::WebDriver::Remote::Capabilities.edge')
+              Remote::Capabilities.edge(opts)
             end
 
             def firefox(opts = {})
-              opts[:browser_version] = opts.delete(:version) if opts.key?(:version)
-              opts[:platform_name] = opts.delete(:platform) if opts.key?(:platform)
-              opts[:timeouts] = {}
-              opts[:timeouts]['implicit'] = opts.delete(:implicit_timeout) if opts.key?(:implicit_timeout)
-              opts[:timeouts]['pageLoad'] = opts.delete(:page_load_timeout) if opts.key?(:page_load_timeout)
-              opts[:timeouts]['script'] = opts.delete(:script_timeout) if opts.key?(:script_timeout)
-              new({browser_name: 'firefox', marionette: true}.merge(opts))
+              WebDriver.logger.deprecate('Selenium::WebDriver::Remote::W3C::Capabilities.firefox',
+                                         'Selenium::WebDriver::Remote::Capabilities.firefox')
+              Remote::Capabilities.firefox(opts)
             end
 
             alias_method :ff, :firefox
@@ -139,10 +145,10 @@ module Selenium
             # @param oss_capabilities [Hash, Remote::Capabilities]
             #
 
-            def from_oss(oss_capabilities)
+            def from_oss(oss_capabilities) # rubocop:disable Metrics/MethodLength
               w3c_capabilities = new
 
-              # TODO (alex): make capabilities enumerable?
+              # TODO: (alex) make capabilities enumerable?
               oss_capabilities = oss_capabilities.__send__(:capabilities) unless oss_capabilities.is_a?(Hash)
               oss_capabilities.each do |name, value|
                 next if value.nil?
@@ -162,11 +168,23 @@ module Selenium
 
               # User can pass :firefox_options or :firefox_profile.
               #
-              # TODO (alex): Refactor this whole method into converter class.
+              # TODO: (alex) Refactor this whole method into converter class.
               firefox_options = oss_capabilities['firefoxOptions'] || oss_capabilities['firefox_options'] || oss_capabilities[:firefox_options]
               firefox_profile = oss_capabilities['firefox_profile'] || oss_capabilities[:firefox_profile]
               firefox_binary  = oss_capabilities['firefox_binary'] || oss_capabilities[:firefox_binary]
 
+              if firefox_options
+                WebDriver.logger.deprecate(':firefox_options capabilitiy', 'Selenium::WebDriver::Firefox::Options')
+              end
+
+              if firefox_profile
+                WebDriver.logger.deprecate(':firefox_profile capabilitiy', 'Selenium::WebDriver::Firefox::Options#profile')
+              end
+
+              if firefox_binary
+                WebDriver.logger.deprecate(':firefox_binary capabilitiy', 'Selenium::WebDriver::Firefox::Options#binary')
+              end
+
               if firefox_profile && firefox_options
                 second_profile = firefox_options['profile'] || firefox_options[:profile]
                 if second_profile && firefox_profile != second_profile
@@ -249,9 +267,7 @@ module Selenium
                 if value
                   hash['proxy'] = value.as_json
                   hash['proxy']['proxyType'] &&= hash['proxy']['proxyType'].downcase
-                  if hash['proxy']['noProxy'].is_a?(String)
-                    hash['proxy']['noProxy'] = hash['proxy']['noProxy'].split(', ')
-                  end
+                  hash['proxy']['noProxy'] = hash['proxy']['noProxy'].split(', ') if hash['proxy']['noProxy'].is_a?(String)
                 end
               when String, :firefox_binary
                 hash[key.to_s] = value
@@ -271,6 +287,7 @@ module Selenium
 
           def ==(other)
             return false unless other.is_a? self.class
+
             as_json == other.as_json
           end
 

data/lib/selenium/webdriver/remote/w3c/commands.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
@@ -32,113 +34,120 @@ module Selenium
             # session handling
             #
 
-            new_session: [:post, 'session'.freeze],
-            delete_session: [:delete, 'session/:session_id'.freeze],
+            new_session: [:post, 'session'],
+            delete_session: [:delete, 'session/:session_id'],
 
             #
             # basic driver
             #
 
-            get: [:post, 'session/:session_id/url'.freeze],
-            get_current_url: [:get, 'session/:session_id/url'.freeze],
-            back: [:post, 'session/:session_id/back'.freeze],
-            forward: [:post, 'session/:session_id/forward'.freeze],
-            refresh: [:post, 'session/:session_id/refresh'.freeze],
-            get_title: [:get, 'session/:session_id/title'.freeze],
+            get: [:post, 'session/:session_id/url'],
+            get_current_url: [:get, 'session/:session_id/url'],
+            back: [:post, 'session/:session_id/back'],
+            forward: [:post, 'session/:session_id/forward'],
+            refresh: [:post, 'session/:session_id/refresh'],
+            get_title: [:get, 'session/:session_id/title'],
 
             #
             # window and Frame handling
             #
 
-            get_window_handle: [:get, 'session/:session_id/window'.freeze],
-            close_window: [:delete, 'session/:session_id/window'.freeze],
-            switch_to_window: [:post, 'session/:session_id/window'.freeze],
-            get_window_handles: [:get, 'session/:session_id/window/handles'.freeze],
-            fullscreen_window: [:post, 'session/:session_id/window/fullscreen'.freeze],
-            minimize_window: [:post, 'session/:session_id/window/minimize'.freeze],
-            maximize_window: [:post, 'session/:session_id/window/maximize'.freeze],
-            set_window_size: [:post, 'session/:session_id/window/size'.freeze],
-            get_window_size: [:get, 'session/:session_id/window/size'.freeze],
-            set_window_position: [:post, 'session/:session_id/window/position'.freeze],
-            get_window_position: [:get, 'session/:session_id/window/position'.freeze],
-            set_window_rect: [:post, 'session/:session_id/window/rect'.freeze],
-            get_window_rect: [:get, 'session/:session_id/window/rect'.freeze],
-            switch_to_frame: [:post, 'session/:session_id/frame'.freeze],
-            switch_to_parent_frame: [:post, 'session/:session_id/frame/parent'.freeze],
+            get_window_handle: [:get, 'session/:session_id/window'],
+            new_window: [:post, 'session/:session_id/window/new'],
+            close_window: [:delete, 'session/:session_id/window'],
+            switch_to_window: [:post, 'session/:session_id/window'],
+            get_window_handles: [:get, 'session/:session_id/window/handles'],
+            fullscreen_window: [:post, 'session/:session_id/window/fullscreen'],
+            minimize_window: [:post, 'session/:session_id/window/minimize'],
+            maximize_window: [:post, 'session/:session_id/window/maximize'],
+            set_window_size: [:post, 'session/:session_id/window/size'],
+            get_window_size: [:get, 'session/:session_id/window/size'],
+            set_window_position: [:post, 'session/:session_id/window/position'],
+            get_window_position: [:get, 'session/:session_id/window/position'],
+            set_window_rect: [:post, 'session/:session_id/window/rect'],
+            get_window_rect: [:get, 'session/:session_id/window/rect'],
+            switch_to_frame: [:post, 'session/:session_id/frame'],
+            switch_to_parent_frame: [:post, 'session/:session_id/frame/parent'],
 
             #
             # element
             #
 
-            find_element: [:post, 'session/:session_id/element'.freeze],
-            find_elements: [:post, 'session/:session_id/elements'.freeze],
-            find_child_element: [:post, 'session/:session_id/element/:id/element'.freeze],
-            find_child_elements: [:post, 'session/:session_id/element/:id/elements'.freeze],
-            get_active_element: [:get, 'session/:session_id/element/active'.freeze],
-            is_element_selected: [:get, 'session/:session_id/element/:id/selected'.freeze],
-            get_element_attribute: [:get, 'session/:session_id/element/:id/attribute/:name'.freeze],
-            get_element_property: [:get, 'session/:session_id/element/:id/property/:name'.freeze],
-            get_element_css_value: [:get, 'session/:session_id/element/:id/css/:property_name'.freeze],
-            get_element_text: [:get, 'session/:session_id/element/:id/text'.freeze],
-            get_element_tag_name: [:get, 'session/:session_id/element/:id/name'.freeze],
-            get_element_rect: [:get, 'session/:session_id/element/:id/rect'.freeze],
-            is_element_enabled: [:get, 'session/:session_id/element/:id/enabled'.freeze],
+            find_element: [:post, 'session/:session_id/element'],
+            find_elements: [:post, 'session/:session_id/elements'],
+            find_child_element: [:post, 'session/:session_id/element/:id/element'],
+            find_child_elements: [:post, 'session/:session_id/element/:id/elements'],
+            get_active_element: [:get, 'session/:session_id/element/active'],
+            is_element_selected: [:get, 'session/:session_id/element/:id/selected'],
+            get_element_attribute: [:get, 'session/:session_id/element/:id/attribute/:name'],
+            get_element_property: [:get, 'session/:session_id/element/:id/property/:name'],
+            get_element_css_value: [:get, 'session/:session_id/element/:id/css/:property_name'],
+            get_element_text: [:get, 'session/:session_id/element/:id/text'],
+            get_element_tag_name: [:get, 'session/:session_id/element/:id/name'],
+            get_element_rect: [:get, 'session/:session_id/element/:id/rect'],
+            is_element_enabled: [:get, 'session/:session_id/element/:id/enabled'],
 
             #
             # document handling
             #
 
-            get_page_source: [:get, 'session/:session_id/source'.freeze],
-            execute_script: [:post, 'session/:session_id/execute/sync'.freeze],
-            execute_async_script: [:post, 'session/:session_id/execute/async'.freeze],
+            get_page_source: [:get, 'session/:session_id/source'],
+            execute_script: [:post, 'session/:session_id/execute/sync'],
+            execute_async_script: [:post, 'session/:session_id/execute/async'],
 
             #
             # cookies
             #
 
-            get_all_cookies: [:get, 'session/:session_id/cookie'.freeze],
-            get_cookie: [:get, 'session/:session_id/cookie/:name'.freeze],
-            add_cookie: [:post, 'session/:session_id/cookie'.freeze],
-            delete_cookie: [:delete, 'session/:session_id/cookie/:name'.freeze],
-            delete_all_cookies: [:delete, 'session/:session_id/cookie'.freeze],
+            get_all_cookies: [:get, 'session/:session_id/cookie'],
+            get_cookie: [:get, 'session/:session_id/cookie/:name'],
+            add_cookie: [:post, 'session/:session_id/cookie'],
+            delete_cookie: [:delete, 'session/:session_id/cookie/:name'],
+            delete_all_cookies: [:delete, 'session/:session_id/cookie'],
 
             #
             # timeouts
             #
 
-            set_timeout: [:post, 'session/:session_id/timeouts'.freeze],
+            set_timeout: [:post, 'session/:session_id/timeouts'],
 
             #
             # actions
             #
 
-            actions: [:post, 'session/:session_id/actions'.freeze],
-            release_actions: [:delete, 'session/:session_id/actions'.freeze],
+            actions: [:post, 'session/:session_id/actions'],
+            release_actions: [:delete, 'session/:session_id/actions'],
 
             #
             # Element Operations
             #
 
-            element_click: [:post, 'session/:session_id/element/:id/click'.freeze],
-            element_tap: [:post, 'session/:session_id/element/:id/tap'.freeze],
-            element_clear: [:post, 'session/:session_id/element/:id/clear'.freeze],
-            element_send_keys: [:post, 'session/:session_id/element/:id/value'.freeze],
+            element_click: [:post, 'session/:session_id/element/:id/click'],
+            element_tap: [:post, 'session/:session_id/element/:id/tap'],
+            element_clear: [:post, 'session/:session_id/element/:id/clear'],
+            element_send_keys: [:post, 'session/:session_id/element/:id/value'],
 
             #
             # alerts
             #
 
-            dismiss_alert: [:post, 'session/:session_id/alert/dismiss'.freeze],
-            accept_alert: [:post, 'session/:session_id/alert/accept'.freeze],
-            get_alert_text: [:get, 'session/:session_id/alert/text'.freeze],
-            send_alert_text: [:post, 'session/:session_id/alert/text'.freeze],
+            dismiss_alert: [:post, 'session/:session_id/alert/dismiss'],
+            accept_alert: [:post, 'session/:session_id/alert/accept'],
+            get_alert_text: [:get, 'session/:session_id/alert/text'],
+            send_alert_text: [:post, 'session/:session_id/alert/text'],
 
             #
             # screenshot
             #
 
-            take_screenshot: [:get, 'session/:session_id/screenshot'.freeze],
-            take_element_screenshot: [:get, 'session/:session_id/element/:id/screenshot'.freeze]
+            take_screenshot: [:get, 'session/:session_id/screenshot'],
+            take_element_screenshot: [:get, 'session/:session_id/element/:id/screenshot'],
+
+            #
+            # server extensions
+            #
+
+            upload_file: [:post, 'session/:session_id/se/file']
           }.freeze
 
         end # Bridge