#187: Add support for Scenario outlines custom name strategies

Author: grey-rain

src/main/java/com/github/invictum/reportportal/ReportIntegrationConfig.java

@@ -1,6 +1,7 @@
 package com.github.invictum.reportportal;
 
-
+import com.github.invictum.reportportal.recorder.DefaultBddOutlineTestNameTransformer;
+import com.github.invictum.reportportal.recorder.TestNameTransformer;
 import net.serenitybdd.annotations.Narrative;
 
 import java.util.Objects;
@@ -20,6 +21,7 @@ public class ReportIntegrationConfig {
 
     private LogsPreset preset = LogsPreset.DEFAULT;
     private Function<Narrative, String> classNarrativeFormatter = n -> String.join("\n", n.text());
+    private TestNameTransformer testNameTransformer = new DefaultBddOutlineTestNameTransformer();
     boolean harvestSeleniumLogs = false;
     boolean truncateNames = false;
 
@@ -57,6 +59,18 @@ public ReportIntegrationConfig useClassNarrativeFormatter(Function<Narrative, St
         return this;
     }
 
+    /**
+     * Overrides default test name, passed from Serenity, with custom logic.
+     */
+    public ReportIntegrationConfig useTestNameTransformer(TestNameTransformer testNameTransformer) {
+        this.testNameTransformer = testNameTransformer;
+        return this;
+    }
+
+    public TestNameTransformer getTestNameTransformer() {
+        return testNameTransformer;
+    }
+
     /**
      * Option allows to enable or disable selenium based logs harvesting
      * Designed to be used in conjunction with {@link com.github.invictum.reportportal.log.unit.Selenium} log unit

src/main/java/com/github/invictum/reportportal/recorder/BddDataDriven.java

@@ -9,7 +9,7 @@
 import net.thucydides.model.domain.TestOutcome;
 import net.thucydides.model.domain.TestStep;
 
-import java.util.Arrays;
+import java.util.List;
 
 /**
  * Recorder aware of parameterized BDD style test specific handling
@@ -32,16 +32,17 @@ public void record(TestOutcome out) {
                 .withDescription(out.getUserStory().getNarrative())
                 .build();
         Maybe<String> id = suiteStorage.start(out.getUserStory().getId(), () -> launch.startTestItem(startStory));
+        TestNameTransformer testNameTransformer = ReportIntegrationConfig.get().getTestNameTransformer();
         // Start test
         StartTestItemRQ startScenario = new StartEventBuilder(ItemType.STEP)
-                .withName(out.getName())
+                .withName(testNameTransformer.transformName(out, last))
                 .withStartTime(currentTest.getStartTime())
                 .withParameters(out.getDataTable().row(last))
                 .withTags(out.getTags())
                 .build();
         Maybe<String> testId = launch.startTestItem(id, startScenario);
         // Steps
-        proceedSteps(testId, Arrays.asList(currentTest));
+        proceedSteps(testId, List.of(currentTest));
         // Stop test
         FinishTestItemRQ finishScenario = new FinishEventBuilder()
                 .withStatus(Status.mapTo(currentTest.getResult()))

src/main/java/com/github/invictum/reportportal/recorder/DefaultBddOutlineTestNameTransformer.java

@@ -0,0 +1,14 @@
+package com.github.invictum.reportportal.recorder;
+
+import net.thucydides.model.domain.TestOutcome;
+
+/**
+ * Default implementation of name as seen in Serenity.
+ */
+public class DefaultBddOutlineTestNameTransformer implements TestNameTransformer {
+
+    @Override
+    public String transformName(TestOutcome testOutcome, int scenarioIndex) {
+        return testOutcome.getName();
+    }
+}

src/main/java/com/github/invictum/reportportal/recorder/TestNameTransformer.java

@@ -0,0 +1,16 @@
+package com.github.invictum.reportportal.recorder;
+
+import net.thucydides.model.domain.TestOutcome;
+
+/**
+ * Allows to transform particular test name in ReportPortal according to specific user requirements.
+ */
+public interface TestNameTransformer {
+
+    /**
+     * @param testOutcome   original test data
+     * @param scenarioIndex index of scenario which is being reported
+     * @return transformed test name
+     */
+    String transformName(TestOutcome testOutcome, int scenarioIndex);
+}