Mocha测试中如何对Node.js未导出内部方法执行expect断言

你给出的myfile.js中a()是模块作用域下的私有方法，未通过module.exports导出时，外部测试文件无法通过原生require拿到方法引用直接做断言，以下是几种可落地的实现方式：

方案1：使用rewire直接获取私有方法（无侵入，推荐） #

rewire是专门用于Node.js模块私有变量访问的工具，不需要修改业务代码，就可以拿到模块内部未导出的方法、变量，完全满足直接对a()做断言的需求。

• 安装依赖

npm install rewire mocha chai sinon --save-dev

• 测试文件示例代码（直接断言a方法返回值）

const rewire = require('rewire');
const { expect } = require('chai');
// 注意：必须用rewire加载目标模块，不能用原生require
const myFileModule = rewire('./myfile.js');

describe('内部方法a测试', () => {
  it('a()返回值应为true', () => {
    // 通过__get__方法获取模块内部未导出的a方法
    const internalA = myFileModule.__get__('a');
    expect(internalA()).to.be.true;
  });
});

如果需要mocka()的返回值、验证main方法异常分支是否调用了a，可以配合sinon实现：

const rewire = require('rewire');
const sinon = require('sinon');
const { expect } = require('chai');
const myFileModule = rewire('./myfile.js');

describe('main方法异常逻辑测试', () => {
  it('捕获到异常时必须调用a方法', () => {
    // 创建mock桩替换原a方法
    const mockA = sinon.stub().returns(true);
    // 注入mock方法替换模块内部的a
    myFileModule.__set__('a', mockA);

    // 构造触发异常的场景调用main
    myFileModule.main();

    // 断言调用逻辑和返回值
    expect(mockA.calledOnce).to.be.true;
    expect(mockA()).to.be.true;
  });
});

方案2：调整业务代码，测试环境导出内部方法（无额外依赖） #

如果不想引入第三方模块，可以对业务代码做极小的侵入调整，仅在测试环境暴露内部方法，生产环境不会对外泄露私有逻辑：

• 修改myfile.js代码

function main() {
  try {
    // 可手动抛出异常测试分支逻辑
    // throw new Error('test error')
  } catch (err) {
    a();
  }
}

function a() {
  // 注意：原代码的return true/false是JS语法错误，需替换为实际布尔返回逻辑
  return true;
}

// 仅测试环境导出内部方法
if (process.env.NODE_ENV === 'test') {
  module.exports._internal = { a };
}
module.exports.main = main;

• 测试时设置环境变量为test，即可直接拿到内部方法做断言

const { expect } = require('chai');
const myFileModule = require('./myfile.js');

describe('内部方法a测试', () => {
  it('a()返回值应为true', () => {
    expect(myFileModule._internal.a()).to.be.true;
  });
});

注意事项 #

• 不要通过修改Node.js模块缓存、篡改require内部实现的方式强行获取私有方法，这类方案兼容性极差，Node版本迭代后很容易失效
• 原始代码中return true/false属于语法错误，JavaScript中没有该运算符，运行前需要修改为合法的布尔返回逻辑

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