CommandScheduler

public class CommandScheduler
extends Object implements ICommandScheduler

java.lang.Object
   ↳ com.android.tradefed.command.CommandScheduler

Un programador para ejecutar comandos de TradeFederation en todos los dispositivos disponibles.

Intentará priorizar los comandos que se ejecutarán en función de un recuento total de ejecución de su tiempo de ejecución. p.ej., los comandos de ejecución frecuentes o rápidos tendrán prioridad sobre los comandos de ejecución prolongada.

Se ejecuta de forma indefinida en segundo plano hasta que se apaga.

Resumen

Clases anidadas

enum CommandScheduler.HostState

Enumeraciones de diferentes estados del host  

Constructores públicos

CommandScheduler()

Crea un CommandScheduler.

Métodos públicos

boolean addCommand(String[] args)

Agrega un comando al programador.

void addCommandFile(String cmdFilePath, extraArgs)

Agrega todos los comandos del archivo determinado al programador.

void await()

Espera a que el programador comience a ejecutarse, lo que incluye esperar a que se complete la entrega de la TF anterior, si corresponde.

static TradefedDelegator checkDelegation(String[] args)

Crea un delegador basado en la línea de comandos para ver si necesitamos delegar la ejecución.

void completeHandover()

Informa al programador de comandos que una secuencia de transferencia iniciada está completa y que debe volver a inicializar su administrador remoto en el puerto predeterminado.

static createReleaseMap(IInvocationContext context, Throwable e)

Crea un mapa del estado de los dispositivos para que se puedan liberar de forma adecuada.

ISandbox createSandbox()

Crea un ISandbox que la invocación usará para ejecutarse.

void displayCommandQueue(PrintWriter printWriter)

Muestra información de depuración detallada sobre el estado de la cola de ejecución de comandos.

void displayCommandsInfo(PrintWriter printWriter, String regex)

Muestra una lista de los comandos actuales.

void displayInvocationsInfo(PrintWriter printWriter)

Muestra una lista de las invocaciones actuales.

void dumpCommandsXml(PrintWriter printWriter, String regex)

Vacía el archivo en formato XML expandido del comando con todos los valores de Option especificados para todos los comandos actuales.

void execCommand(ICommandScheduler.IScheduledInvocationListener listener, ITestDevice device, String[] args)

Ejecuta el comando directamente en el dispositivo ya asignado.

void execCommand(IInvocationContext context, ICommandScheduler.IScheduledInvocationListener listener, String[] args)

Aloca directamente un dispositivo y ejecuta un comando sin agregarlo a la cola de comandos con un IInvocationContext ya existente.

void execCommand(ICommandScheduler.IScheduledInvocationListener listener, String[] args)

Asignan directamente un dispositivo y ejecutan un comando sin agregarlo a la cola de comandos.

CommandFileWatcher getCommandFileWatcher()

Obtén el CommandFileWatcher adecuado para este programador

int getExecutingCommandCount()

Muestra la cantidad de comandos en estado de ejecución.

CommandScheduler.HostState getHostState()
String getInvocationInfo(int invocationId)

Muestra la información de una invocación especificando el ID de invocación.

CommandRunner.ExitCode getLastInvocationExitCode()

Muestra el código de error de la última invocación que se ejecutó.

Throwable getLastInvocationThrowable()

Muestra el Throwable de la última invocación que se ejecutó.

int getReadyCommandCount()

Muestra la cantidad de comandos en estado listo en la cola.

long getShutdownTimeout()
void handoverInitiationComplete()

Informa al programador de comandos que se completó el intercambio inicial de entrega de dispositivos y comandos en uso, y que puede comenzar a programar la operación.

boolean handoverShutdown(int handoverPort)

Inicia un shutdown() y lo entrega a otro proceso de Tradefed en este mismo host.

void notifyFileChanged(File cmdFile, extraArgs)
void removeAllCommands()

Quita todos los comandos del programador

void run()

Es el bloque de ejecución principal de este subproceso.

void setClearcutClient(ClearcutClient client)

Configura el cliente para que informe datos del arnés

boolean shouldShutdownOnCmdfileError()

Muestra verdadero si necesitamos cerrar el programador en un error de comando.

void shutdown()

Intenta cerrar el programador de comandos de forma ordenada.

void shutdownHard(boolean killAdb)

Intenta cerrar de manera forzosa el programador de comandos.

void shutdownHard()

Intenta cerrar de manera forzosa el programador de comandos.

void shutdownOnEmpty()

Es similar a shutdown(), pero esperará a que se ejecuten todos los comandos antes de salir.

void start()

Inicia el programador, incluida la configuración de registro, la inicialización de DeviceManager, etcétera.

boolean stopInvocation(ITestInvocation invocation)

Detener una invocación en ejecución

boolean stopInvocation(int invocationId, String cause)

Para detener una invocación en ejecución, especifica su ID.

Métodos protegidos

void cleanUp()

Cierra los registros y realiza cualquier otra limpieza necesaria antes de salir.

IConfiguration createConfiguration(String[] args)
IInvocationContext createInvocationContext()
IConfigurationFactory getConfigFactory()

Método de fábrica para obtener una referencia a IConfigurationFactory

IDeviceManager getDeviceManager()

Método de fábrica para obtener una referencia a IDeviceManager

TradefedFeatureServer getFeatureServer()
IHostOptions getHostOptions()
IKeyStoreClient getKeyStoreClient()

Recupera un IKeyStoreClient con el IKeyStoreFactory declarado en IGlobalConfiguration o nulo si no se define ninguno.

void initLogging()

Inicializa el registro de ddmlib.

boolean isShutdown()
boolean isShuttingDown()
void processReadyCommands(IDeviceManager manager)
void waitForAllInvocationThreads()

Espera a que se completen todos los subprocesos de invocación.

Constructores públicos

CommandScheduler

public CommandScheduler ()

Crea un CommandScheduler.

Nota: Se debe llamar a start antes de usarlo.

Métodos públicos

addCommand

public boolean addCommand (String[] args)

Agrega un comando al programador.

Un comando es, en esencia, una instancia de una configuración para ejecutar y sus argumentos asociados.

Si se especifica el argumento “--help”, el texto de ayuda de la configuración se enviará a stdout. De lo contrario, la configuración se agregará a la cola para que se ejecute.

Parámetros
args String: Los argumentos de configuración.
Muestra
boolean true si el comando se agregó correctamente
Arroja
ConfigurationException

addCommandFile

public void addCommandFile (String cmdFilePath, 
                 extraArgs)

Agrega todos los comandos del archivo determinado al programador.

Parámetros
cmdFilePath String: Es la ruta de acceso del sistema de archivos del archivo de comandos.
extraArgs : Es un ERROR(/List) de argumentos String que se agregarán a cada comando analizado del archivo. Puede estar vacío, pero no debe ser nulo.
Arroja
ConfigurationException

await

public void await ()

Espera a que el programador comience a ejecutarse, lo que incluye esperar a que se complete la entrega de la TF anterior, si corresponde.

checkDelegation

public static TradefedDelegator checkDelegation (String[] args)

Crea un delegador basado en la línea de comandos para ver si necesitamos delegar la ejecución.

Parámetros
args String

Muestra
TradefedDelegator

Arroja
ConfigurationException

completeHandover

public void completeHandover ()

Informa al programador de comandos que una secuencia de transferencia iniciada está completa y que debe volver a inicializar su administrador remoto en el puerto predeterminado.

createReleaseMap

public static  createReleaseMap (IInvocationContext context, 
                Throwable e)

Crea un mapa del estado de los dispositivos para que se puedan liberar de forma adecuada.

Parámetros
context IInvocationContext

e Throwable

Muestra

createSandbox

public ISandbox createSandbox ()

Crea un ISandbox que la invocación usará para ejecutarse.

Muestra
ISandbox

displayCommandQueue

public void displayCommandQueue (PrintWriter printWriter)

Muestra información de depuración detallada sobre el estado de la cola de ejecución de comandos.

displayCommandsInfo

public void displayCommandsInfo (PrintWriter printWriter, 
                String regex)

Muestra una lista de los comandos actuales.

Parámetros
printWriter PrintWriter: Es el ERROR(/PrintWriter) al que se enviará el resultado.
regex String: Es la expresión regular con la que deben coincidir los comandos para que se impriman. Si es nulo, se imprimirán todos los comandos.

displayInvocationsInfo

public void displayInvocationsInfo (PrintWriter printWriter)

Muestra una lista de las invocaciones actuales.

Parámetros
printWriter PrintWriter: Es el ERROR(/PrintWriter) al que se enviará el resultado.

dumpCommandsXml

public void dumpCommandsXml (PrintWriter printWriter, 
                String regex)

Vacía el archivo en formato XML expandido del comando con todos los valores de Option especificados para todos los comandos actuales.

Parámetros
printWriter PrintWriter: Es el ERROR(/PrintWriter) al que se enviará el estado.
regex String: Es la expresión regular con la que deben coincidir los comandos para que se volque el archivo en formato XML. Si es nulo, se volcarán todos los comandos.

execCommand

public void execCommand (ICommandScheduler.IScheduledInvocationListener listener, 
                ITestDevice device, 
                String[] args)

Ejecuta el comando directamente en el dispositivo ya asignado.

Parámetros
listener ICommandScheduler.IScheduledInvocationListener: Es el ICommandScheduler.IScheduledInvocationListener que se informará.
device ITestDevice: Es el ITestDevice que se usará.
args String: Los argumentos del comando
Arroja
ConfigurationException

execCommand

public void execCommand (IInvocationContext context, 
                ICommandScheduler.IScheduledInvocationListener listener, 
                String[] args)

Aloca directamente un dispositivo y ejecuta un comando sin agregarlo a la cola de comandos con un IInvocationContext ya existente.

Parámetros
context IInvocationContext: Un IInvocationContext existente.
listener ICommandScheduler.IScheduledInvocationListener: Es el ICommandScheduler.IScheduledInvocationListener que se informará.
args String: Los argumentos del comando
Arroja
ConfigurationException
NoDeviceException

execCommand

public void execCommand (ICommandScheduler.IScheduledInvocationListener listener, 
                String[] args)

Asignar directamente un dispositivo y ejecutar un comando sin agregarlo a la cola de comandos

Parámetros
listener ICommandScheduler.IScheduledInvocationListener: Es el ICommandScheduler.IScheduledInvocationListener que se informará.
args String: Los argumentos del comando
Arroja
ConfigurationException
NoDeviceException

getCommandFileWatcher

public CommandFileWatcher getCommandFileWatcher ()

Obtén el CommandFileWatcher adecuado para este programador

Muestra
CommandFileWatcher

getExecutingCommandCount

public int getExecutingCommandCount ()

Muestra la cantidad de comandos en estado de ejecución.

Muestra
int

getHostState

public CommandScheduler.HostState getHostState ()

Muestra
CommandScheduler.HostState

getInvocationInfo

public String getInvocationInfo (int invocationId)

Muestra la información de una invocación especificando el ID de invocación.

Parámetros
invocationId int: El ID de seguimiento de la invocación.
Muestra
String Un String que contiene información sobre la invocación.

getLastInvocationExitCode

public CommandRunner.ExitCode getLastInvocationExitCode ()

Muestra el código de error de la última invocación que se ejecutó. Devuelve 0 (sin errores) si aún no se ejecutó ninguna invocación.

Muestra
CommandRunner.ExitCode

getLastInvocationThrowable

public Throwable getLastInvocationThrowable ()

Muestra el Throwable de la última invocación que se ejecutó. Muestra un valor nulo si no hay un elemento throwable disponible.

Muestra
Throwable

getReadyCommandCount

public int getReadyCommandCount ()

Muestra la cantidad de comandos en estado listo en la cola.

Muestra
int

getShutdownTimeout

public long getShutdownTimeout ()

Muestra
long

handoverInitiationComplete

public void handoverInitiationComplete ()

Informa al programador de comandos que se completó el intercambio inicial de entrega de dispositivos y comandos en uso, y que puede comenzar a programar la operación.

handoverShutdown

public boolean handoverShutdown (int handoverPort)

Inicia un shutdown() y lo entrega a otro proceso de Tradefed en este mismo host.

El programador informará al proceso de tradefed remoto que escucha en ese puerto los dispositivos liberados a medida que estén disponibles.

Parámetros
handoverPort int

Muestra
boolean true si la iniciación de la entrega se realizó correctamente, false de lo contrario

notifyFileChanged

public void notifyFileChanged (File cmdFile, 
                 extraArgs)

Parámetros
cmdFile File

extraArgs

removeAllCommands

public void removeAllCommands ()

Quita todos los comandos del programador

run

public void run ()

Es el bloque de ejecución principal de este subproceso.

setClearcutClient

public void setClearcutClient (ClearcutClient client)

Configura el cliente para que informe datos del arnés

Parámetros
client ClearcutClient

shouldShutdownOnCmdfileError

public boolean shouldShutdownOnCmdfileError ()

Muestra verdadero si necesitamos cerrar el programador en un error de comando.

Muestra
boolean

apagado

public void shutdown ()

Intenta cerrar el programador de comandos de forma ordenada.

Borra los comandos que esperan a que se prueben y solicita que todas las invocaciones en curso se cierren de forma correcta.

Después de llamar a shutdown, el bucle principal del programador esperará a que se completen todas las invocaciones en curso antes de salir por completo.

shutdownHard

public void shutdownHard (boolean killAdb)

Intenta cerrar de manera forzosa el programador de comandos.

Es similar a shutdown(), pero también finalizará, de manera opcional, la conexión adb, en un intento por "inspirar" a las invocaciones en curso para que se completen más rápido.

Parámetros
killAdb boolean

shutdownHard

public void shutdownHard ()

Intenta cerrar de manera forzosa el programador de comandos. Igual que shutdownHard(true).

shutdownOnEmpty

public void shutdownOnEmpty ()

Es similar a shutdown(), pero esperará a que se ejecuten todos los comandos antes de salir.

Ten en cuenta que, si algún comando está en modo de bucle, el programador nunca finalizará.

start

public void start ()

Inicia el programador, incluida la configuración de registro, la inicialización de DeviceManager, etcétera.

stopInvocation

public boolean stopInvocation (ITestInvocation invocation)

Detener una invocación en ejecución

Parámetros
invocation ITestInvocation

Muestra
boolean Es verdadero si se detuvo la invocación; de lo contrario, es falso.

stopInvocation

public boolean stopInvocation (int invocationId, 
                String cause)

Para detener una invocación en ejecución, especifica su ID.

Parámetros
invocationId int: El ID de seguimiento de la invocación.
cause String: Es la causa por la que se detuvo la invocación.
Muestra
boolean Es verdadero si se detuvo la invocación; de lo contrario, es falso.

Métodos protegidos

cleanUp

protected void cleanUp ()

Cierra los registros y realiza cualquier otra limpieza necesaria antes de salir.

Se expone para que las pruebas de unidades puedan simular.

createConfiguration

protected IConfiguration createConfiguration (String[] args)

Parámetros
args String

Muestra
IConfiguration

Arroja
ConfigurationException

createInvocationContext

protected IInvocationContext createInvocationContext ()

Muestra
IInvocationContext

getConfigFactory

protected IConfigurationFactory getConfigFactory ()

Método de fábrica para obtener una referencia a IConfigurationFactory

Muestra
IConfigurationFactory el IConfigurationFactory que se usará

getDeviceManager

protected IDeviceManager getDeviceManager ()

Método de fábrica para obtener una referencia a IDeviceManager

Muestra
IDeviceManager el IDeviceManager que se usará

getFeatureServer

protected TradefedFeatureServer getFeatureServer ()

Muestra
TradefedFeatureServer

getHostOptions

protected IHostOptions getHostOptions ()

Muestra
IHostOptions

getKeyStoreClient

protected IKeyStoreClient getKeyStoreClient ()

Recupera un IKeyStoreClient con el IKeyStoreFactory declarado en IGlobalConfiguration o nulo si no se define ninguno.

Muestra
IKeyStoreClient IKeyStoreClient

initLogging

protected void initLogging ()

Inicializa el registro de ddmlib.

Se expone para que las pruebas de unidades puedan simular.

isShutdown

protected boolean isShutdown ()

Muestra
boolean

isShuttingDown

protected boolean isShuttingDown ()

Muestra
boolean

processReadyCommands

protected void processReadyCommands (IDeviceManager manager)

Parámetros
manager IDeviceManager

waitForAllInvocationThreads

protected void waitForAllInvocationThreads ()

Espera a que se completen todos los subprocesos de invocación.