org.opennms.test.mock

Class MockLogAppender

java.lang.Object

org.apache.log4j.AppenderSkeleton

org.opennms.test.mock.MockLogAppender

All Implemented Interfaces:

org.apache.log4j.Appender, org.apache.log4j.spi.OptionHandler

public class MockLogAppender
extends org.apache.log4j.AppenderSkeleton

MockLogAppender class. If you do not specify the log level specifically, the level will default to DEBUG and you can control the level by setting the mock.logLevel system property.

Used in unit tests to check that the level of logging produced by a test was suitable. In some cases, the test will be that no messages were logged at a higher priority than specified, e.g. Error messages logged when only Notice were expected. Some other tests may wish to ensure that an Error or Warn message was indeed logged as expected Remember: "Greater" in regards to level relates to priority; the higher the level, the less should usually be logged (e.g. Errors (highest) should be only the highest priority messages about really bad things, as compared to Debug (lowest) which is any old rubbish that might be interesting to a developer)

Version:

$Id: $

Author:

brozow

Field Summary

Fields inherited from class org.apache.log4j.AppenderSkeleton

closed, errorHandler, headFilter, layout, name, tailFilter, threshold

Constructor Summary

Constructors

Constructor and Description
MockLogAppender() Constructor for MockLogAppender.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	append(org.apache.log4j.spi.LoggingEvent event)
static void	assertLogAtLevel(org.apache.log4j.Level level) assertLogAtLevel
static void	assertNotGreaterOrEqual(org.apache.log4j.Level level) assertNotGreaterOrEqual
static void	assertNoWarningsOrGreater() assertNoWarningsOrGreater
void	close() close
void	doAppend(org.apache.log4j.spi.LoggingEvent event)
static org.apache.log4j.spi.LoggingEvent[]	getEvents() getEvents
static org.apache.log4j.spi.LoggingEvent[]	getEventsAtLevel(org.apache.log4j.Level level) getEventsAtLevel
static org.apache.log4j.spi.LoggingEvent[]	getEventsGreaterOrEqual(org.apache.log4j.Level level) getEventsGreaterOrEqual
static boolean	isLoggingSetup() isLoggingSetup
static boolean	noWarningsOrHigherLogged() noWarningsOrHigherLogged
static void	receivedLogLevel(org.apache.log4j.Level level) receivedLogLevel
boolean	requiresLayout() requiresLayout
static void	resetEvents() resetEvents
static void	resetLogLevel() resetLogLevel
static void	setupLogging() setupLogging
static void	setupLogging(boolean toConsole) setupLogging
static void	setupLogging(boolean toConsole, Properties props) setupLogging
static void	setupLogging(boolean toConsole, String level) setupLogging
static void	setupLogging(boolean toConsole, String level, Properties config) setupLogging
static void	setupLogging(Properties config) setupLogging

Methods inherited from class org.apache.log4j.AppenderSkeleton

activateOptions, addFilter, clearFilters, finalize, getErrorHandler, getFilter, getFirstFilter, getLayout, getName, getThreshold, isAsSevereAsThreshold, setErrorHandler, setLayout, setName, setThreshold

Methods inherited from class java.lang.Object

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

Constructor Detail

MockLogAppender

public MockLogAppender()

Constructor for MockLogAppender.

Method Detail

doAppend

public void doAppend(org.apache.log4j.spi.LoggingEvent event)

Specified by:

doAppend in interface org.apache.log4j.Appender

Overrides:

doAppend in class org.apache.log4j.AppenderSkeleton

append

protected void append(org.apache.log4j.spi.LoggingEvent event)

Specified by:

append in class org.apache.log4j.AppenderSkeleton

close

public void close()

close

requiresLayout

public boolean requiresLayout()

requiresLayout

Returns:

a boolean.

resetEvents

public static void resetEvents()

resetEvents

getEvents

public static org.apache.log4j.spi.LoggingEvent[] getEvents()

getEvents

Returns:

an array of LoggingEvent objects.

getEventsGreaterOrEqual

public static org.apache.log4j.spi.LoggingEvent[] getEventsGreaterOrEqual(org.apache.log4j.Level level)

getEventsGreaterOrEqual

Parameters:

level - a Level object.

Returns:

an array of LoggingEvent objects.

getEventsAtLevel

public static org.apache.log4j.spi.LoggingEvent[] getEventsAtLevel(org.apache.log4j.Level level)

getEventsAtLevel

Returns events that were logged at the specified level

Parameters:

level - a Level object.

Returns:

an array of LoggingEvent objects.

setupLogging

public static void setupLogging()

setupLogging

setupLogging

public static void setupLogging(Properties config)

setupLogging

Parameters:

config - a Properties object.

setupLogging

public static void setupLogging(boolean toConsole)

setupLogging

Parameters:

toConsole - a boolean.

setupLogging

public static void setupLogging(boolean toConsole,
                Properties props)

setupLogging

Parameters:

toConsole - a boolean.

props - a Properties object.

setupLogging

public static void setupLogging(boolean toConsole,
                String level)

setupLogging

Parameters:

toConsole - a boolean.

level - a String object.

setupLogging

public static void setupLogging(boolean toConsole,
                String level,
                Properties config)

setupLogging

Parameters:

toConsole - a boolean.

level - a String object.

config - a Properties object.

isLoggingSetup

public static boolean isLoggingSetup()

isLoggingSetup

Returns:

a boolean.

receivedLogLevel

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

receivedLogLevel

Parameters:

level - a Level object.

resetLogLevel

public static void resetLogLevel()

resetLogLevel

noWarningsOrHigherLogged

public static boolean noWarningsOrHigherLogged()

noWarningsOrHigherLogged

Returns:

a boolean.

assertNotGreaterOrEqual

public static void assertNotGreaterOrEqual(org.apache.log4j.Level level)
                                    throws junit.framework.AssertionFailedError

assertNotGreaterOrEqual

Parameters:

level - a Level object.

Throws:

junit.framework.AssertionFailedError - if any.

assertNoWarningsOrGreater

public static void assertNoWarningsOrGreater()
                                      throws junit.framework.AssertionFailedError

assertNoWarningsOrGreater

Throws:

junit.framework.AssertionFailedError - if any.

assertLogAtLevel

public static void assertLogAtLevel(org.apache.log4j.Level level)
                             throws junit.framework.AssertionFailedError

assertLogAtLevel

Asserts that a message was logged at the requested level. Useful for testing code that *should* have logged an error message (or a notice or some other special case)

Parameters:

level - a Level object.

Throws:

junit.framework.AssertionFailedError - if any.