webdrivers 4.2.0 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fac06602fcff05585f6d938c97929a997965ce587d40fab35c319fbd1f199b16
-  data.tar.gz: cb7dc89fed860e1c900b1593a98743ffc2f43b31f5d4608e6d86e04a70e10db4
+  metadata.gz: fb33edccefe82002bbea2a0ca410d050bbf12f3b8e3a7a7721147f75ffed9c97
+  data.tar.gz: 2a30c004082f6788096d0d18de559aeea99560a1a96a022b4e9b53c9e4232b12
 SHA512:
-  metadata.gz: 4c331e0e6b99c41b6285f58f6aa1245edc251832f1e6edb5ce2c6b0fca469d31b3b9431f65c220195b2630264a87d3b91e6f7a1d820fa79e3093f1b3c50f3b21
-  data.tar.gz: 341df4de8de5bf6e67784dfc3a74b445c0ea1f3fdfda47f84744a69ac5a3828762926aeff8393d3d6017160ba9d9fbbc51f4b533573992f85a4c94ad4771dc5a
+  metadata.gz: 78187b37c392f86a3ef9b788e39c00b81f48acca6de9f9c64a619c28c4f7b29d71a57f099478786ac903ac0ea199735832324fcde5c50f32635b78ce532cddf1
+  data.tar.gz: 3bd31fda8f71d31238d8b73b2468677d5eb23ffe956bb82a74e382ce99a750dce5127ea8328e868c9a795015517c27f8fb208eee4fcdf0b81fa572b5200c1158

data/CHANGELOG.md

@@ -1,3 +1,41 @@
+# 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)!
+* `msedgedriver` - Add support for Apple M1 specific builds.
+* `msedgedriver` - Added automatic selection of 32-bit vs 64-bit builds on Windows and WSLv1.  
+* When using this gem in WSLv2, Chrome installed on the Linux filesystem will be automatically used ([#196](https://github.com/titusfortner/webdrivers/pull/196)). 
+  WSLv1 continues to automatically use Chrome from the Windows filesystem though. Thanks, [fabioxgn](https://github.com/fabioxgn)!
+  * We'll aim to make the behavior consistent in a future release.
+
+### 4.4.2 (2020-12-29)
+* Use new powershell if available to enhance WSL support ([#176](https://github.com/titusfortner/webdrivers/issues/176), 
+  [#186](https://github.com/titusfortner/webdrivers/pull/186)). Thanks, [G-Rath](https://github.com/G-Rath) and 
+  [131](https://github.com/131)!
+* Update rubocop version (development dependency only) ([#178](https://github.com/titusfortner/webdrivers/pull/178)).
+  Thanks, [utkarsh2102](https://github.com/utkarsh2102)!
+* Replace `git ls-files` with `dir` in the gemspec for better Debian support ([#179](https://github.com/titusfortner/webdrivers/pull/179),
+  [#184](https://github.com/titusfortner/webdrivers/issues/184)).
+  Thanks again, [utkarsh2102](https://github.com/utkarsh2102)!
+* Update README with `require: false` when adding gem to Gemfile ([#183](https://github.com/titusfortner/webdrivers/pull/183)).
+* Make WSL detection more generic ([#187](https://github.com/titusfortner/webdrivers/pull/187)).
+  [rbclark](https://github.com/rbclark)!
+  
+### 4.4.1 (2020-06-01)
+* Do not include binstubs used for troubleshooting only. Fixes [#174](https://github.com/titusfortner/webdrivers/issues/174).
+
+### 4.4.0 (2020-05-31)
+* Implement support for `chromedriver` in Windows Subsystem for Linux (WSL) v1 ([#172](https://github.com/titusfortner/webdrivers/issues/172)). 
+  Thanks, [G-Rath](https://github.com/G-Rath)!
+* Chrome/Edgedriver - Fix [#171](https://github.com/titusfortner/webdrivers/issues/171) by making sure the cached
+driver build version matches the browser build version before using it.
+* Chrome/Edgedriver - Driver version check now matches the driver and browser `major.minor.build` versions instead of just 
+the major version to be fully compliant with the `chromedriver` version selection
+[document](https://chromedriver.chromium.org/downloads/version-selection).
+
+### 4.3.0 (2020-04-14)
+* Add support for Microsoft Edge (Chromium) stable
+* Drop support for Ruby < 2.4.0
+
 ### 4.2.0 (2019-12-27)
 * Add support for Microsoft Edge (Chromium) Beta releases ([#155](https://github.com/titusfortner/webdrivers/pull/155))
 * Use tilde expansion to resolve user's home directory ([#166](https://github.com/titusfortner/webdrivers/pull/161))

data/README.md

@@ -3,6 +3,7 @@
 [![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.
 
@@ -15,11 +16,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.
+
 ## Usage
 
 In your Gemfile:
 
-`gem 'webdrivers', '~> 4.0'`
+```ruby
+gem 'webdrivers', '~> 4.0', require: false
+```
 
 In your project:
 
@@ -92,10 +97,10 @@ variable. **Only set one to avoid confusion**.
 
 ##### Special exception for chromedriver and msedgedriver
 
-Cache time will be respected as long as a driver binary exists and the major versions of
-the browser and the driver match. For example, if you update Chrome or Edge to v76 and its driver is
-still at v75, `webdrivers` will ignore the cache time and update the driver to make sure you're
-using a compatible version.
+Cache time will be respected as long as a driver binary exists and the major.minor.build versions of
+the browser and the driver match. For example, if you update Chrome or Edge to v76.0.123 and its driver is
+still at v76.0.100, `webdrivers` will ignore the cache time and update the driver to make sure you're
+using a compatible build version.
 
 ### Proxy
 
@@ -192,6 +197,20 @@ 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
 
 #### Chrome/Chromium

data/lib/webdrivers/chrome_finder.rb

@@ -50,6 +50,28 @@ module Webdrivers
         nil
       end
 
+      def wsl_location
+        _, drive, user = ENV['PATH'].match(%r{/([a-z])/Users/([^/:]+)/AppData/}).to_a
+
+        roots = [
+          "#{drive}:\\Users\\#{user}\\AppData\\Local",
+          "#{drive}:\\Program Files (x86)",
+          "#{drive}:\\Program Files"
+        ]
+
+        directories = %w[Google\\Chrome\\Application Chromium\\Application]
+        file = 'chrome.exe'
+
+        directories.each do |dir|
+          roots.each do |root|
+            option = System.to_wsl_path("#{root}\\#{dir}\\#{file}")
+            return option if File.exist?(option)
+          end
+        end
+
+        nil
+      end
+
       def mac_location
         directories = ['', File.expand_path('~')]
         files = ['/Applications/Google Chrome.app/Contents/MacOS/Google Chrome',
@@ -66,6 +88,8 @@ module Webdrivers
       end
 
       def linux_location
+        return wsl_location if System.wsl_v1?
+
         directories = %w[/usr/local/sbin /usr/local/bin /usr/sbin /usr/bin /sbin /bin /snap/bin /opt/google/chrome]
         files = %w[google-chrome chrome chromium chromium-browser]
 
@@ -80,10 +104,18 @@ module Webdrivers
       end
 
       def win_version(location)
-        System.call("powershell (Get-ItemProperty '#{location}').VersionInfo.ProductVersion")&.strip
+        System.call("pwsh.exe -command \"(Get-ItemProperty '#{location}').VersionInfo.ProductVersion\"")&.strip
+      rescue StandardError
+        System.call("powershell.exe \"(Get-ItemProperty '#{location}').VersionInfo.ProductVersion\"")&.strip
+      end
+
+      def wsl_version(location)
+        win_version(System.to_win32_path(location))
       end
 
       def linux_version(location)
+        return wsl_version(location) if System.wsl_v1?
+
         System.call(location, '--product-version')&.strip
       end
 

data/lib/webdrivers/chromedriver.rb

@@ -29,9 +29,14 @@ module Webdrivers
       def latest_version
         @latest_version ||= begin
           # Versions before 70 do not have a LATEST_RELEASE file
-          return normalize_version('2.41') if release_version < normalize_version('70')
+          return normalize_version('2.41') if browser_build_version < normalize_version('70')
 
-          latest_applicable = with_cache(file_name) { latest_point_release(release_version) }
+          # Cache check
+          # Cached version should exist and be compatible with the current browser version.
+          # Otherwise, fetch the latest compatible driver.
+          latest_applicable = with_cache(file_name,
+                                         current_build_version,
+                                         browser_build_version) { latest_point_release(browser_build_version) }
 
           Webdrivers.logger.debug "Latest version available: #{latest_applicable}"
           normalize_version(latest_applicable)
@@ -68,48 +73,84 @@ module Webdrivers
           else
             msg
           end
-              rescue NetworkError
-                "#{msg} A network issue is preventing determination of latest chromedriver release."
+        rescue NetworkError
+          "#{msg} A network issue is preventing determination of latest chromedriver release."
         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.storage.googleapis.com/index.html'
         Webdrivers.logger.debug msg
         raise VersionError, msg
       end
 
       def file_name
-        System.platform == 'win' ? 'chromedriver.exe' : 'chromedriver'
+        System.platform == 'win' || System.wsl_v1? ? 'chromedriver.exe' : 'chromedriver'
+      end
+
+      def apple_m1_compatible?(driver_version)
+        if System.apple_m1_architecture? && driver_version >= normalize_version('87.0.4280.88')
+          Webdrivers.logger.debug 'chromedriver version is Apple M1 compatible.'
+          return true
+        end
+
+        Webdrivers.logger.debug 'chromedriver version is NOT Apple M1 compatible. Required >= 87.0.4280.88'
+        false
       end
 
       def download_url
         return @download_url if @download_url
 
-        version = if required_version == EMPTY_VERSION
-                    latest_version
-                  else
-                    normalize_version(required_version)
-                  end
-
-        file_name = System.platform == 'win' ? 'win32' : "#{System.platform}64"
-        url = "#{base_url}/#{version}/chromedriver_#{file_name}.zip"
+        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
       end
 
-      # Returns release version from the currently installed Chrome version
+      def driver_filename(driver_version)
+        if System.platform == 'win' || System.wsl_v1?
+          'win32'
+        elsif System.platform == 'linux'
+          'linux64'
+        elsif System.platform == 'mac'
+          apple_arch = apple_m1_compatible?(driver_version) ? '_m1' : ''
+          "mac64#{apple_arch}"
+        else
+          raise 'Failed to determine driver filename to download for your OS.'
+        end
+      end
+
+      # Returns major.minor.build version from the currently installed chromedriver version
+      #
+      # @example
+      #   73.0.3683.68 (major.minor.build.patch) -> 73.0.3683 (major.minor.build)
+      def current_build_version
+        build_ver = if current_version.nil? # Driver not found
+                      nil
+                    else
+                      current_version.segments[0..2].join('.')
+                    end
+        normalize_version(build_ver)
+      end
+
+      # Returns major.minor.build version from the currently installed Chrome version
       #
       # @example
-      #   73.0.3683.75 -> 73.0.3683
-      def release_version
-        chrome = normalize_version(browser_version)
-        normalize_version(chrome.segments[0..2].join('.'))
+      #   73.0.3683.75 (major.minor.build.patch) -> 73.0.3683 (major.minor.build)
+      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
+      # and its build version matches the browser build version
       def sufficient_binary?
         super && current_version && (current_version < normalize_version('70.0.3538') ||
-            current_version.segments.first == release_version.segments.first)
+          current_build_version == browser_build_version)
       end
     end
   end

data/lib/webdrivers/common.rb

@@ -157,9 +157,15 @@ module Webdrivers
         nil
       end
 
-      def with_cache(file_name)
-        if System.valid_cache?(file_name)
-          normalize_version System.cached_version(file_name)
+      # Returns cached driver version if cache is still valid and the driver binary exists.
+      # Otherwise caches the given version (typically the latest available)
+      # In case of Chrome, it also verifies that the driver build and browser build versions are compatible.
+      # Example usage: lib/webdrivers/chromedriver.rb:34
+      def with_cache(file_name, driver_build = nil, browser_build = nil)
+        if System.valid_cache?(file_name) && exists? && (driver_build == browser_build)
+          cached_version = System.cached_version(file_name)
+          Webdrivers.logger.debug "using cached version as latest: #{cached_version}"
+          normalize_version cached_version
         else
           version = yield
           System.cache_version(file_name, version)

data/lib/webdrivers/edge_finder.rb

@@ -37,7 +37,8 @@ module Webdrivers
 
       def win_location
         envs = %w[LOCALAPPDATA PROGRAMFILES PROGRAMFILES(X86)]
-        directories = ['\\Microsoft\\Edge Beta\\Application',
+        directories = ['\\Microsoft\\Edge\\Application',
+                       '\\Microsoft\\Edge Beta\\Application',
                        '\\Microsoft\\Edge Dev\\Application',
                        '\\Microsoft\\Edge SxS\\Application']
         file = 'msedge.exe'
@@ -68,6 +69,17 @@ module Webdrivers
       end
 
       def linux_location
+        # directories = %w[/usr/local/sbin /usr/local/bin /usr/sbin /usr/bin /sbin /bin /snap/bin /opt/google/chrome]
+        # files = %w[microsoft-edge] # Based on Microsoft Edge 89.0.760.0 dev
+        #
+        # directories.each do |dir|
+        #   files.each do |file|
+        #     option = "#{dir}/#{file}"
+        #     return option if File.exist?(option)
+        #   end
+        # end
+        #
+        # nil
         raise 'Default location not yet known'
       end
 

data/lib/webdrivers/edgedriver.rb

@@ -26,10 +26,6 @@ module Webdrivers
         'https://msedgedriver.azureedge.net/'
       end
 
-      def remove
-        super
-      end
-
       private
 
       def latest_point_release(version)
@@ -58,8 +54,8 @@ module Webdrivers
           else
             msg
           end
-              rescue NetworkError
-                "#{msg} A network issue is preventing determination of latest msedgedriver release."
+        rescue NetworkError
+          "#{msg} A network issue is preventing determination of latest msedgedriver release."
         end
 
         "#{msg} Please set `Webdrivers::Edgedriver.required_version = <desired driver version>` "\
@@ -70,17 +66,44 @@ module Webdrivers
         System.platform == 'win' ? 'msedgedriver.exe' : 'msedgedriver'
       end
 
+      def apple_m1_compatible?(driver_version)
+        if System.apple_m1_architecture? && driver_version >= normalize_version('87.0.669.0')
+          Webdrivers.logger.debug 'msedgedriver version is Apple M1 compatible.'
+          return true
+        end
+
+        Webdrivers.logger.debug 'msedgedriver version is NOT Apple M1 compatible. Required >= 87.0.669.0'
+        false
+      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 System.platform == 'mac'
+          # Determine M1 or Intel architecture
+          apple_arch = apple_m1_compatible?(driver_version) ? 'arm' : 'mac'
+          "#{apple_arch}64"
+        else
+          raise 'Failed to determine driver filename to download for your OS.'
+        end
+      end
+
       def download_url
         return @download_url if @download_url
 
-        version = if required_version == EMPTY_VERSION
-                    latest_version
-                  else
-                    normalize_version(required_version)
-                  end
-
-        file_name = System.platform == 'win' ? 'win32' : "#{System.platform}64"
-        url = "#{base_url}/#{version}/edgedriver_#{file_name}.zip"
+        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
       end

data/lib/webdrivers/iedriver.rb

@@ -44,16 +44,19 @@ module Webdrivers
       end
 
       def downloads
-        doc = Nokogiri::XML.parse(Network.get(base_url))
-        items = doc.css('Key').collect(&:text)
-        items.select! { |item| item.include?('IEDriverServer_Win32') }
-        ds = items.each_with_object({}) do |item, hash|
-          key = normalize_version item[/([^_]+)\.zip/, 1]
-          hash[key] = "#{base_url}#{item}"
+        ds = download_manifest.each_with_object({}) do |item, hash|
+          version = normalize_version item[/([^_]+)\.zip/, 1]
+          hash[version] = "#{base_url}#{item}"
         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') }
+      end
     end
   end
 end