WebDriverIO

WebDriverIO

WebDriverIO helper which wraps webdriverio library to manipulate browser using Selenium WebDriver or PhantomJS.

Selenium Installation

1. Download Selenium Server
2. For Chrome browser install ChromeDriver, for Firefox browser install GeckoDriver.
3. Launch the server: java -jar selenium-server-standalone-3.xx.xxx.jar. To locate Chromedriver binary use -Dwebdriver.chrome.driver=./chromedriver option. For Geckodriver use -Dwebdriver.gecko.driver=.

PhantomJS Installation

PhantomJS is a headless alternative to Selenium Server that implements the WebDriver protocol. It allows you to run Selenium tests on a server without a GUI installed.

1. Download PhantomJS
2. Run PhantomJS in WebDriver mode: phantomjs --webdriver=4444

Configuration

This helper should be configured in codecept.json

• url - base url of website to be tested
• browser - browser in which perform testing
• restart (optional, default: true) - restart browser between tests.
• keepCookies (optional, default: false) - keep cookies between tests when restart set to false.
• windowSize: (optional) default window size. Set to maximize or a dimension in the format 640x480.
• waitForTimeout: (option) sets default wait time in ms for all wait* functions. 1000 by default;
• desiredCapabilities: Selenium's desired capabilities
• manualStart (optional, default: false) - do not start browser before a test, start it manually inside a helper with this.helpers["WebDriverIO"]._startBrowser()
• timeouts: WebDriverIO timeouts defined as hash.

Example:

{
   "helpers": {
     "WebDriverIO" : {
       "browser": "chrome",
       "restart": false,
       "windowSize": "maximize",
       "timeouts": {
         "script": 60000,
         "page load": 10000,
         "implicit" : 5000
       }
     }
   }
}

Additional configuration params can be used from webdriverio website.

Connect through proxy

CodeceptJS also provides flexible options when you want to execute tests to Selenium servers through proxy. You will need to update the helpers.WebDriverIO.desiredCapabilities.proxy key.

{
    "helpers": {
        "WebDriverIO": {
            "desiredCapabilities": {
                "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": {
        "WebDriverIO": {
            "desiredCapabilities": {
                "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.

Cloud Providers

WebDriverIO 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. WebDriverIO automatically know which service provider to connect to.

{
    "helpers":{
        "WebDriverIO": {
            "url": "YOUR_DESIERED_HOST",
            "user": "YOUR_BROWSERSTACK_USER",
            "key": "YOUR_BROWSERSTACK_KEY",
            "desiredCapabilities": {
                "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,
            }
        }
    }
}

Multiremote Capabilities

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": {
        "WebDriverIO": {
            "multiremote": {
                "MyChrome": {
                    "desiredCapabilities": {
                        "browserName": "chrome"
                     }
                },
                "MyFirefox": {
                   "desiredCapabilities": {
                       "browserName": "firefox"
                   }
                }
            }
        }
    }
}

Access From Helpers

Receive a WebDriverIO client from a custom helper by accessing browser property:

this.helpers['WebDriverIO'].browser

Parameters

• config

_locate

Get elements by different locator types, including strict locator Should be used in custom helpers:

this.helpers['WebDriverIO']._locate({name: 'password'}).then //...

Parameters

• locator

_locateCheckable

Find a checkbox by providing human readable text:

this.helpers['WebDriverIO']._locateCheckable('I agree with terms and conditions').then // ...

Parameters

• locator

_locateClickable

Find a clickable element by providing human readable text:

this.helpers['WebDriverIO']._locateClickable('Next page').then // ...

Parameters

• locator

_locateFields

Find field elements by providing human readable text:

this.helpers['WebDriverIO']._locateFields('Your email').then // ...

Parameters

• locator

acceptPopup

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.

amOnPage

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 page

Parameters

• url url path or global url

appendField

Appends text to a input field or textarea. Field is located by name, label, CSS or XPath

I.appendField('#myTextField', 'appended');

Parameters

• field located by label|name|CSS|XPath|strict locator
• value text value

attachFile

Attaches a file to element located by label, name, CSS or XPath Path to file is relative current codecept directory (where codecept.json 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');

Parameters

• locator field located by label|name|CSS|XPath|strict locator
• pathToFile local file path relative to codecept.json config file

cancelPopup

Dismisses the active JavaScript popup, as created by window.alert|window.confirm|window.prompt.

checkOption

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');

Parameters

- field checkbox located by label	name	CSS

clearCookie

Clears a cookie by name, if none provided clears all cookies

I.clearCookie();
I.clearCookie('test');

Parameters

• cookie (optional)

clearField

Clears a <textarea> or text <input> element's value.

I.clearField('Email');
I.clearField('user[email]');
I.clearField('#email');

Parameters

• field located by label|name|CSS|XPath|strict locator

click

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'});

Parameters

- locator clickable link or button located by text, or any element located by CSS	XPath	strict locator

defineTimeout

Set WebDriverIO timeouts in realtime. Timeouts are expected to be passed as object:

I.defineTimeout({ script: 5000 });
I.defineTimeout({ implicit: 10000, "page load": 10000, script: 5000 });

Parameters

• timeouts

dontSee

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

Parameters

• text is not present
• context (optional) element located by CSS|XPath|strict locator in which to perfrom search

dontSeeCheckboxIsChecked

Verifies that the specified checkbox is not checked.

Parameters

• field located by label|name|CSS|XPath|strict locator

dontSeeCookie

Checks that cookie with given name does not exist.

Parameters

• name

dontSeeCurrentUrlEquals

Checks that current url is not equal to provided one. If a relative url provided, a configured url will be prepended to it.

Parameters

• url

dontSeeElement

Opposite to seeElement. Checks that element is not visible

Parameters

• locator located by CSS|XPath|Strict locator

dontSeeElementInDOM

Opposite to seeElementInDOM. Checks that element is not on page.

Parameters

• locator located by CSS|XPath|Strict locator

dontSeeInCurrentUrl

Checks that current url does not contain a provided fragment.

Parameters

• url

dontSeeInField

Checks that value of input field or textare doesn't equal to given value Opposite to seeInField.

Parameters

• field located by label|name|CSS|XPath|strict locator
• value is not expected to be a field value

dontSeeInSource

Checks that the current page contains the given string in its raw source code

Parameters

• text

dontSeeInTitle

Checks that title does not contain text.

Parameters

• text

doubleClick

Performs a double-click on an element matched by link|button|label|CSS or XPath. Context can be specified as second parameter to narrow search.

I.doubleClick('Edit');
I.doubleClick('Edit', '.actions');
I.doubleClick({css: 'button.accept'});
I.doubleClick('.btn.edit');

Parameters

• locator
• context

dragAndDrop

Drag an item to a destination element.

I.dragAndDrop('#dragHandle', '#container');

Parameters

• srcElement
• destElement

executeAsyncScript

Executes async script on page. Provided function should execute a passed callback (as first argument) to signal it is finished.

Example: In Vue.js to make components completely rendered we are waiting for nextTick.

I.executeAsyncScript(function(done) {
Vue.nextTick(done); // waiting for next tick
});

By passing value to done() function you can return values. Additional arguments can be passed as well, while done function is always last parameter in arguments list.

let val = yield I.executeAsyncScript(function(url, done) {
// in browser context
$.ajax(url, { success: (data) => done(data); }
}, 'http://ajax.callback.url/');

Parameters

• fn function to be executed in browser context

executeScript

Executes sync script on a page. Pass arguments to function as additional parameters. Will return execution result to a test. In this case you should use generator and yield to receive results.

Example with jQuery DatePicker:

// change date of jQuery DatePicker
I.executeScript(function() {
// now we are inside browser context
$('date')).datetimepicker('setDate', new Date());
});

Can return values. Don't forget to use yield to get them.

let date = yield I.executeScript(function(el) {
// only basic types can be returned
return $(el).datetimepicker('getDate').toString();
}, '#date'); // passing jquery selector

Parameters

• fn function to be executed in browser context

fillField

Fills a text field or textarea, after clearing its value, with the given string. Field is located by name, label, CSS, or XPath.

// by label
I.fillField('Email', 'hello@world.com');
// by name
I.fillField('password', '123456');
// by CSS
I.fillField('form#login input[name=username]', 'John');
// or by strict locator
I.fillField({css: 'form#login input[name=username]'}, 'John');

Parameters

• field located by label|name|CSS|XPath|strict locator
• value

grabAttributeFrom

Retrieves an attribute from an element located by CSS or XPath and returns it to test. Resumes test execution, so should be used inside a generator with yield operator.

let hint = yield I.grabAttributeFrom('#tooltip', 'title');

Parameters

• locator element located by CSS|XPath|strict locator
• attr

grabCookie

Gets a cookie object by name Resumes test execution, so should be used inside a generator with yield operator.

let cookie = I.grabCookie('auth');
assert(cookie.value, '123456');

Parameters

• name

grabHTMLFrom

Retrieves the innerHTML from an element located by CSS or XPath and returns it to test. Resumes test execution, so should be used inside a generator with yield operator.

let postHTML = yield I.grabHTMLFrom('#post');

Parameters

• locator

grabTextFrom

Retrieves a text from an element located by CSS or XPath and returns it to test. Resumes test execution, so should be used inside a generator with yield operator.

let pin = yield I.grabTextFrom('#pin');

Parameters

• locator element located by CSS|XPath|strict locator

grabTitle

Retrieves a page title and returns it to test. Resumes test execution, so should be used inside a generator with yield operator.

let title = yield I.grabTitle();

grabValueFrom

Retrieves a value from a form element located by CSS or XPath and returns it to test. Resumes test execution, so should be used inside a generator with yield operator.

let email = yield I.grabValueFrom('input[name=email]');

Parameters

• locator field located by label|name|CSS|XPath|strict locator

moveCursorTo

Moves cursor to element matched by locator. Extra shift can be set with offsetX and offsetY options

I.moveCursorTo('.tooltip');
I.moveCursorTo('#submit', 5,5);

Parameters

• locator
• offsetX
• offsetY

pressKey

Presses a key on a focused element. Speical keys like 'Enter', 'Control', etc will be replaced with corresponding unicode. If modifier key is used (Control, Command, Alt, Shift) in array, it will be released afterwards.

I.pressKey('Enter');
I.pressKey(['Control','a']);

Parameters

• key To make combinations with modifier and mouse clicks (like Ctrl+Click) press a modifier, click, then release it.js I.pressKey('Control'); I.click('#someelement'); I.pressKey('Control');

resizeWindow

Resize the current window to provided width and height. First parameter can be set to maximize

Parameters

• width or maximize
• height

rightClick

Performs right click on an element matched by CSS or XPath.

Parameters

• locator

saveScreenshot

Saves a screenshot to ouput folder (set in codecept.json). Filename is relative to output folder.

I.saveScreenshot('debug.png');

Parameters

• fileName

scrollTo

Scrolls to element matched by locator. Extra shift can be set with offsetX and offsetY options

I.scrollTo('footer');
I.scrollTo('#submit', 5,5);

Parameters

• locator
• offsetX
• offsetY

see

Checks that a page contains a visible text. Use context parameter to narrow down the search.

I.see('Welcome'); // text welcome on a page
I.see('Welcome', '.content'); // text inside .content div
I.see('Register', {css: 'form.register'}); // use strict locator

Parameters

• text expected on page
• context (optional) element located by CSS|Xpath|strict locator in which to search for text

seeCheckboxIsChecked

Verifies that the specified checkbox is checked.

I.seeCheckboxIsChecked('Agree');
I.seeCheckboxIsChecked('#agree'); // I suppose user agreed to terms
I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});

Parameters

• field located by label|name|CSS|XPath|strict locator

seeCookie

Checks that cookie with given name exists.

I.seeCookie('Auth');

Parameters

• name

seeCurrentUrlEquals

Checks that current url is equal to provided one. If a relative url provided, a configured url will be prepended to it. So both examples will work:

I.seeCurrentUrlEquals('/register');
I.seeCurrentUrlEquals('http://my.site.com/register');

Parameters

• url

seeElement

Checks that a given Element is visible Element is located by CSS or XPath.

I.seeElement('#modal');

Parameters

• locator located by CSS|XPath|strict locator

seeElementInDOM

Checks that a given Element is present in the DOM Element is located by CSS or XPath.

I.seeElementInDOM('#modal');

Parameters

• locator located by CSS|XPath|strict locator

seeInCurrentUrl

Checks that current url contains a provided fragment.

I.seeInCurrentUrl('/register'); // we are on registration page

Parameters

• url

seeInField

Checks that the given input field or textarea equals to given value. For fuzzy locators, fields are matched by label text, the "name" attribute, CSS, and XPath.

I.seeInField('Username', 'davert');
I.seeInField({css: 'form textarea'},'Type your comment here');
I.seeInField('form input[type=hidden]','hidden_value');
I.seeInField('#searchform input','Search');

Parameters

• field located by label|name|CSS|XPath|strict locator
• value

seeInPopup

Checks that the active JavaScript popup, as created by window.alert|window.confirm|window.prompt, contains the given string.

Parameters

• text

seeInSource

Checks that the current page contains the given string in its raw source code.

I.seeInSource('<h1>Green eggs &amp; ham</h1>');

Parameters

• text

seeInTitle

Checks that title contains text.

Parameters

• text

seeNumberOfElements

asserts that an element appears a given number of times in the DOM Element is located by label or name or CSS or XPath.

I.seeNumberOfElements('#submitBtn', 1);

Parameters

• selector
• num

seeNumberOfVisibleElements

asserts that an element is visible a given number of times Element is located by CSS or XPath.

I.seeNumberOfVisibleElements('.buttons', 3);

Parameters

• selector
• num

selectOption

Selects an option in a drop-down select. Field is searched by label | name | CSS | XPath. Option is selected by visible text or by value.

I.selectOption('Choose Plan', 'Monthly'); // select by label
I.selectOption('subscription', 'Monthly'); // match option by text
I.selectOption('subscription', '0'); // or by value
I.selectOption('//form/select[@name=account]','Premium');
I.selectOption('form select[name=account]', 'Premium');
I.selectOption({css: 'form select[name=account]'}, 'Premium');

Provide an array for the second argument to select multiple options.

I.selectOption('Which OS do you use?', ['Android', 'iOS']);

Parameters

• select field located by label|name|CSS|XPath|strict locator
• option

setCookie

Sets a cookie

I.setCookie({name: 'auth', value: true});

Parameters

• cookie Uses Selenium's JSON cookie format.

switchTo

Switches frame or in case of null locator reverts to parent.

Parameters

• locator

wait

Pauses execution for a number of seconds.

I.wait(2); // wait 2 secs

Parameters

• sec

waitForElement

Waits for element to be present on page (by default waits for 1sec). Element can be located by CSS or XPath.

I.waitForElement('.btn.continue');
I.waitForElement('.btn.continue', 5); // wait for 5 secs

Parameters

• locator element located by CSS|XPath|strict locator
• sec time seconds to wait, 1 by default

waitForEnabled

Waits for element to become enabled (by default waits for 1sec). Element can be located by CSS or XPath.

Parameters

• locator element located by CSS|XPath|strict locator
• sec time seconds to wait, 1 by default

waitForInvisible

Waits for an element to become invisible on a page (by default waits for 1sec). Element can be located by CSS or XPath.

I.waitForInvisible('#popup');

Parameters

• locator element located by CSS|XPath|strict locator
• sec time seconds to wait, 1 by default

waitForStalenessOf

Waits for an element to become not attached to the DOM on a page (by default waits for 1sec). Element can be located by CSS or XPath.

I.waitForStalenessOf('#popup');

Parameters

• locator element located by CSS|XPath|strict locator
• sec time seconds to wait, 1 by default

waitForText

Waits for a text to appear (by default waits for 1sec). Element can be located by CSS or XPath. Narrow down search results by providing context.

I.waitForText('Thank you, form has been submitted');
I.waitForText('Thank you, form has been submitted', 5, '#modal');

Parameters

• text to wait for
• sec seconds to wait
• context element located by CSS|XPath|strict locator

waitForVisible

Waits for an element to become visible on a page (by default waits for 1sec). Element can be located by CSS or XPath.

I.waitForVisible('#popup');

Parameters

• locator element located by CSS|XPath|strict locator
• sec time seconds to wait, 1 by default

waitToHide

Waits for an element to become invisible on a page (by default waits for 1sec). Element can be located by CSS or XPath.

Parameters

• locator
• sec

waitUntil

Waits for a function to return true (waits for 1sec by default).

Parameters

• fn
• sec