selenium-webdriver 3.12.0 → 3.142.7

data/lib/selenium/webdriver/chrome.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
@@ -18,7 +20,6 @@
 require 'net/http'
 
 require 'selenium/webdriver/chrome/bridge'
-require 'selenium/webdriver/chrome/service'
 require 'selenium/webdriver/chrome/driver'
 require 'selenium/webdriver/chrome/profile'
 require 'selenium/webdriver/chrome/options'
@@ -27,12 +28,15 @@ module Selenium
   module WebDriver
     module Chrome
       def self.driver_path=(path)
-        Platform.assert_executable path
-        @driver_path = path
+        WebDriver.logger.deprecate 'Selenium::WebDriver::Chrome#driver_path=',
+                                   'Selenium::WebDriver::Chrome::Service#driver_path='
+        Selenium::WebDriver::Chrome::Service.driver_path = path
       end
 
       def self.driver_path
-        @driver_path ||= nil
+        WebDriver.logger.deprecate 'Selenium::WebDriver::Chrome#driver_path',
+                                   'Selenium::WebDriver::Chrome::Service#driver_path'
+        Selenium::WebDriver::Chrome::Service.driver_path
       end
 
       def self.path=(path)
@@ -46,3 +50,5 @@ module Selenium
     end # Chrome
   end # WebDriver
 end # Selenium
+
+require 'selenium/webdriver/chrome/service'

data/lib/selenium/webdriver/chrome/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
@@ -21,8 +23,11 @@ module Selenium
       module Bridge
 
         COMMANDS = {
-          get_network_conditions: [:get, '/session/:session_id/chromium/network_conditions'.freeze],
-          set_network_conditions: [:post, '/session/:session_id/chromium/network_conditions'.freeze]
+          get_network_conditions: [:get, 'session/:session_id/chromium/network_conditions'],
+          set_network_conditions: [:post, 'session/:session_id/chromium/network_conditions'],
+          send_command: [:post, 'session/:session_id/goog/cdp/execute'],
+          get_available_log_types: [:get, 'session/:session_id/se/log/types'],
+          get_log: [:post, 'session/:session_id/se/log']
         }.freeze
 
         def commands(command)
@@ -33,10 +38,30 @@ module Selenium
           execute :get_network_conditions
         end
 
+        def send_command(command_params)
+          execute :send_command, {}, command_params
+        end
+
         def network_conditions=(conditions)
           execute :set_network_conditions, {}, {network_conditions: conditions}
         end
 
+        def available_log_types
+          types = execute :get_available_log_types
+          Array(types).map(&:to_sym)
+        end
+
+        def log(type)
+          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
+          end
+        end
       end # Bridge
     end # Chrome
   end # WebDriver

data/lib/selenium/webdriver/chrome/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
@@ -28,23 +30,17 @@ module Selenium
         include DriverExtensions::HasNetworkConditions
         include DriverExtensions::HasTouchScreen
         include DriverExtensions::HasWebStorage
+        include DriverExtensions::HasLocation
         include DriverExtensions::TakesScreenshot
+        include DriverExtensions::DownloadsFiles
 
         def initialize(opts = {})
           opts[:desired_capabilities] = create_capabilities(opts)
 
-          unless opts.key?(:url)
-            driver_path = opts.delete(:driver_path) || Chrome.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)
+          @bridge = Remote::Bridge.handshake(**opts)
           @bridge.extend Bridge
 
           super(@bridge, listener: listener)
@@ -57,7 +53,11 @@ module Selenium
         def quit
           super
         ensure
-          @service.stop if @service
+          @service&.stop
+        end
+
+        def execute_cdp(cmd, **params)
+          @bridge.send_command(cmd: cmd, params: params)
         end
 
         private
@@ -70,28 +70,35 @@ module Selenium
           if args
             WebDriver.logger.deprecate ':args or :switches', 'Selenium::WebDriver::Chrome::Options#add_argument'
             raise ArgumentError, ':args must be an Array of Strings' unless args.is_a? Array
+
             args.each { |arg| options.add_argument(arg.to_s) }
           end
 
           profile = opts.delete(:profile)
           if profile
+            WebDriver.logger.deprecate 'Selenium::WebDriver::Chrome::Driver#new with `:profile` parameter',
+                                       'Selenium::WebDriver::Chrome::Options#profile or Options#add_option'
+
             profile = profile.as_json
 
-            if options.args.none? { |arg| arg =~ /user-data-dir/ }
-              options.add_argument("--user-data-dir=#{profile[:directory]}")
+            if options.args.none?(&/user-data-dir/.method(:match?))
+              options.add_argument("--user-data-dir=#{profile['directory']}")
             end
 
-            if profile[:extensions]
-              WebDriver.logger.deprecate 'Using Selenium::WebDriver::Chrome::Profile#extensions',
+            if profile['extensions']
+              WebDriver.logger.deprecate 'Selenium::WebDriver::Chrome::Profile#extensions',
                                          'Selenium::WebDriver::Chrome::Options#add_extension'
-              profile[:extensions].each do |extension|
+              profile['extensions'].each do |extension|
                 options.add_encoded_extension(extension)
               end
             end
           end
 
-          detach = opts.delete(:detach)
-          options.add_option(:detach, true) if detach
+          if opts.key?(:detach)
+            WebDriver.logger.deprecate 'Selenium::WebDriver::Chrome::Driver#new with `:detach` parameter',
+                                       'Selenium::WebDriver::Chrome::Options#new or Options#add_option'
+            options.add_option(:detach, opts.delete(:detach))
+          end
 
           prefs = opts.delete(:prefs)
           if prefs
@@ -102,10 +109,15 @@ module Selenium
           end
 
           options = options.as_json
-          caps[:chrome_options] = options unless options.empty?
+          caps.merge!(options) unless options[Options::KEY].empty?
 
-          caps[:proxy] = opts.delete(:proxy) if opts.key?(:proxy)
-          caps[:proxy] ||= opts.delete('proxy') if opts.key?('proxy')
+          if opts.key?(:proxy) || opts.key?('proxy')
+            WebDriver.logger.deprecate 'Selenium::WebDriver::Chrome::Driver#new with `:proxy` parameter',
+                                       'Selenium::WebDriver::Chrome::Capabilities#proxy='
+
+            caps[:proxy] = opts.delete(:proxy) if opts.key?(:proxy)
+            caps[:proxy] ||= opts.delete('proxy') if opts.key?('proxy')
+          end
 
           caps
         end

data/lib/selenium/webdriver/chrome/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
@@ -18,9 +20,11 @@
 module Selenium
   module WebDriver
     module Chrome
-      class Options
+      class Options < WebDriver::Common::Options
         attr_reader :args, :prefs, :options, :emulation, :extensions, :encoded_extensions
-        attr_accessor :binary
+        attr_accessor :binary, :profile, :detach
+
+        KEY = 'goog:chromeOptions'
 
         #
         # Create a new Options instance.
@@ -45,6 +49,8 @@ module Selenium
           @extensions = opts.delete(:extensions) || []
           @options = opts.delete(:options) || {}
           @emulation = opts.delete(:emulation) || {}
+          @detach = opts.delete(:detach)
+          @profile = opts.delete(:profile)
           @encoded_extensions = []
         end
 
@@ -61,6 +67,7 @@ module Selenium
         def add_extension(path)
           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'
+
           @extensions << path
         end
 
@@ -132,9 +139,6 @@ module Selenium
 
         def headless!
           add_argument '--headless'
-
-          # https://bugs.chromium.org/p/chromium/issues/detail?id=737678#c1
-          add_argument '--disable-gpu' if WebDriver::Platform.windows?
         end
 
         #
@@ -168,6 +172,7 @@ module Selenium
             File.open(crx_path, 'rb') { |crx_file| Base64.strict_encode64 crx_file.read }
           end
           extensions.concat(@encoded_extensions)
+          add_argument("--user-data-dir=#{@profile[:directory]}") if @profile
 
           opts = @options
           opts[:binary] = @binary if @binary
@@ -175,7 +180,9 @@ module Selenium
           opts[:extensions] = extensions if extensions.any?
           opts[:mobileEmulation] = @emulation unless @emulation.empty?
           opts[:prefs] = @prefs unless @prefs.empty?
-          opts
+          opts[:detach] = @detach if !@detach.nil? && @detach != false
+
+          {KEY => generate_as_json(opts)}
         end
       end # Options
     end # Chrome

data/lib/selenium/webdriver/chrome/profile.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
@@ -34,9 +36,7 @@ module Selenium
         end
 
         def add_extension(path)
-          unless File.file?(path)
-            raise Error::WebDriverError, "could not find extension at #{path.inspect}"
-          end
+          raise Error::WebDriverError, "could not find extension at #{path.inspect}" unless File.file?(path)
 
           @extensions << path
         end
@@ -77,8 +77,8 @@ module Selenium
 
           extensions.concat(@encoded_extensions)
 
-          opts = {directory: @directory || layout_on_disk}
-          opts[:extensions] = extensions if extensions.any?
+          opts = {'directory' => directory || layout_on_disk}
+          opts['extensions'] = extensions if extensions.any?
           opts
         end
 
@@ -97,6 +97,7 @@ module Selenium
 
         def read_model_prefs
           return {} unless @model
+
           JSON.parse File.read(prefs_file_for(@model))
         end
 

data/lib/selenium/webdriver/chrome/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,28 +25,26 @@ module Selenium
       #
 
       class Service < WebDriver::Service
-        DEFAULT_PORT = 9515
-        @executable = 'chromedriver'.freeze
-        @missing_text = <<-ERROR.gsub(/\n +| {2,}/, ' ').freeze
+        @default_port = 9515
+        @executable = 'chromedriver'
+        @missing_text = <<~ERROR
           Unable to find chromedriver. Please download the server from
-          http://chromedriver.storage.googleapis.com/index.html and place it somewhere on your PATH.
+          https://chromedriver.storage.googleapis.com/index.html and place it somewhere on your PATH.
           More info at https://github.com/SeleniumHQ/selenium/wiki/ChromeDriver.
         ERROR
+        @shutdown_supported = true
 
-        private
-
-        def start_process
-          @process = build_process(@executable_path, "--port=#{@port}", *@extra_args)
-          @process.leader = true unless Platform.windows?
-          @process.start
+        def self.driver_path=(path)
+          Platform.assert_executable path if path.is_a?(String)
+          @driver_path = path
         end
 
-        def cannot_connect_error_text
-          "unable to connect to chromedriver #{@host}:#{@port}"
-        end
+        private
 
+        # Note: This processing is deprecated
         def extract_service_args(driver_opts)
           driver_args = super
+          driver_opts = driver_opts.dup
           driver_args << "--log-path=#{driver_opts.delete(:log_path)}" if driver_opts.key?(:log_path)
           driver_args << "--url-base=#{driver_opts.delete(:url_base)}" if driver_opts.key?(:url_base)
           driver_args << "--port-server=#{driver_opts.delete(:port_server)}" if driver_opts.key?(:port_server)

data/lib/selenium/webdriver/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
@@ -36,8 +38,8 @@ require 'selenium/webdriver/common/timeouts'
 require 'selenium/webdriver/common/window'
 require 'selenium/webdriver/common/logger'
 require 'selenium/webdriver/common/logs'
-require 'selenium/webdriver/common/options'
-require 'selenium/webdriver/common/w3c_options'
+require 'selenium/webdriver/common/manager'
+require 'selenium/webdriver/common/w3c_manager'
 require 'selenium/webdriver/common/search_context'
 require 'selenium/webdriver/common/action_builder'
 require 'selenium/webdriver/common/interactions/key_actions'
@@ -50,6 +52,7 @@ require 'selenium/webdriver/common/html5/session_storage'
 require 'selenium/webdriver/common/driver_extensions/takes_screenshot'
 require 'selenium/webdriver/common/driver_extensions/rotatable'
 require 'selenium/webdriver/common/driver_extensions/has_web_storage'
+require 'selenium/webdriver/common/driver_extensions/downloads_files'
 require 'selenium/webdriver/common/driver_extensions/has_location'
 require 'selenium/webdriver/common/driver_extensions/has_session_id'
 require 'selenium/webdriver/common/driver_extensions/has_touch_screen'
@@ -69,5 +72,6 @@ require 'selenium/webdriver/common/interactions/pointer_input'
 require 'selenium/webdriver/common/keys'
 require 'selenium/webdriver/common/bridge_helper'
 require 'selenium/webdriver/common/profile_helper'
+require 'selenium/webdriver/common/options'
 require 'selenium/webdriver/common/driver'
 require 'selenium/webdriver/common/element'

data/lib/selenium/webdriver/common/action_builder.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
@@ -319,7 +321,7 @@ module Selenium
       def drag_and_drop(source, target)
         click_and_hold source
         move_to        target
-        release        target
+        release
 
         self
       end

data/lib/selenium/webdriver/common/alert.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/common/bridge_helper.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
@@ -31,6 +33,7 @@ module Selenium
         when Hash
           element_id = element_id_from(arg)
           return Element.new(self, element_id) if element_id
+
           arg.each { |k, v| arg[k] = unwrap_script_result(v) }
         else
           arg
@@ -43,12 +46,12 @@ module Selenium
 
       def parse_cookie_string(str)
         result = {
-          'name'    => '',
-          'value'   => '',
-          'domain'  => '',
-          'path'    => '',
+          'name' => '',
+          'value' => '',
+          'domain' => '',
+          'path' => '',
           'expires' => '',
-          'secure'  => false
+          'secure' => false
         }
 
         str.split(';').each do |attribute|

data/lib/selenium/webdriver/common/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
@@ -73,7 +75,7 @@ module Selenium
       end
 
       def inspect
-        format '#<%s:0x%x browser=%s>', self.class, hash * 2, bridge.browser.inspect
+        format '#<%<class>s:0x%<hash>x browser=%<browser>s>', class: self.class, hash: hash * 2, browser: bridge.browser.inspect
       end
 
       #
@@ -95,12 +97,12 @@ module Selenium
       end
 
       #
-      # @return [Options]
-      # @see Options
+      # @return [Manager]
+      # @see Manager
       #
 
       def manage
-        bridge.options
+        bridge.manage
       end
 
       #
@@ -281,13 +283,26 @@ module Selenium
       # @see SearchContext
       #
 
-      def ref
-        nil
-      end
+      def ref; end
 
       private
 
       attr_reader :bridge
+
+      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')
+        end
+        @service ||= Service.send(browser,
+                                  args: opts.delete(:driver_opts),
+                                  path: opts.delete(:driver_path),
+                                  port: opts.delete(:port))
+        @service.start
+        @service.uri
+      end
     end # Driver
   end # WebDriver
 end # Selenium