Class FileComparisonUtils

java.lang.Object
it.tidalwave.util.test.FileComparisonUtils

public class FileComparisonUtils extends Object
A utility class to compare two text files and assert that they have the same contents.
Author:
Fabrizio Giudici
  • Field Details

    • P_TABULAR_OUTPUT

      public static final String P_TABULAR_OUTPUT
    • P_TABULAR_LIMIT

      public static final String P_TABULAR_LIMIT
  • Constructor Details

    • FileComparisonUtils

      public FileComparisonUtils()
  • Method Details

    • assertSameContents

      public static void assertSameContents(@Nonnull File expectedFile, @Nonnull File actualFile) throws IOException
      Asserts that two files have the same contents.
      Parameters:
      expectedFile - the file with the expected contents
      actualFile - the file with the contents to probe
      Throws:
      IOException - in case of error
    • assertSameContents

      public static void assertSameContents(@Nonnull Path expectedPath, @Nonnull Path actualPath) throws IOException
      Asserts that two files have the same contents.
      Parameters:
      expectedPath - the file with the expected contents
      actualPath - the file with the contents to probe
      Throws:
      IOException - in case of error
    • assertSameContents

      public static void assertSameContents(@Nonnull List<String> expected, @Nonnull List<String> actual)
      Asserts that two collections of strings have the same contents.
      Parameters:
      expected - the expected values
      actual - the actual values
    • checkSameContents

      public static boolean checkSameContents(@Nonnull Path expectedPath, @Nonnull Path actualPath) throws IOException
      Checks whether two files have the same contents.
      Parameters:
      expectedPath - the file with the expected contents
      actualPath - the file with the contents to probe
      Throws:
      IOException - in case of error
      Since:
      1.2-ALPHA-15
    • stringToStrings

      @Nonnull public static List<String> stringToStrings(@Nonnull String string) throws IOException
      Converts a string which contains newlines into a list of strings.
      Parameters:
      string - the source
      Returns:
      the strings
      Throws:
      IOException - in case of error
    • fileToStrings

      @Nonnull public static List<String> fileToStrings(@Nonnull Path file) throws IOException
      Reads a file into a list of strings.
      Parameters:
      file - the file
      Returns:
      the strings
      Throws:
      IOException - in case of error
    • resourceToStrings

      @Nonnull public static List<String> resourceToStrings(@Nonnull String path) throws IOException
      Reads a classpath resource (not a regular file) into a list of strings.
      Parameters:
      path - the path of the classpath resource
      Returns:
      the strings
      Throws:
      IOException - in case of error
    • resourceToStrings

      @Nonnull public static List<String> resourceToStrings(@Nonnull InputStream is) throws IOException
      Reads an input stream into a list of strings. The stream is closed at the end.
      Parameters:
      is - the input stream
      Returns:
      the strings
      Throws:
      IOException - in case of error
    • commonPrefix

      @Nonnull public static String commonPrefix(@Nonnull String s1, @Nonnull String s2)
      Given a string that represents a path whose segments are separated by the standard separator of the platform, returns the common prefix - which means the common directory parents.
      Parameters:
      s1 - the former string
      s2 - the latter string
      Returns:
      the common prefix