如何对 NestJS 中的控制器应用警卫进行单元测试？

Question

我在 NestJS 中配置了一个控制器，我想检查是否设置了适当的保护 - 有没有人有一个如何做到的例子？

这个（删节的）示例作为应用程序可以正常工作，所以我只是在测试指导之后。

您会在用户测试中注意到我调用Reflect.getMetadata 的测试。我正在追求这样的东西 - 当我在 __guards__ 元数据上检查它时，这是一个函数，我正在努力模拟它，所以我可以检查它是否在设置时与 AuthGuard('jwt') 一起应用。

用户.controller.ts

@Controller('/api/user')
export class UserController {
  @UseGuards(AuthGuard('jwt'))
  @Get()
  user(@Request() req) {
    return req.user;
  }
}

User.controller.spec.ts

describe('User Controller', () => {
  // beforeEach setup as per the cli generator

  describe('#user', () => {
    beforeEach(() => {
      // This is how I'm checking the @Get() decorator is applied correctly - I'm after something for __guards__
      expect(Reflect.getMetadata('path', controller.user)).toBe('/');
      expect(Reflect.getMetadata('method', controller.user)).toBe(RequestMethod.GET);
    });

    it('should return the user', () => {
      const req = {
        user: 'userObj',
      };

      expect(controller.user(req)).toBe(req.user);
    });
  });
});

Answer 1

对于它的价值，您不需要测试框架提供的装饰器是否也设置了您所期望的。这就是为什么框架开始对它们进行测试的原因。不过，如果您想检查装饰器是否确实设置了预期的元数据you can see that done here。

如果您只是想测试守卫，您可以直接实例化 GuardClass 并通过提供 ExecutionContext 对象来测试其 canActivate 方法。 I've got an example here。该示例使用library that creates mock objects for you（从那时起为renamed），但它的想法是您将创建一个类似

的对象

const mockExecutionContext: Partial<
  Record<
    jest.FunctionPropertyNames<ExecutionContext>,
    jest.MockedFunction<any>
  >
> = {
  switchToHttp: jest.fn().mockReturnValue({
    getRequest: jest.fn(),
    getResponse: jest.fn(),
  }),
};

其中getRequest 和getResponse 返回HTTP 请求和响应对象（或至少它们的一部分）。要仅使用此对象，您还需要使用 as any 以防止 Typescript 抱怨太多。

Answer 2

我意识到它并不完全是您正在寻找的答案，但是在@Jay McDoniel 的答案的基础上，我使用以下内容来测试自定义装饰器在控制器功能上的存在（尽管我不能 100% 确定这是否正确测试非自定义守卫的方法）

import { Controller } from '@nestjs/common';
import { UseGuards } from '@nestjs/common';
import { JwtAuthGuard } from './jwtAuthGuard';

@Controller()
export class MyController {

  @UseGuards(JwtAuthGuard)
  user() {
    ...
  }
}

it('should ensure the JwtAuthGuard is applied to the user method', async () => {
  const guards = Reflect.getMetadata('__guards__', MyController.prototype.user)
  const guard = new (guards[0])

  expect(guard).toBeInstanceOf(JwtAuthGuard)
});

对于控制器

it('should ensure the JwtAuthGuard is applied to the controller', async () => {
  const guards = Reflect.getMetadata('__guards__', MyController)
  const guard = new (guards[0])

  expect(guard).toBeInstanceOf(JwtAuthGuard)
});