СборTestListener

public class CollectingTestListener
extends Object implements ITestInvocationListener , ILogSaverListener , IDisableable

java.lang.Объект
↳	com.android.tradefed.result.CollectingTestListener

Известные прямые подклассы JsonHttpTestResultReporter , LUCIResultReporter , MetricsXMLResultReporter , ModuleListener , ReportPassedTests , ResultAggregator , ShardListener , SuiteResultReporter , XmlResultReporter JsonHttpTestResultReporter Отчет о результатах, который кодирует результаты тестовых показателей и разветвляет информацию об устройстве в JSON и POST в конечную точку службы HTTP. LUCIResultReporter Средство создания отчетов о результатах, которое сохраняет результаты тестов, необходимые для ResultDB и LUCI, в формате JSON (go/result-sink) и регистрирует расположение файла в консоли. МетриксXMLResultReporter MetricsXMLResultReporter записывает тестовые метрики и запускает метрики в XML-файл в папке, указанной параметром metrics-folder на этапе invoctionEnded теста. МодульПрослушиватель Слушатель, прикрепленный к каждому IRemoteTest каждого модуля для сбора списка результатов. ОтчетПройденоТесты Сообщите в файле о возможных фильтрах для исключения пройденного теста. Агрегатор результатов Специальный сервер пересылки, который при необходимости объединяет результаты на основе выбранной стратегии повторных попыток. ShardListener ITestInvocationListener , который собирает результаты из сегмента вызова (так называемого разделения вызовов для параллельного выполнения на нескольких ресурсах) и пересылает их другому прослушивателю. SuiteResultReporter Соберите результаты тестирования для всего вызова пакета и выведите окончательные результаты. XmlResultReporter Записывает результаты JUnit в XML-файлы в формате, соответствующем Ant XMLJUnitResultFormatter.

Известные косвенные подклассы FormattedGeneratorReporter , XmlFormattedGeneratorReporter ФорматированныйГенераторРепортер Reporter, позволяющий генерировать отчеты в определенном формате. XmlFormattedGeneratorReporter Реализация FormattedGeneratorReporter , который форматирует набор, приводит к формату xml.

---

ITestInvocationListener , который будет собирать все результаты тестов.

Хотя структуры данных, используемые в этом объекте, являются потокобезопасными, обратные вызовы ITestInvocationListener должны вызываться в правильном порядке.

Краткое содержание

Общественные конструкторы
CollectingTestListener ()

Публичные методы
IBuildInfo	getBuildInfo () Этот метод устарел. полагайтесь на IBuildInfo из getInvocationContext() .
TestRunResult	getCurrentRunResults () Получает результаты текущего тестового запуска.
int	getExpectedTests () Возвращает количество ожидаемых тестов.
IInvocationContext	getInvocationContext () Вернуть контекст вызова, о котором было сообщено через invocationStarted(com.android.tradefed.invoker.IInvocationContext)
	getMergedTestRunResults () Возвращает объединенную коллекцию результатов для всех запусков с разными попытками.
IInvocationContext	getModuleContextForRunResult (String testRunName) Возвращает IInvocationContext модуля, связанного с результатами.
MultiMap <String, LogFile >	getModuleLogFiles () Возвращает копию карты, содержащей все зарегистрированные файлы, связанные с модулем.
MultiMap <String, LogFile >	getNonAssociatedLogFiles () Возвращает копию карты, содержащую все зарегистрированные файлы, не связанные с тестовым запуском или модулем.
int	getNumAllFailedTestRuns () Возвращает общее количество запусков тестов в состоянии сбоя.
int	getNumAllFailedTests () Возвращает общее количество тестов в состоянии сбоя (только неудачные, неудачные предположения не учитываются).
int	getNumTestsInState ( TestStatus status) Возвращает количество тестов в данном состоянии для этого запуска.
int	getNumTestsInState (TestResult.TestStatus ddmlibStatus) Для совместимости со старым типом статуса
int	getNumTotalTests () Возвращает общее количество полных тестов для всех запусков.
IBuildInfo	getPrimaryBuildInfo () Верните основную информацию о сборке, переданную через invocationStarted(com.android.tradefed.invoker.IInvocationContext) .
	getRunResults () Этот метод устарел. Используйте getMergedTestRunResults()
TestRunResult	getTestRunAtAttempt (String testRunName, int attempt) Верните TestRunResult для одной попытки.
int	getTestRunAttemptCount (String testRunName) Возвращает количество попыток для заданного имени запуска теста.
	getTestRunAttempts (String testRunName) Получает все попытки TestRunResult данного запуска теста.
	getTestRunForAttempts (int attempt) Получает все результаты для данной попытки.
	getTestRunNames () Верните все имена для всех запусков тестов.
boolean	hasFailedTests () Возвращает, если при вызове были какие-либо неудачные или предположительные тесты.
boolean	hasTestRunResultsForName (String testRunName) Возвращает, есть ли какие-либо результаты для данного имени запуска теста.
void	invocationEnded (long elapsedTime) Сообщает, что вызов завершился успешно или из-за какой-либо ошибки.
void	invocationFailed (Throwable cause) Сообщает о неполном вызове из-за какой-либо ошибки.
void	invocationSkipped ( SkipReason reason) Сообщает о пропущенном вызове
void	invocationStarted ( IInvocationContext context) Сообщает о начале тестового вызова.
boolean	isDisabled () Возвращает True, если весь объект отключен (пропускает как установку, так и демонтаж).
void	logAssociation (String dataName, LogFile logFile) В некоторых случаях журнал должен быть тесно связан с тестовыми примерами, но возможность сделать это напрямую testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile) обратный вызов невозможен.
void	setBuildInfo ( IBuildInfo buildInfo) Этот метод устарел. Для тестирования больше не требуется.
void	setDisable (boolean isDisabled) Устанавливает, должен ли объект быть отключен.
void	setMergeStrategy ( MergeStrategy strategy) Устанавливает MergeStrategy , который будет использоваться при объединении результатов.
void	testAssumptionFailure ( TestDescription test, String trace) Вызывается, когда атомарный тест отмечает, что он предполагает ложное условие.
void	testAssumptionFailure ( TestDescription test, FailureDescription failure) Вызывается, когда атомарный тест отмечает, что он предполагает ложное условие.
void	testEnded ( TestDescription test, long endTime, testMetrics) testEnded ( TestDescription test, long endTime, testMetrics) Альтернатива ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)) где мы можем напрямую указать время окончания.
void	testEnded ( TestDescription test, testMetrics) testEnded ( TestDescription test, testMetrics) Сообщает об окончании выполнения отдельного тестового примера.
void	testFailed ( TestDescription test, FailureDescription failure) Сообщает о сбое отдельного тестового примера.
void	testFailed ( TestDescription test, String trace) Сообщает о сбое отдельного тестового примера.
void	testIgnored ( TestDescription test) Вызывается, когда тест не будет запускаться, обычно потому, что метод теста помечен с помощью org.junit.Ignore.
void	testModuleEnded () Сообщает об окончании выполнения модуля.
void	testModuleStarted ( IInvocationContext moduleContext) Сообщает о начале работы модуля.
void	testRunEnded (long elapsedTime, runMetrics) testRunEnded (long elapsedTime, runMetrics) Сообщает об окончании тестового запуска.
void	testRunFailed ( FailureDescription failure) Тестовый запуск отчетов не удалось завершить из-за сбоя, описанного в FailureDescription .
void	testRunFailed (String errorMessage) Тестовый запуск отчетов не удалось завершить из-за фатальной ошибки.
void	testRunStarted (String name, int numTests, int attemptNumber) Сообщает о начале тестового запуска.
void	testRunStarted (String name, int numTests) Сообщает о начале тестового запуска.
void	testRunStarted (String name, int numTests, int attemptNumber, long startTime) Сообщает о начале тестового запуска.
void	testRunStopped (long elapsedTime) Тестовый запуск отчетов остановлен до завершения по запросу пользователя.
void	testSkipped ( TestDescription test, SkipReason reason) Вызывается, когда тест пропускается и не выполняется по причине, которая обычно не ожидается.
void	testStarted ( TestDescription test, long startTime) Альтернатива testStarted(com.android.tradefed.result.TestDescription) , где мы также указываем, когда тест был запущен, в сочетании с ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map)) для точного измерения. .
void	testStarted ( TestDescription test) Сообщает о начале отдельного тестового примера.

Защищенные методы
final void	clearModuleLogFiles () Позволяет очистить файл модуля, чтобы не носить его слишком долго.
final void	clearResultsForName (String testRunName) Позволяет очистить результаты для заданного имени запуска.
void	setIsAggregrateMetrics (boolean aggregate) Включите опцию «агрегированные показатели»

Общественные конструкторы

СборTestListener

public CollectingTestListener ()

Публичные методы

getBuildInfo

public IBuildInfo getBuildInfo ()

Этот метод устарел.
полагайтесь на IBuildInfo из getInvocationContext() .

Возвращает информацию о сборке.

Возврат
IBuildInfo

getCurrentRunResults

public TestRunResult getCurrentRunResults ()

Получает результаты текущего тестового запуска.

Обратите внимание, что результаты могут быть неполными. Перед обработкой результатов рекомендуется проверить значение TestRunResult.isRunComplete() и/или (@link TestRunResult#isRunFailure()}, если это необходимо.

Возврат
TestRunResult	TestRunResult , представляющий данные, собранные во время последнего запуска теста

GetExpectedTests

public int getExpectedTests ()

Возвращает количество ожидаемых тестов. Может отличаться от getNumTotalTests() если некоторые тесты не запускались.

Возврат
int

getInvoctionContext

public IInvocationContext getInvocationContext ()

Вернуть контекст вызова, о котором было сообщено через invocationStarted(com.android.tradefed.invoker.IInvocationContext)

Возврат
IInvocationContext

getMergedTestRunResults

public  getMergedTestRunResults ()

Возвращает объединенную коллекцию результатов для всех запусков с разными попытками.

Если имеется несколько результатов, каждый запуск теста объединяется, при этом последний результат теста перезаписывает результаты предыдущих запусков. Тестовые запуски упорядочены по номеру попытки.

Метрики для одной и той же попытки будут объединены на основе предпочтений, установленных aggregate-metrics . Итоговыми метриками будут метрики последней попытки.

Возврат

getModuleContextForRunResult

public IInvocationContext getModuleContextForRunResult (String testRunName)

Возвращает IInvocationContext модуля, связанного с результатами.

Параметры
testRunName	String : имя, заданное { testRunStarted(String, int) .

Возврат
IInvocationContext	IInvocationContext модуля для данного имени запуска теста null , если для этого имени нет результатов.

GetModuleLogFiles

public MultiMap<String, LogFile> getModuleLogFiles ()

Возвращает копию карты, содержащей все зарегистрированные файлы, связанные с модулем.

Возврат
MultiMap <String, LogFile >

getNonAssociatedLogFiles

public MultiMap<String, LogFile> getNonAssociatedLogFiles ()

Возвращает копию карты, содержащей все зарегистрированные файлы, не связанные с тестовым запуском или модулем.

Возврат
MultiMap <String, LogFile >

getNumAllFailedTestRuns

public int getNumAllFailedTestRuns ()

Возвращает общее количество запусков тестов в состоянии сбоя.

Возврат
int

getNumAllFailedTests

public int getNumAllFailedTests ()

Возвращает общее количество тестов в состоянии сбоя (только неудачные, неудачные предположения не учитываются).

Возврат
int

getNumTestsInState

public int getNumTestsInState (TestStatus status)

Возвращает количество тестов в данном состоянии для этого запуска.

Параметры
status	TestStatus

Возврат
int

getNumTestsInState

public int getNumTestsInState (TestResult.TestStatus ddmlibStatus)

Для совместимости со старым типом статуса

Параметры
ddmlibStatus	TestResult.TestStatus

Возврат
int

getNumTotalTests

public int getNumTotalTests ()

Возвращает общее количество полных тестов для всех запусков.

Возврат
int

getPrimaryBuildInfo

public IBuildInfo getPrimaryBuildInfo ()

Верните основную информацию о сборке, переданную через invocationStarted(com.android.tradefed.invoker.IInvocationContext) . Первичная сборка — это сборка, возвращаемая первым поставщиком сборки работающей конфигурации. Возвращает значение null, если контекст отсутствует (нет сборки для тестового примера).

Возврат
IBuildInfo

getRunResults

public  getRunResults ()

Этот метод устарел.
Используйте getMergedTestRunResults()

Возвращает результаты всех тестовых запусков.

Возврат

getTestRunAtAttempt

public TestRunResult getTestRunAtAttempt (String testRunName, 
                int attempt)

Верните TestRunResult для одной попытки.

Параметры
testRunName	String : имя, заданное { testRunStarted(String, int) .
attempt	int : идентификатор попытки.

Возврат
TestRunResult	TestRunResult для данного имени и идентификатора попытки или значения null , если он не существует.

getTestRunAttemptCount

public int getTestRunAttemptCount (String testRunName)

Возвращает количество попыток для заданного имени запуска теста.

Параметры
testRunName	String : имя, заданное { testRunStarted(String, int) .

Возврат
int

getTestRunПопытки

public  getTestRunAttempts (String testRunName)

Получает все попытки TestRunResult данного запуска теста.

Параметры
testRunName	String : имя, заданное { testRunStarted(String, int) .

Возврат
	Все TestRunResult для данного запуска теста, отсортированные по попыткам.

getTestRunForAttempts

public  getTestRunForAttempts (int attempt)

Получает все результаты для данной попытки.

Параметры
attempt	int : попытка, для которой мы хотим получить результаты.

Возврат
	Все TestRunResult для данной попытки.

getTestRunNames

public  getTestRunNames ()

Верните все имена для всех запусков тестов.

Эти тестовые запуски могли выполняться несколько раз с разными попытками.

Возврат

имеетFailedTests

public boolean hasFailedTests ()

Возвращает, если при вызове были какие-либо неудачные или предположительные тесты.

Возврат
boolean

хастеструнресултсфорнаме

public boolean hasTestRunResultsForName (String testRunName)

Возвращает, есть ли какие-либо результаты для данного имени запуска теста.

Параметры
testRunName	String : имя, заданное { testRunStarted(String, int) .

Возврат
boolean

вызовЗавершен

public void invocationEnded (long elapsedTime)

Сообщает, что вызов завершился успешно или из-за какой-либо ошибки.

Будет автоматически вызываться платформой TradeFederation.

Параметры
elapsedTime	long : прошедшее время вызова в мс.

вызов не пройден

public void invocationFailed (Throwable cause)

Сообщает о неполном вызове из-за какой-либо ошибки.

Будет автоматически вызываться платформой TradeFederation.

Параметры
cause	Throwable : Throwable причина сбоя

вызовПропущен

public void invocationSkipped (SkipReason reason)

Сообщает о пропущенном вызове

Параметры
reason	SkipReason

вызовНачало

public void invocationStarted (IInvocationContext context)

Сообщает о начале тестового вызова.

Будет автоматически вызываться платформой TradeFederation. Создателям отчетов необходимо переопределить этот метод для поддержки отчетов с нескольких устройств.

Параметры
context	IInvocationContext : информация о вызове.

выключен

public boolean isDisabled ()

Возвращает True, если весь объект отключен (пропускает как установку, так и демонтаж). В противном случае неверно.

Возврат
boolean

logAssociation

public void logAssociation (String dataName, 
                LogFile logFile)

В некоторых случаях журнал должен быть тесно связан с тестовыми примерами, но возможность сделать это напрямую testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile) обратный вызов невозможен. Таким образом, этот обратный вызов позволяет явно обеспечить сильную ассоциацию.

Параметры
dataName	String : имя данных.
logFile	LogFile : LogFile , который был зарегистрирован ранее и должен быть связан с тестовым примером.

setBuildInfo

public void setBuildInfo (IBuildInfo buildInfo)

Этот метод устарел.
Для тестирования больше не требуется.

Установите информацию о сборке. Следует использовать только для тестирования.

Параметры
buildInfo	IBuildInfo

УстановитьОтключить

public void setDisable (boolean isDisabled)

Устанавливает, должен ли объект быть отключен. Отключено означает, что шаги установки и демонтажа следует пропустить. Может использоваться для отключения объекта по умолчанию в конструкторе по умолчанию.

Параметры
isDisabled	boolean : состояние, в которое должен быть переведен объект.

setMergeStrategy

public void setMergeStrategy (MergeStrategy strategy)

Устанавливает MergeStrategy , который будет использоваться при объединении результатов.

Параметры
strategy	MergeStrategy

тестПредположениеОтказ

public void testAssumptionFailure (TestDescription test, 
                String trace)

Вызывается, когда атомарный тест отмечает, что он предполагает ложное условие.

Параметры
test	TestDescription : идентифицирует тест.
trace	String : трассировка стека сбоя.

тестПредположениеОтказ

public void testAssumptionFailure (TestDescription test, 
                FailureDescription failure)

Вызывается, когда атомарный тест отмечает, что он предполагает ложное условие.

Параметры
test	TestDescription : идентифицирует тест.
failure	FailureDescription : FailureDescription , описывающая сбой и его контекст.

testEnded

public void testEnded (TestDescription test, 
                long endTime, 
                 testMetrics)

Альтернатива ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)) где мы можем напрямую указать время окончания. Объедините его с testStarted(com.android.tradefed.result.TestDescription, long) для точного измерения.

Параметры
test	TestDescription : идентифицирует тест.
endTime	long : время окончания теста, измеренное с помощью System.currentTimeMillis()
testMetrics	: ERROR(/Map) выданных метрик

testEnded

public void testEnded (TestDescription test, 
                 testMetrics)

Сообщает об окончании выполнения отдельного тестового примера.

Если testFailed(TestDescription, FailureDescription) не был вызван, этот тест пройден. Также возвращает любые метрики ключ/значение, которые могли быть созданы во время выполнения тестового примера.

Параметры
test	TestDescription : идентифицирует тест.
testMetrics	: ERROR(/Map) выданных метрик

тест не пройден

public void testFailed (TestDescription test, 
                FailureDescription failure)

Сообщает о сбое отдельного тестового примера.

Будет вызываться между testStarted и testEnded.

Параметры
test	TestDescription : идентифицирует тест.
failure	FailureDescription : FailureDescription , описывающая сбой и его контекст.

тест не пройден

public void testFailed (TestDescription test, 
                String trace)

Сообщает о сбое отдельного тестового примера.

Будет вызываться между testStarted и testEnded.

Параметры
test	TestDescription : идентифицирует тест.
trace	String : трассировка стека сбоя.

тестИгнорируется

public void testIgnored (TestDescription test)

Вызывается, когда тест не будет запускаться, обычно потому, что метод теста помечен с помощью org.junit.Ignore.

Параметры
test	TestDescription : идентифицирует тест.

testModuleEnded

public void testModuleEnded ()

Сообщает об окончании выполнения модуля.

testModuleStarted

public void testModuleStarted (IInvocationContext moduleContext)

Сообщает о начале работы модуля. Этот обратный вызов связан с testModuleEnded() и является необязательным в последовательности. Он используется только во время запуска, в котором используются модули: бегуны на основе набора.

Параметры
moduleContext	IInvocationContext : IInvocationContext модуля.

testRunEnded

public void testRunEnded (long elapsedTime, 
                 runMetrics)

Сообщает об окончании тестового запуска. ИСПРАВЛЕНИЕ: мы не можем иметь два интерфейса Map<> разного типа, поэтому здесь нам придется использовать HashMap.

Параметры
elapsedTime	long : устройство сообщило прошедшее время в миллисекундах.
runMetrics	: пары ключ-значение, зарегистрированные в конце тестового запуска с помощью Metric .

testRunFailed

public void testRunFailed (FailureDescription failure)

Тестовый запуск отчетов не удалось завершить из-за сбоя, описанного в FailureDescription .

Параметры
failure	FailureDescription : FailureDescription , описывающая сбой и его контекст.

testRunFailed

public void testRunFailed (String errorMessage)

Тестовый запуск отчетов не удалось завершить из-за фатальной ошибки.

Параметры
errorMessage	String : String , описывающая причину сбоя выполнения.

testRunStarted

public void testRunStarted (String name, 
                int numTests, 
                int attemptNumber)

Сообщает о начале тестового запуска.

Параметры
name	String : имя запуска теста.
numTests	int : общее количество тестов в тестовом запуске
attemptNumber	int : номер заказа, идентифицирующий различные попытки одного и того же имени запуска, которые выполняются несколько раз. Номер попытки имеет индекс 0 и должен увеличиваться каждый раз при новом запуске. например, тест гранулярно повторяется 3 раза, всего должно быть 4 запуска под одним и тем же именем запуска, а номер попытки — от 0 до 3.

testRunStarted

public void testRunStarted (String name, 
                int numTests)

Сообщает о начале тестового запуска.

Параметры
name	String : имя запуска теста.
numTests	int : общее количество тестов в тестовом запуске

testRunStarted

public void testRunStarted (String name, 
                int numTests, 
                int attemptNumber, 
                long startTime)

Сообщает о начале тестового запуска.

Параметры
name	String : имя запуска теста.
numTests	int : общее количество тестов в тестовом запуске
attemptNumber	int : номер заказа, идентифицирующий различные попытки одного и того же имени запуска, которые выполняются несколько раз. Номер попытки имеет индекс 0 и должен увеличиваться каждый раз при новом запуске. например, тест гранулярно повторяется 3 раза, всего должно быть 4 запуска под одним и тем же именем запуска, а номер попытки — от 0 до 3.
startTime	long : время начала прогона, измеренное с помощью System.currentTimeMillis()

testRunStopped

public void testRunStopped (long elapsedTime)

Тестовый запуск отчетов остановлен до завершения по запросу пользователя.

TODO: в настоящее время не используется, рассмотрите возможность удаления

Параметры
elapsedTime	long : устройство сообщило прошедшее время в миллисекундах.

тестПропущен

public void testSkipped (TestDescription test, 
                SkipReason reason)

Вызывается, когда тест пропускается и не выполняется по причине, которая обычно не ожидается. Эти тесты будут предприняты повторно, чтобы попытаться обеспечить правильное выполнение.

Параметры
test	TestDescription : идентифицирует тест.
reason	SkipReason : SkipReason

тестНачало

public void testStarted (TestDescription test, 
                long startTime)

Альтернатива testStarted(com.android.tradefed.result.TestDescription) , где мы также указываем, когда тест был запущен, в сочетании с ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map)) для точного измерения. .

Параметры
test	TestDescription : идентифицирует тест.
startTime	long : время начала теста, измеренное с помощью System.currentTimeMillis()

тестНачало

public void testStarted (TestDescription test)

Сообщает о начале отдельного тестового примера. В более старом интерфейсе следует по возможности использовать testStarted(com.android.tradefed.result.TestDescription) .

Параметры
test	TestDescription : идентифицирует тест.

Защищенные методы

ClearModuleLogFiles

protected final void clearModuleLogFiles ()

Позволяет очистить файл модуля, чтобы не носить его слишком долго.

ОчиститьРезультатыФорНаме

protected final void clearResultsForName (String testRunName)

Позволяет очистить результаты для заданного имени запуска. Следует использовать только в некоторых случаях, например, в качестве агрегатора результатов.

Параметры
testRunName	String

setIsAggregrateMetrics

protected void setIsAggregrateMetrics (boolean aggregate)

Включите опцию «агрегированные показатели»

Параметры
aggregate	boolean