TestCafe.md

permalink	editLink	sidebar	title
/helpers/TestCafe	false	auto	TestCafe

TestCafe

Extends Helper

Uses TestCafe library to run cross-browser tests. The browser version you want to use in tests must be installed on your system.

Requires testcafe package to be installed.

npm i testcafe --save-dev

Configuration

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

• url: base url of website to be tested
• show: - show browser window.
• windowSize: (optional) - set browser window width and height
• getPageTimeout config option to set maximum navigation time in milliseconds.
• waitForTimeout: (optional) default wait* timeout in ms. Default: 5000.
• browser: - See https://devexpress.github.io/testcafe/documentation/using-testcafe/common-concepts/browsers/browser-support.html

Example #1: Show chrome browser window

{
   helpers: {
     TestCafe : {
       url: "http://localhost",
       waitForTimeout: 15000,
       show: true,
       browser: "chrome"
     }
   }
}

To use remote device you can provide 'remote' as browser parameter this will display a link with QR Code See https://devexpress.github.io/testcafe/documentation/recipes/test-on-remote-computers-and-mobile-devices.html

Example #2: Remote browser connection

{
   helpers: {
     TestCafe : {
       url: "http://localhost",
       waitForTimeout: 15000,
       browser: "remote"
     }
   }
}

Access From Helpers

Call Testcafe methods directly using the testcafe controller.

const testcafeTestController = this.helpers['TestCafe'].t;
const comboBox = Selector('.combo-box');
await testcafeTestController
  .hover(comboBox) // hover over combo box
  .click('#i-prefer-both') // click some other element

Methods

Parameters

• config

_locate

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

const elements = await this.helpers['TestCafe']._locate('.item');

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

• url string url path or global url.

appendField

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

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

Parameters

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

attachFile

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

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

checkOption

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

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

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

Parameters

• field (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.

clearCookie

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

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

Parameters

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

clearField

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

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

Parameters

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

click

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

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

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

Parameters

• locator (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.

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.

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

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

dontSeeCookie

Checks that cookie with given name does not exist.

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

Parameters

• name string cookie name.

dontSeeCurrentUrlEquals

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

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

Parameters

• url string value to check.

dontSeeElement

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

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

Parameters

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

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.

dontSeeInCurrentUrl

Checks that current url does not contain a provided fragment.

Parameters

• url string value to check.

dontSeeInField

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 CSS

Parameters

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

dontSeeInSource

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