selenium-webdriver 2.53.4 → 3.8.0

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

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # 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,15 +21,15 @@ module Selenium
       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
@@ -42,7 +40,9 @@ 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
@@ -78,18 +78,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)
@@ -100,7 +101,6 @@ module Selenium
           profile_dir
         end
 
-
         #
         # Set a preference for this particular profile.
         #
@@ -109,11 +109,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
 
@@ -130,9 +130,8 @@ 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
 
         #
@@ -164,7 +163,7 @@ module Selenium
         end
 
         def proxy=(proxy)
-          unless proxy.kind_of? Proxy
+          unless proxy.is_a? Proxy
             raise TypeError, "expected #{Proxy.name}, got #{proxy.inspect}:#{proxy.class}"
           end
 
@@ -172,16 +171,16 @@ module Selenium
           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'] = if proxy.no_proxy
+                                                    proxy.no_proxy
+                                                  else
+                                                    ''
+                                                  end
           when :pac
             self['network.proxy.type'] = 2
             self['network.proxy.autoconfig_url'] = proxy.pac
@@ -190,8 +189,10 @@ module Selenium
           else
             raise ArgumentError, "unsupported proxy type #{proxy.type}"
           end
+        end
 
-          proxy
+        def encoded
+          Zipper.zip(layout_on_disk)
         end
 
         private
@@ -199,17 +200,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
@@ -221,7 +222,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)
@@ -247,7 +248,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
@@ -257,25 +258,24 @@ 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*(.+?)\);/
+            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
+            # 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}", #{value.to_json});}
             end
-          }
+          end
         end
-
       end # Profile
     end # Firefox
   end # WebDriver

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

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # 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,12 +18,10 @@
 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)
@@ -52,29 +48,23 @@ 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
+          is_relative ? File.join(Util.app_data_path, path) : path
         end
-
       end # ProfilesIni
     end # Firefox
   end # WebDriver

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

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # 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 +18,46 @@
 module Selenium
   module WebDriver
     module Firefox
-
       #
       # @api private
       #
-      class Service
-        START_TIMEOUT       = 20
-        SOCKET_LOCK_TIMEOUT = 45
-        STOP_TIMEOUT        = 5
-        DEFAULT_PORT        = 4444
-        MISSING_TEXT        = "Unable to find geckodriver. Please download the executable from https://github.com/mozilla/geckodriver/releases"
-
-        def self.executable_path
-          @executable_path ||= (
-            path = Platform.find_binary("geckodriver*") || Platform.find_binary("wires*")
-            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
-        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
+      class Service < WebDriver::Service
+        DEFAULT_PORT = 4444
+        @executable = 'geckodriver*'.freeze
+        @missing_text = <<-ERROR.gsub(/\n +| {2,}/, ' ').freeze
+          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
-          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
+        private
 
         def start_process
-          server_command = [@executable_path, "--binary=#{Firefox::Binary.path}", "--webdriver-port=#{@port}", *@extra_args]
-          @process       = ChildProcess.build(*server_command)
-
-          @process.io.inherit! if $DEBUG || Platform.os == :windows
+          @process = build_process(@executable_path,
+                                   "--binary=#{Firefox::Binary.path}",
+                                   "--port=#{@port}",
+                                   *@extra_args)
           @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 Mozilla geckodriver #{@host}:#{@port}"
-          end
+        def cannot_connect_error_text
+          "unable to connect to Mozilla geckodriver #{@host}:#{@port}"
         end
 
-        def socket_lock
-          @socket_lock ||= SocketLock.new(@port - 1, SOCKET_LOCK_TIMEOUT)
+        def extract_service_args(driver_opts)
+          driver_args = super
+          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 # Service
+end # Selenium

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

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # 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 +18,6 @@
 module Selenium
   module WebDriver
     module Firefox
-
       # @api private
       module Util
         module_function
@@ -41,7 +38,6 @@ module Selenium
         def stringified?(str)
           str =~ /^".*"$/
         end
-
       end # Util
     end # Firefox
   end # WebDriver

data/lib/selenium/webdriver/ie.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # 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,10 +15,12 @@
 # specific language governing permissions and limitations
 # under the License.
 
+require 'selenium/webdriver/ie/driver'
+require 'selenium/webdriver/ie/options'
+require 'selenium/webdriver/ie/service'
+
 module Selenium
   module WebDriver
-
-    # @api private
     module IE
       def self.driver_path=(path)
         Platform.assert_executable path
@@ -30,10 +30,6 @@ module Selenium
       def self.driver_path
         @driver_path ||= nil
       end
-
     end # IE
   end # WebDriver
 end # Selenium
-
-require 'selenium/webdriver/ie/server'
-require 'selenium/webdriver/ie/bridge'