xUnit.net不捕获控制台输出

Question

我刚刚开始测试xUnit.net,但它似乎没有像我期望的那样捕获任何输出(控制台,调试,跟踪).

那可能吗？我正在使用带有xUnit.net 1.8的示例.NET 4.0类库.

Answer 1

xUnit.net 2的情况发生了一些变化.我知道问题是关于早期版本的问题,但是由于人们将在这里进行升级,我认为值得指出这一点.

为了在版本2中的测试输出中看到某种输出,您需要在实例上的测试类(通过构造函数参数)中获取依赖关系Xunit.Abstractions.ITestOutputHelper,然后WriteLine在此接口上使用该方法.例如:

public class MyTestSpec
{
  private readonly ITestOutputHelper _testOutputHelper;

  public MyTestSpec(ITestOutputHelper testOutputHelper)
  {
    _testOutputHelper = testOutputHelper;
  }

  [Fact]
  public void MyFact()
  {
    _testOutputHelper.WriteLine("Hello world");
  }
}

您可以选择将日志记录框架连接到此接口,可能是通过注入ILog转发所有调用的实现ITestOutpuHelper.

我承认您默认情况下不会这样做,但为了诊断目的,它可能会非常有用.如果您的测试仅在某些基于云的构建和测试服务器上失败,则尤其如此!

Answer 2

如果您Console.Write深入嵌入了一些您不想重构的类层次结构,这可能会有所帮助:

    public MyTestClass(ITestOutputHelper output)
    {
        var converter = new Converter(output);
        Console.SetOut(converter);
    }

    private class Converter : TextWriter
    {
        ITestOutputHelper _output;
        public Converter(ITestOutputHelper output)
        {
            _output = output;
        }
        public override Encoding Encoding
        {
            get { return Encoding.Whatever; }
        }
        public override void WriteLine(string message)
        {
            _output.WriteLine(message);
        }
        public override void WriteLine(string format, params object[] args)
        {
            _output.WriteLine(format, args);
        }
    }

Answer 3

我使用 Console.SetOut 将 Console.Writes 输出到 .NET 测试日志（在 Visual Studio Code 中）。

using System;
using System.IO;
using Xunit;
using Xunit.Abstractions;

namespace UnitTest
{
    public class TestClass
    {
        private ITestOutputHelper output;
        public TestClass(ITestOutputHelper output)
        {
            this.output = output;
        }

        public class ConsoleWriter : StringWriter
        {
            private ITestOutputHelper output;
            public ConsoleWriter(ITestOutputHelper output)
            {
                this.output = output;
            }

            public override void WriteLine(string m)
            {
                output.WriteLine(m);
            }
        }

        [Fact]
        public void TestName()
        {
            Console.SetOut(new ConsoleWriter(output));
            Assert.True(ToBeTested.Foo());
        }



        public class ToBeTested
        {
            public static bool Foo()
            {
                Console.WriteLine("Foo uses Console.WriteLine!!!");
                return true;
            }
        }

    }

}

但通过控制台运行测试更容易

dotnet test 

输出将在没有对测试类进行任何修改的情况下显示。

这是不同的，因为 .NET 测试日志窗口使用 TRX 格式（Visual Studio 测试结果文件），请参阅

dotnet test -h | grep logger

有关 TRX 的更多信息。

Answer 4

一般来说，依赖日志记录和测试是一条糟糕的道路。通过/失败应该是测试的结果。他们根本不应该达到这样的阶段：有足够多的事情正在发生，以至于有必要查看痕迹。

显示xunit.gui.exe控制台和跟踪输出，xunit.console.exe但不显示。如果它很重要，您可以连接一个 TraceListener，它通过创建适当的标准 .NET 配置条目来重定向到文件（FileWriterTraceListener如果您用 google 搜索，您应该能够连接到该文件）。

更新：正如在他的博客文章中所讨论的，Damian Hickey 有一个可能的替代品的很好的例子 - 将日志记录连接到 xUnit 2，ITestOutputHelper如https://github.com/damianh/CapturingLogOutputWithXunit2AndParallelTests/blob/master/src/Lib.Tests中所示/测试.cs

更新 2：在某些情况下，可以添加日志记录并将其提供给ITestOutputHelper无需LogContext使用简单适配器的情况，如下所示（我只在 F# 中使用，抱歉）：

// Requirement: Make SUT depend on Serilog NuGet
// Requirement: Make Tests depend on Serilog.Sinks.Observable

type TestOutputAdapter(testOutput : Xunit.Abstractions.ITestOutputHelper) =
    let formatter = Serilog.Formatting.Display.MessageTemplateTextFormatter(
        "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level}] {Message}{NewLine}{Exception}", null);
    let write logEvent =
        use writer = new System.IO.StringWriter()
        formatter.Format(logEvent, writer);
        writer |> string |> testOutput.WriteLine
    member __.Subscribe(source: IObservable<Serilog.Events.LogEvent>) =
        source.Subscribe write

let createLogger hookObservers =
    LoggerConfiguration()
        .WriteTo.Observers(Action<_> hookObservers)
        .CreateLogger()
let createTestOutputLogger (output: ITestOutputHelper) =
    let adapter = TestOutputAdapter testOutputHelper
    createLogger (adapter.Subscribe >> ignore)

type Tests(testOutputHelper) =
    let log = createTestOutputLogger testOutputHelper

    [<Fact>] let feedToSut () =
        // TODO pass log to System Under Test either as a ctor arg or a method arg

此方法与使用日志上下文的区别在于，Logger不会记录到全局[上下文化] Serilog。