Glossary

This page provides technical definitions and implementation details for core concepts, class names, and abbreviations used throughout the Ocaramba framework. It serves as a reference for onboarding engineers to understand how domain terms map to specific code entities.

Core Framework Concepts

DriverContext

The central state container for a test session. It manages the lifecycle of the IWebDriver and provides access to framework services like logging, performance measurement, and soft assertions.

• Implementation: It manages the IWebDriver instance and provides properties for VerifyMessages, PerformanceMeasures, and test metadata. OcarambaLite/DriverContext.cs51-171
• Mobile Support: Includes specialized methods like SwitchToWebView and SwitchToNative for Appium-based mobile automation. OcarambaLite/DriverContext.cs182-205
• Data Flow: Initialized during test setup, passed to Page Objects via the constructor, and accessed via the Driver property. README.md107-110

Diagram: DriverContext Role in POM

Sources: OcarambaLite/DriverContext.cs51-205 README.md107-110

BaseConfiguration

A static utility class that provides strongly-typed access to configuration values defined in appsettings.json. OcarambaLite/BaseConfiguration.cs1-30

• Implementation: Uses Microsoft.Extensions.Configuration to bind JSON keys to C# properties. Ocaramba/Ocaramba.csproj46-47
• Key Properties: Manages timeouts (MediumTimeout), folder paths (ScreenShotFolder, DownloadFolder), and browser settings. OcarambaLite/DriverContext.cs97-125

Sources: OcarambaLite/BaseConfiguration.cs1-30 Ocaramba/Ocaramba.csproj46-47 OcarambaLite/DriverContext.cs97-125

Verify (Soft Assertions)

A mechanism to perform multiple assertions within a single test without stopping execution upon the first failure. README.md37

• Implementation: Verify.That() catches exceptions and stores the failure details as ErrorDetail objects in DriverContext.VerifyMessages. OcarambaLite/Verify.cs1-40 OcarambaLite/DriverContext.cs165-171
• Data Collection: Captures screenshots and page source automatically when an assertion fails if configured. OcarambaLite/DriverContext.cs97-125

Sources: OcarambaLite/Verify.cs1-40 OcarambaLite/DriverContext.cs165-171 README.md37

---

Codebase Terminology

Term	Definition	File Pointer
OcarambaLite	The foundational engine containing core driver logic, extensions, and element wrappers. It is designed to be lightweight without driver binaries.	OcarambaLite/OcarambaLite.csproj6-24
Ocaramba	The primary distribution package that includes OcarambaLite plus Selenium driver dependencies (Chrome, Gecko).	Ocaramba/Ocaramba.csproj31-37
ProjectPageBase	The base class for all Page Objects. It receives DriverContext and provides access to the WebDriver.	README.md107-110
ProjectTestBase	The base class for test fixtures (NUnit, MsTest, etc.). It manages the DriverContext lifecycle.	README.md76
ElementLocator	Defines how to find elements using the Locator enum (XPath, ID, etc.) and supports parameterized locators.	OcarambaLite/Locator.cs1-30 OcarambaLite/Extensions/LocatorExtensions.cs1-30
TestLogger	A framework-level logger that wraps NLog to provide standardized test starting/ending logs.	OcarambaLite/Logger/TestLogger.cs1-50
PerformanceHelper	Helper class to measure action times (average/90th percentile).	OcarambaLite/Helpers/PerformanceHelper.cs20-40
FilesHelper	Utility for file operations like checking downloads or file types.	OcarambaLite/Helpers/FilesHelper.cs15-35

Sources: OcarambaLite/OcarambaLite.csproj1-24 Ocaramba/Ocaramba.csproj1-66 README.md1-120 OcarambaLite/Logger/TestLogger.cs1-50 OcarambaLite/Helpers/PerformanceHelper.cs20-40 OcarambaLite/Helpers/FilesHelper.cs15-35

---

Technical Helpers & Extensions

SearchContextExtensions

Extends standard Selenium search capabilities to include framework features like automatic waiting and retries.

• GetElement: The primary method for finding elements. It uses WaitHelper to poll for element presence/visibility based on configuration. README.md33
• Wait Logic: Uses BaseConfiguration.MediumTimeout for default polling intervals. OcarambaLite/DriverContext.cs187

Sources: README.md33 OcarambaLite/DriverContext.cs182-205

Performance Measurement

Ocaramba provides built-in utilities for tracking execution metrics during UI tests.

• Implementation: Accessible via DriverContext.PerformanceMeasures. OcarambaLite/DriverContext.cs84
• Reporting: PrintPerformanceResultsHelper outputs metrics in formats compatible with TeamCity or AppVeyor. OcarambaLite/Helpers/PrintPerformanceResultsHelper.cs10-30
• Capabilities: Measures average and 90th percentile action times. README.md38

Sources: OcarambaLite/DriverContext.cs84 README.md38 OcarambaLite/Helpers/PrintPerformanceResultsHelper.cs10-30

---

Execution & CI/CD Terms

Docker Execution

Ocaramba supports running tests inside Linux containers, often using a Selenium Grid architecture. README.md47

• appsettings.Linux.json: Contains overrides for running in Linux/Docker environments, such as headless mode or specific driver paths. Ocaramba.Tests.Features/Ocaramba.Tests.Features.csproj43-45
• Environment Switching: Managed via Microsoft.Extensions.Configuration to load environment-specific JSON files. OcarambaLite/BaseConfiguration.cs15-25

Sources: README.md47 Ocaramba.Tests.Features/Ocaramba.Tests.Features.csproj43-45 OcarambaLite/BaseConfiguration.cs15-25

Cloud Provider Integration

Framework projects dedicated to executing tests on remote infrastructure like BrowserStack or SauceLabs.

• BrowserStack: Integration is supported via specialized configurations and parallel execution capabilities. README.md35
• Cross-Browser: Parallel execution is managed via Ocaramba.Tests.CloudProviderCrossBrowser. README.md62

Diagram: Cloud Execution Configuration

Sources: README.md35-62 OcarambaLite/DriverContext.cs79-84