STAF.UI.API 4.4.0

STAF - Simple Test Automation Framework

C# Selenium | .NET Selenium Framework | MCP Server for Selenium C# | Selenium WebDriver C# | Test Automation .NET | UI Testing C# | API Testing .NET | MSTest Selenium

STAF is a production-ready .NET test automation framework for Selenium-based UI testing, API testing, and Excel validation. It provides base classes, HTML reporting, parallel execution, and optional database and accessibility support. The framework is distributed as the STAF.UI.API NuGet package and targets .NET 10 with MSTest.

Note: This release targets .NET 10. Projects consuming STAF.UI.API must use .NET 10 or above.

Sample Project & MCP Agent

STAF.Selenium.Tests is the official template and reference implementation for STAF. It includes:

• Working samples for every major STAF feature (UI, API, Excel, Database, Accessibility)
• MCP Agent - Model Context Protocol server for Selenium + STAF. Use with Cursor, VS Code, or Visual Studio to:
  • Control browsers - Start Chrome/Edge/Firefox, navigate, click, type, take screenshots
  • Generate STAF code - Produce C# Selenium tests (Page Object Model, ReportResult, TestBaseClass) from natural language

Get started with the framework quickly by cloning the template:

git clone https://github.com/sooraj171/STAF.Selenium.Tests
cd STAF.Selenium.Tests
dotnet restore
dotnet build

See the STAF.Selenium.Tests repository for setup, MCP configuration, and sample tests.

Table of Contents

• Overview
• Features
• Key Components
• Getting Started
• Configuration
• Reporting
• Usage Guide
• License

Overview

STAF streamlines automated testing for web applications and APIs using Selenium WebDriver and C#. It supports:

Features

Key Components

Test and Page Base Classes

Browser and Driver

Reporting

WebDriver Extensions

Excel, Database & Accessibility

Getting Started

Prerequisites

• .NET 10 SDK
• Visual Studio 2022 (or later) or VS Code with C# extension
• Chrome or Edge (for UI tests)
• MSTest (included via package reference)

Install

1. Add the NuGet package to your test project:

   dotnet add package STAF.UI.API
   

   Or use the sample project template for a complete setup with examples.

2. Configure run settings: Test > Configure Run Settings > Select Solution Wide runsettings File > choose testrunsetting.runsettings.

3. Build and run tests from Test Explorer or CLI: dotnet test.

Sample UI Test

[TestMethod]
public void TestLogin()
{
    var element = FindAppElement(By.Id("loginButton"), "Login button");
    ReportResult.ReportResultPass(driver, TestContext, "Login", "Login button is visible");
}

Sample API Test

[TestMethod]
public void TestAPIStatus()
{
    ReportResultAPI.ReportResultPass(TestContext, "API", "Status check passed");
}

Configuration

Run settings (testrunsetting.runsettings)

• TestRunParameters: browser (e.g. chrome), driverPath, url, optional email/smtp settings
• MSTest: Parallelize (e.g. Workers=4, Scope=MethodLevel)
• ResultsDirectory: e.g. .\TestResults

appsettings.json

• ConnectionStrings: e.g. DefaultConnection for DbHelper
• Email: SmtpHost, SmtpPort, UseDefaultCred, Username, Password (optional)

Overriding browser options

protected override ChromeOptions SetChromeOptions()
{
    var options = new ChromeOptions();
    options.AddArguments("start-maximized");
    return options;
}

Reporting

In-test step reporting

ReportResult.ReportResultPass(driver, TestContext, "ModuleName", "Description");
ReportResult.ReportResultFail(driver, TestContext, "ModuleName", "Description", "exception text");

// API tests (no driver)
ReportResultAPI.ReportResultPass(TestContext, "ModuleName", "Description");

Element assertions with reporting

element.ReportElementExists(driver, TestContext, testName, "Element exists", ProdceedFlag: true);
element.ReportElementIsDisplayed(driver, TestContext, testName, "Element is displayed", ProdceedFlag: true);

Assembly summary

After all tests, AssemblyCleanup writes the combined result body to ResultTemplate.html and copies it to ResultTemplateFinal.html. Reporting is parallel-safe (file-based accumulator).

Usage Guide

Excel comparison

var excel = new ExcelDriver();
ExcelCompareStatus res = excel.CompareFiles("path/Excel1.xlsx", "path/Excel2.xlsx", sheetIndex1: 1, sheetIndex2: 1);
if (res.IsMatching) return true;

Accessibility (Axe)

var axe = new AxeAccessibility(driver);
axe.AnalyzePage();                                    // Full page scan
axe.AnalyzePageAndSaveHtml("report.html");            // Run and save HTML report
axe.AnalyzeCssSelector("#main");                      // Scoped scan
axe.AnalyzeWithConfigurator(b => b.Include(".modal")); // Custom configuration

Database (DbHelper)

Configure connection in appsettings.json under ConnectionStrings:DefaultConnection, then use:

DbHelper.VerifyConnection();
var value = DbHelper.ExecuteScalar<int>("SELECT COUNT(*) FROM Users");

License

This project is licensed under the MIT License.

Author: Sooraj Ramachandran
Copyright (c) 2026 Sooraj Ramachandran. All rights reserved.

This software is provided "as is", without warranty of any kind. See the license for full terms.