com.gemstone.gemfire.management.internal.cli.commands

Class CliCommandTestBase

java.lang.Object

junit.framework.Assert

junit.framework.TestCase

dunit.DistributedTestCase

com.gemstone.gemfire.cache30.CacheTestCase

com.gemstone.gemfire.management.internal.cli.commands.CliCommandTestBase

All Implemented Interfaces:

java.io.Serializable, junit.framework.Test

Direct Known Subclasses:

ConfigCommandsDUnitTest, CreateAlterDestroyRegionCommandsDUnitTest, DeployCommandsDUnitTest, DiskStoreCommandsDUnitTest, DurableClientCommandsDUnitTest, FunctionCommandsDUnitTest, GemfireDataCommandsDUnitTest, GfshDUnitTest, IndexCommandsDUnitTest, LauncherLifecycleCommandsDUnitTest, ListAndDescribeDiskStoreCommandsDUnitTest, ListAndDescribeRegionDUnitTest, ListIndexCommandDUnitTest, MiscellaneousCommandsDUnitTest, MiscellaneousCommandsExportLogsPart1DUnitTest, MiscellaneousCommandsExportLogsPart2DUnitTest, MiscellaneousCommandsExportLogsPart3DUnitTest, MiscellaneousCommandsExportLogsPart4DUnitTest, QueueCommandsDUnitTest, ShellCommandsDUnitTest, ShowMetricsDUnitTest, ShowStackTraceDUnitTest, UpgradeOfflineDiskStoreDUnitTest, UserCommandsDUnitTest, WANCommandTestBase

public class CliCommandTestBase
extends CacheTestCase

Base class for all the CLI/gfsh command dunit tests.

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 java.lang.String	USE_HTTP_SYSTEM_PROPERTY

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
CliCommandTestBase(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	commandResultToString(com.gemstone.gemfire.management.internal.cli.result.CommandResult commandResult)
protected int	countLinesInString(java.lang.String stringToSearch, boolean countBlankLines) Counts the number of distinct lines in a String.
protected int	countMatchesInString(java.lang.String stringToSearch, java.lang.String stringToCount) Utility method to determine how many times a string occurs in another string.
protected TestableGfsh	createDefaultSetup(java.util.Properties props) Create all of the components necessary for the default setup.
protected TestableGfsh	createShell() Create a TestableGfsh object.
protected void	debug(java.lang.String string)
protected void	destroyDefaultSetup() Destroy all of the components created for the default setup.
protected void	error(java.lang.String string)
protected void	error(java.lang.String string, java.lang.Throwable e)
protected com.gemstone.gemfire.management.internal.cli.result.CommandResult	executeCommand(java.lang.String command) Execute a command using the default shell and clear the shell events before returning.
protected com.gemstone.gemfire.management.internal.cli.result.CommandResult	executeCommand(TestableGfsh shell, java.lang.String command) Execute a command in the provided shell and clear the shell events before returning.
protected com.gemstone.gemfire.management.internal.cli.result.CommandResult	executeCommandWithoutClear(java.lang.String command) Execute a command using the default shell.
protected com.gemstone.gemfire.management.internal.cli.result.CommandResult	executeCommandWithoutClear(TestableGfsh shell, java.lang.String command) Execute a command in the provided shell.
protected com.gemstone.gemfire.management.internal.cli.result.CommandResult	extractCommandResult(java.util.Map<java.lang.String,java.lang.Object> commandOutput) Utility method for finding the CommandResult object in the Map of CommandOutput objects.
protected TestableGfsh	getDefaultShell() Get the default shell (will create one if it doesn't already exist).
protected java.lang.String	getLineFromString(java.lang.String stringToSearch, int lineNumber) Get a specific line from the string (using \n or \r as a line separator).
protected void	info(java.lang.String string)
protected void	printResult(com.gemstone.gemfire.management.internal.cli.result.CommandResult commandResult, java.io.PrintStream printStream) Utility method for viewing the results of a command.
void	setUp() Sets up the test (noop).
protected void	shellConnect(java.lang.String host, int jmxPort, int httpPort, TestableGfsh shell) Connect a shell to the JMX server at the given host and port
protected boolean	stringContainsLine(java.lang.String stringToSearch, java.lang.String stringPattern) Determines if a string contains a trimmed line that matches the pattern.
void	tearDown2() Tears down the test.

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

USE_HTTP_SYSTEM_PROPERTY

protected static final java.lang.String USE_HTTP_SYSTEM_PROPERTY

See Also:

Constant Field Values

Constructor Detail

CliCommandTestBase

public CliCommandTestBase(java.lang.String name)

Method Detail

setUp

public void setUp()
           throws java.lang.Exception

Description copied from class: DistributedTestCase

Sets up the test (noop).

Overrides:

setUp in class DistributedTestCase

Throws:

java.lang.Exception

tearDown2

public void tearDown2()
               throws java.lang.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:

java.lang.Exception

createDefaultSetup

protected final TestableGfsh createDefaultSetup(java.util.Properties props)

Create all of the components necessary for the default setup. The provided properties will be used when creating the default cache. This will create GFSH in the controller VM (VM[4]) (no cache) and the manager in VM[0] (with cache). When adding regions, functions, keys, whatever to your cache for tests, you'll need to use Host.getHost(0).getVM(0).invoke(new SerializableRunnable() { public void run() { ... } } in order to have this setup run in the same VM as the manager.

Parameters:

props - Properties used when creating the cache for this default setup.

Returns:

The default shell

destroyDefaultSetup

protected final void destroyDefaultSetup()

Destroy all of the components created for the default setup.

shellConnect

protected void shellConnect(java.lang.String host,
                            int jmxPort,
                            int httpPort,
                            TestableGfsh shell)

Connect a shell to the JMX server at the given host and port

Parameters:

host - Host of the JMX server

jmxPort - Port of the JMX server

shell - Shell to connect

getDefaultShell

protected final TestableGfsh getDefaultShell()

Get the default shell (will create one if it doesn't already exist).

Returns:

The default shell

createShell

protected TestableGfsh createShell()

Create a TestableGfsh object.

Returns:

The created shell.

executeCommand

protected com.gemstone.gemfire.management.internal.cli.result.CommandResult executeCommand(java.lang.String command)

Execute a command using the default shell and clear the shell events before returning.

Parameters:

command - Command to execute

Returns:

The result of the command execution

executeCommand

protected com.gemstone.gemfire.management.internal.cli.result.CommandResult executeCommand(TestableGfsh shell,
                                                                                           java.lang.String command)

Execute a command in the provided shell and clear the shell events before returning.

Parameters:

shell - Shell in which to execute the command.

command - Command to execute

Returns:

The result of the command execution

executeCommandWithoutClear

protected com.gemstone.gemfire.management.internal.cli.result.CommandResult executeCommandWithoutClear(java.lang.String command)

Execute a command using the default shell. Useful for getting additional information from the shell after the command has been executed (using getDefaultShell().???). Caller is responsible for calling getDefaultShell().clearEvents() when done.

Parameters:

command - Command to execute

Returns:

The result of the command execution

executeCommandWithoutClear

protected com.gemstone.gemfire.management.internal.cli.result.CommandResult executeCommandWithoutClear(TestableGfsh shell,
                                                                                                       java.lang.String command)

Execute a command in the provided shell. Useful for getting additional information from the shell after the command has been executed (using getDefaultShell().???). Caller is responsible for calling getDefaultShell().clearEvents() when done.

Parameters:

shell - Shell in which to execute the command.

command - Command to execute

Returns:

The result of the command execution

printResult

protected void printResult(com.gemstone.gemfire.management.internal.cli.result.CommandResult commandResult,
                           java.io.PrintStream printStream)

Utility method for viewing the results of a command.

Parameters:

commandResult - Results to dump

printStream - Stream to dump the results to

commandResultToString

protected java.lang.String commandResultToString(com.gemstone.gemfire.management.internal.cli.result.CommandResult commandResult)

extractCommandResult

protected com.gemstone.gemfire.management.internal.cli.result.CommandResult extractCommandResult(java.util.Map<java.lang.String,java.lang.Object> commandOutput)

Utility method for finding the CommandResult object in the Map of CommandOutput objects.

Parameters:

commandOutput - CommandOutput Map to search

Returns:

The CommandResult object or null if not found.

countMatchesInString

protected int countMatchesInString(java.lang.String stringToSearch,
                                   java.lang.String stringToCount)

Utility method to determine how many times a string occurs in another string. Note that when looking for matches substrings of other matches will be counted as a match. For example, looking for "AA" in the string "AAAA" will result in a return value of 3.

Parameters:

stringToSearch - String to search

stringToCount - String to look for and count

Returns:

The number of matches.

stringContainsLine

protected boolean stringContainsLine(java.lang.String stringToSearch,
                                     java.lang.String stringPattern)

Determines if a string contains a trimmed line that matches the pattern. So, any single line whose leading and trailing spaces have been removed which contains a string that exactly matches the given pattern will be considered a match.

Parameters:

stringToSearch - String to search

stringPattern - Pattern to search for

Returns:

True if a match is found, false otherwise

countLinesInString

protected int countLinesInString(java.lang.String stringToSearch,
                                 boolean countBlankLines)

Counts the number of distinct lines in a String.

Parameters:

stringToSearch - String to search for lines.

countBlankLines - Whether to count blank lines (true to count)

Returns:

The number of lines found.

getLineFromString

protected java.lang.String getLineFromString(java.lang.String stringToSearch,
                                             int lineNumber)

Get a specific line from the string (using \n or \r as a line separator).

Parameters:

stringToSearch - String to get the line from

lineNumber - Line number to get

Returns:

The line

info

protected void info(java.lang.String string)

debug

protected void debug(java.lang.String string)

error

protected void error(java.lang.String string)

error

protected void error(java.lang.String string,
                     java.lang.Throwable e)