| permalink | editLink | sidebar | title |
|---|---|---|---|
/helpers/WebDriver |
false |
auto |
WebDriver |
Extends Helper
WebDriver helper which wraps webdriverio library to manipulate browser using Selenium WebDriver or PhantomJS.
WebDriver requires Selenium Server and ChromeDriver/GeckoDriver to be installed. Those tools can be easily installed via NPM. Please check Testing with WebDriver for more details.
This helper should be configured in codecept.json or codecept.conf.js
url: base url of website to be tested.basicAuth: (optional) the basic authentication to pass to base url. Example: {username: 'username', password: 'password'}browser: browser in which to perform testing.host: - WebDriver host to connect.port: - WebDriver port to connect.protocol: - protocol for WebDriver server.path: - path to WebDriver server,restart: - restart browser between tests.smartWait: (optional) enables SmartWait; wait for additional milliseconds for element to appear. Enable for 5 secs: "smartWait": 5000.disableScreenshots: - don't save screenshots on failure.fullPageScreenshots- make full page screenshots on failure.uniqueScreenshotNames: - option to prevent screenshot override if you have scenarios with the same name in different suites.keepBrowserState: - keep browser state between tests whenrestartis set to false.keepCookies: - keep cookies between tests whenrestartset to false.windowSize: (optional) default window size. Set tomaximizeor a dimension in the format640x480.waitForTimeout: sets default wait time in ms for allwait*functions.desiredCapabilities: Selenium's desired capabilities.manualStart: - do not start browser before a test, start it manually inside a helper withthis.helpers["WebDriver"]._startBrowser().timeouts: WebDriver timeouts defined as hash.
Example:
{
helpers: {
WebDriver : {
smartWait: 5000,
browser: "chrome",
restart: false,
windowSize: "maximize",
timeouts: {
"script": 60000,
"page load": 10000
}
}
}
}Example with basic authentication
{
helpers: {
WebDriver : {
smartWait: 5000,
browser: "chrome",
basicAuth: {username: 'username', password: 'password'},
restart: false,
windowSize: "maximize",
timeouts: {
"script": 60000,
"page load": 10000
}
}
}
}Additional configuration params can be used from webdriverio website.
{
helpers: {
WebDriver : {
url: "http://localhost",
browser: "chrome",
desiredCapabilities: {
chromeOptions: {
args: [ "--headless", "--disable-gpu", "--no-sandbox" ]
}
}
}
}
}Additional configuration params can be used from IE options
{
helpers: {
WebDriver : {
url: "http://localhost",
browser: "internet explorer",
desiredCapabilities: {
ieOptions: {
"ie.browserCommandLineSwitches": "-private",
"ie.usePerProcessProxy": true,
"ie.ensureCleanSession": true,
}
}
}
}
}Selenoid is a modern way to run Selenium inside Docker containers.
Selenoid is easy to set up and provides more features than original Selenium Server. Use selenoidOptions to set Selenoid capabilities
{
helpers: {
WebDriver : {
url: "http://localhost",
browser: "chrome",
desiredCapabilities: {
selenoidOptions: {
enableVNC: true,
}
}
}
}
}CodeceptJS also provides flexible options when you want to execute tests to Selenium servers through proxy. You will
need to update the helpers.WebDriver.capabilities.proxy key.
{
helpers: {
WebDriver: {
capabilities: {
proxy: {
"proxyType": "manual|pac",
"proxyAutoconfigUrl": "URL TO PAC FILE",
"httpProxy": "PROXY SERVER",
"sslProxy": "PROXY SERVER",
"ftpProxy": "PROXY SERVER",
"socksProxy": "PROXY SERVER",
"socksUsername": "USERNAME",
"socksPassword": "PASSWORD",
"noProxy": "BYPASS ADDRESSES"
}
}
}
}
}For example,
{
helpers: {
WebDriver: {
capabilities: {
proxy: {
"proxyType": "manual",
"httpProxy": "http://corporate.proxy:8080",
"socksUsername": "codeceptjs",
"socksPassword": "secret",
"noProxy": "127.0.0.1,localhost"
}
}
}
}
}Please refer to Selenium - Proxy Object for more information.
WebDriver makes it possible to execute tests against services like Sauce Labs BrowserStack TestingBot
Check out their documentation on available parameters
Connecting to BrowserStack and Sauce Labs is simple. All you need to do
is set the user and key parameters. WebDriver automatically know which
service provider to connect to.
{
helpers:{
WebDriver: {
url: "YOUR_DESIRED_HOST",
user: "YOUR_BROWSERSTACK_USER",
key: "YOUR_BROWSERSTACK_KEY",
capabilities: {
"browserName": "chrome",
// only set this if you're using BrowserStackLocal to test a local domain
// "browserstack.local": true,
// set this option to tell browserstack to provide addition debugging info
// "browserstack.debug": true,
}
}
}
}SauceLabs can be configured via wdio service, which should be installed additionally:
npm i @wdio/sauce-service --save
It is important to make sure it is compatible with current webdriverio version.
Enable wdio plugin in plugins list and add sauce service:
plugins: {
wdio: {
enabled: true,
services: ['sauce'],
user: ... ,// saucelabs username
key: ... // saucelabs api key
// additional config, from sauce service
}
}See complete reference on webdriver.io.
Alternatively, use codeceptjs-saucehelper for better reporting.
BrowserStack can be configured via wdio service, which should be installed additionally:
npm i @wdio/browserstack-service --save
It is important to make sure it is compatible with current webdriverio version.
Enable wdio plugin in plugins list and add browserstack service:
plugins: {
wdio: {
enabled: true,
services: ['browserstack'],
user: ... ,// browserstack username
key: ... // browserstack api key
// additional config, from browserstack service
}
}See complete reference on webdriver.io.
Alternatively, use codeceptjs-bshelper for better reporting.
Recommended: use official TestingBot Helper.
Alternatively, TestingBot can be configured via wdio service, which should be installed additionally:
npm i @wdio/testingbot-service --save
It is important to make sure it is compatible with current webdriverio version.
Enable wdio plugin in plugins list and add testingbot service:
plugins: {
wdio: {
enabled: true,
services: ['testingbot'],
user: ... ,// testingbot key
key: ... // testingbot secret
// additional config, from testingbot service
}
}See complete reference on webdriver.io.
Visual testing via Applitools service
Use CodeceptJS Applitools Helper with Applitools wdio service.
This is a work in progress but you can control two browsers at a time right out of the box. Individual control is something that is planned for a later version.
Here is the webdriverio docs on the subject
{
helpers: {
WebDriver: {
"multiremote": {
"MyChrome": {
"desiredCapabilities": {
"browserName": "chrome"
}
},
"MyFirefox": {
"desiredCapabilities": {
"browserName": "firefox"
}
}
}
}
}
}Receive a WebDriver client from a custom helper by accessing browser property:
const { WebDriver } = this.helpers;
const browser = WebDriver.browserconfig
Check if locator is type of "Shadow"
locatorobject
Get elements by different locator types, including strict locator. Should be used in custom helpers:
this.helpers['WebDriver']._locate({name: 'password'}).then //...Find a checkbox by providing human readable text:
this.helpers['WebDriver']._locateCheckable('I agree with terms and conditions').then // ...Find a clickable element by providing human readable text:
const els = await this.helpers.WebDriver._locateClickable('Next page');
const els = await this.helpers.WebDriver._locateClickable('Next page', '.pages');Find field elements by providing human readable text:
this.helpers['WebDriver']._locateFields('Your email').then // ...Locate Element within the Shadow Dom
locatorobject
Smart Wait to locate an element
locatorobject
Accepts the active JavaScript native popup window, as created by window.alert|window.confirm|window.prompt. Don't confuse popups with modal windows, as created by various libraries.
Opens a web page in a browser. Requires relative or absolute url.
If url starts with /, opens a web page of a site defined in url config parameter.
I.amOnPage('/'); // opens main page of website
I.amOnPage('https://github.com'); // opens github
I.amOnPage('/login'); // opens a login pageurlstring url path or global url.
Appends text to a input field or textarea. Field is located by name, label, CSS or XPath
I.appendField('#myTextField', 'appended');field(string | object) located by label|name|CSS|XPath|strict locatorvaluestring text value to append.
This action supports React locators
Attaches a file to element located by label, name, CSS or XPath Path to file is relative current codecept directory (where codecept.json or codecept.conf.js is located). File will be uploaded to remote system (if tests are running remotely).
I.attachFile('Avatar', 'data/avatar.jpg');
I.attachFile('form input[name=avatar]', 'data/avatar.jpg');locator(string | object) field located by label|name|CSS|XPath|strict locator.pathToFilestring local file path relative to codecept.json config file. Appium: not tested
Dismisses the active JavaScript popup, as created by window.alert|window.confirm|window.prompt.
Selects a checkbox or radio button. Element is located by label or name or CSS or XPath.
The second parameter is a context (CSS or XPath locator) to narrow the search.
I.checkOption('#agree');
I.checkOption('I Agree to Terms and Conditions');
I.checkOption('agree', '//form');field(string | object) checkbox located by label | name | CSS | XPath | strict locator.context(string? | object) (optional,nullby default) element located by CSS | XPath | strict locator. Appium: not tested
Clears a cookie by name, if none provided clears all cookies.
I.clearCookie();
I.clearCookie('test');cookiestring? (optional,nullby default) cookie name
Clears a <textarea> or text <input> element's value.
I.clearField('Email');
I.clearField('user[email]');
I.clearField('#email');Perform a click on a link or a button, given by a locator. If a fuzzy locator is given, the page will be searched for a button, link, or image matching the locator string. For buttons, the "value" attribute, "name" attribute, and inner text are searched. For links, the link text is searched. For images, the "alt" attribute and inner text of any parent links are searched.
The second parameter is a context (CSS or XPath locator) to narrow the search.
// simple link
I.click('Logout');
// button of form
I.click('Submit');
// CSS button
I.click('#form input[type=submit]');
// XPath
I.click('//form/*[@type=submit]');
// link in context
I.click('Logout', '#nav');
// using strict locator
I.click({css: 'nav a.login'});locator(string | object) clickable link or button located by text, or any element located by CSS|XPath|strict locator.context(string? | object) (optional,nullby default) element to search in CSS|XPath|Strict locator.
This action supports React locators
Close current tab.
I.closeCurrentTab();Close all tabs except for the current one.
I.closeOtherTabs();Set WebDriver timeouts in realtime.
Timeouts are expected to be passed as object:
I.defineTimeout({ script: 5000 });
I.defineTimeout({ implicit: 10000, pageLoad: 10000, script: 5000 });timeoutsWebdriverIO.Timeouts WebDriver timeouts object.
Opposite to see. Checks that a text is not present on a page.
Use context parameter to narrow down the search.
I.dontSee('Login'); // assume we are already logged in.
I.dontSee('Login', '.nav'); // no login inside .nav elementtextstring which is not present.context(string | object)? (optional) element located by CSS|XPath|strict locator in which to perfrom search.
This action supports React locators
Verifies that the specified checkbox is not checked.
I.dontSeeCheckboxIsChecked('#agree'); // located by ID
I.dontSeeCheckboxIsChecked('I agree to terms'); // located by label
I.dontSeeCheckboxIsChecked('agree'); // located by nameChecks that cookie with given name does not exist.
I.dontSeeCookie('auth'); // no auth cookienamestring cookie name.
Checks that current url is not equal to provided one. If a relative url provided, a configured url will be prepended to it.
I.dontSeeCurrentUrlEquals('/login'); // relative url are ok
I.dontSeeCurrentUrlEquals('http://mysite.com/login'); // absolute urls are also okurlstring value to check.
Opposite to seeElement. Checks that element is not visible (or in DOM)
I.dontSeeElement('.modal'); // modal is not shownThis action supports React locators
Opposite to seeElementInDOM. Checks that element is not on page.
I.dontSeeElementInDOM('.nav'); // checks that element is not on page visible or notChecks that current url does not contain a provided fragment.
urlstring value to check.
Checks that value of input field or textarea doesn't equal to given value
Opposite to seeInField.
I.dontSeeInField('email', 'user@user.com'); // field by name
I.dontSeeInField({ css: 'form input.email' }, 'user@user.com'); // field by CSSfield(string | object) located by label|name|CSS|XPath|strict locator.valuestring value to check.
Checks that the current page does not contains the given string in its raw source code.