SubprocessResultsReporter

public class SubprocessResultsReporter
extends Object implements AutoCloseable, ILogSaverListener, ISupportGranularResults, ITestInvocationListener

java.lang.Object
↳	com.android.tradefed.result.SubprocessResultsReporter

既知の直接サブクラス LegacySubprocessResultsReporter LegacySubprocessResultsReporter サブプロセス結果レポーターのフリーズされた実装。スーパークラスの変更にもかかわらず、以前のバージョンの TF/CTS（8 以降など）との互換性を維持する必要があります。

---

result_reporter として指定される ITestInvocationListener を実装し、サブプロセスからテスト、テスト実行、テスト呼び出しの結果を転送します。

概要

パブリック コンストラクタ
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,LogDataType,InputStreamSource,LogFile) コールバックでそれを行うことはできません。
void	printEvent(String key, Object event) イベントキーと JSON オブジェクトを出力するヘルパー。
void	setOutputTestLog(boolean outputTestLog) テストログを出力するかどうかを設定します。
boolean	supportGranularResults() レポートが詳細な結果をサポートしている場合は True、そうでない場合は False を返します。
void	testAssumptionFailure(TestDescription testId, String trace) アトミック テストが、false の条件を想定していることを示すフラグを設定したときに呼び出されます。
void	testAssumptionFailure(TestDescription testId, FailureDescription failure) アトミック テストが、false の条件を想定していることを示すフラグを設定したときに呼び出されます。
void	testEnded(TestDescription testId, long endTime, HashMap<String, MetricMeasurement.Metric> metrics) 終了時間を直接指定できる testEnded(TestDescription,Map) の代替。
void	testEnded(TestDescription testId, HashMap<String, MetricMeasurement.Metric> 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, HashMap<String, MetricMeasurement.Metric> 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	testSkipped(TestDescription testId, SkipReason reason) テストがスキップされ、通常は想定されない理由で実行されなかった場合に呼び出されます。
void	testStarted(TestDescription testId, long startTime) testStarted(TestDescription) の代替。テストの開始時刻も指定し、testEnded(TestDescription,long,Map) と組み合わせて正確な測定を行います。
void	testStarted(TestDescription testId) 個々のテストケースの開始を報告します。

パブリック コンストラクタ

SubprocessResultsReporter

public SubprocessResultsReporter ()

パブリック メソッド

閉じる

public void close ()

getSummary

public TestSummary getSummary ()

InvocationListener が概要を返すことを許可します。

戻り値
TestSummary	実行を要約する TestSummary、または null

invocationEnded

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 原因

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。

printEvent

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

testAssumptionFailure

public void testAssumptionFailure (TestDescription testId, 
                String trace)

アトミック テストが、false の条件を想定していることを示すフラグを設定したときに呼び出されます

パラメータ
testId	TestDescription: テストを識別します
trace	String: 失敗のスタック トレース

testAssumptionFailure

public void testAssumptionFailure (TestDescription testId, 
                FailureDescription failure)

アトミック テストが、false の条件を想定していることを示すフラグを設定したときに呼び出されます

パラメータ
testId	TestDescription: テストを識別します
failure	FailureDescription: 失敗とそのコンテキストを説明する FailureDescription。

testEnded

public void testEnded (TestDescription testId, 
                long endTime, 
                HashMap<String, MetricMeasurement.Metric> metrics)

終了時間を直接指定できる testEnded(TestDescription,Map) の代替。testStarted(TestDescription,long) と組み合わせて正確な測定を行います。

パラメータ
testId	TestDescription: テストを識別します
endTime	long: テストが終了した時刻（System.currentTimeMillis() で測定）
metrics	HashMap: 出力された指標の Map

testEnded

public void testEnded (TestDescription testId, 
                HashMap<String, MetricMeasurement.Metric> metrics)

個々のテストケースの実行終了を報告します。

testFailed(TestDescription, FailureDescription) が呼び出されなかった場合、このテストは合格です。テストケースの実行中に生成された Key-Value 指標も返します。

パラメータ
testId	TestDescription: テストを識別します
metrics	HashMap: 出力された指標の 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: 失敗のスタック トレース

testIgnored

public void testIgnored (TestDescription testId)

テストが実行されない場合に呼び出されます。通常、テストメソッドに org.junit.Ignore のアノテーションが付いていることが原因です。

パラメータ
testId	TestDescription: テストを識別します

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 フレームワークは、このメソッドを自動的に呼び出し、ホストログと、該当する場合はデバイスの logcat を提供します。

パラメータ
dataName	String: データの String 説明的な名前（例: device_logcat）。注: dataName は呼び出しごとに一意でない場合があります。つまり、実装者は同じ dataName での複数の呼び出しを処理できる必要があります。
dataType	LogDataType: データの LogDataType
dataStream	InputStreamSource: データの InputStreamSource。実装者は、createInputStream を呼び出してデータの読み取りを開始し、完了したら結果の InputStream を必ず閉じます。呼び出し元は、testLog メソッドが完了するまで、データのソースが存在し、アクセス可能であることを確認する必要があります。

testModuleEnded

public void testModuleEnded ()

モジュール実行の終了を報告します。

testModuleStarted

public void testModuleStarted (IInvocationContext moduleContext)

モジュールの実行開始を報告します。このコールバックは testModuleEnded() に関連付けられており、シーケンスでは省略可能です。モジュールを使用する実行（スイートベースのランナー）でのみ使用されます。

パラメータ
moduleContext	IInvocationContext: モジュールの IInvocationContext。

testRunEnded

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

テスト実行の終了を報告します。FIXME: 型が異なる Map<> インターフェースを 2 つ持つことはできないため、ここでは HashMap を使用する必要があります。

パラメータ
time	long: デバイスが報告した経過時間（ミリ秒単位）
runMetrics	HashMap: Metric を使用したテスト実行の最後にレポートされる Key-Value ペア。

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: 実行名が同じで複数回実行される異なる試行を識別する注文番号。attemptNumber は 0 から始まり、新しい実行が発生するたびに増分されます。たとえば、テストが 3 回きめ細かく再試行される場合、同じ runName で合計 4 回の実行が行われ、attemptNumber は 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: 実行名が同じで複数回実行される異なる試行を識別する注文番号。attemptNumber は 0 から始まり、新しい実行が発生するたびに増分されます。たとえば、テストが 3 回再試行される場合、同じ runName で合計 4 回実行され、attemptNumber は 0 ～ 3 になります。
startTime	long: 実行の開始時刻（System.currentTimeMillis() で測定）

testRunStopped

public void testRunStopped (long arg0)

ユーザーのリクエストにより、レポートのテスト実行が完了前に停止しました。

TODO: 現在使用されていません。削除することを検討してください

パラメータ
arg0	long: デバイスが報告した経過時間（ミリ秒単位）

testSkipped

public void testSkipped (TestDescription testId, 
                SkipReason reason)

通常は想定されない理由でテストがスキップされ、実行されなかった場合に呼び出されます。これらのテストは、適切な実行を試みるために再試行されます。

パラメータ
testId	TestDescription: テストを識別します
reason	SkipReason: SkipReason

testStarted

public void testStarted (TestDescription testId, 
                long startTime)

testStarted(TestDescription) の代替。テストの開始時刻も指定し、testEnded(TestDescription,long,Map) と組み合わせて正確な測定を行います。

パラメータ
testId	TestDescription: テストを識別します
startTime	long: テストが開始された時刻（System.currentTimeMillis() で測定）

testStarted

public void testStarted (TestDescription testId)

個々のテストケースの開始を報告します。古いインターフェース。可能な限り testStarted(TestDescription) を使用する必要があります。

パラメータ
testId	TestDescription: テストを識別します