Solution Structure and Project Layout

This page provides a detailed technical overview of the Ocaramba.sln solution structure. It explains the purpose of every project, the dependency hierarchy, and the architectural reasoning behind the separation of the core framework from the test implementation layers.

Architectural Overview

Ocaramba is structured as a multi-layered framework designed to support various test runners and platforms while maintaining a single, reusable core. The solution is divided into three primary categories:

1. Core Framework Libraries: OcarambaLite and Ocaramba.
2. Support Projects: Ocaramba.Tests.PageObjects and unit testing for the framework itself.
3. Test Implementation Projects: Runner-specific integrations (NUnit, MsTest, Xunit, SpecFlow) and platform-specific samples (Appium, Angular, Cloud).

Dependency Hierarchy

The following diagram illustrates how projects relate to one another. OcarambaLite serves as the foundational root for all automation logic.

Diagram: Dependency Flow and Project Relationships

Sources: Ocaramba/Ocaramba.csproj:55-56(), Ocaramba.Tests.NUnit/Ocaramba.Tests.NUnit.csproj:36-38(), Ocaramba.UnitTests/Ocaramba.UnitTests.csproj:30-33(), Ocaramba.sln:21-56().

---

Core Framework Projects

OcarambaLite

OcarambaLite is the foundational engine. It contains essential logic for WebDriver management, configuration reading, and low-level element interactions. It is intentionally kept "light" by excluding specific browser driver executables (like chromedriver.exe) from its direct dependencies, allowing users to manage their own driver lifecycle and versions.

• Key Responsibilities:
  • Configuration: Handles JSON-based configuration via Microsoft.Extensions.Configuration OcarambaLite/OcarambaLite.csproj42-43
  • Logging: Integrates NLog for framework and test execution logging OcarambaLite/OcarambaLite.csproj34
  • Mobile Support: Includes Appium.WebDriver to facilitate mobile automation OcarambaLite/OcarambaLite.csproj29
• Target: net8.0 OcarambaLite/OcarambaLite.csproj4-5

Ocaramba (Full)

The Ocaramba project is a comprehensive package built on top of OcarambaLite. It includes the core engine and adds pre-packaged Selenium drivers and additional third-party integrations for database and environment management.

• Key Dependencies:
  • Drivers: Selenium.WebDriver.ChromeDriver Ocaramba/Ocaramba.csproj36 and Selenium.WebDriver.GeckoDriver Ocaramba/Ocaramba.csproj37
  • Database: Microsoft.Data.SqlClient for SQL server interactions Ocaramba/Ocaramba.csproj32
  • Utilities: System.Text.Json Ocaramba/Ocaramba.csproj44 and System.Configuration.ConfigurationManager Ocaramba/Ocaramba.csproj43

Sources: OcarambaLite/OcarambaLite.csproj:1-62(), Ocaramba/Ocaramba.csproj:1-66().

---

Test Runner and Integration Projects

Ocaramba provides reference implementations for major .NET test runners, demonstrating how to bridge the framework with specific runner lifecycles.

Project	Runner / Purpose	Key Features
Ocaramba.Tests.NUnit	NUnit 4	Primary suite; includes Data-Driven Testing (DDT) with Excel (NPOI), CSV, and XML Ocaramba.Tests.NUnit/Ocaramba.Tests.NUnit.csproj12-56
Ocaramba.Tests.MsTest	MSTest	Demonstrates .runsettings and .testsettings integration alongside DDT.csv/DDT.xml Ocaramba.Tests.MsTest/Ocaramba.Tests.MsTest.csproj14-50
Ocaramba.Tests.Xunit	xUnit	Implements the xUnit runner integration for the framework Ocaramba.Tests.Xunit/Ocaramba.Tests.Xunit.csproj18-21
Ocaramba.Tests.NUnitExtentReports	NUnit + Extent	Specialized project for generating HTML dashboards via ExtentReports Ocaramba.sln51

Sources: Ocaramba.Tests.NUnit/Ocaramba.Tests.NUnit.csproj(), Ocaramba.Tests.MsTest/Ocaramba.Tests.MsTest.csproj(), Ocaramba.Tests.Xunit/Ocaramba.Tests.Xunit.csproj().

---

Specialized Implementation Projects

Ocaramba.Tests.PageObjects

This project is a shared library containing the Page Object Model (POM) classes. By separating Page Objects into their own project, they can be reused across different test runners without code duplication. It references OcarambaLite to access core element location logic Ocaramba.Tests.PageObjects/packages.lock.json44-58

Ocaramba.Tests.BrowserStack

A dedicated project for executing tests on the BrowserStack cloud platform.

• Key Dependencies: Uses NLog and Selenium.Support for remote execution management Ocaramba.sln35

Ocaramba.Tests.Appium

Focuses on mobile automation. It configures the DriverContext to initialize mobile-specific drivers, utilizing the Appium.WebDriver dependency defined in the core layer OcarambaLite/OcarambaLite.csproj29

Ocaramba.Tests.Angular

Provides extensions for testing Angular-based applications, specifically focusing on synchronization with the Angular NgZone to prevent flaky tests Ocaramba.sln26

Sources: Ocaramba.Tests.PageObjects/packages.lock.json(), Ocaramba.sln:21-56().

---

Mapping Code Entities to System Roles

The following diagrams map specific code entities to their functional roles within the solution structure.

Diagram: Core Initialization and Configuration

Sources: OcarambaLite/OcarambaLite.csproj:42-43(), Ocaramba/Ocaramba.csproj:46-47().

Diagram: Documentation and Reporting

Sources: Ocaramba.Documentation/Ocaramba.Documentation.shfbproj:36-40(), Ocaramba.Documentation/Selenium.shfbproj:24-26().

---

Legacy and Unit Testing Projects

Legacy: Objectivity.*

The solution structure acknowledges its history through compatibility with legacy Objectivity.Test.Automation.* naming conventions. While the core projects have been rebranded to Ocaramba, the internal logic maintains structural continuity.

Ocaramba.UnitTests

This project contains unit tests for the framework's internal components.

• Dependencies: Uses Magick.NET for image-based verification tests and NUnit for execution Ocaramba.UnitTests/Ocaramba.UnitTests.csproj9-14
• References: It references Ocaramba.Tests.NUnit, Ocaramba.Tests.PageObjects, and OcarambaLite to test integration scenarios Ocaramba.UnitTests/Ocaramba.UnitTests.csproj30-33

Sources: Ocaramba.UnitTests/Ocaramba.UnitTests.csproj().