Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SUREFIRE-2095] Fork crash doesn't fail build with -Dmaven.test.failure.ignore=true when run with failsafe #545

Merged
merged 1 commit into from
Feb 3, 2023

Conversation

br0nstein
Copy link
Contributor

@br0nstein br0nstein commented Jun 7, 2022

When maven.test.failure.ignore is enabled, a test that crashes the JVM (e.g. that causes an OOM, with -XX:+CrashOnOutOfMemoryError) currently does not cause a build failure. This is perhaps the right behavior but is an issue in a CI setting because the following:

  1. No failsafe-reports/TEST-*.xml file is created that corresponds to the test that crashed.
  2. No failsafe-reports/TEST-*.xml files are created for all the tests that did not run (because they were to run after the crashed test in that same forked process).
    Because of that, in a Jenkins setting, the Jenkins Junit plugin does not identify any test failures and the build is marked successful instead of unstable. The forked process crash is only identified in the failsafe-summary XML (in the failureMessage) which AFAIK the Junit plugin does not parse to drive the build status.

This PR ensures that whether test failures are configured to be ignored or not, such a crash in the forked process by the failsafe plugin will always fail the build, to match the new behavior for the surefire plugin in SUREFIRE-1426.

This PR updates the VerifyMojo to pass a SurefireBooterForkException (deserialized from the failureMessage output to the summary XML from the IntegrationTestMojo run prior) to reportExecution so the build is terminated with a MojoExecutionException the same way as it is when tests are run by the surefire plugin (AbstractSurefireMojo).

See 6e60b03 for the corresponding fix for the surefire plugin (SUREFIRE-1426), that this leverages.

Following this checklist to help us incorporate your
contribution quickly and easily:

  • Make sure there is a JIRA issue filed
    for the change (usually before you start working on it). Trivial changes like typos do not
    require a JIRA issue. Your pull request should address just this issue, without
    pulling in other changes.
  • Each commit in the pull request should have a meaningful subject line and body.
  • Format the pull request title like [SUREFIRE-XXX] - Fixes bug in ApproximateQuantiles,
    where you replace SUREFIRE-XXX with the appropriate JIRA issue. Best practice
    is to use the JIRA issue title in the pull request title and in the first line of the
    commit message.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Run mvn clean install to make sure basic checks pass. A more thorough check will
    be performed on your pull request automatically.
  • You have run the integration tests successfully (mvn -Prun-its clean install).

If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.

To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.

…re.ignore=true when run with failsafe

Verify goal should fail when test summary indicates a SurefireBooterForkException occurred
@olamy olamy added the bug label Jun 8, 2022
@br0nstein
Copy link
Contributor Author

br0nstein commented Jun 8, 2022

@olamy I updated the PR description to add some clarification. I don't think this is really the best solution but I did it this way to align with what you and @Tibor17 agreed on for surefire-1426.

I think ideally for both surefire and failsafe the build succeeds (as documented for maven.test.failure.ignore), however somewhere in ForkStarter when we see the non-zero exit code we make sure to create the TEST-*.xml file. For the case of a crash starting the JVM, from debugging I see that forkClient.hasTestsInProgress() is false. So not exactly sure what to do there - is it totally wrong to use the scanResult.classes to identify which files to create? (That said it just has simple class names.) Since these tests weren't at fault though it might make sense to create a TEST file for the running module (using groupId+artifactId)?
However, for the case where a test was running that crashed the JVM, we do have the full class name in forkClient.testsInProgress()and could use that directly to create the TEST-*.xml file. I believe we do not need to populate the individual test cases in the XML - perhaps it isn't well documented but I see the Jenkins Junit plugin for one checks for the presence of an error testSuite element.

@Tibor17 Tibor17 self-requested a review June 10, 2022 00:03
@Tibor17
Copy link
Contributor

Tibor17 commented Jun 10, 2022

@br0nstein
Thx for the fix in the verifier mojo.
I admit the commit 6e60b03 was not done so well. The situation with XML reports is even more complicated if you have forkCount greater than 1.
Additionally, I think in Jira 1426 we touched the discussion with the non-zero exit where the exit on-jvm-startup is different situation from on-test-run-jvm.
Let's continue and discuss it on tomorrow.

@br0nstein
Copy link
Contributor Author

@Tibor17 thanks please let me know how we can go from here to get this problem fixed. Should we try to update the test to actually crash the JVM at runtime rather than cause JVM startup to fail in case that were to be caught by failsafe differently? Not sure if there are any ripe unpatched JVM bugs that we could utilize, heh.

Want to double check that we do want to pursue this approach of causing the verify phase to fail rather than treat this like non-crashing failing tests with test.failure.ignore enabled, by writing out some test result XML that Jenkins/etc could pick up to treat as "unstable."

@olamy olamy merged commit 59e096d into apache:master Feb 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants