Cypress test template

Cypress test template

Run your Cypress tests on the Apify Platform effectively and easily. The template provides the necessary setup for running the Cypress tests. You can change the Cypress configuration in the input, which is defined by the input schema. The template uses globby library to fetch the Cypress test files and run them within the Actor. The video recordings are stored in Key-value store and the comprehensive test results are stored in the Dataset.

Included features

• Apify SDK - toolkit for building Actors
• Input schema - define and easily validate a schema for your Actor's input
• Dataset - store structured data where each object stored has the same attributes
• Cypress - JavaScript Component and E2E testing library

How it works

You can easily run your tests on the Apify Platform, just copy-paste your test files into cypress/e2e folder. The tests' names need to end with -spec.cy.js.

You can also customize the test run by specifying other options in the input, e.g. the screen size, video recording, or the default command timeout.

After running the tests, the Apify platform stores the results in a comprehensive way - datasets for JSON results, and key-value store for videos. You can view the results directly on the platform or download them to your local machine using a REST API.

Resources on Cypress test

• Cypress test runner Actor
• How to deploy tests to the Apify platform
• Video guide on getting data using Apify API
• Integration with Zapier, Make, Google Drive and others
• Video guide on getting data using Apify API
• A short guide on how to create Actors using code templates:

Getting started

For complete information see this article. In short, you will:

1. Build the Actor
2. Run the Actor

Pull the Actor for local development

If you would like to develop locally, you can pull the existing Actor from Apify console using Apify CLI:

1. Install apify-cli

   Using Homebrew

   $brew install apify-cli
   

   Using NPM

   $npm -g install apify-cli
   

2. Pull the Actor by its unique <ActorId>, which is one of the following:

   • unique name of the Actor to pull (e.g. "apify/hello-world")
   • or ID of the Actor to pull (e.g. "E2jjCZBezvAZnX8Rb")

   You can find both by clicking on the Actor title at the top of the page, which will open a modal containing both Actor unique name and Actor ID.

   This command will copy the Actor into the current directory on your local machine.

   $apify pull <ActorId>
   

Documentation reference

To learn more about Apify and Actors, take a look at the following resources:

• Apify SDK for JavaScript documentation
• Apify SDK for Python documentation
• Apify Platform documentation
• Join our developer community on Discord