Reliably expose nested cause exception message for PersistenceException

Issue: SPR-16559

(cherry picked from commit eb9c43d)

spring-core/src/test/java/org/springframework/core/NestedExceptionTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2015 the original author or authors.
+ * Copyright 2002-2018 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -44,19 +44,19 @@ public class NestedExceptionTests {
 		nex.printStackTrace(pw);
 		pw.flush();
 		String stackTrace = new String(baos.toByteArray());
-		assertFalse(stackTrace.indexOf(mesg) == -1);
+		assertTrue(stackTrace.contains(mesg));
 	}
 
 	@Test
 	public void nestedRuntimeExceptionWithRootCause() {
 		String myMessage = "mesg for this exception";
-		String rootCauseMesg = "this is the obscure message of the root cause";
-		Exception rootCause = new Exception(rootCauseMesg);
+		String rootCauseMsg = "this is the obscure message of the root cause";
+		Exception rootCause = new Exception(rootCauseMsg);
 		// Making a class abstract doesn't _really_ prevent instantiation :-)
 		NestedRuntimeException nex = new NestedRuntimeException(myMessage, rootCause) {};
 		assertEquals(nex.getCause(), rootCause);
-		assertTrue(nex.getMessage().indexOf(myMessage) != -1);
-		assertTrue(nex.getMessage().indexOf(rootCauseMesg) != -1);
+		assertTrue(nex.getMessage().contains(myMessage));
+		assertTrue(nex.getMessage().endsWith(rootCauseMsg));
 
 		// check PrintStackTrace
 		ByteArrayOutputStream baos = new ByteArrayOutputStream();
@@ -64,8 +64,8 @@ public class NestedExceptionTests {
 		nex.printStackTrace(pw);
 		pw.flush();
 		String stackTrace = new String(baos.toByteArray());
-		assertFalse(stackTrace.indexOf(rootCause.getClass().getName()) == -1);
-		assertFalse(stackTrace.indexOf(rootCauseMesg) == -1);
+		assertTrue(stackTrace.contains(rootCause.getClass().getName()));
+		assertTrue(stackTrace.contains(rootCauseMsg));
 	}
 
 	@Test
@@ -82,19 +82,19 @@ public class NestedExceptionTests {
 		nex.printStackTrace(pw);
 		pw.flush();
 		String stackTrace = new String(baos.toByteArray());
-		assertFalse(stackTrace.indexOf(mesg) == -1);
+		assertTrue(stackTrace.contains(mesg));
 	}
 
 	@Test
 	public void nestedCheckedExceptionWithRootCause() {
 		String myMessage = "mesg for this exception";
-		String rootCauseMesg = "this is the obscure message of the root cause";
-		Exception rootCause = new Exception(rootCauseMesg);
+		String rootCauseMsg = "this is the obscure message of the root cause";
+		Exception rootCause = new Exception(rootCauseMsg);
 		// Making a class abstract doesn't _really_ prevent instantiation :-)
 		NestedCheckedException nex = new NestedCheckedException(myMessage, rootCause) {};
 		assertEquals(nex.getCause(), rootCause);
-		assertTrue(nex.getMessage().indexOf(myMessage) != -1);
-		assertTrue(nex.getMessage().indexOf(rootCauseMesg) != -1);
+		assertTrue(nex.getMessage().contains(myMessage));
+		assertTrue(nex.getMessage().endsWith(rootCauseMsg));
 
 		// check PrintStackTrace
 		ByteArrayOutputStream baos = new ByteArrayOutputStream();
@@ -102,8 +102,8 @@ public class NestedExceptionTests {
 		nex.printStackTrace(pw);
 		pw.flush();
 		String stackTrace = new String(baos.toByteArray());
-		assertFalse(stackTrace.indexOf(rootCause.getClass().getName()) == -1);
-		assertFalse(stackTrace.indexOf(rootCauseMesg) == -1);
+		assertTrue(stackTrace.contains(rootCause.getClass().getName()));
+		assertTrue(stackTrace.contains(rootCauseMsg));
 	}
 
 }

spring-orm-hibernate5/src/main/java/org/springframework/orm/hibernate5/LocalSessionFactoryBuilder.java

@@ -427,8 +427,13 @@ public class LocalSessionFactoryBuilder extends Configuration {
 				throw new IllegalStateException("Interrupted during initialization of Hibernate SessionFactory", ex);
 			}
 			catch (ExecutionException ex) {
+				Throwable cause = ex.getCause();
+				if (cause instanceof HibernateException) {
+					// Rethrow a provider configuration exception (possibly with a nested cause) directly
+					throw (HibernateException) cause;
+				}
 				throw new IllegalStateException("Failed to asynchronously initialize Hibernate SessionFactory: " +
-						ex.getMessage(), ex.getCause());
+						ex.getMessage(), cause);
 			}
 		}
 	}

spring-orm/src/main/java/org/springframework/orm/jpa/AbstractEntityManagerFactoryBean.java

@@ -379,15 +379,37 @@ public abstract class AbstractEntityManagerFactoryBean implements
 	}
 
 	private EntityManagerFactory buildNativeEntityManagerFactory() {
-		EntityManagerFactory emf = createNativeEntityManagerFactory();
+		EntityManagerFactory emf;
+		try {
+			emf = createNativeEntityManagerFactory();
+		}
+		catch (PersistenceException ex) {
+			if (ex.getClass() == PersistenceException.class) {
+				// Plain PersistenceException wrapper for underlying exception?
+				// Make sure the nested exception message is properly exposed,
+				// along the lines of Spring's NestedRuntimeException.getMessage()
+				Throwable cause = ex.getCause();
+				if (cause != null) {
+					String message = ex.getMessage();
+					String causeString = cause.toString();
+					if (!message.endsWith(causeString)) {
+						throw new PersistenceException(message + "; nested exception is " + causeString, cause);
+					}
+				}
+			}
+			throw ex;
+		}
+
 		if (emf == null) {
 			throw new IllegalStateException(
 					"JPA PersistenceProvider returned null EntityManagerFactory - check your JPA provider setup!");
 		}
+
 		JpaVendorAdapter jpaVendorAdapter = getJpaVendorAdapter();
 		if (jpaVendorAdapter != null) {
 			jpaVendorAdapter.postProcessEntityManagerFactory(emf);
 		}
+
 		if (logger.isInfoEnabled()) {
 			logger.info("Initialized JPA EntityManagerFactory for persistence unit '" + getPersistenceUnitName() + "'");
 		}
@@ -414,6 +436,7 @@ public abstract class AbstractEntityManagerFactoryBean implements
 			ifcs.add(EntityManagerFactory.class);
 		}
 		ifcs.add(EntityManagerFactoryInfo.class);
+
 		try {
 			return (EntityManagerFactory) Proxy.newProxyInstance(this.beanClassLoader,
 					ClassUtils.toClassArray(ifcs), new ManagedEntityManagerFactoryInvocationHandler(this));
@@ -517,8 +540,13 @@ public abstract class AbstractEntityManagerFactoryBean implements
 				throw new IllegalStateException("Interrupted during initialization of native EntityManagerFactory", ex);
 			}
 			catch (ExecutionException ex) {
+				Throwable cause = ex.getCause();
+				if (cause instanceof PersistenceException) {
+					// Rethrow a provider configuration exception (possibly with a nested cause) directly
+					throw (PersistenceException) cause;
+				}
 				throw new IllegalStateException("Failed to asynchronously initialize native EntityManagerFactory: " +
-						ex.getMessage(), ex.getCause());
+						ex.getMessage(), cause);
 			}
 		}
 	}