从单元测试中获取发送到 Console.Out 的输出？

Question

我正在使用 NUnit 在 C# 中构建单元测试，我想测试主程序是否实际根据命令行参数输出正确的输出。

有没有一种方法可以从调用

Program.Main(...)

的 NUnit 测试方法中获取写入

Console.Out

和

Console.Error

的所有内容，以便我可以对其进行验证？

Answer 1

您可以将

Console.In

、

Console.Out

和

Console.Error

重定向到自定义 StringWriter，如下所示

[TestMethod]
public void ValidateConsoleOutput()
{
    using (StringWriter sw = new StringWriter())
    {
        Console.SetOut(sw);

        ConsoleUser cu = new ConsoleUser();
        cu.DoWork();

        string expected = string.Format("Ploeh{0}", Environment.NewLine);
        Assert.AreEqual<string>(expected, sw.ToString());
    }
}

请参阅此博文了解完整详细信息。

Answer 2

您可以使用这个简单的类通过 using 语句获取输出：

public class ConsoleOutput : IDisposable
{
    private StringWriter stringWriter;
    private TextWriter originalOutput;

    public ConsoleOutput()
    {
        stringWriter = new StringWriter();
        originalOutput = Console.Out;
        Console.SetOut(stringWriter);
    }

    public string GetOuput()
    {
        return stringWriter.ToString();
    }

    public void Dispose()
    {
        Console.SetOut(originalOutput);
        stringWriter.Dispose();
    }
}

以下是如何使用它的示例：

using (var consoleOutput = new ConsoleOutput())
{
    target.WriteToConsole(text);

    Assert.AreEqual(text, consoleOutput.GetOuput());
}

您可以在我的博客文章中找到更多详细信息和工作代码示例 - 在单元测试中获取控制台输出。

Answer 3

您仍然需要集成测试，而不是单元，正如其他人正确建议的那样。

集成测试

ProgramTest.cs

using NUnit.Framework;

class ConsoleTests
{
    [Test]
    public void TestsStdOut()
    {
        var capturedStdOut = CapturedStdOut(() =>
        {
            RunApp();
        });

        Assert.AreEqual("Welcome, John!", capturedStdOut);
    }

    void RunApp(string[]? arguments = default)
    {
        var entryPoint = typeof(Program).Assembly.EntryPoint!;
        entryPoint.Invoke(null, new object[] { arguments ?? Array.Empty<string>() });
    }

    string CapturedStdOut(Action callback)
    {
        TextWriter originalStdOut = Console.Out;

        using var newStdOut = new StringWriter();
        Console.SetOut(newStdOut);

        callback.Invoke();
        var capturedOutput = newStdOut.ToString();

        Console.SetOut(originalStdOut);

        return capturedOutput;
    }
}

---

实施

程序.cs

Console.Write($"Welcome, John!");