selenium-webdriver 3.142.7 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c9f40e154da198fff9e277f0613042c22fff6c98
-  data.tar.gz: 33cc734e78b08e66c00a4c73f51c635d97c86fe6
+SHA256:
+  metadata.gz: 40e4bef1fdee7ae817c56466ec231be400d677d56a8c8f46b797c6b3eba28de9
+  data.tar.gz: a9c1af31f12db6096f06c2a89e487e40ea2bb53b8f6e46e5f77a3046f149bb34
 SHA512:
-  metadata.gz: b40eb2e74a284b21ee31924f7cf20b878c7ab6ebcfe7848b21ad163165c80467c9d3a6fa6252ca74680b82db7186e8c1b73a2ac5f4d37501b0dfa16763ec19b9
-  data.tar.gz: bc9e9e0128888f3efe33f59160b677cc88655bf986877c534053adf915f3b39a78ff1d88e9b2d80753c1aba49af92f1796bb4f774ca68114027594813cc26ad3
+  metadata.gz: b5325d0fe9f5fdb721ed4a6daa1384d7876dc7a072dd52f46c73d76b1614434c123fff2b4a9d7de01538968eddfbad57f2e1a87f4dce0e560a850dcf21988840
+  data.tar.gz: 3b345ac66d051c32267d1c4ef9b2dd70aea36e2c4e5bb35ce30197d748effca8fed460824d1961ad5a39340358fc9be3f200708a38557e5e878b09be1b0d61c0

data/CHANGES

@@ -1,3 +1,362 @@
+4.1.0 (2021-11-18)
+=========================
+
+DevTools:
+  * Released selenium-devtools 0.95.0 (supports CDP v85, v93, v94, v95)
+  * Released selenium-devtools 0.96.0 (supports CDP v85, v94, v95, v96)
+  * Added support for secure websockets (#10017)
+
+Ruby:
+  * Execute Script supports ShadowRoots (#10019)
+  * Fixed bug preventing zipping temp files on Windows (#9987)
+  * Sang Pumpkin Carol (thanks Jari!)
+
+4.0.3 (2021-10-20)
+=========================
+
+Firefox:
+  * Fixed bug avoiding camel casing prefs (#9944 thanks @glaszig)
+
+Ruby:
+  * Fixed bug in Select class for finding by index (#9945)
+
+Remote:
+  * Fixed bug preventing sending keys with an empty value
+
+4.0.2 (2021-10-19)
+=========================
+
+Server:
+  * Fixed bug in new download code.
+
+4.0.1 (2021-10-19)
+=========================
+
+Server:
+  * Fixed download by pointing to new storage location.
+    - Only supports Selenium 4 versions
+  * Added default value for Server::get and Server::download to use the latest server version
+
+4.0.0 (2021-10-13)
+=========================
+
+Ruby:
+  * Updated minimum required Ruby version to 2.6
+  * Updated minimum required rexml gem version due to vulnerability
+
+Chrome:
+  * Added default values for Network Conditions so no longer need to specify everything
+
+Firefox:
+  * Fixed bug where Firefox prefs were converting snake case to camel case
+
+4.0.0.rc3 (2021-10-08)
+=========================
+
+Ruby:
+  * Added support for getting timeout values from the driver
+
+4.0.0.rc2 (2021-09-30)
+=========================
+
+DevTools:
+  * Released selenium-devtools 0.93.0 (2021-09-01)
+    - adds CDP version 93
+    - removes CDP version 91
+  * Released selenium-devtools 0.94.0 (2021-09-22)
+    - adds CDP version 94
+    - removes CDP version 92
+  * Added support for mutating responses in network interception
+
+Ruby:
+  * Implemented Options#add_option to work for vendor extension capabilities
+  * Fixed bug for requiring uri (#9825 thanks @flanger001)
+  * Moved New Window functionality to TargetLocator#new_window to be used with Driver#switch_to
+  * Deprecated using Manager#new_window
+  * Changed order of logging output (#9850)
+  * Added support for web_socket_url capability
+
+Chromium:
+  * Implemented casting functionality
+  * Implemented ability to launch chromium app
+  * Implemented support for specifying permissions
+  * Added support for Chrome-specific Android functionality with #enable_android
+
+Firefox:
+  * Implemented context functionality
+  * Added support for Firefox-specific Android functionality with #enable_android
+
+Remote:
+  * Added support for file detector to install Firefox addons from client machine
+
+4.0.0.rc1 (2021-09-01)
+=========================
+
+DevTools:
+  * Released selenium-devtools 0.92.0 (2021-08-21) which:
+    - adds CDP versions 92
+    - removes CDP versions 88, 89, 90
+
+IE:
+  * Added options for running Microsoft Edge in IE mode with IE Driver
+
+Remote:
+  * Added default file detector for remote driver
+
+Ruby:
+  * Fixed bug for getting valid capability that has not been set
+  * Fixed bug preventing loading of ServerError class
+
+4.0.0.beta4 (2021-06-07)
+=========================
+
+Chrome:
+  * Fixed bug with camel casing of localState object
+
+Firefox:
+  * Added support for Full Page Screenshots
+
+Remote:
+  * Added support for #execute_cdp on Chrome and Edge
+
+Ruby:
+  * Changed capabilities to use alwaysMatch instead of firstMatch by default
+  * Fixed bug preventing Options classes from handling Proxy instances
+
+4.0.0.beta3 (2021-04-13)
+=========================
+
+Chrome:
+  * Fixed a regression with prefs hash keys being converted to camelCase.
+  * Fixed an issue when passing Profile object to Options would fail.
+
+DevTools:
+  * Released selenium-devtools 0.91.0 which:
+    - adds CDP versions 90 and 91
+    - removes CDP versions 86 and 87
+
+Remote:
+  * Added support for setting alwaysMatch/firstMatch capabilities per W3C
+    WebDriver specification. It's done using the following methods where
+    `caps` is either a Ruby hash with desired capabilities or an instance
+    of Remote::Capabilities:
+      * Selenium::WebDriver::Remote::Capabilities.always_match(caps)
+      * Selenium::WebDriver::Remote::Capabilities.first_match(caps)
+  * Added support for Driver#save_print_page.
+  * Fixed an issue with Driver#print_page.
+  * Added support for setting timeouts capabilities in Remote::Capabilities
+    per W3C WebDriver specification.
+  * Added support for Element#aria_role which returns WAI-ARIA role of the element.
+  * Added support for Element#accessible name which returns WAI-ARIA label of the element.
+  * Added support for using DevTools version provided by Grid instead of
+    calculating it manually
+
+Ruby:
+  * Remove JRuby-specific socket poller. Note that this requires JRuby 9.2.8.0+.
+
+4.0.0.beta2 (2021-03-16)
+=========================
+
+DevTools:
+  * Separated out DevTools methods into selenium-devtools gem to better manage versioning
+  * Updated supported versions to 85-89
+  * Add support for intercepting browser requests
+
+Firefox:
+  * Add support for using DevTools commands with Firefox Nightly
+
+Remote:
+  * Provide access to browser specific driver extensions as appropriate for designated browser
+  * Add support for using DevTools commands via Grid
+
+Ruby:
+  * Spec Guard implementation moved into lib directory for other projects to use
+  * Implemented `Element#dom_attribute` to obtain attribute value as defined by w3c specification
+  * Implemented `Options#eq?`
+  * Allow Options subclass instances to be created from class methods in superclass
+
+Safari:
+  * Fix bug that prevented usage of Safari Technology Preview
+
+4.0.0.beta1 (2021-02-15)
+=========================
+
+DevTools:
+  * Updated supported versions to 85-88
+
+Edge:
+  * Removed support for legacy Edge HTML
+
+Firefox:
+  * Fixed support for default profile settings
+  * Added support for Devtools for Firefox v87+
+
+Safari:
+  * Removed default platformName specification so it works with Grid
+
+Ruby:
+  * Added support for httpOnly attribute in Cookies
+  * Implemented `#print_page` method (thanks @raju249)
+  * Fixed support for missing libraries in Ruby 3.0 (thanks @znz)
+  * Deprecated `HTTP::Persistent` class
+  * Fixed support for accessors in options classes
+  * Added support for status endpoint for all browsers
+  * Fix support for Browser, Driver, and Performance Logging in Chrome and Edge
+
+4.0.0.alpha7 (2020-11-10)
+=========================
+
+Chrome:
+  * Fixed a link to download ChromeDriver when it's not found (thanks @masakazutakewaka).
+  * Fixed an issue when passing instance of Profile to an Options in capabilities
+    (thanks @masakazutakewaka).
+
+DevTools:
+  * Added support for multiple version of CDP. Currently supported versions are
+    84-87. The proper version is automatically selected when the browser is started
+    based on its version. The implementation is Chromium-based and is confirmed
+    to work in Chrome and Edge at least.
+  * Added support for basic authentication (see HasAuthentication).
+  * Added support for listening to JavaScript console messages (see HasLogEvents).
+  * Added support for listening to JavaScript exceptions (see HasLogEvents).
+  * Added support for listening to DOM mutations (see HasLogEvents).
+
+Edge:
+  * Switched default Edge implementation to Chromium-based. To use older versions
+    of Edge, pass :edge_html when initializing the driver.
+
+Firefox:
+  * Fixed an issue whereby using the new capabilities structure in local drivers
+    would cause the W3C check to complain that `browser_name` was an invalid
+    capability key name (thanks @luke-hill)
+
+Ruby:
+  * Added support for taking screenshots of individual elements using Element#screenshot
+    (thanks @johndouthat).
+  * Fixed deprecation message of using Net::HTTP::Proxy (thanks @masakazutakewaka).
+  * Fixed false negative detection of Linux on WSL2 (thanks @snsten).
+  * Support ChildProcess 4.x versions (thanks @boutil).
+
+Safari:
+  * Fixed browser name in capabilities for Safari Technology Preview.
+
+4.0.0.alpha6 (2020-05-28)
+=========================
+
+Chrome:
+  * Added DevTools classes and methods generated from the CDP specification.
+    It currently supports commands and events and provides Rubyish API:
+      driver.devtools.page.navigate(url: 'http://google.com')
+      driver.devtools.console.clear_messages
+      driver.devtools.page.enable
+      driver.devtools.page.on(:load_event_fired) do |params|
+        puts("Page loaded in #{params['timestamp']}")
+      end
+    Check https://chromedevtools.github.io/devtools-protocol/ for more information
+    about possible commands and events. Please note that this API is considered
+    to be experimental and may change any time before stable 4.0 release.
+  * Fixed an issue when passing :prompt_for_download (or similar snake_cased
+    symbols) in Options#prefs would be ignored by Chrome because Selenium
+    would internally convert it to camelCased format (:promptForDownload).
+    Now :prefs are left intact.
+
+Edge:
+  * Fixed an issue when Driver#execute_cdp would not work for Chromium-based
+    Edge browser.
+
+Ruby:
+  * Deprecated passing :desired_capabilities and :options to driver initialization
+    in favor of :capabilities. They now can be combined in an array to make
+    custom capabilities requirements:
+      caps = Selenium::WebDriver::Remote::Capabilities.chrome
+      opts = Selenium::WebDriver::Chrome::Options.new
+      Selenium::WebDriver.for(:remote, capabilities: :chrome)
+      Selenium::WebDriver.for(:remote, capabilities: caps)
+      Selenium::WebDriver.for(:remote, capabilities: opts)
+      Selenium::WebDriver.for(:remote, capabilities: [caps, opts])
+  * Deprecated passing Hash to :capabilities in favor of Remote::Capabilities object.
+  * Updated minimum require Ruby version to 2.5.
+  * Improved keyword arguments handling to avoid warnings in Ruby 2.7.
+
+4.0.0.alpha5 (2020-03-18)
+=========================
+
+The release is just to synchronize version with other bindings and does not
+include any changes.
+
+4.0.0.alpha4 (2020-01-09)
+=========================
+
+Ruby:
+  * Added initial support for relative locators, which allow to find elements
+    above/below/left/right/near another element. For example, you can find all
+    the cells in a table to the right of your starting cell:
+      start_cell = driver.find_element(css: 'td')
+      right_cells = driver.find_elements(relative: {tag_name: 'td', right: start_cell})
+    The documentation is still lacking so refer to examples in df6be2e962.
+  * Added ability to silence certain logger messages by using it's identifiers:
+      Selenium::WebDriver.logger.ignore(:driver_path)
+  * Added new dependency: websocket. It's used for communicating with Chrome DevTools.
+  * Loosened childprocess dependency to allow using version 2.0+.
+  * Loosened rubyzip dependency to allow using version 2.0+.
+  * Fixed Errno::EACCES error on Linux DeX and similar distributes
+
+Chrome:
+  * Added initial support for communicating with Chrome DevTools. The implementation
+    is very basic and lacks CDP domains, events and types - those will be added
+    in future releases. Still, it allows to execute simple commands to DevTools:
+      driver.devtools.send('Page.navigate', {url: 'https://google.com'})
+
+4.0.0.alpha3 (2019-07-08)
+=========================
+
+Ruby:
+  * All documented driver capabilities supported in respective browser Options class by constructor and accessor
+  * Driver constructor :options and :desired_capabilities generate the same capabilities for local and remote execution
+  * Deprecated :options as keyword for initializing browser Options classes
+
+Chrome:
+  * Add support for browser logging with latest versions of chromedriver
+
+Edge:
+  * Add support for Chromium based implementation
+
+4.0.0.alpha2 (2019-05-02)
+=========================
+
+Ruby:
+  * Fixed an issue with previous alpha release which lead to removed files
+    being packaged inside the gem
+
+4.0.0.alpha1 (2019-05-01)
+=========================
+
+Ruby:
+  * Removed Mouse and Keyboard as their implementations are not compliant to WebDriver specification
+  * Removed TouchActionBuilder as its implementation is not compliant to WebDriver specification
+  * Change ActionBuilder to be fully compliant to WebDriver specification
+  * Change Manager to be fully compliant to WebDriver specification
+  * Removed all deprecated errors that are not compliant to WebDriver specification
+  * Update minimum required Ruby version to 2.4
+  * Changed capabilities to use only those that are compliant to WebDriver specification
+  * Removed deprecated timeout setter on default HTTP client
+  * Removed deprecated Remote::W3C::Capabilities
+  * Fixed an issue when services are not shutdown properly
+
+Chrome:
+  * Removed support for OSS mode - use W3C mode instead by using
+    Selenium::WebDriver::Chrome::Options.new(options: {w3c: true})
+
+PhantomJS:
+  * Removed support for PhantomJS driver
+
+Firefox:
+  * Removed support for legacy Firefox driver - use GeckoDriver instead
+  * Removed deprecated outdated capabilities
+  * Fixed an issue when passing :profile string to Firefox::Options.new would
+    result in NoMethodError. Now it will find a profile with such name on your
+    system and use it accordingly (issue #7119)
+
 3.142.7 (2019-12-27)
 ====================
 
@@ -30,7 +389,6 @@ Firefox:
   * Fixed a regression when Firefox binary path was not sent to GeckoDriver
     by default and browser could not be located (issue #7219)
 
-
 3.142.2 (2019-05-11)
 ====================
 
@@ -581,11 +939,11 @@ Ruby:
   * Fix bug in auto detection of drivers which allowed selection of non-executable binaries
 
 W3C:
-  * Implement #cookie_named and #delete_all_cookies methods (thanks lmtierney)

-  * Implement element #property method (thanks lmtierney)

+  * Implement #cookie_named and #delete_all_cookies methods (thanks lmtierney)

+  * Implement element #property method (thanks lmtierney)

 
 Chrome:
-  * Fix bug in switches (thanks danvine)

+  * Fix bug in switches (thanks danvine)

 
 3.0.1 (2016-11-06)
 ===================
@@ -607,7 +965,7 @@ Ruby:
   * Add support for latest driver options
   * Add support for :port parameter for launching driver
   * Add support for :service_args parameter for driver command line switches
-  * Improve reliability by increasing service shutdown timeout (#2815; thanks John Barbuto )

+  * Improve reliability by increasing service shutdown timeout (#2815; thanks John Barbuto )

 
 Firefox:
   * Add support for :firefox_options in geckodriver

data/Gemfile

@@ -1,4 +1,6 @@
 # frozen_string_literal: true
 
 source 'https://rubygems.org'
-gemspec
+Dir["#{__dir__}/*.gemspec"].each do |spec|
+  gemspec name: File.basename(spec, '.gemspec')
+end

data/LICENSE

@@ -187,7 +187,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2019 Software Freedom Conservancy (SFC)
+   Copyright 2021 Software Freedom Conservancy (SFC)
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

data/NOTICE

@@ -0,0 +1,2 @@
+Copyright 2011-2021 Software Freedom Conservancy
+Copyright 2004-2011 Selenium committers

data/README.md

@@ -1,7 +1,6 @@
 # selenium-webdriver
 
-This gem provides Ruby bindings for WebDriver
-and has been tested to work on MRI (2.0 through 2.2),
+This gem provides Ruby bindings for Selenium and supports MRI >= 2.6
 
 ## Install
 
@@ -9,14 +8,14 @@ and has been tested to work on MRI (2.0 through 2.2),
 
 ## Links
 
-* http://rubygems.org/gems/selenium-webdriver
-* http://seleniumhq.github.io/selenium/docs/api/rb/index.html
+* https://rubygems.org/gems/selenium-webdriver
+* https://www.selenium.dev/selenium/docs/api/rb/index.html
 * https://github.com/SeleniumHQ/selenium/wiki/Ruby-Bindings
 * https://github.com/SeleniumHQ/selenium/issues
 
 ## License
 
-Copyright 2009-2018 Software Freedom Conservancy
+Copyright 2009-2021 Software Freedom Conservancy
 
 Licensed to the Software Freedom Conservancy (SFC) under one
 or more contributor license agreements.  See the NOTICE file

data/lib/selenium/server.rb

@@ -57,47 +57,41 @@ module Selenium
 
     CL_RESET = WebDriver::Platform.windows? ? '' : "\r\e[0K"
 
-    def self.get(required_version, opts = {})
-      new(download(required_version), opts)
-    end
+    class << self
+      #
+      # Download the given version of the selenium-server jar and return instance
+      #
+      # @param [String, Symbol] required_version X.Y.Z defaults to ':latest'
+      # @param [Hash] opts
+      # @return [Selenium::Server]
+      #
 
-    #
-    # Download the given version of the selenium-server-standalone jar.
-    #
+      def get(required_version = :latest, opts = {})
+        new(download(required_version), opts)
+      end
 
-    class << self
-      def download(required_version)
+      #
+      # Download the given version of the selenium-server jar and return location
+      #
+      # @param [String, Symbol] required_version X.Y.Z defaults to ':latest'
+      # @return [String] location of downloaded file
+      #
+
+      def download(required_version = :latest)
         required_version = latest if required_version == :latest
-        download_file_name = "selenium-server-standalone-#{required_version}.jar"
+        download_file_name = "selenium-server-#{required_version}.jar"
 
         return download_file_name if File.exist? download_file_name
 
         begin
-          File.open(download_file_name, 'wb') do |destination|
-            net_http.start('selenium-release.storage.googleapis.com') do |http|
-              resp = http.request_get("/#{required_version[/(\d+\.\d+)\./, 1]}/#{download_file_name}") do |response|
-                total = response.content_length
-                progress = 0
-                segment_count = 0
-
-                response.read_body do |segment|
-                  progress += segment.length
-                  segment_count += 1
+          server = 'https://github.com/seleniumhq/selenium/releases/download'
+          released = Net::HTTP.get_response(URI.parse("#{server}/selenium-#{required_version}/#{download_file_name}"))
+          redirected = URI.parse released.header['location']
 
-                  if (segment_count % 15).zero?
-                    percent = (progress.to_f / total.to_f) * 100
-                    print "#{CL_RESET}Downloading #{download_file_name}: #{percent.to_i}% (#{progress} / #{total})"
-                    segment_count = 0
-                  end
-
-                  destination.write(segment)
-                end
-              end
-
-              raise Error, "#{resp.code} for #{download_file_name}" unless resp.is_a? Net::HTTPSuccess
-            end
+          File.open(download_file_name, 'wb') do |destination|
+            download_server(redirected, destination)
           end
-        rescue
+        rescue StandardError
           FileUtils.rm download_file_name if File.exist? download_file_name
           raise
         end
@@ -106,57 +100,67 @@ module Selenium
       end
 
       #
-      # Ask Google Code what the latest selenium-server-standalone version is.
+      # Ask GitHub what the latest selenium-server version is.
       #
 
       def latest
-        require 'rexml/document'
-        net_http.start('selenium-release.storage.googleapis.com') do |http|
-          versions = REXML::Document.new(http.get('/').body).root.get_elements('//Contents/Key').map do |e|
-            e.text[/selenium-server-standalone-(\d+\.\d+\.\d+)\.jar/, 1]
+        @latest ||= begin
+          net_http_start('api.github.com') do |http|
+            json = http.get('/repos/seleniumhq/selenium/releases').body
+            all_assets = JSON.parse(json).map { |release| release['assets'] }.flatten
+            server_assets = all_assets.map { |asset| asset['name'][/selenium-server-(\d+\.\d+\.\d+)\.jar/, 1] }.compact
+            server_assets.map { |version| Gem::Version.new(version) }.max.version
           end
-
-          versions.compact.map { |version| Gem::Version.new(version) }.max.version
         end
       end
 
-      def net_http
-        http_proxy = ENV['http_proxy'] || ENV['HTTP_PROXY']
+      # @api private
 
+      def net_http_start(address, &block)
+        http_proxy = ENV['http_proxy'] || ENV['HTTP_PROXY']
         if http_proxy
           http_proxy = "http://#{http_proxy}" unless http_proxy.start_with?('http://')
           uri = URI.parse(http_proxy)
 
-          Net::HTTP::Proxy(uri.host, uri.port)
+          Net::HTTP.start(address, nil, uri.host, uri.port, &block)
         else
-          Net::HTTP
+          Net::HTTP.start(address, use_ssl: true, &block)
         end
       end
-    end
-
-    #
-    # The server port
-    #
-
-    attr_accessor :port
-
-    #
-    # The server timeout
-    #
 
-    attr_accessor :timeout
+      def download_server(uri, destination)
+        net_http_start('github-releases.githubusercontent.com') do |http|
+          request = Net::HTTP::Get.new uri
+          resp = http.request(request) do |response|
+            total = response.content_length
+            progress = 0
+            segment_count = 0
+
+            response.read_body do |segment|
+              progress += segment.length
+              segment_count += 1
+
+              if (segment_count % 15).zero?
+                percent = progress.fdiv(total) * 100
+                print "#{CL_RESET}Downloading #{destination.path}: #{percent.to_i}% (#{progress} / #{total})"
+                segment_count = 0
+              end
 
-    #
-    # Whether to launch the server in the background
-    #
+              destination.write(segment)
+            end
+          end
 
-    attr_accessor :background
+          raise Error, "#{resp.code} for #{destination.path}" unless resp.is_a? Net::HTTPSuccess
+        end
+      end
+    end
 
     #
-    # Path to log file, or 'true' for stdout.
+    # The Mode of the Server
+    # :standalone, #hub, #node
     #
 
-    attr_accessor :log
+    attr_accessor :role, :port, :timeout, :background, :log
 
     #
     # @param [String] jar Path to the server jar.
@@ -175,11 +179,12 @@ module Selenium
 
       @jar        = jar
       @host       = '127.0.0.1'
+      @role       = opts.fetch(:role, 'standalone')
       @port       = opts.fetch(:port, 4444)
       @timeout    = opts.fetch(:timeout, 30)
       @background = opts.fetch(:background, false)
       @log        = opts[:log]
-
+      @log_file   = nil
       @additional_args = []
     end
 
@@ -234,7 +239,8 @@ module Selenium
       @process ||= begin
         # extract any additional_args that start with -D as options
         properties = @additional_args.dup - @additional_args.delete_if { |arg| arg[/^-D/] }
-        server_command = ['java'] + properties + ['-jar', @jar, '-port', @port.to_s] + @additional_args
+        args = ['-jar', @jar, @role, '--port', @port.to_s]
+        server_command = ['java'] + properties + args + @additional_args
         cp = ChildProcess.build(*server_command)
         WebDriver.logger.debug("Executing Process #{server_command}")