hydra

Class RemoteTestModule

java.lang.Object

java.rmi.server.RemoteObject

java.rmi.server.RemoteServer

java.rmi.server.UnicastRemoteObject

hydra.RemoteTestModule

All Implemented Interfaces:

RemoteTestModuleIF, Serializable, Runnable, Remote

public class RemoteTestModule
extends UnicastRemoteObject
implements RemoteTestModuleIF, Runnable

Instances of this class represent remote clients in hydra multiuser tests.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Thread	baseClientThread The base (parent) client thread associated with this instance
protected boolean	busy Flag to signal that we're already busy with a task
protected TestTask	currentTask The current task
protected static com.gemstone.gemfire.LogWriter	log The logger for this vm
static MasterProxyIF	Master Stub reference to a remote master controller
static int	MyBaseThreadId The base thread id for the vm
protected static String	MyCanonicalHost The canonical name of the host on which this VM runs
protected static String	MyClientName The logical client name
static String	MyHost The actual vm host
protected static String	MyLogFileName The log file name for this vm
protected static String	MyLogicalHost The logical host name
protected static int	MyNumThreads The number of threads in the vm
static int	MyPid The vm process id
protected int	myThreadGroupId Id identifying the current client thread uniquely to its threadgroup
protected String	myThreadGroupName Id identifying the current client thread's hydra threadgroup name
protected String	myThreadName Name identifying the current client thread uniquely
protected int	myTid Id identifying the current client thread uniquely to the master
protected static TimeClient	MyTimeClient The time client for this vm
protected static int	MyVmid The id for the client vm
protected static ThreadLocal	rmiMod

Fields inherited from class java.rmi.server.RemoteObject

ref

Constructor Summary

Constructors

Constructor and Description
RemoteTestModule()

Method Summary

Modifier and Type	Method and Description
static void	closeClockSkewStatistics()
void	disconnectVM() Used by the master to tell this VM to disconnect.
MethExecutorResult	executeMethodOnClass(String className, String methodName) Called remotely by the master controller to cause the client to execute the method on the class.
MethExecutorResult	executeMethodOnClass(String className, String methodName, Object[] args) Executes a given static method in a given class with the given arguments.
MethExecutorResult	executeMethodOnObject(Object obj, String methodName) Called remotely by the master controller to cause the client to execute the instance method on the object.
MethExecutorResult	executeMethodOnObject(Object obj, String methodName, Object[] args) Executes a given instance method on a given object with the given arguments.
void	executeTask(int tsid, int type, int index) Called remotely by the master controller to cause the client to execute the test task.
protected void	executeTask(int tsid, TestTask task) Spawns a new thread to execute the task.
static List<List<String>>	getClientMapping()
static long	getClockSkew()
TestTask	getCurrentTask()
static RemoteTestModule	getCurrentThread() Each test task is executed in a HydraThread spawned by a RemoteTestModule instance (client).
static int	getMyBaseThreadId()
static String	getMyClientName()
static String	getMyHost()
static String	getMyLogicalHost()
static int	getMyNumThreads()
static int	getMyPid()
static int	getMyVmid()
int	getThreadGroupId()
String	getThreadGroupName()
int	getThreadId()
static boolean	getWaitFlag()
protected static void	handleRemoteException(String msg, RemoteException e) Invokes RemoteException handler with the rethrow flag set to true.
protected static void	handleRemoteException(String msg, RemoteException e, boolean rethrow) Reports meaningful RemoteExceptions to the test error file for easier viewing, and does away with bogus RemoteExceptions, for example when clients are left running after a hang and master goes away.
protected static void	initialize() The startup routine for this remote test client.
protected void	invokeShutdownHook(Long key, Vector shutdownHook)
static void	main(String[] args)
static void	makeAndStartThreadClients() Makes MyNumThreads new RemoteTestModules and fires off each in a separate execution thread.
void	notifyDynamicActionComplete(int actionId) Notifies a client that dynamic action with the specified id is complete.
static void	openClockSkewStatistics()
void	run() Informs the master controller that the new client is ready for work and provides its instance of RemoteTestModule to establish communication.
void	runShutdownHook()
static void	setWaitFlag(boolean val)
protected void	shutdown()
void	shutDownVM(boolean disconnect, boolean runShutdownHook) Used by the master to tell this VM to quit.
protected static ConfigHashtable	tab()

Methods inherited from class java.rmi.server.UnicastRemoteObject

clone, exportObject, exportObject, exportObject, unexportObject

Methods inherited from class java.rmi.server.RemoteServer

getClientHost, getLog, setLog

Methods inherited from class java.rmi.server.RemoteObject

equals, getRef, hashCode, toString, toStub

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MyClientName

protected static String MyClientName

The logical client name

MyLogicalHost

protected static String MyLogicalHost

The logical host name

MyHost

public static String MyHost

The actual vm host

MyCanonicalHost

protected static String MyCanonicalHost

The canonical name of the host on which this VM runs

MyVmid

protected static int MyVmid

The id for the client vm

MyPid

public static int MyPid

The vm process id

MyNumThreads

protected static int MyNumThreads

The number of threads in the vm

MyBaseThreadId

public static int MyBaseThreadId

The base thread id for the vm

Master

public static MasterProxyIF Master

Stub reference to a remote master controller

MyTimeClient

protected static TimeClient MyTimeClient

The time client for this vm

MyLogFileName

protected static String MyLogFileName

The log file name for this vm

log

protected static com.gemstone.gemfire.LogWriter log

The logger for this vm

baseClientThread

protected Thread baseClientThread

The base (parent) client thread associated with this instance

busy

protected boolean busy

Flag to signal that we're already busy with a task

currentTask

protected TestTask currentTask

The current task

myTid

protected int myTid

Id identifying the current client thread uniquely to the master

myThreadGroupName

protected String myThreadGroupName

Id identifying the current client thread's hydra threadgroup name

myThreadGroupId

protected int myThreadGroupId

Id identifying the current client thread uniquely to its threadgroup

myThreadName

protected String myThreadName

Name identifying the current client thread uniquely

rmiMod

protected static ThreadLocal rmiMod

Constructor Detail

RemoteTestModule

public RemoteTestModule()
                 throws RemoteException

Throws:

RemoteException

Method Detail

makeAndStartThreadClients

public static void makeAndStartThreadClients()

Makes MyNumThreads new RemoteTestModules and fires off each in a separate execution thread. Gives each a thread id unique in the test starting with MyBaseThreadId.

run

public void run()

Informs the master controller that the new client is ready for work and provides its instance of RemoteTestModule to establish communication. In return, master provides the client with its threadgroup info.

Specified by:

run in interface Runnable

executeTask

public void executeTask(int tsid,
                        int type,
                        int index)
                 throws RemoteException

Called remotely by the master controller to cause the client to execute the test task. Spawns a new thread to execute the task so that RMI can return immediately and the task can execute asynchyronously.

Specified by:

executeTask in interface RemoteTestModuleIF

Parameters:

tsid - the id of the scheduler who issued the assignment

type - the type of task to execute

index - the index into the tasks of that type

Throws:

RemoteException

executeTask

protected void executeTask(int tsid,
                           TestTask task)

Spawns a new thread to execute the task.

executeMethodOnObject

public MethExecutorResult executeMethodOnObject(Object obj,
                                                String methodName)

Called remotely by the master controller to cause the client to execute the instance method on the object. Does this synchronously (does not spawn a thread). This method is used by the unit test framework, dunit.

Specified by:

executeMethodOnObject in interface RemoteTestModuleIF

Parameters:

obj - the object to execute the method on

methodName - the name of the method to execute

Returns:

the result of method execution

executeMethodOnObject

public MethExecutorResult executeMethodOnObject(Object obj,
                                                String methodName,
                                                Object[] args)

Executes a given instance method on a given object with the given arguments.

Specified by:

executeMethodOnObject in interface RemoteTestModuleIF

executeMethodOnClass

public MethExecutorResult executeMethodOnClass(String className,
                                               String methodName)

Called remotely by the master controller to cause the client to execute the method on the class. Does this synchronously (does not spawn a thread). This method is used by the unit test framework, dunit.

Specified by:

executeMethodOnClass in interface RemoteTestModuleIF

Parameters:

className - the name of the class execute

methodName - the name of the method to execute

Returns:

the result of method execution

executeMethodOnClass

public MethExecutorResult executeMethodOnClass(String className,
                                               String methodName,
                                               Object[] args)

Executes a given static method in a given class with the given arguments.

Specified by:

executeMethodOnClass in interface RemoteTestModuleIF

getCurrentThread

public static RemoteTestModule getCurrentThread()

Each test task is executed in a HydraThread spawned by a RemoteTestModule instance (client). This method, when invoked from within some executing test task, returns that RemoteTestModule.

notifyDynamicActionComplete

public void notifyDynamicActionComplete(int actionId)

Notifies a client that dynamic action with the specified id is complete.

Specified by:

notifyDynamicActionComplete in interface RemoteTestModuleIF

getWaitFlag

public static boolean getWaitFlag()

setWaitFlag

public static void setWaitFlag(boolean val)

disconnectVM

public void disconnectVM()
                  throws RemoteException

Used by the master to tell this VM to disconnect.

Specified by:

disconnectVM in interface RemoteTestModuleIF

Throws:

RemoteException

shutDownVM

public void shutDownVM(boolean disconnect,
                       boolean runShutdownHook)
                throws RemoteException

Used by the master to tell this VM to quit.

Specified by:

shutDownVM in interface RemoteTestModuleIF

Parameters:

disconnect - whether to disconnect the VM from the distributed system before shutting down.

runShutdownHook - whether to run the client shutdown hook

Throws:

RemoteException

invokeShutdownHook

protected void invokeShutdownHook(Long key,
                                  Vector shutdownHook)

runShutdownHook

public void runShutdownHook()

Specified by:

runShutdownHook in interface RemoteTestModuleIF

shutdown

protected void shutdown()

getClientMapping

public static List<List<String>> getClientMapping()

getMyHost

public static String getMyHost()

getMyLogicalHost

public static String getMyLogicalHost()

getMyPid

public static int getMyPid()

getMyClientName

public static String getMyClientName()

getMyVmid

public static int getMyVmid()

getThreadId

public int getThreadId()

getMyBaseThreadId

public static int getMyBaseThreadId()

getMyNumThreads

public static int getMyNumThreads()

getThreadGroupId

public int getThreadGroupId()

getThreadGroupName

public String getThreadGroupName()

getCurrentTask

public TestTask getCurrentTask()

tab

protected static ConfigHashtable tab()

getClockSkew

public static long getClockSkew()

openClockSkewStatistics

public static void openClockSkewStatistics()

closeClockSkewStatistics

public static void closeClockSkewStatistics()

handleRemoteException

protected static void handleRemoteException(String msg,
                                            RemoteException e)

Invokes RemoteException handler with the rethrow flag set to true.

handleRemoteException

protected static void handleRemoteException(String msg,
                                            RemoteException e,
                                            boolean rethrow)

Reports meaningful RemoteExceptions to the test error file for easier viewing, and does away with bogus RemoteExceptions, for example when clients are left running after a hang and master goes away. Rethrows as HydraRuntimeException to allow the acting thread to detect error without grokking RemoteException.

initialize

protected static void initialize()

The startup routine for this remote test client. Mainly does registration and log initialization stuff. Some info will be shared among all thread clients in this process; other info will be stored away on a per thread (per RemoteTestModule instance) basis.

main

public static void main(String[] args)