-
Notifications
You must be signed in to change notification settings - Fork 177
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Konrad Jamrozik
committed
Mar 2, 2023
1 parent
8a02e02
commit 1ed0a49
Showing
7 changed files
with
182 additions
and
123 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| # About common-tests | ||
|
|
||
| Every PowerShell source that is complex enough to have unit tests should have these tests be written in the [Pester](https://pester.dev/) | ||
| framework and placed in `eng/common-tests/**`, i.e. this directory or one of its descendants. | ||
| By design, unlike `eng/common`, `eng/common-tests` is not subject to | ||
| [mirroring to repositories](https://github.com/Azure/azure-sdk-tools/blob/main/doc/common/common_engsys.md). | ||
|
|
||
| ## When tests in this directory are executed | ||
|
|
||
| The PowerShell Pester unit tests will be executed by the [`tools - eng-common-tests`](https://dev.azure.com/azure-sdk/internal/_build/results?buildId=220791) pipeline | ||
| upon a PR that makes changes to `eng/common-tests/**`. The pipeline source is `eng/common-tests/ci.yml`. | ||
|
|
||
| ## How to ensure your PowerShell pester unit test is executed | ||
|
|
||
| By Pester's default convention, the tests are to be placed in files whose | ||
| [names ends with `.tests.ps1`](https://pester.dev/docs/usage/file-placement-and-naming), | ||
| e.g. [`job-matrix-functions.tests.ps1`](https://github.com/Azure/azure-sdk-tools/blob/8a02e02adfc0d213509fce2764132afa74bd4ba4/eng/common-tests/matrix-generator/tests/job-matrix-functions.tests.ps1). | ||
|
|
||
| Furthermore, each test needs to be tagged with `UnitTest`, [e.g. as seen here](https://github.com/Azure/azure-sdk-tools/blob/8a02e02adfc0d213509fce2764132afa74bd4ba4/eng/common-tests/matrix-generator/tests/job-matrix-functions.tests.ps1#L51): `Describe "Matrix-Lookup" -Tag "UnitTest", "lookup"`. | ||
|
|
||
| Finally, as already mentioned, all such test files must be located in the path of `eng/common-tests/**`. | ||
|
|
||
| For more, see [Invoke-Pester doc](https://pester.dev/docs/commands/Invoke-Pester). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| Import-Module Pester | ||
|
|
||
| BeforeAll { | ||
| . $PSScriptRoot/../common/scripts/get-codeowners-functions.ps1 | ||
|
|
||
| $ToolVersion = "1.0.0-dev.20230214.3" | ||
| $ToolPath = (Join-Path ([System.IO.Path]::GetTempPath()) "codeowners-tool") | ||
| $DevOpsFeed = "https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-net/nuget/v3/index.json" | ||
| $VsoVariable = "" | ||
|
|
||
| function TestGetCodeowners([string]$targetPath, [string]$codeownersFileLocation, [bool]$includeNonUserAliases = $false, [string[]]$expectedOwners) { | ||
| Write-Host "Test: Owners for path '$targetPath' in CODEOWNERS file at path '$codeownersFileLocation' should be '$expectedOwners'" | ||
|
|
||
| $actualOwners = Get-Codeowners ` | ||
| -ToolVersion $ToolVersion ` | ||
| -ToolPath $ToolPath ` | ||
| -DevOpsFeed $DevOpsFeed ` | ||
| -VsoVariable $VsoVariable ` | ||
| -targetPath $targetPath ` | ||
| -codeownersFileLocation $codeownersFileLocation ` | ||
| -includeNonUserAliases $IncludeNonUserAliases | ||
|
|
||
| if ($actualOwners.Count -ne $expectedOwners.Count) { | ||
| Write-Error "The length of actual result is not as expected. Expected length: $($expectedOwners.Count), Actual length: $($actualOwners.Count)." | ||
| exit 1 | ||
| } | ||
| for ($i = 0; $i -lt $expectedOwners.Count; $i++) { | ||
| if ($expectedOwners[$i] -ne $actualOwners[$i]) { | ||
| Write-Error "Expect result $expectedOwners[$i] is different than actual result $actualOwners[$i]." | ||
| exit 1 | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| Describe "Retrieve Codeowners" -Tag "UnitTest" { | ||
| It "Should retrieve Codeowners" -TestCases @( | ||
| @{ | ||
| codeownersPath = "$PSScriptRoot/../../.github/CODEOWNERS"; | ||
| targetPath = "eng/common/scripts/get-codeowners.ps1"; | ||
| expectedOwners = @("konrad-jamrozik", "weshaggard", "benbp") | ||
| }, | ||
| @{ | ||
| codeownersPath = "$PSScriptRoot/../../tools/code-owners-parser/Azure.Sdk.Tools.RetrieveCodeOwners.Tests/TestData/glob_path_CODEOWNERS"; | ||
| targetPath = "tools/code-owners-parser/Azure.Sdk.Tools.RetrieveCodeOwners.Tests/TestData/InputDir/a.txt"; | ||
| expectedOwners = @("2star") | ||
| } | ||
| ) { | ||
| $azSdkToolsCodeowners = (Resolve-Path $codeownersPath) | ||
| TestGetCodeowners -targetPath $targetPath -codeownersFileLocation $azSdkToolsCodeowners -includeNonUserAliases $true -expectedOwners $expectedOwners | ||
| $LASTEXITCODE | Should -Be 0 | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| function Get-CodeownersTool([string] $ToolPath, [string] $DevOpsFeed, [string] $ToolVersion) | ||
| { | ||
| $codeownersToolCommand = Join-Path $ToolPath "retrieve-codeowners" | ||
| # Check if the retrieve-codeowners tool exists or not. | ||
| if (Get-Command $codeownersToolCommand -errorAction SilentlyContinue) { | ||
| return $codeownersToolCommand | ||
| } | ||
| if (!(Test-Path $ToolPath)) { | ||
| New-Item -ItemType Directory -Path $ToolPath | Out-Null | ||
| } | ||
| Write-Host "Installing the retrieve-codeowners tool under tool path: $ToolPath ..." | ||
|
|
||
| # Run command under tool path to avoid dotnet tool install command checking .csproj files. | ||
| # This is a bug for dotnet tool command. Issue: https://github.com/dotnet/sdk/issues/9623 | ||
| Push-Location $ToolPath | ||
| dotnet tool install --tool-path $ToolPath --add-source $DevOpsFeed --version $ToolVersion "Azure.Sdk.Tools.RetrieveCodeOwners" | Out-Null | ||
| Pop-Location | ||
| # Test to see if the tool properly installed. | ||
| if (!(Get-Command $codeownersToolCommand -errorAction SilentlyContinue)) { | ||
| Write-Error "The retrieve-codeowners tool is not properly installed. Please check your tool path: $ToolPath" | ||
| return | ||
| } | ||
| return $codeownersToolCommand | ||
| } | ||
|
|
||
| function Get-Codeowners( | ||
| [string] $ToolPath, | ||
| [string] $DevOpsFeed, | ||
| [string] $ToolVersion, | ||
| [string] $VsoVariable, | ||
| [string] $targetPath, | ||
| [string] $targetDirectory, | ||
| [string] $codeownersFileLocation, | ||
| [bool] $includeNonUserAliases = $false) | ||
| { | ||
| # Backward compaitiblity: if $targetPath is not provided, fall-back to the legacy $targetDirectory | ||
| if ([string]::IsNullOrWhiteSpace($targetPath)) { | ||
| $targetPath = $targetDirectory | ||
| } | ||
| if ([string]::IsNullOrWhiteSpace($targetPath)) { | ||
| Write-Error "TargetPath (or TargetDirectory) parameter must be neither null nor whitespace." | ||
| return ,@() | ||
| } | ||
|
|
||
| $codeownersToolCommand = Get-CodeownersTool -ToolPath $ToolPath -DevOpsFeed $DevOpsFeed -ToolVersion $ToolVersion | ||
| Write-Host "Executing: & $codeownersToolCommand --target-path $targetPath --codeowners-file-path-or-url $codeownersFileLocation --exclude-non-user-aliases:$(!$includeNonUserAliases)" | ||
| $commandOutput = & $codeownersToolCommand ` | ||
| --target-path $targetPath ` | ||
| --codeowners-file-path-or-url $codeownersFileLocation ` | ||
| --exclude-non-user-aliases:$(!$includeNonUserAliases) ` | ||
| 2>&1 | ||
|
|
||
| if ($LASTEXITCODE -ne 0) { | ||
| Write-Host "Command $codeownersToolCommand execution failed (exit code = $LASTEXITCODE). Output string: $commandOutput" | ||
| return ,@() | ||
| } else | ||
| { | ||
| Write-Host "Command $codeownersToolCommand executed successfully (exit code = 0). Output string length: $($commandOutput.length)" | ||
| } | ||
|
|
||
| # Assert: $commandOutput is a valid JSON representing: | ||
| # - a single CodeownersEntry, if the $targetPath was a single path | ||
| # - or a dictionary of CodeownerEntries, keyes by each path resolved from a $targetPath glob path. | ||
| # | ||
| # For implementation details, see Azure.Sdk.Tools.RetrieveCodeOwners.Program.Main | ||
|
|
||
| $codeownersJson = $commandOutput | ConvertFrom-Json | ||
|
|
||
| if ($VsoVariable) { | ||
| $codeowners = $codeownersJson.Owners -join "," | ||
| Write-Host "##vso[task.setvariable variable=$VsoVariable;]$codeowners" | ||
| } | ||
|
|
||
| return ,@($codeownersJson.Owners) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters