selenium-webdriver 3.0.0.beta4.0 → 4.0.0.alpha5

data/lib/selenium/webdriver/common/platform.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
@@ -27,12 +27,11 @@ module Selenium
       module_function
 
       def home
-        # jruby has an issue with ENV['HOME'] on Windows
-        @home ||= jruby? ? ENV_JAVA['user.home'] : ENV['HOME']
+        @home ||= Dir.home
       end
 
       def engine
-        @engine ||= defined?(RUBY_ENGINE) ? RUBY_ENGINE.to_sym : :ruby
+        @engine ||= RUBY_ENGINE.to_sym
       end
 
       def os
@@ -52,8 +51,13 @@ module Selenium
       end
 
       def ci
-        return :travis if ENV['TRAVIS']
-        :jenkins if ENV['JENKINS']
+        if ENV['TRAVIS']
+          :travis
+        elsif ENV['JENKINS']
+          :jenkins
+        elsif ENV['APPVEYOR']
+          :appveyor
+        end
       end
 
       def bitsize
@@ -72,10 +76,6 @@ module Selenium
         engine == :jruby
       end
 
-      def ironruby?
-        engine == :ironruby
-      end
-
       def ruby_version
         RUBY_VERSION
       end
@@ -92,36 +92,50 @@ module Selenium
         os == :linux
       end
 
+      def wsl?
+        return false unless linux?
+
+        File.read('/proc/version').include?('Microsoft')
+      rescue Errno::EACCES
+        # the file cannot be accessed on Linux on DeX
+        false
+      end
+
       def cygwin?
         RUBY_PLATFORM =~ /cygwin/
         !Regexp.last_match.nil?
       end
 
       def null_device
-        @null_device ||= if defined?(File::NULL)
-                           File::NULL
-                         else
-                           Platform.windows? ? 'NUL' : '/dev/null'
-                         end
+        File::NULL
       end
 
       def wrap_in_quotes_if_necessary(str)
         windows? && !cygwin? ? %("#{str}") : str
       end
 
-      def cygwin_path(path, opts = {})
+      def cygwin_path(path, **opts)
         flags = []
         opts.each { |k, v| flags << "--#{k}" if v }
 
         `cygpath #{flags.join ' '} "#{path}"`.strip
       end
 
+      def unix_path(path)
+        path.tr(File::ALT_SEPARATOR, File::SEPARATOR)
+      end
+
+      def windows_path(path)
+        path.tr(File::SEPARATOR, File::ALT_SEPARATOR)
+      end
+
       def make_writable(file)
-        File.chmod 0766, file
+        File.chmod 0o766, file
       end
 
       def assert_file(path)
         return if File.file? path
+
         raise Error::WebDriverError, "not a file: #{path.inspect}"
       end
 
@@ -129,6 +143,7 @@ module Selenium
         assert_file(path)
 
         return if File.executable? path
+
         raise Error::WebDriverError, "not executable: #{path.inspect}"
       end
 
@@ -140,15 +155,18 @@ module Selenium
 
       def find_binary(*binary_names)
         paths = ENV['PATH'].split(File::PATH_SEPARATOR)
-        binary_names.map! { |n| "#{n}.exe" } if windows?
+
+        if windows?
+          binary_names.map! { |n| "#{n}.exe" }
+          binary_names.dup.each { |n| binary_names << n.gsub('exe', 'bat') }
+        end
 
         binary_names.each do |binary_name|
           paths.each do |path|
             full_path = File.join(path, binary_name)
-            full_path.tr!('\\', '/') if windows?
-            exe = Dir.glob(full_path).first
-            next unless exe
-            return exe if File.executable?(exe)
+            full_path = unix_path(full_path) if windows?
+            exe = Dir.glob(full_path).find { |f| File.executable?(f) }
+            return exe if exe
           end
         end
 
@@ -158,7 +176,8 @@ module Selenium
       def find_in_program_files(*binary_names)
         paths = [
           ENV['PROGRAMFILES'] || '\\Program Files',
-          ENV['ProgramFiles(x86)'] || '\\Program Files (x86)'
+          ENV['ProgramFiles(x86)'] || '\\Program Files (x86)',
+          ENV['ProgramW6432'] || '\\Program Files'
         ]
 
         paths.each do |root|
@@ -175,6 +194,7 @@ module Selenium
         info = Socket.getaddrinfo 'localhost', 80, Socket::AF_INET, Socket::SOCK_STREAM
 
         return info[0][3] unless info.empty?
+
         raise Error::WebDriverError, "unable to translate 'localhost' for TCP + IPv4"
       end
 
@@ -203,17 +223,3 @@ module Selenium
     end # Platform
   end # WebDriver
 end # Selenium
-
-if __FILE__ == $PROGRAM_NAME
-  p engine: Selenium::WebDriver::Platform.engine,
-    os: Selenium::WebDriver::Platform.os,
-    ruby_version: Selenium::WebDriver::Platform.ruby_version,
-    jruby?: Selenium::WebDriver::Platform.jruby?,
-    windows?: Selenium::WebDriver::Platform.windows?,
-    home: Selenium::WebDriver::Platform.home,
-    bitsize: Selenium::WebDriver::Platform.bitsize,
-    localhost: Selenium::WebDriver::Platform.localhost,
-    ip: Selenium::WebDriver::Platform.ip,
-    interfaces: Selenium::WebDriver::Platform.interfaces,
-    null_device: Selenium::WebDriver::Platform.null_device
-end

data/lib/selenium/webdriver/common/port_prober.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
@@ -25,28 +25,17 @@ module Selenium
         port
       end
 
-      def self.random
-        # TODO: Avoid this
-        #
-        # (a) should pick a port that's guaranteed to be free on all interfaces
-        # (b) should pick a random port outside the ephemeral port range
-        #
-        server = TCPServer.new(Platform.localhost, 0)
-        port   = server.addr[1]
-        server.close
-
-        port
-      end
-
-      IGNORED_ERRORS = [Errno::EADDRNOTAVAIL].freeze
-      IGNORED_ERRORS << Errno::EBADF if Platform.cygwin?
+      IGNORED_ERRORS = [Errno::EADDRNOTAVAIL, Errno::EAFNOSUPPORT].tap { |arr|
+        arr << Errno::EBADF if Platform.cygwin?
+        arr << Errno::EACCES if Platform.windows?
+      }.freeze
 
       def self.free?(port)
         Platform.interfaces.each do |host|
           begin
             TCPServer.new(host, port).close
-          rescue *IGNORED_ERRORS => ex
-            $stderr.puts "port prober could not bind to #{host}:#{port} (#{ex.message})" if $DEBUG
+          rescue *IGNORED_ERRORS => e
+            WebDriver.logger.debug("port prober could not bind to #{host}:#{port} (#{e.message})")
             # ignored - some machines appear unable to bind to some of their interfaces
           end
         end

data/lib/selenium/webdriver/common/profile_helper.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
@@ -31,8 +31,16 @@ module Selenium
         base.extend ClassMethods
       end
 
+      def self.decoded(json)
+        JSON.parse(json).fetch('zip')
+      end
+
+      def encoded
+        Zipper.zip(layout_on_disk)
+      end
+
       def as_json(*)
-        {'zip' => Zipper.zip(layout_on_disk)}
+        {"zip" => encoded}
       end
 
       def to_json(*)
@@ -46,7 +54,7 @@ module Selenium
 
         # TODO: must be a better way..
         FileUtils.rm_rf tmp_directory
-        FileUtils.mkdir_p File.dirname(tmp_directory), mode: 0700
+        FileUtils.mkdir_p File.dirname(tmp_directory), mode: 0o700
         FileUtils.cp_r directory, tmp_directory
 
         tmp_directory
@@ -63,7 +71,7 @@ module Selenium
 
       module ClassMethods
         def from_json(json)
-          data = JSON.parse(json).fetch('zip')
+          data = decoded(json)
 
           # can't use Tempfile here since it doesn't support File::BINARY mode on 1.8
           # can't use Dir.mktmpdir(&blk) because of http://jira.codehaus.org/browse/JRUBY-4082

data/lib/selenium/webdriver/common/proxy.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
@@ -37,9 +37,10 @@ module Selenium
                  auto_detect: 'autodetect',
                  socks: 'socksProxy',
                  socks_username: 'socksUsername',
-                 socks_password: 'socksPassword'}.freeze
+                 socks_password: 'socksPassword',
+                 socks_version: 'socksVersion'}.freeze
 
-      ALLOWED.keys.each { |t| attr_reader t }
+      ALLOWED.each_key { |t| attr_reader t }
 
       def self.json_create(data)
         data['proxyType'] = data['proxyType'].downcase.to_sym
@@ -66,6 +67,7 @@ module Selenium
         end
 
         return if not_allowed.empty?
+
         raise ArgumentError, "unknown option#{'s' if not_allowed.size != 1}: #{not_allowed.inspect}"
       end
 
@@ -119,10 +121,13 @@ module Selenium
         @socks_password = value
       end
 
+      def socks_version=(value)
+        self.type = :manual
+        @socks_version = value
+      end
+
       def type=(type)
-        unless TYPES.key? type
-          raise ArgumentError, "invalid proxy type: #{type.inspect}, expected one of #{TYPES.keys.inspect}"
-        end
+        raise ArgumentError, "invalid proxy type: #{type.inspect}, expected one of #{TYPES.keys.inspect}" unless TYPES.key? type
 
         if defined?(@type) && type != @type
           raise ArgumentError, "incompatible proxy type #{type.inspect} (already set to #{@type.inspect})"
@@ -142,7 +147,8 @@ module Selenium
           'autodetect' => auto_detect,
           'socksProxy' => socks,
           'socksUsername' => socks_username,
-          'socksPassword' => socks_password
+          'socksPassword' => socks_password,
+          'socksVersion' => socks_version
         }.delete_if { |_k, v| v.nil? }
 
         json_result if json_result.length > 1

data/lib/selenium/webdriver/common/search_context.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
@@ -30,25 +30,29 @@ module Selenium
         link_text: 'link text',
         name: 'name',
         partial_link_text: 'partial link text',
+        relative: 'relative',
         tag_name: 'tag name',
         xpath: 'xpath'
       }.freeze
 
       #
-      # Find the first element matching the given arguments.
+      # Find the first element matching the given arguments
       #
       # When using Element#find_element with :xpath, be aware that webdriver
       # follows standard conventions: a search prefixed with "//" will search
       # the entire document, not just the children of this current node. Use
       # ".//" to limit your search to the children of the receiving Element.
       #
-      # @param [:class, :class_name, :css, :id, :link_text, :link, :partial_link_text, :name, :tag_name, :xpath] how
-      # @param [String] what
+      # @overload find_element(how, what)
+      #   @param [Symbol, String] how The method to find the element by
+      #   @param [String] what The locator to use
+      # @overload find_element(opts)
+      #   @param [Hash] opts Find options
+      #   @option opts [Symbol] :how Key named after the method to find the element by, containing the locator
       # @return [Element]
       #
       # @raise [Error::NoSuchElementError] if the element doesn't exist
       #
-      #
 
       def find_element(*args)
         how, what = extract_args(args)
@@ -56,8 +60,8 @@ module Selenium
         by = FINDERS[how.to_sym]
         raise ArgumentError, "cannot find element by #{how.inspect}" unless by
 
-        bridge.find_element_by by, what.to_s, ref
-      rescue Selenium::WebDriver::Error::TimeOutError
+        bridge.find_element_by by, what, ref
+      rescue Selenium::WebDriver::Error::TimeoutError
         # Implicit Wait times out in Edge
         raise Selenium::WebDriver::Error::NoSuchElementError
       end
@@ -67,10 +71,6 @@ module Selenium
       #
       # @see SearchContext#find_element
       #
-      # @param [:class, :class_name, :css, :id, :link_text, :link, :partial_link_text, :name, :tag_name, :xpath] how
-      # @param [String] what
-      # @return [Array<Element>]
-      #
 
       def find_elements(*args)
         how, what = extract_args(args)
@@ -78,8 +78,8 @@ module Selenium
         by = FINDERS[how.to_sym]
         raise ArgumentError, "cannot find elements by #{how.inspect}" unless by
 
-        bridge.find_elements_by by, what.to_s, ref
-      rescue Selenium::WebDriver::Error::TimeOutError
+        bridge.find_elements_by by, what, ref
+      rescue Selenium::WebDriver::Error::TimeoutError
         # Implicit Wait times out in Edge
         []
       end
@@ -93,15 +93,11 @@ module Selenium
         when 1
           arg = args.first
 
-          unless arg.respond_to?(:shift)
-            raise ArgumentError, "expected #{arg.inspect}:#{arg.class} to respond to #shift"
-          end
+          raise ArgumentError, "expected #{arg.inspect}:#{arg.class} to respond to #shift" unless arg.respond_to?(:shift)
 
           # this will be a single-entry hash, so use #shift over #first or #[]
           arr = arg.dup.shift
-          unless arr.size == 2
-            raise ArgumentError, "expected #{arr.inspect} to have 2 elements"
-          end
+          raise ArgumentError, "expected #{arr.inspect} to have 2 elements" unless arr.size == 2
 
           arr
         else

data/lib/selenium/webdriver/common/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
@@ -23,36 +23,77 @@ module Selenium
     # Base class implementing default behavior of service object,
     # responsible for starting and stopping driver implementations.
     #
-    # Subclasses must implement the following private methods:
-    #   * #start_process
-    #   * #stop_server
-    #   * #cannot_connect_error_text
-    #
-    # @api private
-    #
 
     class Service
-      START_TIMEOUT       = 20
+      START_TIMEOUT = 20
       SOCKET_LOCK_TIMEOUT = 45
-      STOP_TIMEOUT        = 20
+      STOP_TIMEOUT = 20
+
+      class << self
+        attr_reader :driver_path
+
+        def chrome(**opts)
+          Chrome::Service.new(**opts)
+        end
+
+        def firefox(**opts)
+          Firefox::Service.new(**opts)
+        end
+
+        def ie(**opts)
+          IE::Service.new(**opts)
+        end
+        alias_method :internet_explorer, :ie
+
+        def edge(**opts)
+          Edge::Service.new(**opts)
+        end
+
+        def edge_chrome(**opts)
+          EdgeChrome::Service.new(**opts)
+        end
+
+        def edge_html(**opts)
+          EdgeHtml::Service.new(**opts)
+        end
+
+        def safari(**opts)
+          Safari::Service.new(**opts)
+        end
+
+        def driver_path=(path)
+          Platform.assert_executable path if path.is_a?(String)
+          @driver_path = path
+        end
+      end
 
       attr_accessor :host
+      attr_reader :executable_path
+
+      #
+      # End users should use a class method for the desired driver, rather than using this directly.
+      #
+      # @api private
+      #
+
+      def initialize(path: nil, port: nil, args: nil)
+        path ||= self.class.driver_path
+        port ||= self.class::DEFAULT_PORT
+        args ||= []
+
+        @executable_path = binary_path(path)
+        @host = Platform.localhost
+        @port = Integer(port)
 
-      def initialize(executable_path, port, *extra_args)
-        @executable_path = executable_path
-        @host            = Platform.localhost
-        @port            = Integer(port)
-        @extra_args      = extra_args
+        @extra_args = args.is_a?(Hash) ? extract_service_args(args) : args
 
         raise Error::WebDriverError, "invalid port: #{@port}" if @port < 1
       end
 
       def start
-        if process_running?
-          raise "already started: #{uri.inspect} #{@executable_path.inspect}"
-        end
+        raise "already started: #{uri.inspect} #{@executable_path.inspect}" if process_running?
 
-        Platform.exit_hook { stop } # make sure we don't leave the server running
+        Platform.exit_hook(&method(:stop)) # make sure we don't leave the server running
 
         socket_lock.locked do
           find_free_port
@@ -62,8 +103,12 @@ module Selenium
       end
 
       def stop
-        return if process_exited?
+        return unless self.class::SHUTDOWN_SUPPORTED
+
         stop_server
+        @process.poll_for_exit STOP_TIMEOUT
+      rescue ChildProcess::TimeoutError
+        nil # noop
       ensure
         stop_process
       end
@@ -74,6 +119,29 @@ module Selenium
 
       private
 
+      def binary_path(path = nil)
+        path = path.call if path.is_a?(Proc)
+        path ||= Platform.find_binary(self.class::EXECUTABLE)
+
+        raise Error::WebDriverError, self.class::MISSING_TEXT unless path
+
+        Platform.assert_executable path
+        path
+      end
+
+      def build_process(*command)
+        WebDriver.logger.debug("Executing Process #{command}")
+        @process = ChildProcess.build(*command)
+        if WebDriver.logger.debug?
+          @process.io.stdout = @process.io.stderr = WebDriver.logger.io
+        elsif Platform.jruby?
+          # Apparently we need to read the output of drivers on JRuby.
+          @process.io.stdout = @process.io.stderr = File.new(Platform.null_device, 'w')
+        end
+
+        @process
+      end
+
       def connect_to_server
         Net::HTTP.start(@host, @port) do |http|
           http.open_timeout = STOP_TIMEOUT / 2
@@ -88,21 +156,30 @@ module Selenium
       end
 
       def start_process
-        raise NotImplementedError, 'subclass responsibility'
-      end
-
-      def stop_server
-        raise NotImplementedError, 'subclass responsibility'
+        @process = build_process(@executable_path, "--port=#{@port}", *@extra_args)
+        # Note: this is a bug only in Windows 7
+        @process.leader = true unless Platform.windows?
+        @process.start
       end
 
       def stop_process
-        @process.poll_for_exit STOP_TIMEOUT
-      rescue ChildProcess::TimeoutError
+        return if process_exited?
+
         @process.stop STOP_TIMEOUT
+        @process.io.stdout.close if Platform.jruby? && !WebDriver.logger.debug?
+      end
+
+      def stop_server
+        return if process_exited?
+
+        connect_to_server do |http|
+          headers = WebDriver::Remote::Http::Common::DEFAULT_HEADERS.dup
+          http.get('/shutdown', headers)
+        end
       end
 
       def process_running?
-        @process && @process.alive?
+        defined?(@process) && @process&.alive?
       end
 
       def process_exited?
@@ -112,16 +189,24 @@ module Selenium
       def connect_until_stable
         socket_poller = SocketPoller.new @host, @port, START_TIMEOUT
         return if socket_poller.connected?
+
         raise Error::WebDriverError, cannot_connect_error_text
       end
 
       def cannot_connect_error_text
-        raise NotImplementedError, 'subclass responsibility'
+        "unable to connect to #{self.class::EXECUTABLE} #{@host}:#{@port}"
       end
 
       def socket_lock
         @socket_lock ||= SocketLock.new(@port - 1, SOCKET_LOCK_TIMEOUT)
       end
+
+      protected
+
+      def extract_service_args(driver_opts)
+        driver_opts.key?(:args) ? driver_opts.delete(:args) : []
+      end
+
     end # Service
   end # WebDriver
 end # Selenium