ExtentReports in Selenium

Why do we need reporting?

Status to:

                1)Upper Management

                2)Development Team

                3)Product/Project Management

1)Representation of automation efforts outside of the team

2- Using reports we calculate the time taken by each test case that helps to calculate ROI(Return on Investment).

3- You can share automation reports with your team and clients as well to share the status of testing progress etc.

What goes in Reports?

        1)High level status of automation run

        2)Should clearly represent the Test Suite/Test Class

        3)Name of Test Classes, Test Methods

        4)Status of Test Methods (Success/Failed/Skipped)

        5)No need to put exception messages/other details of debugging

Why Extent Reports?

      1) Beautiful-looking reports

        2)Automation Framework Independent

        3) Easy-to-use APIs

        4)Provides a dashboard for the entire run

        5)Attach Screenshots

        6)Customizable

For More Information on extent reports refer link: ExtentReportDocumentation

------------------------------------------------------------------------------------------------------------------

ExtentMnager.Java

package com.qa.linkedin.listeners;

import java.io.File;

import java.util.Date;

import org.apache.logging.log4j.LogManager;

import org.apache.logging.log4j.Logger;

import com.aventstack.extentreports.ExtentReports;

import com.aventstack.extentreports.reporter.ExtentHtmlReporter;

import com.aventstack.extentreports.reporter.configuration.Theme;

import com.qa.linkedin.util.Constants;

import com.qa.linkedin.util.TestUtil;

public class ExtentManager {

  private static final Logger log = LogManager.getLogger(ExtentManager.class.getName());

    private static ExtentReports extent;

    public static ExtentReports getInstance() {

        if (extent == null) {

            createInstance();

        }

        return extent;

    }

public static synchronized ExtentReports createInstance() {

        String fileName = TestUtil.getReportName();

        String reportsDirectory = Constants.REPORTS_DIRECTORY;

        new File(reportsDirectory).mkdirs();

        String path = reportsDirectory + fileName;

        log.info("*********** Report Path ***********");

        log.info(path);

        log.info("*********** Report Path ***********");

        ExtentHtmlReporter htmlReporter = new ExtentHtmlReporter(path);    htmlReporter.config().setTheme(Theme.STANDARD);

    htmlReporter.config().setDocumentTitle("Linkedin Automation Test Run");

    htmlReporter.config().setEncoding("utf-8");

    htmlReporter.config().setReportName(fileName);

    extent = new ExtentReports();

    extent.setSystemInfo("Organization", "RameshQaAutomationPlatform");

    extent.setSystemInfo("Automation Framework", "Selenium Webdriver");

    extent.setSystemInfo("Automation Tester", "Ramesh");

    extent.setSystemInfo("Build no", "QA-1234");

    extent.attachReporter(htmlReporter);

    

    return extent;

}

}

=================================================

ExtentReportListener:

----------------------------------------------------------------------------

package com.qa.linkedin.listeners;

import java.io.IOException;

import java.util.Arrays;

import java.util.Calendar;

import java.util.Date;

import org.apache.logging.log4j.LogManager;

import org.apache.logging.log4j.Logger;

import org.openqa.selenium.WebDriver;

import org.testng.ITestContext;

import org.testng.ITestListener;

import org.testng.ITestNGMethod;

import org.testng.ITestResult;

import org.testng.Reporter;

import com.aventstack.extentreports.ExtentReports;

import com.aventstack.extentreports.ExtentTest;

import com.aventstack.extentreports.MediaEntityBuilder;

import com.aventstack.extentreports.Status;

import com.aventstack.extentreports.markuputils.ExtentColor;

import com.aventstack.extentreports.markuputils.Markup;

import com.aventstack.extentreports.markuputils.MarkupHelper;

import com.qa.linkedin.base.TestBase;

import com.qa.linkedin.base.WebDriverFactory;

import com.qa.linkedin.util.BasePageWebActions;

import com.qa.linkedin.util.TestUtil;

public class ExtentReportListener extends TestBase implements ITestListener {

    private static ExtentReports extentReports = ExtentManager.getInstance();

    private static ThreadLocal<ExtentTest> extentTest = new ThreadLocal<ExtentTest>();

    private static final Logger log = LogManager.getLogger(ExtentReportListener.class.getName());

    /**

     * Invoked after the test class is instantiated and before

     * any configuration method is called.

     *

     * @param context

     */

    public void onStart(ITestContext context) {

        log.info("onStart -> Test Tag Name: " + context.getName());

        ITestNGMethod methods[] = context.getAllTestMethods();

        log.info("These methods will be executed in this <test> tag");

        for (ITestNGMethod method: methods) {

            log.info(method.getMethodName());

        }

    }

    /**

     * Invoked after all the tests have run and all their

     * Configuration methods have been called.

     *

     * @param context

     */

    public void onFinish(ITestContext context) {

        log.info("onFinish -> Test Tag Name: " + context.getName());

        extentReports.flush();

    }

    /**

     * Invoked each time before a test method will be invoked.

     *

     * @param result

     * @see ITestResult#STARTED

     */

    public void onTestStart(ITestResult result) {

        ExtentTest test = extentReports.createTest(result.getInstanceName() + " :: "

                + result.getMethod().getMethodName());

        extentTest.set(test);

    }

    /**

     * Invoked each time a test method succeeds.

     *

     * @param result

     * @see ITestResult#SUCCESS

     */

    public void onTestSuccess(ITestResult result) {

        log.info("onTestSuccess -> Test Method Name: " + result.getName());

        String methodName = result.getMethod().getMethodName();

        String logText = "<b>" + "Test Method " + methodName + " Successful" + "</b>";

        Markup m = MarkupHelper.createLabel(logText, ExtentColor.GREEN);

        extentTest.get().log(Status.PASS, m);

    }

    /**

     * Invoked each time a test method fails.

     *

     * @param result

     * @see ITestResult#FAILURE

     */

    public void onTestFailure(ITestResult result) {

        log.info("onTestFailure -> Test Method Name: " + result.getName());

        String methodName = result.getMethod().getMethodName();

        String exceptionMessage = Arrays.toString(result.getThrowable().getStackTrace());

        extentTest.get().fail("<details>" + "<summary>" + "<b>" + "<font color=red>" +

                "Exception Occurred: Click to see details: " + "</font>" + "</b>" + "</summary>" +

        exceptionMessage.replaceAll(",", "<br>") + "</details>" + " \n");

        String browser = WebDriverFactory.getInstance().getBrowser();

        WebDriver driver = WebDriverFactory.getInstance().getDriver(browser);

        BasePageWebActions cd = new BasePageWebActions();

        String path = cd.takeScreenshot(result.getName(), browser);

        try {

            extentTest.get().fail("<b>" + "<font color=red>" +

                    "Screenshot of failure" + "</font>" + "</b>",

                    MediaEntityBuilder.createScreenCaptureFromPath(path).build());

        } catch (IOException e) {

            extentTest.get().fail("Test Method Failed, cannot attach screenshot");

        }

        String logText = "<b>" + "Test Method " + methodName + " Failed" + "</b>";

        Markup m = MarkupHelper.createLabel(logText, ExtentColor.RED);

        extentTest.get().log(Status.FAIL, m);

    }

    /**

     * Invoked each time a test method is skipped.

     *

     * @param result

     * @see ITestResult#SKIP

     */

    public void onTestSkipped(ITestResult result) {

        log.info("onTestSkipped -> Test Method Name: " + result.getName());

        String methodName = result.getMethod().getMethodName();

        String logText = "<b>" + "Test Method " + methodName + " Skipped" + "</b>";

        Markup m = MarkupHelper.createLabel(logText, ExtentColor.YELLOW);

        extentTest.get().log(Status.PASS, m);

    }

    /**

     * Invoked each time a method fails but has been annotated with

     * successPercentage and this failure still keeps it within the

     * success percentage requested.

     *

     * @param result <code>ITestResult</code> containing information about the run test

     * @see ITestResult#SUCCESS_PERCENTAGE_FAILURE

     */

    public void onTestFailedButWithinSuccessPercentage(ITestResult result) {

        // Ignore this

    }

}

-------------------------------------------------------------------