NameMangleListener

public abstract class NameMangleListener
extends Object implements ITestInvocationListener

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


結果が報告されたときにテストメソッド、クラス、パッケージ名を変換するプロキシ リスナー。

概要

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

NameMangleListener(ITestInvocationListener listener)

パブリック メソッド

TestSummary getSummary()

InvocationListener がサマリーを返すことを許可します。

void invocationEnded(long elapsedTime)

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

void invocationFailed(Throwable cause)

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

void invocationStarted(IInvocationContext context)

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

void testAssumptionFailure(TestDescription test, String trace)

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

void testEnded(TestDescription test, testMetrics)

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

void testFailed(TestDescription test, String trace)

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

void testIgnored(TestDescription test)

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

void testLog(String dataName, LogDataType dataType, InputStreamSource dataStream)

テスト呼び出しから関連するログデータまたはデバッグデータを提供します。

void testRunEnded(long elapsedTime, runMetrics)

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

void testRunFailed(String errorMessage)

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

void testRunStarted(String runName, int testCount)

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

void testRunStopped(long elapsedTime)

ユーザー リクエストが原因で、テスト実行が完了する前に停止したことを報告します。

void testStarted(TestDescription test)

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

保護されたメソッド

TestDescription mangleTestId(TestDescription test)

このメソッドは、testStarted(com.android.tradefed.result.TestDescription)testFailed(com.android.tradefed.result.TestDescription, String)ERROR(/#testEnded(com.android.tradefed.result.TestDescription,HashMap)) コールバックに渡されるすべての TestDescription で実行されます。

String mangleTestRunName(String name)

このメソッドは、testRunStarted(String, int) コールバックに渡されるすべてのテスト実行名で実行されます。

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

NameMangleListener

public NameMangleListener (ITestInvocationListener listener)

パラメータ
listener ITestInvocationListener

パブリック メソッド

getSummary

public TestSummary getSummary ()

InvocationListener がサマリーを返すことを許可します。

戻り値
TestSummary 実行を要約した TestSummary(null の場合もあります)

invocationEnded

public void invocationEnded (long elapsedTime)

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

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

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

invocationFailed

public void invocationFailed (Throwable cause)

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

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

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

invocationStarted

public void invocationStarted (IInvocationContext context)

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

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

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

testAssumptionFailure

public void testAssumptionFailure (TestDescription test, 
                String trace)

アトミック テストで、条件が false であるとフラグが立てられたときに呼び出されます

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

trace String: 障害のスタック トレース

testEnded

public void testEnded (TestDescription test, 
                 testMetrics)

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

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

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

testMetrics : 出力された指標の ERROR(/Map)

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: テストを識別します。

testLog

public void testLog (String dataName, 
                LogDataType dataType, 
                InputStreamSource dataStream)

テスト呼び出しの関連ログまたはデバッグデータを提供します。

ERROR(/ITestInvocationListener#invocationFailed(Throwable)) または ERROR(/ITestInvocationListener#invocationEnded(long)) の前に呼び出す必要があります。

TradeFederation フレームワークは、このメソッドを自動的に呼び出し、ホストログと、必要に応じてデバイスの logcat を提供します。

パラメータ
dataName String: データのわかりやすい名前(例: device_logcat)。String注: dataName は呼び出しごとに一意ではない場合があります。つまり、実装者は同じ dataName で複数の呼び出しを処理できる必要があります。

dataType LogDataType: データの LogDataType

dataStream InputStreamSource: データの InputStreamSource。実装者は createInputStream を呼び出してデータの読み取りを開始し、完了後に結果の InputStream を閉じる必要があります。呼び出し元は、testLog メソッドが完了するまで、データソースが存在し、アクセス可能であることを確認する必要があります。

testRunEnded

public void testRunEnded (long elapsedTime, 
                 runMetrics)

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

パラメータ
elapsedTime long: デバイスで報告された経過時間(ミリ秒単位)

runMetrics : テスト実行の終了時に報告される Key-Value ペア

testRunFailed

public void testRunFailed (String errorMessage)

致命的なエラーのため、テスト実行を完了できなかったことをレポートします。

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

testRunStarted

public void testRunStarted (String runName, 
                int testCount)

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

パラメータ
runName String: テスト実行名

testCount int: テスト実行のテスト数の合計

testRunStopped

public void testRunStopped (long elapsedTime)

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

TODO: 現在は使用されていないため、削除を検討してください

パラメータ
elapsedTime long: デバイスで報告された経過時間(ミリ秒単位)

testStarted

public void testStarted (TestDescription test)

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

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

保護されたメソッド

mangleTestId

protected TestDescription mangleTestId (TestDescription test)

このメソッドは、testStarted(com.android.tradefed.result.TestDescription)testFailed(com.android.tradefed.result.TestDescription, String)ERROR(/#testEnded(com.android.tradefed.result.TestDescription,HashMap)) コールバックに渡されるすべての TestDescription で実行されます。このメソッドは、コンストラクション時に指定されたダウンストリームの ITestInvocationListener に渡される、異なる TestDescription を返す必要があります。

実装では、元の TestDescription を変更しないように注意する必要があります。

デフォルトの実装では、受信した ID を変更せずに渡します。

パラメータ
test TestDescription

戻り値
TestDescription

mangleTestRunName

protected String mangleTestRunName (String name)

このメソッドは、testRunStarted(String, int) コールバックに渡されるすべてのテスト実行名で実行されます。このメソッドは、コンストラクション時に指定されたダウンストリームの ITestInvocationListener に渡される、異なるテスト実行名を返す必要があります。

実装では、元の実行名を変更しないように注意する必要があります。

デフォルトの実装では、受信したテスト実行名を変更せずに渡します。

パラメータ
name String

戻り値
String