Node.js集成测试中如何Mock Google Pubsub请求？

为什么nock不好使？ #

你猜的没错，Google Cloud PubSub的Node.js客户端默认采用gRPC/HTTP2通信，而nock仅支持HTTP/1.1，完全拦截不了这类请求——这就是你碰壁的核心原因。

靠谱的Mock方案 #

1. 用Google官方Mock库（最推荐） #

Google为Cloud SDK提供了专门的测试工具@google-cloud/pubsub/build/testing，直接Mock PubSub客户端，不用碰网络层：

const { PubSub } = require('@google-cloud/pubsub');
const { mockPublish } = require('@google-cloud/pubsub/build/testing');

describe('API发布逻辑测试', () => {
  let publishMock;

  beforeEach(() => {
    // 捕获PubSub实例的publish调用
    publishMock = mockPublish(PubSub);
  });

  afterEach(() => {
    // 重置Mock，避免测试污染
    publishMock.mockRestore();
  });

  it('正确触发PubSub发布', async () => {
    // 设置Mock返回值
    publishMock.mockResolvedValue({ messageId: 'mock-message-123' });

    // 调用你的API业务逻辑
    await yourPublishApi('target-topic', 'test-content');

    // 验证调用参数是否符合预期
    expect(publishMock).toHaveBeenCalledWith('target-topic', Buffer.from('test-content'));
  });
});

官方维护的工具完全匹配客户端API，兼容性拉满，不用自己造轮子。

2. 用Testcontainers启动本地模拟器 #

如果需要接近真实环境的端到端测试（但不想调用云端服务），可以用Testcontainers启动PubSub本地模拟器：

const { PubSub } = require('@google-cloud/pubsub');
const { GenericContainer } = require('testcontainers');

describe('本地模拟器测试', () => {
  let pubSubClient;
  let emulatorContainer;

  beforeAll(async () => {
    // 启动PubSub模拟器容器
    emulatorContainer = await new GenericContainer('google/cloud-sdk')
      .withCommand(['gcloud', 'beta', 'emulators', 'pubsub', 'start', '--host-port=0.0.0.0:8085'])
      .withExposedPorts(8085)
      .start();

    // 配置客户端连接到模拟器
    const mappedPort = emulatorContainer.getMappedPort(8085);
    process.env.PUBSUB_EMULATOR_HOST = `localhost:${mappedPort}`;
    pubSubClient = new PubSub();
  });

  afterAll(async () => {
    // 测试结束关闭容器
    await emulatorContainer.stop();
  });

  it('成功向模拟器发布消息', async () => {
    const topic = await pubSubClient.createTopic('test-topic');
    const messageId = await topic.publish(Buffer.from('test-payload'));

    expect(messageId).toBeDefined();
  });
});

这种方式能完整模拟云端PubSub的行为，适合测试发布+订阅的全流程场景。

3. 手动Mock PubSub模块（轻量方案） #

如果不想加额外依赖，直接用Jest/Vitest的Mock功能替换整个PubSub模块：

// 测试文件顶部Mock @google-cloud/pubsub
jest.mock('@google-cloud/pubsub', () => {
  const mockPublish = jest.fn().mockResolvedValue({ messageId: 'mock-id' });
  const mockTopic = jest.fn().mockReturnValue({ publish: mockPublish });
  const mockPubSub = jest.fn().mockReturnValue({ topic: mockTopic });

  return { PubSub: mockPubSub };
});

const { PubSub } = require('@google-cloud/pubsub');
const yourApi = require('./your-api-module');

it('正确调用PubSub发布方法', async () => {
  await yourApi.publishToTopic('demo-topic', 'hello-test');

  // 验证调用链是否符合预期
  expect(PubSub).toHaveBeenCalled();
  expect(PubSub.prototype.topic).toHaveBeenCalledWith('demo-topic');
  expect(PubSub.prototype.topic().publish).toHaveBeenCalledWith(Buffer.from('hello-test'));
});

轻量灵活，适合简单场景，但需要手动维护Mock的API结构，客户端版本更新时可能要同步调整。

总结 #

优先选官方Mock库，省心靠谱；需要真实流程测试就上本地模拟器；简单场景手动Mock也够用。nock确实搞不定gRPC/HTTP2请求，别在这上面死磕了。

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