selenium-webdriver 4.0.0.alpha5 → 4.0.0.alpha6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d04cb682531f39f2806727c1267c2bad759729c9c3a11f134ce3b3b03577bfd2
-  data.tar.gz: 1a08d5c92d03e56fb5374dae94b568f1531e91c722b04a971f1594ca6ef982f3
+  metadata.gz: e4dbf1d975d636f48a1f346ffdb79c19d612287f1f4b625e150ff586b290be49
+  data.tar.gz: 1835a0d9d692b3d158a596fc081b132984e458e372c7ab882b17a10bdfc48a81
 SHA512:
-  metadata.gz: c13f2b89e2002814d96bf6a82cf384c7000757d29ba9a1038b01fe2b7df4842b145d33531f7f7ae8bf015c6b82b43e8a0205cb068f344af7092e4a9d07f1e6c3
-  data.tar.gz: ad5cfc2f64a1a1b3e27ed6df91b06638778de23f82246e12e9e5003f162829b88fabbb8db5764d7330f35b315f1ffe2de22342e431a3fd9404cf524f2e623ed1
+  metadata.gz: d33d076a090456d98b7361f9d890ad97ca5771ef832f609a0145dcbc19a149602ff4cfceb71d882307954017ce971aa0f4197cd612add189770f0c9b4267aacf
+  data.tar.gz: c84c80cf18da2e301122a350df46db0fb35455e1c88738ffff7bb5b784c622a1bb2b63c68fffe885c65fd445133427ac1632562b02473f5fa76c5a02d8649db1

data/CHANGES

@@ -1,3 +1,41 @@
+4.0.0.alpha6 (2020-05-28)
+=========================
+
+Chrome:
+  * Added DevTools classes and methods generated from the CDP specification.
+    It currently supports commands and events and provides Rubyish API:
+      driver.devtools.page.navigate(url: 'http://google.com')
+      driver.devtools.console.clear_messages
+      driver.devtools.page.enable
+      driver.devtools.page.on(:load_event_fired) do |params|
+        puts("Page loaded in #{params['timestamp']}")
+      end
+    Check https://chromedevtools.github.io/devtools-protocol/ for more information
+    about possible commands and events. Please note that this API is considered
+    to be experimental and may change any time before stable 4.0 release.
+  * Fixed an issue when passing :prompt_for_download (or similar snake_cased
+    symbols) in Options#prefs would be ignored by Chrome because Selenium
+    would internally convert it to camelCased format (:promptForDownload).
+    Now :prefs are left intact.
+
+Edge:
+  * Fixed an issue when Driver#execute_cdp would not work for Chromium-based
+    Edge browser.
+
+Ruby:
+  * Deprecated passing :desired_capabilities and :options to driver initialization
+    in favor of :capabilities. They now can be combined in an array to make
+    custom capabilities requirements:
+      caps = Selenium::WebDriver::Remote::Capabilities.chrome
+      opts = Selenium::WebDriver::Chrome::Options.new
+      Selenium::WebDriver.for(:remote, capabilities: :chrome)
+      Selenium::WebDriver.for(:remote, capabilities: caps)
+      Selenium::WebDriver.for(:remote, capabilities: opts)
+      Selenium::WebDriver.for(:remote, capabilities: [caps, opts])
+  * Deprecated passing Hash to :capabilities in favor of Remote::Capabilities object.
+  * Updated minimum require Ruby version to 2.5.
+  * Improved keyword arguments handling to avoid warnings in Ruby 2.7.
+
 4.0.0.alpha5 (2020-03-18)
 =========================
 

data/LICENSE

@@ -187,7 +187,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2019 Software Freedom Conservancy (SFC)
+   Copyright 2020 Software Freedom Conservancy (SFC)
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

data/lib/selenium/webdriver/atoms/findElements.js

@@ -110,7 +110,7 @@ function jd(a){var b=a.shape.toLowerCase();a=a.coords.split(",");if("rect"==b&&4
 function kd(a){return a.replace(/^[^\S\xa0]+|[^\S\xa0]+$/g,"")}function ld(a){var b=[];$c?md(a,b):nd(a,b);a=pa(b,kd);return kd(a.join("\n")).replace(/\xa0/g," ")}
 function od(a,b,c){if(T(a,"BR"))b.push("");else{var d=T(a,"TD"),e=W(a,"display"),f=!d&&!(0<=na(pd,e)),g=k(a.previousElementSibling)?a.previousElementSibling:fb(a.previousSibling);g=g?W(g,"display"):"";var h=W(a,"float")||W(a,"cssFloat")||W(a,"styleFloat");!f||"run-in"==g&&"none"==h||/^[\s\xa0]*$/.test(b[b.length-1]||"")||b.push("");var n=hd(a),t=null,p=null;n&&(t=W(a,"white-space"),p=W(a,"text-transform"));r(a.childNodes,function(G){c(G,b,n,t,p)});a=b[b.length-1]||"";!d&&"table-cell"!=e||!a||wa(a)||
 (b[b.length-1]+=" ");f&&"run-in"!=e&&!/^[\s\xa0]*$/.test(a)&&b.push("")}}function nd(a,b){od(a,b,function(c,d,e,f,g){3==c.nodeType&&e?qd(c,d,f,g):T(c)&&nd(c,d)})}var pd="inline inline-block inline-table none table-cell table-column table-column-group".split(" ");
-function qd(a,b,c,d){a=a.nodeValue.replace(/[\u200b\u200e\u200f]/g,"");a=a.replace(/(\r\n|\r|\n)/g,"\n");if("normal"==c||"nowrap"==c)a=a.replace(/\n/g," ");a="pre"==c||"pre-wrap"==c?a.replace(/[ \f\t\v\u2028\u2029]/g,"\u00a0"):a.replace(/[ \f\t\v\u2028\u2029]+/g," ");"capitalize"==d?a=a.replace(/\b(\S)/g,function(e,f){return f.toUpperCase()}):"uppercase"==d?a=a.toUpperCase():"lowercase"==d&&(a=a.toLowerCase());c=b.pop()||"";wa(c)&&0==a.lastIndexOf(" ",0)&&(a=a.substr(1));b.push(c+a)}
+function qd(a,b,c,d){a=a.nodeValue.replace(/[\u200b\u200e\u200f]/g,"");a=a.replace(/(\r\n|\r|\n)/g,"\n");if("normal"==c||"nowrap"==c)a=a.replace(/\n/g," ");a="pre"==c||"pre-wrap"==c?a.replace(/[ \f\t\v\u2028\u2029]/g,"\u00a0"):a.replace(/[ \f\t\v\u2028\u2029]+/g," ");"capitalize"==d?a=a.replace(/(^|\s|\b)(\S)/g,function(e,f,g){return f+g.toUpperCase()}):"uppercase"==d?a=a.toUpperCase():"lowercase"==d&&(a=a.toLowerCase());c=b.pop()||"";wa(c)&&0==a.lastIndexOf(" ",0)&&(a=a.substr(1));b.push(c+a)}
 function gd(a){if(Oc){if("relative"==W(a,"position"))return 1;a=W(a,"filter");return(a=a.match(/^alpha\(opacity=(\d*)\)/)||a.match(/^progid:DXImageTransform.Microsoft.Alpha\(Opacity=(\d*)\)/))?Number(a[1])/100:1}return rd(a)}function rd(a){var b=1,c=W(a,"opacity");c&&(b=Number(c));(a=ad(a))&&(b*=rd(a));return b}
 function sd(a,b,c,d,e){if(3==a.nodeType&&c)qd(a,b,d,e);else if(T(a))if(T(a,"CONTENT")||T(a,"SLOT")){for(var f=a;f.parentNode;)f=f.parentNode;f instanceof ShadowRoot?(a=T(a,"CONTENT")?a.getDistributedNodes():a.assignedNodes(),r(a,function(g){sd(g,b,c,d,e)})):md(a,b)}else if(T(a,"SHADOW")){for(f=a;f.parentNode;)f=f.parentNode;if(f instanceof ShadowRoot&&(a=f))for(a=a.olderShadowRoot;a;)r(a.childNodes,function(g){sd(g,b,c,d,e)}),a=a.olderShadowRoot}else md(a,b)}
 function md(a,b){a.shadowRoot&&r(a.shadowRoot.childNodes,function(c){sd(c,b,!0,null,null)});od(a,b,function(c,d,e,f,g){var h=null;1==c.nodeType?h=c:3==c.nodeType&&(h=c);null!=h&&(null!=h.assignedSlot||h.getDestinationInsertionPoints&&0<h.getDestinationInsertionPoints().length)||sd(c,d,e,f,g)})};var td={A:function(a,b){return!(!a.querySelectorAll||!a.querySelector)&&!/^\d.*/.test(b)},o:function(a,b){var c=db(b),d=l(a)?c.a.getElementById(a):a;return d?Wc(d,"id")==a&&b!=d&&gb(b,d)?d:ta(lb(c,"*"),function(e){return Wc(e,"id")==a&&b!=e&&gb(b,e)}):null},j:function(a,b){if(!a)return[];if(td.A(b,a))try{return b.querySelectorAll("#"+td.R(a))}catch(c){return[]}b=lb(db(b),"*",null,b);return oa(b,function(c){return Wc(c,"id")==a})},R:function(a){return a.replace(/([\s'"\\#.:;,!?+<>=~*^$|%&@`{}\-\/\[\]\(\)])/g,

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

@@ -20,7 +20,7 @@
 module Selenium
   module WebDriver
     module Chrome
-      module Bridge
+      class Bridge < WebDriver::Remote::Bridge
 
         COMMANDS = {
           get_network_conditions: [:get, 'session/:session_id/chromium/network_conditions'],
@@ -55,11 +55,9 @@ module Selenium
           data = execute :get_log, {}, {type: type.to_s}
 
           Array(data).map do |l|
-            begin
-              LogEntry.new l.fetch('level', 'UNKNOWN'), l.fetch('timestamp'), l.fetch('message')
-            rescue KeyError
-              next
-            end
+            LogEntry.new l.fetch('level', 'UNKNOWN'), l.fetch('timestamp'), l.fetch('message')
+          rescue KeyError
+            next
           end
         end
       end # Bridge

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

@@ -38,6 +38,10 @@ module Selenium
           :chrome
         end
 
+        def bridge_class
+          Bridge
+        end
+
         def execute_cdp(cmd, **params)
           @bridge.send_command(cmd: cmd, params: params)
         end

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

@@ -24,6 +24,7 @@ module Selenium
         attr_accessor :profile
 
         KEY = 'goog:chromeOptions'
+        BROWSER = 'chrome'
 
         # see: http://chromedriver.chromium.org/capabilities
         CAPABILITIES = {args: 'args',
@@ -74,7 +75,7 @@ module Selenium
         #
 
         def initialize(profile: nil, encoded_extensions: nil, **opts)
-          super(opts)
+          super(**opts)
 
           @profile = profile
           @options[:encoded_extensions] = encoded_extensions if encoded_extensions
@@ -179,30 +180,23 @@ module Selenium
           @options[:emulation] = opts
         end
 
-        #
-        # @api private
-        #
-
-        def as_json(*)
-          options = super
-
-          if @profile
-            options['args'] ||= []
-            options['args'] << "--user-data-dir=#{@profile[:directory]}"
-          end
+        private
 
+        def process_browser_options(browser_options)
+          options = browser_options[KEY]
           options['binary'] ||= binary_path if binary_path
-          extensions = options['extensions'] || []
-          encoded_extensions = options.delete(:encoded_extensions) || []
+          (options['args'] || []) << "--user-data-dir=#{@profile[:directory]}" if @profile
+          merge_extensions(options)
+        end
 
-          options['extensions'] = extensions.map(&method(:encode_extension)) + encoded_extensions
-          options.delete('extensions') if options['extensions'].empty?
+        def merge_extensions(browser_options)
+          extensions = browser_options['extensions'] || []
+          encoded_extensions = browser_options.delete(:encoded_extensions) || []
 
-          {KEY => generate_as_json(options)}
+          browser_options['extensions'] = extensions.map(&method(:encode_extension)) + encoded_extensions
+          browser_options.delete('extensions') if browser_options['extensions'].empty?
         end
 
-        private
-
         def binary_path
           Chrome.path
         end
@@ -215,6 +209,17 @@ module Selenium
           raise Error::WebDriverError, "could not find extension at #{path.inspect}" unless File.file?(path)
           raise Error::WebDriverError, "file was not an extension #{path.inspect}" unless File.extname(path) == '.crx'
         end
+
+        def generate_as_json(value, camelize_keys: true)
+          if value.is_a?(Hash)
+            value.each_with_object({}) do |(key, val), hash|
+              key = convert_json_key(key, camelize: camelize_keys)
+              hash[key] = generate_as_json(val, camelize_keys: key != 'prefs')
+            end
+          else
+            super
+          end
+        end
       end # Options
     end # Chrome
   end # WebDriver

data/lib/selenium/webdriver/common.rb

@@ -23,6 +23,7 @@ require 'selenium/webdriver/common/proxy'
 require 'selenium/webdriver/common/log_entry'
 require 'selenium/webdriver/common/file_reaper'
 require 'selenium/webdriver/common/service'
+require 'selenium/webdriver/common/service_manager'
 require 'selenium/webdriver/common/socket_lock'
 require 'selenium/webdriver/common/socket_poller'
 require 'selenium/webdriver/common/port_prober'

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

@@ -43,21 +43,21 @@ module Selenium
         def for(browser, opts = {})
           case browser
           when :chrome
-            Chrome::Driver.new(opts)
+            Chrome::Driver.new(**opts)
           when :internet_explorer, :ie
-            IE::Driver.new(opts)
+            IE::Driver.new(**opts)
           when :safari
-            Safari::Driver.new(opts)
+            Safari::Driver.new(**opts)
           when :firefox, :ff
-            Firefox::Driver.new(opts)
+            Firefox::Driver.new(**opts)
           when :edge
-            Edge::Driver.new(opts)
+            Edge::Driver.new(**opts)
           when :edge_chrome
-            EdgeChrome::Driver.new(opts)
+            EdgeChrome::Driver.new(**opts)
           when :edge_html
-            EdgeHtml::Driver.new(opts)
+            EdgeHtml::Driver.new(**opts)
           when :remote
-            Remote::Driver.new(opts)
+            Remote::Driver.new(**opts)
           else
             raise ArgumentError, "unknown driver: #{browser.inspect}"
           end
@@ -73,7 +73,7 @@ module Selenium
 
       def initialize(bridge: nil, listener: nil, **opts)
         @service = nil
-        bridge ||= create_bridge(opts)
+        bridge ||= create_bridge(**opts)
         @bridge = listener ? Support::EventFiringBridge.new(bridge, listener) : bridge
       end
 
@@ -296,36 +296,68 @@ module Selenium
 
       def create_bridge(**opts)
         opts[:url] ||= service_url(opts)
+        caps = opts.delete(:capabilities)
+        # Note: This is deprecated
+        cap_array = caps.is_a?(Hash) ? [caps] : Array(caps)
+
+        desired_capabilities = opts.delete(:desired_capabilities)
+        if desired_capabilities
+          WebDriver.logger.deprecate(':desired_capabilities as a parameter for driver initialization',
+                                     ':capabilities with an Array value of capabilities/options if necessary',
+                                     id: :desired_capabilities)
+          desired_capabilities = Remote::Capabilities.new(desired_capabilities) if desired_capabilities.is_a?(Hash)
+          cap_array << desired_capabilities
+        end
 
-        desired_capabilities = opts.delete(:desired_capabilities) || Remote::Capabilities.send(browser || :new)
         options = opts.delete(:options)
+        if options
+          WebDriver.logger.deprecate(':options as a parameter for driver initialization',
+                                     ':capabilities with an Array of value capabilities/options if necessary',
+                                     id: :browser_options)
+          cap_array << options
+        end
 
-        bridge = Remote::Bridge.new(http_client: opts.delete(:http_client), url: opts.delete(:url))
-        raise ArgumentError, "Unable to create a driver with parameters: #{opts}" unless opts.empty?
+        capabilities = generate_capabilities(cap_array)
 
-        namespacing = self.class.to_s.split('::')
+        bridge_opts = {http_client: opts.delete(:http_client), url: opts.delete(:url)}
+        raise ArgumentError, "Unable to create a driver with parameters: #{opts}" unless opts.empty?
 
-        if Object.const_defined?("#{namespacing[0..-2].join('::')}::Bridge") && !namespacing.include?('Remote')
-          bridge.extend Object.const_get("#{namespacing[0, namespacing.length - 1].join('::')}::Bridge")
-        end
+        bridge = (respond_to?(:bridge_class) ? bridge_class : Remote::Bridge).new(**bridge_opts)
 
-        bridge.create_session(desired_capabilities, options)
+        bridge.create_session(capabilities)
         bridge
       end
 
+      def generate_capabilities(cap_array)
+        cap_array.map { |cap|
+          if cap.is_a? Symbol
+            cap = Remote::Capabilities.send(cap)
+          elsif cap.is_a? Hash
+            WebDriver.logger.deprecate("passing a Hash value to :capabilities",
+                                       'Capabilities instance initialized with the Hash, or build values with Options class',
+                                       id: :capabilities_hash)
+            cap = Remote::Capabilities.new(cap)
+          elsif !cap.respond_to? :as_json
+            msg = ":capabilities parameter only accepts objects responding to #as_json which #{cap.class} does not"
+            raise ArgumentError, msg
+          end
+          cap&.as_json
+        }.inject(:merge) || Remote::Capabilities.send(browser || :new)
+      end
+
       def service_url(opts)
-        @service = opts.delete(:service)
+        service_config = opts.delete(:service)
         %i[driver_opts driver_path port].each do |key|
           next unless opts.key? key
 
           WebDriver.logger.deprecate(":#{key}", ':service with an instance of Selenium::WebDriver::Service',
                                      id: "service_#{key}".to_sym)
         end
-        @service ||= Service.send(browser,
-                                  args: opts.delete(:driver_opts),
-                                  path: opts.delete(:driver_path),
-                                  port: opts.delete(:port))
-        @service.start
+        service_config ||= Service.send(browser,
+                                        args: opts.delete(:driver_opts),
+                                        path: opts.delete(:driver_path),
+                                        port: opts.delete(:port))
+        @service = service_config.launch
         @service.uri
       end
     end # Driver

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

@@ -40,7 +40,7 @@ module Selenium
                      :close,
                      :debug, :debug?,
                      :info, :info?,
-                     :warn, :warn?,
+                     :warn?,
                      :error, :error?,
                      :fatal, :fatal?,
                      :level, :level=

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

@@ -36,6 +36,7 @@ module Selenium
       # @option opts [String] :value A value
       # @option opts [String] :path ('/') A path
       # @option opts [String] :secure (false) A boolean
+      # @option opts [String] :same_site (Strict or Lax) currently supported only in chrome 80+ versions
       # @option opts [Time,DateTime,Numeric,nil] :expires (nil) Expiry date, either as a Time, DateTime, or seconds since epoch.
       #
       # @raise [ArgumentError] if :name or :value is not specified
@@ -48,6 +49,9 @@ module Selenium
         opts[:path] ||= '/'
         opts[:secure] ||= false
 
+        same_site = opts.delete(:same_site)
+        opts[:sameSite] = same_site if same_site
+
         obj = opts.delete(:expires)
         opts[:expiry] = seconds_from(obj).to_i if obj
 
@@ -169,6 +173,7 @@ module Selenium
           path: cookie['path'],
           domain: cookie['domain'] && strip_port(cookie['domain']),
           expires: cookie['expiry'] && datetime_at(cookie['expiry']),
+          same_site: cookie['sameSite'],
           secure: cookie['secure']
         }
       end

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

@@ -20,6 +20,19 @@
 module Selenium
   module WebDriver
     class Options
+      W3C_OPTIONS = %i[browser_name browser_version platform_name accept_insecure_certs page_load_strategy proxy
+                       set_window_rect timeouts unhandled_prompt_behavior strict_file_interactability].freeze
+
+      W3C_OPTIONS.each do |key|
+        define_method key do
+          @options[key]
+        end
+
+        define_method "#{key}=" do |value|
+          @options[key] = value
+        end
+      end
+
       attr_accessor :options
 
       def initialize(options: nil, **opts)
@@ -31,6 +44,7 @@ module Selenium
                    else
                      opts
                    end
+        @options[:browser_name] = self.class::BROWSER
       end
 
       #
@@ -55,22 +69,30 @@ module Selenium
       def as_json(*)
         options = @options.dup
 
-        opts = self.class::CAPABILITIES.each_with_object({}) do |(capability_alias, capability_name), hash|
+        w3c_options = options.select { |key, _val| W3C_OPTIONS.include?(key) }
+        options.delete_if { |key, _val| W3C_OPTIONS.include?(key) }
+
+        self.class::CAPABILITIES.each do |capability_alias, capability_name|
           capability_value = options.delete(capability_alias)
-          hash[capability_name] = capability_value unless capability_value.nil?
+          options[capability_name] = capability_value unless capability_value.nil?
         end
-        opts.merge(options)
+        browser_options = defined?(self.class::KEY) ? {self.class::KEY => options} : options
+
+        process_browser_options(browser_options) if private_methods(false).include?(:process_browser_options)
+        generate_as_json(w3c_options.merge(browser_options))
       end
 
       private
 
-      def generate_as_json(value)
+      def generate_as_json(value, camelize_keys: true)
         if value.respond_to?(:as_json)
           value.as_json
         elsif value.is_a?(Hash)
-          value.each_with_object({}) { |(key, val), hash| hash[convert_json_key(key)] = generate_as_json(val) }
+          value.each_with_object({}) do |(key, val), hash|
+            hash[convert_json_key(key, camelize: camelize_keys)] = generate_as_json(val, camelize_keys: camelize_keys)
+          end
         elsif value.is_a?(Array)
-          value.map(&method(:generate_as_json))
+          value.map { |val| generate_as_json(val, camelize_keys: camelize_keys) }
         elsif value.is_a?(Symbol)
           value.to_s
         else
@@ -78,15 +100,16 @@ module Selenium
         end
       end
 
-      def convert_json_key(key)
-        key = camel_case(key) if key.is_a?(Symbol)
+      def convert_json_key(key, camelize: true)
+        key = key.to_s if key.is_a?(Symbol)
+        key = camel_case(key) if camelize
         return key if key.is_a?(String)
 
         raise TypeError, "expected String or Symbol, got #{key.inspect}:#{key.class}"
       end
 
       def camel_case(str)
-        str.to_s.gsub(/_([a-z])/) { Regexp.last_match(1).upcase }
+        str.gsub(/_([a-z])/) { Regexp.last_match(1).upcase }
       end
     end # Options
   end # WebDriver

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

@@ -32,12 +32,10 @@ module Selenium
 
       def self.free?(port)
         Platform.interfaces.each do |host|
-          begin
-            TCPServer.new(host, port).close
-          rescue *IGNORED_ERRORS => e
-            WebDriver.logger.debug("port prober could not bind to #{host}:#{port} (#{e.message})")
-            # ignored - some machines appear unable to bind to some of their interfaces
-          end
+          TCPServer.new(host, port).close
+        rescue *IGNORED_ERRORS => e
+          WebDriver.logger.debug("port prober could not bind to #{host}:#{port} (#{e.message})")
+          # ignored - some machines appear unable to bind to some of their interfaces
         end
 
         true