TestTask (GemFire XD Java API Documentation)

java.lang.Object
- hydra.TestTask

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

JUnitTestTask
```
public class TestTask
extends Object
implements Cloneable, Serializable
```
A TestTask object represents a unit of work that can be transmitted from a master controller to a client thread for execution. In addition to specifying work to be done (via a class name/selector combo), a TestTask also stores some information about the circumstances under which it should be executed, as well some scratchpad data about how often it's been used in the current test run, how many instances are currently active, and so on.
To configure a test task, add an entry to the test configuration file as shown in hydra_grammar.txt. Note that a test task of any type can have an arbitrary number of user-defined attributes. These are available as a ConfigHashtable to a client running the task by invoking RemoteTestModule.getCurrentThread().getCurrentTask(). The usual methods on ConfigHashtable are then available for reading the attribute values. See hydratest/checktaskattributes.conf and methods TaskClient.tryItOutAttributes() and TaskClient.tryItOutAttributesOneOf() for examples.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALWAYS` Run mode to cause an INITTASK or CLOSETASK to run on suitable clients every time their VM starts or stops.
`protected static int`	`CLOSETASK`
`protected static int`	`DEFAULT_RUN_MODE`
`static int`	`DYNAMIC` Run mode to cause an INITTASK or CLOSETASK to run on suitable clients only when a client starts or stops their VM via the `ClientVmMgr` interface.
`protected static int`	`DYNAMICCLOSETASK`
`protected static int`	`DYNAMICINITTASK`
`protected static int`	`ENDTASK`
`protected static int`	`INITTASK`
`static int`	`ONCE` Run mode to cause an INITTASK or CLOSETASK to run on suitable clients only when the hydra master starts or stops their VM.
`protected static int`	`STARTTASK`
`protected static int`	`TASK`
`protected static int`	`UNITTEST`

Constructor Summary

Constructors
Constructor and Description

TestTask()

Constructors
Constructor and Description
`TestTask()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`acceptsStopSchedulingOrder()`
`protected boolean`	`acceptsStopSchedulingTaskOnClientOrder()`
`void`	`addElapsedTime(long t)`
`protected void`	`addThreadGroup(HydraThreadGroup tg)`
`protected void`	`addThreadGroupName(String tgName)`
`boolean`	`batch()`
`Object`	`clone()`
`void`	`decrementNumTimesInUse()`
`TestTaskResult`	`execute()` Executes the selector on the receiver.
`Vector`	`getClientNames()`
`NumStats`	`getElapsedTimes()`
`int`	`getEndInterval()`
`int`	`getMaxThreads()`
`int`	`getMaxTimesToRun()`
`int`	`getNumTimesInUse()`
`int`	`getNumTimesRun()`
`String`	`getReceiver()`
`int`	`getRunMode()`
`String`	`getRunModeString()`
`String`	`getSelector()`
`int`	`getStartInterval()`
`ConfigHashtable`	`getTaskAttributes()`
`int`	`getTaskIndex()`
`int`	`getTaskThreadGroupId(String tgName, int tgid)` Returns a unique ID for each thread in a threadgroup for this task, numbered 0 to N-1, where N is the total number of threads in all threadgroups for the task.
`int`	`getTaskType()`
`String`	`getTaskTypeString()`
`Vector`	`getThreadGroupNames()`
`Map`	`getThreadGroups()`
`int`	`getTotalThreads()` Gets the total number of threads in all threadgroups for this task (lazily).
`int`	`getWeight()`
`void`	`incrementNumTimesInUse()`
`void`	`incrementNumTimesRun()`
`void`	`logHangResult(ClientRecord client, String msg)`
`protected void`	`logHangResult(ClientRecord client, TestTaskResult result)`
`protected void`	`logTaskResult(ClientRecord client, TestTaskResult result)`
`void`	`logUnitTestResult(TestTaskResult result)`
`boolean`	`receivedAllStopSchedulingTaskOnClientOrders()`
`protected boolean`	`receivedStopSchedulingTaskOnClientOrder()`
`boolean`	`receivedStopSchedulingTaskOnClientOrder(ClientRecord client)`
`protected void`	`receiveStopSchedulingTaskOnClientOrder(ClientRecord client)`
`boolean`	`satisfiesEndInterval(long now)`
`boolean`	`satisfiesStartInterval(long now)`
`boolean`	`sequential()`
`void`	`setBatch(boolean flag)`
`void`	`setClientNames(Vector names)`
`void`	`setEndInterval(int n)`
`void`	`setEndTimes(long t)`
`void`	`setMaxThreads(int anInt)`
`void`	`setMaxTimesToRun(int anInt)`
`protected void`	`setNumClients(int numClients)`
`void`	`setReceiver(String aStr)`
`void`	`setRunMode(int mode)`
`void`	`setSelector(String aStr)`
`void`	`setSequential(boolean flag)`
`void`	`setStartInterval(int n)`
`void`	`setStartTimes(long t)`
`protected void`	`setTaskAttribute(Long key, Object value)`
`void`	`setTaskIndex(int anIndex)`
`void`	`setTaskType(int aType)`
`protected void`	`setThreadGroupNames(Vector tgNames)`
`void`	`setWeight(int n)`
`String`	`toShortString()` Returns a String that partially describes the receiver.
`SortedMap`	`toSortedMap()`
`String`	`toString()`
`void`	`updateEndTimes(long now)` Updates the earliest known end time for this task with the current time.
`void`	`updateStartTimes(long now)` Updates the earliest known start time for this task with the current time.
`protected boolean`	`usesThreadGroup(String name)`

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail
- STARTTASK
```
protected static final int STARTTASK
```
  See Also:
  
  Constant Field Values
- INITTASK
```
protected static final int INITTASK
```
  See Also:
  
  Constant Field Values
- DYNAMICINITTASK
```
protected static final int DYNAMICINITTASK
```
  See Also:
  
  Constant Field Values
- TASK
```
protected static final int TASK
```
  See Also:
  
  Constant Field Values
- DYNAMICCLOSETASK
```
protected static final int DYNAMICCLOSETASK
```
  See Also:
  
  Constant Field Values
- CLOSETASK
```
protected static final int CLOSETASK
```
  See Also:
  
  Constant Field Values
- ENDTASK
```
protected static final int ENDTASK
```
  See Also:
  
  Constant Field Values
- UNITTEST
```
protected static final int UNITTEST
```
  See Also:
  
  Constant Field Values
- ALWAYS
```
public static final int ALWAYS
```
  Run mode to cause an INITTASK or CLOSETASK to run on suitable clients every time their VM starts or stops.
  
  See Also:
  
  Constant Field Values
- ONCE
```
public static final int ONCE
```
  Run mode to cause an INITTASK or CLOSETASK to run on suitable clients only when the hydra master starts or stops their VM.
  
  See Also:
  
  Constant Field Values
- DYNAMIC
```
public static final int DYNAMIC
```
  Run mode to cause an INITTASK or CLOSETASK to run on suitable clients only when a client starts or stops their VM via the ClientVmMgr interface.
  
  See Also:
  
  Constant Field Values
- DEFAULT_RUN_MODE
```
protected static final int DEFAULT_RUN_MODE
```
  See Also:
  
  Constant Field Values

Constructor Detail
- TestTask
```
public TestTask()
```

Method Detail

clone
```
public Object clone()
```
Overrides:

clone in class Object

execute
```
public TestTaskResult execute()
```
Executes the selector on the receiver. Returns the result, including error status and elapsed time.

Returns:

the result of executing the method.

toShortString
```
public String toShortString()
```
Returns a String that partially describes the receiver.

toSortedMap
```
public SortedMap toSortedMap()
```

toString
```
public String toString()
```
Overrides:

toString in class Object

getTaskIndex
```
public int getTaskIndex()
```

setTaskIndex

public void setTaskIndex(int anIndex)

getTaskType
```
public int getTaskType()
```

getTaskTypeString
```
public String getTaskTypeString()
```

setTaskType
```
public void setTaskType(int aType)
```

getReceiver
```
public String getReceiver()
```

setReceiver
```
public void setReceiver(String aStr)
```

getSelector
```
public String getSelector()
```

setSelector
```
public void setSelector(String aStr)
```

getTaskAttributes

public ConfigHashtable getTaskAttributes()

setTaskAttribute

protected void setTaskAttribute(Long key,
                                Object value)

getRunMode
```
public int getRunMode()
```

setRunMode
```
public void setRunMode(int mode)
```

getRunModeString
```
public String getRunModeString()
```

sequential
```
public boolean sequential()
```

setSequential

public void setSequential(boolean flag)

batch
```
public boolean batch()
```

setBatch
```
public void setBatch(boolean flag)
```

getClientNames
```
public Vector getClientNames()
```

setClientNames

public void setClientNames(Vector names)

getMaxTimesToRun
```
public int getMaxTimesToRun()
```

setMaxTimesToRun

public void setMaxTimesToRun(int anInt)

getMaxThreads
```
public int getMaxThreads()
```

setMaxThreads
```
public void setMaxThreads(int anInt)
```

getWeight
```
public int getWeight()
```

setWeight
```
public void setWeight(int n)
```

getStartInterval
```
public int getStartInterval()
```

setStartInterval
```
public void setStartInterval(int n)
```

getEndInterval
```
public int getEndInterval()
```

setEndInterval
```
public void setEndInterval(int n)
```

setNumClients

protected void setNumClients(int numClients)

getThreadGroupNames
```
public Vector getThreadGroupNames()
```

setThreadGroupNames

protected void setThreadGroupNames(Vector tgNames)

addThreadGroupName

protected void addThreadGroupName(String tgName)

getThreadGroups
```
public Map getThreadGroups()
```

addThreadGroup

protected void addThreadGroup(HydraThreadGroup tg)

usesThreadGroup

protected boolean usesThreadGroup(String name)

getTotalThreads
```
public int getTotalThreads()
```
Gets the total number of threads in all threadgroups for this task (lazily).

getTaskThreadGroupId
```
public int getTaskThreadGroupId(String tgName,
                                int tgid)
```
Returns a unique ID for each thread in a threadgroup for this task, numbered 0 to N-1, where N is the total number of threads in all threadgroups for the task.

setStartTimes
```
public void setStartTimes(long t)
```

setEndTimes
```
public void setEndTimes(long t)
```

updateStartTimes
```
public void updateStartTimes(long now)
```
Updates the earliest known start time for this task with the current time. Invoked when this task is assigned to a client.

updateEndTimes
```
public void updateEndTimes(long now)
```
Updates the earliest known end time for this task with the current time. Invoked when a client completes this task.

satisfiesStartInterval

public boolean satisfiesStartInterval(long now)

satisfiesEndInterval

public boolean satisfiesEndInterval(long now)

getNumTimesRun
```
public int getNumTimesRun()
```

incrementNumTimesRun
```
public void incrementNumTimesRun()
```

getNumTimesInUse
```
public int getNumTimesInUse()
```

incrementNumTimesInUse
```
public void incrementNumTimesInUse()
```

decrementNumTimesInUse
```
public void decrementNumTimesInUse()
```

getElapsedTimes
```
public NumStats getElapsedTimes()
```

addElapsedTime
```
public void addElapsedTime(long t)
```

acceptsStopSchedulingOrder

protected boolean acceptsStopSchedulingOrder()

acceptsStopSchedulingTaskOnClientOrder

protected boolean acceptsStopSchedulingTaskOnClientOrder()

receivedStopSchedulingTaskOnClientOrder

protected boolean receivedStopSchedulingTaskOnClientOrder()

receivedStopSchedulingTaskOnClientOrder

public boolean receivedStopSchedulingTaskOnClientOrder(ClientRecord client)

receiveStopSchedulingTaskOnClientOrder

protected void receiveStopSchedulingTaskOnClientOrder(ClientRecord client)

receivedAllStopSchedulingTaskOnClientOrders

public boolean receivedAllStopSchedulingTaskOnClientOrders()

logTaskResult

protected void logTaskResult(ClientRecord client,
                             TestTaskResult result)

logHangResult

protected void logHangResult(ClientRecord client,
                             TestTaskResult result)

logHangResult

public void logHangResult(ClientRecord client,
                          String msg)

logUnitTestResult

public void logUnitTestResult(TestTaskResult result)

Class TestTask

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

STARTTASK

INITTASK

DYNAMICINITTASK

TASK

DYNAMICCLOSETASK

CLOSETASK

ENDTASK

UNITTEST

ALWAYS

ONCE

DYNAMIC

DEFAULT_RUN_MODE

Constructor Detail

TestTask

Method Detail

clone

execute

toShortString

toSortedMap

toString

getTaskIndex

setTaskIndex

getTaskType

getTaskTypeString

setTaskType

getReceiver

setReceiver

getSelector

setSelector

getTaskAttributes

setTaskAttribute

getRunMode

setRunMode

getRunModeString

sequential

setSequential

batch

setBatch

getClientNames

setClientNames

getMaxTimesToRun

setMaxTimesToRun

getMaxThreads

setMaxThreads

getWeight

setWeight

getStartInterval

setStartInterval

getEndInterval

setEndInterval

setNumClients

getThreadGroupNames

setThreadGroupNames

addThreadGroupName

getThreadGroups

addThreadGroup

usesThreadGroup

getTotalThreads

getTaskThreadGroupId

setStartTimes

setEndTimes

updateStartTimes

updateEndTimes

satisfiesStartInterval

satisfiesEndInterval

getNumTimesRun

incrementNumTimesRun

getNumTimesInUse

incrementNumTimesInUse

decrementNumTimesInUse

getElapsedTimes

addElapsedTime

acceptsStopSchedulingOrder

acceptsStopSchedulingTaskOnClientOrder