テストリスナーの収集
public class CollectingTestListener
extends Object
implements ITestInvocationListener , ILogSaverListener , IDisableable
java.lang.オブジェクト | |
↳ | com.android.tradefed.result.CollectingTestListener |
すべてのテスト結果を収集するITestInvocationListener
。
このオブジェクトで使用されるデータ構造はスレッドセーフですが、 ITestInvocationListener
コールバックは正しい順序で呼び出される必要があります。
まとめ
パブリックコンストラクター | |
---|---|
CollectingTestListener () |
パブリックメソッド | |
---|---|
IBuildInfo | getBuildInfo () このメソッドは廃止されました。 |
TestRunResult | getCurrentRunResults () 現在のテスト実行の結果を取得します。 |
int | getExpectedTests () 予想されるテスト数を返します。 |
IInvocationContext | getInvocationContext () |
getMergedTestRunResults () さまざまな試行にわたるすべての実行の結果のマージされたコレクションを返します。 | |
IInvocationContext | getModuleContextForRunResult (String testRunName) 結果に関連付けられたモジュールの |
MultiMap <String, LogFile > | getModuleLogFiles () モジュールに関連付けられたすべてのログファイルを含むマップのコピーを返します。 |
MultiMap <String, LogFile > | getNonAssociatedLogFiles () テスト実行またはモジュールに関連付けられていないすべてのログ ファイルを含むマップのコピーを返します。 |
int | getNumAllFailedTestRuns () 失敗状態で実行されたテストの合計数を返します。 |
int | getNumAllFailedTests () 失敗状態にあるテストの合計数を返します (失敗のみ。想定失敗はカウントされません)。 |
int | getNumTestsInState (TestResult.TestStatus status) この実行で指定された状態にあるテストの数を返します。 |
int | getNumTotalTests () すべての実行に対する完了したテストの合計数を返します。 |
IBuildInfo | getPrimaryBuildInfo () |
getRunResults () このメソッドは廃止されました。 | |
TestRunResult | getTestRunAtAttempt (String testRunName, int attempt) 1 回の試行に対する |
int | getTestRunAttemptCount (String testRunName) 指定されたテスト実行名の試行回数を返します。 |
getTestRunAttempts (String testRunName) 指定されたテスト実行の | |
getTestRunForAttempts (int attempt) 指定された試行に対するすべての結果を取得します。 | |
getTestRunNames () すべてのテスト実行のすべての名前を返します。 | |
boolean | hasFailedTests () 呼び出しに失敗したテストまたは仮定に失敗したテストがあった場合に返します。 |
boolean | hasTestRunResultsForName (String testRunName) 指定されたテスト実行名に結果があるかどうかを返します。 |
void | invocationEnded (long elapsedTime) 正常に終了したか、何らかのエラー条件により呼び出しが終了したことを報告します。 |
void | invocationFailed (Throwable cause) 何らかのエラー状態が原因で不完全な呼び出しを報告します。 |
void | invocationStarted ( IInvocationContext context) テスト呼び出しの開始を報告します。 |
boolean | isDisabled () オブジェクト全体が無効な場合 (セットアップとティアダウンの両方をスキップする)、True を返します。 |
void | logAssociation (String dataName, LogFile logFile) 場合によっては、ログをテスト ケースと強く関連付ける必要がありますが、直接 |
void | setBuildInfo ( IBuildInfo buildInfo) このメソッドは廃止されました。もうテストには必要ありません。 |
void | setDisable (boolean isDisabled) オブジェクトを無効にするかどうかを設定します。 |
void | setMergeStrategy ( MergeStrategy strategy) 結果をマージするときに使用する |
void | testAssumptionFailure ( TestDescription test, String trace) アトミック テストが条件が false であると仮定することを示すフラグを立てたときに呼び出されます。 |
void | testAssumptionFailure ( TestDescription test, FailureDescription failure) アトミック テストが条件が false であると仮定することを示すフラグを立てたときに呼び出されます。 |
void | testEnded ( TestDescription test, long endTime, testMetrics) testEnded ( TestDescription test, long endTime, testMetrics) |
void | testEnded ( TestDescription test, testMetrics) 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) testRunEnded (long elapsedTime, runMetrics) テスト実行の終了を報告します。 |
void | testRunFailed ( FailureDescription failure) |
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 | testStarted ( TestDescription test, long startTime) |
void | testStarted ( TestDescription test) 個々のテスト ケースの開始を報告します。 |
保護されたメソッド | |
---|---|
final void | clearModuleLogFiles () モジュール ファイルをクリーニングできるため、長時間持ち運ぶことがなくなります。 |
final void | clearResultsForName (String testRunName) 指定された実行名の結果をクリアできます。 |
void | setIsAggregrateMetrics (boolean aggregate) 「集計メトリクス」オプションを切り替えます |
パブリックコンストラクター
テストリスナーの収集
public CollectingTestListener ()
パブリックメソッド
ビルド情報の取得
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
publicgetMergedTestRunResults ()
さまざまな試行にわたるすべての実行の結果のマージされたコレクションを返します。
複数の結果がある場合、各テスト実行はマージされ、最新のテスト結果が以前の実行のテスト結果を上書きします。テストの実行は試行番号順に並べられます。
同じ試行のメトリクスは、 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 (TestResult.TestStatus status)
この実行で指定された状態にあるテストの数を返します。
パラメーター | |
---|---|
status | TestResult.TestStatus |
戻り値 | |
---|---|
int |
getNumTotalTests
public int getNumTotalTests ()
すべての実行に対する完了したテストの合計数を返します。
戻り値 | |
---|---|
int |
getPrimaryBuildInfo
public IBuildInfo getPrimaryBuildInfo ()
invocationStarted(com.android.tradefed.invoker.IInvocationContext)
経由で報告されたプライマリ ビルド情報を返します。プライマリ ビルドは、実行コンフィギュレーションの最初のビルド プロバイダーによって返されるビルドです。コンテキストがない場合 (テスト ケースへのビルドがない場合)、null を返します。
戻り値 | |
---|---|
IBuildInfo |
getRunResults
publicgetRunResults ()
このメソッドは廃止されました。
getMergedTestRunResults()
を使用する
すべてのテスト実行の結果を返します。
戻り値 | |
---|---|
getTestRunAttempt
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
publicgetTestRunAttempts (String testRunName)
指定されたテスト実行のTestRunResult
に対するすべての試行を取得します。
パラメーター | |
---|---|
testRunName | String : { testRunStarted(String, int) によって指定された名前。 |
戻り値 | |
---|---|
試行順に並べられた、特定のテスト実行のすべてのTestRunResult 。 |
getTestRunForAttempts
publicgetTestRunForAttempts (int attempt)
指定された試行に対するすべての結果を取得します。
パラメーター | |
---|---|
attempt | int : 結果が必要な試行。 |
戻り値 | |
---|---|
特定の試行に対するすべてのTestRunResult 。 |
getTestRunNames
publicgetTestRunNames ()
すべてのテスト実行のすべての名前を返します。
これらのテスト実行は、異なる試行で複数回実行された可能性があります。
戻り値 | |
---|---|
失敗したテスト
public boolean hasFailedTests ()
呼び出しに失敗したテストまたは仮定に失敗したテストがあった場合に返します。
戻り値 | |
---|---|
boolean |
hasTestRunResultsForName
public boolean hasTestRunResultsForName (String testRunName)
指定されたテスト実行名に結果があるかどうかを返します。
パラメーター | |
---|---|
testRunName | String : { testRunStarted(String, int) によって指定された名前。 |
戻り値 | |
---|---|
boolean |
呼び出し終了
public void invocationEnded (long elapsedTime)
正常に終了したか、何らかのエラー条件により呼び出しが終了したことを報告します。
TradeFederation フレームワークによって自動的に呼び出されます。パラメーター | |
---|---|
elapsedTime | long : 呼び出しの経過時間 (ミリ秒) |
呼び出し失敗
public void invocationFailed (Throwable cause)
何らかのエラー状態が原因で不完全な呼び出しを報告します。
TradeFederation フレームワークによって自動的に呼び出されます。パラメーター | |
---|---|
cause | Throwable : Throwable の失敗の原因 |
呼び出し開始
public void invocationStarted (IInvocationContext context)
テスト呼び出しの開始を報告します。
TradeFederation フレームワークによって自動的に呼び出されます。複数のデバイスのレポートをサポートするには、レポーターはこのメソッドをオーバーライドする必要があります。
パラメーター | |
---|---|
context | IInvocationContext : 呼び出しに関する情報 |
無効になっています
public boolean isDisabled ()
オブジェクト全体が無効な場合 (セットアップとティアダウンの両方をスキップする)、True を返します。それ以外の場合は false。
戻り値 | |
---|---|
boolean |
ログ関連付け
public void logAssociation (String dataName, LogFile logFile)
場合によっては、ログをテスト ケースと強く関連付ける必要がありますが、直接testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.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 |
テスト仮定失敗
public void testAssumptionFailure (TestDescription test, String trace)
アトミック テストが条件が false であると仮定することを示すフラグを立てたときに呼び出されます。
パラメーター | |
---|---|
test | TestDescription : テストを識別します |
trace | String : 失敗のスタック トレース |
テスト仮定失敗
public void testAssumptionFailure (TestDescription test, FailureDescription failure)
アトミック テストが条件が false であると仮定することを示すフラグを立てたときに呼び出されます。
パラメーター | |
---|---|
test | TestDescription : テストを識別します |
failure | FailureDescription : 失敗とそのコンテキストを説明するFailureDescription 。 |
テスト終了
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) |
テスト終了
public void testEnded (TestDescription test,testMetrics)
個々のテスト ケースの実行終了を報告します。
testFailed(TestDescription, FailureDescription)
呼び出されなかった場合、このテストは合格です。また、テスト ケースの実行中に出力された可能性のあるキー/値メトリクスも返します。
パラメーター | |
---|---|
test | TestDescription : テストを識別します |
testMetrics | ERROR(/Map) |
テスト失敗
public void testFailed (TestDescription test, FailureDescription failure)
個々のテスト ケースの失敗を報告します。
testStarted と testEnded の間で呼び出されます。
パラメーター | |
---|---|
test | TestDescription : テストを識別します |
failure | FailureDescription : 失敗とそのコンテキストを説明するFailureDescription 。 |
テスト失敗
public void testFailed (TestDescription test, String trace)
個々のテスト ケースの失敗を報告します。
testStarted と testEnded の間で呼び出されます。
パラメーター | |
---|---|
test | TestDescription : テストを識別します |
trace | String : 失敗のスタック トレース |
テスト無視されました
public void testIgnored (TestDescription test)
通常、テスト メソッドに org.junit.Ignore アノテーションが付けられているため、テストが実行されないときに呼び出されます。
パラメーター | |
---|---|
test | TestDescription : テストを識別します |
テストモジュール終了
public void testModuleEnded ()
モジュールの実行の終了を報告します。
テストモジュールが開始されました
public void testModuleStarted (IInvocationContext moduleContext)
モジュールの実行の開始を報告します。このコールバックはtestModuleEnded()
に関連付けられており、シーケンス内ではオプションです。これは、モジュール (スイート ベースのランナー) を使用する実行中にのみ使用されます。
パラメーター | |
---|---|
moduleContext | IInvocationContext : モジュールのIInvocationContext 。 |
テスト実行終了
public void testRunEnded (long elapsedTime,runMetrics)
テスト実行の終了を報告します。修正: タイプの異なる 2 つの Map<> インターフェイスを使用することはできないため、ここでは HashMap を使用する必要があります。
パラメーター | |
---|---|
elapsedTime | long : デバイスが報告した経過時間 (ミリ秒単位) |
runMetrics | Metric を使用したテスト実行の終了時に報告されたキーと値のペア。 |
テスト実行失敗
public void testRunFailed (FailureDescription failure)
FailureDescription
で説明されている障害のため、レポートのテスト実行が完了できませんでした。
パラメーター | |
---|---|
failure | FailureDescription : 失敗とそのコンテキストを説明するFailureDescription 。 |
テスト実行失敗
public void testRunFailed (String errorMessage)
レポートのテスト実行は、致命的なエラーのため完了できませんでした。
パラメーター | |
---|---|
errorMessage | String : 実行失敗の理由を説明するString 。 |
テスト実行開始しました
public void testRunStarted (String name, int numTests, int attemptNumber)
テスト実行の開始を報告します。
パラメーター | |
---|---|
name | String : テスト実行名 |
numTests | int : テスト実行のテストの総数 |
attemptNumber | int : 順序番号。複数回実行される同じ runName の異なる試行を識別します。 attemptNumber は 0 から始まるインデックスであり、新しい実行が発生するたびに増加する必要があります。たとえば、テストは 3 回詳細に再試行され、同じ runName で合計 4 回の実行が必要で、attemptNumber は 0 ~ 3 です。 |
テスト実行開始しました
public void testRunStarted (String name, int numTests)
テスト実行の開始を報告します。
パラメーター | |
---|---|
name | String : テスト実行名 |
numTests | int : テスト実行のテストの総数 |
テスト実行開始しました
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() によって測定された実行の開始時刻 |
テスト実行停止
public void testRunStopped (long elapsedTime)
ユーザーの要求により、テスト実行が完了前に停止したことをレポートします。
TODO: 現在使用されていないため、削除することを検討してください
パラメーター | |
---|---|
elapsedTime | long : デバイスが報告した経過時間 (ミリ秒単位) |
テスト開始
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() によって測定されたテストの開始時刻 |
テスト開始
public void testStarted (TestDescription test)
個々のテスト ケースの開始を報告します。古いインターフェイスでは、可能な限りtestStarted(com.android.tradefed.result.TestDescription)
を使用する必要があります。
パラメーター | |
---|---|
test | TestDescription : テストを識別します |
保護されたメソッド
クリアモジュールログファイル
protected final void clearModuleLogFiles ()
モジュール ファイルをクリーニングできるため、長時間持ち運ぶことがなくなります。
クリア結果の名前
protected final void clearResultsForName (String testRunName)
指定された実行名の結果をクリアできます。結果の集計など、一部の場合にのみ使用してください。
パラメーター | |
---|---|
testRunName | String |
setIsAggregrateMetrics
protected void setIsAggregrateMetrics (boolean aggregate)
「集計メトリクス」オプションを切り替えます
パラメーター | |
---|---|
aggregate | boolean |