closes #386 - enhancement: keepLastRetryOnly

Author: anshooarora

src/main/java/com/aventstack/extentreports/AbstractProcessor.java

@@ -14,17 +14,20 @@
 import com.aventstack.extentreports.model.service.MediaService;
 import com.aventstack.extentreports.model.service.TestService;
 
-import lombok.Getter;
-import lombok.Setter;
+import lombok.Data;
 
-@Getter
-@Setter
+@Data
 public abstract class AbstractProcessor extends ReactiveSubject {
     private String[] mediaResolverPath;
     private boolean usingNaturalConf = true;
+    protected boolean keepLastRetryOnly;
 
     @Override
     protected void onTestCreated(Test test) {
+        if (keepLastRetryOnly) {
+            getReport().findTest(test.getName())
+                    .ifPresent(x -> getReport().removeTest(x));
+        }
         getReport().getTestList().add(test);
         super.onTestCreated(test);
     }
@@ -39,6 +42,10 @@ protected void onTestRemoved(Test test) {
     }
 
     protected void onNodeCreated(Test node) {
+        if (keepLastRetryOnly) {
+            getReport().findTest(node.getName())
+                    .ifPresent(x -> getReport().removeTest(x));
+        }
         super.onTestCreated(node);
     }
 

src/main/java/com/aventstack/extentreports/ExtentReports.java

@@ -446,6 +446,16 @@ public void setGherkinDialect(String language) throws UnsupportedEncodingExcepti
         GherkinDialectManager.setLanguage(language);
     }
 
+    /**
+     * This setting allows only 1 instance of a test or node to be present in the report. To maintain
+     * uniqueness, the name of the test is used.
+     *
+     * @param keepLastRetryOnly true - keeps only the last executed test instance
+     */
+    public void keepLastRetryOnly(final boolean keepLastRetryOnly) {
+        super.keepLastRetryOnly = keepLastRetryOnly;
+    }
+
     /**
      * Returns an instance of {@link ReportStats} with counts of tests executed
      * by their status (pass, fail, skip etc)

src/main/java/com/aventstack/extentreports/model/Report.java

@@ -108,6 +108,10 @@ public Optional<Test> findTest(List<Test> list, String name) {
             return test;
         }
     }
+
+    public Optional<Test> findTest(final String name) {
+        return findTest(testList, name);
+    }
 
     public List<ExceptionInfo> aggregateExceptions(List<Test> testList) {
         synchronized (testList) {

src/test/java/com/aventstack/extentreports/ExtentReportsTest.java

@@ -106,4 +106,26 @@ public void addTestRunnerOutputList() {
         Assert.assertEquals(extent.getReport().getLogs().size(), 2);
         Arrays.stream(logs).forEach(x -> Assert.assertTrue(extent.getReport().getLogs().contains(x)));
     }
+
+    @org.testng.annotations.Test
+    public void keepLastRetryOnlyTestEnabled() {
+        final ExtentReports extent = new ExtentReports();
+        extent.keepLastRetryOnly(true);
+        final int numberOfTests = 5;
+        for (int i = 0; i < numberOfTests; i++) {
+            extent.createTest("test");
+        }
+        Assert.assertEquals(extent.getReport().getTestList().size(), 1);
+    }
+
+    @org.testng.annotations.Test
+    public void keepLastRetryOnlyTestDisabled() {
+        final ExtentReports extent = new ExtentReports();
+        extent.keepLastRetryOnly(false);
+        final int numberOfTests = 5;
+        for (int i = 0; i < numberOfTests; i++) {
+            extent.createTest("test");
+        }
+        Assert.assertEquals(extent.getReport().getTestList().size(), numberOfTests);
+    }
 }