TestResult (Gradle API 7.6.4)

Package org.gradle.api.tasks.testing

## Interface TestResult

-     public interface TestResult

  Describes a test result.

- - ### Nested Class Summary

    Nested Classes
    Modifier and Type | Interface | Description
    --- | --- | ---
    `static class` | `TestResult.ResultType` | The final status of a test.

  - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `long` | `getEndTime()` | Returns the time when this test completed execution.
    `java.lang.Throwable` | `getException()` | If the test failed with an exception, this will be the exception.
    `java.util.List<java.lang.Throwable>` | `getExceptions()` | If the test failed with any exceptions, this will contain the exceptions.
    `long` | `getFailedTestCount()` | Returns the number of failed atomic tests executed for this test.
    `java.util.List<TestFailure>` | `getFailures()` | If the test failed with any exceptions, this will contain the exceptions and a description of the failure types.
    `TestResult.ResultType` | `getResultType()` | Returns the type of result.
    `long` | `getSkippedTestCount()` | Returns the number of skipped atomic tests executed for this test.
    `long` | `getStartTime()` | Returns the time when this test started execution.
    `long` | `getSuccessfulTestCount()` | Returns the number of successful atomic tests executed for this test.
    `long` | `getTestCount()` | Returns the total number of atomic tests executed for this test.

- - ### Method Detail

    - #### getResultType

          TestResult.ResultType getResultType()

      Returns the type of result. Generally one wants it to be SUCCESS!
      Returns:
        The result type.

    - #### getException

          @Nullable
          java.lang.Throwable getException()

      If the test failed with an exception, this will be the exception. Some test frameworks do not fail without an exception (JUnit), so in those cases this method will never return null.
      Returns:
        The exception, if any, logged for this test. If none, a null is returned.

    - #### getFailures

          @Incubating
          java.util.List<TestFailure> getFailures()

      If the test failed with any exceptions, this will contain the exceptions and a description of the failure types.
      Returns:
        The failures, if any, logged for this test. If none, an empty list is returned.
      Since:
        7.6
      See Also:
        `getExceptions()`

    - #### getExceptions

          java.util.List<java.lang.Throwable> getExceptions()

      If the test failed with any exceptions, this will contain the exceptions. Some test frameworks do not fail without an exception (JUnit), so in those cases this method will never return an empty list.
      Returns:
        The exceptions, if any, logged for this test. If none, an empty list is returned.

    - #### getStartTime

          long getStartTime()

      Returns the time when this test started execution.
      Returns:
        The start time, in milliseconds since the epoch.

    - #### getEndTime

          long getEndTime()

      Returns the time when this test completed execution.
      Returns:
        The end t ime, in milliseconds since the epoch.

    - #### getTestCount

          long getTestCount()

      Returns the total number of atomic tests executed for this test. This will return 1 if this test is itself an atomic test.
      Returns:
        The number of tests, possibly 0

    - #### getSuccessfulTestCount

          long getSuccessfulTestCount()

      Returns the number of successful atomic tests executed for this test.
      Returns:
        The number of tests, possibly 0

    - #### getFailedTestCount

          long getFailedTestCount()

      Returns the number of failed atomic tests executed for this test.
      Returns:
        The number of tests, possibly 0

    - #### getSkippedTestCount

          long getSkippedTestCount()

      Returns the number of skipped atomic tests executed for this test.
      Returns:
        The number of tests, possibly 0