Obscura

Extends CDPBrowser

Obscura drives Obscura, a lightweight headless browser controlled over the Chrome DevTools Protocol. Default builds from v0.2.0 render pages (layout, screenshots); -no-render builds and v0.1.x run JavaScript and the DOM only. The helper detects which build it runs against, so the same config works for both.

The helper starts and stops obscura serve for you, the same way Playwright manages its browser.

Obscura support is experimental in CodeceptJS 4.2. Pin the browser version in CI and keep a Playwright/WebDriver job for browser-compatibility coverage.

Compatibility

CodeceptJS	Recommended Obscura	Notes
4.2.x	0.2.2	Version used by the CodeceptJS Obscura CI workflow
4.2.x	0.2.x	Supported; capabilities are detected at runtime
4.2.x	0.1.x / -no-render	DOM-only mode; no layout, visibility assertions, or screenshots

Modes

• ATTACH — endpoint is set explicitly in the config. The helper only connects to it; it never spawns or kills anything, no matter what binaryPath/port are set to.
• SELF-LAUNCH — endpoint is unset and a binary can be resolved, in order: binaryPath in the config, then the OBSCURA_PATH environment variable, then obscura on PATH. The helper spawns obscura serve --port <port> --allow-private-network --allow-file-access (port from the config, or a free port picked automatically), waits for it to answer, connects, and stops it when tests finish.
• COURTESY-ATTACH — endpoint is unset and no binary can be resolved, but something already answers http://127.0.0.1:9222/json/version (e.g. obscura serve started by hand, or by CI before this process ever ran). The helper attaches to it and never kills it — it isn’t the helper’s process to kill. If neither a binary nor a running server on :9222 can be found, the helper throws a loud, actionable error.

Install

Download a release archive from Obscura releases. CodeceptJS 4.2 is tested with Obscura 0.2.2. Rendering archives are available for:

platform	archive
Linux x64	obscura-x86_64-linux.tar.gz
Linux ARM64	obscura-aarch64-linux.tar.gz
macOS Intel	obscura-x86_64-macos.tar.gz
macOS Apple Silicon	obscura-aarch64-macos.tar.gz
Windows x64	obscura-x86_64-windows.zip

Extract the archive and put obscura (obscura.exe on Windows) on your PATH, or point binaryPath/OBSCURA_PATH at it. The helper then launches and tears it down automatically. For example, on Linux x64:

curl -sL https://github.com/h4ckf0r0day/obscura/releases/download/v0.2.2/obscura-x86_64-linux.tar.gz | tar xz

--allow-private-network and --allow-file-access are always passed by this helper: the first is required to reach apps running on localhost/private IPs, e.g. a dev server on 127.0.0.1:8000, the second to let attachFile upload local files. Obscura blocks both by default.

Config presets

These are set automatically and only need overriding for unusual setups:

option	value	why
input	synthetic	clicks that navigate are unreliable in Obscura, so click behaves like forceClick
xpathPolyfill	auto	Obscura’s XPath lacks attribute selection and not(), so the polyfill is used when needed

capabilities are detected at runtime from the Obscura build. Set them in your config to skip detection or to force a mode.

Limitations

• input is always synthetic, even on rendering builds — see input above.
• No frames or popups.
• On -no-render builds and v0.1.x: no screenshots, no visibility assertions (seeElement/dontSeeElement always throw) — only DOM presence (seeElementInDOM/dontSeeElementInDOM) is meaningful without a layout engine.
• On v0.2.0+ default (rendering) builds: layout, screenshots, and CSS work, but it’s a new, independently implemented rendering/CSS engine — expect edge cases and gaps versus a real browser.
• Single V8 isolate: heavy or long-running pages, or many pages in parallel against one obscura serve process, compete for the same isolate.

Configuration

This helper should be configured in codecept.conf.js

Type: object

Properties

• endpoint string? connect to a running Obscura instead of starting one (ATTACH mode).
• binaryPath string? path to the obscura executable. Checked before OBSCURA_PATH and PATH.
• port number? port for obscura serve. A free port is picked when unset, so parallel workers never collide.
• serverStartTimeout number? how long to wait for obscura serve to start, in milliseconds.
• url string? base url of website to be tested.
• headers object? headers sent when connecting to the endpoint, e.g. for authenticated remote browsers.
• input string? how actions are dispatched: cdp (real mouse and keyboard events) or synthetic (DOM events). auto picks cdp when the browser renders layout.
• xpathPolyfill (string | boolean)? inject an XPath polyfill for browsers with incomplete XPath support. auto detects when it is needed.
• capabilities object? browser capabilities (layout, xpath, screenshot, video, innerText, aria) to use instead of detecting them at runtime.
• waitForTimeout number? default timeout for wait* actions, in seconds.
• waitForAction number? fixed delay after each action, in milliseconds. When unset, actions wait only for the navigation they trigger.
• pollInterval number? interval between checks while waiting, in milliseconds.
• getPageTimeout number? maximum time to wait for a page to load, in seconds.
• waitForNavigation string? when a navigation is considered finished: load, domcontentloaded, or networkidle.

Example

// inside codecept.conf.js — SELF-LAUNCH mode (recommended): the helper finds/starts/stops
// obscura serve on its own, on a free port. Ideal for run-workers: every worker gets its own
// instance with no config.
{
  helpers: {
    Obscura: {
      url: 'http://localhost',
    }
  }
}

// ATTACH mode — connect to an Obscura instance you manage yourself (remote host, container, etc.)
{
  helpers: {
    Obscura: {
      url: 'http://localhost',
      endpoint: 'http://127.0.0.1:9222',
    }
  }
}

Methods

Parameters

• config ObscuraConfig

amOnPage

Opens a web page in a browser. Requires relative or absolute url. If url starts with /, opens a web page of a site defined in url config parameter.

I.amOnPage('/'); // opens main page of website
I.amOnPage('https://github.com'); // opens github
I.amOnPage('/login'); // opens a login page

Parameters

• url string url path or global url.

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

The third parameter is an optional context (CSS or XPath locator) to narrow the search.

I.appendField('#myTextField', 'appended');
// typing secret
I.appendField('password', secret('123456'));
// within a context
I.appendField('name', 'John', '.form-container');

Parameters

• field (string | object) located by label|name|CSS|XPath|strict locator
• value string text value to append.
• context (string? | object) (optional, null by default) element located by CSS | XPath | strict locator.

Returns void automatically synchronized promise through #recorder

attachFile

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).

The third parameter is an optional context (CSS or XPath locator) to narrow the search.

I.attachFile('Avatar', 'data/avatar.jpg');
I.attachFile('form input[name=avatar]', 'data/avatar.jpg');
// within a context
I.attachFile('Avatar', 'data/avatar.jpg', '.form-container');

If the locator points to a non-file-input element (e.g., a dropzone area), the file will be dropped onto that element using drag-and-drop events.

I.attachFile('#dropzone', 'data/avatar.jpg');

Parameters

• field
• pathToFile string local file path relative to codecept.conf.ts or codecept.conf.js config file.
• context (string? | object) (optional, null by default) element located by CSS | XPath | strict locator.
• locator (string | object) field located by label|name|CSS|XPath|strict locator.

Returns void automatically synchronized promise through #recorder

blur

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

Parameters

• locator (string | object) field located by label|name|CSS|XPath|strict locator.
• options any? Playwright only: Additional options for available options object as 2nd argument.

Returns void automatically synchronized promise through #recorder

capabilities

Type: CodeceptJS.HelperCapabilities

checkOption

Selects a checkbox or radio button. Element is located by label or name or CSS or XPath.

The second parameter is an optional context (CSS or XPath locator) to narrow the search.

I.checkOption('#agree');
I.checkOption('I Agree to Terms and Conditions');
I.checkOption('agree', '//form');

Parameters

• field (string | object) checkbox located by label | name | CSS | XPath | strict locator.
• context (string? | object) (optional, null by default) element located by CSS | XPath | strict locator.

Returns void automatically synchronized promise through #recorder

clearClipboard

Clears the system clipboard.

I.clearClipboard();
I.seeClipboardEquals('');

Returns void automatically synchronized promise through #recorder

clearCookie

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

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

Parameters

• name
• cookie string? (optional, null by default) cookie name

clearField

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

The second parameter is an optional context (CSS or XPath locator) to narrow the search.

I.clearField('Email');
I.clearField('user[email]');
I.clearField('#email');
// within a context
I.clearField('Email', '.form-container');

Parameters

• field
• context (string? | object) (optional, null by default) element located by CSS | XPath | strict locator.
• editable (string | object) field located by label|name|CSS|XPath|strict locator.

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.

If no locator is provided, defaults to clicking the body element ('//body').

The second parameter is a context (CSS or XPath locator) to narrow the search.

// click body element (default)
I.click();
// 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'});
// using ARIA role locator
I.click({role: 'button', name: 'Submit'});

ℹ️ ARIA role locators ({role, name}) match elements the way assistive technology does and survive markup refactors. See Locators.

Parameters

• locator (string | object) (optional, '//body' by default) clickable link or button located by text, or any element located by CSS|XPath|strict locator.
• context (string? | object | null) (optional, null by default) element to search in CSS|XPath|Strict locator.

Returns void automatically synchronized promise through #recorder

clickXY

Clicks at page coordinates, or at coordinates relative to an element. Requires a browser that renders layout.

I.clickXY(100, 200); // page coordinates
I.clickXY('#area', 50, 30); // relative to #area

Parameters

• locator (string | object | number) element to click relative to, or the X page coordinate.
• x number? X coordinate relative to the element, or the Y page coordinate if locator is a number.
• y number? Y coordinate relative to the element.

Returns void automatically synchronized promise through #recorder

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

• text string 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

dontSeeCheckboxIsChecked

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

• locator
• field (string | object) located by label|name|CSS|XPath|strict locator.

Returns void automatically synchronized promise through #recorder

dontSeeCookie

Checks that cookie with given name does not exist.

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

Parameters

• name string cookie name.

Returns void automatically synchronized promise through #recorder

dontSeeCurrentPathEquals

Checks that current URL path does NOT match the expected path. Query strings and URL fragments are ignored.

I.dontSeeCurrentPathEquals('/form'); // fails for '/form', '/form?user=1', '/form#section'
I.dontSeeCurrentPathEquals('/'); // fails for '/', '/?user=ok', '/#top'

Parameters

• path string value to check.

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

• url string value to check.

Returns void automatically synchronized promise through #recorder

dontSeeElement

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

The second parameter is a context (CSS or XPath locator) to narrow the search.

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

Parameters

• locator (string | object) located by CSS|XPath|Strict locator.
• context (string? | object) (optional, null by default) element located by CSS | XPath | strict locator.

Returns void automatically synchronized promise through #recorder

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

• locator (string | object) located by CSS|XPath|Strict locator.

Returns void automatically synchronized promise through #recorder

dontSeeInCurrentUrl

Checks that current url does not contain a provided fragment.

Parameters

• url string value to check.

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.

The third parameter is an optional context (CSS or XPath locator) to narrow the search.

I.dontSeeInField('email', 'user@user.com'); // field by name
I.dontSeeInField({ css: 'form input.email' }, 'user@user.com'); // field by CSS
// within a context
I.dontSeeInField('Name', 'old_value', '.form-container');

Parameters

• field (string | object) located by label|name|CSS|XPath|strict locator.
• value (string | object) value to check.
• context (string? | object) (optional, null by default) element located by CSS | XPath | strict locator.

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

• text
• value string to check.

Returns void automatically synchronized promise through #recorder

dontSeeInTitle

Checks that title does not contain text.

I.dontSeeInTitle('Error');

Parameters

• text string value to check.

Returns void automatically synchronized promise through #recorder

dontSeeTraffic

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

• opts Object options when checking the traffic network.

  • opts.name string A name of that request. Can be any value. Only relevant to have a more meaningful error message in case of fail.
  • opts.url (string | RegExp) Expected URL of request in network traffic. Can be a string or a regular expression.

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

• locator (string | object) clickable link or button located by text, or any element located by CSS|XPath|strict locator.
• context (string? | object) (optional, null by default) element to search in CSS|XPath|Strict locator.

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.

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

• fn (string | function) function to be executed in browser context.
• args …any to be passed to function.

Returns Promise script return value

executeScript

Executes sync script on a page. Pass arguments to function as additional parameters. Will return execution result to a test. In this case you should use 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

• fn (string | function) function to be executed in browser context.
• args …any to be passed to function.

Returns Promise 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.

The third parameter is an optional context (CSS or XPath locator) to narrow the search.

// 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');
// by ARIA role locator
I.fillField({role: 'textbox', name: 'Email'}, 'hello@world.com');
// within a context
I.fillField('Name', 'John', '#section2');

ℹ️ ARIA role locators ({role, name}) match fields by their accessible name and survive markup refactors. See Locators.

Parameters

• field (string | object) located by label|name|CSS|XPath|strict locator.
• value (string | object) text value to fill.
• context (string? | object) (optional, null by default) element located by CSS | XPath | strict locator.

Returns void automatically synchronized promise through #recorder

flushNetworkTraffics

Resets all recorded network requests.

I.flushNetworkTraffics();

focus

Calls focus on the matching element.

Examples:

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

Parameters

• locator (string | object) field located by label|name|CSS|XPath|strict locator.
• options any? Playwright only: Additional options for available options object as 2nd argument.

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

• locator (string | object) clickable link or button located by text, or any element located by CSS|XPath|strict locator.
• context (string? | object) (optional, null by default) element to search in CSS|XPath|Strict locator.

Returns void automatically synchronized promise through #recorder

grabAriaSnapshot

Retrieves the ARIA snapshot of the page, or of an element, built from the browser accessibility tree. The format matches Playwright’s ARIA snapshots.

const snapshot = await I.grabAriaSnapshot();
const formSnapshot = await I.grabAriaSnapshot('#login-form');

Parameters

• locator (string | object) element located by CSS|XPath|strict locator. Defaults to body element.

Returns Promise<string> YAML representation of the accessibility tree

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

• locator (string | object) element located by CSS|XPath|strict locator.
• attr string attribute name.

Returns Promise<string> 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

• locator (string | object) element located by CSS|XPath|strict locator.
• attr string attribute name.

Returns Promise<Array<string>> attribute value

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

• name string? cookie name.

Returns any attribute value

grabCookies

Retrieves all cookies visible to the current page. Resumes test execution, so should be used inside async function with await operator.

let cookies = await I.grabCookies();

Returns Promise<Array<CodeceptJS.Cookie>> array of cookie objects.

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

• locator (string | object) element located by CSS|XPath|strict locator.
• cssProperty string CSS property name.

Returns Promise<string> 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

• locator (string | object) element located by CSS|XPath|strict locator.
• cssProperty string CSS property name.

Returns Promise<Array<string>> 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<string> current URL

grabFromClipboard

Grabs the text content of the system clipboard and returns it to test. Resumes test execution, so should be used inside async function with await operator.

I.click('Copy to clipboard');
let url = await I.grabFromClipboard();

Reading the clipboard requires a secure context (https or localhost) and is supported in Chromium-based browsers, where read access is granted automatically.

Returns Promise<string> the system clipboard contents.

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

• locator
• element (string | object) located by CSS|XPath|strict locator.

Returns Promise<string> 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

• locator
• element (string | object) located by CSS|XPath|strict locator.

Returns Promise<Array<string>> HTML code for an element

grabNumberOfElements

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

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

Parameters

• locator (string | object) located by CSS|XPath|strict locator.

Returns Promise<number> number of matched elements.

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

• locator (string | object) located by CSS|XPath|strict locator.

Returns Promise<number> 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 scroll position

grabRecordedNetworkTraffics

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

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<string> 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

• locator (string | object) element located by CSS|XPath|strict locator.

Returns Promise<string> 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

• locator (string | object) element located by CSS|XPath|strict locator.

Returns Promise<Array<string>> 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<string> 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

• locator (string | object) field located by label|name|CSS|XPath|strict locator.

Returns Promise<string> 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

• locator (string | object) field located by label|name|CSS|XPath|strict locator.

Returns Promise<Array<string>> attribute value

grabWebElement

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

Parameters

• locator (string | object) element located by CSS|XPath|strict locator.

Returns Promise WebElement of being used Web helper

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

• locator (string | object) element located by CSS|XPath|strict locator.

Returns Promise WebElement of being used Web helper

pressKey

Presses a key or a key combination on the focused element.

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

Parameters

• key (string | Array<string>) a key or an array of keys to combine (modifiers first).

Returns void automatically synchronized promise through #recorder

refreshPage

Reload the current page.

I.refreshPage();

Returns void automatically synchronized promise through #recorder

resizeWindow

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

Parameters

• width number width in pixels or maximize.
• height number height in pixels.

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

• locator (string | object) clickable element located by CSS|XPath|strict locator.
• context (string? | object) (optional, null by default) element located by CSS|XPath|strict locator.

Returns void automatically synchronized promise through #recorder

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

• locator (string | object) element located by CSS|XPath|strict locator.
• fileName string file name to save.

Returns void automatically synchronized promise through #recorder

saveScreenshot

Saves a screenshot to the output folder (set in codecept.conf.ts or codecept.conf.js). Filename is relative to the output folder.

I.saveScreenshot('debug.png');

Parameters

• fileName string file name to save.

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

• locator (string | object) located by CSS|XPath|strict locator.
• offsetX number (optional, 0 by default) X-axis offset.
• offsetY number (optional, 0 by default) Y-axis offset.

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

• text string expected on page.
• context (string? | object) (optional, null by default) element located by CSS|Xpath|strict locator in which to search for text.

Returns void automatically synchronized promise through #recorder

seeAttributesOnElements

Checks that all elements with given locator have given attributes.

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

Parameters

• locator (string | object) located by CSS|XPath|strict locator.
• attributes object attributes and their values to check.

Returns void automatically synchronized promise through #recorder

seeCheckboxIsChecked

Verifies that the specified checkbox is checked.

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

Parameters

• locator
• field (string | object) located by label|name|CSS|XPath|strict locator.

Returns void automatically synchronized promise through #recorder

seeClipboardEquals

Checks that the system clipboard is equal to the given text.

I.click('Copy to clipboard');
I.seeClipboardEquals('https://codecept.io');

Reading the clipboard requires a secure context (https or localhost) and is supported in Chromium-based browsers, where read access is granted automatically.

Parameters

• text string value to check.

Returns void automatically synchronized promise through #recorder

seeCookie

Checks that cookie with given name exists.

I.seeCookie('Auth');

Parameters

• name string cookie name.

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

• locator (string | object) located by CSS|XPath|strict locator.
• cssProperties object object with CSS properties and their values to check.

Returns void automatically synchronized promise through #recorder

seeCurrentPathEquals

Checks that current URL path matches the expected path. Query strings and URL fragments are ignored.

I.seeCurrentPathEquals('/info'); // passes for '/info', '/info?user=1', '/info#section'
I.seeCurrentPathEquals('/'); // passes for '/', '/?user=ok', '/#top'

Parameters

• path string value to check.

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

• url string value to check.

Returns void automatically synchronized promise through #recorder

seeElement

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

The second parameter is a context (CSS or XPath locator) to narrow the search.

I.seeElement('#modal');
I.seeElement('#modal', '#container');
// using ARIA role locator
I.seeElement({role: 'dialog'});

ℹ️ ARIA role locators ({role, name}) match elements the way assistive technology does and survive markup refactors. See Locators.

Parameters

• locator (string | object) located by CSS|XPath|strict locator.
• context (string? | object) (optional, null by default) element located by CSS | XPath | strict locator.

Returns void automatically synchronized promise through #recorder

seeElementInDOM

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

I.seeElementInDOM('#modal');

Parameters

• locator (string | object) element located by CSS|XPath|strict locator.

Returns void automatically synchronized promise through #recorder

seeInClipboard

Checks that the system clipboard contains the given text.

I.click('Copy to clipboard');
I.seeInClipboard('https://codecept.io');

Reading the clipboard requires a secure context (https or localhost) and is supported in Chromium-based browsers, where read access is granted automatically.

Parameters

• text string value to check.

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

• url string a fragment to check

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.

The third parameter is an optional context (CSS or XPath locator) to narrow the search.

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');
// within a context
I.seeInField('Name', 'John', '.form-container');

Parameters

• field (string | object) located by label|name|CSS|XPath|strict locator.
• value (string | object) value to check.
• context (string? | object) (optional, null by default) element located by CSS | XPath | strict locator.

Returns void automatically synchronized promise through #recorder

seeInSource

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

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

Parameters

• text string value to check.

Returns void automatically synchronized promise through #recorder

seeInTitle

Checks that title contains text.

I.seeInTitle('Home Page');

Parameters

• text string text value to check.

Returns void automatically synchronized promise through #recorder

seeNumberOfVisibleElements

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

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

Parameters

• locator (string | object) element located by CSS|XPath|strict locator.
• num number number of elements.

Returns void automatically synchronized promise through #recorder

seeTraffic

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

• opts Object options when checking the traffic network.

  • opts.name string A name of that request. Can be any value. Only relevant to have a more meaningful error message in case of fail.
  • opts.url string Expected URL of request in network traffic
  • opts.parameters Object? Expected parameters of that request in network traffic
  • opts.requestPostData Object? Expected that request contains post data in network traffic
  • opts.timeout number? Timeout to wait for request in seconds. Default is 10 seconds.

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.

The third parameter is an optional context (CSS or XPath locator) to narrow the search.

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');
// within a context
I.selectOption('age', '21-60', '#section2');

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

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

Parameters

• select (string | object) field located by label|name|CSS|XPath|strict locator.
• option (string | Array) visible text or value of option.
• context (string? | object) (optional, null by default) element located by CSS | XPath | strict locator.

Returns void automatically synchronized promise through #recorder

setCookie

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

• cookie (Cookie | Array) a cookie object or array of cookie objects.

Returns void automatically synchronized promise through #recorder

startRecordingTraffic

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

I.startRecordingTraffic();

Returns void automatically synchronized promise through #recorder

startScreencast

Starts recording a video of the page. Stop it with stopScreencast. Usually enabled through the screencast plugin rather than called directly.

I.startScreencast();

Parameters

• options object? { maxWidth, maxHeight, quality, everyNthFrame }

Returns void automatically synchronized promise through #recorder

stopRecordingTraffic

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

I.stopRecordingTraffic();

stopScreencast

Stops the recording started by startScreencast and returns it as an animated PNG.

const video = await I.stopScreencast();

Parameters

• options object? { lastFrameDelayMs }: how long the last frame is shown, in milliseconds (1000 by default).

Returns Promise<(Buffer | null)> APNG data, or null if no frames were recorded.

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

• keys
• delay number? (optional) delay in ms between key presses
• key (string | Array<string>) or array of keys to type.

Returns void automatically synchronized promise through #recorder

uncheckOption

Unselects a checkbox or radio button. Element is located by label or name or CSS or XPath.

The second parameter is an optional 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

• field (string | object) checkbox located by label | name | CSS | XPath | strict locator.
• context (string? | object) (optional, null by default) element located by CSS | XPath | strict locator.

Returns void automatically synchronized promise through #recorder

wait

Pauses execution for a number of seconds.

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

Parameters

• sec number number of second to wait.

Returns void automatically synchronized promise through #recorder

waitCurrentPathEquals

Waits for the current URL path to match the expected path. Query strings and URL fragments are ignored.

I.waitCurrentPathEquals('/info', 5);

Parameters

• path string value to check.
• sec number? (optional, waitForTimeout by default) time in seconds to wait

Returns void automatically synchronized promise through #recorder

waitForCookie

Waits for the specified cookie in the cookies.

I.waitForCookie("token");

Parameters

• name string expected cookie name.
• sec number (optional, 3 by default) time in seconds to wait

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

• locator (string | object) element located by CSS|XPath|strict locator.
• sec number (optional, 1 by default) time in seconds to wait

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

• locator (string | object) element located by CSS|XPath|strict locator.
• sec number? (optional, 1 by default) time in seconds to wait

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

• fn (string | function) to be executed in browser context.
• argsOrSec (Array | number)? (optional, 1 by default) arguments for function or seconds.
• sec number? (optional, 1 by default) time in seconds to wait

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

• locator (string | object) element located by CSS|XPath|strict locator.
• sec number (optional, 1 by default) time in seconds to wait

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

• text string to wait for.
• sec number (optional, 1 by default) time in seconds to wait
• context (string | object)? (optional) element located by CSS|XPath|strict locator.

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

• locator (string | object) element located by CSS|XPath|strict locator.
• sec number (optional, 1 by default) time in seconds to wait

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

• urlPart string value to check.
• sec number (optional, 1 by default) time in seconds to wait

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

• locator (string | object) element located by CSS|XPath|strict locator.
• sec number (optional, 1 by default) time in seconds to wait

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

• urlPart string value to check.
• sec number (optional, 1 by default) time in seconds to wait

Returns void automatically synchronized promise through #recorder

_connect

In SELF-MANAGED mode, resolves and spawns the browser server (or courtesy-attaches to an already-running one on :9222) exactly once via _resolveSelfManaged. Then resolves the CDP endpoint and opens the underlying CDPConnection, storing it on this.cdp.

_findFreePort

Picks a free TCP port on 127.0.0.1 by briefly listening on port 0 and reading back the OS-assigned port. Used when options.port isn’t explicitly set, so multiple run-workers workers never collide on the same port.

Returns Promise<number> a free port.

_manageServer

Opts a subclass into managing its own browser server process. Called from a subclass constructor with the raw user config and a server descriptor:

• name — binary name looked up on PATH, also used in messages
• envVar — environment variable that may point at the binary
• args(port) — arguments the binary is spawned with to serve CDP on port
• env — extra environment variables for the spawned process
• releases — URL shown when no binary can be resolved

An explicit endpoint in the user config always wins: the helper stays in ATTACH mode and never spawns or kills anything. Otherwise the helper becomes SELF-MANAGED and the default endpoint is cleared until _resolveSelfManaged sets the real one.

Parameters

• config object the config object the helper was constructed with.
• server object the server descriptor described above.

_probeUp

Probes a /json/version-style URL with a short timeout, used for the courtesy-attach check.

Parameters

• url string

Returns Promise<boolean> true if the URL answered.

_resolveBinary

Resolves the binary to spawn, in priority order: options.binaryPath, then the server descriptor’s environment variable, then its name on PATH. The PATH lookup walks the directories itself instead of shelling out to which, which does not exist on Windows: on Windows every PATHEXT suffix is tried, so a .exe on PATH is found too.

Returns (string | null) an absolute or relative path to the binary, or null if none resolved.

_resolveSelfManaged

Resolves how to reach a SELF-MANAGED browser, trying, in order: spawn a binary (binaryPath config, then the descriptor’s envVar, then its name on PATH) on options.port or a free port, courtesy-attach to http://127.0.0.1:9222 if something already answers there (never killed by this helper), or throw a loud, actionable error. Sets this.options.endpoint as a side effect.

A spawn failure (e.g. a bad binary) is delivered asynchronously by Node as an error event; it is recorded on this.serverError and surfaced as a rejection from _waitForServer instead of crashing the process as an uncaught exception.

_waitForServer

Polls http://127.0.0.1:<port>/json/version until the spawned server responds, this.serverError is set by the process’ error event, or options.serverStartTimeout elapses. The process typically comes up within tens of milliseconds — a 20ms retry interval keeps the wasted tail after the server is actually ready small, since this cost is paid once per run and counts directly toward real-world startup latency.