[JUnit Platform] Use EngineDiscoveryRequestResolver

CHANGELOG.md

@@ -10,6 +10,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+- [JUnit Platform Engine] Added option to include a parameterized scenario name only if the scenario is parameterized ([#2835](https://github.com/cucumber/cucumber-jvm/pull/2835) M.P. Korstanje)
+- [JUnit Platform Engine] Added option order features and scenarios ([#2835](https://github.com/cucumber/cucumber-jvm/pull/2835) M.P. Korstanje)
+- [JUnit Platform Engine] Log warnings when a classpath resource selector is (e.g. `@SelectClasspathResource`) is used to select a directory. ([#2835](https://github.com/cucumber/cucumber-jvm/pull/2835) M.P. Korstanje)
+
+### Changed
+- [JUnit Platform Engine] Use JUnit's `EngineDiscoveryRequestResolver` to resolve classpath based resources. ([#2835](https://github.com/cucumber/cucumber-jvm/pull/2835) M.P. Korstanje)
 
 ## [7.22.0] - 2025-04-05
 ### Changed

cucumber-core/src/main/java/io/cucumber/core/options/Constants.java

@@ -42,7 +42,8 @@ public final class Constants {
      * Valid values are {@code lexical}, {@code reverse}, {@code random} or
      * {@code random:[seed]}.
      * <p>
-     * By default features are executed in lexical file name order
+     * By default, features are executed in lexical file name order and
+     * scenarios in a feature from top to bottom.
      */
     public static final String EXECUTION_ORDER_PROPERTY_NAME = "cucumber.execution.order";
 

cucumber-core/src/main/java/io/cucumber/core/order/StandardPickleOrders.java

@@ -8,8 +8,9 @@
 
 public final class StandardPickleOrders {
 
-    private static final Comparator<Pickle> pickleUriComparator = Comparator.comparing(Pickle::getUri)
-            .thenComparing(pickle -> pickle.getLocation().getLine());
+    private static final Comparator<Pickle> pickleUriComparator = Comparator
+            .comparing(Pickle::getUri)
+            .thenComparing(Pickle::getLocation);
 
     private StandardPickleOrders() {
 

cucumber-gherkin-messages/src/main/java/io/cucumber/core/gherkin/messages/GherkinMessagesExample.java

@@ -4,6 +4,7 @@
 import io.cucumber.plugin.event.Location;
 import io.cucumber.plugin.event.Node;
 
+import java.net.URI;
 import java.util.Optional;
 
 final class GherkinMessagesExample implements Node.Example {
@@ -20,6 +21,11 @@ final class GherkinMessagesExample implements Node.Example {
         this.rowIndex = rowIndex;
     }
 
+    @Override
+    public URI getUri() {
+        return parent.getUri();
+    }
+
     @Override
     public Location getLocation() {
         return GherkinMessagesLocation.from(tableRow.getLocation());

cucumber-gherkin-messages/src/main/java/io/cucumber/core/gherkin/messages/GherkinMessagesExamples.java

@@ -3,6 +3,7 @@
 import io.cucumber.plugin.event.Location;
 import io.cucumber.plugin.event.Node;
 
+import java.net.URI;
 import java.util.Collection;
 import java.util.List;
 import java.util.Optional;
@@ -31,6 +32,11 @@ public Collection<Example> elements() {
         return children;
     }
 
+    @Override
+    public URI getUri() {
+        return parent.getUri();
+    }
+
     @Override
     public Location getLocation() {
         return location;

cucumber-gherkin-messages/src/main/java/io/cucumber/core/gherkin/messages/GherkinMessagesRule.java

@@ -4,6 +4,7 @@
 import io.cucumber.plugin.event.Location;
 import io.cucumber.plugin.event.Node;
 
+import java.net.URI;
 import java.util.Collection;
 import java.util.List;
 import java.util.Optional;
@@ -42,6 +43,11 @@ public Collection<Node> elements() {
         return children;
     }
 
+    @Override
+    public URI getUri() {
+        return parent.getUri();
+    }
+
     @Override
     public Location getLocation() {
         return GherkinMessagesLocation.from(rule.getLocation());

cucumber-gherkin-messages/src/main/java/io/cucumber/core/gherkin/messages/GherkinMessagesScenario.java

@@ -3,6 +3,7 @@
 import io.cucumber.plugin.event.Location;
 import io.cucumber.plugin.event.Node;
 
+import java.net.URI;
 import java.util.Optional;
 
 final class GherkinMessagesScenario implements Node.Scenario {
@@ -20,6 +21,11 @@ public Optional<Node> getParent() {
         return Optional.of(parent);
     }
 
+    @Override
+    public URI getUri() {
+        return parent.getUri();
+    }
+
     @Override
     public Location getLocation() {
         return GherkinMessagesLocation.from(scenario.getLocation());

cucumber-gherkin-messages/src/main/java/io/cucumber/core/gherkin/messages/GherkinMessagesScenarioOutline.java

@@ -3,6 +3,7 @@
 import io.cucumber.plugin.event.Location;
 import io.cucumber.plugin.event.Node;
 
+import java.net.URI;
 import java.util.Collection;
 import java.util.List;
 import java.util.Optional;
@@ -34,6 +35,11 @@ public Collection<Examples> elements() {
         return children;
     }
 
+    @Override
+    public URI getUri() {
+        return parent.getUri();
+    }
+
     @Override
     public Location getLocation() {
         return GherkinMessagesLocation.from(scenario.getLocation());

cucumber-gherkin/src/main/java/io/cucumber/core/gherkin/Feature.java

@@ -2,7 +2,6 @@
 
 import io.cucumber.plugin.event.Node;
 
-import java.net.URI;
 import java.util.List;
 
 public interface Feature extends Node.Feature {
@@ -11,8 +10,6 @@ public interface Feature extends Node.Feature {
 
     List<Pickle> getPickles();
 
-    URI getUri();
-
     String getSource();
 
     Iterable<?> getParseEvents();

cucumber-junit-platform-engine/README.md

@@ -26,7 +26,8 @@ like this:
 
 ```mermaid
 erDiagram
-    "IDE, Maven, Gradle or Console Launcher" ||--|{ "JUnit Platform" : "requests discovery and execution"
+    "IDE" ||--|{ "JUnit Platform" : "requests discovery and execution"
+    "Maven or Gradle" ||--|{ "JUnit Platform" : "requests discovery and execution"
     "Console Launcher" ||--|{ "JUnit Platform" : "requests discovery and execution"
     "JUnit Platform" ||--|{ "Cucumber Test Engine": "forwards request"
     "JUnit Platform" ||--|{ "Jupiter Test Engine": "forwards request"
@@ -209,11 +210,12 @@ different configurations. Conceptually this looks like this:
 
 ```mermaid
 erDiagram
-    "IDE, Maven, Gradle or Console Launcher" ||--|{ "JUnit Platform" : "requests discovery and execution"
+    "IDE" ||--|{ "JUnit Platform" : "requests discovery and execution"
+    "Maven or Gradle" ||--|{ "JUnit Platform" : "requests discovery and execution"
+    "Console Launcher" ||--|{ "JUnit Platform" : "requests discovery and execution"
     "JUnit Platform" ||--|{ "Suite Test Engine": "forwards request"
     "Suite Test Engine" ||--|{ "@Suite annotated class A" : "discovers and executes"
     "Suite Test Engine" ||--|{ "@Suite annotated class B" : "discovers and executes"
-
     "@Suite annotated class A" ||--|{ "JUnit Platform (A)" :  "requests discovery and execution"
     "@Suite annotated class B" ||--|{ "JUnit Platform (B)" :  "requests discovery and execution"
     "JUnit Platform (A)" ||--|{ "Cucumber Test Engine (A)": "forwards request"
@@ -420,14 +422,14 @@ cucumber.junit-platform.naming-strategy=                       # long or short.
                                                                # default: short
                                                                # include parent descriptor name in test descriptor.
 
-cucumber.junit-platform.naming-strategy.short.example-name=    # number or pickle.
-                                                               # default: number
-                                                               # Use example number or pickle name for examples when
+cucumber.junit-platform.naming-strategy.short.example-name=    # number, number-and-pickle-if-parameterized or pickle.
+                                                               # default: number-and-pickle-if-parameterized
+                                                               # Use example number and/or pickle name for examples when
                                                                # short naming strategy is used
 
-cucumber.junit-platform.naming-strategy.long.example-name=     # number or pickle.
-                                                               # default: number
-                                                               # Use example number or pickle name for examples when
+cucumber.junit-platform.naming-strategy.long.example-name=     # number, number-and-pickle-if-parameterized, or pickle.
+                                                               # default: number-and-pickle-if-parameterized
+                                                               # Use example number and/or pickle name for examples when
                                                                # long naming strategy is used
 
 cucumber.plugin=                                               # comma separated plugin strings.
@@ -464,6 +466,12 @@ cucumber.execution.execution-mode.feature=                     # same_thread or
                                                                # concurrent - executes scenarios concurrently on any
                                                                # available thread
 
+cucumber.execution.order=                                     # lexical, reverse, random or random:[seed] (CLI only). default: lexical
+                                                              # default: lexical
+                                                              # lexical - executes features in lexical uri order, scenarios and examples from top to bottom 
+                                                              # reverse - as lexical, but in reverse
+                                                              # random - at random. Note: scenarios and examples are only shuffled within their containing element 
+
 cucumber.execution.parallel.enabled=                           # true or false.
                                                                # default: false
 

cucumber-junit-platform-engine/pom.xml

@@ -65,6 +65,11 @@
             <artifactId>junit-jupiter-api</artifactId>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter-params</artifactId>
+            <scope>test</scope>
+        </dependency>
         <dependency>
             <groupId>org.junit.platform</groupId>
             <artifactId>junit-platform-testkit</artifactId>

cucumber-junit-platform-engine/src/main/java/io/cucumber/junit/platform/engine/AbstractCucumberTestDescriptor.java

@@ -0,0 +1,19 @@
+package io.cucumber.junit.platform.engine;
+
+import io.cucumber.plugin.event.Location;
+import org.junit.platform.engine.TestSource;
+import org.junit.platform.engine.UniqueId;
+import org.junit.platform.engine.support.descriptor.AbstractTestDescriptor;
+
+import java.net.URI;
+
+abstract class AbstractCucumberTestDescriptor extends AbstractTestDescriptor {
+
+    protected AbstractCucumberTestDescriptor(UniqueId uniqueId, String displayName, TestSource source) {
+        super(uniqueId, displayName, source);
+    }
+
+    protected abstract URI getUri();
+
+    protected abstract Location getLocation();
+}

cucumber-junit-platform-engine/src/main/java/io/cucumber/junit/platform/engine/CachingFeatureParser.java

@@ -1,10 +1,14 @@
 package io.cucumber.junit.platform.engine;
 
+import io.cucumber.core.exception.CucumberException;
 import io.cucumber.core.feature.FeatureParser;
 import io.cucumber.core.gherkin.Feature;
 import io.cucumber.core.resource.Resource;
 
+import java.io.IOException;
+import java.io.InputStream;
 import java.net.URI;
+import java.net.URISyntaxException;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.Optional;
@@ -21,4 +25,32 @@ class CachingFeatureParser {
     Optional<Feature> parseResource(Resource resource) {
         return cache.computeIfAbsent(resource.getUri(), uri -> delegate.parseResource(resource));
     }
+
+    Optional<Feature> parseResource(org.junit.platform.commons.support.Resource resource) {
+        return cache.computeIfAbsent(resource.getUri(), uri -> delegate.parseResource(new ResourceAdapter(resource)));
+    }
+
+    private static class ResourceAdapter implements Resource {
+        private final org.junit.platform.commons.support.Resource resource;
+
+        public ResourceAdapter(org.junit.platform.commons.support.Resource resource) {
+            this.resource = resource;
+        }
+
+        @Override
+        public URI getUri() {
+            String name = resource.getName();
+            try {
+                return new URI("classpath", name, null);
+            } catch (URISyntaxException e) {
+                String message = String.format("Could not create classpath uri for resource '%s'", name);
+                throw new CucumberException(message, e);
+            }
+        }
+
+        @Override
+        public InputStream getInputStream() throws IOException {
+            return resource.getInputStream();
+        }
+    }
 }

cucumber-junit-platform-engine/src/main/java/io/cucumber/junit/platform/engine/Constants.java

@@ -261,6 +261,11 @@ public final class Constants {
      */
     public static final String EXECUTION_MODE_FEATURE_PROPERTY_NAME = "cucumber.execution.execution-mode.feature";
 
+    /**
+     * TODO: Document
+     */
+    public static final String EXECUTION_ORDER_PROPERTY_NAME = io.cucumber.core.options.Constants.EXECUTION_ORDER_PROPERTY_NAME;
+
     /**
      * Property name used to enable parallel test execution: {@value}
      * <p>

cucumber-junit-platform-engine/src/main/java/io/cucumber/junit/platform/engine/Cucumber.java

@@ -24,7 +24,9 @@
  * <p>
  * 
  * @deprecated Please use the JUnit Platform Suite to run Cucumber in
- *             combination with Surefire or Gradle. E.g: <code><pre>{@code
+ *             combination with Surefire or Gradle. E.g:
+ * 
+ *             <pre>{@code
  *package com.example;
  *
  *import org.junit.platform.suite.api.ConfigurationParameter;
@@ -33,15 +35,15 @@
  *
  *import static io.cucumber.junit.platform.engine.Constants.GLUE_PROPERTY_NAME;
  *
- *&#64;Suite
- *&#64;SelectPackages("com.example")
- *&#64;ConfigurationParameter(
- *   key = GLUE_PROPERTY_NAME,
- *   value = "com.example"
- *)
- *public class RunCucumberTest {
- *}
- *}</pre></code>
+ *             @Suite
+ *             @SelectPackages("com.example")
+ *             @ConfigurationParameter(
+ *             key = GLUE_PROPERTY_NAME,
+ *             value = "com.example")
+ *             public class RunCucumberTest {
+ *             }
+ * }</pre>
+ * 
  * @see        CucumberTestEngine
  */
 @API(status = Status.DEPRECATED)