A Node.js tool to automate end-to-end web testing.
Switch branches/tags
Clone or download
Permalink
Failed to load latest commit information.
.github Fix the label configuration name Oct 24, 2018
.md-lint [docs] Add the FAQ section (#1690) Aug 21, 2017
bin Handle SIGINT via async-exit-hook (closes #1378) (#1780) Sep 20, 2017
docker add docker-test task (closes #3026) (#3081) Nov 12, 2018
docs Fix button names in the Handling Native Dialogs topic Nov 12, 2018
examples Fix example Feb 20, 2018
media Add an SVG logo for README.md Sep 19, 2018
src Add a clear error when fixture is not defined (closes #2913) (#3108) Nov 13, 2018
test Add a clear error when fixture is not defined (closes #2913) (#3108) Nov 13, 2018
ts-defs Update the hooks parameter in TS definitions (#2772) Aug 27, 2018
.dockerignore add docker-test task (closes #3026) (#3081) Nov 12, 2018
.editorconfig Start implementing build infrastructure Jun 25, 2015
.eslintignore Fix `ReferenceError: selector is not defined` if selector promise is … Aug 12, 2016
.eslintrc Enable ESLint no-var rule (#2858) Sep 20, 2018
.gitattributes Fix EOL in TS files (#1748) Aug 31, 2017
.gitignore Fix importing pure TS module from a TS test file (#3061) Nov 6, 2018
.publishrc Bump version (v0.23.2) (#3106) Nov 12, 2018
.travis-docs.yml [docs] Add some info about a typical report content (#2932) Oct 15, 2018
.travis.yml Use node 8 for testing (#3063) Nov 1, 2018
CHANGELOG.md Update changelog (v0.23.2) (#3107) Nov 12, 2018
CODE_OF_CONDUCT.md update code_of_conduct (#2394) May 11, 2018
CONTRIBUTING.md [docs] Updated "General Discussion" (#3013) Oct 29, 2018
Gulpfile.js add docker-test task (closes #3026) (#3081) Nov 12, 2018
LICENSE Update year in license to 2018 Sep 18, 2018
README.md [docs] Update issues, questions and contributing (#3012) Oct 30, 2018
appveyor.yml Use node 8 for testing (#3063) Nov 1, 2018
azure-pipelines.yml Use node 8 for testing (#3063) Nov 1, 2018
package.json Bump version (v0.23.2) (#3106) Nov 12, 2018

README.md

testcafe

Functional Windows desktop All Travis tasks (server, client, functional: mobile, macOS, Edge) NPM Version

A Node.js tool to automate end-to-end web testing.
Write tests in JS or TypeScript, run them and view results.

https://devexpress.github.io/testcafe


  • Works on all popular environments: TestCafe runs on Windows, MacOS, and Linux. It supports desktop, mobile, remote and cloud browsers (UI or headless).
  • 1 minute to set up: You do not need WebDriver or any other testing software. Install TestCafe with one command, and you are ready to test: npm install -g testcafe
  • Free and open source: TestCafe is free to use under the MIT license. Plugins provide custom reports, integration with other tools, launching tests from IDE, etc. You can use the plugins made by the GitHub community or make your own.

Install TestCafe and Run a Test

Running a sample test in Safari

Table of contents

Features

Stable tests and no manual timeouts
TestCafe automatically waits for page loads and XHRs before the test starts and after each action. It also features smart test actions and assertions that wait for page elements to appear. You can change the maximum wait time. If elements load faster, tests skip the timeout and continue.

Rapid test development tool
Changes in test code immediately restart the test, and you see the results instantly.
See how it works in the TestCafe Live repository.

Latest JS and TypeScript support
TestCafe supports the latest JavaScript features, including ES2017 (for example, async/await). You can also use TypeScript if you prefer a strongly typed language.

Detects JS errors in your code
TestCafe reports JS errors that it finds on the webpage. Tests automatically fail because of that. However, you can disable this.

Concurrent tests launch
TestCafe can open multiple instances of the same browser to run parallel tests which decreases test execution time.

PageObject pattern support
The TestCafe's Test API includes a high-level selector library, assertions, etc. You can combine them to implement readable tests with the PageObject pattern.

const macOSInput = Selector('.column').find('label').withText('MacOS').child('input');

Easy to include in a continuous integration system
You can run TestCafe from a console, and its reports can be viewed in a CI system's interface (TeamCity, Jenkins, Travis & etc.)

IDE for End-to-End Web Testing

We've got one more tool for you!

Check out TestCafe Studio: all the perks of TestCafe + GUI + Visual Test Recorder

Get Started with TestCafe Studio

Record and Run a Test in TestCafe Studio

Getting Started

Installation

Ensure that Node.js (version 6 or newer) and npm are installed on your computer before running it:

npm install -g testcafe

Creating the Test

As an example, we are going to test the https://devexpress.github.io/testcafe/example page.

Create a .js or .ts file on your computer. Note that it needs to have a specific structure: tests must be organized into fixtures. You can paste the following code to see the test in action:

import { Selector } from 'testcafe'; // first import testcafe selectors

fixture `Getting Started`// declare the fixture
    .page `https://devexpress.github.io/testcafe/example`;  // specify the start page


//then create a test and place your code there
test('My first test', async t => {
    await t
        .typeText('#developer-name', 'John Smith')
        .click('#submit-button')

        // Use the assertion to check if the actual header text is equal to the expected one
        .expect(Selector('#article-header').innerText).eql('Thank you, John Smith!');
});

Running the Test

Call the following command in a command shell. Specify the target browser and file path.

testcafe chrome test1.js

TestCafe opens the browser and starts executing the test.

Important! Make sure to stay in the browser tab that is running tests. Do not minimize the browser window. Tests are not guaranteed to execute correctly in inactive tabs and minimized browser windows because they switch to a lower resource consumption mode.

Viewing the Results

TestCafe outputs the results into a command shell by default. See Reporters for more information. You can also use plugins to customize the reports.

Test Report

Read the Getting Started page for a more detailed guide.

Documentation

Go to our website for full documentation on TestCafe.

Get Help

Join the TestCafe community on Stack Overflow to get help. Ask and answer questions with the TestCafe tag.

Issue Tracker

Use our GitHub issues page to report bugs and suggest improvements.

Stay in Touch

Follow us on Twitter. We post TestCafe news and updates, several times a week.

Contributing

Read our Contributing Guide to learn how to contribute to the project.

To create your own plugin for TestCafe, you can use these plugin generators:

If you want your plugin to be listed below, send us a note in a Github issue.

Thank you to all the people who already contributed to TestCafe!

Plugins

TestCafe developers and community members made these plugins:

Different Versions of TestCafe

There is a line of products called TestCafe. Below are the similarities and key differences between them.

  • All three versions share the same core features:

    • No need for WebDriver, browser plugins or other tools.
    • Cross-platform and cross-browser out of the box.
  • TestCafe
    first released in 2013, commercial web application

    • Visual Test Recorder and web GUI to create, edit and run tests.
    • You can record tests or edit them as JavaScript code.
  • TestCafe - you are here
    first released in 2016, free and open-source node.js application

  • TestCafe Studio
    Preview released in 2018, commercial desktop application

    • Based on the open-source TestCafe, and supports its major features.
    • You can record tests or edit them as JavaScript or TypeScript code.
    • New Visual Test Recorder and IDE-like GUI to record, edit, run and debug tests.
    • Currently available as a free preview version. The release version will replace the 2013 version of TestCafe.

Badge

Show everyone you are using TestCafe: Tested with TestCafe

To display this badge, add the following code to your repository readme:

<a href="https://github.com/DevExpress/testcafe">
    <img alt="Tested with TestCafe" src="https://img.shields.io/badge/tested%20with-TestCafe-2fa4cf.svg">
</a>

Thanks to BrowserStack

We are grateful to BrowserStack for providing the infrastructure that we use to test code in this repository.

BrowserStack Logo

License

Code released under the MIT license.

Creators

Developer Express Inc. (https://devexpress.com)