org.wso2.testgrid.common.util.tinkerer

Class TinkererSDK

java.lang.Object

org.wso2.testgrid.common.util.tinkerer.TinkererSDK

public class TinkererSDK
extends Object

Execute commands on remote agent through tinkerer.

Constructor Summary

Constructors

Constructor and Description
TinkererSDK() Initialize details of the tinkerer host and authentication details.

Method Summary

Modifier and Type	Method and Description
int	abortExecution(String operationId, String agentId) Abort running operation by sending abort command.
void	broadcastShellCommand(String testPlanId, String shellCommand) Send a command to all the tinkerer agents belongs to a given test-plan.
AsyncCommandResponse	executeCommandAsync(String agentId, String command) Send shell command as http request to the Tinkerer and get back the result as asynced result.
SyncCommandResponse	executeCommandSync(String agentId, String testPlanId, String instantName, String command) Send shell command as http request to the Tinkerer and get back the result as synced response.
List<Agent>	getAgentListByInstantName(String testPlanId, String instantName) Get a list of agent by given test plan id and instant name.
List<Agent>	getAgentListByTestPlanId(String testPlanId) Get a list of agent for given set of test plans
List<Agent>	getAllAgentList() Get a list of all agents from Tinkerer
List<String>	getAllTestPlanIds()
void	setTinkererHost(String tinkererHost) Set Tinkerer host

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TinkererSDK

public TinkererSDK()

Initialize details of the tinkerer host and authentication details.

Method Detail

executeCommandAsync

public AsyncCommandResponse executeCommandAsync(String agentId,
                                                String command)

Send shell command as http request to the Tinkerer and get back the result as asynced result.

Parameters:

agentId - id of the agent to send command

command - command to execute

Returns:

Response handler as Async response

executeCommandSync

public SyncCommandResponse executeCommandSync(String agentId,
                                              String testPlanId,
                                              String instantName,
                                              String command)

Send shell command as http request to the Tinkerer and get back the result as synced response.

Parameters:

agentId - id of the agent to send command

testPlanId - The test plan id

instantName - The instant name

command - command to execute

Returns:

Response handler as Sync response

abortExecution

public int abortExecution(String operationId,
                          String agentId)

Abort running operation by sending abort command.

Parameters:

operationId - Operation id of the process to abort

agentId - Agent id which running operation

Returns:

The result status

getAgentListByTestPlanId

public List<Agent> getAgentListByTestPlanId(String testPlanId)

Get a list of agent for given set of test plans

Parameters:

testPlanId - The test plan id

Returns:

List of agents for given test plan id

getAllAgentList

public List<Agent> getAllAgentList()

Get a list of all agents from Tinkerer

Returns:

List of all Tinkerer agents

getAllTestPlanIds

public List<String> getAllTestPlanIds()

getAgentListByInstantName

public List<Agent> getAgentListByInstantName(String testPlanId,
                                             String instantName)

Get a list of agent by given test plan id and instant name.

Parameters:

testPlanId - The test plan id

instantName - Instant name of the node

Returns:

List of agents

setTinkererHost

public void setTinkererHost(String tinkererHost)

Set Tinkerer host

Parameters:

tinkererHost - The Tinkerer host

broadcastShellCommand

public void broadcastShellCommand(String testPlanId,
                                  String shellCommand)

Send a command to all the tinkerer agents belongs to a given test-plan.

Parameters:

testPlanId - test-plan-id

shellCommand - shell command wants to be executed