Package org.nuxeo.runtime.test.runner

Class LogFeature

java.lang.Object
org.nuxeo.runtime.test.runner.LogFeature
All Implemented Interfaces:
RunnerFeature
public class LogFeature extends Object implements RunnerFeature
Since:
9.3

  • Field Details

    • CONSOLE_APPENDER

      protected static final String CONSOLE_APPENDER
      See Also:

    • CONSOLE_LOG_FEATURE_APPENDER

      protected static final String CONSOLE_LOG_FEATURE_APPENDER
      See Also:

    • consoleAppender

      protected org.apache.logging.log4j.core.appender.ConsoleAppender consoleAppender

    • hiddenAppender

      protected org.apache.logging.log4j.core.appender.ConsoleAppender hiddenAppender

    • originalConfigurationByLogger

      protected Map<LoggerLevelKey,LogFeature.LoggerLightConfig> originalConfigurationByLogger
      Stores the original log level for a given logger name, which allows us to restore the level as defined before launching the tests.
      Since:
      11.1

  • Constructor Details

    • LogFeature

      public LogFeature()

  • Method Details

    • initialize

      public void initialize(FeaturesRunner runner)
      Called when preparing to run the test class. Framework is not started at this point. Here is time for the feature to configure the runner from annotations on the test class.

      Specified by:
      initialize in interface RunnerFeature
      Since:
      11.1

    • stop

      public void stop(FeaturesRunner runner)
      Before exiting the test.

      Specified by:
      stop in interface RunnerFeature
      Since:
      11.1

    • beforeMethodRun

      public void beforeMethodRun(FeaturesRunner runner, org.junit.runners.model.FrameworkMethod method, Object test)
      Before a test method is invoked.

      Specified by:
      beforeMethodRun in interface RunnerFeature
      Since:
      11.1

    • afterMethodRun

      public void afterMethodRun(FeaturesRunner runner, org.junit.runners.model.FrameworkMethod method, Object test)
      After a test method was ran.

      Specified by:
      afterMethodRun in interface RunnerFeature
      Since:
      11.1

    • hideWarningFromConsoleLog

      @Deprecated(since="11.1", forRemoval=true) public void hideWarningFromConsoleLog()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 11.1. Use ConsoleLogLevelThreshold with ConsoleLogLevelThreshold.value() set to ERROR.

    • hideErrorFromConsoleLog

      @Deprecated(since="11.1", forRemoval=true) public void hideErrorFromConsoleLog()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 11.1. Use ConsoleLogLevelThreshold with ConsoleLogLevelThreshold.value() set to FATAL.
      Since:
      9.10

    • setConsoleLogThreshold

      public void setConsoleLogThreshold(String level)
      Since:
      9.10

    • restoreConsoleLog

      public void restoreConsoleLog()

    • addConsoleThresholdLogLevel

      protected void addConsoleThresholdLogLevel(FeaturesRunner runner, org.junit.runners.model.FrameworkMethod method)
      Adds the console threshold log level. To be proceed a Class / Method should be annotated by
      Parameters:
      runner - the feature runner, cannot be null
      method - the framework method, can be null
      Since:
      11.1
      See Also:

    • restoreConsoleThresholdLogLevel

      protected void restoreConsoleThresholdLogLevel(FeaturesRunner runner, org.junit.runners.model.FrameworkMethod method)
      Restores the console threshold log level. Based on if Class or Method is annotated by ConsoleLogLevelThreshold.

      restoreConsoleLog()

      Since:
      11.1

    • addOrUpdateLoggerLevel

      protected void addOrUpdateLoggerLevel(FeaturesRunner runner, org.junit.runners.model.FrameworkMethod method)
      Adds or updates the logger level.

      The definition of LoggerLevel can be done on a given Class / Method test. At the end of the test each overriding logger must be restored to its original value for this the purpose we should save the original level.

      restoreLoggerLevel(FeaturesRunner, FrameworkMethod) to see how the restore part will be happened.

      Parameters:
      runner - the feature runner, cannot be null
      method - the framework method, can be null
      Since:
      11.1

    • restoreLoggerLevel

      protected void restoreLoggerLevel(FeaturesRunner runner, org.junit.runners.model.FrameworkMethod method)
      Restores the original value of the logger level.

      addOrUpdateLoggerLevel(FeaturesRunner, FrameworkMethod)} to see how we store the original value and set the new one.

      Parameters:
      runner - the feature runner, cannot be null
      method - the framework method, can be null
      Since:
      11.1

    • addAppendersFromRefs

      protected void addAppendersFromRefs(org.apache.logging.log4j.core.config.LoggerConfig loggerConfig, org.apache.logging.log4j.core.config.Configuration configuration)

    • getLoggerName

      protected String getLoggerName(LoggerLevel logLevel)
      Gets the logger name from a given LoggerLevel.
      Since:
      11.1

    • buildKey

      protected LoggerLevelKey buildKey(LoggerLevel logger, org.junit.runners.model.FrameworkMethod method)
      Builds the logger key.
      Since:
      11.1