webdrivers 5.1.0 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 366e7e4f90b5bd54a2f5f1cbe2df6074f6cad56026502ec6d9f0ceddd4a269c8
-  data.tar.gz: '09439fb8a5f6e550ab6562891e1b11daa43f13694e21740e8e7141916b02641d'
+  metadata.gz: ea3a67076ea1a3e77e954a92642eed78d0bbcc041dfa0715ff08f911b20e2577
+  data.tar.gz: 0bc4ae97ff8d252e5201b79aa24f58d29e1e965948bc4f63bd1923cf84d0accd
 SHA512:
-  metadata.gz: d7b1a0e9791e985716d7e887c23e7346752218c108ac1bc11c1833c087ecfbf43f5eab718968ab6ddbce1b313740af6d8758a9568cb058edcbe06ae08583a44d
-  data.tar.gz: 98fe42f01271e270387795e0dd30ec943d5c0937d413f8ddedf96946ac00b7686a9cf2aee4ce78e52510ff08e2dffb963dd6a282c9abb6267d003a2704f9cfe1
+  metadata.gz: c6c95c4b5cc8f198f1df0715574bcf76018e976a311c51e498ef9e3b56277e1a9e45b6255ce721a22e415d546fdef1dcd2b02e864553bdbb1290a06ff3ad8264
+  data.tar.gz: d3a8876c9ee4cbe31552946e870775a9fd0aa833db5c9a8843a56ecfd85bbc92d285b9f4237de365fb8bcb1fe837afee6633c9937010442e5c6e47759899645b

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 5.3.0 (2023-07-31)
+* Add support for Chrome for Testing drivers ([#237](https://github.com/titusfortner/webdrivers/issues/249), thanks sadahiro-ono)
+* Support is restricted to Selenium 4.0 - 4.10 to encourage people to update to Selenium 4.11
+
+# 5.2.0 (2022-09-29)
+* `chromedriver` - Fix downloading on M1 macs from version 106.0.5249.61 ([#237](https://github.com/titusfortner/webdrivers/issues/237), thanks jmccure)
+
 # 5.1.0 (2022-09-19)
 * Improve error messages (#232, thanks dan-jensen)
 * Fix circular require bug with railtie (#233, thanks amatsuda)

data/LICENSE.txt

@@ -1,7 +1,7 @@
 (The MIT License)
 
-Copyright (c) 2017-2019: Titus Fortner
-Copyright (c) 2019: Lakshya Kapoor, Thomas Walpole
+Copyright (c) 2017-2023: Titus Fortner
+Copyright (c) 2019-2023: Lakshya Kapoor, Thomas Walpole
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -5,6 +5,30 @@
 
 Run Selenium tests more easily with automatic installation and updates for all supported webdrivers.
 
+## Update: Future of this Project
+
+With Google's new [Chrome for Testing](https://developer.chrome.com/blog/chrome-for-testing/) project, 
+and Selenium's new [Selenium Manager](https://www.selenium.dev/documentation/selenium_manager/) feature, 
+what is required of this gem has changed.
+
+If you can update to to the latest version of Selenium (4.11+), please do so and stop requiring this gem.
+Provide feedback or raise issues to [Selenium Project](https://github.com/SeleniumHQ/selenium/issues/new/choose)
+
+If you cannot upgrade to Selenium 4.11, Webdrivers 5.3.0 will continue to support Ruby 2.6+ and Selenium 4.0 - 4.10
+
+If you are using an older version of webdrivers gem, and cannot upgrade, you can set
+the required version of chromedriver to v114 (`Webdrivers.required_version = '114.0.5735.90'`) and 
+[Disable the build check](https://www.selenium.dev/documentation/webdriver/browsers/chrome/#disabling-build-check). 
+This is not guaranteed to continue working and will not receive bug fixes.
+
+**Webdrivers 6.0**
+To provide support for Selenium 3 and Ruby < 2.6 a 6.0 version is planned. It requires:
+* Creating a `selenium-manager.gem` based off of https://github.com/SeleniumHQ/selenium/pull/12429
+* Re-implementing this gem to wrap `selenium-manager.gem`
+* Ensuring compatible with older versions of Selenium & Ruby
+
+If anyone would like to help get Webdrivers 6 working, please let us know.
+
 ## Description
 
 `webdrivers` downloads drivers and directs Selenium to use them. Currently supports:

data/lib/webdrivers/chromedriver.rb

@@ -63,7 +63,11 @@ module Webdrivers
       private
 
       def latest_point_release(version)
-        normalize_version(Network.get(URI.join(base_url, "LATEST_RELEASE_#{version}")))
+        if version < normalize_version('115')
+          return normalize_version(Network.get(URI.join(base_url, "LATEST_RELEASE_#{version}")))
+        end
+
+        latest_patch_version(version)
       rescue NetworkError
         msg = "Unable to find latest point release version for #{version}."
         msg = begin
@@ -78,7 +82,7 @@ module Webdrivers
         end
 
         msg = "#{msg} Please set `Webdrivers::Chromedriver.required_version = <desired driver version>` "\
-              'to a known chromedriver version: https://chromedriver.storage.googleapis.com/index.html'
+                'to a known chromedriver version: https://chromedriver.chromium.org/downloads/version-selection'
         Webdrivers.logger.debug msg
         raise VersionError, msg
       end
@@ -97,8 +101,23 @@ module Webdrivers
         false
       end
 
+      def apple_filename(driver_version)
+        unless apple_m1_compatible?(driver_version)
+          return driver_version >= normalize_version('115') ? 'mac-x64' : 'mac64'
+        end
+
+        if driver_version < normalize_version('106.0.5249.61')
+          'mac64_m1'
+        elsif driver_version < normalize_version('115')
+          'mac_arm64'
+        else
+          'mac-arm64'
+        end
+      end
+
       def direct_url(driver_version)
-        "#{base_url}/#{driver_version}/chromedriver_#{driver_filename(driver_version)}.zip"
+        direct_url_from_api(driver_version) ||
+          "#{base_url}/#{driver_version}/chromedriver_#{driver_filename(driver_version)}.zip"
       end
 
       def driver_filename(driver_version)
@@ -107,8 +126,7 @@ module Webdrivers
         elsif System.platform == 'linux'
           'linux64'
         elsif System.platform == 'mac'
-          apple_arch = apple_m1_compatible?(driver_version) ? '_m1' : ''
-          "mac64#{apple_arch}"
+          apple_filename(driver_version)
         else
           raise 'Failed to determine driver filename to download for your OS.'
         end
@@ -134,6 +152,7 @@ module Webdrivers
       def browser_build_version
         normalize_version(browser_version.segments[0..2].join('.'))
       end
+
       alias chrome_build_version browser_build_version
 
       # Returns true if an executable driver binary exists
@@ -142,6 +161,33 @@ module Webdrivers
         super && current_version && (current_version < normalize_version('70.0.3538') ||
           current_build_version == browser_build_version)
       end
+
+      def chrome_for_testing_base_url
+        'https://googlechromelabs.github.io/chrome-for-testing/'
+      end
+
+      def latest_patch_version(driver_version)
+        latest_patch_version = URI.join(chrome_for_testing_base_url, 'latest-patch-versions-per-build.json')
+                                  .then { |url| Network.get(url) }
+                                  .then { |res| JSON.parse(res, symbolize_names: true) }
+                                  .then { |json| json.dig(:builds, :"#{driver_version}", :version) }
+                                  .then { |version| version ? normalize_version(version) : nil }
+        raise NetworkError unless latest_patch_version
+
+        latest_patch_version
+      end
+
+      def direct_url_from_api(driver_version)
+        return if normalize_version(driver_version) < normalize_version('115')
+
+        URI.join(chrome_for_testing_base_url, 'known-good-versions-with-downloads.json')
+           .then { |url| Network.get(url) }
+           .then { |res| JSON.parse(res, symbolize_names: true) }
+           .then { |json| json[:versions].find { |e| e[:version] == driver_version.to_s } }
+           .then { |json| json.dig(:downloads, :chromedriver) }
+           .then { |json| json.find { |e| e[:platform] == driver_filename(driver_version) } }
+           .then { |json| json&.dig(:url) }
+      end
     end
   end
 end

data/lib/webdrivers/system.rb

@@ -127,8 +127,7 @@ module Webdrivers
         Webdrivers.logger.debug "Decompressing #{filename}"
 
         Zip::File.open(filename) do |zip_file|
-          driver = zip_file.get_entry(driver_name)
-          f_path = File.join(Dir.pwd, driver.name)
+          driver, f_path = driver_and_path(zip_file, driver_name)
           delete(f_path)
           FileUtils.mkdir_p(File.dirname(f_path)) unless File.exist?(File.dirname(f_path))
           zip_file.extract(driver, f_path)
@@ -136,6 +135,18 @@ module Webdrivers
         driver_name
       end
 
+      def driver_and_path(zip_file, driver_name)
+        driver = zip_file.get_entry(driver_name)
+        f_path = File.join(Dir.pwd, driver.name)
+
+        [driver, f_path]
+      rescue Errno::ENOENT
+        driver = zip_file.entries.find { |e| File.basename(e.name) == driver_name }
+        f_path = File.join(Dir.pwd, File.basename(driver.name))
+
+        [driver, f_path]
+      end
+
       def platform
         if Selenium::WebDriver::Platform.linux?
           'linux'

data/lib/webdrivers/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Webdrivers
-  VERSION = '5.1.0'
+  VERSION = '5.3.0'
 end

data/spec/webdrivers/chromedriver_spec.rb

@@ -65,8 +65,9 @@ describe Webdrivers::Chromedriver do
       it 'raises ConnectionError when offline, and no binary exists' do
         allow(Net::HTTP).to receive(:get_response).and_raise(SocketError)
         allow(chromedriver).to receive(:exists?).and_return(false)
+        allow(Webdrivers::ChromeFinder).to receive(:version).and_return('115.0.5790.114')
 
-        msg = %r{Can not reach https://chromedriver.storage.googleapis.com}
+        msg = %r{Can not reach https://googlechromelabs.github.io/chrome-for-testing}
         expect { chromedriver.update }.to raise_error(Webdrivers::ConnectionError, msg)
       end
     end
@@ -100,8 +101,9 @@ describe Webdrivers::Chromedriver do
 
       it 'raises ConnectionError if offline' do
         allow(Net::HTTP).to receive(:get_response).and_raise(SocketError)
+        chromedriver.required_version = '115.0.5790.102'
 
-        msg = %r{Can not reach https://chromedriver.storage.googleapis.com/}
+        msg = %r{Can not reach https://googlechromelabs.github.io/chrome-for-testing}
         expect { chromedriver.update }.to raise_error(Webdrivers::ConnectionError, msg)
       end
     end
@@ -135,6 +137,62 @@ describe Webdrivers::Chromedriver do
         expect(chromedriver.current_version.version).to eq('72.0.3626.7')
       end
     end
+
+    context 'when using an Apple machine' do
+      before do
+        allow(Webdrivers::System).to receive(:platform).and_return('mac')
+        allow(Webdrivers::System).to receive(:download)
+      end
+
+      context 'with Intel architecture' do
+        it 'v114 uses correct suffix' do
+          allow(Webdrivers::System).to receive(:apple_m1_architecture?).and_return(false)
+          allow(chromedriver).to receive(:latest_version).and_return(Gem::Version.new('114.0.5735.90'))
+          chromedriver.required_version = nil
+
+          chromedriver.update
+          expect(Webdrivers::System).to have_received(:download).with(end_with('_mac64.zip'), anything)
+        end
+
+        it 'v115 uses correct suffix' do
+          allow(Webdrivers::System).to receive(:apple_m1_architecture?).and_return(false)
+          allow(chromedriver).to receive(:latest_version).and_return(Gem::Version.new('115.0.5790.102'))
+          chromedriver.required_version = nil
+
+          chromedriver.update
+          expect(Webdrivers::System).to have_received(:download).with(end_with('-mac-x64.zip'), anything)
+        end
+      end
+
+      context 'with Apple architecture' do
+        it 'v106.0.5249.61 uses correct suffix' do
+          allow(Webdrivers::System).to receive(:apple_m1_architecture?).and_return(true)
+          allow(chromedriver).to receive(:latest_version).and_return(Gem::Version.new('106.0.5249.61'))
+          chromedriver.required_version = nil
+
+          chromedriver.update
+          expect(Webdrivers::System).to have_received(:download).with(end_with('_arm64.zip'), anything)
+        end
+
+        it 'less than v106.0.5249.61 uses correct suffix' do
+          allow(Webdrivers::System).to receive(:apple_m1_architecture?).and_return(true)
+          allow(chromedriver).to receive(:latest_version).and_return(Gem::Version.new('106.0.5249.21'))
+          chromedriver.required_version = nil
+
+          chromedriver.update
+          expect(Webdrivers::System).to have_received(:download).with(end_with('_mac64_m1.zip'), anything)
+        end
+
+        it 'v115 uses correct suffix' do
+          allow(Webdrivers::System).to receive(:apple_m1_architecture?).and_return(true)
+          allow(chromedriver).to receive(:latest_version).and_return(Gem::Version.new('115.0.5790.102'))
+          chromedriver.required_version = nil
+
+          chromedriver.update
+          expect(Webdrivers::System).to have_received(:download).with(end_with('-mac-arm64.zip'), anything)
+        end
+      end
+    end
   end
 
   describe '#current_version' do
@@ -172,7 +230,7 @@ describe Webdrivers::Chromedriver do
       msg = 'Unable to find latest point release version for 999.0.0. '\
 'You appear to be using a non-production version of Chrome. '\
 'Please set `Webdrivers::Chromedriver.required_version = <desired driver version>` '\
-'to a known chromedriver version: https://chromedriver.storage.googleapis.com/index.html'
+'to a known chromedriver version: https://chromedriver.chromium.org/downloads/version-selection'
 
       expect { chromedriver.latest_version }.to raise_exception(Webdrivers::VersionError, msg)
     end
@@ -181,19 +239,21 @@ describe Webdrivers::Chromedriver do
       allow(chromedriver).to receive(:browser_version).and_return Gem::Version.new('72.0.9999.0000')
       msg = 'Unable to find latest point release version for 72.0.9999. '\
 'Please set `Webdrivers::Chromedriver.required_version = <desired driver version>` '\
-'to a known chromedriver version: https://chromedriver.storage.googleapis.com/index.html'
+'to a known chromedriver version: https://chromedriver.chromium.org/downloads/version-selection'
 
       expect { chromedriver.latest_version }.to raise_exception(Webdrivers::VersionError, msg)
     end
 
     it 'raises ConnectionError when offline' do
       allow(Net::HTTP).to receive(:get_response).and_raise(SocketError)
+      allow(Webdrivers::ChromeFinder).to receive(:version).and_return('115.0.5790.114')
 
-      msg = %r{^Can not reach https://chromedriver.storage.googleapis.com}
+      msg = %r{^Can not reach https://googlechromelabs.github.io/chrome-for-testing}
       expect { chromedriver.latest_version }.to raise_error(Webdrivers::ConnectionError, msg)
     end
 
     it 'creates cached file' do
+      allow(chromedriver).to receive(:latest_patch_version).and_return(nil)
       allow(Webdrivers::Network).to receive(:get).and_return('71.0.3578.137')
 
       chromedriver.latest_version
@@ -224,6 +284,17 @@ describe Webdrivers::Chromedriver do
       expect(Webdrivers::Network).to have_received(:get)
       expect(Webdrivers::System).to have_received(:valid_cache?)
     end
+
+    it 'call chrome_for_testing if the browser version is greater than 115' do
+      allow(chromedriver).to receive(:browser_version).and_return Gem::Version.new('115.0.5790.102')
+      allow(Webdrivers::Network).to receive(:get).and_return(
+        {"builds": {'115.0.5790': {"version": '115.0.5790.102'}}}.to_json
+      )
+      uri = URI.join('https://googlechromelabs.github.io', '/chrome-for-testing/latest-patch-versions-per-build.json')
+
+      expect(chromedriver.latest_version).to eq Gem::Version.new('115.0.5790.102')
+      expect(Webdrivers::Network).to have_received(:get).with(uri)
+    end
   end
 
   describe '#required_version=' do

data/spec/webdrivers/edgedriver_spec.rb

@@ -95,6 +95,7 @@ describe Webdrivers::Edgedriver do
       before { allow(edgedriver).to receive(:correct_binary?).and_return(false) }
 
       it 'downloads binary' do
+        allow(Webdrivers::EdgeFinder).to receive(:version).and_return('115.0.1901.188')
         edgedriver.update
 
         expect(edgedriver.current_version).not_to be_nil
@@ -241,6 +242,7 @@ describe Webdrivers::Edgedriver do
 
   describe '#remove' do
     it 'removes existing edgedriver' do
+      allow(Webdrivers::EdgeFinder).to receive(:version).and_return('115.0.1901.188')
       edgedriver.update
 
       edgedriver.remove

data/spec/webdrivers/geckodriver_spec.rb

@@ -86,10 +86,10 @@ describe Webdrivers::Geckodriver do
       expect(Webdrivers::System).to have_received(:download).with(url, geckodriver.driver_path)
     end
 
-    it 'does something when a wrong version is supplied' do
+    it 'raises error when a wrong version is supplied' do
       geckodriver.required_version = '0.2.0'
 
-      msg = /Net::HTTPServerException: 404 "Not Found"/
+      msg = /404 "Not Found"/
       expect { geckodriver.update }.to raise_error(StandardError, msg)
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: webdrivers
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.3.0
 platform: ruby
 authors:
 - Titus Fortner
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-19 00:00:00.000000000 Z
+date: 2023-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -159,6 +159,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -166,6 +169,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.11'
 description: Run Selenium tests more easily with install and updates for all supported
   webdrivers.
 email:
@@ -212,8 +218,8 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/titusfortner/webdrivers/issues
   changelog_uri: https://github.com/titusfortner/webdrivers/blob/master/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/webdrivers/5.1.0
-  source_code_uri: https://github.com/titusfortner/webdrivers/tree/v5.1.0
+  documentation_uri: https://www.rubydoc.info/gems/webdrivers/5.3.0
+  source_code_uri: https://github.com/titusfortner/webdrivers/tree/v5.3.0
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -229,7 +235,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: Easy download and use of browser drivers.