Better TestNG Reports with ATU Reporter

TestNG has decent reporting capability in terms of its in-built reports. But for some purpose, they may not be as user friendly as you’d like it to be. ATU Reporter is an open source utility which we can use to generate good looking TestNG reports. In this post, we will explore how we can configure ATU Reporter with Selenium WebDriver.

Before we proceed, let’s clarify that ATU Reporter will be useful to you only if you are using TestNG. It does not depend on Selenium. That means it can be used during unit testing as well.

A bit about ATU Reporter:

It’s an open source utility for TestNG framework. Its TestNG Listeners(ATUReportsListener, ConfigurationListener and MethodListener) can be used to generate customized graphical reports such as Line Chart, Bar Chart and Pie Chart. It is built using JQuery, CSS, HTML and jqPlot charting library.

Now, let’s take a look at how we can configure it with Selenium WebDriver project. Follow below steps for it.

• Download latest version of ATU Reporter.
• Unzip the file which contains JAR files of ATU Reporter and ATU Test Recorder, Java-doc, Properties file and a Sample Project.
• Reference JAR files in your Selenium project.
• Open class file. We need to add ATUReportsListener.class, ConfigurationListener.class and MethodListener.class Listeners to it. Make sure you update your class file with necessary package imports.
  
  @Listeners({ ATUReportsListener.class, ConfigurationListener.class, MethodListener.class }) public class ReportsTest {

  1 2	@Listeners({ ATUReportsListener.class, ConfigurationListener.class, MethodListener.class }) public class ReportsTest {

• Reference ATU Reporter properties file in your class file with below code.
  
  { System.setProperty("atu.reporter.config", "Path of properties file"); }

  1 2 3

  { System.setProperty("atu.reporter.config", "Path of properties file"); }

• Set the driver object to the ATU Reporter. You can modify indexPageDescription value with your choice of description.
  
  driver = new FirefoxDriver(); ATUReports.setWebDriver(driver); ATUReports.indexPageDescription = "Test Project";

  1 2 3

  driver = new FirefoxDriver(); ATUReports.setWebDriver(driver); ATUReports.indexPageDescription = "Test Project";

• The ATUReports class has four overloaded add methods for logging the step information. Add these four methods using below code.
  
  @Test public void testNewLogs() throws AWTException, IOException { ATUReports.add("INfo Step", LogAs.INFO, new CaptureScreen( ScreenshotOf.BROWSER_PAGE)); ATUReports.add("Pass Step", LogAs.PASSED, new CaptureScreen( ScreenshotOf.DESKTOP)); WebElement element = driver .findElement(By.xpath("/html/body/div/h1/a")); ATUReports.add("Warning Step", LogAs.WARNING, new CaptureScreen(element)); ATUReports.add("Fail step", LogAs.FAILED, new CaptureScreen( ScreenshotOf.DESKTOP)); }

  1 2 3 4 5 6 7 8 9 10 11 12 13 14

  @Test public void testNewLogs() throws AWTException, IOException {   ATUReports.add("INfo Step", LogAs.INFO, new CaptureScreen( ScreenshotOf.BROWSER_PAGE)); ATUReports.add("Pass Step", LogAs.PASSED, new CaptureScreen( ScreenshotOf.DESKTOP)); WebElement element = driver .findElement(By.xpath("/html/body/div/h1/a")); ATUReports.add("Warning Step", LogAs.WARNING, new CaptureScreen(element)); ATUReports.add("Fail step", LogAs.FAILED, new CaptureScreen( ScreenshotOf.DESKTOP)); }

• After performing all above steps, your class file should be as below.
  
  package com.core.testscripts; import java.awt.AWTException; import java.io.IOException; import org.openqa.selenium.By; import org.openqa.selenium.WebDriver; import org.openqa.selenium.WebElement; import org.openqa.selenium.firefox.FirefoxDriver; import org.openqa.selenium.interactions.Actions; import org.testng.Assert; import org.testng.annotations.AfterMethod; import org.testng.annotations.BeforeMethod; import org.testng.annotations.Listeners; import org.testng.annotations.Test; import atu.testng.reports.ATUReports; import atu.testng.reports.listeners.ATUReportsListener; import atu.testng.reports.listeners.ConfigurationListener; import atu.testng.reports.listeners.MethodListener; import atu.testng.reports.logging.LogAs; import atu.testng.selenium.reports.CaptureScreen; import atu.testng.selenium.reports.CaptureScreen.ScreenshotOf; @Listeners({ ATUReportsListener.class, ConfigurationListener.class, MethodListener.class }) public class ReportsTest { { System.setProperty("atu.reporter.config", "C:\\atu.properties"); } private WebDriver driver; private String baseUrl; @BeforeMethod public void setUp() throws Exception { driver = new FirefoxDriver(); baseUrl = "https://www.google.co.in"; driver.get(baseUrl + "/"); // ATU Reports ATUReports.setWebDriver(driver); ATUReports.indexPageDescription = "Test Project"; } @Test public void GoogleTooltip() throws Exception, SQLException { Actions ToolTip1 = new Actions(driver); WebElement googleLogo = driver.findElement(By .xpath("//div[@id='hplogo']")); ToolTip1.clickAndHold(googleLogo).perform(); String ToolTipText = googleLogo.getAttribute("title"); Assert.assertEquals(ToolTipText, "Google"); System.out.println("Tooltip value is: " + ToolTipText); } // ATU Reports Method @Test public void testNewLogs() throws AWTException, IOException { ATUReports.add("INfo Step", LogAs.INFO, new CaptureScreen( ScreenshotOf.BROWSER_PAGE)); ATUReports.add("Pass Step", LogAs.PASSED, new CaptureScreen( ScreenshotOf.DESKTOP)); WebElement element = driver .findElement(By.xpath("/html/body/div/h1/a")); ATUReports.add("Warning Step", LogAs.WARNING, new CaptureScreen(element)); ATUReports.add("Fail step", LogAs.FAILED, new CaptureScreen( ScreenshotOf.DESKTOP)); } @AfterMethod public void tearDown() throws Exception { driver.quit(); } }

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79

  package com.core.testscripts;   import java.awt.AWTException; import java.io.IOException; import org.openqa.selenium.By; import org.openqa.selenium.WebDriver; import org.openqa.selenium.WebElement; import org.openqa.selenium.firefox.FirefoxDriver; import org.openqa.selenium.interactions.Actions;   import org.testng.Assert; import org.testng.annotations.AfterMethod; import org.testng.annotations.BeforeMethod; import org.testng.annotations.Listeners; import org.testng.annotations.Test;   import atu.testng.reports.ATUReports; import atu.testng.reports.listeners.ATUReportsListener; import atu.testng.reports.listeners.ConfigurationListener; import atu.testng.reports.listeners.MethodListener; import atu.testng.reports.logging.LogAs; import atu.testng.selenium.reports.CaptureScreen; import atu.testng.selenium.reports.CaptureScreen.ScreenshotOf;   @Listeners({ ATUReportsListener.class, ConfigurationListener.class, MethodListener.class }) public class ReportsTest {   { System.setProperty("atu.reporter.config", "C:\\atu.properties"); }   private WebDriver driver; private String baseUrl;   @BeforeMethod public void setUp() throws Exception { driver = new FirefoxDriver(); baseUrl = "https://www.google.co.in"; driver.get(baseUrl + "/");   // ATU Reports ATUReports.setWebDriver(driver); ATUReports.indexPageDescription = "Test Project"; }   @Test public void GoogleTooltip() throws Exception, SQLException { Actions ToolTip1 = new Actions(driver); WebElement googleLogo = driver.findElement(By .xpath("//div[@id='hplogo']")); ToolTip1.clickAndHold(googleLogo).perform(); String ToolTipText = googleLogo.getAttribute("title"); Assert.assertEquals(ToolTipText, "Google"); System.out.println("Tooltip value is: " + ToolTipText); }   // ATU Reports Method @Test public void testNewLogs() throws AWTException, IOException {   ATUReports.add("INfo Step", LogAs.INFO, new CaptureScreen( ScreenshotOf.BROWSER_PAGE)); ATUReports.add("Pass Step", LogAs.PASSED, new CaptureScreen( ScreenshotOf.DESKTOP)); WebElement element = driver .findElement(By.xpath("/html/body/div/h1/a")); ATUReports.add("Warning Step", LogAs.WARNING, new CaptureScreen(element)); ATUReports.add("Fail step", LogAs.FAILED, new CaptureScreen( ScreenshotOf.DESKTOP)); }   @AfterMethod public void tearDown() throws Exception { driver.quit(); }   }

• Now, open your TestNG XML file and add necessary Listeners.
  
  <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE suite SYSTEM "http://testng.org/testng-1.0.dtd"> <suite name="Suite" parallel="false"> <test name="Test"> <classes> <class name="com.core.testscripts.ReportsTest"/> </classes> </test> <listeners> <listener class-name="atu.testng.reports.listeners.ATUReportsListener"></listener> <listener class-name="atu.testng.reports.listeners.ConfigurationListener"></listener> <listener class-name="atu.testng.reports.listeners.MethodListener"></listener> </listeners> </suite>

  1 2 3 4 5 6 7 8 9 10 11 12 13 14

  <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE suite SYSTEM "http://testng.org/testng-1.0.dtd"> <suite name="Suite" parallel="false"> <test name="Test"> <classes> <class name="com.core.testscripts.ReportsTest"/> </classes> </test> <listeners> <listener class-name="atu.testng.reports.listeners.ATUReportsListener"></listener> <listener class-name="atu.testng.reports.listeners.ConfigurationListener"></listener> <listener class-name="atu.testng.reports.listeners.MethodListener"></listener> </listeners> </suite>

• That’s it. Now run your project using TestNG. You should be able to see customized graphical TestNG reports at location defined in ATU Reporter’s properties file.

Below is the output of above exercise. It shows TestNG reports in Bar Chart format.

Bar Chart TestNG Report

As you can see, ATU Reporter is very useful in generating good looking TestNG reports. Give it a try and let us know if its useful in your case.