com.gemstone.gemfire.admin

Class AdminDUnitTestCase

java.lang.Object

junit.framework.Assert

junit.framework.TestCase

dunit.DistributedTestCase

com.gemstone.gemfire.cache30.CacheTestCase

com.gemstone.gemfire.admin.AdminDUnitTestCase

All Implemented Interfaces:

Serializable, junit.framework.Test

Direct Known Subclasses:

AdminDistributedSystemDisconnectDUnitTest, AdminDSSecurityDUnitTest, ClientStatsManagerDUnitTest, DistributedSystemDUnitTest, GemFireHealthDUnitTest, GemFireMemberandVMStatsDUnitTest, GemFireMemberPRandVMStatsDUnitTest, GemFireMemberRegionStatusDUnitTest, GemFireMemberStatsDUnitTest, GemFireMemberStatusDUnitTest, JmxClientStatResourcesCleanupDUnitTest, JmxRegionResourcesCleanupDUnitTest, JmxStatResourcesCleanupDUnitTest, MailManagerDUnitTest, MemberInfoWithStatsMBeanDUnitTest, MemberInfoWithStatsMBeanGFEValidationDUnitTest, PartitionedRegionSystemMemberRegionListenerDUnitTest, RegionSubRegionSnapsotDUnitTest, StatAlertDefinitionDUnitTest, StatAlertManagerDUnitTest, SystemMemberCacheDUnitTest, SystemMemberCacheListenerDUnitTest, SystemMemberDUnitTest, SystemMemberRegionDUnitTest

public abstract class AdminDUnitTestCase
extends CacheTestCase

Abstract superclass of tests that exercise the functionality of the GemFire external administration API. It is a subclass of CacheTestCase because it is easiest to test the administration of cache-related components.

Admin tests that test JMX behavior should override methods like isJMX() and isRMI().

Since:

3.5

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 com.gemstone.gemfire.admin.jmx.Agent	agent The JMX agent optionally started by this test
protected static int	AGENT_VM The index of the VM in which the JMX Agent is hosted
protected boolean	debug
static int	NUM_RETRY
static int	RETRY_INTERVAL
protected static Thread	shutdownThread A shutdown hook that is used for debugging
protected com.gemstone.gemfire.admin.AdminDistributedSystem	tcSystem The DistributedSystem admin object created for this test
protected String	urlString The URL on which the RMI agent runs

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

Method Summary

Modifier and Type	Method and Description
protected void	assertAgent()
protected static void	assertLog(String log, int minEntries) Asserts that a log has at least the given number of entries.
protected com.gemstone.gemfire.admin.AdminDistributedSystem	createDistributedSystem(String mcastAddress, int mcastPort, String locators, String remoteCommand) Creates a new DistributedSystem with the given configuration.
protected void	disconnect()
com.gemstone.gemfire.admin.AdminDistributedSystem	getAdminDistributedSystem()
protected static com.gemstone.gemfire.distributed.DistributedMember	getDistributedMember() Returns DistributedMember instance if connected to the dist system.
com.gemstone.gemfire.distributed.internal.DistributionConfig	getDistributionConfig() Returns the distribution configuration for this test.
protected String	getLocators(com.gemstone.gemfire.distributed.internal.DistributionConfig config)
protected boolean	isJMX() Returns whether or not this test exercises JMX behavior.
protected boolean	isRMI() Returns whether or not this test exercises JMX RMI behavior.
protected boolean	isSSL() Returns whether or not this test exercises JMX RMI SSL behavior.
void	reconnectToSystem()
void	setUp() In addition to the setup done by the superclass, also creates a DistributedSystem admin object.
protected void	startAgent() Starts the JMX Agent
protected void	stopAgent()
void	tearDown2() Destroys the DistributedSystem created in setUp() and performs the tear down inherited from the superclass.

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

Field Detail

AGENT_VM

protected static final int AGENT_VM

The index of the VM in which the JMX Agent is hosted

See Also:

Constant Field Values

tcSystem

protected transient com.gemstone.gemfire.admin.AdminDistributedSystem tcSystem

The DistributedSystem admin object created for this test

debug

protected final transient boolean debug

See Also:

Constant Field Values

shutdownThread

protected static final Thread shutdownThread

A shutdown hook that is used for debugging

agent

protected transient com.gemstone.gemfire.admin.jmx.Agent agent

The JMX agent optionally started by this test

urlString

protected String urlString

The URL on which the RMI agent runs

NUM_RETRY

public static final int NUM_RETRY

See Also:

Constant Field Values

RETRY_INTERVAL

public static final int RETRY_INTERVAL

See Also:

Constant Field Values

Constructor Detail

AdminDUnitTestCase

public AdminDUnitTestCase(String name)

Creates a new AdminDUnitTestCase

Method Detail

reconnectToSystem

public void reconnectToSystem()

getLocators

protected String getLocators(com.gemstone.gemfire.distributed.internal.DistributionConfig config)

setUp

public void setUp()
           throws Exception

In addition to the setup done by the superclass, also creates a DistributedSystem admin object.

Overrides:

setUp in class DistributedTestCase

Throws:

Exception

tearDown2

public void tearDown2()
               throws Exception

Destroys the DistributedSystem created in setUp() and performs the tear down inherited from the superclass.

Overrides:

tearDown2 in class CacheTestCase

Throws:

Exception

getAdminDistributedSystem

public com.gemstone.gemfire.admin.AdminDistributedSystem getAdminDistributedSystem()
                                                                            throws Exception

Throws:

Exception

getDistributedMember

protected static com.gemstone.gemfire.distributed.DistributedMember getDistributedMember()

Returns DistributedMember instance if connected to the dist system.

Since:

5.0

getDistributionConfig

public com.gemstone.gemfire.distributed.internal.DistributionConfig getDistributionConfig()

Returns the distribution configuration for this test. This is needed primarily for starting the JMX agent.

Since:

4.0

startAgent

protected void startAgent()
                   throws Exception

Starts the JMX Agent

Throws:

Exception

disconnect

protected void disconnect()

stopAgent

protected void stopAgent()
                  throws Exception

Throws:

Exception

assertAgent

protected void assertAgent()
                    throws Exception

Throws:

Exception

createDistributedSystem

protected com.gemstone.gemfire.admin.AdminDistributedSystem createDistributedSystem(String mcastAddress,
                                                                                    int mcastPort,
                                                                                    String locators,
                                                                                    String remoteCommand)
                                                                             throws com.gemstone.gemfire.admin.AdminException

Creates a new DistributedSystem with the given configuration. Note that the DistributedSystem will log to DUnit's (Hydra's) log file. The actual type of DistributedSystem that is returned depends on whether or not this test tests JMX behavior.

Throws:

com.gemstone.gemfire.admin.AdminException

isJMX

protected boolean isJMX()

Returns whether or not this test exercises JMX behavior. Unless overridden, this method returns false.

isRMI

protected boolean isRMI()

Returns whether or not this test exercises JMX RMI behavior. Unless overridden, this method returns false.

isSSL

protected boolean isSSL()

Returns whether or not this test exercises JMX RMI SSL behavior. Unless overridden, this method returns false.

assertLog

protected static void assertLog(String log,
                                int minEntries)
                         throws IOException

Asserts that a log has at least the given number of entries.

Throws:

IOException

Since:

4.0