Extent report customization in Selenium Java

Introduction

Extent reports help you see test results clearly. Customizing them makes reports easier to read and understand.

You want to add your company logo to test reports.

You need to change report colors to match your project theme.

You want to add extra information like tester name or environment.

You want to organize test results by categories or tags.

You want to save reports with custom file names or locations.

Syntax

Selenium Java

ExtentHtmlReporter htmlReporter = new ExtentHtmlReporter("path/to/report.html");
ExtentReports extent = new ExtentReports();
extent.attachReporter(htmlReporter);

// Customize report
htmlReporter.config().setDocumentTitle("My Test Report");
htmlReporter.config().setReportName("Regression Tests");
htmlReporter.config().setTheme(Theme.STANDARD);

Use ExtentHtmlReporter to create and customize the HTML report.

Call attachReporter to link the reporter to your ExtentReports object.

Examples

This sets a custom title, report name, and uses a dark theme for better visibility in low light.

Selenium Java

htmlReporter.config().setDocumentTitle("Login Tests Report");
htmlReporter.config().setReportName("Login Module");
htmlReporter.config().setTheme(Theme.DARK);

Adds extra info about who tested and which environment was used.

Selenium Java

extent.setSystemInfo("Tester", "Alice");
extent.setSystemInfo("Environment", "QA");

Assigns a category to a test to group similar tests in the report.

Selenium Java

ExtentTest test = extent.createTest("Test Case 1").assignCategory("Smoke");

Sample Program

This program creates a customized Extent report with title, name, theme, system info, and two tests with pass/fail status.

Selenium Java

import com.aventstack.extentreports.ExtentReports;
import com.aventstack.extentreports.ExtentTest;
import com.aventstack.extentreports.reporter.ExtentHtmlReporter;
import com.aventstack.extentreports.reporter.configuration.Theme;

public class ExtentReportDemo {
    public static void main(String[] args) {
        ExtentHtmlReporter htmlReporter = new ExtentHtmlReporter("test-output/MyReport.html");
        htmlReporter.config().setDocumentTitle("My Test Report");
        htmlReporter.config().setReportName("Sample Tests");
        htmlReporter.config().setTheme(Theme.STANDARD);

        ExtentReports extent = new ExtentReports();
        extent.attachReporter(htmlReporter);

        extent.setSystemInfo("Tester", "Bob");
        extent.setSystemInfo("OS", "Windows 11");

        ExtentTest test1 = extent.createTest("Test Login").assignCategory("Functional");
        test1.pass("Login test passed successfully.");

        ExtentTest test2 = extent.createTest("Test Logout").assignCategory("Functional");
        test2.fail("Logout test failed due to timeout.");

        extent.flush();
    }
}

Important Notes

Always call extent.flush() at the end to save the report.

Use meaningful categories to filter tests easily in the report.

Customize colors and logos to make reports look professional and match your brand.

Summary

Extent report customization makes test results clearer and more useful.

You can change titles, themes, add system info, and organize tests by categories.

Remember to attach the reporter and flush the report to save changes.

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()