Package org.elasticsearch.test

Class MockLog

java.lang.Object

org.elasticsearch.test.MockLog

All Implemented Interfaces:

Closeable, AutoCloseable, org.elasticsearch.core.Releasable

public class MockLog
extends Object
implements org.elasticsearch.core.Releasable

Test appender that can be used to verify that certain events were logged correctly

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MockLog.AbstractEventExpectation
static class	MockLog.EventuallySeenEventExpectation
static class	MockLog.ExceptionSeenEventExpectation
static interface	MockLog.LoggingExpectation	Keeps track of whether the LogEvent instances it receives match the expected content.
static class	MockLog.PatternSeenEventExpectation
static class	MockLog.SeenEventExpectation
static class	MockLog.UnseenEventExpectation

Method Summary

Modifier and Type	Method	Description
void	addExpectation(MockLog.LoggingExpectation expectation)
void	assertAllExpectationsMatched()
static void	assertThatLogger(Runnable action, Class<?> loggerOwner, MockLog.LoggingExpectation... expectations)	Executes an action and verifies expectations against the provided logger
void	awaitAllExpectationsMatched()
static void	awaitLogger(Runnable action, Class<?> loggerOwner, MockLog.LoggingExpectation... expectations)	Executes an action and waits until the given logging expectations are satisfied.
static MockLog	capture(Class<?>... classes)	Adds the list of class loggers to this MockLog.
static MockLog	capture(String... names)	Same as above except takes string class names of each logger.
void	close()
static void	init()	Initialize the mock log appender with the log4j system.

Methods inherited from class java.lang.Object

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

Method Details

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface org.elasticsearch.core.Releasable

init

public static void init()

Initialize the mock log appender with the log4j system.

addExpectation

public void addExpectation(MockLog.LoggingExpectation expectation)

assertAllExpectationsMatched

public void assertAllExpectationsMatched()

awaitAllExpectationsMatched

public void awaitAllExpectationsMatched()

capture

public static MockLog capture(Class<?>... classes)

Adds the list of class loggers to this MockLog. Stops and runs some checks on the MockLog once the returned object is released.

capture

public static MockLog capture(String... names)

Same as above except takes string class names of each logger.

assertThatLogger

public static void assertThatLogger(Runnable action,
 Class<?> loggerOwner,
 MockLog.LoggingExpectation... expectations)

Executes an action and verifies expectations against the provided logger

awaitLogger

public static void awaitLogger(Runnable action,
 Class<?> loggerOwner,
 MockLog.LoggingExpectation... expectations)

Executes an action and waits until the given logging expectations are satisfied.