Data cleanup approaches in Cypress - Framework Patterns

Framework Mode - Data cleanup approaches

Folder Structure

  cypress/
  ├── e2e/                  # Test specs
  │   ├── login.cy.js
  │   ├── userManagement.cy.js
  │   └── dataCleanup.cy.js  # Tests related to data cleanup
  ├── fixtures/             # Test data files
  │   └── users.json
  ├── support/              # Support files and commands
  │   ├── commands.js       # Custom Cypress commands
  │   ├── dataCleanup.js    # Data cleanup utility functions
  │   └── index.js          # Support file entry point
  ├── plugins/              # Cypress plugins
  │   └── index.js
  cypress.config.js         # Cypress configuration file
  

Test Framework Layers

• Test Specs (cypress/e2e): Contains test files that execute user scenarios and verify application behavior.
• Support Layer (cypress/support): Houses reusable code like custom commands and data cleanup utilities to keep tests clean and DRY.
• Fixtures (cypress/fixtures): Stores static test data such as JSON files for consistent test inputs.
• Plugins (cypress/plugins): Extends Cypress functionality, e.g., for environment setup or database connections.
• Configuration (cypress.config.js): Defines environment variables, base URLs, and test settings.

Configuration Patterns

Data cleanup requires flexible configuration to handle different environments and test needs.

• Environment Variables: Use cypress.config.js or cypress.env.json to store sensitive info like API keys or database credentials.
• Custom Commands: Define cleanup commands in cypress/support/commands.js to reuse cleanup steps across tests.
• Conditional Cleanup: Use environment flags to run cleanup only when needed, e.g., --env cleanup=true.
• API or DB Access: Configure endpoints or database connection strings in config files for cleanup scripts.

Test Reporting and CI/CD Integration

• Test Reports: Use Cypress reporters (like Mochawesome) to generate detailed reports showing if cleanup steps passed or failed.
• CI/CD Pipelines: Integrate cleanup commands in pipeline scripts to reset test data before or after test runs.
• Fail Fast: Configure tests to stop if cleanup fails to avoid false positives.
• Logs: Capture cleanup operation logs for troubleshooting in CI environments.

Best Practices for Data Cleanup in Cypress

1. Isolate Tests: Ensure each test cleans up its own data or runs in a clean environment to avoid flaky tests.
2. Use API Calls for Cleanup: Prefer backend API calls or direct DB access over UI interactions for faster and more reliable cleanup.
3. Centralize Cleanup Logic: Keep cleanup code in support files or custom commands to avoid duplication.
4. Run Cleanup in Hooks: Use beforeEach or afterEach hooks to automate cleanup around tests.
5. Handle Failures Gracefully: Add error handling in cleanup scripts to log issues without crashing the entire test suite.

Self Check

Where in this folder structure would you add a new utility function to delete test users via API after each test run?

Key Result

Centralize data cleanup logic in Cypress support files and automate it via hooks for reliable, isolated tests.