The full sorry-cypress setup allows to use all the supported featured but comes with an overhead of maintaining the infrastructure required to run the services:
sorry-cypress-director in "persisting" mode
Test Recordings storage
Director service is responsible for
parallelization and coordination of test runs
integration with Slack, GitHub and emitting generic WebHooks
saving tests results
generating signed upload URL for saving failed tests screenshots
When you launch Cypress agents on a CI environment with multiple machines, each agent contacts the director service and gets instructions on the next spec file to run.
After running the test spec, the agent reports the results to the Director service, receives the instructions for the next run, and so on until all the tests are done.
The director service coordinates those activities for multiple agents and different runs, stores the test results in a database.
Full setup requires the director to run in "persisting" mode to use MongoDB driver and provide credentials.,
Also, see Director Configuration options.
API Service is a simple GraphQL wrapper that exposes a convenient way to query the data stored by Director.
The service is only required as an interface for the Web Dashboard, but can be used to query the database and describe the internal data models.
Also, see API Configuration options.
The dashboard allows end-users to interact with sorry-cypress using a browser and to:
track test runs progress
browser test results, videos, and failures screenshots
set projects configuration like WebHooks, Slack, and GitHub integration
create and delete entries (projects, runs)
Also, see Dashboard Configuration options.
Cypress comes with the ability to take screenshots and videos, whether you are running via
cypress open or
cypress run, even in CI.
We need remote storage to store the generated screenshots and videos. Director service will send a signed upload URL that cypress agent will use to upload the generated artifacts.
A signed URL is a URL that provides limited permission and time to make a request. Signed URLs contain authentication information in their query string, allowing users without credentials to perform specific actions on a resource.
Sorry-cypress integrates with the major remote cloud storage solutions:
Minio integration (via Minio S3 Gateway) that is compatible with
Google Cloud Storage
Azure Blob Storage
To disable remote storage, we need to set a"dummy" screenshots driver for Director service.
To enable remote storage, see Director Configuration options.
Director and API services work with MongoDB as a persistency layer. It's up to you to choose MongoDB solution that works for your needs.
MongoDB Atlas is a simple and popular managed solution that also has a free tier.
Having a redis connection available allows the director to use to run delayed tasks. Delayed tasks are being used to implement Inactivity Timeout for runs. When set, the director would set up delayed tasks using the provided redis connection, instead of volatile memory timers .