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

TestRunResult

public class TestRunResult implements ITestRunListener

Holds results from a single test run.

Maintains an accurate count of tests, and tracks incomplete tests.

Not thread safe! The test* callbacks must be called in order

This is an android-compatible copy of com.android.ddmlib.testrunner.TestRunResult.

Summary

Public constructors

Create an emptyandroidx.test.orchestrator.listeners.result.TestRunResult.

Public methods
Set<TestIdentifier>

Gets the set of completed tests.
long
String
int

Return total number of tests in a failure state (failed, assumption failure)
int

Gets the number of complete tests in this run ie with status != incomplete.
int

Gets the number of tests in this run.
int

Gets the number of tests in given state for this run.
String

Return the run failure error message, null if run did not fail.
Map<String, String>
Map<TestIdentifier, TestResult>

Gets a map of the test results.
String

Return a user friendly string describing results.
boolean
boolean
boolean
void
setAggregateMetrics(boolean metricAggregation)
void
setRunComplete(boolean runComplete)
void

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

Reports the execution end of an individual test case.
void

Reports the failure of a individual test case.
void

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

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

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

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

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

Reports the start of an individual test case.

Public constructors

TestRunResult

public TestRunResult()

Create an emptyandroidx.test.orchestrator.listeners.result.TestRunResult.

Public methods

getCompletedTests

public Set<TestIdentifier> getCompletedTests()

Gets the set of completed tests.

getElapsedTime

public long getElapsedTime()
Returns
long

getName

public String getName()
Returns
String

the test run name

getNumAllFailedTests

public int getNumAllFailedTests()

Return total number of tests in a failure state (failed, assumption failure)

getNumCompleteTests

public int getNumCompleteTests()

Gets the number of complete tests in this run ie with status != incomplete.

getNumTests

public int getNumTests()

Gets the number of tests in this run.

getNumTestsInState

public int getNumTestsInState(TestResult.TestStatus status)

Gets the number of tests in given state for this run.

getRunFailureMessage

public String getRunFailureMessage()

Return the run failure error message, null if run did not fail.

getRunMetrics

public Map<String, String> getRunMetrics()
Returns
Map<String, String>

a Map of the test test run metrics.

getTestResults

public Map<TestIdentifier, TestResult> getTestResults()

Gets a map of the test results.

Returns
Map<TestIdentifier, TestResult>

getTextSummary

public String getTextSummary()

Return a user friendly string describing results.

Returns
String

hasFailedTests

public boolean hasFailedTests()
Returns
boolean

true if test run had any failed or error tests.

isRunComplete

public boolean isRunComplete()
Returns
boolean

true if test run finished.

isRunFailure

public boolean isRunFailure()
Returns
boolean

true if test run failed.

setAggregateMetrics

public void setAggregateMetrics(boolean metricAggregation)

setRunComplete

public void setRunComplete(boolean runComplete)

testAssumptionFailure

public void testAssumptionFailure(TestIdentifier test, String trace)

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

Parameters
TestIdentifier test

identifies the test
String trace

stack trace of failure

testEnded

public void testEnded(TestIdentifier test, Map<String, 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
TestIdentifier test

identifies the test
Map<String, String> testMetrics

a Map of the metrics emitted

testFailed

public void testFailed(TestIdentifier test, String trace)

Reports the failure of a individual test case.

Will be called between testStarted and testEnded.

Parameters
TestIdentifier test

identifies the test
String trace

stack trace of failure

testIgnored

public void testIgnored(TestIdentifier test)

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

Parameters
TestIdentifier test

identifies the test

testRunEnded

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

Reports end of test run.

Parameters
long elapsedTime

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

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

testRunFailed

public void testRunFailed(String errorMessage)

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

Parameters
String errorMessage

String describing reason for run failure.

testRunStarted

public void testRunStarted(String runName, int testCount)

Reports the start of a test run.

Parameters
String runName

the test run name
int testCount

total number of tests in test run

testRunStopped

public void testRunStopped(long elapsedTime)

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

TODO: currently unused, consider removing

Parameters
long elapsedTime

device reported elapsed time, in milliseconds

testStarted

public void testStarted(TestIdentifier test)

Reports the start of an individual test case.

Parameters
TestIdentifier test

identifies the test