selenium-webdriver 3.142.7 → 4.16.0

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

@@ -23,18 +23,20 @@ module Selenium
       class Profile
         include ProfileHelper
 
-        VALID_PREFERENCE_TYPES   = [TrueClass, FalseClass, Integer, Float, String].freeze
-        WEBDRIVER_EXTENSION_PATH = File.expand_path("#{WebDriver.root}/selenium/webdriver/firefox/extension/webdriver.xpi")
-        WEBDRIVER_PREFS          = {
-          native_events: 'webdriver_enable_native_events',
-          untrusted_certs: 'webdriver_accept_untrusted_certs',
-          untrusted_issuer: 'webdriver_assume_untrusted_issuer',
-          port: 'webdriver_firefox_port',
-          log_file: 'webdriver.log.file'
+        VALID_PREFERENCE_TYPES = [TrueClass, FalseClass, Integer, Float, String].freeze
+
+        DEFAULT_PREFERENCES = {
+          'browser.newtabpage.enabled' => false,
+          'browser.startup.homepage' => 'about:blank',
+          'browser.usedOnWindows10.introURL' => 'about:blank',
+          'network.captive-portal-service.enabled' => false,
+          'security.csp.enable' => false
         }.freeze
 
+        LOCK_FILES = %w[.parentlock parent.lock lock].freeze
+
         attr_reader   :name, :log_file
-        attr_writer   :secure_ssl, :native_events, :load_no_focus_lib
+        attr_writer   :secure_ssl, :load_no_focus_lib
 
         class << self
           def ini
@@ -48,10 +50,8 @@ module Selenium
             raise Error::WebDriverError, "unable to find profile named: #{name.inspect}"
           end
 
-          def default_preferences
-            @default_preferences ||= JSON.parse(
-              File.read(File.expand_path("#{WebDriver.root}/selenium/webdriver/firefox/extension/prefs.json"))
-            ).freeze
+          def decoded(json)
+            JSON.parse(json)
           end
         end
 
@@ -70,25 +70,7 @@ module Selenium
         def initialize(model = nil)
           @model = verify_model(model)
 
-          model_prefs = read_model_prefs
-
-          if model_prefs.empty?
-            @native_events     = DEFAULT_ENABLE_NATIVE_EVENTS
-            @secure_ssl        = DEFAULT_SECURE_SSL
-            @untrusted_issuer  = DEFAULT_ASSUME_UNTRUSTED_ISSUER
-            @load_no_focus_lib = DEFAULT_LOAD_NO_FOCUS_LIB
-
-            @additional_prefs  = {}
-          else
-            # TODO: clean this up
-            @native_events     = model_prefs.delete(WEBDRIVER_PREFS[:native_events]) == 'true'
-            @secure_ssl        = model_prefs.delete(WEBDRIVER_PREFS[:untrusted_certs]) != 'true'
-            @untrusted_issuer  = model_prefs.delete(WEBDRIVER_PREFS[:untrusted_issuer]) == 'true'
-            # not stored in profile atm, so will always be false.
-            @load_no_focus_lib = model_prefs.delete(WEBDRIVER_PREFS[:load_no_focus_lib]) == 'true'
-            @additional_prefs  = model_prefs
-          end
-
+          @additional_prefs = read_model_prefs
           @extensions = {}
         end
 
@@ -132,12 +114,6 @@ module Selenium
           self[WEBDRIVER_PREFS[:log_file]] = file
         end
 
-        def add_webdriver_extension
-          return if @extensions.key?(:webdriver)
-
-          add_extension(WEBDRIVER_EXTENSION_PATH, :webdriver)
-        end
-
         #
         # Add the extension (directory, .zip or .xpi) at the given path to the profile.
         #
@@ -146,26 +122,6 @@ module Selenium
           @extensions[name] = Extension.new(path)
         end
 
-        def native_events?
-          @native_events == true
-        end
-
-        def load_no_focus_lib?
-          @load_no_focus_lib == true
-        end
-
-        def secure_ssl?
-          @secure_ssl == true
-        end
-
-        def assume_untrusted_certificate_issuer?
-          @untrusted_issuer == true
-        end
-
-        def assume_untrusted_certificate_issuer=(bool)
-          @untrusted_issuer = bool
-        end
-
         def proxy=(proxy)
           raise TypeError, "expected #{Proxy.name}, got #{proxy.inspect}:#{proxy.class}" unless proxy.is_a? Proxy
 
@@ -189,9 +145,7 @@ module Selenium
           end
         end
 
-        def encoded
-          Zipper.zip(layout_on_disk)
-        end
+        alias as_json encoded
 
         private
 
@@ -208,7 +162,7 @@ module Selenium
           destination = File.join(directory, 'extensions')
 
           @extensions.each do |name, extension|
-            WebDriver.logger.debug({extenstion: name}.inspect)
+            WebDriver.logger.debug({extension: name}.inspect, id: :firefox_profile)
             extension.write_to(destination)
           end
         end
@@ -224,7 +178,7 @@ module Selenium
         end
 
         def delete_lock_files(directory)
-          %w[.parentlock parent.lock].each do |name|
+          LOCK_FILES.each do |name|
             FileUtils.rm_f File.join(directory, name)
           end
         end
@@ -236,17 +190,11 @@ module Selenium
         def update_user_prefs_in(directory)
           path = File.join(directory, 'user.js')
           prefs = read_user_prefs(path)
-
-          prefs.merge! self.class.default_preferences.fetch 'mutable'
-          prefs.merge! @additional_prefs
-          prefs.merge! self.class.default_preferences.fetch 'frozen'
-
-          prefs[WEBDRIVER_PREFS[:untrusted_certs]]  = !secure_ssl?
-          prefs[WEBDRIVER_PREFS[:native_events]]    = native_events?
-          prefs[WEBDRIVER_PREFS[:untrusted_issuer]] = assume_untrusted_certificate_issuer?
+          prefs.merge! self.class::DEFAULT_PREFERENCES
+          prefs.merge!(@additional_prefs)
 
           # If the user sets the home page, we should also start up there
-          prefs['startup.homepage_welcome_url'] = prefs['browser.startup.homepage']
+          prefs['startup.homepage_welcome_url'] ||= prefs['browser.startup.homepage']
 
           write_prefs prefs, path
         end

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

@@ -20,32 +20,10 @@
 module Selenium
   module WebDriver
     module Firefox
-      #
-      # @api private
-      #
-
       class Service < WebDriver::Service
-        @default_port = 4444
-        @executable = 'geckodriver'
-        @missing_text = <<~ERROR
-          Unable to find Mozilla geckodriver. Please download the server from
-          https://github.com/mozilla/geckodriver/releases and place it somewhere on your PATH.
-          More info at https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/WebDriver.
-        ERROR
-        @shutdown_supported = false
-
-        private
-
-        # Note: This processing is deprecated
-        def extract_service_args(driver_opts)
-          driver_args = super
-          driver_opts = driver_opts.dup
-          driver_args << "--binary=#{driver_opts[:binary]}" if driver_opts.key?(:binary)
-          driver_args << "--log=#{driver_opts[:log]}" if driver_opts.key?(:log)
-          driver_args << "--marionette-port=#{driver_opts[:marionette_port]}" if driver_opts.key?(:marionette_port)
-          driver_args << "--host=#{driver_opts[:host]}" if driver_opts.key?(:host)
-          driver_args
-        end
+        DEFAULT_PORT = 4444
+        EXECUTABLE = 'geckodriver'
+        SHUTDOWN_SUPPORTED = false
       end # Service
     end # Firefox
   end # WebDriver

data/lib/selenium/webdriver/firefox/util.rb

@@ -27,7 +27,7 @@ module Selenium
         def app_data_path
           case Platform.os
           when :windows
-            "#{ENV['APPDATA']}\\Mozilla\\Firefox"
+            "#{ENV.fetch('APPDATA')}\\Mozilla\\Firefox"
           when :macosx
             "#{Platform.home}/Library/Application Support/Firefox"
           when :unix, :linux

data/lib/selenium/webdriver/firefox.rb

@@ -21,46 +21,35 @@ require 'timeout'
 require 'socket'
 require 'rexml/document'
 
-require 'selenium/webdriver/firefox/driver'
-
-require 'selenium/webdriver/firefox/util'
-require 'selenium/webdriver/firefox/extension'
-require 'selenium/webdriver/firefox/binary'
-require 'selenium/webdriver/firefox/profiles_ini'
-require 'selenium/webdriver/firefox/profile'
-require 'selenium/webdriver/firefox/launcher'
-require 'selenium/webdriver/firefox/legacy/driver'
-
-require 'selenium/webdriver/firefox/marionette/bridge'
-require 'selenium/webdriver/firefox/marionette/driver'
-require 'selenium/webdriver/firefox/options'
-
 module Selenium
   module WebDriver
     module Firefox
+      autoload :Util, 'selenium/webdriver/firefox/util'
+      autoload :Extension, 'selenium/webdriver/firefox/extension'
+      autoload :ProfilesIni, 'selenium/webdriver/firefox/profiles_ini'
+      autoload :Profile, 'selenium/webdriver/firefox/profile'
+      autoload :Features, 'selenium/webdriver/firefox/features'
+      autoload :Driver, 'selenium/webdriver/firefox/driver'
+      autoload :Options, 'selenium/webdriver/firefox/options'
+      autoload :Service, 'selenium/webdriver/firefox/service'
+
       DEFAULT_PORT = 7055
-      DEFAULT_ENABLE_NATIVE_EVENTS = Platform.os == :windows
       DEFAULT_SECURE_SSL = false
       DEFAULT_ASSUME_UNTRUSTED_ISSUER = true
       DEFAULT_LOAD_NO_FOCUS_LIB = false
 
-      def self.driver_path=(path)
-        WebDriver.logger.deprecate 'Selenium::WebDriver::Firefox#driver_path=',
-                                   'Selenium::WebDriver::Firefox::Service#driver_path='
-        Selenium::WebDriver::Firefox::Service.driver_path = path
-      end
+      # Mozilla Automation Team asked to only support 85
+      # until WebDriver Bidi is available.
+      DEVTOOLS_VERSION = 85
 
-      def self.driver_path
-        WebDriver.logger.deprecate 'Selenium::WebDriver::Firefox#driver_path',
-                                   'Selenium::WebDriver::Firefox::Service#driver_path'
-        Selenium::WebDriver::Firefox::Service.driver_path
+      def self.path=(path)
+        Platform.assert_executable path
+        @path = path
       end
 
-      def self.path=(path)
-        Binary.path = path
+      def self.path
+        @path ||= nil
       end
     end # Firefox
   end # WebDriver
 end # Selenium
-
-require 'selenium/webdriver/firefox/service'

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

@@ -20,7 +20,6 @@
 module Selenium
   module WebDriver
     module IE
-
       #
       # Driver implementation for Internet Explorer supporting
       # both OSS and W3C dialects of JSON wire protocol.
@@ -28,57 +27,18 @@ module Selenium
       #
 
       class Driver < WebDriver::Driver
-        include DriverExtensions::HasWebStorage
-        include DriverExtensions::TakesScreenshot
-
-        def initialize(opts = {})
-          opts[:desired_capabilities] = create_capabilities(opts)
+        EXTENSIONS = [DriverExtensions::HasWebStorage].freeze
 
-          opts[:url] ||= service_url(opts)
+        include LocalDriver
 
-          listener = opts.delete(:listener)
-          @bridge = Remote::Bridge.handshake(**opts)
-          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
           :internet_explorer
         end
-
-        def quit
-          super
-        ensure
-          @service&.stop
-        end
-
-        private
-
-        def create_capabilities(opts)
-          caps = opts.delete(:desired_capabilities) { Remote::Capabilities.internet_explorer }
-          options = opts.delete(:options) { Options.new }
-
-          if opts.delete(:introduce_flakiness_by_ignoring_security_domains)
-            WebDriver.logger.deprecate ':introduce_flakiness_by_ignoring_security_domains',
-                                       'Selenium::WebDriver::IE::Options#ignore_protected_mode_settings='
-            options.ignore_protected_mode_settings = true
-          end
-
-          native_events = opts.delete(:native_events)
-          unless native_events.nil?
-            WebDriver.logger.deprecate ':native_events', 'Selenium::WebDriver::IE::Options#native_events='
-            options.native_events = native_events
-          end
-
-          # Backward compatibility with older IEDriverServer versions
-          caps[:ignore_protected_mode_settings] = options.ignore_protected_mode_settings
-          caps[:native_events] = options.native_events
-
-          options = options.as_json
-          caps.merge!(options) unless options.empty?
-
-          caps
-        end
-
       end # Driver
     end # IE
   end # WebDriver

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

@@ -0,0 +1,34 @@
+# 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 IE
+      module Features
+        def command_list
+          self.class::COMMANDS
+        end
+
+        def commands(command)
+          command_list[command]
+        end
+      end # Bridge
+    end # Ie
+  end # WebDriver
+end # Selenium

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

@@ -20,7 +20,7 @@
 module Selenium
   module WebDriver
     module IE
-      class Options < WebDriver::Common::Options
+      class Options < WebDriver::Options
         KEY = 'se:ieOptions'
         SCROLL_TOP = 0
         SCROLL_BOTTOM = 1
@@ -39,20 +39,14 @@ module Selenium
           persistent_hover: 'enablePersistentHover',
           require_window_focus: 'requireWindowFocus',
           use_per_process_proxy: 'ie.usePerProcessProxy',
-          validate_cookie_document_type: 'ie.validateCookieDocumentType'
+          use_legacy_file_upload_dialog_handling: 'ie.useLegacyFileUploadDialogHandling',
+          attach_to_edge_chrome: 'ie.edgechromium',
+          edge_executable_path: 'ie.edgepath',
+          ignore_process_match: 'ie.ignoreprocessmatch'
         }.freeze
+        BROWSER = 'internet explorer'
 
-        CAPABILITIES.each_key do |key|
-          define_method key do
-            @options[key]
-          end
-
-          define_method "#{key}=" do |value|
-            @options[key] = value
-          end
-        end
-
-        attr_reader :args, :options
+        attr_reader :args
 
         #
         # Create a new Options instance
@@ -86,8 +80,9 @@ module Selenium
         #
 
         def initialize(**opts)
-          @args = Set.new(opts.delete(:args) || [])
-          @options = opts
+          @args = (opts.delete(:args) || []).to_set
+          super(**opts)
+
           @options[:native_events] = true if @options[:native_events].nil?
         end
 
@@ -101,36 +96,11 @@ module Selenium
           @args << arg
         end
 
-        #
-        # Add a new option not yet handled by these bindings.
-        #
-        # @example
-        #   options = Selenium::WebDriver::IE::Options.new
-        #   options.add_option(:foo, 'bar')
-        #
-        # @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
-
-        #
-        # @api private
-        #
-
-        def as_json(*)
-          opts = {}
-
-          CAPABILITIES.each do |capability_alias, capability_name|
-            capability_value = @options.delete(capability_alias)
-            opts[capability_name] = capability_value unless capability_value.nil?
-          end
-          opts['ie.browserCommandLineSwitches'] = @args.to_a.join(' ') if @args.any?
-          opts.merge!(@options)
+        private
 
-          {KEY => generate_as_json(opts)}
+        def process_browser_options(browser_options)
+          options = browser_options[KEY]
+          options['ie.browserCommandLineSwitches'] = @args.to_a.join(' ') if @args.any?
         end
       end # Options
     end # IE

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

@@ -20,34 +20,10 @@
 module Selenium
   module WebDriver
     module IE
-      #
-      # @api private
-      #
-
       class Service < WebDriver::Service
-        @default_port = 5555
-        @executable = 'IEDriverServer'
-        @missing_text = <<~ERROR
-          Unable to find IEDriverServer. Please download the server from
-          http://selenium-release.storage.googleapis.com/index.html and place it somewhere on your PATH.
-          More info at https://github.com/SeleniumHQ/selenium/wiki/InternetExplorerDriver.
-        ERROR
-        @shutdown_supported = true
-
-        private
-
-        # Note: This processing is deprecated
-        def extract_service_args(driver_opts)
-          driver_args = super
-          driver_opts = driver_opts.dup
-          driver_args << "--log-level=#{driver_opts.delete(:log_level).to_s.upcase}" if driver_opts.key?(:log_level)
-          driver_args << "--log-file=#{driver_opts.delete(:log_file)}" if driver_opts.key?(:log_file)
-          driver_args << "--implementation=#{driver_opts.delete(:implementation).to_s.upcase}" if driver_opts.key?(:implementation)
-          driver_args << "--host=#{driver_opts.delete(:host)}" if driver_opts.key?(:host)
-          driver_args << "--extract_path=#{driver_opts.delete(:extract_path)}" if driver_opts.key?(:extract_path)
-          driver_args << "--silent" if driver_opts[:silent] == true
-          driver_args
-        end
+        DEFAULT_PORT = 5555
+        EXECUTABLE = 'IEDriverServer'
+        SHUTDOWN_SUPPORTED = true
       end # Server
     end # IE
   end # WebDriver

data/lib/selenium/webdriver/ie.rb

@@ -17,25 +17,13 @@
 # specific language governing permissions and limitations
 # under the License.
 
-require 'selenium/webdriver/ie/driver'
-require 'selenium/webdriver/ie/options'
-
 module Selenium
   module WebDriver
     module IE
-      def self.driver_path=(path)
-        WebDriver.logger.deprecate 'Selenium::WebDriver::IE#driver_path=',
-                                   'Selenium::WebDriver::IE::Service#driver_path='
-        Selenium::WebDriver::IE::Service.driver_path = path
-      end
-
-      def self.driver_path
-        WebDriver.logger.deprecate 'Selenium::WebDriver::IE#driver_path',
-                                   'Selenium::WebDriver::IE::Service#driver_path'
-        Selenium::WebDriver::IE::Service.driver_path
-      end
+      autoload :Features, 'selenium/webdriver/ie/features'
+      autoload :Driver,   'selenium/webdriver/ie/driver'
+      autoload :Options,  'selenium/webdriver/ie/options'
+      autoload :Service,  'selenium/webdriver/ie/service'
     end # IE
   end # WebDriver
 end # Selenium
-
-require 'selenium/webdriver/ie/service'