如何验证 ILogger<t> .Log 扩展方法是否已使用 Moq 调用？</t>

Question

我创建了一个 xUnit 项目来测试这个示例代码

public class ClassToTest
{
    private readonly ILogger<ClassToTest> _logger;

    public ClassToTest(ILogger<ClassToTest> logger)
    {
        _logger = logger;
    }
    
    public void Foo() => _logger.LogError(string.Empty);
}

我安装了 Moq 来为记录器创建一个模拟实例

public class ClassToTestTests
{
    private readonly ClassToTest _classToTest;
    private readonly Mock<ILogger<ClassToTest>> _loggerMock;
    
    public ClassToTestTests()
    {
        _loggerMock = new Mock<ILogger<ClassToTest>>();
        _classToTest = new ClassToTest(_loggerMock.Object);
    }

    [Fact]
    public void TestFoo()
    {
        _classToTest.Foo();
        
        _loggerMock.Verify(logger => logger.LogError(It.IsAny<string>()), Times.Once);
    }
}

运行测试时，我收到此错误消息

System.NotSupportedException：不支持的表达式：logger => logger.LogError(It.IsAny(), new[] { })

System.NotSupportedException 不支持的表达式：logger => logger.LogError(It.IsAny(), new[] { }) 扩展方法（此处：LoggerExtensions.LogError）不能用于设置/验证表达式。

经过一些研究，我知道所有的日志方法都只是扩展方法。 Moq 无法设置扩展方法。

我想避免为这个问题安装额外的第三方包。 是否有任何解决方案可以使测试通过？

Answer 1

你不能模拟扩展方法。

代替 mocking

logger.LogError(...)

您需要模拟接口方法

void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception exception, Func<TState, Exception, string> formatter);

LogError 实际上像这样调用该接口方法

logger.Log(LogLevel.Error, 0, new FormattedLogValues(message, args), null, (state, ex) => state.ToString());

所以你需要模拟

 _loggerMock.Verify(logger => logger.Log(It.Is(LogLevel.Error), It.Is(0), It.IsAny<FormattedLogValues>(), It.IsAny<Exception>(), It.IsAny<Func<TState, Exception, string>>()), Times.Once);

免责声明我没有验证代码

在pinkfloydx33的评论后编辑，我在.net50中设置了一个测试示例并得出以下答案

使用最新的框架，FormattedLogValues class 已在内部实现。 因此，您不能将其与通用 Moq.It 成员一起使用。 但是 Moq 有另一种方法来做到这一点（这个答案也提到了解决方案）

像这样调用记录器

_logger.LogError("myMessage");

您需要像这样验证

_loggerMock.Verify(logger => logger.Log(
        It.Is<LogLevel>(logLevel => logLevel == LogLevel.Error),
        It.Is<EventId>(eventId => eventId.Id == 0),
        It.Is<It.IsAnyType>((@object, @type) => @object.ToString() == "myMessage" && @type.Name == "FormattedLogValues"),
        It.IsAny<Exception>(),
        It.IsAny<Func<It.IsAnyType, Exception, string>>()),
    Times.Once);

您将 It.IsAnyType 用于您无权访问的类型。 如果您需要限制验证，您可以添加一个 func<object, type> 来检查类型是否符合您的预期，或者将其转换为公共接口并验证它拥有的任何公共成员。

当您使用字符串消息和一些参数时，您需要将 FormattedLogValues 类型的 object 转换为接口 IReadOnlyList<KeyValuePair<string, object?>> 并验证不同参数的字符串/值。

Answer 2

我发现 Sergio Moreno 在Git中发布的答案对我有用：

mock.Verify(
                x => x.Log(
                        It.IsAny<LogLevel>(),
                        It.IsAny<EventId>(),
                        It.Is<It.IsAnyType>((v,t) => true),
                        It.IsAny<Exception>(),
                        It.Is<Func<It.IsAnyType, Exception, string>>((v,t) => true))