io.github.glytching.junit.extension.watcher

Class WatcherExtension

java.lang.Object

io.github.glytching.junit.extension.watcher.WatcherExtension

All Implemented Interfaces:

org.junit.jupiter.api.extension.AfterTestExecutionCallback, org.junit.jupiter.api.extension.BeforeTestExecutionCallback, org.junit.jupiter.api.extension.Extension

public class WatcherExtension
extends Object
implements org.junit.jupiter.api.extension.BeforeTestExecutionCallback, org.junit.jupiter.api.extension.AfterTestExecutionCallback

The watcher extension logs test execution flow including:

• Entry
• Exit
• Elapsed time in ms

It produces output like so:

 INFO: Starting test: [aTest]
 INFO: Completed test [aTest] in 21 ms.
 

Usage example:

 @ExtendWith(WatcherExtension.class)
 public class MyTest {

  @Test
  public void aTest() {
      // ...
  }
 }
 

Since:

1.0.0

See Also:

JUnit 4 TestWatchman/TestWatcher Rules

Method Summary

Modifier and Type	Method and Description
void	afterTestExecution(org.junit.jupiter.api.extension.ExtensionContext extensionContext) Log test method exit, using the start time stored by beforeTestExecution(ExtensionContext) to calculate a duration.
void	beforeTestExecution(org.junit.jupiter.api.extension.ExtensionContext extensionContext) Log test method entry and store its start time in the ExtensionContext.Store for use in afterTestExecution(ExtensionContext).

Methods inherited from class java.lang.Object

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

Method Detail

beforeTestExecution

public void beforeTestExecution(org.junit.jupiter.api.extension.ExtensionContext extensionContext)
                         throws Exception

Log test method entry and store its start time in the ExtensionContext.Store for use in afterTestExecution(ExtensionContext).

Specified by:

beforeTestExecution in interface org.junit.jupiter.api.extension.BeforeTestExecutionCallback

Parameters:

extensionContext - the context in which the current test or container is being executed

Throws:

Exception

afterTestExecution

public void afterTestExecution(org.junit.jupiter.api.extension.ExtensionContext extensionContext)
                        throws Exception

Log test method exit, using the start time stored by beforeTestExecution(ExtensionContext) to calculate a duration.

Specified by:

afterTestExecution in interface org.junit.jupiter.api.extension.AfterTestExecutionCallback

Parameters:

extensionContext - the context in which the current test or container is being executed

Throws:

Exception