org.marketcetera.util.test

Class LogTestAssist

java.lang.Object

org.marketcetera.util.test.LogTestAssist

public class LogTestAssist
extends Object

A log message test helper.

Since:

2.0.0

Version:

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

Author:

tlerios@marketcetera.com, anshul@marketcetera.com

Constructor Summary

Constructors

Constructor and Description
LogTestAssist() Creates a new helper which doesn't track any logger output.
LogTestAssist(String name) Creates a new helper which tracks the log events sent out to the logger with the given name.
LogTestAssist(String name, org.apache.log4j.Level level) Creates a new helper which tracks the log events sent out to the logger with the given name at the given optional threshold level.

Method Summary

Methods

Modifier and Type	Method and Description
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.
void	assertEventCount(int count) Asserts that the receiver's collector contains the given number of events.
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.
void	assertNoEvents() Asserts that the receiver's collector contains no events.
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.
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.
MemoryAppender	getAppender() Returns the receiver's collector (appender) of retained events.
String	getEventsAsString() Returns a string with all the events of the receiver's collector.
void	resetAppender() Clears the contents of the receiver's collector.
static void	setDefaultLevel(org.apache.log4j.Level level) Sets the level of the root logger to the given level.
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	trackLogger(String name) Starts tracking log events sent out to the logger with the given name.
void	trackLogger(String name, org.apache.log4j.Level level) Starts tracking log events sent out to the logger with the given name at the given optional threshold level.

Methods inherited from class java.lang.Object

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

Constructor Detail

LogTestAssist

public LogTestAssist(String name,
             org.apache.log4j.Level level)

Creates a new helper which tracks the log events sent out to the logger with the given name at the given optional threshold level.

Parameters:

name - The logger name.

level - The level. It may be null, in which case logger's threshold level is not altered.

LogTestAssist

public LogTestAssist(String name)

Creates a new helper which tracks the log events sent out to the logger with the given name.

Parameters:

name - The logger name.

LogTestAssist

public LogTestAssist()

Creates a new helper which doesn't track any logger output. The helper can be configured to track logger output using trackLogger(String,org.apache.log4j.Level).

Method Detail

setDefaultLevel

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

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

Parameters:

level - The level.

setLevel

public 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

public 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".

trackLogger

public void trackLogger(String name,
               org.apache.log4j.Level level)

Starts tracking log events sent out to the logger with the given name at the given optional threshold level.

Parameters:

name - The logger name.

level - The level. It may be null, in which case logger's threshold level is not altered.

trackLogger

public void trackLogger(String name)

Starts tracking log events sent out to the logger with the given name.

Parameters:

name - The logger name.

resetAppender

public void resetAppender()

Clears the contents of the receiver's collector.

getEventsAsString

public String getEventsAsString()

Returns a string with all the events of the receiver's collector.

Returns:

The string.

getAppender

public MemoryAppender getAppender()

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

Returns:

The appender.

assertEventCount

public void assertEventCount(int count)

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

Parameters:

count - The number of events.

assertNoEvents

public void assertNoEvents()

Asserts that the receiver's collector contains no events.

assertLastEvent

public 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

public 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

public 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".