webdrivers 4.4.0 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f905a3a4839d0f0a56317926d560cab4ee29f98b3d36d4feb1bb671e3f1b23b
-  data.tar.gz: 44ae96f9ba7edfbb2fb1bd1fd7ef319e73643f5a43c0fce59c51e2b94c1a25c8
+  metadata.gz: fb33edccefe82002bbea2a0ca410d050bbf12f3b8e3a7a7721147f75ffed9c97
+  data.tar.gz: 2a30c004082f6788096d0d18de559aeea99560a1a96a022b4e9b53c9e4232b12
 SHA512:
-  metadata.gz: 73d60000abc1ad06f692ee556bca7bd57403cde91f2152b5349fda2b0feaa2afb261dd87b1e16f6f8c74e843634b8dbde3da85ed666164920e78163fed764029
-  data.tar.gz: 1c94fde9cafdb1929a3e70ada28c7dfec07cbae6f68220e247ffe62343700c5b3ca2c0556d1d028d4d25b0f6bbd76923c402f1925574ec6f117eb8c4066e6255
+  metadata.gz: 78187b37c392f86a3ef9b788e39c00b81f48acca6de9f9c64a619c28c4f7b29d71a57f099478786ac903ac0ea199735832324fcde5c50f32635b78ce532cddf1
+  data.tar.gz: 3bd31fda8f71d31238d8b73b2468677d5eb23ffe956bb82a74e382ce99a750dce5127ea8328e868c9a795015517c27f8fb208eee4fcdf0b81fa572b5200c1158

data/CHANGELOG.md

@@ -1,5 +1,31 @@
+# 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 initial support for WSLv1 ([#172](https://github.com/titusfortner/webdrivers/issues/172)). Thanks G-Rath!
+* 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 

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:
 
@@ -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

@@ -88,7 +88,7 @@ module Webdrivers
       end
 
       def linux_location
-        return wsl_location if System.wsl?
+        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]
@@ -104,6 +104,8 @@ module Webdrivers
       end
 
       def win_version(location)
+        System.call("pwsh.exe -command \"(Get-ItemProperty '#{location}').VersionInfo.ProductVersion\"")&.strip
+      rescue StandardError
         System.call("powershell.exe \"(Get-ItemProperty '#{location}').VersionInfo.ProductVersion\"")&.strip
       end
 
@@ -112,7 +114,7 @@ module Webdrivers
       end
 
       def linux_version(location)
-        return wsl_version(location) if System.wsl?
+        return wsl_version(location) if System.wsl_v1?
 
         System.call(location, '--product-version')&.strip
       end

data/lib/webdrivers/chromedriver.rb

@@ -73,36 +73,57 @@ 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' || System.wsl? ? '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' || System.wsl? ? '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
 
+      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

data/lib/webdrivers/edge_finder.rb

@@ -69,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

data/lib/webdrivers/network.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'net/http'
+
 module Webdrivers
   #
   # @api private

data/lib/webdrivers/system.rb

@@ -148,8 +148,18 @@ module Webdrivers
         end
       end
 
+      def apple_m1_architecture?
+        if platform == 'mac' && RUBY_PLATFORM.include?('arm64-darwin')
+          Webdrivers.logger.debug 'Apple architecture: M1 (arm64-darwin)'
+          return true
+        end
+
+        Webdrivers.logger.debug 'Apple architecture: Intel (mac64)'
+        false
+      end
+
       # @return [TrueClass, FalseClass]
-      def wsl?
+      def wsl_v1?
         platform == 'linux' && File.open('/proc/version').read.include?('Microsoft')
       end
 

data/lib/webdrivers/version.rb

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

data/spec/webdrivers/chrome_finder_spec.rb

@@ -52,7 +52,7 @@ describe Webdrivers::ChromeFinder do
     before do
       skip "The current platform cannot be WSL, as it's not Linux" unless Selenium::WebDriver::Platform.linux?
 
-      allow(Webdrivers::System).to receive(:wsl?).and_return(true)
+      allow(Webdrivers::System).to receive(:wsl_v1?).and_return(true)
       allow(Webdrivers::System).to receive(:to_wsl_path).and_return('')
       allow(Webdrivers::System).to receive(:to_win32_path).and_return('')
     end