selenium-webdriver 4.0.0.alpha6 → 4.0.0.beta4

data/lib/selenium/webdriver/common/driver_extensions/has_logs.rb

@@ -0,0 +1,30 @@
+# 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 DriverExtensions
+      module HasLogs
+        def logs
+          @logs ||= Logs.new(@bridge)
+        end
+      end # HasLogs
+    end # DriverExtensions
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/common/driver_extensions/has_network_connection.rb

@@ -17,40 +17,19 @@
 # specific language governing permissions and limitations
 # under the License.
 
+# TODO: Deprecated; Delete after 4.0 release
 module Selenium
   module WebDriver
     module DriverExtensions
       module HasNetworkConnection
         def network_connection_type
-          connection_value = @bridge.network_connection
-
-          connection_type = values_to_type[connection_value]
-
-          # In case the connection type is not recognized return the
-          # connection value.
-          connection_type || connection_value
-        end
-
-        def network_connection_type=(connection_type)
-          raise ArgumentError, 'Invalid connection type' unless valid_type? connection_type
-
-          connection_value = type_to_values[connection_type]
-
-          @bridge.network_connection = connection_value
-        end
-
-        private
-
-        def type_to_values
-          {airplane_mode: 1, wifi: 2, data: 4, all: 6, none: 0}
-        end
-
-        def values_to_type
-          type_to_values.invert
+          raise Error::UnsupportedOperationError,
+                'The W3C standard does not currently support getting network connection'
         end
 
-        def valid_type?(type)
-          type_to_values.key? type
+        def network_connection_type=(*)
+          raise Error::UnsupportedOperationError,
+                'The W3C standard does not currently support setting network connection'
         end
       end # HasNetworkConnection
     end # DriverExtensions

data/lib/selenium/webdriver/common/driver_extensions/has_network_interception.rb

@@ -0,0 +1,67 @@
+# 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 DriverExtensions
+      module HasNetworkInterception
+
+        #
+        # Intercepts requests coming from browser allowing
+        # to either pass them through like proxy or provide
+        # a stubbed response instead.
+        #
+        # @example Log requests and pass through
+        #   driver.intercept do |request|
+        #     puts "#{request.method} #{request.url}"
+        #     request.continue
+        #   end
+        #
+        # @example Stub response for image requests
+        #   driver.intercept do |request|
+        #     if request.url.match?(/\.png$/)
+        #       request.respond(body: File.read('myfile.png'))
+        #     else
+        #       request.continue
+        #     end
+        #   end
+        #
+        # @param [#call] block which is called when request is interecepted
+        # @yieldparam [DevTools::Request]
+        #
+
+        def intercept
+          devtools.network.set_cache_disabled(cache_disabled: true)
+          devtools.fetch.on(:request_paused) do |params|
+            request = DevTools::Request.new(
+              devtools: devtools,
+              id: params['requestId'],
+              url: params.dig('request', 'url'),
+              method: params.dig('request', 'method'),
+              headers: params.dig('request', 'headers')
+            )
+            yield request
+          end
+          devtools.fetch.enable
+        end
+
+      end # HasNetworkInterception
+    end # DriverExtensions
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/common/driver_extensions/has_remote_status.rb

@@ -22,6 +22,7 @@ module Selenium
     module DriverExtensions
       module HasRemoteStatus
         def remote_status
+          WebDriver.logger.deprecate('#remote_status', '#status')
           @bridge.status
         end
       end # HasRemoteStatus

data/lib/selenium/webdriver/common/driver_extensions/{rotatable.rb → prints_page.rb}

@@ -19,43 +19,41 @@
 
 module Selenium
   module WebDriver
-    #
-    # @api private
-    #
-
     module DriverExtensions
-      module Rotatable
-        ORIENTATIONS = %i[landscape portrait].freeze
-
+      module PrintsPage
+        #
+        # Save a page as a PDF to the given path
         #
-        # Change the screen orientation
+        # @example Save Printed Page
+        #   driver.save_print_page('../printed_page.pdf')
         #
-        # @param [:landscape, :portrait] orientation
+        # @param [String] path to where the pdf should be saved
         #
         # @api public
         #
 
-        def rotation=(orientation)
-          unless ORIENTATIONS.include?(orientation)
-            raise ArgumentError, "expected #{ORIENTATIONS.inspect}, got #{orientation.inspect}"
+        def save_print_page(path, **options)
+          File.open(path, 'wb') do |file|
+            content = Base64.decode64 print_page(options)
+            file << content
           end
-
-          bridge.screen_orientation = orientation.to_s.upcase
         end
-        alias_method :rotate, :rotation=
 
         #
-        # Get the current screen orientation
+        # Return a Base64 encoded Print Page as a string
         #
-        # @return [:landscape, :portrait] orientation
+        # @see https://w3c.github.io/webdriver/#print-page
         #
         # @api public
         #
 
-        def orientation
-          bridge.screen_orientation.to_sym.downcase
+        def print_page(**options)
+          options[:pageRanges] = Array(options.delete(:page_ranges)) || []
+          options[:shrinkToFit] = options.delete(:shrink_to_fit) { true }
+
+          @bridge.print_page(options)
         end
-      end # Rotatable
+      end # PrintsPage
     end # DriverExtensions
   end # WebDriver
 end # Selenium

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

@@ -23,6 +23,7 @@ module Selenium
       ELEMENT_KEY = 'element-6066-11e4-a52e-4f735466cecf'
 
       include SearchContext
+      include TakesScreenshot
 
       #
       # Creates a new Element
@@ -91,13 +92,18 @@ module Selenium
       end
 
       #
-      # Get the value of a the given attribute of the element. Will return the current value, even if
-      # this has been modified after the page has been loaded. More exactly, this method will return
-      # the value of the given attribute, unless that attribute is not present, in which case the
-      # value of the property with the same name is returned. If neither value is set, nil is
-      # returned. The "style" attribute is converted as best can be to a text representation with a
-      # trailing semi-colon. The following are deemed to be "boolean" attributes, and will
-      # return either "true" or "false":
+      # This method attempts to provide the most likely desired current value for the attribute
+      # of the element, even when that desired value is actually a JavaScript property.
+      # It is implemented with a custom JavaScript atom. To obtain the exact value of the attribute or property,
+      # use #dom_attribute or #property methods respectively.
+      #
+      # More exactly, this method will return the value of the property with the given name,
+      # if it exists. If it does not, then the value of the attribute with the given name is returned.
+      # If neither exists, null is returned.
+      #
+      # The "style" attribute is converted as best can be to a text representation with a trailing semi-colon.
+      #
+      # The following are deemed to be "boolean" attributes, and will return either "true" or "false":
       #
       # async, autofocus, autoplay, checked, compact, complete, controls, declare, defaultchecked,
       # defaultselected, defer, disabled, draggable, ended, formnovalidate, hidden, indeterminate,
@@ -105,22 +111,46 @@ module Selenium
       # nowrap, open, paused, pubdate, readonly, required, reversed, scoped, seamless, seeking,
       # selected, spellcheck, truespeed, willvalidate
       #
-      # Finally, the following commonly mis-capitalized attribute/property names are evaluated as
-      # expected:
+      # Finally, the following commonly mis-capitalized attribute/property names are evaluated as expected:
       #
-      # class, readonly
+      # When the value of "class" is requested, the "className" property is returned.
+      # When the value of "readonly" is requested, the "readOnly" property is returned.
       #
       # @param [String] name attribute name
       # @return [String, nil] attribute value
       #
+      # @see #dom_attribute
+      # @see #property
+      #
 
       def attribute(name)
         bridge.element_attribute self, name
       end
 
       #
-      # Get the value of a the given property with the same name of the element. If the value is not
-      # set, nil is returned.
+      # Gets the value of a declared HTML attribute of this element.
+      #
+      # As opposed to the #attribute method, this method
+      # only returns attributes declared in the element's HTML markup.
+      #
+      # If the attribute is not set, nil is returned.
+      #
+      # @param [String] name attribute name
+      # @return [String, nil] attribute value
+      #
+      # @see #attribute
+      # @see #property
+      #
+
+      def dom_attribute(name)
+        bridge.element_dom_attribute self, name
+      end
+
+      #
+      # Gets the value of a JavaScript property of this element
+      # This will return the current value,
+      # even if this has been modified after the page has been loaded.
+      # If the value is not set, nil is returned.
       #
       # @param [String] name property name
       # @return [String, nil] property value
@@ -130,6 +160,26 @@ module Selenium
         bridge.element_property self, name
       end
 
+      #
+      # Gets the computed WAI-ARIA role of element
+      #
+      # @return [String]
+      #
+
+      def aria_role
+        bridge.element_aria_role self
+      end
+
+      #
+      # Gets the computed WAI-ARIA label of element.
+      #
+      # @return [String]
+      #
+
+      def accessible_name
+        bridge.element_aria_label self
+      end
+
       #
       # Get the text content of this element
       #
@@ -327,6 +377,10 @@ module Selenium
 
         tn == 'option' || (tn == 'input' && %w[radio checkbox].include?(type))
       end
+
+      def screenshot
+        bridge.element_screenshot(self)
+      end
     end # Element
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver/common/interactions/interaction.rb

@@ -26,7 +26,10 @@ module Selenium
         attr_reader :source
 
         def initialize(source)
-          raise TypeError, "#{source.type} is not a valid input type" unless Interactions::SOURCE_TYPES.include? source.type
+          unless Interactions::SOURCE_TYPES.include? source.type
+            raise TypeError,
+                  "#{source.type} is not a valid input type"
+          end
 
           @source = source
         end

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

@@ -108,10 +108,11 @@ module Selenium
       #
       # @param [String] old
       # @param [String, nil] new
-      # @param [Symbol, Array<Sybmol>] id
+      # @param [Symbol, Array<Symbol>] id
+      # @param [String] reference
       # @yield appends additional message to end of provided template
       #
-      def deprecate(old, new = nil, id: [], &block)
+      def deprecate(old, new = nil, id: [], reference: '', &block)
         id = Array(id)
         return if @ignored.include?(:deprecations) || (@ignored & id).any?
 
@@ -123,6 +124,8 @@ module Selenium
                    else
                      ' and will be removed in a future release.'
                    end
+        message << " See explanation for this deprecation: #{reference}." unless reference.empty?
+
         warn message, &block
       end
 

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

@@ -46,12 +46,15 @@ module Selenium
         raise ArgumentError, 'name is required' unless opts[:name]
         raise ArgumentError, 'value is required' unless opts[:value]
 
-        opts[:path] ||= '/'
+        # NOTE: This is required because of https://bugs.chromium.org/p/chromedriver/issues/detail?id=3732
         opts[:secure] ||= false
 
         same_site = opts.delete(:same_site)
         opts[:sameSite] = same_site if same_site
 
+        http_only = opts.delete(:http_only)
+        opts[:httpOnly] = http_only if http_only
+
         obj = opts.delete(:expires)
         opts[:expiry] = seconds_from(obj).to_i if obj
 
@@ -106,6 +109,7 @@ module Selenium
       #
 
       def logs
+        WebDriver.logger.deprecate('Manager#logs', 'Chrome::Driver#logs')
         @logs ||= Logs.new(@bridge)
       end
 
@@ -174,6 +178,7 @@ module Selenium
           domain: cookie['domain'] && strip_port(cookie['domain']),
           expires: cookie['expiry'] && datetime_at(cookie['expiry']),
           same_site: cookie['sameSite'],
+          http_only: cookie['httpOnly'],
           secure: cookie['secure']
         }
       end

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

@@ -23,19 +23,51 @@ module Selenium
       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]
+      class << self
+        attr_reader :driver_path
+
+        def chrome(**opts)
+          Chrome::Options.new(**opts)
+        end
+
+        def firefox(**opts)
+          Firefox::Options.new(**opts)
+        end
+
+        def ie(**opts)
+          IE::Options.new(**opts)
+        end
+        alias_method :internet_explorer, :ie
+
+        def edge(**opts)
+          Edge::Options.new(**opts)
+        end
+        alias_method :microsoftedge, :edge
+
+        def safari(**opts)
+          Safari::Options.new(**opts)
         end
 
-        define_method "#{key}=" do |value|
-          @options[key] = value
+        def set_capabilities
+          (W3C_OPTIONS + self::CAPABILITIES.keys).each do |key|
+            next if method_defined? key
+
+            define_method key do
+              @options[key]
+            end
+
+            define_method "#{key}=" do |value|
+              @options[key] = value
+            end
+          end
         end
       end
 
       attr_accessor :options
 
       def initialize(options: nil, **opts)
+        self.class.set_capabilities
+
         @options = if options
                      WebDriver.logger.deprecate(":options as keyword for initializing #{self.class}",
                                                 "custom values directly in #new constructor",
@@ -62,6 +94,14 @@ module Selenium
         @options[name] = value
       end
 
+      def ==(other)
+        return false unless other.is_a? self.class
+
+        as_json == other.as_json
+      end
+
+      alias_method :eql?, :==
+
       #
       # @api private
       #
@@ -69,28 +109,40 @@ module Selenium
       def as_json(*)
         options = @options.dup
 
-        w3c_options = options.select { |key, _val| W3C_OPTIONS.include?(key) }
-        options.delete_if { |key, _val| W3C_OPTIONS.include?(key) }
+        w3c_options = process_w3c_options(options)
 
         self.class::CAPABILITIES.each do |capability_alias, capability_name|
           capability_value = options.delete(capability_alias)
-          options[capability_name] = capability_value unless capability_value.nil?
+          options[capability_name] = capability_value if !capability_value.nil? && !options.key?(capability_name)
         end
         browser_options = defined?(self.class::KEY) ? {self.class::KEY => options} : options
 
-        process_browser_options(browser_options) if private_methods(false).include?(:process_browser_options)
+        process_browser_options(browser_options)
         generate_as_json(w3c_options.merge(browser_options))
       end
 
       private
 
+      def process_w3c_options(options)
+        w3c_options = options.select { |key, _val| W3C_OPTIONS.include?(key) }
+        w3c_options[:unhandled_prompt_behavior] &&= w3c_options[:unhandled_prompt_behavior]&.to_s&.tr('_', ' ')
+        options.delete_if { |key, _val| W3C_OPTIONS.include?(key) }
+        w3c_options
+      end
+
+      def process_browser_options(_browser_options)
+        nil
+      end
+
+      def camelize?(_key)
+        true
+      end
+
       def generate_as_json(value, camelize_keys: true)
-        if value.respond_to?(:as_json)
+        if value.is_a?(Hash)
+          process_json_hash(value, camelize_keys)
+        elsif value.respond_to?(:as_json)
           value.as_json
-        elsif value.is_a?(Hash)
-          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 { |val| generate_as_json(val, camelize_keys: camelize_keys) }
         elsif value.is_a?(Symbol)
@@ -100,6 +152,16 @@ module Selenium
         end
       end
 
+      def process_json_hash(value, camelize_keys)
+        value.each_with_object({}) do |(key, val), hash|
+          next if val.respond_to?(:empty?) && val.empty?
+
+          camelize = camelize_keys ? camelize?(key) : false
+          key = convert_json_key(key, camelize: camelize)
+          hash[key] = generate_as_json(val, camelize_keys: camelize)
+        end
+      end
+
       def convert_json_key(key, camelize: true)
         key = key.to_s if key.is_a?(Symbol)
         key = camel_case(key) if camelize