如何比较 JUnit 测试用例中的文件？

Question

我想在我正在从事的一个小项目上实现 JUnit，因为我想了解一些关于它的知识。

我读过的教程都引用了具有特定输出的方法。

就我而言，我的输出是文件，我该怎么做？有什么简单的例子吗？ 有什么方法可以帮助我解决这个问题吗？

这些文件是通过 void 私有方法构建的原始文本文件。

Answer 1

您希望为给定的一组输入获取正确的输出文件，并设置一个测试以使用这些输入调用 void 方法，然后将经过验证的输出文件与方法生成的文件进行比较。您需要确保有某种方法来指定方法的输出位置，否则您的测试将非常脆弱。

@Rule
public TemporaryFolder folder = new TemporaryFolder();

@Test
public void testXYZ() {
    final File expected = new File("xyz.txt");
    final File output = folder.newFile("xyz.txt");
    TestClass.xyz(output);
    Assert.assertEquals(FileUtils.readLines(expected), FileUtils.readLines(output));
}

为了方便起见，使用 commons-io FileUtils文本文件比较& JUnit 的 TemporaryFolder 确保输出文件在测试运行之前不存在。

Answer 2

使用 junitx.framework.FileAssert 类junit-addons 项目。其他链接：

• API
• pom （可通过 http://search.maven.org）。

其中一种方法：

assertEquals(java.lang.String message,
             java.io.Reader expected,
             java.io.Reader actual) 

Answer 3

在您的方法写入文件后，在单元测试中您可以读取该文件并验证其是否写入正确。

另一件有意义的事情是将您的方法分成一个检索该数据并将其返回到仅将其写入文件的方法。然后就可以验证第一个方法返回的数据是否没问题。

另一种可行的方法是将 OutputStream 传递给写入数据的方法。在“真实代码”中，您可以传递 FileOutputStream / FileWriter，而在测试代码中，您可以编写 OutputStream 的模拟实现，并且检查正在写入的内容。

Answer 4

尽管您的问题可能看起来很简单，但它确实触及了单元测试的核心，但需要编写格式良好且可测试的代码。这就是为什么一些专家建议应该先编写单元测试，然后再编写实现类。

在您的情况下，我建议您允许您的方法执行并创建预期的文件，然后您的单元测试可以分析文件是否正确形成。

Answer 5

如果您无法控制该方法将输出放入流中，那么我会说您需要重构代码，以便该方法在参数中（或其类的构造函数中）接收流。

之后，测试非常简单 - 您只需检查流即可。易于测试的代码通常等于好的代码。