IRemoteAndroidTestRunner
public
interface
IRemoteAndroidTestRunner
| com.android.ddmlib.testrunner.IRemoteAndroidTestRunner |
Android テストコマンドをリモートで実行し、リスナーに結果をレポートするためのインターフェース。
概要
パブリック メソッド | |
|---|---|
abstract
void
|
addBooleanArg(String name, boolean value)
計測コマンドに含めるブール値引数を追加します。 |
abstract
void
|
addInstrumentationArg(String name, String value)
計測コマンドに含める引数を追加します。 |
abstract
void
|
cancel()
このテスト実行のキャンセルをリクエストします。 |
abstract
IRemoteAndroidTestRunner.CoverageOutput
|
getCoverageOutputType()
ランナーによって生成されるテスト カバレッジのタイプを返します。 |
abstract
String
|
getPackageName()
アプリケーションのパッケージ名を返します。 |
abstract
String
|
getRunnerName()
runnerName を返します。 |
abstract
void
|
removeInstrumentationArg(String name)
以前に追加された引数を削除します。 |
abstract
void
|
run(ITestRunListener... listeners)
このテスト実行を実行します。 |
abstract
void
|
run(
このテスト実行を実行します。 |
abstract
void
|
setAdditionalTestOutputLocation(String additionalTestDataPath)
テストアプリがアンインストールされる前にホストにコピーされる追加のテスト出力の場所を設定します。 |
abstract
void
|
setClassName(String className)
このクラスのテストのみを実行するように設定します。'run' の前に呼び出す必要があります。 |
abstract
void
|
setClassNames(String[] classNames)
指定されたクラス内のテストのみを実行するように設定します。'run' の前に呼び出す必要があります。 |
abstract
void
|
setCoverage(boolean coverage)
このテスト実行のコード カバレッジ モードを設定します。 |
abstract
void
|
setCoverageReportLocation(String reportPath)
生成されたカバレッジ レポートの場所を設定します。 |
abstract
void
|
setDebug(boolean debug)
このテスト実行のデバッグモードを設定します。 |
abstract
void
|
setLogOnly(boolean logOnly)
このテスト実行をログ専用モードに設定します。テストの実行はスキップされます。 |
abstract
void
|
setMaxTimeToOutputResponse(long maxTimeToOutputResponse, TimeUnit maxTimeUnits)
デバイスでテストを実行するシェル コマンドの出力間の最大許容時間を設定します。 |
abstract
void
|
setMaxTimeout(long maxTimeout, TimeUnit maxTimeUnits)
計測が完了するまでの最大許容時間を設定します。 |
abstract
void
|
setMaxtimeToOutputResponse(int maxTimeToOutputResponse)
このメソッドは非推奨です。 |
abstract
void
|
setMethodName(String className, String testName)
指定されたテストメソッドのみを実行するように設定します。'run' の前に呼び出す必要があります。 |
abstract
void
|
setRunName(String runName)
指定しない場合、パッケージ名が使用されます。 |
abstract
void
|
setTestCollection(boolean collection)
このテスト実行をテスト収集モードに設定します。 |
abstract
void
|
setTestPackageName(String packageName)
指定されたパッケージ内のすべてのテストを実行するように設定します。'run' の前に呼び出す必要があります。 |
abstract
void
|
setTestSize(IRemoteAndroidTestRunner.TestSize size)
指定されたサイズのテストのみを実行するように設定します。 |
パブリック メソッド
addBooleanArg
public abstract void addBooleanArg (String name,
boolean value)計測コマンドに含めるブール値の引数を追加します。
| パラメータ | |
|---|---|
name |
String: 計測バンドル引数の名前 |
value |
boolean: 引数の値 |
addInstrumentationArg
public abstract void addInstrumentationArg (String name,
String value)計測コマンドに含める引数を追加します。
「run」の前に呼び出す必要があります。指定された名前の引数がすでに指定されている場合、その値はオーバーライドされます。
| パラメータ | |
|---|---|
name |
String: 計測バンドル引数の名前 |
value |
String: 引数の値 |
キャンセル
public abstract void cancel ()
このテスト実行のキャンセルをリクエストします。
getCoverageOutputType
public abstract IRemoteAndroidTestRunner.CoverageOutput getCoverageOutputType ()
ランナーによって生成されるテスト カバレッジのタイプを返します。CoverageOutput をご覧ください。
| 戻り値 | |
|---|---|
IRemoteAndroidTestRunner.CoverageOutput |
|
getPackageName
public abstract String getPackageName ()
アプリケーションのパッケージ名を返します。
| 戻り値 | |
|---|---|
String |
|
getRunnerName
public abstract String getRunnerName ()
runnerName を返します。
| 戻り値 | |
|---|---|
String |
|
removeInstrumentationArg
public abstract void removeInstrumentationArg (String name)
以前に追加された引数を削除します。
| パラメータ | |
|---|---|
name |
String: 削除する計測バンドル引数の名前 |
ホームラン
public abstract void run (ITestRunListener... listeners)
このテスト実行を実行します。
ERROR(/#run(Collection)) のコンビニエンス メソッド。
| パラメータ | |
|---|---|
listeners |
ITestRunListener: テスト結果をリッスンします |
| 例外 | |
|---|---|
TimeoutException |
接続がタイムアウトした場合に、 |
AdbCommandRejectedException |
adb がコマンドを拒否した場合 |
ShellCommandUnresponsiveException |
デバイスが最大出力時間よりも長い期間、テスト結果を出力しなかった場合。 |
|
デバイスへの接続が失われた場合。 |
ホームラン
public abstract void run (listeners)
このテスト実行を実行します。
| パラメータ | |
|---|---|
listeners |
|
| 例外 | |
|---|---|
TimeoutException |
接続がタイムアウトした場合に、 |
AdbCommandRejectedException |
adb がコマンドを拒否した場合 |
ShellCommandUnresponsiveException |
デバイスが最大出力時間よりも長い期間、テスト結果を出力しなかった場合。 |
|
デバイスへの接続が失われた場合。 |
setAdditionalTestOutputLocation
public abstract void setAdditionalTestOutputLocation (String additionalTestDataPath)
テストアプリがアンインストールされる前にホストにコピーされる追加のテスト出力の場所を設定します。例: 生成されたベンチマーク レポート。
| パラメータ | |
|---|---|
additionalTestDataPath |
String |
setClassName
public abstract void setClassName (String className)
このクラスのテストのみを実行するように設定します。'run' の前に呼び出す必要があります。
| パラメータ | |
|---|---|
className |
String: 完全修飾クラス名（例: x.y.z） |
setClassNames
public abstract void setClassNames (String[] classNames)
指定されたクラスのテストのみを実行するように設定します。run の前に呼び出す必要があります。
複数のクラスを指定する場合は、複数のクラス引数構文をサポートする InstrumentationTestRunner が必要です。
| パラメータ | |
|---|---|
classNames |
String: 完全修飾クラス名の配列（例: x.y.z） |
setCoverage
public abstract void setCoverage (boolean coverage)
このテスト実行のコード カバレッジ モードを設定します。
| パラメータ | |
|---|---|
coverage |
boolean |
setCoverageReportLocation
public abstract void setCoverageReportLocation (String reportPath)
生成されたカバレッジ レポートの場所を設定します。
| パラメータ | |
|---|---|
reportPath |
String |
setDebug
public abstract void setDebug (boolean debug)
このテスト実行のデバッグモードを設定します。true の場合、Android テストランナーは、デバッガがアタッチされるのを待ってからテストの実行に進みます。
| パラメータ | |
|---|---|
debug |
boolean |
setLogOnly
public abstract void setLogOnly (boolean logOnly)
このテスト実行をログ専用モードに設定します。テストの実行はスキップされます。
| パラメータ | |
|---|---|
logOnly |
boolean |
setMaxTimeToOutputResponse
public abstract void setMaxTimeToOutputResponse (long maxTimeToOutputResponse,
TimeUnit maxTimeUnits)デバイスでテストを実行するシェル コマンドの出力間の最大許容時間を設定します。
これにより、テストがスタックして終了しない場合にタイムアウトを設定できます。これは、接続の通常のタイムアウトとは異なります。
デフォルトでは、タイムアウトは指定されません。
| パラメータ | |
|---|---|
maxTimeToOutputResponse |
long: コマンドがレスポンスを出力しないことが許容される最大時間。値が 0 の場合、メソッドはコマンド出力が返されるまで（receiver が実行をキャンセルするまで）永久に待機し、例外をスローしません。 |
maxTimeUnits |
TimeUnit: ゼロ以外の maxTimeToOutputResponse 値と maxTimeout 値の単位。 |
setMaxTimeout
public abstract void setMaxTimeout (long maxTimeout,
TimeUnit maxTimeUnits)計測が完了するまでの最大許容時間を設定します。
これにより、テストがスタックして終了しない場合にタイムアウトを設定できます。これは、接続の通常のタイムアウトとは異なります。
デフォルトでは、タイムアウトは指定されません。
| パラメータ | |
|---|---|
maxTimeout |
long: コマンドがレスポンスを出力しないことが許容される最大時間。値が 0 の場合、メソッドはコマンド出力が返されるまで（receiver が実行をキャンセルするまで）永久に待機し、例外をスローしません。 |
maxTimeUnits |
TimeUnit: ゼロ以外の maxTimeToOutputResponse 値と maxTimeout 値の単位。 |
setMaxtimeToOutputResponse
public abstract void setMaxtimeToOutputResponse (int maxTimeToOutputResponse)
このメソッドは非推奨です。
ERROR(/#setMaxTimeToOutputResponse(long,java.util.concurrent.TimeUnit)) を使用します。
| パラメータ | |
|---|---|
maxTimeToOutputResponse |
int |
setMethodName
public abstract void setMethodName (String className,
String testName)指定されたテストメソッドのみを実行するように設定します。'run' の前に呼び出す必要があります。
| パラメータ | |
|---|---|
className |
String: 完全修飾クラス名（例: x.y.z） |
testName |
String: メソッド名 |
setRunName
public abstract void setRunName (String runName)
run( の ITestRunListener にレポートされるカスタム実行名を設定します。
指定しない場合、パッケージ名が使用されます
setTestCollection
public abstract void setTestCollection (boolean collection)
このテスト実行をテスト収集モードに設定します。true の場合、テストの実行をスキップし、テスト コレクションを成功させるために必要なすべての適切なランナー引数を設定します。
| パラメータ | |
|---|---|
collection |
boolean |
setTestPackageName
public abstract void setTestPackageName (String packageName)
指定されたパッケージ内のすべてのテストを実行するように設定します。'run' の前に呼び出す必要があります。
| パラメータ | |
|---|---|
packageName |
String: 完全修飾されたパッケージ名（例: x.y.z） |
setTestSize
public abstract void setTestSize (IRemoteAndroidTestRunner.TestSize size)
指定されたサイズのテストのみを実行するように設定します。「run」の前に呼び出す必要があります。
| パラメータ | |
|---|---|
size |
IRemoteAndroidTestRunner.TestSize: 実行する TestSize。 |