@browserstack/testcafe

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

Homepage   •  
Documentation   •  
FAQ   •  
Support

* 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
* TestCafe Studio: IDE for End-to-End Web Testing
* Getting Started
* Documentation
* Get Help
* Issue Tracker
* Stay in Touch
* Contributing
* Plugins
* Different Versions of TestCafe
* Badge
* License
* Creators

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

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

TestCafe Studio: IDE for End-to-End Web Testing

TestCafe works great for JavaScript developers, but at some point you will need to delegate testing tasks to your Q&A department. If that's the case and you are looking for a codeless way to record and maintain tests compatible with your existing infrastructure, check out TestCafe Studio - a testing IDE built on top of the open-source TestCafe.

Read the following article to learn how TestCafe Studio could fit into your workflow: What's Better than TestCafe? TestCafe Studio.

!Get Started with TestCafe Studio


Record and Run a Test in TestCafe Studio


Getting Started

$3

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

`sh
npm install -g testcafe
`

$3

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:

`js
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!');
});
`

$3

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

`sh
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.

$3

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:

* Build a browser provider
to set up tests on your on-premises server farm, to use a cloud testing platform, or to start your local browsers in a special way. Use this Yeoman generator to write only a few lines of code.
* To build a custom reporter
with your formatting and style, check out this generator.

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!

| | | | | |
:---: |:---: |:---: |:---: |:---: |:---: |
alexey-lin |anthophobiac |ericyd |NickCis |timnederhoff |vitalics |

| | | | | |
:---: |:---: |:---: |:---: |:---: |:---: |
alexwybraniec |andrewbranch |radarhere |ai |AndyWendt |infctr |

| | | | | |
:---: |:---: |:---: |:---: |:---: |:---: |
benmonro |caseyWebb |lzxb |smockle |cdrini |beyondcompute |

| | | | | |
:---: |:---: |:---: |:---: |:---: |:---: |
GeoffreyBooth |Ivan-Katovich |jamesgeorge007 |mcjim |jaypea |kanhaiya15 |

| | | | | |
:---: |:---: |:---: |:---: |:---: |:---: |
dej611 |mattmanske |MatthewNielsen27 |morfey13 |rbardini |renancouto |

| | | | | |
:---: |:---: |:---: |:---: |:---: |:---: |
macdonaldr93 |honsq90 |stefanschenk |sgrillon14 |tobiasbueschel |raspo |

| | | | | |
:---: |:---: |:---: |:---: |:---: |:---: |
varunkumar |theghostbel |aha-oretama |bill-looby-i |bsmithb2 |link89 |

| | | | | |
:---: |:---: |:---: |:---: |:---: |:---: |
VasilyStrelyaev |AndreyBelym |AlexanderMoskovkin |inikulin |AlexKamaev |helen-dikareva |

| | | | | |
:---: |:---: |:---: |:---: |:---: |:---: |
miherlosev |MargaritaLoseva |LavrovArtem |churkin |AlexSkorkin |kirovboris |

| | | | | |
:---: |:---: |:---: |:---: |:---: |:---: |
Farfurix |Dmitry-Ostashev |Nuarat |aleks-pro |arubtsov |Marketionist |

| | | | | |
:---: |:---: |:---: |:---: |:---: |:---: |
murajun1978 |pietrovich |superroma |cgfarmer4 |

| |
:---: |:---: |
b12031106 |tomashanacek |

Plugins

TestCafe developers and community members made these plugins:

* Browser Providers

Use TestCafe with cloud browser providers and emulators.
* SauceLabs provider (by @AndreyBelym)
* BrowserStack provider (by @AndreyBelym)
* CrossBrowserTesting provider (by @sijosyn)
* LambdaTest provider (by @kanhaiya15)
* Nightmare headless provider (by @ryx)
* fbsimctl iOS emulator (by @ents24)
* Electron (by @AndreyBelym)
* Puppeteer (by @jdobosz)
* Puppeteer Chromium (by @stefanschenk)

* Framework-Specific Selectors

Work with page elements in a way that is native to your framework.
* React (by @kirovboris)
* Angular (by @miherlosev)
* Vue (by @miherlosev)
* Aurelia (by @miherlosev)

* Plugins for Task Runners

Integrate TestCafe into your project's workflow.
* Grunt (by @crudo)
* Gulp (by @inikulin)

* Custom Reporters

View test results in different formats.
* TeamCity (by @nirsky)
* Slack (by @Shafied)
* NUnit (by @AndreyBelym)
* TimeCafe (by @jimthedev)

* GitHub Action

Run TestCafe tests in GitHub Actions workflows.
* Run TestCafe

* Test Accessibility

Find accessibility issues in your web app.
* axe-testcafe (by @helen-dikareva)

* IDE Plugins

Run tests and view results from your favorite IDE.
* TestCafe Test Runner for Visual Studio Code (by @romanresh)
* TestLatte for Visual Studio Code (by @Selminha)
* TestCafe runner for Webstorm (by @lilbaek)
* Code snippets for TestCafe (by @hdorgeval)
* SublimeText (by @churkin)

* ESLint

Use ESLint when writing and editing TestCafe tests.
* ESLint plugin (by @miherlosev)

* Cucumber Support

Create and run tests that use the Cucumber syntax.
* gherkin-testcafe (by @kiwigrid) - run your Cucumber tests with TestCafe as a backend. Requires CucumberJS.
* testcafe-cucumber-steps (by @Marketionist) - provides predefined Cucumber steps for gherkin-testcafe.

Different Versions of TestCafe

|   | TestCafe | TestCafe Studio |
| ------ |:-------------------------------------------------:|:-----------------------------------------------------------------------:|
| No need for WebDriver, browser plugins or other tools | ✓ | ✓ |
| Cross-platform and cross-browser out of the box | ✓ | ✓ |
| Write tests in the latest JavaScript or TypeScript | ✓ | ✓ |
| Clear and flexible API supports ES6 and PageModel pattern | ✓ | ✓ |
| Stable tests due to the Smart Assertion Query Mechanism | ✓ | ✓ |
| Tests run fast due to intelligent Automatic Waiting Mechanism and Concurrent Test Execution | ✓ | ✓ |
| Custom reporter plugins | ✓ | ✓ |
| Use third-party Node.js modules in test scripts | ✓ | ✓ |
| Integration with popular CI systems | ✓ |  ✓\* |
| Free and open-source | ✓ |   |
| Visual Test Recorder |   | ✓ |
| Interactive Test Editor |   | ✓ |
| Automatic Selector Generation |   | ✓ |
| Run Configuration Manager |   | ✓ |
| IDE-like GUI |   | ✓ |

\* You can use open-source TestCafe to run TestCafe Studio tests in CI systems.

Badge

Show everyone you are using TestCafe: !Tested with TestCafe

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

`html



``

Thanks to BrowserStack

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

License

Code released under the MIT license.

Creators

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