selenium-webdriver 2.53.3 → 3.142.7

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

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# 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
@@ -20,104 +20,32 @@
 module Selenium
   module WebDriver
     module Edge
-
       #
       # @api private
       #
 
-      class Service
-        START_TIMEOUT       = 20
-        SOCKET_LOCK_TIMEOUT = 45
-        STOP_TIMEOUT        = 5
-        DEFAULT_PORT        = 17556
-        MISSING_TEXT        = "Unable to find MicrosoftWebDriver. Please download the server from https://www.microsoft.com/en-us/download/details.aspx?id=48212. More info at https://github.com/SeleniumHQ/selenium/wiki/MicrosoftWebDriver."
-
-        def self.executable_path
-          @executable_path ||= (
-            path = Platform.find_binary "MicrosoftWebDriver"
-            path or raise Error::WebDriverError, MISSING_TEXT
-            Platform.assert_executable path
-
-            path
-          )
-        end
-
-        def self.executable_path=(path)
-          Platform.assert_executable path
-          @executable_path = path
-        end
-
-        def self.default_service(*extra_args)
-          new executable_path, DEFAULT_PORT, *extra_args
+      class Service < WebDriver::Service
+        @default_port = 17556
+        @executable = 'MicrosoftWebDriver'
+        @missing_text = <<~ERROR
+          Unable to find MicrosoftWebDriver. Please download the server from
+          https://www.microsoft.com/en-us/download/details.aspx?id=48212 and place it somewhere on your PATH.
+          More info at https://github.com/SeleniumHQ/selenium/wiki/MicrosoftWebDriver.
+        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 << "--host=#{driver_opts[:host]}" if driver_opts.key? :host
+          driver_args << "--package=#{driver_opts[:package]}" if driver_opts.key? :package
+          driver_args << "--silent" if driver_opts[:silent] == true
+          driver_args << "--verbose" if driver_opts[:verbose] == true
+          driver_args
         end
-
-        def initialize(executable_path, port, *extra_args)
-          @executable_path = executable_path
-          @host            = Platform.localhost
-          @port            = Integer(port)
-
-          raise Error::WebDriverError, "invalid port: #{@port}" if @port < 1
-
-          @extra_args = extra_args
-        end
-
-        def start
-          Platform.exit_hook { stop } # make sure we don't leave the server running
-
-          socket_lock.locked do
-            find_free_port
-            start_process
-            connect_until_stable
-          end
-        end
-
-        def stop
-          return if @process.nil? || @process.exited?
-
-          Net::HTTP.start(@host, @port) do |http|
-            http.open_timeout = STOP_TIMEOUT / 2
-            http.read_timeout = STOP_TIMEOUT / 2
-
-            http.head("/shutdown")
-          end
-        ensure
-          stop_process
-        end
-
-        def uri
-          URI.parse "http://#{@host}:#{@port}"
-        end
-
-        def find_free_port
-          @port = PortProber.above @port
-        end
-
-        def start_process
-          server_command = [@executable_path, "--port=#{@port}", *@extra_args]
-          @process       = ChildProcess.build(*server_command)
-
-          @process.io.inherit! if $DEBUG == true
-          @process.start
-        end
-
-        def stop_process
-          @process.poll_for_exit STOP_TIMEOUT
-        rescue ChildProcess::TimeoutError
-          @process.stop STOP_TIMEOUT
-        end
-
-        def connect_until_stable
-          socket_poller = SocketPoller.new @host, @port, START_TIMEOUT
-
-          unless socket_poller.connected?
-            raise Error::WebDriverError, "unable to connect to MicrosoftWebDriver #{@host}:#{@port}"
-          end
-        end
-
-        def socket_lock
-          @socket_lock ||= SocketLock.new(@port - 1, SOCKET_LOCK_TIMEOUT)
-        end
-
       end # Service
     end # Edge
   end # WebDriver

data/lib/selenium/webdriver/edge.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# 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
@@ -19,26 +19,26 @@
 
 require 'net/http'
 
-require 'selenium/webdriver/edge/service'
 require 'selenium/webdriver/edge/bridge'
+require 'selenium/webdriver/edge/driver'
+require 'selenium/webdriver/edge/options'
 
 module Selenium
   module WebDriver
-
     module Edge
       def self.driver_path=(path)
-        Service.executable_path = path
+        WebDriver.logger.deprecate 'Selenium::WebDriver::Edge#driver_path=',
+                                   'Selenium::WebDriver::Edge::Service#driver_path='
+        Selenium::WebDriver::Edge::Service.driver_path = path
       end
 
-      def self.path=(path)
-        Platform.assert_executable path
-        @path = path
+      def self.driver_path
+        WebDriver.logger.deprecate 'Selenium::WebDriver::Edge#driver_path',
+                                   'Selenium::WebDriver::Edge::Service#driver_path'
+        Selenium::WebDriver::Edge::Service.driver_path
       end
-
-      def self.path
-        @path ||= nil
-      end
-
     end # Edge
   end # WebDriver
 end # Selenium
+
+require 'selenium/webdriver/edge/service'

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

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# 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
@@ -20,42 +20,40 @@
 module Selenium
   module WebDriver
     module Firefox
-
       # @api private
       class Binary
-
-        NO_FOCUS_LIBRARY_NAME = "x_ignore_nofocus.so"
-        NO_FOCUS_LIBRARIES    = [
-          ["#{WebDriver.root}/selenium/webdriver/firefox/native/linux/amd64/#{NO_FOCUS_LIBRARY_NAME}", "amd64/#{NO_FOCUS_LIBRARY_NAME}"],
-          ["#{WebDriver.root}/selenium/webdriver/firefox/native/linux/x86/#{NO_FOCUS_LIBRARY_NAME}", "x86/#{NO_FOCUS_LIBRARY_NAME}"],
-        ]
+        NO_FOCUS_LIBRARY_NAME = 'x_ignore_nofocus.so'
+        NO_FOCUS_LIBRARIES = [
+          ["#{WebDriver.root}/selenium/webdriver/firefox/native/linux/amd64/#{NO_FOCUS_LIBRARY_NAME}",
+           "amd64/#{NO_FOCUS_LIBRARY_NAME}"],
+          ["#{WebDriver.root}/selenium/webdriver/firefox/native/linux/x86/#{NO_FOCUS_LIBRARY_NAME}",
+           "x86/#{NO_FOCUS_LIBRARY_NAME}"]
+        ].freeze
 
         WAIT_TIMEOUT = 90
         QUIT_TIMEOUT = 5
 
         def start_with(profile, profile_path, *args)
           if Platform.cygwin?
-            profile_path = Platform.cygwin_path(profile_path, :windows => true)
+            profile_path = Platform.cygwin_path(profile_path, windows: true)
           elsif Platform.windows?
-            profile_path = profile_path.gsub("/", "\\")
+            profile_path = Platform.windows_path(profile_path)
           end
 
-          ENV['XRE_CONSOLE_LOG']           = profile.log_file if profile.log_file
-          ENV['XRE_PROFILE_PATH']          = profile_path
-          ENV['MOZ_NO_REMOTE']             = '1' # able to launch multiple instances
+          ENV['XRE_CONSOLE_LOG'] = profile.log_file if profile.log_file
+          ENV['XRE_PROFILE_PATH'] = profile_path
+          ENV['MOZ_NO_REMOTE'] = '1' # able to launch multiple instances
           ENV['MOZ_CRASHREPORTER_DISABLE'] = '1' # disable breakpad
-          ENV['NO_EM_RESTART']             = '1' # prevent the binary from detaching from the console
+          ENV['NO_EM_RESTART'] = '1' # prevent the binary from detaching from the console
 
-          if Platform.linux? && (profile.native_events? || profile.load_no_focus_lib?)
-            modify_link_library_path profile_path
-          end
+          modify_link_library_path profile_path if Platform.linux? && (profile.native_events? || profile.load_no_focus_lib?)
 
           execute(*args)
-          cope_with_mac_strangeness(args) if Platform.mac?
         end
 
         def quit
           return unless @process
+
           @process.poll_for_exit QUIT_TIMEOUT
         rescue ChildProcess::TimeoutError
           # ok, force quit
@@ -76,26 +74,12 @@ module Selenium
         private
 
         def execute(*extra_args)
-          args = [self.class.path, "-no-remote"] + extra_args
+          args = [self.class.path, '-no-remote'] + extra_args
           @process = ChildProcess.build(*args)
-          @process.io.inherit! if $DEBUG
-          @process.start
-        end
+          WebDriver.logger.debug("Executing Process #{args}")
 
-        def cope_with_mac_strangeness(args)
-          sleep 0.3
-
-          if @process.crashed?
-            # ok, trying a restart
-            sleep 7
-            execute(*args)
-          end
-
-          # ensure we're ok
-          sleep 0.3
-          if @process.crashed?
-            raise Error::WebDriverError, "unable to start Firefox cleanly, args: #{args.inspect}"
-          end
+          @process.io.stdout = @process.io.stderr = WebDriver.logger.io if WebDriver.logger.debug?
+          @process.start
         end
 
         def modify_link_library_path(profile_path)
@@ -112,11 +96,10 @@ module Selenium
           paths += ENV['LD_LIBRARY_PATH'].to_s.split(File::PATH_SEPARATOR)
 
           ENV['LD_LIBRARY_PATH'] = paths.uniq.join(File::PATH_SEPARATOR)
-          ENV['LD_PRELOAD']      = NO_FOCUS_LIBRARY_NAME
+          ENV['LD_PRELOAD'] = NO_FOCUS_LIBRARY_NAME
         end
 
         class << self
-
           #
           # @api private
           #
@@ -139,15 +122,17 @@ module Selenium
                       when :windows
                         windows_path
                       when :linux, :unix
-                        Platform.find_binary("firefox3", "firefox2", "firefox") || "/usr/bin/firefox"
+                        Platform.find_binary('firefox3', 'firefox2', 'firefox') || '/usr/bin/firefox'
                       else
                         raise Error::WebDriverError, "unknown platform: #{Platform.os}"
                       end
 
-            @path = Platform.cygwin_path(@path) if Platform.cygwin?
+            @path = Platform.cygwin_path(@path, windows: true) if Platform.cygwin?
 
             unless File.file?(@path.to_s)
-              raise Error::WebDriverError, "Could not find Firefox binary (os=#{Platform.os}). Make sure Firefox is installed or set the path manually with #{self}.path="
+              error = "Could not find Firefox binary (os=#{Platform.os}). " \
+                      "Make sure Firefox is installed or set the path manually with #{self}.path="
+              raise Error::WebDriverError, error
             end
 
             @path
@@ -155,27 +140,29 @@ module Selenium
 
           def version
             @version = case Platform.os
-                         when :macosx
-                           `#{path} -v`.strip[/[^\s]*$/][/^\d+/].to_i
-                         when :windows
-                           `\"#{path}\" -v | more`.strip[/[^\s]*$/][/^\d+/].to_i
-                         when :linux
-                           `#{path} -v`.strip[/[^\s]*$/][/^\d+/].to_i
-                         else
-                           0
-                         end
+                       when :macosx
+                         `#{path} -v`.strip[/[^\s]*$/][/^\d+/].to_i
+                       when :windows
+                         `\"#{path}\" -v | more`.strip[/[^\s]*$/][/^\d+/].to_i
+                       when :linux
+                         `#{path} -v`.strip[/[^\s]*$/][/^\d+/].to_i
+                       else
+                         0
+                       end
           end
 
           private
 
           def windows_path
-            windows_registry_path || Platform.find_in_program_files("\\Mozilla Firefox\\firefox.exe") || Platform.find_binary("firefox")
+            windows_registry_path ||
+              Platform.find_in_program_files('\\Mozilla Firefox\\firefox.exe') ||
+              Platform.find_binary('firefox')
           end
 
           def macosx_path
-            path = "/Applications/Firefox.app/Contents/MacOS/firefox-bin"
-            path = File.expand_path("~/Applications/Firefox.app/Contents/MacOS/firefox-bin") unless File.exist?(path)
-            path = Platform.find_binary("firefox-bin") unless File.exist?(path)
+            path = '/Applications/Firefox.app/Contents/MacOS/firefox-bin'
+            path = File.expand_path('~/Applications/Firefox.app/Contents/MacOS/firefox-bin') unless File.exist?(path)
+            path = Platform.find_binary('firefox-bin') unless File.exist?(path)
 
             path
           end
@@ -184,18 +171,16 @@ module Selenium
             require 'win32/registry'
 
             lm = Win32::Registry::HKEY_LOCAL_MACHINE
-            lm.open("SOFTWARE\\Mozilla\\Mozilla Firefox") do |reg|
+            lm.open('SOFTWARE\\Mozilla\\Mozilla Firefox') do |reg|
               main = lm.open("SOFTWARE\\Mozilla\\Mozilla Firefox\\#{reg.keys[0]}\\Main")
-              if entry = main.find { |key, type, data| key =~ /pathtoexe/i }
-                return entry.last
-              end
+              entry = main.find { |key, _type, _data| key =~ /pathtoexe/i }
+              return entry.last if entry
             end
           rescue LoadError
             # older JRuby or IronRuby does not have win32/registry
           rescue Win32::Registry::Error
           end
         end # class << self
-
       end # Binary
     end # Firefox
   end # WebDriver

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

@@ -0,0 +1,50 @@
+# 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 Firefox
+      module Driver
+        class << self
+
+          #
+          # Instantiates correct Firefox driver implementation
+          # @return [Marionette::Driver, Legacy::Driver]
+          #
+
+          def new(**opts)
+            if marionette?(opts)
+              Firefox::Marionette::Driver.new(opts)
+            else
+              Firefox::Legacy::Driver.new(opts)
+            end
+          end
+
+          private
+
+          def marionette?(opts)
+            opts.delete(:marionette) != false &&
+              (!opts[:desired_capabilities] || opts[:desired_capabilities][:marionette] != false)
+          end
+        end
+
+      end # Driver
+    end # Firefox
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/firefox/extension/prefs.json

@@ -29,7 +29,6 @@
     "extensions.autoDisableScopes": 10,
     "extensions.blocklist.enabled": false,
     "extensions.checkCompatibility.nightly": false,
-    "extensions.logging.enabled": true,
     "extensions.update.enabled": false,
     "extensions.update.notifyUser": false,
     "javascript.enabled": true,
@@ -37,18 +36,8 @@
     "network.http.phishy-userpass-length": 255,
     "offline-apps.allow_by_default": true,
     "prompts.tab_modal.enabled": false,
-    "security.csp.enable": false,
     "security.fileuri.origin_policy": 3,
     "security.fileuri.strict_origin_policy": false,
-    "security.warn_entering_secure": false,
-    "security.warn_entering_secure.show_once": false,
-    "security.warn_entering_weak": false,
-    "security.warn_entering_weak.show_once": false,
-    "security.warn_leaving_secure": false,
-    "security.warn_leaving_secure.show_once": false,
-    "security.warn_submit_insecure": false,
-    "security.warn_viewing_mixed": false,
-    "security.warn_viewing_mixed.show_once": false,
     "signon.rememberSignons": false,
     "toolkit.networkmanager.disable": true,
     "toolkit.telemetry.prompted": 2,
@@ -64,12 +53,14 @@
     "browser.newtabpage.enabled": false,
     "browser.startup.page": 0,
     "browser.startup.homepage": "about:blank",
+    "browser.startup.homepage_override.mstone": "ignore",
     "browser.usedOnWindows10.introURL": "about:blank",
     "dom.max_chrome_script_run_time": 30,
     "dom.max_script_run_time": 30,
     "dom.report_all_js_exceptions": true,
     "javascript.options.showInConsole": true,
-    "network.http.max-connections-per-server": 10,
+    "network.captive-portal-service.enabled": false,
+    "security.csp.enable": false,
     "startup.homepage_welcome_url": "about:blank",
     "startup.homepage_welcome_url.additional": "about:blank",
     "webdriver_accept_untrusted_certs": true,

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

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# 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
@@ -20,7 +20,6 @@
 module Selenium
   module WebDriver
     module Firefox
-
       #
       # @api private
       #
@@ -29,9 +28,7 @@ module Selenium
         NAMESPACE = 'http://www.mozilla.org/2004/em-rdf#'
 
         def initialize(path)
-          unless File.exist?(path)
-            raise Error::WebDriverError, "could not find extension at #{path.inspect}"
-          end
+          raise Error::WebDriverError, "could not find extension at #{path.inspect}" unless File.exist?(path)
 
           @path             = path
           @should_reap_root = false
@@ -39,10 +36,10 @@ module Selenium
 
         def write_to(extensions_dir)
           root_dir = create_root
-          ext_path = File.join extensions_dir, read_id_from_install_rdf(root_dir)
+          ext_path = File.join extensions_dir, read_id(root_dir)
 
           FileUtils.rm_rf ext_path
-          FileUtils.mkdir_p File.dirname(ext_path), :mode => 0700
+          FileUtils.mkdir_p File.dirname(ext_path), mode: 0o700
           FileUtils.cp_r root_dir, ext_path
 
           FileReaper.reap(root_dir) if @should_reap_root
@@ -55,7 +52,7 @@ module Selenium
             @path
           else
             unless Zipper::EXTENSIONS.include? File.extname(@path)
-              raise Error::WebDriverError, "expected #{Zipper::EXTENSIONS.join(" or ")}, got #{@path.inspect}"
+              raise Error::WebDriverError, "expected #{Zipper::EXTENSIONS.join(' or ')}, got #{@path.inspect}"
             end
 
             @should_reap_root = true
@@ -63,8 +60,14 @@ module Selenium
           end
         end
 
+        def read_id(directory)
+          read_id_from_install_rdf(directory) || read_id_from_manifest_json(directory)
+        end
+
         def read_id_from_install_rdf(directory)
-          rdf_path = File.join(directory, "install.rdf")
+          rdf_path = File.join(directory, 'install.rdf')
+          return unless File.exist?(rdf_path)
+
           doc = REXML::Document.new(File.read(rdf_path))
           namespace = doc.root.namespaces.key(NAMESPACE)
 
@@ -79,6 +82,13 @@ module Selenium
           raise Error::WebDriverError, "cannot locate extension id in #{rdf_path}"
         end
 
+        def read_id_from_manifest_json(directory)
+          manifest_path = File.join(directory, 'manifest.json')
+          return unless File.exist?(manifest_path)
+
+          manifest = JSON.parse(File.read(manifest_path))
+          [manifest['name'].delete(' '), manifest['version']].join('@')
+        end
       end # Extension
     end # Firefox
   end # WebDriver

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

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# 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
@@ -20,10 +20,8 @@
 module Selenium
   module WebDriver
     module Firefox
-
       # @api private
       class Launcher
-
         SOCKET_LOCK_TIMEOUT       = 45
         STABLE_CONNECTION_TIMEOUT = 60
 
@@ -33,14 +31,14 @@ module Selenium
 
           raise Error::WebDriverError, "invalid port: #{@port}" if @port < 1
 
-          if profile.kind_of? Profile
+          if profile.is_a? Profile
             @profile = profile
           else
             @profile_name = profile
             @profile = nil
           end
 
-          @host = "127.0.0.1"
+          @host = '127.0.0.1'
         end
 
         def url
@@ -79,38 +77,34 @@ module Selenium
 
         def start
           assert_profile
-          @binary.start_with @profile, @profile_dir, "-foreground"
+          @binary.start_with @profile, @profile_dir, '-foreground'
         end
 
         def connect_until_stable
           poller = SocketPoller.new(@host, @port, STABLE_CONNECTION_TIMEOUT)
 
-          unless poller.connected?
-            @binary.quit
-            raise Error::WebDriverError, "unable to obtain stable firefox connection in #{STABLE_CONNECTION_TIMEOUT} seconds (#{@host}:#{@port})"
-          end
+          return if poller.connected?
+
+          @binary.quit
+          error = "unable to obtain stable firefox connection in #{STABLE_CONNECTION_TIMEOUT} seconds (#{@host}:#{@port})"
+          raise Error::WebDriverError, error
         end
 
         def fetch_profile
-          if @profile_name
-            @profile = Profile.from_name @profile_name
-
-            unless @profile
-              raise Error::WebDriverError, "unable to find profile named: #{@profile_name.inspect}"
-            end
-          else
-            @profile = Profile.new
-          end
+          @profile = if @profile_name
+                       Profile.from_name @profile_name
+                     else
+                       Profile.new
+                     end
         end
 
         def assert_profile
-          raise Error::WebDriverError, "must create_profile first" unless @profile && @profile_dir
+          raise Error::WebDriverError, 'must create_profile first' unless @profile && @profile_dir
         end
 
         def socket_lock
           @socket_lock ||= SocketLock.new(@port - 1, SOCKET_LOCK_TIMEOUT)
         end
-
       end # Launcher
     end # Firefox
   end # WebDriver