agentleFS
Hey-DigaHey-Diga/dotclaude/skills/testing-guide/SKILL.md

testing-guide

Skill17 starsChanged 9 months agoMITView on GitHub

Test writing patterns, mocking strategies, and test data templates for Jest unit and integration tests. Use when writing new tests or need guidance on mocking repositories.

  • Reads credentials

5 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use documentation-guide.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • volfpeterSkill

    documentation-guide

    Use when writing or modifying documentation, guides, or example READMEs. Covers documentation structure, writing style, formatting conventions, cross-referencing, and code example standards.

    Also in 3 projects that use this

The file

We split this skill into the rules it gives an agent

8 rules. 0 are common, 6 are distinctive, and 2 are very specific to this project.

  • 0

    Common

    Most of the 4 edited versions we read keep these.

  • 6

    Distinctive

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    NEVER mock @prisma/client: - if you need Prisma client, you haven't properly mocked the repository

    line 16
  2. Distinctive:

    Use realistic Spanish test data for all tests:

    line 77
  3. Distinctive:

    Always consider testing these:

    line 97
  4. Distinctive:

    Isolate tests: Avoid shared state or order dependency

    line 137
  5. Distinctive:

    One behavior per test: Follow AAA pattern (Arrange, Act, Assert)

    line 138
  6. Distinctive:

    User-centric: Test components via user interactions (React Testing Library)

    line 139
  7. Very specific:

    Clean up: Always restore spies and mocks in afterAll/afterEach

    line 140
  8. Distinctive:

    When writing new tests, explore for existing patterns:

    line 147

“Common” is measured: kept by at least 6 in 10 of the 4 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Testing Guide

Patterns and templates for writing Jest unit and integration tests. This complements the unit-tester subagent which handles test execution.


Critical Rules (Always Apply)

  • NEVER import or use @prisma/client directly in any test file
  • NEVER mock @prisma/client - if you need Prisma client, you haven't properly mocked the repository
  • ALWAYS mock the specific repository modules used by the code under test
  • Never test repositories in src/lib/repositories directly

Repository Mocking Pattern

This is the core mocking pattern. Mock the repository module, then configure return values per test.

// ✅ CORRECT: Mock repository modules
jest.mock("@/lib/repositories/userRepository", () => ({
  getById: jest.fn(),
  updateName: jest.fn(),
}));
const mockUserRepository = require("@/lib/repositories/userRepository");

// In your test:
mockUserRepository.getById.mockResolvedValue({
  id: 1,
  name: "Ana Garcia",
  email: "ana@example.com",
});
// ❌ WRONG: Never mock Prisma client
jest.mock("@prisma/client"); // DON'T DO THIS!

External Dependencies Mocking

// Mock external libraries at module level
jest.mock("langfuse", () => ({
  Langfuse: jest.fn(),
  TextPromptClient: jest.fn(),
}));

// Spy on console methods
const consoleLogSpy = jest.spyOn(console, "log").mockImplementation(() => {});
afterAll(() => {
  consoleLogSpy.mockRestore();
});

Environment Variable Testing

  • AVOID direct assignment to process.env.NODE_ENV (TypeScript read-only)
  • USE expect.any(Boolean) for environment-dependent behavior
  • PREFER testing actual behavior over mocking environment variables

Spanish Business Context Test Data

Use realistic Spanish test data for all tests:

const testData = {
  customers: [
    { name: "Ana Garcia", phone: "+34611223344" },
    { name: "Jose Maria Fernandez-Vazquez", phone: "+34612345678" },
  ],
  businesses: [
    { name: "Salon Bella", address: "Calle Mayor 1, Madrid" },
    { name: "Peluqueria Nona & Coiffeur", services: ["corte", "peinado"] },
  ],
  specialChars: "Hola! Como esta usted?",
};

Edge Cases Checklist

Always consider testing these:

  • null and undefined values
  • Empty objects {} and arrays []
  • Complex nested objects
  • Special characters and emojis
  • Circular references (where applicable)
  • Functions within objects
  • Large data sets

Test File Structure

__tests__/
  unit/            # Unit tests (functions, hooks, utils)
  integration/     # Integration tests (components, API handlers)
  e2e/             # Playwright E2E test scripts
testing/
  setupTests.ts    # Jest global setup file

Running Tests

CommandPurpose
npm testAll Jest tests
npm test -- --coverageWith coverage report
npm run test:watchWatch mode
npm run test:e2eAll Playwright E2E tests
npm run test:e2e:smokeSmoke tests only (fast, for PRs)
npm run test:e2e:fullFull E2E suite (nightly)

Best Practices

  • Isolate tests: Avoid shared state or order dependency
  • One behavior per test: Follow AAA pattern (Arrange, Act, Assert)
  • User-centric: Test components via user interactions (React Testing Library)
  • Clean up: Always restore spies and mocks in afterAll/afterEach
  • Coverage target: >= 80% on critical code paths

Workflow: Finding Existing Test Patterns

When writing new tests, explore for existing patterns:

  1. Find similar test files: Glob("__tests__/**/*.test.ts")
  2. Find mock patterns: Grep("jest.mock", path="__tests__/")
  3. Find test setup: Read("testing/setupTests.ts")
  4. Find how a specific repository is mocked: Grep("mock.*Repository", path="__tests__/")

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.