1.9. Example of IReporter

1.9. Example of IReporter

IReporter is the listener you need to implement if you want to generate a report after all the suites are run.

In test class, ReporterListenerExample, I have grouped three method testcase1, testcase2 and testcase4 in “sanity”. Method testcase3 is not in any group.
Suppose I want to generate a report that contains test results of the tests belonging to “sanity” group, I need to implementIReporter and implement generateReport method.

	ReporterListenerExample:
	package com.ireporter;
	import org.testng.Assert;
	import org.testng.annotations.Test;
	public class ReporterListenerExample {
	@Test(groups="sanity")
	public void testcase1() {
	System.out.println("in testcase1");
	}
	@Test(groups="sanity", expectedExceptions=RuntimeException.class)
	public void testcase2() {
	System.out.println("in testcase2");
	}
	@Test
	public void testcase3() {
	System.out.println("in testcase3");
	}
	@Test(groups="sanity", invocationCount=4)
	public void testcase4() {
	System.out.println("in t4");
	i++;
	if (i==1 || i==3) {
	Assert.assertEquals(i, 10);
	}
	}
	private int i;
	}

view raw 1.IReporter.java hosted with ❤ by GitHub

	package com.ireporter;
	import java.util.Collection;
	import java.util.List;
	import java.util.Map;
	import java.util.Set;
	import org.testng.IReporter;
	import org.testng.IResultMap;
	import org.testng.ISuite;
	import org.testng.ISuiteResult;
	import org.testng.ITestContext;
	import org.testng.ITestNGMethod;
	import org.testng.ITestResult;
	import org.testng.xml.XmlSuite;
	public class ReporterListener implements IReporter {
	@Override
	public void generateReport(List<XmlSuite> xmlSuites, List<ISuite> suites,
	String outputDirectory) {
	System.out.println("*****Custom Report******");
	ISuite suite = suites.get(0);
	Map<String, Collection<ITestNGMethod>> methodsByGroup = suite.getMethodsByGroups();
	Map<String, ISuiteResult> tests = suite.getResults();
	for (String key : tests.keySet()) {
	System.out.println("Key: " + key + ", Value: " + tests.get(key));
	}
	Collection<ISuiteResult> suiteResults = tests.values();
	ISuiteResult suiteResult = suiteResults.iterator().next();
	ITestContext testContext = suiteResult.getTestContext();
	Collection<ITestNGMethod> perfMethods = methodsByGroup.get("perf");
	IResultMap failedTests = testContext.getFailedTests();
	for (ITestNGMethod perfMethod : perfMethods) {
	Set<ITestResult> testResultSet = failedTests.getResults(perfMethod);
	for (ITestResult testResult : testResultSet) {
	System.out.println("Test " + testResult.getName() + " failed, error " + testResult.getThrowable());
	}
	}
	IResultMap passedTests = testContext.getPassedTests();
	for (ITestNGMethod perfMethod : perfMethods) {
	Set<ITestResult> testResultSet = passedTests.getResults(perfMethod);
	for (ITestResult testResult : testResultSet) {
	System.out.println("Test " + testResult.getName() + " passed, time took " +
	(testResult.getStartMillis() - testResult.getEndMillis()));
	}
	}
	System.out.println("*****End of Report******");
	}
	}

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

	reportListenerTestng.xml
	<?xml version="1.0" encoding="UTF-8"?>
	<suite name="TestListenerExample Suite">
	<listeners>
	<listener class-name="com.ireporter.ReporterListener" />
	</listeners>
	<test name="TestListenerExample">
	<classes>
	<class name="com.ireporter.ReporterListenerExample" />
	</classes>
	</test>
	</suite>

view raw 3. reporterxml.xml hosted with ❤ by GitHub

	Output :
	[TestNGContentHandler] [WARN] It is strongly recommended to add "<!DOCTYPE suite SYSTEM "http://testng.org/testng-1.0.dtd" >" at the top of your file, otherwise TestNG may fail or not work as expected.
	[TestNG] Running:
	in testcase1
	in testcase2
	in testcase3
	in t4
	in t4
	in t4
	===============================================
	TestListenerExample Suite
	Total tests run: 6, Failures: 3, Skips: 0
	===============================================
	*****Custom Report******
	Key: TestListenerExample, Value: [SuiteResult context=TestListenerExample]
	Test testcase4 failed, error java.lang.AssertionError: expected [10] but found [1]
	Test testcase4 failed, error java.lang.AssertionError: expected [10] but found [3]
	Test testcase4 passed, time took -1
	*****End of Report******

view raw 4.Output.txt hosted with ❤ by GitHub