Get Started

Get started with a free parallelization using sorry-cypress

Let's start by running a basic sorry-cypress configuration:

docker run -p 1234:1234 agoldis/sorry-cypress-director

We've just launched director service on http://localhost:1234 - this service coordinates cypress agents and enables free parallelization.

Install and configure cypress-cloud and cypress

cypress-cloud is an open-source tool for integrating Cypress with alternative cloud services like Currents or Sorry Cypress.

npm install cypress-cloud cypress

Create a new configuration file: currents.config.js in the project’s root, set cloudServiceUrl to self-hosted director service of Sorry Cypress

// currents.config.js
module.exports = {
  projectId: "yyy", // the projectId, can be any values for sorry-cypress users
  recordKey: "xxx", // the record key, can be any value for sorry-cypress users
  cloudServiceUrl: "http://localhost:1234",   // Sorry Cypress users - set the director service URL
};

Add cypress-cloud/plugin to cypress.config.{js|ts|mjs}

// cypress.config.js
const { defineConfig } = require("cypress");
const { cloudPlugin } = require("cypress-cloud/plugin");
module.exports = defineConfig({
  e2e: {
    setupNodeEvents(on, config) {
      return cloudPlugin(on, config);
    },
  },
});

Running cypress tests in parallel

Let's open several terminal windows and run cypress-cloud in each. Make sure you have cypress tests defined in advance.

# run in each terminal
npx cypress-cloud run --parallel --record --key somekey --ci-build-id hello-cypress

You'll notice that different instances of cypress agents are running different tests.

🎉 We've just finished the basic setup of sorry-cypress and ran our tests in parallel!

• Use the same --ci-build-id to associate different cypress agents with the same run

• You can run as many cypress agents as you want - each will run a different test suite

• This basic director configuration keeps all the test results in memory. Restarting it wipes all the data

• --key and projectId do not have any effect on the basic setup