HHH-19832 Disable BytecodeEnhancedTestEngine by default

Author: marko-bekhta

hibernate-testing/src/main/java/org/hibernate/testing/bytecode/enhancement/extension/BytecodeEnhancementPostDiscoveryFilter.java

@@ -8,6 +8,7 @@
 import static org.junit.platform.commons.util.AnnotationUtils.isAnnotated;
 
 import org.hibernate.testing.bytecode.enhancement.extension.engine.BytecodeEnhancedEngineDescriptor;
+import org.hibernate.testing.bytecode.enhancement.extension.engine.BytecodeEnhancedTestEngine;
 import org.junit.jupiter.engine.descriptor.ClassBasedTestDescriptor;
 import org.junit.platform.engine.FilterResult;
 import org.junit.platform.engine.TestDescriptor;
@@ -24,6 +25,11 @@ public FilterResult apply(TestDescriptor testDescriptor) {
 			}
 
 			boolean isEnhanced = isAnnotated( descriptor.getTestClass(), BytecodeEnhanced.class );
+			if ( isEnhanced && !BytecodeEnhancedTestEngine.isEnabled() ) {
+				throw new IllegalStateException(
+						"BytecodeEnhancedTestEngine is disabled. But the tests rely on the @BytecodeEnhanced extensions: %s. In order to run this test, make sure to exactly align your dependency to JUnit with that of hibernate-testing, and set system property '%s=true'.".formatted(
+								descriptor, BytecodeEnhancedTestEngine.ENHANCEMENT_EXTENSION_ENGINE_ENABLED ) );
+			}
 			if ( root instanceof BytecodeEnhancedEngineDescriptor ) {
 				if ( !isEnhanced ) {
 					return FilterResult.excluded( "Not bytecode enhanced." );
@@ -32,7 +38,7 @@ public FilterResult apply(TestDescriptor testDescriptor) {
 			else {
 				if ( isEnhanced ) {
 					testDescriptor.removeFromHierarchy();
-					return FilterResult.excluded( "Not bytecode enhanced." );
+					return FilterResult.excluded( "Not bytecode enhanced engine, but test requires bytecode enhancement." );
 				}
 			}
 		}

hibernate-testing/src/main/java/org/hibernate/testing/bytecode/enhancement/extension/engine/BytecodeEnhancedTestEngine.java

@@ -51,19 +51,34 @@
 import org.junit.platform.engine.OutputDirectoryCreator;
 import org.junit.platform.engine.TestDescriptor;
 import org.junit.platform.engine.UniqueId;
+import org.junit.platform.engine.support.descriptor.EngineDescriptor;
 import org.junit.platform.engine.support.hierarchical.EngineExecutionContext;
 import org.junit.platform.engine.support.hierarchical.HierarchicalTestEngine;
 import org.junit.platform.engine.support.hierarchical.ThrowableCollector;
 
 public class BytecodeEnhancedTestEngine extends HierarchicalTestEngine<JupiterEngineExecutionContext> {
 
+	public static final String ENHANCEMENT_EXTENSION_ENGINE_ENABLED = "hibernate.testing.bytecode.enhancement.extension.engine.enabled";
+
+	public static boolean isEnabled() {
+		return "true".equalsIgnoreCase( System.getProperty( ENHANCEMENT_EXTENSION_ENGINE_ENABLED, "false" ) );
+	}
+
 	@Override
 	public String getId() {
 		return "bytecode-enhanced-engine";
 	}
 
 	@Override
 	public TestDescriptor discover(EngineDiscoveryRequest discoveryRequest, UniqueId uniqueId) {
+		if ( isEnabled() ) {
+			return doDiscover( discoveryRequest, uniqueId );
+		}
+
+		return new EngineDescriptor( uniqueId, getId() );
+	}
+
+	public TestDescriptor doDiscover(EngineDiscoveryRequest discoveryRequest, UniqueId uniqueId) {
 		final BytecodeEnhancedEngineDescriptor engineDescriptor = new BytecodeEnhancedEngineDescriptor(
 				(JupiterEngineDescriptor) new JupiterTestEngine().discover( discoveryRequest, uniqueId )
 		);
@@ -235,8 +250,12 @@ protected JupiterEngineExecutionContext createExecutionContext(ExecutionRequest
 	}
 
 	private JupiterConfiguration getJupiterConfiguration(ExecutionRequest request) {
-		JupiterEngineDescriptor engineDescriptor = (JupiterEngineDescriptor) request.getRootTestDescriptor();
-		return engineDescriptor.getConfiguration();
+		if ( request.getRootTestDescriptor() instanceof JupiterEngineDescriptor descriptor ) {
+			return descriptor.getConfiguration();
+		}
+		else {
+			return null;
+		}
 	}
 
 	public Optional<String> getGroupId() {

local-build-plugins/src/main/groovy/local.java-module.gradle

@@ -52,7 +52,7 @@ dependencies {
     }
 
     // JUnit dependencies made up of:
-    // 		* JUnit 6
+    // 		* JUnit (version 5 or later)
     // 		* the Jupiter engine which runs JUnit 6 based tests
     //		* the "vintage" engine - which runs JUnit 3 and 4 based tests
     testImplementation testLibs.junitJupiterApi
@@ -212,6 +212,8 @@ tasks.withType( Test.class ).each { test ->
 
     test.maxHeapSize = '3G'
 
+    // Enable bytecode enhanced engine:
+    test.systemProperties['hibernate.testing.bytecode.enhancement.extension.engine.enabled'] = true
     test.systemProperties['hibernate.test.validatefailureexpected'] = true
     test.systemProperties['hibernate.highlight_sql'] = false
     test.systemProperties += System.properties.findAll { it.key.startsWith( "hibernate." ) }

test-case-guide.adoc

@@ -16,7 +16,7 @@ There are a number of tenants that make up a good test case as opposed to a poor
 [[junit-jupiter]]
 == [[junit5]] JUnit Jupiter (6) extensions
 
-JUnit 6 offers better support for integration, compared to JUnit 4, via https://junit.org/junit5/docs/current/user-guide/#extensions[extensions].  Hibernate builds on those concepts in its `hibernate-testing` module allowing set up of test fixtures using annotations.  The following sections describe the Hibernate extensions.
+JUnit Jupiter offers better support for integration, compared to JUnit 4, via https://docs.junit.org/current/user-guide[extensions].  Hibernate builds on those concepts in its `hibernate-testing` module allowing set up of test fixtures using annotations.  The following sections describe the Hibernate extensions.
 
 NOTE: The extensions exist in the `org.hibernate.testing.orm.junit` package, as opposed to the older `org.hibernate.testing.junit4` package used with JUnit 4.
 
@@ -29,7 +29,7 @@ Manages a `ServiceRegistry` as part of the test lifecycle.  2 in fact, depending
 `@BootstrapServiceRegistry`:: configures Hibernate's bootstrap `BootstrapServiceRegistry` which manages class-loading, etc.  `@BootstrapServiceRegistry` is used to provide Java services and Hibernate `Integrator` implementations for the test.
 `@ServiceRegistry`:: configures Hibernate's standard `StandardServiceRegistry`.  `@ServiceRegistry` is used to provide settings, contributors, services, etc.
 
-Also exposes `ServiceRegistryScope` via JUnit 6 `ParameterResolver`.  `ServiceRegistryScope` allows
+Also exposes `ServiceRegistryScope` via JUnit's `ParameterResolver`.  `ServiceRegistryScope` allows
 access to the managed `ServiceRegistry` from tests and callbacks.
 
 ```