Сравнение текстовых файлов с 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 в своем проекте. Но нет хороших, подробных сообщений об ошибках, как в решении Марк .

Редактировать
Хех, если присмотреться к 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).hasSameContentAs(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

Я бы предложил использовать Assert.assertThat и matcher * 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;
         }
      }
   }
}

Соответствующие плюсы:

• Состав и повторное использование
• Использовать как в обычном коде, так и в тесте
  • Коллекция
  • Используется в макете (ах)
  • Может использоваться общая функция предиката
• Действительно хорошая лог-способность
• Может сочетаться с другими сопоставителями и описаниями, а описания отказов являются точными и точными

Минусы:

• Ну, это довольно очевидно, верно? Это более многословно, чем assert или junitx (для данного конкретного случая)
• Вам, вероятно, нужно будет включить либкера подколенного сухожилия, чтобы получить максимальную выгоду

Answer 6

Сравнение содержимого двух файлов с API java.nio.file.

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 7

FileUtils конечно, хороший. Вот еще один простой подход для проверки того, совпадают ли файлы.

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

Хотя assertEquals () обеспечивает немного больше обратной связи, чем assertTrue (), результат checkumCRC32 () - длинный. Так что это может быть не очень полезно.

Answer 8

Если в ожидаемом количестве строк больше, чем в действительности, произойдет сбой assertEquals перед тем, как перейти к assertNull позже.

Это довольно легко исправить, хотя:

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)) ;