LogCaptureRule (infrautils-docs 1.9.1 API)

java.lang.Object
- org.opendaylight.infrautils.testutils.LogCaptureRule

All Implemented Interfaces:

TestRule
```
public class LogCaptureRule
extends Object
implements TestRule
```
JUnit Rule which "captures" slf4j-simple logs. By default, it fails the test if an error was logged. It can also pass the test if a logged error was expected (but fail it otherwise).
Usage:
```
   public @Rule LogCaptureRule logCaptureRule = new LogCaptureRule();

   @Test ...

       logRule.expectError();
 
```
See also e.g. slf4j-test or slf4jtesting (both of which, contrary to this, don't integrate with slf4j-simple which we already widely use in ODL tests).
Author:

Michael Vorburger.ch

See Also:

ExpectedException

Constructor Summary

Constructors
Constructor Description

LogCaptureRule()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Statement`	`apply(Statement statement, Description description)`
`void`	`expectError(String message)`
`void`	`expectError(String message, int howManyMessagesBack)`
`void`	`expectLastErrorMessageContains(String partialErrorMessage)`
`Throwable`	`getErrorThrowable(int howManyMessagesBack)`
`Throwable`	`getLastErrorThrowable()`
`void`	`handleErrorLogs(Consumer<ImmutableList<LogCapture>> newErrorLogHandler)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- LogCaptureRule
```
public LogCaptureRule()
```

Method Detail

apply

public Statement apply(Statement statement,
                       Description description)

Specified by:: apply in interface TestRule

handleErrorLogs

public void handleErrorLogs(Consumer<ImmutableList<LogCapture>> newErrorLogHandler)

expectLastErrorMessageContains

public void expectLastErrorMessageContains(String partialErrorMessage)

expectError

public void expectError(String message,
                        int howManyMessagesBack)

expectError

public void expectError(String message)

getLastErrorThrowable

public Throwable getLastErrorThrowable()

getErrorThrowable

public Throwable getErrorThrowable(int howManyMessagesBack)