selenium-webdriver 3.141.0 → 3.142.3

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|
@@ -61,7 +64,14 @@ module Selenium
             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
@@ -81,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
@@ -140,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?
@@ -163,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
@@ -250,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
@@ -272,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,119 +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]
+            upload_file: [:post, 'session/:session_id/se/file']
           }.freeze
 
         end # Bridge

data/lib/selenium/webdriver/safari.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
@@ -18,7 +20,6 @@
 require 'selenium/webdriver/safari/bridge'
 require 'selenium/webdriver/safari/driver'
 require 'selenium/webdriver/safari/options'
-require 'selenium/webdriver/safari/service'
 
 module Selenium
   module WebDriver
@@ -41,18 +42,24 @@ module Selenium
           @path ||= '/Applications/Safari.app/Contents/MacOS/Safari'
           return @path if File.file?(@path) && File.executable?(@path)
           raise Error::WebDriverError, 'Safari is only supported on Mac' unless Platform.os.mac?
+
           raise Error::WebDriverError, 'Unable to find Safari'
         end
 
         def driver_path=(path)
-          Platform.assert_executable path
-          @driver_path = path
+          WebDriver.logger.deprecate 'Selenium::WebDriver::Safari#driver_path=',
+                                     'Selenium::WebDriver::Safari::Service#driver_path='
+          Selenium::WebDriver::Safari::Service.driver_path = path
         end
 
         def driver_path
-          @driver_path ||= nil
+          WebDriver.logger.deprecate 'Selenium::WebDriver::Safari#driver_path',
+                                     'Selenium::WebDriver::Safari::Service#driver_path'
+          Selenium::WebDriver::Safari::Service.driver_path
         end
       end
     end # Safari
   end # WebDriver
 end # Selenium
+
+require 'selenium/webdriver/safari/service'

data/lib/selenium/webdriver/safari/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
@@ -22,9 +24,9 @@ module Selenium
 
         # https://developer.apple.com/library/content/documentation/NetworkingInternetWeb/Conceptual/WebDriverEndpointDoc/Commands/Commands.html
         COMMANDS = {
-          get_permissions: [:get, '/session/:session_id/apple/permissions'.freeze],
-          set_permissions: [:post, '/session/:session_id/apple/permissions'.freeze],
-          attach_debugger: [:post, '/session/:session_id/apple/attach_debugger'.freeze]
+          get_permissions: [:get, 'session/:session_id/apple/permissions'],
+          set_permissions: [:post, 'session/:session_id/apple/permissions'],
+          attach_debugger: [:post, 'session/:session_id/apple/attach_debugger']
         }.freeze
 
         def commands(command)

data/lib/selenium/webdriver/safari/driver.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,15 +34,7 @@ module Selenium
         def initialize(opts = {})
           opts[:desired_capabilities] = create_capabilities(opts)
 
-          unless opts.key?(:url)
-            driver_path = opts.delete(:driver_path) || Safari.driver_path
-            driver_opts = opts.delete(:driver_opts) || {}
-            port = opts.delete(:port) || Service::DEFAULT_PORT
-
-            @service = Service.new(driver_path, port, driver_opts)
-            @service.start
-            opts[:url] = @service.uri
-          end
+          opts[:url] ||= service_url(opts)
 
           listener = opts.delete(:listener)
           @bridge = Remote::Bridge.handshake(opts)
@@ -49,10 +43,14 @@ module Selenium
           super(@bridge, listener: listener)
         end
 
+        def browser
+          :safari
+        end
+
         def quit
           super
         ensure
-          @service.stop if @service
+          @service&.stop
         end
 
         private

data/lib/selenium/webdriver/safari/options.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/safari/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
@@ -23,34 +25,13 @@ module Selenium
       #
 
       class Service < WebDriver::Service
-        DEFAULT_PORT = 7050
-        @executable = '/usr/bin/safaridriver'.freeze
-        @missing_text = <<-ERROR.gsub(/\n +| {2,}/, ' ').freeze
+        @default_port = 7050
+        @executable = 'safaridriver'
+        @missing_text = <<~ERROR
           Unable to find Apple's safaridriver which comes with Safari 10.
           More info at https://webkit.org/blog/6900/webdriver-support-in-safari-10/
         ERROR
-
-        def stop
-          stop_process
-        end
-
-        private
-
-        def binary_path(path)
-          path = self.class.executable if path.nil?
-          raise Error::WebDriverError, self.class.missing_text unless path
-          Platform.assert_executable path
-          path
-        end
-
-        def start_process
-          @process = build_process(@executable_path, "--port=#{@port}", *@extra_args)
-          @process.start
-        end
-
-        def cannot_connect_error_text
-          "unable to connect to safaridriver #{@host}:#{@port}"
-        end
+        @shutdown_supported = false
       end # Service
     end # Safari
   end # WebDriver