如何使用 Moq 验证某个方法被调用了一次？

Question

如何使用 Moq 验证某个方法被调用了一次？ Verify() 与 Verifable() 的事情确实令人困惑。

Answer 1

您可以使用 Times.Once() 或 Times.Exactly(1)：

mockContext.Verify(x => x.SaveChanges(), Times.Once());
mockContext.Verify(x => x.SaveChanges(), Times.Exactly(1));

以下是 Times 类：

• AtLeast - 指定应调用模拟方法的次数为最小次数。
• AtLeastOnce - 指定模拟方法至少应调用一次。
• AtMost - 指定应调用模拟方法的次数为最大值。
• AtMostOnce - 指定模拟方法最多应调用一次。
• Between - 指定应在 from 和 to 时间之间调用模拟方法。
• Exactly - 指定模拟方法应该被精确调用几次。
• Never - 指定不应调用模拟方法。
• Once - 指定模拟方法应该被调用一次。

只要记住它们是方法调用即可；我总是被绊倒，以为它们是属性，却忘记了括号。

Answer 2

想象一下，我们正在构建一个计算器，其中包含一种将 2 个整数相加的方法。我们进一步想象一下需求是，当调用add方法时，调用一次print方法。以下是我们测试的方法：

public interface IPrinter
{
    void Print(int answer);
}

public class ConsolePrinter : IPrinter
{
    public void Print(int answer)
    {
        Console.WriteLine("The answer is {0}.", answer);
    }
}

public class Calculator
{
    private IPrinter printer;
    public Calculator(IPrinter printer)
    {
        this.printer = printer;
    }

    public void Add(int num1, int num2)
    {
        printer.Print(num1 + num2);
    }
}

这里是实际测试，代码中带有注释以供进一步说明：

[TestClass]
public class CalculatorTests
{
    [TestMethod]
    public void WhenAddIsCalled__ItShouldCallPrint()
    {
        /* Arrange */
        var iPrinterMock = new Mock<IPrinter>();

        // Let's mock the method so when it is called, we handle it
        iPrinterMock.Setup(x => x.Print(It.IsAny<int>()));

        // Create the calculator and pass the mocked printer to it
        var calculator = new Calculator(iPrinterMock.Object);

        /* Act */
        calculator.Add(1, 1);

        /* Assert */
        // Let's make sure that the calculator's Add method called printer.Print. Here we are making sure it is called once but this is optional
        iPrinterMock.Verify(x => x.Print(It.IsAny<int>()), Times.Once);

        // Or we can be more specific and ensure that Print was called with the correct parameter.
        iPrinterMock.Verify(x => x.Print(3), Times.Once);
    }
}

注意：默认情况下，Moq 将在您创建 Mock 对象后立即存根所有属性和方法。因此，即使不调用 Setup，Moq 也已经存根了 IPrinter 的方法，因此您只需调用 Verify 即可。然而，作为一个好的实践，我总是设置它，因为我们可能需要强制方法的参数以满足某些期望，或者强制方法的返回值以满足某些期望或调用它的次数。

Answer 3

测试控制器可能是：

  public HttpResponseMessage DeleteCars(HttpRequestMessage request, int id)
    {
        Car item = _service.Get(id);
        if (item == null)
        {
            return request.CreateResponse(HttpStatusCode.NotFound);
        }

        _service.Remove(id);
        return request.CreateResponse(HttpStatusCode.OK);
    }

并且当使用有效的 id 调用 DeleteCars 方法时，我们可以验证，通过此测试，服务删除方法只调用了一次：

 [TestMethod]
    public void Delete_WhenInvokedWithValidId_ShouldBeCalledRevomeOnce()
    {
        //arange
        const int carid = 10;
        var car = new Car() { Id = carid, Year = 2001, Model = "TTT", Make = "CAR 1", Price=2000 };
        mockCarService.Setup(x => x.Get(It.IsAny<int>())).Returns(car);

        var httpRequestMessage = new HttpRequestMessage();
        httpRequestMessage.Properties[HttpPropertyKeys.HttpConfigurationKey] = new HttpConfiguration();

        //act
        var result = carController.DeleteCar(httpRequestMessage, vechileId);

        //assert
        mockCarService.Verify(x => x.Remove(carid), Times.Exactly(1));
    }