如何在C#AspNet Core中模拟LoggerFactory

前端之家收集整理的这篇文章主要介绍了如何在C#AspNet Core中模拟LoggerFactory前端之家小编觉得挺不错的,现在分享给大家,也给大家做个参考。
我正在尝试为控制器操作编写一些单元测试.为此,我使用XUnit和Moq.控制器在构造函数中注入ILoggerFactory.一个Moq如何进行测试?

我已经尝试为控制器类模拟一个Logger,然后模拟CreateLogger以返回模拟Logger,但是当调用LogInformation()函数时,我不断获得各种测试运行时NullReferenceExceptions.

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

我假设问题是正在调用LogInformation,这是一个扩展方法,那么如何moq呢?

解决方法

对于需要回答这个问题的人,而不是一个解决方法,我扩展了本文的工作:

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

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

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

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

  1. public class Log<T> : ILog<T>
  2. {
  3. private readonly ILogger<T> logger;
  4.  
  5. public Log(ILogger<T> logger)
  6. {
  7. this.logger = logger;
  8. }
  9.  
  10. public void LogError(Exception ex,params object[] args) => this.logger.LogError(ex,message,args);
  11. public void LogInformation(string message,params object[] args) => this.logger.LogInformation(message,args);
  12. }

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

  1. public interface ILogFactory
  2. {
  3. ILog<T> CreateLog<T>();
  4. }

并实施:

  1. public class LogFactory : ILogFactory
  2. {
  3. private readonly ILoggerFactory loggerFactory;
  4.  
  5. public LogFactory()
  6. {
  7. this.loggerFactory = new LoggerFactory();
  8. }
  9.  
  10. public ILog<T> CreateLog<T>() => new Log<T>(new Logger<T>(this.loggerFactory));
  11. }

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

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

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

  1. public class MyClass
  2. {
  3. public void MyMethod(IServiceCollection serviceCollection)
  4. {
  5. var serviceProvider = serviceCollection.BuildServiceProvider();
  6. var logFactory = this.serviceProvider.GetrequiredService<ILogFactory>();
  7. var log = logFactory.CreateLog<ServiceApplication>();
  8. log.LogInformation("Hello,World!");
  9. }
  10. }

您可以想象将MyMethod的参数从IServiceCollection更改为ILogFactory或ILog< MyClass>按要求.并且 – 重点是 – 您现在可以使用以下方法模拟上述代码

  1. [Fact]
  2. public void Test()
  3. {
  4. IServiceCollection serviceCollection = new ServiceCollection();
  5. var mockLog = new Mock<ILog<MyClass>>();
  6. var mockLogFactory = new Mock<ILogFactory>();
  7. mockLogFactory.Setup(f => f.CreateLog<MyClass>()).Returns(mockLog.Object);
  8. serviceCollection.AddSingleton<ILogFactory>(mockLogFactory.Object);
  9.  
  10. var myClass = new MyClass();
  11. myClass.MyMethod(serviceCollection);
  12.  
  13. mockLog.Verify(l => l.LogInformation("Hello,World!"),Times.Once);
  14. }

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

猜你在找的.NET Core相关文章