create-e2e-test_skill

Overview

This skill creates a ready-to-run end-to-end (E2E) test file for a specified NestJS module. It scaffolds a Vitest-based controller e2e-spec.ts file in the correct apps/core/test path, including mock data, model setup, and common CRUD test flows. Use it to speed up adding consistent E2E coverage for controllers.

How this skill works

Given a module name, the skill generates an E2E test file at apps/core/test/src/modules/<module-name>/<module-name>.controller.e2e-spec.ts. The template wires the controller, service, and model into a test app via createE2EApp, injects mock data in pourData, and provides tests for list, get, create, update, and delete endpoints. The template also includes database and redis mock helpers and notes about auth mocking and response shapes.

When to use it

• Adding an end-to-end test for a new or existing controller module
• Standardizing E2E test structure across modules
• Bootstrapping tests when onboarding a new feature in the core app
• Creating reproducible CRUD tests for API endpoints before deployment

Best practices

• Populate mockData with realistic required fields used by your schema
• Use pourData to seed only the records needed for tests and clean up in afterAll
• Validate both success and failure cases (invalid id, invalid payload)
• Rely on proxy.app.inject() to simulate HTTP requests through full request pipeline
• Keep tests focused and deterministic; avoid external network calls

Example use cases

• Generate tests for a posts controller to verify pagination, retrieval, create, update, and delete flows
• Add E2E coverage for a user management module with auth-disabled tests for happy paths
• Quickly scaffold tests for a new product or content module backed by Mongoose models
• Create a baseline set of tests before refactoring controller or service logic