RecovDelayTest (GemFire XD Java API Documentation)

java.lang.Object
- recovDelay.RecovDelayTest

```
public class RecovDelayTest
extends Object
```
Test class for recovery delay in partitioned regions.

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.gemstone.gemfire.cache.Region`	`aRegion`
`protected static String`	`CONCURRENT_STARTUP`
`protected Map`	`hostMap`
`protected int`	`IMMEDIATE`
`protected List`	`liveVMs`
`protected Set`	`masterBucketIdSet`
`protected List`	`masterBucketInfoList`
`protected Map`	`masterPrMap`
`protected int`	`NEVER`
`protected int`	`numDataStoreVMs`
`protected ParRegTest`	`parRegTestInstance`
`protected int`	`recoveryDelay`
`protected int`	`redundantCopies`
`protected static String`	`redundantCopiesKey`
`protected static String`	`SERIAL_STARTUP`
`protected static String`	`START_WITH_ALL`
`protected String`	`startStrategy`
`protected int`	`startupRecoveryDelay`
`protected boolean`	`startupRecoveryRace`
`protected List`	`stoppedVMs`
`protected String`	`stopStrategy`
`static RecovDelayTest`	`testInstance`
`protected int`	`totalBucketCopies`
`protected int`	`totalNumVMsToStop`
`protected boolean`	`uniqueHostTest`
`protected static String`	`vmIDStr`
`protected List`	`vmsToStart`

Constructor Summary

Constructors
Constructor and Description

RecovDelayTest()

Constructors
Constructor and Description
`RecovDelayTest()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`adjustRegionSnapshotForLostKeys(Map regionSnapshot)`
`protected void`	`checkForBalance(Map prMap)` Check for balance: 1) The number of buckets per vm is roughly equal.
`protected void`	`controller()` Main controller for recover delay tests.
`protected void`	`controllerStartVMs()` Start vms, either one at a time or concurrently, with appropriate validation.
`protected void`	`controllerStopVMs()` Stop vms, either one at a time or concurrently, with appropriate validation.
`protected Set`	`getBucketIds(List aBucketList)`
`protected Set`	`getLostBuckets()`
`static void`	`HydraTask_checkForBalance()` Checks for rough balance of buckets, keys and primaries.
`static void`	`HydraTask_controller()` Task to control the delay recover test.
`static void`	`HydraTask_initAfterLoad()` Task to control the delay recover test.
`static void`	`HydraTask_initializeAccessor()` Creates and initializes the singleton instance of RecovDelayTest in this VM and the vm's accessor region.
`static void`	`HydraTask_initializeDataStore()` Creates and initializes the singleton instance of RecovDelayTest in this VM and the vm's data store region.
`static void`	`HydraTask_initRedundantCopies()` Write the number of redundant copies for the pr to the blackboard by using the hydra param RecovDelayPrms.redundantCopies, which can be: "zero" - Write 0 to the blackboard.
`static void`	`HydraTask_load()` Loads the region with keys/values.
`static void`	`HydraTask_waitForStartupRecovery()` If this vm has a startup delay, wait for it.
`protected void`	`initAfterLoad()` Do initialization after the load
`void`	`initializeInstance()` Initialize this test instance
`void`	`initializeRegion(String regDescriptName)` Create a region with the given region description name.
`protected void`	`load()` Load the region with RecovDelayPrms.initialNumKeys.
`protected List`	`stopVMs(List availableVMs, int numToStop)` Using the list of available vms, stop numToStop vms and return a List of ClientVmInfos that were stopped.
`protected void`	`validateNoRecovery()` Verify that no recovery has occurred.
`protected void`	`validatePRAfterStarting(List previousLiveVMs, List vmsStartedThisTime)` Do various checks on the PR after starting: - check for balance if we recovered - make sure each bucket has a primary - verify consistency of PR meta data - verify data - verify bucket copy consistency
`protected void`	`validatePRAfterStopping(int numStoppedThisTime)` Do various checks on the PR after stopping: - make sure each bucket has a primary - verify consistency of PR meta data - verify data - verify bucket copy consistency
`protected void`	`validateRecoveryNow(List vmsExpectingRecovery, int numRecovPerVM, boolean isStartupRecovery)` Validate that recovery occurs now.
`protected void`	`validateRecoveryWithDelay(int delayMillis, List vmsExpectingRecovery, int numRecovPerVM, boolean isStartupRecovery)` Validate that recovery occurs after the given delay.
`protected void`	`verifyBucketsInVMs(List emptyVMs, List nonEmptyVMs)` Verify that the given vms contain no buckets.
`protected void`	`waitForNever()` Wait a sufficient amount of time to satisfy the test that recovery never runs.

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

- Field Detail
  - testInstance
```
public static RecovDelayTest testInstance
```
  - vmIDStr
```
protected static final String vmIDStr
```
    See Also:
    
    Constant Field Values
  - redundantCopiesKey
```
protected static final String redundantCopiesKey
```
    See Also:
    
    Constant Field Values
  - START_WITH_ALL
```
protected static final String START_WITH_ALL
```
    See Also:
    
    Constant Field Values
  - SERIAL_STARTUP
```
protected static final String SERIAL_STARTUP
```
    See Also:
    
    Constant Field Values
  - CONCURRENT_STARTUP
```
protected static final String CONCURRENT_STARTUP
```
    See Also:
    
    Constant Field Values
  - aRegion
```
protected com.gemstone.gemfire.cache.Region aRegion
```
  - startStrategy
```
protected String startStrategy
```
  - stopStrategy
```
protected String stopStrategy
```
  - recoveryDelay
```
protected int recoveryDelay
```
  - startupRecoveryDelay
```
protected int startupRecoveryDelay
```
  - redundantCopies
```
protected int redundantCopies
```
  - totalBucketCopies
```
protected int totalBucketCopies
```
  - numDataStoreVMs
```
protected int numDataStoreVMs
```
  - totalNumVMsToStop
```
protected int totalNumVMsToStop
```
  - stoppedVMs
```
protected List stoppedVMs
```
  - vmsToStart
```
protected List vmsToStart
```
  - liveVMs
```
protected List liveVMs
```
  - parRegTestInstance
```
protected ParRegTest parRegTestInstance
```
  - masterBucketInfoList
```
protected List masterBucketInfoList
```
  - masterPrMap
```
protected Map masterPrMap
```
  - masterBucketIdSet
```
protected Set masterBucketIdSet
```
  - uniqueHostTest
```
protected boolean uniqueHostTest
```
  - hostMap
```
protected Map hostMap
```
  - startupRecoveryRace
```
protected boolean startupRecoveryRace
```
  - NEVER
```
protected final int NEVER
```
    See Also:
    
    Constant Field Values
  - IMMEDIATE
```
protected final int IMMEDIATE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - RecovDelayTest
```
public RecovDelayTest()
```
- Method Detail
  - HydraTask_initializeDataStore
```
public static void HydraTask_initializeDataStore()
```
    Creates and initializes the singleton instance of RecovDelayTest in this VM and the vm's data store region.
  - HydraTask_initializeAccessor
```
public static void HydraTask_initializeAccessor()
```
    Creates and initializes the singleton instance of RecovDelayTest in this VM and the vm's accessor region.
  - initializeRegion
```
public void initializeRegion(String regDescriptName)
```
    Create a region with the given region description name.
    
    Parameters:
    
    regDescriptName - The name of a region description.
  - initializeInstance
```
public void initializeInstance()
```
    Initialize this test instance
  - initAfterLoad
```
protected void initAfterLoad()
```
    Do initialization after the load
  - HydraTask_load
```
public static void HydraTask_load()
```
    Loads the region with keys/values.
  - HydraTask_checkForBalance
```
public static void HydraTask_checkForBalance()
```
    Checks for rough balance of buckets, keys and primaries.
  - HydraTask_controller
```
public static void HydraTask_controller()
```
    Task to control the delay recover test. There should only be one thread at a time calling this method.
  - HydraTask_initAfterLoad
```
public static void HydraTask_initAfterLoad()
```
    Task to control the delay recover test.
  - HydraTask_initRedundantCopies
```
public static void HydraTask_initRedundantCopies()
```
    Write the number of redundant copies for the pr to the blackboard by using the hydra param RecovDelayPrms.redundantCopies, which can be: "zero" - Write 0 to the blackboard. "nonZero" - Randome choose 1, 2 or 3 and write to the blackboard.
  - HydraTask_waitForStartupRecovery
```
public static void HydraTask_waitForStartupRecovery()
```
    If this vm has a startup delay, wait for it.
  - load
```
protected void load()
```
    Load the region with RecovDelayPrms.initialNumKeys. This is batched and must be called multiple times until a stop scheduling exception is thrown.
  - controller
```
protected void controller()
```
    Main controller for recover delay tests. Stop the vms with validation, then restart them with validation.
  - controllerStopVMs
```
protected void controllerStopVMs()
```
    Stop vms, either one at a time or concurrently, with appropriate validation. This method gets called repeatedly to do its job, so its task can be batched. It will stop one or more vms per call until totalNumVMsToStop has been reached.
  - controllerStartVMs
```
protected void controllerStartVMs()
```
    Start vms, either one at a time or concurrently, with appropriate validation. This method gets called repeatedly to do its job, so its task can be batched. It will start one or more vms per call until all totalNumVMsToStop stopped vms have been restarted.
  - validatePRAfterStopping
```
protected void validatePRAfterStopping(int numStoppedThisTime)
```
    Do various checks on the PR after stopping: - make sure each bucket has a primary - verify consistency of PR meta data - verify data - verify bucket copy consistency
    
    Parameters:
    
    numStoppedThisTime - The number of vms stopped the last time vms were stopped.
  - validatePRAfterStarting
```
protected void validatePRAfterStarting(List previousLiveVMs,
                                       List vmsStartedThisTime)
```
    Do various checks on the PR after starting: - check for balance if we recovered - make sure each bucket has a primary - verify consistency of PR meta data - verify data - verify bucket copy consistency
    
    Parameters:
    
    previousLiveVMs - A List of ClientVmInfo instances of the vms that were alive prior to starting vmsStartedThisTime.
    
    vmsStartedThisTime - A List of ClientVmInfo instances of the vms started this time.
  - validateNoRecovery
```
protected void validateNoRecovery()
```
    Verify that no recovery has occurred.
  - validateRecoveryNow
```
protected void validateRecoveryNow(List vmsExpectingRecovery,
                                   int numRecovPerVM,
                                   boolean isStartupRecovery)
```
    Validate that recovery occurs now. Returns when recovery is finished.
    
    Parameters:
    
    vmsExpectingRecovery - A List of either Integers (vmIds) or ClientVmInfo instances containing vmIds of vms expected to recover.
    
    numRecovPerVM - The number of recovery activities expected per vm in vmsExpectingRecovery.
    
    isStartupRecovery - true if the expected recovery is from startup, false otherwise.
  - validateRecoveryWithDelay
```
protected void validateRecoveryWithDelay(int delayMillis,
                                         List vmsExpectingRecovery,
                                         int numRecovPerVM,
                                         boolean isStartupRecovery)
```
    Validate that recovery occurs after the given delay. Returns when recovery is finished.
    
    Parameters:
    
    delayMillis - The delay value in milliseconds.
    
    vmsExpectingRecovery - A List of either Integers (vmIds) or ClientVmInfo instances containing vmIds of vms expected to recover.
    
    numRecovPerVM - The number of recovery activities expected per vm in vmsExpectingRecovery.
    
    isStartupRecovery - true if the expected recovery is from startup, false otherwise.
  - checkForBalance
```
protected void checkForBalance(Map prMap)
```
    Check for balance: 1) The number of buckets per vm is roughly equal. 2) The number of primaries per vm is roughly equal. 3) The number of entries per bucket is roughly equal. Throw an exception if any are out of balance. This is used for an initial balance check after loading. It allows for a variance, rather than exact balance. NOTE: This checks for balance for vms that contain buckets. VMs that don't contain buckets are not considered.
    
    Parameters:
    
    prMap - The return from PrState.getPrMap(Region); this the the PR picture to check.
  - waitForNever
```
protected void waitForNever()
```
    Wait a sufficient amount of time to satisfy the test that recovery never runs. This must be longer than the delays used in the test so we know it's really never.
  - verifyBucketsInVMs
```
protected void verifyBucketsInVMs(List emptyVMs,
                                  List nonEmptyVMs)
```
    Verify that the given vms contain no buckets.
    
    Parameters:
    
    emptyVMs - A List of ClientVmInfo instances or vm ids (Integers). This vms should contain no buckets. This arg can be null.
    
    nonEmptyVMs - A List of ClientVmInfo instances or vm ids (Integers). This vms should contain buckets. This arg can be null.
  - stopVMs
```
protected List stopVMs(List availableVMs,
                       int numToStop)
```
    Using the list of available vms, stop numToStop vms and return a List of ClientVmInfos that were stopped.
    
    Parameters:
    
    availableVMs - A List of Integers, where the Integer is the vm id of a vm available for stopping. This is modified upon return to remove the vms that were stopped.
    
    numToStop - The desired number of vms to stop. Throws an exception of this is more than the number of vms available to stop.
    
    Returns:
    
    A List of ClientVmInfos that were stopped.
  - getBucketIds
```
protected Set getBucketIds(List aBucketList)
```
  - getLostBuckets
```
protected Set getLostBuckets()
```
  - adjustRegionSnapshotForLostKeys
```
protected void adjustRegionSnapshotForLostKeys(Map regionSnapshot)
```

Class RecovDelayTest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

testInstance

vmIDStr

redundantCopiesKey

START_WITH_ALL

SERIAL_STARTUP

CONCURRENT_STARTUP

aRegion

startStrategy

stopStrategy

recoveryDelay

startupRecoveryDelay

redundantCopies

totalBucketCopies

numDataStoreVMs

totalNumVMsToStop

stoppedVMs

vmsToStart

liveVMs

parRegTestInstance

masterBucketInfoList

masterPrMap

masterBucketIdSet

uniqueHostTest

hostMap

startupRecoveryRace

NEVER

IMMEDIATE

Constructor Detail

RecovDelayTest

Method Detail

HydraTask_initializeDataStore

HydraTask_initializeAccessor

initializeRegion

initializeInstance

initAfterLoad

HydraTask_load

HydraTask_checkForBalance

HydraTask_controller

HydraTask_initAfterLoad

HydraTask_initRedundantCopies

HydraTask_waitForStartupRecovery

load

controller

controllerStopVMs

controllerStartVMs

validatePRAfterStopping

validatePRAfterStarting

validateNoRecovery

validateRecoveryNow

validateRecoveryWithDelay

checkForBalance

waitForNever

verifyBucketsInVMs

stopVMs

getBucketIds

getLostBuckets

adjustRegionSnapshotForLostKeys