如何在 .net Core 中将日志从 TestServerFixture 重定向到 ITestOutputHelper？

Question

我目前在 VSTS 中的构建机器上的测试失败了，真的很难知道发生了什么。我有很多由 API 生成的日志，这些日志可能真的很有帮助。

我的目的是将我的 API 中生成的所有日志重定向到 OutputTestHelper。

使用 Xunit，我有一个 TestServerFixture：

 public class TestServerFixture : IDisposable
    {
        public TestServer Server { get; }
        public HttpClient Client { get; }
        public T GetService<T>() => (T)Server.Host.Services.GetService(typeof(T));

        public TestServerFixture()
        {
            var builder = new WebHostBuilder()
                .UseContentRoot(Directory.GetCurrentDirectory())
                .UseEnvironment("Development")
                .ConfigureAppConfiguration((hostingContext, config) =>
                {
                    config.AddJsonFile("appsettings.json", optional: true, reloadOnChange: true)
                          .AddJsonFile($"appsettings.{hostingContext.HostingEnvironment.EnvironmentName}.json", optional: true, reloadOnChange: true)
                          .AddEnvironmentVariables();
                })
                .UseStartup<TestStartup>()
                .ConfigureLogging((hostingContext, logging) =>
                {

                    logging.AddXunit(output); //How Can I get ITestOuputHelper?
                });

            Server = new TestServer(builder);
            Client = Server.CreateClient();
        }
        public void Dispose()
        {
            Server.Dispose();
            Client.Dispose();
        }
    }

阅读：

• https://github.com/aspnet/Logging/blob/d9b34d1c36fde204bd736d09b89b86451bd82e95/src/Microsoft.Extensions.Logging.Testing/XunitLoggerFactoryExtensions.cs

• .net core 2.0 ConfigureLogging xunit test

我有一个扩展程序允许我将 Xunit ITestOutputHelper 添加到需要 ITestOutputHelper 作为参数的记录器 (AddXunit())。

问题是，我找不到在 TestServerFixture 中获取它的方法。我试过了：

• 也许在 TestServerFixture 的构造函数中有一些可用的 Injection 可以实例化 ITestOutputHelper ？ public TestServerFixture(ITestOutputHelper output) => 失败

• 也许有办法从 IloggingBuilder.Services 中解决 ITestOutputHelper（如 loggingBuilder.Services.Resolve<ITestOutputHelper>()）=> FAILED

• 也许我可以从 TestStartup 中的 Configure 方法获得它（如 public void Configure(IApplicationBuilder app, ILoggerFactory loggerFactory, ITestOutputHelper output)）=> FAILED

您知道配置 TestServerFixture 以将所有日志重定向到 OutpuTestHelper 的方法吗？

Answer 1

如果您的 DI（包括 ILoggerFactory）已经在您的夹具上配置了一个写入 xUnit 输出的记录器提供程序实现，那么您应该能够从夹具上的服务提供商请求 ILogger<whatever>（使用您在其中向我们展示的GetService<T> 方法）。

Microsoft 的记录器 DI 集成注册服务 ILogger<> 以提供来自 LoggerFactory 的记录器（您需要为此注册提供程序，这就是您在 AddXunit 调用上使用 AddXunit 扩展所做的事情）

Answer 2

我终于找到了解决办法。由于无法从 Injection 访问 ITestOutpuHelper，因此我没有其他方法可以为每个 Test 类创建一个新的 TestServerFixture。

我之前的：

public class Users_Tests
{
    [...]
    public Users_Tests(
        TestServerFixture server
        ITestOutputHelper output
    )
    {
        [...]
    }
}

我现在拥有的：

public class Users_Tests
{
    [...]
    public Users_Tests(
        ITestOutputHelper output
    )
    {
        TestServerFixture = new TestServerFixture(output);    
        [...]
    }
}

所以我的 TestServiceFixture 现在是：

public class TestServerFixture : IDisposable
{
    public TestServer Server { get; }
    public HttpClient Client { get; }
    public T GetService<T>() => (T)Server.Host.Services.GetService(typeof(T));

    public TestServerFixture(ITestOutputHelper output)
    {
        var builder = new WebHostBuilder()
            .UseContentRoot(Directory.GetCurrentDirectory())
            .UseEnvironment("Development")
            .ConfigureAppConfiguration((hostingContext, config) =>
            {
                config.AddJsonFile("appsettings.json", optional: true, reloadOnChange: true)
                      .AddJsonFile($"appsettings.{hostingContext.HostingEnvironment.EnvironmentName}.json", optional: true, reloadOnChange: true)
                      .AddEnvironmentVariables();
            })
            .UseStartup<TestStartup>()
            .ConfigureLogging((hostingContext, logging) =>
            {
                logging.AddXunit(output);
            });

        Server = new TestServer(builder);
        Client = Server.CreateClient();
    }
    public void Dispose()
    {
        Server.Dispose();
        Client.Dispose();
    }
}

所以现在所有日志都被重定向到输出，这有助于我了解错误来自哪里！

Answer 3

如果您没有通过ITestOutputHelper 获取日志的严格要求，您可以尝试在xUnit 中使用IMessageSink 抽象，用于在TestFixtures 中进行日志记录。

public class SutTests : IClassFixture<TestServerFixture>
{
    private readonly ITestOutputHelper _output; // for logging inside test classes
    private readonly TestServerFixture  _fixture;

    public SutTests(TestServerFixture fixture, ITestOutputHelper output) {
        _fixture = fixture
        _output = output;
    }
    ...
}

public class TestServerFixture : IAsyncLifetime
{
    private readonly IMessageSink _sink; // for logging inside TestFixtures
    public TestServerFixture(IMessageSink sink) {
        _sink = sink;
        _sink.OnMessage(new DiagnosticMessage("Test Server Fixture Created."));
    }

    public async Task InitializeAsync() {
        // initialize stuffs..
        _sink.OnMessage(new DiagnosticMessage("Fixture initialized."));
    }
    ...
}

注意事项：

• 您需要在 Xunit 配置文件中enable Diagnostic Messages。
• 您需要 XUnit 版本 2.4.1 或更高版本。