io.snappydata.test.dunit

Class DistributedTestBase

java.lang.Object

junit.framework.Assert

junit.framework.TestCase

io.snappydata.test.dunit.DistributedTestBase

All Implemented Interfaces:

java.io.Serializable, junit.framework.Test

public abstract class DistributedTestBase
extends junit.framework.TestCase
implements java.io.Serializable

This class is the superclass of all distributed unit tests. tests/hydra/JUnitTestTask is the main DUnit driver. It supports two additional public static methods if they are defined in the test case: public static void caseSetUp() -- comparable to JUnit's BeforeClass annotation public static void caseTearDown() -- comparable to JUnit's AfterClass annotation

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DistributedTestBase.ExpectedException A class that represents an currently logged expected exception, which should be removed
static class	DistributedTestBase.InitializeRun
static interface	DistributedTestBase.WaitCriterion
static interface	DistributedTestBase.WaitCriterion2

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	beforeClassDone this indicates whether beforeClass has been executed for current class
protected static java.lang.String	lastTest this stores the last test method in the current class for afterClass
static java.lang.String	lineSeparator the system line separator
static boolean	logPerTest
static boolean	reconnect
static com.gemstone.gemfire.distributed.internal.InternalDistributedSystem	system
static java.lang.String	testName

Constructor Summary

Constructors

Constructor and Description
DistributedTestBase(java.lang.String name) Creates a new DistributedTestBase test with the given name.

Method Summary

Modifier and Type	Method and Description
static DistributedTestBase.ExpectedException	addExpectedException(java.lang.String exception) Log in all VMs, in both the test logger and the GemFire logger the expected exception string to prevent grep logs from complaining.
static DistributedTestBase.ExpectedException	addExpectedException(java.lang.String exception, VM v) Log in all VMs, in both the test logger and the GemFire logger the expected exception string to prevent grep logs from complaining.
void	afterClass() Common cleanup for all the tests in a class.
void	beforeClass() Common setup for all the tests in a class.
static void	checkBBFlag(java.lang.String name, int expectedValue)
static void	clearBBFlag(java.lang.String name)
void	deleteLocatorStateFile(int... ports) delete locator state files.
static void	disconnectFromDS()
static void	dumpAllStacks() print stack dumps for all vms
static void	dumpStack() print a stack dump for this vm
static void	dumpStack(Host host) print stack dumps for all vms on the given host
static void	dumpStack(org.apache.log4j.Logger logger) print a stack dump for this vm
static void	dumpStack(VM vm) print a stack dump for the given vm
static void	dumpStackTrace(java.lang.Thread t, java.lang.StackTraceElement[] stack, org.apache.log4j.Logger logger)
static void	fail(java.lang.String message, java.lang.Throwable ex) Helper method that causes this test to fail because of the given exception.
static void	generateThreadDump(java.lang.StringBuilder msg)
static java.util.Properties	getAllDistributedSystemProperties(java.util.Properties props)
static int	getDUnitLocatorPort() Get the port that the standard dunit locator is listening on.
static org.apache.log4j.Logger	getGlobalLogger()
static java.lang.String	getHostAddress(java.net.InetAddress addr) A wrapper for InetAddress.getHostAddress() that removes the scope_id from all IPv4 address and all global IPv6 addresses.
static java.lang.String	getIPLiteral()
java.lang.String	getLogLevel() This returns the log level configured for the test run.
org.apache.log4j.Logger	getLogWriter()
protected long	getRepeatTimeoutMs() The number of milliseconds to try repeating validation code in the event that AssertionFailedError is thrown.
static java.lang.String	getServerHostName(Host host) get the host name to use for a server cache in client/server dunit testing
static java.lang.String	getStackTrace(java.lang.Throwable aThrowable) Get a stack trace for the given Throwable and return it as a String.
com.gemstone.gemfire.distributed.internal.InternalDistributedSystem	getSystem()
com.gemstone.gemfire.distributed.internal.InternalDistributedSystem	getSystem(java.util.Properties props)
protected java.lang.Class	getTestClass()
static java.lang.String	getTestName()
java.lang.String	getUniqueName() Returns a unique name for this test method.
protected static int	getVMCount() Return the total number of VMs on all hosts
static void	incBBFlag(java.lang.String name)
static void	invokeInEveryVM(java.lang.Class c, java.lang.String method) Invokes a method in every remote VM that DUnit knows about.
static void	invokeInEveryVM(java.lang.Class c, java.lang.String method, java.lang.Object[] methodArgs) Invokes a method in every remote VM that DUnit knows about.
static java.util.Map	invokeInEveryVM(SerializableCallable work) Invokes a SerializableCallable in every VM that DUnit knows about.
static void	invokeInEveryVM(SerializableRunnable work) Invokes a SerializableRunnable in every VM that DUnit knows about.
protected void	invokeInEveryVMRepeatingIfNecessary(RepeatableRunnable work) Invokes a SerializableRunnable in every VM that DUnit knows about.
static void	invokeInLocator(SerializableRunnable work)
void	invokeInVM(VM vm, java.lang.String method, java.lang.Object... methodArgs) Invokes a method in every remote VM that DUnit knows about.
static void	invokeInVM(VM vm, java.lang.String className, java.lang.String method, java.lang.Object[] methodArgs)
protected void	invokeRepeatingIfNecessary(VM vm, RepeatableRunnable task)
static void	join(java.lang.Thread t, long ms, org.apache.log4j.Logger logger) Wait for a thread to join
protected void	logTestHistory() Write a message to the log about what tests have ran previously.
static java.lang.String	noteTiming(long operations, java.lang.String operationUnit, long beginTime, long endTime, java.lang.String timeUnit)
protected void	pause() pause for a default interval
static void	pause(int ms) pause for specified ms interval Make sure system clock has advanced by the specified number of millis before returning.
void	perVMSetUp(java.lang.String name, java.lang.String defaultDiskStoreName)
void	perVMTearDown(java.lang.String name)
static void	setTestName(java.lang.String name)
void	setUp() Sets up the test (noop).
static void	sleepForMs(int msToSleep) Sleep "soundly" for msToSleep milliseconds.
static void	staticLogString(java.lang.String msg)
static void	staticPause(int ms) Use of this function indicates a place in the tests tree where t he use of Thread.sleep() is highly questionable.
void	tearDown() For logPerTest to work, we have to disconnect from the DS, but all subclasses do not call super.tearDown().
void	tearDown2() Tears down the test.
protected void	tearDownAfter() Tears down the test.
static void	waitForBBFlag(java.lang.String name, int expectedValue, long timeout)
static void	waitForCriterion(DistributedTestBase.WaitCriterion ev, long ms, long interval, boolean throwOnTimeout) Wait until given criterion is met
static void	waitMutex(DistributedTestBase.WaitCriterion ev, java.lang.Object mutex, long ms, long interval, boolean throwOnTimeout) Wait on a mutex.

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

testName

public static volatile java.lang.String testName

reconnect

public static boolean reconnect

logPerTest

public static final boolean logPerTest

lineSeparator

public static final java.lang.String lineSeparator

the system line separator

system

public static com.gemstone.gemfire.distributed.internal.InternalDistributedSystem system

beforeClassDone

protected static boolean beforeClassDone

this indicates whether beforeClass has been executed for current class

lastTest

protected static java.lang.String lastTest

this stores the last test method in the current class for afterClass

Constructor Detail

DistributedTestBase

public DistributedTestBase(java.lang.String name)

Creates a new DistributedTestBase test with the given name.

Method Detail

sleepForMs

public static void sleepForMs(int msToSleep)

Sleep "soundly" for msToSleep milliseconds.

getStackTrace

public static java.lang.String getStackTrace(java.lang.Throwable aThrowable)

Get a stack trace for the given Throwable and return it as a String.

Parameters:

aThrowable - The exception to get the stack trace for.

Returns:

The call stack for aThrowable as a string.

getHostAddress

public static java.lang.String getHostAddress(java.net.InetAddress addr)

A wrapper for InetAddress.getHostAddress() that removes the scope_id from all IPv4 address and all global IPv6 addresses.

Parameters:

addr - the InetAddress to lookup

Returns:

the address with the scope_id stripped off (assuming the address would still be valid with it removed)

getAllDistributedSystemProperties

public static final java.util.Properties getAllDistributedSystemProperties(java.util.Properties props)

getSystem

public com.gemstone.gemfire.distributed.internal.InternalDistributedSystem getSystem()

getSystem

public com.gemstone.gemfire.distributed.internal.InternalDistributedSystem getSystem(java.util.Properties props)

disconnectFromDS

public static void disconnectFromDS()

invokeInEveryVM

public static void invokeInEveryVM(SerializableRunnable work)

Invokes a SerializableRunnable in every VM that DUnit knows about.

See Also:

VM.invoke(Runnable)

invokeInLocator

public static void invokeInLocator(SerializableRunnable work)

invokeInEveryVM

public static java.util.Map invokeInEveryVM(SerializableCallable work)

Invokes a SerializableCallable in every VM that DUnit knows about.

Returns:

a Map of results, where the key is the VM and the value is the result

invokeInEveryVM

public static void invokeInEveryVM(java.lang.Class c,
                                   java.lang.String method)

Invokes a method in every remote VM that DUnit knows about.

See Also:

VM.invoke(Class, String)

invokeInEveryVM

public static void invokeInEveryVM(java.lang.Class c,
                                   java.lang.String method,
                                   java.lang.Object[] methodArgs)

Invokes a method in every remote VM that DUnit knows about.

See Also:

VM.invoke(Class, String)

invokeInVM

public static void invokeInVM(VM vm,
                              java.lang.String className,
                              java.lang.String method,
                              java.lang.Object[] methodArgs)

invokeInVM

public void invokeInVM(VM vm,
                       java.lang.String method,
                       java.lang.Object... methodArgs)

Invokes a method in every remote VM that DUnit knows about.

See Also:

VM.invoke(Class, String)

getRepeatTimeoutMs

protected long getRepeatTimeoutMs()

The number of milliseconds to try repeating validation code in the event that AssertionFailedError is thrown. For ACK scopes, no repeat should be necessary.

invokeRepeatingIfNecessary

protected void invokeRepeatingIfNecessary(VM vm,
                                          RepeatableRunnable task)

invokeInEveryVMRepeatingIfNecessary

protected void invokeInEveryVMRepeatingIfNecessary(RepeatableRunnable work)

Invokes a SerializableRunnable in every VM that DUnit knows about. If work.run() throws an assertion failure, its execution is repeated, until no assertion failure occurs or repeatTimeout milliseconds have passed.

See Also:

VM.invoke(Runnable)

getVMCount

protected static int getVMCount()

Return the total number of VMs on all hosts

dumpStack

public static void dumpStack()

print a stack dump for this vm

Since:

5.0

dumpStack

public static void dumpStack(org.apache.log4j.Logger logger)

print a stack dump for this vm

Since:

5.0

dumpStack

public static void dumpStack(VM vm)

print a stack dump for the given vm

Since:

5.0

dumpStack

public static void dumpStack(Host host)

print stack dumps for all vms on the given host

Since:

5.0

dumpAllStacks

public static void dumpAllStacks()

print stack dumps for all vms

Since:

5.0

generateThreadDump

public static void generateThreadDump(java.lang.StringBuilder msg)

noteTiming

public static java.lang.String noteTiming(long operations,
                                          java.lang.String operationUnit,
                                          long beginTime,
                                          long endTime,
                                          java.lang.String timeUnit)

getTestClass

protected java.lang.Class getTestClass()

getGlobalLogger

public static org.apache.log4j.Logger getGlobalLogger()

getLogWriter

public final org.apache.log4j.Logger getLogWriter()

getLogLevel

public java.lang.String getLogLevel()

This returns the log level configured for the test run. It can be configured globally for dunit tests using "logLevel" system property.

Returns:

the dunit log-level setting

beforeClass

public void beforeClass()
                 throws java.lang.Exception

Common setup for all the tests in a class.

Throws:

java.lang.Exception

afterClass

public void afterClass()
                throws java.lang.Exception

Common cleanup for all the tests in a class.

Throws:

java.lang.Exception

setUp

public void setUp()
           throws java.lang.Exception

Sets up the test (noop).

Overrides:

setUp in class junit.framework.TestCase

Throws:

java.lang.Exception

logTestHistory

protected void logTestHistory()

Write a message to the log about what tests have ran previously. This makes it easier to figure out if a previous test may have caused problems

perVMSetUp

public void perVMSetUp(java.lang.String name,
                       java.lang.String defaultDiskStoreName)

setTestName

public static void setTestName(java.lang.String name)

getTestName

public static java.lang.String getTestName()

tearDown

public final void tearDown()
                    throws java.lang.Exception

For logPerTest to work, we have to disconnect from the DS, but all subclasses do not call super.tearDown(). To prevent this scenario this method has been declared final. Subclasses must now override tearDown2() instead.

Overrides:

tearDown in class junit.framework.TestCase

Throws:

java.lang.Exception

perVMTearDown

public void perVMTearDown(java.lang.String name)

tearDown2

public void tearDown2()
               throws java.lang.Exception

Tears down the test. This method is called by the final tearDown() method and should be overridden to perform actual test cleanup and release resources used by the test. The tasks executed by this method are performed before the DUnit test framework using Hydra cleans up the client VMs.

Throws:

java.lang.Exception - if the tear down process and test cleanup fails.

See Also:

tearDown(), tearDownAfter()

tearDownAfter

protected void tearDownAfter()
                      throws java.lang.Exception

Tears down the test. Performs additional tear down tasks after the DUnit tests framework using Hydra cleans up the client VMs. This method is called by the final tearDown() method and should be overridden to perform post tear down activities.

Throws:

java.lang.Exception - if the test tear down process fails.

See Also:

tearDown(), tearDown2()

getServerHostName

public static java.lang.String getServerHostName(Host host)

get the host name to use for a server cache in client/server dunit testing

Parameters:

host -

Returns:

the host name

getIPLiteral

public static java.lang.String getIPLiteral()

getDUnitLocatorPort

public static int getDUnitLocatorPort()

Get the port that the standard dunit locator is listening on.

Returns:

getUniqueName

public java.lang.String getUniqueName()

Returns a unique name for this test method. It is based on the name of the class as well as the name of the method.

fail

public static void fail(java.lang.String message,
                        java.lang.Throwable ex)

Helper method that causes this test to fail because of the given exception.

pause

protected void pause()

pause for a default interval

staticPause

public static final void staticPause(int ms)

Use of this function indicates a place in the tests tree where t he use of Thread.sleep() is highly questionable.

Some places in the system, especially those that test expirations and other timeouts, have a very good reason to call Thread.sleep(long). The other places are marked by the use of this method.

Parameters:

ms -

pause

public static final void pause(int ms)

pause for specified ms interval Make sure system clock has advanced by the specified number of millis before returning.

waitForCriterion

public static void waitForCriterion(DistributedTestBase.WaitCriterion ev,
                                    long ms,
                                    long interval,
                                    boolean throwOnTimeout)

Wait until given criterion is met

Parameters:

ev - criterion to wait on

ms - total time to wait, in milliseconds

interval - pause interval between waits

throwOnTimeout - if false, don't generate an error

waitMutex

public static void waitMutex(DistributedTestBase.WaitCriterion ev,
                             java.lang.Object mutex,
                             long ms,
                             long interval,
                             boolean throwOnTimeout)

Wait on a mutex. This is done in a loop in order to address the "spurious wakeup" "feature" in Java.

Parameters:

ev - condition to test

mutex - object to lock and wait on

ms - total amount of time to wait

interval - interval to pause for the wait

throwOnTimeout - if false, no error is thrown.

join

public static void join(java.lang.Thread t,
                        long ms,
                        org.apache.log4j.Logger logger)

Wait for a thread to join

Parameters:

t - thread to wait on

ms - maximum time to wait

dumpStackTrace

public static void dumpStackTrace(java.lang.Thread t,
                                  java.lang.StackTraceElement[] stack,
                                  org.apache.log4j.Logger logger)

staticLogString

public static void staticLogString(java.lang.String msg)

addExpectedException

public static DistributedTestBase.ExpectedException addExpectedException(java.lang.String exception)

Log in all VMs, in both the test logger and the GemFire logger the expected exception string to prevent grep logs from complaining. The expected string is used by the GrepLogs utility and so can contain regular expression characters. If you do not remove the expected exception, it will be removed at the end of your test case automatically.

Parameters:

exception - the exception string to expect

Returns:

an ExpectedException instance for removal

Since:

5.7bugfix

addExpectedException

public static DistributedTestBase.ExpectedException addExpectedException(java.lang.String exception,
                                                                         VM v)

Log in all VMs, in both the test logger and the GemFire logger the expected exception string to prevent grep logs from complaining. The expected string is used by the GrepLogs utility and so can contain regular expression characters.

Parameters:

exception - the exception string to expect

v - the VM on which to log the expected exception or null for all VMs

Returns:

an ExpectedException instance for removal purposes

Since:

5.7bugfix

deleteLocatorStateFile

public void deleteLocatorStateFile(int... ports)

delete locator state files. Use this after getting a random port to ensure that an old locator state file isn't picked up by the new locator you're starting.

Parameters:

ports -

incBBFlag

public static void incBBFlag(java.lang.String name)

clearBBFlag

public static void clearBBFlag(java.lang.String name)

checkBBFlag

public static void checkBBFlag(java.lang.String name,
                               int expectedValue)
                        throws com.gemstone.gemfire.cache.CacheException

Throws:

com.gemstone.gemfire.cache.CacheException

waitForBBFlag

public static void waitForBBFlag(java.lang.String name,
                                 int expectedValue,
                                 long timeout)
                          throws com.gemstone.gemfire.cache.TimeoutException

Throws:

com.gemstone.gemfire.cache.TimeoutException