Csharp 如何使用 NSubstitute 对 struct 化日志(log)记录调用进行单元测试

有一件事你可以做，这是我自己在几个场合中用过的.

首先，创建我们将称为"可测试的"记录器抽象:

public abstract class TestableLogger<T> : ILogger<T>
{
    public abstract IDisposable? BeginScope<TState>(TState state)
        where TState : notnull;

    public abstract bool IsEnabled(LogLevel logLevel);

    public void Log<TState>(
        LogLevel logLevel,
        EventId eventId,
        TState state,
        Exception? exception,
        Func<TState, Exception?, string> formatter)
    {
        this.Log(logLevel, eventId, state?.ToString(), exception);
    }

    public abstract void Log(
        LogLevel logLevel,
        EventId eventId,
        string? state,
        Exception? exception);
}

这个包装器的目的是尽可能忠实地实现ILogger<T>，同时允许您对原始Log<TState>方法的细微变化做出断言:我们通过绕过内部Formatter/TState类来"简化"实现，只需在TState参数上调用ToString.

我们并不真正关心BeginScope和IsEnabled个原始成员，所以我们只是通过抽象地实现它们来"忽略它们".

然后，您现在可以替换这个新的抽象类，而不是原来的ILogger<T>，并对其进行断言，如下所示:

[TestClass]
public class UnitTest1
{
    [TestMethod]
    public void TestMethod1()
    {
        // Arrange
        var user = new User { UserId = 1 };
        var exception = new NullReferenceException();
        var logger = Substitute.For<TestableLogger<Service>>();
        var verifier = Substitute.For<IUserVerifier>();
        verifier
            .When(v => v.Verify(user))
            .Throw(exception);

        var service = new Service(logger, verifier);

        // Act
        service.DoStuff(user);

        // Assert
        logger.Received(1).Log(
            LogLevel.Error,
            Arg.Any<EventId>(),
            "Encountered NullReferenceException. Unable to verify user with id 1",
            exception);
    }
}

我已经对您的场景的其余部分做了一些假设，但这似乎是合理的.请注意，我在那里使用的是您的原始消息.

以下是我为支持此示例而创建的其余代码:

public interface IUserVerifier
{
    void Verify(User user);
}

public class User
{
    public int UserId { get; set; }
}

public class Service
{
    private readonly ILogger<Service> logger;
    private readonly IUserVerifier userVerifier;

    public Service(ILogger<Service> logger, IUserVerifier userVerifier)
    {
        this.logger = logger;
        this.userVerifier = userVerifier;
    }

    public void DoStuff(User user)
    {
        try
        {
            this.userVerifier.Verify(user);
        }
        catch (Exception ex)
        {
            this.logger.LogError(
                ex, 
                "Encountered {exceptionType}. Unable to verify user with id {userId}",
                ex.GetType().Name,
                user.UserId);
        }
    }
}

这里唯一的警告是，您不能单独断言作为 struct 化日志(log)记录参数传递的各个值，但它仍然是一个在某种程度上有效的断言.

这种方法的一个有趣方面是，您实际上可以根据自己的喜好定制新的抽象方法.我只删除了容易出问题的部分，但您可以完全更改该方法的形状，并仍然能够在其上断言，只要您执行与原始Log方法相同的调用重定向.

我目前还不知道有什么不同的方法可以让您专门测试每个参数.