Use this plugin to manage, download and install WebDriver drivers directly from your pom.
The following drivers are currently maintained and available for installation:
- internetexplorerdriver, windows, 32bit
- internetexplorerdriver, windows, 64bit
- chromedriver, windows, 32bit
- chromedriver, mac, 32bit
- chromedriver, linux, 32bit
- chromedriver, linux, 64bit
- phantomjs, windows, 64bit
- phantomjs, mac, 64bit
- phantomjs, linux, 32bit
- phantomjs, linux, 64bit
- geckodriver, windows, 64bit
- geckodriver, mac, 64bit
- geckodriver, linux, 64bit
- edgedriver, windows, 64bit
- operadriver, windows, 32bit
- operadriver, windows, 64bit
- operadriver, mac, 32bit
- operadriver, linux, 32bit
- operadriver, linux, 64bit
We try to update the drivers as soon as we notice they are updated. If you want to help to keep the drivers updated see the projects GitHub repository. To verify that a version is available for installation check that it exists in the default drivers repository-3.0.json file.
However if the driver is not yet available in the repo it can also be installed by providing an URL to the download location, see the section below for more details on how.
There are some issues with the tests failing to download the phantomjs driver from bitbucket. This should however only occur in the tests.
To install the latest drivers for the current platform and the most probable bit version add the plugin configured to execute the install-drivers goal.
<plugin>
<groupId>com.github.webdriverextensions</groupId>
<artifactId>webdriverextensions-maven-plugin</artifactId>
<version>3.1.3</version>
<executions>
<execution>
<goals>
<goal>install-drivers</goal>
</goals>
</execution>
</executions>
</plugin>The installed driver's bit version will be 32 bit if you are running the plugin from a windows or mac platform. However on linux platforms the OS bit version will determine the bit version of the installed driver.
Note that the plugin will automatically update the driver if a newer driver version is released.
If you wish to be more specific about which drivers to install you can provide the drivers yourself in the plugin configuration.
E.g. to install specific versions of all available drivers
<plugin>
<groupId>com.github.webdriverextensions</groupId>
<artifactId>webdriverextensions-maven-plugin</artifactId>
<version>3.1.3</version>
<executions>
<execution>
<goals>
<goal>install-drivers</goal>
</goals>
</execution>
</executions>
<configuration>
<drivers>
<driver>
<name>internetexplorerdriver</name>
<platform>windows</platform>
<bit>32</bit>
<version>3.8.0</version>
</driver>
<driver>
<name>internetexplorerdriver</name>
<platform>windows</platform>
<bit>64</bit>
<version>3.8.0</version>
</driver>
<driver>
<name>chromedriver</name>
<platform>windows</platform>
<bit>32</bit>
<version>2.34</version>
</driver>
<driver>
<name>chromedriver</name>
<platform>mac</platform>
<bit>64</bit>
<version>2.34</version>
</driver>
<driver>
<name>chromedriver</name>
<platform>linux</platform>
<bit>32</bit>
<version>2.34</version>
</driver>
<driver>
<name>chromedriver</name>
<platform>linux</platform>
<bit>64</bit>
<version>2.34</version>
</driver>
<driver>
<name>phantomjs</name>
<platform>windows</platform>
<bit>64</bit>
<version>2.1.1</version>
</driver>
<driver>
<name>phantomjs</name>
<platform>mac</platform>
<bit>64</bit>
<version>2.1.1</version>
</driver>
<driver>
<name>phantomjs</name>
<platform>linux</platform>
<bit>32</bit>
<version>2.1.1</version>
</driver>
<driver>
<name>phantomjs</name>
<platform>linux</platform>
<bit>64</bit>
<version>2.1.1</version>
</driver>
<driver>
<name>geckodriver</name>
<platform>windows</platform>
<bit>64</bit>
<version>0.19.1</version>
</driver>
<driver>
<name>geckodriver</name>
<platform>windows</platform>
<bit>32</bit>
<version>0.19.1</version>
</driver>
<driver>
<name>geckodriver</name>
<platform>mac</platform>
<bit>64</bit>
<version>0.19.1</version>
</driver>
<driver>
<name>geckodriver</name>
<platform>linux</platform>
<bit>64</bit>
<version>0.19.1</version>
</driver>
<driver>
<name>geckodriver</name>
<platform>linux</platform>
<bit>32</bit>
<version>0.19.1</version>
</driver>
<driver>
<name>edgedriver</name>
<platform>windows</platform>
<bit>64</bit>
<version>5.16299</version>
</driver>
<driver>
<name>operadriver</name>
<platform>windows</platform>
<bit>32</bit>
<version>2.30</version>
</driver>
<driver>
<name>operadriver</name>
<platform>windows</platform>
<bit>64</bit>
<version>2.30</version>
</driver>
<driver>
<name>operadriver</name>
<platform>mac</platform>
<bit>64</bit>
<version>2.30</version>
</driver>
<driver>
<name>operadriver</name>
<platform>linux</platform>
<bit>64</bit>
<version>2.30</version>
</driver>
</drivers>
</configuration>
</plugin>If you wish to make sure that you always have the latest driver installed omit the version of the driver. For more detailed driver configuration possibilities see the plugin goal documentation.
If the driver is not available in the default drivers repository-3.0.json file you can install the driver by also providing an URL to the download location.
E.g. to install an old Chrome Driver for windows
<driver>
<name>chromedriver</name>
<platform>windows</platform>
<bit>32</bit>
<version>2.27</version>
<url>http://chromedriver.storage.googleapis.com/2.27/chromedriver_win32.zip</url>
</driver>When installing a custom driver you can select what files should be extracted from
the downloaded zip/bz2 file. This is done by providing a regex pattern in a tag named
<fileMatchInside>.
<driver>
<name>phantomjs</name>
<platform>linux</platform>
<bit>32</bit>
<version>2.1.1</version>
<url>https://bitbucket.org/ariya/phantomjs/downloads/phantomjs-1.9.6-linux-i686.tar.bz2</url>
<fileMatchInside>.*/bin/phantomjs$</fileMatchInside>
</driver>By default the drivers are installed a directory called drivers in the maven
project root (${basedir}/drivers). To install the drivers to another directory specify the custom
path through the configuration parameter named installationDirectory.
<plugin>
<groupId>com.github.webdriverextensions</groupId>
<artifactId>webdriverextensions-maven-plugin</artifactId>
<version>3.1.3</version>
<executions>
<execution>
<goals>
<goal>install-drivers</goal>
</goals>
</execution>
</executions>
<configuration>
<installationDirectory>/Users/andidev/drivers</installationDirectory>
<drivers>
... drivers to install
</drivers>
</configuration>
</plugin>To avoid downloading the drivers more than once if you switch between
driver versions or something similar you could set <keepDownloadedWebdrivers>true</keepDownloadedWebdrivers> configuration paramter.
<plugin>
<groupId>com.github.webdriverextensions</groupId>
<artifactId>webdriverextensions-maven-plugin</artifactId>
<version>3.1.3</version>
<executions>
<execution>
<goals>
<goal>install-drivers</goal>
</goals>
</execution>
</executions>
<configuration>
<keepDownloadedWebdrivers>true</keepDownloadedWebdrivers>
<drivers>
... drivers to install
</drivers>
</configuration>
</plugin>If you have configured a proxy in the settings.xml file the first encountered active proxy will be used. To specify a specific proxy to use you can provide the proxy id in the configuration.
<plugin>
<groupId>com.github.webdriverextensions</groupId>
<artifactId>webdriverextensions-maven-plugin</artifactId>
<version>3.1.3</version>
<executions>
<execution>
<goals>
<goal>install-drivers</goal>
</goals>
</execution>
</executions>
<configuration>
<proxyId>yourproxyid</proxyId>
</configuration>
</plugin>To skip the installation you can add <skip>true</skip> in the configuration tag.
<plugin>
<groupId>com.github.webdriverextensions</groupId>
<artifactId>webdriverextensions-maven-plugin</artifactId>
<version>3.1.3</version>
<executions>
<execution>
<goals>
<goal>install-drivers</goal>
</goals>
</execution>
</executions>
<configuration>
<skip>true</skip>
<drivers>
... drivers to install
</drivers>
</configuration>
</plugin>To set a custom file name for the specified driver configuration.
<plugin>
<groupId>com.github.webdriverextensions</groupId>
<artifactId>webdriverextensions-maven-plugin</artifactId>
<version>3.1.3</version>
<executions>
<execution>
<goals>
<goal>install-drivers</goal>
</goals>
</execution>
</executions>
<configuration>
<drivers>
<driver>
<name>chromedriver</name>
<platform>linux</platform>
<customFileName>chrome-linux-custom</customFileName>
</driver>
</drivers>
</configuration>
</plugin>For more details on how to further configure this plugin please see the plugin goal documentation.
- BUGFIX Made Opera driver executable (Thanks to @svenruppert)
- BUGFIX Fixed issue where latest driver where not downloaded when only name was provided for driver
- MAJOR BUGFIX Fixed issue where updating driver was not possible
- BUGFIX Fixed issue 24 Geckodriver on macOS shows as posix tar
- REFACTORING Cache folder name changed from cache to downloads
- BUGFIX Fixed issue 21 with failing on extracting chromedriver on windows machines
- BUGFIX Fixed debug message on error not shown on windows machines
- Added support for geckodriver (Marionette) (Thanks to @pumano)
- Added support for edgedriver (Microsoft WebDriver)
- Added support for operadriver
- Fixed bitDetection for internetexplorerdriver on Windows 10 enviroments
- Fixed bitDetection for phantomjs (Thanks to @lkwg82)
- IMPROVEMENT No need to manually delete drivers when download fails issue 11
- IMPROVEMENT Improved logs to exactly show what the install goal is doing, e.g.
[info] chromedriver-mac-32bit version 2.20.0
[info] Downloading "http://chromedriver.storage.googleapis.com/2.20/chromedriver_mac32.zip" to "/var/folders/mc/fd7bwdvd4c19wwhw0dmt2ngm0000gn/T/webdriverextensions-maven-plugin/temp/chromedriver_mac32.zip"
[info] Extracting "/var/folders/mc/fd7bwdvd4c19wwhw0dmt2ngm0000gn/T/webdriverextensions-maven-plugin/temp/chromedriver_mac32.zip" to temp folder
[info] Moving "/var/folders/mc/fd7bwdvd4c19wwhw0dmt2ngm0000gn/T/webdriverextensions-maven-plugin/temp/chromedriver_mac32/chromedriver" to "/Users/anders/Workspace/webdriverextensions-maven-plugin/src/test/resources/drivers/chromedriver-mac-32bit"
- IMPROVEMENT Print error message in downloaded file if present, e.g.
[info] phantomjs-linux-64bit version 1.9.8
[info] Downloading "https://bitbucket.org/ariya/phantomjs/downloads/phantomjs-1.9.8-linux-x86_64.tar.bz2" to "/var/folders/mc/fd7bwdvd4c19wwhw0dmt2ngm0000gn/T/webdriverextensions-maven-plugin/temp/phantomjs-1.9.8-linux-x86_64.tar.bz2"
[info] Downloaded driver file contains the following error message
[info] <?xml version="1.0" encoding="UTF-8"?>
[info] <Error><Code>AccessDenied</Code><Message>Request has expired</Message><Expires>2016-04-19T21:53:01Z</Expires><ServerTime>2016-04-19T21:57:53Z</ServerTime><RequestId>A7C783167E23A035</RequestId><HostId>QgT8M6Wsn6CdvOPcL1Iu3bpSmPYc9fLIhvSbGTrWRmQYmX6ZejV76VoeNeNnCYt6yGvb/0HBRdY=</HostId></Error>
- REFACTORING Lots of it to make the code more readable
- FEATURE Added support for extracting bz2 files (Thanks to @lkwg82)
- FEATURE Added support for only extracting specific files with the
fileMatchInsidedriver configuration parameter (Thanks to @lkwg82) - FEATURE Added support to cache downloaded drivers with the
keepDownloadedWebdriversplugin configuration parameter (Thanks to @lkwg82) - PHANTOMJS Added official support for phantomjs (Thanks to @lkwg82)
- JAVA 7 REQUIREMENT Now compiled with java 7
- FEATURE Added support for using proxy configured in settings.xml
- BUGFIX Fixed platform not provided bug
- BUGFIX Removed dependency to java 7
- Initial release!
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License in the LICENSE file, or at:
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.