org.spf4j.test.log

Class TestLoggers

java.lang.Object

org.spf4j.test.log.TestLoggers

All Implemented Interfaces:

org.slf4j.ILoggerFactory

public final class TestLoggers
extends Object
implements org.slf4j.ILoggerFactory

Author:

Zoltan Farkas

Method Summary

Modifier and Type	Method and Description
LogCollection<ArrayDeque<LogRecord>>	collect(Level minimumLogLevel, int maxNrLogs, boolean collectPrinted) Collect up to a number of log messages.
<T> LogCollection<T>	collect(String category, Level fromLevel, boolean passThrough, Collector<LogRecord,?,T> collector) Collect a bunch of logs.
<T> LogCollection<T>	collect(String category, Level fromLevel, Level toLevel, boolean passThrough, Collector<LogRecord,?,T> collector) Collect a bunch of logs.
LogAssert	dontExpect(String category, Level minimumLogLevel, org.hamcrest.Matcher<LogRecord>... matchers) the opposite of expect.
LogAssert	expect(String category, Level minimumLogLevel, int nrTimes, org.hamcrest.Matcher<LogRecord>... matchers) Ability to assert is you expect a sequence of logs to be repeated.
LogAssert	expect(String category, Level minimumLogLevel, org.hamcrest.Matcher<LogRecord>... matchers) Create an log expectation that can be asserted like: LogAssert expect = TestLoggers.expect("org.spf4j.test", Level.ERROR, Matchers.hasProperty("format", Matchers.equalTo("Booo"))); LOG.error("Booo", new RuntimeException()); expect.assertObservation();
AsyncObservationAssert	expectUncaughtException(org.hamcrest.Matcher<UncaughtExceptionDetail> matcher) Assert uncaught exceptions.
LogConfig	getConfig()
Logger	getJulGlobal()
Logger	getJulRoot()
org.slf4j.Logger	getLogger(String name) Return an appropriate SimpleLogger instance by name.
HandlerRegistration	ignore(String category, Level from, Level to) all logs from category and specified levels will be ignored...
HandlerRegistration	intercept(String category, LogHandler handler) Ability to intercept log messages logged under a category
HandlerRegistration	interceptAllLevels(String category, AllLevelsLogHandler handler) Convenience method for functional use.
HandlerRegistration	print(String category, Level level) Print logs above a category and log level.
static TestLoggers	sys()
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

sys

public static TestLoggers sys()

getConfig

public LogConfig getConfig()

print

@CheckReturnValue
public HandlerRegistration print(String category,
                                                   Level level)

Print logs above a category and log level.

Parameters:

category - the log category.

level - the log level.

Returns:

a handler that allows this printing to stop (when calling close).

intercept

@CheckReturnValue
public HandlerRegistration intercept(String category,
                                                       LogHandler handler)

Ability to intercept log messages logged under a category

Parameters:

category - the logger category name (a.b.c)

handler - the log handler to register.

Returns:

a registration handle, that you can use to unregister.

collect

@CheckReturnValue
public <T> LogCollection<T> collect(String category,
                                                      Level fromLevel,
                                                      boolean passThrough,
                                                      Collector<LogRecord,?,T> collector)

Collect a bunch of logs.

Type Parameters:

T - the type of object to collect into.

Parameters:

category - the log category (a.b.c)

fromLevel - from level to collect.

passThrough - pass the logs to lower category handlers or not.

collector - the collector to collect the logs.

Returns:

collected logs.

collect

@CheckReturnValue
public <T> LogCollection<T> collect(String category,
                                                      Level fromLevel,
                                                      Level toLevel,
                                                      boolean passThrough,
                                                      Collector<LogRecord,?,T> collector)

Collect a bunch of logs.

Type Parameters:

T - the type of object to collect into.

Parameters:

category - the log category (a.b.c)

fromLevel - from level to collect.

toLevel - to level to collect.

passThrough - pass the logs to lower category handlers or not.

collector - the collector to collect the logs.

Returns:

collected logs.

interceptAllLevels

@CheckReturnValue
public HandlerRegistration interceptAllLevels(String category,
                                                                AllLevelsLogHandler handler)

Convenience method for functional use.

Parameters:

category - the log category.

handler - a functional handler.

Returns:

a registration handle to allow you to undo the registration.

ignore

@CheckReturnValue
public HandlerRegistration ignore(String category,
                                                    Level from,
                                                    Level to)

all logs from category and specified levels will be ignored... (unless there are more specific handlers)

Parameters:

category - the log category.

from - from log level.

to - to log level.

Returns:

a registration handle to allow you to undo this filtering.

expect

@CheckReturnValue
public LogAssert expect(String category,
                                          Level minimumLogLevel,
                                          org.hamcrest.Matcher<LogRecord>... matchers)

Create an log expectation that can be asserted like: LogAssert expect = TestLoggers.expect("org.spf4j.test", Level.ERROR, Matchers.hasProperty("format", Matchers.equalTo("Booo"))); LOG.error("Booo", new RuntimeException()); expect.assertObservation();

Parameters:

category - the category under which we should expect these messages.

minimumLogLevel - minimum log level of expected log messages

matchers - a succession of LogMessages with each matching a Matcher is expected.

Returns:

an assertion handle.

dontExpect

@CheckReturnValue
public LogAssert dontExpect(String category,
                                              Level minimumLogLevel,
                                              org.hamcrest.Matcher<LogRecord>... matchers)

the opposite of expect.

Parameters:

category - the category under which we should expect these messages.

minimumLogLevel - minimum log level of expected log messages

matchers - a succession of LogMessages with each matching a Matcher is NOT expected.

Returns:

an assertion handle.

expect

public LogAssert expect(String category,
                        Level minimumLogLevel,
                        int nrTimes,
                        org.hamcrest.Matcher<LogRecord>... matchers)

Ability to assert is you expect a sequence of logs to be repeated.

Parameters:

category - the log category (a.b.c)

minimumLogLevel - the minimum log level of expected messages.

nrTimes - number of time the sequence should appear.

matchers - the sequence of matchers.

Returns:

the assertion handle.

expectUncaughtException

@Beta
public AsyncObservationAssert expectUncaughtException(org.hamcrest.Matcher<UncaughtExceptionDetail> matcher)

Assert uncaught exceptions. (from threads)

Parameters:

matcher - the exception matcher.

Returns:

the assertion handle.

collect

public LogCollection<ArrayDeque<LogRecord>> collect(Level minimumLogLevel,
                                                    int maxNrLogs,
                                                    boolean collectPrinted)

Collect up to a number of log messages.

Parameters:

minimumLogLevel - the minimum log level of the messages.

maxNrLogs - the max number of messages to collect.

collectPrinted - collect messages that have been printed or not.

Returns:

the collection of messages.

getLogger

public org.slf4j.Logger getLogger(String name)

Return an appropriate SimpleLogger instance by name.

Specified by:

getLogger in interface org.slf4j.ILoggerFactory

getJulGlobal

public Logger getJulGlobal()

getJulRoot

public Logger getJulRoot()

toString

public String toString()

Overrides:

toString in class Object