selenium-webdriver 4.0.0.alpha2 → 4.0.0

data/lib/selenium/webdriver/firefox.rb

@@ -21,42 +21,48 @@ require 'timeout'
 require 'socket'
 require 'rexml/document'
 
-require 'selenium/webdriver/firefox/driver'
-
-require 'selenium/webdriver/firefox/extension'
-require 'selenium/webdriver/firefox/binary'
-require 'selenium/webdriver/firefox/profiles_ini'
-require 'selenium/webdriver/firefox/profile'
-require 'selenium/webdriver/firefox/bridge'
-require 'selenium/webdriver/firefox/driver'
-require 'selenium/webdriver/firefox/options'
-
 module Selenium
   module WebDriver
     module Firefox
+      autoload :Extension, 'selenium/webdriver/firefox/extension'
+      autoload :ProfilesIni, 'selenium/webdriver/firefox/profiles_ini'
+      autoload :Profile, 'selenium/webdriver/firefox/profile'
+      autoload :Features, 'selenium/webdriver/firefox/features'
+      autoload :Driver, 'selenium/webdriver/firefox/driver'
+      autoload :Options, 'selenium/webdriver/firefox/options'
+      autoload :Service, 'selenium/webdriver/firefox/service'
+
       DEFAULT_PORT = 7055
-      DEFAULT_ENABLE_NATIVE_EVENTS = Platform.os == :windows
       DEFAULT_SECURE_SSL = false
       DEFAULT_ASSUME_UNTRUSTED_ISSUER = true
       DEFAULT_LOAD_NO_FOCUS_LIB = false
 
+      # Mozilla Automation Team asked to only support 85
+      # until WebDriver Bidi is available.
+      DEVTOOLS_VERSION = 85
+
       def self.driver_path=(path)
         WebDriver.logger.deprecate 'Selenium::WebDriver::Firefox#driver_path=',
-                                   'Selenium::WebDriver::Firefox::Service#driver_path='
+                                   'Selenium::WebDriver::Firefox::Service#driver_path=',
+                                   id: :driver_path
         Selenium::WebDriver::Firefox::Service.driver_path = path
       end
 
       def self.driver_path
         WebDriver.logger.deprecate 'Selenium::WebDriver::Firefox#driver_path',
-                                   'Selenium::WebDriver::Firefox::Service#driver_path'
+                                   'Selenium::WebDriver::Firefox::Service#driver_path',
+                                   id: :driver_path
         Selenium::WebDriver::Firefox::Service.driver_path
       end
 
       def self.path=(path)
-        Binary.path = path
+        Platform.assert_executable path
+        @path = path
+      end
+
+      def self.path
+        @path ||= nil
       end
     end # Firefox
   end # WebDriver
 end # Selenium
-
-require 'selenium/webdriver/firefox/service'

data/lib/selenium/webdriver/ie/driver.rb

@@ -28,44 +28,11 @@ module Selenium
       #
 
       class Driver < WebDriver::Driver
-        include DriverExtensions::HasWebStorage
-        include DriverExtensions::TakesScreenshot
-
-        def initialize(opts = {})
-          opts[:desired_capabilities] = create_capabilities(opts)
-
-          opts[:url] ||= service_url(opts)
-
-          listener = opts.delete(:listener)
-          desired_capabilities = opts.delete(:desired_capabilities)
-
-          @bridge = Remote::Bridge.new(opts)
-          @bridge.create_session(desired_capabilities)
-
-          super(@bridge, listener: listener)
-        end
+        EXTENSIONS = [DriverExtensions::HasWebStorage].freeze
 
         def browser
           :internet_explorer
         end
-
-        def quit
-          super
-        ensure
-          @service&.stop
-        end
-
-        private
-
-        def create_capabilities(opts)
-          caps = opts.delete(:desired_capabilities) { Remote::Capabilities.internet_explorer }
-          options = opts.delete(:options) { Options.new }
-          options = options.as_json
-          caps.merge!(options) unless options.empty?
-
-          caps
-        end
-
       end # Driver
     end # IE
   end # WebDriver

data/lib/selenium/webdriver/ie/options.rb

@@ -20,7 +20,7 @@
 module Selenium
   module WebDriver
     module IE
-      class Options
+      class Options < WebDriver::Options
         KEY = 'se:ieOptions'
         SCROLL_TOP = 0
         SCROLL_BOTTOM = 1
@@ -39,20 +39,13 @@ module Selenium
           persistent_hover: 'enablePersistentHover',
           require_window_focus: 'requireWindowFocus',
           use_per_process_proxy: 'ie.usePerProcessProxy',
-          validate_cookie_document_type: 'ie.validateCookieDocumentType'
+          use_legacy_file_upload_dialog_handling: 'ie.useLegacyFileUploadDialogHandling',
+          attach_to_edge_chrome: 'ie.edgechromium',
+          edge_executable_path: 'ie.edgepath'
         }.freeze
+        BROWSER = 'internet explorer'
 
-        CAPABILITIES.each_key do |key|
-          define_method key do
-            @options[key]
-          end
-
-          define_method "#{key}=" do |value|
-            @options[key] = value
-          end
-        end
-
-        attr_reader :args, :options
+        attr_reader :args
 
         #
         # Create a new Options instance
@@ -86,8 +79,9 @@ module Selenium
         #
 
         def initialize(**opts)
-          @args = Set.new(opts.delete(:args) || [])
-          @options = opts
+          @args = (opts.delete(:args) || []).to_set
+          super(**opts)
+
           @options[:native_events] = true if @options[:native_events].nil?
         end
 
@@ -101,36 +95,11 @@ module Selenium
           @args << arg
         end
 
-        #
-        # Add a new option not yet handled by these bindings.
-        #
-        # @example
-        #   options = Selenium::WebDriver::IE::Options.new
-        #   options.add_option(:foo, 'bar')
-        #
-        # @param [String, Symbol] name Name of the option
-        # @param [Boolean, String, Integer] value Value of the option
-        #
-
-        def add_option(name, value)
-          @options[name] = value
-        end
-
-        #
-        # @api private
-        #
-
-        def as_json(*)
-          opts = {}
-
-          CAPABILITIES.each do |capability_alias, capability_name|
-            capability_value = @options.delete(capability_alias)
-            opts[capability_name] = capability_value unless capability_value.nil?
-          end
-          opts['ie.browserCommandLineSwitches'] = @args.to_a.join(' ') if @args.any?
-          opts.merge!(@options)
+        private
 
-          {KEY => opts}
+        def process_browser_options(browser_options)
+          options = browser_options[KEY]
+          options['ie.browserCommandLineSwitches'] = @args.to_a.join(' ') if @args.any?
         end
       end # Options
     end # IE

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

@@ -20,31 +20,29 @@
 module Selenium
   module WebDriver
     module IE
-      #
-      # @api private
-      #
-
       class Service < WebDriver::Service
         DEFAULT_PORT = 5555
         EXECUTABLE = 'IEDriverServer'
         MISSING_TEXT = <<~ERROR
           Unable to find IEDriverServer. Please download the server from
-          http://selenium-release.storage.googleapis.com/index.html and place it somewhere on your PATH.
+          https://www.selenium.dev/downloads/ and place it somewhere on your PATH.
           More info at https://github.com/SeleniumHQ/selenium/wiki/InternetExplorerDriver.
         ERROR
         SHUTDOWN_SUPPORTED = true
 
         private
 
-        # Note: This processing is deprecated
+        # NOTE: This processing is deprecated
         def extract_service_args(driver_opts)
           driver_args = super
           driver_opts = driver_opts.dup
-          driver_args << "--log-level=#{driver_opts.delete(:log_level).to_s.upcase}" if driver_opts.key?(:log_level)
-          driver_args << "--log-file=#{driver_opts.delete(:log_file)}" if driver_opts.key?(:log_file)
-          driver_args << "--implementation=#{driver_opts.delete(:implementation).to_s.upcase}" if driver_opts.key?(:implementation)
-          driver_args << "--host=#{driver_opts.delete(:host)}" if driver_opts.key?(:host)
-          driver_args << "--extract_path=#{driver_opts.delete(:extract_path)}" if driver_opts.key?(:extract_path)
+          driver_args << "--log-level=#{driver_opts[:log_level].to_s.upcase}" if driver_opts.key?(:log_level)
+          driver_args << "--log-file=#{driver_opts[:log_file]}" if driver_opts.key?(:log_file)
+          if driver_opts.key?(:implementation)
+            driver_args << "--implementation=#{driver_opts[:implementation].to_s.upcase}"
+          end
+          driver_args << "--host=#{driver_opts[:host]}" if driver_opts.key?(:host)
+          driver_args << "--extract_path=#{driver_opts[:extract_path]}" if driver_opts.key?(:extract_path)
           driver_args << "--silent" if driver_opts[:silent] == true
           driver_args
         end

data/lib/selenium/webdriver/ie.rb

@@ -17,25 +17,26 @@
 # specific language governing permissions and limitations
 # under the License.
 
-require 'selenium/webdriver/ie/driver'
-require 'selenium/webdriver/ie/options'
-
 module Selenium
   module WebDriver
     module IE
+      autoload :Driver, 'selenium/webdriver/ie/driver'
+      autoload :Options, 'selenium/webdriver/ie/options'
+      autoload :Service, 'selenium/webdriver/ie/service'
+
       def self.driver_path=(path)
         WebDriver.logger.deprecate 'Selenium::WebDriver::IE#driver_path=',
-                                   'Selenium::WebDriver::IE::Service#driver_path='
+                                   'Selenium::WebDriver::IE::Service#driver_path=',
+                                   id: :driver_path
         Selenium::WebDriver::IE::Service.driver_path = path
       end
 
       def self.driver_path
         WebDriver.logger.deprecate 'Selenium::WebDriver::IE#driver_path',
-                                   'Selenium::WebDriver::IE::Service#driver_path'
+                                   'Selenium::WebDriver::IE::Service#driver_path',
+                                   id: :driver_path
         Selenium::WebDriver::IE::Service.driver_path
       end
     end # IE
   end # WebDriver
 end # Selenium
-
-require 'selenium/webdriver/ie/service'

data/lib/selenium/webdriver/remote/bridge.rb

@@ -25,35 +25,22 @@ module Selenium
 
         PORT = 4444
 
-        attr_accessor :context, :http, :file_detector
+        attr_accessor :http, :file_detector
         attr_reader :capabilities
 
         #
         # Initializes the bridge with the given server URL
-        # @param [Hash] opts options for the driver
-        # @option opts [String] :url url for the remote server
-        # @option opts [Object] :http_client an HTTP client instance that implements the same protocol as Http::Default
-        # @option opts [Capabilities] :desired_capabilities an instance of Remote::Capabilities describing the capabilities you want
+        # @param [String, URI] :url url for the remote server
+        # @param [Object] :http_client an HTTP client instance that implements the same protocol as Http::Default
         # @api private
         #
 
-        def initialize(opts = {})
-          opts = opts.dup
-
-          http_client = opts.delete(:http_client) { Http::Default.new }
-          url = opts.delete(:url) { "http://#{Platform.localhost}:#{PORT}/wd/hub" }
-          opts.delete(:options)
-
-          unless opts.empty?
-            raise ArgumentError, "unknown option#{'s' if opts.size != 1}: #{opts.inspect}"
-          end
-
+        def initialize(url:, http_client: nil)
           uri = url.is_a?(URI) ? url : URI.parse(url)
-          uri.path += '/' unless %r{\/$}.match?(uri.path)
+          uri.path += '/' unless uri.path.end_with?('/')
 
-          http_client.server_url = uri
-
-          @http = http_client
+          @http = http_client || Http::Default.new
+          @http.server_url = uri
           @file_detector = nil
         end
 
@@ -61,8 +48,8 @@ module Selenium
         # Creates session.
         #
 
-        def create_session(desired_capabilities, options = nil)
-          response = execute(:new_session, {}, merged_capabilities(desired_capabilities, options))
+        def create_session(capabilities)
+          response = execute(:new_session, {}, prepare_capabilities_payload(capabilities))
 
           @session_id = response['sessionId']
           capabilities = response['capabilities']
@@ -70,6 +57,17 @@ module Selenium
           raise Error::WebDriverError, 'no sessionId in returned payload' unless @session_id
 
           @capabilities = Capabilities.json_create(capabilities)
+
+          case @capabilities[:browser_name]
+          when 'chrome'
+            extend(WebDriver::Chrome::Features)
+          when 'firefox'
+            extend(WebDriver::Firefox::Features)
+          when 'msedge'
+            extend(WebDriver::Edge::Features)
+          when 'Safari', 'Safari Technology Preview'
+            extend(WebDriver::Safari::Features)
+          end
         end
 
         #
@@ -83,7 +81,7 @@ module Selenium
         def browser
           @browser ||= begin
             name = @capabilities.browser_name
-            name ? name.tr(' ', '_').to_sym : 'unknown'
+            name ? name.tr(' ', '_').downcase.to_sym : 'unknown'
           end
         end
 
@@ -95,17 +93,16 @@ module Selenium
           execute :get, {}, {url: url}
         end
 
-        def implicit_wait_timeout=(milliseconds)
-          timeout('implicit', milliseconds)
-        end
+        #
+        # timeouts
+        #
 
-        def script_timeout=(milliseconds)
-          timeout('script', milliseconds)
+        def timeouts
+          execute :get_timeouts, {}
         end
 
-        def timeout(type, milliseconds)
-          type = 'pageLoad' if type == 'page load'
-          execute :set_timeout, {}, {type => milliseconds}
+        def timeouts=(timeouts)
+          execute :set_timeout, {}, timeouts
         end
 
         #
@@ -220,7 +217,10 @@ module Selenium
         end
 
         def window_size(handle = :current)
-          raise Error::UnsupportedOperationError, 'Switch to desired window before getting its size' unless handle == :current
+          unless handle == :current
+            raise Error::UnsupportedOperationError,
+                  'Switch to desired window before getting its size'
+          end
 
           data = execute :get_window_rect
           Dimension.new data['width'], data['height']
@@ -231,7 +231,10 @@ module Selenium
         end
 
         def maximize_window(handle = :current)
-          raise Error::UnsupportedOperationError, 'Switch to desired window before changing its size' unless handle == :current
+          unless handle == :current
+            raise Error::UnsupportedOperationError,
+                  'Switch to desired window before changing its size'
+          end
 
           execute :maximize_window
         end
@@ -264,6 +267,10 @@ module Selenium
           execute :take_screenshot
         end
 
+        def element_screenshot(element)
+          execute :take_element_screenshot, id: element
+        end
+
         #
         # HTML 5
         #
@@ -316,22 +323,6 @@ module Selenium
           execute_script('return sessionStorage.length')
         end
 
-        def location
-          raise Error::UnsupportedOperationError, 'The W3C standard does not currently support getting location'
-        end
-
-        def set_location(_lat, _lon, _alt)
-          raise Error::UnsupportedOperationError, 'The W3C standard does not currently support setting location'
-        end
-
-        def network_connection
-          raise Error::UnsupportedOperationError, 'The W3C standard does not currently support getting network connection'
-        end
-
-        def network_connection=(_type)
-          raise Error::UnsupportedOperationError, 'The W3C standard does not currently support setting network connection'
-        end
-
         #
         # javascript execution
         #
@@ -402,6 +393,10 @@ module Selenium
           execute :release_actions
         end
 
+        def print_page(options = {})
+          execute :print_page, {}, {options: options}
+        end
+
         def click_element(element)
           execute :element_click, id: element
         end
@@ -435,20 +430,12 @@ module Selenium
         end
 
         def submit_element(element)
-          form = find_element_by('xpath', "./ancestor-or-self::form", element)
+          form = find_element_by('xpath', "./ancestor-or-self::form", [:element, element])
           execute_script("var e = arguments[0].ownerDocument.createEvent('Event');" \
                             "e.initEvent('submit', true, true);" \
                             'if (arguments[0].dispatchEvent(e)) { arguments[0].submit() }', form.as_json)
         end
 
-        def screen_orientation=(orientation)
-          execute :set_screen_orientation, {}, {orientation: orientation}
-        end
-
-        def screen_orientation
-          execute :get_screen_orientation
-        end
-
         #
         # element properties
         #
@@ -462,8 +449,20 @@ module Selenium
           execute_atom :getAttribute, element, name
         end
 
+        def element_dom_attribute(element, name)
+          execute :get_element_attribute, id: element, name: name
+        end
+
         def element_property(element, name)
-          execute :get_element_property, id: element.ref, name: name
+          execute :get_element_property, id: element, name: name
+        end
+
+        def element_aria_role(element)
+          execute :get_element_aria_role, id: element
+        end
+
+        def element_aria_label(element)
+          execute :get_element_aria_label, id: element
         end
 
         def element_value(element)
@@ -524,29 +523,47 @@ module Selenium
 
         alias_method :switch_to_active_element, :active_element
 
-        def find_element_by(how, what, parent = nil)
-          how, what = convert_locators(how, what)
+        def find_element_by(how, what, parent_ref = [])
+          how, what = convert_locator(how, what)
+
+          return execute_atom(:findElements, Support::RelativeLocator.new(what).as_json).first if how == 'relative'
 
-          id = if parent
-                 execute :find_child_element, {id: parent}, {using: how, value: what}
+          parent_type, parent_id = parent_ref
+          id = case parent_type
+               when :element
+                 execute :find_child_element, {id: parent_id}, {using: how, value: what.to_s}
+               when :shadow_root
+                 execute :find_shadow_child_element, {id: parent_id}, {using: how, value: what.to_s}
                else
-                 execute :find_element, {}, {using: how, value: what}
+                 execute :find_element, {}, {using: how, value: what.to_s}
                end
+
           Element.new self, element_id_from(id)
         end
 
-        def find_elements_by(how, what, parent = nil)
-          how, what = convert_locators(how, what)
+        def find_elements_by(how, what, parent_ref = [])
+          how, what = convert_locator(how, what)
 
-          ids = if parent
-                  execute :find_child_elements, {id: parent}, {using: how, value: what}
+          return execute_atom :findElements, Support::RelativeLocator.new(what).as_json if how == 'relative'
+
+          parent_type, parent_id = parent_ref
+          ids = case parent_type
+                when :element
+                  execute :find_child_elements, {id: parent_id}, {using: how, value: what.to_s}
+                when :shadow_root
+                  execute :find_shadow_child_elements, {id: parent_id}, {using: how, value: what.to_s}
                 else
-                  execute :find_elements, {}, {using: how, value: what}
+                  execute :find_elements, {}, {using: how, value: what.to_s}
                 end
 
           ids.map { |id| Element.new self, element_id_from(id) }
         end
 
+        def shadow_root(element)
+          id = execute :get_element_shadow_root, id: element
+          ShadowRoot.new self, shadow_root_id_from(id)
+        end
+
         private
 
         #
@@ -579,16 +596,6 @@ module Selenium
           COMMANDS[command]
         end
 
-        def merged_capabilities(capabilities, options = nil)
-          capabilities.merge!(options.as_json) if options
-
-          {
-            capabilities: {
-              firstMatch: [capabilities]
-            }
-          }
-        end
-
         def unwrap_script_result(arg)
           case arg
           when Array
@@ -604,34 +611,53 @@ module Selenium
         end
 
         def element_id_from(id)
-          id['ELEMENT'] || id['element-6066-11e4-a52e-4f735466cecf']
+          id['ELEMENT'] || id[Element::ELEMENT_KEY]
+        end
+
+        def shadow_root_id_from(id)
+          id[ShadowRoot::ROOT_KEY]
+        end
+
+        def prepare_capabilities_payload(capabilities)
+          capabilities = {alwaysMatch: capabilities} if !capabilities['alwaysMatch'] && !capabilities['firstMatch']
+          {capabilities: capabilities}
         end
 
-        def convert_locators(how, what)
+        def convert_locator(how, what)
+          how = SearchContext::FINDERS[how.to_sym] || how
+
           case how
           when 'class name'
             how = 'css selector'
-            what = ".#{escape_css(what)}"
+            what = ".#{escape_css(what.to_s)}"
           when 'id'
             how = 'css selector'
-            what = "##{escape_css(what)}"
+            what = "##{escape_css(what.to_s)}"
           when 'name'
             how = 'css selector'
-            what = "*[name='#{escape_css(what)}']"
+            what = "*[name='#{escape_css(what.to_s)}']"
           when 'tag name'
             how = 'css selector'
           end
+
+          if what.is_a?(Hash)
+            what = what.each_with_object({}) do |(h, w), hash|
+              h, w = convert_locator(h.to_s, w)
+              hash[h] = w
+            end
+          end
+
           [how, what]
         end
 
-        ESCAPE_CSS_REGEXP = /(['"\\#.:;,!?+<>=~*^$|%&@`{}\-\[\]\(\)])/.freeze
+        ESCAPE_CSS_REGEXP = /(['"\\#.:;,!?+<>=~*^$|%&@`{}\-\[\]()])/.freeze
         UNICODE_CODE_POINT = 30
 
         # Escapes invalid characters in CSS selector.
         # @see https://mathiasbynens.be/notes/css-escapes
         def escape_css(string)
           string = string.gsub(ESCAPE_CSS_REGEXP) { |match| "\\#{match}" }
-          string = "\\#{UNICODE_CODE_POINT + Integer(string[0])} #{string[1..-1]}" if !string.empty? && string[0].match?(/[[:digit:]]/)
+          string = "\\#{UNICODE_CODE_POINT + Integer(string[0])} #{string[1..]}" if string[0]&.match?(/[[:digit:]]/)
 
           string
         end