webdrivers 4.5.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb33edccefe82002bbea2a0ca410d050bbf12f3b8e3a7a7721147f75ffed9c97
-  data.tar.gz: 2a30c004082f6788096d0d18de559aeea99560a1a96a022b4e9b53c9e4232b12
+  metadata.gz: f4c9d9a6544732e58eb7a88d34e39b188b5ff658caaa14fbdff15931a69d1e2d
+  data.tar.gz: 92a4997e99508bb79374838461cd2fee48591185b271dd6ce170628c51a02c2c
 SHA512:
-  metadata.gz: 78187b37c392f86a3ef9b788e39c00b81f48acca6de9f9c64a619c28c4f7b29d71a57f099478786ac903ac0ea199735832324fcde5c50f32635b78ce532cddf1
-  data.tar.gz: 3bd31fda8f71d31238d8b73b2468677d5eb23ffe956bb82a74e382ce99a750dce5127ea8328e868c9a795015517c27f8fb208eee4fcdf0b81fa572b5200c1158
+  metadata.gz: fb469a584a66b14097ec87b6a8f2ad30e2cbefdaeef91efd2a50f16ff0451c8a748f8607d53d06ceed3506d61e54ef31b9997e068f9e55dfe9136f8012570234
+  data.tar.gz: ed61ff78edd17f205673242eeba0fa76dcb2df9675a7d8dc4c813e8dd056799a44b13c1a10b238eeb36bae96cc188ca20c4edd71aebf9ec48e9a78e613136f17

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+# 5.0.0 (2021-10-19)
+* Require Selenium 4+
+* Remove custom Logger and use the one in Selenium 4
+
+# 4.7.0 (2021-10-14)
+* Add support for Selenium 4.x #218 (thanks yahonda )
+* Allow Edge on Linux
+* Update required Selenium > 3.141 because of a change in 4.6
+* Require Ruby 2.6+
+* Fix IE downloads with the change in location of assets
+
+# 4.6.1 (2021-08-19)
+* Fix bug in IEdriver caused by bad formatting in recent release
+
+# 4.6.0 (2021-02-26)
+* Update `Edgedriver` naming to support Selenium 4 beta (([#206](https://github.com/titusfortner/webdrivers/pull/206))
+
 # 4.5.0 (2021-01-19)
 * Improve format of README usage section. Thanks, [okuramasafumi](https://github.com/okuramasafumi)!
 * `chromedriver` - Add support for Apple M1 specific builds ([#193](https://github.com/titusfortner/webdrivers/pull/193)). Thanks, [MichaelHoste](https://github.com/MichaelHoste)!

data/README.md

@@ -1,8 +1,6 @@
 # Webdrivers
 
 [![Gem Version](https://badge.fury.io/rb/webdrivers.svg)](https://badge.fury.io/rb/webdrivers)
-[![Build status](https://travis-ci.org/titusfortner/webdrivers.svg?branch=master)](https://travis-ci.org/titusfortner/webdrivers)
-[![AppVeyor status](https://ci.appveyor.com/api/projects/status/ejh90xqbvkphq4cy/branch/master?svg=true)](https://ci.appveyor.com/project/titusfortner/webdrivers/branch/master)
 ![Tests](https://github.com/titusfortner/webdrivers/workflows/Tests/badge.svg)
 
 Run Selenium tests more easily with automatic installation and updates for all supported webdrivers.
@@ -16,14 +14,15 @@ Run Selenium tests more easily with automatic installation and updates for all s
 * [IEDriverServer](https://github.com/SeleniumHQ/selenium/wiki/InternetExplorerDriver)
 * [msedgedriver](https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/)
 
-Works on macOS, Linux, Windows, and Windows Subsystem for Linux (WSL) v1.
+Works on macOS, Linux, Windows, and Windows Subsystem for Linux (WSL) v1 and v2. And do see the browser and OS specific
+notes at the bottom.
 
 ## Usage
 
 In your Gemfile:
 
 ```ruby
-gem 'webdrivers', '~> 4.0', require: false
+gem 'webdrivers', '~> 5.0', require: false
 ```
 
 In your project:
@@ -197,21 +196,7 @@ The logging level can be configured for debugging purpose:
 Webdrivers.logger.level = :DEBUG
 ```
 
-### WSLv1 support
-
-While WSLv1 is not designed to run headful applications like Chrome, it can run exes; as such when found to be running
-in WSL, `webdrivers` will use the Windows `chromedriver.exe`.
-
-It's recommended that you install the new PowerShell (PS7) to avoid [a known issue](https://github.com/microsoft/terminal/issues/367) 
-with the console font being changed when calling the old PowerShell (PS5).
-
-### WSLv2 support
-
-Webdrivers will detect WSLv2 as running on Linux.
-
-WSLv2 doesn't support connecting to host ports out of the box, so it isn't possible to connect to Chromedriver on Windows without extra configurations, see: https://github.com/microsoft/WSL/issues/4619. The simplest way to use Chromedriver with WSLv2 is to run Chrome headless on Linux.
-
-### Browser Specific Notes
+### Browser & OS Specific Notes
 
 #### Chrome/Chromium
 
@@ -236,7 +221,7 @@ variable.
 This is also required if Google Chrome is not installed in its
 [default location](https://github.com/SeleniumHQ/selenium/wiki/ChromeDriver).
 
-##### Heroku Users
+#### Chrome on Heroku
 
 Follow the specific instructions [here](https://github.com/titusfortner/webdrivers/wiki/Heroku-buildpack-google-chrome) if you're using `heroku-buildpack-google-chrome`.
 
@@ -248,6 +233,27 @@ section apply to this browser as well.
 
 Please note that `msedgedriver` requires `selenium-webdriver` v4.
 
+#### WSLv1 support
+
+While WSLv1 is not designed to run headful applications like Chrome, it can run exes; as such when found to be running
+in WSL, `webdrivers` will use Chrome on the Windows filesystem.
+
+It's recommended that you install the new PowerShell (PS7) to avoid [a known issue](https://github.com/microsoft/terminal/issues/367)
+with the console font being changed when calling the old PowerShell (PS5).
+
+#### WSLv2 support
+
+Webdrivers will detect WSLv2 as running on Linux and use Chrome on the Linux filesystem.
+
+WSLv2 doesn't support connecting to host ports out of the box, so it isn't possible to connect to Chromedriver on
+Windows without extra configurations, see: https://github.com/microsoft/WSL/issues/4619. The simplest way to use 
+Chromedriver with WSLv2 is to run Chrome headless on Linux.
+
+#### Chrome and Edge on Apple M1 (`arm64`)
+
+If you're switching from Intel to M1, you'll have to manually delete the existing Intel (`mac64`) driver before the 
+M1 (`arm64`) build can be downloaded. Otherwise, you'll get an error: `Bad CPU type in executable - ~/.webdrivers/chromedriver (Errno::E086)`
+
 ## Wiki
 
 Please see the [wiki](https://github.com/titusfortner/webdrivers/wiki)

data/lib/webdrivers/chromedriver.rb

@@ -97,18 +97,8 @@ module Webdrivers
         false
       end
 
-      def download_url
-        return @download_url if @download_url
-
-        driver_version = if required_version == EMPTY_VERSION
-                           latest_version
-                         else
-                           normalize_version(required_version)
-                         end
-        filename = driver_filename(driver_version)
-        url = "#{base_url}/#{driver_version}/chromedriver_#{filename}.zip"
-        Webdrivers.logger.debug "chromedriver URL: #{url}"
-        @download_url = url
+      def direct_url(driver_version)
+        "#{base_url}/#{driver_version}/chromedriver_#{driver_filename(driver_version)}.zip"
       end
 
       def driver_filename(driver_version)
@@ -156,17 +146,4 @@ module Webdrivers
   end
 end
 
-if ::Selenium::WebDriver::Service.respond_to? :driver_path=
-  ::Selenium::WebDriver::Chrome::Service.driver_path = proc { ::Webdrivers::Chromedriver.update }
-else
-  # v3.141.0 and lower
-  module Selenium
-    module WebDriver
-      module Chrome
-        def self.driver_path
-          @driver_path ||= Webdrivers::Chromedriver.update
-        end
-      end
-    end
-  end
-end
+::Selenium::WebDriver::Chrome::Service.driver_path = proc { ::Webdrivers::Chromedriver.update }

data/lib/webdrivers/common.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 require 'rubygems/package'
-require 'webdrivers/logger'
 require 'webdrivers/network'
 require 'webdrivers/system'
 require 'selenium-webdriver'
+require 'webdrivers/logger'
 require 'webdrivers/version'
 
 module Webdrivers
@@ -118,12 +118,12 @@ module Webdrivers
 
       private
 
+      def download_version
+        required_version == EMPTY_VERSION ? latest_version : required_version
+      end
+
       def download_url
-        @download_url ||= if required_version == EMPTY_VERSION
-                            downloads[downloads.keys.max]
-                          else
-                            downloads[normalize_version(required_version)]
-                          end
+        @download_url ||= direct_url(download_version).tap { |url| Webdrivers.logger.debug "#{file_name} URL: #{url}" }
       end
 
       def exists?
@@ -131,11 +131,7 @@ module Webdrivers
       end
 
       def correct_binary?
-        current_version == if required_version == EMPTY_VERSION
-                             latest_version
-                           else
-                             normalize_version(required_version)
-                           end
+        current_version == download_version
       rescue ConnectionError, VersionError
         driver_path if sufficient_binary?
       end

data/lib/webdrivers/edge_finder.rb

@@ -24,15 +24,15 @@ module Webdrivers
       private
 
       def user_defined_location
-        if Selenium::WebDriver::EdgeChrome.path
-          Webdrivers.logger.debug "Selenium::WebDriver::EdgeChrome.path: #{Selenium::WebDriver::EdgeChrome.path}"
-          return Selenium::WebDriver::EdgeChrome.path
+        if Selenium::WebDriver::Edge.path
+          Webdrivers.logger.debug "Selenium::WebDriver::Edge.path: #{Selenium::WebDriver::Edge.path}"
+          return Selenium::WebDriver::Edge.path
         end
 
-        return if ENV['WD_EDGE_CHROME_PATH'].nil?
+        return if ENV['WD_EDGE_PATH'].nil?
 
-        Webdrivers.logger.debug "WD_EDGE_CHROME_PATH: #{ENV['WD_EDGE_CHROME_PATH']}"
-        ENV['WD_EDGE_CHROME_PATH']
+        Webdrivers.logger.debug "WD_EDGE_PATH: #{ENV['WD_EDGE_PATH']}"
+        ENV['WD_EDGE_PATH']
       end
 
       def win_location

data/lib/webdrivers/edgedriver.rb

@@ -76,15 +76,15 @@ module Webdrivers
         false
       end
 
-      # def linux_compatible?(driver_version)
-      #   System.platform == 'linux' && driver_version >= normalize_version('89.0.731.0')
-      # end
+      def linux_compatible?(driver_version)
+        System.platform == 'linux' && driver_version >= normalize_version('89.0.731.0')
+      end
 
       def driver_filename(driver_version)
         if System.platform == 'win' || System.wsl_v1?
           "win#{System.bitsize}" # 32 or 64-bit
-        # elsif linux_compatible?(driver_version)
-        #   'linux64'
+        elsif linux_compatible?(driver_version)
+          'linux64'
         elsif System.platform == 'mac'
           # Determine M1 or Intel architecture
           apple_arch = apple_m1_compatible?(driver_version) ? 'arm' : 'mac'
@@ -94,36 +94,11 @@ module Webdrivers
         end
       end
 
-      def download_url
-        return @download_url if @download_url
-
-        driver_version = if required_version == EMPTY_VERSION
-                           latest_version
-                         else
-                           normalize_version(required_version)
-                         end
-        filename = driver_filename(driver_version)
-        url = "#{base_url}/#{driver_version}/edgedriver_#{filename}.zip"
-        Webdrivers.logger.debug "msedgedriver URL: #{url}"
-        @download_url = url
+      def direct_url(driver_version)
+        "#{base_url}/#{driver_version}/edgedriver_#{driver_filename(driver_version)}.zip"
       end
     end
   end
 end
 
-if defined? Selenium::WebDriver::EdgeChrome
-  if ::Selenium::WebDriver::Service.respond_to? :driver_path=
-    ::Selenium::WebDriver::EdgeChrome::Service.driver_path = proc { ::Webdrivers::Edgedriver.update }
-  else
-    # v3.141.0 and lower
-    module Selenium
-      module WebDriver
-        module EdgeChrome
-          def self.driver_path
-            @driver_path ||= Webdrivers::Edgedriver.update
-          end
-        end
-      end
-    end
-  end
-end
+::Selenium::WebDriver::Edge::Service.driver_path = proc { ::Webdrivers::Edgedriver.update }

data/lib/webdrivers/geckodriver.rb

@@ -42,14 +42,6 @@ module Webdrivers
         System.platform == 'win' ? 'geckodriver.exe' : 'geckodriver'
       end
 
-      def download_url
-        @download_url ||= if required_version == EMPTY_VERSION
-                            direct_url(latest_version)
-                          else
-                            direct_url(required_version)
-                          end
-      end
-
       def direct_url(version)
         "#{base_url}/download/v#{version}/geckodriver-v#{version}-#{platform_ext}"
       end
@@ -68,17 +60,4 @@ module Webdrivers
   end
 end
 
-if ::Selenium::WebDriver::Service.respond_to? :driver_path=
-  ::Selenium::WebDriver::Firefox::Service.driver_path = proc { ::Webdrivers::Geckodriver.update }
-else
-  # v3.141.0 and lower
-  module Selenium
-    module WebDriver
-      module Firefox
-        def self.driver_path
-          @driver_path ||= Webdrivers::Geckodriver.update
-        end
-      end
-    end
-  end
-end
+::Selenium::WebDriver::Firefox::Service.driver_path = proc { ::Webdrivers::Geckodriver.update }

data/lib/webdrivers/iedriver.rb

@@ -34,7 +34,7 @@ module Webdrivers
       #
       # @return [String]
       def base_url
-        'https://selenium-release.storage.googleapis.com/'
+        'https://api.github.com/repos/seleniumhq/selenium/releases'
       end
 
       private
@@ -43,35 +43,26 @@ module Webdrivers
         'IEDriverServer.exe'
       end
 
+      def direct_url(version)
+        downloads[version]
+      end
+
       def downloads
         ds = download_manifest.each_with_object({}) do |item, hash|
-          version = normalize_version item[/([^_]+)\.zip/, 1]
-          hash[version] = "#{base_url}#{item}"
+          version = normalize_version item['name'][/\.?([^_]+)\.zip/, 1]
+          hash[version] = item['browser_download_url']
         end
         Webdrivers.logger.debug "Versions now located on downloads site: #{ds.keys}"
         ds
       end
 
       def download_manifest
-        doc = Nokogiri::XML.parse(Network.get(base_url))
-        items = doc.css('Key').collect(&:text)
-        items.select { |item| item.include?('IEDriverServer_Win32') }
+        json = Network.get(base_url)
+        all_assets = JSON.parse(json).map { |release| release['assets'] }.flatten
+        all_assets.select { |asset| asset['name'].include?('IEDriverServer_Win32') }
       end
     end
   end
 end
 
-if ::Selenium::WebDriver::Service.respond_to? :driver_path=
-  ::Selenium::WebDriver::IE::Service.driver_path = proc { ::Webdrivers::IEdriver.update }
-else
-  # v3.141.0 and lower
-  module Selenium
-    module WebDriver
-      module IE
-        def self.driver_path
-          @driver_path ||= Webdrivers::IEdriver.update
-        end
-      end
-    end
-  end
-end
+::Selenium::WebDriver::IE::Service.driver_path = proc { ::Webdrivers::IEdriver.update }

data/lib/webdrivers/logger.rb

@@ -1,11 +1,5 @@
 # frozen_string_literal: true
 
-require 'forwardable'
-require 'logger'
-
-# Code adapted from Selenium Implementation
-# https://github.com/SeleniumHQ/selenium/blob/master/rb/lib/selenium/webdriver/common/logger.rb
-
 module Webdrivers
   #
   # @example Enable full logging
@@ -18,94 +12,9 @@ module Webdrivers
   #   Webdrivers.logger.info('This is info message')
   #   Webdrivers.logger.warn('This is warning message')
   #
-  class Logger
-    extend Forwardable
-    include ::Logger::Severity
-
-    def_delegators :@logger, :debug, :debug?,
-                   :info, :info?,
-                   :warn, :warn?,
-                   :error, :error?,
-                   :fatal, :fatal?,
-                   :level
-
+  class Logger < Selenium::WebDriver::Logger
     def initialize
-      @logger = create_logger($stdout)
-    end
-
-    def output=(io)
-      # `Logger#reopen` was added in Ruby 2.3
-      if @logger.respond_to?(:reopen)
-        @logger.reopen(io)
-      else
-        @logger = create_logger(io)
-      end
-    end
-
-    #
-    # For Ruby < 2.3 compatibility
-    # Based on https://github.com/ruby/ruby/blob/ruby_2_3/lib/logger.rb#L250
-    #
-
-    def level=(severity)
-      if severity.is_a?(Integer)
-        @logger.level = severity
-      else
-        case severity.to_s.downcase
-        when 'debug'
-          @logger.level = DEBUG
-        when 'info'
-          @logger.level = INFO
-        when 'warn'
-          @logger.level = WARN
-        when 'error'
-          @logger.level = ERROR
-        when 'fatal'
-          @logger.level = FATAL
-        when 'unknown'
-          @logger.level = UNKNOWN
-        else
-          raise ArgumentError, "invalid log level: #{severity}"
-        end
-      end
-    end
-
-    #
-    # Returns IO object used by logger internally.
-    #
-    # Normally, we would have never needed it, but we want to
-    # use it as IO object for all child processes to ensure their
-    # output is redirected there.
-    #
-    # It is only used in debug level, in other cases output is suppressed.
-    #
-    # @api private
-    #
-    def io
-      @logger.instance_variable_get(:@logdev).instance_variable_get(:@dev)
-    end
-
-    #
-    # Marks code as deprecated with replacement.
-    #
-    # @param [String] old
-    # @param [String] new
-    #
-    def deprecate(old, new)
-      warn "[DEPRECATION] #{old} is deprecated. Use #{new} instead."
-    end
-
-    private
-
-    def create_logger(output)
-      logger = ::Logger.new(output)
-      logger.progname = 'Webdrivers'
-      logger.level = ($DEBUG ? DEBUG : WARN)
-      logger.formatter = proc do |severity, time, progname, msg|
-        "#{time.strftime('%F %T')} #{severity} #{progname} #{msg}\n"
-      end
-
-      logger
+      super('Webdrivers')
     end
   end
 end

data/lib/webdrivers/version.rb

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

data/spec/webdrivers/edge_finder_spec.rb

@@ -5,13 +5,7 @@ require 'spec_helper'
 describe Webdrivers::EdgeFinder do
   let(:edge_finder) { described_class }
 
-  before(:all) do # rubocop:disable RSpec/BeforeAfterAll
-    # Skip these tests if version of selenium-webdriver being tested with doesn't
-    # have Chromium based Edge support
-    unless defined?(Selenium::WebDriver::EdgeChrome)
-      skip "The current selenium-webdriver doesn't include Chromium based Edge support"
-    end
-  end
+  before { skip 'Edge is not yet supported on Linux' if Webdrivers::System.platform == 'linux' }
 
   context 'when the user relies on the gem to figure out the location of Edge' do
     it 'determines the location correctly based on the current OS' do
@@ -20,8 +14,8 @@ describe Webdrivers::EdgeFinder do
   end
 
   context 'when the user provides a path to the Edge binary' do
-    it 'uses Selenium::WebDriver::EdgeChrome.path when it is defined' do
-      Selenium::WebDriver::EdgeChrome.path = edge_finder.location
+    it 'uses Selenium::WebDriver::Edge.path when it is defined' do
+      Selenium::WebDriver::Edge.path = edge_finder.location
       locations = %i[win_location mac_location linux_location]
       allow(edge_finder).to receive_messages(locations)
 
@@ -29,8 +23,8 @@ describe Webdrivers::EdgeFinder do
       locations.each { |loc| expect(edge_finder).not_to have_received(loc) }
     end
 
-    it "uses ENV['WD_EDGE_CHROME_PATH'] when it is defined" do
-      allow(ENV).to receive(:[]).with('WD_EDGE_CHROME_PATH').and_return(edge_finder.location)
+    it "uses ENV['WD_EDGE_PATH'] when it is defined" do
+      allow(ENV).to receive(:[]).with('WD_EDGE_PATH').and_return(edge_finder.location)
       locations = %i[win_location mac_location linux_location]
       allow(edge_finder).to receive_messages(locations)
 
@@ -38,11 +32,11 @@ describe Webdrivers::EdgeFinder do
       locations.each { |loc| expect(edge_finder).not_to have_received(loc) }
     end
 
-    it 'uses Selenium::WebDriver::EdgeChrome.path over WD_EDGE_CHROME_PATH' do
-      Selenium::WebDriver::EdgeChrome.path = edge_finder.location
-      allow(ENV).to receive(:[]).with('WD_EDGE_CHROME_PATH').and_return('my_wd_chrome_path')
+    it 'uses Selenium::WebDriver::Edge.path over WD_EDGE_PATH' do
+      Selenium::WebDriver::Edge.path = edge_finder.location
+      allow(ENV).to receive(:[]).with('WD_EDGE_PATH').and_return('my_wd_chrome_path')
       expect(edge_finder.version).not_to be_nil
-      expect(ENV).not_to have_received(:[]).with('WD_EDGE_CHROME_PATH')
+      expect(ENV).not_to have_received(:[]).with('WD_EDGE_PATH')
     end
   end
 

data/spec/webdrivers/edgedriver_spec.rb

@@ -5,16 +5,11 @@ require 'spec_helper'
 describe Webdrivers::Edgedriver do
   let(:edgedriver) { described_class }
 
-  before(:all) do # rubocop:disable RSpec/BeforeAfterAll
-    # Skip these tests if version of selenium-webdriver being tested with doesn't
-    # have Chromium based Edge support
-    unless defined?(Selenium::WebDriver::EdgeChrome)
-      skip "The current selenium-webdriver doesn't include Chromium based Edge support"
-    end
+  before do
+    skip 'Edge is not yet supported on Linux' if Webdrivers::System.platform == 'linux'
+    edgedriver.remove
   end
 
-  before { edgedriver.remove }
-
   describe '#update' do
     context 'when evaluating #correct_binary?' do
       it 'does not download when latest version and current version match' do
@@ -180,8 +175,7 @@ describe Webdrivers::Edgedriver do
     end
 
     it 'raises VersionError for unknown version' do
-      skip "MS doesn't yet support point release latest versioning."
-      allow(edgedriver).to receive(:browser_version).and_return('77.0.9999.0000')
+      allow(edgedriver).to receive(:browser_version).and_return Gem::Version.new('77.0.9999')
       msg = 'Unable to find latest point release version for 77.0.9999. '\
 'Please set `Webdrivers::Edgedriver.required_version = <desired driver version>` '\
 'to a known edgedriver version: Can not reach https://msedgedriver.azureedge.net/'

data/spec/webdrivers/geckodriver_spec.rb

@@ -192,14 +192,12 @@ You can obtain a copy of the license at https://mozilla.org/MPL/2.0/"
     end
 
     it 'uses provided value' do
-      begin
-        install_dir = File.expand_path(File.join(ENV['HOME'], '.webdrivers2'))
-        Webdrivers.install_dir = install_dir
+      install_dir = File.expand_path(File.join(ENV['HOME'], '.webdrivers2'))
+      Webdrivers.install_dir = install_dir
 
-        expect(Webdrivers::System.install_dir).to eq install_dir
-      ensure
-        Webdrivers.install_dir = nil
-      end
+      expect(Webdrivers::System.install_dir).to eq install_dir
+    ensure
+      Webdrivers.install_dir = nil
     end
   end