SubprocessResultsReporter

public class SubprocessResultsReporter
extends Object implements ITestInvocationListener, ILogSaverListener, AutoCloseable

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


Implements ITestInvocationListener to be specified as a result_reporter and forward from the subprocess the results of tests, test runs, test invocations.

Summary

Public constructors

SubprocessResultsReporter()

Public methods

void close()

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(Throwable cause)

Reports an incomplete invocation due to some error condition.

void invocationStarted(IInvocationContext context)

Reports the start of the test invocation.

void logAssociation(String dataName, LogFile logFile)

In some cases, log must be strongly associated with a test cases, but the opportunity to do so on the direct testLogSaved(String, LogDataType, InputStreamSource, LogFile) callback is not possible.

void printEvent(String key, Object event)

Helper to print the event key and then the json object.

void setLogSaver(ILogSaver logSaver)

Set the ILogSaver to allow the implementor to save files.

void testAssumptionFailure(TestDescription testId, String trace)

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

void testEnded(TestDescription testId, HashMap<String, MetricMeasurement.Metric> metrics)

Reports the execution end of an individual test case.

void testEnded(TestDescription testId, long endTime, HashMap<String, MetricMeasurement.Metric> metrics)

Alternative to testEnded(TestDescription, Map) where we can specify the end time directly.

void testFailed(TestDescription testId, String reason)

Reports the failure of a individual test case.

void testIgnored(TestDescription testId)

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 testLogSaved(String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile)

Called when the test log is saved.

void testModuleEnded()

Reports the end of a module run.

void testModuleStarted(IInvocationContext moduleContext)

Reports the beginning of a module running.

void testRunEnded(long time, HashMap<String, MetricMeasurement.Metric> runMetrics)

Reports end of test run.

void testRunFailed(String reason)

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 arg0)

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

void testStarted(TestDescription testId, long startTime)

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

void testStarted(TestDescription testId)

Reports the start of an individual test case.

Public constructors

SubprocessResultsReporter

public SubprocessResultsReporter ()

Public methods

close

public void close ()

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

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

logAssociation

public void logAssociation (String dataName, 
                LogFile logFile)

In some cases, log must be strongly associated with a test cases, but the opportunity to do so on the direct testLogSaved(String, LogDataType, InputStreamSource, LogFile) callback is not possible. Thus, this callback allows to provide a strong association explicitly.

Parameters
dataName String: The name of the data

logFile LogFile: the LogFile that was logged before and should be associated with the test case.

printEvent

public void printEvent (String key, 
                Object event)

Helper to print the event key and then the json object.

Parameters
key String

event Object

setLogSaver

public void setLogSaver (ILogSaver logSaver)

Set the ILogSaver to allow the implementor to save files.

Parameters
logSaver ILogSaver: the ILogSaver

testAssumptionFailure

public void testAssumptionFailure (TestDescription testId, 
                String trace)

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

Parameters
testId TestDescription: identifies the test

trace String: stack trace of failure

testEnded

public void testEnded (TestDescription testId, 
                HashMap<String, MetricMeasurement.Metric> metrics)

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
testId TestDescription: identifies the test

metrics HashMap: a ERROR(/Map) of the metrics emitted

testEnded

public void testEnded (TestDescription testId, 
                long endTime, 
                HashMap<String, MetricMeasurement.Metric> metrics)

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

Parameters
testId TestDescription: identifies the test

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

metrics HashMap: a ERROR(/Map) of the metrics emitted

testFailed

public void testFailed (TestDescription testId, 
                String reason)

Reports the failure of a individual test case.

Will be called between testStarted and testEnded.

Parameters
testId TestDescription: identifies the test

reason String: stack trace of failure

testIgnored

public void testIgnored (TestDescription testId)

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

Parameters
testId 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 ITestInvocationListener.invocationFailed(Throwable) or 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.

testLogSaved

public void testLogSaved (String dataName, 
                LogDataType dataType, 
                InputStreamSource dataStream, 
                LogFile logFile)

Called when the test log is saved.

Should be used in place of ITestLogger.testLog(String, LogDataType, InputStreamSource).

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.

logFile LogFile: the LogFile containing the meta data of the saved file.

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.

testRunEnded

public void testRunEnded (long time, 
                HashMap<String, MetricMeasurement.Metric> runMetrics)

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

Parameters
time long: device reported elapsed time, in milliseconds

runMetrics HashMap: key-value pairs reported at the end of a test run with MetricMeasurement.Metric.

testRunFailed

public void testRunFailed (String reason)

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

Parameters
reason String: String describing reason for run failure.

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

testRunStopped

public void testRunStopped (long arg0)

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

TODO: currently unused, consider removing

Parameters
arg0 long: device reported elapsed time, in milliseconds

testStarted

public void testStarted (TestDescription testId, 
                long startTime)

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

Parameters
testId TestDescription: identifies the test

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

testStarted

public void testStarted (TestDescription testId)

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

Parameters
testId TestDescription: identifies the test