Configuring ReportNG with TestNG for HTML Reports

ReportNG is a simple plug-in for the TestNG unit-testing framework to generate HTML reports as a replacement for the default TestNG HTML reports. You can also customize html report with the help of TestNG listeners.

To use ReportNG reports we need to follow the below three steps:

Step 1: Add the below Jars Files to your project.

reportng-1.1.4.jar
velocity-dep-1.4.jar
guice-3.0.jar

Please use the below links to download the jars.

Click here to Download ReportNG and Velocity jars. Click on downloads to download the jars. You just need to unzip and add to the project.

Click here to download Google Guice Jar. You need to unzip and add guice.jar once the download completes.

The structure should look like below:
ReportNG Jars

Step 2: The Most important step, to make sure reportNG reports, we need to disable the default TestNG Listeners.

It can be done by following the below steps:

1. Right Click on Properties
2. Click on TestNG
3. You will find an option as "Disable default listeners", check the checbox
4. Click on "Apply" button, it will show as message as "Project preferences are saved".
5. Now Click on "OK" button.

The screen should look like the below:

TestNG Properties

Step 3: We need to add the below two listeners to testng.xml file.

<listeners>
      <listener class-name="org.uncommons.reportng.HTMLReporter"/>
      <listener class-name="org.uncommons.reportng.JUnitXMLReporter"/>
  </listeners>

Finally testng.xml file should look as the below for the given example :

<!DOCTYPE suite SYSTEM "http://testng.org/testng-1.0.dtd" >
<suite name="Suite1" verbose="1" >
<listeners>
      <listener class-name="org.uncommons.reportng.HTMLReporter"/>
      <listener class-name="org.uncommons.reportng.JUnitXMLReporter"/>
  </listeners>
  <test name="Regression Test Suite"   >
    <packages>
      <package name="packOne" />
      <package name="packTwo" />
   </packages>
 </test>
</suite>

The example code as follows:

Please add two packages as "packOne" and "packTwo" and a class for both the packages.

Package: PackOne
Class : demoOne

Here the first testcase will result in failure as i have used timeOut as 1000, to show you the report with both PASS and FAIL report.

package packOne;
import org.testng.annotations.Test;
public class demoOne {
	@Test(timeOut=1000)
	public void firstTestCase() throws InterruptedException
	{
		System.out.println("im in first test case from demoOne Class");
		Thread.sleep(1500);
	}
	@Test
	public void secondTestCase()
	{
		System.out.println("im in second test case from demoOne Class");
	}
}

Package : packTwo
Class : demoTwo

package packTwo;
import org.testng.annotations.Test;
public class demoTwo {
	@Test
	public void firstTestCase()
	{
		System.out.println("im in first test case from demoTwo Class");
	}
	@Test
	public void secondTestCase()
	{
		System.out.println("im in second test case from demoTwo Class");
	}
}

The below report is with the Default TestNG HTML Report.

TestNG Reports

Please execute the testcases/scripts to see the reports as below. After executing the testcases, Refresh the project folder to see the updated Reports. You will find a folder "html" and click on Index.html file to view the Report Generated By ReportNG

The below is the Overview Report generated after configuring the ReportNG with TestNG.

ReportNg Report Overview

The below is the Report generated after configuring the ReportNG with TestNG.

ReportNg Report

Test Frameworks: 

Comments

I can see only two files in html folder index and overview.....it throws error like below :-

File not found

Firefox can't find the file at /C:/Users/aelangovan/workspace/TestNG/test-output/html/suites.html.

Check the file name for capitalisation or other typing errors.
Check to see if the file was moved, renamed or deleted.

Please help me on this

Very nice.

Very basic- Though good one

Thanks for sharing this information. I was looking for same. (^_^)

Same issue, did everything, as mentioned , refresh multiple times, same entry in testng.xml but no new html folder creating, tried in eclipse luna and Indigo.
No luck please help.

for me this is a very very good information, because its contents make us become better know and learn more about the wide world

Listener org.uncommons.reportng.HTMLReporter was not found in project's classpath.

how to resolve this issue.

Thankq so much for your information

Fantastic information

Really Nice article

Add new comment