Extent Reports setup in Selenium Java - Framework Patterns

Framework Mode - Extent Reports setup

Folder Structure

src/
├── main/
│   └── java/
│       └── com/example/project/
│           └── pages/                 # Page Object classes
├── test/
│   └── java/
│       └── com/example/project/tests/ # Test classes
│       └── com/example/project/utils/ # Utility classes (e.g., ExtentManager)
│       └── com/example/project/config/ # Configuration classes
└── resources/
    └── config.properties             # Environment and browser settings

Test Framework Layers

• Driver Layer: Manages WebDriver setup and teardown.
• Page Objects: Encapsulate UI elements and actions for each page.
• Tests: Test classes using TestNG or JUnit to run test cases.
• Utilities: Helper classes including ExtentManager to configure and provide ExtentReports instance.
• Configuration: Properties files and classes to manage environment, browser, and credentials.

Configuration Patterns

• config.properties: Store environment URLs, browser types, and credentials.
• ConfigReader class: Reads properties file and provides values to tests and utilities.
• ExtentManager utility: Creates and configures ExtentReports instance with report path, system info, and theme.
• Test Listeners: Implement TestNG listeners to start and flush ExtentReports on test start and finish.

Test Reporting and CI/CD Integration

• ExtentReports generates detailed HTML reports with test status, logs, screenshots, and timestamps.
• Reports saved in test-output/extent-reports/ folder for easy access.
• Integrate report generation in CI/CD pipelines (e.g., Jenkins) to publish reports after test runs.
• Use TestNG listeners to automatically attach ExtentReports lifecycle to test execution.

Best Practices for Extent Reports Setup

• Use a singleton pattern in ExtentManager to avoid multiple report instances.
• Keep report configuration centralized for easy updates (e.g., report path, theme).
• Attach screenshots on test failure to improve debugging.
• Use TestNG listeners to separate reporting logic from test logic.
• Clean old reports before new test runs to avoid confusion.

Self Check

Where in this folder structure would you add a new utility class to capture screenshots for ExtentReports?

Key Result

Organize Selenium Java tests with Page Objects, utilities like ExtentManager, and TestNG listeners for clean Extent Reports integration.

Practice

1. What is the primary purpose of using ExtentHtmlReporter in Selenium Java testing?

easy

A. To execute Selenium WebDriver tests

B. To locate web elements on a page

C. To generate an HTML report for test execution results

D. To manage browser windows during tests

Solution

1. Step 1: Understand the role of ExtentHtmlReporter

   ExtentHtmlReporter is used to create a visual HTML report that shows test results clearly.

2. Step 2: Differentiate from other components

   It does not run tests or interact with browsers; it only formats and outputs reports.

3. Final Answer:

   To generate an HTML report for test execution results -> Option C

4. Quick Check:

   ExtentHtmlReporter = HTML report generator [OK]

Hint: ExtentHtmlReporter creates HTML reports, not test execution [OK]

Common Mistakes:

• Confusing ExtentHtmlReporter with WebDriver
• Thinking it runs tests
• Assuming it manages browser actions

2. Which of the following is the correct way to initialize ExtentReports with ExtentHtmlReporter in Java?

easy

A. ExtentReports extent = new ExtentReports(); extent.createReporter("report.html");

B. ExtentHtmlReporter reporter = new ExtentHtmlReporter("report.html"); ExtentReports extent = new ExtentReports(); extent.attachReporter(reporter);

C. ExtentHtmlReporter reporter = new ExtentHtmlReporter(); extent.attachReporter(reporter);

D. ExtentReports extent = new ExtentReports("report.html"); ExtentHtmlReporter reporter = new ExtentHtmlReporter();

Solution

1. Step 1: Create ExtentHtmlReporter with file path

   You must instantiate ExtentHtmlReporter with the report file name or path.

2. Step 2: Attach reporter to ExtentReports instance

   Create ExtentReports object and attach the reporter using attachReporter method.

3. Final Answer:

   ExtentHtmlReporter reporter = new ExtentHtmlReporter("report.html"); ExtentReports extent = new ExtentReports(); extent.attachReporter(reporter); -> Option B

4. Quick Check:

   Initialize reporter with path, then attach to ExtentReports [OK]

Hint: Create reporter with path, then attach to ExtentReports [OK]

Common Mistakes:

• Not passing file path to ExtentHtmlReporter constructor
• Calling attachReporter before creating ExtentReports
• Using non-existent methods like createReporter

3. Given the following code snippet, what will be the output in the Extent Report after execution?

ExtentHtmlReporter reporter = new ExtentHtmlReporter("testReport.html");
ExtentReports extent = new ExtentReports();
extent.attachReporter(reporter);
ExtentTest test = extent.createTest("LoginTest");
test.pass("Login successful");
extent.flush();

medium

A. The report will show a test named 'LoginTest' marked as failed.

B. The report will be empty because flush() is called before creating the test.

C. The code will throw a runtime exception due to missing test initialization.

D. The report will show a test named 'LoginTest' marked as passed with message 'Login successful'.

Solution

1. Step 1: Analyze test creation and logging

   The test 'LoginTest' is created and logged as passed with message 'Login successful'.

2. Step 2: Understand flush() role

   Calling extent.flush() writes the report to the file including all logged tests.

3. Final Answer:

   The report will show a test named 'LoginTest' marked as passed with message 'Login successful'. -> Option D

4. Quick Check:

   createTest + pass + flush = Passed test in report [OK]

Hint: Create test, log pass, then flush to save report [OK]

Common Mistakes:

• Thinking flush() clears tests
• Assuming test is failed without fail() call
• Believing report is empty without flush()

4. Identify the error in the following Extent Reports setup code:

ExtentHtmlReporter reporter = new ExtentHtmlReporter();
ExtentReports extent = new ExtentReports();
extent.attachReporter(reporter);
ExtentTest test = extent.createTest("SearchTest");
test.pass("Search executed");
extent.flush();

medium

A. ExtentHtmlReporter must be initialized with a file path in its constructor.

B. ExtentReports cannot attach more than one reporter.

C. createTest() method requires two parameters.

D. flush() should be called before creating tests.

Solution

1. Step 1: Check ExtentHtmlReporter initialization

   ExtentHtmlReporter requires a file path string in its constructor to specify report output location.

2. Step 2: Verify other method usages

   attachReporter, createTest, and flush are used correctly; no multiple reporter restriction or parameter issues.

3. Final Answer:

   ExtentHtmlReporter must be initialized with a file path in its constructor. -> Option A

4. Quick Check:

   Reporter needs file path on creation [OK]

Hint: Always give file path when creating ExtentHtmlReporter [OK]

Common Mistakes:

• Omitting file path in ExtentHtmlReporter constructor
• Misunderstanding createTest parameters
• Calling flush too early

5. You want to create an Extent Report that logs multiple tests and marks one as failed with a custom error message. Which code snippet correctly sets up the report and logs these results?

hard

A. ExtentHtmlReporter reporter = new ExtentHtmlReporter("multiTestReport.html");
ExtentReports extent = new ExtentReports();
extent.attachReporter(reporter);
ExtentTest test1 = extent.createTest("Test1");
test1.pass("Test1 passed");
ExtentTest test2 = extent.createTest("Test2");
test2.fail("Test2 failed due to timeout");
extent.flush();

B. ExtentReports extent = new ExtentReports("multiTestReport.html");
ExtentHtmlReporter reporter = new ExtentHtmlReporter();
extent.createTest("Test1").pass("Test1 passed");
extent.createTest("Test2").fail("Test2 failed due to timeout");
extent.flush();

C. ExtentHtmlReporter reporter = new ExtentHtmlReporter();
ExtentReports extent = new ExtentReports();
extent.attachReporter(reporter);
extent.createTest("Test1").pass("Test1 passed");
extent.createTest("Test2").fail("Test2 failed due to timeout");
extent.flush();

D. ExtentHtmlReporter reporter = new ExtentHtmlReporter();
ExtentReports extent = new ExtentReports();
extent.attachReporter(reporter);
ExtentTest test1 = extent.createTest("Test1");
test1.fail("Test1 failed");
ExtentTest test2 = extent.createTest("Test2");
test2.pass("Test2 passed");
extent.flush();

Solution

1. Step 1: Initialize ExtentHtmlReporter with file path

   Instantiate ExtentHtmlReporter with the path to the report file, create an ExtentReports instance, and attach the reporter.

2. Step 2: Create multiple tests and log statuses

   Create ExtentTest instances with createTest(), log one with pass("message") and one with fail("custom error message"), then flush().

3. Final Answer:

   ExtentHtmlReporter reporter = new ExtentHtmlReporter("multiTestReport.html"); ExtentReports extent = new ExtentReports(); extent.attachReporter(reporter); ExtentTest test1 = extent.createTest("Test1"); test1.pass("Test1 passed"); ExtentTest test2 = extent.createTest("Test2"); test2.fail("Test2 failed due to timeout"); extent.flush(); -> Option A

4. Quick Check:

   Reporter with path + attach + pass/fail + flush [OK]

Hint: Attach reporter with path, create tests, log pass/fail, then flush [OK]

Common Mistakes:

• Not passing file path to ExtentHtmlReporter
• Swapping pass and fail calls
• Calling flush before logging tests