org.marketcetera.util.test

Class TestCaseBase

java.lang.Object

org.marketcetera.util.test.TestCaseBase

public class TestCaseBase
extends Object

Base class for test cases.

Since:

0.5.0

Version:

$Id: TestCaseBase.java 16154 2012-07-14 16:34:05Z colin $

Author:

tlerios@marketcetera.com

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	DIR_CLASSES The root directory for class files.
protected static String	DIR_ROOT The root directory for test files.
protected static String	DIR_TARGET The root directory for target files.
protected static String	DIR_TEST_CLASSES The root directory for test class files.

Constructor Summary

Constructors

Constructor and Description
TestCaseBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected static void	assertEvent(org.apache.log4j.spi.LoggingEvent event, org.apache.log4j.Level level, String logger, String message, String location) Asserts that the contents of the given event match the given expected level, logger name, message, and location.
protected void	assertEventCount(int count) Asserts that the receiver's collector contains the given number of events.
protected void	assertLastEvent(org.apache.log4j.Level level, String logger, String message, String location) Asserts that the contents of the receiver's collector's most recent event match the given expected level, logger name, message, and location.
protected void	assertNoEvents() Asserts that the receiver's collector contains no events.
protected void	assertSingleEvent(org.apache.log4j.Level level, String logger, String message, String location) Asserts that the receiver's collector contains a single event, and that its contents match the given expected level, logger name, message, and location.
protected void	assertSomeEvent(org.apache.log4j.Level level, String logger, String message, String location) Asserts that at least one of the receiver's collector's events matches the given expected level, logger name, message, and location.
protected MemoryAppender	getAppender() Returns the receiver's collector (appender) of retained events.
protected LogTestAssist	getLogAssist() Returns the receiver's log message helper.
protected static void	setDefaultLevel(org.apache.log4j.Level level) Sets the level of the root logger to the given level.
protected static void	setLevel(String name, org.apache.log4j.Level level) Sets the level of the logger with the given name to the given level.
void	setupTestCaseBase() Sets up the receiver's collector of retained events as part of each test's fixture.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DIR_ROOT

protected static final String DIR_ROOT

The root directory for test files.

DIR_TARGET

protected static final String DIR_TARGET

The root directory for target files.

See Also:

Constant Field Values

DIR_CLASSES

protected static final String DIR_CLASSES

The root directory for class files.

DIR_TEST_CLASSES

protected static final String DIR_TEST_CLASSES

The root directory for test class files.

Constructor Detail

TestCaseBase

public TestCaseBase()

Method Detail

setDefaultLevel

protected static void setDefaultLevel(org.apache.log4j.Level level)

Sets the level of the root logger to the given level.

Parameters:

level - The level.

setLevel

protected static void setLevel(String name,
            org.apache.log4j.Level level)

Sets the level of the logger with the given name to the given level.

Parameters:

name - The logger name.

level - The level.

assertEvent

protected static void assertEvent(org.apache.log4j.spi.LoggingEvent event,
               org.apache.log4j.Level level,
               String logger,
               String message,
               String location)

Asserts that the contents of the given event match the given expected level, logger name, message, and location.

Parameters:

event - The event.

level - The expected level. Use null to indicate "don't care".

logger - The expected logger name. Use null to indicate "don't care".

message - The expected message. Use null to indicate "don't care".

location - The expected location. Use null to indicate "don't care".

setupTestCaseBase

public void setupTestCaseBase()

Sets up the receiver's collector of retained events as part of each test's fixture.

getLogAssist

protected LogTestAssist getLogAssist()

Returns the receiver's log message helper.

Returns:

The helper.

getAppender

protected MemoryAppender getAppender()

Returns the receiver's collector (appender) of retained events.

Returns:

The appender.

assertEventCount

protected void assertEventCount(int count)

Asserts that the receiver's collector contains the given number of events.

Parameters:

count - The number of events.

assertNoEvents

protected void assertNoEvents()

Asserts that the receiver's collector contains no events.

assertLastEvent

protected void assertLastEvent(org.apache.log4j.Level level,
                   String logger,
                   String message,
                   String location)

Asserts that the contents of the receiver's collector's most recent event match the given expected level, logger name, message, and location. The assertion fails if the receiver has no events.

Parameters:

level - The expected level. Use null to indicate "don't care".

logger - The expected logger name. Use null to indicate "don't care".

message - The expected message. Use null to indicate "don't care".

location - The expected location. Use null to indicate "don't care".

assertSomeEvent

protected void assertSomeEvent(org.apache.log4j.Level level,
                   String logger,
                   String message,
                   String location)

Asserts that at least one of the receiver's collector's events matches the given expected level, logger name, message, and location. If the collector has no events, the assertion fails.

Parameters:

level - The expected level. Use null to indicate "don't care".

logger - The expected logger name. Use null to indicate "don't care".

message - The expected message. Use null to indicate "don't care".

location - The expected location. Use null to indicate "don't care".

assertSingleEvent

protected void assertSingleEvent(org.apache.log4j.Level level,
                     String logger,
                     String message,
                     String location)

Asserts that the receiver's collector contains a single event, and that its contents match the given expected level, logger name, message, and location. The collector's list of retained events is cleared upon success.

Parameters:

level - The expected level. Use null to indicate "don't care".

logger - The expected logger name. Use null to indicate "don't care".

message - The expected message. Use null to indicate "don't care".

location - The expected location. Use null to indicate "don't care".