selenium-webdriver 3.142.7 → 4.16.0

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

@@ -17,109 +17,32 @@
 # specific language governing permissions and limitations
 # under the License.
 
+require 'selenium/webdriver/chromium/driver'
+
 module Selenium
   module WebDriver
     module Chrome
-
       #
       # Driver implementation for Chrome.
       # @api private
       #
 
-      class Driver < WebDriver::Driver
-        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)
+      class Driver < Chromium::Driver
+        include LocalDriver
 
-          opts[:url] ||= service_url(opts)
-
-          listener = opts.delete(:listener)
-          @bridge = Remote::Bridge.handshake(**opts)
-          @bridge.extend Bridge
-
-          super(@bridge, listener: listener)
+        def initialize(options: nil, service: nil, url: nil, **opts)
+          caps, url = initialize_local_driver(options, service, url)
+          super(caps: caps, url: url, **opts)
         end
 
         def browser
           :chrome
         end
 
-        def quit
-          super
-        ensure
-          @service&.stop
-        end
-
-        def execute_cdp(cmd, **params)
-          @bridge.send_command(cmd: cmd, params: params)
-        end
-
         private
 
-        def create_capabilities(opts)
-          caps = opts.delete(:desired_capabilities) { Remote::Capabilities.chrome }
-          options = opts.delete(:options) { Options.new }
-
-          args = opts.delete(:args) || opts.delete(:switches)
-          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?(&/user-data-dir/.method(:match?))
-              options.add_argument("--user-data-dir=#{profile['directory']}")
-            end
-
-            if profile['extensions']
-              WebDriver.logger.deprecate 'Selenium::WebDriver::Chrome::Profile#extensions',
-                                         'Selenium::WebDriver::Chrome::Options#add_extension'
-              profile['extensions'].each do |extension|
-                options.add_encoded_extension(extension)
-              end
-            end
-          end
-
-          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
-            WebDriver.logger.deprecate ':prefs', 'Selenium::WebDriver::Chrome::Options#add_preference'
-            prefs.each do |key, value|
-              options.add_preference(key, value)
-            end
-          end
-
-          options = options.as_json
-          caps.merge!(options) unless options[Options::KEY].empty?
-
-          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
+        def devtools_address
+          "http://#{capabilities['goog:chromeOptions']['debuggerAddress']}"
         end
       end # Driver
     end # Chrome

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

@@ -0,0 +1,48 @@
+# 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.
+
+require 'selenium/webdriver/chromium/features'
+
+module Selenium
+  module WebDriver
+    module Chrome
+      module Features
+        include WebDriver::Chromium::Features
+
+        CHROME_COMMANDS = {
+          get_cast_sinks: [:get, 'session/:session_id/goog/cast/get_sinks'],
+          set_cast_sink_to_use: [:post, 'session/:session_id/goog/cast/set_sink_to_use'],
+          start_cast_tab_mirroring: [:post, 'session/:session_id/goog/cast/start_tab_mirroring'],
+          start_cast_desktop_mirroring: [:post, 'session/:session_id/goog/cast/start_desktop_mirroring'],
+          get_cast_issue_message: [:get, 'session/:session_id/goog/cast/get_issue_message'],
+          stop_casting: [:post, 'session/:session_id/goog/cast/stop_casting'],
+          send_command: [:post, 'session/:session_id/goog/cdp/execute']
+        }.freeze
+
+        def command_list
+          CHROME_COMMANDS.merge(CHROMIUM_COMMANDS).merge(self.class::COMMANDS)
+        end
+
+        def commands(command)
+          command_list[command]
+        end
+      end # Bridge
+    end # Chrome
+  end # WebDriver
+end # Selenium

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

@@ -17,172 +17,23 @@
 # specific language governing permissions and limitations
 # under the License.
 
+require 'selenium/webdriver/chromium/options'
+
 module Selenium
   module WebDriver
     module Chrome
-      class Options < WebDriver::Common::Options
-        attr_reader :args, :prefs, :options, :emulation, :extensions, :encoded_extensions
-        attr_accessor :binary, :profile, :detach
-
+      class Options < Chromium::Options
         KEY = 'goog:chromeOptions'
+        BROWSER = 'chrome'
 
-        #
-        # Create a new Options instance.
-        #
-        # @example
-        #   options = Selenium::WebDriver::Chrome::Options.new(args: ['start-maximized', 'user-data-dir=/tmp/temp_profile'])
-        #   driver = Selenium::WebDriver.for(:chrome, options: options)
-        #
-        # @param [Hash] opts the pre-defined options to create the Chrome::Options with
-        # @option opts [Array<String>] :args List of command-line arguments to use when starting Chrome
-        # @option opts [String] :binary Path to the Chrome executable to use
-        # @option opts [Hash] :prefs A hash with each entry consisting of the name of the preference and its value
-        # @option opts [Array<String>] :extensions A list of paths to (.crx) Chrome extensions to install on startup
-        # @option opts [Hash] :options A hash for raw options
-        # @option opts [Hash] :emulation A hash for raw emulation options
-        #
-
-        def initialize(**opts)
-          @args = Set.new(opts.delete(:args) || [])
-          @binary = opts.delete(:binary) || Chrome.path
-          @prefs = opts.delete(:prefs) || {}
-          @extensions = opts.delete(:extensions) || []
-          @options = opts.delete(:options) || {}
-          @emulation = opts.delete(:emulation) || {}
-          @detach = opts.delete(:detach)
-          @profile = opts.delete(:profile)
-          @encoded_extensions = []
-        end
-
-        #
-        # Add an extension by local path.
-        #
-        # @example
-        #   options = Selenium::WebDriver::Chrome::Options.new
-        #   options.add_extension('/path/to/extension.crx')
-        #
-        # @param [String] path The local path to the .crx file
-        #
-
-        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
-
-        #
-        # Add an extension by Base64-encoded string.
-        #
-        # @example
-        #   options = Selenium::WebDriver::Chrome::Options.new
-        #   options.add_encoded_extension(encoded_string)
-        #
-        # @param [String] encoded The Base64-encoded string of the .crx file
-        #
+        private
 
-        def add_encoded_extension(encoded)
-          @encoded_extensions << encoded
+        def enable_logging(browser_options)
+          browser_options['goog:loggingPrefs'] = @logging_prefs
         end
 
-        #
-        # Add a command-line argument to use when starting Chrome.
-        #
-        # @example Start Chrome maximized
-        #   options = Selenium::WebDriver::Chrome::Options.new
-        #   options.add_argument('start-maximized')
-        #
-        # @param [String] arg The command-line argument to add
-        #
-
-        def add_argument(arg)
-          @args << arg
-        end
-
-        #
-        # Add a new option not yet handled by bindings.
-        #
-        # @example Leave Chrome open when chromedriver is killed
-        #   options = Selenium::WebDriver::Chrome::Options.new
-        #   options.add_option(:detach, true)
-        #
-        # @param [String, Symbol] name Name of the option
-        # @param [Boolean, String, Integer] value Value of the option
-        #
-
-        def add_option(name, value)
-          @options[name] = value
-        end
-
-        #
-        # Add a preference that is only applied to the user profile in use.
-        #
-        # @example Set the default homepage
-        #   options = Selenium::WebDriver::Chrome::Options.new
-        #   options.add_preference('homepage', 'http://www.seleniumhq.com/')
-        #
-        # @param [String] name Key of the preference
-        # @param [Boolean, String, Integer] value Value of the preference
-        #
-
-        def add_preference(name, value)
-          prefs[name] = value
-        end
-
-        #
-        # Run Chrome in headless mode.
-        #
-        # @example Enable headless mode
-        #   options = Selenium::WebDriver::Chrome::Options.new
-        #   options.headless!
-        #
-
-        def headless!
-          add_argument '--headless'
-        end
-
-        #
-        # Add an emulation device name
-        #
-        # @example Start Chrome in mobile emulation mode by device name
-        #   options = Selenium::WebDriver::Chrome::Options.new
-        #   options.add_emulation(device_name: 'iPhone 6')
-        #
-        # @example Start Chrome in mobile emulation mode by device metrics
-        #   options = Selenium::WebDriver::Chrome::Options.new
-        #   options.add_emulation(device_metrics: {width: 400, height: 800, pixelRatio: 1, touch: true})
-        #
-        # @param [String] device_name Name of the device or a hash containing width, height, pixelRatio, touch
-        # @param [Hash] device_metrics Hash containing width, height, pixelRatio, touch
-        # @param [String] user_agent Full user agent
-        #
-
-        def add_emulation(device_name: nil, device_metrics: nil, user_agent: nil)
-          @emulation[:deviceName] = device_name if device_name
-          @emulation[:deviceMetrics] = device_metrics if device_metrics
-          @emulation[:userAgent] = user_agent if user_agent
-        end
-
-        #
-        # @api private
-        #
-
-        def as_json(*)
-          extensions = @extensions.map do |crx_path|
-            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
-          opts[:args] = @args.to_a if @args.any?
-          opts[:extensions] = extensions if extensions.any?
-          opts[:mobileEmulation] = @emulation unless @emulation.empty?
-          opts[:prefs] = @prefs unless @prefs.empty?
-          opts[:detach] = @detach if !@detach.nil? && @detach != false
-
-          {KEY => generate_as_json(opts)}
+        def binary_path
+          Chrome.path
         end
       end # Options
     end # Chrome

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

@@ -17,6 +17,8 @@
 # specific language governing permissions and limitations
 # under the License.
 
+require 'selenium/webdriver/chromium/profile'
+
 module Selenium
   module WebDriver
     module Chrome
@@ -24,86 +26,7 @@ module Selenium
       # @private
       #
 
-      class Profile
-        include ProfileHelper
-
-        attr_reader :directory
-
-        def initialize(model = nil)
-          @model = verify_model(model)
-          @extensions = []
-          @encoded_extensions = []
-        end
-
-        def add_extension(path)
-          raise Error::WebDriverError, "could not find extension at #{path.inspect}" unless File.file?(path)
-
-          @extensions << path
-        end
-
-        def add_encoded_extension(encoded)
-          @encoded_extensions << encoded
-        end
-
-        #
-        # Set a preference in the profile.
-        #
-        # See https://src.chromium.org/svn/trunk/src/chrome/common/pref_names.cc
-        #
-
-        def []=(key, value)
-          parts = key.split('.')
-          parts[0..-2].inject(prefs) { |a, e| a[e] ||= {} }[parts.last] = value
-        end
-
-        def [](key)
-          parts = key.split('.')
-          parts.inject(prefs) { |a, e| a.fetch(e) }
-        end
-
-        def layout_on_disk
-          @directory = @model ? create_tmp_copy(@model) : Dir.mktmpdir('webdriver-chrome-profile')
-          FileReaper << @directory
-
-          write_prefs_to @directory
-
-          @directory
-        end
-
-        def as_json(*)
-          extensions = @extensions.map do |crx_path|
-            File.open(crx_path, 'rb') { |crx_file| Base64.strict_encode64 crx_file.read }
-          end
-
-          extensions.concat(@encoded_extensions)
-
-          opts = {'directory' => directory || layout_on_disk}
-          opts['extensions'] = extensions if extensions.any?
-          opts
-        end
-
-        private
-
-        def write_prefs_to(dir)
-          prefs_file = prefs_file_for(dir)
-
-          FileUtils.mkdir_p File.dirname(prefs_file)
-          File.open(prefs_file, 'w') { |file| file << JSON.generate(prefs) }
-        end
-
-        def prefs
-          @prefs ||= read_model_prefs
-        end
-
-        def read_model_prefs
-          return {} unless @model
-
-          JSON.parse File.read(prefs_file_for(@model))
-        end
-
-        def prefs_file_for(dir)
-          File.join dir, 'Default', 'Preferences'
-        end
+      class Profile < Chromium::Profile
       end # Profile
     end # Chrome
   end # WebDriver

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

@@ -20,38 +20,16 @@
 module Selenium
   module WebDriver
     module Chrome
-      #
-      # @api private
-      #
-
       class Service < WebDriver::Service
-        @default_port = 9515
-        @executable = 'chromedriver'
-        @missing_text = <<~ERROR
-          Unable to find chromedriver. Please download the server from
-          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
-
-        def self.driver_path=(path)
-          Platform.assert_executable path if path.is_a?(String)
-          @driver_path = path
-        end
+        DEFAULT_PORT = 9515
+        EXECUTABLE = 'chromedriver'
+        SHUTDOWN_SUPPORTED = true
 
-        private
+        def log
+          return @log unless @log.is_a? String
 
-        # 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)
-          driver_args << "--whitelisted-ips=#{driver_opts.delete(:whitelisted_ips)}" if driver_opts.key?(:whitelisted_ips)
-          driver_args << "--verbose" if driver_opts.key?(:verbose)
-          driver_args << "--silent" if driver_opts.key?(:silent)
-          driver_args
+          @args << "--log-path=#{@log}"
+          @log = nil
         end
       end # Service
     end # Chrome

data/lib/selenium/webdriver/chrome.rb

@@ -17,27 +17,14 @@
 # specific language governing permissions and limitations
 # under the License.
 
-require 'net/http'
-
-require 'selenium/webdriver/chrome/bridge'
-require 'selenium/webdriver/chrome/driver'
-require 'selenium/webdriver/chrome/profile'
-require 'selenium/webdriver/chrome/options'
-
 module Selenium
   module WebDriver
     module Chrome
-      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 = 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
-      end
+      autoload :Features, 'selenium/webdriver/chrome/features'
+      autoload :Driver, 'selenium/webdriver/chrome/driver'
+      autoload :Profile, 'selenium/webdriver/chrome/profile'
+      autoload :Options, 'selenium/webdriver/chrome/options'
+      autoload :Service, 'selenium/webdriver/chrome/service'
 
       def self.path=(path)
         Platform.assert_executable path
@@ -50,5 +37,3 @@ module Selenium
     end # Chrome
   end # WebDriver
 end # Selenium
-
-require 'selenium/webdriver/chrome/service'

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

@@ -0,0 +1,60 @@
+# 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 Chromium
+      #
+      # Driver implementation for Chrome.
+      # @api private
+      #
+
+      class Driver < WebDriver::Driver
+        EXTENSIONS = [DriverExtensions::HasCDP,
+                      DriverExtensions::HasBiDi,
+                      DriverExtensions::HasCasting,
+                      DriverExtensions::HasNetworkConditions,
+                      DriverExtensions::HasNetworkInterception,
+                      DriverExtensions::HasWebStorage,
+                      DriverExtensions::HasLaunching,
+                      DriverExtensions::HasPermissions,
+                      DriverExtensions::DownloadsFiles,
+                      DriverExtensions::HasDevTools,
+                      DriverExtensions::HasAuthentication,
+                      DriverExtensions::HasLogs,
+                      DriverExtensions::HasLogEvents,
+                      DriverExtensions::HasPinnedScripts,
+                      DriverExtensions::PrintsPage].freeze
+
+        protected
+
+        def devtools_url
+          uri = URI(devtools_address)
+          response = Net::HTTP.get(uri.hostname, '/json/version', uri.port)
+
+          JSON.parse(response)['webSocketDebuggerUrl']
+        end
+
+        def devtools_version
+          Integer(capabilities.browser_version.split('.').first)
+        end
+      end # Driver
+    end # Chromium
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/{chrome/bridge.rb → chromium/features.rb}

@@ -19,33 +19,66 @@
 
 module Selenium
   module WebDriver
-    module Chrome
-      module Bridge
-
-        COMMANDS = {
+    module Chromium
+      module Features
+        CHROMIUM_COMMANDS = {
+          launch_app: [:post, 'session/:session_id/chromium/launch_app'],
           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'],
+          delete_network_conditions: [:delete, 'session/:session_id/chromium/network_conditions'],
+          set_permission: [:post, 'session/:session_id/permissions'],
           get_available_log_types: [:get, 'session/:session_id/se/log/types'],
           get_log: [:post, 'session/:session_id/se/log']
         }.freeze
 
-        def commands(command)
-          COMMANDS[command] || super
+        def launch_app(id)
+          execute :launch_app, {}, {id: id}
         end
 
-        def network_conditions
-          execute :get_network_conditions
+        def cast_sinks
+          execute :get_cast_sinks
         end
 
-        def send_command(command_params)
-          execute :send_command, {}, command_params
+        def cast_sink_to_use=(name)
+          execute :set_cast_sink_to_use, {}, {sinkName: name}
+        end
+
+        def cast_issue_message
+          execute :cast_issue_message
+        end
+
+        def start_cast_tab_mirroring(name)
+          execute :start_cast_tab_mirroring, {}, {sinkName: name}
+        end
+
+        def start_cast_desktop_mirroring(name)
+          execute :start_cast_desktop_mirroring, {}, {sinkName: name}
+        end
+
+        def stop_casting(name)
+          execute :stop_casting, {}, {sinkName: name}
+        end
+
+        def set_permission(name, value)
+          execute :set_permission, {}, {descriptor: {name: name}, state: value}
+        end
+
+        def network_conditions
+          execute :get_network_conditions
         end
 
         def network_conditions=(conditions)
           execute :set_network_conditions, {}, {network_conditions: conditions}
         end
 
+        def delete_network_conditions
+          execute :delete_network_conditions
+        end
+
+        def send_command(command_params)
+          execute :send_command, {}, command_params
+        end
+
         def available_log_types
           types = execute :get_available_log_types
           Array(types).map(&:to_sym)
@@ -55,14 +88,12 @@ 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
-    end # Chrome
+    end # Chromium
   end # WebDriver
 end # Selenium