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.relevantcodes.extentreports.ExtentReports;
import com.relevantcodes.extentreports.ExtentTest;
import com.relevantcodes.extentreports.LogStatus;

public class CapturingScreenshot
{
    ExtentReports extent;
    ExtentTest test;
    WebDriver driver;
    
    @BeforeTest
    public void init()
    {
        extent = new ExtentReports(System.getProperty("user.dir") + "/test-output/ExtentScreenshot.html", true);
    }
    
    @Test
    public void captureScreenshot()
    {
        test = extent.startTest("captureScreenshot");
        driver = new FirefoxDriver();
        driver.get("https://automationtesting.in");
        String title = driver.getTitle();
        Assert.assertEquals("Home - Automation Test", title);
        test.log(LogStatus.PASS, "Test Passed");
    }
    
    @AfterMethod
    public void getResult(ITestResult result) throws IOException
    {
        if(result.getStatus() == ITestResult.FAILURE)
        {
            String screenShotPath = GetScreenShot.capture(driver, "screenShotName");
            test.log(LogStatus.FAIL, result.getThrowable());
            test.log(LogStatus.FAIL, "Snapshot below: " + test.addScreenCapture(screenShotPath));
        }
        extent.endTest(test);
    }
    
        
    @AfterTest
    public void endreport()
    {
        driver.close();
        extent.flush();
        extent.close();
    }
}

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 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 LogStatus.INFO as first parameter in the log() method. And we need to use LogStatus.PASS for the passed test case and LogStatus.FAIL for the failed test cases.

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.relevantcodes.extentreports.ExtentReports;
import com.relevantcodes.extentreports.ExtentTest;
import com.relevantcodes.extentreports.LogStatus;

public class CreatingStepLogs
{
    ExtentReports extent;
    ExtentTest test;
    
    @BeforeTest
    public void config()
    {
        extent = new ExtentReports(System.getProperty("user.dir") +"/test-output/ExtentStepLogs.html", true);
    }
    
    @Test
    public void stepLogsGeneration()
    {
        test = extent.startTest("stepLogsGeneration");
        test.log(LogStatus.INFO, "startTest() method will return the Extent Test object ");
        test.log(LogStatus.INFO, "I am in actual test method");
        test.log(LogStatus.INFO, "We Can Write The Actual Test Logic In This Test");
    }
        
    @AfterTest
    public void tearDown()
    {
        extent.endTest(test);
        test.log(LogStatus.INFO, "endTest() method will stop capturing information about the test log");
        extent.flush();
        test.log(LogStatus.INFO, "flush() method of ExtentReports wil push/write everything to the document");
        test.log(LogStatus.INFO, "close() method will clear/close all resource of the ExtentReports object");
        extent.close();
    }
}

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 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 from the external XML file. Once you create the XML file need to load in the program to read the configuration.

We can provide below information to the report using XML file:

1. Report Title
2. Report Name
3. Report Headline
4. Date Format
5. Time Format

Apart from the above we can provide HostName, Environment Information and User Name etc… from the program.

Below is the sample program:

import java.io.File;
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.relevantcodes.extentreports.ExtentReports;
import com.relevantcodes.extentreports.ExtentTest;
import com.relevantcodes.extentreports.LogStatus;

public class GenerateExtentReport
{
    ExtentReports extent;
    ExtentTest test;
        
    @BeforeTest
    public void startReport()
    {
        extent = new ExtentReports(System.getProperty("user.dir") +"/test-output/MyOwnReport.html", true);
        extent
        .addSystemInfo("Host Name", "Krishna")
        .addSystemInfo("Environment", "QA")
        .addSystemInfo("User Name", "Krishna Sakinala");
        extent.loadConfig(new File(System.getProperty("user.dir")+"\\extent-config.xml"));
    }
    
    @Test
    public void demoReportPass()
    {
        test=extent.startTest("demoReportPass");
        Assert.assertTrue(true);
        test.log(LogStatus.PASS, "Assert Pass as condition is True");
    }
    
    @Test
    public void demoReportFail()
    {
        test=extent.startTest("demoReportFail");
        Assert.assertTrue(false);
        test.log(LogStatus.FAIL, "Assert Fail as condition is False");
    }
    
    @AfterMethod
    public void getResult(ITestResult result)
    {
        if(result.getStatus()==ITestResult.FAILURE)
        {
            test.log(LogStatus.FAIL, result.getThrowable());
            
        }
        extent.endTest(test);
    }
    
    @AfterTest
    public void endreport()
    {
        extent.flush();
        extent.close();
    }
}

In the above program, we have used two classes called ExtentReports, ExtentTest. These two classes objects will help us to create a rich HTML reports with lot of useful information. ExtentReports  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. And ExtentTest will be used to log the so much information to the report like PASS, FAIL  and SKIP status of the executed tests.

Important points to be remember:

1. ExtentReports will create the report file.
2. ExtentTest will log the information in the report.
3. startTest() method of ExtentReports class is the starting point of the test and it will return the ExtentTest object.
4. We need to capture that object into ExtentTest object.
5. Used this reference to log the information into the report.
6. ExtentReports object will be used to add the report information like Title, Header and Theme etc..
7. And the above configuration need to passed from the external XML file using loadConfig() method of ExtentReports class. It will take the XML file path as argument.
8. endTest() method of ExtentReports will stop capturing information about the test log.
9. flush() method of ExtentReports wil push/write everything to the document.
10. close() method of ExtentReports will clear/close all resource of the ExtentReports object.

Below is the sample configuration file:

<!--?xml version="1.0" encoding="UTF-8"?-->

  
    <!-- report theme -->
    <!-- standard, dark -->
    standard
  
    <!-- document encoding -->
    <!-- defaults to UTF-8 -->
    UTF-8
    
    <!-- protocol for script and stylesheets -->
    <!-- defaults to https -->
    https
    
    <!-- title of the document -->
    ExtentReports 2.0
    
    <!-- report name - displayed at top-nav -->
    Automation Report
    
    <!-- report headline - displayed at top-nav, after reportHeadline -->
    
    
    <!-- global date format override -->
    <!-- defaults to yyyy-MM-dd -->
    yyyy-MM-dd
    
    <!-- global time format override -->
    <!-- defaults to HH:mm:ss -->
    HH:mm:ss
    
    <!-- custom javascript -->
    <scripts>
      <![CDATA[ $(document).ready(function() { }); ]]>
    </scripts>
    
    <!-- custom styles -->
    <styles>
      <![CDATA[ ]]>
    </styles>
  </configuration>
</extentreports>

This ways we can configure the report information and can generate the extent reports.

Output of the above program is:

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

The post Generating Extent Reports – Java 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.

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.

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. It will 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.relevantcodes.com/java/

You can download the Extent Reports Jars in this link:

http://extentreports.relevantcodes.com/

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 appeared first on Selenium Webdriver Appium Complete Tutorial.