CodeceptJS
💖 Support Us    
🇺🇦 CodeceptJS was created in Ukraine. #StandWithUkraine

WebDriver

# WebDriver

Extends Helper

WebDriver helper which wraps webdriverio (opens new window) 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 (opens new window) for more details.

With the release of WebdriverIO version v8.14.0, and onwards, all driver management hassles are now a thing of the past 🙌. Read more here (opens new window). One of the significant advantages of this update is that you can now get rid of any driver services you previously had to manage, such as wdio-chromedriver-service, wdio-geckodriver-service, wdio-edgedriver-service, wdio-safaridriver-service, and even @wdio/selenium-standalone-service.

For those who require custom driver options, fear not; WebDriver Helper allows you to pass in driver options through custom WebDriver configuration. If you have a custom grid, use a cloud service, or prefer to run your own driver, there's no need to worry since WebDriver Helper will only start a driver when there are no other connection information settings like hostname or port specified.

# Configuration

This helper should be configured in codecept.conf.js

Type: object (opens new window)

# Properties

Example:

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

Testing Chrome locally is now more convenient than ever. You can define a browser channel, and WebDriver Helper will take care of downloading the specified browser version for you. For example:

{
   helpers: {
     WebDriver : {
       smartWait: 5000,
       browser: "chrome",
       browserVersion: '116.0.5793.0', // or 'stable', 'beta', 'dev' or 'canary'
       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 (opens new window).

# Headless Chrome

{
   helpers: {
     WebDriver : {
       url: "http://localhost",
       browser: "chrome",
       desiredCapabilities: {
         chromeOptions: {
           args: [ "--headless", "--disable-gpu", "--no-sandbox" ]
         }
       }
     }
   }
}

# Running with devtools protocol

{
   helpers: {
     WebDriver : {
       url: "http://localhost",
       browser: "chrome",
       devtoolsProtocol: true,
       desiredCapabilities: {
         chromeOptions: {
           args: [ "--headless", "--disable-gpu", "--no-sandbox" ]
         }
       }
     }
   }
}

# Internet Explorer

Additional configuration params can be used from IE options (opens new window)

{
   helpers: {
     WebDriver : {
       url: "http://localhost",
       browser: "internet explorer",
       desiredCapabilities: {
         ieOptions: {
           "ie.browserCommandLineSwitches": "-private",
           "ie.usePerProcessProxy": true,
           "ie.ensureCleanSession": true,
         }
       }
     }
   }
}

# Selenoid Options

Selenoid (opens new window) 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,
         }
       }
     }
   }
}

# 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.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 (opens new window) for more information.

# Cloud Providers

WebDriver makes it possible to execute tests against services like Sauce Labs BrowserStack TestingBot Check out their documentation on available parameters (opens new window)

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

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 (opens new window).

Alternatively, use codeceptjs-saucehelper (opens new window) for better reporting.

# BrowserStack

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 (opens new window).

Alternatively, use codeceptjs-bshelper (opens new window) for better reporting.

# TestingBot

Recommended: use official TestingBot Helper (opens new window).

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 (opens new window).

# Applitools

Visual testing via Applitools service

Use CodeceptJS Applitools Helper (opens new window) with Applitools wdio service.

# 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 (opens new window) on the subject

{
    helpers: {
        WebDriver: {
            "multiremote": {
                "MyChrome": {
                    "desiredCapabilities": {
                        "browserName": "chrome"
                     }
                },
                "MyFirefox": {
                   "desiredCapabilities": {
                       "browserName": "firefox"
                   }
                }
            }
        }
    }
}

# Access From Helpers

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

const { WebDriver } = this.helpers;
const browser = WebDriver.browser

# Methods

# Parameters

  • config

# _isShadowLocator

Check if locator is type of "Shadow"

# Parameters

# _locate

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

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

# Parameters

# _locateCheckable

Find a checkbox by providing human-readable text:

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

# Parameters

# _locateClickable

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

# Parameters

# _locateFields

Find field elements by providing human-readable text:

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

# Parameters

# _locateShadow

Locate Element within the Shadow Dom

# Parameters

# _smartWait

Smart Wait to locate an element

# Parameters

# 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 (opens new window).

# 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

Returns void automatically synchronized promise through #recorder

# appendField

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

I.appendField('#myTextField', 'appended');
// typing secret
I.appendField('password', secret('123456'));

# Parameters

Returns void automatically synchronized promise through #recorder

This action supports React locators (opens new window)

# attachFile

Appium: not tested

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

# Parameters

Returns void automatically synchronized promise through #recorder

# blur

Remove focus from a text input, button, etc. Calls blur (opens new window) on the element.

Examples:

I.blur('.text-area')

//element `#product-tile` is focused
I.see('#add-to-cart-btn');
I.blur('#product-tile')
I.dontSee('#add-to-cart-btn');

# Parameters

Returns void automatically synchronized promise through #recorder

# cancelPopup

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

# checkOption

Appium: not tested 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

Returns void automatically synchronized promise through #recorder

# clearCookie

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

I.clearCookie();
I.clearCookie('test'); // Playwright currently doesn't support clear a particular cookie name

# Parameters

# clearField

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

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

# Parameters

Returns void automatically synchronized promise through #recorder.

# 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

Returns void automatically synchronized promise through #recorder

This action supports React locators (opens new window)

# closeCurrentTab

Close current tab.

I.closeCurrentTab();

Returns void automatically synchronized promise through #recorder

# closeOtherTabs

Close all tabs except for the current one.

I.closeOtherTabs();

Returns void automatically synchronized promise through #recorder

# defineTimeout

Set WebDriver timeouts (opens new window) in realtime.

Timeouts are expected to be passed as object:

I.defineTimeout({ script: 5000 });
I.defineTimeout({ implicit: 10000, pageLoad: 10000, script: 5000 });

# Parameters

  • timeouts any WebDriver timeouts object.

# 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.
I.dontSee('Login', '.nav'); // no login inside .nav element

# Parameters

Returns void automatically synchronized promise through #recorder

This action supports React locators (opens new window)

# dontSeeCheckboxIsChecked

Appium: not tested 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 name

# Parameters

Returns void automatically synchronized promise through #recorder

# dontSeeCookie

Checks that cookie with given name does not exist.

I.dontSeeCookie('auth'); // no auth cookie

# Parameters

Returns void automatically synchronized promise through #recorder

# dontSeeCurrentUrlEquals

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 ok

# Parameters

Returns void automatically synchronized promise through #recorder

# dontSeeElement

Opposite to seeElement. Checks that element is not visible (or in DOM)

I.dontSeeElement('.modal'); // modal is not shown

# Parameters

Returns void automatically synchronized promise through #recorder

This action supports React locators (opens new window)

# dontSeeElementInDOM

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

I.dontSeeElementInDOM('.nav'); // checks that element is not on page visible or not

# Parameters

Returns void automatically synchronized promise through #recorder

# dontSeeInCurrentUrl

Checks that current url does not contain a provided fragment.

# Parameters

Returns void automatically synchronized promise through #recorder

# dontSeeInField

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

I.dontSeeInField('email', '[email protected]'); // field by name
I.dontSeeInField({ css: 'form input.email' }, '[email protected]'); // field by CSS

# Parameters

Returns void automatically synchronized promise through #recorder

# dontSeeInSource

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

I.dontSeeInSource('<!--'); // no comments in source

# Parameters

Returns void automatically synchronized promise through #recorder

# dontSeeInTitle

Checks that title does not contain text.

I.dontSeeInTitle('Error');

# Parameters

Returns void automatically synchronized promise through #recorder

# dontSeeTraffic

Note: Only works when devtoolsProtocol is enabled.

Verifies that a certain request is not part of network traffic.

Examples:

I.dontSeeTraffic({ name: 'Unexpected API Call', url: 'https://api.example.com' });
I.dontSeeTraffic({ name: 'Unexpected API Call of "user" endpoint', url: /api.example.com.*user/ });

# Parameters

Returns void automatically synchronized promise through #recorder

# 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

Returns void automatically synchronized promise through #recorder

This action supports React locators (opens new window)

# dragAndDrop

Appium: not tested Drag an item to a destination element.

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

# Parameters

Returns void automatically synchronized promise through #recorder

# dragSlider

Drag the scrubber of a slider to a given position For fuzzy locators, fields are matched by label text, the "name" attribute, CSS, and XPath.

I.dragSlider('#slider', 30);
I.dragSlider('#slider', -70);

# Parameters

Returns void automatically synchronized promise through #recorder

# 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 (opens new window).

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 = await I.executeAsyncScript(function(url, done) {
  // in browser context
  $.ajax(url, { success: (data) => done(data); }
}, 'http://ajax.callback.url/');

# Parameters

Returns Promise (opens new window)<any> script return value

# executeScript

Wraps execute (opens new window) command.

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 async function and await 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 await to get them.

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

# Parameters

Returns Promise (opens new window)<any> script return value

# 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', '[email protected]');
// by name
I.fillField('password', secret('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

Returns void automatically synchronized promise through #recorder

This action supports React locators (opens new window)

# flushNetworkTraffics

Note: Only works when devtoolsProtocol is enabled.

Resets all recorded network requests.

I.flushNetworkTraffics();

# focus

Calls focus (opens new window) on the matching element.

Examples:

I.dontSee('#add-to-cart-btn');
I.focus('#product-tile')
I.see('#add-to-cart-bnt');

# Parameters

Returns void automatically synchronized promise through #recorder

# forceClick

Perform an emulated click on a link or a button, given by a locator. Unlike normal click instead of sending native event, emulates a click with JavaScript. This works on hidden, animated or inactive elements as well.

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.forceClick('Logout');
// button of form
I.forceClick('Submit');
// CSS button
I.forceClick('#form input[type=submit]');
// XPath
I.forceClick('//form/*[@type=submit]');
// link in context
I.forceClick('Logout', '#nav');
// using strict locator
I.forceClick({css: 'nav a.login'});

# Parameters

Returns void automatically synchronized promise through #recorder

This action supports React locators (opens new window)

# forceRightClick

Emulates right click on an element. Unlike normal click instead of sending native event, emulates a click with JavaScript. This works on hidden, animated or inactive elements as well.

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.forceRightClick('Menu');

# Parameters

Returns void automatically synchronized promise through #recorder

This action supports React locators (opens new window)

# grabAllWindowHandles

Get all Window Handles. Useful for referencing a specific handle when calling I.switchToWindow(handle)

const windows = await I.grabAllWindowHandles();

Returns Promise (opens new window)<Array (opens new window)<string (opens new window)>>

# 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 async with await operator. If more than one element is found - attribute of first element is returned.

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

# Parameters

Returns Promise (opens new window)<string (opens new window)> attribute value

# grabAttributeFromAll

Retrieves an array of attributes from elements located by CSS or XPath and returns it to test. Resumes test execution, so should be used inside async with await operator.

let hints = await I.grabAttributeFromAll('.tooltip', 'title');

# Parameters

Returns Promise (opens new window)<Array (opens new window)<string (opens new window)>> attribute value

# grabBrowserLogs

Get JS log from browser. Log buffer is reset after each request. Resumes test execution, so should be used inside an async function with await operator.

let logs = await I.grabBrowserLogs();
console.log(JSON.stringify(logs))

Returns (Promise (opens new window)<Array (opens new window)<object (opens new window)>> | undefined (opens new window)) all browser logs

# grabCookie

Gets a cookie object by name. If none provided gets all cookies. Resumes test execution, so should be used inside async function with await operator.

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

# Parameters

Returns any attribute value

# grabCssPropertyFrom

Grab CSS property for given locator Resumes test execution, so should be used inside an async function with await operator. If more than one element is found - value of first element is returned.

const value = await I.grabCssPropertyFrom('h3', 'font-weight');

# Parameters

Returns Promise (opens new window)<string (opens new window)> CSS value

# grabCssPropertyFromAll

Grab array of CSS properties for given locator Resumes test execution, so should be used inside an async function with await operator.

const values = await I.grabCssPropertyFromAll('h3', 'font-weight');

# Parameters

Returns Promise (opens new window)<Array (opens new window)<string (opens new window)>> CSS value

# grabCurrentUrl

Get current URL from browser. Resumes test execution, so should be used inside an async function.

let url = await I.grabCurrentUrl();
console.log(`Current URL is [${url}]`);

Returns Promise (opens new window)<string (opens new window)> current URL

# grabCurrentWindowHandle

Get the current Window Handle. Useful for referencing it when calling I.switchToWindow(handle)

const window = await I.grabCurrentWindowHandle();

Returns Promise (opens new window)<string (opens new window)>

# grabElementBoundingRect

Grab the width, height, location of given locator. Provide width or heightas second param to get your desired prop. Resumes test execution, so should be used inside an async function with await operator.

Returns an object with x, y, width, height keys.

const value = await I.grabElementBoundingRect('h3');
// value is like { x: 226.5, y: 89, width: 527, height: 220 }

To get only one metric use second parameter:

const width = await I.grabElementBoundingRect('h3', 'width');
// width == 527

# Parameters

Returns (Promise (opens new window)<DOMRect> | Promise (opens new window)<number (opens new window)>) Element bounding rectangle

# grabGeoLocation

This method is deprecated.

Return the current geo location Resumes test execution, so should be used inside async function with await operator.

let geoLocation = await I.grabGeoLocation();

Returns Promise (opens new window)<{latitude: number (opens new window), longitude: number (opens new window), altitude: number (opens new window)}>

# 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 async function with await operator. If more than one element is found - HTML of first element is returned.

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

# Parameters

Returns Promise (opens new window)<string (opens new window)> HTML code for an element

# grabHTMLFromAll

Retrieves all the innerHTML from elements located by CSS or XPath and returns it to test. Resumes test execution, so should be used inside async function with await operator.

let postHTMLs = await I.grabHTMLFromAll('.post');

# Parameters

Returns Promise (opens new window)<Array (opens new window)<string (opens new window)>> HTML code for an element

# grabNumberOfOpenTabs

Grab number of open tabs. Resumes test execution, so should be used inside async function with await operator.

let tabs = await I.grabNumberOfOpenTabs();

Returns Promise (opens new window)<number (opens new window)> number of open tabs

# grabNumberOfVisibleElements

Grab number of visible elements by locator. Resumes test execution, so should be used inside async function with await operator.

let numOfElements = await I.grabNumberOfVisibleElements('p');

# Parameters

Returns Promise (opens new window)<number (opens new window)> number of visible elements

# grabPageScrollPosition

Retrieves a page scroll position and returns it to test. Resumes test execution, so should be used inside an async function with await operator.

let { x, y } = await I.grabPageScrollPosition();

Returns Promise (opens new window)<PageScrollPosition> scroll position

# grabPopupText

Grab the text within the popup. If no popup is visible then it will return null.

await I.grabPopupText();

Returns Promise (opens new window)<string (opens new window)>

# grabRecordedNetworkTraffics

Note: Only works when devtoolsProtocol is enabled.

Grab the recording network traffics

const traffics = await I.grabRecordedNetworkTraffics();
expect(traffics[0].url).to.equal('https://reqres.in/api/comments/1');
expect(traffics[0].response.status).to.equal(200);
expect(traffics[0].response.body).to.contain({ name: 'this was mocked' });

Returns Array (opens new window) recorded network traffics

# grabSource

Retrieves page source and returns it to test. Resumes test execution, so should be used inside async function with await operator.

let pageSource = await I.grabSource();

Returns Promise (opens new window)<string (opens new window)> source code

# 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 async with await operator.

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

If multiple elements found returns first element.

# Parameters

Returns Promise (opens new window)<string (opens new window)> attribute value

# grabTextFromAll

Retrieves all texts from an element located by CSS or XPath and returns it to test. Resumes test execution, so should be used inside async with await operator.

let pins = await I.grabTextFromAll('#pin li');

# Parameters

Returns Promise (opens new window)<Array (opens new window)<string (opens new window)>> attribute value

# grabTitle

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

let title = await I.grabTitle();

Returns Promise (opens new window)<string (opens new window)> title

# 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 async function with await operator. If more than one element is found - value of first element is returned.

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

# Parameters

Returns Promise (opens new window)<string (opens new window)> attribute value

# grabValueFromAll

Retrieves an array of value from a form located by CSS or XPath and returns it to test. Resumes test execution, so should be used inside async function with await operator.

let inputs = await I.grabValueFromAll('//form/input');

# Parameters

Returns Promise (opens new window)<Array (opens new window)<string (opens new window)>> attribute value

# grabWebElements

Grab WebElements for given locator Resumes test execution, so should be used inside an async function with await operator.

const webElements = await I.grabWebElements('#button');

# Parameters

Returns Promise (opens new window)<any> WebElement of being used Web helper

# 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

Returns void automatically synchronized promise through #recorder

# openNewTab

Open new tab and switch to it.

I.openNewTab();

# Parameters

  • url
  • windowName

Returns void automatically synchronized promise through #recorder

# pressKey

Note: In case a text field or textarea is focused be aware that some browsers do not respect active modifier when combining modifier keys with other keys.

Presses a key in the browser (on a focused element).

Hint: For populating text field or textarea, it is recommended to use fillField.

I.pressKey('Backspace');

To press a key in combination with modifier keys, pass the sequence as an array. All modifier keys ('Alt', 'Control', 'Meta', 'Shift') will be released afterwards.

I.pressKey(['Control', 'Z']);

For specifying operation modifier key based on operating system it is suggested to use 'CommandOrControl'. This will press 'Command' (also known as 'Meta') on macOS machines and 'Control' on non-macOS machines.

I.pressKey(['CommandOrControl', 'Z']);

Some of the supported key names are:

  • 'AltLeft' or 'Alt'
  • 'AltRight'
  • 'ArrowDown'
  • 'ArrowLeft'
  • 'ArrowRight'
  • 'ArrowUp'
  • 'Backspace'
  • 'Clear'
  • 'ControlLeft' or 'Control'
  • 'ControlRight'
  • 'Command'
  • 'CommandOrControl'
  • 'Delete'
  • 'End'
  • 'Enter'
  • 'Escape'
  • 'F1' to 'F12'
  • 'Home'
  • 'Insert'
  • 'MetaLeft' or 'Meta'
  • 'MetaRight'
  • 'Numpad0' to 'Numpad9'
  • 'NumpadAdd'
  • 'NumpadDecimal'
  • 'NumpadDivide'
  • 'NumpadMultiply'
  • 'NumpadSubtract'
  • 'PageDown'
  • 'PageUp'
  • 'Pause'
  • 'Return'
  • 'ShiftLeft' or 'Shift'
  • 'ShiftRight'
  • 'Space'
  • 'Tab'

# Parameters

Returns void automatically synchronized promise through #recorder

# pressKeyDown

Presses a key in the browser and leaves it in a down state.

To make combinations with modifier key and user operation (e.g. 'Control' + click).

I.pressKeyDown('Control');
I.click('#element');
I.pressKeyUp('Control');

# Parameters

Returns void automatically synchronized promise through #recorder

# pressKeyUp

Releases a key in the browser which was previously set to a down state.

To make combinations with modifier key and user operation (e.g. 'Control' + click).

I.pressKeyDown('Control');
I.click('#element');
I.pressKeyUp('Control');

# Parameters

Returns void automatically synchronized promise through #recorder

# refreshPage

Reload the current page.

I.refreshPage();

Returns void automatically synchronized promise through #recorder

# resizeWindow

Appium: not tested in web, in apps doesn't work

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

# Parameters

Returns void automatically synchronized promise through #recorder

# rightClick

Performs right click on a clickable element matched by semantic locator, CSS or XPath.

// right click element with id el
I.rightClick('#el');
// right click link or button with text "Click me"
I.rightClick('Click me');
// right click button with text "Click me" inside .context
I.rightClick('Click me', '.context');

# Parameters

Returns void automatically synchronized promise through #recorder

This action supports React locators (opens new window)

# runInWeb

Placeholder for ~ locator only test case write once run on both Appium and WebDriver.

# Parameters

  • fn

# runOnAndroid

Placeholder for ~ locator only test case write once run on both Appium and WebDriver.

# Parameters

  • caps any
  • fn any

# runOnIOS

Placeholder for ~ locator only test case write once run on both Appium and WebDriver.

# Parameters

  • caps any
  • fn any

# saveElementScreenshot

Saves screenshot of the specified locator to ouput folder (set in codecept.conf.ts or codecept.conf.js). Filename is relative to output folder.

I.saveElementScreenshot(`#submit`,'debug.png');

# Parameters

Returns void automatically synchronized promise through #recorder

# saveScreenshot

Saves a screenshot to ouput folder (set in codecept.conf.ts or codecept.conf.js). Filename is relative to output folder. Optionally resize the window to the full available page scrollHeight and scrollWidth to capture the entire page by passing true in as the second argument.

I.saveScreenshot('debug.png');
I.saveScreenshot('debug.png', true) //resizes to available scrollHeight and scrollWidth before taking screenshot

# Parameters

Returns void automatically synchronized promise through #recorder

# scrollIntoView

Scroll element into viewport.

I.scrollIntoView('#submit');
I.scrollIntoView('#submit', true);
I.scrollIntoView('#submit', { behavior: "smooth", block: "center", inline: "center" });

# Parameters

Returns void automatically synchronized promise through #recorder

# scrollPageToBottom

Scroll page to the bottom.

I.scrollPageToBottom();

Returns void automatically synchronized promise through #recorder

# scrollPageToTop

Scroll page to the top.

I.scrollPageToTop();

Returns void automatically synchronized promise through #recorder

# 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

Returns void automatically synchronized promise through #recorder

# 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

Returns void automatically synchronized promise through #recorder

This action supports React locators (opens new window)

# seeAttributesOnElements

Checks that all elements with given locator have given attributes.

I.seeAttributesOnElements('//form', { method: "post"});

# Parameters

Returns void automatically synchronized promise through #recorder

# seeCheckboxIsChecked

Appium: not tested 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

Returns void automatically synchronized promise through #recorder

# seeCookie

Checks that cookie with given name exists.

I.seeCookie('Auth');

# Parameters

Returns void automatically synchronized promise through #recorder

# seeCssPropertiesOnElements

Checks that all elements with given locator have given CSS properties.

I.seeCssPropertiesOnElements('h3', { 'font-weight': "bold"});

# Parameters

Returns void automatically synchronized promise through #recorder

# 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

Returns void automatically synchronized promise through #recorder

# seeElement

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

I.seeElement('#modal');

# Parameters

Returns void automatically synchronized promise through #recorder

This action supports React locators (opens new window)

# seeElementInDOM

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

I.seeElementInDOM('#modal');

# Parameters

Returns void automatically synchronized promise through #recorder

# seeInCurrentUrl

Checks that current url contains a provided fragment.

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

# Parameters

Returns void automatically synchronized promise through #recorder

# 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

Returns void automatically synchronized promise through #recorder

# seeInPopup

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

# Parameters

# seeInSource

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

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

# Parameters

Returns void automatically synchronized promise through #recorder

# seeInTitle

Checks that title contains text.

I.seeInTitle('Home Page');

# Parameters

Returns void automatically synchronized promise through #recorder

# 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

Returns void automatically synchronized promise through #recorder

This action supports React locators (opens new window)

# seeNumberOfVisibleElements

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

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

# Parameters

Returns void automatically synchronized promise through #recorder

This action supports React locators (opens new window)

# seeTextEquals

Checks that text is equal to provided one.

I.seeTextEquals('text', 'h1');

# Parameters

Returns void automatically synchronized promise through #recorder

# seeTitleEquals

Checks that title is equal to provided one.

I.seeTitleEquals('Test title.');

# Parameters

Returns void automatically synchronized promise through #recorder

# seeTraffic

Note: Only works when devtoolsProtocol is enabled.

Verifies that a certain request is part of network traffic.

// checking the request url contains certain query strings
I.amOnPage('https://openai.com/blog/chatgpt');
I.startRecordingTraffic();
await I.seeTraffic({
    name: 'sentry event',
    url: 'https://images.openai.com/blob/cf717bdb-0c8c-428a-b82b-3c3add87a600',
    parameters: {
    width: '1919',
    height: '1138',
    },
  });

// checking the request url contains certain post data
I.amOnPage('https://openai.com/blog/chatgpt');
I.startRecordingTraffic();
await I.seeTraffic({
    name: 'event',
    url: 'https://cloudflareinsights.com/cdn-cgi/rum',
    requestPostData: {
    st: 2,
    },
  });

# Parameters

Returns void automatically synchronized promise through #recorder

# 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

Returns void automatically synchronized promise through #recorder

# setCookie

Uses Selenium's JSON cookie format (opens new window). Sets cookie(s).

Can be a single cookie object or an array of cookies:

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

// as array
I.setCookie([
  {name: 'auth', value: true},
  {name: 'agree', value: true}
]);

# Parameters

Returns void automatically synchronized promise through #recorder

# setGeoLocation

This method is deprecated.

Set the current geo location

I.setGeoLocation(121.21, 11.56);
I.setGeoLocation(121.21, 11.56, 10);

# Parameters

Returns void automatically synchronized promise through #recorder

# startRecordingTraffic

Note: Only works when devtoolsProtocol is enabled.

Starts recording the network traffics. This also resets recorded network requests.

I.startRecordingTraffic();

Returns void automatically synchronized promise through #recorder

# stopRecordingTraffic

Note: Only works when devtoolsProtocol is enabled.

Stops recording of network traffic. Recorded traffic is not flashed.

I.stopRecordingTraffic();

# switchTo

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

I.switchTo('iframe'); // switch to first iframe
I.switchTo(); // switch back to main page

# Parameters

Returns void automatically synchronized promise through #recorder

# switchToNextTab

Switch focus to a particular tab by its number. It waits tabs loading and then switch tab.

I.switchToNextTab();
I.switchToNextTab(2);

# Parameters

Returns void automatically synchronized promise through #recorder

# switchToPreviousTab

Switch focus to a particular tab by its number. It waits tabs loading and then switch tab.

I.switchToPreviousTab();
I.switchToPreviousTab(2);

# Parameters

Returns void automatically synchronized promise through #recorder

# switchToWindow

Switch to the window with a specified handle.

const windows = await I.grabAllWindowHandles();
// ... do something
await I.switchToWindow( windows[0] );

const window = await I.grabCurrentWindowHandle();
// ... do something
await I.switchToWindow( window );

# Parameters

# type

Types out the given text into an active field. To slow down typing use a second parameter, to set interval between key presses. Note: Should be used when fillField is not an option.

// passing in a string
I.type('Type this out.');

// typing values with a 100ms interval
I.type('4141555311111111', 100);

// passing in an array
I.type(['T', 'E', 'X', 'T']);

// passing a secret
I.type(secret('123456'));

# Parameters

Returns void automatically synchronized promise through #recorder

# uncheckOption

Appium: not tested Unselects 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.uncheckOption('#agree');
I.uncheckOption('I Agree to Terms and Conditions');
I.uncheckOption('agree', '//form');

# Parameters

Returns void automatically synchronized promise through #recorder

# useWebDriverTo

Use webdriverio (opens new window) API inside a test.

First argument is a description of an action. Second argument is async function that gets this helper as parameter.

{ browser (opens new window)) } object from WebDriver API is available.

I.useWebDriverTo('open multiple windows', async ({ browser }) {
   // create new window
   await browser.newWindow('https://webdriver.io');
});

# Parameters

# wait

Pauses execution for a number of seconds.

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

# Parameters

Returns void automatically synchronized promise through #recorder

# waitForClickable

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

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

# Parameters

Returns void automatically synchronized promise through #recorder

# waitForCookie

Waits for the specified cookie in the cookies.

I.waitForCookie("token");

# Parameters

Returns void automatically synchronized promise through #recorder

# waitForDetached

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.waitForDetached('#popup');

# Parameters

Returns void automatically synchronized promise through #recorder

# 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

Returns void automatically synchronized promise through #recorder

# waitForEnabled

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

# Parameters

Returns void automatically synchronized promise through #recorder

# waitForFunction

Waits for a function to return true (waits for 1 sec by default). Running in browser context.

I.waitForFunction(fn[, [args[, timeout]])

I.waitForFunction(() => window.requests == 0);
I.waitForFunction(() => window.requests == 0, 5); // waits for 5 sec
I.waitForFunction((count) => window.requests == count, [3], 5) // pass args and wait for 5 sec

# Parameters

Returns void automatically synchronized promise through #recorder

# waitForInvisible

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

I.waitForInvisible('#popup');

# Parameters

Returns void automatically synchronized promise through #recorder

# waitForNumberOfTabs

Waits for number of tabs.

I.waitForNumberOfTabs(2);

# Parameters

Returns void automatically synchronized promise through #recorder

# 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

Returns void automatically synchronized promise through #recorder

# waitForValue

Waits for the specified value to be in value attribute.

I.waitForValue('//input', "GoodValue");

# Parameters

Returns void automatically synchronized promise through #recorder

# 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

Returns void automatically synchronized promise through #recorder

# waitInUrl

Waiting for the part of the URL to match the expected. Useful for SPA to understand that page was changed.

I.waitInUrl('/info', 2);

# Parameters

Returns void automatically synchronized promise through #recorder

# waitNumberOfVisibleElements

Waits for a specified number of elements on the page.

I.waitNumberOfVisibleElements('a', 3);

# Parameters

Returns void automatically synchronized promise through #recorder

# waitToHide

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

I.waitToHide('#popup');

# Parameters

Returns void automatically synchronized promise through #recorder

# waitUrlEquals

Waits for the entire URL to match the expected

I.waitUrlEquals('/info', 2);
I.waitUrlEquals('http://127.0.0.1:8000/info');

# Parameters

Returns void automatically synchronized promise through #recorder

Last Updated: 2/16/2024, 11:18:12 AM

More Information

Videos

Books & Posts

Examples

Cookbook →

Commercial Services →

Trainings →

Testomat.io →
Plan your end 2 end tests, collaborate, synchronize with code & get reports!
Join Testomat.io while it is in beta and get a huge discount!

Support us via OpenCollective!