io.spine.testing.logging

Class LoggingTest

java.lang.Object

io.spine.testing.logging.LoggingTest

Direct Known Subclasses:

SimpleLoggingTest

public abstract class LoggingTest
extends java.lang.Object

Abstract base for tests of logging.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LoggingTest(java.lang.Class<?> loggingClass, java.util.logging.Level level) Creates a new test suite.

Method Summary

Modifier and Type	Method and Description
protected LoggingAssertions	assertLog() Obtains the instance of AssertingHandler of this test.
protected void	interceptLogging() Redirects logging to a custom handler which would accumulate the log output.
protected java.util.logging.Level	level() Obtains the level of logging assigned for the tests.
protected java.lang.Class<?>	loggingClass() Obtains the class which logging operations are tested.
protected java.util.logging.Level	previousLevel() Obtains the level of the logging set for the logging class before the tests.
protected void	restoreLogging() Removes the handler assigned in interceptLogging() and restores the value of the flag for using parent handlers.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoggingTest

protected LoggingTest(java.lang.Class<?> loggingClass,
                      java.util.logging.Level level)

Creates a new test suite.

Parameters:

loggingClass - the class which performs the logging operations

level - the level of logging in which we are interested in the tests

Method Detail

assertLog

protected final LoggingAssertions assertLog()

Obtains the instance of AssertingHandler of this test.

Throws:

java.lang.NullPointerException - if the handler was not initialized or already removed

See Also:

interceptLogging(), restoreLogging()

loggingClass

protected final java.lang.Class<?> loggingClass()

Obtains the class which logging operations are tested.

level

protected final java.util.logging.Level level()

Obtains the level of logging assigned for the tests.

previousLevel

protected final java.util.logging.Level previousLevel()

Obtains the level of the logging set for the logging class before the tests.

interceptLogging

protected final void interceptLogging()

Redirects logging to a custom handler which would accumulate the log output.

The output can be later asserted.

The logging will have the level assigned for the test. The method also turns off parent handlers.

See Also:

restoreLogging()

API Note:

This method is not annotated @BeforeEach to allow derived test suites hook up the logging where appropriate to the test suite. In some cases the logger should be tuned after some of the operations performed in a test setup.

restoreLogging

protected final void restoreLogging()

Removes the handler assigned in interceptLogging() and restores the value of the flag for using parent handlers.

The handler is not available after this method is called until it is created and added back by interceptLogging().