CODEWITHSUNDEEP
javaseleniumreportwebdrivertestng
David Tishkoff
David Tishkoff

Reputation: 21

Create Custom TestNG Report - WebDriver

I'm trying to implement org.testng IReporter Interface. My Java is not that great, base on some example I found online I was able to create a Reporter class. The problem I'm having is how to use it and where do I call it and how and which parameters to pass to it?

public class Reporter implements IReporter {

public void generateReport(List<XmlSuite> xmlSuites, List<ISuite> suites, String outputDirectory){
      ISuiteResult results =suites.get(0).getResults().get("Sanity Suite");
      ITestContext context = results.getTestContext();

      IResultMap passedTests = context.getPassedTests();
      IResultMap failedTests = context.getFailedTests();

      // Print all test exceptions...
      for( ITestResult r: failedTests.getAllResults()) {
          System.out.println( r.getThrowable());
      }
}

}

For example I have this WebDriver Selenium TestNG test:

public class VerifyTest extends TestBase {

@Test
public void test1() {
    verifyTrue(false);
    verifyEquals("pass", "fail");
    verifyFalse(true);
}

@Test
public void test2() {
    verifyTrue(false);
    assertEquals("pass", "fail");
    verifyFalse(true);
}

How would I use my Reporter to get a customize report at the end of the run???

Thank You!

Upvotes: 1

Views: 20228

Answers (5)

saba
saba

Reputation: 539

Beautiful reporting with realtime report of any running test is possible using RealTime report plugin. Very easy to use and no modification needed in existing code, for details please visit this github url RealTimeReport

You can find details implementation of different TestNg Reporting intrfaces

enter image description here

Upvotes: 1

Raju
Raju

Reputation: 21

You can use 

@Listeners(ReporterClassName.class)

ex: @Listeners(Reporter.class)

public class VerifyTest extends TestBase

Upvotes: 1

djangofan
djangofan

Reputation: 29669

I created a project that is an example of generating a customized report.

The basic idea is to create a Listener class and reference it in the testing.xml file. 

<listeners>
    <listener class-name="qa.hs.framework.CustomReportListener"/>
  </listeners>

And then create the class:

 public class CustomReportListener implements IReporter {

    @Override
    public void generateReport( List<XmlSuite> xmlSuites, List<ISuite> suites, 
           String outputDirectory ) {
       System.out.println();
       //Iterating over each suite included in the test
       for (ISuite suite : suites) {
       //Following code gets the suite name
       String suiteName = suite.getName();
       //Getting the results for the said suite
       Map<String, ISuiteResult> suiteResults = suite.getResults();
       for ( ISuiteResult sr : suiteResults.values() ) {
          ITestContext tc = sr.getTestContext();
          System.out.println("Passed tests for suite '" + suiteName + "' is:" +
               tc.getPassedTests().getAllResults().size());
        }
        CustomReport cr = new CustomReport();
        cr.generateReport( xmlSuites, suites, outputDirectory );
        ...

Then, from that Listener class you can create a "Report Writer" class that creates any arbitrary HTML output using something like so:

public class CustomReport extends CustomReportListener
{
        private static final Logger LOG = Logger.getLogger( CustomReport.class );
        private static final SimpleDateFormat dateFormatter = new SimpleDateFormat(" MMM d 'at' hh:mm a");

        private String reportFileName = Constants.reportFileName;
        private PrintWriter m_out;
        private int m_row;
        private Integer m_testIndex;
        private int m_methodIndex;
        private Scanner scanner;

        @Override
        public void generateReport( List<XmlSuite> xml, List<ISuite> suites, String outdir ) {
                try {
                        m_out = createWriter( outdir );
                }
                catch ( IOException e ) {
                        LOG.error("output file", e);
                        return;
                }
                startHtml(m_out);
                generateSuiteSummaryReport(suites);
                generateMethodSummaryReport(suites);
                generateMethodDetailReport(suites);
                endHtml(m_out);
                m_out.flush();
                m_out.close();
        }

And finally, from that "CustomReport" class your "generate report" methods all have access to all data from the report, such as:

testContext.getPassedTests()
Map<String, ISuiteResult> r = suite.getResults()
method.getDescription()
method.getTestClass().getName()
ITestResult.SUCCESS
tests.getAllMethods()
overview.getStartDate().getTime()
overview.getIncludedGroups()
etc.

Upvotes: 1

niharika_neo
niharika_neo

Reputation: 8531

David, you can add your custom reporter to your testng.xml in case you are invoking your tests through an xml in the suite section.

<listeners>
<listener class-name="yourpackage.Reporter"/> </listeners>

In case you are programmatically invoking those, then you need to add it through your code as documented @ Running TestNG programmatically

If you are invoking your tests from command line, refer this

This reporter would be invoked by TestNG at then end of all the runs, if you specify in either of the above ways.

Upvotes: 1

Cedric Beust
Cedric Beust

Reputation: 15608

Just expand your skeleton above to generate your results where you want them, .xml, .html, text file, etc...

Upvotes: 1

Related Questions