selenium-webdriver 4.2.1 → 4.15.0

data/lib/selenium/webdriver/common/proxy.rb

@@ -74,7 +74,7 @@ module Selenium
       def ==(other)
         other.is_a?(self.class) && as_json == other.as_json
       end
-      alias_method :eql?, :==
+      alias eql? ==
 
       def ftp=(value)
         self.type = :manual
@@ -152,7 +152,7 @@ module Selenium
           'socksUsername' => socks_username,
           'socksPassword' => socks_password,
           'socksVersion' => socks_version
-        }.delete_if { |_k, v| v.nil? }
+        }.compact
 
         json_result if json_result.length > 1
       end

data/lib/selenium/webdriver/common/selenium_manager.rb

@@ -0,0 +1,134 @@
+# 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 'open3'
+
+module Selenium
+  module WebDriver
+    #
+    # Wrapper for getting information from the Selenium Manager binaries.
+    # This implementation is still in beta, and may change.
+    # @api private
+    #
+    class SeleniumManager
+      class << self
+        attr_writer :bin_path
+
+        def bin_path
+          @bin_path ||= '../../../../../bin'
+        end
+
+        # @param [Options] options browser options.
+        # @return [String] the path to the correct driver.
+        def driver_path(options)
+          command = generate_command(binary, options)
+
+          output = run(*command)
+
+          browser_path = output['browser_path']
+          driver_path = output['driver_path']
+          Platform.assert_executable driver_path
+
+          if options.respond_to?(:binary) && browser_path && !browser_path.empty?
+            options.binary = browser_path
+            options.browser_version = nil
+          end
+
+          driver_path
+        end
+
+        private
+
+        def generate_command(binary, options)
+          command = [binary, '--browser', options.browser_name]
+          if options.browser_version
+            command << '--browser-version'
+            command << options.browser_version
+          end
+          if options.respond_to?(:binary) && !options.binary.nil?
+            command << '--browser-path'
+            command << options.binary.gsub('\\', '\\\\\\')
+          end
+          if options.proxy
+            command << '--proxy'
+            (command << options.proxy.ssl) || options.proxy.http
+          end
+          command
+        end
+
+        # @return [String] the path to the correct selenium manager
+        def binary
+          @binary ||= begin
+            location = ENV.fetch('SE_MANAGER_PATH', begin
+              directory = File.expand_path(bin_path, __FILE__)
+              if Platform.windows?
+                "#{directory}/windows/selenium-manager.exe"
+              elsif Platform.mac?
+                "#{directory}/macos/selenium-manager"
+              elsif Platform.linux?
+                "#{directory}/linux/selenium-manager"
+              end
+            end)
+
+            validate_location(location)
+            location
+          end
+        end
+
+        def validate_location(location)
+          begin
+            Platform.assert_file(location)
+            Platform.assert_executable(location)
+          rescue TypeError
+            raise Error::WebDriverError,
+                  "Unable to locate or obtain Selenium Manager binary; #{location} is not a valid file object"
+          rescue Error::WebDriverError => e
+            raise Error::WebDriverError, "Selenium Manager binary located, but #{e.message}"
+          end
+
+          WebDriver.logger.debug("Selenium Manager binary found at #{location}", id: :selenium_manager)
+        end
+
+        def run(*command)
+          command += %w[--output json]
+          command << '--debug' if WebDriver.logger.debug?
+
+          WebDriver.logger.debug("Executing Process #{command}", id: :selenium_manager)
+
+          begin
+            stdout, stderr, status = Open3.capture3(*command)
+          rescue StandardError => e
+            raise Error::WebDriverError, "Unsuccessful command executed: #{command}; #{e.message}"
+          end
+
+          json_output = stdout.empty? ? {} : JSON.parse(stdout)
+          (json_output['logs'] || []).each do |log|
+            level = log['level'].casecmp('info').zero? ? 'debug' : log['level'].downcase
+            WebDriver.logger.send(level, log['message'], id: :selenium_manager)
+          end
+
+          result = json_output['result']
+          return result unless status.exitstatus.positive?
+
+          raise Error::WebDriverError, "Unsuccessful command executed: #{command}\n#{result}#{stderr}"
+        end
+      end
+    end # SeleniumManager
+  end # WebDriver
+end # Selenium

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

@@ -39,12 +39,13 @@ module Selenium
         def ie(**opts)
           IE::Service.new(**opts)
         end
-        alias_method :internet_explorer, :ie
+        alias internet_explorer ie
 
         def edge(**opts)
           Edge::Service.new(**opts)
         end
-        alias_method :microsoftedge, :edge
+        alias microsoftedge edge
+        alias msedge edge
 
         def safari(**opts)
           Safari::Service.new(**opts)
@@ -56,8 +57,8 @@ module Selenium
         end
       end
 
-      attr_accessor :host
-      attr_reader :executable_path, :port, :extra_args
+      attr_accessor :host, :executable_path, :port, :log, :args
+      alias extra_args args
 
       #
       # End users should use a class method for the desired driver, rather than using this directly.
@@ -65,47 +66,37 @@ module Selenium
       # @api private
       #
 
-      def initialize(path: nil, port: nil, args: nil)
-        path ||= self.class.driver_path
+      def initialize(path: nil, port: nil, log: nil, args: nil)
         port ||= self.class::DEFAULT_PORT
         args ||= []
 
-        @executable_path = binary_path(path)
+        @executable_path = path
         @host = Platform.localhost
         @port = Integer(port)
-
-        @extra_args = args.is_a?(Hash) ? extract_service_args(args) : args
+        @log = case log
+               when :stdout
+                 $stdout
+               when :stderr
+                 $stderr
+               else
+                 log
+               end
+        @args = args
 
         raise Error::WebDriverError, "invalid port: #{@port}" if @port < 1
       end
 
       def launch
-        sm = ServiceManager.new(self)
-        sm.start
-        sm
+        @executable_path ||= begin
+          default_options = WebDriver.const_get("#{self.class.name.split('::')[2]}::Options").new
+          DriverFinder.path(default_options, self.class)
+        end
+        ServiceManager.new(self).tap(&:start)
       end
 
       def shutdown_supported
         self.class::SHUTDOWN_SUPPORTED
       end
-
-      protected
-
-      def extract_service_args(driver_opts)
-        driver_opts.key?(:args) ? driver_opts.delete(:args) : []
-      end
-
-      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
     end # Service
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver/common/service_manager.rb

@@ -40,7 +40,8 @@ module Selenium
         @executable_path = config.executable_path
         @host = Platform.localhost
         @port = config.port
-        @extra_args = config.extra_args
+        @io = config.log
+        @extra_args = config.args
         @shutdown_supported = config.shutdown_supported
 
         raise Error::WebDriverError, "invalid port: #{@port}" if @port < 1
@@ -64,7 +65,7 @@ module Selenium
 
         stop_server
         @process.poll_for_exit STOP_TIMEOUT
-      rescue ChildProcess::TimeoutError
+      rescue ChildProcess::TimeoutError, Errno::ECONNREFUSED
         nil # noop
       ensure
         stop_process
@@ -77,14 +78,10 @@ module Selenium
       private
 
       def build_process(*command)
-        WebDriver.logger.debug("Executing Process #{command}")
+        WebDriver.logger.debug("Executing Process #{command}", id: :driver_service)
         @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
+        @io ||= WebDriver.logger.io if WebDriver.logger.debug?
+        @process.io = @io if @io
 
         @process
       end
@@ -104,8 +101,6 @@ module Selenium
 
       def start_process
         @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
 
@@ -113,7 +108,6 @@ module Selenium
         return if process_exited?
 
         @process.stop STOP_TIMEOUT
-        @process.io.stdout.close if Platform.jruby? && !WebDriver.logger.debug?
       end
 
       def stop_server

data/lib/selenium/webdriver/common/shadow_root.rb

@@ -42,7 +42,7 @@ module Selenium
       def ==(other)
         other.is_a?(self.class) && ref == other.ref
       end
-      alias_method :eql?, :==
+      alias eql? ==
 
       def hash
         [@id, @bridge].hash
@@ -81,7 +81,6 @@ module Selenium
       private
 
       attr_reader :bridge
-
     end # ShadowRoot
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver/common/socket_lock.rb

@@ -26,6 +26,7 @@ module Selenium
     class SocketLock
       def initialize(port, timeout)
         @port    = port
+        @server  = nil
         @timeout = timeout
       end
 
@@ -66,11 +67,10 @@ module Selenium
 
       def can_lock?
         @server = TCPServer.new(Platform.localhost, @port)
-        ChildProcess.close_on_exec @server
-
+        @server.close_on_exec = true
         true
       rescue SocketError, Errno::EADDRINUSE, Errno::EBADF => e
-        WebDriver.logger.debug("#{self}: #{e.message}")
+        WebDriver.logger.debug("#{self}: #{e.message}", id: :driver_service)
         false
       end
 

data/lib/selenium/webdriver/common/socket_poller.rb

@@ -93,7 +93,7 @@ module Selenium
           true
         rescue *NOT_CONNECTED_ERRORS
           sock&.close
-          WebDriver.logger.debug("polling for socket on #{[@host, @port].inspect}")
+          WebDriver.logger.debug("polling for socket on #{[@host, @port].inspect}", id: :driver_service)
           false
         end
       end

data/lib/selenium/webdriver/common/takes_screenshot.rb

@@ -32,8 +32,8 @@ module Selenium
       def save_screenshot(png_path, full_page: false)
         extension = File.extname(png_path).downcase
         if extension != '.png'
-          WebDriver.logger.warn "name used for saved screenshot does not match file type. "\
-                                "It should end with .png extension",
+          WebDriver.logger.warn 'name used for saved screenshot does not match file type. ' \
+                                'It should end with .png extension',
                                 id: :screenshot
         end
         File.open(png_path, 'wb') { |f| f << screenshot_as(:png, full_page: full_page) }
@@ -60,7 +60,6 @@ module Selenium
       rescue NameError
         raise Error::UnsupportedOperationError, "Full Page Screenshots are not supported for #{inspect}"
       end
-
     end # TakesScreenshot
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver/common/target_locator.rb

@@ -51,9 +51,8 @@ module Selenium
       #
 
       def new_window(type = :window)
-        unless %i[window tab].include?(type)
-          raise ArgumentError, "Valid types are :tab and :window, received: #{type.inspect}"
-        end
+        raise ArgumentError, "Valid types are :tab and :window, received: #{type.inspect}" unless %i[window
+                                                                                                     tab].include?(type)
 
         handle = @bridge.new_window(type)['handle']
 

data/lib/selenium/webdriver/common/timeouts.rb

@@ -48,7 +48,7 @@ module Selenium
       def script
         Float(@bridge.timeouts['script']) / 1000
       end
-      alias_method :script_timeout, :script
+      alias script_timeout script
 
       #
       # Sets the amount of time to wait for an asynchronous script to finish
@@ -59,7 +59,7 @@ module Selenium
       def script=(seconds)
         @bridge.timeouts = {'script' => Integer(seconds * 1000)}
       end
-      alias_method :script_timeout=, :script=
+      alias script_timeout= script=
 
       #
       # Gets the amount of time to wait for a page load to complete before throwing an error.

data/lib/selenium/webdriver/common/virtual_authenticator/credential.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.
+
+#
+# A credential stored in a virtual authenticator.
+# @see https://w3c.github.io/webauthn/#credential-parameters
+#
+
+module Selenium
+  module WebDriver
+    class Credential
+      class << self
+        def resident(**opts)
+          Credential.new(resident_credential: true, **opts)
+        end
+
+        def non_resident(**opts)
+          Credential.new(resident_credential: false, **opts)
+        end
+
+        def encode(byte_array)
+          Base64.urlsafe_encode64(byte_array&.pack('C*'))
+        end
+
+        def decode(base64)
+          Base64.urlsafe_decode64(base64).unpack('C*')
+        end
+
+        def from_json(opts)
+          user_handle = opts['userHandle'] ? decode(opts['userHandle']) : nil
+          new(id: decode(opts['credentialId']),
+              resident_credential: opts['isResidentCredential'],
+              rp_id: opts['rpId'],
+              private_key: opts['privateKey'],
+              sign_count: opts['signCount'],
+              user_handle: user_handle)
+        end
+      end
+
+      attr_reader :id, :resident_credential, :rp_id, :user_handle, :private_key, :sign_count
+      alias resident_credential? resident_credential
+
+      def initialize(id:, resident_credential:, rp_id:, private_key:, **opts)
+        @id = id
+        @resident_credential = resident_credential
+        @rp_id = rp_id
+        @user_handle = opts.delete(:user_handle) { nil }
+        @private_key = private_key
+        @sign_count = opts.delete(:sign_count) { 0 }
+
+        raise ArgumentError, "Invalid arguments: #{opts.keys}" unless opts.empty?
+      end
+
+      #
+      # @api private
+      #
+
+      def as_json(*)
+        credential_data = {'credentialId' => Credential.encode(id),
+                           'isResidentCredential' => resident_credential?,
+                           'rpId' => rp_id,
+                           'privateKey' => Credential.encode(private_key),
+                           'signCount' => sign_count}
+        credential_data['userHandle'] = Credential.encode(user_handle) if user_handle
+        credential_data
+      end
+    end # Credential
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/common/virtual_authenticator/virtual_authenticator.rb

@@ -0,0 +1,72 @@
+# 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
+    class VirtualAuthenticator
+      attr_reader :options
+
+      #
+      # api private
+      # Use `Driver#add_virtual_authenticator`
+      #
+
+      def initialize(bridge, authenticator_id, options)
+        @id = authenticator_id
+        @bridge = bridge
+        @options = options
+        @valid = true
+      end
+
+      def add_credential(credential)
+        credential = credential.as_json
+        @bridge.add_credential credential, @id
+      end
+
+      def credentials
+        credential_data = @bridge.credentials @id
+        credential_data.map do |cred|
+          Credential.from_json(cred)
+        end
+      end
+
+      def remove_credential(credential_id)
+        credential_id = Credential.encode(credential_id) if credential_id.instance_of?(Array)
+        @bridge.remove_credential credential_id, @id
+      end
+
+      def remove_all_credentials
+        @bridge.remove_all_credentials @id
+      end
+
+      def user_verified=(verified)
+        @bridge.user_verified verified, @id
+      end
+
+      def remove!
+        @bridge.remove_virtual_authenticator(@id)
+        @valid = false
+      end
+
+      def valid?
+        @valid
+      end
+    end # VirtualAuthenticator
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/common/virtual_authenticator/virtual_authenticator_options.rb

@@ -0,0 +1,62 @@
+# 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.
+
+#
+# Options for the creation of virtual authenticators.
+# @see http://w3c.github.io/webauthn/#sctn-automation
+#
+
+module Selenium
+  module WebDriver
+    class VirtualAuthenticatorOptions
+      PROTOCOL = {ctap2: 'ctap2', u2f: 'ctap1/u2f'}.freeze
+      TRANSPORT = {ble: 'ble', usb: 'usb', nfc: 'nfc', internal: 'internal'}.freeze
+
+      attr_accessor :protocol, :transport, :resident_key, :user_verification, :user_consenting, :user_verified
+      alias resident_key? resident_key
+      alias user_verification? user_verification
+      alias user_consenting? user_consenting
+      alias user_verified? user_verified
+
+      def initialize(**opts)
+        @protocol = opts.delete(:protocol) { :ctap2 }
+        @transport = opts.delete(:transport) { :usb }
+        @resident_key = opts.delete(:resident_key) { false }
+        @user_verification = opts.delete(:user_verification) { false }
+        @user_consenting = opts.delete(:user_consenting) { true }
+        @user_verified = opts.delete(:user_verified) { false }
+
+        raise ArgumentError, "Invalid arguments: #{opts.keys}" unless opts.empty?
+      end
+
+      #
+      # @api private
+      #
+
+      def as_json(*)
+        {'protocol' => PROTOCOL[protocol],
+         'transport' => TRANSPORT[transport],
+         'hasResidentKey' => resident_key?,
+         'hasUserVerification' => user_verification?,
+         'isUserConsenting' => user_consenting?,
+         'isUserVerified' => user_verified?}
+      end
+    end # VirtualAuthenticatorOptions
+  end # WebDriver
+end # Selenium