Fixed the bug while running on parallel using TestNG (#31)

.gitignore

@@ -2,4 +2,5 @@
 *.iml
 target
 output
-*.DS_Store
+*.DS_Store
+/test-output/report.html

Changelog.md

@@ -1,5 +1,8 @@
 # Changelog
 
+### v2.0.3
+- Fixed the bug while running on parallel using TestNG 
+
 ### v2.0.2
 - Fixed the system info when execute from multiple runners
 

Readme.md

@@ -14,7 +14,7 @@ If you are using a maven based project, you can directly add this library as a d
 <dependency>
     <groupId>com.vimalselvam</groupId>
     <artifactId>cucumber-extentsreport</artifactId>
-    <version>2.0.1</version>
+    <version>2.0.3</version>
 </dependency>
 ```
 
@@ -64,6 +64,8 @@ public class RunCukesTest {
 
 ```
 
+Please note that the plugin `com.cucumber.listener.ExtentCucumberFormatter` takes an argument of where the report file should be generated. If you omit the parameter of file path, the report will be generated in the `test-output` folder in your project directory by default with the file name as `report.html`.
+
 The above example shows a JUnit runner. However, you can use the TestNG runner too.
 Also make sure the `loadXMLConfig`, `setSystemInfo` and `setTestRunnerOutput` methods should be in your `@AfterClass` method.
 

pom.xml

@@ -6,7 +6,19 @@
 
     <groupId>com.vimalselvam</groupId>
     <artifactId>cucumber-extentsreport</artifactId>
-    <version>2.0.2</version>
+    <version>2.0.3</version>
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <configuration>
+                    <source>1.8</source>
+                    <target>1.8</target>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
     <packaging>jar</packaging>
 
     <name>Cucumber Extents Report</name>
@@ -57,6 +69,13 @@
             <scope>test</scope>
         </dependency>
 
+        <dependency>
+            <groupId>info.cukes</groupId>
+            <artifactId>cucumber-testng</artifactId>
+            <version>${cucumber.version}</version>
+            <scope>test</scope>
+        </dependency>
+
         <dependency>
             <groupId>junit</groupId>
             <artifactId>junit</artifactId>

src/main/java/com/cucumber/listener/ExtentCucumberFormatter.java

@@ -7,17 +7,7 @@
 import com.aventstack.extentreports.reporter.ExtentHtmlReporter;
 import gherkin.formatter.Formatter;
 import gherkin.formatter.Reporter;
-import gherkin.formatter.model.Background;
-import gherkin.formatter.model.DataTableRow;
-import gherkin.formatter.model.Examples;
-import gherkin.formatter.model.ExamplesTableRow;
-import gherkin.formatter.model.Feature;
-import gherkin.formatter.model.Match;
-import gherkin.formatter.model.Result;
-import gherkin.formatter.model.Scenario;
-import gherkin.formatter.model.ScenarioOutline;
-import gherkin.formatter.model.Step;
-import gherkin.formatter.model.Tag;
+import gherkin.formatter.model.*;
 
 import java.io.File;
 import java.util.LinkedList;
@@ -27,43 +17,54 @@
  * A cucumber based reporting listener which generates the Extent Report
  */
 public class ExtentCucumberFormatter implements Reporter, Formatter {
-    private static ThreadLocal<ExtentReports> reportsThreadLocal = new ThreadLocal<ExtentReports>();
-    private static ThreadLocal<ExtentHtmlReporter> htmlReporterThreadLocal =
-        new ThreadLocal<ExtentHtmlReporter>();
-    private static ThreadLocal<ExtentTest> featureTestThreadLocal = new ThreadLocal<ExtentTest>();
-    private static ThreadLocal<ExtentTest> scenarioOutlineThreadLocal =
-        new ThreadLocal<ExtentTest>();
-    static ThreadLocal<ExtentTest> scenarioThreadLocal = new ThreadLocal<ExtentTest>();
+    private static ExtentReports extentReports;
+    private static ExtentHtmlReporter htmlReporter;
+    private static ThreadLocal<ExtentTest> featureTestThreadLocal = new InheritableThreadLocal<>();
+    private static ThreadLocal<ExtentTest> scenarioOutlineThreadLocal = new InheritableThreadLocal<>();
+    static ThreadLocal<ExtentTest> scenarioThreadLocal = new InheritableThreadLocal<>();
     private static ThreadLocal<LinkedList<Step>> stepListThreadLocal =
-        new ThreadLocal<LinkedList<Step>>();
-    static ThreadLocal<ExtentTest> stepTestThreadLocal = new ThreadLocal<ExtentTest>();
+        new InheritableThreadLocal<>();
+    static ThreadLocal<ExtentTest> stepTestThreadLocal = new InheritableThreadLocal<>();
     private boolean scenarioOutlineFlag;
 
+    public ExtentCucumberFormatter() {
+        this(null);
+    }
+
     public ExtentCucumberFormatter(File file) {
-        if (getExtentReport() == null) {
-            setExtentHtmlReport(new ExtentHtmlReporter(file));
-            ExtentReports extentReports = new ExtentReports();
-            extentReports.attachReporter(getExtentHtmlReport());
-            setExtentReport(extentReports);
-        }
+        setExtentHtmlReport(file);
+        setExtentReport();
         stepListThreadLocal.set(new LinkedList<Step>());
         scenarioOutlineFlag = false;
     }
 
-    private static void setExtentHtmlReport(ExtentHtmlReporter htmlReport) {
-        htmlReporterThreadLocal.set(htmlReport);
+    private static void setExtentHtmlReport(File file) {
+        if (htmlReporter != null) {
+            return;
+        }
+        if (file == null) {
+            file = new File("test-output/report.html");
+            if (!file.exists()) {
+                file.getParentFile().mkdirs();
+            }
+        }
+        htmlReporter = new ExtentHtmlReporter(file);
     }
 
     static ExtentHtmlReporter getExtentHtmlReport() {
-        return htmlReporterThreadLocal.get();
+        return htmlReporter;
     }
 
-    private static void setExtentReport(ExtentReports extentReports) {
-        reportsThreadLocal.set(extentReports);
+    private static void setExtentReport() {
+        if (extentReports != null) {
+            return;
+        }
+        extentReports = new ExtentReports();
+        extentReports.attachReporter(htmlReporter);
     }
 
     static ExtentReports getExtentReport() {
-        return reportsThreadLocal.get();
+        return extentReports;
     }
 
     public void syntaxError(String state, String event, List<String> legalEvents, String uri,

src/main/java/com/cucumber/listener/Reporter.java

@@ -14,7 +14,7 @@
  * This class houses few utilities required for the report
  */
 public class Reporter {
-    private static Map<String, Boolean> systemInfoKeyMap = new HashMap<String, Boolean>();
+    private static Map<String, Boolean> systemInfoKeyMap = new HashMap<>();
 
     private Reporter() {
         // Defeat instantiation

src/test/java/com/cucumber/runner/MyTestNGCukesRunner.java

@@ -0,0 +1,23 @@
+package com.cucumber.runner;
+
+import com.cucumber.listener.Reporter;
+import cucumber.api.CucumberOptions;
+import cucumber.api.testng.AbstractTestNGCucumberTests;
+import org.testng.annotations.AfterClass;
+
+import java.io.File;
+
+@CucumberOptions(
+        features = {"src/test/resources/features/MySecondFeature.feature"},
+        glue = {"com.cucumber.stepdefinitions"},
+        plugin = {"com.cucumber.listener.ExtentCucumberFormatter"}
+)
+public class MyTestNGCukesRunner extends AbstractTestNGCucumberTests {
+    @AfterClass
+    public static void setup() {
+        Reporter.loadXMLConfig(new File("src/test/resources/extent-config.xml"));
+        Reporter.setSystemInfo("user", System.getProperty("user.name"));
+        Reporter.setSystemInfo("os", "Mac OSX");
+        Reporter.setTestRunnerOutput("Sample test runner output message");
+    }
+}

src/test/java/com/cucumber/runner/TestNGCukesRunner.java

@@ -0,0 +1,23 @@
+package com.cucumber.runner;
+
+import com.cucumber.listener.Reporter;
+import cucumber.api.CucumberOptions;
+import cucumber.api.testng.AbstractTestNGCucumberTests;
+import org.testng.annotations.AfterClass;
+
+import java.io.File;
+
+@CucumberOptions(
+        features = {"src/test/resources/features/MyFeature.feature"},
+        glue = {"com.cucumber.stepdefinitions"},
+        plugin = {"com.cucumber.listener.ExtentCucumberFormatter"}
+)
+public class TestNGCukesRunner extends AbstractTestNGCucumberTests {
+    @AfterClass
+    public static void setup() {
+        Reporter.loadXMLConfig(new File("src/test/resources/extent-config.xml"));
+        Reporter.setSystemInfo("user", System.getProperty("user.name"));
+        Reporter.setSystemInfo("os", "Mac OSX");
+        Reporter.setTestRunnerOutput("Sample test runner output message");
+    }
+}

src/test/resources/suite.xml

@@ -0,0 +1,10 @@
+<!DOCTYPE suite SYSTEM "http://testng.org/testng-1.0.dtd" >
+
+<suite name="Suite1" verbose="2" parallel="classes">
+    <test name="Test" >
+        <classes>
+            <class name="com.cucumber.runner.TestNGCukesRunner" />
+            <class name="com.cucumber.runner.MyTestNGCukesRunner" />
+        </classes>
+    </test>
+</suite>