CtrlK
BlogDocsLog inGet started
Tessl Logo

run-api-e2e-tests

Run e2e tests for the API service. Use when the user wants to run API E2E tests.

72

Quality

87%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

SecuritybySnyk

Passed

No findings from the security scan

SKILL.md
Quality
Evals
Security

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:

  1. Find the test file using Glob with pattern *.e2e.ts or *.e2e-ee.ts in apps/api
  2. Extract the filename (without extension) - e.g., trigger-event-preferences.e2e.ts → trigger-event-preferences
  3. Determine the test location:
    • Check if the test is in src/ or e2e/enterprise/
  4. 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/):

# Found: apps/api/src/app/events/e2e/trigger-event-preferences.e2e.ts
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:

# Found: apps/api/e2e/enterprise/billing/billing.e2e.ts
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
Repository
novuhq/novu
Path

.cursor/skills/run-api-e2e-tests/SKILL.md

Commit

d921755

Last updated
First committed

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.

Claim skill