SinonJS 测试指南：如何对模块依赖进行桩测试-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00939/article/details/148417249

SinonJS 测试指南：如何对模块依赖进行桩测试

sinon Test spies, stubs and mocks for JavaScript. 项目地址: https://gitcode.com/gh_mirrors/si/sinon

什么是桩测试？

在单元测试中，桩测试(Stub)是一种模拟技术，它允许我们替换真实依赖的行为，以便更专注地测试目标模块的功能。SinonJS 提供了强大的桩测试功能，能够帮助我们创建、配置和管理测试桩。

基本桩测试方法

关键概念

模块依赖：当测试一个模块时，该模块可能依赖其他模块的功能
桩替换：通过替换依赖模块的特定方法，控制其行为
测试隔离：确保测试只关注目标模块，不受依赖模块实现的影响

基本示例

假设我们有以下两个模块：

// dependencyModule.js
function getSecretNumber() {
  return 44;
}

module.exports = { getSecretNumber };

// moduleUnderTest.js
const dependencyModule = require("./dependencyModule");

function getTheSecret() {
  return `The secret was: ${dependencyModule.getSecretNumber()}`;
}

module.exports = { getTheSecret };

测试代码如下：

const assert = require("assert");
const sinon = require("sinon");

const dependencyModule = require("./dependencyModule");
const { getTheSecret } = require("./moduleUnderTest");

describe("moduleUnderTest", function() {
  describe("when the secret is 3", function() {
    it("should be returned with a string prefix", function() {
      // 创建桩
      sinon.stub(dependencyModule, "getSecretNumber").returns(3);
      
      // 执行测试
      const result = getTheSecret();
      
      // 验证结果
      assert.equal(result, "The secret was: 3");
    });
  });
});

重要注意事项

避免解构：被桩替换的方法不能在模块或测试中被解构
作用域：必须在测试中显式导入依赖模块
清理：测试完成后应恢复原始方法（可使用sinon.restore()）

异步代码的桩测试

对于返回 Promise 的异步依赖，测试需要特殊处理：

异步示例

// userApi.js
const axios = require("axios");

async function getPageOfUsers(page) {
  const result = await axios({
    method: "GET",
    url: `https://reqres.in/api/users?page=${page}`,
  });
  return result.data;
}

module.exports = { getPageOfUsers };

// userUtils.js
const userApi = require("./userApi");

async function getAllUsers() {
  const users = [];
  let page = 0, usersPage = null;

  do {
    page += 1;
    usersPage = await userApi.getPageOfUsers(page);
    users.push(...usersPage.data);
  } while (usersPage.total_pages > page);

  return users;
}

module.exports = { getAllUsers };

测试代码：

const assert = require("assert");
const sinon = require("sinon");
const userUtils = require("./userUtils");
const userApi = require("./userApi");

describe("userUtils", function() {
  let getPageOfUsersStub;

  beforeEach(function() {
    getPageOfUsersStub = sinon.stub(userApi, "getPageOfUsers");
  });

  afterEach(function() {
    sinon.restore();
  });

  describe("when a single page of users exists", function() {
    it("should return users from that page", async function() {
      // 准备测试数据
      const pageOfUsers = {
        page: 1,
        total_pages: 1,
        data: [aUser(1), aUser(2), aUser(3)]
      };

      // 配置桩行为
      getPageOfUsersStub.returns(Promise.resolve(pageOfUsers));

      // 执行并等待异步操作
      const result = await userUtils.getAllUsers();

      // 验证结果
      assert.equal(result.length, 3);
      assert.equal(getPageOfUsersStub.calledOnce, true);
    });
  });
});