selenium-webdriver 4.0.0.alpha3 → 4.0.0.alpha4

data/lib/selenium/webdriver/chrome.rb

@@ -30,13 +30,15 @@ module Selenium
 
       def self.driver_path=(path)
         WebDriver.logger.deprecate 'Selenium::WebDriver::Chrome#driver_path=',
-                                   'Selenium::WebDriver::Chrome::Service#driver_path='
+                                   'Selenium::WebDriver::Chrome::Service#driver_path=',
+                                   id: :driver_path
         Selenium::WebDriver::Chrome::Service.driver_path = path
       end
 
       def self.driver_path
         WebDriver.logger.deprecate 'Selenium::WebDriver::Chrome#driver_path',
-                                   'Selenium::WebDriver::Chrome::Service#driver_path'
+                                   'Selenium::WebDriver::Chrome::Service#driver_path',
+                                   id: :driver_path
         Selenium::WebDriver::Chrome::Service.driver_path
       end
 

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

@@ -32,22 +32,7 @@ module Selenium
         include DriverExtensions::HasLocation
         include DriverExtensions::TakesScreenshot
         include DriverExtensions::DownloadsFiles
-
-        def initialize(opts = {})
-          opts[:desired_capabilities] ||= Remote::Capabilities.send(browser)
-
-          opts[:url] ||= service_url(opts)
-
-          listener = opts.delete(:listener)
-          desired_capabilities = opts.delete(:desired_capabilities)
-          options = opts.delete(:options)
-
-          @bridge = Remote::Bridge.new(opts)
-          @bridge.extend Bridge
-          @bridge.create_session(desired_capabilities, options)
-
-          super(@bridge, listener: listener)
-        end
+        include DriverExtensions::HasDevTools
 
         def browser
           :chrome

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

@@ -169,7 +169,7 @@ module Selenium
         #   options = Selenium::WebDriver::Chrome::Options.new
         #   options.add_emulation(device_metrics: {width: 400, height: 800, pixelRatio: 1, touch: true})
         #
-        # @param [Hash] opts the pre-defined options for adding mobilie emulation values
+        # @param [Hash] opts the pre-defined options for adding mobile emulation values
         # @option opts [String] :device_name A valid device name from the Chrome DevTools Emulation panel
         # @option opts [Hash] :device_metrics Hash containing width, height, pixelRatio, touch
         # @option opts [String] :user_agent Full user agent

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

@@ -20,10 +20,6 @@
 module Selenium
   module WebDriver
     module Chrome
-      #
-      # @api private
-      #
-
       class Service < WebDriver::Service
         DEFAULT_PORT = 9515
         EXECUTABLE = 'chromedriver'

data/lib/selenium/webdriver/common.rb

@@ -62,6 +62,7 @@ require 'selenium/webdriver/common/driver_extensions/has_permissions'
 require 'selenium/webdriver/common/driver_extensions/has_debugger'
 require 'selenium/webdriver/common/driver_extensions/uploads_files'
 require 'selenium/webdriver/common/driver_extensions/has_addons'
+require 'selenium/webdriver/common/driver_extensions/has_devtools'
 require 'selenium/webdriver/common/keys'
 require 'selenium/webdriver/common/profile_helper'
 require 'selenium/webdriver/common/options'

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

@@ -71,10 +71,10 @@ module Selenium
       # @api private
       #
 
-      def initialize(bridge, listener: nil)
+      def initialize(bridge: nil, listener: nil, **opts)
         @service = nil
-        @bridge = bridge
-        @bridge = Support::EventFiringBridge.new(bridge, listener) if listener
+        bridge ||= create_bridge(opts)
+        @bridge = listener ? Support::EventFiringBridge.new(bridge, listener) : bridge
       end
 
       def inspect
@@ -276,7 +276,7 @@ module Selenium
       end
 
       def browser
-        bridge.browser
+        bridge&.browser
       end
 
       def capabilities
@@ -294,12 +294,32 @@ module Selenium
 
       attr_reader :bridge
 
+      def create_bridge(**opts)
+        opts[:url] ||= service_url(opts)
+
+        desired_capabilities = opts.delete(:desired_capabilities) || Remote::Capabilities.send(browser || :new)
+        options = opts.delete(:options)
+
+        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?
+
+        namespacing = self.class.to_s.split('::')
+
+        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.create_session(desired_capabilities, options)
+        bridge
+      end
+
       def service_url(opts)
         @service = 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')
+          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),

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

@@ -0,0 +1,38 @@
+# 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 HasDevTools
+
+        #
+        # Retrieves connection to DevTools.
+        #
+        # @return [DevTools]
+        #
+
+        def devtools
+          @devtools ||= DevTools.new(capabilities['goog:chromeOptions']['debuggerAddress'])
+        end
+
+      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

@@ -45,8 +45,12 @@ module Selenium
                      :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/options.rb

@@ -25,7 +25,8 @@ module Selenium
       def initialize(options: nil, **opts)
         @options = if options
                      WebDriver.logger.deprecate(":options as keyword for initializing #{self.class}",
-                                                "custom values directly in #new constructor")
+                                                "custom values directly in #new constructor",
+                                                id: :options_options)
                      opts.merge(options)
                    else
                      opts

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

@@ -34,8 +34,8 @@ module Selenium
         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})")
+          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
         end

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
         []

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

@@ -37,19 +37,6 @@ module Selenium
         end
 
         def firefox(**opts)
-          binary_path = Firefox::Binary.path
-          args = opts.delete(:args)
-          case args
-          when Hash
-            args[:binary] ||= binary_path
-            opts[:args] = args
-          when Array
-            opts[:args] = ["--binary=#{binary_path}"]
-            opts[:args] += args
-          else
-            opts[:args] = ["--binary=#{binary_path}"]
-          end
-
           Firefox::Service.new(**opts)
         end
 

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

@@ -69,8 +69,8 @@ module Selenium
         ChildProcess.close_on_exec @server
 
         true
-      rescue SocketError, Errno::EADDRINUSE, Errno::EBADF => ex
-        WebDriver.logger.debug("#{self}: #{ex.message}")
+      rescue SocketError, Errno::EADDRINUSE, Errno::EBADF => e
+        WebDriver.logger.debug("#{self}: #{e.message}")
         false
       end
 

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

@@ -55,7 +55,7 @@ module Selenium
           begin
             result = yield
             return result if result
-          rescue *@ignored => last_error
+          rescue *@ignored => last_error # rubocop:disable Naming/RescuedExceptionsVariableName
             # swallowed
           end
 

data/lib/selenium/webdriver/edge.rb

@@ -28,13 +28,15 @@ module Selenium
 
       def self.driver_path=(path)
         WebDriver.logger.deprecate 'Selenium::WebDriver::Edge#driver_path=',
-                                   'Selenium::WebDriver::Edge::Service#driver_path='
+                                   'Selenium::WebDriver::Edge::Service#driver_path=',
+                                   id: :driver_path
         Selenium::WebDriver::Edge::Service.driver_path = path
       end
 
       def self.driver_path
         WebDriver.logger.deprecate 'Selenium::WebDriver::Edge#driver_path',
-                                   'Selenium::WebDriver::Edge::Service#driver_path'
+                                   'Selenium::WebDriver::Edge::Service#driver_path',
+                                   id: :driver_path
         Selenium::WebDriver::Edge::Service.driver_path
       end
     end # EdgeHtml

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

@@ -33,6 +33,6 @@ module Selenium
           :edge_chrome
         end
       end # Driver
-    end # Chrome
+    end # EdgeChrome
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver/edge_chrome/service.rb

@@ -22,10 +22,6 @@ require 'selenium/webdriver/chrome/service'
 module Selenium
   module WebDriver
     module EdgeChrome
-      #
-      # @api private
-      #
-
       class Service < Selenium::WebDriver::Chrome::Service
         DEFAULT_PORT = 9515
         EXECUTABLE = 'msedgedriver'

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

@@ -30,24 +30,10 @@ module Selenium
         include DriverExtensions::HasWebStorage
         include DriverExtensions::TakesScreenshot
 
-        def initialize(opts = {})
-          opts[:desired_capabilities] ||= Remote::Capabilities.edge
-
-          opts[:url] ||= service_url(opts)
-
-          listener = opts.delete(:listener)
-          desired_capabilities = opts.delete(:desired_capabilities)
-
-          @bridge = Remote::Bridge.new(opts)
-          @bridge.create_session(desired_capabilities)
-
-          super(@bridge, listener: listener)
-        end
-
         def browser
           :edge
         end
       end # Driver
-    end # Edge
+    end # EdgeHtml
   end # WebDriver
 end # Selenium

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

@@ -86,6 +86,6 @@ module Selenium
           raise Error::WebDriverError, "could not find extension at #{path.inspect}" unless File.directory?(path)
         end
       end # Options
-    end # Edge
+    end # EdgeHtml
   end # WebDriver
 end # Selenium