Feature/generate report on interruption #397
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 3 commits
February 23, 2024 15:44
…teJUnitXML2ReportListener;
registered JVMExitHook as new shutdownHook in Testerra; removed deprecated Code in TesterraListener; added log message in ExecutionEndListener:
clemensgrosse
requested review from
mreiche,
martingrossmann,
gogro,
mbeuthan and
wolamms
as code owners
mreiche
previously approved these changes
Feb 26, 2024
|
The information that a test is crashed is never used. We should add a notice to the report. I think we can add something like that in if (contextController.getExecutionContext().isCrashed()) {
log().warn("Test execution was aborted. Test results may be imcomplete.", Loggable.prompt);
} |
martingrossmann
requested changes
Feb 26, 2024
core/src/main/java/eu/tsystems/mms/tic/testframework/common/JVMExitHook.java
Show resolved
Hide resolved
added log message in case of execution abortion in ExecutionEndListener;
|
As discussed please add a short note in documentation about this helpful feature. |
mreiche
previously approved these changes
Feb 29, 2024
added paragraph on aborted execution in overview.adoc; added screenshots report-ng-23.png, report-ng-24.png, report-ng-25.png; removed jvm-monitor section in execution.adoc; included new JVM section in index.adoc; updated jvm-monitor.adoc; added reference to ExecutionAbortionEvent
added 2 commits
February 29, 2024 13:20
…cated section aborted-execution.adoc; added new include in reports.adoc;
mreiche
reviewed
Feb 29, 2024
docs/src/docs/jvm/jvm-exit-hook.adoc
Outdated
| The `JVMExitHook` was integrated to achieve the generation of a report with Report-NG in case an <<#ExecutionAbortion, aborted test run>>. With the start of a test execution the `JVMExitHook` is added as a shutdown hook to the JVM. | ||
|
|
||
| When the JVM is about to stop, shutdown hooks are always called by default. This includes cases of abortion, all other system errors and normal finish. In the latter case a flag indicating an already created report is set true once in the process of the report generation. | ||
| To avoid overriding the already existing report, the `JVMExitHook` only triggers when this flag is false, as this is the only indicator of an unexpected exit and a missing report. It then sends the <<#ExecutionAbortEvent, ExecutionAbortEvent>>, which is then caught by the corresponding listeners creating a report. |
There was a problem hiding this comment.
Your link to ExecutionAbortEvent does not work anymore because it's an own chapter now. ;-)
mreiche
previously approved these changes
Mar 1, 2024
coorrect reference to link of abortion event in jvm-exit-hook.adoc;
martingrossmann
approved these changes
Mar 4, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Added mechanism to generate a report in case of unexpected abortion of test execution.
A ShutDownHook triggers on JVM finish in successful and failure cases. Report generation is then triggered within the Hook, if no report has been generated before. with sending a ExecutionAbortEvent.
Flag for generated report is set once only in ExecutionEndListener, in case of successful end of test execution (ExecutionFinishEvent received by the mentioned Listener).
Type of change
Checklist: