Repository navigation
AL-Go Telemetry Enhancements: repository fork and hosting information #2392
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Alexander Holstrup (aholstrup1)
wants to merge
3
commits into
main
Choose a base branch
from
aholstrup1-al-go-telemetry
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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,242 @@ | ||
| [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', '', Justification = 'Test case parameters are used in Pester mock parameter filters')] | ||
| param() | ||
|
|
||
| $errorActionPreference = "Stop"; $ProgressPreference = "SilentlyContinue"; Set-StrictMode -Version 2.0 | ||
|
|
||
| Import-Module (Join-Path $PSScriptRoot '../Actions/TelemetryHelper.psm1') -Force -DisableNameChecking | ||
|
|
||
| Describe 'Structured action telemetry' { | ||
| InModuleScope TelemetryHelper { | ||
| BeforeAll { | ||
| [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignments', 'wrapperPath', Justification = 'Used by tests in separate Pester scriptblocks')] | ||
| $wrapperPath = Join-Path $PSScriptRoot '../Actions/Invoke-AlGoAction.ps1' -Resolve | ||
| } | ||
|
|
||
| BeforeEach { | ||
| $additionalData = [System.Collections.Generic.Dictionary[string, string]]::new() | ||
| $additionalData.Add('CustomProperty', 'preserved') | ||
| Mock AddTelemetryEvent {} | ||
| Mock Write-Host {} | ||
| } | ||
|
|
||
| It 'Adds the action name without inferring a conclusion from <command>' -TestCases @( | ||
| @{ command = 'Trace-Information'; expectedMessage = 'AL-Go action ran: Test'; expectedSeverity = 'Information' } | ||
| @{ command = 'Trace-Exception'; expectedMessage = 'AL-Go action failed: Test'; expectedSeverity = 'Error' } | ||
| ) { | ||
| param($command, $expectedMessage, $expectedSeverity) | ||
| & $command -ActionName 'Test' -AdditionalData $additionalData | ||
|
|
||
| Assert-MockCalled AddTelemetryEvent -Times 1 -Exactly -ParameterFilter { | ||
| $Data['ActionName'] -eq 'Test' -and | ||
| -not $Data.ContainsKey('ActionConclusion') -and | ||
| $Data['CustomProperty'] -eq 'preserved' -and | ||
| $Message -eq $expectedMessage -and $Severity -eq $expectedSeverity | ||
| } | ||
| } | ||
|
|
||
| It 'Does not add action dimensions to message-only <command> events' -TestCases @( | ||
| @{ command = 'Trace-Information' } | ||
| @{ command = 'Trace-Exception' } | ||
| @{ command = 'Trace-Warning' } | ||
| ) { | ||
| param($command) | ||
| & $command -Message 'Custom message' | ||
|
|
||
| Assert-MockCalled AddTelemetryEvent -Times 1 -Exactly -ParameterFilter { | ||
| -not $Data.ContainsKey('ActionName') -and | ||
| -not $Data.ContainsKey('ActionConclusion') -and | ||
| $Message -eq 'Custom message' | ||
| } | ||
| } | ||
|
|
||
| It 'Reports successful completion with the existing duration and additional data' { | ||
| & $wrapperPath -ActionName 'Test' -Action {} -AdditionalData $additionalData | ||
|
|
||
| Assert-MockCalled AddTelemetryEvent -Times 1 -Exactly -ParameterFilter { | ||
| $Data['ActionName'] -eq 'Test' -and | ||
| $Data['ActionConclusion'] -eq 'Success' -and | ||
| $Data.ContainsKey('ActionDuration') -and [double]$Data['ActionDuration'] -ge 0 -and | ||
| $Data['CustomProperty'] -eq 'preserved' | ||
| } | ||
| } | ||
|
|
||
| It 'Reports a terminating failure and preserves the error and exit code' { | ||
| & $wrapperPath -ActionName 'Test' -Action { throw 'Action failed' } | ||
|
|
||
| $LASTEXITCODE | Should -Be 1 | ||
| Assert-MockCalled AddTelemetryEvent -Times 1 -Exactly -ParameterFilter { | ||
| $Data['ActionName'] -eq 'Test' -and | ||
| $Data['ActionConclusion'] -eq 'Failure' -and | ||
| $Data['ErrorMessage'] -eq 'Action failed' -and | ||
| $Data.ContainsKey('ActionDuration') -and [double]$Data['ActionDuration'] -ge 0 | ||
| } | ||
| } | ||
|
|
||
| It 'Does not count a handled error as a failed action execution' { | ||
| & $wrapperPath -ActionName 'Test' -Action { | ||
| try { | ||
| throw 'Handled error' | ||
| } | ||
| catch { | ||
| Trace-Exception -ActionName 'Test' -ErrorRecord $_ | ||
| } | ||
| } | ||
|
|
||
| Assert-MockCalled AddTelemetryEvent -Times 2 -Exactly | ||
| Assert-MockCalled AddTelemetryEvent -Times 1 -Exactly -ParameterFilter { | ||
| $Data['ActionName'] -eq 'Test' -and | ||
| $Data['ErrorMessage'] -eq 'Handled error' -and | ||
| -not $Data.ContainsKey('ActionConclusion') | ||
| } | ||
| Assert-MockCalled AddTelemetryEvent -Times 1 -Exactly -ParameterFilter { | ||
| $Data['ActionConclusion'] -eq 'Success' | ||
| } | ||
| } | ||
|
|
||
| It 'Honors SkipTelemetry when the action fails: <fail>' -TestCases @( | ||
| @{ fail = $false } | ||
| @{ fail = $true } | ||
| ) { | ||
| param($fail) | ||
| & $wrapperPath -ActionName 'Test' -SkipTelemetry -Action { | ||
| if ($fail) { throw 'Action failed' } | ||
| } | ||
|
|
||
| Assert-MockCalled AddTelemetryEvent -Times 0 -Exactly | ||
| if ($fail) { | ||
| $LASTEXITCODE | Should -Be 1 | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| Describe 'Repository environment telemetry' { | ||
| InModuleScope TelemetryHelper { | ||
| BeforeEach { | ||
| [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignments', 'savedServerUrl', Justification = 'Restored in AfterEach')] | ||
| $savedServerUrl = $env:GITHUB_SERVER_URL | ||
| [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignments', 'savedEventPath', Justification = 'Restored in AfterEach')] | ||
| $savedEventPath = $env:GITHUB_EVENT_PATH | ||
|
github-advanced-security[bot] marked this conversation as resolved.
Fixed
|
||
| $env:GITHUB_SERVER_URL = 'https://github.com' | ||
| $env:GITHUB_EVENT_PATH = Join-Path $TestDrive 'event.json' | ||
| '{"repository":{"fork":false}}' | Set-Content -LiteralPath $env:GITHUB_EVENT_PATH -Encoding UTF8 | ||
| [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignments', 'data', Justification = 'Used by tests in separate Pester scriptblocks')] | ||
| $data = [System.Collections.Generic.Dictionary[string, string]]::new() | ||
|
github-advanced-security[bot] marked this conversation as resolved.
Fixed
|
||
| Mock Write-Host {} | ||
| } | ||
|
|
||
| AfterEach { | ||
| $env:GITHUB_SERVER_URL = $savedServerUrl | ||
| $env:GITHUB_EVENT_PATH = $savedEventPath | ||
| } | ||
|
|
||
| It 'Classifies <url> as <expected>' -TestCases @( | ||
| @{ url = 'https://github.com'; expected = 'GitHub.com' } | ||
| @{ url = 'https://GITHUB.COM/'; expected = 'GitHub.com' } | ||
| @{ url = 'https://contoso.ghe.com'; expected = 'GHEC' } | ||
| @{ url = 'https://CONTOSO.GHE.COM/'; expected = 'GHEC' } | ||
| @{ url = 'https://github.contoso.com'; expected = 'GHES' } | ||
| @{ url = 'https://github.contoso.com:8443/'; expected = 'GHES' } | ||
| @{ url = 'https://notghe.com'; expected = 'GHES' } | ||
| @{ url = 'https://contoso.ghe.com.example.org'; expected = 'GHES' } | ||
| @{ url = 'https://github.com.example.org'; expected = 'GHES' } | ||
| ) { | ||
| param($url, $expected) | ||
| $env:GITHUB_SERVER_URL = $url | ||
|
|
||
| Get-GitHubHostingType | Should -Be $expected | ||
| Assert-MockCalled Write-Host -Times 0 | ||
| } | ||
|
|
||
| It 'Reports Unknown for invalid server URL <url>' -TestCases @( | ||
| @{ url = '' } | ||
| @{ url = 'not a URL' } | ||
| @{ url = 'github.com' } | ||
| @{ url = 'file:///tmp/github.com' } | ||
| ) { | ||
| param($url) | ||
| $env:GITHUB_SERVER_URL = $url | ||
|
|
||
| Get-GitHubHostingType | Should -Be 'Unknown' | ||
| Assert-MockCalled Write-Host -Times 1 -ParameterFilter { $Object -like '::Warning::*GITHUB_SERVER_URL*' } | ||
| } | ||
|
|
||
| It 'Uses the workflow repository fork flag, not the pull request source' -TestCases @( | ||
| @{ repositoryFork = $true; headFork = $false; expected = 'true' } | ||
| @{ repositoryFork = $false; headFork = $true; expected = 'false' } | ||
| ) { | ||
| param($repositoryFork, $headFork, $expected) | ||
| @{ | ||
| repository = @{ fork = $repositoryFork } | ||
| pull_request = @{ head = @{ repo = @{ fork = $headFork } } } | ||
| } | ConvertTo-Json -Depth 5 | Set-Content -LiteralPath $env:GITHUB_EVENT_PATH -Encoding UTF8 | ||
|
|
||
| Get-RepositoryIsFork | Should -Be $expected | ||
| Assert-MockCalled Write-Host -Times 0 | ||
| } | ||
|
|
||
| It 'Reports Unknown for unavailable or invalid fork metadata: <json>' -TestCases @( | ||
| @{ json = '{}' } | ||
| @{ json = '{"repository":{}}' } | ||
| @{ json = '{"repository":{"fork":null}}' } | ||
| @{ json = '{"repository":{"fork":"false"}}' } | ||
| @{ json = '{"repository":{"fork":0}}' } | ||
| @{ json = '{"repository":null}' } | ||
| @{ json = 'null' } | ||
| @{ json = '{invalid json' } | ||
| ) { | ||
| param($json) | ||
| $json | Set-Content -LiteralPath $env:GITHUB_EVENT_PATH -Encoding UTF8 | ||
|
|
||
| Get-RepositoryIsFork | Should -Be 'Unknown' | ||
| Assert-MockCalled Write-Host -Times 1 -ParameterFilter { $Object -like '::Warning::*GITHUB_EVENT_PATH*' } | ||
| } | ||
|
|
||
| It 'Reports Unknown when the event file is unavailable' -TestCases @( | ||
| @{ missingPath = $true } | ||
| @{ missingPath = $false } | ||
| ) { | ||
| param($missingPath) | ||
| if ($missingPath) { | ||
| $env:GITHUB_EVENT_PATH = $null | ||
| } | ||
| else { | ||
| $env:GITHUB_EVENT_PATH = Join-Path $TestDrive 'missing.json' | ||
| } | ||
|
|
||
| Get-RepositoryIsFork | Should -Be 'Unknown' | ||
| Assert-MockCalled Write-Host -Times 1 -ParameterFilter { $Object -like '::Warning::*GITHUB_EVENT_PATH*' } | ||
| } | ||
|
|
||
| It 'Adds repository dimensions to events without replacing existing data' { | ||
| Mock ReadSettings { return @{ microsoftTelemetryConnectionString = ''; partnerTelemetryConnectionString = '' } } | ||
| Mock Get-Module { return $null } -ParameterFilter { $Name -eq 'BcContainerHelper' } | ||
| Mock Get-ApplicationInsightsTelemetryClient { throw 'Telemetry must not be sent when disabled.' } | ||
| $data.Add('ActionDuration', '42') | ||
|
|
||
| AddTelemetryEvent -Message 'AL-Go action ran: Test' -Data $data | ||
|
|
||
| $data['RepositoryIsFork'] | Should -Be 'false' | ||
| $data['GitHubHostingType'] | Should -Be 'GitHub.com' | ||
| $data['PowerShellVersion'] | Should -Be $PSVersionTable.PSVersion.ToString() | ||
| $data['ActionDuration'] | Should -Be '42' | ||
| Assert-MockCalled ReadSettings -Times 1 -Exactly | ||
| Assert-MockCalled Get-ApplicationInsightsTelemetryClient -Times 0 | ||
| } | ||
|
|
||
| It 'Continues logging existing telemetry when new metadata is invalid' { | ||
| Mock ReadSettings { return @{ microsoftTelemetryConnectionString = ''; partnerTelemetryConnectionString = '' } } | ||
| Mock Get-Module { return $null } -ParameterFilter { $Name -eq 'BcContainerHelper' } | ||
| $env:GITHUB_SERVER_URL = 'invalid' | ||
| '{invalid json' | Set-Content -LiteralPath $env:GITHUB_EVENT_PATH -Encoding UTF8 | ||
|
|
||
| AddTelemetryEvent -Message 'AL-Go workflow ran' -Data $data | ||
|
|
||
| $data['RepositoryIsFork'] | Should -Be 'Unknown' | ||
| $data['GitHubHostingType'] | Should -Be 'Unknown' | ||
| $data['PowerShellVersion'] | Should -Be $PSVersionTable.PSVersion.ToString() | ||
| Assert-MockCalled ReadSettings -Times 1 -Exactly | ||
| Assert-MockCalled Write-Host -Times 0 -ParameterFilter { $Object -like 'Failed to log telemetry event:*' } | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.