‫اجتناب از الگوهای نادرست در تست واحد با استفاده از ILogger در توسعه .NET

public class OrderPlacedEventHandler : IDomainEventHandler<OrderPlacedEvent>
{
    private readonly ILogger<OrderPlacedEventHandler> _logger;
    public OrderPlacedEventHandler(ILogger<OrderPlacedEventHandler> logger)
    {
        _logger = logger;
    }
    public Task Handle(OrderPlacedEvent domainEvent, CancellationToken cancellationToken)
    {
        _logger.LogInformation("Order placed: {OrderId} at {OccurredOn}", domainEvent.OrderId, domainEvent.OccurredOn);
        return Task.CompletedTask;
    }
}

[Fact]
public async Task Handle_ShouldLogInformation()
{
    var logger = new Mock<ILogger<OrderPlacedEventHandler>>();
    var handler = new OrderPlacedEventHandler(logger.Object);
    var domainEvent = new OrderPlacedEvent(Guid.NewGuid());
    
    await handler.Handle(domainEvent, CancellationToken.None);
    
    logger.Verify(
        x => x.Log(
            LogLevel.Information,
            It.IsAny<EventId>(),
            It.IsAny<It.IsAnyType>(),
            It.IsAny<Exception>(),
            It.IsAny<Func<It.IsAnyType, Exception?, string>>()),
        Times.Once);
}

1. پیچیدگی بالا: تنظیم و تأیید موک برای ILogger به‌دلیل ساختار پیچیده متد Log (که تمام متدهای سطح بالا به آن ارجاع می‌دهند) دشوار است.
2. ** شکنندگی (Fragility)**: اگر قالب پیام یا سطح لاگ تغییر کند، تست شکست می‌خورد، حتی اگر منطق اصلی بدون تغییر باقی بماند.
3. تمرکز نادرست: تست واحد باید رفتار اصلی کد (مانند پردازش رویداد) را بررسی کند، نه جزئیات پیاده‌سازی لاگینگ.

[Fact]
public async Task Handle_ShouldCompleteSuccessfully()
{
    var logger = NullLogger<OrderPlacedEventHandler>.Instance;
    var handler = new OrderPlacedEventHandler(logger);
    var domainEvent = new OrderPlacedEvent(Guid.NewGuid());
    
    var result = await handler.Handle(domainEvent, CancellationToken.None);
    
    Assert.Equal(Task.CompletedTask, result);
}

• سادگی: نیاز به تنظیمات پیچیده را حذف می‌کند.
• پایداری: تست را در برابر تغییرات در لاگینگ مقاوم می‌کند.
• تمرکز: هدف اصلی تست واحد را حفظ می‌کند.

ILoggerFactory factory = LoggerFactory.Create(builder => builder.AddConsole());
ILogger<OrderPlacedEventHandler> logger = factory.CreateLogger<OrderPlacedEventHandler>();

1. جداسازی وابستگی‌ها: ILogger را از طریق تزریق وابستگی (Dependency Injection) وارد کنید تا بتوانید به‌راحتی آن را با یک پیاده‌سازی جعلی جایگزین کنید.
2. حداقل کردن تست لاگینگ: فقط در صورتی لاگینگ را تست کنید که بخشی از منطق اصلی باشد، نه یک ابزار جانبی.
3. استفاده از ابزارهای مناسب: از NullLogger یا FakeLogger (در بسته Microsoft.Extensions.Diagnostics.Testing) برای تست‌های ساده‌تر استفاده کنید.