feat: Add Requirement Tag for XRay Import

Author: timgrohmann

java/src/main/java/io/cucumber/junitxmlformatter/XmlReportData.java

@@ -1,28 +1,15 @@
 package io.cucumber.junitxmlformatter;
 
 import io.cucumber.messages.Convertor;
-import io.cucumber.messages.types.Envelope;
-import io.cucumber.messages.types.Feature;
-import io.cucumber.messages.types.Pickle;
-import io.cucumber.messages.types.PickleStep;
-import io.cucumber.messages.types.Step;
-import io.cucumber.messages.types.TestCaseStarted;
-import io.cucumber.messages.types.TestRunStarted;
-import io.cucumber.messages.types.TestStep;
-import io.cucumber.messages.types.TestStepFinished;
-import io.cucumber.messages.types.TestStepResult;
-import io.cucumber.messages.types.TestStepResultStatus;
+import io.cucumber.messages.types.*;
 import io.cucumber.query.Lineage;
 import io.cucumber.query.NamingStrategy;
 import io.cucumber.query.Query;
 
 import java.time.Duration;
+import java.util.*;
 import java.util.AbstractMap.SimpleEntry;
-import java.util.List;
-import java.util.Locale;
-import java.util.Map;
 import java.util.Map.Entry;
-import java.util.Optional;
 
 import static io.cucumber.messages.types.TestStepResultStatus.PASSED;
 import static java.time.format.DateTimeFormatter.ISO_INSTANT;
@@ -83,6 +70,20 @@ String getFeatureName(TestCaseStarted testCaseStarted) {
                 .orElseGet(() -> this.getPickle(testCaseStarted).getUri());
     }
 
+    /**
+     * Extracts a requirement tag denoted by starting with "@Req:"
+     */
+    List<String> getFeatureRequirements(TestCaseStarted testCaseStarted) {
+        String requirementPrefix = "Req:";
+        return query.findPickleBy(testCaseStarted)
+                .map(Pickle::getTags)
+                .orElse(Collections.emptyList())
+                .stream()
+                .filter(tag -> tag.getName().startsWith(requirementPrefix))
+                .map(tag -> tag.getName().substring(requirementPrefix.length()))
+                .collect(toList());
+    }
+
     List<Entry<String, String>> getStepsAndResult(TestCaseStarted testCaseStarted) {
         return query.findTestStepFinishedAndTestStepBy(testCaseStarted)
                 .stream()

java/src/main/java/io/cucumber/junitxmlformatter/XmlReportWriter.java

@@ -12,6 +12,7 @@
 import java.util.EnumSet;
 import java.util.Map;
 import java.util.Optional;
+import java.util.stream.Collectors;
 
 import static io.cucumber.messages.types.TestStepResultStatus.PASSED;
 import static io.cucumber.messages.types.TestStepResultStatus.SKIPPED;
@@ -78,6 +79,7 @@ private void writeTestcase(EscapingXmlStreamWriter writer, TestCaseStarted testC
         writer.writeStartElement("testcase");
         writeTestCaseAttributes(writer, testCaseStarted);
         writer.writeNewLine();
+        writeRequirementProperties(writer, testCaseStarted);
         writeNonPassedElement(writer, testCaseStarted);
         writeStepAndResultList(writer, testCaseStarted);
         writer.writeEndElement();
@@ -90,6 +92,19 @@ private void writeTestCaseAttributes(EscapingXmlStreamWriter writer, TestCaseSta
         writer.writeAttribute("time", String.valueOf(data.getDurationInSeconds(testCaseStarted)));
     }
 
+    private void writeRequirementProperties(EscapingXmlStreamWriter writer, TestCaseStarted testCaseStarted) throws XMLStreamException {
+        List<String> requirements = data.getFeatureRequirements(testCaseStarted);
+
+        if (!requirements.isEmpty()) {
+            writer.writeStartElement("properties");
+            writer.writeStartElement("property");
+            writer.writeAttribute("name", "requirements");
+            writer.writeAttribute("value", String.join(",", requirements));
+            writer.writeNewLine();
+        }
+
+    }
+
     private void writeNonPassedElement(EscapingXmlStreamWriter writer, TestCaseStarted testCaseStarted) throws XMLStreamException {
         TestStepResult result = data.getTestCaseStatus(testCaseStarted);
         TestStepResultStatus status = result.getStatus();
@@ -164,4 +179,4 @@ private static String createStepResultList(List<Map.Entry<String, String>> resul
         });
         return sb.toString();
     }
-}
+}

javascript/src/index.ts

@@ -41,6 +41,13 @@ export default {
             name: testCase.name,
             time: testCase.time,
           })
+          if (testCase.requirements.length > 0) {
+            const properties = testcaseElement.ele('properties')
+            properties.ele('property', {
+              name: 'requirements',
+              value: testCase.requirements.join(",")
+            })
+          }
           if (testCase.failure) {
             const failureElement = testcaseElement.ele(testCase.failure.kind)
             if (testCase.failure.kind === 'failure' && testCase.failure.type) {

javascript/src/makeReport.ts

@@ -15,6 +15,8 @@ const NAMING_STRATEGY = namingStrategy(
   NamingStrategyExampleName.NUMBER_AND_PICKLE_IF_PARAMETERIZED
 )
 
+const REQUIREMENT_TAG_PREFIX = "Req:"
+
 interface ReportSuite {
   time: number
   tests: number
@@ -31,6 +33,7 @@ interface ReportTestCase {
   time: number
   failure?: ReportFailure
   output: string
+  requirements: string[]
 }
 
 interface ReportFailure {
@@ -85,6 +88,9 @@ function makeTestCases(query: Query): ReadonlyArray<ReportTestCase> {
           return formatStep(gherkinStep, pickleStep, testStepFinished.testStepResult.status)
         })
         .join('\n'),
+      requirements: pickle.tags
+        .filter(tag => tag.name.startsWith(REQUIREMENT_TAG_PREFIX))
+        .map(tag => tag.name.substring(REQUIREMENT_TAG_PREFIX.length)),
     }
   })
 }