Репортер подпроцессрезультатов

public class SubprocessResultsReporter
extends Object implements ITestInvocationListener , ILogSaverListener , ISupportGranularResults

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

Известные прямые подклассы LegacySubprocessResultsReporter LegacySubprocessResultsReporter Замороженная реализация генератора отчетов о результатах подпроцесса, который должен оставаться совместимым с более ранними версиями TF/CTS (например, 8+), несмотря на изменения в его суперклассе.

---

Реализует ITestInvocationListener для указания в качестве result_reporter и пересылки из подпроцесса результатов тестов, тестовых прогонов, тестовых вызовов.

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

Публичные конструкторы
SubprocessResultsReporter ()

Публичные методы
void	close ()
TestSummary	getSummary () Позволяет InvocationListener возвращать сводку.
void	invocationEnded (long elapsedTime) Сообщает, что вызов завершился успешно или из-за какой-либо ошибки.
void	invocationFailed ( FailureDescription failure) Сообщает о незавершенном вызове из-за некоторого состояния ошибки.
void	invocationFailed (Throwable cause) Сообщает о незавершенном вызове из-за некоторого состояния ошибки.
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	printEvent (String key, Object event) Помощник для печати ключа события, а затем объекта json.
void	setOutputTestLog (boolean outputTestLog) Устанавливает, должны ли мы выводить зарегистрированный тест или нет.
boolean	supportGranularResults () Возвращает True, если генератор отчетов поддерживает детализированные результаты, в противном случае — false.
void	testAssumptionFailure ( TestDescription testId, String trace) Вызывается, когда атомарный тест отмечает, что он принимает условие, которое является ложным.
void	testAssumptionFailure ( TestDescription testId, FailureDescription failure) Вызывается, когда атомарный тест отмечает, что он принимает условие, которое является ложным.
void	testEnded ( TestDescription testId, long endTime, metrics) testEnded ( TestDescription testId, long endTime, metrics) Альтернатива ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)) где мы можем напрямую указать время окончания.
void	testEnded ( TestDescription testId, metrics) testEnded ( TestDescription testId, metrics) Сообщает об окончании выполнения отдельного тестового примера.
void	testFailed ( TestDescription testId, FailureDescription failure) Сообщает о сбое отдельного тестового примера.
void	testFailed ( TestDescription testId, String reason) Сообщает о сбое отдельного тестового примера.
void	testIgnored ( TestDescription testId) Вызывается, когда тест не будет запущен, как правило, потому, что метод теста помечен org.junit.Ignore.
void	testLog (String dataName, LogDataType dataType, InputStreamSource dataStream) Предоставляет связанный журнал или данные отладки из вызова теста.
void	testModuleEnded () Сообщает об окончании выполнения модуля.
void	testModuleStarted ( IInvocationContext moduleContext) Сообщает о начале работы модуля.
void	testRunEnded (long time, runMetrics) testRunEnded (long time, runMetrics) Сообщает об окончании тестового прогона.
void	testRunFailed ( FailureDescription failure) Не удалось выполнить тестовый запуск отчетов из-за сбоя, описанного в FailureDescription .
void	testRunFailed (String reason) Не удалось выполнить тестовый запуск отчетов из-за неустранимой ошибки.
void	testRunStarted (String runName, int testCount, int attemptNumber) Сообщает о начале тестового прогона.
void	testRunStarted (String runName, int testCount) Сообщает о начале тестового прогона.
void	testRunStarted (String runName, int testCount, int attemptNumber, long startTime) Сообщает о начале тестового прогона.
void	testRunStopped (long arg0) Тестовый запуск отчетов остановлен до завершения по запросу пользователя.
void	testStarted ( TestDescription testId, long startTime) Альтернатива testStarted(com.android.tradefed.result.TestDescription) , где мы также указываем, когда тест был запущен, в сочетании с ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map)) для точного измерения .
void	testStarted ( TestDescription testId) Сообщает о начале отдельного тестового примера.

Публичные конструкторы

Репортер подпроцессрезультатов

public SubprocessResultsReporter ()

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

закрывать

public void close ()

getSummary

public TestSummary getSummary ()

Позволяет InvocationListener возвращать сводку.

Возвращает
TestSummary	TestSummary обобщающий прогон, или null

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

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

событие печати

public void printEvent (String key, 
                Object event)

Помощник для печати ключа события, а затем объекта json.

Параметры
key	String
event	Object

setOutputTestLog

public void setOutputTestLog (boolean outputTestLog)

Устанавливает, должны ли мы выводить зарегистрированный тест или нет.

Параметры
outputTestLog	boolean

supportGranularResults

public boolean supportGranularResults ()

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

Возвращает
boolean

testAssummentFailure

public void testAssumptionFailure (TestDescription testId, 
                String trace)

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

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

testAssummentFailure

public void testAssumptionFailure (TestDescription testId, 
                FailureDescription failure)

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

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

testEnded

public void testEnded (TestDescription testId, 
                long endTime, 
                 metrics)

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

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

testEnded

public void testEnded (TestDescription testId, 
                 metrics)

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

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

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

testFailed

public void testFailed (TestDescription testId, 
                FailureDescription failure)

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

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

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

testFailed

public void testFailed (TestDescription testId, 
                String reason)

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

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

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

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

public void testIgnored (TestDescription testId)

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

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

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

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 не завершится.

testModuleEnded

public void testModuleEnded ()

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

тестмодулестартед

public void testModuleStarted (IInvocationContext moduleContext)

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

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

testRunEnded

public void testRunEnded (long time, 
                 runMetrics)

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

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

testRunFailed

public void testRunFailed (FailureDescription failure)

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

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

testRunFailed

public void testRunFailed (String reason)

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

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

testRunStarted

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

Сообщает о начале тестового прогона.

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

testRunStarted

public 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, которые выполняются несколько раз. ПопыткаNumber имеет индекс 0 и должна увеличиваться каждый раз, когда происходит новый запуск. Например, тест гранулированно повторяется 3 раза, он должен иметь 4 полных запуска под одним и тем же именем запуска, а число попыток — от 0 до 3.
startTime	long : время запуска, измеренное с помощью System.currentTimeMillis()

testRunStopped

public void testRunStopped (long arg0)

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

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

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

testStarted

public void testStarted (TestDescription testId, 
                long startTime)

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

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

testStarted

public void testStarted (TestDescription testId)

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

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