webdrivers 4.0.1 → 4.1.0

data/lib/webdrivers/chromedriver.rb

@@ -42,9 +42,10 @@ module Webdrivers
       # Returns currently installed Chrome/Chromium version.
       #
       # @return [Gem::Version]
-      def chrome_version
+      def browser_version
         normalize_version ChromeFinder.version
       end
+      alias chrome_version browser_version
 
       #
       # Returns url with domain for calls to get this driver.
@@ -102,7 +103,7 @@ module Webdrivers
       # @example
       #   73.0.3683.75 -> 73.0.3683
       def release_version
-        chrome = normalize_version(chrome_version)
+        chrome = normalize_version(browser_version)
         normalize_version(chrome.segments[0..2].join('.'))
       end
 

data/lib/webdrivers/common.rb

@@ -19,6 +19,7 @@ module Webdrivers
   end
 
   DEFAULT_CACHE_TIME = 86_400 # 24 hours
+  DEFAULT_INSTALL_DIR = File.expand_path(File.join(ENV['HOME'], '.webdrivers'))
 
   class << self
     attr_accessor :proxy_addr, :proxy_port, :proxy_user, :proxy_pass
@@ -30,7 +31,8 @@ module Webdrivers
     # are set, it defaults to 86,400 Seconds (24 hours).
     #
     def cache_time
-      (ENV['WD_CACHE_TIME'] || @cache_time || DEFAULT_CACHE_TIME).to_i
+      @cache_time ||= (ENV['WD_CACHE_TIME'] || DEFAULT_CACHE_TIME)
+      @cache_time.to_i
     end
 
     #
@@ -38,7 +40,7 @@ module Webdrivers
     #
     # @return [String]
     def install_dir
-      @install_dir || ENV['WD_INSTALL_DIR'] || File.expand_path(File.join(ENV['HOME'], '.webdrivers'))
+      @install_dir ||= ENV['WD_INSTALL_DIR'] || DEFAULT_INSTALL_DIR
     end
 
     def logger
@@ -65,7 +67,7 @@ module Webdrivers
       raise 'Webdrivers.net_http_ssl_fix is no longer available.' \
       ' Please see https://github.com/titusfortner/webdrivers#ssl_connect-errors.'
     end
-end
+  end
 
   class Common
     class << self
@@ -76,7 +78,7 @@ end
       #
       # @return [Gem::Version]
       def required_version
-        normalize_version @required_version
+        normalize_version(@required_version ||= nil)
       end
 
       #
@@ -109,7 +111,7 @@ end
       #
       # @return [String]
       def driver_path
-        System.escape_path File.join(System.install_dir, file_name)
+        File.absolute_path File.join(System.install_dir, file_name)
       end
 
       private
@@ -145,7 +147,7 @@ end
       end
 
       def binary_version
-        version = System.call("#{driver_path} --version")
+        version = System.call(driver_path, '--version')
         Webdrivers.logger.debug "Current version of #{driver_path} is #{version}"
         version
       rescue Errno::ENOENT

data/lib/webdrivers/edge_finder.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Webdrivers
+  #
+  # @api private
+  #
+  class EdgeFinder
+    class << self
+      def version
+        version = send("#{System.platform}_version", location)
+
+        raise VersionError, 'Failed to find Edge binary or its version.' if version.nil? || version.empty?
+
+        Webdrivers.logger.debug "Browser version: #{version}"
+        version[/\d+\.\d+\.\d+\.\d+/] # Microsoft Edge 73.0.3683.75 -> 73.0.3683.75
+      end
+
+      def location
+        user_defined_location || send("#{System.platform}_location")
+      end
+
+      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
+        end
+
+        return if ENV['WD_EDGE_CHROME_PATH'].nil?
+
+        Webdrivers.logger.debug "WD_EDGE_CHROME_PATH: #{ENV['WD_EDGE_CHROME_PATH']}"
+        ENV['WD_EDGE_CHROME_PATH']
+      end
+
+      def win_location
+        envs = %w[LOCALAPPDATA PROGRAMFILES PROGRAMFILES(X86)]
+        directories = ['\\Microsoft\\Edge Dev\\Application', '\\Microsoft\\Edge SxS\\Application']
+        file = 'msedge.exe'
+
+        directories.each do |dir|
+          envs.each do |root|
+            option = "#{ENV[root]}\\#{dir}\\#{file}"
+            return option if File.exist?(option)
+          end
+        end
+        nil
+      end
+
+      def mac_location
+        directories = ['', File.expand_path('~')]
+        files = ['/Applications/Microsoft Edge.app/Contents/MacOS/Microsoft Edge',
+                 '/Applications/Microsoft Edge Dev.app/Contents/MacOS/Microsoft Edge Dev',
+                 '/Applications/Microsoft Edge Canary.app/Contents/MacOS/Microsoft Edge Canary']
+
+        directories.each do |dir|
+          files.each do |file|
+            option = "#{dir}/#{file}"
+            return option if File.exist?(option)
+          end
+        end
+        nil
+      end
+
+      def linux_location
+        raise 'Default location not yet known'
+      end
+
+      def win_version(location)
+        System.call("powershell (Get-ItemProperty '#{location}').VersionInfo.ProductVersion")&.strip
+      end
+
+      def linux_version(location)
+        System.call(location, '--product-version')&.strip
+      end
+
+      def mac_version(location)
+        System.call(location, '--version')&.strip
+      end
+    end
+  end
+end

data/lib/webdrivers/edgedriver.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require 'shellwords'
+require 'webdrivers/common'
+require 'webdrivers/chromedriver'
+require 'webdrivers/edge_finder'
+
+module Webdrivers
+  class Edgedriver < Chromedriver
+    class << self
+      undef :chrome_version
+      #
+      # Returns currently installed Edge version.
+      #
+      # @return [Gem::Version]
+      def browser_version
+        normalize_version EdgeFinder.version
+      end
+
+      #
+      # Returns url with domain for calls to get this driver.
+      #
+      # @return [String]
+      def base_url
+        # 'https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/'
+        'https://msedgedriver.azureedge.net/'
+      end
+
+      def remove
+        super
+      end
+
+      private
+
+      def latest_point_release(version)
+        # Microsoft doesn't currently provide LATEST_RELEASE_X.Y.Z - only use X
+        # but require the driver version be >= the passed in version
+        str = Network.get(URI.join(base_url, "LATEST_RELEASE_#{version.segments[0]}"))
+        latest_release = normalize_version(str.encode('ASCII-8BIT', 'UTF-16'))
+        raise VersionError unless latest_release >= version
+
+        latest_release
+      rescue NetworkError, VersionError
+        msg = failed_to_find_message(version)
+        Webdrivers.logger.debug msg
+        raise VersionError, msg
+      end
+
+      def failed_to_find_message(version)
+        msg = "Unable to find latest point release version for #{version}."
+        msg = begin
+          # str = Network.get(URI.join(base_url, 'LATEST_RELEASE'))
+          # Microsoft doesn't yet/ever support LATEST_RELEASE - Use Canary as latest
+          str = Network.get(URI.join(base_url, 'LATEST_CANARY'))
+          latest_release = normalize_version(str.encode('ASCII-8BIT', 'UTF-16'))
+          if version > latest_release
+            "#{msg} You appear to be using a non-production version of Edge."
+          else
+            msg
+          end
+              rescue NetworkError
+                "#{msg} A network issue is preventing determination of latest msedgedriver release."
+        end
+
+        "#{msg} Please set `Webdrivers::Edgedriver.required_version = <desired driver version>` "\
+        "to a known edgedriver version: Can not reach #{base_url}"
+      end
+
+      def file_name
+        System.platform == 'win' ? 'msedgedriver.exe' : 'msedgedriver'
+      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"
+        Webdrivers.logger.debug "msedgedriver URL: #{url}"
+        @download_url = url
+      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

data/lib/webdrivers/system.rb

@@ -2,6 +2,7 @@
 
 require 'rubygems/package'
 require 'zip'
+require 'English'
 
 module Webdrivers
   #
@@ -89,7 +90,7 @@ module Webdrivers
         when /tar\.bz2$/
           untarbz2_file(tempfile)
         when /\.zip$/
-          unzip_file(tempfile)
+          unzip_file(tempfile, File.basename(target))
         else
           Webdrivers.logger.debug 'No Decompression needed'
           FileUtils.cp(tempfile, File.join(Dir.pwd, file_name))
@@ -114,19 +115,17 @@ module Webdrivers
         end
       end
 
-      def unzip_file(filename)
+      def unzip_file(filename, driver_name)
         Webdrivers.logger.debug "Decompressing #{filename}"
 
         Zip::File.open(filename) do |zip_file|
-          zip_file.each do |f|
-            @top_path ||= f.name
-            f_path = File.join(Dir.pwd, f.name)
-            delete(f_path)
-            FileUtils.mkdir_p(File.dirname(f_path)) unless File.exist?(File.dirname(f_path))
-            zip_file.extract(f, f_path)
-          end
+          driver = zip_file.get_entry(driver_name)
+          f_path = File.join(Dir.pwd, 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)
         end
-        @top_path
+        driver_name
       end
 
       def platform
@@ -145,15 +144,16 @@ module Webdrivers
         Selenium::WebDriver::Platform.bitsize
       end
 
-      def call(cmd)
+      def call(process, arg = nil)
+        cmd = arg ? [process, arg] : process # Windows provides powershell command (process) only, no args.
         Webdrivers.logger.debug "making System call: #{cmd}"
-        `#{cmd}`
-      end
-
-      def escape_path(path)
-        return path.tr('/', '\\') if platform == 'win' # Windows
+        p = IO.popen(cmd)
+        out = p.read
+        p.close
+        raise "Failed to make system call: #{cmd}" unless $CHILD_STATUS.success?
 
-        Shellwords.escape(path) # Linux and macOS
+        Webdrivers.logger.debug "System call returned: #{out}"
+        out
       end
     end
   end

data/lib/webdrivers/tasks/chromedriver.rake

@@ -19,8 +19,6 @@ namespace :webdrivers do
     desc 'Remove and download updated chromedriver if necessary'
     task :update, [:version] do |_, args|
       args.with_defaults(version: 0)
-      Webdrivers.cache_time                     = ENV.fetch('WD_CACHE_TIME', 86_400)
-      Webdrivers.install_dir                    = ENV.fetch('WD_INSTALL_DIR', nil)
       Webdrivers::Chromedriver.required_version = args.version
       Webdrivers::Chromedriver.update
       Webdrivers.logger.info "Updated to chromedriver #{Webdrivers::Chromedriver.current_version}"

data/lib/webdrivers/tasks/edgedriver.rake

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+namespace :webdrivers do
+  require 'webdrivers/edgedriver'
+
+  namespace :edgedriver do
+    Webdrivers.logger.level = :info
+
+    desc 'Print current edgedriver version'
+    task :version do
+      gem_ver = Webdrivers::Edgedriver.current_version
+      if gem_ver
+        Webdrivers.logger.info "edgedriver #{gem_ver.version}"
+      else
+        Webdrivers.logger.warn 'No existing edgedriver found.'
+      end
+    end
+
+    desc 'Remove and download updated edgedriver if necessary'
+    task :update, [:version] do |_, args|
+      args.with_defaults(version: 0)
+      Webdrivers::Edgedriver.required_version = args.version
+      Webdrivers::Edgedriver.update
+      Webdrivers.logger.info "Updated to edgedriver #{Webdrivers::Edgedriver.current_version}"
+    end
+
+    desc 'Force remove edgedriver'
+    task :remove do
+      unless File.exist? Webdrivers::Edgedriver.driver_path
+        Webdrivers.logger.info 'No existing edgedriver to remove.'
+        next # Return early
+      end
+
+      cur_version = Webdrivers::Edgedriver.current_version
+      Webdrivers::Edgedriver.remove
+
+      if File.exist? Webdrivers::Edgedriver.driver_path # Failed for some reason
+        Webdrivers.logger.error 'Failed to remove edgedriver. Please try removing manually.'
+      else
+        Webdrivers.logger.info "Removed edgedriver #{cur_version}."
+      end
+    end
+  end
+end

data/lib/webdrivers/tasks/geckodriver.rake

@@ -19,8 +19,6 @@ namespace :webdrivers do
     desc 'Remove and download updated geckodriver if necessary'
     task :update, [:version] do |_, args|
       args.with_defaults(version: 0)
-      Webdrivers.cache_time                    = ENV.fetch('WD_CACHE_TIME', 86_400)
-      Webdrivers.install_dir                   = ENV.fetch('WD_INSTALL_DIR', nil)
       Webdrivers::Geckodriver.required_version = args.version
       Webdrivers::Geckodriver.update
       Webdrivers.logger.info "Updated to geckodriver #{Webdrivers::Geckodriver.current_version}"

data/lib/webdrivers/tasks/iedriver.rake

@@ -19,8 +19,6 @@ namespace :webdrivers do
     desc 'Remove and download updated IEDriverServer if necessary'
     task :update, [:version] do |_, args|
       args.with_defaults(version: 0)
-      Webdrivers.cache_time                 = ENV.fetch('WD_CACHE_TIME', 86_400)
-      Webdrivers.install_dir                = ENV.fetch('WD_INSTALL_DIR', nil)
       Webdrivers::IEdriver.required_version = args.version
       Webdrivers::IEdriver.update
       Webdrivers.logger.info "Updated to IEDriverServer #{Webdrivers::IEdriver.current_version}"

data/lib/webdrivers/version.rb

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

data/spec/webdrivers/chrome_finder_spec.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Webdrivers::ChromeFinder do
+  let(:chrome_finder) { described_class }
+
+  context 'when the user relies on the gem to figure out the location of Chrome' do
+    it 'determines the location correctly based on the current OS' do
+      expect(chrome_finder.location).not_to be_nil
+    end
+  end
+
+  context 'when the user provides a path to the Chrome binary' do
+    it 'uses Selenium::WebDriver::Chrome.path when it is defined' do
+      Selenium::WebDriver::Chrome.path = chrome_finder.location
+      allow(chrome_finder).to receive(:win_location)
+      allow(chrome_finder).to receive(:mac_location)
+      allow(chrome_finder).to receive(:linux_location)
+      expect(chrome_finder.version).not_to be_nil
+      expect(chrome_finder).not_to have_received(:win_location)
+      expect(chrome_finder).not_to have_received(:mac_location)
+      expect(chrome_finder).not_to have_received(:linux_location)
+    end
+
+    it "uses ENV['WD_CHROME_PATH'] when it is defined" do
+      allow(ENV).to receive(:[]).with('WD_CHROME_PATH').and_return(chrome_finder.location)
+      allow(chrome_finder).to receive(:win_location)
+      allow(chrome_finder).to receive(:mac_location)
+      allow(chrome_finder).to receive(:linux_location)
+      expect(chrome_finder.version).not_to be_nil
+      expect(chrome_finder).not_to have_received(:win_location)
+      expect(chrome_finder).not_to have_received(:mac_location)
+      expect(chrome_finder).not_to have_received(:linux_location)
+    end
+
+    it 'uses Selenium::WebDriver::Chrome.path over WD_CHROME_PATH' do
+      Selenium::WebDriver::Chrome.path = chrome_finder.location
+      allow(ENV).to receive(:[]).with('WD_CHROME_PATH').and_return('my_wd_chrome_path')
+      expect(chrome_finder.version).not_to be_nil
+      expect(ENV).not_to have_received(:[]).with('WD_CHROME_PATH')
+    end
+  end
+end