ResultForwarder

public class ResultForwarder
extends Object implements ITestInvocationListener

java.lang.Object
↳	com.android.tradefed.result.ResultForwarder

Known direct subclasses

FilteredResultForwarder, JarHostTest.HostTestListener, LogSaverResultForwarder, LogcatCrashResultForwarder, PythonBinaryHostTest.PythonForwarder, ResultAndLogForwarder, RetryResultForwarder, ShardMainResultForwarder, TestTimeoutEnforcer

FilteredResultForwarder	Variant of `ResultForwarder` that only allows an allowlist of `TestDescription` to be reported.
JarHostTest.HostTestListener	Wrapper listener that forwards all events except testRunStarted() and testRunEnded() to the embedded listener.
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.
PythonBinaryHostTest.PythonForwarder	Result forwarder to replace the run name by the binary name.
ResultAndLogForwarder	Forwarder for results and logs events.
RetryResultForwarder	An Extension of `ResultForwarder` that always push to a given attempt number.
ShardMainResultForwarder	A `ResultForwarder` that combines the results of a sharded test invocations.
TestTimeoutEnforcer	Listeners that allows to check the execution time of a given test case and fail it if it goes over a given timeout.

Known indirect subclasses

GranularRetriableTestWrapper.StartEndCollector, RetryLogSaverResultForwarder

GranularRetriableTestWrapper.StartEndCollector	Class helper to catch missing run start and end.
RetryLogSaverResultForwarder	Forwarder that also handles passing the current attempt we are at.

A ITestInvocationListener that forwards invocation results to a list of other listeners.

Summary

Public constructors
`ResultForwarder(ITestInvocationListener... listeners)` Alternate variable arg constructor for `ResultForwarder`.
`ResultForwarder( listeners)` Create a `ResultForwarder`.

Protected constructors
`ResultForwarder()` Create a `ResultForwarder` with deferred listener setting.

Public methods
`TestSummary`	`getSummary()` Allows the InvocationListener to return a summary.
`void`	`invocationEnded(long elapsedTime)` Reports that the invocation has terminated, whether successfully or due to some error condition.
`void`	`invocationFailed(FailureDescription failure)` Reports an incomplete invocation due to some error condition.
`void`	`invocationFailed(Throwable cause)` Reports an incomplete invocation due to some error condition.
`void`	`invocationSkipped(SkipReason reason)` Reports an invocation as skipped
`void`	`invocationStarted(IInvocationContext context)` Reports the start of the test invocation.
`void`	`testAssumptionFailure(TestDescription test, String trace)` Called when an atomic test flags that it assumes a condition that is false
`void`	`testAssumptionFailure(TestDescription test, FailureDescription failure)` Called when an atomic test flags that it assumes a condition that is false
`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.
`void`	`testEnded(TestDescription test, testMetrics)` Reports the execution end of an individual test case.
`void`	`testFailed(TestDescription test, FailureDescription failure)` Reports the failure of a individual test case.
`void`	`testFailed(TestDescription test, String trace)` Reports the failure of a individual test case.
`void`	`testIgnored(TestDescription test)` Called when a test will not be run, generally because a test method is annotated with org.junit.Ignore.
`void`	`testLog(String dataName, LogDataType dataType, InputStreamSource dataStream)` Provides the associated log or debug data from the test invocation.
`void`	`testModuleEnded()` Reports the end of a module run.
`void`	`testModuleStarted(IInvocationContext moduleContext)` Reports the beginning of a module running.
`void`	`testRunEnded(long elapsedTime, runMetrics)` Reports end of test run.
`void`	`testRunFailed(FailureDescription failure)` Reports test run failed to complete due to a failure described by `FailureDescription`.
`void`	`testRunFailed(String errorMessage)` Reports test run failed to complete due to a fatal error.
`void`	`testRunStarted(String runName, int testCount, int attemptNumber)` Reports the start of a test run.
`void`	`testRunStarted(String runName, int testCount)` Reports the start of a test run.
`void`	`testRunStarted(String runName, int testCount, int attemptNumber, long startTime)` Reports the start of a test run.
`void`	`testRunStopped(long elapsedTime)` Reports test run stopped before completion due to a user request.
`void`	`testSkipped(TestDescription test, SkipReason reason)` Called when a test is skipped and did not execute for a reason that is not usually expected.
`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.
`void`	`testStarted(TestDescription test)` Reports the start of an individual test case.

Protected methods
	`getListeners()` Get the list of listeners.
`void`	`setListeners(ITestInvocationListener... listeners)` Set the listeners after construction.
`void`	`setListeners( listeners)` Set the listeners after construction.

Public constructors

ResultForwarder

public ResultForwarder (ITestInvocationListener... listeners)

Alternate variable arg constructor for ResultForwarder.

Parameters
`listeners`	`ITestInvocationListener`: the real `ITestInvocationListener`s to forward results to

ResultForwarder

public ResultForwarder ( listeners)

Create a ResultForwarder.

Parameters
`listeners`	: the real `ITestInvocationListener`s to forward results to

Protected constructors

ResultForwarder

protected ResultForwarder ()

Create a ResultForwarder with deferred listener setting. Intended only for use by subclasses.

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 (FailureDescription failure)

Reports an incomplete invocation due to some error condition.

Will be automatically called by the TradeFederation framework.

Parameters
`failure`	`FailureDescription`: the `FailureDescription` describing the cause of the failure

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

invocationSkipped

public void invocationSkipped (SkipReason reason)

Reports an invocation as skipped

Parameters
`reason`	`SkipReason`

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

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

testAssumptionFailure

public void testAssumptionFailure (TestDescription test, 
                FailureDescription failure)

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

Parameters
`test`	`TestDescription`: identifies the test
`failure`	`FailureDescription`: `FailureDescription` describing the failure and its context.

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, FailureDescription) 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, 
                FailureDescription failure)

Reports the failure of a individual test case.

Will be called between testStarted and testEnded.

Parameters
`test`	`TestDescription`: identifies the test
`failure`	`FailureDescription`: `FailureDescription` describing the failure and its context.

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

testLog

public void testLog (String dataName, 
                LogDataType dataType, 
                InputStreamSource dataStream)

Provides the associated log or debug data from the test invocation.

Must be called before ERROR(/ITestInvocationListener#invocationFailed(Throwable)) or ERROR(/ITestInvocationListener#invocationEnded(long))

The TradeFederation framework will automatically call this method, providing the host log and if applicable, the device logcat.

Parameters
`dataName`	`String`: a `String` descriptive name of the data. e.g. "device_logcat". Note dataName may not be unique per invocation. ie implementers must be able to handle multiple calls with same dataName
`dataType`	`LogDataType`: the `LogDataType` of the data
`dataStream`	`InputStreamSource`: the `InputStreamSource` of the data. Implementers should call createInputStream to start reading the data, and ensure to close the resulting InputStream when complete. Callers should ensure the source of the data remains present and accessible until the testLog method completes.

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: suite based runners.

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

testRunEnded

public void testRunEnded (long elapsedTime, 
                 runMetrics)

Reports end of test run.

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

testRunFailed

public void testRunFailed (FailureDescription failure)

Reports test run failed to complete due to a failure described by FailureDescription.

Parameters
`failure`	`FailureDescription`: `FailureDescription` describing the failure and its context.

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

testSkipped

public void testSkipped (TestDescription test, 
                SkipReason reason)

Called when a test is skipped and did not execute for a reason that is not usually expected. These tests will be attempted to be retried to attempt to get a proper execution.

Parameters
`test`	`TestDescription`: identifies the test
`reason`	`SkipReason`: `SkipReason`

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

Protected methods

getListeners

protected  getListeners ()

Get the list of listeners. Intended only for use by subclasses.

Returns
	The list of `ITestInvocationListener`s.

setListeners

protected void setListeners (ITestInvocationListener... listeners)

Set the listeners after construction. Intended only for use by subclasses.

Parameters
`listeners`	`ITestInvocationListener`: the real `ITestInvocationListener`s to forward results to

setListeners

protected void setListeners ( listeners)

Set the listeners after construction. Intended only for use by subclasses.

Parameters
`listeners`	: the real `ITestInvocationListener`s to forward results to