Test Runner Integrations: NUnit, MsTest, Xunit

Ocaramba is designed to be test-runner agnostic, providing specialized integration projects for the three major .NET testing frameworks: NUnit, MsTest, and Xunit. While the core logic resides in OcarambaLite, these integration projects provide the necessary glue code, base classes, and data-driven helpers required to execute tests within specific runner environments.

Integration Architecture

The framework uses a provider-based approach where each test runner project implements a ProjectTestBase (inheriting from the framework's TestBase) to handle the lifecycle of the DriverContext.

Runner Logic Flow

The following diagram illustrates how different test runners interact with the Ocaramba core and Page Objects.

Diagram: Test Runner Data Flow

Sources: Ocaramba.Tests.NUnit/Ocaramba.Tests.NUnit.csproj36-37 Ocaramba.Tests.MsTest/Ocaramba.Tests.MsTest.csproj25-26 Ocaramba.Tests.Xunit/Ocaramba.Tests.Xunit.csproj36-37

---

Ocaramba.Tests.NUnit (Primary Integration)

Ocaramba.Tests.NUnit is the most feature-rich integration and serves as the primary reference implementation. It includes advanced data-driven testing, performance measurement, and file comparison capabilities.

Key Features

• Data-Driven Helpers: The DataDrivenHelper class provides methods to read test data from .xlsx, .xml, and .csv files using NPOI and System.Text.Json Ocaramba.Tests.NUnit/DataDriven/DataDrivenHelper.cs42-120
• File Comparison: Includes CompareFiles logic and sample files for comparing "live" vs "branch" versions of text and CSV files Ocaramba.Tests.NUnit/Ocaramba.Tests.NUnit.csproj60-71
• Parallel Execution: Configured for fixture-level parallelism using the [Parallelizable(ParallelScope.Fixtures)] attribute Ocaramba.Tests.NUnit/Tests/HerokuappTestsNUnit.cs32
• Advanced Assertions: Utilizes Verify.That to perform soft assertions that capture screenshots on failure without halting test execution Ocaramba.Tests.NUnit/Tests/HerokuappTestsNUnit.cs42-45

Data-Driven Implementation

The DataDrivenHelper uses XDocument for XML parsing and StreamReader for CSV files to yield TestCaseData objects compatible with NUnit's [TestCaseSource] Ocaramba.Tests.NUnit/DataDriven/DataDrivenHelper.cs65-99

Sources: Ocaramba.Tests.NUnit/DataDriven/DataDrivenHelper.cs65-99 Ocaramba.Tests.NUnit/Tests/HerokuappTestsNUnit.cs30-46

---

Ocaramba.Tests.MsTest

The MsTest integration is tailored for environments where Microsoft's native test runner is preferred. It focuses on standard MsTest data-driven patterns.

Configuration and Data

• Deployment Items: Uses DDT.csv and DDT.xml for data-driven testing, which are copied to the output directory Ocaramba.Tests.MsTest/Ocaramba.Tests.MsTest.csproj36-41
• Settings: Includes Runsettings.runsettings and Testsettings.testsettings for fine-grained runner control Ocaramba.Tests.MsTest/Ocaramba.Tests.MsTest.csproj45-50
• Drivers: Explicitly includes the Selenium.WebDriver.IEDriver package (v4.14.0), which is often a requirement in legacy MsTest environments Ocaramba.Tests.MsTest/Ocaramba.Tests.MsTest.csproj20

Sources: Ocaramba.Tests.MsTest/Ocaramba.Tests.MsTest.csproj1-61

---

Ocaramba.Tests.Xunit

The Xunit integration utilizes the TestFixture pattern to manage the browser lifecycle. Unlike NUnit or MsTest, Xunit does not use [SetUp] or [TearDown] attributes; instead, it relies on constructor and Dispose logic often encapsulated in a TestFixture class.

Xunit Test Structure

Tests use the [Fact] attribute for standard tests and inherit from ProjectTestBase to gain access to this.DriverContext Ocaramba.Tests.Xunit/Tests/ExampleTest2.cs28-33

Diagram: Xunit Entity Association

Sources: Ocaramba.Tests.Xunit/Tests/ExampleTest2.cs28-35 Ocaramba.Tests.Xunit/Ocaramba.Tests.Xunit.csproj18-21

---

Project Dependencies and Setup

Each runner project requires a specific set of NuGet packages and project references to function correctly within the Ocaramba ecosystem.

Shared Dependencies

All runner projects reference:

1. OcarambaLite: The core engine Ocaramba.Tests.NUnit/Ocaramba.Tests.NUnit.csproj37
2. Ocaramba.Tests.PageObjects: The shared library containing application-specific logic Ocaramba.Tests.NUnit/Ocaramba.Tests.NUnit.csproj36
3. Selenium Drivers: Browser-specific drivers including ChromeDriver, GeckoDriver, and MSEdgeDriver Ocaramba.Tests.NUnit/Ocaramba.Tests.NUnit.csproj15-27

Comparison of Runner Packages

Feature	NUnit Project	MsTest Project	Xunit Project
Test SDK	Microsoft.NET.Test.Sdk	Microsoft.NET.Test.Sdk	Microsoft.NET.Test.Sdk
Adapter	NUnit3TestAdapter	MSTest.TestAdapter	xunit.runner.visualstudio
Framework	NUnit	MSTest.TestFramework	xunit
Data Format	Excel (NPOI), CSV, XML	CSV, XML	Theory/MemberData (Standard Xunit)

Sources: Ocaramba.Tests.NUnit/Ocaramba.Tests.NUnit.csproj9-31 Ocaramba.Tests.MsTest/Ocaramba.Tests.MsTest.csproj14-21 Ocaramba.Tests.Xunit/Ocaramba.Tests.Xunit.csproj18-32

Adding New Tests

To add a new test to any of the runner projects:

1. Inherit from ProjectTestBase to ensure the DriverContext is initialized correctly Ocaramba.Tests.NUnit/Tests/HerokuappTestsNUnit.cs33
2. Initialize Page Objects by passing this.DriverContext to the constructor Ocaramba.Tests.NUnit/Tests/HerokuappTestsNUnit.cs39-40
3. Use Verify.That for soft assertions to allow the test to continue after a failure while capturing screenshots Ocaramba.Tests.NUnit/Tests/HerokuappTestsNUnit.cs42-45
4. Ensure Configuration Files (appsettings.json, nlog.config) are present in the output directory of the test project Ocaramba.Tests.NUnit/Ocaramba.Tests.NUnit.csproj45-59

Diagram: Page Object Initialization in Tests

Sources: Ocaramba.Tests.NUnit/Tests/HerokuappTestsNUnit.cs33-46 Ocaramba.Tests.NUnit/Ocaramba.Tests.NUnit.csproj45-59