ExtentReports Integration (NUnitExtentReports)

The Ocaramba.Tests.NUnitExtentReports project provides a reference implementation for integrating ExtentReports (v5.0.4) with the Ocaramba framework and NUnit Ocaramba.Tests.NUnitExtentReports/Ocaramba.Tests.NUnitExtentReports.csproj1-67 It generates interactive, searchable HTML dashboards that include test results, detailed logs, and embedded screenshots.

System Architecture and Data Flow

The integration utilizes NUnit lifecycle hooks to initialize the reporting engine, manage test nodes across parallel executions, and finalize the output.

Reporting Lifecycle Diagram

This diagram shows how ExtentReports entities are mapped to NUnit execution phases.

ExtentReports Entity Mapping

Sources: Ocaramba.Tests.NUnitExtentReports/TestExecutionManager.cs12-47 Ocaramba.Tests.NUnitExtentReports/ProjectTestBase.cs79-143

Core Implementation Classes

TestExecutionManager

The TestExecutionManager class is marked with the [SetUpFixture] attribute, ensuring it runs once for the entire assembly Ocaramba.Tests.NUnitExtentReports/TestExecutionManager.cs12-14

• Initialization: In BeforeSuite ([OneTimeSetUp]), it initializes the ExtentReports object and an ExtentSparkReporter pointing to \TestOutput\index.html. It configures the report name using BaseConfiguration.TestBrowser Ocaramba.Tests.NUnitExtentReports/TestExecutionManager.cs30-38
• Finalization: In AfterSuite ([OneTimeTearDown]), it calls extent.Flush(), which writes all cached test data to the HTML file Ocaramba.Tests.NUnitExtentReports/TestExecutionManager.cs43-47

ProjectTestBase

This class inherits from TestBase and manages the DriverContext alongside ExtentReport test nodes Ocaramba.Tests.NUnitExtentReports/ProjectTestBase.cs40-42

• Thread Safety: It uses [ThreadStatic] for testContainer and test fields to ensure that parallel NUnit executions do not overwrite reporting nodes Ocaramba.Tests.NUnitExtentReports/ProjectTestBase.cs44-48
• Hierarchical Reporting:
  • BeforeClass ([OneTimeSetUp]) creates a top-level test node named after the test class using TestContext.CurrentContext.Test.ClassName Ocaramba.Tests.NUnitExtentReports/ProjectTestBase.cs79-83
  • BeforeTest ([SetUp]) creates a child node (node) for the specific test method using testContainer.CreateNode Ocaramba.Tests.NUnitExtentReports/ProjectTestBase.cs104-107
• Failure Handling: In AfterTest ([TearDown]), it checks the NUnit Result.Outcome.Status and DriverContext.IsTestFailed (which accounts for VerifyMessages) Ocaramba.Tests.NUnitExtentReports/ProjectTestBase.cs116-120 If a failure or JavaScript error is detected, it logs the error to ExtentReports via ExtentTestLogger.Fail and embeds any captured screenshots Ocaramba.Tests.NUnitExtentReports/ProjectTestBase.cs134-138

ExtentTestLogger

A static helper class that provides a bridge between test logic and the reporting engine. It allows logging without directly referencing the ProjectTestBase instance by accessing the [ThreadStatic] test property.

Method	Purpose	Implementation
Info(string text)	Adds an info step to the report	ProjectTestBase.test.Info(text)
Pass(string text)	Marks the current node as passed	ProjectTestBase.test.Pass(text)
Fail(TestStatus status, string message)	Logs failure details	ProjectTestBase.test.Fail(message)
Warning(string text)	Adds a warning icon/message	ProjectTestBase.test.Warning(text)

Sources: Ocaramba.Tests.NUnitExtentReports/ProjectTestBase.cs48 Ocaramba.Tests.NUnitExtentReports/ExtentLogger/ExtentTestLogger.cs25-85

Screenshot and Attachment Integration

When a test fails, Ocaramba automatically captures screenshots if configured. The ProjectTestBase class handles attaching these to the ExtentReport.

Attachment Data Flow

Sources: Ocaramba.Tests.NUnitExtentReports/ProjectTestBase.cs116-123 Ocaramba.Tests.NUnitExtentReports/ProjectTestBase.cs156-166

The EmbedAttachmentsToExtentReport method converts absolute file paths into relative paths (e.g., .\screenshot.png) using Path.GetFileName so the HTML report can load them correctly when distributed Ocaramba.Tests.NUnitExtentReports/ProjectTestBase.cs161-163

Configuration and Usage

Required Dependencies

The project relies on the following NuGet packages defined in the .csproj:

• ExtentReports (v5.0.4) Ocaramba.Tests.NUnitExtentReports/Ocaramba.Tests.NUnitExtentReports.csproj26-28
• NUnit (v4.4.0) and NUnit3TestAdapter (v6.1.0) Ocaramba.Tests.NUnitExtentReports/Ocaramba.Tests.NUnitExtentReports.csproj14-19
• OcarambaLite and Ocaramba.Tests.PageObjects Ocaramba.Tests.NUnitExtentReports/Ocaramba.Tests.NUnitExtentReports.csproj37-38

Logging in Page Objects

Page objects within this project utilize ExtentTestLogger to provide high-level business step visibility in the report. For example, in InternetPage:

• OpenHomePageWithUserCredentials() logs the URL being opened via ExtentTestLogger.Info Ocaramba.Tests.NUnitExtentReports/PageObject/InternetPage.cs70
• GoToDropdownPage() logs the navigation action Ocaramba.Tests.NUnitExtentReports/PageObject/InternetPage.cs76

Logging in Tests

In the test methods, developers can add custom info steps directly using the static test property from ProjectTestBase or via ExtentTestLogger. Example from HerokuappTestsNUnit:

• Tests inherit from ProjectTestBase to gain reporting capabilities Ocaramba.Tests.NUnitExtentReports/Tests/HerokuappTestsNUnit.cs33
• Manual logging: test.Info("Verifying congratulations info...") Ocaramba.Tests.NUnitExtentReports/Tests/HerokuappTestsNUnit.cs44

Sources:

• Ocaramba.Tests.NUnitExtentReports/Ocaramba.Tests.NUnitExtentReports.csproj
• Ocaramba.Tests.NUnitExtentReports/TestExecutionManager.cs
• Ocaramba.Tests.NUnitExtentReports/ProjectTestBase.cs
• Ocaramba.Tests.NUnitExtentReports/ExtentLogger/ExtentTestLogger.cs
• Ocaramba.Tests.NUnitExtentReports/PageObject/InternetPage.cs
• Ocaramba.Tests.NUnitExtentReports/Tests/HerokuappTestsNUnit.cs