#187: CR comments addressed

Author: grey-rain

README.md

@@ -334,25 +334,44 @@ and add `failsafe.rerunFailingTestsCount` or `surefire.rerunFailingTestsCount` p
 
 #### BDD Scenario test name customization
 
-n some cases, you may need to customize the test name for BDD Scenario Outlines (for example, to insert parameters into
-the test name in ReportPortal). To achieve this, you need to implement the desired customization logic in a class that
-implements the `TestNameTransformer` interface. This class should then be specified in the `ReportIntegrationConfig`.
+In some cases, you may need to customize the test name for BDD Scenario Outlines (for example, to insert parameters into
+the test name in ReportPortal). To achieve this, you need to implement the desired customization logic in a class which
+implements the `TestNameProvider` interface. This class should then be specified in the `ReportIntegrationConfig`.
+For example, to provide ability for test name to insert parameters, the following steps should be performed:
 
-```
-ReportIntegrationConfig.get().useTestNameTransformer(new MyTransformer());
-```
+1. Create class `ParametrizedNameProvider`
 
 ```
-public class MyTransformer implements TestNameTransformer {
+public class ParametrizedNameProvider implements TestNameProvider {
 
     @Override
-    public String transformName(TestOutcome testOutcome, int scenarioIndex) {
-        <...
-        //transformation logic
-        ...>
+    public String provideName(TestOutcome testOutcome, int scenarioIndex) {
+        // Regular expression to match content within < >
+        final String parameterRegexp = "<([^>]+)>";
+        final Pattern pattern = Pattern.compile(parameterRegexp);
+        final Matcher matcher = pattern.matcher(testOutcome.getName());
+        final StringBuilder result = new StringBuilder();
+        int index = 0;
+        List<String> replacements = testOutcome.getDataTable().getRows().get(scenarioIndex).getStringValues();
+        // Iterate through the matches and replace with values from the ArrayList
+        while (matcher.find()) {
+            if (index < replacements.size()) {
+                matcher.appendReplacement(result, replacements.get(index));
+                index++;
+            }
+        }
+        // Append the rest of the string
+        matcher.appendTail(result);
+        return result.toString();
     }
 ```
 
+2. Update integration configuration
+
+```
+ReportIntegrationConfig.get().useTestNameTransformer(new ParametrizedNameProvider());
+```
+
 #### Other settings
 
 Section includes minor settings that available to configure and describes their usage.

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

@@ -1,7 +1,7 @@
 package com.github.invictum.reportportal;
 
-import com.github.invictum.reportportal.recorder.DefaultBddOutlineTestNameTransformer;
-import com.github.invictum.reportportal.recorder.TestNameTransformer;
+import com.github.invictum.reportportal.recorder.DefaultBddOutlineTestNameProvider;
+import com.github.invictum.reportportal.recorder.TestNameProvider;
 import net.serenitybdd.annotations.Narrative;
 
 import java.util.Objects;
@@ -21,7 +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();
+    private TestNameProvider testNameProvider = new DefaultBddOutlineTestNameProvider();
     boolean harvestSeleniumLogs = false;
     boolean truncateNames = false;
 
@@ -62,13 +62,13 @@ public ReportIntegrationConfig useClassNarrativeFormatter(Function<Narrative, St
     /**
      * Overrides default test name, passed from Serenity, with custom logic.
      */
-    public ReportIntegrationConfig useTestNameTransformer(TestNameTransformer testNameTransformer) {
-        this.testNameTransformer = testNameTransformer;
+    public ReportIntegrationConfig useTestNameTransformer(TestNameProvider testNameProvider) {
+        this.testNameProvider = testNameProvider;
         return this;
     }
 
-    public TestNameTransformer getTestNameTransformer() {
-        return testNameTransformer;
+    public TestNameProvider getTestNameTransformer() {
+        return testNameProvider;
     }
 
     /**

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

@@ -32,10 +32,10 @@ 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();
+        TestNameProvider testNameProvider = ReportIntegrationConfig.get().getTestNameTransformer();
         // Start test
         StartTestItemRQ startScenario = new StartEventBuilder(ItemType.STEP)
-                .withName(testNameTransformer.transformName(out, last))
+                .withName(testNameProvider.provideName(out, last))
                 .withStartTime(currentTest.getStartTime())
                 .withParameters(out.getDataTable().row(last))
                 .withTags(out.getTags())

src/main/java/com/github/invictum/reportportal/recorder/DefaultBddOutlineTestNameTransformer.java renamed to src/main/java/com/github/invictum/reportportal/recorder/DefaultBddOutlineTestNameProvider.java

@@ -5,10 +5,10 @@
 /**
  * Default implementation of name as seen in Serenity.
  */
-public class DefaultBddOutlineTestNameTransformer implements TestNameTransformer {
+public class DefaultBddOutlineTestNameProvider implements TestNameProvider {
 
     @Override
-    public String transformName(TestOutcome testOutcome, int scenarioIndex) {
+    public String provideName(TestOutcome testOutcome, int scenarioIndex) {
         return testOutcome.getName();
     }
 }

src/main/java/com/github/invictum/reportportal/recorder/TestNameTransformer.java renamed to src/main/java/com/github/invictum/reportportal/recorder/TestNameProvider.java

@@ -5,12 +5,12 @@
 /**
  * Allows to transform particular test name in ReportPortal according to specific user requirements.
  */
-public interface TestNameTransformer {
+public interface TestNameProvider {
 
     /**
      * @param testOutcome   original test data
      * @param scenarioIndex index of scenario which is being reported
      * @return transformed test name
      */
-    String transformName(TestOutcome testOutcome, int scenarioIndex);
+    String provideName(TestOutcome testOutcome, int scenarioIndex);
 }