selenium-webdriver 4.0.0.alpha1 → 4.0.0.alpha6

data/lib/selenium/webdriver/common/driver_extensions/{has_touch_screen.rb → has_devtools.rb}

@@ -20,17 +20,19 @@
 module Selenium
   module WebDriver
     module DriverExtensions
-      module HasTouchScreen
-        def touch
-          TouchActionBuilder.new Mouse.new(@bridge), Keyboard.new(@bridge), touch_screen
-        end
+      module HasDevTools
 
-        private
+        #
+        # Retrieves connection to DevTools.
+        #
+        # @return [DevTools]
+        #
 
-        def touch_screen
-          TouchScreen.new @bridge
+        def devtools
+          @devtools ||= DevTools.new(capabilities['goog:chromeOptions']['debuggerAddress'])
         end
-      end # HasTouchScreen
+
+      end # HasDevTools
     end # DriverExtensions
   end # WebDriver
 end # Selenium

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

@@ -35,7 +35,8 @@ module Selenium
           extension = File.extname(png_path).downcase
           if extension != '.png'
             WebDriver.logger.warn "name used for saved screenshot does not match file type. "\
-                                  "It should end with .png extension"
+                                  "It should end with .png extension",
+                                  id: :screenshot
           end
           File.open(png_path, 'wb') { |f| f << screenshot_as(:png) }
         end

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

@@ -40,13 +40,17 @@ module Selenium
                      :close,
                      :debug, :debug?,
                      :info, :info?,
-                     :warn, :warn?,
+                     :warn?,
                      :error, :error?,
                      :fatal, :fatal?,
                      :level, :level=
 
-      def initialize
-        @logger = create_logger($stdout)
+      #
+      # @param [String] progname Allow child projects to use Selenium's Logger pattern
+      #
+      def initialize(progname = 'Selenium')
+        @logger = create_logger(progname)
+        @ignored = []
       end
 
       #
@@ -73,28 +77,60 @@ module Selenium
         @logger.instance_variable_get(:@logdev).dev
       end
 
+      #
+      # Will not log the provided ID.
+      #
+      # @param [Array, Symbol] id
+      #
+      def ignore(id)
+        Array(id).each { |ignore| @ignored << ignore }
+      end
+
+      #
+      # Overrides default #warn to skip ignored messages by provided id
+      #
+      # @param [String] message
+      # @param [Symbol, Array<Sybmol>] id
+      # @yield see #deprecate
+      #
+      def warn(message, id: [])
+        id = Array(id)
+        return if (@ignored & id).any?
+
+        msg = id.empty? ? message : "[#{id.map(&:inspect).join(', ')}] #{message} "
+        msg += " #{yield}" if block_given?
+
+        @logger.warn { msg }
+      end
+
       #
       # Marks code as deprecated with/without replacement.
       #
       # @param [String] old
       # @param [String, nil] new
+      # @param [Symbol, Array<Sybmol>] id
+      # @yield appends additional message to end of provided template
       #
-      def deprecate(old, new = nil)
-        message = +"[DEPRECATION] #{old} is deprecated"
+      def deprecate(old, new = nil, id: [], &block)
+        id = Array(id)
+        return if @ignored.include?(:deprecations) || (@ignored & id).any?
+
+        ids = id.empty? ? '' : "[#{id.map(&:inspect).join(', ')}] "
+
+        message = +"[DEPRECATION] #{ids}#{old} is deprecated"
         message << if new
                      ". Use #{new} instead."
                    else
-                     ' and will be removed in the next releases.'
+                     ' and will be removed in a future release.'
                    end
-
-        warn message
+        warn message, &block
       end
 
       private
 
-      def create_logger(output)
-        logger = ::Logger.new(output)
-        logger.progname = 'Selenium'
+      def create_logger(name)
+        logger = ::Logger.new($stdout)
+        logger.progname = name
         logger.level = default_level
         logger.formatter = proc do |severity, time, progname, msg|
           "#{time.strftime('%F %T')} #{severity} #{progname} #{msg}\n"
@@ -104,11 +140,7 @@ module Selenium
       end
 
       def default_level
-        if $DEBUG || ENV.key?('DEBUG')
-          :debug
-        else
-          :warn
-        end
+        $DEBUG || ENV.key?('DEBUG') ? :debug : :warn
       end
     end # Logger
   end # WebDriver

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,157 +20,96 @@
 module Selenium
   module WebDriver
     class Options
-      #
-      # @api private
-      #
-
-      def initialize(bridge)
-        @bridge = bridge
-      end
-
-      #
-      # Add a cookie to the browser
-      #
-      # @param [Hash] opts the options to create a cookie with.
-      # @option opts [String] :name A name
-      # @option opts [String] :value A value
-      # @option opts [String] :path ('/') A path
-      # @option opts [String] :secure (false) A boolean
-      # @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
-      #
-
-      def add_cookie(opts = {})
-        raise ArgumentError, 'name is required' unless opts[:name]
-        raise ArgumentError, 'value is required' unless opts[:value]
+      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
 
-        opts[:path] ||= '/'
-        opts[:secure] ||= false
-
-        obj = opts.delete(:expires)
-        opts[:expiry] = seconds_from(obj).to_i if obj
+      W3C_OPTIONS.each do |key|
+        define_method key do
+          @options[key]
+        end
 
-        @bridge.add_cookie opts
+        define_method "#{key}=" do |value|
+          @options[key] = value
+        end
       end
 
-      #
-      # Get the cookie with the given name
-      #
-      # @param [String] name the name of the cookie
-      # @return [Hash, nil] the cookie, or nil if it wasn't found.
-      #
-
-      def cookie_named(name)
-        all_cookies.find { |c| c[:name] == name }
+      attr_accessor :options
+
+      def initialize(options: nil, **opts)
+        @options = if options
+                     WebDriver.logger.deprecate(":options as keyword for initializing #{self.class}",
+                                                "custom values directly in #new constructor",
+                                                id: :options_options)
+                     opts.merge(options)
+                   else
+                     opts
+                   end
+        @options[:browser_name] = self.class::BROWSER
       end
 
       #
-      # Delete the cookie with the given name
-      #
-      # @param [String] name the name of the cookie to delete
+      # Add a new option not yet handled by bindings.
       #
-
-      def delete_cookie(name)
-        @bridge.delete_cookie name
-      end
-
+      # @example Leave Chrome open when chromedriver is killed
+      #   options = Selenium::WebDriver::Chrome::Options.new
+      #   options.add_option(:detach, true)
       #
-      # Delete all cookies
+      # @param [String, Symbol] name Name of the option
+      # @param [Boolean, String, Integer] value Value of the option
       #
 
-      def delete_all_cookies
-        @bridge.delete_all_cookies
+      def add_option(name, value)
+        @options[name] = value
       end
 
       #
-      # Get all cookies
-      #
-      # @return [Array<Hash>] list of cookies
+      # @api private
       #
 
-      def all_cookies
-        @bridge.cookies.map { |cookie| convert_cookie(cookie) }
-      end
+      def as_json(*)
+        options = @options.dup
 
-      def timeouts
-        @timeouts ||= Timeouts.new(@bridge)
-      end
+        w3c_options = options.select { |key, _val| W3C_OPTIONS.include?(key) }
+        options.delete_if { |key, _val| W3C_OPTIONS.include?(key) }
 
-      #
-      # @api beta This API may be changed or removed in a future release.
-      #
-
-      def logs
-        @logs ||= Logs.new(@bridge)
-      end
-
-      #
-      # Create a new top-level browsing context
-      # https://w3c.github.io/webdriver/#new-window
-      # @param type [Symbol] Supports two values: :tab and :window.
-      #  Use :tab if you'd like the new window to share an OS-level window
-      #  with the current browsing context.
-      #  Use :window otherwise
-      # @return [String] The value of the window handle
-      #
-      def new_window(type = :tab)
-        case type
-        when :tab, :window
-          result = @bridge.new_window(type)
-          unless result.key?('handle')
-            raise UnknownError, "the driver did not return a handle. " \
-                                "The returned result: #{result.inspect}"
-          end
-          result['handle']
-        else
-          raise ArgumentError, "invalid argument for type. Got: '#{type.inspect}'. " \
-                               "Try :tab or :window"
+        self.class::CAPABILITIES.each do |capability_alias, capability_name|
+          capability_value = options.delete(capability_alias)
+          options[capability_name] = capability_value unless capability_value.nil?
         end
-      end
-
-      #
-      # @api beta This API may be changed or removed in a future release.
-      #
+        browser_options = defined?(self.class::KEY) ? {self.class::KEY => options} : options
 
-      def window
-        @window ||= Window.new(@bridge)
+        process_browser_options(browser_options) if private_methods(false).include?(:process_browser_options)
+        generate_as_json(w3c_options.merge(browser_options))
       end
 
       private
 
-      SECONDS_PER_DAY = 86_400.0
-
-      def datetime_at(int)
-        DateTime.civil(1970) + (int / SECONDS_PER_DAY)
-      end
-
-      def seconds_from(obj)
-        case obj
-        when Time
-          obj.to_f
-        when DateTime
-          (obj - DateTime.civil(1970)) * SECONDS_PER_DAY
-        when Numeric
-          obj
+      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({}) 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)
+          value.to_s
         else
-          raise ArgumentError, "invalid value for expiration date: #{obj.inspect}"
+          value
         end
       end
 
-      def strip_port(str)
-        str.split(':', 2).first
+      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 convert_cookie(cookie)
-        {
-          name: cookie['name'],
-          value: cookie['value'],
-          path: cookie['path'],
-          domain: cookie['domain'] && strip_port(cookie['domain']),
-          expires: cookie['expiry'] && datetime_at(cookie['expiry']),
-          secure: cookie['secure']
-        }
+      def camel_case(str)
+        str.gsub(/_([a-z])/) { Regexp.last_match(1).upcase }
       end
     end # Options
   end # WebDriver

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

@@ -96,6 +96,9 @@ module Selenium
         return false unless linux?
 
         File.read('/proc/version').include?('Microsoft')
+      rescue Errno::EACCES
+        # the file cannot be accessed on Linux on DeX
+        false
       end
 
       def cygwin?

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 => ex
-            WebDriver.logger.debug("port prober could not bind to #{host}:#{port} (#{ex.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

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

@@ -31,8 +31,16 @@ module Selenium
         base.extend ClassMethods
       end
 
+      def self.decoded(json)
+        JSON.parse(json).fetch('zip')
+      end
+
+      def encoded
+        Zipper.zip(layout_on_disk)
+      end
+
       def as_json(*)
-        {"zip" => Zipper.zip(layout_on_disk)}
+        {"zip" => encoded}
       end
 
       def to_json(*)
@@ -63,7 +71,7 @@ module Selenium
 
       module ClassMethods
         def from_json(json)
-          data = JSON.parse(json).fetch('zip')
+          data = decoded(json)
 
           # can't use Tempfile here since it doesn't support File::BINARY mode on 1.8
           # can't use Dir.mktmpdir(&blk) because of http://jira.codehaus.org/browse/JRUBY-4082

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

@@ -30,6 +30,7 @@ module Selenium
         link_text: 'link text',
         name: 'name',
         partial_link_text: 'partial link text',
+        relative: 'relative',
         tag_name: 'tag name',
         xpath: 'xpath'
       }.freeze
@@ -59,7 +60,7 @@ module Selenium
         by = FINDERS[how.to_sym]
         raise ArgumentError, "cannot find element by #{how.inspect}" unless by
 
-        bridge.find_element_by by, what.to_s, ref
+        bridge.find_element_by by, what, ref
       rescue Selenium::WebDriver::Error::TimeoutError
         # Implicit Wait times out in Edge
         raise Selenium::WebDriver::Error::NoSuchElementError
@@ -77,7 +78,7 @@ module Selenium
         by = FINDERS[how.to_sym]
         raise ArgumentError, "cannot find elements by #{how.inspect}" unless by
 
-        bridge.find_elements_by by, what.to_s, ref
+        bridge.find_elements_by by, what, ref
       rescue Selenium::WebDriver::Error::TimeoutError
         # Implicit Wait times out in Edge
         []