Run Selenium tests more easily with automatic installation and updates for all supported webdrivers.
webdrivers downloads drivers and directs Selenium to use them. Currently supports:
In your Gemfile:
gem 'webdrivers', '~> 4.0'
In your project:
The drivers will now be automatically downloaded or updated when you launch a browser through Selenium.
If you want webdrivers to only manage specific drivers you can specify one or more as follows:
require 'webdrivers/chromedriver' require 'webdrivers/geckodriver' require 'webdrivers/iedriver'
The default download location is
~/.webdrivers directory, and this is configurable:
. = '/webdrivers/install/dir'
Alternatively, you can define the path via the
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.
# Chrome ::. = '2.46' # Firefox ::. = '0.23.0' # Internet Explorer ::. = '3.14.0'
You can explicitly trigger the update in your code, but this will happen automatically when the driver is initialized:
You can set Webdrivers to only look for updates if the previous check was longer ago than a specified number of seconds.
. = 86_400
Alternatively, you can define this value via the
The default is set to 24 hours (86,400 seconds).
If there is a proxy between you and the Internet then you will need to configure
the gem to use the proxy. You can do this by calling the
. do |config| config.proxy_addr = 'myproxy_address.com' config.proxy_port = '8080' config.proxy_user = 'username' config.proxy_pass = 'password' end
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:
Add the following to your code:
Other solutions are documented on the RubyGems website.
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
an update check per thread.
$ bundle exec rake -T rake webdrivers:chromedriver:remove # Force remove chromedriver rake webdrivers:chromedriver:update[version] # Remove and download updated chromedriver if necessary rake webdrivers:chromedriver:version # Print current chromedriver version rake webdrivers:geckodriver:remove # Force remove geckodriver rake webdrivers:geckodriver:update[version] # Remove and download updated geckodriver if necessary rake webdrivers:geckodriver:version # Print current geckodriver version rake webdrivers:iedriver:remove # Force remove IEDriverServer rake webdrivers:iedriver:update[version] # Remove and download updated IEDriverServer if necessary rake webdrivers:iedriver:version # Print current IEDriverServer version
These tasks respect the
variables which can also be passed through the
$ bundle exec rake webdrivers:chromedriver:update[2.46] webdrivers:geckodriver:update[0.24.0] WD_CACHE_TIME=86_400 WD_INSTALL_DIR='my_dir' 2019-05-20 19:03:01 INFO Webdrivers Updated to chromedriver 2.46.628388 2019-05-20 19:03:04 INFO Webdrivers Updated to geckodriver 0.24.0
Please note that these tasks do not use any of the configurations from your
project (code) and only respect the
ENV variables and the version (optional)
passed to the
The logging level can be configured for debugging purpose:
..level = :DEBUG
Browser Specific Notes
The version of
chromedriver will depend on the version of Chrome you are using it with:
- For versions >= 70, the downloaded version of
chromedriverwill match the installed version of Google Chrome. More information here.
- For versions <= 69,
chromedriverversion 2.41 will be downloaded.
- For beta versions, you'll have to require the beta version of
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:
::::.path = '/chromium/install/path/to/binary'
This is also required if Google Chrome is not installed in its default location.
Follow the specific instructions here if your CI environment provides custom shims for Chrome or Chromium.
Microsoft Edge support for v18 and older has been removed for now, as it is currently unreliable. To use Microsoft Edge, please visit the Downloads and Installation page.
Please see the wiki for solutions to commonly reported issues.
Join us in the
#webdrivers-gem channel on Slack
if you have any questions.
The gem is available as open source under the terms of the MIT License, see LICENSE.txt for full details and copyright.
Bug reports and pull requests are welcome on GitHub.
bundle exec rake and squash the commits in your PRs.