HHH-19925 - Locking root(s) should be based on select-clause, not from-clause

Author: sebersole

hibernate-core/src/test/java/org/hibernate/orm/test/flush/TestAutoFlushBeforeQueryExecution.java

@@ -6,6 +6,7 @@
 
 import org.hibernate.Hibernate;
 import org.hibernate.boot.Metadata;
+import org.hibernate.boot.registry.BootstrapServiceRegistry;
 import org.hibernate.boot.registry.BootstrapServiceRegistryBuilder;
 import org.hibernate.boot.spi.BootstrapContext;
 import org.hibernate.engine.spi.ActionQueue;
@@ -15,10 +16,10 @@
 import org.hibernate.event.spi.PreUpdateEvent;
 import org.hibernate.event.spi.PreUpdateEventListener;
 import org.hibernate.integrator.spi.Integrator;
+import org.hibernate.testing.orm.junit.BootstrapServiceRegistryProducer;
 import org.hibernate.testing.orm.junit.DomainModel;
 import org.hibernate.testing.orm.junit.JiraKey;
 import org.hibernate.testing.orm.junit.ServiceRegistryFunctionalTesting;
-import org.hibernate.testing.orm.junit.ServiceRegistryProducer;
 import org.hibernate.testing.orm.junit.SessionFactory;
 import org.hibernate.testing.orm.junit.SessionFactoryScope;
 import org.junit.jupiter.api.Assertions;
@@ -36,7 +37,7 @@
 @ServiceRegistryFunctionalTesting
 @DomainModel(annotatedClasses = { Author.class, Book.class, Publisher.class, UnrelatedEntity.class })
 @SessionFactory
-public class TestAutoFlushBeforeQueryExecution implements ServiceRegistryProducer {
+public class TestAutoFlushBeforeQueryExecution implements BootstrapServiceRegistryProducer {
 
 	@Test
 	public void testAutoflushIsRequired(SessionFactoryScope factoryScope) {
@@ -211,7 +212,7 @@ record Ids (Long publisherId, Long unrelatedEntityId ) {
 	}
 
 	@Override
-	public void prepareBootstrapRegistryBuilder(BootstrapServiceRegistryBuilder builder) {
+	public BootstrapServiceRegistry produceServiceRegistry(BootstrapServiceRegistryBuilder builder) {
 		builder.applyIntegrator(
 				new Integrator() {
 					@Override
@@ -229,6 +230,7 @@ private void integrate(SessionFactoryImplementor sessionFactory) {
 					}
 				}
 		);
+		return builder.build();
 	}
 
 	public static class InitializingPreUpdateEventListener implements PreUpdateEventListener {

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

@@ -13,6 +13,14 @@
 import org.junit.jupiter.api.TestInstance;
 import org.junit.jupiter.api.extension.ExtendWith;
 
+/// Applies standard set of JUnit Jupiter [extensions][org.junit.jupiter.api.extension.Extension]
+/// useful for all testing.
+///
+/// @see FailureExpectedExtension
+/// @see ExpectedExceptionExtension
+/// @see DialectFilterExtension
+///
+/// @author Steve Ebersole
 @Inherited
 @Target( ElementType.TYPE )
 @Retention( RetentionPolicy.RUNTIME )

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

@@ -12,9 +12,11 @@
 
 import org.hibernate.integrator.spi.Integrator;
 
-/**
- * Used to define the bootstrap ServiceRegistry to be used for testing.
- */
+/// Used to define the bootstrap [org.hibernate.boot.registry.BootstrapServiceRegistry] to be used for testing.
+///
+/// @see ServiceRegistryExtension
+///
+/// @author Steve Ebersole
 @Inherited
 @Target({ElementType.TYPE, ElementType.METHOD})
 @Retention(RetentionPolicy.RUNTIME)

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

@@ -7,9 +7,13 @@
 import org.hibernate.boot.registry.BootstrapServiceRegistry;
 import org.hibernate.boot.registry.BootstrapServiceRegistryBuilder;
 
-/**
- * Producer of BootstrapServiceRegistry
- */
+/// An alternative to [@BootstrapServiceRegistry][org.hibernate.testing.orm.junit.BootstrapServiceRegistry]
+/// for producing a [BootstrapServiceRegistry] when programmatic building is needed.
+///
+/// @see ServiceRegistryExtension
+///
+/// @author Steve Ebersole
 public interface BootstrapServiceRegistryProducer {
+	/// Produce the [BootstrapServiceRegistry]
 	BootstrapServiceRegistry produceServiceRegistry(BootstrapServiceRegistryBuilder builder);
 }

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

@@ -10,6 +10,17 @@
 
 import org.jboss.logging.Logger;
 
+/// Provides [ClassLoader] isolation for tests.
+/// Used in combination with the test class implementing the [IsolatedClassLoaderProvider], e.g.
+///
+/// ```java
+/// @ExtendWith(ClassLoadingIsolaterExtension.class)
+/// class SomeTestClass implements IsolatedClassLoaderProvider {
+///     ...
+/// }
+/// ```
+///
+/// @author Andrea Boriero
 public class ClassLoadingIsolaterExtension implements AfterEachCallback, BeforeEachCallback {
 
 	private static final Logger log = Logger.getLogger( ClassLoadingIsolaterExtension.class );

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

@@ -18,12 +18,10 @@
 
 import org.jboss.logging.Logger;
 
-/**
- * JUnit Jupiter extension used to add {@link RequiresDialect} and {@link SkipForDialect}
- * handling
- *
- * @author Steve Ebersole
- */
+/// JUnit Jupiter extension used to add [RequiresDialect] and [SkipForDialect]
+/// handling
+///
+/// @author Steve Ebersole
 public class DialectFilterExtension implements ExecutionCondition {
 	private static final Logger log = Logger.getLogger( DialectFilterExtension.class );
 

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

@@ -20,64 +20,26 @@
 
 import jakarta.persistence.SharedCacheMode;
 
-/**
- * @asciidoc
- *
- * Used to define the test model ({@link org.hibernate.boot.spi.MetadataImplementor})
- * to be used for testing.
- *
- * Can be used by itself, along with {@link DomainModelScopeAware}, to test the MetadataImplementor.  E.g.
- *
- * [source, java, indent=0]
- * ----
- * @TestDomain ( ... )
- * class MyTest implements TestDomainAware {
- *
- * 		@Test
- * 		public void doTheTest() {
- * 		    // use the injected MetadataImplementor
- * 		}
- *
- * 		private MetadataImplementor model;
- *
- * 		@Override
- * 		public void injectTestModelScope(MetadataImplementor model) {
- * 		 	this.model = model;
- * 		}
- * }
- * ----
- *
- *
- * Can optionally be used with {@link ServiceRegistry} to define the ServiceRegistry used to
- * build the MetadataImplementor (passed to
- * {@link org.hibernate.boot.MetadataSources#MetadataSources(org.hibernate.service.ServiceRegistry)}).
- *
- * [source, java, indent=0]
- * ----
- * @ServiceRegistry ( ... )
- * @TestDomain ( ... )
- * class MyTest implements TestDomainAware {
- *
- * 		@Test
- * 		public void doTheTest() {
- * 		    // use the injected MetadataImplementor
- * 		}
- *
- * 		private MetadataImplementor model;
- *
- * 		@Override
- * 		public void injectTestModelScope(MetadataImplementor model) {
- * 		 	this.model = model;
- * 		}
- * }
- * ----
- *
- * It can also be used in conjunction with {@link SessionFactory}
- *
- * @see DomainModelScopeAware
- *
- * @author Steve Ebersole
- */
+/// Used to define the [domain model][org.hibernate.boot.spi.MetadataImplementor] to be used for testing.
+/// Produces a [DomainModelScope] which can be injected via [JUnit ParameterResolver][DomainModelParameterResolver]
+/// or via [DomainModelScopeAware]; the ParameterResolver should be preferred.
+///
+/// ```java
+/// @DomainModel(annotatedClasses=SomeEntity.class)
+/// class SomeTest {
+///     @Test
+///     void testStuff(DomainModelScope modelScope) {
+///         ...
+///     }
+/// }
+/// ```
+///
+/// @see DomainModelExtension
+/// @see DomainModelScope
+/// @see DomainModelScopeAware
+/// @see DomainModelProducer
+///
+/// @author Steve Ebersole
 @Inherited
 @Target({ElementType.TYPE, ElementType.METHOD})
 @Retention(RetentionPolicy.RUNTIME)

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

@@ -32,15 +32,15 @@
 
 import jakarta.persistence.SharedCacheMode;
 
-/**
- * hibernate-testing implementation of a few JUnit5 contracts to support SessionFactory-based testing,
- * including argument injection (or see {@link DomainModelScopeAware})
- *
- * @see ServiceRegistryScope
- * @see DomainModelExtension
- *
- * @author Steve Ebersole
- */
+/// Support for defining the [domain model][MetadataImplementor] used in a test.
+///
+/// @see DomainModel
+/// @see DomainModelFunctionalTesting
+/// @see DomainModelProducer
+///
+/// @implNote Leverages the [service registry][ServiceRegistryScope] defined using the [ServiceRegistryExtension].
+///
+/// @author Steve Ebersole
 public class DomainModelExtension
 		implements TestInstancePostProcessor, BeforeEachCallback, TestExecutionExceptionHandler {
 

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

@@ -13,9 +13,26 @@
 import org.junit.jupiter.api.TestInstance;
 import org.junit.jupiter.api.extension.ExtendWith;
 
-/**
- * @author Steve Ebersole
- */
+/// Used in conjunction with [DomainModelProducer] to behave
+/// as if [@DomainModel][DomainModel] were used.  E.g.
+///
+/// ```java
+/// @DomainModelFunctionalTesting
+/// class SomeTest implements DomainModelProducer {
+///     @Override
+///     MetadataImplementor produceModel(StandardServiceRegistry serviceRegistry) {
+/// 	}
+///
+///     @Test
+///     void testStuff(DomainModelScope modelScope) {
+///         ...
+///     }
+///
+///     ...
+/// }
+/// ```
+///
+/// @author Steve Ebersole
 @Inherited
 @Retention( RetentionPolicy.RUNTIME )
 @Target({ElementType.TYPE, ElementType.METHOD})

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

@@ -11,9 +11,10 @@
 import org.junit.jupiter.api.extension.ParameterResolutionException;
 import org.junit.jupiter.api.extension.ParameterResolver;
 
-/**
- * @author Steve Ebersole
- */
+/// ParameterResolver for [DomainModelExtension], capable of resolving
+/// either [DomainModelScope] or [MetadataImplementor].
+///
+/// @author Steve Ebersole
 public class DomainModelParameterResolver implements ParameterResolver {
 	@Override
 	public boolean supportsParameter(