 |
VOOZH | about |
|
VOOZH | about |
This page documents the PowerShell scripting layer used by Ocaramba to orchestrate test execution across different environments, including local Windows machines, Linux runners, Docker containers, and Cloud providers (BrowserStack, SauceLabs). These scripts bridge the gap between CI/CD pipeline definitions (GitHub Actions and Azure Pipelines) and the dotnet vstest engine.
The primary utility script for environment-specific configuration is scripts/set_AppConfig_for_tests.ps1. This script is capable of modifying both legacy XML-based .config files and modern JSON appsettings.json files at runtime. It is extensively used in CI pipelines to inject secrets (like BrowserStack keys) or change the target browser without modifying the source code.
The script defines a function set_AppConfig_for_tests scripts/set_AppConfig_for_tests.ps136-112 that takes parameters for the directory, file name, section, and pipe-separated keys and values.
-json switch is $false (default), the script uses [xml] type casting to load the file scripts/set_AppConfig_for_tests.ps178 It uses SelectSingleNode to find elements via XPath (e.g., /configuration$section//add[@key='$key']/@value) and updates their attributes scripts/set_AppConfig_for_tests.ps191-94-json switch is $true, it uses ConvertFrom-Json to parse the file into a PowerShell object scripts/set_AppConfig_for_tests.ps197 It updates the object property dynamically using $appsettings.$section.$key and writes it back using ConvertTo-Json -depth 32 to ensure deep object structures are preserved scripts/set_AppConfig_for_tests.ps1108-110The following diagram shows how the script manipulates configuration files during a CI run.
"Configuration Injection Flow"
Sources: scripts/set_AppConfig_for_tests.ps136-112
Ocaramba utilizes specialized scripts to trigger tests in different environments. These scripts are typically called by the PowerShell@2 task in Azure Pipelines or the run step in GitHub Actions.
GitHub Actions uses a numbered series of scripts to parallelize test execution across multiple Windows runners:
ExecutingTestsOnWindowsGithubActions1.ps1: Executes Ocaramba.Tests.Angular, Ocaramba.Tests.NUnit, and Ocaramba.Tests.NUnitExtentReports using Edge scripts/ExecutingTestsOnWindowsGithubActions1.ps15-11ExecutingTestsOnWindowsGithubActions2.ps1: Runs Features, MsTest, Xunit, and UnitTests using Edge scripts/ExecutingTestsOnWindowsGithubActions2.ps15-21ExecutingTestsOnWindowsGithubActions5.ps1: Configures and runs tests against a local Selenium Grid hub (http://localhost:4444/wd/hub) scripts/ExecutingTestsOnWindowsGithubActions5.ps17-13 It sets ASPNETCORE_ENVIRONMENT="Linux" to trigger Linux-specific configuration overrides scripts/ExecutingTestsOnWindowsGithubActions5.ps11ExecutingTestsOnWindowsGithubActions6.ps1: Manages SauceLabs integration by injecting MAPPED_ENV_SAUCELABSUSERNAME and MAPPED_ENV_SAUCELABSACCESSKEY into the remote hub URL scripts/ExecutingTestsOnWindowsGithubActions6.ps15-9ExecutingTestsOnDockerGithubActions.ps1: Uses docker exec to run commands inside the ocaramba_selenium container. It performs a solution pruning using sed to remove projects like Documentation, Appium, and BrowserStack before building to reduce overhead scripts/ExecutingTestsOnDockerGithubActions.ps15 It then executes dotnet vstest with Linux-specific appsettings.Linux.json scripts/ExecutingTestsOnDockerGithubActions.ps16-7ExecutingTestsOnLinuxAzure.ps1: Used in Azure Pipelines to run NUnit tests on Linux agents. It explicitly sets ASPNETCORE_ENVIRONMENT="Linux" scripts/ExecutingTestsOnLinuxAzure.ps15 and targets a custom host (localhost:7080) scripts/ExecutingTestsOnLinuxAzure.ps19"GitHub Actions Windows Orchestration"
Sources: scripts/ExecutingTestsOnWindowsGithubActions1.ps11-27 scripts/ExecutingTestsOnWindowsGithubActions2.ps11-43 scripts/ExecutingTestsOnWindowsGithubActions5.ps11-34 scripts/ExecutingTestsOnWindowsGithubActions6.ps11-19
| Script | Purpose | Key Parameters / Commands |
|---|---|---|
set_AppConfig_for_tests.ps1 | Updates config files before test run | $OutDir, $configName, $section, $keys, $values, $json scripts/set_AppConfig_for_tests.ps120-34 |
ExecutingTestsOnWindowsGithubActions*.ps1 | Triggers NUnit/MsTest/Xunit on Windows | Invokes dotnet vstest for specific test suites. |
ExecutingTestsOnDockerGithubActions.ps1 | Runs tests inside Docker container | docker exec ocaramba_selenium bash -c ... scripts/ExecutingTestsOnDockerGithubActions.ps15-7 |
ExecutingTestsOnLinuxAzure.ps1 | Triggers tests on Azure Linux agents | $Env:ASPNETCORE_ENVIRONMENT="Linux" scripts/ExecutingTestsOnLinuxAzure.ps15 |
Most execution scripts include post-test logic to collect logs and screenshots:
TestOutput directories are copied to a temporary folder (e.g., TempZipStaging) scripts/ExecutingTestsOnWindowsGithubActions1.ps113-17Compress-Archive scripts/ExecutingTestsOnWindowsGithubActions2.ps135Remove-Item -Recurse -Force scripts/ExecutingTestsOnWindowsGithubActions5.ps126docker cp is used to pull TestOutput and .trx files from the container to the host before zipping scripts/ExecutingTestsOnDockerGithubActions.ps19-14removeSubprojectFromSolution.ps1: Uses regex replacement to prune Documentation subprojects from Ocaramba.sln scripts/removeSubprojectFromSolution.ps15PublishingApiDocumentationOn_gh-pages.ps1: Orchestrates the deployment of Sandcastle-generated documentation. It configures git credentials using GithubAuthToken scripts/PublishingApiDocumentationOn_gh-pages.ps117 clones the gh-pages branch, and pushes updated content scripts/PublishingApiDocumentationOn_gh-pages.ps125-49Sources:
Refresh this wiki