Как тестировать контроллер с @Res аргументом в методе?

Question

[historydev]

Здравствуйте. Пытаюсь тестировать сгенерированный модуль nestjs. Всё получается, кроме одного момента, я не знаю даже как гуглить мою проблему, по ошибке ничего не находит. Собственно, я решил поиграться со статусами и использовал апи express для end-поинта следующим образом(убрал свои манипуляции с статусом, оставил проблемный аргумент):

import { Controller, Get, HttpCode, Post, HttpStatus, Res } from '@nestjs/common';
import { AppService } from './app.service';
import { Response } from 'express';

@Controller()
export class AppController {
	constructor(private readonly appService: AppService) {}
	
	@Get()
	getHello(@Res() res: Response):string {
		return this.appService.getHello('WTF its working!');
	}
}

Здесь всё работает и всё хорошо, следом я пишу тест по документации(пока нашёл только сквозное тестирование полного end-поинта, потыкал и это не помогло, видимо не то) - сейчас у меня есть следующий тест контроллера и сервиса:

import { Test, TestingModule } from '@nestjs/testing';
import { AppController } from './app.controller';
import { AppService } from './app.service';
import {Response} from 'express';

describe('AppController', () => {
  let appController: AppController;
  let appService: AppService;

  beforeEach(async () => {
    const app: TestingModule = await Test.createTestingModule({
      controllers: [AppController],
      providers: [AppService],
    }).compile();

	appService = app.get<AppService>(AppService);
    appController = app.get<AppController>(AppController);
  });

  describe('root', () => {
    it('should return "Hello World!"', async () => {
		const result = 'WTF it working!';
	
	    expect(appService.getHello('WTF it working!')).toBe(result);
        expect(appController.getHello()).toBe(result);
    });
  });
});

Тест сервиса как по маслу, всё понятно и просто, а вот изменённый мной контроллер не поддаётся тесту, я пробовал передать ему res который он требует, аналогично как передал и в настоящем контроллере, но он подсвечивает его красным. Скажите пожалуйста, что мне искать в документации для решения? или можно пример, остальное найду.

Спасибо.

Comments

[Sergey]

Через request отправлять запросы на апи.
Посмотрите https://github.com/AlariCode/top-api-demo

[historydev]

Sergey, я пробовал, но здесь другая ошибка у меня, сейчас покажу

[historydev]

Sergey, Вот смотрите, такой тест падает с такой ошибкой, но это не то, что я получал при первых попытках:

import * as request from 'supertest';
import { Test } from '@nestjs/testing';
import { AppModule } from './app.module';
import { AppService } from './app.service';
import { INestApplication } from '@nestjs/common';

describe('Cats', () => {
	let app: INestApplication;
	let appService = { getHello: () => 'test' };
	
	beforeAll(async () => {
		const moduleRef = await Test.createTestingModule({
				imports: [AppModule],
			})
			.overrideProvider(AppService)
			.useValue(appService)
			.compile();
		
		app = moduleRef.createNestApplication();
		await app.init();
	});
	
	it(`/GET WTF`, () => {
		return request(app.getHttpServer())
			.get('/')
			.expect(200)
			.expect({
				data: appService.getHello(),
			});
	});
	
	afterAll(async () => {
		await app.close();
	});
});

src/app.controller.spec.ts (17.215 s)
● Cats › /GET WTF

thrown: "Exceeded timeout of 5000 ms for a test.
Use jest.setTimeout(newTimeout) to increase the timeout value, if this is a long-running test."

21 | });
22 |
> 23 | it(`/GET WTF`, () => {
| ^
24 | return request(app.getHttpServer())
25 | .get('/')
26 | .expect(200)

at app.controller.spec.ts:23:2
at Object. (app.controller.spec.ts:7:1)

[historydev]

Sergey, о, я решил изменить под пример свой контроллер и получил passed, однако не понимаю почему, ведь значения разные:

controller:

import { Controller, Get, HttpCode, Post, HttpStatus, Res } from '@nestjs/common';
import { AppService } from './app.service';
import { Response } from 'express';

@Controller()
export class AppController {
	constructor(private readonly appService: AppService) {}
	
	@Get()
	getHello(@Res() res: Response):object {
		return res.send({data: this.appService.getHello('WTF it working!')});
	}
}

Test:

import * as request from 'supertest';
import { Test } from '@nestjs/testing';
import { AppModule } from './app.module';
import { AppService } from './app.service';
import { INestApplication } from '@nestjs/common';

describe('Cats', () => {
	let app: INestApplication;
	let appService = { getHello: () => 'test' };
	
	beforeAll(async () => {
		const moduleRef = await Test.createTestingModule({
				imports: [AppModule],
			})
			.overrideProvider(AppService)
			.useValue(appService)
			.compile();
		
		app = moduleRef.createNestApplication();
		await app.init();
	});
	
	it(`/GET WTF`, () => {
		return request(app.getHttpServer())
			.get('/')
			.expect(200)
			.expect({
				data: appService.getHello(),
			});
	});
	
	afterAll(async () => {
		await app.close();
	});
});

PASS src/app.controller.spec.ts (6.898 s)
Cats
√ /GET WTF (55 ms)

Test Suites: 1 passed, 1 total
Tests: 1 passed, 1 total
Snapshots: 0 total
Time: 7.087 s
Ran all test suites.

[historydev]

Sergey, разобрался, спасибо, скажите пожалуйста, как называется эта конструкция, как гуглить?

.then(({body}: request.Response) => {
				expect(body.data).toBe(appService.getHello())
			}) // ({body}: value)