Package org.apache.hadoop.hbase

Class HBaseJupiterExtension

java.lang.Object

org.apache.hadoop.hbase.HBaseJupiterExtension

All Implemented Interfaces:

org.junit.jupiter.api.extension.AfterAllCallback, org.junit.jupiter.api.extension.AfterEachCallback, org.junit.jupiter.api.extension.BeforeAllCallback, org.junit.jupiter.api.extension.BeforeEachCallback, org.junit.jupiter.api.extension.Extension, org.junit.jupiter.api.extension.InvocationInterceptor, org.junit.jupiter.api.extension.TestInstantiationAwareExtension

@Private
public class HBaseJupiterExtension
extends Object
implements org.junit.jupiter.api.extension.InvocationInterceptor, org.junit.jupiter.api.extension.BeforeAllCallback, org.junit.jupiter.api.extension.AfterAllCallback, org.junit.jupiter.api.extension.BeforeEachCallback, org.junit.jupiter.api.extension.AfterEachCallback

Class test rule implementation for JUnit5.

It ensures that all JUnit5 tests should have at least one of SmallTests, MediumTests, LargeTests, IntegrationTests tags, and set timeout based on the tag.

It also controls the timeout for the whole test class running, while the timeout annotation in JUnit5 can only enforce the timeout for each test method. When a test is timed out, a thread dump will be printed to log output.

It also implements resource check for each test method, using the ResourceChecker class.

Finally, it also forbid System.exit call in tests.
TODO: need to find a new way as SecurityManager was deprecated in Java 17 and permanently disabled since Java 24.

Nested Class Summary

Nested classes/interfaces inherited from interface org.junit.jupiter.api.extension.InvocationInterceptor

org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<T extends Object>

Nested classes/interfaces inherited from interface org.junit.jupiter.api.extension.TestInstantiationAwareExtension

org.junit.jupiter.api.extension.TestInstantiationAwareExtension.ExtensionContextScope

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	DEADLINE
private static final String	EXECUTOR
private static final org.slf4j.Logger	LOG
private static final org.junit.jupiter.api.extension.ExtensionContext.Namespace	NAMESPACE
private static final String	RESOURCE_CHECK
private static final SecurityManager	securityManager
private static final Map<String,Duration>	TAG_TO_TIMEOUT

Constructor Summary

Constructors

Constructor	Description
HBaseJupiterExtension()

Method Summary

Modifier and Type	Method	Description
void	afterAll(org.junit.jupiter.api.extension.ExtensionContext ctx)
void	afterEach(org.junit.jupiter.api.extension.ExtensionContext ctx)
void	beforeAll(org.junit.jupiter.api.extension.ExtensionContext ctx)
void	beforeEach(org.junit.jupiter.api.extension.ExtensionContext ctx)
void	interceptAfterAllMethod(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<Void> invocation, org.junit.jupiter.api.extension.ReflectiveInvocationContext<Method> invocationContext, org.junit.jupiter.api.extension.ExtensionContext extensionContext)
void	interceptAfterEachMethod(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<Void> invocation, org.junit.jupiter.api.extension.ReflectiveInvocationContext<Method> invocationContext, org.junit.jupiter.api.extension.ExtensionContext extensionContext)
void	interceptBeforeAllMethod(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<Void> invocation, org.junit.jupiter.api.extension.ReflectiveInvocationContext<Method> invocationContext, org.junit.jupiter.api.extension.ExtensionContext extensionContext)
void	interceptBeforeEachMethod(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<Void> invocation, org.junit.jupiter.api.extension.ReflectiveInvocationContext<Method> invocationContext, org.junit.jupiter.api.extension.ExtensionContext extensionContext)
<T> T	interceptTestClassConstructor(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<T> invocation, org.junit.jupiter.api.extension.ReflectiveInvocationContext<Constructor<T>> invocationContext, org.junit.jupiter.api.extension.ExtensionContext extensionContext)
void	interceptTestMethod(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<Void> invocation, org.junit.jupiter.api.extension.ReflectiveInvocationContext<Method> invocationContext, org.junit.jupiter.api.extension.ExtensionContext extensionContext)
private Duration	pickTimeout(org.junit.jupiter.api.extension.ExtensionContext ctx)
private void	printThreadDump()
private <T> T	runWithTimeout(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<T> invocation, org.junit.jupiter.api.extension.ExtensionContext ctx, String name)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.junit.jupiter.api.extension.InvocationInterceptor

interceptDynamicTest, interceptDynamicTest, interceptTestFactoryMethod, interceptTestTemplateMethod

Methods inherited from interface org.junit.jupiter.api.extension.TestInstantiationAwareExtension

getTestInstantiationExtensionContextScope

Field Details

LOG

private static final org.slf4j.Logger LOG

securityManager

private static final SecurityManager securityManager

NAMESPACE

private static final org.junit.jupiter.api.extension.ExtensionContext.Namespace NAMESPACE

TAG_TO_TIMEOUT

private static final Map<String,Duration> TAG_TO_TIMEOUT

EXECUTOR

private static final String EXECUTOR

See Also:

• Constant Field Values

DEADLINE

private static final String DEADLINE

See Also:

• Constant Field Values

RESOURCE_CHECK

private static final String RESOURCE_CHECK

See Also:

• Constant Field Values

Constructor Details

HBaseJupiterExtension

public HBaseJupiterExtension()

Method Details

pickTimeout

private Duration pickTimeout(org.junit.jupiter.api.extension.ExtensionContext ctx)

beforeAll

public void beforeAll(org.junit.jupiter.api.extension.ExtensionContext ctx)
               throws Exception

Specified by:

beforeAll in interface org.junit.jupiter.api.extension.BeforeAllCallback

Throws:

Exception

afterAll

public void afterAll(org.junit.jupiter.api.extension.ExtensionContext ctx)
              throws Exception

Specified by:

afterAll in interface org.junit.jupiter.api.extension.AfterAllCallback

Throws:

Exception

runWithTimeout

private <T> T runWithTimeout(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<T> invocation,
 org.junit.jupiter.api.extension.ExtensionContext ctx,
 String name)
                      throws Throwable

Throws:

Throwable

printThreadDump

private void printThreadDump()

interceptBeforeAllMethod

public void interceptBeforeAllMethod(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<Void> invocation,
 org.junit.jupiter.api.extension.ReflectiveInvocationContext<Method> invocationContext,
 org.junit.jupiter.api.extension.ExtensionContext extensionContext)
                              throws Throwable

Specified by:

interceptBeforeAllMethod in interface org.junit.jupiter.api.extension.InvocationInterceptor

Throws:

Throwable

interceptBeforeEachMethod

public void interceptBeforeEachMethod(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<Void> invocation,
 org.junit.jupiter.api.extension.ReflectiveInvocationContext<Method> invocationContext,
 org.junit.jupiter.api.extension.ExtensionContext extensionContext)
                               throws Throwable

Specified by:

interceptBeforeEachMethod in interface org.junit.jupiter.api.extension.InvocationInterceptor

Throws:

Throwable

interceptTestMethod

public void interceptTestMethod(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<Void> invocation,
 org.junit.jupiter.api.extension.ReflectiveInvocationContext<Method> invocationContext,
 org.junit.jupiter.api.extension.ExtensionContext extensionContext)
                         throws Throwable

Specified by:

interceptTestMethod in interface org.junit.jupiter.api.extension.InvocationInterceptor

Throws:

Throwable

interceptAfterEachMethod

public void interceptAfterEachMethod(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<Void> invocation,
 org.junit.jupiter.api.extension.ReflectiveInvocationContext<Method> invocationContext,
 org.junit.jupiter.api.extension.ExtensionContext extensionContext)
                              throws Throwable

Specified by:

interceptAfterEachMethod in interface org.junit.jupiter.api.extension.InvocationInterceptor

Throws:

Throwable

interceptAfterAllMethod

public void interceptAfterAllMethod(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<Void> invocation,
 org.junit.jupiter.api.extension.ReflectiveInvocationContext<Method> invocationContext,
 org.junit.jupiter.api.extension.ExtensionContext extensionContext)
                             throws Throwable

Specified by:

interceptAfterAllMethod in interface org.junit.jupiter.api.extension.InvocationInterceptor

Throws:

Throwable

interceptTestClassConstructor

public <T> T interceptTestClassConstructor(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation<T> invocation,
 org.junit.jupiter.api.extension.ReflectiveInvocationContext<Constructor<T>> invocationContext,
 org.junit.jupiter.api.extension.ExtensionContext extensionContext)
                                    throws Throwable

Specified by:

interceptTestClassConstructor in interface org.junit.jupiter.api.extension.InvocationInterceptor

Throws:

Throwable

beforeEach

public void beforeEach(org.junit.jupiter.api.extension.ExtensionContext ctx)
                throws Exception

Specified by:

beforeEach in interface org.junit.jupiter.api.extension.BeforeEachCallback

Throws:

Exception

afterEach

public void afterEach(org.junit.jupiter.api.extension.ExtensionContext ctx)
               throws Exception

Specified by:

afterEach in interface org.junit.jupiter.api.extension.AfterEachCallback

Throws:

Exception