使用Sinon编写Node.js单元测试时遇restore报错及Stub重置问题

嘿，我帮你搞定这个Sinon Stub重置的问题！你遇到的两个报错其实是关联的，咱们一步步拆解解决：

问题根源分析 #

1. TypeError: Attempted to wrap getLastData which is already wrapped：
   这是因为你在多个测试用例中重复对QueryHelper.getLastData创建Stub，但前一个测试的Stub没有被清理，导致Sinon尝试包装一个已经被包装过的方法。

2. sinon.restore is not a function：
   全局的sinon.restore()并不是万能的——它只对通过sinon.wrap()或者全局注册的包装生效。而你用sinon.stub()直接创建的Stub，需要用Stub自身的restore()方法，或者通过Sinon Sandbox来统一管理重置。

解决方案一：使用Sinon Sandbox（推荐） #

Sandbox是Sinon提供的最整洁的方式，它可以帮你统一管理所有Stub，确保每个测试用例都是独立的，测试后自动清理所有修改。

var assert = require('assert');
var sinon = require('sinon');
// 替换成你的QueryHelper实际路径
var QueryHelper = require('./path/to/QueryHelper');

describe('QueryHelper 单元测试', function() {
  let sandbox;

  // 每个测试前创建新的sandbox
  beforeEach(function() {
    sandbox = sinon.createSandbox();
  });

  // 每个测试后重置sandbox，清理所有Stub
  afterEach(function() {
    sandbox.restore();
  });

  it('应该返回模拟的lastData实体', async function() {
    // 用sandbox创建Stub，模拟Promise resolve的结果
    const mockLastData = { id: 123, content: '测试数据' };
    sandbox.stub(QueryHelper, 'getLastData').resolves(mockLastData);

    // 执行测试逻辑
    const result = await QueryHelper.getLastData();
    assert.deepStrictEqual(result, mockLastData);
  });

  it('应该处理getLastData返回null的场景', async function() {
    // 这里可以重新创建Stub，不会有重复包装的问题
    sandbox.stub(QueryHelper, 'getLastData').resolves(null);

    const result = await QueryHelper.getLastData();
    assert.strictEqual(result, null);
  });
});

解决方案二：单独重置单个Stub #

如果你不想用Sandbox，也可以针对每个创建的Stub单独调用restore()方法，确保测试后清理。

var assert = require('assert');
var sinon = require('sinon');
var QueryHelper = require('./path/to/QueryHelper');

describe('QueryHelper 单元测试', function() {
  let getLastDataStub;

  // 每个测试后重置Stub
  afterEach(function() {
    if (getLastDataStub) {
      getLastDataStub.restore();
    }
  });

  it('应该返回模拟数据', async function() {
    const mockData = { id: 456, content: '另一份测试数据' };
    // 保存Stub引用，方便后续重置
    getLastDataStub = sinon.stub(QueryHelper, 'getLastData').resolves(mockData);

    const result = await QueryHelper.getLastData();
    assert.deepStrictEqual(result, mockData);
  });
});

额外提示 #

针对返回Promise的方法，Sinon提供了resolves()和rejects()方法来快速模拟Promise的成功/失败状态，这个你已经在使用了，继续保持就好~

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