HHH-19884 Custom @ClassTemplate lifecycle annotations and extension

Author: mbellade

hibernate-testing/src/main/java/org/hibernate/testing/orm/junit/AfterClassTemplate.java

@@ -0,0 +1,19 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright Red Hat Inc. and Hibernate Authors
+ */
+package org.hibernate.testing.orm.junit;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Similar to JUnit's {@link org.junit.jupiter.api.AfterAll} but called after
+ * each template invocation in a {@link @ClassTemplate} test class.
+ */
+@Target(ElementType.METHOD)
+@Retention(RetentionPolicy.RUNTIME)
+public @interface AfterClassTemplate {
+}

hibernate-testing/src/main/java/org/hibernate/testing/orm/junit/BeforeClassTemplate.java

@@ -0,0 +1,19 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright Red Hat Inc. and Hibernate Authors
+ */
+package org.hibernate.testing.orm.junit;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Similar to JUnit's {@link org.junit.jupiter.api.BeforeAll} but called before
+ * each template invocation in a {@link @ClassTemplate} test class.
+ */
+@Target(ElementType.METHOD)
+@Retention(RetentionPolicy.RUNTIME)
+public @interface BeforeClassTemplate {
+}

hibernate-testing/src/main/java/org/hibernate/testing/orm/junit/ClassTemplateInvocationListenersExtension.java

@@ -0,0 +1,83 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright Red Hat Inc. and Hibernate Authors
+ */
+package org.hibernate.testing.orm.junit;
+
+import org.junit.jupiter.api.extension.AfterClassTemplateInvocationCallback;
+import org.junit.jupiter.api.extension.BeforeClassTemplateInvocationCallback;
+import org.junit.jupiter.api.extension.ExtensionContext;
+
+import java.lang.reflect.InvocationTargetException;
+import java.lang.reflect.Method;
+
+import static org.junit.platform.commons.support.AnnotationSupport.findAnnotatedMethods;
+import static org.junit.platform.commons.support.AnnotationSupport.findAnnotation;
+import static org.junit.platform.commons.support.HierarchyTraversalMode.BOTTOM_UP;
+
+/**
+ * JUnit extension to provide hooks for methods annotated with {@link BeforeClassTemplate}
+ * and {@link AfterClassTemplate} to be called before and after each class template invocation
+ * <p>
+ * Provides native support for methods with zero parameters or a single parameter typed either
+ * as {@link EntityManagerFactoryScope} or {@link SessionFactoryScope}, for easy integration
+ * with the {@link EntityManagerFactoryExtension entity manager} and {@link SessionFactoryExtension
+ * session factory} extensions.
+ */
+public class ClassTemplateInvocationListenersExtension
+		implements BeforeClassTemplateInvocationCallback, AfterClassTemplateInvocationCallback {
+	@Override
+	public void beforeClassTemplateInvocation(ExtensionContext context) throws Exception {
+		final var testClass = context.getRequiredTestClass();
+		final var annotatedMethods = findAnnotatedMethods( testClass, BeforeClassTemplate.class, BOTTOM_UP );
+		for ( final var method : annotatedMethods ) {
+			invokeLifecycleMethod( method, context.getRequiredTestInstance(), context );
+		}
+	}
+
+	@Override
+	public void afterClassTemplateInvocation(ExtensionContext context) throws Exception {
+		final var testClass = context.getRequiredTestClass();
+		final var annotatedMethods = findAnnotatedMethods( testClass, AfterClassTemplate.class, BOTTOM_UP );
+		for ( final var method : annotatedMethods ) {
+			invokeLifecycleMethod( method, context.getRequiredTestInstance(), context );
+		}
+	}
+
+	private static void invokeLifecycleMethod(Method method, Object testInstance, ExtensionContext context)
+			throws InvocationTargetException, IllegalAccessException {
+		method.setAccessible( true );
+		final var parameterTypes = method.getParameterTypes();
+		if ( parameterTypes.length == 1 ) {
+			final var parameterType = parameterTypes[0];
+			if ( EntityManagerFactoryScope.class.isAssignableFrom( parameterType ) ) {
+				final var scope = EntityManagerFactoryExtension.findEntityManagerFactoryScope(
+						context.getRequiredTestInstance(),
+						findAnnotation( context.getRequiredTestClass(), Jpa.class ),
+						context
+				);
+				method.invoke( testInstance, scope );
+			}
+			else if ( SessionFactoryScope.class.isAssignableFrom( parameterType ) ) {
+				final var sessionFactoryScope = SessionFactoryExtension.findSessionFactoryScope(
+						context.getRequiredTestInstance(),
+						context
+				);
+				method.invoke( testInstance, sessionFactoryScope );
+			}
+			else {
+				throw new IllegalStateException(
+						"ClassTemplate lifecycle method '" + method.getName() + "' has an unsupported parameter type: " + parameterType.getName()
+				);
+			}
+		}
+		else if ( parameterTypes.length == 0 ) {
+			method.invoke( testInstance );
+		}
+		else {
+			throw new IllegalStateException(
+					"ClassTemplate lifecycle method '" + method.getName() + "' can only have zero or one parameter"
+			);
+		}
+	}
+}