Use long naming strategy for pickles

cucumber · Dec 5, 2022 · 44fd048 · 44fd048
1 parent d52c96d
commit 44fd048
Show file tree

Hide file tree

Showing 5 changed files with 56 additions and 22 deletions.
diff --git a/java/src/main/java/io/cucumber/junitxmlformatter/XmlReportData.java b/java/src/main/java/io/cucumber/junitxmlformatter/XmlReportData.java
@@ -1,9 +1,14 @@
 package io.cucumber.junitxmlformatter;
 
 import io.cucumber.messages.types.Envelope;
+import io.cucumber.messages.types.Examples;
+import io.cucumber.messages.types.Feature;
 import io.cucumber.messages.types.GherkinDocument;
 import io.cucumber.messages.types.Pickle;
 import io.cucumber.messages.types.PickleStep;
+import io.cucumber.messages.types.Rule;
+import io.cucumber.messages.types.Scenario;
+import io.cucumber.messages.types.TableRow;
 import io.cucumber.messages.types.TestCase;
 import io.cucumber.messages.types.TestCaseFinished;
 import io.cucumber.messages.types.TestCaseStarted;
@@ -15,7 +20,13 @@
 
 import java.time.Duration;
 import java.time.Instant;
-import java.util.*;
+import java.util.Comparator;
+import java.util.Deque;
+import java.util.LinkedHashMap;
+import java.util.List;
+import java.util.Locale;
+import java.util.Map;
+import java.util.Optional;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.ConcurrentLinkedDeque;
 import java.util.function.Function;
@@ -48,6 +59,7 @@ class XmlReportData {
     private final Map<String, String> pickleIdToScenarioAstNodeId = new ConcurrentHashMap<>();
     private final Map<String, String> scenarioAstNodeIdToFeatureName = new ConcurrentHashMap<>();
     private final Map<String, String> stepAstNodeIdToStepKeyWord = new ConcurrentHashMap<>();
+    private final Map<String, String> pickleAstNodeIdToLongName = new ConcurrentHashMap<>();
 
     void collect(Envelope envelope) {
         envelope.getTestRunStarted().ifPresent(event -> this.testRunStarted = timestampToJavaInstant(event.getTimestamp()));
@@ -91,23 +103,42 @@ private void source(GherkinDocument event) {
                 featureChild.getRule().ifPresent(rule -> {
                     rule.getChildren().forEach(ruleChild -> {
                         ruleChild.getScenario().ifPresent(scenario -> {
-                            scenarioAstNodeIdToFeatureName.put(scenario.getId(), feature.getName());
-                            scenario.getSteps().forEach(step -> {
-                                stepAstNodeIdToStepKeyWord.put(step.getId(), step.getKeyword());
-                            });
+                            scenario(feature, rule, scenario);
                         });
                     });
                 });
                 featureChild.getScenario().ifPresent(scenario -> {
-                    scenarioAstNodeIdToFeatureName.put(scenario.getId(), feature.getName());
-                    scenario.getSteps().forEach(step -> {
-                        stepAstNodeIdToStepKeyWord.put(step.getId(), step.getKeyword());
-                    });
+                    scenario(feature, null, scenario);
                 });
             });
         });
     }
 
+    private void scenario(Feature feature, Rule rule, Scenario scenario) {
+        scenarioAstNodeIdToFeatureName.put(scenario.getId(), feature.getName());
+        scenario.getSteps().forEach(step -> {
+            stepAstNodeIdToStepKeyWord.put(step.getId(), step.getKeyword());
+        });
+
+        String rulePrefix = rule == null ? "" : rule.getName() + " - ";
+        pickleAstNodeIdToLongName.put(scenario.getId(), rulePrefix + scenario.getName());
+
+        List<Examples> examples = scenario.getExamples();
+        for (int examplesIndex = 0; examplesIndex < examples.size(); examplesIndex++) {
+            Examples currentExamples = examples.get(examplesIndex);
+            List<TableRow> tableRows = currentExamples.getTableBody();
+            for (int exampleIndex = 0; exampleIndex < tableRows.size(); exampleIndex++) {
+                TableRow currentExample = tableRows.get(exampleIndex);
+                StringBuilder suffix = new StringBuilder(" - ");
+                if (!currentExamples.getName().isEmpty()) {
+                    suffix.append(currentExamples.getName()).append(" - ");
+                }
+                suffix.append("Example #").append(examplesIndex + 1).append(".").append(exampleIndex + 1);
+                pickleAstNodeIdToLongName.put(currentExample.getId(), rulePrefix + scenario.getName() + suffix);
+            }
+        }
+    }
+
     private void pickle(Pickle event) {
         pickleIdToPickle.put(event.getId(), event);
         // @formatter:off
@@ -153,7 +184,10 @@ int getTestCaseCount() {
     String getPickleName(String testCaseStartedId) {
         String testCaseId = testCaseStartedIdToTestCaseId.get(testCaseStartedId);
         String pickleId = testCaseIdToTestCase.get(testCaseId).getPickleId();
-        return pickleIdToPickle.get(pickleId).getName();
+        Pickle pickle = pickleIdToPickle.get(pickleId);
+        List<String> astNodeIds = pickle.getAstNodeIds();
+        String pickleAstNodeId = astNodeIds.get(astNodeIds.size() - 1);
+        return pickleAstNodeIdToLongName.getOrDefault(pickleAstNodeId, pickle.getName());
     }
 
     public String getFeatureName(String testCaseStartedId) {

diff --git a/testdata/attachments.feature.xml b/testdata/attachments.feature.xml
@@ -24,7 +24,7 @@ When an array with 10 bytes is attached as "text/plain".....................pass
 When a JPEG image is attached...............................................passed
 ]]></system-out>
 </testcase>
-<testcase classname="Attachments" name="Attaching images in examples" time="0.005"><system-out><![CDATA[
+<testcase classname="Attachments" name="Attaching images in examples - Example #1.1" time="0.005"><system-out><![CDATA[
 When the cucumber.png png is attached.......................................passed
 ]]></system-out>
 </testcase>

diff --git a/testdata/examples-tables.feature.xml b/testdata/examples-tables.feature.xml
@@ -1,18 +1,18 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <testsuite name="Cucumber" time="0.049" tests="6" skipped="0" failures="4" errors="0">
-<testcase classname="Examples Tables" name="eating cucumbers" time="0.007"><system-out><![CDATA[
+<testcase classname="Examples Tables" name="eating cucumbers - These are passing - Example #1.1" time="0.007"><system-out><![CDATA[
 Given there are 12 cucumbers................................................passed
 When I eat 5 cucumbers......................................................passed
 Then I should have 7 cucumbers..............................................passed
 ]]></system-out>
 </testcase>
-<testcase classname="Examples Tables" name="eating cucumbers" time="0.007"><system-out><![CDATA[
+<testcase classname="Examples Tables" name="eating cucumbers - These are passing - Example #1.2" time="0.007"><system-out><![CDATA[
 Given there are 20 cucumbers................................................passed
 When I eat 5 cucumbers......................................................passed
 Then I should have 15 cucumbers.............................................passed
 ]]></system-out>
 </testcase>
-<testcase classname="Examples Tables" name="eating cucumbers" time="0.007">
+<testcase classname="Examples Tables" name="eating cucumbers - These are failing - Example #2.1" time="0.007">
 <failure>
 <![CDATA[Expected values to be strictly equal:
 
@@ -27,7 +27,7 @@ When I eat 20 cucumbers.....................................................pass
 Then I should have 0 cucumbers..............................................failed
 ]]></system-out>
 </testcase>
-<testcase classname="Examples Tables" name="eating cucumbers" time="0.007">
+<testcase classname="Examples Tables" name="eating cucumbers - These are failing - Example #2.2" time="0.007">
 <failure>
 <![CDATA[Expected values to be strictly equal:
 
@@ -42,14 +42,14 @@ When I eat 1 cucumbers......................................................pass
 Then I should have 0 cucumbers..............................................failed
 ]]></system-out>
 </testcase>
-<testcase classname="Examples Tables" name="eating cucumbers" time="0.007">
+<testcase classname="Examples Tables" name="eating cucumbers - These are undefined because the value is not an {int} - Example #3.1" time="0.007">
 <failure/><system-out><![CDATA[
 Given there are 12 cucumbers................................................passed
 When I eat banana cucumbers.................................................undefined
 Then I should have 12 cucumbers.............................................skipped
 ]]></system-out>
 </testcase>
-<testcase classname="Examples Tables" name="eating cucumbers" time="0.007">
+<testcase classname="Examples Tables" name="eating cucumbers - These are undefined because the value is not an {int} - Example #3.2" time="0.007">
 <failure/><system-out><![CDATA[
 Given there are 0 cucumbers.................................................passed
 When I eat 1 cucumbers......................................................passed

diff --git a/testdata/markdown.feature.md.xml b/testdata/markdown.feature.md.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <testsuite name="Cucumber" time="0.021" tests="2" skipped="0" failures="1" errors="0">
-<testcase classname="Cheese" name="Ylajali!" time="0.009">
+<testcase classname="Cheese" name="Nom nom nom - Ylajali! - because we need more tables - Example #1.1" time="0.009">
 <failure>
 <![CDATA[You asked me to fail
 samples/markdown/markdown.feature.md:24
@@ -13,7 +13,7 @@ When we use a data table and attach something and then fail.................fail
 Then this might or might not run............................................skipped
 ]]></system-out>
 </testcase>
-<testcase classname="Cheese" name="Ylajali!" time="0.009"><system-out><![CDATA[
+<testcase classname="Cheese" name="Nom nom nom - Ylajali! - because we need more tables - Example #1.2" time="0.009"><system-out><![CDATA[
 Given some TypeScript code:.................................................passed
 And some classic Gherkin:...................................................passed
 When we use a data table and attach something and then pass.................passed

diff --git a/testdata/rules.feature.xml b/testdata/rules.feature.xml
@@ -1,19 +1,19 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <testsuite name="Cucumber" time="0.029" tests="3" skipped="0" failures="0" errors="0">
-<testcase classname="Rules" name="no change" time="0.007"><system-out><![CDATA[
+<testcase classname="Rules" name="a sale cannot happen if change cannot be returned - no change" time="0.007"><system-out><![CDATA[
 Given there are 5 0.20 coins inside.........................................passed
 When the customer tries to buy a 0.85 chocolate with a 1 coin...............passed
 Then the sale should not happen.............................................passed
 ]]></system-out>
 </testcase>
-<testcase classname="Rules" name="exact change" time="0.009"><system-out><![CDATA[
+<testcase classname="Rules" name="a sale cannot happen if change cannot be returned - exact change" time="0.009"><system-out><![CDATA[
 Given there are 5 0.20 coins inside.........................................passed
 And there are 3 chocolates inside...........................................passed
 When the customer tries to buy a 0.80 chocolate with a 1 coin...............passed
 Then the customer's change should be 1 0.20 coin............................passed
 ]]></system-out>
 </testcase>
-<testcase classname="Rules" name="no chocolates left" time="0.009"><system-out><![CDATA[
+<testcase classname="Rules" name="a sale cannot happen if we're out of stock - no chocolates left" time="0.009"><system-out><![CDATA[
 Given there are no chocolates inside........................................passed
 But there are 10 0.5 coins inside...........................................passed
 When the customer tries to buy a 0.85 chocolate with a 1 coin...............passed