Nodejs Nestjs测试模块@nestjs/testing的使用

在NestJS中，@nestjs/testing模块提供了一套工具来帮助开发者进行单元测试和集成测试。下面我将展示如何使用这个模块来创建一个简单的测试。

首先，确保你的项目已经安装了@nestjs/testing模块。如果没有，可以通过以下命令安装：

npm install @nestjs/testing --save

接下来，我们将创建一个简单的控制器和服务作为示例，并编写对应的测试用例。

示例服务

假设我们有一个名为CatsService的服务，它包含了一个简单的函数用于获取猫的名字。

// cats.service.ts
import { Injectable } from '@nestjs/common';

@Injectable()
export class CatsService {
  private readonly cats: string[] = [];

  addCat(name: string) {
    this.cats.push(name);
  }

  getCats(): string[] {
    return this.cats;
  }
}

示例控制器

然后，我们创建一个控制器CatsController来处理与猫相关的HTTP请求。

// cats.controller.ts
import { Controller, Get, Post } from '@nestjs/common';
import { CatsService } from './cats.service';

@Controller('cats')
export class CatsController {
  constructor(private readonly catsService: CatsService) {}

  @Post()
  addCat(name: string) {
    this.catsService.addCat(name);
    return { message: 'Cat added successfully' };
  }

  @Get()
  getCats() {
    return this.catsService.getCats();
  }
}

编写测试

现在，我们可以为CatsService和CatsController编写测试用例。

// cats.service.spec.ts
import { Test, TestingModule } from '@nestjs/testing';
import { CatsService } from './cats.service';

describe('CatsService', () => {
  let service: CatsService;

  beforeEach(async () => {
    const module: TestingModule = await Test.createTestingModule({
      providers: [CatsService],
    }).compile();

    service = module.get<CatsService>(CatsService);
  });

  it('should be defined', () => {
    expect(service).toBeDefined();
  });

  it('should add a cat', () => {
    service.addCat('Tom');
    expect(service.getCats()).toEqual(['Tom']);
  });
});

// cats.controller.spec.ts
import { Test, TestingModule } from '@nestjs/testing';
import { CatsController } from './cats.controller';
import { CatsService } from './cats.service';

describe('CatsController', () => {
  let controller: CatsController;

  beforeEach(async () => {
    const module: TestingModule = await Test.createTestingModule({
      controllers: [CatsController],
      providers: [CatsService],
    }).compile();

    controller = module.get<CatsController>(CatsController);
  });

  it('should be defined', () => {
    expect(controller).toBeDefined();
  });

  it('should add a cat', async () => {
    const response = await controller.addCat('Jerry');
    expect(response.message).toBe('Cat added successfully');
    expect(controller['catsService'].getCats()).toEqual(['Jerry']);
  });

  it('should get all cats', async () => {
    controller['catsService'].addCat('Tom');
    controller['catsService'].addCat('Jerry');

    const result = await controller.getCats();
    expect(result).toEqual(['Tom', 'Jerry']);
  });
});

以上代码展示了如何使用@nestjs/testing模块来编写基本的单元测试。你可以根据需要扩展这些测试用例以覆盖更多的场景。