Extent Report with Multiple classes will discuss about how to create a single report when you have multiple classes. Usually people will face issue that they will get the report with single class as all the extent reports related classes will be in the same class but when they have multiple classes then they might not get the single report for all the methods which are there in the different classes.

To overcome this issue, we need to create a separate class to declare the extent reports related classes and need to extend that class to access the object of those classes in each class where we need to generate the report for the test methods.

To show this, here we will create a class(i.e. BaseTest) to declare the extent reports related classes and will create 2 more classes(i.e. Functionality1 and Functionality2) to access these objects and will create a single report from these two classes.

The most important thing here is, once you create an object to the extent report classes we need to access the same object in different classes for this we have declare these variables as static then all the instances share the same copy of that variable. And a class variable can be accessed directly with the class, without the need to create an instance.

Below is the BaseTest class where we can declare the classes which are required to generate the extent reports and will configure the basic information for the report how it should generate. As we know that extent reports will use TestNG to generate the reports. Basic configuration is single time activity so we will put that code in @BeforeSuite and @AfterSuite annotations. And will run the code using testng.xml file as we need to run multiple classes at a time.

import org.testng.ITestResult;
import org.testng.annotations.AfterMethod;
import org.testng.annotations.AfterSuite;
import org.testng.annotations.BeforeSuite;

import com.aventstack.extentreports.ExtentReports;
import com.aventstack.extentreports.ExtentTest;
import com.aventstack.extentreports.Status;
import com.aventstack.extentreports.markuputils.ExtentColor;
import com.aventstack.extentreports.markuputils.MarkupHelper;
import com.aventstack.extentreports.reporter.ExtentHtmlReporter;
import com.aventstack.extentreports.reporter.configuration.ChartLocation;
import com.aventstack.extentreports.reporter.configuration.Theme;

public class BaseTest
{
    public static ExtentHtmlReporter htmlReporter;
    public static ExtentReports extent;
    public static ExtentTest test;
    
    @BeforeSuite
    public void setUp()
    {
        htmlReporter = new ExtentHtmlReporter(System.getProperty("user.dir") +"/test-output/MyOwnReport.html");
        extent = new ExtentReports();
        extent.attachReporter(htmlReporter);
        
        extent.setSystemInfo("OS", "Mac Sierra");
        extent.setSystemInfo("Host Name", "Krishna");
        extent.setSystemInfo("Environment", "QA");
        extent.setSystemInfo("User Name", "Krishna Sakinala");
        
        htmlReporter.config().setChartVisibilityOnOpen(true);
        htmlReporter.config().setDocumentTitle("AutomationTesting.in Demo Report");
        htmlReporter.config().setReportName("My Own Report");
        htmlReporter.config().setTestViewChartLocation(ChartLocation.TOP);
        htmlReporter.config().setTheme(Theme.DARK);
    }
    
    @AfterMethod
    public void getResult(ITestResult result)
    {
        if(result.getStatus() == ITestResult.FAILURE)
        {
            test.log(Status.FAIL, MarkupHelper.createLabel(result.getName()+" Test case FAILED due to below issues:", ExtentColor.RED));
            test.fail(result.getThrowable());
        }
        else if(result.getStatus() == ITestResult.SUCCESS)
        {
            test.log(Status.PASS, MarkupHelper.createLabel(result.getName()+" Test Case PASSED", ExtentColor.GREEN));
        }
        else
        {
            test.log(Status.SKIP, MarkupHelper.createLabel(result.getName()+" Test Case SKIPPED", ExtentColor.ORANGE));
            test.skip(result.getThrowable());
        }
    }
    
    @AfterSuite
    public void tearDown()
    {
        extent.flush();
    }
}

Below is the class1 (i.e. Functionality1) which will have actual test cases/scripts and need to generate the report for the status of the test methods under this class. So, we will extend the BaseTest to this class to access the extent report related classes.

import org.testng.Assert;
import org.testng.annotations.Test;

public class Functionality1 extends BaseTest
{
    @Test
    public void functionality1Test1()
    {
        test = extent.createTest("functionality1Test1");
        Assert.assertTrue(1 > 0);
    }
    
    @Test
    public void functionality1Test2()
    {
        test = extent.createTest("functionality1Test2");
        Assert.assertEquals("Krishna", "Sakinala");
    }
    
    @Test
    public void functionality1Test3()
    {
        test = extent.createTest("functionality1Test3");
        Assert.assertNotEquals("Krishna", "Krishna");
    }
}

Below is the class2 (i.e. Functionality2) which will have actual test cases/scripts and need to generate the report for the status of the test methods under this class. So, we will extend the BaseTest to this class to access the extent report related classes.

import org.testng.Assert;
import org.testng.annotations.Test;

public class Functionality2 extends BaseTest
{
    @Test
    public void functionality2Test1()
    {
        test = extent.createTest("functionality2Test1");
        Assert.assertTrue(1 > 0);
    }
    
    @Test
    public void functionality2Test2()
    {
        test = extent.createTest("functionality2Test2");
        Assert.assertEquals("Krishna", "Sakinala");
    }
    
    @Test
    public void functionality2Test3()
    {
        test = extent.createTest("functionality2Test3");
        Assert.assertNotEquals("Krishna", "Krishna");
    }
}

Now we will run the both classes using testng.xml file and will get the consolidated report for both the classes. Can find the same report below:

This way we can generate the single report from multiple classes.

Please watch the YouTube video of this blog for better understanding.

The post Extent Report With Multiple Classes appeared first on Selenium Webdriver Appium Complete Tutorial.

Capture Screenshot in Extent Reports will discuss about capturing the screenshot of a particular failure step in the HTML report.  In our previous blog we have seen how to log the messages in the report. Same way here we will capture the screenshot for a particular failure step. The screenshot will give the information about on which screen the script  got failed during the execution. Then we can easily identify the issue by looking into the report.

But the issue from Selenium 3 is; it will not capture the full screenshot of the particular page rather it will capture only the visible area of the web page. But sometimes we need to capture full page of the particular web page. Then we can not use the normal screenshot functionality which is provided by the selenium. For this we will use Ashot to capture the full page screenshot of the particular web page. In one of our previous blogs we have seen how to capture the same using Ashot. In this blog, we will use Ashot functionality and make that available in the extent reports.

For this we need to use the log() method of ExtentTest class. To log the screenshot in the report we need to pass the path of the screenshot to the log method as a parameter. So, before logging the screenshot to the report we need to capture the full page screenshot of that particular failure and place it in a folder, from there we need to get the path of the screenshot file and pass it to the log method.

Below is the sample program to capture screenshot in the report:

import org.openqa.selenium.WebDriver;
import org.openqa.selenium.firefox.FirefoxDriver;
import org.testng.Assert;
import org.testng.ITestResult;
import org.testng.annotations.AfterMethod;
import org.testng.annotations.AfterTest;
import org.testng.annotations.BeforeTest;
import org.testng.annotations.Test;

import com.aventstack.extentreports.ExtentReports;
import com.aventstack.extentreports.ExtentTest;
import com.aventstack.extentreports.Status;
import com.aventstack.extentreports.markuputils.ExtentColor;
import com.aventstack.extentreports.markuputils.MarkupHelper;
import com.aventstack.extentreports.reporter.ExtentHtmlReporter;

public class CapturingFullPageScreenshot
{
    ExtentHtmlReporter htmlReporter;
    ExtentReports extent;
    ExtentTest test;
    WebDriver driver;
    
    @BeforeTest
    public void config()
    {
        htmlReporter = new ExtentHtmlReporter(System.getProperty("user.dir") +"/test-output/MyOwnReport.html");
        extent = new ExtentReports();
        extent.attachReporter(htmlReporter);
    }
    
    @Test
    public void captureScreenshot()
    {
        test = extent.createTest("captureScreenshot");
        System.setProperty("webdriver.gecko.driver", "/KRISHNA VOLUME/drivers/geckodriver");
        driver = new FirefoxDriver();
        driver.get("https://automationtesting.in");
        String title = driver.getTitle();
        Assert.assertEquals("Home - Automation Test", title);
    }
    
    @AfterMethod
    public void getResult(ITestResult result) throws Exception
    {
        if (result.getStatus() == ITestResult.FAILURE)
        {
            String screenShotPath = GetFullPageScreenShot.capture(driver, "MyFullPageScreenshot");
            test.log(Status.FAIL, MarkupHelper.createLabel(result.getName()+" Test case FAILED due to below issues:", ExtentColor.RED));
            test.fail(result.getThrowable());
            test.fail("Snapshot below: " + test.addScreenCaptureFromPath(screenShotPath));
        }
        else if(result.getStatus() == ITestResult.SUCCESS)
        {
            test.log(Status.PASS, MarkupHelper.createLabel(result.getName()+" Test Case PASSED", ExtentColor.GREEN));
        }
        else
        {
            test.log(Status.SKIP, MarkupHelper.createLabel(result.getName()+" Test Case SKIPPED", ExtentColor.ORANGE));
            test.skip(result.getThrowable());
        }
        extent.flush();
    }
    
    @AfterTest
    public void endReport()
    {
        driver.quit();
    }
}

In the above program we have written  test.log method to log the screenshot into the extent reports. This information will logged in the report with time stamp.

In the above program we have written  test.log method to log the screenshot into the extent reports. This information will logged in the report with time stamp. addScreenCaptureFromPath() is a method to place the screenshot in the extent report.

Below is the program to capture the full page screenshot and it will place the screenshot in a particular folder and will return the path of the screenshot. Will use that path to capture the full page screenshot in the HTML report for a failure step.

import org.openqa.selenium.WebDriver;
import ru.yandex.qatools.ashot.AShot;
import ru.yandex.qatools.ashot.Screenshot;
import ru.yandex.qatools.ashot.shooting.ShootingStrategies;

import javax.imageio.ImageIO;
import java.io.File;

public class GetFullPageScreenShot
{
    public static String capture(WebDriver driver, String screenShotName) throws Exception
    {
        Screenshot screenshot = new AShot().shootingStrategy(ShootingStrategies.viewportPasting(1000)).takeScreenshot(driver);
        String dest = System.getProperty("user.dir") + "/ErrorScreenshots/" + screenShotName + ".png";
        ImageIO.write(screenshot.getImage(),"PNG",new File(dest));
        return dest;
    }
}

Above program will return the path of the screenshot.

Below is the output of the above program:

Please watch the YouTube video of this blog for better understanding.

The post Capture FullPage Screenshot in Extent Reports – Java appeared first on Selenium Webdriver Appium Complete Tutorial.

Capture Screenshot in Extent Reports will discuss about capturing the screenshot of a particular failure step in the HTML report.  In our previous blog we have seen how to log the messages in the report. Same way here we will capture the screenshot for a particular failure step. The screenshot will give the information about on which screen the script  got failed during the execution. Then we can easily identify the issue by looking into the report.

For this we need to use the log() method of ExtentTest class. To log the screenshot in the report we need to pass the path of the screenshot to the log method as a parameter. So, before logging the screenshot to the report we need to capture the screenshot of that particular failure method and place it in a folder from there we need to get the path of the screenshot file and pass it to the log method.

Below is the sample program to capture screenshot in the report:

import java.io.IOException;

import org.openqa.selenium.WebDriver;
import org.openqa.selenium.firefox.FirefoxDriver;
import org.testng.Assert;
import org.testng.ITestResult;
import org.testng.annotations.AfterMethod;
import org.testng.annotations.AfterTest;
import org.testng.annotations.BeforeTest;
import org.testng.annotations.Test;

import com.aventstack.extentreports.ExtentReports;
import com.aventstack.extentreports.ExtentTest;
import com.aventstack.extentreports.Status;
import com.aventstack.extentreports.markuputils.ExtentColor;
import com.aventstack.extentreports.markuputils.MarkupHelper;
import com.aventstack.extentreports.reporter.ExtentHtmlReporter;

public class CapturingScreenshot
{
    ExtentHtmlReporter htmlReporter;
    ExtentReports extent;
    ExtentTest test;
    WebDriver driver;
    
    @BeforeTest
    public void config()
    {
        htmlReporter = new ExtentHtmlReporter(System.getProperty("user.dir") +"/test-output/MyOwnReport.html");
        extent = new ExtentReports();
        extent.attachReporter(htmlReporter);
    }
    
    @Test
    public void captureScreenshot()
    {
        test = extent.createTest("captureScreenshot");
        System.setProperty("webdriver.gecko.driver", "/KRISHNA VOLUME/drivers/geckodriver");
        driver = new FirefoxDriver();
        driver.get("https://automationtesting.in");
        String title = driver.getTitle();
        Assert.assertEquals("Home - Automation Test", title);
        }
    
    @AfterMethod
    public void getResult(ITestResult result) throws IOException
    {
        if (result.getStatus() == ITestResult.FAILURE)
        {
            String screenShotPath = GetScreenShot.capture(driver, "screenShotName");
            test.log(Status.FAIL, MarkupHelper.createLabel(result.getName()+" Test case FAILED due to below issues:", ExtentColor.RED));
            test.fail(result.getThrowable());
            test.fail("Snapshot below: " + test.addScreenCaptureFromPath(screenShotPath));
        }
        else if(result.getStatus() == ITestResult.SUCCESS)
        {
            test.log(Status.PASS, MarkupHelper.createLabel(result.getName()+" Test Case PASSED", ExtentColor.GREEN));
        }
        else
        {
            test.log(Status.SKIP, MarkupHelper.createLabel(result.getName()+" Test Case SKIPPED", ExtentColor.ORANGE));
            test.skip(result.getThrowable());
        }
        extent.flush();
    }
    
    @AfterTest
    public void endReport()
    {
        driver.quit();
    }
}

In the above program we have written  test.log method to log the screenshot into the extent reports. This information will logged in the report with time stamp.




Below is the program to capture the screenshot and it will place the screenshot in a particular folder and will return the path of the screenshot. Will use that path to capture the screenshot in the HTML report for a failure step.

import java.io.File;
import java.io.IOException;
import org.apache.commons.io.FileUtils;
import org.openqa.selenium.OutputType;
import org.openqa.selenium.TakesScreenshot;
import org.openqa.selenium.WebDriver;

public class GetScreenShot {
    
    public static String capture(WebDriver driver,String screenShotName) throws IOException
    {
        TakesScreenshot ts = (TakesScreenshot)driver;
        File source = ts.getScreenshotAs(OutputType.FILE);
        String dest = System.getProperty("user.dir") +"\ErrorScreenshots\"+screenShotName+".png";
        File destination = new File(dest);
        FileUtils.copyFile(source, destination);        
                    
        return dest;
    }
}

Above program will return the path of the screenshot.

Below is the output of the above program:

Please watch the YouTube video of this blog for better understanding.

The post Capture Screenshot in Extent Reports – Java – Version3 appeared first on Selenium Webdriver Appium Complete Tutorial.

Extent Reports Log Generation will discuss about how to generate log steps in the Extent Reports. While running the test suite user want to log some information about the execution in the report. This information will help the user to understand the test step execution flow and any failures during the test suite execution.

By using Extent Reports we can generate logs in the HTML report. For this we need use the log() method of the ExtentTest Class. By using this method not only log the step information, we can provide the PASS, FAIL and SKIP information of the particular test case. To log the information we need to use the Status.INFO as first parameter in the log() method. And we need to use Status.PASS for the passed test case and Status.FAIL for the failed test cases.

Not only log the information in the report as plain text, along with this we can also apply some backgrounds to that information using Label concept in the extent reports. By using this we can apply different colours to the log information.

Below is the sample program for generating step logs in the report:

import org.testng.annotations.AfterTest;
import org.testng.annotations.BeforeTest;
import org.testng.annotations.Test;

import com.aventstack.extentreports.ExtentReports;
import com.aventstack.extentreports.ExtentTest;
import com.aventstack.extentreports.Status;
import com.aventstack.extentreports.markuputils.ExtentColor;
import com.aventstack.extentreports.markuputils.MarkupHelper;
import com.aventstack.extentreports.reporter.ExtentHtmlReporter;

public class CreatingLogs
{
    ExtentHtmlReporter htmlReporter;
    ExtentReports extent;
    ExtentTest test;
    
    @BeforeTest
    public void config()
    {
        htmlReporter = new ExtentHtmlReporter(System.getProperty("user.dir") +"/test-output/MyOwnReport.html");
        extent = new ExtentReports();
        extent.attachReporter(htmlReporter);
    }
    
    @Test
    public void logsGeneration()
    {
        test = extent.createTest("logsGeneration");
        test.log(Status.INFO,"createTest() method will return the ExtentTest object");
        test.log(Status.INFO, "I am in actual Test");
        test.log(Status.INFO, "We can write the actual test logic in this Test");
        
        // Using Labels
        test.log(Status.INFO, MarkupHelper.createLabel("*************** Using Labels ***************", ExtentColor.RED));
        test.log(Status.INFO, MarkupHelper.createLabel("This is Test Logger 1", ExtentColor.BLUE));
        test.log(Status.INFO, MarkupHelper.createLabel("This is Test Logger 2", ExtentColor.BLUE));
        test.log(Status.INFO, MarkupHelper.createLabel("This is Test Logger 3", ExtentColor.BLUE));
        test.log(Status.INFO, MarkupHelper.createLabel("This is Test Logger 4", ExtentColor.BLUE));
    }
    
    @AfterTest
    public void tearDown()
    {
        extent.flush();
    }
}

In the above program we have written so many test.log methods to log the information into the extent reports. This information will logged in the report with time stamp.

Below is the output/report of the above program.

Please watch the YouTube video of this blog for better understanding.

The post Extent Reports Log Generation – Java – Version3 appeared first on Selenium Webdriver Appium Complete Tutorial.

Extent reports are very rich HTML reports for the selenium webdriver. This report will give so much of information about the execution status. The extra information can be provided using some of the methods provided by the extent reports classes.

We can provide below information to be displayed in the HTML report:

1. Report Title
2. Report Name
3. PIE Chart Visibility
4. PIE Chart Location
5. Document Theme
6. Operating System Name
7. Hostname
8. Environment Name
9. User Name etc…

Below is the sample program:

import org.testng.Assert;
import org.testng.ITestResult;
import org.testng.SkipException;
import org.testng.annotations.AfterMethod;
import org.testng.annotations.AfterTest;
import org.testng.annotations.BeforeTest;
import org.testng.annotations.Test;

import com.aventstack.extentreports.ExtentReports;
import com.aventstack.extentreports.ExtentTest;
import com.aventstack.extentreports.Status;
import com.aventstack.extentreports.markuputils.ExtentColor;
import com.aventstack.extentreports.markuputils.MarkupHelper;
import com.aventstack.extentreports.reporter.ExtentHtmlReporter;
import com.aventstack.extentreports.reporter.configuration.ChartLocation;
import com.aventstack.extentreports.reporter.configuration.Theme;

public class GenerateExtentReport
{
    ExtentHtmlReporter htmlReporter;
    ExtentReports extent;
    ExtentTest test;
        
    @BeforeTest
    public void startReport()
    {
        htmlReporter = new ExtentHtmlReporter(System.getProperty("user.dir") +"/test-output/MyOwnReport.html");
        extent = new ExtentReports();
        extent.attachReporter(htmlReporter);
        
        extent.setSystemInfo("OS", "Mac Sierra");
        extent.setSystemInfo("Host Name", "Krishna");
        extent.setSystemInfo("Environment", "QA");
        extent.setSystemInfo("User Name", "Krishna Sakinala");
        
        htmlReporter.config().setChartVisibilityOnOpen(true);
        htmlReporter.config().setDocumentTitle("AutomationTesting.in Demo Report");
        htmlReporter.config().setReportName("My Own Report");
        htmlReporter.config().setTestViewChartLocation(ChartLocation.TOP);
        htmlReporter.config().setTheme(Theme.DARK);
    }
    
    @Test
    public void demoTestPass()
    {
        test = extent.createTest("demoTestPass", "This test will demonstrate the PASS test case");
        Assert.assertTrue(true);
    }
    
    @Test
    public void demoTestFail()
    {
        test = extent.createTest("demoTestFail", "This test will demonstrate the FAIL test case");
        Assert.assertTrue(false);
    }
    
    @Test
    public void demoTestSkip()
    {
        test = extent.createTest("demoTestSkip", "This test will demonstrate the SKIP test case");
        throw new SkipException("This test case not ready for execution");
    }
    
    @AfterMethod
    public void getResult(ITestResult result)
    {
        if(result.getStatus() == ITestResult.FAILURE)
        {
            test.log(Status.FAIL, MarkupHelper.createLabel(result.getName()+" Test case FAILED due to below issues:", ExtentColor.RED));
            test.fail(result.getThrowable());
        }
        else if(result.getStatus() == ITestResult.SUCCESS)
        {
            test.log(Status.PASS, MarkupHelper.createLabel(result.getName()+" Test Case PASSED", ExtentColor.GREEN));
        }
        else
        {
            test.log(Status.SKIP, MarkupHelper.createLabel(result.getName()+" Test Case SKIPPED", ExtentColor.ORANGE));
            test.skip(result.getThrowable());
        }
    }
    
    @AfterTest
    public void tearDown()
    {
        extent.flush();
    }
}

In the above program, we have used three classes called ExtentHtmlReporter, ExtentReports and ExtentTest. These three classes will help us to create a rich HTML reports with lot of useful information. ExtentHtmlReporter will take the HTML report file path as an argument and it will create the report file with the mentioned name in the mentioned location. By using this we can set lot of configuration to the report. ExtentReports will be used to set the system/custom information in the generated HTML report. And ExtentTest will be used to log the so much information to the report like PASS, FAIL  and SKIP status of the executed tests. Along with this we can generate logs in the generated HTML report.

Important points to be remember:

1. ExtentHtmlReporter will create the report file and set the configuration to the report.
2. ExtentReports will set the system/custom information to the report.
3. ExtentTest will log the information in the report.
4. createTest() method of ExtentReports class is the starting point of the test and it will return the ExtentTest object.
5. We need to capture that object into ExtentTest object.
6. Used this reference to log the information into the report.
7. ExtentHtmlReporter object will be used to add the report information like Title, Header and Theme etc..
8. flush() method of ExtentReports will push/write everything to the document.

Output of the above program is:

Please watch the YouTube video of this blog for better understanding.

The post Generating Extent Reports – Java – Version3 appeared first on Selenium Webdriver Appium Complete Tutorial.

In software test automation after completion of the test suite execution we need to have a report for the execution status and it is the only way of evidence for the pass and fail status of the tests. And most of the clients bother about the detailed report of the execution status. Most of the licensed automation testing tools will have in built rich report option to show the execution status. But coming to open source automation tools lacking in this option. Same way, Selenium also does not have the automation report generation option. But to execute the test suite, selenium is depending on unit testing frameworks like TestNG and Junit.

After test suite execution using TestNG or Junit, by default they will give the HTML reports, but the information provided by these reports are not so good. To avoid this, we are using XSLT reports, these are much better than normal TestNG and Junit reports.These will give a pie chart to represent the PASS,FAIL and SKIP test cases. Apart from this PIE Chart it will not give anymore information in the generated HTML report. If we want any other information we need to write separate code. And configuring XSLT reports also bit tedious process. For this, we need to install and configure the ant in the machine and follow certain procedure to generate these reports.

TestNG Default Report:

XSLT Report:

To overcome these type of issues, we can use Extent Reports. These are very good and rich HTML reports. By using these reports we can provide lot information to the reports. These will also give the status in the form of PIE Chart. We have two variants of extent reports one is Community version and the other is paid version. But most of the things can be achieved using community version.

Below are the advantages provided by the Extent Reports:

1. Status will be shown in the form of PIE chart.
2. Can replace the existing report with the new report or append the new status to the existing report.
3. We can change display order of the tests(i.e. oldest test at the top, newest at the end or newest test at the top, oldest at the end)
4. Can generate ONLINE or OFFLINE reports.
5. Can give the our own name to the test method (i.e can change the test method name in the report).
6. Can generate stepwise log information in the report.
7. Can segregate the tests using Test Categories.
8. Can give test author name to display in the report.
9. Can add a test node as a child of another test.
10. Can insert any custom HTML in the logs by using an HTML tag.
11. Can show the screenshots in the report wherever we need.
12. Can add recording of your test runs in the report.
13. Can add our own information in the report (i.e. version of selenium used, Environment information where the test suite executed).
14. Can give our own name to the HTML report.
15. You can give the System information in the report (i.e. HostName and OS used to execute the test suite.)

The above are the advantages provided by the extent reports. We can discuss all these things in the coming blogs.

Extent Report:

You can find the complete information in the below link:

http://extentreports.com/docs/versions/3/java/

You can download the Extent Reports Jars in this link:

http://extentreports.com/community/

Last but not least, a big thanks to Anshoo Arora for giving this type of reports.

Please watch the YouTube video of this blog for better understanding.

The post Extent Reports Introduction – Java – Version3 appeared first on Selenium Webdriver Appium Complete Tutorial.