Getting Started

Introduction

DeploySentinel enables easy test debugging, parallelization and reporting. Use DeploySentinel to identify & fix flaky tests and run tests faster than before.

Plugin Installation

The DeploySentinel Cypress plugin automatically captures debug telemetry and test results from your Cypress test suite.

Install NPM Package

npm install -D @deploysentinel/cypress-debugger

Add Plugin & Support Files

// Cypress Config File (cypress.config.js)
const { defineConfig } = require('cypress');
module.exports = defineConfig({
  e2e: {
    setupNodeEvents(on, config) {
      // ❗ Must be declared at the top of the function to prevent conflicts
      [on, config] = require('@deploysentinel/cypress-debugger/plugin')(
        on,
        config,
      );
    },
  },
});

Note: This example overwrites the on and config variables on purpose to workaround downstream plugin conflicts.

// Cypress Support File (cypress/support/e2e.js)
import '@deploysentinel/cypress-debugger/support'; // ❗ Must be imported top of file
import './commands';

Run With API key

Chrome Example:

CYPRESS_DEPLOYSENTINEL_KEY=YOUR_API_KEY npx cypress run --browser chrome

Electron Example:

ELECTRON_EXTRA_LAUNCH_ARGS="--remote-debugging-port=40500" CYPRESS_DEPLOYSENTINEL_KEY=YOUR_API_KEY npx cypress run --browser electron

Next Steps

Now you're all set with the DeploySentinel debugger. To enable parallelization, check out our parallelization setup docs.

Debugger