本文详解如何使用 sinon + chai 对 node.js 模块中「被导入并调用的子模块函数」进行精准单元测试，重点解决因模块导入方式不当导致的 spy/stub 失效问题，并提供可运行的重构示例与验证要点。
本文详解如何使用 sinon + chai 对 node.js 模块中「被导入并调用的子模块函数」进行精准单元测试，重点解决因模块导入方式不当导致的 spy/stub 失效问题，并提供可运行的重构示例与验证要点。
在 Node.js 单元测试中，一个常见但易出错的场景是：主模块（mainModule）内部依赖并调用了另一个模块（functionModule）的函数，我们希望验证该依赖函数是否被正确调用。初学者常尝试直接对 mainModule 对象上“不存在的属性”打 spy（如 chai.spy.on(mainModule, 'functionModule')），这必然失败——因为 functionModule 并非 mainModule 的导出方法，而是其闭包内私有引用的依赖项。
要成功拦截和断言依赖调用，核心原则是：必须 stub（或 spy）被导入模块本身的导出接口，而非主模块。这意味着模块导出方式需支持可替换性（即采用命名导出或对象导出），而非默认导出匿名函数。
✅ 正确实践：模块重构 + Sinon Stub
首先，重构 functionModule.js，放弃默认导出匿名函数，改用具名导出：
// functionModule.js
const send = (param) => {
let somethingOld;
if (param) {
somethingOld = param;
}
return somethingOld;
};
module.exports = { send }; // ✅ 支持 sinon.stub(functionModule, 'send')接着，同步更新 mainModule.js，显式调用具名方法：
// mainModule.js
const functionModule = require('./functionModule');
module.exports = (param1, param2) => {
// 注意：原示例中 argument 未定义，此处修正为使用入参（如 param1）
const somethingNew = functionModule.send(param1); // ✅ 调用 functionModule.send
return { somethingNew };
};最后，编写可验证的测试用例（使用 Sinon stub + Chai expect）：
// mainModule.test.js
const mainModule = require('../mainModule');
const functionModule = require('../functionModule'); // ✅ 直接引入被依赖模块
const sinon = require('sinon');
const { expect } = require('chai');
describe('test mainModule', () => {
it('should call functionModule.send exactly once', () => {
// ✅ Stub functionModule 的 send 方法，避免实际执行
const sendStub = sinon.stub(functionModule, 'send').returns('stubbed-result');
// 执行被测函数
const result = mainModule('test-param', 'ignored');
// ✅ 断言：stub 被调用一次，且参数正确
expect(sendStub.calledOnce).to.be.true;
expect(sendStub.firstCall.args[0]).to.equal('test-param');
// ✅ 可选：验证返回值符合预期
expect(result).to.deep.equal({ somethingNew: 'stubbed-result' });
// ? 测试后恢复原始方法（推荐在 afterEach 中统一 restore）
sendStub.restore();
});
});⚠️ 关键注意事项
- 不要 stub mainModule 上不存在的属性：chai.spy.on(mainModule, 'functionModule') 失败是因为 functionModule 是局部变量，不是 mainModule 的属性。
- 确保模块导入路径准确：测试文件中 require('../functionModule') 必须与 mainModule 中的 require('./functionModule') 指向同一份模块实例（Node.js 缓存机制保证单例）。
- 及时 restore stub：避免影响其他测试用例。建议在 afterEach 中调用 sinon.restore() 或对每个 stub 显式 .restore()。
- 参数校验增强可靠性：仅检查 calledOnce 不足以证明逻辑正确，应结合 firstCall.args 验证传入参数是否符合预期。
- Mocha + Sinon + Chai 组合版本兼容性：推荐使用 Sinon v15+（API 稳定）、Chai v4+，并确保 sinon-chai 插件已安装以支持 expect(stub).to.have.been.calledWith(...) 等链式断言。
通过以上结构化重构与测试设计，你将获得可维护、可验证、符合模块化测试最佳实践的单元测试方案。
