cy2
v4.0.9
Published
Integrate Cypress with alternative cloud services like Sorry Cypress or Currents
Downloads
740,138
Readme
cy2
Integrate Cypress with alternative cloud services like Sorry Cypress or Currents
Currents.dev - is a hosted cloud service used to run millions of Cypress tests without breaking the bank. This is an enhanced version of Sorry Cypress with better security, performance, analytics, integrations and support.
Sorry Cypress - is an open-source, free alternative to Cypress Cloud that unlocks unlimited parallelization, test recordings, and integration with GitHub, Slack and more.
cy2
integrates cypress with alternative orchestration services like Sorry Cypress or Currents.
Dec 2023 Update
If you are seeing Error: certificate has expired
, please upgrade to version 4.0.8+.
March 2023 Update
⭐️ Cypress 12.6.0+ users, please use https://github.com/currents-dev/cypress-cloud if you are seeing Cypress does not support recording test results to this third party service
error ⭐️
Install
npm install cy2
CLI Usage
Set the environment variable CYPRESS_API_URL
and run cy2
. The command passes down all the CLI flags to cypress runner as-is.
# use `http://localhost:1234` as orchestration cloud service
CYPRESS_API_URL="http://localhost:1234/" cy2 run --parallel --record --key somekey --ci-build-id hello-cypress
Example usage with sorry-cypress. The URL should point to director
service.
CYPRESS_API_URL="https://sorry-cypress-demo-director.herokuapp.com" cy2 run --parallel --record --key somekey --ci-build-id hello-cypress
API
run
Run Cypress via its Module API
run(apiUrl: string, config: CypressCommandLine.CypressRunOptions): Promise<CypressCommandLine.CypressRunResult | CypressCommandLine.CypressFailedRunResult>
Example:
import { run } from 'cy2';
const results = await run('https://sorry-cypress.company.net', {
reporter: 'junit',
browser: 'chrome',
config: {
baseUrl: 'http://localhost:8080',
video: true,
},
});
spawn
Spawn Cypress as a child process and inherit all the flags and environment variables. It invokes process.exit
with the child process' exit code.
spawn(apiUrl: string): Promise<void>
Example:
import { spawn } from 'cy2';
await spawn(process.env.CYPRESS_API_URL);
Breaking Changes
Version 4
patch
method was deprecated. Userun
instead.
Version 3
- Starting version 3+, the API methods
run
andpatch
rely onprocess.env.CYPRESS_API_URL
instead of accepting an argument. That's because of a new patching method that doesn't permanently change cypress configuration after invokingcy2
.
patch
[deprecated in 4+]
Deprecated due to the changes in cypress introduced in version 12+.
Change cypress configuration without running it.
patch(cypressPackageEntryPath: string) => Promise<void>
⚠️ Make sure to set process.env.CYPRESS_API_URL
before invoking patch
Example:
import { patch } from 'cy2';
import cypress from 'cypress';
process.env.CYPRESS_API_URL = 'https://dashboard.service.url';
async function main() {
// optional - provide cypress package main entry point location
await patch(require.resolve('cypress'));
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);
});