All skills
bmad-labs avatar

/typescript-e2e-testing

@3bcc7a6
by bmad-labsbmad-labs/skills15 stars
4

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.

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

This session only. Nothing lands on disk.

referencesredisdocker-setup.md

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

Redis Docker Setup for E2E Testing

docker-compose.e2e.yml

version: '3.8'

services:
  redis-e2e:
    image: redis:7-alpine
    container_name: redis-e2e
    ports:
      - "6380:6379"  # Different port from dev
    healthcheck:
      test: ["CMD", "redis-cli", "ping"]
      interval: 5s
      timeout: 3s
      retries: 5
    # Performance: Disable persistence for tests
    command: redis-server --save "" --appendonly no --maxmemory 100mb --maxmemory-policy allkeys-lru

volumes:
  redis-e2e-data:

Health Check Script

#!/bin/bash
# scripts/wait-for-redis.sh

until docker-compose -f docker-compose.e2e.yml exec redis-e2e redis-cli ping; do
  echo "Waiting for Redis..."
  sleep 1
done
echo "Redis is ready!"

Connection String

# .env.e2e
REDIS_URL=redis://localhost:6380

Performance Tuning

Optimized for Test Speed

command: >
  redis-server
  --save ""                    # Disable RDB snapshots
  --appendonly no              # Disable AOF
  --maxmemory 100mb            # Limit memory
  --maxmemory-policy allkeys-lru  # Evict old keys
  --tcp-backlog 128            # Smaller backlog for tests

Settings Explained

Setting Default Test Value Effect
save "" periodic disabled Skip RDB snapshots
appendonly yes no Skip AOF persistence
maxmemory unlimited 100mb Limit memory usage
maxmemory-policy noeviction allkeys-lru Evict old keys
tcp-backlog 511 128 Smaller backlog for tests

Warning: These settings sacrifice persistence for speed. Only use for tests.


Connection Configuration

ioredis Configuration

import Redis from 'ioredis';

const redis = new Redis({
  host: 'localhost',
  port: 6380,
  db: 0,
  lazyConnect: true,
  retryDelayOnClusterDown: 100,
  retryDelayOnFailover: 100,
  maxRetriesPerRequest: 3,
});

node-redis Configuration

import { createClient } from 'redis';

const client = createClient({
  url: 'redis://localhost:6380',
});

await client.connect();

Complete Docker Compose with All Services

version: '3.8'

services:
  redis-e2e:
    image: redis:7-alpine
    container_name: redis-e2e
    ports:
      - "6380:6379"
    healthcheck:
      test: ["CMD", "redis-cli", "ping"]
      interval: 5s
      timeout: 3s
      retries: 5
    command: redis-server --save "" --appendonly no --maxmemory 100mb

  # Add other services as needed
  mongodb-e2e:
    image: mongo:7.0
    ports:
      - "27018:27017"
    command: mongod --wiredTigerCacheSizeGB 1

  postgres-e2e:
    image: postgres:15-alpine
    ports:
      - "5433:5432"
    environment:
      POSTGRES_USER: test
      POSTGRES_PASSWORD: test
      POSTGRES_DB: testdb

Redis with Sentinel (High Availability)

For testing Sentinel-based failover:

services:
  redis-master:
    image: redis:7-alpine
    ports:
      - "6380:6379"
    command: redis-server --save "" --appendonly no

  redis-sentinel:
    image: redis:7-alpine
    ports:
      - "26379:26379"
    depends_on:
      - redis-master
    command: >
      sh -c 'echo "sentinel monitor mymaster redis-master 6379 1" > /tmp/sentinel.conf &&
             echo "sentinel down-after-milliseconds mymaster 5000" >> /tmp/sentinel.conf &&
             redis-sentinel /tmp/sentinel.conf'

Redis Cluster (Sharding)

For testing cluster mode:

services:
  redis-cluster:
    image: grokzen/redis-cluster:7.0.0
    ports:
      - "7000-7005:7000-7005"
    environment:
      IP: 0.0.0.0
      INITIAL_PORT: 7000
      MASTERS: 3
      SLAVES_PER_MASTER: 0

Note: Cluster mode requires more complex setup and is typically not needed for most E2E tests.

Source: SKILL.md on GitHub

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

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
  • TypeScript
  • jest
  • nestjs
  • e2e-testing
  • supertest
  • docker
  • kafka
  • postgres
  • mongodb
  • redis
  • integration-testing
  • gwt-pattern

README badge

README badge for bmad-labs/skills

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.

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.