如何在 C# AspNet Core 中 Moq 模拟 LoggerFactory

Question

我正在尝试为控制器操作编写一些单元测试。为此，我使用 XUnit 和 Moq。控制器在构造函数中注入了一个 ILoggerFactory。一个起订量如何进行测试？

我尝试为控制器类模拟一个 Logger，然后模拟 CreateLogger 以返回模拟 Logger，但是当调用 LogInformation() 函数时，我不断收到各种测试运行时 NullReferenceExceptions。

        //   Logger that yields only disappointment...          
        var mockLogger = new Mock<ILogger<JwtController>>();
        mockLogger.Setup(ml => ml.Log(It.IsAny<LogLevel>(), It.IsAny<EventId>(), It.IsAny<object>(), It.IsAny<Exception>(), It.IsAny<Func<object, Exception, string>>()));
        var mockLoggerFactory = new Mock<ILoggerFactory>();
        mockLoggerFactory.Setup(mlf => mlf.CreateLogger("JwtController")).Returns(mockLogger.Object);

我假设问题是正在调用 LogInformation，这是一个扩展方法，那么如何起订量呢？

Answer 1

为了它的价值：你也可以传递一个NullLoggerFactory 的实例，而不是模拟一个ILoggerFactory。这个NullLoggerFactory 将返回NullLogger 的实例。根据文档，这是一个：

什么都不做的简约记录器。

Answer 2

我只是模拟如下 ILogger 扩展方法，并在 ILoggerFactory 设置中使用返回 Mock ILogger 对象的值函数。

var mockLogger = new Mock<ILogger<[YOUR_CLASS_TYPE]>>();
mockLogger.Setup(
    m => m.Log(
        LogLevel.Information,
        It.IsAny<EventId>(),
        It.IsAny<object>(),
        It.IsAny<Exception>(),
        It.IsAny<Func<object, Exception, string>>()));

var mockLoggerFactory = new Mock<ILoggerFactory>();
mockLoggerFactory.Setup(x => x.CreateLogger(It.IsAny<string>())).Returns(() => mockLogger.Object);

这将返回您模拟的 Logger，您可以验证对其进行的任何调用。无需编写包装器或帮助器。

您甚至可以模拟 IsEnabled，这对于一些利用该功能的代码是必需的。

        mockLogger.Setup(
            m => m.IsEnabled(
                Microsoft.Extensions.Logging.LogLevel.Debug)).Returns(true);

因为只有一种方法可以模拟，（并且您必须调用），所以下面显示了您（可能）使用的日志记录调用，以使所有内容都指向这个确切的方法。

 catch (ArgumentOutOfRangeException argEx)
{
    // this.logger.LogError(argEx, argEx.Message); /* << this is what you would like to do, BUT it is an extension method, NOT (easily) mockable */
    Func<object, Exception, string> returnAnEmptyStringFunc = (a, b) => string.Empty;
    this.logger.Log(LogLevel.Error, ushort.MaxValue, argEx.Message, argEx, returnAnEmptyStringFunc);
    throw argEx;
}

Answer 3

对于任何需要这个问题的答案而不是变通方法的人，我扩展了本文的工作：

https://ardalis.com/testing-logging-in-aspnet-core

包装您使用的日志框架的任何部分，这无论如何都是个好主意。从您自己的日志记录界面开始：

public interface ILog<T>
{
    void LogError(Exception ex, string message, params object[] args);
    void LogInformation(string message, params object[] args);
}

然后添加实现以传递对框架的调用：

public class Log<T> : ILog<T>
{
    private readonly ILogger<T> logger;

    public Log(ILogger<T> logger)
    {
        this.logger = logger;
    }

    public void LogError(Exception ex, string message, params object[] args) => this.logger.LogError(ex, message, args);
    public void LogInformation(string message, params object[] args) => this.logger.LogInformation(message, args);
}

继续，添加一个用于包装记录器工厂的接口：

public interface ILogFactory
{
    ILog<T> CreateLog<T>();
}

以及实现：

public class LogFactory : ILogFactory
{
    private readonly ILoggerFactory loggerFactory;

    public LogFactory()
    {
        this.loggerFactory = new LoggerFactory();
    }

    public ILog<T> CreateLog<T>() => new Log<T>(new Logger<T>(this.loggerFactory));
}

这些是您应该引用Microsoft.Extensions.Logging 命名空间的唯一地方。在其他地方，使用您的ILog<T> 代替ILogger<T> 和您的ILogFactory 代替ILoggerFactory。您通常会在哪里依赖注入 LoggerFactory，而不是注入包装器：

IServiceCollection serviceCollection = new ServiceCollection();
serviceCollection.AddSingleton<ILogFactory>(new LogFactory());

在您的主代码中，您可以检索此 LogFactory 并为您的班级创建特定的 Log<T>：

public class MyClass
{
    public void MyMethod(IServiceCollection serviceCollection)
    {
        var serviceProvider = serviceCollection.BuildServiceProvider();
        var logFactory = this.serviceProvider.GetRequiredService<ILogFactory>();
        var log = logFactory.CreateLog<ServiceApplication>();
        log.LogInformation("Hello, World!");
    }
}

您可以想象根据需要将MyMethod 的参数从IServiceCollection 更改为ILogFactory 或ILog<MyClass>。而且 - 重点是 - 你现在可以模拟上面的代码：

[Fact]
public void Test()
{
    IServiceCollection serviceCollection = new ServiceCollection();
    var mockLog = new Mock<ILog<MyClass>>();
    var mockLogFactory = new Mock<ILogFactory>();
    mockLogFactory.Setup(f => f.CreateLog<MyClass>()).Returns(mockLog.Object);
    serviceCollection.AddSingleton<ILogFactory>(mockLogFactory.Object);

    var myClass = new MyClass();
    myClass.MyMethod(serviceCollection);

    mockLog.Verify(l => l.LogInformation("Hello, World!"), Times.Once);
}

“根据您在整个应用程序中无法控制的类型，会增加耦合并经常成为问题和技术债务的来源。” - 史蒂夫史密斯