Starting March 27, 2025, we recommend using android-latest-release instead of aosp-main to build and contribute to AOSP. For more information, see Changes to AOSP.

ModuleListener

public class ModuleListener
extends CollectingTestListener

java.lang.Object
↳	com.android.tradefed.result.CollectingTestListener
	↳	com.android.tradefed.testtype.suite.ModuleListener

Listener attached to each IRemoteTest of each module in order to collect the list of results.

Summary

Public constructors
`ModuleListener(ITestInvocationListener listener, IInvocationContext moduleContext)` Constructor.

Public methods
`boolean`	`hasLastAttemptFailed()` Returns whether or not the listener last retry session has failed.
`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, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile)` callback is not possible.
`void`	`setAttemptIsolation(CurrentInvocation.IsolationGrade isolation)` Sets whether or not the attempt should be reported as isolated.
`void`	`setCollectTestsOnly(boolean collectTestsOnly)` Sets whether or not we are only collecting the tests.
`void`	`setMarkTestsSkipped(boolean skip)` Whether or not to mark all the test cases skipped.
`void`	`setTestMappingSources( testMappingSources)` Sets test-mapping sources that will be inserted into metrics.
`void`	`setUseModuleResultsForwarder(boolean useModuleResultsForwarder)`
`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)`
`void`	`testLogSaved(String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile)`
`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 name, int numTests, int attemptNumber)` Reports the start of a test run.
`void`	`testRunStarted(String name, int numTests, 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.

Public constructors

ModuleListener

public ModuleListener (ITestInvocationListener listener, 
                IInvocationContext moduleContext)

Constructor.

Parameters
`listener`	`ITestInvocationListener`
`moduleContext`	`IInvocationContext`

Public methods

hasLastAttemptFailed

public boolean hasLastAttemptFailed ()

Returns whether or not the listener last retry session has failed.

Returns
`boolean`

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, 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
`logFile`	`LogFile`: the `LogFile` that was logged before and should be associated with the test case.

setAttemptIsolation

public void setAttemptIsolation (CurrentInvocation.IsolationGrade isolation)

Sets whether or not the attempt should be reported as isolated.

Parameters
`isolation`	`CurrentInvocation.IsolationGrade`

setCollectTestsOnly

public void setCollectTestsOnly (boolean collectTestsOnly)

Sets whether or not we are only collecting the tests.

Parameters
`collectTestsOnly`	`boolean`

setMarkTestsSkipped

public void setMarkTestsSkipped (boolean skip)

Whether or not to mark all the test cases skipped.

Parameters
`skip`	`boolean`

setTestMappingSources

public void setTestMappingSources ( testMappingSources)

Sets test-mapping sources that will be inserted into metrics.

Parameters
`testMappingSources`

setUseModuleResultsForwarder

public void setUseModuleResultsForwarder (boolean useModuleResultsForwarder)

Parameters
`useModuleResultsForwarder`	`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, 
                 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)

Parameters
`dataName`	`String`
`dataType`	`LogDataType`
`dataStream`	`InputStreamSource`

testLogSaved

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

Parameters
`dataName`	`String`
`dataType`	`LogDataType`
`dataStream`	`InputStreamSource`
`logFile`	`LogFile`

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 name, 
                int numTests, 
                int attemptNumber)

Reports the start of a test run.

Parameters
`name`	`String`: the test run name
`numTests`	`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 name, 
                int numTests, 
                int attemptNumber, 
                long startTime)

Reports the start of a test run.

Parameters
`name`	`String`: the test run name
`numTests`	`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()`