CommandTest (GemFire XD Java API Documentation)

java.lang.Object
- management.test.cli.CommandTest

```
public class CommandTest
extends Object
```

Field Summary

Fields
Modifier and Type Field and Description

TestableGfsh shell

static CommandTest testInstance
instance of this test class

Fields
Modifier and Type	Field and Description
`TestableGfsh`	`shell`
`static CommandTest`	`testInstance` instance of this test class

Constructor Summary

Constructors
Constructor and Description

CommandTest()

Constructors
Constructor and Description
`CommandTest()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static String[]`	`connectCLI()` Connect gfsh to either a locator or jmxManager according to the hydra parameter CommandPrms.connectToLocator.
`String[]`	`execCommand(String command, boolean haltOnCommandFailure)` Execute the given command.
`protected void`	`executeFunction(String fcnName, boolean invokeWithId)` Execute a function
`protected static Object`	`getValueFromFunction(com.gemstone.gemfire.management.RegionMXBean regionMBean)` Execute the CliHelperFunction to retrieve a value from a remote member.
`protected static String`	`getXmlFileName(int vmId)` Given a vmId, return the xml file name for it
`static void`	`HydraTask_addFunction()`
`static void`	`HydraTask_addIndex()` Hydra task to add an index to test the execution of the list index command
`static void`	`HydraTask_becomeManager()` Temporary until the product members can automatically become managers
`static void`	`HydraTask_checkCompressedPerfStats()`
`static void`	`HydraTask_checkForCommandErrors()`
`static void`	`HydraTask_checkForDataErrors()`
`static void`	`HydraTask_checkForHelpErrors()`
`static void`	`HydraTask_clearManagers()` Clear fields in preparation to recreate managers with HydraTask_becomeManager.
`static void`	`HydraTask_CmdListDiskStoreTest()`
`static void`	`HydraTask_concDeployTest()` Hydra task for a serial deploy test
`static void`	`HydraTask_configurableInit()` Initialize this member based on the hydra config params numMembersJoinDSOnly and numMembersCreateCacheOnly.
`static void`	`HydraTask_connectCLI()` Hydra task to initialize a TestableShell instance and connect.
`static void`	`HydraTask_createIndexTest()` Hydra task to test the execution of the create index command
`static void`	`HydraTask_createLocator()`
`static void`	`HydraTask_createXmlFile()` Create an xml file for the current cache and all its regions and write it to the blackboard for later use.
`static void`	`HydraTask_dataRateController()` Hydra task to control the work flow for the Data Rate Verification Test
`static void`	`HydraTask_dataRateOperations()`
`static void`	`HydraTask_dataRateVerificationInit()` Hydra initialize task to initialize the Data Rate Verification Test We need to: set the flag that controls running the data operations call the method that creates the Region(s)
`static void`	`HydraTask_deployTest()` Hydra task for a serial deploy test
`static void`	`HydraTask_disconnect()` Disconnect from the DS
`static void`	`HydraTask_execConnectedCommands()` Hydra task to test the execution of all the various connected commands
`static void`	`HydraTask_execDisconnectedCommands()` Hydra task to test the execution of all the various disconnected commands
`static void`	`HydraTask_initAndConnectCLI()` Hydra task to initialize a TestableShell instance and connect.
`static void`	`HydraTask_initCLI()` Hydra task to initialize a TestableShell instance and connect.
`static void`	`HydraTask_initialize()` Creates and initializes a server or peer.
`static void`	`HydraTask_initializeCache()`
`static void`	`HydraTask_initializeClient()` Creates and initializes an edge client.
`static void`	`HydraTask_initializeDS()`
`static void`	`HydraTask_initializeRegions()` Creates and initializes a server or peer.
`static void`	`HydraTask_initShell()` Hydra task to initialize one testableShell per jvm and connect it to a random managing member.
`static void`	`HydraTask_listFunctionTest()` Hydra task to test the execution of the list function command
`static void`	`HydraTask_listIndexTest()` Hydra task to test the execution of the list index command
`static void`	`HydraTask_load()` Loads regions with data.
`static void`	`HydraTask_logBBs()`
`static void`	`HydraTask_logManagerStatus()` Log whether this member is a manager or not
`static void`	`HydraTask_logRegions()`
`static void`	`HydraTask_memberTests()` Hydra task to test the 'list member' & 'describe member' commands
`static void`	`HydraTask_multiRegionAccessorInit()` Create accessor regions based on the datastore regions already created and whose datastore attributes are written to the blackboard.
`static void`	`HydraTask_rebalanceController()` This is run from a "cli" member, which is not part of the ds but is there to execute cli commands from gfsh.
`static void`	`HydraTask_recordManagerStatus()` Record in the blackboard if this member is a manager.
`static void`	`HydraTask_regionCommands()`
`static void`	`HydraTask_regionTests()` Hydra task to test the 'list region' & 'describe region' commands
`static void`	`HydraTask_serialDeployTest()` Hydra task for a serial deploy test
`static void`	`HydraTask_sleep()` Method used for interactive debugging so that a test can start up members then sleep for a long time so we can run an interactive gfsh session against the members started by hydra.
`static void`	`HydraTask_startLocatorAndDS()`
`static void`	`HydraTask_startManagerIfRequired()` Method to handle starting of managers according to the setting of CommandPrms-nbrOfManagers.
`static void`	`HydraTask_stopStart()`
`static void`	`HydraTask_testAsyncEventQueueCommands()`
`static void`	`HydraTask_testCreateDiskStoreCommands()`
`static void`	`HydraTask_verifyAutoManagers()` Verify manager status for this member for a test that is configured such that the product automatically creates manager.
`static void`	`HydraTask_verifyAutoNumManagers()` Verify that the distributed system has the correct number of managers
`static void`	`HydraTask_verifyCompressedDataTest()`
`static void`	`HydraTask_verifyDataTest()` Hydra task to test the ....
`static void`	`HydraTask_verifyHelpForCommands()` Hydra task to exercise executing the help command
`static void`	`HydraTask_verifyManagers()` Verify manager status for this member
`static void`	`HydraTask_verifyMemberMBeans()` Verify the presence of MBeans
`static void`	`HydraTask_verifyNoManagers()` Verify nobody is a manager
`static void`	`HydraTask_verifyOfflineHelpCommand()` Hydra task to exercise executing the help command
`static void`	`HydraTask_verifyOnlineHelpCommand()` Hydra task to exercise executing the help command
`static void`	`HydraTask_verifyRegionMBeans()` Verify the presence of Region MBeans and their values in this member.
`static void`	`HydraTask_writeJmxManagerSettingToBB()` Write this members jmxManager value to the blackboard
`static void`	`HydraTask_writeMemberDescriptionToBB()` Write the MemberDescription for this member to the blackboard
`static void`	`HydraTask_writeRegionNamesToBB()` Write the names of the regions defined in this member to the blackboard
`void`	`initShell()` Initialize the test instance shell variable.
`protected Object`	`instantiateObject(int versionNumber, String className)` Instantiate and return an object of the given className from the given version (1 or 2) in /testsVersions
`protected static long`	`logExecutionNumber()` Log the execution number of this serial task.
`String[]`	`mergeArrays(String[] mainArray, String[] addArray)`
`protected static void`	`registerInterest()` Register interest with ALL_KEYS, and InterestPolicyResult = KEYS_VALUES which is equivalent to a full GII.
`protected static void`	`startManagerIfRequired()` Start a manager if required.
`protected static void`	`startRmiConnector()` Temporary until the product does this automatically, start an RMI connector to later be used for gfsh to connect to.
`static String`	`toHexString(byte[] array)`
`static void`	`verifyBucketCopies()` Verify bucket copies in all regions in this test
`protected void`	`verifyClassAvailability(int vmId, String[] availableClasses, String[] unavailableClasses)` Execute a function to verify a jar was deployed on other members.
`protected static void`	`verifyMethodNames(String className, Set methodNames)` Verify the list of method names not validated (should be empty)
`static void`	`waitForSilence()` Wait for 30 seconds of silence to make sure all events have been delivered.

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

- Field Detail
  - testInstance
```
public static CommandTest testInstance
```
    instance of this test class
  - shell
```
public TestableGfsh shell
```
- Constructor Detail
  - CommandTest
```
public CommandTest()
```
- Method Detail
  - HydraTask_createLocator
```
public static void HydraTask_createLocator()
                                    throws Throwable
```
    Throws:
    
    Throwable
  - HydraTask_startLocatorAndDS
```
public static void HydraTask_startLocatorAndDS()
                                        throws Throwable
```
    Throws:
    
    Throwable
  - HydraTask_configurableInit
```
public static void HydraTask_configurableInit()
```
    Initialize this member based on the hydra config params numMembersJoinDSOnly and numMembersCreateCacheOnly.
  - HydraTask_initializeDS
```
public static void HydraTask_initializeDS()
```
  - HydraTask_initialize
```
public static void HydraTask_initialize()
```
    Creates and initializes a server or peer.
  - HydraTask_initializeCache
```
public static void HydraTask_initializeCache()
```
  - HydraTask_writeJmxManagerSettingToBB
```
public static void HydraTask_writeJmxManagerSettingToBB()
```
    Write this members jmxManager value to the blackboard
  - HydraTask_initializeRegions
```
public static void HydraTask_initializeRegions()
```
    Creates and initializes a server or peer.
  - HydraTask_initializeClient
```
public static void HydraTask_initializeClient()
```
    Creates and initializes an edge client.
  - HydraTask_multiRegionAccessorInit
```
public static void HydraTask_multiRegionAccessorInit()
```
    Create accessor regions based on the datastore regions already created and whose datastore attributes are written to the blackboard.
  - HydraTask_createXmlFile
```
public static void HydraTask_createXmlFile()
```
    Create an xml file for the current cache and all its regions and write it to the blackboard for later use.
  - getXmlFileName
```
protected static String getXmlFileName(int vmId)
```
    Given a vmId, return the xml file name for it
    
    Parameters:
    
    vmId - The vmId of a test jvm.
    
    Returns:
    
    The xml file name (not the complete path) of the xml file for the vmId.
  - initShell
```
public void initShell()
```
    Initialize the test instance shell variable. If already initialized then this is a noop.
  - registerInterest
```
protected static void registerInterest()
```
    Register interest with ALL_KEYS, and InterestPolicyResult = KEYS_VALUES which is equivalent to a full GII.
  - HydraTask_startManagerIfRequired
```
public static void HydraTask_startManagerIfRequired()
```
    Method to handle starting of managers according to the setting of CommandPrms-nbrOfManagers. If CommandPrms-nbrOfManagers <= 0 return without action; the test writer has the option of making this member a manager with properties else start a manager if the system does not yet have the required number of managers (specified with CommandPrms-nbrOfManagers).
  - HydraTask_verifyAutoManagers
```
public static void HydraTask_verifyAutoManagers()
```
    Verify manager status for this member for a test that is configured such that the product automatically creates manager.
  - HydraTask_verifyAutoNumManagers
```
public static void HydraTask_verifyAutoNumManagers()
```
    Verify that the distributed system has the correct number of managers
  - HydraTask_verifyNoManagers
```
public static void HydraTask_verifyNoManagers()
```
    Verify nobody is a manager
  - HydraTask_verifyManagers
```
public static void HydraTask_verifyManagers()
```
    Verify manager status for this member
  - HydraTask_becomeManager
```
public static void HydraTask_becomeManager()
```
    Temporary until the product members can automatically become managers
  - startRmiConnector
```
protected static void startRmiConnector()
```
    Temporary until the product does this automatically, start an RMI connector to later be used for gfsh to connect to.
  - HydraTask_sleep
```
public static void HydraTask_sleep()
```
    Method used for interactive debugging so that a test can start up members then sleep for a long time so we can run an interactive gfsh session against the members started by hydra.
  - HydraTask_initAndConnectCLI
```
public static void HydraTask_initAndConnectCLI()
```
    Hydra task to initialize a TestableShell instance and connect. This replaces HydraTask_initShell().
  - HydraTask_initCLI
```
public static void HydraTask_initCLI()
```
    Hydra task to initialize a TestableShell instance and connect. This replaces HydraTask_initShell().
  - HydraTask_connectCLI
```
public static void HydraTask_connectCLI()
```
    Hydra task to initialize a TestableShell instance and connect. This replaces HydraTask_initShell().
  - HydraTask_initShell
```
public static void HydraTask_initShell()
```
    Hydra task to initialize one testableShell per jvm and connect it to a random managing member. NOTE: This is the old way to start TestableShell, which relied on HydraTask_becomeManager. This is no longer needed now that Gfsh can connect to locators and the product will automatically have members become managers.
  - HydraTask_serialDeployTest
```
public static void HydraTask_serialDeployTest()
```
    Hydra task for a serial deploy test
  - HydraTask_deployTest
```
public static void HydraTask_deployTest()
```
    Hydra task for a serial deploy test
  - HydraTask_concDeployTest
```
public static void HydraTask_concDeployTest()
```
    Hydra task for a serial deploy test
  - HydraTask_execDisconnectedCommands
```
public static void HydraTask_execDisconnectedCommands()
```
    Hydra task to test the execution of all the various disconnected commands
  - HydraTask_execConnectedCommands
```
public static void HydraTask_execConnectedCommands()
```
    Hydra task to test the execution of all the various connected commands
  - HydraTask_checkForCommandErrors
```
public static void HydraTask_checkForCommandErrors()
```
  - HydraTask_addFunction
```
public static void HydraTask_addFunction()
```
  - HydraTask_addIndex
```
public static void HydraTask_addIndex()
```
    Hydra task to add an index to test the execution of the list index command
  - HydraTask_CmdListDiskStoreTest
```
public static void HydraTask_CmdListDiskStoreTest()
```
  - HydraTask_verifyOfflineHelpCommand
```
public static void HydraTask_verifyOfflineHelpCommand()
```
    Hydra task to exercise executing the help command
  - HydraTask_verifyOnlineHelpCommand
```
public static void HydraTask_verifyOnlineHelpCommand()
```
    Hydra task to exercise executing the help command
  - HydraTask_verifyHelpForCommands
```
public static void HydraTask_verifyHelpForCommands()
```
    Hydra task to exercise executing the help command
  - HydraTask_checkForHelpErrors
```
public static void HydraTask_checkForHelpErrors()
```
  - HydraTask_verifyDataTest
```
public static void HydraTask_verifyDataTest()
```
    Hydra task to test the ....
  - HydraTask_checkForDataErrors
```
public static void HydraTask_checkForDataErrors()
```
  - HydraTask_verifyCompressedDataTest
```
public static void HydraTask_verifyCompressedDataTest()
```
  - HydraTask_checkCompressedPerfStats
```
public static void HydraTask_checkCompressedPerfStats()
```
  - HydraTask_memberTests
```
public static void HydraTask_memberTests()
```
    Hydra task to test the 'list member' & 'describe member' commands
  - HydraTask_regionTests
```
public static void HydraTask_regionTests()
```
    Hydra task to test the 'list region' & 'describe region' commands
  - HydraTask_listFunctionTest
```
public static void HydraTask_listFunctionTest()
```
    Hydra task to test the execution of the list function command
  - HydraTask_createIndexTest
```
public static void HydraTask_createIndexTest()
```
    Hydra task to test the execution of the create index command
  - HydraTask_listIndexTest
```
public static void HydraTask_listIndexTest()
```
    Hydra task to test the execution of the list index command
  - HydraTask_regionCommands
```
public static void HydraTask_regionCommands()
```
  - HydraTask_writeRegionNamesToBB
```
public static void HydraTask_writeRegionNamesToBB()
```
    Write the names of the regions defined in this member to the blackboard
  - HydraTask_writeMemberDescriptionToBB
```
public static void HydraTask_writeMemberDescriptionToBB()
```
    Write the MemberDescription for this member to the blackboard
  - HydraTask_disconnect
```
public static void HydraTask_disconnect()
```
    Disconnect from the DS
  - HydraTask_clearManagers
```
public static void HydraTask_clearManagers()
```
    Clear fields in preparation to recreate managers with HydraTask_becomeManager. This is only used if it is desired that the managers be in potentially different members than they were before during their first initialization, otherwise this call can be skipped and if a member was a manager before it will become one again when HydraTask_becomeManager is called.
  - HydraTask_rebalanceController
```
public static void HydraTask_rebalanceController()
```
    This is run from a "cli" member, which is not part of the ds but is there to execute cli commands from gfsh. It brings members in and out of the ds and to cause rebalance work to be done.
  - HydraTask_load
```
public static void HydraTask_load()
```
    Loads regions with data. This is a batched task, and each thread will repeatedly run this task until it loads CommandPrms.numToLoadEachRegion into each region of the cache, then it will throw a StopSchedulingTaskOnclientOrder exception.
  - HydraTask_logRegions
```
public static void HydraTask_logRegions()
```
  - HydraTask_logBBs
```
public static void HydraTask_logBBs()
```
  - HydraTask_stopStart
```
public static void HydraTask_stopStart()
```
  - HydraTask_logManagerStatus
```
public static void HydraTask_logManagerStatus()
```
    Log whether this member is a manager or not
  - HydraTask_verifyMemberMBeans
```
public static void HydraTask_verifyMemberMBeans()
```
    Verify the presence of MBeans
  - HydraTask_verifyRegionMBeans
```
public static void HydraTask_verifyRegionMBeans()
```
    Verify the presence of Region MBeans and their values in this member.
  - verifyMethodNames
```
protected static void verifyMethodNames(String className,
                                        Set methodNames)
```
    Verify the list of method names not validated (should be empty)
    
    Parameters:
    
    className - The name of the class containing the methods
    
    methodNames - A set of methodNames from classNames
  - getValueFromFunction
```
protected static Object getValueFromFunction(com.gemstone.gemfire.management.RegionMXBean regionMBean)
```
    Execute the CliHelperFunction to retrieve a value from a remote member.
    
    Parameters:
    
    regionMBean - This contains information about the remote member and region of interest.
    
    Returns:
    
    The value requested by functionTask from the member and region specified in the regionMBean.
  - HydraTask_recordManagerStatus
```
public static void HydraTask_recordManagerStatus()
```
    Record in the blackboard if this member is a manager.
  - HydraTask_dataRateVerificationInit
```
public static void HydraTask_dataRateVerificationInit()
```
    Hydra initialize task to initialize the Data Rate Verification Test We need to: set the flag that controls running the data operations call the method that creates the Region(s)
  - HydraTask_dataRateController
```
public static void HydraTask_dataRateController()
```
    Hydra task to control the work flow for the Data Rate Verification Test
  - HydraTask_dataRateOperations
```
public static void HydraTask_dataRateOperations()
```
  - logExecutionNumber
```
protected static long logExecutionNumber()
```
    Log the execution number of this serial task.
  - executeFunction
```
protected void executeFunction(String fcnName,
                               boolean invokeWithId)
```
    Execute a function
    
    Parameters:
    
    fcnName - The name of the function to execute
    
    invokeWithId - If true then invoke with the function id, otherwise invoke by instantiating the function
  - instantiateObject
```
protected Object instantiateObject(int versionNumber,
                                   String className)
```
    Instantiate and return an object of the given className from the given version (1 or 2) in /testsVersions
    
    Parameters:
    
    versionNumber - Refers to /testsVersions/versionN where N is 1 or 2
    
    className - The name of the class in the specified version
    
    Returns:
    
    A new instance of the className from the given version.
  - verifyClassAvailability
```
protected void verifyClassAvailability(int vmId,
                                       String[] availableClasses,
                                       String[] unavailableClasses)
```
    Execute a function to verify a jar was deployed on other members.
    
    Parameters:
    
    vmId -
    
    availableClasses -
    
    unavailableClasses -
  - execCommand
```
public String[] execCommand(String command,
                            boolean haltOnCommandFailure)
```
    Execute the given command.
    
    Parameters:
    
    command - The command to execute.
    
    haltOnCommandFailure - If true, then throw an exception if the command does not succeed; if false then just return the output (for example, if the test explicitly gives a command with bad syntax and is expected to fail, the output is returned for the test to determine if the failure is correct).
    
    Returns:
    
    [0] The TestableShell.getOutputText() result of the command. [1] The presentation string (the output text of the command that is presented to the user).
  - startManagerIfRequired
```
protected static void startManagerIfRequired()
```
    Start a manager if required. A manager will be started if this vmId was previously a manager or if we have designated a certain number of members to be managers and this one was randomly selected.
  - connectCLI
```
public static String[] connectCLI()
```
    Connect gfsh to either a locator or jmxManager according to the hydra parameter CommandPrms.connectToLocator.
    
    Returns:
    
    [0] The TestableShell.getOutputText() result of the command. [1] The presentation string (the output text of the command that is presented to the user).
  - toHexString
```
public static String toHexString(byte[] array)
```
  - HydraTask_testAsyncEventQueueCommands
```
public static void HydraTask_testAsyncEventQueueCommands()
```
  - HydraTask_testCreateDiskStoreCommands
```
public static void HydraTask_testCreateDiskStoreCommands()
```
  - mergeArrays
```
public String[] mergeArrays(String[] mainArray,
                            String[] addArray)
```
  - waitForSilence
```
public static void waitForSilence()
```
    Wait for 30 seconds of silence to make sure all events have been delivered.
  - verifyBucketCopies
```
public static void verifyBucketCopies()
```
    Verify bucket copies in all regions in this test

Class CommandTest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

testInstance

shell

Constructor Detail

CommandTest

Method Detail

HydraTask_createLocator

HydraTask_startLocatorAndDS

HydraTask_configurableInit

HydraTask_initializeDS

HydraTask_initialize

HydraTask_initializeCache

HydraTask_writeJmxManagerSettingToBB

HydraTask_initializeRegions

HydraTask_initializeClient

HydraTask_multiRegionAccessorInit

HydraTask_createXmlFile

getXmlFileName

initShell

registerInterest

HydraTask_startManagerIfRequired

HydraTask_verifyAutoManagers

HydraTask_verifyAutoNumManagers

HydraTask_verifyNoManagers

HydraTask_verifyManagers

HydraTask_becomeManager

startRmiConnector

HydraTask_sleep

HydraTask_initAndConnectCLI

HydraTask_initCLI

HydraTask_connectCLI

HydraTask_initShell

HydraTask_serialDeployTest

HydraTask_deployTest

HydraTask_concDeployTest

HydraTask_execDisconnectedCommands

HydraTask_execConnectedCommands

HydraTask_checkForCommandErrors

HydraTask_addFunction

HydraTask_addIndex

HydraTask_CmdListDiskStoreTest

HydraTask_verifyOfflineHelpCommand

HydraTask_verifyOnlineHelpCommand

HydraTask_verifyHelpForCommands

HydraTask_checkForHelpErrors

HydraTask_verifyDataTest

HydraTask_checkForDataErrors

HydraTask_verifyCompressedDataTest

HydraTask_checkCompressedPerfStats

HydraTask_memberTests

HydraTask_regionTests

HydraTask_listFunctionTest

HydraTask_createIndexTest

HydraTask_listIndexTest

HydraTask_regionCommands

HydraTask_writeRegionNamesToBB

HydraTask_writeMemberDescriptionToBB

HydraTask_disconnect

HydraTask_clearManagers

HydraTask_rebalanceController

HydraTask_load

HydraTask_logRegions

HydraTask_logBBs

HydraTask_stopStart

HydraTask_logManagerStatus

HydraTask_verifyMemberMBeans

HydraTask_verifyRegionMBeans

verifyMethodNames

getValueFromFunction

HydraTask_recordManagerStatus

HydraTask_dataRateVerificationInit

HydraTask_dataRateController

HydraTask_dataRateOperations

logExecutionNumber

executeFunction