Interface TestFrameworkSupport


  • @API(status=INTERNAL,
         since="1.10.0")
    public interface TestFrameworkSupport
    Abstraction to provide test framework specific behavior to the snapshot-test core
    Since:
    1.10.0
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.Throwable assumptionFailed​(java.lang.String message)
      Creates a throwable that will mark the repsective test as skipped.
      boolean isSnapshotTest​(java.lang.Class<?> testClass, java.lang.reflect.Method testMethod)
      Tries to determine whether the given method is (still) a snapshot test.
    • Method Detail

      • isSnapshotTest

        boolean isSnapshotTest​(java.lang.Class<?> testClass,
                               java.lang.reflect.Method testMethod)
        Tries to determine whether the given method is (still) a snapshot test. This is used during static orphan detection in order to determine whether the method mentioned in an existing snapshot's header pertains to an existing snapshot test method.

        It might not always be possible to statically determine whether a test method uses snapshot assertions. In this case the method should return true in order to prevent false positives during orphan detection.

        Parameters:
        testClass - The test class.
        testMethod - The test method.
        Returns:
        Whether the given test method uses snapshot assertions.
      • assumptionFailed

        java.lang.Throwable assumptionFailed​(java.lang.String message)
        Creates a throwable that will mark the repsective test as skipped.
        Parameters:
        message - The message for the throwable.
        Returns:
        The throwable.