Package org.testng

Class FileAssert


  • public class FileAssert
    extends java.lang.Object
    Assertion tool for File centric assertions. Conceptually, this is an extension of Assert. Presents assertion methods with a more natural parameter order. The order is always actualValue, expectedValue [, message].
    Since:
    5.6
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private FileAssert()
      Protect this constructor since it is a static only class.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static void assertDirectory​(java.io.File tstvalue)  
      static void assertDirectory​(java.io.File tstvalue, java.lang.String message)
      Asserts that a tstvalue is a proper directory.
      static void assertFile​(java.io.File tstvalue)  
      static void assertFile​(java.io.File tstvalue, java.lang.String message)
      Asserts that a tstvalue is a proper file.
      static void assertLength​(java.io.File tstvalue, long expected)  
      static void assertLength​(java.io.File tstvalue, long expected, java.lang.String message)
      Asserts that a tstvalue is a file of exactly expected characters or a directory of exactly expected entries.
      static void assertMaxLength​(java.io.File tstvalue, long expected)  
      static void assertMaxLength​(java.io.File tstvalue, long expected, java.lang.String message)
      Asserts that a tstvalue is a file of at most expected characters or a directory of at most expected entries.
      static void assertMinLength​(java.io.File tstvalue, long expected)  
      static void assertMinLength​(java.io.File tstvalue, long expected, java.lang.String message)
      Asserts that a tstvalue is a file of at least expected characters or a directory of at least expected entries.
      static void assertReadable​(java.io.File tstvalue)  
      static void assertReadable​(java.io.File tstvalue, java.lang.String message)
      Asserts that a tstvalue is readable.
      static void assertReadWrite​(java.io.File tstvalue)  
      static void assertReadWrite​(java.io.File tstvalue, java.lang.String message)
      Asserts that a tstvalue is readable and writeable.
      static void assertWriteable​(java.io.File tstvalue)  
      static void assertWriteable​(java.io.File tstvalue, java.lang.String message)
      Asserts that a tstvalue is writeable.
      static void fail()
      Fails a test with no message.
      static void fail​(java.lang.String message)
      Fails a test with the given message.
      static void fail​(java.lang.String message, java.lang.Throwable realCause)
      Fails a test with the given message and wrapping the original exception.
      private static void failFile​(java.io.File path, java.lang.String actual, java.lang.String expected, java.lang.String message)
      Formats failure for file assertions.
      private static void failSecurity​(java.lang.Exception e, java.io.File path, java.lang.String actual, java.lang.String expected, java.lang.String message)  
      private static java.lang.String fileAccess​(java.io.File path)
      String representation of read and write permissions of path.
      private static java.lang.String fileType​(java.io.File path)
      String representation of what sort of file path is.
      private static java.lang.String toString​(java.io.File path)  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • FileAssert

        private FileAssert()
        Protect this constructor since it is a static only class.
    • Method Detail

      • assertDirectory

        public static void assertDirectory​(java.io.File tstvalue,
                                           java.lang.String message)
        Asserts that a tstvalue is a proper directory. If it isn't, an AssertionError with the given message is thrown.
        Parameters:
        tstvalue - the file to evaluate
        message - the assertion error message
      • assertDirectory

        public static void assertDirectory​(java.io.File tstvalue)
      • assertFile

        public static void assertFile​(java.io.File tstvalue,
                                      java.lang.String message)
        Asserts that a tstvalue is a proper file. If it isn't, an AssertionError with the given message is thrown.
        Parameters:
        tstvalue - the file to evaluate
        message - the assertion error message
      • assertFile

        public static void assertFile​(java.io.File tstvalue)
        Parameters:
        tstvalue - The actual file
        See Also:
        assertFile(File, String)
      • assertLength

        public static void assertLength​(java.io.File tstvalue,
                                        long expected,
                                        java.lang.String message)
        Asserts that a tstvalue is a file of exactly expected characters or a directory of exactly expected entries. If it isn't, an AssertionError with the given message is thrown.
        Parameters:
        tstvalue - the file to evaluate
        expected - the expected value
        message - the assertion error message
      • assertLength

        public static void assertLength​(java.io.File tstvalue,
                                        long expected)
        Parameters:
        tstvalue - The actual file
        expected - The expected length
        See Also:
        assertLength(File, long, String)
      • assertMinLength

        public static void assertMinLength​(java.io.File tstvalue,
                                           long expected,
                                           java.lang.String message)
        Asserts that a tstvalue is a file of at least expected characters or a directory of at least expected entries. If it isn't, an AssertionError with the given message is thrown.
        Parameters:
        tstvalue - the file to evaluate
        expected - the expected value
        message - the assertion error message
      • assertMinLength

        public static void assertMinLength​(java.io.File tstvalue,
                                           long expected)
        Parameters:
        tstvalue - The actual file
        expected - The expected min length
        See Also:
        assertMinLength(File, long, String)
      • assertMaxLength

        public static void assertMaxLength​(java.io.File tstvalue,
                                           long expected,
                                           java.lang.String message)
        Asserts that a tstvalue is a file of at most expected characters or a directory of at most expected entries. If it isn't, an AssertionError with the given message is thrown.
        Parameters:
        tstvalue - the file to evaluate
        expected - The expected max length
        message - the assertion error message
      • assertMaxLength

        public static void assertMaxLength​(java.io.File tstvalue,
                                           long expected)
        Parameters:
        tstvalue - The actual file
        expected - The expected length
        See Also:
        assertMaxLength(File, long, String)
      • assertReadable

        public static void assertReadable​(java.io.File tstvalue,
                                          java.lang.String message)
        Asserts that a tstvalue is readable. If it isn't, an AssertionError with the given message is thrown.
        Parameters:
        tstvalue - the file to evaluate
        message - the assertion error message
      • assertReadable

        public static void assertReadable​(java.io.File tstvalue)
        Parameters:
        tstvalue - The actual file
        See Also:
        assertReadable(File, String)
      • assertWriteable

        public static void assertWriteable​(java.io.File tstvalue,
                                           java.lang.String message)
        Asserts that a tstvalue is writeable. If it isn't, an AssertionError with the given message is thrown.
        Parameters:
        tstvalue - the file to evaluate
        message - the assertion error message
      • assertWriteable

        public static void assertWriteable​(java.io.File tstvalue)
        Parameters:
        tstvalue - The actual file
        See Also:
        assertWriteable(File, String)
      • assertReadWrite

        public static void assertReadWrite​(java.io.File tstvalue,
                                           java.lang.String message)
        Asserts that a tstvalue is readable and writeable. If it isn't, an AssertionError with the given message is thrown.
        Parameters:
        tstvalue - the file to evaluate
        message - the assertion error message
      • assertReadWrite

        public static void assertReadWrite​(java.io.File tstvalue)
        Parameters:
        tstvalue - The actual file
        See Also:
        assertReadWrite(File, String)
      • fail

        public static void fail​(java.lang.String message,
                                java.lang.Throwable realCause)
        Fails a test with the given message and wrapping the original exception.
        Parameters:
        message - the assertion error message
        realCause - the original exception
      • fail

        public static void fail​(java.lang.String message)
        Fails a test with the given message.
        Parameters:
        message - the assertion error message
      • fail

        public static void fail()
        Fails a test with no message.
      • failFile

        private static void failFile​(java.io.File path,
                                     java.lang.String actual,
                                     java.lang.String expected,
                                     java.lang.String message)
        Formats failure for file assertions.
      • failSecurity

        private static void failSecurity​(java.lang.Exception e,
                                         java.io.File path,
                                         java.lang.String actual,
                                         java.lang.String expected,
                                         java.lang.String message)
        Parameters:
        tstvalue -
        string -
        string2 -
        message -
      • fileType

        private static java.lang.String fileType​(java.io.File path)
        String representation of what sort of file path is.
      • fileAccess

        private static java.lang.String fileAccess​(java.io.File path)
        String representation of read and write permissions of path.
      • toString

        private static java.lang.String toString​(java.io.File path)