Honor analyzer report path inputs

Author: MariusStorhaug

.github/workflows/Action-Test.yml

@@ -152,6 +152,35 @@ jobs:
             -TestResultPath .PSModule/TestResult/PSScriptAnalyzer-TestResult-Report.xml `
             -CodeCoveragePath .PSModule/CodeCoverage/PSScriptAnalyzer-CodeCoverage-Report.xml
 
+  ActionTestDefaultReportPaths:
+    name: Action-Test - [Default 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
+          CodeCoverage_Enabled: true
+          CodeCoverage_OutputFormat: JaCoCo
+          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
@@ -185,6 +214,7 @@ jobs:
       - ActionTestSrcWithManifest
       - ActionTestSrcWithManifestDefault
       - ActionTestReportPaths
+      - ActionTestDefaultReportPaths
       - ActionTestOutputs
     if: always()
     runs-on: ubuntu-latest

README.md

@@ -41,7 +41,7 @@ customize rule selection, severity filtering, and custom rule inclusion.
 | `Run_SkipRemainingOnFailure`         | Skips remaining tests after failure (None/Run/Container/Block).                | false    |                                                     |
 | `CodeCoverage_Enabled`               | Enable CodeCoverage.                                                           | false    |                                                     |
 | `CodeCoverage_OutputFormat`          | Format to use for code coverage report (JaCoCo/CoverageGutters/Cobertura).     | false    |                                                     |
-| `CodeCoverage_OutputPath`            | Path relative to the current directory where code coverage report is saved.    | false    |                                                     |
+| `CodeCoverage_OutputPath`            | Path relative to the current directory where code coverage report is saved.    | false    | `.PSModule/CodeCoverage/PSScriptAnalyzer-CodeCoverage-Report.xml` |
 | `CodeCoverage_OutputEncoding`        | Encoding of the output file.                                                   | false    |                                                     |
 | `CodeCoverage_Path`                  | Directories or files to be used for code coverage.                             | false    |                                                     |
 | `CodeCoverage_ExcludeTests`          | Exclude tests from code coverage.                                              | false    |                                                     |
@@ -51,7 +51,7 @@ customize rule selection, severity filtering, and custom rule inclusion.
 | `CodeCoverage_SingleHitBreakpoints`  | Remove breakpoint when it is hit.                                              | false    |                                                     |
 | `TestResult_Enabled`                 | Enable TestResult.                                                             | false    |                                                     |
 | `TestResult_OutputFormat`            | Format to use for test result report (NUnitXml/NUnit2.5/NUnit3/JUnitXml).      | false    |                                                     |
-| `TestResult_OutputPath`              | Path relative to the current directory where test result report is saved.      | false    |                                                     |
+| `TestResult_OutputPath`              | Path relative to the current directory where test result report is saved.      | false    | `.PSModule/TestResult/PSScriptAnalyzer-TestResult-Report.xml` |
 | `TestResult_OutputEncoding`          | Encoding of the output file.                                                   | false    |                                                     |
 | `TestResult_TestSuiteName`           | Set the name assigned to the root 'test-suite' element.                        | false    | `PSScriptAnalyzer`                                  |
 | `Should_ErrorAction`                 | Controls if Should throws on error. Use 'Stop' or 'Continue'.                  | false    |                                                     |

action.yml

@@ -110,6 +110,7 @@ inputs:
     description: |
       Path relative to the current directory where code coverage report is saved.
     required: false
+    default: .PSModule/CodeCoverage/PSScriptAnalyzer-CodeCoverage-Report.xml
   CodeCoverage_OutputEncoding:
     description: |
       Encoding of the output file.
@@ -150,6 +151,7 @@ inputs:
     description: |
       Path relative to the current directory where test result report is saved.
     required: false
+    default: .PSModule/TestResult/PSScriptAnalyzer-TestResult-Report.xml
   TestResult_OutputEncoding:
     description: |
       Encoding of the output file.
@@ -282,7 +284,7 @@ runs:
         Script: ${{ github.action_path }}/src/main.ps1
 
     - name: Invoke-Pester
-      uses: PSModule/Invoke-Pester@4ff33199141fdf22568990b6107fe3148ae93a1c # v5.1.0
+      uses: PSModule/Invoke-Pester@c5494aba3c07d7bfd81bdbbc9f301e8fa4a729fb # v5.1.1
       id: test
       env:
         SettingsFilePath: ${{ fromJson(steps.paths.outputs.result).SettingsFilePath }}

tests/Assert-ReportPaths.ps1

@@ -11,6 +11,10 @@ param(
 )
 
 function Assert-ReportPath {
+    <#
+        .SYNOPSIS
+        Confirms that an action report is generated in the fixture artifact directory.
+    #>
     [CmdletBinding()]
     param(
         [Parameter(Mandatory)]