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.

Practice

1. Why is data cleanup important in Cypress tests?

easy

A. It makes tests run slower

B. It increases the number of test failures

C. It keeps tests independent and reliable

D. It removes the need for assertions

Solution

1. Step 1: Understand test independence

   Tests should not depend on data left by previous tests to avoid false results.

2. Step 2: Recognize reliability benefits

   Cleaning data ensures each test starts fresh, making results trustworthy.

3. Final Answer:

   It keeps tests independent and reliable -> Option C

4. Quick Check:

   Data cleanup = test independence and reliability [OK]

Hint: Data cleanup ensures fresh start for each test [OK]

Common Mistakes:

• Thinking cleanup slows tests
• Believing cleanup causes more failures
• Assuming cleanup removes assertions

2. Which Cypress hook is best to use for cleaning test data after each test?

easy

A. afterEach

B. beforeEach

C. before

D. after

Solution

1. Step 1: Identify hooks for cleanup timing

   afterEach runs after every test, ideal for cleanup after each test.

2. Step 2: Compare other hooks

   before and beforeEach run before tests; after runs once after all tests.

3. Final Answer:

   afterEach -> Option A

4. Quick Check:

   Cleanup after each test = afterEach [OK]

Hint: Use afterEach to clean after every test [OK]

Common Mistakes:

• Using before for cleanup
• Confusing beforeEach with cleanup hook
• Using after which runs only once

3. What will happen if you use this code snippet in Cypress?

after(() => {
  cy.request('DELETE', '/api/test-data')
})

medium

A. Test data is never cleaned

B. Test data is cleaned once after all tests finish

C. Test data is cleaned after each test

D. Test data is cleaned before each test

Solution

1. Step 1: Understand after hook behavior

   after runs once after all tests in the suite complete.

2. Step 2: Analyze the API request timing

   The DELETE request runs only once after all tests, cleaning data once at the end.

3. Final Answer:

   Test data is cleaned once after all tests finish -> Option B

4. Quick Check:

   after = cleanup once after all tests [OK]

Hint: after runs once after all tests finish [OK]

Common Mistakes:

• Thinking after runs after each test
• Confusing after with afterEach
• Assuming cleanup runs before tests

4. You wrote this code to clean test data after each test:

afterEach(() => {
  cy.request('DELETE', '/api/test-data')
})

But test data is not cleaned properly. What is the likely problem?

medium

A. The API endpoint URL might be incorrect or unavailable

B. The afterEach hook is not supported in Cypress

C. You should use beforeEach instead of afterEach

D. The DELETE method is not allowed in HTTP

Solution

1. Step 1: Verify afterEach hook validity

   afterEach is valid and commonly used for cleanup in Cypress.

2. Step 2: Check API request issues

   If data is not cleaned, the DELETE request may fail due to wrong URL or server issues.

3. Final Answer:

   The API endpoint URL might be incorrect or unavailable -> Option A

4. Quick Check:

   Failed cleanup often means API endpoint problem [OK]

Hint: Check API URL if cleanup fails [OK]

Common Mistakes:

• Thinking afterEach is unsupported
• Using wrong HTTP method assumptions
• Switching hooks unnecessarily

5. You want to ensure test data is cleaned efficiently before and after each test in Cypress. Which approach is best?

hard

A. Manually delete data in each test without hooks

B. Use only before hook to clean data once before all tests

C. Use after hook to clean data once after all tests finish

D. Use beforeEach to create data and afterEach to delete data via API requests

Solution

1. Step 1: Understand test data lifecycle

   Creating data before each test and cleaning after each test keeps tests isolated and reliable.

2. Step 2: Use API requests in hooks

   API calls in beforeEach and afterEach efficiently manage test data per test.

3. Final Answer:

   Use beforeEach to create data and afterEach to delete data via API requests -> Option D

4. Quick Check:

   Setup and cleanup per test = beforeEach + afterEach [OK]

Hint: Use beforeEach and afterEach with API calls [OK]

Common Mistakes:

• Cleaning data only once before or after all tests
• Not using hooks for cleanup
• Manually deleting data inside tests