selenium-webdriver 3.141.0 → 3.141.592

data/lib/selenium/webdriver/ie/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) || IE.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)
@@ -54,7 +48,7 @@ module Selenium
         def quit
           super
         ensure
-          @service.stop if @service
+          @service&.stop
         end
 
         private

data/lib/selenium/webdriver/ie/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
@@ -19,7 +21,7 @@ module Selenium
   module WebDriver
     module IE
       class Options
-        KEY = 'se:ieOptions'.freeze
+        KEY = 'se:ieOptions'
         SCROLL_TOP = 0
         SCROLL_BOTTOM = 1
         CAPABILITIES = {
@@ -86,7 +88,7 @@ module Selenium
         def initialize(**opts)
           @args = Set.new(opts.delete(:args) || [])
           @options = opts
-          @options[:native_events] ||= true
+          @options[:native_events] = true if @options[:native_events].nil?
         end
 
         #

data/lib/selenium/webdriver/ie/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,27 +25,21 @@ module Selenium
       #
 
       class Service < WebDriver::Service
-        DEFAULT_PORT = 5555
-        @executable = 'IEDriverServer'.freeze
-        @missing_text = <<-ERROR.gsub(/\n +| {2,}/, ' ').freeze
+        @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.
           More info at https://github.com/SeleniumHQ/selenium/wiki/InternetExplorerDriver.
         ERROR
+        @shutdown_supported = true
 
         private
 
-        def start_process
-          @process = build_process(@executable_path, "--port=#{@port}", *@extra_args)
-          @process.start
-        end
-
-        def cannot_connect_error_text
-          "unable to connect to IE server #{@host}:#{@port}"
-        end
-
+        # 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)

data/lib/selenium/webdriver/remote.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/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
@@ -24,7 +26,7 @@ module Selenium
 
         PORT = 4444
         COMMANDS = {
-          new_session: [:post, 'session'.freeze]
+          new_session: [:post, 'session']
         }.freeze
 
         attr_accessor :context, :http, :file_detector
@@ -46,6 +48,7 @@ module Selenium
             unless Capabilities.respond_to?(desired_capabilities)
               raise Error::WebDriverError, "invalid desired capability: #{desired_capabilities.inspect}"
             end
+
             desired_capabilities = Capabilities.__send__(desired_capabilities)
           end
 
@@ -112,9 +115,7 @@ module Selenium
             end
           end
 
-          unless @session_id
-            raise Error::WebDriverError, 'no sessionId in returned payload'
-          end
+          raise Error::WebDriverError, 'no sessionId in returned payload' unless @session_id
 
           if oss_status
             WebDriver.logger.info 'Detected OSS dialect.'
@@ -172,6 +173,7 @@ module Selenium
 
         def commands(command)
           raise NotImplementedError unless command == :new_session
+
           COMMANDS[command]
         end
 

data/lib/selenium/webdriver/remote/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
@@ -44,6 +46,7 @@ module Selenium
           end
 
           next if key == :proxy
+
           define_method "#{key}=" do |value|
             @capabilities[key] = value
           end
@@ -80,14 +83,21 @@ module Selenium
           def edge(opts = {})
             new({
               browser_name: 'MicrosoftEdge',
-              platform: :windows,
-              javascript_enabled: true,
-              takes_screenshot: true,
-              css_selectors_enabled: true
+              platform: :windows
             }.merge(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))
+          end
+
+          def firefox_legacy(opts = {})
             new({
               browser_name: 'firefox',
               javascript_enabled: true,
@@ -175,10 +185,6 @@ module Selenium
         # @option :native_events          [Boolean] does this driver use native events?
         # @option :proxy                  [Selenium::WebDriver::Proxy, Hash] proxy configuration
         #
-        # Firefox-specific options:
-        #
-        # @option :firefox_profile        [Selenium::WebDriver::Firefox::Profile] the firefox profile to use
-        #
         # @api public
         #
 
@@ -224,7 +230,7 @@ module Selenium
         # @api private
         #
 
-        def as_json(*)
+        def as_json(*) # rubocop:disable Metrics/CyclomaticComplexity
           hash = {}
 
           @capabilities.each do |key, value|
@@ -232,10 +238,16 @@ module Selenium
             when :platform
               hash['platform'] = value.to_s.upcase
             when :firefox_profile
-              hash['firefox_profile'] = value.as_json['zip'] if value
+              if value
+                WebDriver.logger.deprecate(':firefox_profile capabilitiy', 'Selenium::WebDriver::Firefox::Options#profile')
+                hash['firefox_profile'] = value.as_json['zip']
+              end
             when :proxy
               hash['proxy'] = value.as_json if value
             when String, :firefox_binary
+              if key == :firefox_binary && value
+                WebDriver.logger.deprecate(':firefox_binary capabilitiy', 'Selenium::WebDriver::Firefox::Options#binary')
+              end
               hash[key.to_s] = value
             when Symbol
               hash[camel_case(key.to_s)] = value
@@ -253,6 +265,7 @@ module Selenium
 
         def ==(other)
           return false unless other.is_a? self.class
+
           as_json == other.as_json
         end
         alias_method :eql?, :==

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

@@ -0,0 +1,156 @@
+# 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
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Selenium
+  module WebDriver
+    module Remote
+
+      #
+      # https://w3c.github.io/webdriver/#endpoints
+      # @api private
+      #
+
+      class Bridge
+        COMMANDS = {
+          status: [:get, 'status'],
+
+          #
+          # session handling
+          #
+
+          new_session: [:post, 'session'],
+          delete_session: [:delete, 'session/:session_id'],
+
+          #
+          # basic driver
+          #
+
+          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'],
+          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'],
+          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'],
+          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'],
+          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'],
+
+          #
+          # actions
+          #
+
+          actions: [:post, 'session/:session_id/actions'],
+          release_actions: [:delete, 'session/:session_id/actions'],
+
+          #
+          # Element Operations
+          #
+
+          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'],
+          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'],
+          take_element_screenshot: [:get, 'session/:session_id/element/:id/screenshot'],
+
+          #
+          # server extensions
+          #
+
+          upload_file: [:post, 'session/:session_id/se/file']
+        }.freeze
+
+      end # Bridge
+    end # Remote
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/remote/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

data/lib/selenium/webdriver/remote/http/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
@@ -21,7 +23,7 @@ module Selenium
       module Http
         class Common
           MAX_REDIRECTS   = 20 # same as chromium/gecko
-          CONTENT_TYPE    = 'application/json'.freeze
+          CONTENT_TYPE    = 'application/json'
           DEFAULT_HEADERS = {
             'Accept' => CONTENT_TYPE,
             'Content-Type' => "#{CONTENT_TYPE}; charset=UTF-8",
@@ -50,7 +52,7 @@ module Selenium
 
             if command_hash
               payload                   = JSON.generate(command_hash)
-              headers['Content-Length'] = payload.bytesize.to_s if [:post, :put].include?(verb)
+              headers['Content-Length'] = payload.bytesize.to_s if %i[post put].include?(verb)
 
               WebDriver.logger.info("   >>> #{url} | #{payload}")
               WebDriver.logger.debug("     > #{headers.inspect}")
@@ -66,6 +68,7 @@ module Selenium
 
           def server_url
             return @server_url if @server_url
+
             raise Error::WebDriverError, 'server_url not set'
           end
 
@@ -81,12 +84,16 @@ module Selenium
 
             if content_type.include? CONTENT_TYPE
               raise Error::WebDriverError, "empty body: #{content_type.inspect} (#{code})\n#{body}" if body.empty?
+
               Response.new(code, JSON.parse(body))
             elsif code == 204
               Response.new(code)
             else
-              msg = "unexpected response, code=#{code}, content-type=#{content_type.inspect}"
-              msg << "\n#{body}" unless body.empty?
+              msg = if body.empty?
+                      "unexpected response, code=#{code}, content-type=#{content_type.inspect}"
+                    else
+                      "unexpected response, code=#{code}, content-type=#{content_type.inspect}\n#{body}"
+                    end
 
               raise Error::WebDriverError, msg
             end

data/lib/selenium/webdriver/remote/http/curb.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
@@ -77,7 +79,7 @@ module Selenium
           end
 
           def client
-            @client ||= (
+            @client ||= begin
               c = Curl::Easy.new
 
               c.max_redirects   = MAX_REDIRECTS
@@ -86,7 +88,7 @@ module Selenium
               c.verbose         = WebDriver.logger.info?
 
               c
-            )
+            end
           end
         end # Curb
       end # Http