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.

Sign up for GitHub

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

Jump to bottom

[JUnit Platform] Use EngineDiscoveryRequestResolver #2835

Draft
wants to merge 17 commits into
base: main
Choose a base branch
from
Draft

[JUnit Platform] Use EngineDiscoveryRequestResolver #2835

wants to merge 17 commits into from

Conversation

mpkorstanje
Copy link
Contributor

@mpkorstanje mpkorstanje commented Dec 16, 2023 •
edited
Loading

🤔 What's changed?

⚡️ What's your motivation?

Fully utilize the EngineDiscoveryRequestResolver API to reduce our own complexity (junit-team/junit5#3705, junit-team/junit5#3718)

🏷️ What kind of change is this?

  • 🏦 Refactoring/debt/DX (improvement to code design, tooling, documentation etc. without changing behaviour)

♻️ Anything particular you want feedback on?

📋 Checklist:

  • I agree to respect and uphold the Cucumber Community Code of Conduct
  • I've changed the behaviour of the code
    • I have added/updated tests to cover my changes.
  • My change requires a change to the documentation.
    • I have updated the documentation accordingly.
  • Users should know about my change
    • I have added an entry to the "Unreleased" section of the CHANGELOG, linking to this pull request.

@codecov Codecov
Copy link

codecov bot commented Dec 17, 2023 •
edited
Loading

Codecov Report

Attention: Patch coverage is 91.81034% with 19 lines in your changes missing coverage. Please review.

Project coverage is 84.86%. Comparing base (6549826) to head (b6ab3cb).
Report is 33 commits behind head on main.

❗ Current head b6ab3cb differs from pull request most recent head 294d880

Please upload reports for the commit 294d880 to get more accurate results.

Files Patch % Lines
...it/platform/engine/CucumberDiscoverySelectors.java 81.25% 9 Missing and 3 partials ⚠️
...ucumber/junit/platform/engine/FeatureResolver.java 95.65% 2 Missing and 3 partials ⚠️
...junit/platform/engine/PackageFilteringVisitor.java 81.81% 1 Missing and 1 partial ⚠️
Additional details and impacted files 
@@             Coverage Diff              @@
##               main    #2835      +/-   ##
============================================
+ Coverage     84.80%   84.86%   +0.06%     
+ Complexity     2728     2719       -9     
============================================
  Files           331      334       +3     
  Lines          9428     9569     +141     
  Branches        902      932      +30     
============================================
+ Hits           7995     8121     +126     
- Misses         1111     1118       +7     
- Partials        322      330       +8

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@mpkorstanje mpkorstanje mentioned this pull request Feb 20, 2024
Open
@mpkorstanje
Copy link
Contributor Author

The current implementation of the JUnit Platform Engine treats @SelectClasspathResource aimed at directories as if all resources in that directory should be considered. This is not the intended usage, for this @SelectPackages should be used.

Cucumbers documentation consistently uses @SelectClasspathResource.

This will become a problem if/when we start to use the EngineDiscoveryRequestResolver with (#2835, junit-team/junit5#3705, junit-team/junit5#3718) because @SelectClasspathResource will cause an exception to be thrown when used with a non-existing resource.

@mpkorstanje mpkorstanje mentioned this pull request Mar 8, 2024
Merged
@mpkorstanje mpkorstanje mentioned this pull request Oct 29, 2024
Merged
6 tasks
marcphilipp
marcphilipp reviewed Nov 4, 2024
View reviewed changes
...latform-engine/src/main/java/io/cucumber/junit/platform/engine/FeaturesPropertyResolver.java
"\n" +
"This is a work around for the limited JUnit 5 support in Maven and Gradle. " +
"Please request/upvote/sponsor/ect better support for JUnit 5 discovery selectors. " +
"For details see: https://github.com/cucumber/cucumber-jvm/pull/2498\n" +
Copy link

Choose a reason for hiding this comment

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

This should also be interesting for you (if/when it gets merged):
gradle/gradle#29535

marcphilipp
marcphilipp reviewed Nov 4, 2024
View reviewed changes
Copy link

@marcphilipp marcphilipp left a comment

Choose a reason for hiding this comment

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

Great to see this being used here now! 👍

cucumber-junit-platform-engine/src/main/java/io/cucumber/junit/platform/engine/IsFeature.java
class IsFeature implements Predicate<Resource> {
@Override
public boolean test(Resource resource) {
return resource.getUri().toString().endsWith(".feature");
Copy link

Choose a reason for hiding this comment

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

Wouldn't checking Resource.getName() suffice here?

...rm-engine/src/main/java/io/cucumber/junit/platform/engine/FeatureElementOrderingVisitor.java
Comment on lines +20 to +21
sortedChildren.forEach(descriptor::removeChild);
sortedChildren.forEach(descriptor::addChild);
Copy link

Choose a reason for hiding this comment

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

I wonder if we should introduce an TestDescriptor.orderChildren(UnaryOperator<TestDescriptor> orderer) method (or similar). We could also make use of that in Jupiter. 🤔

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@marcphilipp marcphilipp marcphilipp left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@mpkorstanje @marcphilipp