CommandScheduler

CommandScheduler

public CommandScheduler ()

Creates a CommandScheduler.

Note: start must be called before use.

addCommand

public Pair<Boolean, Integer> addCommand (String[] args)

Adds a command to the scheduler.

A command is essentially an instance of a configuration to run and its associated arguments.

If "--help" argument is specified the help text for the config will be outputed to stdout. Otherwise, the config will be added to the queue to run.

addCommandFile

public void addCommandFile (String cmdFilePath, 
                 extraArgs)

Adds all commands from given file to the scheduler

await

public void await ()

Waits for scheduler to start running, including waiting for handover from old TF to complete if applicable.

checkDelegation

public static TradefedDelegator checkDelegation (String[] args)

Create a delegator based on the command line to see if we need to delegate the run.

createReleaseMap

public static  createReleaseMap (IInvocationContext context, 
                Throwable e)

Create a map of the devices state so they can be released appropriately.

createSandbox

public ISandbox createSandbox ()

Create a ISandbox that the invocation will use to run.

displayCommandQueue

public void displayCommandQueue (PrintWriter printWriter)

Output detailed debug info on state of command execution queue.

displayCommandsInfo

public void displayCommandsInfo (PrintWriter printWriter, 
                String regex)

Output a list of current commands.

displayInvocationsInfo

public void displayInvocationsInfo (PrintWriter printWriter)

Displays a list of current invocations.

dumpCommandsXml

public void dumpCommandsXml (PrintWriter printWriter, 
                String regex)

Dump the expanded xml file for the command with all Option values specified for all current commands.

execCommand

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

Directly execute command on already allocated device.

execCommand

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

Directly execute command on already allocated devices.

execCommand

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

Directly allocates a device and executes a command without adding it to the command queue using an already existing IInvocationContext.

execCommand

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

Directly allocates a device and executes a command without adding it to the command queue.

getCommandFileWatcher

public CommandFileWatcher getCommandFileWatcher ()

Get the appropriate CommandFileWatcher for this scheduler

getExecutingCommandCount

public int getExecutingCommandCount ()

Returns the number of Commands in executing state.

getHostState

public CommandScheduler.HostState getHostState ()

getInvocationInfo

public String getInvocationInfo (int invocationId)

Return the information on an invocation bu specifying the invocation id.

getLastInvocationExitCode

public CommandRunner.ExitCode getLastInvocationExitCode ()

Return the error code of the last invocation that ran. Return 0 (no error), if no invocation has ran yet.

getLastInvocationThrowable

public Throwable getLastInvocationThrowable ()

Return the Throwable from the last invocation that ran. Return null, if no throwable is available.

getReadyCommandCount

public int getReadyCommandCount ()

Returns the number of Commands in ready state in the queue.

getShutdownTimeout

public long getShutdownTimeout ()

isDeviceInInvocationThread

public boolean isDeviceInInvocationThread (ITestDevice device)

Returns true if the device is used by an active invocation thread.

isShuttingDown

public boolean isShuttingDown ()

notifyFileChanged

public void notifyFileChanged (File cmdFile, 
                 extraArgs)

removeAllCommands

public void removeAllCommands ()

Remove all commands from scheduler

run

public void run ()

The main execution block of this thread.

setClearcutClient

public void setClearcutClient (ClearcutClient client)

Set the client to report harness data

shouldShutdownOnCmdfileError

public boolean shouldShutdownOnCmdfileError ()

Return true if we need to shutdown the scheduler on a command errors

shutdown

public void shutdown (boolean notifyStop)

Attempt to gracefully shutdown the command scheduler.

shutdownHard

public void shutdownHard (boolean killAdb)

Attempt to forcefully shutdown the command scheduler.

Similar to shutdown(), but will also optionally kill the adb connection, in an attempt to 'inspire' invocations in progress to complete quicker.

shutdownHard

public void shutdownHard ()

Attempt to forcefully shutdown the command scheduler. Same as shutdownHard(true).

shutdownOnEmpty

public void shutdownOnEmpty ()

Similar to shutdown(), but will instead wait for all commands to be executed before exiting.

Note that if any commands are in loop mode, the scheduler will never exit.

start

public void start ()

Starts the scheduler including setting up of logging, init of DeviceManager etc

stopInvocation

public boolean stopInvocation (ITestInvocation invocation)

Stop a running invocation.

stopInvocation

public boolean stopInvocation (int invocationId, 
                String cause)

Stop a running invocation by specifying it's id.

stopScheduling

public void stopScheduling ()

Stops scheduling and accepting new tests but does not stop Tradefed. This is meant to enable a two steps shutdown where first we drain all the running tests, then terminate Tradefed process.

cleanUp

protected void cleanUp ()

Closes the logs and does any other necessary cleanup before we quit.

Exposed so unit tests can mock.

createConfiguration

protected IConfiguration createConfiguration (String[] args)

createInvocationContext

protected IInvocationContext createInvocationContext ()

dryRunCommandReporting

protected void dryRunCommandReporting (ICommandScheduler.IScheduledInvocationListener handler, 
                IConfiguration config)

Determines if a given command is a dry-run. If the command is a dry-run, validate it. If there are any configs issue, it will throw a ConfigurationException.

execCommand

protected long execCommand (IInvocationContext context, 
                ICommandScheduler.IScheduledInvocationListener listener, 
                 reservedDevices, 
                String[] args)

getConfigFactory

protected IConfigurationFactory getConfigFactory ()

Factory method for getting a reference to the IConfigurationFactory

getDeviceManagementServer

protected DeviceManagementGrpcServer getDeviceManagementServer ()

getDeviceManager

protected IDeviceManager getDeviceManager ()

Factory method for getting a reference to the IDeviceManager

getFeatureServer

protected TradefedFeatureServer getFeatureServer ()

getHostOptions

protected IHostOptions getHostOptions ()

getKeyStoreClient

protected IKeyStoreClient getKeyStoreClient ()

Fetches a IKeyStoreClient using the IKeyStoreFactory declared in IGlobalConfiguration or null if none is defined.

getTestInvocationManagementServer

protected TestInvocationManagementServer getTestInvocationManagementServer ()

initLogging

protected void initLogging ()

Initializes the ddmlib log.

Exposed so unit tests can mock.

isShutdown

protected boolean isShutdown ()

processReadyCommands

protected void processReadyCommands (IDeviceManager manager)