如何验证已使用Moq调用ILogger<T>.Log扩展方法?

c#

我创建了一个 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 无法设置扩展方法。

我想避免为此问题安装其他第三方软件包。有没有办法让测试通过?

回答

你不能模拟扩展方法。

而不是嘲笑

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 类已成为内部的。所以你不能将它与通用的 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 类型的对象转换为接口 IReadOnlyList<KeyValuePair<string, object?>> 并验证不同参数的字符串/值。


以上是如何验证已使用Moq调用ILogger&lt;T&gt;.Log扩展方法?的全部内容。
THE END
分享
二维码
< <上一篇
下一篇>>