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.

referencespostgresknowledge.md

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

PostgreSQL E2E Testing Knowledge

Overview

PostgreSQL E2E testing focuses on verifying data persistence, transactions, and complex query behaviors in a relational database context.

Key Concepts

Concept Description
ACID Transactions Atomicity, Consistency, Isolation, Durability
Foreign Keys Referential integrity constraints
Indexes Performance optimization structures
Sequences Auto-incrementing ID generators
Schemas Logical separation of tables

Test Isolation Strategies

Strategy Speed Complexity Use Case
TRUNCATE CASCADE Fast Low Default - recommended
Transaction Rollback Fastest Medium When no commit needed
Schema Per Suite Medium Medium Parallel test suites
Testcontainers Slow Low Complete isolation

PostgreSQL-Specific Challenges

Challenge Solution
Foreign key constraints Clean in correct order or use CASCADE
Sequence reset ALTER SEQUENCE ... RESTART WITH 1
Connection pool exhaustion Single connection for tests
Deadlocks in parallel tests Run sequentially (--runInBand)

TypeORM vs Prisma

Feature TypeORM Prisma
Query Builder Yes No (raw SQL)
Migrations Built-in Separate tool
Transaction API QueryRunner $transaction
Table Truncation synchronize(true) $executeRaw

Docker Configuration for Tests

postgres-e2e:
  image: postgres:15-alpine
  ports:
    - "5433:5432"  # Different from dev
  environment:
    POSTGRES_USER: test
    POSTGRES_PASSWORD: test
    POSTGRES_DB: testdb
  # Performance tuning for tests
  command: >
    postgres
    -c shared_buffers=256MB
    -c fsync=off
    -c synchronous_commit=off
    -c full_page_writes=off

Performance Settings Explained

Setting Default Test Value Effect
fsync on off Skip disk sync (faster)
synchronous_commit on off Async commits (faster)
full_page_writes on off Skip WAL writes (faster)
shared_buffers 128MB 256MB More memory cache

⚠️ Warning: These settings sacrifice durability for speed. Only use for tests.

Key Files

File Purpose
rules.md PostgreSQL-specific testing rules
test-helper.md PostgresTestHelper implementation
docker-setup.md Docker configuration
examples.md Complete test examples

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.