Restore TestSourcesModel (#3077)

mpkorstanje · web-flow · commit d7f7355e0360 · 2025-09-16T01:13:54.000+02:00
Unfortunately Serenity is shadowing the `io.cucumber.plugin` package and using our internal APIs. hey shouldn't be doing that, and it will irreparably break once we upgrade to Java 17 because of the module system. But until then we can keep this around. Fixes: #3076
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -17,6 +17,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 - [Core] Emit StepMatchArgumentsList for ambiguous steps ([#3066](https://github.com/cucumber/cucumber-jvm/pull/3066) M.P. Korstanje)
+- [Core] Restore `TestSourcesModel` ([#3076](https://github.com/cucumber/cucumber-jvm/pull/3076) M.P. Korstanje)
 
 ### Changed
 - [Core] Use a message based `RerunFormatter` ([#3075](https://github.com/cucumber/cucumber-jvm/pull/3075) M.P. Korstanje)
diff --git a/cucumber-core/src/main/java/io/cucumber/core/plugin/TestSourceReadResource.java b/cucumber-core/src/main/java/io/cucumber/core/plugin/TestSourceReadResource.java
@@ -0,0 +1,38 @@
+package io.cucumber.core.plugin;
+
+import io.cucumber.core.resource.Resource;
+import io.cucumber.plugin.event.TestSourceRead;
+
+import java.io.ByteArrayInputStream;
+import java.io.InputStream;
+import java.net.URI;
+
+import static java.nio.charset.StandardCharsets.UTF_8;
+
+/**
+ * Internal class, potentially still used by others.
+ *
+ * @see        <a href=
+ *             "https://github.com/cucumber/cucumber-jvm/issues/3076">cucumber/cucumber-jvm#3076</a>
+ * @deprecated for removal, use messages + query.
+ */
+@Deprecated
+final class TestSourceReadResource implements Resource {
+
+    private final TestSourceRead event;
+
+    TestSourceReadResource(TestSourceRead event) {
+        this.event = event;
+    }
+
+    @Override
+    public URI getUri() {
+        return event.getUri();
+    }
+
+    @Override
+    public InputStream getInputStream() {
+        return new ByteArrayInputStream(event.getSource().getBytes(UTF_8));
+    }
+
+}
diff --git a/cucumber-core/src/main/java/io/cucumber/core/plugin/TestSourcesModel.java b/cucumber-core/src/main/java/io/cucumber/core/plugin/TestSourcesModel.java
@@ -0,0 +1,262 @@
+package io.cucumber.core.plugin;
+
+import io.cucumber.gherkin.GherkinParser;
+import io.cucumber.messages.types.Background;
+import io.cucumber.messages.types.Envelope;
+import io.cucumber.messages.types.Examples;
+import io.cucumber.messages.types.Feature;
+import io.cucumber.messages.types.FeatureChild;
+import io.cucumber.messages.types.GherkinDocument;
+import io.cucumber.messages.types.Rule;
+import io.cucumber.messages.types.RuleChild;
+import io.cucumber.messages.types.Scenario;
+import io.cucumber.messages.types.Source;
+import io.cucumber.messages.types.SourceMediaType;
+import io.cucumber.messages.types.Step;
+import io.cucumber.messages.types.TableRow;
+import io.cucumber.plugin.event.TestSourceRead;
+
+import java.io.File;
+import java.net.URI;
+import java.net.URISyntaxException;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Optional;
+import java.util.regex.Pattern;
+import java.util.stream.Stream;
+
+/**
+ * Internal class, still used by Serenity.
+ *
+ * @see        <a href=
+ *             "https://github.com/cucumber/cucumber-jvm/issues/3076">cucumber/cucumber-jvm#3076</a>
+ * @deprecated for removal, use messages + query.
+ */
+@SuppressWarnings("unused")
+@Deprecated
+final class TestSourcesModel {
+
+    private final Map<URI, TestSourceRead> pathToReadEventMap = new HashMap<>();
+    private final Map<URI, GherkinDocument> pathToAstMap = new HashMap<>();
+    private final Map<URI, Map<Long, AstNode>> pathToNodeMap = new HashMap<>();
+
+    static Scenario getScenarioDefinition(AstNode astNode) {
+        AstNode candidate = astNode;
+        while (candidate != null && !(candidate.node instanceof Scenario)) {
+            candidate = candidate.parent;
+        }
+        return candidate == null ? null : (Scenario) candidate.node;
+    }
+
+    static boolean isBackgroundStep(AstNode astNode) {
+        return astNode.parent.node instanceof Background;
+    }
+
+    static String calculateId(AstNode astNode) {
+        Object node = astNode.node;
+        if (node instanceof Rule) {
+            return calculateId(astNode.parent) + ";" + convertToId(((Rule) node).getName());
+        }
+        if (node instanceof Scenario) {
+            return calculateId(astNode.parent) + ";" + convertToId(((Scenario) node).getName());
+        }
+        if (node instanceof ExamplesRowWrapperNode) {
+            return calculateId(astNode.parent) + ";" + (((ExamplesRowWrapperNode) node).bodyRowIndex + 2);
+        }
+        if (node instanceof TableRow) {
+            return calculateId(astNode.parent) + ";" + 1;
+        }
+        if (node instanceof Examples) {
+            return calculateId(astNode.parent) + ";" + convertToId(((Examples) node).getName());
+        }
+        if (node instanceof Feature) {
+            return convertToId(((Feature) node).getName());
+        }
+        return "";
+    }
+
+    private static final Pattern replacementPattern = Pattern.compile("[\\s'_,!]");
+
+    static String convertToId(String name) {
+        return replacementPattern.matcher(name).replaceAll("-").toLowerCase();
+    }
+
+    static URI relativize(URI uri) {
+        if (!"file".equals(uri.getScheme())) {
+            return uri;
+        }
+        if (!uri.isAbsolute()) {
+            return uri;
+        }
+
+        try {
+            URI root = new File("").toURI();
+            URI relative = root.relativize(uri);
+            // Scheme is lost by relativize
+            return new URI("file", relative.getSchemeSpecificPart(), relative.getFragment());
+        } catch (URISyntaxException e) {
+            throw new IllegalArgumentException(e.getMessage(), e);
+        }
+    }
+
+    void addTestSourceReadEvent(URI path, TestSourceRead event) {
+        pathToReadEventMap.put(path, event);
+    }
+
+    Feature getFeature(URI path) {
+        if (!pathToAstMap.containsKey(path)) {
+            parseGherkinSource(path);
+        }
+        if (pathToAstMap.containsKey(path)) {
+            return pathToAstMap.get(path).getFeature().orElse(null);
+        }
+        return null;
+    }
+
+    private void parseGherkinSource(URI path) {
+        if (!pathToReadEventMap.containsKey(path)) {
+            return;
+        }
+        String source = pathToReadEventMap.get(path).getSource();
+
+        GherkinParser parser = GherkinParser.builder()
+                .build();
+
+        Stream<Envelope> envelopes = parser.parse(
+            Envelope.of(new Source(path.toString(), source, SourceMediaType.TEXT_X_CUCUMBER_GHERKIN_PLAIN)));
+
+        // TODO: What about empty gherkin docs?
+        GherkinDocument gherkinDocument = envelopes
+                .map(Envelope::getGherkinDocument)
+                .filter(Optional::isPresent)
+                .map(Optional::get)
+                .findFirst()
+                .orElse(null);
+
+        pathToAstMap.put(path, gherkinDocument);
+        Map<Long, AstNode> nodeMap = new HashMap<>();
+        // TODO: What about gherkin docs with no features?
+        Feature feature = gherkinDocument.getFeature().get();
+        AstNode currentParent = new AstNode(feature, null);
+        for (FeatureChild child : feature.getChildren()) {
+            processFeatureDefinition(nodeMap, child, currentParent);
+        }
+        pathToNodeMap.put(path, nodeMap);
+
+    }
+
+    private void processFeatureDefinition(Map<Long, AstNode> nodeMap, FeatureChild child, AstNode currentParent) {
+        child.getBackground().ifPresent(background -> processBackgroundDefinition(nodeMap, background, currentParent));
+        child.getScenario().ifPresent(scenario -> processScenarioDefinition(nodeMap, scenario, currentParent));
+        child.getRule().ifPresent(rule -> {
+            AstNode childNode = new AstNode(rule, currentParent);
+            nodeMap.put(rule.getLocation().getLine(), childNode);
+            rule.getChildren().forEach(ruleChild -> processRuleDefinition(nodeMap, ruleChild, childNode));
+        });
+    }
+
+    private void processBackgroundDefinition(
+            Map<Long, AstNode> nodeMap, Background background, AstNode currentParent
+    ) {
+        AstNode childNode = new AstNode(background, currentParent);
+        nodeMap.put(background.getLocation().getLine(), childNode);
+        for (Step step : background.getSteps()) {
+            nodeMap.put(step.getLocation().getLine(), new AstNode(step, childNode));
+        }
+    }
+
+    private void processScenarioDefinition(Map<Long, AstNode> nodeMap, Scenario child, AstNode currentParent) {
+        AstNode childNode = new AstNode(child, currentParent);
+        nodeMap.put(child.getLocation().getLine(), childNode);
+        for (io.cucumber.messages.types.Step step : child.getSteps()) {
+            nodeMap.put(step.getLocation().getLine(), new AstNode(step, childNode));
+        }
+        if (!child.getExamples().isEmpty()) {
+            processScenarioOutlineExamples(nodeMap, child, childNode);
+        }
+    }
+
+    private void processRuleDefinition(Map<Long, AstNode> nodeMap, RuleChild child, AstNode currentParent) {
+        child.getBackground().ifPresent(background -> processBackgroundDefinition(nodeMap, background, currentParent));
+        child.getScenario().ifPresent(scenario -> processScenarioDefinition(nodeMap, scenario, currentParent));
+    }
+
+    private void processScenarioOutlineExamples(
+            Map<Long, AstNode> nodeMap, Scenario scenarioOutline, AstNode parent
+    ) {
+        for (Examples examples : scenarioOutline.getExamples()) {
+            AstNode examplesNode = new AstNode(examples, parent);
+            // TODO: Can tables without headers even exist?
+            TableRow headerRow = examples.getTableHeader().get();
+            AstNode headerNode = new AstNode(headerRow, examplesNode);
+            nodeMap.put(headerRow.getLocation().getLine(), headerNode);
+            for (int i = 0; i < examples.getTableBody().size(); ++i) {
+                TableRow examplesRow = examples.getTableBody().get(i);
+                Object rowNode = new ExamplesRowWrapperNode(examplesRow, i);
+                AstNode expandedScenarioNode = new AstNode(rowNode, examplesNode);
+                nodeMap.put(examplesRow.getLocation().getLine(), expandedScenarioNode);
+            }
+        }
+    }
+
+    AstNode getAstNode(URI path, int line) {
+        if (!pathToNodeMap.containsKey(path)) {
+            parseGherkinSource(path);
+        }
+        if (pathToNodeMap.containsKey(path)) {
+            return pathToNodeMap.get(path).get((long) line);
+        }
+        return null;
+    }
+
+    boolean hasBackground(URI path, int line) {
+        if (!pathToNodeMap.containsKey(path)) {
+            parseGherkinSource(path);
+        }
+        if (pathToNodeMap.containsKey(path)) {
+            AstNode astNode = pathToNodeMap.get(path).get((long) line);
+            return getBackgroundForTestCase(astNode).isPresent();
+        }
+        return false;
+    }
+
+    static Optional<Background> getBackgroundForTestCase(AstNode astNode) {
+        Feature feature = getFeatureForTestCase(astNode);
+        return feature.getChildren()
+                .stream()
+                .map(FeatureChild::getBackground)
+                .filter(Optional::isPresent)
+                .map(Optional::get)
+                .findFirst();
+    }
+
+    private static Feature getFeatureForTestCase(AstNode astNode) {
+        while (astNode.parent != null) {
+            astNode = astNode.parent;
+        }
+        return (Feature) astNode.node;
+    }
+
+    static class ExamplesRowWrapperNode {
+
+        final int bodyRowIndex;
+
+        ExamplesRowWrapperNode(Object examplesRow, int bodyRowIndex) {
+            this.bodyRowIndex = bodyRowIndex;
+        }
+
+    }
+
+    static class AstNode {
+
+        final Object node;
+        final AstNode parent;
+
+        AstNode(Object node, AstNode parent) {
+            this.node = node;
+            this.parent = parent;
+        }
+
+    }
+
+}
