axios - NestJS:使用基于 axios 的客户端的端到端测试未按预期工作

Question

我有一个公开一些端点的 NestJS 应用程序，我已经编写了一个客户端应用程序，我计划将其作为 NPM 包发布以与 nest 服务器一起使用。我正在尝试编写启动 nest 服务器的端到端测试，将其连接到本地 docker 容器中的测试数据库，并使用客户端对其进行测试。以下是我尝试做的一些片段:

Controller :

@Controller('/api/v1/messages')
export class MessagesController {

    constructor(
        private messagesService: MessagesService
    ) {}

    @Get()
    @UsePipes(new ValidationPipe({ whitelist: true, forbidNonWhitelisted: true }))
    private findAll(
        @Query() searchCriteria: MessageSearchDto
    ): Promise<MessageDto[]> {
        if (Object.keys(searchCriteria).length > 0) 
            return this.messagesService.search(searchCriteria);
        return this.messagesService.findAll();
    }
}

客户:

const http = require('axios');
const dotenv = require('dotenv');

dotenv.config();

export class MessageClient {

    public baseUri: string = process.env.MessageClientTarget ?? './';

    constructor() {}

    public async findAll() {
        return await http.get(this.baseTarget());
    }

    private baseTarget() {
        return `${this.baseUri}/api/v1/messages`;
    }
}

端到端测试:

describe('MessageController (e2e)', () => {
    let app: INestApplication;
    let client: MessageClient = new MessageClient();

    beforeAll(async () => {
        let moduleFixture: TestingModule = await Test.createTestingModule({
        imports: [AppModule, MessagesModule],
        }).compile();

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

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

    it('/ (GET)', async done => {
        const { data: messages } = await client.findAll()
        expect(messages).toEqual([]);    
        done();
    });
});

和.env:

MessageClientTarget=http://localhost:3000

当我尝试运行它时，出现以下错误:“connect ECONNREFUSED 127.0.0.1:3000”

据我了解，这是因为 createNestApplication 方法实际上并未启动服务器，而是创建了应用程序的模拟版本。

我的问题是如何使用 INestApplication 或 TestingModule 来启动应用程序，或者我必须以什么其他方式以编程方式启动 NestJS 应用程序。对我来说，重要的是我使用基于 Axios 的客户端执行 e2e 测试，而不是作为同时测试客户端和服务器的 super 测试。

我已验证服务器应该在本地端口 3000 上启动，并且我已验证客户端设置了正确的 baseUri。客户端在测试时使用的地址为:http://localhost:3000/api/v1/messages，测试时将值输出到控制台进行验证。此外，目前只有数据库位于 docker 容器中，并且我可以正常运行。整个应用程序在本地运行时运行完美，只有在测试时才会失败。

Answer 1

请确保您运行测试的测试环境设置为节点。在你的 jest 配置文件中添加 testEnvironemnt:'node' jest 参数。

无论您运行的是 nestjs 测试模块还是实际的 nestjs 应用程序实例，您都可以使用您选择的任何客户端运行端到端测试。我个人使用测试模块，因为它可以很容易地在测试应用程序时模拟应用程序的任何第三方依赖项(这是测试模块的主要目的，提供一种优雅的方式来替换或模拟您可能想要的任何组件) .