com.gemstone.gemfire.internal.cache

Class DistributedCacheTestCase

java.lang.Object

junit.framework.Assert

junit.framework.TestCase

dunit.DistributedTestCase

com.gemstone.gemfire.internal.cache.DistributedCacheTestCase

All Implemented Interfaces:

Serializable, junit.framework.Test

Direct Known Subclasses:

CacheEventListenerTest, PartitionedRegionEventsDUnitTest, SystemFailureAdminDUnitTest, SystemFailureDUnitTest

public abstract class DistributedCacheTestCase
extends DistributedTestCase

This is the abstract superclass of tests that validate the functionality of GemFire's distributed caches. It provides a number of convenient helper classes.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class dunit.DistributedTestCase

DistributedTestCase.ExpectedException, DistributedTestCase.WaitCriterion, DistributedTestCase.WaitCriterion2

Field Summary

Fields

Modifier and Type	Field and Description
protected static com.gemstone.gemfire.cache.Cache	cache The current cache in this VM

Fields inherited from class dunit.DistributedTestCase

logPerTest, reconnect, system, testName

Constructor Summary

Constructors

Constructor and Description
DistributedCacheTestCase(String name)

Method Summary

Modifier and Type	Method and Description
void	forEachVMInvoke(String methodName, Object[] args) Assumes there is only one host, and invokes the given method in every VM that host knows about.
protected static com.gemstone.gemfire.distributed.internal.DistributionManager	getDistributionManager() Return the distribution manager associate with the cache
protected static com.gemstone.gemfire.cache.Region	getRootRegion() Returns the root region of the cache.
protected static void	remoteAssertEntryValue(String regionName, String entryName, Object expected) Asserts that the value of an entry in a region is what we expect it to be.
protected static void	remoteCreateRegion(String name) Creates a new sub-Region of the root Region in a remote VM with default scope, SCOPE_LOCAL.
protected static void	remoteCreateRegion(String name, com.gemstone.gemfire.cache.Scope scope) Creates a new sub-Region of the root Region in a remote VM.
protected static void	remoteDefineEntry(String regionName, String entryName, com.gemstone.gemfire.cache.Scope scope) Defines an entry in the Region with the given name and scope.
protected static void	remoteDefineEntry(String regionName, String entryName, com.gemstone.gemfire.cache.Scope scope, boolean doNetSearch) Defines an entry in the Region with the given name and scope.
protected static void	remoteDestroy(String regionName, String entryName) Destroys the value of an entry in a region in a remote VM
protected static void	remoteInvalidate(String regionName, String entryName) Invalidates the value of an entry in a region in a remote VM
protected static void	remotePut(String regionName, String entryName, Object value, com.gemstone.gemfire.cache.Scope scope) Puts (or creates) a value in a subregion of region named entryName.
protected static void	remotePutDistributed(String regionName, String entryName, Object value) Does a put with the given value, defining a DISTRIBUTED_NO_ACK entry in the Region with the given name.
protected static void	remoteReplace(String regionName, String entryName, Object value) Replaces the value of an entry in a region in a remote VM
void	setUp() Sets up the test (noop).
protected void	setUp(boolean createLocalCache) Creates the Cache and root region in each remote VM and, if createLocalCache, in this VM.
void	tearDown2() Closes the cache in this VM and each remote VM

Methods inherited from class dunit.DistributedTestCase

addExpectedException, addExpectedException, addHydraProperties, attachDebugger, checkBBFlag, cleanupAllVms, clearBBFlag, crashDistributedSystem, crashDistributedSystem, createLogWriter, disconnectAllFromDS, disconnectFromDS, dumpAllStacks, dumpMyThreads, dumpStack, dumpStack, dumpStack, dumpStackTrace, fail, getAllDistributedSystemProperties, getDistributedSystemProperties, getDUnitLocatorAddress, getDUnitLocatorPort, getDUnitLocatorString, getDUnitLogLevel, getIPLiteral, getLogWriter, getLonerSystem, getMcastSystem, getMcastSystem, getRepeatTimeoutMs, getServerHostName, getSystem, getSystem, getTestClass, getTestName, getUniqueName, getVMCount, incBBFlag, invokeInEveryVM, invokeInEveryVM, invokeInEveryVM, invokeInEveryVM, invokeInEveryVMRepeatingIfNecessary, invokeInLocator, invokeRepeatingIfNecessary, isConnectedToDS, join, noteTiming, pause, pause, perVMSetUp, realTearDown, setDiskStoreForGateway, setSystem, setTestName, staticPause, tearDown, unregisterAllDataSerializersFromAllVms, unregisterDataSerializerInThisVM, unregisterInstantiatorsInThisVM, waitForBBFlag, waitForCriterion, waitMutex

Methods inherited from class junit.framework.TestCase

assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertFalse, assertFalse, assertNotNull, assertNotNull, assertNotSame, assertNotSame, assertNull, assertNull, assertSame, assertSame, assertTrue, assertTrue, countTestCases, createResult, fail, fail, failNotEquals, failNotSame, failSame, format, getName, run, run, runBare, runTest, setName, toString

Methods inherited from class java.lang.Object

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

Field Detail

cache

protected static com.gemstone.gemfire.cache.Cache cache

The current cache in this VM

Constructor Detail

DistributedCacheTestCase

public DistributedCacheTestCase(String name)

Method Detail

setUp

public void setUp()
           throws Exception

Description copied from class: DistributedTestCase

Sets up the test (noop).

Overrides:

setUp in class DistributedTestCase

Throws:

Exception

setUp

protected void setUp(boolean createLocalCache)
              throws Exception

Creates the Cache and root region in each remote VM and, if createLocalCache, in this VM.

Throws:

Exception

tearDown2

public void tearDown2()
               throws Exception

Closes the cache in this VM and each remote VM

Overrides:

tearDown2 in class DistributedTestCase

Throws:

Exception

getRootRegion

protected static com.gemstone.gemfire.cache.Region getRootRegion()
                                                          throws com.gemstone.gemfire.cache.CacheException

Returns the root region of the cache. We assume that the Cache and the root region have already been created.

Throws:

com.gemstone.gemfire.cache.CacheException

getDistributionManager

protected static com.gemstone.gemfire.distributed.internal.DistributionManager getDistributionManager()

Return the distribution manager associate with the cache

Since:

2.1

remoteCreateRegion

protected static void remoteCreateRegion(String name)
                                  throws com.gemstone.gemfire.cache.CacheException

Creates a new sub-Region of the root Region in a remote VM with default scope, SCOPE_LOCAL.

Parameters:

name - The name of the newly-created sub-Region. It is recommended that the name of the Region be the DistributedTestCase.getUniqueName() of the test.

Throws:

com.gemstone.gemfire.cache.CacheException

remoteCreateRegion

protected static void remoteCreateRegion(String name,
                                         com.gemstone.gemfire.cache.Scope scope)
                                  throws com.gemstone.gemfire.cache.CacheException

Creates a new sub-Region of the root Region in a remote VM.

Parameters:

name - The name of the newly-created sub-Region. It is recommended that the name of the Region be the DistributedTestCase.getUniqueName() of the test.

scope - create the region attributes with this scope

Throws:

com.gemstone.gemfire.cache.CacheException

remoteDefineEntry

protected static void remoteDefineEntry(String regionName,
                                        String entryName,
                                        com.gemstone.gemfire.cache.Scope scope)
                                 throws com.gemstone.gemfire.cache.CacheException

Defines an entry in the Region with the given name and scope.

Parameters:

regionName - The name of a region that is a sub-region of the root region, or a global name

entryName - Must be Serializable

Throws:

com.gemstone.gemfire.cache.CacheException

remoteDefineEntry

protected static void remoteDefineEntry(String regionName,
                                        String entryName,
                                        com.gemstone.gemfire.cache.Scope scope,
                                        boolean doNetSearch)
                                 throws com.gemstone.gemfire.cache.CacheException

Defines an entry in the Region with the given name and scope. In 3.0 this method create a subregion named entryName (with the appropriate attributes) that contains an entry named entryName.

Parameters:

regionName - The name of a region that is a sub-region of the root region, or a global name

entryName - Must be Serializable

doNetSearch - Will the distributed region perform a netSearch when looking for objects? If false a CacheException will be thrown if an entry in the region is asked for and it not there.

Throws:

com.gemstone.gemfire.cache.CacheException

remotePut

protected static void remotePut(String regionName,
                                String entryName,
                                Object value,
                                com.gemstone.gemfire.cache.Scope scope)
                         throws com.gemstone.gemfire.cache.CacheException

Puts (or creates) a value in a subregion of region named entryName.

Throws:

com.gemstone.gemfire.cache.CacheException

remotePutDistributed

protected static void remotePutDistributed(String regionName,
                                           String entryName,
                                           Object value)
                                    throws com.gemstone.gemfire.cache.CacheException

Does a put with the given value, defining a DISTRIBUTED_NO_ACK entry in the Region with the given name.

Parameters:

regionName - The name of a region that is a sub-region of the root region, or a global name

entryName - Must be Serializable

Throws:

com.gemstone.gemfire.cache.CacheException

remoteReplace

protected static void remoteReplace(String regionName,
                                    String entryName,
                                    Object value)
                             throws com.gemstone.gemfire.cache.CacheException

Replaces the value of an entry in a region in a remote VM

Parameters:

regionName - The name of a region that is a sub-region of the root region

entryName - Must be Serializable

value - The value used to replace

Throws:

com.gemstone.gemfire.cache.CacheException

See Also:

Region#put()

remoteInvalidate

protected static void remoteInvalidate(String regionName,
                                       String entryName)
                                throws com.gemstone.gemfire.cache.CacheException

Invalidates the value of an entry in a region in a remote VM

Parameters:

regionName - The name of a region that is a sub-region of the root region

entryName - Must be Serializable

Throws:

com.gemstone.gemfire.cache.CacheException

See Also:

Region#replace()

remoteDestroy

protected static void remoteDestroy(String regionName,
                                    String entryName)
                             throws com.gemstone.gemfire.cache.CacheException

Destroys the value of an entry in a region in a remote VM

Parameters:

regionName - The name of a region that is a sub-region of the root region

entryName - Must be Serializable

Throws:

com.gemstone.gemfire.cache.CacheException

See Also:

Region#replace()

remoteAssertEntryValue

protected static void remoteAssertEntryValue(String regionName,
                                             String entryName,
                                             Object expected)
                                      throws com.gemstone.gemfire.cache.CacheException

Asserts that the value of an entry in a region is what we expect it to be.

Parameters:

regionName - The name of a region that is a sub-region of the root region

entryName - Must be Serializable

Throws:

com.gemstone.gemfire.cache.CacheException

forEachVMInvoke

public void forEachVMInvoke(String methodName,
                            Object[] args)

Assumes there is only one host, and invokes the given method in every VM that host knows about.