Official sample and reference solution for STAF.UI.API — UI automation (Selenium), REST API tests, Excel and database helpers, HTML reporting, and accessibility checks using STAF.
- .NET 10 SDK
- Visual Studio 2022+, or VS Code with C# Dev Kit
- Chrome or Edge (UI tests)
git clone https://github.com/sooraj171/STAF.Selenium.Tests
cd STAF.Selenium.Tests
dotnet restore
dotnet build
dotnet test --settings STAFTests/testrunsetting.runsettingsRun settings: The project defaults to STAFTests/testrunsetting.runsettings. In Visual Studio, use Test → Configure Run Settings → Select Solution Wide runsettings File if tests do not pick it up automatically.
Configuration: URLs, browser, and credentials are in STAFTests/testrunsetting.runsettings (purl, userName, password, …) and STAFTests/appsettings.json (database connection, optional email).
After a run, open TestResults for per-test HTML reports and the assembly summary (ResultTemplateFinal.html).
| Area | Examples |
|---|---|
| UI tests | ParaTests, GoogleSearchTest, ReportingSamplesTests, WebDriverExtensionsSamplesTests |
| API / data | APITests, ExcelTests, DatabaseSamplesTests |
| Page objects | LoginPage, AboutUsPage, AccountsOverviewPage (PageBaseClass, FindAppElement) |
| Actions | Login, AboutUs, AccountsOverview — fluent flows with ReportResult |
| Reporting | ReportResult, ReportElement*, ReportResultAPI |
| Accessibility | Axe in ParaTests.LoginToApp |
| Parallel runs | MSTest Parallelize in run settings |
See RELEASE_NOTES.md for the .NET 10 upgrade and the current dependency refresh.
AI index maintenance: After adding or renaming pages, actions, or tests, update docs/ai/ai-index.json and run powershell -File tools/UpdateAiIndex.ps1 from the repo root to validate (or pwsh if you use PowerShell 7). Use -Discover to list classes under STAFTests/Pages, Actions, Tests, Requests, and APIData.
STAF.Selenium.Tests/
├── README.md
├── AGENTS.md # AI assistant entry (Cursor, Copilot)
├── STAF.Selenium.Tests.sln
├── STAFTests/ # Test project (Pages, Actions, Tests, Requests, APIData)
├── docs/ # User guide, architecture summary, AI docs
├── MCPAgent/ # Optional MCP servers (stdio)
│ ├── publish/ # selenium-staf browser and codegen
│ └── AzureDevOps/ # Azure DevOps MCP server
├── .github/ # Copilot instructions and VS custom agents
├── .cursor/ # Cursor rules and skills
└── .vscode/ # VS Code settings and MCP config
| Document | Audience |
|---|---|
| docs/README.md | Documentation hub |
| docs/STAF-Framework-User-Guide.html | End-user framework guide (browser / PDF) |
| docs/Architecture-Summary.md | One-page architecture and MCP overview |
| docs/ai/QUICK_START.md | AI: add UI, page/action, or API tests |
| docs/details/ | Extended / maintainer reference (optional) |
STAF patterns are enforced via repo instructions so generated code uses TestBaseClass, FindAppElement, and ReportResult — not raw Thread.Sleep or ad-hoc WebDriver code.
| Tool | Entry |
|---|---|
| All agents | AGENTS.md |
| GitHub Copilot | .github/copilot-instructions.md |
| Visual Studio agents | .github/agents/ — STAF UI Automation, STAF API Automation |
| Cursor | .cursor/rules/, .cursor/skills/ |
| MCP | MCPAgent/README.md — selenium-staf and azure-devops |
Symbol index: docs/ai/ai-index.json — refresh with pwsh tools/UpdateAiIndex.ps1 after adding types.
STAFTests/STAF.Selenium.Tests.csproj targets net10.0 and references these versions:
| Package | Version |
|---|---|
| STAF.UI.API | 4.4.4 |
| Microsoft.NET.Test.Sdk | 18.10.1 |
| MSTest.TestAdapter | 4.4.1 |
| MSTest.TestFramework | 4.4.1 |
| RestSharp | 114.0.0 |
| HtmlAgilityPack | 1.13.0 |
# All tests (runsettings from project)
dotnet test
# Explicit runsettings
dotnet test --settings STAFTests/testrunsetting.runsettings
# Filter
dotnet test --filter "ClassName~ParaTests" --settings STAFTests/testrunsetting.runsettingsMIT License — Copyright © 2026 Sooraj Ramachandran.