org.nuxeo.runtime.test.runner

Class LogCaptureFeature

java.lang.Object

org.nuxeo.runtime.test.runner.SimpleFeature

org.nuxeo.runtime.test.runner.LogCaptureFeature

All Implemented Interfaces:

RunnerFeature

public class LogCaptureFeature
extends SimpleFeature

Test feature to capture from a log4j appender to check that some log4j calls have been correctly called.
On a test class or a test method using this feature, a custom LogCaptureFeature.Filter class is to be provided with the annotation LogCaptureFeature.FilterWith to select the log events to capture.
A LogCaptureFeature.Result instance is to be injected with Inject as an attribute of the test.
The method LogCaptureFeature.Result.assertHasEvent() can then be called from test methods to check that matching log calls (events) have been captured.

Since:

5.7

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LogCaptureFeature.Filter
static interface	LogCaptureFeature.FilterWith
class	LogCaptureFeature.NoLogCaptureFilterException
class	LogCaptureFeature.Result

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.log4j.Appender	logAppender
protected LogCaptureFeature.Filter	logCaptureFilter
protected LogCaptureFeature.Result	myResult
protected org.apache.log4j.Logger	rootLogger

Constructor Summary

Constructors

Constructor and Description
LogCaptureFeature()

Method Summary

Modifier and Type	Method and Description
void	afterMethodRun(FeaturesRunner runner, org.junit.runners.model.FrameworkMethod method, Object test) After a test method was ran.
void	afterTeardown(FeaturesRunner runner) After the call of the @After methods
void	beforeMethodRun(FeaturesRunner runner, org.junit.runners.model.FrameworkMethod method, Object test) Before a test method is invoked.
void	beforeSetup(FeaturesRunner runner) Before entering in the @Before methods
void	configure(FeaturesRunner runner, com.google.inject.Binder binder) Configures Guice bindings if any is required by the feature.
protected void	disable()
protected void	enable(Class<? extends LogCaptureFeature.Filter> filterClass)

Methods inherited from class org.nuxeo.runtime.test.runner.SimpleFeature

afterRun, beforeRun, initialize, start, stop, testCreated

Methods inherited from class java.lang.Object

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

Field Detail

logCaptureFilter

protected LogCaptureFeature.Filter logCaptureFilter

myResult

protected final LogCaptureFeature.Result myResult

rootLogger

protected org.apache.log4j.Logger rootLogger

logAppender

protected org.apache.log4j.Appender logAppender

Constructor Detail

LogCaptureFeature

public LogCaptureFeature()

Method Detail

configure

public void configure(FeaturesRunner runner,
                      com.google.inject.Binder binder)

Description copied from interface: RunnerFeature

Configures Guice bindings if any is required by the feature. This is called after the framework is started and before Guice module is built. The tests are launched after guice module is built.

Specified by:

configure in interface RunnerFeature

Overrides:

configure in class SimpleFeature

beforeSetup

public void beforeSetup(FeaturesRunner runner)
                 throws Exception

Description copied from interface: RunnerFeature

Before entering in the @Before methods

Specified by:

beforeSetup in interface RunnerFeature

Overrides:

beforeSetup in class SimpleFeature

Parameters:

runner - TODO

Throws:

Exception

afterTeardown

public void afterTeardown(FeaturesRunner runner)
                   throws Exception

Description copied from interface: RunnerFeature

After the call of the @After methods

Specified by:

afterTeardown in interface RunnerFeature

Overrides:

afterTeardown in class SimpleFeature

Parameters:

runner - TODO

Throws:

Exception

beforeMethodRun

public void beforeMethodRun(FeaturesRunner runner,
                            org.junit.runners.model.FrameworkMethod method,
                            Object test)
                     throws Exception

Description copied from interface: RunnerFeature

Before a test method is invoked.

Specified by:

beforeMethodRun in interface RunnerFeature

Overrides:

beforeMethodRun in class SimpleFeature

Throws:

Exception

afterMethodRun

public void afterMethodRun(FeaturesRunner runner,
                           org.junit.runners.model.FrameworkMethod method,
                           Object test)
                    throws Exception

Description copied from interface: RunnerFeature

After a test method was ran.

Specified by:

afterMethodRun in interface RunnerFeature

Overrides:

afterMethodRun in class SimpleFeature

Throws:

Exception

enable

protected void enable(Class<? extends LogCaptureFeature.Filter> filterClass)
               throws InstantiationException,
                      IllegalAccessException

Throws:

InstantiationException

IllegalAccessException

Since:

6.0

disable

protected void disable()

Since:

6.0