Extent report customization in Selenium Java - Build an Automation Script

Customize Extent Report with Title, Theme, and System Info

Preconditions (2)

Step 1: Initialize ExtentReports and attach ExtentHtmlReporter

Step 2: Set the report document title to 'My Test Report'

Step 3: Set the report theme to DARK

Step 4: Add system information: OS as 'Windows 10' and Tester as 'QA Team'

Step 5: Run a sample test that passes

Step 6: Flush the report to generate the HTML file

✅ Expected Result: The generated Extent report HTML file should have the title 'My Test Report', use the DARK theme, and display system info with OS as 'Windows 10' and Tester as 'QA Team'. The test status should show as passed.

Automation Requirements - Selenium with TestNG and ExtentReports

Assertions Needed:

Verify the report file is created

Verify the report title is 'My Test Report'

Verify the report theme is DARK

Verify system info contains OS and Tester

Verify the test status is PASS

Best Practices:

Use ExtentHtmlReporter for HTML report customization

Set report properties before running tests

Flush the report after tests complete

Use TestNG annotations for setup and teardown

Use explicit waits in Selenium if needed

Automated Solution

Selenium Java

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;

import java.io.File;

public class ExtentReportCustomizationTest {

    ExtentReports extent;
    ExtentTest test;
    WebDriver driver;
    String reportPath = System.getProperty("user.dir") + "/test-output/ExtentReport.html";

    @BeforeClass
    public void setup() {
        // Setup ExtentHtmlReporter
        ExtentHtmlReporter htmlReporter = new ExtentHtmlReporter(reportPath);
        htmlReporter.config().setDocumentTitle("My Test Report");
        htmlReporter.config().setTheme(Theme.DARK);

        // Initialize ExtentReports and attach reporter
        extent = new ExtentReports();
        extent.attachReporter(htmlReporter);

        // Add system info
        extent.setSystemInfo("OS", "Windows 10");
        extent.setSystemInfo("Tester", "QA Team");

        // Setup WebDriver (Assuming chromedriver is in PATH)
        driver = new ChromeDriver();
    }

    @Test
    public void sampleTest() {
        test = extent.createTest("Sample Passing Test");
        driver.get("https://www.example.com");

        String title = driver.getTitle();
        test.log(Status.INFO, "Page title is: " + title);

        // Simple assertion
        Assert.assertTrue(title.contains("Example Domain"));
        test.log(Status.PASS, "Title contains 'Example Domain'");
    }

    @AfterClass
    public void teardown() {
        if (driver != null) {
            driver.quit();
        }
        extent.flush();

        // Verify report file exists
        File reportFile = new File(reportPath);
        Assert.assertTrue(reportFile.exists(), "Extent report file should exist");
    }
}

This test class sets up an ExtentHtmlReporter with a custom document title and DARK theme in the @BeforeClass method. It also adds system information like OS and Tester name.

The sampleTest method opens a website, logs the page title, asserts the title contains expected text, and logs the test status as PASS.

In @AfterClass, the WebDriver quits and the ExtentReports flushes to write the report file. Then it asserts the report file was created successfully.

This structure ensures the report is customized and generated properly with the required details.

Common Mistakes - 5 Pitfalls

Not calling extent.flush() after tests

Setting report configurations after attaching reporter

{'mistake': 'Hardcoding file paths without using System properties', 'why_bad': 'Hardcoded paths may not work on different machines or environments.', 'correct_approach': 'Use System.getProperty("user.dir") to build relative paths for portability.'}

Not adding system info to ExtentReports

Not logging test steps or status in ExtentTest

Bonus Challenge

Now add data-driven testing with 3 different URLs and verify their titles in the Extent report

Show Hint

Practice

1. What is the main purpose of customizing an Extent report in Selenium Java?

easy

A. To make test results clearer and easier to understand

B. To increase the speed of test execution

C. To reduce the size of the test scripts

D. To automatically fix test failures

Solution

1. Step 1: Understand Extent report role

   Extent reports show test results in a readable format.

2. Step 2: Identify customization benefits

   Customization helps make these results clearer and more useful.

3. Final Answer:

   To make test results clearer and easier to understand -> Option A

4. Quick Check:

   Customization = clearer test results [OK]

Hint: Think: Why improve report look? To understand results better [OK]

Common Mistakes:

• Confusing report customization with test speed
• Thinking customization changes test logic
• Assuming customization fixes test errors

2. Which code snippet correctly sets the theme of an Extent report to DARK in Selenium Java?

easy

A. extentHtmlReporter.config().setTheme(Theme.DARK);

B. extentHtmlReporter.setTheme("dark");

C. extentHtmlReporter.config().theme = "dark";

D. extentHtmlReporter.setConfigTheme(Theme.DARK);

Solution

1. Step 1: Recall ExtentReports theme setting syntax

   Use config() method and setTheme with Theme enum.

2. Step 2: Match correct method and enum usage

   Only extentHtmlReporter.config().setTheme(Theme.DARK); uses config().setTheme(Theme.DARK) correctly.

3. Final Answer:

   extentHtmlReporter.config().setTheme(Theme.DARK); -> Option A

4. Quick Check:

   Use config().setTheme(Theme.DARK) [OK]

Hint: Remember: config() then setTheme with Theme enum [OK]

Common Mistakes:

• Using setTheme directly without config()
• Passing theme as string instead of Theme enum
• Using incorrect method names

3. Given the following code snippet, what will be the title of the generated Extent report?

ExtentHtmlReporter htmlReporter = new ExtentHtmlReporter("testReport.html");
htmlReporter.config().setDocumentTitle("My Test Report");
ExtentReports extent = new ExtentReports();
extent.attachReporter(htmlReporter);

medium

A. Extent Report

B. testReport.html

C. My Test Report

D. Default Title

Solution

1. Step 1: Identify method setting report title

   config().setDocumentTitle("My Test Report") sets the HTML page title.

2. Step 2: Understand effect on report

   The report's browser tab will show "My Test Report" as title.

3. Final Answer:

   My Test Report -> Option C

4. Quick Check:

   setDocumentTitle sets report title [OK]

Hint: Look for setDocumentTitle method for report title [OK]

Common Mistakes:

• Confusing file name with report title
• Assuming default title is used
• Ignoring config() method effects

4. Identify the error in the following code that prevents the Extent report from saving properly:

ExtentHtmlReporter reporter = new ExtentHtmlReporter("report.html");
ExtentReports extent = new ExtentReports();
extent.attachReporter(reporter);
// Missing flush call

medium

A. ExtentHtmlReporter should be initialized after ExtentReports

B. Incorrect file name extension, should be .txt

C. attachReporter method is deprecated and should not be used

D. Missing call to extent.flush() to save the report

Solution

1. Step 1: Check report saving process

   Extent report requires extent.flush() to write data to file.

2. Step 2: Identify missing flush call

   The code does not call extent.flush(), so report is not saved.

3. Final Answer:

   Missing call to extent.flush() to save the report -> Option D

4. Quick Check:

   Always call extent.flush() to save report [OK]

Hint: Remember to call extent.flush() after tests [OK]

Common Mistakes:

• Forgetting to call flush()
• Changing file extension incorrectly
• Misunderstanding attachReporter usage

5. You want to add system information like OS and Java version to your Extent report. Which code snippet correctly adds this info before flushing the report?

ExtentReports extent = new ExtentReports();
ExtentHtmlReporter htmlReporter = new ExtentHtmlReporter("sysInfoReport.html");
extent.attachReporter(htmlReporter);
// Add system info here
extent.flush();

hard

A. htmlReporter.setSystemInfo("OS", System.getProperty("os.name"));
htmlReporter.setSystemInfo("Java Version", System.getProperty("java.version"));

B. extent.addSystemInfo("OS", System.getProperty("os.name"));
extent.addSystemInfo("Java Version", System.getProperty("java.version"));

C. extent.setSystemInfo("OS", System.getProperty("os.name"));
extent.setSystemInfo("Java Version", System.getProperty("java.version"));

D. htmlReporter.addSystemInfo("OS", System.getProperty("os.name"));
htmlReporter.addSystemInfo("Java Version", System.getProperty("java.version"));

Solution

1. Step 1: Identify correct method to add system info

   ExtentReports class has addSystemInfo method to add info.

2. Step 2: Confirm usage on ExtentReports instance

   System info is added on extent, not on htmlReporter.

3. Final Answer:

   extent.addSystemInfo("OS", System.getProperty("os.name")); extent.addSystemInfo("Java Version", System.getProperty("java.version")); -> Option B

4. Quick Check:

   Use extent.addSystemInfo() before flush [OK]

Hint: Add system info on extent, not htmlReporter [OK]

Common Mistakes:

• Calling setSystemInfo on htmlReporter instead of extent
• Using setSystemInfo which does not exist
• Adding system info after flush()