ProtoResultReporter

public abstract class ProtoResultReporter
extends Object implements ILogSaverListener , ISupportGranularResults , ITestInvocationListener

java.lang.Object
↳	com.android.tradefed.result.proto.ProtoResultReporter

Известные прямые подклассы FileProtoResultReporter , StreamProtoResultReporter FileProtoResultReporter Прототип репортера, который сохраняет TestRecord в файл. StreamProtoResultReporter Реализация ProtoResultReporter

Известные косвенные подклассы InvocationProtoResultReporter , ModuleProtoResultReporter InvocationProtoResultReporter Репортеры для хранения информации о кэшировании на уровне вызова и списка соответствующих модулей. ModuleProtoResultReporter Программа для формирования отчетов, предназначенная для отображения результатов только на уровне модуля.

---

Функция формирования результатов создает protobuf-объект TestRecord , содержащий все результаты. Ее следует расширить, чтобы она обрабатывала действия с окончательным proto в processFinalProto(TestRecord) .

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

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

Общедоступные методы
final void	invocationEnded (long elapsedTime) Сообщает о завершении вызова, будь то успешное завершение или возникновение ошибки.
void	invocationFailed ( FailureDescription failure) Сообщает о неполном вызове из-за какой-либо ошибки.
void	invocationFailed (Throwable cause) Сообщает о неполном вызове из-за какой-либо ошибки.
void	invocationSkipped ( SkipReason reason) Сообщает о пропуске вызова.
void	invocationStarted ( IInvocationContext context) Сообщает о начале выполнения теста.
final void	logAssociation (String dataName, LogFile logFile) В некоторых случаях лог должен быть тесно связан с тестовыми случаями, но сделать это непосредственно в функции обратного вызова testLogSaved(String,LogDataType,InputStreamSource,LogFile) невозможно.
void	processFinalInvocationLogs (TestRecordProto.TestRecord invocationLogs) Используйте запись вызова, чтобы поочередно отправлять все окончательные журналы вызова.
void	processFinalProto (TestRecordProto.TestRecord finalRecord) Обработка финального прототипа со всеми результатами.
void	processStartInvocation (TestRecordProto.TestRecord invocationStartRecord, IInvocationContext invocationContext) Обработка частичного протокола записи теста вызова после вызова invocationStarted(IInvocationContext) .
void	processTestCaseEnded (TestRecordProto.TestRecord testCaseRecord) Обработка завершенного прототипа записи тестового случая после testEnded(TestDescription,long,HashMap) .
void	processTestCaseStarted (TestRecordProto.TestRecord testCaseStartedRecord) Обработка частичного прототипа записи тестового случая после testStarted(TestDescription,long) .
void	processTestModuleEnd (TestRecordProto.TestRecord moduleRecord) Обработка завершенного прототипа записи модуля после вызова функции testModuleEnded() .
void	processTestModuleStarted (TestRecordProto.TestRecord moduleStartRecord) Обработка частичного протокола записи модуля после вызова testModuleStarted(IInvocationContext) .
void	processTestRunEnded (TestRecordProto.TestRecord runRecord, boolean moduleInProgress) Обработка завершенного прототипа записи выполнения после завершения вызова testRunEnded(long,HashMap) .
void	processTestRunStarted (TestRecordProto.TestRecord runStartedRecord) Обработка частичного протокола записи выполнения теста после вызова testRunStarted(String,int) .
void	setGranularResults (boolean granularResults)
void	setInlineRecordOfChildren (boolean inline)
boolean	supportGranularResults () Возвращает True, если система поддерживает детализированные результаты, и False в противном случае.
final void	testAssumptionFailure ( TestDescription test, String trace) Вызывается, когда атомарный тест указывает на то, что он предполагает ложное условие.
final void	testAssumptionFailure ( TestDescription test, FailureDescription failure) Вызывается, когда атомарный тест указывает на то, что он предполагает ложное условие.
final void	testEnded ( TestDescription test, long endTime, HashMap<String, MetricMeasurement.Metric> testMetrics) Альтернатива функции testEnded(TestDescription,Map) позволяющая напрямую указать время окончания.
void	testEnded ( TestDescription test, HashMap<String, MetricMeasurement.Metric> testMetrics) Сообщает о завершении выполнения отдельного тестового случая.
final void	testFailed ( TestDescription test, FailureDescription failure) Сообщает о сбое отдельного тестового случая.
final void	testFailed ( TestDescription test, String trace) Сообщает о сбое отдельного тестового случая.
final void	testIgnored ( TestDescription test) Вызывается, когда тест выполняться не будет, как правило, потому что тестовый метод аннотирован с помощью org.junit.Ignore.
final void	testModuleEnded () Сообщает об окончании выполнения модуля.
final void	testModuleStarted ( IInvocationContext moduleContext) Сообщает о начале работы модуля.
final void	testRunEnded (long elapsedTimeMillis, HashMap<String, MetricMeasurement.Metric> runMetrics) Сообщает об окончании тестового запуска.
final void	testRunFailed ( FailureDescription failure) Сообщается, что запуск тестового запуска не завершился из-за ошибки, описанной в FailureDescription .
final void	testRunFailed (String errorMessage) Сообщается, что тестовый запуск не завершился из-за критической ошибки.
void	testRunStarted (String runName, int testCount, int attemptNumber) Сообщает о начале тестового запуска.
final void	testRunStarted (String runName, int testCount) Сообщает о начале тестового запуска.
void	testRunStarted (String runName, int testCount, int attemptNumber, long startTime) Сообщает о начале тестового запуска.
final void	testSkipped ( TestDescription test, SkipReason reason) Вызывается, когда тест пропущен и не выполнен по причине, которая обычно не ожидается.
final void	testStarted ( TestDescription test, long startTime) Альтернатива функции testStarted(TestDescription) , где мы также указываем время начала теста, в сочетании с testEnded(TestDescription,long,Map) для более точного измерения.
final void	testStarted ( TestDescription test) Сообщает о начале выполнения отдельного тестового случая.

Защищенные методы
void	afterModuleEnd ()
void	beforeModuleStart ()
TestRecordProto.ChildReference	createModuleChildReference (TestRecordProto.TestRecord record) Создает дочернюю ссылку для модуля.

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

ProtoResultReporter

public ProtoResultReporter ()

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

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

public final 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 final void logAssociation (String dataName, 
                LogFile logFile)

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

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

processFinalInvocationLogs

public void processFinalInvocationLogs (TestRecordProto.TestRecord invocationLogs)

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

Параметры
invocationLogs	TestRecordProto.TestRecord : Завершенный прототип, представляющий собой вызов.

processFinalProto

public void processFinalProto (TestRecordProto.TestRecord finalRecord)

Обработка финального прототипа со всеми результатами.

Параметры
finalRecord	TestRecordProto.TestRecord : Завершенный протокол со всеми результатами вызова.

processStartInvocation

public void processStartInvocation (TestRecordProto.TestRecord invocationStartRecord, 
                IInvocationContext invocationContext)

Обработка частичного протокола записи теста вызова после вызова invocationStarted(IInvocationContext) .

Параметры
invocationStartRecord	TestRecordProto.TestRecord : Частичный протокол, заполняемый после вызова InvocationStart.
invocationContext	IInvocationContext : Вызов IInvocationContext .

processTestCaseEnded

public void processTestCaseEnded (TestRecordProto.TestRecord testCaseRecord)

Обработка завершенного прототипа записи тестового случая после testEnded(TestDescription,long,HashMap) .

Параметры
testCaseRecord	TestRecordProto.TestRecord : Завершенный прототип, представляющий собой тестовый случай.

процессТестНачался

public void processTestCaseStarted (TestRecordProto.TestRecord testCaseStartedRecord)

Обработка частичного прототипа записи тестового случая после testStarted(TestDescription,long) .

Параметры
testCaseStartedRecord	TestRecordProto.TestRecord : Частичный прототип, представляющий тестовый случай.

processTestModuleEnd

public void processTestModuleEnd (TestRecordProto.TestRecord moduleRecord)

Обработка завершенного прототипа записи модуля после вызова функции testModuleEnded() .

Параметры
moduleRecord	TestRecordProto.TestRecord : Завершенный прототип, представляющий модуль.

processTestModuleStarted

public void processTestModuleStarted (TestRecordProto.TestRecord moduleStartRecord)

Обработка частичного протокола записи модуля после вызова testModuleStarted(IInvocationContext) .

Параметры
moduleStartRecord	TestRecordProto.TestRecord : Частичный прототип, представляющий модуль.

processTestRunEnded

public void processTestRunEnded (TestRecordProto.TestRecord runRecord, 
                boolean moduleInProgress)

Обработка завершенного прототипа записи выполнения после завершения вызова testRunEnded(long,HashMap) .

Параметры
runRecord	TestRecordProto.TestRecord : Завершенный прототип, представляющий собой результат выполнения.
moduleInProgress	boolean : указывает, выполняется ли модуль.

процессЗапускТестированияНачался

public void processTestRunStarted (TestRecordProto.TestRecord runStartedRecord)

Обработка частичного протокола записи выполнения теста после вызова testRunStarted(String,int) .

Параметры
runStartedRecord	TestRecordProto.TestRecord : Частичный прототип, представляющий собой результат выполнения теста.

setGranularResults

public void setGranularResults (boolean granularResults)

Параметры
granularResults	boolean

setInlineRecordOfChildren

public void setInlineRecordOfChildren (boolean inline)

Параметры
inline	boolean

supportGranularResults

public boolean supportGranularResults ()

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

Возвраты
boolean

testAssumptionFailure

public final void testAssumptionFailure (TestDescription test, 
                String trace)

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

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

testAssumptionFailure

public final void testAssumptionFailure (TestDescription test, 
                FailureDescription failure)

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

Параметры
test	TestDescription : идентифицирует тест
failure	FailureDescription : Описание ошибки и контекст её FailureDescription .

тест завершен

public final void testEnded (TestDescription test, 
                long endTime, 
                HashMap<String, MetricMeasurement.Metric> testMetrics)

Альтернатива функции testEnded(TestDescription,Map) , позволяющая напрямую указать время окончания. Для более точного измерения можно использовать в сочетании с testStarted(TestDescription,long) .

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

тест завершен

public void testEnded (TestDescription test, 
                HashMap<String, MetricMeasurement.Metric> testMetrics)

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

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

Параметры
test	TestDescription : идентифицирует тест
testMetrics	HashMap : Map сгенерированных метрик

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

public final void testFailed (TestDescription test, 
                FailureDescription failure)

Сообщает о сбое отдельного тестового случая.

Эта функция будет вызвана в промежутке между testStarted и testEnded.

Параметры
test	TestDescription : идентифицирует тест
failure	FailureDescription : Описание ошибки и контекст её FailureDescription .

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

public final void testFailed (TestDescription test, 
                String trace)

Сообщает о сбое отдельного тестового случая.

Эта функция будет вызвана в промежутке между testStarted и testEnded.

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

тест проигнорирован

public final void testIgnored (TestDescription test)

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

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

testModuleEnded

public final void testModuleEnded ()

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

testModuleStarted

public final void testModuleStarted (IInvocationContext moduleContext)

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

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

testRunEnded

public final void testRunEnded (long elapsedTimeMillis, 
                HashMap<String, MetricMeasurement.Metric> runMetrics)

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

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

testRunFailed

public final void testRunFailed (FailureDescription failure)

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

Параметры
failure	FailureDescription : Описание ошибки и контекст её FailureDescription .

testRunFailed

public final void testRunFailed (String errorMessage)

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

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

testRunStarted

public void testRunStarted (String runName, 
                int testCount, 
                int attemptNumber)

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

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

testRunStarted

public final void testRunStarted (String runName, 
                int testCount)

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

Параметры
runName	String : название тестового запуска
testCount	int : общее количество тестов в тестовом запуске

testRunStarted

public void testRunStarted (String runName, 
                int testCount, 
                int attemptNumber, 
                long startTime)

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

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

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

public final void testSkipped (TestDescription test, 
                SkipReason reason)

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

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

тест начат

public final void testStarted (TestDescription test, 
                long startTime)

Альтернатива функции testStarted(TestDescription) , где мы также указываем время начала теста, в сочетании с testEnded(TestDescription,long,Map) для более точного измерения.

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

тест начат

public final void testStarted (TestDescription test)

Сообщает о начале отдельного тестового случая. Более старый интерфейс, следует использовать testStarted(TestDescription) везде, где это возможно.

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

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

afterModuleEnd

protected void afterModuleEnd ()

beforeModuleStart

protected void beforeModuleStart ()

createModuleChildReference

protected TestRecordProto.ChildReference createModuleChildReference (TestRecordProto.TestRecord record)

Создает дочернюю ссылку для модуля.

Параметры
record	TestRecordProto.TestRecord

Возвраты
TestRecordProto.ChildReference