JUnit5 test runs with Gherkin scenarios have spinner after test completes

[incident-recipient]

Some users reported that gherkin scenario with tablular data render incorrectly in intelliJ. After the test finishes executing a node in the result tree continues to spin. This is likely an error in our implementation of JUnit5. We perhaps forgot to send a signal to alert the framework that the test completed.

[incident-recipient]

This isn't something we've been able to reproduce in the UAT tests for the PDSL framework itself, however we've seen it on some other tests that use webdriver.

It isn't clear why this would happen at a glance; PDSL sends no pass/fail signals to JUnit5 per-se. It simply throws an exception if something goes wrong.

Gemini made some suggestions to troubleshoot:

The Problem: Your extension might not be signaling the end of the entire test template execution correctly. JUnit 5 extensions have various lifecycle callbacks (e.g., BeforeAllCallback, AfterAllCallback, BeforeEachCallback, AfterEachCallback).

The Solution:
Carefully review the JUnit 5 Extension API documentation.
Ensure that any necessary cleanup or signaling logic in your extension is being executed at the appropriate time within the test template's lifecycle.
Pay close attention to how your extension interacts with the ExtensionContext. This context provides information about the current test execution and can be used to store and retrieve data. You might need to use the ExtensionContext to manage the state of the test template execution and signal its completion.
TestTemplateInvocationContextProvider:

The Problem: The way your TestTemplateInvocationContextProvider provides contexts might be affecting how the IDE interprets the test flow.

The Solution:
Double-check that your TestTemplateInvocationContextProvider is implemented correctly.
Ensure that the stream of TestTemplateInvocationContext objects it provides is correctly terminated.
The IDE might be relying on some internal mechanism within the TestTemplateInvocationContextProvider to determine the end of the test template execution.
JUnit 5 Internal Reporting:

The Problem: There might be some subtle nuances in how JUnit 5 internally reports the execution of test templates, and some IDEs might not be handling it perfectly.

The Solution:
JUnit 5 Issue Tracker: Check the JUnit 5 issue tracker to see if there are any existing bug reports or discussions related to test template reporting in IDEs. If you can't find anything, consider reporting your issue.
IDE-Specific Issues: It's also possible that the issue is specific to the IDE you're using. Check the issue tracker or support forums for your IDE.

[incident-recipient]

There is an odd behavior here.

If you select the node in IntelliJ that represents the method it shows the logs for all test cases that execute. When the bug occurs some of the child test cases showing a spinner have no logs at all. The tests execute, but it's as if they aren't associated with the nested node it represents.

In any case, having reproduced the issue we might be able to do something about it now.

[incident-recipient]

I noticed the spinner showed up on tests that had the same display name. When I gave each test a unique scenario name the error mostly went away. The test suite itself continued to have a spinner that never ended, but the child cases had no such problem.

I'm guessing the root issue is somewhere in PdslInvocationContext.java