/typescript-e2e-testing

E2E and integration testing for TypeScript/NestJS projects using Jest, supertest, and real infrastructure via Docker (Kafka, PostgreSQL, MongoDB, Redis) with the Given-When-Then pattern. Use whenever the user is working on `.e2e-spec.ts` files or anything under `test/e2e/`, or asks to set up, write, review, run, debug, or optimize E2E or integration tests — including flaky tests, docker-compose for tests, Kafka/Redpanda consumers, test isolation, or GWT compliance.

102 files
406 KB
Updated 5 months ago
GitHub
1 alert

Ask your Agent

Use this Skill: https://skilld.dev/gh/bmad-labs/skills/typescript-e2e-testing

This session only. Nothing lands on disk.

referencesapiknowledge.md

2.8 KB raw

≈727 tokens on demand. Your agent reads this file only when SKILL.md points to it.

API E2E Testing Knowledge

Overview

API E2E testing focuses on verifying HTTP endpoints, request/response handling, authentication, and integration with external services.

Key Concepts

Concept	Description
REST API	HTTP-based resource-oriented endpoints
GraphQL	Query language with single endpoint
gRPC	High-performance RPC framework
Authentication	JWT, OAuth, API keys
Rate Limiting	Request throttling
Mocking	Simulating external services

API Testing Tools

Tool	Purpose	Use Case
Supertest	HTTP assertions	REST API testing with NestJS
MSW	Mock Service Worker	Mocking external APIs
Nock	HTTP interception	Mocking HTTP requests
graphql-request	GraphQL client	GraphQL testing
@grpc/grpc-js	gRPC client	gRPC testing

HTTP Methods & Status Codes

Common Methods

Method	Purpose	Success Code
GET	Retrieve resource	200
POST	Create resource	201
PUT	Replace resource	200
PATCH	Update resource	200
DELETE	Remove resource	204

Common Status Codes

Code	Meaning	Use Case
200	OK	Successful GET/PUT/PATCH
201	Created	Successful POST
204	No Content	Successful DELETE
400	Bad Request	Validation error
401	Unauthorized	Missing/invalid auth
403	Forbidden	Insufficient permissions
404	Not Found	Resource not found
409	Conflict	Duplicate/constraint violation
429	Too Many Requests	Rate limit exceeded
500	Internal Error	Server error

Response Structure

Standard Success Response

{
  code: 'SUCCESS',
  message: 'Operation completed successfully',
  data: { ... }
}

Standard Error Response

{
  code: 'VALIDATION_ERROR',
  message: 'Input validation failed',
  errors: [
    { field: 'email', message: 'Invalid email format' }
  ]
}

Pagination Response

{
  code: 'SUCCESS',
  data: [...],
  meta: {
    page: 1,
    limit: 10,
    total: 100,
    totalPages: 10
  }
}

External API Mocking

MSW vs Nock

Feature	MSW	Nock
Approach	Service Worker	HTTP interception
Browser Support	Yes	No
Node Support	Yes	Yes
Request Matching	Path/Method	URL/Headers/Body
Response Types	JSON/Text/Binary	JSON/Text/Binary
Chaining	No	Yes

Key Files

File	Purpose
rules.md	API-specific testing rules
test-helper.md	AuthTestHelper implementation
rest-examples.md	REST API test examples
graphql-examples.md	GraphQL test examples
mocking.md	External API mocking examples

Source: SKILL.md on GitHub

Third-party checks

1 alert16d5 checks · Risk SAFE

Gen Agent Trust Hub16d
This skill provides comprehensive workflows and reference materials for E2E testing in TypeScript/NestJS projects. It uses standard development tools like Jest, Docker, and shell commands. No malicious patterns or security risks were detected.
Socket16d
No alerts
Snyk16d
Risk: LOW · No issues
Runlayer7mo
30/103 files flagged
ZeroLeaks5mo
Score: 93/100 · 2 sections analyzed

Provenance

Signed by skilld at 3bcc7a6. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 2 days ago.

Activeupdated 5 months ago

Topics

TypeScript
jest
nestjs
e2e-testing
supertest
docker
kafka
postgres
mongodb
redis
integration-testing
gwt-pattern

What it does

Writes E2E and integration tests for NestJS projects using Jest and supertest against real Docker infrastructure (Kafka, PostgreSQL, MongoDB, Redis) following the Given-When-Then pattern. Covers test setup, writing, review, debugging, and optimization workflows with technology-specific helpers and isolation strategies for each service.

Generated from the current SKILL.md.

Frequently asked

Does this skill work with NestJS only?

The skill is built for NestJS projects using Jest and supertest, but the patterns and workflows apply to any TypeScript backend with HTTP endpoints. Technology-specific helpers exist for Kafka, PostgreSQL, MongoDB, and Redis.

Do I need Docker running to use this skill?

Yes. The skill assumes real infrastructure via Docker (Kafka, PostgreSQL, MongoDB, Redis). Tests execute against actual services, not mocks.

What if my E2E tests are flaky or failing?

The Debugging E2E Test workflow provides a systematic protocol: fix one test at a time using isolated test runs, verify with 3-5 consecutive runs before moving to the next failure, then run the full suite only once all tests pass individually.

Does this skill cover GraphQL or gRPC testing?

Yes. The API testing reference includes examples for REST, GraphQL, and gRPC, plus external API mocking with MSW and Nock.

What is the Given-When-Then pattern and is it mandatory?

GWT is the mandatory test structure: Given describes setup state, When describes the action under test, Then describes expected outcomes. All E2E tests in this skill must follow this pattern.

Generated from the current SKILL.md. These answers refresh after source changes.

/typescript-e2e-testing