cy2

cy2

---

Run millions of cypress tests in parallel without breaking the bank

Currents.dev - is a hosted cloud service that hundreds of companies around the globe use to run millions of Cypress tests without breaking the bank. This is an enhanced version of Sorry Cypress with a better security, performance, analytics, integrations and support.

Sorry Cypress is an open-source, free alternative to Cypress Dashboard that unlocks unlimited parallelization, test recordings, integration with GitHub, Slack and more.

---

Change cypress API URL configuration on-the-fly using environment variable CYPRESS_API_URL. It passes down all the CLI flags as-is, so you can just use it instead of cypress.

CYPRESS_API_URL should point to Sorry Cypress director service, Currents dashboard or other compatible service.

Install

npm install cy2

Usage

CLI usage - use http://localhost:1234 as Cypress:

CYPRESS_API_URL="http://localhost:1234/" cy2 run --parallel --record --key somekey --ci-build-id hello-cypress

Example usage with sorry-cypress

CYPRESS_API_URL="https://sorry-cypress-demo-director.herokuapp.com" cy2 run  --parallel --record --key somekey --ci-build-id hello-cypress

API

Breaking change in version 3+

Starting version 3+, the API methods run and patch rely on process.env.CYPRESS_API_URL - they do not accept any argument. That's because of a new patching method that doesn't permanently change cypress installation after invoking cy2.

Run Cypress programmatically

⚠️ Make sure to set process.env.CYPRESS_API_URL before invoking run

import { run } from 'cy2';

process.env.CYPRESS_API_URL = 'https://dashboard.servuce.url';

run().catch((error) => {
  console.error(error);
  process.exit(1);
});

Patch Cypress without running

⚠️ Make sure to set process.env.CYPRESS_API_URL before invoking

import { patch } from 'cy2';
import cypress from 'cypress';

process.env.CYPRESS_API_URL = 'https://dashboard.servuce.url';

async function main() {
  await patch();

  cypress
    .run({
      // the path is relative to the current working directory
      spec: './cypress/e2e/examples/actions.cy.js',
    })
    .then((results) => {
      console.log(results);
    })
    .catch((err) => {
      console.error(err);
    });
}
main().catch((error) => {
  console.error(error);
  process.exit(1);
});

Changelog

3.0.0-alpha.2 (2022-10-21)

Features

• implement patch and update README (ad95e9d)