c# - Xml 解析器类的单元测试

Question

我有一个类使用 C# 中的 XmlReader 和 XmlReaderSettings 类根据架构验证 Xml 文件。由于我的应用程序涉及从数据库中读取 Xml 数据，因此我决定在 MessageBox 中向用户显示错误。因此，任何验证错误以及抛出的任何异常都将显示为出现在 MessageBox 中的字符串“解析时发生错误”。

我还有一个返回解析是否成功的 bool 变量。

现在，我在 Assert 中使用 Parse 函数返回的 bool 值，同时让 parse 函数解析有效和无效的 Xml 文件。

因此，在运行测试用例套件时，我将这些消息框堆叠在另一个窗口中。

我遇到的真正问题是，当 Visual Studio 中的单元测试框架告诉我们是否所有测试都通过时，弹出许多这样的消息框是可以的。

或者是我只需要返回一个 bool 值然后 GUI 类显示适当的错误消息的情况。

Q2。另外，如果我确实需要检查特定字符串是否被正确解析并存储到数组中，我是否可以子类化主类以添加一些功能来帮助我更好地编写单元测试？

我非常感谢关于我的设计和单元测试应该如何进行的一些建议。

另外，我确实承认我在写下我需要测试的类之后在编写单元测试时犯了一个大错误，我知道应该反过来。

Answer 1

Xml 的解析和错误消息的显示是不同的问题，因此您的解析器不应该知道错误消息是如何显示的。

根据您的需要，有几个选项:

异常(exception)情况

我经常遵守规则:“如果一个方法不能完成它的工作，抛出一个异常”。如果您需要在出现第一个错误时停止，异常就是解决之道。

从单元测试的角度来看，如果您传入非法数据，请使用 [ExpectedException] 属性验证代码是否抛出异常。

[TestMethod, ExpectedException(typeof(ParserValidationException))]
public void IllegalDataShouldThrowValidationErrors()
{
    var parser = new MyParser();
    parser.Parse( dataThatContainsErrors );
}

但是，如果您需要忽略非法数据并报告错误，您可能需要一种不同的方法。

专用返回类型

如果需要收集所有错误，最好将解析结果和错误一起作为一个对象保存。

public class ParsedResult<T>
{
    public T Result;
    public List<string> Warnings;
}

从单元测试的角度来看，如果您传入非法数据，您应该验证警告列表不为空。

[TestMethod]
public void ParsedResultsForIllegalDataShouldContainWarnings()
{
    var parsedResult = new MyParser.Parse<Foo>( dataThatContainsErrors );

    Assert.IsNotNull(parsedResult);
    Assert.IsNotNull(parsedResult.Result);
    Assert.AreEqual(1, parsedResult.Warnings.Count);
}

错误报告者

将协作者传入对象并让它报告它的发现。

public ObjectToReturn Parse(string xml, IProgressReporter progress)
{
     // create xml reader
     // read values from xml
     // if a value is invalid, log it
     progress.AddMessage( "property x was invalid. ")
}

进度报告器可以是 MessageBox 的包装器，也可以是控制台输出、记录器等。从单元测试的角度来看，您可以创建一个捕获消息的测试替身，也可以使用模拟框架并验证它被调用了一定次数。这是一个使用 Moq 的示例。

var mockReporter = new Mock<IProgressReporter>();
IProgressReporter reporter = mockReporter.Object;

var parser = new MyParser();
var illegalData = // your illegal data;

var result = parser.Parse( illegalData, parser);

Assert.IsNotNull(result, "The value was not parsed correctly.");
mockReporter.Verify( r => r.AddMessage( It.IsAny<string>() ), Times.AtLeast(1));