Maris.Logging.Testing 1.0.0-Beta2

Maris.Logging.Testing

Microsoft.Extensions.Logging.ILogger または Microsoft.Extensions.Logging.ILogger<TCategoryName> の xUnit テストで利用可能なロガーを提供します。 このロガーを使用すると、テスト対象クラスで出力したログを、 Visual Studio のテストエクスプローラー上で確認できるようになります。 また Microsoft.Extensions.Logging.Testing.FakeLogger と連携して、テストコード内でログ出力内容を検証する機能を提供します。

インストール方法

パッケージマネージャーコンソールまたはコマンドプロンプトで以下のコマンドを実行してインストールしてください。

• パッケージマネージャーコンソール

Install-Package Maris.Logging.Testing

• コマンドプロンプト

dotnet add package Maris.Logging.Testing

使用方法

以下のような ILogger<TCategoryName> のオブジェクトを必要とするクラスに対して、 xUnit のテストコードを記述する場合を考えます。

using Microsoft.Extensions.Logging;

namespace Maris;

public class TestTarget
{
    private readonly ILogger<TestTarget> Logger;

    public TestTarget(ILogger<TestTarget> logger)
        => this.Logger = logger;
    
    // 省略
}

テストコードでテスト用のロガーを利用するためには、以下の手順で実装します。

1. xUnit v3 のプロジェクトテンプレートをインストール して、 dotnet new xunit3 コマンドで xUnit v3 テストプロジェクトを作成します。
2. xUnit のテストプロジェクトに Maris.Logging.Testing のパッケージをインストールします。
3. テストクラスのコンストラクターを定義し、 Xunit.ITestOutputHelper インターフェースのオブジェクトを引数に取ります。
4. コンストラクターで Maris.Logging.Testing.Xunit.TestLoggerManager のオブジェクトを生成し、フィールドに保存します。 TestLoggerManager のコンストラクターには ITestOutputHelper のオブジェクトを渡します。
5. テストメソッド内で TestLoggerManager の CreateLogger メソッドを呼び出して、テスト対象クラスに渡す ILogger または ILogger<TCategoryName> のオブジェクトを生成します。

using Maris.Logging.Testing.Xunit;
using Xunit;

namespace Maris.Tests;

public class TestClass1
{
    private readonly TestLoggerManager loggerManager;

    public TestClass1(ITestOutputHelper testOutputHelper)
        => this.loggerManager = new TestLoggerManager(testOutputHelper);

    [Fact]
    public void TestMethod()
    {
        // ILogger<T> のオブジェクトを生成可能。
        var logger = this.loggerManager.CreateLogger<TestTarget>();
        var target = new TestTarget(logger);

        // Do something...

        // TestLoggerManagerのLogCollectorプロパティはFakeLogger.Collectorを公開します
        Assert.Equal(1, this.loggerManager.LogCollector.Count);  
        Assert.Equal("expectedCategory", this.loggerManager.LogCollector.LatestRecord.Category);
        Assert.Equal("expectedMessage", this.loggerManager.LogCollector.LatestRecord.Message);
    }
}

Microsoft.Extensions.Hosting.IHost のテストを行う際は、 AddTestLogging メソッドを利用してテスト用のロガーを DI コンテナーに登録できます。 AddTestLogging メソッドは Microsoft.Extensions.DependencyInjection.TestLoggerServiceCollectionExtensions クラスに定義されています。 xUnit のテストコード例は以下のとおりです。

using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Maris.Logging.Testing.Xunit;
using Xunit;

namespace Maris.Tests;

public class TestClass2
{
    private readonly TestLoggerManager loggerManager;

    public TestClass2(ITestOutputHelper testOutputHelper)
        => this.loggerManager = new TestLoggerManager(testOutputHelper);

    [Fact]
    public async Task TestMethod()
    {
        using var app = this.CreateHost();
        var cancellationToken = TestContext.Current.CancellationToken;
        await app.RunAsync(cancellationToken);
        
        // Do something...
    }

    private IHost CreateHost()
    {
        var builder = Host.CreateDefaultBuilder();
        builder.ConfigureServices((context, services) =>
        {
            // テスト用の Logger を登録
            services.AddTestLogging(this.loggerManager);

            // Do something...            
        });

        return builder.Build();
    }
}

テストエクスプローラーではテスト実行中に出力されたログが以下のように表示されます。

詳細は ASP.NET Core での統合テスト を参照してください。

主な依存ライブラリ

• xunit.v3.extensibility.core

  xUnit v3 の拡張機能を開発するためのパッケージです。 このライブラリは xUnit v3 で開発されたテストプロジェクトでのみ利用できます。

• Microsoft.Extensions.Diagnostics.Testing

  ログ出力のテストを行うためのライブラリです。

ライセンス

Apache License Version 2.0