back-port JUnit5 based testing support

Author: sebersole

documentation/documentation.gradle

@@ -216,10 +216,10 @@ task buildTutorialZip(type: Zip) {
 	from 'src/main/asciidoc/quickstart/tutorials'
 	destinationDir = tasks.renderGettingStartedGuides.outputDir
 	archiveName = 'hibernate-tutorials.zip'
-	expand(
+ 	expand(
 			version: project.version,
 			slf4j: "1.7.5",
-			junit: project.junitVersion,
+			junit: project.junit4Version,
 			h2: project.h2Version
 	)
 }

gradle/libraries.gradle

@@ -8,8 +8,10 @@
 // build a map of the dependency artifacts to use.  Allows centralized definition of the version of artifacts to
 // use.  In that respect it serves a role similar to <dependencyManagement> in Maven
 ext {
+    junit5Version = '5.8.2'
+    junitVintageVersion = junit5Version
+    junit4Version = '4.13.2'
 
-    junitVersion = '4.13.2'
     h2Version = '1.4.197'
     bytemanVersion = '4.0.16' //Compatible with JDK 17
     jnpVersion = '5.0.6.CR1'
@@ -116,8 +118,14 @@ ext {
 
             // ~~~~~~~~~~~~~~~~~~~~~~~~~~ testing
 
+            junit5_api:     "org.junit.jupiter:junit-jupiter-api:${junit5Version}",
+            junit5_jupiter: "org.junit.jupiter:junit-jupiter-engine:${junit5Version}",
+            junit5_params : "org.junit.jupiter:junit-jupiter-params:${junit5Version}",
+            junit:          "junit:junit:${junit4Version}",
+            junit5_vintage: "org.junit.vintage:junit-vintage-engine:${junitVintageVersion}",
+
             log4j2:          "org.apache.logging.log4j:log4j-core:2.17.1",
-            junit:           "junit:junit:${junitVersion}",
+
             byteman:         "org.jboss.byteman:byteman:${bytemanVersion}",
             byteman_install: "org.jboss.byteman:byteman-install:${bytemanVersion}",
             byteman_bmunit:  "org.jboss.byteman:byteman-bmunit:${bytemanVersion}",

hibernate-core/src/main/java/org/hibernate/internal/util/ReflectHelper.java

@@ -435,7 +435,7 @@ private static Field locateField(Class clazz, String propertyName) {
 		}
 	}
 
-	private static boolean isStaticField(Field field) {
+	public static boolean isStaticField(Field field) {
 		return field != null && ( field.getModifiers() & Modifier.STATIC ) == Modifier.STATIC;
 	}
 

hibernate-core/src/main/java/org/hibernate/sql/JoinType.java

@@ -13,21 +13,28 @@
  */
 
 public enum JoinType {
-	NONE( -666 ),
-	INNER_JOIN( 0 ),
-	LEFT_OUTER_JOIN( 1 ),
-	RIGHT_OUTER_JOIN( 2 ),
-	FULL_JOIN( 4 );
-	private int joinTypeValue;
-
-	JoinType(int joinTypeValue) {
+	NONE( -666, null ),
+	INNER_JOIN( 0, "inner" ),
+	LEFT_OUTER_JOIN( 1, "left" ),
+	RIGHT_OUTER_JOIN( 2, "right" ),
+	FULL_JOIN( 4, "full" );
+
+	private final int joinTypeValue;
+	private final String sqlText;
+
+	JoinType(int joinTypeValue, String sqlText) {
 		this.joinTypeValue = joinTypeValue;
+		this.sqlText = sqlText;
 	}
 
 	public int getJoinTypeValue() {
 		return joinTypeValue;
 	}
 
+	public String getSqlText() {
+		return sqlText;
+	}
+
 	public static JoinType parse(int joinType) {
 		if ( joinType < 0 ) {
 			return NONE;

hibernate-core/src/main/java/org/hibernate/tool/schema/Action.java

@@ -76,6 +76,14 @@ public enum Action {
 		this.externalHbm2ddlName = externalHbm2ddlName;
 	}
 
+	public String getExternalJpaName() {
+		return externalJpaName;
+	}
+
+	public String getExternalHbm2ddlName() {
+		return externalHbm2ddlName;
+	}
+
 	@Override
 	public String toString() {
 		return getClass().getSimpleName() + "(externalJpaName=" + externalJpaName + ", externalHbm2ddlName=" + externalHbm2ddlName + ")";

hibernate-core/src/main/java/org/hibernate/tool/schema/spi/SchemaManagementToolCoordinator.java

@@ -7,7 +7,9 @@
 package org.hibernate.tool.schema.spi;
 
 import java.util.EnumSet;
+import java.util.HashSet;
 import java.util.Map;
+import java.util.Set;
 
 import org.hibernate.boot.Metadata;
 import org.hibernate.boot.registry.classloading.spi.ClassLoaderService;
@@ -41,6 +43,8 @@
 import static org.hibernate.cfg.AvailableSettings.JAKARTA_HBM2DDL_SCRIPTS_ACTION;
 import static org.hibernate.cfg.AvailableSettings.JAKARTA_HBM2DDL_SCRIPTS_CREATE_TARGET;
 import static org.hibernate.cfg.AvailableSettings.JAKARTA_HBM2DDL_SCRIPTS_DROP_TARGET;
+import static org.hibernate.internal.log.DeprecationLogger.DEPRECATION_LOGGER;
+import static org.hibernate.internal.util.NullnessHelper.coalesceSuppliedValues;
 
 /**
  * Responsible for coordinating SchemaManagementTool execution(s) for auto-tooling whether
@@ -527,27 +531,71 @@ public Action getScriptAction() {
 		}
 
 		public static ActionGrouping interpret(Map configurationValues) {
-			Object databaseActionSetting = configurationValues.get( HBM2DDL_DATABASE_ACTION );
-			Object scriptsActionSetting = configurationValues.get( HBM2DDL_SCRIPTS_ACTION );
-			if ( databaseActionSetting == null ) {
-				databaseActionSetting = configurationValues.get( JAKARTA_HBM2DDL_DATABASE_ACTION );
-			}
-			if ( scriptsActionSetting == null ) {
-				scriptsActionSetting = configurationValues.get( JAKARTA_HBM2DDL_SCRIPTS_ACTION );
-			}
-			// interpret the JPA settings first
-			Action databaseAction = Action.interpretJpaSetting( databaseActionSetting );
-			Action scriptAction = Action.interpretJpaSetting( scriptsActionSetting );
-
-			// if no JPA settings were specified, look at the legacy HBM2DDL_AUTO setting...
-			if ( databaseAction == Action.NONE && scriptAction == Action.NONE ) {
-				final Action hbm2ddlAutoAction = Action.interpretHbm2ddlSetting( configurationValues.get( HBM2DDL_AUTO ) );
-				if ( hbm2ddlAutoAction != Action.NONE ) {
-					databaseAction = hbm2ddlAutoAction;
+			// default to the JPA settings
+			Action databaseActionToUse = determineJpaDbActionSetting( configurationValues );
+			Action scriptActionToUse = determineJpaScriptActionSetting( configurationValues );
+			Action autoAction = determineAutoSettingImpliedAction( configurationValues, null );
+
+			if ( databaseActionToUse == null && scriptActionToUse == null ) {
+				// no JPA (jakarta nor javax) settings were specified, use the legacy Hibernate
+				// `hbm2ddl.auto` setting to possibly set the database-action
+				if ( autoAction != null ) {
+					databaseActionToUse = autoAction;
 				}
 			}
 
-			return new ActionGrouping( databaseAction, scriptAction );
+			if ( databaseActionToUse == null ) {
+				databaseActionToUse = Action.NONE;
+			}
+
+			if ( scriptActionToUse == null ) {
+				scriptActionToUse = Action.NONE;
+			}
+
+			if ( databaseActionToUse == Action.NONE &&  scriptActionToUse == Action.NONE ) {
+				log.debugf( "No schema actions specified" );
+			}
+
+			return new ActionGrouping( databaseActionToUse, scriptActionToUse );
+		}
+
+		private static Action determineJpaDbActionSetting(Map<?,?> configurationValues) {
+			final Object scriptsActionSetting = coalesceSuppliedValues(
+					() -> configurationValues.get( JAKARTA_HBM2DDL_DATABASE_ACTION ),
+					() -> {
+						final Object setting = configurationValues.get( HBM2DDL_DATABASE_ACTION );
+						if ( setting != null ) {
+							DEPRECATION_LOGGER.deprecatedSetting( HBM2DDL_DATABASE_ACTION, JAKARTA_HBM2DDL_DATABASE_ACTION );
+						}
+						return setting;
+					}
+			);
+
+			return scriptsActionSetting == null ? null : Action.interpretJpaSetting( scriptsActionSetting );
+		}
+
+		private static Action determineJpaScriptActionSetting(Map<?,?> configurationValues) {
+			final Object scriptsActionSetting = coalesceSuppliedValues(
+					() -> configurationValues.get( JAKARTA_HBM2DDL_SCRIPTS_ACTION ),
+					() -> {
+						final Object setting = configurationValues.get( HBM2DDL_SCRIPTS_ACTION );
+						if ( setting != null ) {
+							DEPRECATION_LOGGER.deprecatedSetting( HBM2DDL_SCRIPTS_ACTION, JAKARTA_HBM2DDL_SCRIPTS_ACTION );
+						}
+						return setting;
+					}
+			);
+
+			return scriptsActionSetting == null ? null : Action.interpretJpaSetting( scriptsActionSetting );
+		}
+
+		public static Action determineAutoSettingImpliedAction(Map<?,?> settings, Action defaultValue) {
+			final Object autoActionSetting = settings.get( HBM2DDL_AUTO );
+			if ( autoActionSetting == null ) {
+				return defaultValue;
+			}
+
+			return Action.interpretHbm2ddlSetting( autoActionSetting );
 		}
 	}
 }

hibernate-testing/hibernate-testing.gradle

@@ -13,12 +13,22 @@ apply from: rootProject.file( 'gradle/published-java-module.gradle' )
 dependencies {
     compile project( ':hibernate-core' )
     compile( libraries.jta )
-    compile( libraries.junit )
+
+    compile libraries.junit
+    compile libraries.junit5_api
+    compile libraries.junit5_params
+
+    compile libraries.assertj
+
+    compile libraries.log4j2
+
+    compile 'javax.money:money-api:1.0.1'
+    compile 'org.javamoney:moneta:1.1'
+
     compile( libraries.byteman )
     compile( libraries.byteman_install )
     compile( libraries.byteman_bmunit )
     compile( libraries.xapool )
-    compile( libraries.log4j2 )
     compile( libraries.jboss_tx_spi ) {
         transitive=false;
     }

hibernate-testing/src/main/java/org/hibernate/testing/boot/ExtraJavaServicesClassLoaderService.java

@@ -0,0 +1,73 @@
+/*
+ * Hibernate, Relational Persistence for Idiomatic Java
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later
+ * See the lgpl.txt file in the root directory or http://www.gnu.org/licenses/lgpl-2.1.html
+ */
+package org.hibernate.testing.boot;
+
+import java.lang.reflect.InvocationTargetException;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.List;
+
+import org.hibernate.boot.registry.classloading.internal.ClassLoaderServiceImpl;
+
+/**
+ * @author Steve Ebersole
+ */
+public class ExtraJavaServicesClassLoaderService extends ClassLoaderServiceImpl {
+	private final List<JavaServiceDescriptor<?>> extraJavaServices;
+
+	public ExtraJavaServicesClassLoaderService(List<JavaServiceDescriptor<?>> extraJavaServices) {
+		this.extraJavaServices = extraJavaServices;
+	}
+
+	@Override
+	public <S> Collection<S> loadJavaServices(Class<S> serviceContract) {
+		final Collection<S> baseServices = super.loadJavaServices( serviceContract );
+		final List<S> services = new ArrayList<>( baseServices );
+
+		applyExtraJavaServices( serviceContract, services );
+
+		return services;
+	}
+
+	private <S> void applyExtraJavaServices(Class<S> serviceContract, List<S> services) {
+		extraJavaServices.forEach(
+				(javaServiceDescriptor) -> {
+					if ( serviceContract.isAssignableFrom( javaServiceDescriptor.role ) ) {
+						try {
+							final Object serviceInstance = javaServiceDescriptor.impl.getDeclaredConstructor().newInstance();
+							//noinspection unchecked
+							services.add( (S) serviceInstance );
+						}
+						catch (NoSuchMethodException | IllegalAccessException e) {
+							throw new RuntimeException( "Unable to access constructor for specified 'extra' Java service : " + javaServiceDescriptor.impl.getName(), e );
+						}
+						catch (InstantiationException | InvocationTargetException e) {
+							throw new RuntimeException( "Unable to instantiate specified 'extra' Java service : " + javaServiceDescriptor.impl.getName(), e );
+						}
+					}
+				}
+		);
+	}
+
+	public static class JavaServiceDescriptor<ROLE> {
+		private final Class<ROLE> role;
+		private final Class<? extends ROLE> impl;
+
+		public JavaServiceDescriptor(Class<ROLE> role, Class<? extends ROLE> impl) {
+			this.role = role;
+			this.impl = impl;
+		}
+
+		public Class<ROLE> getRole() {
+			return role;
+		}
+
+		public Class<? extends ROLE> getImpl() {
+			return impl;
+		}
+	}
+}