selenium-webdriver 3.141.0 → 3.142.3

data/lib/selenium/webdriver/firefox/binary.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
@@ -20,7 +22,7 @@ module Selenium
     module Firefox
       # @api private
       class Binary
-        NO_FOCUS_LIBRARY_NAME = 'x_ignore_nofocus.so'.freeze
+        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}"],
@@ -35,7 +37,7 @@ module Selenium
           if Platform.cygwin?
             profile_path = Platform.cygwin_path(profile_path, windows: true)
           elsif Platform.windows?
-            profile_path = profile_path.tr('/', '\\')
+            profile_path = Platform.windows_path(profile_path)
           end
 
           ENV['XRE_CONSOLE_LOG'] = profile.log_file if profile.log_file
@@ -44,15 +46,14 @@ module Selenium
           ENV['MOZ_CRASHREPORTER_DISABLE'] = '1' # disable breakpad
           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)
         end
 
         def quit
           return unless @process
+
           @process.poll_for_exit QUIT_TIMEOUT
         rescue ChildProcess::TimeoutError
           # ok, force quit
@@ -126,7 +127,7 @@ module Selenium
                         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)
               error = "Could not find Firefox binary (os=#{Platform.os}). "

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

@@ -0,0 +1,47 @@
+# 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 Bridge
+
+        COMMANDS = {
+          install_addon: [:post, 'session/:session_id/moz/addon/install'],
+          uninstall_addon: [:post, 'session/:session_id/moz/addon/uninstall']
+        }.freeze
+
+        def commands(command)
+          COMMANDS[command] || super
+        end
+
+        def install_addon(path, temporary)
+          payload = {path: path}
+          payload[:temporary] = temporary unless temporary.nil?
+          execute :install_addon, {}, payload
+        end
+
+        def uninstall_addon(id)
+          execute :uninstall_addon, {}, {id: id}
+        end
+
+      end # Bridge
+    end # Firefox
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/firefox/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

data/lib/selenium/webdriver/firefox/extension.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,12 +25,10 @@ module Selenium
       #
 
       class Extension
-        NAMESPACE = 'http://www.mozilla.org/2004/em-rdf#'.freeze
+        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

data/lib/selenium/webdriver/firefox/launcher.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
@@ -82,6 +84,7 @@ module Selenium
           poller = SocketPoller.new(@host, @port, STABLE_CONNECTION_TIMEOUT)
 
           return if poller.connected?
+
           @binary.quit
           error = "unable to obtain stable firefox connection in #{STABLE_CONNECTION_TIMEOUT} seconds (#{@host}:#{@port})"
           raise Error::WebDriverError, error

data/lib/selenium/webdriver/firefox/legacy/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,8 +30,10 @@ module Selenium
         class Driver < WebDriver::Driver
           include DriverExtensions::TakesScreenshot
 
-          def initialize(opts = {})
-            opts[:desired_capabilities] ||= Remote::Capabilities.firefox
+          def initialize(opts = {}) # rubocop:disable Metrics/AbcSize
+            WebDriver.logger.deprecate 'Selenium support for legacy Firefox', 'Firefox via marionette'
+
+            opts[:desired_capabilities] ||= Remote::Capabilities.firefox_legacy
 
             if opts.key? :proxy
               WebDriver.logger.deprecate ':proxy', "Selenium::WebDriver::Remote::Capabilities.firefox(proxy: #{opts[:proxy]})"
@@ -56,7 +60,7 @@ module Selenium
             begin
               super(@bridge, listener: listener)
             rescue
-              @launcher.quit if @launcher
+              @launcher&.quit
               raise
             end
           end

data/lib/selenium/webdriver/firefox/marionette/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
@@ -22,8 +24,8 @@ module Selenium
         module Bridge
 
           COMMANDS = {
-            install_addon: [:post, 'session/:session_id/moz/addon/install'.freeze],
-            uninstall_addon: [:post, 'session/:session_id/moz/addon/uninstall'.freeze]
+            install_addon: [:post, 'session/:session_id/moz/addon/install'],
+            uninstall_addon: [:post, 'session/:session_id/moz/addon/uninstall']
           }.freeze
 
           def commands(command)

data/lib/selenium/webdriver/firefox/marionette/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
@@ -33,15 +35,7 @@ module Selenium
           def initialize(opts = {})
             opts[:desired_capabilities] = create_capabilities(opts)
 
-            unless opts.key?(:url)
-              driver_path = opts.delete(:driver_path) || Firefox.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)
             WebDriver.logger.info 'Skipping handshake as we know it is W3C.'
@@ -61,13 +55,13 @@ module Selenium
           def quit
             super
           ensure
-            @service.stop if @service
+            @service&.stop
           end
 
           private
 
           def create_capabilities(opts)
-            caps = opts.delete(:desired_capabilities) { Remote::W3C::Capabilities.firefox }
+            caps = opts.delete(:desired_capabilities) { Remote::Capabilities.firefox }
             options = opts.delete(:options) { Options.new }
 
             firefox_options = opts.delete(:firefox_options)

data/lib/selenium/webdriver/firefox/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
@@ -22,7 +24,7 @@ module Selenium
         attr_reader :args, :prefs, :options, :profile
         attr_accessor :binary, :log_level
 
-        KEY = 'moz:firefoxOptions'.freeze
+        KEY = 'moz:firefoxOptions'
 
         #
         # Create a new Options instance, only for W3C-capable versions of Firefox.
@@ -43,7 +45,7 @@ module Selenium
         def initialize(**opts)
           @args = Set.new(opts.delete(:args) || [])
           @binary = opts.delete(:binary)
-          @profile = opts.delete(:profile)
+          @profile = process_profile(opts.delete(:profile))
           @log_level = opts.delete(:log_level)
           @prefs = opts.delete(:prefs) || {}
           @options = opts.delete(:options) || {}
@@ -121,11 +123,7 @@ module Selenium
         #
 
         def profile=(profile)
-          @profile = if profile.is_a?(Profile)
-                       profile
-                     else
-                       Profile.from_name(profile)
-                     end
+          @profile = process_profile(profile)
         end
 
         #
@@ -143,6 +141,21 @@ module Selenium
 
           {KEY => opts}
         end
+
+        private
+
+        def process_profile(profile)
+          return unless profile
+
+          case profile
+          when Profile
+            profile
+          when String
+            Profile.from_name(profile)
+          else
+            raise Error::WebDriverError, "don't know how to handle profile: #{profile.inspect}"
+          end
+        end
       end # Options
     end # Firefox
   end # WebDriver

data/lib/selenium/webdriver/firefox/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
@@ -42,6 +44,7 @@ module Selenium
           def from_name(name)
             profile = ini[name]
             return profile if profile
+
             raise Error::WebDriverError, "unable to find profile named: #{name.inspect}"
           end
 
@@ -131,6 +134,7 @@ module Selenium
 
         def add_webdriver_extension
           return if @extensions.key?(:webdriver)
+
           add_extension(WEBDRIVER_EXTENSION_PATH, :webdriver)
         end
 
@@ -163,9 +167,7 @@ module Selenium
         end
 
         def proxy=(proxy)
-          unless proxy.is_a? Proxy
-            raise TypeError, "expected #{Proxy.name}, got #{proxy.inspect}:#{proxy.class}"
-          end
+          raise TypeError, "expected #{Proxy.name}, got #{proxy.inspect}:#{proxy.class}" unless proxy.is_a? Proxy
 
           case proxy.type
           when :manual
@@ -176,11 +178,7 @@ module Selenium
             set_manual_proxy_preference 'ssl', proxy.ssl
             set_manual_proxy_preference 'socks', proxy.socks
 
-            self['network.proxy.no_proxies_on'] = if proxy.no_proxy
-                                                    proxy.no_proxy
-                                                  else
-                                                    ''
-                                                  end
+            self['network.proxy.no_proxies_on'] = proxy.no_proxy || ''
           when :pac
             self['network.proxy.type'] = 2
             self['network.proxy.autoconfig_url'] = proxy.pac
@@ -259,6 +257,7 @@ module Selenium
 
           File.read(path).split("\n").each do |line|
             next unless line =~ /user_pref\("([^"]+)"\s*,\s*(.+?)\);/
+
             key = Regexp.last_match(1).strip
             value = Regexp.last_match(2).strip
 

data/lib/selenium/webdriver/firefox/profiles_ini.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
@@ -63,6 +65,7 @@ module Selenium
 
         def path_for(name, is_relative, path)
           return unless [name, path].any?
+
           is_relative ? File.join(Util.app_data_path, path) : path
         end
       end # ProfilesIni

data/lib/selenium/webdriver/firefox/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,34 +25,21 @@ module Selenium
       #
 
       class Service < WebDriver::Service
-        DEFAULT_PORT = 4444
-        @executable = 'geckodriver'.freeze
-        @missing_text = <<-ERROR.gsub(/\n +| {2,}/, ' ').freeze
+        @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
-
-        def stop
-          stop_process
-        end
+        @shutdown_supported = false
 
         private
 
-        def start_process
-          @process = build_process(@executable_path,
-                                   "--binary=#{Firefox::Binary.path}",
-                                   "--port=#{@port}",
-                                   *@extra_args)
-          @process.start
-        end
-
-        def cannot_connect_error_text
-          "unable to connect to Mozilla geckodriver #{@host}:#{@port}"
-        end
-
+        # 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)

data/lib/selenium/webdriver/firefox/util.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/ie.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
@@ -17,19 +19,23 @@
 
 require 'selenium/webdriver/ie/driver'
 require 'selenium/webdriver/ie/options'
-require 'selenium/webdriver/ie/service'
 
 module Selenium
   module WebDriver
     module IE
       def self.driver_path=(path)
-        Platform.assert_executable path
-        @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
-        @driver_path ||= nil
+        WebDriver.logger.deprecate 'Selenium::WebDriver::IE#driver_path',
+                                   'Selenium::WebDriver::IE::Service#driver_path'
+        Selenium::WebDriver::IE::Service.driver_path
       end
     end # IE
   end # WebDriver
 end # Selenium
+
+require 'selenium/webdriver/ie/service'

data/lib/selenium/webdriver/ie/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
@@ -32,15 +34,7 @@ module Selenium
         def initialize(opts = {})
           opts[:desired_capabilities] = create_capabilities(opts)
 
-          unless opts.key?(:url)
-            driver_path = opts.delete(:driver_path) || IE.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)
@@ -54,7 +48,7 @@ module Selenium
         def quit
           super
         ensure
-          @service.stop if @service
+          @service&.stop
         end
 
         private