Fix bug where Pester fails to run but workflow pipeline itself doesn't fail

.github/workflows/unit_test_powershell.yaml

@@ -19,7 +19,8 @@ jobs:
       - name: Check out repository code
         uses: actions/checkout@v4
       - name: Run Pester Tests
-        if: ${{ !cancelled() }}
         shell: powershell
         run: |
-          Invoke-Pester -Output 'Detailed' -Path 'PowerShell/ScubaGear/Testing/Unit/PowerShell'
+          # Source the function
+          . utils/workflow/Invoke-PesterTests.ps1
+          Invoke-PesterTests -Path 'PowerShell/ScubaGear/Testing/Unit/PowerShell'

.github/workflows/unit_test_workflows.yaml

@@ -19,7 +19,8 @@ jobs:
     steps:
       - name: Check out repository code
         uses: actions/checkout@v4
-      - name: Run Pester Tests
+      - name: Run Invoke PSSA Pester Tests
         run: |
-          # This should run all workflow unit tests
-          Invoke-Pester -Output 'Detailed' -Path 'Testing/workflow'
+          # Source the function
+          . utils/workflow/Invoke-PesterTests.ps1
+          Invoke-PesterTests -Path 'Testing/workflow'

Testing/workflow/Invoke-PSSA.Tests.ps1

@@ -24,8 +24,8 @@ Describe "PSSA Check" {
   It "PSSA should write output" {
     # There should be write-warning statements
     $global:Warnings | Should -Not -BeNullOrEmpty
-    # Note: This is a bit fragile.  It only works as long as one of these two
-    # summary statements is the final output written by the Invoke function.
+    # Note: This is a little bit fragile.  It only works as long as one of these two
+    # summary statements is the final output written.
     $global:Warnings | Select-Object -Last 1 | Should -BeIn @("Problems were found in the PowerShell scripts.", "No problems were found in the PowerShell scripts.")
   }
 }

Testing/workflow/Invoke-PesterTests.Tests.ps1

@@ -0,0 +1,11 @@
+# The purpose of this test is to have a trivial Pester test that passes.
+# This simply verifies that Pester is running.
+
+Describe "Pester Check" {
+  It "Passing test should pass." {
+    $TestFile = Join-Path -Path $PSScriptRoot -ChildPath 'PesterTestFile/SimplePassFile.ps1' -Resolve
+    # Source the function
+    . utils/workflow/Invoke-PesterTests.ps1
+    Invoke-PesterTests -Path $TestFile
+  }
+}

Testing/workflow/PesterTestFile/SimplePassFile.ps1

@@ -0,0 +1,7 @@
+# Ultra trivial Pester test that should always pass.
+
+Describe "Pester Check" {
+  It "Passing test should pass." {
+    $true | Should -Be $true
+  }
+}

utils/workflow/Invoke-PesterTests.ps1

@@ -0,0 +1,30 @@
+function Invoke-PesterTests {
+  <#
+    .SYNOPSIS
+      Calls the Invoke-Pester command to test the PowerShell files in some location.
+    .PARAMETER Path
+      The path to the PowerShell.  This can be a directory or a file.
+  #>
+	[CmdletBinding()]
+	param(
+		[Parameter(Mandatory = $true)]
+		[string]
+		$Path
+	)
+  Write-Warning "The path to test is ${Path}."
+  # The -PassThru parameter is what allows the output to be passed to the $result output.
+  # https://pester.dev/docs/commands/Invoke-Pester#-passthru
+  $result = Try {
+    Invoke-Pester -Output 'Detailed' -Path $Path -PassThru
+  } Catch {
+    # This catches an error with the Pester tests.
+    Write-Warning "An error occurred while running the Pester tests:"
+    Write-Warning $_
+    exit 1
+  }
+  # This catches an error that causes Pester not to run at all
+  # (e.g., if the -Path is set to a nonexistent directory).
+  if ($null -eq $result) {
+    throw "The Pester tests failed to run."
+  }
+}