| name | run-api-e2e-tests |
| description | Run e2e tests for the API service. Use when the user wants to run API E2E tests. |
Run API E2E Tests
Run novu-v2 e2e tests for the API service. Tests are located in apps/api.
Running All Tests
pnpm test:e2e:novu-v2
This runs all e2e tests with the novu-v2 pattern across both regular and enterprise test suites.
Running a Specific Test
When the user mentions a specific test or feature:
- Find the test file using Glob with pattern
*.e2e.ts or *.e2e-ee.ts in apps/api
- Extract the filename (without extension) - e.g.,
trigger-event-preferences.e2e.ts → trigger-event-preferences
- Determine the test location:
- Check if the test is in
src/ or e2e/enterprise/
- Run the appropriate command based on test location:
For tests in src/ directory:
pnpm exec cross-env NODE_ENV=test CI_EE_TEST=true CLERK_ENABLED=true NODE_OPTIONS=--max_old_space_size=8192 mocha --timeout 30000 --retries 3 --grep '#novu-v2' --require ./swc-register.js --exit --file e2e/setup.ts 'src/**/<name-of-the-test>.e2e{,-ee}.ts'
For tests in e2e/enterprise/ directory:
pnpm exec cross-env NODE_ENV=test CI_EE_TEST=true CLERK_ENABLED=true NODE_OPTIONS=--max_old_space_size=8192 mocha --timeout 30000 --retries 3 --grep '#novu-v2' --require ./swc-register.js --exit --file e2e/setup.ts 'e2e/enterprise/**/<name-of-the-test>.e2e.ts'
Replace <name-of-the-test> with the actual test filename (without extension).
Examples
Running trigger-event-preferences test (in src/):
pnpm exec cross-env NODE_ENV=test CI_EE_TEST=true CLERK_ENABLED=true NODE_OPTIONS=--max_old_space_size=8192 mocha --timeout 30000 --retries 3 --grep '#novu-v2' --require ./swc-register.js --exit --file e2e/setup.ts 'src/**/trigger-event-preferences.e2e{,-ee}.ts'
Running enterprise billing test:
pnpm exec cross-env NODE_ENV=test CI_EE_TEST=true CLERK_ENABLED=true NODE_OPTIONS=--max_old_space_size=8192 mocha --timeout 30000 --retries 3 --grep '#novu-v2' --require ./swc-register.js --exit --file e2e/setup.ts 'e2e/enterprise/**/billing.e2e.ts'
Important Notes
- Always run commands from
apps/api directory
- For specific tests, use the full mocha command (not pnpm script) to target the exact test file
- Report test results clearly to the user
