selenium-webdriver 2.45.0 → 3.142.7

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

@@ -1,18 +1,37 @@
+# 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
       class Profile
         include ProfileHelper
 
-        VALID_PREFERENCE_TYPES   = [TrueClass, FalseClass, Integer, Float, String]
+        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'
-        }
+          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'
+        }.freeze
 
         attr_reader   :name, :log_file
         attr_writer   :secure_ssl, :native_events, :load_no_focus_lib
@@ -23,11 +42,14 @@ module Selenium
           end
 
           def from_name(name)
-            ini[name]
+            profile = ini[name]
+            return profile if profile
+
+            raise Error::WebDriverError, "unable to find profile named: #{name.inspect}"
           end
 
           def default_preferences
-            @default_preferences ||= WebDriver.json_load(
+            @default_preferences ||= JSON.parse(
               File.read(File.expand_path("#{WebDriver.root}/selenium/webdriver/firefox/extension/prefs.json"))
             ).freeze
           end
@@ -59,18 +81,19 @@ module Selenium
             @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"
-            @load_no_focus_lib = model_prefs.delete(WEBDRIVER_PREFS[:load_no_focus_lib]) == "true" # not stored in profile atm, so will always be false.
+            @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
 
-          @extensions        = {}
+          @extensions = {}
         end
 
         def layout_on_disk
-          profile_dir = @model ? create_tmp_copy(@model) : Dir.mktmpdir("webdriver-profile")
+          profile_dir = @model ? create_tmp_copy(@model) : Dir.mktmpdir('webdriver-profile')
           FileReaper << profile_dir
 
           install_extensions(profile_dir)
@@ -81,7 +104,6 @@ module Selenium
           profile_dir
         end
 
-
         #
         # Set a preference for this particular profile.
         #
@@ -90,11 +112,11 @@ module Selenium
         #
 
         def []=(key, value)
-          unless VALID_PREFERENCE_TYPES.any? { |e| value.kind_of? e }
+          unless VALID_PREFERENCE_TYPES.any? { |e| value.is_a? e }
             raise TypeError, "expected one of #{VALID_PREFERENCE_TYPES.inspect}, got #{value.inspect}:#{value.class}"
           end
 
-          if value.kind_of?(String) && Util.stringified?(value)
+          if value.is_a?(String) && Util.stringified?(value)
             raise ArgumentError, "preference values must be plain strings: #{key.inspect} => #{value.inspect}"
           end
 
@@ -111,9 +133,9 @@ module Selenium
         end
 
         def add_webdriver_extension
-          unless @extensions.has_key?(:webdriver)
-            add_extension(WEBDRIVER_EXTENSION_PATH, :webdriver)
-          end
+          return if @extensions.key?(:webdriver)
+
+          add_extension(WEBDRIVER_EXTENSION_PATH, :webdriver)
         end
 
         #
@@ -145,24 +167,18 @@ module Selenium
         end
 
         def proxy=(proxy)
-          unless proxy.kind_of? 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
             self['network.proxy.type'] = 1
 
-            set_manual_proxy_preference "ftp", proxy.ftp
-            set_manual_proxy_preference "http", proxy.http
-            set_manual_proxy_preference "ssl", proxy.ssl
-            set_manual_proxy_preference "socks", proxy.socks
+            set_manual_proxy_preference 'ftp', proxy.ftp
+            set_manual_proxy_preference 'http', proxy.http
+            set_manual_proxy_preference 'ssl', proxy.ssl
+            set_manual_proxy_preference 'socks', proxy.socks
 
-            if proxy.no_proxy
-              self["network.proxy.no_proxies_on"] = proxy.no_proxy
-            else
-              self["network.proxy.no_proxies_on"] = ""
-            end
+            self['network.proxy.no_proxies_on'] = proxy.no_proxy || ''
           when :pac
             self['network.proxy.type'] = 2
             self['network.proxy.autoconfig_url'] = proxy.pac
@@ -171,8 +187,10 @@ module Selenium
           else
             raise ArgumentError, "unsupported proxy type #{proxy.type}"
           end
+        end
 
-          proxy
+        def encoded
+          Zipper.zip(layout_on_disk)
         end
 
         private
@@ -180,17 +198,17 @@ module Selenium
         def set_manual_proxy_preference(key, value)
           return unless value
 
-          host, port = value.to_s.split(":", 2)
+          host, port = value.to_s.split(':', 2)
 
           self["network.proxy.#{key}"] = host
           self["network.proxy.#{key}_port"] = Integer(port) if port
         end
 
         def install_extensions(directory)
-          destination = File.join(directory, "extensions")
+          destination = File.join(directory, 'extensions')
 
           @extensions.each do |name, extension|
-            p :extension => name if $DEBUG
+            WebDriver.logger.debug({extenstion: name}.inspect)
             extension.write_to(destination)
           end
         end
@@ -202,7 +220,7 @@ module Selenium
         end
 
         def delete_extensions_cache(directory)
-          FileUtils.rm_f File.join(directory, "extensions.cache")
+          FileUtils.rm_f File.join(directory, 'extensions.cache')
         end
 
         def delete_lock_files(directory)
@@ -228,7 +246,7 @@ module Selenium
           prefs[WEBDRIVER_PREFS[:untrusted_issuer]] = assume_untrusted_certificate_issuer?
 
           # 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
@@ -238,25 +256,25 @@ module Selenium
           return prefs unless File.exist?(path)
 
           File.read(path).split("\n").each do |line|
-            if line =~ /user_pref\("([^"]+)"\s*,\s*(.+?)\);/
-              key, value = $1.strip, $2.strip
+            next unless line =~ /user_pref\("([^"]+)"\s*,\s*(.+?)\);/
 
-              # wrap the value in an array to make it a valid JSON string.
-              prefs[key] = WebDriver.json_load("[#{value}]").first
-            end
+            key = Regexp.last_match(1).strip
+            value = Regexp.last_match(2).strip
+
+            # wrap the value in an array to make it a valid JSON string.
+            prefs[key] = JSON.parse("[#{value}]").first
           end
 
           prefs
         end
 
         def write_prefs(prefs, path)
-          File.open(path, "w") { |file|
+          File.open(path, 'w') do |file|
             prefs.each do |key, value|
-              file.puts %{user_pref("#{key}", #{WebDriver.json_dump value});}
+              file.puts %{user_pref("#{key}", #{value.to_json});}
             end
-          }
+          end
         end
-
       end # Profile
     end # Firefox
   end # WebDriver

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

@@ -1,12 +1,29 @@
+# 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
-
       # @api private
       class ProfilesIni
-
         def initialize
-          @ini_path = File.join(Util.app_data_path, "profiles.ini")
+          @ini_path = File.join(Util.app_data_path, 'profiles.ini')
           @profile_paths = {}
 
           parse if File.exist?(@ini_path)
@@ -33,29 +50,24 @@ module Selenium
           string.split("\n").each do |line|
             case line
             when /^\[Profile/
-              if p = path_for(name, is_relative, path)
-                @profile_paths[name] = p
-                name, path = nil
-              end
+              name, path = nil if path_for(name, is_relative, path)
             when /^Name=(.+)$/
-              name = $1.strip
+              name = Regexp.last_match(1).strip
             when /^IsRelative=(.+)$/
-              is_relative = $1.strip == "1"
+              is_relative = Regexp.last_match(1).strip == '1'
             when /^Path=(.+)$/
-              path = $1.strip
+              path = Regexp.last_match(1).strip
+              p = path_for(name, is_relative, path)
+              @profile_paths[name] = p if p
             end
           end
-
-          if p = path_for(name, is_relative, path)
-            @profile_paths[name] = p
-          end
         end
 
         def path_for(name, is_relative, path)
           return unless [name, path].any?
-          path = is_relative ? File.join(Util.app_data_path, path) : path
-        end
 
+          is_relative ? File.join(Util.app_data_path, path) : path
+        end
       end # ProfilesIni
     end # Firefox
   end # WebDriver

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

@@ -0,0 +1,52 @@
+# 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
+      #
+      # @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
+      end # Service
+    end # Firefox
+  end # WebDriver
+end # Selenium

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

@@ -1,7 +1,25 @@
+# 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
-
       # @api private
       module Util
         module_function
@@ -22,7 +40,6 @@ module Selenium
         def stringified?(str)
           str =~ /^".*"$/
         end
-
       end # Util
     end # Firefox
   end # WebDriver

data/lib/selenium/webdriver/firefox.rb

@@ -1,30 +1,66 @@
+# 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 '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/socket_lock'
 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/bridge'
+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
-
-      DEFAULT_PORT                    = 7055
-      DEFAULT_ENABLE_NATIVE_EVENTS    = Platform.os == :windows
-      DEFAULT_SECURE_SSL              = false
+      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
+      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
+
+      def self.driver_path
+        WebDriver.logger.deprecate 'Selenium::WebDriver::Firefox#driver_path',
+                                   'Selenium::WebDriver::Firefox::Service#driver_path'
+        Selenium::WebDriver::Firefox::Service.driver_path
+      end
 
       def self.path=(path)
         Binary.path = path
       end
+    end # Firefox
+  end # WebDriver
+end # Selenium
 
-    end
-  end
-end
+require 'selenium/webdriver/firefox/service'

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

@@ -0,0 +1,85 @@
+# 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
+
+      #
+      # Driver implementation for Internet Explorer supporting
+      # both OSS and W3C dialects of JSON wire protocol.
+      # @api private
+      #
+
+      class Driver < WebDriver::Driver
+        include DriverExtensions::HasWebStorage
+        include DriverExtensions::TakesScreenshot
+
+        def initialize(opts = {})
+          opts[:desired_capabilities] = create_capabilities(opts)
+
+          opts[:url] ||= service_url(opts)
+
+          listener = opts.delete(:listener)
+          @bridge = Remote::Bridge.handshake(**opts)
+          super(@bridge, listener: listener)
+        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
+end # Selenium