ITestLifeCycleReceiver

public interface ITestLifeCycleReceiver

com.android.tradefed.result.ITestLifeCycleReceiver

Known indirect subclasses

AggregatePostProcessor, AtraceCollector, AtraceRunMetricCollector, AveragePostProcessor, BaseDeviceMetricCollector, BasePostProcessor, BuddyInfoMetricCollector, BugreportCollector, BugreportzMetricCollector, BugreportzOnFailureCollector, CollectingTestListener, ConsoleResultReporter, DebugHostLogOnFailureCollector, DeviceUnavailEmailResultReporter, DumpHeapCollector, and 58 others.

AggregatePostProcessor	A metric aggregator that gives the min, max, mean, variance and standard deviation for numeric metrics collected during multiple-iteration test runs, treating them as doubles.
AtraceCollector	A `IMetricCollector` that runs atrace during a test and collects the result and log them to the invocation.
AtraceRunMetricCollector	Collects the traces from all the test directory under the given directory from the test device, log the test directory and post process the trace files under the test directory and aggregate the metrics.
AveragePostProcessor	Implementation of post processor that calculate the average of the list of metrics.
BaseDeviceMetricCollector	Base implementation of `IMetricCollector` that allows to start and stop collection on `onTestRunStart(com.android.tradefed.device.metric.DeviceMetricData)` and `ERROR(/#onTestRunEnd(com.android.tradefed.device.metric.DeviceMetricData,Map))`.
BasePostProcessor	The base `IPostProcessor` that every implementation should extend.
BuddyInfoMetricCollector	A `ScheduledDeviceMetricCollector` to collect fragmentation at regular intervals.
BugreportCollector	A pass-through `ITestInvocationListener` that collects bugreports when configurable events occur and then calls `ITestInvocationListener#testLog` on its children after each bugreport is collected.
BugreportzMetricCollector	A `ScheduledDeviceMetricCollector` to collect zipped bugreport at regular intervals.
BugreportzOnFailureCollector	Collect a bugreportz when a test case fails.
CollectingTestListener	A `ITestInvocationListener` that will collect all test results.
ConsoleResultReporter	Result reporter to print the test results to the console.
DebugHostLogOnFailureCollector	Collector that will gather and log the host-side logs when a test case failure occurs.
DeviceUnavailEmailResultReporter	An `EmailResultReporter` that will send email when invocation fails due to a device not available exception.
DumpHeapCollector	A `ScheduledDeviceMetricCollector` to collect memory dumps of processes at regular intervals.
EmailResultReporter	A simple result reporter base class that sends emails for test results.
FailureEmailResultReporter	An `EmailResultReporter` that sends notifications if either a test failure or invocation failure occurred.
FileProtoResultReporter	Proto reporter that dumps the `TestRecord` into a file.
FilePullerDeviceMetricCollector	A `BaseDeviceMetricCollector` that listen for metrics key coming from the device and pull them as a file from the device.
FilePullerLogCollector	Logger of the file reported by the device-side.
FilteredResultForwarder	Variant of `ResultForwarder` that only allows a whitelist of `TestDescription` to be reported.
FormattedGeneratorReporter	Reporter that allows to generate reports in a particular format.
GraphicsStatsMetricCollector	A `ScheduledDeviceMetricCollector` to collect graphics stats at regular intervals.
HostStatsdMetricCollector	A `IMetricCollector` that collects statsd metrics from host side using statsd utility commands.
ICommandScheduler.IScheduledInvocationListener	Listener for invocation events when invocation completes.
ILogSaverListener	Allows for `ITestInvocationListener`s to listen for when log files are saved.
IMetricCollector	This interface will be added as a decorator when reporting tests results in order to collect matching metrics.
IPostProcessor	Post processors is a Trade Federation object meant to allow the processing of metrics and logs AFTER the tests and BEFORE result reporting.
IShardableListener	A `ITestInvocationListener` that can be sharded.
ITestInvocationListener	Listener for test results from the test invocation.
ITestSummaryListener	Interface that allows `ITestInvocationListener` to exchange some limited information via summaries.
IncidentReportCollector	Pulls and processes incident reports that are reported device-side.
InvocationFailureEmailResultReporter	An `EmailResultReporter` that can also restrict notifications to just invocation failures.
InvocationToJUnitResultForwarder	A class that listens to `ITestInvocationListener` events and forwards them to a `TestListener`.
IonHeapInfoMetricCollector	A `ScheduledDeviceMetricCollector` to collect audio and system memory heaps at regular intervals.
JsonHttpTestResultReporter	A result reporter that encode test metrics results and branch, device info into JSON and POST into an HTTP service endpoint
LegacySubprocessResultsReporter	A class for freezed subprocess results reporter which is compatible with M & N version of CTS.
LogSaverResultForwarder	A `ResultForwarder` for saving logs with the global file saver.
LogcatCrashResultForwarder	Special listener: on failures (instrumentation process crashing) it will attempt to extract from the logcat the crash and adds it to the failure message associated with the test.
LogcatOnFailureCollector	Collector that will capture and log a logcat when a test case fails.
MemInfoMetricCollector	A `ScheduledDeviceMetricCollector` to collect memory dumps at regular intervals.
MetricsXMLResultReporter	MetricsXMLResultReporter writes test metrics and run metrics to an XML file in a folder specified by metrics-folder parameter at the invocationEnded phase of the test.
ModuleListener	Listener attached to each `IRemoteTest` of each module in order to collect the list of results.
NameMangleListener	A proxy listener to translate test method, class, and package names as results are reported.
NativeCodeCoverageListener	A `ResultForwarder` that will pull native coverage measurements off of the device and log them as test artifacts.
PagetypeInfoMetricCollector	A `ScheduledDeviceMetricCollector` to collect free page counts at regular intervals.
PerfettoPullerMetricCollector	Base implementation of `FilePullerDeviceMetricCollector` that allows pulling the perfetto files from the device and collect the metrics from it.
PrettyTestEventLogger	Logger matching the events and logging them in order to make it easier to debug.
ProcessMaxMemoryCollector	A `ScheduledDeviceMetricCollector` to measure peak memory usage of specified processes.
ProtoResultReporter	Result reporter build a `TestRecord` protobuf with all the results inside.
PythonBinaryHostTest.PythonForwarder	Result forwarder to replace the run name by the binary name.
RebootReasonCollector	Collector that collects device reboot during the test run and report them by reason and counts.
ResultAndLogForwarder	Forwarder for results and logs events.
ResultForwarder	A `ITestInvocationListener` that forwards invocation results to a list of other listeners.
RetryResultForwarder	An Extension of `ResultForwarder` that always push to a given attempt number.
RuntimeRestartCollector	Collector that collects timestamps of runtime restarts (system server crashes) during the test run, if any.
ScheduleMultipleDeviceMetricCollector	A `IMetricCollector` that makes runs multiple metric collectors periodically.
ScheduledDeviceMetricCollector	A `IMetricCollector` that allows to run a collection task periodically at a set interval.
ScreenshotOnFailureCollector	Collector that will capture and log a screenshot when a test case fails.
ShardListener	A `ITestInvocationListener` that collects results from a invocation shard (aka an invocation split to run on multiple resources in parallel), and forwards them to another listener.
ShardMasterResultForwarder	A `ResultForwarder` that combines the results of a sharded test invocations.
StreamProtoResultReporter	An implementation of `ProtoResultReporter`
SubprocessResultsReporter	Implements `ITestInvocationListener` to be specified as a result_reporter and forward from the subprocess the results of tests, test runs, test invocations.
SuiteResultReporter	Collect test results for an entire suite invocation and output the final results.
TemperatureCollector	A `ScheduledDeviceMetricCollector` to measure min and max device temperature.
TestFailureEmailResultReporter	An `EmailResultReporter` that can also restrict notifications to just test failures.
TestFailureListener	Listener used to take action such as screenshot, bugreport, logcat collection upon a test failure when requested.
TextResultReporter	A test result reporter that forwards results to the JUnit text result printer.
TraceCmdCollector	A `IMetricCollector` that collects traces during the test using trace-cmd, and logs them to the invocation.
TraceMetricCollector	A `ScheduledDeviceMetricCollector` to collect kernel debug trace at regular intervals.
TradefedSandboxRunner.StubScheduledInvocationListener	A stub `IScheduledInvocationListener` that does nothing.
XmlFormattedGeneratorReporter	Implementation of the `FormattedGeneratorReporter` which format the suite results in an xml format.
XmlResultReporter	Writes JUnit results to an XML files in a format consistent with Ant's XMLJUnitResultFormatter.

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

Summary

Public methods
`default void`	`testAssumptionFailure(TestDescription test, String trace)` Called when an atomic test flags that it assumes a condition that is false
`default void`	`testEnded(TestDescription test, long endTime, testMetrics)` Alternative to `ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map))` where we can specify the end time directly.
`default void`	`testEnded(TestDescription test, testMetrics)` Reports the execution end of an individual test case.
`default void`	`testFailed(TestDescription test, String trace)` Reports the failure of a individual test case.
`default void`	`testIgnored(TestDescription test)` Called when a test will not be run, generally because a test method is annotated with org.junit.Ignore.
`default void`	`testRunEnded(long elapsedTimeMillis, runMetrics)` Reports end of test run.
`default void`	`testRunFailed(String errorMessage)` Reports test run failed to complete due to a fatal error.
`default void`	`testRunStarted(String runName, int testCount, int attemptNumber)` Reports the start of a test run.
`default void`	`testRunStarted(String runName, int testCount)` Reports the start of a test run.
`default void`	`testRunStarted(String runName, int testCount, int attemptNumber, long startTime)` Reports the start of a test run.
`default void`	`testRunStopped(long elapsedTime)` Reports test run stopped before completion due to a user request.
`default void`	`testStarted(TestDescription test, long startTime)` Alternative to `testStarted(com.android.tradefed.result.TestDescription)` where we also specify when the test was started, combined with `ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map))` for accurate measure.
`default void`	`testStarted(TestDescription test)` Reports the start of an individual test case.

Public methods

testAssumptionFailure

public void testAssumptionFailure (TestDescription test, 
                String trace)

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

Parameters
`test`	`TestDescription`: identifies the test
`trace`	`String`: stack trace of failure

testEnded

public void testEnded (TestDescription test, 
                long endTime, 
                 testMetrics)

Alternative to ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)) where we can specify the end time directly. Combine with testStarted(com.android.tradefed.result.TestDescription, long) for accurate measure.

Parameters
`test`	`TestDescription`: identifies the test
`endTime`	`long`: the time the test ended, measured via `System.currentTimeMillis()`
`testMetrics`	: a `ERROR(/Map)` of the metrics emitted

testEnded

public void testEnded (TestDescription test, 
                 testMetrics)

Reports the execution end of an individual test case.

If testFailed(TestDescription, 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`	`TestDescription`: identifies the test
`testMetrics`	: a `ERROR(/Map)` of the metrics emitted

testFailed

public void testFailed (TestDescription test, 
                String trace)

Reports the failure of a individual test case.

Will be called between testStarted and testEnded.

Parameters
`test`	`TestDescription`: identifies the test
`trace`	`String`: stack trace of failure

testIgnored

public void testIgnored (TestDescription test)

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

Parameters
`test`	`TestDescription`: identifies the test

testRunEnded

public void testRunEnded (long elapsedTimeMillis, 
                 runMetrics)

Reports end of test run. FIXME: We cannot have two Map<> interfaces with different type, so we have to use HashMap here.

Parameters
`elapsedTimeMillis`	`long`: device reported elapsed time, in milliseconds
`runMetrics`	: key-value pairs reported at the end of a test run with `Metric`.

testRunFailed

public void testRunFailed (String errorMessage)

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

Parameters
`errorMessage`	`String`: `String` describing reason for run failure.

testRunStarted

public void testRunStarted (String runName, 
                int testCount, 
                int attemptNumber)

Reports the start of a test run.

Parameters
`runName`	`String`: the test run name
`testCount`	`int`: total number of tests in test run
`attemptNumber`	`int`: order number, identifying the different attempts of the same runName that run multiple times. The attemptNumber is 0-indexed and should increment everytime a new run happens. e.g. A test is granular retried 3 times, it should have 4 total runs under the same runName and the attemptNumber is from 0 to 3.

testRunStarted

public void testRunStarted (String runName, 
                int testCount)

Reports the start of a test run.

Parameters
`runName`	`String`: the test run name
`testCount`	`int`: total number of tests in test run

testRunStarted

public void testRunStarted (String runName, 
                int testCount, 
                int attemptNumber, 
                long startTime)

Reports the start of a test run.

Parameters
`runName`	`String`: the test run name
`testCount`	`int`: total number of tests in test run
`attemptNumber`	`int`: order number, identifying the different attempts of the same runName that run multiple times. The attemptNumber is 0-indexed and should increment everytime a new run happens. e.g. A test is granular retried 3 times, it should have 4 total runs under the same runName and the attemptNumber is from 0 to 3.
`startTime`	`long`: the time the run started, measured via `System.currentTimeMillis()`

testRunStopped

public void testRunStopped (long elapsedTime)

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

TODO: currently unused, consider removing

Parameters
`elapsedTime`	`long`: device reported elapsed time, in milliseconds

testStarted

public void testStarted (TestDescription test, 
                long startTime)

Alternative to testStarted(com.android.tradefed.result.TestDescription) where we also specify when the test was started, combined with ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map)) for accurate measure.

Parameters
`test`	`TestDescription`: identifies the test
`startTime`	`long`: the time the test started, measured via `System.currentTimeMillis()`

testStarted

public void testStarted (TestDescription test)

Reports the start of an individual test case. Older interface, should use testStarted(com.android.tradefed.result.TestDescription) whenever possible.

Parameters
`test`	`TestDescription`: identifies the test