Issue 3054 avoiding inclusion of the suppressed PreconditionViolation…

[BassemElMasry]

…Exception in the stacktrace

Overview

This PR is aimed to resolve the issue described here Issue 3054

Shall we include a test under ParameterizedTestIntegrationTests to ensure that suppressed exceptions are not included? I have tried but could not replicate the exact issue mentioned for static initializer so maybe we can take another approach like violating a specific PreCondition and ensure that the default one under the stream.close is not included in the suppressed exceptions.

I hereby agree to the terms of the JUnit Contributor License Agreement.

---

Definition of Done

• There are no TODOs left in the code
• Method preconditions are checked and documented in the method's Javadoc
• Coding conventions (e.g. for logging) have been followed
• Change is covered by automated tests including corner cases, errors, and exception handling
• Public API has Javadoc and @API annotations
• Change is documented in the User Guide and Release Notes

[marcphilipp]

Shall we include a test under ParameterizedTestIntegrationTests to ensure that suppressed exceptions are not included? I have tried but could not replicate the exact issue mentioned for static initializer so maybe we can take another approach like violating a specific PreCondition and ensure that the default one under the stream.close is not included in the suppressed exceptions.

I've added a test in cb3d5d6.

[marcphilipp]

I don't think we should generally discard all Throwables thrown from providers' onClose callbacks. The exception could contain an important hint so adding it as a suppressed exception could be useful. Therefore, I think we should introduce a custom TemplateInvocationValidationException (in org.junit.jupiter.api.extension) that extends JUnitException and throw it from here:

junit5/junit-jupiter-params/src/main/java/org/junit/jupiter/params/ParameterizedInvocationContextProvider.java

Lines 51 to 52 in c4faa6c

	Preconditions.condition(invocationCount.get() > 0 || declarationContext.isAllowingZeroInvocations(),
	() -> String.format("Configuration error: You must configure at least one set of arguments for this @%s", declarationContext.getAnnotationName())));

[marcphilipp]

@BassemElMasry Do you have time to make the change or should I take it from here?

[BassemElMasry]

Hello @marcphilipp , I can finalize it this week. Sorry I did not see the comments earlier. If this is not feasible for you, feel free to finalize it of course.

[marcphilipp]

No worries! Finalizing it this week is fine, please go ahead! 🙂

[BassemElMasry]

Hey @marcphilipp unfortunately I had another medical emergency and just came out of the hospital yesterday. Can you please take care of this as I am very sick? 😭 I am so sorry for the delay I caused.