NestJS集成测试与组件测试全解析

### NestJS 集成测试与组件测试全解析 #### 1. 集成测试概述 集成测试超越了单元测试的范畴，旨在验证服务、模块和外部集成之间的协调性。它能全面呈现应用程序在模拟真实场景下的行为。在从理论转向实践时，做好充分准备至关重要。准备阶段不仅要选择合适的工具，还要创建一个能准确模拟生产环境的测试环境，以便细致检查应用程序各部分的协同工作情况。 #### 2. 集成测试准备 - **测试环境搭建**：使用 NestJS 进行集成测试时，需先搭建测试环境。NestJS 提供了 Jest 用于断言，supertest 用于模拟 HTTP 请求，为集成测试提供了理想的起点。在现有的 NestJS 项目中，可在 `test/` 目录下找到 `app.e2e-spec.ts` 这个端到端（e2e）测试的样板文件。 ```typescript // Initial test/app.e2e-spec.ts content import { Test, TestingModule } from '@nestjs/testing'; import { INestApplication } from '@nestjs/common'; import * as request from 'supertest'; import { AppModule } from './../src/app.module'; describe('AppController (e2e)', () => { let app: INestApplication; beforeEach(async () => { const moduleFixture: TestingModule = await Test .createTestingModule({ imports: [AppModule], }).compile(); app = moduleFixture.createNestApplication(); await app.init(); }); it('/ (GET)', () => { return request(app.getHttpServer()) .get('/') .expect(200) .expect('Hello World!'); }); }); ``` - **处理版本控制**：若应用程序支持版本控制，运行上述测试可能会失败。因为有 `response - logging.interceptor` 拦截器会拦截所有请求并返回特定格式的响应。 ```javascript // response-logging.inerceptor.js return { success: !(data instanceof Error) && data !== null, data: data, timestamp: new Date().toISOString(), }; ``` 为使测试环境与应用程序的当前状态（特别是版本控制功能）保持一致，需要对样板 e2e 测试设置进行修改，配置 `AppModule` 以正确识别和路由版本化请求。 ```typescript beforeEach(async () => { const moduleFixture: TestingModule = await Test .createTestingModule({ imports: [AppModule], }).compile(); app = moduleFixture.createNestApplication(); app.enableVersioning({ type: VersioningType.URI, }); await app.init(); }); ``` 同时，更新 `/ (GET)` 测试用例，以适应新的响应格式。 ```typescript it('/ (GET)', () => { return request(app.getHttpServer()) .get('/v1') .expect(200) .expect((res) => { expect(res.body.success).toBe(true); expect(res.body.data).toBe('Hello World!'); expect(res.body.timestamp).toBeDefined(); }); }); ``` #### 3. 用户管理应用测试 - **测试环境准备**：在 NestJS 中组织测试时，保持一致的结构对可维护性和可读性至关重要。对于用户模块，集成测试文件位于 `test/users/users.e2e - spec.ts`。 ```typescript import { Test, TestingModule } from '@nestjs/testing'; import { INestApplication, VersioningType } from '@nestjs/common'; import * as request from 'supertest'; import { AppModule } from '../../src/app.module'; describe('User Management (e2e)', () => { let app: INestApplication; beforeEach(async () => { const moduleFixture: TestingModule = await Test .createTestingModule({ imports: [AppModule], }).compile(); app = moduleFixture.createNestApplication(); app.enableVersioning({ type: VersioningType.URI, defaultVersion: '1', }); await app.init(); }); afterEach(async () => { await app.close(); }); // Test cases will be added here }); ``` - **模拟 HTTP 请求与断言响应** - **测试 POST /v1/users 端点**：模拟创建新用户，确保操作成功且响应包含预期的用户详细信息。 ```typescript it('POST /v1/users - should create a new user', async () => { const response = await request(app.getHttpServer()) .post('/v1/users') .send({ name: 'Justin Dusenge', email: '[email protected]' }) .expect(201); expect(response.body).toHaveProperty('data'); ```