Node.js中如何测试模块导出对象的函数及验证request方法调用？

我来帮你一步步解决这两个Node.js测试相关的问题：

测试这类模块导出的对象方法，核心思路是模拟依赖、跟踪函数调用，常用的工具组合包括Mocha/Jest（测试框架）+ Sinon（存根/间谍工具），再配合proxyquire或rewire来替换模块的依赖。举个实际例子：

假设你有一个模块db.js，代码如下：

// db.js
const dbClient = require('some-db-client');

exports.sqlQuery = (sql) => {
  return dbClient.execute(sql);
};

要测试sqlQuery函数，你可以这么做：

• 用Sinon创建some-db-client的存根，模拟execute方法的行为
• 用proxyquire加载db.js并替换掉真实的some-db-client依赖
• 调用sqlQuery后，验证存根方法是否被正确调用

示例测试代码（用Mocha+Sinon+Chai）：

const proxyquire = require('proxyquire');
const sinon = require('sinon');
const { expect } = require('chai');

describe('db.js - sqlQuery', () => {
  it('should call dbClient.execute with the correct SQL', () => {
    // 1. 创建存根：模拟dbClient的execute方法
    const dbClientStub = {
      execute: sinon.stub().returns(Promise.resolve({ rows: [] }))
    };

    // 2. 用proxyquire加载目标模块，替换依赖
    const db = proxyquire('./db', {
      'some-db-client': dbClientStub
    });

    // 3. 调用要测试的函数
    const testSql = 'SELECT * FROM users';
    return db.sqlQuery(testSql).then(() => {
      // 4. 验证存根方法的调用情况
      expect(dbClientStub.execute.calledOnce).to.be.true;
      expect(dbClientStub.execute.calledWith(testSql)).to.be.true;
    });
  });
});

如果你的模块是直接导出对象（而非用require创建后再导出方法），思路是一样的：只要确保你能控制依赖，并用存根替代真实实现，就能验证函数的逻辑和调用情况。

你遇到的报错，本质是对request模块的存根结构不对——原代码里调用了request.query()，但你提供的存根没有query这个函数属性，导致调用时出错。下面分两种工具给出解决方案：

方案1：用proxyquire + Sinon修正存根 #

假设你的目标模块api.js代码如下：

// api.js
const request = require('request');

exports.sqlQuery = (params) => {
  return request.query(params);
};

测试时，你需要给request存根添加query方法，并用Sinon跟踪调用：

const proxyquire = require('proxyquire');
const sinon = require('sinon');
const { expect } = require('chai');

describe('api.js - sqlQuery', () => {
  it('should call request.query with correct parameters', async () => {
    // 关键：创建包含query方法的request存根
    const requestStub = {
      query: sinon.stub().resolves({ data: 'mock result' })
    };

    // 用proxyquire替换request依赖
    const api = proxyquire('./api', {
      'request': requestStub
    });

    // 执行测试函数
    const testParams = { sql: 'SELECT * FROM products' };
    await api.sqlQuery(testParams);

    // 验证request.query的调用情况
    expect(requestStub.query.calledOnce).to.be.true;
    expect(requestStub.query.calledWithExactly(testParams)).to.be.true;
  });
});

方案2：用rewire替换模块内部的request #

如果你想用rewire，思路是直接修改目标模块内部的request变量，而不是替换整个依赖：

const rewire = require('rewire');
const sinon = require('sinon');
const { expect } = require('chai');

describe('api.js - sqlQuery (rewire版本)', () => {
  it('should invoke request.query correctly', async () => {
    const api = rewire('./api');
    // 创建query方法的存根
    const queryStub = sinon.stub().resolves({});
    // 替换模块内的request对象
    api.__set__('request', { query: queryStub });

    await api.sqlQuery({});
    // 验证存根被调用
    expect(queryStub.calledOnce).to.be.true;
  });
});

关键注意点 #

• 存根的结构必须和真实依赖匹配：如果原代码用request.query()，存根就必须是一个包含query函数的对象，不能直接传一个函数
• 用Sinon的stub可以方便跟踪调用次数、传入参数，甚至模拟返回值（成功/失败场景都能覆盖）
• proxyquire适合替换整个模块依赖，rewire更适合修改模块内部的局部变量，根据你的场景选择即可

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