| permalink | /helpers/Puppeteer |
|---|---|
| editLink | false |
| sidebar | auto |
| title | Puppeteer |
Extends Helper
Uses Google Chrome's Puppeteer library to run tests inside headless Chrome. Browser control is executed via DevTools Protocol (instead of Selenium). This helper works with a browser out of the box with no additional tools required to install.
Requires puppeteer or puppeteer-core package to be installed.
npm i puppeteer --save
or
npm i puppeteer-core --save
Using puppeteer-core package, will prevent the download of browser binaries and allow connecting to an existing browser installation or for connecting to a remote one.
Experimental Firefox support can be activated.
This helper should be configured in codecept.conf.js
Type: object
urlstring base url of website to be testedbasicAuthobject? (optional) the basic authentication to pass to base url. Example: {username: 'username', password: 'password'}showboolean? show Google Chrome window for debug.restartboolean? restart browser between tests.disableScreenshotsboolean? don't save screenshot on failure.fullPageScreenshotsboolean? make full page screenshots on failure.uniqueScreenshotNamesboolean? option to prevent screenshot override if you have scenarios with the same name in different suites.traceboolean? record tracing information with screenshots.keepTraceForPassedTestsboolean? save trace for passed tests.keepBrowserStateboolean? keep browser state between tests whenrestartis set to false.keepCookiesboolean? keep cookies between tests whenrestartis set to false.waitForActionnumber? how long to wait after click, doubleClick or PressKey actions in ms. Default: 100.waitForNavigation(string | Array<string>)? when to consider navigation succeeded. Possible options:load,domcontentloaded,networkidle0,networkidle2. See Puppeteer API. Array values are accepted as well.pressKeyDelaynumber? delay between key presses in ms. Used when calling Puppeteers page.type(...) in fillField/appendFieldgetPageTimeoutnumber? config option to set maximum navigation time in milliseconds. If the timeout is set to 0, then timeout will be disabled.waitForTimeoutnumber? default wait* timeout in ms.windowSizestring? default window size. Set a dimension in format WIDTHxHEIGHT like640x480.userAgentstring? user-agent string.manualStartboolean? do not start browser before a test, start it manually inside a helper withthis.helpers["Puppeteer"]._startBrowser().browserstring? can be changed tofirefoxwhen using puppeteer-firefox.chromeobject? pass additional Puppeteer run options.highlightElementboolean? highlight the interacting elements. Default: false. Note: only activate under verbose mode (--verbose).
Find a single element using Puppeteer's native element discovery methods Note: Puppeteer Locator API doesn't have .first() method like Playwright
Returns Promise<Object> Single ElementHandle object
Find elements using Puppeteer's native element discovery methods Note: Unlike Playwright, Puppeteer's Locator API doesn't have .all() method for multiple elements
Returns Promise<Array> Array of ElementHandle objects
Trace recording provides complete information on test execution and includes screenshots, and network requests logged during run.
Traces will be saved to output/trace
trace: enables trace recording for failed tests; trace are saved intooutput/tracefolderkeepTraceForPassedTests: - save trace for passed tests
{
helpers: {
Puppeteer : {
url: "http://localhost",
restart: false,
waitForNavigation: "networkidle0",
waitForAction: 500
}
}
}{
helpers: {
Puppeteer : {
url: "http://localhost",
restart: false,
waitForNavigation: [ "domcontentloaded", "networkidle0" ],
waitForAction: 500
}
}
}{
helpers: {
Puppeteer : {
url: "http://localhost",
show: true
}
}
}Example #4: Connect to remote browser by specifying websocket endpoint
{
helpers: {
Puppeteer: {
url: "http://localhost",
chrome: {
browserWSEndpoint: "ws://localhost:9222/devtools/browser/c5aa6160-b5bc-4d53-bb49-6ecb36cd2e0a"
}
}
}
}Note: When connecting to remote browser
showand specificchromeoptions (e.g.headlessordevtools) are ignored.
{
helpers: {
Puppeteer : {
url: 'http://localhost',
basicAuth: {username: 'username', password: 'password'},
show: true
}
}
}Error Message: No usable sandbox!
When running Puppeteer on CI try to disable sandbox if you see that message
helpers: {
Puppeteer: {
url: 'http://localhost',
show: false,
chrome: {
args: ['--no-sandbox', '--disable-setuid-sandbox']
}
},
}
Receive Puppeteer client from a custom helper by accessing browser for the Browser object or page for the current Page object:
const { browser } = this.helpers.Puppeteer;
await browser.pages(); // List of pages in the browser
const { page } = this.helpers.Puppeteer;
await page.url(); // Get the url of the current pageconfig
Add the 'dialog' event listener to a page
page
Gets page URL including hash.
Get elements by different locator types, including strict locator Should be used in custom helpers:
const elements = await this.helpers['Puppeteer']._locate({name: 'password'});This action supports React locators
locator
Find a checkbox by providing human-readable text: NOTE: Assumes the checkable element exists
this.helpers['Puppeteer']._locateCheckable('I agree with terms and conditions').then // ...locatorprovidedContext
Find a clickable element by providing human-readable text:
this.helpers['Puppeteer']._locateClickable('Next page').then // ...locator
Get single element by different locator types, including strict locator Should be used in custom helpers:
const element = await this.helpers['Puppeteer']._locateElement({name: 'password'});This action supports React locators
locator
Find field elements by providing human-readable text:
this.helpers['Puppeteer']._locateFields('Your email').then // ...locator
Set current page
pageobject page to set
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.
Set the automatic popup response to Accept. This must be set before a popup is triggered.
I.amAcceptingPopups();
I.click('#triggerPopup');
I.acceptPopup();Set the automatic popup response to Cancel/Dismiss. This must be set before a popup is triggered.
I.amCancellingPopups();
I.click('#triggerPopup');
I.cancelPopup();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.
Returns void automatically synchronized promise through #recorder
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'));field(string | object) located by label|name|CSS|XPath|strict locatorvaluestring text value to append.
Returns void automatically synchronized promise through #recorder
This action supports React locators
⚠ There is an issue with file upload in Puppeteer 2.1.0 & 2.1.1, downgrade to 2.0.0 if you face it.
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');locator(string | object) field located by label|name|CSS|XPath|strict locator.pathToFilestring local file path relative to codecept.conf.ts or codecept.conf.js config file.
Returns void automatically synchronized promise through #recorder
Remove focus from a text input, button, etc. Calls blur 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');locator(string | object) field located by label|name|CSS|XPath|strict locator.optionsany? Playwright only: Additional options for available options object as 2nd argument.
Returns void automatically synchronized promise through #recorder
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.
Returns void automatically synchronized promise through #recorder
Clears a cookie by name, if none provided clears all cookies.
I.clearCookie();
I.clearCookie('test');namecookiestring? (optional,nullby default) cookie name
Clears a <textarea> or text <input> element's value.
I.clearField('Email');
I.clearField('user[email]');
I.clearField('#email');Returns void automatically synchronized promise through #recorder.
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 | null) (optional,nullby default) element to search in CSS|XPath|Strict locator.
Returns void automatically synchronized promise through #recorder
This action supports React locators
Performs a click on a link and waits for navigation before moving on.
I.clickLink('Logout', '#nav');locator(string | object) clickable link or button located by text, or any element located by CSS|XPath|strict locatorcontext(string? | object) (optional,nullby default) element to search in CSS|XPath|Strict locator
Returns void automatically synchronized promise through #recorder
This action supports React locators
Close current tab and switches to previous.
I.closeCurrentTab();Close all tabs except for the current one.
I.closeOtherTabs();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.
Returns void automatically synchronized promise through #recorder
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 nameReturns void automatically synchronized promise through #recorder
Checks that cookie with given name does not exist.
I.dontSeeCookie('auth'); // no auth cookienamestring cookie name.
Returns void automatically synchronized promise through #recorder
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.
Returns void automatically synchronized promise through #recorder
Opposite to seeElement. Checks that element is not visible (or in DOM)
I.dontSeeElement('.modal'); // modal is not shownReturns void automatically synchronized promise through #recorder
This 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 notReturns void automatically synchronized promise through #recorder
Checks that current url does not contain a provided fragment.
urlstring value to check.
Returns void automatically synchronized promise through #recorder
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.value(string | object) value to check.
Returns void automatically synchronized promise through #recorder
Checks that the current page does not contains the given string in its raw source code.
I.dontSeeInSource('<!--'); // no comments in sourcetextvaluestring to check.
Returns void automatically synchronized promise through #recorder
Checks that title does not contain text.
I.dontSeeInTitle('Error');textstring value to check.
Returns void automatically synchronized promise through #recorder
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/ });-
optsObject options when checking the traffic network.
Returns void automatically synchronized promise through #recorder
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');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.
Returns void automatically synchronized promise through #recorder
This action supports React locators
This method is deprecated.
Please use handleDownloads() instead.
locatorcustomName
Drag an item to a destination element.
I.dragAndDrop('#dragHandle', '#container');srcElement(string | object) located by CSS|XPath|strict locator.destElement(string | object) located by CSS|XPath|strict locator.
Returns void automatically synchronized promise through #recorder
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);locator(string | object) located by label|name|CSS|XPath|strict locator.offsetXnumber position to drag.
Returns void automatically synchronized promise through #recorder
This action supports React locators
Asynchronous scripts can also be executed with executeScript if a function returns a Promise.
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 = await I.executeAsyncScript(function(url, done) {
// in browser context
$.ajax(url, { success: (data) => done(data); }
}, 'http://ajax.callback.url/');args...any to be passed to function.fn(string | function) function to be executed in browser context.
Returns Promise script return value
If a function returns a Promise, tt will wait for its resolution.
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 selectorargs...any to be passed to function.fn(string | function) function to be executed in browser context.
Returns Promise script return value
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', 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');field(string | object) located by label|name|CSS|XPath|strict locator.value(string | object) text value to fill.
Returns void automatically synchronized promise through #recorder
This action supports React locators
Resets all recorded network requests.
I.flushNetworkTraffics();Resets all recorded WS messages.
Calls focus on the matching element.
Examples:
I.dontSee('#add-to-cart-btn');
I.focus('#product-tile')
I.see('#add-to-cart-bnt');locator(string | object) field located by label|name|CSS|XPath|strict locator.optionsany? Playwright only: Additional options for available options object as 2nd argument.
Returns void automatically synchronized promise through #recorder
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'});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.
Returns void automatically synchronized promise through #recorder
This action supports React locators
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');Returns Promise<string> attribute value
This action supports React locators
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');Returns Promise<Array<string>> attribute value
This action supports React locators
Get JS log from browser.
let logs = await I.grabBrowserLogs();
console.log(JSON.stringify(logs))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');namestring? cookie name.
Returns any attribute valueReturns cookie in JSON format. If name not passed returns all cookies for this domain.
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');locator(string | object) element located by CSS|XPath|strict locator.cssPropertystring CSS property name.
Returns Promise<string> CSS value
This action supports React locators
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');locator(string | object) element located by CSS|XPath|strict locator.cssPropertystring CSS property name.
Returns Promise<Array<string>> CSS value
This action supports React locators
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<string> current URL
Grab the data from performance timing using Navigation Timing API. The returned data will contain following things in ms:
- responseEnd,
- domInteractive,
- domContentLoadedEventEnd,
- loadEventEnd
Resumes test execution, so should be used inside an async function with
awaitoperator.
await I.amOnPage('https://example.com');
let data = await I.grabDataFromPerformanceTiming();
//Returned data
{ // all results are in [ms]
responseEnd: 23,
domInteractive: 44,
domContentLoadedEventEnd: 196,
loadEventEnd: 241
}Returns void automatically synchronized promise through #recorder
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 == 527locator(string | object) element located by CSS|XPath|strict locator.propelementSizestring? x, y, width or height of the given element.
Returns (Promise | Promise<number>) Element bounding rectangle
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');Returns Promise<string> HTML code for an element
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');Returns Promise<Array<string>> HTML code for an element
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<number> number of open tabs
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');Returns Promise<number> number of visible elements
This action supports React locators
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 scroll position
Grab the text within the popup. If no popup is visible then it will return null
await I.grabPopupText();Returns Promise<(string | null)>
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 recorded network traffics
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<string> source code
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.
Returns Promise<string> attribute value
This action supports React locators
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');Returns Promise<Array<string>> attribute value
This action supports React locators
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();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]');Returns Promise<string> attribute value
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');Returns Promise<Array<string>> attribute value
Grab WebElement for given locator
Resumes test execution, so should be used inside an async function with await operator.
const webElement = await I.grabWebElement('#button');Returns Promise WebElement of being used Web helper
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');Returns Promise WebElement of being used Web helper
Grab the recording WS messages
Sets a directory to where save files. Allows to test file downloads. Should be used with FileSystem helper to check that file were downloaded correctly.
By default, files are saved to output/downloads.
This directory is cleaned on every handleDownloads call, to ensure no old files are kept.
I.handleDownloads();
I.click('Download Avatar');
I.amInPath('output/downloads');
I.seeFile('avatar.jpg');downloadPathstring change this parameter to set another directory for saving
Mocks network request using Request Interception
I.mockRoute(/(.png$)|(.jpg$)/, route => route.abort());This method allows intercepting and mocking requests & responses. Learn more about it
url(string | RegExp)? URL, regex or pattern for to match URLhandlerfunction? a function to process request
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);locator(string | object) located by CSS|XPath|strict locator.offsetXnumber (optional,0by default) X-axis offset.offsetYnumber (optional,0by default) Y-axis offset.
Returns void automatically synchronized promise through #recorder
This action supports React locators
Open new tab and switch to it
I.openNewTab();Note: Shortcuts like 'Meta' + 'A' do not work on macOS (puppeteer/puppeteer#1313).
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'
Returns void automatically synchronized promise through #recorder
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');keystring name of key to press down.
Returns void automatically synchronized promise through #recorder
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');keystring name of key to release.
Returns void automatically synchronized promise through #recorder
Reload the current page.
I.refreshPage();Returns void automatically synchronized promise through #recorder
Unlike other drivers Puppeteer changes the size of a viewport, not the window! Puppeteer does not control the window of a browser, so it can't adjust its real size. It also can't maximize a window.
Resize the current window to provided width and height.
First parameter can be set to maximize.
Returns void automatically synchronized promise through #recorder
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');locator(string | object) clickable element located by CSS|XPath|strict locator.context(string? | object) (optional,nullby default) element located by CSS|XPath|strict locator.
Returns void automatically synchronized promise through #recorder
This action supports React locators
Saves screenshot of the specified locator to output folder (set in codecept.conf.ts or codecept.conf.js). Filename is relative to output folder.
I.saveElementScreenshot(`#submit`,'debug.png');locator(string | object) element located by CSS|XPath|strict locator.fileNamestring file name to save.
Returns void automatically synchronized promise through #recorder
Saves a screenshot to output 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
I.saveScreenshot('customFolder/debug.png') //saves to customFolder/debug.pngfileNamestring file name to save.fullPageboolean (optional,falseby default) flag to enable fullscreen screenshot mode.
Returns void automatically synchronized promise through #recorder
Scroll page to the bottom.
I.scrollPageToBottom();Returns void automatically synchronized promise through #recorder
Scroll page to the top.
I.scrollPageToTop();Returns void automatically synchronized promise through #recorder
Scrolls to element matched by locator. Extra shift can be set with offsetX and offsetY options.
I.scrollTo('footer');
I.scrollTo('#submit', 5, 5);locator(string | object) located by CSS|XPath|strict locator.offsetXnumber (optional,0by default) X-axis offset.offsetYnumber (optional,0by default) Y-axis offset.
Returns void automatically synchronized promise through #recorder
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 locatortextstring expected on page.context(string? | object) (optional,nullby default) element located by CSS|Xpath|strict locator in which to search for text.
Returns void automatically synchronized promise through #recorder
This action supports React locators
Checks that all elements with given locator have given attributes.
I.seeAttributesOnElements('//form', { method: "post"});locator(string | object) located by CSS|XPath|strict locator.attributesobject attributes and their values to check.
Returns void automatically synchronized promise through #recorder
This action supports React locators
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]'});Returns void automatically synchronized promise through #recorder
Checks that cookie with given name exists.
I.seeCookie('Auth');namestring cookie name.
Returns void automatically synchronized promise through #recorder
Checks that all elements with given locator have given CSS properties.
I.seeCssPropertiesOnElements('h3', { 'font-weight': "bold"});locator(string | object) located by CSS|XPath|strict locator.cssPropertiesobject object with CSS properties and their values to check.
Returns void automatically synchronized promise through #recorder
This action supports React locators
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');urlstring value to check.
Returns void automatically synchronized promise through #recorder
Checks that a given Element is visible Element is located by CSS or XPath.
I.seeElement('#modal');Returns void automatically synchronized promise through #recorder
This action supports React locators
Checks that a given Element is present in the DOM Element is located by CSS or XPath.
I.seeElementInDOM('#modal');Returns void automatically synchronized promise through #recorder
Checks that current url contains a provided fragment.
I.seeInCurrentUrl('/register'); // we are on registration pageurlstring a fragment to check
Returns void automatically synchronized promise through #recorder
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');field(string | object) located by label|name|CSS|XPath|strict locator.value(string | object) value to check.
Returns void automatically synchronized promise through #recorder
Checks that the active JavaScript popup, as created by window.alert|window.confirm|window.prompt, contains the
given string.
I.seeInPopup('Popup text');textstring value to check.
Returns void automatically synchronized promise through #recorder
Checks that the current page contains the given string in its raw source code.
I.seeInSource('<h1>Green eggs & ham</h1>');textstring value to check.
Returns void automatically synchronized promise through #recorder
Checks that title contains text.
I.seeInTitle('Home Page');textstring text value to check.
Returns void automatically synchronized promise through #recorder
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);locator(string | object) element located by CSS|XPath|strict locator.numnumber number of elements.
Returns void automatically synchronized promise through #recorder
This action supports React locators
Asserts that an element is visible a given number of times. Element is located by CSS or XPath.
I.seeNumberOfVisibleElements('.buttons', 3);locator(string | object) element located by CSS|XPath|strict locator.numnumber number of elements.
Returns void automatically synchronized promise through #recorder
This action supports React locators
Checks that text is equal to provided one.
I.seeTextEquals('text', 'h1');textstring element value to check.context(string | object)? element located by CSS|XPath|strict locator.
Returns void automatically synchronized promise through #recorder
Checks that title is equal to provided one.
I.seeTitleEquals('Test title.');textstring value to check.
Returns void automatically synchronized promise through #recorder
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,
},
});-
optsObject options when checking the traffic network.opts.namestring A name of that request. Can be any value. Only relevant to have a more meaningful error message in case of fail.opts.urlstring Expected URL of request in network trafficopts.parametersObject? Expected parameters of that request in network trafficopts.requestPostDataObject? Expected that request contains post data in network trafficopts.timeoutnumber? Timeout to wait for request in seconds. Default is 10 seconds.
Returns void automatically synchronized promise through #recorder
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']);select(string | object) field located by label|name|CSS|XPath|strict locator.option(string | Array) visible text or value of option.
Returns void automatically synchronized promise through #recorder
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}
]);cookie(Cookie | Array) a cookie object or array of cookie objects.
Returns void automatically synchronized promise through #recorder
Set headers for all next requests
I.setPuppeteerRequestHeaders({
'X-Sent-By': 'CodeceptJS',
});customHeadersobject headers to set
Starts recording the network traffics. This also resets recorded network requests.
I.startRecordingTraffic();Returns void automatically synchronized promise through #recorder
Starts recording of websocket messages. This also resets recorded websocket messages.
await I.startRecordingWebSocketMessages();Returns void automatically synchronized promise through #recorder
Stops network mocking created by mockRoute.
I.stopMockingRoute(/(.png$)|(.jpg$)/);Stops recording of network traffic. Recorded traffic is not flashed.
I.stopRecordingTraffic();Stops recording WS messages. Recorded WS messages is not flashed.
await I.stopRecordingWebSocketMessages();Returns void automatically synchronized promise through #recorder
Switches frame or in case of null locator reverts to parent.
I.switchTo('iframe'); // switch to first iframe
I.switchTo(); // switch back to main pageReturns void automatically synchronized promise through #recorder
Switch focus to a particular tab by its number. It waits tabs loading and then switch tab
I.switchToNextTab();
I.switchToNextTab(2);numnumber
Switch focus to a particular tab by its number. It waits tabs loading and then switch tab
I.switchToPreviousTab();
I.switchToPreviousTab(2);numnumber
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'));keysdelaynumber? (optional) delay in ms between key presseskey(string | Array<string>) or array of keys to type.
Returns void automatically synchronized promise through #recorder
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');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.
Returns void automatically synchronized promise through #recorder
Use Puppeteer API inside a test.
First argument is a description of an action. Second argument is async function that gets this helper as parameter.
{ page, browser } from Puppeteer API are available.
I.usePuppeteerTo('emulate offline mode', async ({ page }) {
await page.setOfflineMode(true);
});descriptionstring used to show in logs.fnfunction async function that is executed with Puppeteer as argument
Pauses execution for a number of seconds.
I.wait(2); // wait 2 secssecnumber number of second to wait.
Returns void automatically synchronized promise through #recorder
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 secslocator(string | object) element located by CSS|XPath|strict locator.waitTimeoutsecnumber? (optional,1by default) time in seconds to wait
Returns void automatically synchronized promise through #recorder
Waits for the specified cookie in the cookies.
I.waitForCookie("token");Returns void automatically synchronized promise through #recorder
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');locator(string | object) element located by CSS|XPath|strict locator.secnumber (optional,1by default) time in seconds to wait
Returns void automatically synchronized promise through #recorder
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 secslocator(string | object) element located by CSS|XPath|strict locator.secnumber? (optional,1by default) time in seconds to wait
Returns void automatically synchronized promise through #recorder
This action supports React locators
Waits for element to become enabled (by default waits for 1sec). Element can be located by CSS or XPath.
locator(string | object) element located by CSS|XPath|strict locator.secnumber (optional) time in seconds to wait, 1 by default.
Returns void automatically synchronized promise through #recorder
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 secfn(string | function) to be executed in browser context.argsOrSec(Array | number)? (optional,1by default) arguments for function or seconds.secnumber? (optional,1by default) time in seconds to wait
Returns void automatically synchronized promise through #recorder
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');locator(string | object) element located by CSS|XPath|strict locator.secnumber (optional,1by default) time in seconds to wait
Returns void automatically synchronized promise through #recorder
Waits for navigation to finish. By default, takes configured waitForNavigation option.
optsany
Waits for number of tabs.
I.waitForNumberOfTabs(2);Returns void automatically synchronized promise through #recorder
Waits for a network request.
I.waitForRequest('http://example.com/resource');
I.waitForRequest(request => request.url() === 'http://example.com' && request.method() === 'GET');Waits for a network response.
I.waitForResponse('http://example.com/resource');
I.waitForResponse(response => response.url() === 'http://example.com' && response.request().method() === 'GET');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');textstring to wait for.secnumber (optional,1by default) time in seconds to waitcontext(string | object)? (optional) element located by CSS|XPath|strict locator.
Returns void automatically synchronized promise through #recorder
Waits for the specified value to be in value attribute.
I.waitForValue('//input', "GoodValue");field(string | object) input field.valuestring expected value.secnumber (optional,1by default) time in seconds to wait
Returns void automatically synchronized promise through #recorder
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');locator(string | object) element located by CSS|XPath|strict locator.secnumber (optional,1by default) time in seconds to wait
Returns void automatically synchronized promise through #recorder
This action supports React locators
Waiting for the part of the URL to match the expected. Useful for SPA to understand that page was changed.
I.waitInUrl('/info', 2);Returns void automatically synchronized promise through #recorder
Waits for a specified number of elements on the page.
I.waitNumberOfVisibleElements('a', 3);locator(string | object) element located by CSS|XPath|strict locator.numnumber number of elements.secnumber (optional,1by default) time in seconds to wait
Returns void automatically synchronized promise through #recorder
This action supports React locators
Waits for an element to hide (by default waits for 1sec). Element can be located by CSS or XPath.
I.waitToHide('#popup');locator(string | object) element located by CSS|XPath|strict locator.secnumber (optional,1by default) time in seconds to wait
Returns void automatically synchronized promise through #recorder
Waits for the entire URL to match the expected
I.waitUrlEquals('/info', 2);
I.waitUrlEquals('http://127.0.0.1:8000/info');Returns void automatically synchronized promise through #recorder