ResultReporter

public class ResultReporter
extends Object implements IConfigurationReceiver, ILogSaverListener, ISupportGranularResults, ITestSummaryListener

java.lang.Object
↳	com.google.android.tradefed.result.teststorage.ResultReporter

---

Summary

Nested classes
class	ResultReporter.ListBuilder<T>

Constants
String	DEFAULT_BUILDPROVIDER
String	EXPERIMENTAL
String	SYSTEM_CHECKER
String	TRADEFED

Public constructors
ResultReporter()

Public methods
void	enableFilterProperty(boolean enableFilterProperty)
IConfiguration	getConfiguration()
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	logAssociation(String dataName, LogFile log) In some cases, log must be strongly associated with a test cases, but the opportunity to do so on the direct testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile) callback is not possible.
void	putEarlySummary( summaries) Passes a ERROR(/List) of non-null TestSummarys which may have been returned from any ITestInvocationListeners instantiated as part of the configuration.
void	setConfiguration(IConfiguration configuration) Injects the IConfiguration in use.
void	setLogSaver(ILogSaver logSaver) Set the ILogSaver to allow the implementor to save files.
boolean	supportGranularResults() Returns True if the reporter support granular results, false otherwise.
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, metrics) 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	testModuleEnded() Reports the end of a module run.
void	testModuleStarted(IInvocationContext moduleContext) Reports the beginning of a module running.
void	testRunEnded(long elapsedTimeMillis, 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	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
ITestStorageClient	createTestStorageClient(IInvocationContext context)
String	getVersion()

Constants

DEFAULT_BUILDPROVIDER

public static final String DEFAULT_BUILDPROVIDER

Constant Value: "androidbuild"

EXPERIMENTAL

public static final String EXPERIMENTAL

Constant Value: "experimental"

SYSTEM_CHECKER

public static final String SYSTEM_CHECKER

Constant Value: "system_checker"

TRADEFED

public static final String TRADEFED

Constant Value: "tradefed"

Public constructors

ResultReporter

public ResultReporter ()

Public methods

enableFilterProperty

public void enableFilterProperty (boolean enableFilterProperty)

Parameters
enableFilterProperty	boolean

getConfiguration

public IConfiguration getConfiguration ()

Returns
IConfiguration

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

logAssociation

public void logAssociation (String dataName, 
                LogFile log)

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

Parameters
dataName	String: The name of the data
log	LogFile: the LogFile that was logged before and should be associated with the test case.

putEarlySummary

public void putEarlySummary ( summaries)

Passes a ERROR(/List) of non-null TestSummarys which may have been returned from any ITestInvocationListeners instantiated as part of the configuration. The early summaries are generated after ITestInvocationListener.invocationStarted(com.android.tradefed.invoker.IInvocationContext) and can be completed at the end of the invocation via ERROR(/#putSummary(List)).

This is called before ITestInvocationListener.invocationStarted(com.android.tradefed.invoker.IInvocationContext) and contains all the summaries from the listeners configured before it.

Parameters
summaries	: A ERROR(/List) of non-null TestSummarys from ITestInvocationListeners that are part of the current configuration.

setConfiguration

public void setConfiguration (IConfiguration configuration)

Injects the IConfiguration in use.

Parameters
configuration	IConfiguration

setLogSaver

public void setLogSaver (ILogSaver logSaver)

Set the ILogSaver to allow the implementor to save files.

Parameters
logSaver	ILogSaver: the ILogSaver

supportGranularResults

public boolean supportGranularResults ()

Returns True if the reporter support granular results, false otherwise.

Returns
boolean

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, 
                 metrics)

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
metrics	: 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

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 elapsedTimeMillis, 
                 runMetrics)

Reports end of test run.

Parameters
elapsedTimeMillis	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()

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

createTestStorageClient

protected ITestStorageClient createTestStorageClient (IInvocationContext context)

Parameters
context	IInvocationContext

Returns
ITestStorageClient

getVersion

protected String getVersion ()

Returns
String