Add demonstration test for GitHub Actions annotations feature

Copilot · TravisEz13 · Copilot · commit 790ef4434d47 · 2026-02-12T19:13:44.000Z
- Added test in ciModule.Tests.ps1 to demonstrate the annotation feature
- Test intentionally fails to show annotations in CI output
- Verifies relative path conversion and test log links
- Can be removed after feature is verified in actual CI runs

Co-authored-by: TravisEz13 &lt;10873629+TravisEz13@users.noreply.github.com&gt;
diff --git a/test/infrastructure/ciModule.Tests.ps1 b/test/infrastructure/ciModule.Tests.ps1
@@ -244,3 +244,89 @@ Describe "Install-CIPester" {
     }
 }
 
+Describe "Show-PSPesterError GitHub Actions Annotations" {
+    BeforeAll {
+        # Import the build module which contains Show-PSPesterError
+        Import-Module "$PSScriptRoot/../../build.psm1" -Force
+        
+        # Set up GitHub Actions environment to trigger annotation feature
+        $script:originalGitHubWorkflow = $env:GITHUB_WORKFLOW
+        $script:originalGitHubWorkspace = $env:GITHUB_WORKSPACE
+        $script:originalGitHubServerUrl = $env:GITHUB_SERVER_URL
+        $script:originalGitHubRepository = $env:GITHUB_REPOSITORY
+        $script:originalGitHubRunId = $env:GITHUB_RUN_ID
+        
+        $env:GITHUB_WORKFLOW = 'test-workflow'
+        # Set workspace to repo root (two levels up from test/infrastructure)
+        $env:GITHUB_WORKSPACE = Resolve-Path "$PSScriptRoot/../.."
+        $env:GITHUB_SERVER_URL = 'https://github.com'
+        $env:GITHUB_REPOSITORY = 'PowerShell/PowerShell'
+        $env:GITHUB_RUN_ID = '12345'
+    }
+    
+    AfterAll {
+        # Restore original environment
+        if ($null -eq $script:originalGitHubWorkflow) {
+            Remove-Item Env:\GITHUB_WORKFLOW -ErrorAction SilentlyContinue
+        } else {
+            $env:GITHUB_WORKFLOW = $script:originalGitHubWorkflow
+        }
+        if ($null -eq $script:originalGitHubWorkspace) {
+            Remove-Item Env:\GITHUB_WORKSPACE -ErrorAction SilentlyContinue
+        } else {
+            $env:GITHUB_WORKSPACE = $script:originalGitHubWorkspace
+        }
+        if ($null -eq $script:originalGitHubServerUrl) {
+            Remove-Item Env:\GITHUB_SERVER_URL -ErrorAction SilentlyContinue
+        } else {
+            $env:GITHUB_SERVER_URL = $script:originalGitHubServerUrl
+        }
+        if ($null -eq $script:originalGitHubRepository) {
+            Remove-Item Env:\GITHUB_REPOSITORY -ErrorAction SilentlyContinue
+        } else {
+            $env:GITHUB_REPOSITORY = $script:originalGitHubRepository
+        }
+        if ($null -eq $script:originalGitHubRunId) {
+            Remove-Item Env:\GITHUB_RUN_ID -ErrorAction SilentlyContinue
+        } else {
+            $env:GITHUB_RUN_ID = $script:originalGitHubRunId
+        }
+    }
+    
+    Context "When test failure occurs in GitHub Actions" {
+        It "Should generate GitHub Actions annotation with relative file path - DEMONSTRATION TEST (will fail)" {
+            # This test intentionally fails to demonstrate the GitHub Actions annotation feature
+            # It can be removed once we verify the feature works in actual CI
+            
+            # Create a mock test failure XML with absolute path
+            $absolutePath = Join-Path $env:GITHUB_WORKSPACE "test/infrastructure/ciModule.Tests.ps1"
+            $xmlContent = @"
+<?xml version="1.0" encoding="utf-8"?>
+<test-results>
+  <test-case description="Demo Context" name="Demo test that fails" result="Failure">
+    <failure>
+      <message>This is a demonstration failure to show GitHub Actions annotations</message>
+      <stack-trace>at line: 42 in $absolutePath</stack-trace>
+    </failure>
+  </test-case>
+</test-results>
+"@
+            
+            $xml = [xml]$xmlContent
+            $testCase = $xml.'test-results'.'test-case'
+            
+            # Capture the output from Show-PSPesterError (Write-Host goes to stream 6)
+            $output = Show-PSPesterError -testFailure $testCase 6>&1 | Out-String
+            
+            # Verify the annotation is generated with relative path (not absolute)
+            $output | Should -Match '::error file=test/infrastructure/ciModule.Tests.ps1,line=42'
+            
+            # Verify the test log link is included
+            $output | Should -Match 'Test logs:.*github.com/PowerShell/PowerShell/actions/runs/12345'
+            
+            # This line intentionally fails to demonstrate the annotation in CI output
+            1 | Should -Be 2 -Because "This test demonstrates GitHub Actions annotations for test failures. Remove this test after verifying the feature works in CI."
+        }
+    }
+}
+
