Add regression test for analyzer report paths

Author: MariusStorhaug

.github/workflows/Action-Test.yml

@@ -121,6 +121,37 @@ jobs:
           Write-Host "Outcome: ${{ steps.action-test.outcome }}"
           Write-Host "Conclusion: ${{ steps.action-test.conclusion }}"
 
+  ActionTestReportPaths:
+    name: Action-Test - [Report Paths]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+        with:
+          persist-credentials: false
+
+      - name: Action-Test
+        uses: ./
+        id: action-test
+        with:
+          Path: src
+          WorkingDirectory: tests/srcTestRepo
+          TestResult_Enabled: true
+          TestResult_OutputFormat: NUnitXml
+          TestResult_OutputPath: .PSModule/TestResult/PSScriptAnalyzer-TestResult-Report.xml
+          CodeCoverage_Enabled: true
+          CodeCoverage_OutputFormat: JaCoCo
+          CodeCoverage_OutputPath: .PSModule/CodeCoverage/PSScriptAnalyzer-CodeCoverage-Report.xml
+          CodeCoverage_Path: ../../src/tests/PSScriptAnalyzer/PSScriptAnalyzer.Tests.ps1
+
+      - name: Assert report paths
+        shell: pwsh
+        run: |
+          tests/Assert-ReportPaths.ps1 `
+            -WorkingDirectory tests/srcTestRepo `
+            -TestResultPath .PSModule/TestResult/PSScriptAnalyzer-TestResult-Report.xml `
+            -CodeCoveragePath .PSModule/CodeCoverage/PSScriptAnalyzer-CodeCoverage-Report.xml
+
   ActionTestOutputs:
     name: Action-Test - [outputs]
     runs-on: ubuntu-latest
@@ -153,6 +184,7 @@ jobs:
       - ActionTestSrcCustom
       - ActionTestSrcWithManifest
       - ActionTestSrcWithManifestDefault
+      - ActionTestReportPaths
       - ActionTestOutputs
     if: always()
     runs-on: ubuntu-latest

tests/Assert-ReportPaths.ps1

@@ -0,0 +1,64 @@
+[CmdletBinding()]
+param(
+    [Parameter(Mandatory)]
+    [string] $WorkingDirectory,
+
+    [Parameter(Mandatory)]
+    [string] $TestResultPath,
+
+    [Parameter(Mandatory)]
+    [string] $CodeCoveragePath
+)
+
+function Assert-ReportPath {
+    [CmdletBinding()]
+    param(
+        [Parameter(Mandatory)]
+        [string] $Path,
+
+        [Parameter(Mandatory)]
+        [string] $ReportName,
+
+        [Parameter(Mandatory)]
+        [string] $ArtifactDirectory
+    )
+
+    $resolvedPath = [System.IO.Path]::GetFullPath($Path)
+    $resolvedArtifactDirectory = [System.IO.Path]::GetFullPath($ArtifactDirectory).TrimEnd(
+        [System.IO.Path]::DirectorySeparatorChar,
+        [System.IO.Path]::AltDirectorySeparatorChar
+    ) + [System.IO.Path]::DirectorySeparatorChar
+
+    if (-not $resolvedPath.StartsWith($resolvedArtifactDirectory, [System.StringComparison]::OrdinalIgnoreCase)) {
+        throw "Expected $ReportName report beneath [$resolvedArtifactDirectory], but found [$resolvedPath]."
+    }
+
+    foreach ($reportPath in @($resolvedPath, [System.IO.Path]::ChangeExtension($resolvedPath, '.json'))) {
+        if (-not (Test-Path -Path $reportPath -PathType Leaf)) {
+            throw "Expected $ReportName report at [$reportPath]."
+        }
+    }
+
+    try {
+        $null = [xml](Get-Content -Path $resolvedPath -Raw)
+    } catch {
+        throw "Expected an XML $ReportName report at [$resolvedPath]."
+    }
+}
+
+$resolvedWorkingDirectory = [System.IO.Path]::GetFullPath($WorkingDirectory)
+$artifactDirectory = Join-Path -Path $resolvedWorkingDirectory -ChildPath '.PSModule'
+
+Assert-ReportPath -Path (Join-Path -Path $resolvedWorkingDirectory -ChildPath $TestResultPath) `
+    -ReportName 'test result' `
+    -ArtifactDirectory $artifactDirectory
+Assert-ReportPath -Path (Join-Path -Path $resolvedWorkingDirectory -ChildPath $CodeCoveragePath) `
+    -ReportName 'code coverage' `
+    -ArtifactDirectory $artifactDirectory
+
+foreach ($unexpectedDirectory in @('TestResult', 'CodeCoverage', '.temp')) {
+    $unexpectedPath = Join-Path -Path $resolvedWorkingDirectory -ChildPath $unexpectedDirectory
+    if (Test-Path -Path $unexpectedPath) {
+        throw "Did not expect generated action state at [$unexpectedPath]."
+    }
+}