{% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %} {% include "_shared/_reference-head-tags.html" %}

ITestRunListener

interface ITestRunListener

Known direct subclasses
TestRunResult

Holds results from a single test run.

Receives event notifications during instrumentation test runs.

Patterned after org.junit.runner.notification.RunListener

The sequence of calls will be:

This is a copy of com.android.ddmlib.testrunner.ITestRunListener.

Summary

Public methods
abstract @NonNull void

Called when an atomic test flags that it assumes a condition that is false
abstract @NonNull void
testEnded(
    @NonNull TestIdentifier test,
    @NonNull Map<@NonNull String, @NonNull String> testMetrics
)

Reports the execution end of an individual test case.
abstract @NonNull void

Reports the failure of a individual test case.
abstract @NonNull void

Called when a test will not be run, generally because a test method is annotated with org.junit.Ignore.
abstract @NonNull void
testRunEnded(
    @NonNull long elapsedTime,
    @NonNull Map<@NonNull String, @NonNull String> runMetrics
)

Reports end of test run.
abstract @NonNull void
testRunFailed(@NonNull String errorMessage)

Reports test run failed to complete due to a fatal error.
abstract @NonNull void
testRunStarted(@NonNull String runName, @NonNull int testCount)

Reports the start of a test run.
abstract @NonNull void
testRunStopped(@NonNull long elapsedTime)

Reports test run stopped before completion due to a user request.
abstract @NonNull void

Reports the start of an individual test case.

Public methods

testAssumptionFailure

@NonNull
public abstract void testAssumptionFailure(@NonNull TestIdentifier test, @NonNull String trace)

Called when an atomic test flags that it assumes a condition that is false

Parameters
@NonNull TestIdentifier test

identifies the test
@NonNull String trace

stack trace of failure

testEnded

@NonNull
public abstract void testEnded(
    @NonNull TestIdentifier test,
    @NonNull Map<@NonNull String, @NonNull String> testMetrics
)

Reports the execution end of an individual test case.

If testFailed was not invoked, this test passed. Also returns any key/value metrics which may have been emitted during the test case's execution.

Parameters
@NonNull TestIdentifier test

identifies the test
@NonNull Map<@NonNull String, @NonNull String> testMetrics

a Map of the metrics emitted

testFailed

@NonNull
public abstract void testFailed(@NonNull TestIdentifier test, @NonNull String trace)

Reports the failure of a individual test case.

Will be called between testStarted and testEnded.

Parameters
@NonNull TestIdentifier test

identifies the test
@NonNull String trace

stack trace of failure

testIgnored

@NonNull
public abstract void testIgnored(@NonNull TestIdentifier test)

Called when a test will not be run, generally because a test method is annotated with org.junit.Ignore.

Parameters
@NonNull TestIdentifier test

identifies the test

testRunEnded

@NonNull
public abstract void testRunEnded(
    @NonNull long elapsedTime,
    @NonNull Map<@NonNull String, @NonNull String> runMetrics
)

Reports end of test run.

Parameters
@NonNull long elapsedTime

device reported elapsed time, in milliseconds
@NonNull Map<@NonNull String, @NonNull String> runMetrics

key-value pairs reported at the end of a test run

testRunFailed

@NonNull
public abstract void testRunFailed(@NonNull String errorMessage)

Reports test run failed to complete due to a fatal error.

Parameters
@NonNull String errorMessage

String describing reason for run failure.

testRunStarted

@NonNull
public abstract void testRunStarted(@NonNull String runName, @NonNull int testCount)

Reports the start of a test run.

Parameters
@NonNull String runName

the test run name
@NonNull int testCount

total number of tests in test run

testRunStopped

@NonNull
public abstract void testRunStopped(@NonNull long elapsedTime)

Reports test run stopped before completion due to a user request.

TODO: currently unused, consider removing

Parameters
@NonNull long elapsedTime

device reported elapsed time, in milliseconds

testStarted

@NonNull
public abstract void testStarted(@NonNull TestIdentifier test)

Reports the start of an individual test case.

Parameters
@NonNull TestIdentifier test

identifies the test