ShardListener

public class ShardListener
extends CollectingTestListener implements ISupportGranularResults

java.lang.Object
↳ com.android.tradefed.result.CollectingTestListener
↳ com.android.tradefed.invoker.ShardListener

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

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

Государственные строители

ShardListener ( ITestInvocationListener main)

Create a ShardListener .

Общедоступные методы

List< ITestInvocationListener > getUnderlyingResultReporter ()
void invocationEnded (long elapsedTime)

Сообщает о завершении вызова, будь то успешное завершение или возникновение ошибки.

void invocationFailed ( FailureDescription failure)

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

void invocationFailed (Throwable cause)

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

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

В некоторых случаях лог должен быть тесно связан с тестовыми случаями, но сделать это непосредственно в функции обратного вызова testLogSaved(String,LogDataType,InputStreamSource,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 ()

Reports the end of a module run.

void testModuleStarted ( IInvocationContext moduleContext)

Reports the beginning of a module running.

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

Reports end of test run.

void testRunFailed ( FailureDescription failure)

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

void testRunFailed (String failureMessage)

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

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

Reports the start of a test run.

Public constructors

ShardListener 

public ShardListener (ITestInvocationListener main)

Создайте ShardListener .

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

Общедоступные методы

getUnderlyingResultReporter 

public List<ITestInvocationListener> getUnderlyingResultReporter ()

Возвраты
List< ITestInvocationListener >

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

public void invocationEnded (long elapsedTime)

Сообщает о завершении вызова, будь то успешное завершение или возникновение ошибки.

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

Параметры
elapsedTime long : время выполнения вызова в миллисекундах

invocationFailed 

public void invocationFailed (FailureDescription failure)

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

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

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

invocationFailed 

public void invocationFailed (Throwable cause)

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

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

Параметры
cause Throwable : Throwable причина отказа.

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

public void invocationSkipped (SkipReason reason)

Reports an invocation as skipped

Параметры
reason SkipReason

invocationStarted 

public void invocationStarted (IInvocationContext context)

Сообщает о начале выполнения теста.

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

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

logAssociation 

public void logAssociation (String dataName, 
                LogFile logFile)

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

Параметры
dataName String : Название данных

logFile LogFile : LogFile , в который были записаны данные ранее и который должен быть связан с тестовым случаем.

setSupportGranularResults 

public void setSupportGranularResults (boolean enableGranularResults)

Параметры
enableGranularResults boolean

supportGranularResults 

public boolean supportGranularResults ()

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

Возвраты
boolean

testLog 

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

Предоставляет соответствующие данные журнала или отладочные данные из вызова теста.

Необходимо вызвать перед ERROR(ITestInvocationListener.invocationFailed(Throwable)/ITestInvocationListener#invocationFailed(java.lang.Throwable) ITestInvocationListener.invocationFailed(Throwable)) или ERROR(/ITestInvocationListener#invocationEnded(long))

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

Параметры
dataName String : String описательное имя данных. Например, "device_logcat". Обратите внимание, что dataName может быть не уникальным для каждого вызова. То есть разработчики должны иметь возможность обрабатывать несколько вызовов с одним и тем же 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, 
                HashMap<String, MetricMeasurement.Metric> runMetrics)

Сообщает об окончании выполнения теста. FIXME: Мы не можем иметь два интерфейса Map<> с разными типами, поэтому здесь необходимо использовать HashMap.

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

runMetrics HashMap : пары ключ-значение, отображаемые в конце выполнения теста с помощью Metric .

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 : порядковый номер, идентифицирующий различные попытки выполнения одного и того же runName, которые выполняются несколько раз. attemptNumber имеет индексацию от 0 и должен увеличиваться каждый раз при новом запуске. Например, если тест повторяется 3 раза, то всего должно быть 4 запуска под одним и тем же runName, а attemptNumber принимает значения от 0 до 3.

startTime long : время начала выполнения, измеренное с помощью System.currentTimeMillis()