使用Sinon模拟Node.js无导出API方法的技术咨询

我当初刚从Java转Node.js写测试的时候，也觉得Sinon和Mockito的思路有点拧巴，加上模块没导出方法的问题，确实容易卡壳。咱们一步步来拆解解决：

1. 先搞定“访问未导出的subscribeToChannel方法” #

因为你的index.js没有把这个方法导出，直接require是拿不到的，这里推荐用rewire库——它能帮你访问模块内部的私有变量和方法，不用修改原代码的结构。

步骤： #

• 先安装rewire：

npm install rewire --save-dev

• 在测试文件里用rewire获取私有方法：

const rewire = require('rewire');
const indexModule = rewire('./index.js');
// 用__get__方法取出subscribeToChannel
const subscribeToChannel = indexModule.__get__('subscribeToChannel');

2. 用Sinon存根依赖（对应Mockito的Mock） #

假设你的subscribeToChannel是通过axios或者其他HTTP库发起POST请求，那我们需要存根这个HTTP调用，避免真的请求外部服务。这里对比下Sinon和Mockito的思路，帮你快速对应：

完整测试示例（配合Mocha+Chai） #

假设你的index.js里的逻辑大概是这样：

const axios = require('axios');

function subscribeToChannel(channelId) {
  return axios.post('https://your-api.com/channel/subscribe', { channelId });
}

// 假设绑定到某个Express路由
const express = require('express');
const app = express();
app.use(express.json());
app.post('/subscribe', async (req, res) => {
  try {
    await subscribeToChannel(req.body.channelId);
    res.status(200).send({ success: true });
  } catch (err) {
    res.status(500).send({ error: 'Subscribe failed' });
  }
});
app.listen(3000);

那测试文件可以这么写：

const sinon = require('sinon');
const { expect } = require('chai');
const rewire = require('rewire');
const axios = require('axios');
const request = require('supertest'); // 如果要测API接口的话

describe('subscribeToChannel 方法测试', () => {
  let subscribeToChannel;
  let axiosPostStub;

  // 每个测试前初始化
  beforeEach(() => {
    const indexModule = rewire('./index.js');
    subscribeToChannel = indexModule.__get__('subscribeToChannel');
    // 存根axios的post方法
    axiosPostStub = sinon.stub(axios, 'post');
  });

  // 每个测试后恢复原方法，避免影响其他测试
  afterEach(() => {
    axiosPostStub.restore();
  });

  it('应该正确发起POST请求并返回结果', async () => {
    // 模拟成功响应
    const mockSuccessResponse = { data: { subscribed: true } };
    axiosPostStub.resolves(mockSuccessResponse);

    const result = await subscribeToChannel('channel_123');

    // 验证请求参数是否正确
    expect(axiosPostStub.calledOnceWith(
      'https://your-api.com/channel/subscribe',
      { channelId: 'channel_123' }
    )).to.be.true;
    // 验证返回结果
    expect(result).to.deep.equal(mockSuccessResponse);
  });

  it('请求失败时应该抛出错误', async () => {
    // 模拟请求失败
    const mockError = new Error('API timeout');
    axiosPostStub.rejects(mockError);

    try {
      await subscribeToChannel('channel_123');
      // 如果走到这里说明测试失败
      expect.fail('应该抛出错误，但没有');
    } catch (err) {
      expect(err).to.equal(mockError);
    }
  });
});

// 如果要测试API接口的完整流程
describe('/subscribe 接口测试', () => {
  let app;
  let axiosPostStub;

  beforeEach(() => {
    const indexModule = rewire('./index.js');
    app = indexModule.__get__('app'); // 取出内部的Express app实例
    axiosPostStub = sinon.stub(axios, 'post');
  });

  afterEach(() => {
    axiosPostStub.restore();
  });

  it('接口返回200当订阅成功时', async () => {
    axiosPostStub.resolves({ data: {} });

    const response = await request(app)
      .post('/subscribe')
      .send({ channelId: 'channel_123' });

    expect(response.status).to.equal(200);
    expect(response.body).to.deep.equal({ success: true });
  });

  it('接口返回500当订阅失败时', async () => {
    axiosPostStub.rejects(new Error('Fail'));

    const response = await request(app)
      .post('/subscribe')
      .send({ channelId: 'channel_123' });

    expect(response.status).to.equal(500);
    expect(response.body).to.deep.equal({ error: 'Subscribe failed' });
  });
});

3. 如果你不想用rewire？ #

如果实在不想引入新库，那只能稍微调整index.js的结构，把需要测试的方法导出，比如：

// 在index.js末尾加上
module.exports = { subscribeToChannel };
// 或者如果是Express服务器，导出app：
module.exports = { app, subscribeToChannel };

但这种方式需要修改原代码，如果你不想动原文件，rewire是更优的选择。

其实Sinon和Mockito的核心逻辑是一致的：隔离外部依赖，验证方法的交互和行为，只是API的写法不一样，多写几个用例就能适应啦。

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