在单元测试中验证 XML 的最佳方法是什么？

Question

我有一个带有生成 XML 的 ToString 方法的类。 我想对其进行单元测试以确保它生成有效的 xml。 我有一个 DTD 来验证 XML。

我应该将 DTD 作为字符串包含在单元测试中以避免对其的依赖，还是有更聪明的方法来做到这一点？

Answer 1

如果您的程序在正常执行期间根据 DTD 验证 XML，那么您应该从程序将获取 DTD 的任何地方获取它。

如果不是，并且 DTD 非常短（只有几行），那么将其作为字符串存储在代码中可能就可以了。

否则，我会将其放入外部文件中，并让您的单元测试从该文件中读取它。

Answer 2

在单元测试中使用 DTD 来测试其有效性是一回事，测试内容的正确性又是另一回事。

您可以使用 DTD 来检查生成的 xml 的有效性，我将按照您在程序中的方式简单地读取它。 我个人不会将其包含在内联（作为字符串）； 应用程序代码和单元测试之间始终存在依赖关系。 当生成的xml发生变化时，DTD也会发生变化。

为了测试正确的内容，我会选择 XMLUnit。

使用 XMLUnit 断言 xml：

XMLUnit.setIgnoreWhitespace(true);
XMLUnit.setIgnoreDiffBetweenTextAndCDATA(true);

Diff diff = new Diff(expectedDocument, obtainedDocument);
XMLAssert.assertXMLIdentical("xml invalid", diff, true);

您可能会遇到的一件事是生成的 xml 可能包含更改的标识符（id/uid 属性或类似属性）。 这可以通过使用 DifferenceListener 来解决断言生成的 xml。

这种 DifferenceListener 的示例实现：

public class IgnoreVariableAttributesDifferenceListener implements DifferenceListener {

    private final List<String> IGNORE_ATTRS;
    private final boolean ignoreAttributeOrder;

    public IgnoreVariableAttributesDifferenceListener(List<String> attributesToIgnore, boolean ignoreAttributeOrder) {
        this.IGNORE_ATTRS = attributesToIgnore;
        this.ignoreAttributeOrder = ignoreAttributeOrder;
    }

    @Override
    public int differenceFound(Difference difference) {
        // for attribute value differences, check for ignored attributes
        if (difference.getId() == DifferenceConstants.ATTR_VALUE_ID) {
            if (IGNORE_ATTRS.contains(difference.getControlNodeDetail().getNode().getNodeName())) {
                return RETURN_IGNORE_DIFFERENCE_NODES_IDENTICAL;
            }
        }
        // attribute order mismatch (optionally ignored)
        else if (difference.getId() == DifferenceConstants.ATTR_SEQUENCE_ID && ignoreAttributeOrder) {
            return RETURN_IGNORE_DIFFERENCE_NODES_IDENTICAL;
        }
        // attribute missing / not expected
        else if (difference.getId() == DifferenceConstants.ATTR_NAME_NOT_FOUND_ID) {
            if (IGNORE_ATTRS.contains(difference.getTestNodeDetail().getValue())) {
                return RETURN_IGNORE_DIFFERENCE_NODES_IDENTICAL;
            }
        }

        return RETURN_ACCEPT_DIFFERENCE;
    }

    @Override
    public void skippedComparison(Node control, Node test) {
        // nothing to do
    }
}

使用 DifferenceListener：

    XMLUnit.setIgnoreWhitespace(true);
    XMLUnit.setIgnoreDiffBetweenTextAndCDATA(true);

    Diff diff = new Diff(expectedDocument, obtainedDocument);
    diff.overrideDifferenceListener(new IgnoreVariableAttributesDifferenceListener(Arrays.asList("id", "uid"), true));

    XMLAssert.assertXMLIdentical("xml invalid", diff, true);

Answer 3

我过去使用过 XmlUnit 并发现它很有用。

它可用于根据架构验证 XML 或将 XML 与字符串进行比较。 它足够聪明，能够理解XML的解析规则。
例如，它知道“” 相当于“” 并且可以配置为忽略或包含空格。