如何在 Node.js 中正确测试模块内部函数调用

本文详解如何使用 sinon + chai 对 node.js 模块中依赖的子模块函数进行行为验证，通过 stub 替换被依赖函数并断言其调用状态，解决常见“未被调用”断言失败问题。

本文详解如何使用 sinon + chai 对 node.js 模块中依赖的子模块函数进行行为验证，通过 stub 替换被依赖函数并断言其调用状态，解决常见“未被调用”断言失败问题。

在 node.js 单元测试中，验证一个模块是否真正调用了其依赖的内部函数（而非仅检查返回值）是一项关键能力。但初学者常陷入误区：试图对 mainModule 本身“打桩”或“监听”其内部引用的 functionModule，而忽略了 JavaScript 模块加载与作用域绑定的本质——mainModule 内部的 functionModule 是一个独立导入的模块对象引用，必须对其源模块导出的对象属性进行 stub，而非对主模块的局部变量或未定义的方法名做 spy。

✅ 正确做法：Stub 依赖模块的导出方法

首先，需确保被依赖模块采用具名导出（Object-based export），便于精准 stub：

// functionModule.js const send = (param) => {   return param ?? undefined; };  module.exports = { send }; // ✅ 必须是命名导出，如 { send }

主模块也需显式调用该命名方法：

// mainModule.js const functionModule = require('./functionModule');  module.exports = (param1, param2) => {   // 注意：此处应使用 functionModule.send(...)，且参数需明确（原文中 argument 应为 param1 或 param2）   const somethingNew = functionModule.send(param1); // ✅ 显式调用导出方法   return { somethingNew }; };

? 测试代码：使用 Sinon stub + Chai 断言

在测试文件中，直接 stub functionModule 模块的 send 方法，并验证其是否被调用：

// 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('mocked-result');      // ✅ 执行被测函数（注意传入实际参数，避免 undefined 引发意外逻辑）     const result = mainModule('test-param', 'ignored');      // ✅ 验证 stub 是否被调用（推荐使用 calledOnce，语义清晰）     expect(sendStub.calledOnce).to.be.true;      // ✅ 可选：验证调用参数     expect(sendStub.firstCall.args[0]).to.equal('test-param');      // ✅ 清理：测试后务必 restore，避免污染其他测试     sendStub.restore();   }); });

⚠️ 关键注意事项

• ❌ 错误示范：chai.spy.on(mainModule, ‘functionModule’) 无效，因为 mainModule 并未导出 functionModule 属性；它只是内部变量。
• ✅ 必须导入被依赖模块：const functionModule = require(…) 是 stub 的前提，Sinon 需要操作该模块对象的属性。
• 参数需明确定义：argument1、argument2 等占位符必须替换为真实值（如 ‘hello’），否则可能因 undefined 导致逻辑跳过调用。
• 始终调用 .restore()：尤其在 beforeEach/afterEach 中管理 stub 生命周期，防止测试间相互干扰。
• 推荐使用 calledOnce 而非 called()：前者明确表达“期望恰好一次调用”，增强测试意图可读性。

? 总结

验证模块内依赖调用的核心逻辑是：控制依赖的入口点（即其导出接口），而非被测模块的实现细节。通过 Sinon stub 目标模块的具名方法，并结合 Chai 的语义化断言，即可可靠、隔离地完成行为驱动测试。这一模式适用于 CommonJS 环境下的绝大多数依赖注入场景，是构建健壮 Node.js 单元测试套件的基础实践。