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-2065] Fix parameterized JUnit4 test reporting #608

Merged
merged 2 commits into from Feb 6, 2023

Conversation

andpab
Copy link
Contributor

@andpab andpab commented Feb 5, 2023

This is an adjusted PR based on #516 from chalmagr.

I kept the additional ITs exactly as written by chalmagr.
The fix itself is different. It's less invasive, doesn't require making changes to the expectations of any expecting tests or ITs.

The root cause of the bug is that the logic for determining hasParams only looks at methodSource.getMethodParameterTypes(). That's not correct for JUnit 4 Parameterized tests since they do not have a method parameter. In JUnit 4 the parameterization is handled on a level further up.

The fix corrects the logic for determining hasParams so that it also works for JUnit4. It relies on the fact that for JUnit 4 parameterized tests there is a container-type test identifier with the legacyReportingName [<index>] or [<displayName>] that has an empty source field in the test identifier hierarchy - between the test method and the test class.


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.

@jbonofre
Copy link
Member

jbonofre commented Feb 5, 2023

I'm reviewing and testing the PR. Thanks.

Copy link
Member

@jbonofre jbonofre left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, I'm just testing with junit5-vintage-engine to be sure it behaves well too.

@jbonofre
Copy link
Member

jbonofre commented Feb 6, 2023

@olamy ^^ can you please take a look and eventually merge ? A new surefire-plugin release would be great as well, I can prepare it if you want.

@olamy olamy added the bug label Feb 6, 2023
@olamy olamy merged commit 11d0541 into apache:master Feb 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
4 participants