IRemoteAndroidTestRunner

public interface IRemoteAndroidTestRunner

com.android.ddmlib.testrunner.IRemoteAndroidTestRunner

已知的间接子类 AndroidTestOrchestratorRemoteTestRunner、DefaultRemoteAndroidTestRunner、RemoteAndroidTestRunner、UiAutomatorRunner AndroidTestOrchestratorRemoteTestRunner 使用 adb 命令和 AndroidTestOrchestrator 运行插桩 Android 测试。  DefaultRemoteAndroidTestRunner 扩展了 ddmlib RemoteAndroidTestRunner，以便为 Tradefed 使用情形设置一些默认值。  RemoteAndroidTestRunner 远程运行 Android 测试命令并报告结果。  UiAutomatorRunner 在设备上运行 UI Automator 测试并报告结果。

---

用于远程运行 Android 测试命令并将结果报告给监听器的接口。

摘要

公共方法
abstract void	addBooleanArg(String name, boolean value) 添加一个布尔值实参，以包含在插桩命令中。
abstract void	addInstrumentationArg(String name, String value) 添加了要包含在插桩命令中的实参。
abstract void	cancel() 请求取消此测试运行。
abstract IRemoteAndroidTestRunner.CoverageOutput	getCoverageOutputType() 返回 runner 生成的测试覆盖率类型。
abstract String	getPackageName() 返回应用软件包名称。
abstract String	getRunnerName() 返回 runnerName。
abstract void	removeInstrumentationArg(String name) 移除之前添加的实参。
abstract void	run(ITestRunListener... listeners) 执行此测试运行。
abstract void	run( listeners) 执行此测试运行。
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) 设置在设备上运行测试的 shell 命令输出之间允许的最大时间。
abstract void	setMaxTimeout(long maxTimeout, TimeUnit maxTimeUnits) 设置检测完成所需的最长时间。
abstract void	setMaxtimeToOutputResponse(int maxTimeToOutputResponse) 此方法已弃用。 使用 ERROR(/#setMaxTimeToOutputResponse(long,java.util.concurrent.TimeUnit))。
abstract void	setMethodName(String className, String testName) 设置仅运行指定的测试方法，必须在“run”之前调用。
abstract void	setRunName(String runName) 设置要向 ITestRunListener 报告的自定义运行名称，时间为 run() 如果未指定，将使用软件包名称
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：实参的值

另见：

• RemoteAndroidTestRunner.addInstrumentationArg(String, String)

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	如果设备在超过输出最长时间的期限内未输出任何测试结果。
	如果与设备的连接断开。

另见：

• setMaxtimeToOutputResponse(int)

得分

public abstract void run ( listeners)

执行此测试运行。

参数
listeners	：测试结果的监听器集合

抛出
TimeoutException	以防连接超时。
AdbCommandRejectedException	如果 adb 拒绝该命令
ShellCommandUnresponsiveException	如果设备在超过输出最长时间的期限内未输出任何测试结果。
	如果与设备的连接断开。

另见：

• setMaxtimeToOutputResponse(int)

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)

设置在设备上运行测试的 shell 命令输出之间允许的最大时间。

这样，您就可以设置超时时间，以防测试卡住而永远无法完成。这与连接的正常超时不同。

默认情况下，不会指定超时时间。

参数
maxTimeToOutputResponse	long：允许命令在最长多长时间内不输出任何响应。值为 0 表示该方法将无限期等待（直到 receiver 取消执行）命令输出，并且永远不会抛出异常。
maxTimeUnits	TimeUnit：非零 maxTimeToOutputResponse 和 maxTimeout 值的单位。

另见：

• IShellEnabledDevice.executeShellCommand(String, com.android.ddmlib.IShellOutputReceiver, long, long, TimeUnit)

setMaxTimeout

public abstract void setMaxTimeout (long maxTimeout, 
                TimeUnit maxTimeUnits)

设置检测完成所需的最长时间。

这样，您就可以设置超时时间，以防测试卡住而永远无法完成。这与连接的正常超时不同。

默认情况下，不会指定超时时间。

参数
maxTimeout	long：允许命令在最长多长时间内不输出任何响应。值为 0 表示该方法将无限期等待（直到 receiver 取消执行）命令输出，并且永远不会抛出异常。
maxTimeUnits	TimeUnit：非零 maxTimeToOutputResponse 和 maxTimeout 值的单位。

另见：

• IShellEnabledDevice.executeShellCommand(String, com.android.ddmlib.IShellOutputReceiver, long, long, TimeUnit)

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)

设置要向 ITestRunListener 报告的自定义运行名称，时间为 run()

如果未指定，将使用软件包名称

setTestCollection

public abstract void setTestCollection (boolean collection)

将此测试运行设置为测试收集模式。如果为 true，则会跳过测试执行，并设置成功收集测试所需的所有相应 runner 实参。

参数
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。