org.apache.drill.test

Class LogFixture

java.lang.Object

org.apache.drill.test.LogFixture

All Implemented Interfaces:

AutoCloseable

public class LogFixture
extends Object
implements AutoCloseable

Establishes test-specific logging without having to alter the global logback-test.xml file. Allows directing output to the console (if not already configured) and setting the log level on specific loggers of interest in the test. The fixture automatically restores the original log configuration on exit.

Typical usage:

  @Test
 public void myTest() {
   LogFixtureBuilder logBuilder = LogFixture.builder()
          .toConsole()
          .disable() // Silence all other loggers
          .logger(ExternalSortBatch.class, Level.DEBUG);
   try (LogFixture logs = logBuilder.build()) {
     // Test code here
   }
 }

You can – and should – combine the log fixture with the cluster and client fixtures to have complete control over your test-time Drill environment.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LogFixture.LogFixtureBuilder Builds the log settings to be used for a test.
static class	LogFixture.LogSpec Memento for a logger name and level.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CONSOLE_FORMAT

Constructor Summary

Constructors

Constructor and Description
LogFixture(LogFixture.LogFixtureBuilder builder)

Method Summary

Modifier and Type	Method and Description
static LogFixture.LogFixtureBuilder	builder() Creates a new log fixture builder.
void	close()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONSOLE_FORMAT

public static final String DEFAULT_CONSOLE_FORMAT

See Also:

Constant Field Values

Constructor Detail

LogFixture

public LogFixture(LogFixture.LogFixtureBuilder builder)

Method Detail

builder

public static LogFixture.LogFixtureBuilder builder()

Creates a new log fixture builder.

Returns:

the log fixture builder

close

public void close()

Specified by:

close in interface AutoCloseable