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)

指定された実行名の結果をクリアできます。
final void clearTestRunResults()

テスト実行結果をすべてクリアして、長期間保持しないようにします。
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 特定のテスト実行名 null のモジュールの IInvocationContext（その名前に結果がない場合）。

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: 実行名が同じで複数回実行される異なる試行を識別する注文番号。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: 実行名が同じで複数回実行される異なる試行を識別する注文番号。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

clearTestRunResults

protected final void clearTestRunResults ()

テスト実行結果をすべてクリアして、長期間保持しないようにします。

setIsAggregrateMetrics

protected void setIsAggregrateMetrics (boolean aggregate)

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

パラメータ
aggregate boolean