开发与测试
test-driven-development
TDD red-green-refactor cycle, test structure, mocking patterns for Vitest/Jest. Use when starting a new feature, fixing a bug, or refactoring — write the test first, then the implementation.
sabahattink · 已有静态检查记录
安装与使用
运行命令前先阅读来源与依赖说明。复制命令不会自动安装或执行。
npx skills add sabahattink/antigravity-fullstack-hq --skill test-driven-development技能说明
name: test-driven-development description: TDD red-green-refactor cycle, test structure, mocking patterns for Vitest/Jest. Use when starting a new feature, fixing a bug, or refactoring — write the test first, then the implementation.
Test-Driven Development
The Red-Green-Refactor Cycle
RED → Write a failing test that describes the desired behavior
GREEN → Write the minimum code to make it pass (no more, no less)
REFACTOR → Improve the code without changing behavior; tests stay green
Never skip the RED step. If you write code before the test, you lose confidence that your test actually tests anything.
Test Structure: AAA Pattern
// Arrange → Act → Assert — every test follows this shape
describe('UserService', () => {
describe('create', () => {
it('should hash the password before saving', async () => {
// ARRANGE — set up everything the test needs
const dto: CreateUserDto = {
email: 'jane@example.com',
password: 'S3cureP@ss!',
name: 'Jane Doe',
}
const mockRepo = createMockUserRepo()
const mockHasher = createMockHasher({ result: 'hashed_password' })
const sut = new UserService(mockRepo, mockHasher)
// ACT — call the thing under test
await sut.create(dto)
// ASSERT — verify outcomes
expect(mockHasher.hash).toHaveBeenCalledWith('S3cureP@ss!')
expect(mockRepo.save).toHaveBeenCalledWith(
expect.objectContaining({ passwordHash: 'hashed_password' })
)
})
})
})
Vitest Setup
// vitest.config.ts
import { defineConfig } from 'vitest/config'
import tsconfigPaths from 'vite-tsconfig-paths'
export default defineConfig({
plugins: [tsconfigPaths()],
test: {
globals: true,
environment: 'node',
setupFiles: ['./src/test/setup.ts'],
coverage: {
provider: 'v8',
reporter: ['text', 'html', 'lcov'],
thresholds: { lines: 80, functions: 80, branches: 80 },
exclude: ['**/*.dto.ts', '**/*.entity.ts', '**/index.ts'],
},
},
})
// src/test/setup.ts
import { vi } from 'vitest'
// Reset all mocks between tests — prevents state leakage
beforeEach(() => { vi.clearAllMocks() })
afterEach(() => { vi.restoreAllMocks() })
Mocking Patterns
Factory Functions for Mocks
// test/factories/user-repo.factory.ts
import { vi } from 'vitest'
import type { IUserRepository } from '../../domain/user/user.repository.interface'
export function createMockUserRepo(
overrides: Partial<IUserRepository> = {}
): jest.Mocked<IUserRepository> {
return {
findById: vi.fn().mockResolvedValue(null),
findByEmail: vi.fn().mockResolvedValue(null),
existsByEmail: vi.fn().mockResolvedValue(false),
save: vi.fn().mockResolvedValue(undefined),
delete: vi.fn().mockResolvedValue(undefined),
...overrides,
}
}
// Usage in a test
const repo = createMockUserRepo({
findByEmail: vi.fn().mockResolvedValue(existingUser),
})
Spying on Methods
// Spy on a real object's method without replacing implementation
it('should call findById with the correct id', async () => {
const repo = new UserTypeOrmRepository(dataSource)
const spy = vi.spyOn(repo, 'findById')
const service = new UserService(repo)
await service.findOneOrFail(42)
expect(spy).toHaveBeenCalledWith(42)
expect(spy).toHaveBeenCalledTimes(1)
})
Module Mocking
// Mock an entire module
vi.mock('../lib/email-client', () => ({
sendEmail: vi.fn().mockResolvedValue({ messageId: 'mock-id' }),
}))
// In test:
import { sendEmail } from '../lib/email-client'
expect(sendEmail).toHaveBeenCalledWith(
expect.objectContaining({ to: 'jane@example.com' })
)
Testing Domain Logic
// Pure domain logic — no mocks needed, just test the entity
describe('User entity', () => {
describe('rename', () => {
it('should return a new User with the updated name', () => {
const user = User.create({ id: UserId.generate(), email: Email.create('j@x.com'), name: 'Old Name' })
const updated = user.rename('New Name')
expect(updated.name).toBe('New Name')
expect(user.name).toBe('Old Name') // original is unchanged — immutability
})
it('should throw DomainError when name is blank', () => {
const user = User.create({ id: UserId.generate(), email: Email.create('j@x.com'), name: 'Jane' })
expect(() => user.rename(' ')).toThrow(DomainError)
expect(() => user.rename(' ')).toThrow('Name cannot be empty')
})
})
describe('promote', () => {
it('should throw DomainError when actor is not admin', () => {
const actor = makeUser({ role: UserRole.USER })
const target = makeUser({ role: UserRole.USER })
expect(() => target.promote(UserRole.ADMIN, actor)).toThrow(DomainError)
})
})
})
Testing Services (Unit)
describe('CreateUserHandler', () => {
let handler: CreateUserHandler
let repo: ReturnType<typeof createMockUserRepo>
let hasher: { hash: ReturnType<typeof vi.fn> }
let eventBus: { publish: ReturnType<typeof vi.fn> }
beforeEach(() => {
repo = createMockUserRepo()
hasher = { hash: vi.fn().mockResolvedValue('$2b$12$hashed') }
eventBus = { publish: vi.fn() }
handler = new CreateUserHandler(repo, hasher, eventBus)
})
it('should save a new user and publish UserCreatedEvent', async () => {
const cmd = new CreateUserCommand('jane@example.com', 'Pass123!', 'Jane', 'actor-id')
const userId = await handler.execute(cmd)
expect(repo.save).toHaveBeenCalledTimes(1)
expect(eventBus.publish).toHaveBeenCalledWith(
expect.objectContaining({ eventType: 'user.created', email: 'jane@example.com' })
)
expect(userId).toBeDefined()
})
it('should throw ConflictException when email already exists', async () => {
repo.existsByEmail.mockResolvedValue(true)
阅读完整来源 ↗