Nightmare

# Nightmare

Extends Helper

Nightmare helper wraps Nightmare (opens new window) library to provide fastest headless testing using Electron engine. Unlike Selenium-based drivers this uses Chromium-based browser with Electron with lots of client side scripts, thus should be less stable and less trusted.

Requires nightmare package to be installed.

# Configuration

This helper should be configured in codecept.conf.ts or codecept.conf.js

  • url - base url of website to be tested

  • restart - restart browser between tests.

  • disableScreenshots - don't save screenshot on failure.

  • uniqueScreenshotNames - option to prevent screenshot override if you have scenarios with the same name in different suites.

  • fullPageScreenshots - make full page screenshots on failure.

  • keepBrowserState - keep browser state between tests when restart set to false.

  • keepCookies - keep cookies between tests when restart set to false.

  • waitForAction: (optional) how long to wait after click, doubleClick or PressKey actions in ms. Default: 500.

  • waitForTimeout: (optional) default wait* timeout in ms. Default: 1000.

  • windowSize: (optional) default window size. Set a dimension like 640x480.

  • options from Nightmare configuration (opens new window)

# Methods

# Parameters

  • config

# _locate

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

This method return promise with array of IDs of found elements. Actual elements can be accessed inside evaluate by using codeceptjs.fetchElement() client-side function:

// get an inner text of an element

let browser = this.helpers['Nightmare'].browser;
let value = this.helpers['Nightmare']._locate({name: 'password'}).then(function(els) {
  return browser.evaluate(function(el) {
    return codeceptjs.fetchElement(el).value;
  }, els[0]);
});

# Parameters

  • locator

# amOnPage

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

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

# Parameters

Returns void automatically synchronized promise through #recorder

# appendField

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

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

# Parameters

Returns void automatically synchronized promise through #recorder

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

I.attachFile('Avatar', 'data/avatar.jpg');
I.attachFile('form input[name=avatar]', 'data/avatar.jpg');

# Parameters

Returns void automatically synchronized promise through #recorderDoesn't work if the Chromium DevTools panel is open (as Chromium allows only one attachment to the debugger at a time. See more (opens new window))

# checkOption

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

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

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

# Parameters

Returns void automatically synchronized promise through #recorder

# clearCookie

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

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

# Parameters

# clearField

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

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

# Parameters

Returns void automatically synchronized promise through #recorder.

# click

Perform a click on a link or a button, given by a locator. If a fuzzy locator is given, the page will be searched for a button, link, or image matching the locator string. For buttons, the "value" attribute, "name" attribute, and inner text are searched. For links, the link text is searched. For images, the "alt" attribute and inner text of any parent links are searched.

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

// simple link
I.click('Logout');
// button of form
I.click('Submit');
// CSS button
I.click('#form input[type=submit]');
// XPath
I.click('//form/*[@type=submit]');
// link in context
I.click('Logout', '#nav');
// using strict locator
I.click({css: 'nav a.login'});

# Parameters

Returns void automatically synchronized promise through #recorder

# dontSee

Opposite to see. Checks that a text is not present on a page. Use context parameter to narrow down the search.

I.dontSee('Login'); // assume we are already logged in.
I.dontSee('Login', '.nav'); // no login inside .nav element

# Parameters

Returns void automatically synchronized promise through #recorder

# 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

Returns void automatically synchronized promise through #recorder

# dontSeeCookie

Checks that cookie with given name does not exist.

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

# Parameters

Returns void automatically synchronized promise through #recorder

# dontSeeCurrentUrlEquals

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

I.dontSeeCurrentUrlEquals('/login'); // relative url are ok
I.dontSeeCurrentUrlEquals('http://mysite.com/login'); // absolute urls are also ok

# Parameters

Returns void automatically synchronized promise through #recorder

# dontSeeElement

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

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

# Parameters

Returns void automatically synchronized promise through #recorder

# dontSeeElementInDOM

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

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

# Parameters

Returns void automatically synchronized promise through #recorder

# dontSeeInCurrentUrl

Checks that current url does not contain a provided fragment.

# Parameters

Returns void automatically synchronized promise through #recorder

# dontSeeInField

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

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

# Parameters

Returns void automatically synchronized promise through #recorder

# dontSeeInSource

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

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

# Parameters

Returns void automatically synchronized promise through #recorder

# dontSeeInTitle

Checks that title does not contain text.

I.dontSeeInTitle('Error');

# Parameters

Returns void automatically synchronized promise through #recorder

# doubleClick

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

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

# Parameters

Returns void automatically synchronized promise through #recorder

# executeAsyncScript

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

Example: In Vue.js to make components completely rendered we are waiting for nextTick (opens new window).

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

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

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

# Parameters

Returns Promise (opens new window)<any> script return valueWrapper for asynchronous evaluate (opens new window). Unlike NightmareJS implementation calling done will return its first argument.

# 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

Returns Promise (opens new window)<any> script return valueWrapper for synchronous evaluate (opens new window)

# fillField

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

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

# Parameters

Returns void automatically synchronized promise through #recorder

# grabAttributeFrom

Retrieves an attribute from an element located by CSS or XPath and returns it to test. Resumes test execution, so should be used inside async with await operator. If more than one element is found - attribute of first element is returned.

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

# Parameters

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

# grabAttributeFromAll

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

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

# Parameters

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

# grabCookie

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

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

# Parameters

Returns any attribute valueCookie in JSON format. If name not passed returns all cookies for this domain.Multiple cookies can be received by passing query object I.grabCookie({ secure: true});. If you'd like get all cookies for all urls, use: .grabCookie({ url: null }).

# grabCssPropertyFrom

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

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

# Parameters

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

# grabCurrentUrl

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

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

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

# grabElementBoundingRect

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

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

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

To get only one metric use second parameter:

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

# Parameters

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

# grabHAR

Get HAR

let har = await I.grabHAR();
fs.writeFileSync('sample.har', JSON.stringify({log: har}));

# grabHTMLFrom

Retrieves the innerHTML from an element located by CSS or XPath and returns it to test. Resumes test execution, so should be used inside async function with await operator. If more than one element is found - HTML of first element is returned.

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

# Parameters

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

# grabHTMLFromAll

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

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

# Parameters

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

# grabNumberOfVisibleElements

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

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

# Parameters

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

# grabPageScrollPosition

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

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

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

# grabTextFrom

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

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

If multiple elements found returns first element.

# Parameters

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

# grabTextFromAll

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

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

# Parameters

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

# grabTitle

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

let title = await I.grabTitle();

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

# grabValueFrom

Retrieves a value from a form element located by CSS or XPath and returns it to test. Resumes test execution, so should be used inside async function with await operator. If more than one element is found - value of first element is returned.

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

# Parameters

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

# grabValueFromAll

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

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

# Parameters

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

# haveHeader

Add a header override for all HTTP requests. If header is undefined, the header overrides will be reset.

I.haveHeader('x-my-custom-header', 'some value');
I.haveHeader(); // clear headers

# Parameters

  • header
  • value

# moveCursorTo

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

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

# Parameters

Returns void automatically synchronized promise through #recorder

# pressKey

Sends input event (opens new window) on a page. Can submit special keys like 'Enter', 'Backspace', etc

# Parameters

  • key

# refresh

Reload the page

# 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

Returns void automatically synchronized promise through #recorder

# rightClick

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

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

# Parameters

Returns void automatically synchronized promise through #recorder

# saveElementScreenshot

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

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

# Parameters

Returns void automatically synchronized promise through #recorder

# saveScreenshot

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

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

# Parameters

Returns void automatically synchronized promise through #recorder

# scrollPageToBottom

Scroll page to the bottom.

I.scrollPageToBottom();

Returns void automatically synchronized promise through #recorder

# scrollPageToTop

Scroll page to the top.

I.scrollPageToTop();

Returns void automatically synchronized promise through #recorder

# scrollTo

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

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

# Parameters

Returns void automatically synchronized promise through #recorder

# see

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

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

# Parameters

Returns void automatically synchronized promise through #recorder

# 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

Returns void automatically synchronized promise through #recorder

# seeCookie

Checks that cookie with given name exists.

I.seeCookie('Auth');

# Parameters

Returns void automatically synchronized promise through #recorder

# seeCurrentUrlEquals

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

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

# Parameters

Returns void automatically synchronized promise through #recorder

# seeElement

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

I.seeElement('#modal');

# Parameters

Returns void automatically synchronized promise through #recorder

# seeElementInDOM

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

I.seeElementInDOM('#modal');

# Parameters

Returns void automatically synchronized promise through #recorder

# seeInCurrentUrl

Checks that current url contains a provided fragment.

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

# Parameters

Returns void automatically synchronized promise through #recorder

# seeInField

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

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

# Parameters

Returns void automatically synchronized promise through #recorder

# seeInSource

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

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

# Parameters

Returns void automatically synchronized promise through #recorder

# seeInTitle

Checks that title contains text.

I.seeInTitle('Home Page');

# Parameters

Returns void automatically synchronized promise through #recorder

# seeNumberOfElements

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

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

# Parameters

Returns void automatically synchronized promise through #recorder

# seeNumberOfVisibleElements

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

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

# Parameters

Returns void automatically synchronized promise through #recorder

# selectOption

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

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

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

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

# Parameters

Returns void automatically synchronized promise through #recorder

# setCookie

Sets cookie(s).

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

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

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

# Parameters

Returns void automatically synchronized promise through #recorderWrapper for .cookies.set(cookie). See more (opens new window)

# triggerMouseEvent

Sends input event (opens new window) on a page. Should be a mouse event like: { type: 'mouseDown', x: args.x, y: args.y, button: "left" }

# Parameters

  • event

# uncheckOption

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

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

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

# Parameters

Returns void automatically synchronized promise through #recorder

# wait

Pauses execution for a number of seconds.

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

# Parameters

Returns void automatically synchronized promise through #recorder

# waitForDetached

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

I.waitForDetached('#popup');

# Parameters

Returns void automatically synchronized promise through #recorder

# waitForElement

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

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

# Parameters

Returns void automatically synchronized promise through #recorder

# waitForFunction

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

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

# Parameters

Returns void automatically synchronized promise through #recorder

# waitForInvisible

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

I.waitForInvisible('#popup');

# Parameters

Returns void automatically synchronized promise through #recorder

# waitForText

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

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

# Parameters

Returns void automatically synchronized promise through #recorder

# waitForVisible

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

I.waitForVisible('#popup');

# Parameters

Returns void automatically synchronized promise through #recorder

# waitToHide

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

I.waitToHide('#popup');

# Parameters

Returns void automatically synchronized promise through #recorder

Last Updated: 12/20/2023, 1:01:55 AM