webdrivers 4.1.0 → 4.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c836de6a779887c856d52f673efe3aa222046c32d50386f195c31e1c1f37ac4f
-  data.tar.gz: 972c301f2b3176ad1629820779bff1174043858160e36c56f57522f263458284
+  metadata.gz: e9d16f809899161b5099baae7ca53e6d71d376083fe3cecf0278acef552605ec
+  data.tar.gz: 3c4dcab7d0e285716adfe50d0e78a172e9cab65202192c02726df3790d7b96b3
 SHA512:
-  metadata.gz: 89f7b359fe431e1fe4092baf2867049af4876df5f38f6edc8e7b91fc22bd2a8b7f81e6ea5492c97778453f9e532e4756f5102cc0b90e9954c9b4345e1b0e697f
-  data.tar.gz: 4c237d64c244c3e62581179b57c58d3961412ea1577d2a57f9c636c86b280db61496a156a28a341b7d6155136c855b38bc034efcc464370c9a6dc543d6a0b808
+  metadata.gz: 9123c087f485c843954414de9004c137bb5a7fc1619ad4bc4fc9ec79ce5ed2433f6377994347a46bd06d96f7dd69049192c8631363608088f30159f2fae2b33b
+  data.tar.gz: af36c0d87ffad38e87dea124abc387e79bdc2fc5127fee456d3992e6c19f912a8943d5cdb11ec8d6600ed41f92c2fa8f3f018a2a4a34e76c1338cf5ee25b5068

data/.travis.yml

@@ -24,6 +24,7 @@ matrix:
     - rvm: 2.4.6
       env: RAKE_TASK=rubocop
     - rvm: jruby-9.2.7.0
+      jdk: openjdk8
       env: RAKE_TASK=spec
     - rvm: 2.6
       env: RAKE_TASK=spec
@@ -35,6 +36,6 @@ matrix:
         homebrew:
           taps: homebrew/cask-versions
           casks:
-            - microsoft-edge-canary
+            - microsoft-edge-dev
   allow_failures:
     - gemfile: gemfiles/Gemfile.edge

data/CHANGELOG.md

@@ -1,4 +1,7 @@
-### 4.1.0 (2019-06-26)
+### 4.1.1 (2019-07-18)
+* Raise `BrowserNotFound` if Chrome and Edge binary are not found (issue [#144](https://github.com/titusfortner/webdrivers/issues/144)).
+
+### 4.1.0 (2019-07-03)
 * Add support for `msedgedriver` (issue [#93](https://github.com/titusfortner/webdrivers/issues/93))
 * Allow users to provide a custom binary path via `WD_CHROME_PATH` 
 and `WD_EDGE_CHROME_ATH` environment variables (issues #[137](https://github.com/titusfortner/webdrivers/issues/137) 

data/README.md

@@ -17,7 +17,7 @@ Run Selenium tests more easily with automatic installation and updates for all s
 
 ## Usage
 
-In your Gemfile: 
+In your Gemfile:
 
 `gem 'webdrivers', '~> 4.0'`
 
@@ -28,7 +28,7 @@ require 'webdrivers'
 ```
 
 The drivers will now be automatically downloaded or updated when you launch a browser
-through Selenium. 
+through Selenium.
 
 ### Specific Drivers
 
@@ -44,7 +44,7 @@ require 'webdrivers/edgedriver'
 ### Download Location
 
 The default download location is `~/.webdrivers` directory, and this is configurable:
- 
+
  ```ruby
  Webdrivers.install_dir = '/webdrivers/install/dir'
 ```
@@ -54,7 +54,7 @@ variable.
 
 ### Version Pinning
 
-If you would like to use a specific (older or beta) version, you can specify it for each driver. Otherwise, 
+If you would like to use a specific (older or beta) version, you can specify it for each driver. Otherwise,
 the latest (stable) driver will be downloaded and passed to Selenium.
 
 ```ruby
@@ -92,9 +92,9 @@ 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 
+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.
 
 ### Proxy
@@ -114,7 +114,7 @@ end
 ### `SSL_connect` errors
 
 If you are getting an error like this (especially common on Windows):
- 
+
 `SSL_connect returned=1 errno=0 state=SSLv3 read server certificate B: certificate verify failed`
 
 Add the following to your Gemfile:
@@ -134,10 +134,26 @@ Other solutions are documented on the RubyGems [website](https://guides.rubygems
 ### Rake tasks
 
 Each driver has its own set of `rake` tasks (with `Railtie` support) that
-you can call once before executing the tests. These are especially 
-useful if you're running tests in parallel and want to avoid performing 
+you can call once before executing the tests. These are especially
+useful if you're running tests in parallel and want to avoid performing
 an update check per thread.
 
+If you are using Rails default configuration the `webdrivers` gem will only be loaded in the test group
+so you will need to specify the test environment when using the tasks:
+
+```ruby
+RAILS_ENV=test rails webdrivers:chromedriver:update
+```
+
+If you are not using Rails, you'll need to load them into your Rakefile like this:
+
+```ruby
+require 'webdrivers'
+load 'webdrivers/Rakefile'
+```
+
+The full list of available tasks is:
+
 ```bash
 $ bundle exec rake -T
 rake webdrivers:chromedriver:remove           # Force remove chromedriver
@@ -154,15 +170,8 @@ rake webdrivers:iedriver:update[version]      # Remove and download updated IEDr
 rake webdrivers:iedriver:version              # Print current IEDriverServer version
 ```
 
-If you are not using Rails, you'll need to load them into your Rakefile like this:
-
-```ruby
-require 'webdrivers'
-load 'webdrivers/Rakefile'
-```
-
 These tasks respect the `WD_INSTALL_DIR`, `WD_CACHE_TIME`, `WD_CHROME_PATH`,
-and `WD_EDGE_CHROME_PATH` environment variables, which can also be passed 
+and `WD_EDGE_CHROME_PATH` environment variables, which can also be passed
 through the `rake` command:
 
 ```bash
@@ -185,17 +194,17 @@ Webdrivers.logger.level = :DEBUG
 
 ### Browser Specific Notes
 
-#### Chrome/Chromium 
+#### Chrome/Chromium
 
 The version of `chromedriver` will depend on the version of Chrome you are using it with:
 
- * For versions >= 70, the downloaded version of `chromedriver` will match the installed version of Google Chrome. 
+ * For versions >= 70, the downloaded version of `chromedriver` will match the installed version of Google Chrome.
  More information [here](http://chromedriver.chromium.org/downloads/version-selection).
  * For versions <=  69, `chromedriver` version 2.41 will be downloaded.
- * For beta versions, you'll have to require the beta version of `chromedriver` 
+ * For beta versions, you'll have to require the beta version of `chromedriver`
  using `Webdrivers::Chromedriver.required_version`.
- 
-The gem looks for the Chrome/Chromium version that `chromedriver` will use by default. 
+
+The gem looks for the Chrome/Chromium version that `chromedriver` will use by default.
 You can override this behavior by providing a path to the browser binary you want to use:
 
 ```ruby
@@ -205,26 +214,26 @@ Selenium::WebDriver::Chrome.path = '/chromium/install/path/to/binary'
 Alternatively, you can define the path via the `WD_CHROME_PATH` environment
 variable.
 
-This is also required if Google Chrome is not installed in its 
+This is also required if Google Chrome is not installed in its
 [default location](https://github.com/SeleniumHQ/selenium/wiki/ChromeDriver).
 
 ##### CircleCI Users
 
-Follow the specific instructions [here](https://github.com/titusfortner/webdrivers/wiki/Heroku-buildpack-google-chrome) if your CI environment provides custom shims for Chrome or Chromium. 
+Follow the specific instructions [here](https://github.com/titusfortner/webdrivers/wiki/Heroku-buildpack-google-chrome) if your CI environment provides custom shims for Chrome or Chromium.
 
 Please note that as of 06/21/2019, [`heroku-buildpack-google-chrome`](https://github.com/heroku/heroku-buildpack-google-chrome/pull/73) no longer requires this workaround.
 
 #### Microsoft Edge (Chromium)
 
-Microsoft Edge (Chromium) support was added in v4.1.0. Notes 
-from the [Chrome/Chromium](https://github.com/titusfortner/webdrivers#chromechromium) 
+Microsoft Edge (Chromium) support was added in v4.1.0. Notes
+from the [Chrome/Chromium](https://github.com/titusfortner/webdrivers#chromechromium)
 section apply to this browser as well.
-  
+
 Please note that `msedgedriver` requires `selenium-webdriver` v4.
 
 ## Wiki
 
-Please see the [wiki](https://github.com/titusfortner/webdrivers/wiki) 
+Please see the [wiki](https://github.com/titusfortner/webdrivers/wiki)
 for solutions to commonly reported issues.
 
 Join us in the `#webdrivers-gem` channel on [Slack](https://seleniumhq.herokuapp.com/)
@@ -237,5 +246,5 @@ see LICENSE.txt for full details and copyright.
 
 ## Contributing
 
-Bug reports and pull requests are welcome [on GitHub](https://github.com/titusfortner/webdrivers). 
+Bug reports and pull requests are welcome [on GitHub](https://github.com/titusfortner/webdrivers).
 Run `bundle exec rake` and squash the commits in your PRs.

data/lib/webdrivers/chrome_finder.rb

@@ -8,15 +8,17 @@ module Webdrivers
     class << self
       def version
         version = send("#{System.platform}_version", location)
-
-        raise VersionError, 'Failed to find Chrome binary or its version.' if version.nil? || version.empty?
+        raise VersionError, 'Failed to find Chrome version.' if version.nil? || version.empty?
 
         Webdrivers.logger.debug "Browser version: #{version}"
         version[/\d+\.\d+\.\d+\.\d+/] # Google Chrome 73.0.3683.75 -> 73.0.3683.75
       end
 
       def location
-        user_defined_location || send("#{System.platform}_location")
+        chrome_bin = user_defined_location || send("#{System.platform}_location")
+        return chrome_bin unless chrome_bin.nil?
+
+        raise BrowserNotFound, 'Failed to find Chrome binary.'
       end
 
       private

data/lib/webdrivers/common.rb

@@ -18,6 +18,9 @@ module Webdrivers
   class NetworkError < StandardError
   end
 
+  class BrowserNotFound < StandardError
+  end
+
   DEFAULT_CACHE_TIME = 86_400 # 24 hours
   DEFAULT_INSTALL_DIR = File.expand_path(File.join(ENV['HOME'], '.webdrivers'))
 

data/lib/webdrivers/edge_finder.rb

@@ -8,15 +8,17 @@ module Webdrivers
     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?
+        raise VersionError, 'Failed to find Edge 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")
+        edge_bin = user_defined_location || send("#{System.platform}_location")
+        return edge_bin unless edge_bin.nil?
+
+        raise BrowserNotFound, 'Failed to find Edge binary.'
       end
 
       private

data/lib/webdrivers/version.rb

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

data/spec/webdrivers/chrome_finder_spec.rb

@@ -7,38 +7,44 @@ describe Webdrivers::ChromeFinder do
 
   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
+      expect { chrome_finder.location }.not_to raise_error
     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
+      locations = %i[win_location mac_location linux_location]
+      allow(chrome_finder).to receive_messages(locations)
 
-    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)
+      locations.each { |loc| expect(chrome_finder).not_to have_received(loc) }
     end
+  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')
+  it "uses ENV['WD_CHROME_PATH'] when it is defined" do
+    allow(ENV).to receive(:[]).with('WD_CHROME_PATH').and_return(chrome_finder.location)
+    locations = %i[win_location mac_location linux_location]
+    allow(chrome_finder).to receive_messages(locations)
+
+    expect(chrome_finder.version).not_to be_nil
+    locations.each { |loc| expect(chrome_finder).not_to have_received(loc) }
+  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
+
+  context 'when Chrome is not installed' do
+    it 'raises BrowserNotFound' do
+      locations = %i[win_location mac_location linux_location]
+      allow(chrome_finder).to receive_messages(locations)
+      allow(chrome_finder).to receive(:user_defined_location).and_return(nil)
+
+      expect { chrome_finder.version }.to raise_error(Webdrivers::BrowserNotFound)
     end
   end
 end

data/spec/webdrivers/edge_finder_spec.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+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
+
+  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
+      expect { edge_finder.location }.not_to raise_error
+    end
+  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
+      locations = %i[win_location mac_location linux_location]
+      allow(edge_finder).to receive_messages(locations)
+
+      expect(edge_finder.version).not_to be_nil
+      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)
+      locations = %i[win_location mac_location linux_location]
+      allow(edge_finder).to receive_messages(locations)
+
+      expect(edge_finder.version).not_to be_nil
+      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')
+      expect(edge_finder.version).not_to be_nil
+      expect(ENV).not_to have_received(:[]).with('WD_EDGE_CHROME_PATH')
+    end
+  end
+
+  context 'when Edge is not installed' do
+    it 'raises BrowserNotFound' do
+      locations = %i[win_location mac_location linux_location]
+      allow(edge_finder).to receive_messages(locations)
+      allow(edge_finder).to receive(:user_defined_location).and_return(nil)
+
+      expect { edge_finder.version }.to raise_error(Webdrivers::BrowserNotFound)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: webdrivers
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.1.1
 platform: ruby
 authors:
 - Titus Fortner
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-03 00:00:00.000000000 Z
+date: 2019-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -213,6 +213,7 @@ files:
 - spec/spec_helper.rb
 - spec/webdrivers/chrome_finder_spec.rb
 - spec/webdrivers/chromedriver_spec.rb
+- spec/webdrivers/edge_finder_spec.rb
 - spec/webdrivers/edgedriver_spec.rb
 - spec/webdrivers/geckodriver_spec.rb
 - spec/webdrivers/i_edriver_spec.rb