com.gemstone.gemfire.cache30

Class RegionTestCase

java.lang.Object

junit.framework.Assert

junit.framework.TestCase

dunit.DistributedTestCase

com.gemstone.gemfire.cache30.CacheTestCase

com.gemstone.gemfire.cache30.RegionTestCase

All Implemented Interfaces:

Serializable, junit.framework.Test

Direct Known Subclasses:

MultiVMRegionTestCase, RegionAttributesTestCase

public abstract class RegionTestCase
extends CacheTestCase

An abstract class whose test methods test the functionality of a region regardless of its scope.

This class also contains functionality that is used by subclasses. See getRegionAttributes().

Since:

3.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	RegionTestCase.TestExpiry

Nested classes/interfaces inherited from class dunit.DistributedTestCase

DistributedTestCase.ExpectedException, DistributedTestCase.WaitCriterion, DistributedTestCase.WaitCriterion2

Field Summary

Fields

Modifier and Type	Field and Description
protected int	eventCount
static com.gemstone.gemfire.cache.Region	preSnapshotRegion Tests basic creation and loading of a snapshot from perspective of single VM

Fields inherited from class com.gemstone.gemfire.cache30.CacheTestCase

cache

Fields inherited from class dunit.DistributedTestCase

logPerTest, reconnect, system, testName

Constructor Summary

Constructors

Constructor and Description
RegionTestCase(String name)

Method Summary

Modifier and Type	Method and Description
protected com.gemstone.gemfire.cache.Region	createRegion(String name) Returns a region with the given name and the attributes for this test.
protected com.gemstone.gemfire.cache.Region	createRootRegion()
static boolean	entryIsLocal(com.gemstone.gemfire.cache.Region.Entry re)
protected abstract com.gemstone.gemfire.cache.RegionAttributes	getRegionAttributes() Returns the attributes of a region to be tested by this test.
protected void	pauseIfNecessary() pauses only if no ack
protected void	pauseIfNecessary(int ms)
void	remoteTestPostSnapshot(String name, boolean isController, boolean isRoot)
protected boolean	supportsLocalDestroyAndLocalInvalidate() Indicate whether localDestroy and localInvalidate are supported
protected boolean	supportsSubregions() Indicate whether subregions are supported
void	tearDown2() Tears down the test.
void	testBadRegionAccess() Tests that creating or getting entries at an improper time throws exceptions.
void	testCloseRegion() Tests closing a region, and checks different behavior when this is a disk region with persistBackup.
void	testContainsKey() Tests that creating an entry in a region actually creates it
void	testCreateSubregions() Tests creating subregions.
void	testCustomEntryIdleReset() Verify that a get or put resets the idle time on an entry
void	testCustomEntryIdleTimeout1() Verify that special entries expire but other entries in the region don't
void	testCustomEntryIdleTimeout2() Verify that special entries don't expire but other entries in the region do
void	testCustomEntryIdleTimeout3() Expire an entry with a custom idle time.
void	testCustomEntryTtl1() Verify that special entries expire but other entries in the region don't
void	testCustomEntryTtl2() Verify that special entries don't expire but other entries in the region do
void	testCustomEntryTtl3() Expire an entry with a custom ttl time.
void	testCustomIdleOnce() Verify that expiry is calculatod only once on an entry
void	testDestroyEntry() Tests destroying an entry and attempting to access it afterwards.
void	testDestroyRegion() Tests destroying an entire region and that accessing it after it has been destory causes a RegionDestroyedException.
void	testEntries() Tests the Region.entries(boolean) method without recursion
void	testEntriesRecursive() Tests the Region.entries(boolean) method with recursion
void	testEntryExpirationAfterMutate()
void	testEntryFromLoadTtlInvalidate() Tests that an entry whose value is loaded into a region expires with an invalidation after a given time to live.
void	testEntryIdleDestroy() Tests that an entry in a region that remains idle for a given amount of time is destroyed.
void	testEntryIdleInvalidate() Tests that an entry in a local region that remains idle for a given amount of time is invalidated.
void	testEntryIdleReset() Verify that accessing an entry resets its idle time
void	testEntryIdleTimeout3() Expire an entry with a given idle time.
void	testEntryIdleTtl() Verify that accessing an entry does not delay expiration due to TTL
void	testEntryTtl3() Expire an entry with a ttl time.
void	testEntryTtlDestroy() Tests that an entry in a region expires with a destroy after a given time to live.
void	testEntryTtlInvalidate() Tests that an entry in a region expires with an invalidation after a given time to live.
void	testEntryUserAttribute() Tests a region entry's user attribute
void	testGetCache() Tests the Region.getCache() method (for what it's worth)
void	testGetName() Tests the Region.getName() method
void	testGetParentRegion() Tests the Region.getParentRegion() method
void	testGetPathFromRoot() Tests the Region.getFullPath() method
void	testInvalidateEntry() Tests invalidating a region entry
void	testInvalidateRegion() Tests invalidating an entire region
void	testKeys() Tests the Region.keys() method.
void	testLocalDestroyEntry() Tests locally destroying an entry and attempting to access it afterwards.
void	testLocalDestroyRegion() Tests locally destroying an entire region and that accessing it after it has been destory causes a RegionDestroyedException.
void	testLocalInvalidateEntry() Tests locally invalidating a region entry
void	testLocalInvalidateRegion() Tests locally invalidating an entire region
void	testNulls() Tests that sending null to various APIs throws the appropriate exception.
void	testPutNonExistentEntry() Tests that Region.put(K, V) on a previously non-existent region entry creates it.
void	testRegionExpirationAfterMutate()
void	testRegionIdleDestroy() Tests that a region expires with a destruction after a given idle time.
void	testRegionIdleInvalidate() Tests that a region that remains idle for a given amount of time is invalidated.
void	testRegionTtlDestroy() Tests that a region expires with a destruction after a given time to live.
void	testRegionTtlInvalidate() Tests that a region expires with an invalidation after a given time to live.
void	testRegionUserAttribute() Tests a Region's user attribute
void	testRootSnapshot()
void	testSnapshot()
void	testSubregions() Tests the Region.subregions(boolean) method without recursion
void	testSubregionsRecursive() Tests the Region.subregions(boolean) method with recursion
void	testValues() Tests the Region.values() method without recursion
protected void	waitForDestroy(com.gemstone.gemfire.cache.Region.Entry entry, long p_tilt) Since tilt is the earliest time we expect, one must check the current time before invoking the operation intended to keep the entry alive.
protected void	waitForInvalidate(com.gemstone.gemfire.cache.Region.Entry entry, long p_tilt) Since tilt is the earliest time we expect, one must check the current time before invoking the operation intended to keep the entry alive.
protected void	waitForRegionDestroy(com.gemstone.gemfire.cache.Region region, long p_tilt) Since tilt is the earliest time we expect, one must check the current time before invoking the operation intended to keep the region alive.

Methods inherited from class com.gemstone.gemfire.cache30.CacheTestCase

addExceptionTag1, basicGetCache, beginCacheXml, cleanDiskDirs, closeAllCache, closeCache, createLonerCache, createMcastCache, createMcastCache, createRegion, createRegion, createRootRegion, createRootRegion, disconnectFromDS, finishCacheXml, finishCacheXml, getCache, getCache, getCache, getCache, getClientCache, getDiskDirs, getGemfireCache, getInternalRegionArguments, getRootRegion, getRootRegion, hasCache, remoteTearDown, removeExceptionTag1, sendSerialMessageToAll, sendUnorderedMessageToAll

Methods inherited from class dunit.DistributedTestCase

addExpectedException, addExpectedException, addHydraProperties, attachDebugger, checkBBFlag, cleanupAllVms, clearBBFlag, crashDistributedSystem, crashDistributedSystem, createLogWriter, disconnectAllFromDS, 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, setUp, 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

eventCount

protected volatile int eventCount

preSnapshotRegion

public static com.gemstone.gemfire.cache.Region preSnapshotRegion

Tests basic creation and loading of a snapshot from perspective of single VM

Constructor Detail

RegionTestCase

public RegionTestCase(String name)

Method Detail

tearDown2

public void tearDown2()
               throws Exception

Description copied from class: DistributedTestCase

Tears down the test. This method is called by the final DistributedTestCase.tearDown() method, and should be over ridden in its place.

Overrides:

tearDown2 in class CacheTestCase

Throws:

Exception

createRegion

protected final com.gemstone.gemfire.cache.Region createRegion(String name)
                                                        throws com.gemstone.gemfire.cache.CacheException

Returns a region with the given name and the attributes for this test.

Throws:

com.gemstone.gemfire.cache.CacheException

See Also:

getRegionAttributes()

createRootRegion

protected final com.gemstone.gemfire.cache.Region createRootRegion()
                                                            throws com.gemstone.gemfire.cache.CacheException

Throws:

com.gemstone.gemfire.cache.CacheException

getRegionAttributes

protected abstract com.gemstone.gemfire.cache.RegionAttributes getRegionAttributes()

Returns the attributes of a region to be tested by this test. Note that the decision as to which attributes are used is left up to the concrete subclass.

pauseIfNecessary

protected void pauseIfNecessary()

pauses only if no ack

pauseIfNecessary

protected void pauseIfNecessary(int ms)

testContainsKey

public void testContainsKey()
                     throws com.gemstone.gemfire.cache.CacheException

Tests that creating an entry in a region actually creates it

Throws:

com.gemstone.gemfire.cache.CacheException

See Also:

Region.containsKey(java.lang.Object), Region.containsValueForKey(java.lang.Object)

testBadRegionAccess

public void testBadRegionAccess()
                         throws com.gemstone.gemfire.cache.CacheException

Tests that creating or getting entries at an improper time throws exceptions.

Throws:

com.gemstone.gemfire.cache.CacheException

See Also:

Region.get(java.lang.Object), Region.getEntry(java.lang.Object), Region.create(K, V)

testPutNonExistentEntry

public void testPutNonExistentEntry()
                             throws com.gemstone.gemfire.cache.CacheException

Tests that Region.put(K, V) on a previously non-existent region entry creates it.

Throws:

com.gemstone.gemfire.cache.CacheException

supportsSubregions

protected boolean supportsSubregions()

Indicate whether subregions are supported

Returns:

supportsLocalDestroyAndLocalInvalidate

protected boolean supportsLocalDestroyAndLocalInvalidate()

Indicate whether localDestroy and localInvalidate are supported

Returns:

true if they are supported

testNulls

public void testNulls()
               throws com.gemstone.gemfire.cache.CacheException

Tests that sending null to various APIs throws the appropriate exception.

Throws:

com.gemstone.gemfire.cache.CacheException

testCreateSubregions

public void testCreateSubregions()
                          throws com.gemstone.gemfire.cache.CacheException

Tests creating subregions. Note that this tests accesses the Region's statistics, so the region must have been created with statistics enabled.

Throws:

com.gemstone.gemfire.cache.CacheException

entryIsLocal

public static boolean entryIsLocal(com.gemstone.gemfire.cache.Region.Entry re)

testDestroyEntry

public void testDestroyEntry()
                      throws com.gemstone.gemfire.cache.CacheException

Tests destroying an entry and attempting to access it afterwards.

Throws:

com.gemstone.gemfire.cache.CacheException

testDestroyRegion

public void testDestroyRegion()
                       throws com.gemstone.gemfire.cache.CacheException

Tests destroying an entire region and that accessing it after it has been destory causes a RegionDestroyedException.

Throws:

com.gemstone.gemfire.cache.CacheException

See Also:

Region.destroyRegion()

testEntries

public void testEntries()
                 throws com.gemstone.gemfire.cache.CacheException

Tests the Region.entries(boolean) method without recursion

Throws:

com.gemstone.gemfire.cache.CacheException

testEntriesRecursive

public void testEntriesRecursive()
                          throws com.gemstone.gemfire.cache.CacheException

Tests the Region.entries(boolean) method with recursion

Throws:

com.gemstone.gemfire.cache.CacheException

testGetCache

public void testGetCache()
                  throws com.gemstone.gemfire.cache.CacheException

Tests the Region.getCache() method (for what it's worth)

Throws:

com.gemstone.gemfire.cache.CacheException

testGetName

public void testGetName()
                 throws com.gemstone.gemfire.cache.CacheException

Tests the Region.getName() method

Throws:

com.gemstone.gemfire.cache.CacheException

testGetPathFromRoot

public void testGetPathFromRoot()
                         throws com.gemstone.gemfire.cache.CacheException

Tests the Region.getFullPath() method

Throws:

com.gemstone.gemfire.cache.CacheException

testGetParentRegion

public void testGetParentRegion()
                         throws com.gemstone.gemfire.cache.CacheException

Tests the Region.getParentRegion() method

Throws:

com.gemstone.gemfire.cache.CacheException

testRegionUserAttribute

public void testRegionUserAttribute()
                             throws com.gemstone.gemfire.cache.CacheException

Tests a Region's user attribute

Throws:

com.gemstone.gemfire.cache.CacheException

See Also:

Region.setUserAttribute(java.lang.Object)

testEntryUserAttribute

public void testEntryUserAttribute()
                            throws com.gemstone.gemfire.cache.CacheException

Tests a region entry's user attribute

Throws:

com.gemstone.gemfire.cache.CacheException

testInvalidateEntry

public void testInvalidateEntry()
                         throws com.gemstone.gemfire.cache.CacheException

Tests invalidating a region entry

Throws:

com.gemstone.gemfire.cache.CacheException

testInvalidateRegion

public void testInvalidateRegion()
                          throws com.gemstone.gemfire.cache.CacheException

Tests invalidating an entire region

Throws:

com.gemstone.gemfire.cache.CacheException

testKeys

public void testKeys()
              throws com.gemstone.gemfire.cache.CacheException

Tests the Region.keys() method.

Throws:

com.gemstone.gemfire.cache.CacheException

testLocalDestroyEntry

public void testLocalDestroyEntry()
                           throws com.gemstone.gemfire.cache.CacheException

Tests locally destroying an entry and attempting to access it afterwards. (Not too useful with a LOCAL region.)

Throws:

com.gemstone.gemfire.cache.CacheException

testLocalDestroyRegion

public void testLocalDestroyRegion()
                            throws com.gemstone.gemfire.cache.CacheException

Tests locally destroying an entire region and that accessing it after it has been destory causes a RegionDestroyedException.

Throws:

com.gemstone.gemfire.cache.CacheException

See Also:

Region.localDestroyRegion()

testCloseRegion

public void testCloseRegion()
                     throws com.gemstone.gemfire.cache.CacheException

Tests closing a region, and checks different behavior when this is a disk region with persistBackup.

Throws:

com.gemstone.gemfire.cache.CacheException

testLocalInvalidateEntry

public void testLocalInvalidateEntry()
                              throws com.gemstone.gemfire.cache.CacheException

Tests locally invalidating a region entry

Throws:

com.gemstone.gemfire.cache.CacheException

testLocalInvalidateRegion

public void testLocalInvalidateRegion()
                               throws com.gemstone.gemfire.cache.CacheException

Tests locally invalidating an entire region

Throws:

com.gemstone.gemfire.cache.CacheException

testSubregions

public void testSubregions()
                    throws com.gemstone.gemfire.cache.CacheException

Tests the Region.subregions(boolean) method without recursion

Throws:

com.gemstone.gemfire.cache.CacheException

testSubregionsRecursive

public void testSubregionsRecursive()
                             throws com.gemstone.gemfire.cache.CacheException

Tests the Region.subregions(boolean) method with recursion

Throws:

com.gemstone.gemfire.cache.CacheException

testValues

public void testValues()
                throws com.gemstone.gemfire.cache.CacheException

Tests the Region.values() method without recursion

Throws:

com.gemstone.gemfire.cache.CacheException

waitForInvalidate

protected void waitForInvalidate(com.gemstone.gemfire.cache.Region.Entry entry,
                                 long p_tilt)

Since tilt is the earliest time we expect, one must check the current time before invoking the operation intended to keep the entry alive.

Parameters:

entry - entry we want to be invalidated

p_tilt - earliest time we expect to see the invalidate

waitForDestroy

protected void waitForDestroy(com.gemstone.gemfire.cache.Region.Entry entry,
                              long p_tilt)

Since tilt is the earliest time we expect, one must check the current time before invoking the operation intended to keep the entry alive.

Parameters:

entry - entry we want to be invalidated

p_tilt - earliest time we expect to see the invalidate

waitForRegionDestroy

protected void waitForRegionDestroy(com.gemstone.gemfire.cache.Region region,
                                    long p_tilt)

Since tilt is the earliest time we expect, one must check the current time before invoking the operation intended to keep the region alive.

Parameters:

region - region we want to be destroyed

p_tilt - earliest time we expect to see the destroy

testEntryTtlInvalidate

public void testEntryTtlInvalidate()
                            throws com.gemstone.gemfire.cache.CacheException

Tests that an entry in a region expires with an invalidation after a given time to live.

Throws:

com.gemstone.gemfire.cache.CacheException

testCustomEntryTtl1

public void testCustomEntryTtl1()

Verify that special entries expire but other entries in the region don't

testCustomEntryTtl2

public void testCustomEntryTtl2()

Verify that special entries don't expire but other entries in the region do

testCustomEntryTtl3

public void testCustomEntryTtl3()

Expire an entry with a custom ttl time. Set a new ttl time, create the same entry again, make sure it observes the new ttl time.

testEntryTtl3

public void testEntryTtl3()

Expire an entry with a ttl time. Set a new ttl time, create the same entry again, make sure it observes the new ttl time.

testEntryFromLoadTtlInvalidate

public void testEntryFromLoadTtlInvalidate()
                                    throws com.gemstone.gemfire.cache.CacheException,
                                           InterruptedException

Tests that an entry whose value is loaded into a region expires with an invalidation after a given time to live.

Throws:

com.gemstone.gemfire.cache.CacheException

InterruptedException

testEntryTtlDestroy

public void testEntryTtlDestroy()
                         throws com.gemstone.gemfire.cache.CacheException,
                                InterruptedException

Tests that an entry in a region expires with a destroy after a given time to live.

Throws:

com.gemstone.gemfire.cache.CacheException

InterruptedException

testRegionTtlInvalidate

public void testRegionTtlInvalidate()
                             throws com.gemstone.gemfire.cache.CacheException,
                                    InterruptedException

Tests that a region expires with an invalidation after a given time to live.

Throws:

com.gemstone.gemfire.cache.CacheException

InterruptedException

testRegionTtlDestroy

public void testRegionTtlDestroy()
                          throws com.gemstone.gemfire.cache.CacheException,
                                 InterruptedException

Tests that a region expires with a destruction after a given time to live.

Throws:

com.gemstone.gemfire.cache.CacheException

InterruptedException

testEntryIdleInvalidate

public void testEntryIdleInvalidate()
                             throws com.gemstone.gemfire.cache.CacheException,
                                    InterruptedException

Tests that an entry in a local region that remains idle for a given amount of time is invalidated.

Throws:

com.gemstone.gemfire.cache.CacheException

InterruptedException

testCustomEntryIdleTimeout1

public void testCustomEntryIdleTimeout1()

Verify that special entries expire but other entries in the region don't

testCustomEntryIdleTimeout2

public void testCustomEntryIdleTimeout2()

Verify that special entries don't expire but other entries in the region do

testCustomEntryIdleTimeout3

public void testCustomEntryIdleTimeout3()

Expire an entry with a custom idle time. Set a new idle time, create the same entry again, make sure it observes the new idle time.

testEntryIdleTimeout3

public void testEntryIdleTimeout3()

Expire an entry with a given idle time. Set a new idle time, create the same entry again, make sure it observes the new idle time.

testCustomIdleOnce

public void testCustomIdleOnce()

Verify that expiry is calculatod only once on an entry

testCustomEntryIdleReset

public void testCustomEntryIdleReset()

Verify that a get or put resets the idle time on an entry

testEntryIdleDestroy

public void testEntryIdleDestroy()
                          throws com.gemstone.gemfire.cache.CacheException,
                                 InterruptedException

Tests that an entry in a region that remains idle for a given amount of time is destroyed.

Throws:

com.gemstone.gemfire.cache.CacheException

InterruptedException

testEntryIdleReset

public void testEntryIdleReset()
                        throws Exception

Verify that accessing an entry resets its idle time

Throws:

Exception

testEntryExpirationAfterMutate

public void testEntryExpirationAfterMutate()
                                    throws com.gemstone.gemfire.cache.CacheException,
                                           InterruptedException

Throws:

com.gemstone.gemfire.cache.CacheException

InterruptedException

testEntryIdleTtl

public void testEntryIdleTtl()

Verify that accessing an entry does not delay expiration due to TTL

testRegionExpirationAfterMutate

public void testRegionExpirationAfterMutate()
                                     throws com.gemstone.gemfire.cache.CacheException,
                                            InterruptedException

Throws:

com.gemstone.gemfire.cache.CacheException

InterruptedException

testRegionIdleInvalidate

public void testRegionIdleInvalidate()
                              throws InterruptedException,
                                     com.gemstone.gemfire.cache.CacheException

Tests that a region that remains idle for a given amount of time is invalidated. Also tests that accessing an entry of a region or a subregion counts as an access.

Throws:

InterruptedException

com.gemstone.gemfire.cache.CacheException

testRegionIdleDestroy

public void testRegionIdleDestroy()
                           throws com.gemstone.gemfire.cache.CacheException,
                                  InterruptedException

Tests that a region expires with a destruction after a given idle time.

Throws:

com.gemstone.gemfire.cache.CacheException

InterruptedException

testSnapshot

public void testSnapshot()
                  throws IOException,
                         com.gemstone.gemfire.cache.CacheException,
                         ClassNotFoundException

Throws:

IOException

com.gemstone.gemfire.cache.CacheException

ClassNotFoundException

testRootSnapshot

public void testRootSnapshot()
                      throws IOException,
                             com.gemstone.gemfire.cache.CacheException,
                             ClassNotFoundException

Throws:

IOException

com.gemstone.gemfire.cache.CacheException

ClassNotFoundException

remoteTestPostSnapshot

public void remoteTestPostSnapshot(String name,
                                   boolean isController,
                                   boolean isRoot)
                            throws com.gemstone.gemfire.cache.CacheException

Throws:

com.gemstone.gemfire.cache.CacheException