de.tum.in.test.api.jupiter.UnifiedInvocationInterceptor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of artemis-java-test-sandbox Show documentation
The Artemis Java Test Sandbox. A JUnit 5 Extension for secure Artemis Java Testing.
There is a newer version: 1.13.0
Show newest version
package de.tum.in.test.api.jupiter;

import java.lang.reflect.Constructor;
import java.lang.reflect.Method;
import java.util.Optional;

import org.junit.jupiter.api.DynamicTest;
import org.junit.jupiter.api.extension.ExtensionContext;
import org.junit.jupiter.api.extension.InvocationInterceptor;
import org.junit.jupiter.api.extension.ReflectiveInvocationContext;

/**
 * Combines all invocation interceptions into one method called
 * {@link #interceptGenericInvocation(org.junit.jupiter.api.extension.InvocationInterceptor.Invocation, ExtensionContext, Optional)
 * interceptGenericInvocation}.
 * 
 * For derivations from the generic interception for special cases, override the
 * corresponding default method.
 *
 * @author Christian Femers
 *
 */
public interface UnifiedInvocationInterceptor extends InvocationInterceptor {

	@Override
	default  T interceptTestClassConstructor(Invocation invocation,
			ReflectiveInvocationContext> invocationContext, ExtensionContext extensionContext)
			throws Throwable {
		return interceptGenericInvocation(invocation, extensionContext, Optional.of(invocationContext));
	}

	@Override
	default void interceptBeforeAllMethod(Invocation invocation,
			ReflectiveInvocationContext invocationContext, ExtensionContext extensionContext) throws Throwable {
		interceptGenericInvocation(invocation, extensionContext, Optional.of(invocationContext));
	}

	@Override
	default void interceptBeforeEachMethod(Invocation invocation,
			ReflectiveInvocationContext invocationContext, ExtensionContext extensionContext) throws Throwable {
		interceptGenericInvocation(invocation, extensionContext, Optional.of(invocationContext));
	}

	@Override
	default void interceptTestMethod(Invocation invocation, ReflectiveInvocationContext invocationContext,
			ExtensionContext extensionContext) throws Throwable {
		interceptGenericInvocation(invocation, extensionContext, Optional.of(invocationContext));
	}

	@Override
	default  T interceptTestFactoryMethod(Invocation invocation,
			ReflectiveInvocationContext invocationContext, ExtensionContext extensionContext) throws Throwable {
		return interceptGenericInvocation(invocation, extensionContext, Optional.of(invocationContext));
	}

	@Override
	default void interceptTestTemplateMethod(Invocation invocation,
			ReflectiveInvocationContext invocationContext, ExtensionContext extensionContext) throws Throwable {
		interceptGenericInvocation(invocation, extensionContext, Optional.of(invocationContext));
	}

	@Override
	default void interceptDynamicTest(Invocation invocation, ExtensionContext extensionContext) throws Throwable {
		interceptGenericInvocation(invocation, extensionContext, Optional.empty());
	}

	@Override
	default void interceptAfterEachMethod(Invocation invocation,
			ReflectiveInvocationContext invocationContext, ExtensionContext extensionContext) throws Throwable {
		interceptGenericInvocation(invocation, extensionContext, Optional.of(invocationContext));
	}

	@Override
	default void interceptAfterAllMethod(Invocation invocation,
			ReflectiveInvocationContext invocationContext, ExtensionContext extensionContext) throws Throwable {
		interceptGenericInvocation(invocation, extensionContext, Optional.of(invocationContext));
	}

	/**
	 * Called for all invocation types unless the default method of this interface
	 * is explicitly overridden.
	 * 
	 * @param                the result type of the invocation, often just
	 *                          {@link Void}
	 * @param invocation        the invocation that is being intercepted; never null
	 * @param extensionContext  the current extension context; never null
	 * @param invocationContext the context of the invocation that is being
	 *                          intercepted; never null; but may be empty for
	 *                          {@link DynamicTest}s
	 * @return the result of the invocation; potentially null
	 * @author Christian Femers
	 */
	 T interceptGenericInvocation(Invocation invocation, ExtensionContext extensionContext,
			Optional> invocationContext) throws Throwable;
}