⚠️ DEPRECATION WARNING: This service got deprecated and is no longer maintained. If you use WebdriverIO v8.14 or higher. We recommend to remove the service as dependency and from your WebdriverIO configuration as it is no longer needed. For more information, please read this blog post.
This service helps you to run the Safari browser seamlessly when running tests with the WDIO testrunner. It uses the /usr/bin/safaridriver
that comes with Safari/OSX.
Note - this service does not require a Selenium server, but uses the /usr/bin/safaridriver
to communicate with the browser directly. Obvisously, it only supports:
capabilities: [{
browserName: 'safari'
}]
The easiest way is to keep wdio-safaridriver-service
as a devDependency in your package.json
.
{
"devDependencies": {
"wdio-safaridriver-service": "^1.0.0"
}
}
You can simple do it by:
npm install wdio-safaridriver-service --save-dev
Instructions on how to install WebdriverIO
can be found here.
Safari’s WebDriver support for developers is turned off by default. How you enable it depends on your operating system.
Run safaridriver --enable
once. (If you’re upgrading from a previous macOS release, you may need to use sudo.)
If you haven’t already done so, make the Develop menu available. Choose Safari > Preferences, and on the Advanced tab, select “Show Develop menu in menu bar.” For details, see Safari Help.
Choose Develop > Allow Remote Automation.
Authorize safaridriver
to launch the XPC service that hosts the local web server. To permit this, manually run /usr/bin/safaridriver
once and follow the authentication prompt.
By design, only Safari is available, and will only work on Mac OS. In order to use the service you need to add safaridriver
to your service array:
// wdio.conf.js
export.config = {
// port to find safaridriver
port: 4447, // if you want to specify the port. Default is 4444
path: '/',
// ...
capabilities: [{
/*
* safaridriver can only handle 1 instance unfortunately
* https://developer.apple.com/documentation/webkit/about_webdriver_for_safari
*/
maxInstances: 1,
}],
services: [
['safaridriver', {
outputDir: './logs',
logFileName: 'wdio-safaridriver.log'
}]
],
// ...
};
port
The port on which the driver should run on.
Example: 4444
Type: number
args
Array of arguments to pass to the safaridriver executable. -p
will use wdioConfig.port if not specified.
Type: string[]
outputDir
The path where the output of the Safaridriver server should be stored (uses the config.outputDir
by default when not set).
Type: string
logFileName
The name of the log file to be written in outputDir.
Type: string
For more information on WebdriverIO see the homepage.