NuGet Package Structure

The Ocaramba framework is distributed as a set of NuGet packages designed to provide flexible integration options for test automation projects. The packaging strategy separates core logic from specific driver dependencies, utilizes deterministic restore for environment consistency, and integrates advanced development tools like SourceLink and StyleCop for code quality.

Package Variants: Ocaramba vs. OcarambaLite

Ocaramba provides two primary NuGet packages to cater to different project requirements. Both projects target net8.0 and are configured to generate packages on build Ocaramba/Ocaramba.csproj4-15 OcarambaLite/OcarambaLite.csproj4-15

Ocaramba (Full)

The standard package designed for most users. It includes the core framework logic plus direct dependencies on common Selenium drivers to simplify the initial setup.

• Purpose: "Framework to automate tests using Selenium WebDriver" Ocaramba/Ocaramba.csproj6
• Key Dependencies: Includes Selenium.WebDriver.ChromeDriver, Selenium.WebDriver.GeckoDriver, and Microsoft.Data.SqlClient Ocaramba/Ocaramba.csproj32-37
• Project Reference: Depends on the OcarambaLite project Ocaramba/Ocaramba.csproj55

OcarambaLite

A lightweight version intended for advanced users or CI/CD environments where driver management is handled externally (e.g., via Docker or custom driver paths).

• Purpose: "Framework to automate tests using Selenium WebDriver (lighten version without selenium drivers)" OcarambaLite/OcarambaLite.csproj6
• Key Dependencies: Includes core Selenium libraries (Selenium.WebDriver, Selenium.Support) and Appium.WebDriver, but excludes specific browser driver executables OcarambaLite/OcarambaLite.csproj29-33

Dependency Mapping

The following diagram illustrates the relationship between the NuGet packages and their external dependencies as defined in the project files.

Package Dependency Hierarchy

Sources: Ocaramba/Ocaramba.csproj31-55 OcarambaLite/OcarambaLite.csproj29-34

Deterministic Restore and Security

Ocaramba employs packages.lock.json files to ensure deterministic NuGet restores. This locks the entire dependency graph, including transitive dependencies, to specific versions and content hashes, preventing "floating" version issues in CI/CD.

• Configuration: Enabled via <RestorePackagesWithLockFile>true</RestorePackagesWithLockFile> in the project files Ocaramba/Ocaramba.csproj64 OcarambaLite/OcarambaLite.csproj60
• Lock Files: Separate lock files are maintained for Ocaramba Ocaramba/packages.lock.json1-10 OcarambaLite OcarambaLite/packages.lock.json1-10 and the various test runner projects Ocaramba.Tests.NUnit/packages.lock.json1-10 Ocaramba.Tests.MsTest/packages.lock.json1-10 Ocaramba.Tests.Xunit/packages.lock.json1-10
• Data Structure: The lock file contains a version and a dependencies object mapping target frameworks (e.g., net8.0) to specific package metadata including resolved versions and contentHash Ocaramba/packages.lock.json2-9

Sources: Ocaramba/Ocaramba.csproj64 OcarambaLite/OcarambaLite.csproj60 Ocaramba/packages.lock.json1-10 OcarambaLite/packages.lock.json1-10

Development and Quality Tools

The NuGet packages are built with integrated tools to support debugging and enforce coding standards across the solution.

SourceLink

Configured to allow users to step into Ocaramba source code during debugging by mapping the NuGet package back to the GitHub repository.

• Package: Microsoft.SourceLink.GitHub Ocaramba/Ocaramba.csproj38 OcarambaLite/OcarambaLite.csproj35
• Settings: <PublishRepositoryUrl>true</PublishRepositoryUrl> and <EmbedUntrackedSources>true</EmbedUntrackedSources> are enabled to include source information in the symbols Ocaramba/Ocaramba.csproj19-20 OcarambaLite/OcarambaLite.csproj18-19

StyleCop.Analyzers

Ensures that the framework code adheres to consistent formatting and documentation standards.

• Implementation: Included as a PrivateAsset so it does not flow to consumers of the Ocaramba package Ocaramba/Ocaramba.csproj39-42 OcarambaLite/OcarambaLite.csproj36-39
• Rule Enforcement: Linked to fxcop-sonarqube.tests.ruleset for static analysis, which defines specific rules for managed code analysis like CA1001 and CA1305 Ocaramba/Ocaramba.csproj18 Ocaramba/fxcop-sonarqube.tests.ruleset8-64

Sources: Ocaramba/Ocaramba.csproj18-42 OcarambaLite/OcarambaLite.csproj18-39 Ocaramba/fxcop-sonarqube.tests.ruleset1-175

Release Pipeline and Publishing

The release process is automated via CI/CD pipelines (GitHub Actions and Azure Pipelines), handling versioning, artifact creation, and publishing to NuGet.org.

Pipeline Orchestration

The build process produces two types of artifacts for each package:

• .nupkg: The standard NuGet package containing the compiled binaries.
• .snupkg: The symbol package used for debugging, enabled via <IncludeSymbols>true</IncludeSymbols> and <SymbolPackageFormat>snupkg</SymbolPackageFormat> Ocaramba/Ocaramba.csproj21-22

Metadata Configuration

The .csproj files contain standard NuGet metadata properties used during the dotnet pack operation:

• License: MIT Ocaramba/Ocaramba.csproj12
• Project URL: https Ocaramba/Ocaramba.csproj9
• Package Icon: Uses icon.png included in the package path Ocaramba/Ocaramba.csproj10-27
• Readme: Includes README.md as the package documentation Ocaramba/Ocaramba.csproj23-28

NuGet Packaging and Pipeline Flow

Sources: Ocaramba/Ocaramba.csproj9-30 OcarambaLite/OcarambaLite.csproj9-28