CollectingTestListener

public class CollectingTestListener
extends Object implements IDisableable, ILogSaverListener, ITestInvocationListener

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

すべてのテスト結果を収集する ITestInvocationListener。

このオブジェクトで使用されるデータ構造はスレッドセーフですが、ITestInvocationListener コールバックは正しい順序で呼び出す必要があります。

概要

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

CollectingTestListener()

パブリック メソッド

IBuildInfo getBuildInfo()

このメソッドは非推奨です。 getInvocationContext() の IBuildInfo に依存します。

TestRunResult getCurrentRunResults()

現在のテスト実行の結果を取得します。

int getExpectedTests()

期待されるテスト数を返します。

IInvocationContext getInvocationContext()

invocationStarted(com.android.tradefed.invoker.IInvocationContext) を介して報告された呼び出しコンテキストを返します。

getMergedTestRunResults()

さまざまな試行のすべての実行の結果を統合したコレクションを返します。

IInvocationContext getModuleContextForRunResult(String testRunName)

結果に関連付けられているモジュールの IInvocationContext を返します。

MultiMap<String, LogFile> getModuleLogFiles()

モジュールに関連付けられているすべてのログファイルを含むマップのコピーを返します。
MultiMap<String, LogFile> getNonAssociatedLogFiles()

テスト実行またはモジュールに関連付けられていないすべてのログファイルを含むマップのコピーを返します。

int getNumAllFailedTestRuns()

失敗状態のテスト実行の合計数を返します。

int getNumAllFailedTests()

失敗状態のテストの数を返します（失敗のみ。前提条件の失敗はカウントされません）。

int getNumTestsInState(TestStatus status)

この実行で指定された状態のテストの数を返します。

int getNumTestsInState(TestResult.TestStatus ddmlibStatus)

古いステータス タイプとの互換性のため

int getNumTotalTests()

すべての実行について完了したテストの合計数を返します。
IBuildInfo getPrimaryBuildInfo()

invocationStarted(com.android.tradefed.invoker.IInvocationContext) で報告されたプライマリ ビルド情報を返します。

getRunResults()

このメソッドは非推奨です。 getMergedTestRunResults() を使用する

TestRunResult getTestRunAtAttempt(String testRunName, int attempt)

1 回の試行に対して TestRunResult を返します。
int getTestRunAttemptCount(String testRunName)

指定されたテスト実行名の試行回数を返します。

getTestRunAttempts(String testRunName)

特定のテスト実行の TestRunResult のすべての試行を取得します。

getTestRunForAttempts(int attempt)

特定の試行のすべての結果を取得します。

getTestRunNames()

すべてのテスト実行のすべての名前を返します。
boolean hasFailedTests()

呼び出しで失敗したテストまたは前提条件が失敗したテストがあったかどうかを返します。

boolean hasTestRunResultsForName(String testRunName)

指定したテスト実行名に結果があるかどうかを返します。

void invocationEnded(long elapsedTime)

呼び出しが正常に終了したか、なんらかのエラー状態が原因で終了したかを報告します。

void invocationFailed(Throwable cause)

エラー状態が原因で呼び出しが完了しなかったことを報告します。

void invocationSkipped(SkipReason reason)

呼び出しをスキップされたものとして報告します

void invocationStarted(IInvocationContext context)

テスト呼び出しの開始を報告します。

boolean isDisabled()

オブジェクト全体が無効になっている場合（セットアップと破棄の両方をスキップ）、true を返します。

void logAssociation(String dataName, LogFile logFile)

場合によっては、ログをテストケースに強く関連付ける必要があります。ただし、直接の testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile) コールバックでそうすることはできません。

void setBuildInfo(IBuildInfo buildInfo)

このメソッドは非推奨です。 テストでは不要になりました。

void setDisable(boolean isDisabled)

オブジェクトを無効にするかどうかを設定します。

void setMergeStrategy(MergeStrategy strategy)

結果の統合時に使用する MergeStrategy を設定します。

void testAssumptionFailure(TestDescription test, String trace)

アトミック テストが false の条件を前提としていることを報告するフラグが立てられたときに呼び出されます。
void testAssumptionFailure(TestDescription test, FailureDescription failure)

アトミック テストが false の条件を前提としていることを報告するフラグが立てられたときに呼び出されます。
void testEnded(TestDescription test, long endTime, testMetrics)

ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)) の代わりに、終了時間を直接指定できます。

void testEnded(TestDescription test, testMetrics)

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

void testFailed(TestDescription test, FailureDescription failure)

個々のテストケースの失敗を報告します。

void testFailed(TestDescription test, String trace)

個々のテストケースの失敗を報告します。

void testIgnored(TestDescription test)

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

void testModuleEnded()

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

void testModuleStarted(IInvocationContext moduleContext)

モジュールの実行開始を報告します。

void testRunEnded(long elapsedTime, runMetrics)

テスト実行の終了を報告します。

void testRunFailed(FailureDescription failure)

FailureDescription で説明されているエラーが原因で、テスト実行が完了しなかったことを報告します。

void testRunFailed(String errorMessage)

致命的なエラーが発生したため、レポートのテスト実行が完了しませんでした。

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

テスト実行の開始を報告します。

void testRunStarted(String name, int numTests)

テスト実行の開始を報告します。

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

テスト実行の開始を報告します。

void testRunStopped(long elapsedTime)

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

void testSkipped(TestDescription test, SkipReason reason)

通常は想定されない理由でテストがスキップされ、実行されなかったときに呼び出されます。

void testStarted(TestDescription test, long startTime)

testStarted(com.android.tradefed.result.TestDescription) に代わるもので、テストの開始日時も指定します。正確な測定のために ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map)) と組み合わせて使用します。

void testStarted(TestDescription test)

個々のテストケースの開始を報告します。

保護されたメソッド

final void clearModuleLogFiles()

モジュール ファイルをクリーンアップして、長時間保持しないようにします。

final void clearResultsForName(String testRunName)

特定の実行名の結果を消去できます。

void setIsAggregrateMetrics(boolean aggregate)

[指標を集計] オプションを切り替えます。

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

CollectingTestListener

public CollectingTestListener ()

パブリック メソッド

getBuildInfo

public IBuildInfo getBuildInfo ()

このメソッドは非推奨となりました。
は getInvocationContext() の IBuildInfo に依存します。

ビルド情報を返します。

戻り値
IBuildInfo

getCurrentRunResults

public TestRunResult getCurrentRunResults ()

現在のテスト実行の結果を取得します。

結果が不完全な場合があります。結果を処理する前に、必要に応じて TestRunResult.isRunComplete() と（@link TestRunResult#isRunFailure()}、またはその両方）の値をテストすることをおすすめします。

戻り値
TestRunResult TestRunResult: 前回のテスト実行中に収集されたデータを表します。

getExpectedTests

public int getExpectedTests ()

想定されるテスト数を返します。一部のテストが実行されていない場合は、getNumTotalTests() と異なる場合があります。

戻り値
int

getInvocationContext

public IInvocationContext getInvocationContext ()

invocationStarted(com.android.tradefed.invoker.IInvocationContext) を介して報告された呼び出しコンテキストを返します。

戻り値
IInvocationContext

getMergedTestRunResults

public  getMergedTestRunResults ()

さまざまな試行のすべての実行の結果を統合したコレクションを返します。

結果が複数ある場合は、各テスト実行が統合され、最新のテスト結果が以前の実行のテスト結果を上書きします。テスト実行は試行回数で並べ替えられます。

同じ試行の指標は、aggregate-metrics で設定された設定に基づいて統合されます。最終的な指標は、最後の試行の指標になります。

戻り値

getModuleContextForRunResult

public IInvocationContext getModuleContextForRunResult (String testRunName)

結果に関連付けられたモジュールの IInvocationContext を返します。

パラメータ
testRunName String: {testRunStarted(String, int) によって指定された名前。
戻り値
IInvocationContext 特定のテスト実行名のモジュールの IInvocationContext（その名前の結果がない場合）。null

getModuleLogFiles

public MultiMap<String, LogFile> getModuleLogFiles ()

モジュールに関連付けられたすべてのログファイルを含むマップのコピーを返します。

戻り値
MultiMap<String, LogFile>

getNonAssociatedLogFiles

public MultiMap<String, LogFile> getNonAssociatedLogFiles ()

テスト実行またはモジュールに関連付けられていないログファイルをすべて含むマップのコピーを返します。

戻り値
MultiMap<String, LogFile>

getNumAllFailedTestRuns

public int getNumAllFailedTestRuns ()

失敗状態のテスト実行の合計数を返します。

戻り値
int

getNumAllFailedTests

public int getNumAllFailedTests ()

失敗状態のテストの数を返します（失敗したテストのみ。前提条件の失敗はカウントされません）。

戻り値
int

getNumTestsInState

public int getNumTestsInState (TestStatus status)

この実行で指定された状態のテストの数を返します。

パラメータ
status TestStatus

戻り値
int

getNumTestsInState

public int getNumTestsInState (TestResult.TestStatus ddmlibStatus)

古いステータス タイプとの互換性のため

パラメータ
ddmlibStatus TestResult.TestStatus

戻り値
int

getNumTotalTests

public int getNumTotalTests ()

すべての実行で完了したテストの合計数を返します。

戻り値
int

getPrimaryBuildInfo

public IBuildInfo getPrimaryBuildInfo ()

invocationStarted(com.android.tradefed.invoker.IInvocationContext) を介して報告されたプライマリ ビルド情報を返します。プライマリ ビルドは、実行中の構成の最初のビルド プロバイダから返されたビルドです。コンテキストがない場合（テストケースをビルドできない場合）は null を返します。

戻り値
IBuildInfo

getRunResults

public  getRunResults ()

このメソッドは非推奨です。
getMergedTestRunResults() を使用します

すべてのテスト実行の結果を返します。

戻り値

getTestRunAtAttempt

public TestRunResult getTestRunAtAttempt (String testRunName, 
                int attempt)

1 回目の試行で TestRunResult を返します。

パラメータ
testRunName String: {testRunStarted(String, int) によって指定された名前。
attempt int: 試行 ID。
戻り値
TestRunResult 指定の名前と試行 ID の TestRunResult。存在しない場合は null。

getTestRunAttemptCount

public int getTestRunAttemptCount (String testRunName)

指定されたテスト実行名に対する試行回数を返します。

パラメータ
testRunName String: {testRunStarted(String, int) によって指定された名前。
戻り値
int

getTestRunAttempts

public  getTestRunAttempts (String testRunName)

特定のテスト実行の TestRunResult のすべての試行を取得します。

パラメータ
testRunName String: {testRunStarted(String, int) によって指定された名前。
戻り値
特定のテスト実行のすべての TestRunResult を試行回数で並べ替えます。

getTestRunForAttempts

public  getTestRunForAttempts (int attempt)

特定の試行のすべての結果を取得します。

パラメータ
attempt int: 結果を取得する試行。
戻り値
特定の試行のすべての TestRunResult。

getTestRunNames

public  getTestRunNames ()

すべてのテスト実行のすべての名前を返します。

これらのテスト実行は、異なる試行で複数回実行されている可能性があります。

戻り値

hasFailedTests

public boolean hasFailedTests ()

呼び出しで失敗したテストまたは前提条件が失敗したテストがあったかどうかを返します。

戻り値
boolean

hasTestRunResultsForName

public boolean hasTestRunResultsForName (String testRunName)

指定されたテスト実行名に結果があるかどうかを返します。

パラメータ
testRunName String: {testRunStarted(String, int) によって指定された名前。
戻り値
boolean

invocationEnded

public void invocationEnded (long elapsedTime)

呼び出しが正常に終了したか、なんらかのエラー状態が原因で終了したかを報告します。

TradeFederation フレームワークによって自動的に呼び出されます。

パラメータ
elapsedTime long: 呼び出しの所要時間（ミリ秒単位）

invocationFailed

public void invocationFailed (Throwable cause)

エラー状態が原因で呼び出しが完了しなかったことを報告します。

TradeFederation フレームワークによって自動的に呼び出されます。

パラメータ
cause Throwable: 失敗の原因である Throwable

invocationSkipped

public void invocationSkipped (SkipReason reason)

呼び出しをスキップとして報告する

パラメータ
reason SkipReason

invocationStarted

public void invocationStarted (IInvocationContext context)

テスト呼び出しの開始を報告します。

TradeFederation フレームワークによって自動的に呼び出されます。複数のデバイスのレポートをサポートするには、レポーターがこのメソッドをオーバーライドする必要があります。

パラメータ
context IInvocationContext: 呼び出しに関する情報

isDisabled

public boolean isDisabled ()

オブジェクト全体が無効になっている場合（セットアップとテイクダウンの両方をスキップ）、true を返します。それ以外の場合は False です。

戻り値
boolean

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。

setBuildInfo

public void setBuildInfo (IBuildInfo buildInfo)

このメソッドは非推奨です。
テストでは不要になりました。

ビルド情報を設定します。テスト専用です。

パラメータ
buildInfo IBuildInfo

setDisable

public void setDisable (boolean isDisabled)

オブジェクトを無効にするかどうかを設定します。無効にすると、セットアップとティアダウンの両方の手順がスキップされます。デフォルト コンストラクタでオブジェクトをデフォルトで無効にするために使用できます。

パラメータ
isDisabled boolean: オブジェクトを配置する状態。

setMergeStrategy

public void setMergeStrategy (MergeStrategy strategy)

結果の統合時に使用する MergeStrategy を設定します。

パラメータ
strategy MergeStrategy

testAssumptionFailure

public void testAssumptionFailure (TestDescription test, 
                String trace)

アトミック テストが false の条件を前提としていることを報告するフラグが立てられたときに呼び出されます。

パラメータ
test TestDescription: テストを識別します。
trace String: 障害のスタック トレース

testAssumptionFailure

public void testAssumptionFailure (TestDescription test, 
                FailureDescription failure)

アトミック テストが false の条件を前提としていることを報告するフラグが立てられたときに呼び出されます。

パラメータ
test TestDescription: テストを識別します。
failure FailureDescription: エラーとそのコンテキストを記述する FailureDescription。

testEnded

public void testEnded (TestDescription test, 
                long endTime, 
                 testMetrics)

終了時間を直接指定できる ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)) の代替手段。正確な測定を行うには、testStarted(com.android.tradefed.result.TestDescription, long) と組み合わせてください。

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

testEnded

public void testEnded (TestDescription test, 
                 testMetrics)

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

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

パラメータ
test TestDescription: テストを識別します。
testMetrics : 出力された指標の ERROR(/Map)

testFailed

public void testFailed (TestDescription test, 
                FailureDescription failure)

個々のテストケースの失敗を報告します。

testStarted と testEnded の間で呼び出されます。

パラメータ
test TestDescription: テストを識別します。
failure FailureDescription: 障害とそのコンテキストを記述する FailureDescription。

testFailed

public void testFailed (TestDescription test, 
                String trace)

個々のテストケースの失敗を報告します。

testStarted と testEnded の間で呼び出されます。

パラメータ
test TestDescription: テストを識別します。
trace String: 障害のスタック トレース

testIgnored

public void testIgnored (TestDescription test)

テストが実行されない場合に呼び出されます（通常は、テストメソッドに org.junit.Ignore がアノテーションされているため）。

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

testModuleEnded

public void testModuleEnded ()

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

testModuleStarted

public void testModuleStarted (IInvocationContext moduleContext)

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

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

testRunEnded

public void testRunEnded (long elapsedTime, 
                 runMetrics)

テスト実行の終了をレポートします。

パラメータ
elapsedTime long: デバイスが報告した経過時間（ミリ秒単位）
runMetrics : テスト実行の終了時に報告される Key-Value ペア

testRunFailed

public void testRunFailed (FailureDescription failure)

FailureDescription で説明されているエラーが原因で、テスト実行が完了しなかったことを報告します。

パラメータ
failure FailureDescription: 障害とそのコンテキストを記述する FailureDescription。

testRunFailed

public void testRunFailed (String errorMessage)

致命的なエラーが発生したため、レポートのテスト実行が完了しませんでした。

パラメータ
errorMessage String: 実行失敗の理由を説明する String。

testRunStarted

public void testRunStarted (String name, 
                int numTests, 
                int attemptNumber)

テスト実行の開始を報告します。

パラメータ
name String: テスト実行名
numTests int: テスト実行のテストの合計数
attemptNumber int: オーダー番号。同じ runName を複数回実行する際の試行を識別します。attemptNumber は 0 から始まり、新しい実行が行われるたびにインクリメントされます。たとえば、テストが 3 回きめ細かく再試行された場合、同じ runName で合計 4 回の実行が行われ、attemptNumber は 0 ～ 3 になります。

testRunStarted

public void testRunStarted (String name, 
                int numTests)

テスト実行の開始を報告します。

パラメータ
name String: テスト実行名
numTests int: テスト実行のテスト数の合計

testRunStarted

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

テスト実行の開始を報告します。

パラメータ
name String: テスト実行名
numTests int: テスト実行のテストの合計数
attemptNumber int: オーダー番号。同じ runName を複数回実行する際の試行を識別します。attemptNumber は 0 から始まり、新しい実行が行われるたびにインクリメントされます。たとえば、テストが 3 回きめ細かく再試行された場合、同じ runName で合計 4 回の実行が行われ、attemptNumber は 0 ～ 3 になります。
startTime long: 実行が開始された時刻（System.currentTimeMillis() で測定）

testRunStopped

public void testRunStopped (long elapsedTime)

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

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

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

testSkipped

public void testSkipped (TestDescription test, 
                SkipReason reason)

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

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

testStarted

public void testStarted (TestDescription test, 
                long startTime)

testStarted(com.android.tradefed.result.TestDescription) の代替手段。テストの開始時刻も指定します。ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map)) と組み合わせて正確な測定を行います。

パラメータ
test TestDescription: テストを識別します。
startTime long: テストの開始時間（System.currentTimeMillis() で測定）

testStarted

public void testStarted (TestDescription test)

個々のテストケースの開始を報告します。古いインターフェースの場合は、可能な限り testStarted(com.android.tradefed.result.TestDescription) を使用してください。

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

保護されたメソッド

clearModuleLogFiles

protected final void clearModuleLogFiles ()

モジュール ファイルをクリーンアップして、モジュール ファイルを長時間保持しないようにします。

clearResultsForName

protected final void clearResultsForName (String testRunName)

特定の実行名の結果を消去できます。結果のアグリゲータなど、一部のケースでのみ使用してください。

パラメータ
testRunName String

setIsAggregrateMetrics

protected void setIsAggregrateMetrics (boolean aggregate)

[指標を集計] オプションを切り替える

パラメータ
aggregate boolean