com.gemstone.gemfire.management

Class OffHeapManagementDUnitTest

java.lang.Object

junit.framework.Assert

junit.framework.TestCase

dunit.DistributedTestCase

com.gemstone.gemfire.cache30.CacheTestCase

com.gemstone.gemfire.management.OffHeapManagementDUnitTest

All Implemented Interfaces:

Serializable, junit.framework.Test

public class OffHeapManagementDUnitTest
extends CacheTestCase

Tests the off-heap additions to the RegionMXBean and MemberMXBean JMX interfaces.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class dunit.DistributedTestCase

DistributedTestCase.ExpectedException, DistributedTestCase.WaitCriterion, DistributedTestCase.WaitCriterion2

Field Summary

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
OffHeapManagementDUnitTest(String name) Creates a new OffHeapManagementDUnitTest.

Method Summary

Modifier and Type	Method and Description
protected void	addOffHeapNotificationListener() Adds an off-heap notification listener to the MemberMXBean.
protected void	addOffHeapNotificationListenerOnVm(VM vm) Adds an off-heap notification listener to the MemberMXBean for a vm.
protected void	assertCompactionTimeStat(long compactionTime, com.gemstone.gemfire.management.OffHeapManagementDUnitTest.ASSERT_OP op) Asserts that the compactionTime stat is available and satisfies an assert operation.
protected void	assertCompactionTimeStatOnVm(VM vm, long compactionTime, com.gemstone.gemfire.management.OffHeapManagementDUnitTest.ASSERT_OP op) Asserts that the compactionTime stat is available and satisfies an assert operation.
protected void	assertFragmentationStat(int fragmentation, com.gemstone.gemfire.management.OffHeapManagementDUnitTest.ASSERT_OP op) Asserts that the fragmentation stat is available and satisfies an assert operation.
protected void	assertFragmentationStatOnVm(VM vm, int fragmentation, com.gemstone.gemfire.management.OffHeapManagementDUnitTest.ASSERT_OP op) Asserts that the fragmentation stat is available and satisfies an assert operation.
protected void	assertOffHeapMetrics(long freeMemory, long allocatedMemory, long objects, int fragmentation) Asserts that OffHeapMetrics match input parameters.
protected void	assertOffHeapMetricsOnVm(VM vm, long freeMemory, long allocatedMemory, long objects, int fragmentation) Asserts that OffHeapMetrics match input parameters for a VM.
protected void	assertOffHeapRegionAttributes() Asserts that the off heap region data is available and enabled.
protected void	assertOffHeapRegionAttributesOnVm(VM vm) Asserts that the off heap region data is available and enabled for a VM.
protected void	cleanup() Removes off-heap region and disconnects.
protected void	clearNotificationListenerOnVm(VM vm) Clears received notifications.
protected com.gemstone.gemfire.cache.Region	createOffHeapRegion(String name, com.gemstone.gemfire.cache.DataPolicy dataPolicy) Creates an off-heap region.
protected boolean	createOffHeapRegionOnVm(VM vm, String name, com.gemstone.gemfire.cache.DataPolicy dataPolicy) Creates an off-heap region on a vm.
protected void	doCleanupOnVm(VM vm) Removes off heap region on vm and disconnects.
protected int	doConsumeOffHeapMemory(int allocationSize) Consumes off off-heap memory until the allocation size cannot be satisfied.
protected int	doConsumeOffHeapMemoryOnVm(VM vm, int allocationSize) Consumes off off-heap memory until the allocation size cannot be satisfied.
protected void	doDestroy(Object key, String regionName) Performs a destroy operation.
protected void	doDestroyOnVm(VM vm, Object key, String regionName) Performs a destroy operation on a vm.
protected void	doFreeOffHeapMemory(int numAllocations, int numDestroys) Performs some destroys to free off-heap allocations.
protected void	doFreeOffHeapMemoryOnVm(VM vm, int numAllocations, int numDestroys) Destroys a number of entries previously allocated.
protected void	doPut(Object key, Object value, String regionName, boolean expectException) Performs a put operation.
protected void	doPutOnVm(VM vm, Object key, Object value, String regionName, boolean expectException) Performs a put operation on a vm.
protected Properties	getSystemProperties() Returns off-heap system properties for enabling off-heap and the JMX system.
protected void	setSystemProperties(boolean management, Properties props) Sets the distributed system properties.
protected void	setSystemPropertiesOnVm(VM vm, boolean management, Properties props) Sets the distributed system properties for a vm.
void	setUp() Sets up the test (noop).
protected void	setupOffHeapMonitor(String attribute, long highThreshold, long lowThreshold, boolean aggregate) Creates and adds a generic GaugeMonitor for an attribute of the MemberMXBean.
protected void	setupOffHeapMonitorOnVm(VM vm, String attribute, long highThreshold, long lowThreshold, boolean aggregate) Creates and adds a generic GaugeMonitor for an attribute of the MemberMXBean on a VM.
void	tearDown2() Tears down the test.
void	testCompactionTimeStat() Tests the compation time statistic for off-heap memory.
void	testFragmentationStat() Tests the fragmentation statistic for off-heap memory.
void	testOffHeapAllocatedSizeMonitoring() Asserts that a monitor assigned to the OffHeapAllocatedSize attribute is triggered.
void	testOffHeapFreeSizeAggregateMonitoring() Asserts that a monitor assigned to the OffHeapUsedSize attribute is triggered.
void	testOffHeapFreeSizeMonitoring() Asserts that a monitor assigned to the OffHeapFreeSize attribute is triggered.
void	testOffHeapMBeanAttributesAndStats() Tests off-heap additions to the RegionMXBean and MemberMXBean interfaces.
void	testOffHeapObjectsMonitoring() Asserts that a monitor assigned to the OffHeapObjects attribute is triggered.
void	testOffHeapUsedSizeAggregateMonitoring() Asserts that a monitor assigned to the OffHeapUsedSize attribute is triggered.
protected void	waitForNotificationListenerOnVm(VM vm, long wait, long interval, boolean throwOnTimeout) Waits to receive MBean notifications.

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, 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

Constructor Detail

OffHeapManagementDUnitTest

public OffHeapManagementDUnitTest(String name)

Creates a new OffHeapManagementDUnitTest.

Parameters:

name - the test 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

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

testOffHeapMBeanAttributesAndStats

public void testOffHeapMBeanAttributesAndStats()
                                        throws Exception

Tests off-heap additions to the RegionMXBean and MemberMXBean interfaces.

Throws:

Exception

testFragmentationStat

public void testFragmentationStat()
                           throws Exception

Tests the fragmentation statistic for off-heap memory.

Throws:

Exception

testCompactionTimeStat

public void testCompactionTimeStat()
                            throws Exception

Tests the compation time statistic for off-heap memory.

Throws:

Exception

testOffHeapObjectsMonitoring

public void testOffHeapObjectsMonitoring()
                                  throws Exception

Asserts that a monitor assigned to the OffHeapObjects attribute is triggered.

Throws:

Exception

testOffHeapFreeSizeMonitoring

public void testOffHeapFreeSizeMonitoring()
                                   throws Exception

Asserts that a monitor assigned to the OffHeapFreeSize attribute is triggered.

Throws:

Exception

testOffHeapAllocatedSizeMonitoring

public void testOffHeapAllocatedSizeMonitoring()
                                        throws Exception

Asserts that a monitor assigned to the OffHeapAllocatedSize attribute is triggered.

Throws:

Exception

testOffHeapUsedSizeAggregateMonitoring

public void testOffHeapUsedSizeAggregateMonitoring()
                                            throws Exception

Asserts that a monitor assigned to the OffHeapUsedSize attribute is triggered.

Throws:

Exception

testOffHeapFreeSizeAggregateMonitoring

public void testOffHeapFreeSizeAggregateMonitoring()
                                            throws Exception

Asserts that a monitor assigned to the OffHeapUsedSize attribute is triggered.

Throws:

Exception

doFreeOffHeapMemoryOnVm

protected void doFreeOffHeapMemoryOnVm(VM vm,
                                       int numAllocations,
                                       int numDestroys)

Destroys a number of entries previously allocated.

Parameters:

vm - a virtual machine

numAllocations - the number of previous off-heap allocations

numDestroys - the number of destroys to perform

doFreeOffHeapMemory

protected void doFreeOffHeapMemory(int numAllocations,
                                   int numDestroys)

Performs some destroys to free off-heap allocations.

Parameters:

numAllocations - the number of previous off-heap allocations

numDestroys - the number of destroys to perform

doConsumeOffHeapMemoryOnVm

protected int doConsumeOffHeapMemoryOnVm(VM vm,
                                         int allocationSize)

Consumes off off-heap memory until the allocation size cannot be satisfied.

Parameters:

vm - a virtual machine

allocationSize - the number of bytes for each allocation

Returns:

the number of successful puts

doConsumeOffHeapMemory

protected int doConsumeOffHeapMemory(int allocationSize)

Consumes off off-heap memory until the allocation size cannot be satisfied.

Parameters:

allocationSize - the number of bytes for each allocation

Returns:

the number of successful puts

assertCompactionTimeStatOnVm

protected void assertCompactionTimeStatOnVm(VM vm,
                                            long compactionTime,
                                            com.gemstone.gemfire.management.OffHeapManagementDUnitTest.ASSERT_OP op)

Asserts that the compactionTime stat is available and satisfies an assert operation.

Parameters:

vm - a virtual machine.

compactionTime - total off heap compaction time.

op - an assert operation.

assertCompactionTimeStat

protected void assertCompactionTimeStat(long compactionTime,
                                        com.gemstone.gemfire.management.OffHeapManagementDUnitTest.ASSERT_OP op)

Asserts that the compactionTime stat is available and satisfies an assert operation.

Parameters:

compactionTime - total off heap compaction time.

op - an assert operation.

assertFragmentationStatOnVm

protected void assertFragmentationStatOnVm(VM vm,
                                           int fragmentation,
                                           com.gemstone.gemfire.management.OffHeapManagementDUnitTest.ASSERT_OP op)

Asserts that the fragmentation stat is available and satisfies an assert operation.

Parameters:

vm - a virtual machine

fragmentation - a fragmentation percentage

op - an assertion operation

assertFragmentationStat

protected void assertFragmentationStat(int fragmentation,
                                       com.gemstone.gemfire.management.OffHeapManagementDUnitTest.ASSERT_OP op)

Asserts that the fragmentation stat is available and satisfies an assert operation.

Parameters:

fragmentation - a fragmentation percentage

op - an assertion operation

getSystemProperties

protected Properties getSystemProperties()

Returns off-heap system properties for enabling off-heap and the JMX system.

doCleanupOnVm

protected void doCleanupOnVm(VM vm)

Removes off heap region on vm and disconnects.

Parameters:

vm - a virutal machine.

cleanup

protected void cleanup()

Removes off-heap region and disconnects.

assertOffHeapRegionAttributesOnVm

protected void assertOffHeapRegionAttributesOnVm(VM vm)

Asserts that the off heap region data is available and enabled for a VM.

assertOffHeapRegionAttributes

protected void assertOffHeapRegionAttributes()

Asserts that the off heap region data is available and enabled.

assertOffHeapMetricsOnVm

protected void assertOffHeapMetricsOnVm(VM vm,
                                        long freeMemory,
                                        long allocatedMemory,
                                        long objects,
                                        int fragmentation)

Asserts that OffHeapMetrics match input parameters for a VM.

Parameters:

vm - a virtual machine.

freeMemory - total off-heap free memory in bytes.

allocatedMemory - allocated (or used) off-heap memory in bytes.

objects - number of objects stored in off-heap memory.

fragmentation - the fragmentation percentage.

assertOffHeapMetrics

protected void assertOffHeapMetrics(long freeMemory,
                                    long allocatedMemory,
                                    long objects,
                                    int fragmentation)

Asserts that OffHeapMetrics match input parameters.

Parameters:

freeMemory - total off-heap free memory in bytes.

allocatedMemory - allocated (or used) off-heap memory in bytes.

objects - number of objects stored in off-heap memory.

fragmentation - the fragmentation percentage.

createOffHeapRegionOnVm

protected boolean createOffHeapRegionOnVm(VM vm,
                                          String name,
                                          com.gemstone.gemfire.cache.DataPolicy dataPolicy)

Creates an off-heap region on a vm.

Parameters:

vm - a virtual machine.

name - a region name.

dataPolicy - a data policy.

Returns:

true if successful.

createOffHeapRegion

protected com.gemstone.gemfire.cache.Region createOffHeapRegion(String name,
                                                                com.gemstone.gemfire.cache.DataPolicy dataPolicy)

Creates an off-heap region.

Parameters:

name - a region name.

dataPolicy - a data policy.

Returns:

the newly created region.

setSystemPropertiesOnVm

protected void setSystemPropertiesOnVm(VM vm,
                                       boolean management,
                                       Properties props)

Sets the distributed system properties for a vm.

Parameters:

vm - a virtual machine.

management - starts the ManagementService when true.

props - distributed system properties.

setSystemProperties

protected void setSystemProperties(boolean management,
                                   Properties props)

Sets the distributed system properties.

Parameters:

management - starts the ManagementService when true.

props - distributed system properties.

doDestroyOnVm

protected void doDestroyOnVm(VM vm,
                             Object key,
                             String regionName)

Performs a destroy operation on a vm.

Parameters:

vm - a virtual machine.

key - the region entry to destroy.

regionName - a region name.

doDestroy

protected void doDestroy(Object key,
                         String regionName)

Performs a destroy operation.

Parameters:

key - the region entry to destroy.

regionName - a region name.

doPutOnVm

protected void doPutOnVm(VM vm,
                         Object key,
                         Object value,
                         String regionName,
                         boolean expectException)

Performs a put operation on a vm.

Parameters:

vm - a virtual machine.

key - region entry key.

value - region entry value.

regionName - a region name.

doPut

protected void doPut(Object key,
                     Object value,
                     String regionName,
                     boolean expectException)

Performs a put operation.

Parameters:

key - region entry key.

value - region entry value.

regionName - a region name.

addOffHeapNotificationListenerOnVm

protected void addOffHeapNotificationListenerOnVm(VM vm)

Adds an off-heap notification listener to the MemberMXBean for a vm.

Parameters:

vm - a virtual machine.

addOffHeapNotificationListener

protected void addOffHeapNotificationListener()

Adds an off-heap notification listener to the MemberMXBean.

setupOffHeapMonitorOnVm

protected void setupOffHeapMonitorOnVm(VM vm,
                                       String attribute,
                                       long highThreshold,
                                       long lowThreshold,
                                       boolean aggregate)

Creates and adds a generic GaugeMonitor for an attribute of the MemberMXBean on a VM.

Parameters:

vm - a virtual machine.

attribute - the attribute to monitor.

highThreshold - the high threshold trigger.

lowThreshold - the low threshold trigger.

setupOffHeapMonitor

protected void setupOffHeapMonitor(String attribute,
                                   long highThreshold,
                                   long lowThreshold,
                                   boolean aggregate)

Creates and adds a generic GaugeMonitor for an attribute of the MemberMXBean.

Parameters:

attribute - the attribute to monitor.

highThreshold - the high threshold trigger.

lowThreshold - the low threshold trigger.

waitForNotificationListenerOnVm

protected void waitForNotificationListenerOnVm(VM vm,
                                               long wait,
                                               long interval,
                                               boolean throwOnTimeout)

Waits to receive MBean notifications.

Parameters:

vm - a virtual machine.

wait - how long to wait for in millis.

interval - the polling interval to check for notifications.

throwOnTimeout - throws an exception on timeout if true.

clearNotificationListenerOnVm

protected void clearNotificationListenerOnVm(VM vm)

Clears received notifications.

Parameters:

vm - a virtual machine.