webdrivers 4.0.1 → 4.1.0

data/spec/webdrivers/chromedriver_spec.rb

@@ -31,7 +31,7 @@ describe Webdrivers::Chromedriver do
       it 'does not download when offline, binary exists and matches major browser version' do
         allow(Net::HTTP).to receive(:get_response).and_raise(SocketError)
         allow(chromedriver).to receive(:exists?).and_return(true)
-        allow(chromedriver).to receive(:chrome_version).and_return(Gem::Version.new('73.0.3683.68'))
+        allow(chromedriver).to receive(:browser_version).and_return(Gem::Version.new('73.0.3683.68'))
         allow(chromedriver).to receive(:current_version).and_return(Gem::Version.new('73.0.3683.20'))
 
         chromedriver.update
@@ -44,7 +44,7 @@ describe Webdrivers::Chromedriver do
 
         allow(Webdrivers::Network).to receive(:get_response).and_return(client_error)
         allow(chromedriver).to receive(:exists?).and_return(true)
-        allow(chromedriver).to receive(:chrome_version).and_return(Gem::Version.new('73.0.3683.68'))
+        allow(chromedriver).to receive(:browser_version).and_return(Gem::Version.new('73.0.3683.68'))
         allow(chromedriver).to receive(:current_version).and_return(Gem::Version.new('73.0.3683.20'))
 
         chromedriver.update
@@ -55,7 +55,7 @@ describe Webdrivers::Chromedriver do
       it 'raises ConnectionError when offline, and binary does not match major browser version' do
         allow(Net::HTTP).to receive(:get_response).and_raise(SocketError)
         allow(chromedriver).to receive(:exists?).and_return(true)
-        allow(chromedriver).to receive(:chrome_version).and_return(Gem::Version.new('73.0.3683.68'))
+        allow(chromedriver).to receive(:browser_version).and_return(Gem::Version.new('73.0.3683.68'))
         allow(chromedriver).to receive(:current_version).and_return(Gem::Version.new('72.0.0.0'))
 
         msg = %r{Can not reach https://chromedriver.storage.googleapis.com}
@@ -108,7 +108,7 @@ describe Webdrivers::Chromedriver do
 
     it 'makes a network call if cached driver does not match the browser' do
       Webdrivers::System.cache_version('chromedriver', '71.0.3578.137')
-      allow(chromedriver).to receive(:chrome_version).and_return(Gem::Version.new('73.0.3683.68'))
+      allow(chromedriver).to receive(:browser_version).and_return(Gem::Version.new('73.0.3683.68'))
       allow(Webdrivers::Network).to receive(:get).and_return('73.0.3683.68')
       allow(Webdrivers::System).to receive(:download)
 
@@ -146,7 +146,7 @@ describe Webdrivers::Chromedriver do
     it 'returns a Gem::Version instance if binary is on the system' do
       allow(chromedriver).to receive(:exists?).and_return(true)
       allow(Webdrivers::System).to receive(:call)
-        .with("#{chromedriver.driver_path} --version")
+        .with(chromedriver.driver_path, '--version')
         .and_return '71.0.3578.137'
 
       expect(chromedriver.current_version).to eq Gem::Version.new('71.0.3578.137')
@@ -155,19 +155,19 @@ describe Webdrivers::Chromedriver do
 
   describe '#latest_version' do
     it 'returns 2.41 if the browser version is less than 70' do
-      allow(chromedriver).to receive(:chrome_version).and_return('69.0.0')
+      allow(chromedriver).to receive(:browser_version).and_return('69.0.0')
 
       expect(chromedriver.latest_version).to eq(Gem::Version.new('2.41'))
     end
 
     it 'returns the correct point release for a production version greater than 70' do
-      allow(chromedriver).to receive(:chrome_version).and_return '71.0.3578.9999'
+      allow(chromedriver).to receive(:browser_version).and_return '71.0.3578.9999'
 
       expect(chromedriver.latest_version).to eq Gem::Version.new('71.0.3578.137')
     end
 
     it 'raises VersionError for beta version' do
-      allow(chromedriver).to receive(:chrome_version).and_return('100.0.0')
+      allow(chromedriver).to receive(:browser_version).and_return('100.0.0')
       msg = 'Unable to find latest point release version for 100.0.0. '\
 'You appear to be using a non-production version of Chrome. '\
 'Please set `Webdrivers::Chromedriver.required_version = <desired driver version>` '\
@@ -177,7 +177,7 @@ describe Webdrivers::Chromedriver do
     end
 
     it 'raises VersionError for unknown version' do
-      allow(chromedriver).to receive(:chrome_version).and_return('72.0.9999.0000')
+      allow(chromedriver).to receive(:browser_version).and_return('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'
@@ -253,8 +253,19 @@ describe Webdrivers::Chromedriver do
   describe '#driver_path' do
     it 'returns full location of binary' do
       expected_bin = "chromedriver#{'.exe' if Selenium::WebDriver::Platform.windows?}"
-      expected_path = Webdrivers::System.escape_path("#{File.join(ENV['HOME'])}/.webdrivers/#{expected_bin}")
+      expected_path = File.absolute_path "#{File.join(ENV['HOME'])}/.webdrivers/#{expected_bin}"
       expect(chromedriver.driver_path).to eq(expected_path)
     end
   end
+
+  describe '#browser_version' do
+    it 'returns a Gem::Version object' do
+      expect(chromedriver.browser_version).to be_an_instance_of(Gem::Version)
+    end
+
+    it 'returns currently installed Chrome version' do
+      allow(Webdrivers::ChromeFinder).to receive(:version).and_return('72.0.0.0')
+      expect(chromedriver.browser_version).to be Gem::Version.new('72.0.0.0')
+    end
+  end
 end

data/spec/webdrivers/edgedriver_spec.rb

@@ -0,0 +1,276 @@
+# frozen_string_literal: true
+
+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
+  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
+        allow(edgedriver).to receive(:latest_version).and_return(Gem::Version.new('72.0.0'))
+        allow(edgedriver).to receive(:current_version).and_return(Gem::Version.new('72.0.0'))
+
+        edgedriver.update
+
+        expect(edgedriver.send(:exists?)).to be false
+      end
+
+      it 'does not download when offline, binary exists and is less than v70' do
+        allow(Net::HTTP).to receive(:get_response).and_raise(SocketError)
+        allow(edgedriver).to receive(:exists?).and_return(true)
+        allow(edgedriver).to receive(:current_version).and_return(Gem::Version.new(69))
+
+        edgedriver.update
+
+        expect(File.exist?(edgedriver.driver_path)).to be false
+      end
+
+      it 'does not download when offline, binary exists and matches major browser version' do
+        allow(Net::HTTP).to receive(:get_response).and_raise(SocketError)
+        allow(edgedriver).to receive(:exists?).and_return(true)
+        allow(edgedriver).to receive(:browser_version).and_return(Gem::Version.new('73.0.3683.68'))
+        allow(edgedriver).to receive(:current_version).and_return(Gem::Version.new('73.0.3683.20'))
+
+        edgedriver.update
+
+        expect(File.exist?(edgedriver.driver_path)).to be false
+      end
+
+      it 'does not download when get raises exception, binary exists and matches major browser version' do
+        client_error = instance_double(Net::HTTPNotFound, class: Net::HTTPNotFound, code: 404, message: '')
+
+        allow(Webdrivers::Network).to receive(:get_response).and_return(client_error)
+        allow(edgedriver).to receive(:exists?).and_return(true)
+        allow(edgedriver).to receive(:browser_version).and_return(Gem::Version.new('73.0.3683.68'))
+        allow(edgedriver).to receive(:current_version).and_return(Gem::Version.new('73.0.3683.20'))
+
+        edgedriver.update
+
+        expect(File.exist?(edgedriver.driver_path)).to be false
+      end
+
+      it 'raises ConnectionError when offline, and binary does not match major browser version' do
+        allow(Net::HTTP).to receive(:get_response).and_raise(SocketError)
+        allow(edgedriver).to receive(:exists?).and_return(true)
+        allow(edgedriver).to receive(:browser_version).and_return(Gem::Version.new('73.0.3683.68'))
+        allow(edgedriver).to receive(:current_version).and_return(Gem::Version.new('72.0.0.0'))
+
+        msg = %r{Can not reach https://msedgedriver.azureedge.net/}
+        expect { edgedriver.update }.to raise_error(Webdrivers::ConnectionError, msg)
+      end
+
+      it 'raises ConnectionError when offline, and no binary exists' do
+        allow(Net::HTTP).to receive(:get_response).and_raise(SocketError)
+        allow(edgedriver).to receive(:exists?).and_return(false)
+
+        msg = %r{Can not reach https://msedgedriver.azureedge.net/}
+        expect { edgedriver.update }.to raise_error(Webdrivers::ConnectionError, msg)
+      end
+    end
+
+    context 'when correct binary is found' do
+      before { allow(edgedriver).to receive(:correct_binary?).and_return(true) }
+
+      it 'does not download' do
+        edgedriver.update
+
+        expect(edgedriver.current_version).to be_nil
+      end
+
+      it 'does not raise exception if offline' do
+        allow(Net::HTTP).to receive(:get_response).and_raise(SocketError)
+
+        edgedriver.update
+
+        expect(edgedriver.current_version).to be_nil
+      end
+    end
+
+    context 'when correct binary is not found' do
+      before { allow(edgedriver).to receive(:correct_binary?).and_return(false) }
+
+      it 'downloads binary' do
+        edgedriver.update
+
+        expect(edgedriver.current_version).not_to be_nil
+      end
+
+      it 'raises ConnectionError if offline' do
+        allow(Net::HTTP).to receive(:get_response).and_raise(SocketError)
+
+        msg = %r{Can not reach https://msedgedriver.azureedge.net/}
+        expect { edgedriver.update }.to raise_error(Webdrivers::ConnectionError, msg)
+      end
+    end
+
+    it 'makes a network call if cached driver does not match the browser' do
+      Webdrivers::System.cache_version('msedgedriver', '71.0.3578.137')
+      allow(edgedriver).to receive(:browser_version).and_return(Gem::Version.new('73.0.3683.68'))
+      allow(Webdrivers::Network).to receive(:get).and_return('73.0.3683.68'.encode('UTF-16'))
+      allow(Webdrivers::System).to receive(:download)
+
+      edgedriver.update
+
+      expect(Webdrivers::Network).to have_received(:get).once
+    end
+
+    context 'when required version is 0' do
+      it 'downloads the latest version' do
+        allow(edgedriver).to receive(:latest_version).and_return(Gem::Version.new('77.0.207.0'))
+        edgedriver.required_version = 0
+        edgedriver.update
+        expect(edgedriver.current_version.version).to eq('77.0.207.0')
+      end
+    end
+
+    context 'when required version is nil' do
+      it 'downloads the latest version' do
+        allow(edgedriver).to receive(:latest_version).and_return(Gem::Version.new('77.0.207.0'))
+        edgedriver.required_version = nil
+        edgedriver.update
+        expect(edgedriver.current_version.version).to eq('77.0.207.0')
+      end
+    end
+  end
+
+  describe '#current_version' do
+    it 'returns nil if binary does not exist on the system' do
+      allow(edgedriver).to receive(:driver_path).and_return('')
+
+      expect(edgedriver.current_version).to be_nil
+    end
+
+    it 'returns a Gem::Version instance if binary is on the system' do
+      allow(edgedriver).to receive(:exists?).and_return(true)
+      allow(Webdrivers::System).to receive(:call)
+        .with(edgedriver.driver_path, '--version')
+        .and_return '71.0.3578.137'
+
+      expect(edgedriver.current_version).to eq Gem::Version.new('71.0.3578.137')
+    end
+  end
+
+  describe '#latest_version' do
+    it 'returns the correct point release for a production version' do
+      allow(edgedriver).to receive(:browser_version).and_return '77.0.207.0'
+
+      expect(edgedriver.latest_version).to be_between(Gem::Version.new('77.0.207.0'), Gem::Version.new('78'))
+    end
+
+    it 'raises VersionError for beta version' do
+      allow(edgedriver).to receive(:browser_version).and_return('100.0.0')
+      msg = 'Unable to find latest point release version for 100.0.0. '\
+'You appear to be using a non-production version of Edge. '\
+'Please set `Webdrivers::Edgedriver.required_version = <desired driver version>` '\
+'to a known edgedriver version: Can not reach https://msedgedriver.azureedge.net/'
+
+      expect { edgedriver.latest_version }.to raise_exception(Webdrivers::VersionError, msg)
+    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')
+      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/'
+
+      expect { edgedriver.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)
+
+      msg = %r{^Can not reach https://msedgedriver.azureedge.net}
+      expect { edgedriver.latest_version }.to raise_error(Webdrivers::ConnectionError, msg)
+    end
+
+    it 'creates cached file' do
+      allow(edgedriver).to receive(:browser_version).and_return('77.0.207.0')
+      allow(Webdrivers::Network).to receive(:get).and_return('77.0.207.0'.encode('UTF-16'))
+
+      edgedriver.latest_version
+      expect(File.exist?("#{Webdrivers::System.install_dir}/msedgedriver.version")).to eq true
+    end
+
+    it 'does not make network call if cache is valid' do
+      allow(Webdrivers).to receive(:cache_time).and_return(3600)
+      Webdrivers::System.cache_version('msedgedriver', '77.0.207.0')
+      allow(Webdrivers::Network).to receive(:get)
+
+      expect(edgedriver.latest_version).to eq Gem::Version.new('77.0.207.0')
+
+      expect(Webdrivers::Network).not_to have_received(:get)
+    end
+
+    it 'makes a network call if cache is expired' do
+      Webdrivers::System.cache_version('msedgedriver', '71.0.3578.137')
+      allow(Webdrivers::Network).to receive(:get).and_return('77.0.207.0'.encode('UTF-16'))
+      allow(Webdrivers::System).to receive(:valid_cache?)
+      allow(edgedriver).to receive(:browser_version).and_return('77.0.207.0')
+
+      expect(edgedriver.latest_version).to eq Gem::Version.new('77.0.207.0')
+
+      expect(Webdrivers::Network).to have_received(:get)
+      expect(Webdrivers::System).to have_received(:valid_cache?)
+    end
+  end
+
+  describe '#required_version=' do
+    after { edgedriver.required_version = nil }
+
+    it 'returns the version specified as a Float' do
+      edgedriver.required_version = 73.0
+
+      expect(edgedriver.required_version).to eq Gem::Version.new('73.0')
+    end
+
+    it 'returns the version specified as a String' do
+      edgedriver.required_version = '73.0'
+
+      expect(edgedriver.required_version).to eq Gem::Version.new('73.0')
+    end
+  end
+
+  describe '#remove' do
+    it 'removes existing edgedriver' do
+      edgedriver.update
+
+      edgedriver.remove
+      expect(edgedriver.current_version).to be_nil
+    end
+
+    it 'does not raise exception if no edgedriver found' do
+      expect { edgedriver.remove }.not_to raise_error
+    end
+  end
+
+  describe '#driver_path' do
+    it 'returns full location of binary' do
+      expected_bin = "msedgedriver#{'.exe' if Selenium::WebDriver::Platform.windows?}"
+      expected_path = File.absolute_path "#{File.join(ENV['HOME'])}/.webdrivers/#{expected_bin}"
+      expect(edgedriver.driver_path).to eq(expected_path)
+    end
+  end
+
+  describe '#browser_version' do
+    it 'returns a Gem::Version object' do
+      expect(edgedriver.browser_version).to be_an_instance_of(Gem::Version)
+    end
+
+    it 'returns currently installed Edge version' do
+      allow(Webdrivers::EdgeFinder).to receive(:version).and_return('72.0.0.0')
+      expect(edgedriver.browser_version).to be Gem::Version.new('72.0.0.0')
+    end
+  end
+end

data/spec/webdrivers/geckodriver_spec.rb

@@ -112,7 +112,7 @@ testing/geckodriver in https://hg.mozilla.org/mozilla-central.
 This program is subject to the terms of the Mozilla Public License 2.0.
 You can obtain a copy of the license at https://mozilla.org/MPL/2.0/"
 
-      allow(Webdrivers::System).to receive(:call).with("#{geckodriver.driver_path} --version").and_return return_value
+      allow(Webdrivers::System).to receive(:call).with(geckodriver.driver_path, '--version').and_return return_value
 
       expect(geckodriver.current_version).to eq Gem::Version.new('0.24.0')
     end
@@ -205,7 +205,7 @@ You can obtain a copy of the license at https://mozilla.org/MPL/2.0/"
   describe '#driver_path' do
     it 'returns full location of binary' do
       expected_bin = "geckodriver#{'.exe' if Selenium::WebDriver::Platform.windows?}"
-      expected_path = Webdrivers::System.escape_path("#{File.join(ENV['HOME'])}/.webdrivers/#{expected_bin}")
+      expected_path = File.absolute_path "#{File.join(ENV['HOME'])}/.webdrivers/#{expected_bin}"
       expect(geckodriver.driver_path).to eq(expected_path)
     end
   end

data/spec/webdrivers/i_edriver_spec.rb

@@ -87,7 +87,7 @@ describe Webdrivers::IEdriver do
 
       return_value = 'something IEDriverServer.exe 3.5.1 something else'
 
-      allow(Webdrivers::System).to receive(:call).with("#{iedriver.driver_path} --version").and_return return_value
+      allow(Webdrivers::System).to receive(:call).with(iedriver.driver_path, '--version').and_return return_value
 
       expect(iedriver.current_version).to eq Gem::Version.new('3.5.1')
     end
@@ -186,7 +186,7 @@ describe Webdrivers::IEdriver do
 
   describe '#driver_path' do
     it 'returns full location of binary' do
-      expected_path = Webdrivers::System.escape_path("#{File.join(ENV['HOME'])}/.webdrivers/IEDriverServer.exe")
+      expected_path = File.absolute_path "#{File.join(ENV['HOME'])}/.webdrivers/IEDriverServer.exe"
       expect(iedriver.driver_path).to eq(expected_path)
     end
   end

data/spec/webdrivers/webdrivers_spec.rb

@@ -29,15 +29,15 @@ describe Webdrivers do
     end
 
     context 'when ENV variable WD_CACHE_TIME is set' do
-      before { described_class.cache_time = 86_400 }
+      before { described_class.cache_time = 3600 }
 
-      it 'uses cache time value from ENV variable over the Webdrivers.cache_time value' do
-        allow(ENV).to receive(:[]).with('WD_CACHE_TIME').and_return(999)
-        expect(described_class.cache_time).to be(999)
+      it 'uses cache time value from Webdrivers.cache_time over the ENV variable value' do
+        allow(ENV).to receive(:[]).with('WD_CACHE_TIME').and_return(900)
+        expect(described_class.cache_time).to be(3600)
       end
 
       it 'returns cache time as an Integer' do
-        allow(ENV).to receive(:fetch).with('WD_CACHE_TIME', 86_400).and_return('999')
+        allow(ENV).to receive(:fetch).with('WD_CACHE_TIME', 3600).and_return('999')
         expect(described_class.cache_time).to be_an_instance_of(Integer)
       end
     end
@@ -70,5 +70,17 @@ describe Webdrivers do
         end
       end
     end
+
+    context 'when both ENV variable WD_INSTALL_DIR and Webdrivers.install_dir are set' do
+      it 'uses path from Webdrivers.install_dir' do
+        begin
+          described_class.install_dir = 'my_install_dir_path'
+          allow(ENV).to receive(:[]).with('WD_INSTALL_DIR').and_return('my_env_path')
+          expect(described_class.install_dir).to be('my_install_dir_path')
+        ensure
+          described_class.install_dir = nil
+        end
+      end
+    end
   end
 end

data/support/install_msedge.ps1

@@ -0,0 +1,17 @@
+$downloadDevLink = "https://go.microsoft.com/fwlink/?linkid=2069324&Channel=Dev&language=en-us&Consent=0&IID=85213fc4-6a13-57ae-9082-72910982ede8"
+$downloadCanaryLink = "https://go.microsoft.com/fwlink/?linkid=2084706&Channel=Canary&language=en-us&Consent=0&IID=85213fc4-6a13-57ae-9082-72910982ede8"
+$devSetup = "C:\MicrosoftEdgeSetupDev.exe"
+$canarySetup = "C:\MicrosoftEdgeSetupCanary.exe"
+
+#  Note: We're purposely skipping the -Wait flag in Start-Process.
+#  This is because Edge auto-launches after the setup is done and
+#  Start-Process continues to indefinitely wait on that process.
+Write-Host "Installing Microsoft Edge (Dev)..." -ForegroundColor cyan
+Invoke-WebRequest $downloadDevLink -OutFile $devSetup # Download Dev
+Start-Process $devSetup # Run installer
+Write-Host "Microsoft Edge (Dev) installed.`n" -ForegroundColor green
+
+Write-Host "Installing Microsoft Edge (Canary)..." -ForegroundColor cyan
+Invoke-WebRequest $downloadCanaryLink -OutFile $canarySetup # Download Canary
+Start-Process $canarySetup # Run installer
+Write-Host "Microsoft Edge (Canary) installed.`n" -ForegroundColor green