将文本文件与 Junit 进行比较

Question

我正在使用 junit 比较文本文件：

public static void assertReaders(BufferedReader expected,
          BufferedReader actual) throws IOException {
    String line;
    while ((line = expected.readLine()) != null) {
        assertEquals(line, actual.readLine());
    }

    assertNull("Actual had more lines then the expected.", actual.readLine());
    assertNull("Expected had more lines then the actual.", expected.readLine());
}

这是比较文本文件的好方法吗？ 什么是首选？

Answer 1

这是检查文件是否完全相同的一种简单方法：

assertEquals("The files differ!", 
    FileUtils.readFileToString(file1, "utf-8"), 
    FileUtils.readFileToString(file2, "utf-8"));

其中 file1 和 file2 是 File 实例，和 FileUtils 来自 Apache Commons IO。

没有太多自己的代码需要维护，这始终是一个优点。 :) 如果您已经在项目中使用了 Apache Commons，那么非常简单。 但没有像 mark 的解决方案中那样的详细错误消息。

编辑：
呵呵，仔细观察 FileUtils API，甚至还有一个 更简单的方法：

assertTrue("The files differ!", FileUtils.contentEquals(file1, file2));

作为奖励，此版本适用于所有文件，而不仅仅是文本。

Answer 2

junit-addons 对此有很好的支持：FileAssert

它为您提供了如下例外：

junitx.framework.ComparisonFailure: aa Line [3] expected: [b] but was:[a]

Answer 3

以下是各种第三方 Java 库中文件比较器的更详尽列表：

• org.apache.commons.io.FileUtils
• org.dbunit.util.FileAsserts
• org.fest.assertions.FileAssert
• junitx.framework.FileAssert
• org.springframework.batch.test.AssertFile
• org.netbeans.junit.NbTestCase
• org.assertj.core.api.FileAssert

Answer 4

截至 2015 年，我会推荐 AssertJ，一个优雅而全面的断言库。 对于文件，您可以针对另一个文件进行断言：

@Test
public void file() {
    File actualFile = new File("actual.txt");
    File expectedFile = new File("expected.txt");
    assertThat(actualFile).hasSameTextualContentAs(expectedFile);
}

或针对内联字符串进行断言：

@Test
public void inline() {
    File actualFile = new File("actual.txt");
    assertThat(linesOf(actualFile)).containsExactly(
            "foo 1",
            "foo 2",
            "foo 3"
    );
}

失败消息也非常有用。 如果一行不同，您将得到：

java.lang.AssertionError: 
File:
  <actual.txt>
and file:
  <expected.txt>
do not have equal content:
line:<2>, 
Expected :foo 2
Actual   :foo 20

如果其中一个文件有多行，您将得到：

java.lang.AssertionError:
File:
  <actual.txt>
and file:
  <expected.txt>
do not have equal content:
line:<4>,
Expected :EOF
Actual   :foo 4

Answer 5

使用 java.nio.file API 简单比较两个文件的内容。

byte[] file1Bytes = Files.readAllBytes(Paths.get("Path to File 1"));
byte[] file2Bytes = Files.readAllBytes(Paths.get("Path to File 2"));

String file1 = new String(file1Bytes, StandardCharsets.UTF_8);
String file2 = new String(file2Bytes, StandardCharsets.UTF_8);

assertEquals("The content in the strings should match", file1, file2);

或者，如果您想比较各个行：

List<String> file1 = Files.readAllLines(Paths.get("Path to File 1"));
List<String> file2 = Files.readAllLines(Paths.get("Path to File 2"));

assertEquals(file1.size(), file2.size());

for(int i = 0; i < file1.size(); i++) {
   System.out.println("Comparing line: " + i)
   assertEquals(file1.get(i), file2.get(i));
}

Answer 6

我建议使用 Assert.assertThat 和 hamcrest 匹配器（junit 4.5 或更高版本 - 甚至可能4.4）。

我最终会得到类似的结果：

assertThat(fileUnderTest, containsExactText(expectedFile));

我的匹配器在哪里：

class FileMatcher {
   static Matcher<File> containsExactText(File expectedFile){
      return new TypeSafeMatcher<File>(){
         String failure;
         public boolean matchesSafely(File underTest){
            //create readers for each/convert to strings
            //Your implementation here, something like:
              String line;
              while ((line = expected.readLine()) != null) {
                 Matcher<?> equalsMatcher = CoreMatchers.equalTo(line);
                 String actualLine = actual.readLine();
                 if (!equalsMatcher.matches(actualLine){
                    failure = equalsMatcher.describeFailure(actualLine);
                    return false;
                 }
              }
              //record failures for uneven lines
         }

         public String describeFailure(File underTest);
             return failure;
         }
      }
   }
}

匹配器优点：

• 组合和重用
• 在正常代码以及测试中使用
  • 收藏
  • 用于模拟框架
  • 可以使用通用谓词函数
• 非常好的日志能力
• 可以与其他匹配器结合使用，并且描述和失败描述准确且精确

缺点：

• 嗯，这很明显，对吧？ 这比断言或 junitx 更详细（对于这种特殊情况）
• 您可能需要包含 hamcrest 库才能获得最大好处

Answer 7

FileUtils 确实是一个不错的选择。 这是另一个 检查文件是否完全相同的简单方法。

assertEquals(FileUtils.checksumCRC32(file1), FileUtils.checksumCRC32(file2));

虽然assertEquals()确实比assertTrue()提供了更多的反馈，但checksumCRC32()的结果很长。 所以，这可能没有什么本质上的帮助。

Answer 8

如果预期的行数比实际的行数多，则在稍后进入assertNull 之前，您将失败assertEquals。

不过修复起来相当容易：

public static void assertReaders(BufferedReader expected,
    BufferedReader actual) throws IOException {
  String expectedLine;
  while ((expectedLine = expected.readLine()) != null) {
    String actualLine = actual.readLine();
    assertNotNull("Expected had more lines then the actual.", actualLine);
    assertEquals(expectedLine, actualLine);
  }
  assertNull("Actual had more lines then the expected.", actual.readLine());
}

Answer 9

这是我自己的 equalFiles 实现，无需向您的项目添加任何库。

private static boolean equalFiles(String expectedFileName,
        String resultFileName) {
    boolean equal;
    BufferedReader bExp;
    BufferedReader bRes;
    String expLine ;
    String resLine ;

    equal = false;
    bExp = null ;
    bRes = null ;

    try {
        bExp = new BufferedReader(new FileReader(expectedFileName));
        bRes = new BufferedReader(new FileReader(resultFileName));

        if ((bExp != null) && (bRes != null)) {
            expLine = bExp.readLine() ;
            resLine = bRes.readLine() ;

            equal = ((expLine == null) && (resLine == null)) || ((expLine != null) && expLine.equals(resLine)) ;

            while(equal && expLine != null)
            {
                expLine = bExp.readLine() ;
                resLine = bRes.readLine() ; 
                equal = expLine.equals(resLine) ;
            }
        }
    } catch (Exception e) {

    } finally {
        try {
            if (bExp != null) {
                bExp.close();
            }
            if (bRes != null) {
                bRes.close();
            }
        } catch (Exception e) {
        }

    }

    return equal;

}

要使用它，只需使用常规的 AssertTrue JUnit 方法

assertTrue(equalFiles(expected, output)) ;