selenium-webdriver 4.14.0 → 4.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc5fa0275bc4e0f7675b6579bb652cb2efc20bc47797407a3c1da5cd3ac61959
-  data.tar.gz: 35d845b2fab6603c02c7c6d56f8b2e2e21aa956ed1fcbe01adc0ec0e1b4627d6
+  metadata.gz: 2005eb5039203a271b3d3bc3bacbe8e184e7bed9d145eaf3a87295456cf1a8e8
+  data.tar.gz: b94d892de1f0c8b6e19d9ff4831cd075b0d56d765b754d3797b8d2f15468343f
 SHA512:
-  metadata.gz: 61ce01ca9e41da013f55b0a970f3c4fe68e496132fd3f70c7a4770e1874dfdbc3a0102e530cbc01e9e4cfc4dd02614eee6120366471e2e07da9cb0d097222e78
-  data.tar.gz: 00ebdefe7adc44e8d535a6ab2099ea6233d6a2d9d5c2960a93ac001c34657a7860857e3387c3c93053f034bcccda4dc8120325c105c16bd0ba7151acb8e1211e
+  metadata.gz: d5bb85e63490bbb9f1ecd49bf5fb5a2ebf21b79b5fb4bb41162c43c62d6e73da4142e7b8c13b449ae8909958e9169049d4770b2d3e206337a1645e0a5b002c92
+  data.tar.gz: 136cd21751e98c3bd737a8f1e954671124a339674221151cd00f992d1067349d42a92dc1d64dc32e0e157a9f52227215be8c76cb1eca9133a46774fc30101426

data/CHANGES

@@ -1,4 +1,13 @@
-4.14.0 (Unreleased)
+4.15.0 (unreleased)
+=========================
+
+* Do not set browser binary in selenium manager if it is an empty string (#12738)
+* Add flaky condition to guards to mark unreliable tests
+* Rake update needs to build latest grid for running remote tests
+* Add CDP v119 and remove v116
+* Implement file downloads (#12979)
+
+4.14.0 (2023-10-09)
 =========================
 Ruby:
   * allow users to access the full script of the atom directly

data/lib/selenium/webdriver/chrome/features.rb

@@ -35,8 +35,12 @@ module Selenium
           send_command: [:post, 'session/:session_id/goog/cdp/execute']
         }.freeze
 
+        def command_list
+          CHROME_COMMANDS.merge(CHROMIUM_COMMANDS).merge(self.class::COMMANDS)
+        end
+
         def commands(command)
-          CHROME_COMMANDS[command] || CHROMIUM_COMMANDS[command] || self.class::COMMANDS[command]
+          command_list[command]
         end
       end # Bridge
     end # Chrome

data/lib/selenium/webdriver/chromium/features.rb

@@ -31,10 +31,6 @@ module Selenium
           get_log: [:post, 'session/:session_id/se/log']
         }.freeze
 
-        def commands(command)
-          CHROME_COMMANDS[command] || self.class::COMMANDS[command]
-        end
-
         def launch_app(id)
           execute :launch_app, {}, {id: id}
         end

data/lib/selenium/webdriver/common/driver_extensions/has_file_downloads.rb

@@ -0,0 +1,65 @@
+# 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 DriverExtensions
+      module HasFileDownloads
+        def downloadable_files
+          verify_enabled
+
+          @bridge.downloadable_files['names']
+        end
+
+        def download_file(file_name, target_directory)
+          verify_enabled
+
+          response = @bridge.download_file(file_name)
+          contents = response['contents']
+
+          File.open("#{file_name}.zip", 'wb') { |f| f << Base64.decode64(contents) }
+          target_directory += '/' unless target_directory.end_with?('/')
+          FileUtils.mkdir_p(target_directory)
+
+          begin
+            Zip::File.open("#{file_name}.zip") do |zip|
+              zip.each { |entry| zip.extract(entry, "#{target_directory}#{file_name}") }
+            end
+          ensure
+            FileUtils.rm_f("#{file_name}.zip")
+          end
+        end
+
+        def delete_downloadable_files
+          verify_enabled
+
+          @bridge.delete_downloadable_files
+        end
+
+        private
+
+        def verify_enabled
+          return if capabilities['se:downloadsEnabled']
+
+          raise Error::WebDriverError, 'You must enable downloads in order to work with downloadable files.'
+        end
+      end # HasFileDownloads
+    end # DriverExtensions
+  end # WebDriver
+end # Selenium

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

@@ -24,6 +24,8 @@ module Selenium
                        set_window_rect timeouts unhandled_prompt_behavior strict_file_interactability
                        web_socket_url].freeze
 
+      GRID_OPTIONS = %i[enable_downloads].freeze
+
       class << self
         attr_reader :driver_path
 
@@ -104,6 +106,8 @@ module Selenium
       def as_json(*)
         options = @options.dup
 
+        downloads = options.delete(:enable_downloads)
+        options['se:downloadsEnabled'] = downloads unless downloads.nil?
         w3c_options = process_w3c_options(options)
 
         browser_options = self.class::CAPABILITIES.each_with_object({}) do |(capability_alias, capability_name), hash|

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

@@ -45,7 +45,7 @@ module Selenium
           driver_path = output['driver_path']
           Platform.assert_executable driver_path
 
-          if options.respond_to? :binary
+          if options.respond_to?(:binary) && browser_path && !browser_path.empty?
             options.binary = browser_path
             options.browser_version = nil
           end

data/lib/selenium/webdriver/common.rb

@@ -81,6 +81,7 @@ require 'selenium/webdriver/common/driver_extensions/full_page_screenshot'
 require 'selenium/webdriver/common/driver_extensions/has_addons'
 require 'selenium/webdriver/common/driver_extensions/has_bidi'
 require 'selenium/webdriver/common/driver_extensions/has_devtools'
+require 'selenium/webdriver/common/driver_extensions/has_file_downloads'
 require 'selenium/webdriver/common/driver_extensions/has_authentication'
 require 'selenium/webdriver/common/driver_extensions/has_logs'
 require 'selenium/webdriver/common/driver_extensions/has_log_events'

data/lib/selenium/webdriver/edge/features.rb

@@ -35,8 +35,12 @@ module Selenium
           send_command: [:post, 'session/:session_id/ms/cdp/execute']
         }.freeze
 
+        def command_list
+          EDGE_COMMANDS.merge(CHROMIUM_COMMANDS).merge(self.class::COMMANDS)
+        end
+
         def commands(command)
-          EDGE_COMMANDS[command] || CHROMIUM_COMMANDS[command] || self.class::COMMANDS[command]
+          command_list[command]
         end
       end # Bridge
     end # Edge

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

@@ -29,8 +29,12 @@ module Selenium
           full_page_screenshot: [:get, 'session/:session_id/moz/screenshot/full']
         }.freeze
 
+        def command_list
+          FIREFOX_COMMANDS.merge(self.class::COMMANDS)
+        end
+
         def commands(command)
-          FIREFOX_COMMANDS[command] || self.class::COMMANDS[command]
+          command_list[command]
         end
 
         def install_addon(path, temporary)

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

@@ -0,0 +1,34 @@
+# 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
+      module Features
+        def command_list
+          self.class::COMMANDS
+        end
+
+        def commands(command)
+          command_list[command]
+        end
+      end # Bridge
+    end # Ie
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/ie.rb

@@ -20,9 +20,10 @@
 module Selenium
   module WebDriver
     module IE
-      autoload :Driver, 'selenium/webdriver/ie/driver'
-      autoload :Options, 'selenium/webdriver/ie/options'
-      autoload :Service, 'selenium/webdriver/ie/service'
+      autoload :Features, 'selenium/webdriver/ie/features'
+      autoload :Driver,   'selenium/webdriver/ie/driver'
+      autoload :Options,  'selenium/webdriver/ie/options'
+      autoload :Service,  'selenium/webdriver/ie/service'
     end # IE
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver/remote/bridge/commands.rb

@@ -144,12 +144,6 @@ module Selenium
           take_screenshot: [:get, 'session/:session_id/screenshot'],
           take_element_screenshot: [:get, 'session/:session_id/element/:id/screenshot'],
 
-          #
-          # server extensions
-          #
-
-          upload_file: [:post, 'session/:session_id/se/file'],
-
           #
           # virtual-authenticator
           #

data/lib/selenium/webdriver/remote/bridge.rb

@@ -391,30 +391,11 @@ module Selenium
         end
 
         def send_keys_to_element(element, keys)
-          # TODO: rework file detectors before Selenium 4.0
-          if @file_detector
-            local_files = keys.first&.split("\n")&.map { |key| @file_detector.call(Array(key)) }&.compact
-            if local_files&.any?
-              keys = local_files.map { |local_file| upload(local_file) }
-              keys = Array(keys.join("\n"))
-            end
-          end
-
-          # Keep .split(//) for backward compatibility for now
+          keys = upload_if_necessary(keys) if @file_detector
           text = keys.join
           execute :element_send_keys, {id: element}, {value: text.chars, text: text}
         end
 
-        def upload(local_file)
-          unless File.file?(local_file)
-            WebDriver.logger.debug("File detector only works with files. #{local_file.inspect} isn`t a file!",
-                                   id: :file_detector)
-            raise Error::WebDriverError, "You are trying to work with something that isn't a file."
-          end
-
-          execute :upload_file, {}, {file: Zipper.zip_file(local_file)}
-        end
-
         def clear_element(element)
           execute :element_clear, id: element
         end

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

@@ -28,6 +28,7 @@ module Selenium
       class Driver < WebDriver::Driver
         include DriverExtensions::UploadsFiles
         include DriverExtensions::HasSessionId
+        include DriverExtensions::HasFileDownloads
 
         def initialize(capabilities: nil, options: nil, service: nil, url: nil, **opts)
           raise ArgumentError, "Can not set :service object on #{self.class}" if service
@@ -36,6 +37,9 @@ module Selenium
           caps = process_options(options, capabilities)
           super(caps: caps, url: url, **opts)
           @bridge.file_detector = ->((filename, *)) { File.exist?(filename) && filename.to_s }
+          command_list = @bridge.command_list
+          @bridge.extend(WebDriver::Remote::Features)
+          @bridge.add_commands(command_list)
         end
 
         private

data/lib/selenium/webdriver/remote/features.rb

@@ -0,0 +1,75 @@
+# 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 Remote
+      module Features
+        REMOTE_COMMANDS = {
+          upload_file: [:post, 'session/:session_id/se/file'],
+          get_downloadable_files: [:get, 'session/:session_id/se/files'],
+          download_file: [:post, 'session/:session_id/se/files'],
+          delete_downloadable_files: [:delete, 'session/:session_id/se/files']
+        }.freeze
+
+        def add_commands(commands)
+          @command_list = command_list.merge(commands)
+        end
+
+        def command_list
+          @command_list ||= REMOTE_COMMANDS
+        end
+
+        def commands(command)
+          command_list[command]
+        end
+
+        def upload(local_file)
+          unless File.file?(local_file)
+            WebDriver.logger.error("File detector only works with files. #{local_file.inspect} isn`t a file!",
+                                   id: :file_detector)
+            raise Error::WebDriverError, "You are trying to upload something that isn't a file."
+          end
+
+          execute :upload_file, {}, {file: Zipper.zip_file(local_file)}
+        end
+
+        def upload_if_necessary(keys)
+          local_files = keys.first&.split("\n")&.map { |key| @file_detector.call(Array(key)) }&.compact
+          return keys unless local_files&.any?
+
+          keys = local_files.map { |local_file| upload(local_file) }
+          Array(keys.join("\n"))
+        end
+
+        def downloadable_files
+          execute :get_downloadable_files
+        end
+
+        def download_file(name)
+          execute :download_file, {}, {name: name}
+        end
+
+        def delete_downloadable_files
+          execute :delete_downloadable_files
+        end
+      end
+    end # Remote
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/remote.rb

@@ -23,6 +23,7 @@ require 'selenium/webdriver/remote/server_error'
 module Selenium
   module WebDriver
     module Remote
+      autoload :Features,     'selenium/webdriver/remote/features'
       autoload :Bridge,       'selenium/webdriver/remote/bridge'
       autoload :Driver,       'selenium/webdriver/remote/driver'
       autoload :Response,     'selenium/webdriver/remote/response'

data/lib/selenium/webdriver/safari/features.rb

@@ -28,8 +28,12 @@ module Selenium
           attach_debugger: [:post, 'session/:session_id/apple/attach_debugger']
         }.freeze
 
+        def command_list
+          SAFARI_COMMANDS.merge(self.class::COMMANDS)
+        end
+
         def commands(command)
-          SAFARI_COMMANDS[command] || self.class::COMMANDS[command]
+          command_list[command]
         end
 
         def permissions

data/lib/selenium/webdriver/support/guards/guard.rb

@@ -53,7 +53,9 @@ module Selenium
 
             case @type
             when :exclude
-              "Test not guarded because it breaks test run; #{details}"
+              "Test skipped because it breaks test run; #{details}"
+            when :flaky
+              "Test skipped because it is unreliable in this configuration; #{details}"
             when :exclusive
               "Test does not apply to this configuration; #{details}"
             else
@@ -71,9 +73,10 @@ module Selenium
             @type == :only
           end
 
-          # Bug is present on all configurations specified, but test can not be run because it breaks other tests
+          # Bug is present on all configurations specified, but test can not be run because it breaks other tests,
+          # or it is flaky and unreliable
           def exclude?
-            @type == :exclude
+            @type == :exclude || @type == :flaky
           end
 
           # Test only applies to configurations specified

data/lib/selenium/webdriver/support/guards.rb

@@ -24,7 +24,7 @@ module Selenium
   module WebDriver
     module Support
       class Guards
-        GUARD_TYPES = %i[except only exclude exclusive].freeze
+        GUARD_TYPES = %i[except only exclude exclusive flaky].freeze
 
         attr_reader :messages
         attr_accessor :bug_tracker

data/lib/selenium/webdriver/version.rb

@@ -19,6 +19,6 @@
 
 module Selenium
   module WebDriver
-    VERSION = '4.14.0'
+    VERSION = '4.15.0'
   end # WebDriver
 end # Selenium

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: selenium-webdriver
 version: !ruby/object:Gem::Version
-  version: 4.14.0
+  version: 4.15.0
 platform: ruby
 authors:
 - Alex Rodionov
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-10 00:00:00.000000000 Z
+date: 2023-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rexml
@@ -258,6 +258,7 @@ files:
 - lib/selenium/webdriver/common/driver_extensions/has_context.rb
 - lib/selenium/webdriver/common/driver_extensions/has_debugger.rb
 - lib/selenium/webdriver/common/driver_extensions/has_devtools.rb
+- lib/selenium/webdriver/common/driver_extensions/has_file_downloads.rb
 - lib/selenium/webdriver/common/driver_extensions/has_launching.rb
 - lib/selenium/webdriver/common/driver_extensions/has_log_events.rb
 - lib/selenium/webdriver/common/driver_extensions/has_logs.rb
@@ -348,6 +349,7 @@ files:
 - lib/selenium/webdriver/firefox/util.rb
 - lib/selenium/webdriver/ie.rb
 - lib/selenium/webdriver/ie/driver.rb
+- lib/selenium/webdriver/ie/features.rb
 - lib/selenium/webdriver/ie/options.rb
 - lib/selenium/webdriver/ie/service.rb
 - lib/selenium/webdriver/remote.rb
@@ -355,6 +357,7 @@ files:
 - lib/selenium/webdriver/remote/bridge/commands.rb
 - lib/selenium/webdriver/remote/capabilities.rb
 - lib/selenium/webdriver/remote/driver.rb
+- lib/selenium/webdriver/remote/features.rb
 - lib/selenium/webdriver/remote/http/common.rb
 - lib/selenium/webdriver/remote/http/curb.rb
 - lib/selenium/webdriver/remote/http/default.rb