Stop logging exceptions thrown from ExtensionContext.close()

marcphilipp · marcphilipp · commit 9af6ca4ba66e · 2023-10-13T15:27:49.000+02:00
Prior to this commit such exceptions were logged and rethrown which caused them to be reported twice: once in the log and once as part of the test failure. Fixes #3422.
diff --git a/junit-jupiter-engine/src/main/java/org/junit/jupiter/engine/execution/JupiterEngineExecutionContext.java b/junit-jupiter-engine/src/main/java/org/junit/jupiter/engine/execution/JupiterEngineExecutionContext.java
@@ -53,8 +53,7 @@ public void close() throws Exception {
 				((AutoCloseable) extensionContext).close();
 			}
 			catch (Exception e) {
-				logger.error(e, () -> "Caught exception while closing extension context: " + extensionContext);
-				throw e;
+				throw new JUnitException("Failed to close extension context", e);
 			}
 		}
 	}
diff --git a/junit-jupiter-engine/src/test/java/org/junit/jupiter/api/extension/CloseableResourceIntegrationTests.java b/junit-jupiter-engine/src/test/java/org/junit/jupiter/api/extension/CloseableResourceIntegrationTests.java
@@ -15,6 +15,7 @@
 import static org.junit.platform.testkit.engine.EventConditions.finishedWithFailure;
 import static org.junit.platform.testkit.engine.EventConditions.reportEntry;
 import static org.junit.platform.testkit.engine.EventConditions.test;
+import static org.junit.platform.testkit.engine.TestExecutionResultConditions.cause;
 import static org.junit.platform.testkit.engine.TestExecutionResultConditions.message;
 import static org.junit.platform.testkit.engine.TestExecutionResultConditions.suppressed;
 
@@ -57,7 +58,10 @@ void exceptionsDuringCloseAreReportedAsSuppressed() {
 					test(), //
 					finishedWithFailure( //
 						message("Exception in test"), //
-						suppressed(0, message("Exception in onClose")))));
+						suppressed(0, //
+							message("Failed to close extension context"), //
+							cause(message("Exception in onClose")) //
+						))));
 	}
 
 	@ExtendWith(ThrowingOnCloseExtension.class)
diff --git a/junit-jupiter-engine/src/test/java/org/junit/jupiter/engine/execution/JupiterEngineExecutionContextTests.java b/junit-jupiter-engine/src/test/java/org/junit/jupiter/engine/execution/JupiterEngineExecutionContextTests.java
@@ -17,15 +17,10 @@
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.withSettings;
 
-import java.util.logging.Level;
-import java.util.logging.LogRecord;
-
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtensionContext;
-import org.junit.jupiter.api.fixtures.TrackLogRecords;
 import org.junit.jupiter.engine.config.JupiterConfiguration;
 import org.junit.jupiter.engine.extension.MutableExtensionRegistry;
-import org.junit.platform.commons.logging.LogRecordListener;
 import org.junit.platform.engine.EngineExecutionListener;
 
 /**
@@ -89,23 +84,21 @@ void canOverrideAttributeWhenContextIsExtended() {
 	}
 
 	@Test
-	@TrackLogRecords
-	void closeAttemptExceptionWillBeThrownDownTheCallStack(LogRecordListener logRecordListener) throws Exception {
+	void closeAttemptExceptionWillBeThrownDownTheCallStack() throws Exception {
 		ExtensionContext failingExtensionContext = mock(ExtensionContext.class,
 			withSettings().extraInterfaces(AutoCloseable.class));
-		Exception expectedException = new Exception("test message");
-		doThrow(expectedException).when(((AutoCloseable) failingExtensionContext)).close();
+		Exception expectedCause = new Exception("test message");
+		doThrow(expectedCause).when(((AutoCloseable) failingExtensionContext)).close();
 
 		JupiterEngineExecutionContext newContext = originalContext.extend() //
 				.withExtensionContext(failingExtensionContext) //
 				.build();
 
 		Exception actualException = assertThrows(Exception.class, newContext::close);
 
-		assertSame(expectedException, actualException);
-		assertThat(logRecordListener.stream(JupiterEngineExecutionContext.class, Level.SEVERE)) //
-				.extracting(LogRecord::getMessage) //
-				.containsOnly("Caught exception while closing extension context: " + failingExtensionContext);
+		assertThat(actualException) //
+				.hasMessage("Failed to close extension context") //
+				.hasCauseReference(expectedCause);
 	}
 
 }
diff --git a/junit-jupiter-engine/src/test/java/org/junit/jupiter/engine/extension/TempDirectoryPerDeclarationTests.java b/junit-jupiter-engine/src/test/java/org/junit/jupiter/engine/extension/TempDirectoryPerDeclarationTests.java
@@ -230,11 +230,14 @@ private void onlyAttemptsToDeleteUndeletablePathOnce(Class<? extends Undeletable
 				it -> Path.of(it.getKeyValuePairs().get(UndeletableTestCase.TEMP_DIR))).findAny().orElseThrow();
 
 		assertSingleFailedTest(results, //
-			instanceOf(IOException.class), //
-			message("Failed to delete temp directory " + tempDir.toAbsolutePath() + ". " + //
-					"The following paths could not be deleted (see suppressed exceptions for details): <root>, undeletable"), //
-			suppressed(0, instanceOf(DirectoryNotEmptyException.class)), //
-			suppressed(1, instanceOf(IOException.class), message("Simulated failure")));
+			cause( //
+				instanceOf(IOException.class), //
+				message("Failed to delete temp directory " + tempDir.toAbsolutePath() + ". " + //
+						"The following paths could not be deleted (see suppressed exceptions for details): <root>, undeletable"), //
+				suppressed(0, instanceOf(DirectoryNotEmptyException.class)), //
+				suppressed(1, instanceOf(IOException.class), message("Simulated failure")) //
+			) //
+		);
 	}
 
 	@Nested

Original file line number	Diff line number	Diff line change
`@@ -53,8 +53,7 @@ public void close() throws Exception {`
`53`	`53`	`((AutoCloseable) extensionContext).close();`
`54`	`54`	`}`
`55`	`55`	`catch (Exception e) {`
`56`		`- logger.error(e, () -> "Caught exception while closing extension context: " + extensionContext);`
`57`		`- throw e;`
	`56`	`+ throw new JUnitException("Failed to close extension context", e);`
`58`	`57`	`}`
`59`	`58`	`}`
`60`	`59`	`}`