Selenium HTML result reporting using ExtentReports 3.X

In our earlier post (Selenium reporting using extent 2.x), we have seen as a starting point how to generate report at end of test execution using 2.x version.

As extent report is becoming more popular and they are also trying to make it more flexible by providing frequent updates, so in this post, we will be discussing more in detail about the newly release version 3.0 (till now), which is of quite different in configuration (of course, concept remains same :D).

Find the required dependencies from following links

• Extent report 3.x 
• Freemarker
• Mongodb bson 
• Selenium and testNG related dependecies

Let’s look into the code implementation

1st thing, we need a utility or base class (ExtentManager.java) that takes care all the extent configuration, so that test cases will be using this ExtentManager.java to generate report.

package mypkg;

import com.aventstack.extentreports.ExtentReports;
import com.aventstack.extentreports.ExtentTest;
import com.aventstack.extentreports.reporter.ExtentHtmlReporter;

public class ExtentManager {
	
	private static ExtentReports extent;
	private static ExtentTest test;
	private static ExtentHtmlReporter htmlReporter;
	private static String filePath = "./extentreport.html";
	
	
	public static ExtentReports GetExtent(){
		if (extent != null)
                    return extent; //avoid creating new instance of html file
                extent = new ExtentReports();		
		extent.attachReporter(getHtmlReporter());
		return extent;
	}

	private static ExtentHtmlReporter getHtmlReporter() {
                htmlReporter = new ExtentHtmlReporter(filePath);
	        // make the charts visible on report open
                htmlReporter.config().setChartVisibilityOnOpen(true);
                htmlReporter.config().setDocumentTitle("QAV automation report");
                htmlReporter.config().setReportName("Regression cycle");
                return htmlReporter;
	}
	
	public static ExtentTest createTest(String name, String description){
		test = extent.createTest(name, description);
		return test;
	}
}

Create testcases, log results or steps to generate report

public class TC1 {
	
	ExtentReports extent;
	ExtentTest test;
	WebDriver driver;
	
	@BeforeClass
	public void M1(){
		extent = ExtentManager.GetExtent();
		System.setProperty("webdriver.gecko.driver", "./geckodriver.exe");
		driver = new FirefoxDriver();
	}
	
	@Test
	public void checkHome()
	{
		try{
		driver.get("http://www.qavalidation.com/");
		
		//test = extent.startTest("OpenUT", "Verify HomePage");//earlier version
		test = extent.createTest("QAVsite", "Verify HomePage");
		
		if(driver.getTitle().contains("QA manual")){
			//test.log(LogStatus.PASS, driver.getTitle() +" contain "+"QA & Validation" );//earlier version
			//test.log(Status.PASS, driver.getTitle() +" contain "+"QA & Validation");
			//or
		    test.pass(driver.getTitle() +" contain "+"QA manual");
		    //test.log(Status.INFO, "Snapshot" +  test.addScreenCaptureFromPath("./1.jpg"));
		}
		else
			//test.log(LogStatus.FAIL, driver.getTitle() +" doesn't contain "+"QA & Validation" );//earlier version
			test.log(Status.FAIL, driver.getTitle() +" doesn't contain "+"QA manual" );
		}catch(Exception e){test.log(Status.ERROR, e.getMessage());}
	}
	
	@Test
	public void checkFail(){
		test = extent.createTest("Testing how fail works");
		//test.log(Status.INFO, "fail check started");
		test.fail("Test fail");
	}
		
	@AfterClass
	public void tear()
	{
		//extent.endTest(test);//earlier version
		extent.flush();
		extent.close();
		driver.quit();
	}
}

run the TC1.java, refresh your project, you will see extentreport.html created, open html page in a browser to see the extent report.

Explanation :

in ExtentManager.java, we are getting the objects of ExtentReports, ExtentHtmlReporter and ExtentTest , so separate test cases can use those objects to send test results to generate report.

each test case will have

• @BeforeClass – get the ExtentReports object and some test case specific code statements.
• @Test  – actual test case functionality.
• @AfterClass – to write the test case results in to html (extent.flush())

All other code statements are explained with below screenshot

Configuration :

Extent report can be customized or configured by using ExtentHtmlReporter.config() (e.g – setDocumentTitle, setReportName) or by using config.xml and load it at run time.

NOTE: In the above code implementation, we saw how to configure extent report using ExtentHtmlReporter.config()

Now let’s see how we can load and cofigure report using config.xml

a typical config.xml –

<?xml version="1.0" encoding="UTF-8"?>
<extentreports>
    <configuration>
        <!-- report theme -->
        <!-- standard, dark -->
        <theme>standard</theme>
    
        <!-- document encoding -->
        <!-- defaults to UTF-8 -->
        <encoding>UTF-8</encoding>
        
        <!-- protocol for script and stylesheets -->
        <!-- defaults to https -->
        <protocol>https</protocol>
        
        <!-- title of the document -->
        <documentTitle>QAV report</documentTitle>
        
        <!-- report name - displayed at top-nav -->
        <reportName>Regression</reportName>
        
        <!-- location of charts in the test view -->
        <!-- top, bottom -->
        <testViewChartLocation>bottom</testViewChartLocation>
        
        <!-- custom javascript -->
        <scripts>
            <![CDATA[
                $(document).ready(function() {
                    
                });
            ]]>
        </scripts>
        
        <!-- custom styles -->
        <styles>
            <![CDATA[
                
            ]]>
        </styles>
    </configuration>
</extentreports>

Do required changes to the config.xml and place under your project folder, and change the ExtentManager.java a bit to use the xml file.

private static ExtentHtmlReporter getHtmlReporter() {
        htmlReporter = new ExtentHtmlReporter(filePath);
        htmlReporter.loadXMLConfig("./config.xml");
        return htmlReporter;
}

References –

github – extent report in java

https://github.com/anshooarora/extentreports-java/issues/652

Update –

Updated GetExtent() under class ExtentManager

if(extent != null)

return extent; \\to avoid creating new instance of html file at every test run