Extent Report in Selenium Testing

Extent Reports are advanced reporting tools used to generate interactive and visually appealing reports for Selenium automation test results. This section explains how to integrate and use Extent Reports in Selenium with a detailed example.

Required Maven Dependencies

Add the following dependencies in your pom.xml if using Maven:

<dependencies>
                <!-- Selenium Java -->
                <dependency>
                    <groupId>org.seleniumhq.selenium</groupId>
                    <artifactId>selenium-java</artifactId>
                    <version>4.12.1</version>
                </dependency>
            
                <!-- Extent Reports -->
                <dependency>
                    <groupId>com.aventstack</groupId>
                    <artifactId>extentreports</artifactId>
                    <version>5.0.9</version>
                </dependency>
            </dependencies>
                

Complete Java Code for Selenium with Extent Reports

import org.openqa.selenium.WebDriver;
            import org.openqa.selenium.chrome.ChromeDriver;
            import org.testng.Assert;
            import org.testng.annotations.AfterClass;
            import org.testng.annotations.BeforeClass;
            import org.testng.annotations.Test;
            
            import com.aventstack.extentreports.ExtentReports;
            import com.aventstack.extentreports.ExtentTest;
            import com.aventstack.extentreports.Status;
            import com.aventstack.extentreports.reporter.ExtentHtmlReporter;
            import com.aventstack.extentreports.reporter.configuration.Theme;
            
            public class ExtentReportExample {
            
                ExtentReports extent;
                ExtentHtmlReporter htmlReporter;
                ExtentTest test;
                WebDriver driver;
            
                @BeforeClass
                public void setup() {
                    htmlReporter = new ExtentHtmlReporter("test-output/ExtentReport.html");
                    htmlReporter.config().setTheme(Theme.STANDARD);
                    htmlReporter.config().setDocumentTitle("Selenium Test Report");
                    htmlReporter.config().setReportName("Extent Report Demo");
            
                    extent = new ExtentReports();
                    extent.attachReporter(htmlReporter);
                    extent.setSystemInfo("Tester", "Your Name");
                    extent.setSystemInfo("Browser", "Chrome");
            
                    driver = new ChromeDriver();
                }
            
                @Test
                public void testGoogleTitle() {
                    test = extent.createTest("Google Title Test", "Validate the title of Google homepage");
                    driver.get("https://www.google.com");
                    test.log(Status.INFO, "Navigated to Google");
            
                    String title = driver.getTitle();
                    test.log(Status.INFO, "Title fetched: " + title);
            
                    try {
                        Assert.assertEquals(title, "Google");
                        test.pass("Title validation passed");
                    } catch (AssertionError e) {
                        test.fail("Title validation failed: " + e.getMessage());
                    }
                }
            
                @AfterClass
                public void tearDown() {
                    driver.quit();
                    test.log(Status.INFO, "Browser closed");
                    extent.flush();
                }
            }
                

Explanation of the Code

• Maven Dependencies: Selenium and ExtentReports dependencies are required.
• Extent Report Configuration: HTML reporter is set up with themes and document metadata.
• System Info: Metadata like tester name and browser are added to the report.
• Test Execution: A test is created to validate the Google homepage title.
• Logs and Validation: Logs are generated during the test, and results are added to the report.
• Flushing the Report: The report is written to the file after the test completes.

Folder Structure of Generated Report

The generated report will have:

• ExtentReport.html: The HTML report with all test details.
• Screenshots (Optional): Capture screenshots for failed tests and attach them to the report.

How to Run the Program

1. Download and install the Chrome browser and ChromeDriver.
2. Add the ChromeDriver path to your system's PATH variable.
3. Run the program in your IDE.
4. Check the test-output/ExtentReport.html file for the report.

Why Use Extent Reports?

• Interactive HTML Reports with logs and screenshots.
• Detailed test execution logging.
• Customizable reports with themes and metadata.
• Cross-platform compatibility.

Attaching Screenshots in Extent Report with Selenium

Screenshots are crucial for identifying issues during test execution. Attaching screenshots to Extent Reports helps visualize errors and improve test analysis. This section covers a real-time scenario where a screenshot is captured and added to the report if a test fails.

Required Maven Dependencies

Ensure you have the following Maven dependencies in your pom.xml:

<dependencies>
                <!-- Selenium Java -->
                <dependency>
                    <groupId>org.seleniumhq.selenium</groupId>
                    <artifactId>selenium-java</artifactId>
                    <version>4.12.1</version>
                </dependency>
            
                <!-- Extent Reports -->
                <dependency>
                    <groupId>com.aventstack</groupId>
                    <artifactId>extentreports</artifactId>
                    <version>5.0.9</version>
                </dependency>
            </dependencies>
                

Java Code: Attaching Screenshot to Extent Report

This code demonstrates capturing a screenshot when a test fails and attaching it to the Extent Report.

import org.openqa.selenium.OutputType;
            import org.openqa.selenium.TakesScreenshot;
            import org.openqa.selenium.WebDriver;
            import org.openqa.selenium.chrome.ChromeDriver;
            import org.apache.commons.io.FileUtils;
            import org.testng.Assert;
            import org.testng.annotations.AfterClass;
            import org.testng.annotations.BeforeClass;
            import org.testng.annotations.Test;
            
            import com.aventstack.extentreports.ExtentReports;
            import com.aventstack.extentreports.ExtentTest;
            import com.aventstack.extentreports.Status;
            import com.aventstack.extentreports.reporter.ExtentHtmlReporter;
            
            import java.io.File;
            import java.io.IOException;
            import java.text.SimpleDateFormat;
            import java.util.Date;
            
            public class ScreenshotInExtentReport {
            
                WebDriver driver;
                ExtentReports extent;
                ExtentTest test;
            
                @BeforeClass
                public void setup() {
                    ExtentHtmlReporter htmlReporter = new ExtentHtmlReporter("test-output/ExtentScreenshotReport.html");
                    extent = new ExtentReports();
                    extent.attachReporter(htmlReporter);
            
                    driver = new ChromeDriver();
                }
            
                @Test
                public void testGoogleTitleWithScreenshot() {
                    test = extent.createTest("Google Title Test with Screenshot", 
                                              "This test captures a screenshot if the title validation fails.");
            
                    driver.get("https://www.google.com");
                    test.log(Status.INFO, "Navigated to Google homepage");
            
                    String actualTitle = driver.getTitle();
                    test.log(Status.INFO, "Fetched title: " + actualTitle);
            
                    try {
                        Assert.assertEquals(actualTitle, "Google123"); // Intentionally incorrect title
                        test.pass("Title validation passed");
                    } catch (AssertionError e) {
                        String screenshotPath = captureScreenshot("GoogleTitleTest");
                        test.fail("Title validation failed").addScreenCaptureFromPath(screenshotPath);
                    }
                }
            
                public String captureScreenshot(String screenshotName) {
                    // Format the timestamp for the screenshot name
                    String timestamp = new SimpleDateFormat("yyyyMMddHHmmss").format(new Date());
                    String filePath = "screenshots/" + screenshotName + "_" + timestamp + ".png";
            
                    // Capture the screenshot and save it
                    File srcFile = ((TakesScreenshot) driver).getScreenshotAs(OutputType.FILE);
                    try {
                        FileUtils.copyFile(srcFile, new File(filePath));
                        System.out.println("Screenshot saved: " + filePath);
                    } catch (IOException e) {
                        System.out.println("Failed to save screenshot: " + e.getMessage());
                    }
                    return filePath;
                }
            
                @AfterClass
                public void tearDown() {
                    driver.quit();
                    extent.flush();
                }
            }
                

Explanation of the Code

• Maven Dependencies: The Selenium and ExtentReports dependencies are required for browser automation and reporting.
• Extent Report Configuration: ExtentHtmlReporter initializes the HTML report where the results will be logged.
• Test Case with Screenshot:
  • The test navigates to the Google homepage and fetches its title.
  • If the title validation fails, the captureScreenshot() method captures a screenshot and saves it in the screenshots folder with a timestamp.
  • The screenshot is then attached to the report using addScreenCaptureFromPath().
• Screenshot Capture Logic:
  • The TakesScreenshot interface is used to capture the screenshot.
  • The screenshot is saved in the screenshots/ directory with a timestamp to avoid overwriting.
• Report Generation: The report is flushed using extent.flush() at the end of the test execution to write all logs and screenshots into the HTML report.

Real-Time Scenario: When to Use Screenshots?

• Test Failures: Capture screenshots to visualize what went wrong during the test execution.
• UI Validation: Validate the appearance of UI elements across browsers and platforms.
• Automation Debugging: Use screenshots to debug failed test steps during automation runs.
• Continuous Integration: Attach screenshots to reports generated in Jenkins, GitLab CI/CD, or other CI tools for easier issue tracking.

Folder Structure for Screenshots and Report

• test-output/ExtentScreenshotReport.html: The HTML report with screenshots and logs.
• screenshots/: Directory containing screenshots with timestamps.

How to Run the Program

1. Install the latest version of ChromeDriver and add it to your system PATH.
2. Run the test using your IDE or mvn test if you are using Maven.
3. Check the test-output/ExtentScreenshotReport.html report for the attached screenshots.

Allure Report in Selenium Testing

Allure Reports are powerful tools that provide visually appealing and detailed test reports. They help testers and developers analyze and track test results effectively, integrating features like timelines, logs, and screenshots.

Required Maven Dependencies

Add the following dependencies in your pom.xml to integrate Selenium with Allure Reports:

<dependencies>
                <!-- Selenium Java -->
                <dependency>
                    <groupId>org.seleniumhq.selenium</groupId>
                    <artifactId>selenium-java</artifactId>
                    <version>4.12.1</version>
                </dependency>
            
                <!-- Allure TestNG -->
                <dependency>
                    <groupId>io.qameta.allure</groupId>
                    <artifactId>allure-testng</artifactId>
                    <version>2.20.1</version>
                </dependency>
            </dependencies>
                

Complete Java Code for Selenium with Allure Reports

import org.openqa.selenium.WebDriver;
            import org.openqa.selenium.chrome.ChromeDriver;
            import org.testng.Assert;
            import org.testng.annotations.AfterClass;
            import org.testng.annotations.BeforeClass;
            import org.testng.annotations.Test;
            import io.qameta.allure.Allure;
            import io.qameta.allure.Description;
            import io.qameta.allure.Step;
            import io.qameta.allure.Attachment;
            
            public class AllureReportExample {
            
                WebDriver driver;
            
                @BeforeClass
                public void setup() {
                    driver = new ChromeDriver(); // Ensure ChromeDriver is set in PATH
                    Allure.addAttachment("Browser", "Chrome");
                }
            
                @Test(description = "Validate Google Title")
                @Description("This test validates the title of the Google homepage.")
                public void testGoogleTitle() {
                    openGoogle();
                    String title = driver.getTitle();
                    logInfo("Fetched title: " + title);
            
                    try {
                        Assert.assertEquals(title, "Google");
                        logInfo("Title validation passed.");
                    } catch (AssertionError e) {
                        captureScreenshot();
                        logInfo("Title validation failed: " + e.getMessage());
                        throw e;
                    }
                }
            
                @Step("Open Google Homepage")
                public void openGoogle() {
                    driver.get("https://www.google.com");
                }
            
                @Attachment(value = "Screenshot", type = "image/png")
                public byte[] captureScreenshot() {
                    // Code to capture a screenshot (skipped for brevity)
                    return new byte[0];
                }
            
                @Step("Log Information: {0}")
                public void logInfo(String message) {
                    Allure.addAttachment("Info", message);
                }
            
                @AfterClass
                public void tearDown() {
                    driver.quit();
                    Allure.addAttachment("Browser closed", "Chrome");
                }
            }
                

Explanation of the Code

• Maven Dependencies: Selenium and Allure TestNG are required for this setup.
• Allure Annotations: @Description and @Step annotations enhance the readability of the report.
• Test Flow: A test is written to validate the Google homepage title.
• Logging and Attachments: The test logs information and attaches screenshots if the test fails.
• Teardown: The driver quits, and a final message is logged in the report.

How to Generate Allure Report

1. Install **Allure** on your machine:

   brew install allure  # For macOS
               choco install allure  # For Windows

2. Run your tests with mvn test.
3. Generate the report by executing:

   allure serve target/allure-results

Why Use Allure Reports?

• Allure provides **graphical timelines** and **detailed insights** for each test step.
• Integrates easily with **Selenium**, **TestNG**, **JUnit**, and other frameworks.
• Supports adding **screenshots, logs, and attachments** to enhance the report.
• Generates **real-time HTML reports** viewable in any browser.

Folder Structure of Generated Report

The report folder will have the following structure:

• allure-results: Directory where test results are saved.
• allure-report: Directory containing the generated HTML report (after running the allure serve command).