Sinon 存根不允许对实际功能进行测试覆盖答案

【问题标题】：Sinon stub not allowing for test coverage on actual functionSinon 存根不允许对实际功能进行测试覆盖
【发布时间】：2021-09-10 08:56:09
【问题描述】：

这里是被测函数：

export const callStoredProcedure = async (procedureName, procedureArgs)
 => {
  let resultSet: any;
  try {
    await knexClient.transaction(async trx => {
      await trx.raw(`CALL ${procedureName}(${procedureArgs});`).then(result => {
        if (result[0] && result[0][0]) {
          resultSet = JSON.stringify(result[0][0]);
        }
      });
    });
  } catch (err) {
    console.log(err);
  }
  return resultSet;
};

在这里，我在 beforeEach 块中模拟 knexClient：

 let knexClientMock;
  beforeEach(() => {
    // Stub Data source clients
    const rawStub = sinon.stub().resolves([{ affectiveRows: 0, insertId: 0 }]);
    knexClientMock = sinon.stub(knexClient, 'transaction').callsFake(
      async (): Promise<any> => {
        return {
          raw: rawStub,
        };
      },
    );
  });

但是，当我运行测试时，if 语句 if (result[0] && result[0][0]) 永远不会运行，并且 Jest 覆盖显示从 raw 语句到 catch 的所有内容都未发现。

模拟似乎工作正常，因为它使用了模拟 knexClient.transaction，但它没有覆盖其余的行。我想我只想用模拟承诺结果模拟 raw 函数并允许 .then 函数运行。

如何仅模拟 knexClient.transaction.raw 函数并允许其余代码具有测试覆盖率？

【问题讨论】：

将事务存根标记为异步时会发生什么？现在给事务的回调在代码中是异步的，但在你的模拟中是同步的。可能在您的测试中发生的情况是您的 catch 处理程序正在记录 TypeError，因为返回对象上不存在属性 then。
不错，但似乎无法解决问题。我将 `sinon.stub(knexClient, 'tranaction') 标记为异步，但仍然有同样的问题。顺便说一句，没有抛出/捕获错误。我将使用新代码编辑原始帖子

标签： node.js typescript unit-testing sinon

【解决方案1】：

问题是您的测试存根没有正确模拟正在使用的对象：

您代码中的“事务”方法采用单个参数（回调函数）并调用此回调，将具有异步“原始”方法的事务执行器传递给它。

您的测试存根使“事务”方法返回一个具有异步原始方法的对象。

在为您的代码编写单元测试时，首先要了解您的代码是如何工作的，这一点非常重要。否则，编写无法防止引入错误的无意义测试非常容易。

【讨论】：