# Cypress Test Runner (`valek.josef/cypress-test-runner`) Actor
Run your Cypress tests on the Apify Platform effectively and easily. Just set up your test environment using a user-friendly UI and let the platform do the rest.
- **URL**: https://apify.com/valek.josef/cypress-test-runner.md
- **Developed by:** [Josef VΓ‘lek](https://apify.com/valek.josef) (community)
- **Categories:** Developer tools, Automation, Open source
- **Stats:** 51 total users, 7 monthly users, 65.1% runs succeeded, 2 bookmarks
- **User rating**: No ratings yet
## Pricing
Pay per usage
This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have.
Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-usage
## What's an Apify Actor?
An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.
## How to integrate an Actor?
If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.
For examples already wired to this Actor's own input schema, see the [API](#api) section below.
Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).
# README
Run your Cypress tests on the Apify Platform effectively and easily. Just set up your test environment using a user-friendly UI and let the platform do the rest.
### Features
#### Run your Cypress tests on the Apify Platform
#### Collect and analyze your test results online
After running the tests, the Apify Platform stores the results in comprehensive datasets. You can view the results directly on the platform or download them to your local machine using a REST API.
#### How to use
To run test suites, just copy-paste your generated test code into the *Cypress spec code* field in the Actor settings.
You can also customize the test run by specifying other options in the settings, e.g. the screen size, default comand timeout, and video settings.
# Actor input Schema
## `specCode` (type: `string`):
Just copy paste your test code here and click on save and start
## `baseUrl` (type: `string`):
URL used as prefix for cy.visit() or cy.request() command's URL.
## `defaultCommandTimeout` (type: `integer`):
Maximum time the for the command to be executed. Default is `30000`.
## `video` (type: `boolean`):
Record video of the test run which is then stored in Key Value Store. Default is true.
## `viewportWidth` (type: `integer`):
Viewport width in pixels. Default is `1280`.
## `viewportHeight` (type: `integer`):
Viewport height in pixels. Default is `720`.
## Actor input object example
```json
{
"specCode": "describe('spec', () => {\n it('test that should succeed', () => {\n cy.visit('/');\n cy.get('h1').should('contain', 'Example Domain');\n cy.screenshot();\n });\n\n it('test that should fail', () => {\n cy.visit('/');\n cy.get('h1', { timeout: 1000 }).should('contain', 'Some different text');\n });\n});",
"baseUrl": "https://example.com",
"defaultCommandTimeout": 30000,
"video": true,
"viewportWidth": 1280,
"viewportHeight": 720
}
```
# API
You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.
## JavaScript example
```javascript
import { ApifyClient } from 'apify-client';
// Initialize the ApifyClient with your Apify API token
// Replace the '' with your token
const client = new ApifyClient({
token: '',
});
// Prepare Actor input
const input = {
"specCode": `describe('spec', () => {
it('test that should succeed', () => {
cy.visit('/');
cy.get('h1').should('contain', 'Example Domain');
cy.screenshot();
});
it('test that should fail', () => {
cy.visit('/');
cy.get('h1', { timeout: 1000 }).should('contain', 'Some different text');
});
});`,
"baseUrl": "https://example.com"
};
// Run the Actor and wait for it to finish
const run = await client.actor("valek.josef/cypress-test-runner").call(input);
// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`πΎ Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
console.dir(item);
});
// π Want to learn more π? Go to β https://docs.apify.com/api/client/js/docs
```
## Python example
```python
from apify_client import ApifyClient
# Initialize the ApifyClient with your Apify API token
# Replace '' with your token.
client = ApifyClient("")
# Prepare the Actor input
run_input = {
"specCode": """describe('spec', () => {
it('test that should succeed', () => {
cy.visit('/');
cy.get('h1').should('contain', 'Example Domain');
cy.screenshot();
});
it('test that should fail', () => {
cy.visit('/');
cy.get('h1', { timeout: 1000 }).should('contain', 'Some different text');
});
});""",
"baseUrl": "https://example.com",
}
# Run the Actor and wait for it to finish
run = client.actor("valek.josef/cypress-test-runner").call(run_input=run_input)
# Fetch and print Actor results from the run's dataset (if there are any)
print(f"πΎ Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
print(item)
# π Want to learn more π? Go to β https://docs.apify.com/api/client/python/docs/quick-start
```
## CLI example
```bash
echo '{
"specCode": "describe('\''spec'\'', () => {\\n it('\''test that should succeed'\'', () => {\\n cy.visit('\''/'\'');\\n cy.get('\''h1'\'').should('\''contain'\'', '\''Example Domain'\'');\\n cy.screenshot();\\n });\\n\\n it('\''test that should fail'\'', () => {\\n cy.visit('\''/'\'');\\n cy.get('\''h1'\'', { timeout: 1000 }).should('\''contain'\'', '\''Some different text'\'');\\n });\\n});",
"baseUrl": "https://example.com"
}' |
apify call valek.josef/cypress-test-runner --silent --output-dataset
```
## MCP server setup
```json
{
"mcpServers": {
"apify": {
"type": "http",
"url": "https://mcp.apify.com/?tools=fetch-actor-details,valek.josef/cypress-test-runner"
}
}
}
```
The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer ` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).
## OpenAPI specification
Download the OpenAPI definition: https://api.apify.com/v2/actors/5tsTpPyh5lntNVIuC/builds/rAzTtII90ZKTMySYf/openapi.json