如何使用Sinon、Proxyquire或Rewire强制模拟未导出函数的返回值？

嘿，这个需求太常见了——要测试导出函数的失败路径，就得mock掉它依赖的未导出内部函数对吧？我来给你拆解用Rewire+Sinon、以及Proxyquire的实现方式，都是实战里常用的套路：

首先先补充下被测代码的完整场景（假设你有一个导出的publicFunction依赖未导出的saySecret）：

// utils.js
function saySecret() { // 未导出的内部函数
  return '狼';
}

export function publicFunction() {
  const secretValue = saySecret();
  if (secretValue === '狼') {
    return 'success';
  } else {
    return 'failure'; // 你要触发的失败路径
  }
}

方法1：Rewire + Sinon（最适合同一模块内的未导出函数） #

Rewire的__set__方法可以直接替换模块内部的未导出变量/函数，结合Sinon的stub能方便地控制返回值、验证调用行为：

// utils.test.js
import utilsRewire from './utils.js';
import sinon from 'sinon';
import { expect } from 'chai';

describe('publicFunction', () => {
  let originalSaySecret; // 保存原函数，用于测试后恢复
  let saySecretStub;

  beforeEach(() => {
    // 1. 获取原未导出函数并保存
    originalSaySecret = utilsRewire.__get__('saySecret');
    // 2. 创建Sinon stub，指定返回值为你需要的测试数据
    saySecretStub = sinon.stub().returns('羊');
    // 3. 用Rewire替换模块内部的saySecret为stub
    utilsRewire.__set__('saySecret', saySecretStub);
  });

  afterEach(() => {
    // 测试后恢复原函数，避免影响其他测试用例
    utilsRewire.__set__('saySecret', originalSaySecret);
    saySecretStub.restore();
  });

  it('triggers failure path when saySecret returns unexpected value', () => {
    // 调用导出的publicFunction
    const result = utilsRewire.publicFunction();
    
    // 验证结果是否符合失败路径预期
    expect(result).to.equal('failure');
    // 额外验证saySecret是否被正确调用（可选）
    expect(saySecretStub.calledOnce).to.be.true;
  });
});

关键要点： #

• __get__：获取未导出的内部函数/变量
• __set__：替换内部函数为我们的stub
• 一定要在afterEach里恢复原函数，避免测试用例之间的污染

方法2：Proxyquire（适合跨模块依赖的mock，也能处理同一模块场景） #

Proxyquire主要用于替换模块的外部依赖，但如果你的未导出函数是依赖其他模块的（比如saySecret是从./secret-utils.js导入的），它会更顺手。如果是同一模块的未导出函数，也可以用技巧实现：

场景1：saySecret是外部依赖（更适合Proxyquire） #

假设utils.js依赖外部模块：

// utils.js
import { saySecret } from './secret-utils.js';

export function publicFunction() {
  const secretValue = saySecret();
  // ... 逻辑和之前一样
}

测试代码：

// utils.test.js
import proxyquire from 'proxyquire';
import sinon from 'sinon';
import { expect } from 'chai';

describe('publicFunction', () => {
  it('triggers failure path with proxyquire', () => {
    // 1. 创建stub控制返回值
    const saySecretStub = sinon.stub().returns('羊');
    // 2. 用proxyquire加载utils.js，替换它依赖的./secret-utils.js
    const utils = proxyquire('./utils.js', {
      './secret-utils.js': { saySecret: saySecretStub }
    });

    // 3. 调用并验证
    const result = utils.publicFunction();
    expect(result).to.equal('failure');
    expect(saySecretStub.calledOnce).to.be.true;
  });
});

场景2：saySecret是同一模块的未导出函数（Proxyquire的变通方案） #

如果一定要用Proxyquire处理同一模块的未导出函数，你可以把未导出函数抽成一个内部模块（比如./utils-internal.js），然后用Proxyquire替换这个内部模块的导出——本质上还是把它变成跨模块依赖来处理，这样更符合Proxyquire的设计初衷。

总结选择： #

• 如果你只需要mock同一模块内的未导出函数：Rewire + Sinon是最直接的方案，不需要调整代码结构。
• 如果你需要mock跨模块的依赖：Proxyquire更合适，它能统一管理模块的所有外部依赖mock。
• Sinon本身无法直接访问未导出函数，必须结合Rewire或Proxyquire来获取/替换目标函数。

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