ITestInvocationListener

public interface ITestInvocationListener
implements ITestLogger, ITestLifeCycleReceiver

com.android.tradefed.result.ITestInvocationListener

Known indirect subclasses

AggregatePostProcessor, AtraceCollector, AtraceRunMetricCollector, AveragePostProcessor, BaseDeviceMetricCollector, BasePostProcessor, BuddyInfoMetricCollector, BugreportCollector, BugreportzMetricCollector, BugreportzOnFailureCollector, CollectingTestListener, ConsoleResultReporter, DebugHostLogOnFailureCollector, DeviceUnavailEmailResultReporter, DumpHeapCollector, and 57 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.
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.

Listener for test results from the test invocation.

A test invocation can itself include multiple test runs, so the sequence of calls will be

invocationStarted(BuildInfo)
testRunStarted
testStarted
[testFailed]
testEnded
...
testRunEnded
...
testRunStarted
...
testRunEnded
[invocationFailed]
[testLog+]
invocationEnded
getSummary

Summary

Public methods
`default TestSummary`	`getSummary()` Allows the InvocationListener to return a summary.
`default void`	`invocationEnded(long elapsedTime)` Reports that the invocation has terminated, whether successfully or due to some error condition.
`default void`	`invocationFailed(Throwable cause)` Reports an incomplete invocation due to some error condition.
`default void`	`invocationInterrupted()` Called on `ICommandScheduler#shutdown()`, gives the invocation the opportunity to do something before terminating.
`default void`	`invocationStarted(IInvocationContext context)` Reports the start of the test invocation.
`default void`	`testModuleEnded()` Reports the end of a module run.
`default void`	`testModuleStarted(IInvocationContext moduleContext)` Reports the beginning of a module running.

Public methods

getSummary

public TestSummary getSummary ()

Allows the InvocationListener to return a summary.

Returns
`TestSummary`	A `TestSummary` summarizing the run, or null

invocationEnded

public void invocationEnded (long elapsedTime)

Reports that the invocation has terminated, whether successfully or due to some error condition.

Will be automatically called by the TradeFederation framework.

Parameters
`elapsedTime`	`long`: the elapsed time of the invocation in ms

invocationFailed

public void invocationFailed (Throwable cause)

Reports an incomplete invocation due to some error condition.

Will be automatically called by the TradeFederation framework.

Parameters
`cause`	`Throwable`: the `Throwable` cause of the failure

invocationInterrupted

public void invocationInterrupted ()

Called on ICommandScheduler#shutdown(), gives the invocation the opportunity to do something before terminating.

invocationStarted

public void invocationStarted (IInvocationContext context)

Reports the start of the test invocation.

Will be automatically called by the TradeFederation framework. Reporters need to override this method to support multiple devices reporting.

Parameters
`context`	`IInvocationContext`: information about the invocation

testModuleEnded

public void testModuleEnded ()

Reports the end of a module run.

testModuleStarted

public void testModuleStarted (IInvocationContext moduleContext)

Reports the beginning of a module running. This callback is associated with testModuleEnded() and is optional in the sequence. It is only used during a run that uses modules: ITestSuite based runners.

Parameters
`moduleContext`	`IInvocationContext`: the `IInvocationContext` of the module.