Package net.officefloor.frame.test

Class Assertions

java.lang.Object
org.junit.jupiter.api.Assertions
net.officefloor.frame.test.Assertions
public class Assertions extends org.junit.jupiter.api.Assertions
Assertions extended with additional features.
Author:
Daniel Sagenschneider

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    protected static interface 
    Assertions.FailOperation
    Operation for assertFail(net.officefloor.frame.test.Assertions.FailOperation, java.lang.Class<F>) that should fail.

    Nested classes/interfaces inherited from class org.junit.jupiter.api.Assertions

    org.junit.jupiter.api.Assertions.TimeoutFailureFactory<T extends Throwable>

  • Constructor Summary

    Constructors
    Constructor
    Description
    Assertions()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static void
    assertContents(File expected, File actual)
    Asserts the contents of the input File instances are the same.
    static void
    assertContents(Reader expected, Reader actual)
    Asserts the contents of the input Reader instances are the same.
    static <F extends Throwable>
    F
    assertFail(Class<F> expectedFailureType, Object object, Method method, Object... parameters)
    Provides simplified facade to verify Method will fail.
    static <F extends Throwable>
    F
    assertFail(Class<F> expectedFailureType, Object object, String methodName, Object... parameters)
    Provides simplified facade to verify Method will fail.
    static <F extends Throwable>
    F
    assertFail(Assertions.FailOperation operation, Class<F> expectedFailureType)
    Asserts the failure.
    static <O> void
    assertGraph(O expectedRoot, O actualRoot, String... ignoreMethodNames)
    Assets that the input graph is as expected.
    static <O> void
    assertList(String[] methods, List<O> list, O... expectedItems)
    Asserts that properties on items within list match.
    static <O> void
    assertList(String[] methods, O[] array, O... expectedItems)
    Asserts that properties on items within the array match.
    static <O> void
    assertList(String sortMethod, String[] methods, List<O> list, O... expectedItems)
    Asserts that properties on items within list match after the list is sorted.
    static <O> void
    assertList(List<O> list, O... expectedItems)
    Asserts that the input list equals the expected.
    static <O> void
    assertList(ListItemMatcher<O> matcher, List<O> list, O... expectedItems)
    Asserts that the input list is as expected.
    static <O> void
    assertProperties(O expected, O actual, String... methods)
    Asserts that properties on the input objects match for the specified methods.
    static void
    assertTextEquals(String expected, String actual, String message)
    Asserts the input texts match taking into account platform differences.
    static void
    assertXmlEquals(String expected, String actual, String message)
    Asserts the input XML's match with white spacing removed.
    static String
    createPlatformIndependentText(String rawText)
    Creates the platform independent text for comparing.
    static <T> T
    getItem(Collection<T> items, String methodName, Object value)
    Obtains the item within the items whose property by methodName matches the input value.
    static Object
    getProperty(Object object, String methodName)
    Obtains the property on the Object.
    static String
    removeXmlWhiteSpacing(String xml)
    Removes the white spacing from the XML.

    Methods inherited from class org.junit.jupiter.api.Assertions

    assertAll, assertAll, assertAll, assertAll, assertAll, assertAll, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertDoesNotThrow, assertDoesNotThrow, assertDoesNotThrow, assertDoesNotThrow, assertDoesNotThrow, assertDoesNotThrow, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertFalse, assertFalse, assertFalse, assertFalse, assertFalse, assertFalse, assertInstanceOf, assertInstanceOf, assertInstanceOf, assertIterableEquals, assertIterableEquals, assertIterableEquals, assertLinesMatch, assertLinesMatch, assertLinesMatch, assertLinesMatch, assertLinesMatch, assertLinesMatch, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotNull, assertNotNull, assertNotNull, assertNotSame, assertNotSame, assertNotSame, assertNull, assertNull, assertNull, assertSame, assertSame, assertSame, assertThrows, assertThrows, assertThrows, assertThrowsExactly, assertThrowsExactly, assertThrowsExactly, assertTimeout, assertTimeout, assertTimeout, assertTimeout, assertTimeout, assertTimeout, assertTimeoutPreemptively, assertTimeoutPreemptively, assertTimeoutPreemptively, assertTimeoutPreemptively, assertTimeoutPreemptively, assertTimeoutPreemptively, assertTimeoutPreemptively, assertTrue, assertTrue, assertTrue, assertTrue, assertTrue, assertTrue, fail, fail, fail, fail, fail

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • Assertions

      public Assertions()

  • Method Details

    • assertFail

      public static <F extends Throwable> F assertFail(Assertions.FailOperation operation, Class<F> expectedFailureType)
      Asserts the failure.
      Type Parameters:
      F - Failure type.
      Parameters:
      operation - Assertions.FailOperation that is expected fail.
      expectedFailureType - Expect type of failure.
      Returns:
      Actual failure for further assertions.

    • assertFail

      public static <F extends Throwable> F assertFail(Class<F> expectedFailureType, Object object, String methodName, Object... parameters)
      Provides simplified facade to verify Method will fail.
      Type Parameters:
      F - Failure type.
      Parameters:
      expectedFailureType - Expected failure of method.
      object - Object to invoke Method on.
      methodName - Name of the Method.
      parameters - Parameters for the Method.
      Returns:
      Actual failure for further assertions.

    • assertFail

      public static <F extends Throwable> F assertFail(Class<F> expectedFailureType, Object object, Method method, Object... parameters)
      Provides simplified facade to verify Method will fail.
      Type Parameters:
      F - Failure type.
      Parameters:
      expectedFailureType - Expected failure of method.
      object - Object to invoke Method on.
      method - Method.
      parameters - Parameters for the Method.
      Returns:
      Actual failure for further assertions.

    • assertTextEquals

      public static void assertTextEquals(String expected, String actual, String message)
      Asserts the input texts match taking into account platform differences.
      Parameters:
      expected - Raw expected text.
      actual - Raw actual text.
      message - Message.

    • createPlatformIndependentText

      public static String createPlatformIndependentText(String rawText)
      Creates the platform independent text for comparing.
      Parameters:
      rawText - Raw text.
      Returns:
      Platform independent text.

    • assertXmlEquals

      public static void assertXmlEquals(String expected, String actual, String message)
      Asserts the input XML's match with white spacing removed.
      Parameters:
      expected - Raw expected text.
      actual - Raw actual text.
      message - Message.

    • removeXmlWhiteSpacing

      public static String removeXmlWhiteSpacing(String xml)
      Removes the white spacing from the XML.
      Parameters:
      xml - XML.
      Returns:
      XML with white spacing removed.

    • assertGraph

      public static <O> void assertGraph(O expectedRoot, O actualRoot, String... ignoreMethodNames) throws Exception
      Assets that the input graph is as expected.
      Type Parameters:
      O - Type.
      Parameters:
      expectedRoot - Expected root.
      actualRoot - Actual root.
      ignoreMethodNames - Listing of methods to be ignored in checking.
      Throws:
      Exception - If fails.

    • assertContents

      public static void assertContents(File expected, File actual) throws IOException
      Asserts the contents of the input File instances are the same.
      Parameters:
      expected - Expected file.
      actual - Actual file.
      Throws:
      IOException - If fails to read contents.

    • assertContents

      public static void assertContents(Reader expected, Reader actual)
      Asserts the contents of the input Reader instances are the same.
      Parameters:
      expected - Expected content.
      actual - Actual content.

    • assertList

      @SafeVarargs public static <O> void assertList(ListItemMatcher<O> matcher, List<O> list, O... expectedItems)
      Asserts that the input list is as expected.
      Type Parameters:
      O - Type.
      Parameters:
      matcher - Matches the items of the list.
      list - List to be checked.
      expectedItems - Items expected to be in the list.

    • assertList

      @SafeVarargs public static <O> void assertList(List<O> list, O... expectedItems)
      Asserts that the input list equals the expected.
      Type Parameters:
      O - Type.
      Parameters:
      list - List to be checked.
      expectedItems - Items expected in the list.

    • assertList

      @SafeVarargs public static <O> void assertList(String[] methods, List<O> list, O... expectedItems)
      Asserts that properties on items within list match.
      Type Parameters:
      O - Type.
      Parameters:
      methods - Method names to specify the properties on the items to match.
      list - List to be checked.
      expectedItems - Items expected in the list.

    • assertList

      @SafeVarargs public static <O> void assertList(String[] methods, O[] array, O... expectedItems)
      Asserts that properties on items within the array match.
      Type Parameters:
      O - Type.
      Parameters:
      methods - Method names to specify the properties on the items to match.
      array - Array to be checked.
      expectedItems - Items expected in the array.

    • assertList

      @SafeVarargs public static <O> void assertList(String sortMethod, String[] methods, List<O> list, O... expectedItems)
      Asserts that properties on items within list match after the list is sorted.
      Type Parameters:
      O - Type.
      Parameters:
      sortMethod - Name of method on the items to sort the list by to ensure match in order.
      methods - Method names to specify the properties on the items to match.
      list - List to be checked.
      expectedItems - Items expected in the list.

    • assertProperties

      public static <O> void assertProperties(O expected, O actual, String... methods)
      Asserts that properties on the input objects match for the specified methods.
      Type Parameters:
      O - Type.
      Parameters:
      expected - Expected item.
      actual - Actual item.
      methods - Method names to specify the properties on the item to match.

    • getProperty

      public static Object getProperty(Object object, String methodName)
      Obtains the property on the Object.
      Parameters:
      object - Object.
      methodName - Method name to obtain property value.
      Returns:
      Value of property.

    • getItem

      public static <T> T getItem(Collection<T> items, String methodName, Object value)
      Obtains the item within the items whose property by methodName matches the input value.
      Type Parameters:
      T - Item type.
      Parameters:
      items - Items to search.
      methodName - Property on the item.
      value - Value of property the item should match.
      Returns:
      Item with the matching property.