NestJS gRPC客户端E2E测试问题：无法加载自定义配置与.proto文件

核心问题拆解 #

你的测试代码没有正确覆盖原AppModule中的ClientsModule配置，同时测试环境下Proto文件的相对路径解析逻辑和开发环境不一致，导致路径错误。以下是针对性的解决方案：

1. 完全隔离测试模块的ClientsModule配置 #

不要直接导入AppModule（否则会继承生产环境的gRPC配置），而是在测试模块中手动注册ClientsModule，使用测试专用的配置项：

import { Test } from '@nestjs/testing';
import { ClientsModule, Transport } from '@nestjs/microservices';
import { join } from 'path';
import { ConfigModule } from '@nestjs/config';
import { UsersClient } from '../src/users/users.client';

describe('Users Service E2E Tests', () => {
  let usersClient: UsersClient;

  beforeEach(async () => {
    const moduleRef = await Test.createTestingModule({
      imports: [
        // 加载测试环境变量
        ConfigModule.forRoot({
          envFilePath: '.env.test',
          isGlobal: true,
        }),
        // 手动注册测试用gRPC客户端
        ClientsModule.register([
          {
            name: 'USERS_SERVICE', // 必须和生产代码中注入的名称一致
            transport: Transport.GRPC,
            options: {
              url: process.env.TEST_GRPC_URL || 'localhost:50051',
              package: 'users',
              // 使用绝对路径确保测试环境能找到Proto文件
              protoPath: join(__dirname, '../src/proto/users.proto'),
            },
          },
        ]),
      ],
      providers: [UsersClient],
    }).compile();

    usersClient = moduleRef.get<UsersClient>(UsersClient);
  });

  it('should fetch user via gRPC', async () => {
    const response = await usersClient.getUser({ id: 'test-id' });
    expect(response).toHaveProperty('id');
  });
});

如果必须导入AppModule（比如依赖其他模块），可以用模块覆盖功能替换原ClientsModule配置：

const moduleRef = await Test.createTestingModule({
  imports: [AppModule],
})
.overrideModule(ClientsModule)
.useModule(ClientsModule.register([
  // 测试用gRPC配置
  {
    name: 'USERS_SERVICE',
    transport: Transport.GRPC,
    options: {
      url: 'localhost:50052',
      package: 'users',
      protoPath: join(__dirname, '../src/proto/users.proto'),
    },
  },
]))
.compile();

2. 修复Proto文件路径问题 #

方式一：确保Nest编译时复制Proto文件到测试目录

更新nest-cli.json，确保编译时将Proto文件纳入资源文件：

{
  "collection": "@nestjs/schematics",
  "sourceRoot": "src",
  "compilerOptions": {
    "deleteOutDir": true,
    "assets": ["**/*.proto"],
    "watchAssets": true
  }
}

方式二：在Jest配置中添加路径映射

修改jest-e2e.json，添加模块路径映射，避免相对路径解析错误：

{
  "moduleFileExtensions": ["js", "json", "ts"],
  "rootDir": ".",
  "testEnvironment": "node",
  "testRegex": ".e2e-spec.ts$",
  "transform": {
    "^.+\\.(t|j)s$": "ts-jest"
  },
  "moduleNameMapper": {
    "^src/(.*)$": "<rootDir>/src/$1"
  }
}

3. 验证配置生效的关键检查点 #

• 打印protoPath的实际路径，确认是否指向正确文件：

  console.log('Proto文件路径:', join(__dirname, '../src/proto/users.proto'));
  

• 确保UsersClient中注入的gRPC客户端名称和测试配置中的name完全一致（比如@Inject('USERS_SERVICE')）
• 测试环境变量文件.env.test中必须包含测试用的gRPC地址配置

内容的提问来源于stack exchange，提问作者mh377