ShardListener

public class ShardListener
extends CollectingTestListener implements ISupportGranularResults

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

ITestInvocationListener , который собирает результаты из сегмента вызова (так называемого разделения вызовов для параллельного выполнения на нескольких ресурсах) и пересылает их другому прослушивателю.

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

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

ShardListener ( ITestInvocationListener main)

Создайте ShardListener .

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

getUnderlyingResultReporter ()
void invocationEnded (long elapsedTime)

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

void invocationFailed ( FailureDescription failure)

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

void invocationFailed (Throwable cause)

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

void invocationSkipped ( SkipReason reason)

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

void invocationStarted ( IInvocationContext context)

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

void logAssociation (String dataName, LogFile logFile)

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

void setSupportGranularResults (boolean enableGranularResults)
boolean supportGranularResults ()

Возвращает True, если генератор отчетов поддерживает детализированные результаты, в противном случае — false.

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

Предоставляет связанные данные журнала или отладки из тестового вызова.

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

void testModuleEnded ()

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

void testModuleStarted ( IInvocationContext moduleContext)

Сообщает о начале работы модуля.

void testRunEnded (long elapsedTime, runMetrics) testRunEnded (long elapsedTime, runMetrics)

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

void testRunFailed ( FailureDescription failure)

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

void testRunFailed (String failureMessage)

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

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

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

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

ShardListener 

public ShardListener (ITestInvocationListener main)

Создайте ShardListener .

Параметры
main ITestInvocationListener : ITestInvocationListener результаты которого должны быть перенаправлены. Чтобы предотвратить конфликты с другими ShardListener , этот объект будет синхронизироваться с main при пересылке результатов. Результаты будут отправлены только после завершения осколка вызова.

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

getUnderlyingResultReporter 

public  getUnderlyingResultReporter ()

Возврат

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

public void invocationEnded (long elapsedTime)

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

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

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

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

public void invocationFailed (FailureDescription failure)

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

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

Параметры
failure FailureDescription : « FailureDescription описывающее причину сбоя.

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

public void invocationFailed (Throwable cause)

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

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

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

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

public void invocationSkipped (SkipReason reason)

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

Параметры
reason SkipReason

вызовНачало 

public void invocationStarted (IInvocationContext context)

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

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

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

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 , который был зарегистрирован ранее и должен быть связан с тестовым примером.

setSupportGranularResults 

public void setSupportGranularResults (boolean enableGranularResults)

Параметры
enableGranularResults boolean

поддержкаGranularResults 

public boolean supportGranularResults ()

Возвращает True, если генератор отчетов поддерживает детализированные результаты, в противном случае — false.

Возврат
boolean

журнал испытаний 

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

Предоставляет связанные данные журнала или отладки из тестового вызова.

Должен быть вызван перед ERROR(/ITestInvocationListener#invocationFailed(Throwable)) или ERROR(/ITestInvocationListener#invocationEnded(long))

Платформа TradeFederation автоматически вызовет этот метод, предоставив журнал хоста и, если применимо, logcat устройства.

Параметры
dataName String : String описательное имя данных. например, «device_logcat». Примечание. dataName не может быть уникальным для каждого вызова. т.е. разработчики должны иметь возможность обрабатывать несколько вызовов с одним и тем же именем данных.

dataType LogDataType : LogDataType данных.

dataStream InputStreamSource : InputStreamSource данных. Разработчики должны вызвать createInputStream, чтобы начать чтение данных, и обеспечить закрытие результирующего InputStream после завершения. Вызывающая сторона должна гарантировать, что источник данных остается присутствующим и доступным до завершения метода testLog.

testLogSaved 

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

Параметры
dataName String

dataType LogDataType

dataStream InputStreamSource

logFile LogFile

testModuleEnded 

public void testModuleEnded ()

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

testModuleStarted 

public void testModuleStarted (IInvocationContext moduleContext)

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

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

testRunEnded 

public void testRunEnded (long elapsedTime, 
                 runMetrics)

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

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

runMetrics : пары ключ-значение сообщаются в конце тестового запуска.

testRunFailed 

public void testRunFailed (FailureDescription failure)

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

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

testRunFailed 

public void testRunFailed (String failureMessage)

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

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

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