‫دیگر ILogger را Mock نکنید: تست لاگینگ در دات‌نت با FakeLogger

• Package:Microsoft.Extensions.Diagnostics.Testing
• Namespace:Microsoft.Extensions.Logging.Testing

public class DemoService(ILogger<DemoService> logger)
{
    public void LogMe()
    {
        logger.LogInformation("This should be logged.");
    }
}

// Arrange
var fakeLogger = new FakeLogger<DemoService>();
var sut = new DemoService(fakeLogger);

// Act
sut.LogMe();

// Assert
fakeLogger.LatestRecord.Message.Should().Be("This should be logged.");

// Assert (ادامه تست قبلی)
fakeLogger.LatestRecord.Message.Should().Be("This should be logged.");
fakeLogger.LatestRecord.LogLevel.Should().Be(LogLevel.Information);

public partial class DemoService(ILogger<DemoService> logger)
{
    public void LogMe(Guid id)
    {
        // ایجاد یک اسکوپ با اطلاعات زمینه‌ای
        using var _ = logger.BeginScope(new Dictionary<string, object> { { "id", id } });

        logger.LogInformation("This should be logged.");
    }
}

public class DemoServiceTests
{
    [Fact]
    public void ScopeUsage()
    {
        // Arrange
        var fakeLogger = new FakeLogger<DemoService>();
        var sut = new DemoService(fakeLogger);
        var id = Guid.NewGuid();

        // Act
        sut.LogMe(id);

        // Assert
        // 1. بررسی پیام لاگ
        fakeLogger.LatestRecord.Message.Should().Be("This should be logged.");

        // 2. بررسی اسکوپ
        // Scopes مجموعه‌ای از اسکوپ‌های فعال در زمان لاگ است
        var scope = fakeLogger.LatestRecord.Scopes[0] as Dictionary<string, object>;
        
        scope.Should().NotBeNull();
        scope.Keys.Should().Contain("id");
        scope.Values.Should().Contain(id);
    }
}

• ما SUT را با استفاده از FakeLogger می‌سازیم (بدون نیاز به ماک یا Setup).
• متد LogMe فراخوانی می‌شود و یک رکورد لاگ تولید می‌کند.
• ما محتوای پیام را Assert می‌کنیم و سپس کالکشن Scopes ثبت شده را بازرسی می‌کنیم.
• هر Scope به عنوان یک object ضبط می‌شود، و در این مورد، ما می‌دانیم که آن یک Dictionary است که حاوی id ماست.

• چگونه FakeLogger جایگزین ماک کردن ILogger می‌شود.
• نحوه‌ی راه‌اندازی و استفاده‌ی پایه از آن برای بررسی پیام و سطح لاگ.
• چگونه Scopeهای لاگ، متادیتای زمینه‌ای مفیدی را ارائه می‌دهند.
• چگونه FakeLogger می‌تواند آن Scopeها را برای تست، ضبط و افشا کند.