🩹 [Patch]: Added verbosity to BeforeAll (#70)

MariusStorhaug · web-flow · commit 6e4779fb6a48 · 2024-08-21T22:39:56.000+02:00
## Description - Added verbosity to BeforeAll on SourceCode tests. ## Type of change  - [ ] 📖 [Docs] - [ ] 🪲 [Fix] - [x] 🩹 [Patch] - [ ] ⚠️ [Security fix] - [ ] 🚀 [Feature] - [ ] 🌟 [Breaking change] ## Checklist  - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas
diff --git a/README.md b/README.md
@@ -101,7 +101,8 @@ jobs:
 | `TestType` | The type of tests to run. Can be either `Module` or `SourceCode`.  | `true` | |
 | `Name` | The name of the module to test. The name of the repository is used if not specified. | `false` | |
 | `TestsPath` | The path to the tests to run. | `false` | `tests` |
-| `Shell` | The shell to use for running the tests. | `false` | `pwsh` |
+| `StackTraceVerbosity` | Verbosity level of the stack trace. Allowed values: `None`, `FirstLine`, `Filtered`, `Full`. | `false` | `None` |
+| `Verbosity` | Verbosity level of the test output. Allowed values: `None`, `Normal`, `Detailed`, `Diagnostic`. | `false` | `Detailed` |
 
 ### Outputs
 
diff --git a/action.yml b/action.yml
@@ -19,6 +19,14 @@ inputs:
     description: The path to the tests to run.
     required: false
     default: tests
+  StackTraceVerbosity:
+    description: "Verbosity level of the stack trace. Allowed values: 'None', 'FirstLine', 'Filtered', 'Full'."
+    required: false
+    default: 'None'
+  Verbosity:
+    description: "Verbosity level of the test output. Allowed values: 'None', 'Normal', 'Detailed', 'Diagnostic'."
+    required: false
+    default: 'Detailed'
 
 outputs:
   passed:
@@ -39,6 +47,8 @@ runs:
         GITHUB_ACTION_INPUT_Path: ${{ inputs.Path }}
         GITHUB_ACTION_INPUT_TestType: ${{ inputs.TestType }}
         GITHUB_ACTION_INPUT_TestsPath: ${{ inputs.TestsPath }}
+        GITHUB_ACTION_INPUT_StackTraceVerbosity: ${{ inputs.StackTraceVerbosity }}
+        GITHUB_ACTION_INPUT_Verbosity: ${{ inputs.Verbosity }}
       run: |
         # Test-PSModule
         $passed = . "${{ github.action_path }}\scripts\main.ps1" -Verbose
diff --git a/scripts/helpers/Test-PSModule.ps1 b/scripts/helpers/Test-PSModule.ps1
@@ -5,6 +5,10 @@
     #>
     [OutputType([int])]
     [CmdletBinding()]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute(
+        'PSReviewUnusedParameter', '', Scope = 'Function',
+        Justification = 'Parameters are used in nested ScriptBlocks'
+    )]
     param(
         # Path to the folder where the code to test is located.
         [Parameter(Mandatory)]
@@ -17,7 +21,17 @@
 
         # Path to the folder where the tests are located.
         [Parameter()]
-        [string] $TestsPath = 'tests'
+        [string] $TestsPath = 'tests',
+
+        # Verbosity level of the stack trace.
+        [Parameter()]
+        [ValidateSet('None', 'FirstLine', 'Filtered', 'Full')]
+        [string] $StackTraceVerbosity = 'None',
+
+        # Verbosity level of the test output.
+        [Parameter()]
+        [ValidateSet('None', 'Normal', 'Detailed', 'Diagnostic')]
+        [string] $Verbosity = 'Detailed'
     )
 
     $moduleName = Split-Path -Path $Path -Leaf
@@ -151,8 +165,8 @@
                 }
                 Output       = @{
                     CIFormat            = 'Auto'
-                    StackTraceVerbosity = 'None'
-                    Verbosity           = 'Detailed'
+                    StackTraceVerbosity = $StackTraceVerbosity
+                    Verbosity           = $Verbosity
                 }
             }
         }
diff --git a/scripts/main.ps1 b/scripts/main.ps1
@@ -11,32 +11,40 @@ LogGroup "Loading helper scripts from [$path]" {
 
 LogGroup 'Loading inputs' {
     $moduleName = if ($env:GITHUB_ACTION_INPUT_Name | IsNullOrEmpty) { $env:GITHUB_REPOSITORY_NAME } else { $env:GITHUB_ACTION_INPUT_Name }
-    Write-Verbose "Module name:       [$moduleName]"
+    Write-Verbose "Module name:         [$moduleName]"
 
     $codeToTest = Join-Path -Path $env:GITHUB_WORKSPACE -ChildPath "$env:GITHUB_ACTION_INPUT_Path\$moduleName"
     if (Test-Path -Path $codeToTest) {
-        Write-Verbose "Code to test:      [$codeToTest]"
+        Write-Verbose "Code to test:        [$codeToTest]"
     } else {
         $codeToTest = Join-Path -Path $env:GITHUB_WORKSPACE -ChildPath $env:GITHUB_ACTION_INPUT_Path
     }
 
-    Write-Verbose "Code to test:      [$codeToTest]"
+    Write-Verbose "Code to test:        [$codeToTest]"
     if (-not (Test-Path -Path $codeToTest)) {
         throw "Path [$codeToTest] does not exist."
     }
     Write-Verbose "Test type to run:  [$env:GITHUB_ACTION_INPUT_TestType]"
 
     $testsPath = $env:GITHUB_ACTION_INPUT_TestsPath
-    Write-Verbose "Path to tests:     [$testsPath]"
+    Write-Verbose "Path to tests:       [$testsPath]"
     if (-not (Test-Path -Path $testsPath)) {
         throw "Path [$testsPath] does not exist."
     }
+
+    $StackTraceVerbosity = $env:GITHUB_ACTION_INPUT_StackTraceVerbosity
+    Write-Verbose "StackTraceVerbosity: [$StackTraceVerbosity]"
+    $Verbosity = $env:GITHUB_ACTION_INPUT_Verbosity
+    Write-Verbose "Verbosity:           [$Verbosity]"
+
 }
 
 $params = @{
-    Path      = $codeToTest
-    TestType  = $env:GITHUB_ACTION_INPUT_TestType
-    TestsPath = $testsPath
+    Path                = $codeToTest
+    TestType            = $env:GITHUB_ACTION_INPUT_TestType
+    TestsPath           = $testsPath
+    StackTraceVerbosity = $StackTraceVerbosity
+    Verbosity           = $Verbosity
 }
 $results = Test-PSModule @params
 
diff --git a/scripts/tests/PSModule/SourceCode.Tests.ps1 b/scripts/tests/PSModule/SourceCode.Tests.ps1
@@ -13,6 +13,11 @@ Param(
 
 BeforeAll {
     $scriptFiles = Get-ChildItem -Path $Path -Include *.psm1, *.ps1 -Recurse -File
+    LogGroup 'Script files:' {
+        $scriptFiles | ForEach-Object {
+            Write-Verbose " - $($_.FullName)" -Verbose
+        }
+    }
     $functionsPath = Join-Path -Path $Path -ChildPath 'functions'
     # $privateFunctionsPath = Join-Path -Path $functionsPath -ChildPath 'private'
     $publicFunctionsPath = Join-Path -Path $functionsPath -ChildPath 'public'
@@ -22,9 +27,9 @@ BeforeAll {
     $functionFiles = (Test-Path -Path $functionsPath) ? (Get-ChildItem -Path $functionsPath -Filter '*.ps1' -File) : $null
     $publicFunctionFiles = (Test-Path -Path $publicFunctionsPath) ? (Get-ChildItem -Path $publicFunctionsPath -File -Filter '*.ps1' -Recurse) : $null
 
-    Write-Verbose "Found $($scriptFiles.Count) script files in $Path"
-    Write-Verbose "Found $($functionFiles.Count) function files in $Path"
-    Write-Verbose "Found $($publicFunctionFiles.Count) public function files in $Path"
+    Write-Verbose "Found $($scriptFiles.Count) script files in [$Path]" -Verbose
+    Write-Verbose "Found $($functionFiles.Count) function files in [$functionsPath]" -Verbose
+    Write-Verbose "Found $($publicFunctionFiles.Count) public function files in [$publicFunctionsPath]" -Verbose
 }
 
 Describe 'PSModule - SourceCode tests' {
