Reports by Extent Reporting plugin

Selenium does;tn come with any reporting  feature, as a automation tester its responsibility to capture good reporting and present to management team. So in earlier post we have seen reporting with ReportNG and XSLT report plugin, now in this post we see another free plugin called ExtentReports.

About ExtentReports

• Very simple to use API

• Beautiful and responsive UI

• Provides dashboard for the entire run

• Parallel execution of classes and methods supported

• Creates a single report file, so less management of artifacts required (Online only*, Offline report stores all artifacts locally)

• Separate section for categories, provides analysis of tests by category

• Easily integrate test-runner logs

• Can be customized heavily using an external config file

and this is developed by http://extentreports.relevantcodes.com

Step1: Download all necessary jars - go to this link http://extentreports.relevantcodes.com

Step2 : 

ExtentReports is an open-source reporting library for test automation. It is very easily integrated with all test-frameworks (TestNG, JUnit, NUnit etc.) and provides better looking reports. Because Extent is created as a logging utility, it is also possible to use custom logs for each test, add snapshots & videos, assign categories and authors and filter using several parameters. Below are a few quick features of Extent:

Step3 : Create a simple TestNG script (under package package com.testNG; 

	public class AnukoTimeSheet {
	static WebDriver myTestDriver=null;
	@Test
	public void loginAnukoTimesheet() throws InterruptedException, IOException {
	System.setProperty("webdriver.chrome.driver","d:\\chromedriver.exe");
	WebDriver myTestDriver=new ChromeDriver();
	myTestDriver.get("https://timetracker.anuko.com/login.php");
	myTestDriver.manage().timeouts().implicitlyWait(10, TimeUnit.SECONDS);
	// maximizze the window.
	myTestDriver.manage().window().maximize();
	WebElement enterusername=myTestDriver.findElement(By.id("login"));
	waitforelement(enterusername);
	// if success then enter data to username
	enterusername.sendKeys("guest");
	WebElement enterpwd=myTestDriver.findElement(By.id("password"));
	waitforelement(enterpwd);
	// if success then enter data to username
	enterpwd.sendKeys("guest");
	// to click on button
	WebElement loginbtn=myTestDriver.findElement(By.id("btn_login"));
	waitforelement(loginbtn);
	// if success then enter data to username
	loginbtn.click();
	// myTestDriver.close();
	}
	public static String waitforelement(WebElement element) throws IOException{
	String msg;
	try {
	WebDriverWait wait = new WebDriverWait(myTestDriver, 30);
	// below method will check for visibility of the element i.e in this case its username element
	wait.until(ExpectedConditions.visibilityOf(element));
	msg="PASS";
	System.out.println(msg);
	} catch (Exception e) {
	System.out.println("waitForElementPresent method failed! "+ e.getMessage());
	msg="FAIL -waitForElementPresent method failed! "+ e.getMessage() ;
	}
	return msg;
	}
	}

view raw 1extent.java hosted with ❤ by GitHub

	Step 4 : Create a package com.extentereports.listener and create a ExtentReporterNG class file
	package com.ontestautomation.extentreports.listener;
	import java.io.File;
	import java.util.Calendar;
	import java.util.Date;
	import java.util.List;
	import java.util.Map;
	import org.testng.IReporter;
	import org.testng.IResultMap;
	import org.testng.ISuite;
	import org.testng.ISuiteResult;
	import org.testng.ITestContext;
	import org.testng.ITestResult;
	import org.testng.xml.XmlSuite;
	import com.relevantcodes.extentreports.ExtentReports;
	import com.relevantcodes.extentreports.ExtentTest;
	import com.relevantcodes.extentreports.LogStatus;
	public class ExtentReporterNG implements IReporter {
	private ExtentReports extent;
	@Override
	public void generateReport(List<XmlSuite> xmlSuites, List<ISuite> suites, String outputDirectory) {
	extent = new ExtentReports(outputDirectory + File.separator + "ExtentReportsTestNG.html", true);
	for (ISuite suite : suites) {
	Map<String, ISuiteResult> result = suite.getResults();
	for (ISuiteResult r : result.values()) {
	ITestContext context = r.getTestContext();
	buildTestNodes(context.getPassedTests(), LogStatus.PASS);
	buildTestNodes(context.getFailedTests(), LogStatus.FAIL);
	buildTestNodes(context.getSkippedTests(), LogStatus.SKIP);
	}
	}
	extent.flush();
	extent.close();
	}
	private void buildTestNodes(IResultMap tests, LogStatus status) {
	ExtentTest test;
	if (tests.size() > 0) {
	for (ITestResult result : tests.getAllResults()) {
	test = extent.startTest(result.getMethod().getMethodName());
	// test.getTest().getStartedTime() = getTime(result.getStartMillis());
	// test.getTest().endedTime = getTime(result.getEndMillis());
	for (String group : result.getMethod().getGroups())
	test.assignCategory(group);
	String message = "Test " + status.toString().toLowerCase() + "ed";
	if (result.getThrowable() != null)
	message = result.getThrowable().getMessage();
	test.log(status, message);
	extent.endTest(test);
	}
	}
	}
	private Date getTime(long millis) {
	Calendar calendar = Calendar.getInstance();
	calendar.setTimeInMillis(millis);
	return calendar.getTime();
	}
	}

view raw 2.Extent2.java hosted with ❤ by GitHub

and this will log into https://anukotimetracker.com.login.php

Step5 : Make sure that to add all the necessary jar;s that already downloaded

extentreports-java-2.40.0.jar

freemarker-2.3.23.jar

soup-1.8.3.jar

sqlite-jdbc-3.8.11.1.jar

and also make sure latest selenium jar added.

Step6 : Create xml like (testing.xml) and call the listener and anuko timesheet testNG class file

<?xml version="1.0" encoding="UTF-8"?>

<suite name="Sample Suite" verbose="1" >

<listeners>

<listener class-name="com.extentereports.listener.ExtentReporterNG" />

</listeners>

  <test name="run testng files" >

    <classes>

         <class name="com.testNG.AnukoTimeSheet"/>

        

    </classes>

  </test> 

</suite>

Step7 : Right click and run the file as TestNGSuite

Step 8: Once ran successfully go to your package folder and view the report 

ex. your project path/test-output, and look for the file ExtentReportsTestNG.html

Step 9 : Open the ExtentReportTestNG.html file and should look like this 

Thanks

Gururaj