IRemoteAndroidTestRunner

public interface IRemoteAndroidTestRunner

com.android.ddmlib.testrunner.IRemoteAndroidTestRunner


Es una interfaz para ejecutar un comando de prueba de Android de forma remota y registrar el resultado en un objeto de escucha.

Resumen

Métodos públicos

abstract void addBooleanArg(String name, boolean value)

Agrega un argumento booleano para incluir en el comando de instrumentación.

abstract void addInstrumentationArg(String name, String value)

Agrega un argumento para incluir en el comando de instrumentación.

abstract void cancel()

Solicita la cancelación de esta ejecución de prueba.

abstract IRemoteAndroidTestRunner.CoverageOutput getCoverageOutputType()

Devuelve el tipo de cobertura de pruebas que produce el ejecutor.

abstract String getPackageName()

Devuelve el nombre del paquete de la aplicación.

abstract String getRunnerName()

Devuelve el valor de runnerName.

abstract void removeInstrumentationArg(String name)

Quita un argumento agregado anteriormente.

abstract void run(ITestRunListener... listeners)

Ejecuta esta prueba.

abstract void run( listeners)

Ejecuta esta prueba.

abstract void setAdditionalTestOutputLocation(String additionalTestDataPath)

Establece la ubicación de la salida de prueba adicional que se copiará en el host antes de desinstalar la app de prueba.

abstract void setClassName(String className)

Establece que solo se ejecuten las pruebas de esta clase. Se debe llamar antes de "run".

abstract void setClassNames(String[] classNames)

Establece que solo se ejecuten las pruebas en las clases proporcionadas. Se debe llamar antes de "run".

abstract void setCoverage(boolean coverage)

Establece el modo de cobertura de código de esta ejecución de prueba.

abstract void setCoverageReportLocation(String reportPath)

Establece la ubicación de los informes de cobertura generados.

abstract void setDebug(boolean debug)

Establece el modo de depuración de esta ejecución de prueba.

abstract void setLogOnly(boolean logOnly)

Establece esta ejecución de prueba en modo de solo registro, lo que omite la ejecución de la prueba.

abstract void setMaxTimeToOutputResponse(long maxTimeToOutputResponse, TimeUnit maxTimeUnits)

Establece el tiempo máximo permitido entre la salida del comando de shell que ejecuta las pruebas en los dispositivos.

abstract void setMaxTimeout(long maxTimeout, TimeUnit maxTimeUnits)

Establece el tiempo máximo permitido para que finalice la instrumentación.

abstract void setMaxtimeToOutputResponse(int maxTimeToOutputResponse)

Este método dejó de estar disponible. Usa ERROR(/#setMaxTimeToOutputResponse(long,java.util.concurrent.TimeUnit)).

abstract void setMethodName(String className, String testName)

Establece que solo se ejecute el método de prueba especificado. Se debe llamar antes de "run".

abstract void setRunName(String runName)

Establece un nombre de ejecución personalizado para que se informe a ITestRunListener en run()

Si no se especifica, se usará el nombre del paquete.

abstract void setTestCollection(boolean collection)

Establece esta ejecución de prueba en el modo de recopilación de pruebas.

abstract void setTestPackageName(String packageName)

Establece que se ejecuten todas las pruebas en el paquete especificado. Se debe llamar antes de "run".

abstract void setTestSize(IRemoteAndroidTestRunner.TestSize size)

Establece que solo se ejecuten pruebas del tamaño determinado.

Métodos públicos

addBooleanArg

public abstract void addBooleanArg (String name, 
                boolean value)

Agrega un argumento booleano para incluir en el comando de instrumentación.

Parámetros
name String: El nombre del argumento del paquete de la instrumentación

value boolean: Es el valor del argumento.

addInstrumentationArg

public abstract void addInstrumentationArg (String name, 
                String value)

Agrega un argumento para incluir en el comando de instrumentación.

Se debe llamar antes de "run". Si ya se proporcionó un argumento con el nombre determinado, se anulará su valor.

Parámetros
name String: El nombre del argumento del paquete de la instrumentación

value String: Es el valor del argumento.

cancelar

public abstract void cancel ()

Solicita la cancelación de esta ejecución de prueba.

getCoverageOutputType

public abstract IRemoteAndroidTestRunner.CoverageOutput getCoverageOutputType ()

Devuelve el tipo de cobertura de pruebas que produce el ejecutor. Consulta los CoverageOutput.

Muestra
IRemoteAndroidTestRunner.CoverageOutput

getPackageName

public abstract String getPackageName ()

Devuelve el nombre del paquete de la aplicación.

Muestra
String

getRunnerName

public abstract String getRunnerName ()

Devuelve el valor de runnerName.

Muestra
String

removeInstrumentationArg

public abstract void removeInstrumentationArg (String name)

Quita un argumento agregado anteriormente.

Parámetros
name String: Es el nombre del argumento del paquete de instrumentación que se quitará.

run

public abstract void run (ITestRunListener... listeners)

Ejecuta esta prueba.

Método de conveniencia para ERROR(/#run(Collection)).

Parámetros
listeners ITestRunListener: Escucha los resultados de las pruebas

Arroja
TimeoutException en caso de que se agote el tiempo de espera de la conexión.
AdbCommandRejectedException Si adb rechaza el comando
ShellCommandUnresponsiveException Si el dispositivo no generó ningún resultado de prueba durante un período superior al tiempo máximo para generar resultados.
Si se perdió la conexión con el dispositivo

run

public abstract void run ( listeners)

Ejecuta esta prueba.

Parámetros
listeners : Colección de objetos de escucha para los resultados de las pruebas

Arroja
TimeoutException en caso de que se agote el tiempo de espera de la conexión.
AdbCommandRejectedException Si adb rechaza el comando
ShellCommandUnresponsiveException Si el dispositivo no generó ningún resultado de prueba durante un período superior al tiempo máximo para generar resultados.
Si se perdió la conexión con el dispositivo

setAdditionalTestOutputLocation

public abstract void setAdditionalTestOutputLocation (String additionalTestDataPath)

Establece la ubicación de la salida de prueba adicional que se copiará en el host antes de desinstalar la app de prueba. p. ej., informes comparativos generados

Parámetros
additionalTestDataPath String

setClassName

public abstract void setClassName (String className)

Establece que solo se ejecuten las pruebas de esta clase. Se debe llamar antes de "run".

Parámetros
className String: Nombre de clase completamente calificado (p. ej., x.y.z)

setClassNames

public abstract void setClassNames (String[] classNames)

Establece que solo se ejecuten las pruebas en las clases proporcionadas. Se debe llamar antes de "run".

Si se proporciona más de una clase, se requiere un InstrumentationTestRunner que admita la sintaxis de argumentos de varias clases.

Parámetros
classNames String: Es un array de nombres de clase completamente calificados (p. ej., x.y.z).

setCoverage

public abstract void setCoverage (boolean coverage)

Establece el modo de cobertura de código de esta ejecución de prueba.

Parámetros
coverage boolean

setCoverageReportLocation

public abstract void setCoverageReportLocation (String reportPath)

Establece la ubicación de los informes de cobertura generados.

Parámetros
reportPath String

setDebug

public abstract void setDebug (boolean debug)

Establece el modo de depuración de esta ejecución de prueba. Si es verdadero, el ejecutor de pruebas de Android esperará a que se adjunte un depurador antes de continuar con la ejecución de la prueba.

Parámetros
debug boolean

setLogOnly

public abstract void setLogOnly (boolean logOnly)

Establece esta ejecución de prueba en modo de solo registro, lo que omite la ejecución de la prueba.

Parámetros
logOnly boolean

setMaxTimeToOutputResponse

public abstract void setMaxTimeToOutputResponse (long maxTimeToOutputResponse, 
                TimeUnit maxTimeUnits)

Establece el tiempo máximo permitido entre la salida del comando de shell que ejecuta las pruebas en los dispositivos.

Esto permite establecer un tiempo de espera en caso de que las pruebas se queden atascadas y nunca finalicen. Esto es diferente del tiempo de espera normal de la conexión.

De forma predeterminada, no se especificará ningún tiempo de espera.

Parámetros
maxTimeToOutputResponse long: Es la cantidad máxima de tiempo durante la cual el comando puede no generar ninguna respuesta. Un valor de 0 significa que el método esperará indefinidamente (hasta que receiver cancele la ejecución) la salida del comando y nunca arrojará una excepción.

maxTimeUnits TimeUnit: Unidades para los valores maxTimeToOutputResponse y maxTimeout distintos de cero.

setMaxTimeout

public abstract void setMaxTimeout (long maxTimeout, 
                TimeUnit maxTimeUnits)

Establece el tiempo máximo permitido para que finalice la instrumentación.

Esto permite establecer un tiempo de espera en caso de que las pruebas se queden atascadas y nunca finalicen. Esto es diferente del tiempo de espera normal de la conexión.

De forma predeterminada, no se especificará ningún tiempo de espera.

Parámetros
maxTimeout long: Es la cantidad máxima de tiempo durante la cual el comando puede no generar ninguna respuesta. Un valor de 0 significa que el método esperará indefinidamente (hasta que receiver cancele la ejecución) la salida del comando y nunca arrojará una excepción.

maxTimeUnits TimeUnit: Unidades para los valores maxTimeToOutputResponse y maxTimeout distintos de cero.

setMaxtimeToOutputResponse

public abstract void setMaxtimeToOutputResponse (int maxTimeToOutputResponse)

Este método dejó de estar disponible.
Usa ERROR(/#setMaxTimeToOutputResponse(long,java.util.concurrent.TimeUnit)).

Parámetros
maxTimeToOutputResponse int

setMethodName

public abstract void setMethodName (String className, 
                String testName)

Establece que solo se ejecute el método de prueba especificado. Se debe llamar antes de "run".

Parámetros
className String: Nombre de clase completamente calificado (p. ej., x.y.z)

testName String: Nombre del método

setRunName

public abstract void setRunName (String runName)

Establece un nombre de ejecución personalizado para que se informe a ITestRunListener en run()

Si no se especifica, se usará el nombre del paquete.

setTestCollection

public abstract void setTestCollection (boolean collection)

Establece esta ejecución de prueba en el modo de recopilación de pruebas. Si es verdadero, se omitirá la ejecución de la prueba y se establecerán todos los argumentos del ejecutor adecuados que se requieren para una recopilación de pruebas exitosa.

Parámetros
collection boolean

setTestPackageName

public abstract void setTestPackageName (String packageName)

Establece que se ejecuten todas las pruebas en el paquete especificado. Se debe llamar antes de "run".

Parámetros
packageName String: Nombre del paquete completamente calificado (p. ej., x.y.z)

setTestSize

public abstract void setTestSize (IRemoteAndroidTestRunner.TestSize size)

Establece que solo se ejecuten pruebas del tamaño determinado. Se debe llamar antes de "run".

Parámetros
size IRemoteAndroidTestRunner.TestSize: Es el TestSize que se ejecutará.