com.android.ddmlib.testrunner

Interface ITestRunListener

All Known Implementing Classes:

TestRunResult, XmlTestRunListener

public interface ITestRunListener

Receives event notifications during instrumentation test runs.

Patterned after org.junit.runner.notification.RunListener

The sequence of calls will be:

• testRunStarted
• testStarted
• [testFailed]
• [testAssumptionFailure]
• [testIgnored]
• testEnded
• ....
• [testRunFailed]
• testRunEnded

Method Summary

Modifier and Type	Method and Description
void	testAssumptionFailure(TestIdentifier test, java.lang.String trace) Called when an atomic test flags that it assumes a condition that is false
default void	testEnded(TestIdentifier test, long endTime, java.util.Map<java.lang.String,java.lang.String> testMetrics) Alternative to testEnded(TestIdentifier, Map) where we can specify the end time directly.
void	testEnded(TestIdentifier test, java.util.Map<java.lang.String,java.lang.String> testMetrics) Reports the execution end of an individual test case.
void	testFailed(TestIdentifier test, java.lang.String trace) Reports the failure of a individual test case.
void	testIgnored(TestIdentifier test) Called when a test will not be run, generally because a test method is annotated with org.junit.Ignore.
void	testRunEnded(long elapsedTime, java.util.Map<java.lang.String,java.lang.String> runMetrics) Reports end of test run.
void	testRunFailed(java.lang.String errorMessage) Reports test run failed to complete due to a fatal error.
void	testRunStarted(java.lang.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	testStarted(TestIdentifier test) Reports the start of an individual test case.
default void	testStarted(TestIdentifier test, long startTime) Alternative to testStarted(TestIdentifier) where we also specify when the test was started, combined with testEnded(TestIdentifier, long, Map) for accurate measure.

Method Detail

testRunStarted

void testRunStarted(java.lang.String runName,
                    int testCount)

Reports the start of a test run.

Parameters:

runName - the test run name

testCount - total number of tests in test run

testStarted

void testStarted(TestIdentifier test)

Reports the start of an individual test case.

Parameters:

test - identifies the test

testStarted

default void testStarted(TestIdentifier test,
                         long startTime)

Alternative to testStarted(TestIdentifier) where we also specify when the test was started, combined with testEnded(TestIdentifier, long, Map) for accurate measure.

Parameters:

test - identifies the test

startTime - the time the test started, measured via System.currentTimeMillis()

testFailed

void testFailed(TestIdentifier test,
                java.lang.String trace)

Reports the failure of a individual test case.

Will be called between testStarted and testEnded.

Parameters:

test - identifies the test

trace - stack trace of failure

testAssumptionFailure

void testAssumptionFailure(TestIdentifier test,
                           java.lang.String trace)

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

Parameters:

test - identifies the test

trace - stack trace of failure

testIgnored

void testIgnored(TestIdentifier test)

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

Parameters:

test - identifies the test

testEnded

void testEnded(TestIdentifier test,
               java.util.Map<java.lang.String,java.lang.String> testMetrics)

Reports the execution end of an individual test case.

If testFailed(com.android.ddmlib.testrunner.TestIdentifier, java.lang.String) was not invoked, this test passed. Also returns any key/value metrics which may have been emitted during the test case's execution.

Parameters:

test - identifies the test

testMetrics - a Map of the metrics emitted

testEnded

default void testEnded(TestIdentifier test,
                       long endTime,
                       java.util.Map<java.lang.String,java.lang.String> testMetrics)

Alternative to testEnded(TestIdentifier, Map) where we can specify the end time directly. Combine with testStarted(TestIdentifier, long) for accurate measure.

Parameters:

test - identifies the test

endTime - the time the test ended, measured via System.currentTimeMillis()

testMetrics - a Map of the metrics emitted

testRunFailed

void testRunFailed(java.lang.String errorMessage)

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

Parameters:

errorMessage - String describing reason for run failure.

testRunStopped

void testRunStopped(long elapsedTime)

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

TODO: currently unused, consider removing

Parameters:

elapsedTime - device reported elapsed time, in milliseconds

testRunEnded

void testRunEnded(long elapsedTime,
                  java.util.Map<java.lang.String,java.lang.String> runMetrics)

Reports end of test run.

Parameters:

elapsedTime - device reported elapsed time, in milliseconds

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