在前端开发中，单元测试是非常重要的一环，可以大大提高代码的健壮性和可维护性。chai是一个流行的 JavaScript 测试框架，它提供了一些非常有用的测试工具，比如spy和stub。在本文中，我们将讨论如何使用chai的spy和stub，以及如何在单元测试中应用它们。
spy
chai中的spy是一种特殊类型的函数，可以用来监视其他函数的执行情况。spy函数实际上是被测函数的包装器，它会记录每次被调用时的参数、返回值等信息，以便我们在测试中进行断言。使用spy可以轻松地验证函数的调用次数、传入参数、返回值等等。
创建一个spy
chai中的spy可以使用chai.spy方法创建，例如：
-- -------------------- ---- ------- ----- ---- - ---------------- ----- ----- - ---------------------- ---------------- ----- --- - -- -- - ---------------- -- --------- - ----- ------ - --------------
上面的代码中，我们通过调用chai.spy方法，创建了一个监视函数foo的spy。注意，在创建spy之前，需要先使用chai.use(spies)告诉chai我们要使用spy组件。
调用一个spy
在使用spy时，我们将不再直接调用被监视的函数，而是使用spy来包装它。例如，下面的代码中，我们用spyFoo代替了原来的foo函数：
spyFoo();
当我们调用spyFoo时，chai会记录下该调用的相关信息。我们可以在测试代码中使用chai.assert(spyFoo.called)来判断该函数是否被调用过。
断言一个spy
chai中提供了很多高级的spy断言方法，可以方便地对函数进行断言。例如，我们可以使用chai.assert(spyFoo.called)来判断函数是否被调用过，使用chai.assert(spyFoo.calledOnce)来判断函数是否只被调用了一次，使用chai.assert(spyFoo.calledWith('bar'))来判断函数是否被传入了参数'bar'等。
下面是一个完整的spy使用示例：
-- -------------------- ---- ------- ----- ---- - ---------------- ----- ----- - ---------------------- ---------------- ----- --- - --- -- -- - ---------------- -- ------ ------ -- --- ------ - - -- - ----- ------ - -------------- --------- --- --------------------------- ------------------------------- -------------------------------- ---- ----------------------------------------- ---
上面的代码中，我们创建了一个监视函数foo的spy，并调用了它。然后，我们使用四个不同的断言来验证spy的行为是否符合预期。
stub
chai中的stub与spy非常相似，不同之处在于，stub不仅可以监视函数的执行情况，还可以替换函数的行为。使用stub，我们可以轻松地模拟一个函数的返回值、抛出异常等等，以便进行测试。
创建一个stub
chai中的stub也可以使用chai.spy方法创建，例如：
-- -------------------- ---- ------- ----- ---- - ---------------- ----- ----- - ---------------------- ---------------- ----- --- - -- -- - ---------------- -- --------- ------ -- - ----- ------- - ---------------- ------------------
上面的代码中，我们使用chai.spy.on方法来创建了一个监视函数foo的stub。通过传入被监视函数和要替换的函数名，我们可以将原本的函数替换为一个新的函数。在这个新的函数中，我们可以使用returns方法来指定返回值。
调用一个stub
当我们调用stubFoo时，chai会执行我们替换的那个函数，并返回我们指定的返回值：
console.log(stubFoo()); // 输出2
断言一个stub
与spy相似，chai中也提供了丰富的stub断言方法。例如，我们可以使用chai.assert(stubFoo.called)来判断函数是否被调用过，使用chai.assert.equal(stubFoo.returnValues[0], 2)来判断函数返回的值是否为我们指定的值等等。
下面是一个完整的stub使用示例：
-- -------------------- ---- ------- ----- ---- - ---------------- ----- ----- - ---------------------- ---------------- ----- --- - --- -- -- - ---------------- -- ------ ------ -- --- ------ - - -- - ----- ------- - ---------------- ------------------ ---------------------- ---- -- --- ---------------------------- ------------------------------------------ ---
上面的代码中，我们创建了一个监视函数foo的stub，并调用了它。然后，我们使用两个不同的断言来验证stub的行为是否符合预期。
总结
在单元测试中，使用chai的spy和stub可以大大提高测试的效率和可靠性。无论是监视函数的执行情况，还是替换函数的行为，chai都可以提供非常好用的工具。在实际开发中，我们应该充分利用这些工具来保证代码的质量和可维护性。
参考资料
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6471667f968c7c53b0f44db7