Skip to main content

Testing web apps using TestCafe

Running Tests with Applitools​

Prerequisites​

  1. A free Applitools account and Applitools API KEY

    Tip: Unsure how to find your API key?

    Read Retrieving your API key to find your API key.

  2. Node.js https://nodejs.org

  3. Git https://git-scm.com

    Note: Installing git is optional

    Installing git is used to clone the demo project from the Github repository. Instead of installing git, you can simply download the Zip file from the repository. Further, if you are Mac, you already have git.

  4. Google Chrome Browser https://www.google.com/chrome/

Running the Example Project​

  1. Clone or download the repository and navigate to that folder
git clone https://github.com/applitools/tutorial-testcafe.git
cd tutorial-testcafe

Note: you can alternatively download the project as a Zip file and extract it

  1. Install the dependencies
npm install
  1. Run the example test

To run all of the tests, run:

APPLITOOLS_API_KEY="[Your API Key]" npm run test

Adding Applitools Eyes to an Existing Node.js TestCafe Project​

Install Applitools Eyes dependencies:

npm install @applitools/eyes-testcafe --save-dev

Sample test​


Note that you may set the API key, concurrency (number of parallel screenshots), browsers X viewports, etc in the applitools.config.js file in the root directory.


More information​

The @applitools/eyes-testcafe npm package page contain more information about advanced configuration, best practices and troubleshooting. Visit eyes-testcafe SDK repo to find out more about what's possible with Applitools' TestCafe SDK.

Having Trouble?

Don't suffer in silence! Let us help you. Please reach out to us to get your project working.

Taking the next steps with Applitools​

Congratulations on completing this quickstart! There's still so much to learn about visual testing with Applitools, but you're off to a great start.

Resources for next steps:​

  1. 🤖 Learning how visual testing works
  2. ↔️ Setting match levels for visual checkpoints
  3. 💥 Troubleshooting common issues
  4. 🐞 Reporting bugs
  5. 🗺 Detailed overview of visual testing with Applitools

You can also:​