Nest.js 如何进行集成测试？

推荐答案

在 Nest.js 中进行集成测试时，通常使用 @nestjs/testing 模块提供的工具来模拟整个应用程序的运行环境。以下是一个典型的集成测试流程：

1. 创建测试模块：使用 Test.createTestingModule 方法创建一个测试模块，并配置需要测试的模块、控制器、服务等。

2. 编译和初始化：调用 compile 方法编译测试模块，并使用 createNestApplication 方法创建一个 Nest.js 应用程序实例。

3. 执行测试：通过 HTTP 请求模拟客户端请求，验证应用程序的响应是否符合预期。

4. 清理资源：测试完成后，关闭应用程序实例以释放资源。

以下是一个简单的集成测试示例：

// www.javascriptcn.com code example
import { Test, TestingModule } from '@nestjs/testing';
import { INestApplication } from '@nestjs/common';
import * as request from 'supertest';
import { AppModule } from './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();
  });

  afterEach(async () => {
    await app.close();
  });

  it('/ (GET)', () => {
    return request(app.getHttpServer())
      .get('/')
      .expect(200)
      .expect('Hello World!');
  });
});

本题详细解读

1. 创建测试模块

在集成测试中，首先需要创建一个测试模块。Test.createTestingModule 方法允许你配置需要测试的模块、控制器、服务等。你可以通过 imports 属性导入需要测试的模块，或者通过 providers 和 controllers 属性手动注入依赖。

const moduleFixture: TestingModule = await Test.createTestingModule({
  imports: [AppModule],
}).compile();

2. 编译和初始化

在创建测试模块后，调用 compile 方法编译模块。编译完成后，使用 createNestApplication 方法创建一个 Nest.js 应用程序实例。最后，调用 init 方法初始化应用程序。

app = moduleFixture.createNestApplication();
await app.init();

3. 执行测试

在初始化应用程序后，可以使用 supertest 库来模拟 HTTP 请求。supertest 提供了一个简单的 API 来发送请求并验证响应。你可以通过 app.getHttpServer() 获取应用程序的 HTTP 服务器实例，并将其传递给 supertest。

it('/ (GET)', () => {
  return request(app.getHttpServer())
    .get('/')
    .expect(200)
    .expect('Hello World!');
});

4. 清理资源

测试完成后，应该关闭应用程序实例以释放资源。可以通过调用 app.close() 方法来关闭应用程序。

afterEach(async () => {
  await app.close();
});

通过以上步骤，你可以在 Nest.js 中编写完整的集成测试，确保应用程序的各个部分能够协同工作。