🩹 [Patch]: Include debug and verbose preference parameters into the testing suites (#81)

## Description

This pull request introduces changes to improve the verbosity and
debugging capabilities of the PowerShell module tests. The most
important changes include updating verbosity and debug preferences,
modifying the default verbosity level, and enhancing the module import
process.

### Verbosity and Debug Preferences:

*
[`.github/workflows/Action-Test-Src-Default.yml`](diffhunk://#diff-8ecb4765631346daa3fc827a56e509b7e8c1db0fc5ce7e3736bfea19531c0779R37-R38):
Added `DebugPreference` and `VerbosePreference` settings to the
`PSModuleTest` job.
*
[`scripts/helpers/Test-PSModule.ps1`](diffhunk://#diff-2100eb52126417766eeb5b98f9c6a0da1dd10302b3b7c05d476295e3bd76ce76L62-R63):
Updated multiple instances to use `VerbosePreference` and
`DebugPreference` from environment variables instead of hardcoded
values.
[[1]](diffhunk://#diff-2100eb52126417766eeb5b98f9c6a0da1dd10302b3b7c05d476295e3bd76ce76L62-R63)
[[2]](diffhunk://#diff-2100eb52126417766eeb5b98f9c6a0da1dd10302b3b7c05d476295e3bd76ce76L75-R77)
[[3]](diffhunk://#diff-2100eb52126417766eeb5b98f9c6a0da1dd10302b3b7c05d476295e3bd76ce76L89-R92)
[[4]](diffhunk://#diff-2100eb52126417766eeb5b98f9c6a0da1dd10302b3b7c05d476295e3bd76ce76L105-R109)
[[5]](diffhunk://#diff-2100eb52126417766eeb5b98f9c6a0da1dd10302b3b7c05d476295e3bd76ce76R123-R124)
[[6]](diffhunk://#diff-2100eb52126417766eeb5b98f9c6a0da1dd10302b3b7c05d476295e3bd76ce76L176-R193)

### Default Verbosity Level:

*
[`action.yml`](diffhunk://#diff-1243c5424efaaa19bd8e813c5e6f6da46316e63761421b3e5f5c8ced9a36e6b6L25-R25):
Changed the default verbosity level of the stack trace from 'Filtered'
to 'Full'.

### Module Import Process:

*
[`scripts/helpers/Test-PSModule.ps1`](diffhunk://#diff-2100eb52126417766eeb5b98f9c6a0da1dd10302b3b7c05d476295e3bd76ce76L137-R146):
Enhanced the module import process to remove existing modules and their
dependencies more thoroughly before importing the test module.

These changes collectively improve the control over verbosity and
debugging during test execution, and ensure a cleaner module import
process.

## Type of change

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [ ] 📖 [Docs]
- [ ] 🪲 [Fix]
- [x] 🩹 [Patch]
- [ ] ⚠️ [Security fix]
- [ ] 🚀 [Feature]
- [ ] 🌟 [Breaking change]

## Checklist

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [x] I have performed a self-review of my own code
- [x] I have commented my code, particularly in hard-to-understand areas

Author: MariusStorhaug

.github/workflows/Action-Test-Src-Default.yml

@@ -34,6 +34,8 @@ jobs:
           Name: PSModuleTest
           Path: tests/src
           TestType: SourceCode
+          DebugPreference: 'Continue'
+          VerbosePreference: 'Continue'
 
       - name: Status
         shell: pwsh

action.yml

@@ -22,7 +22,7 @@ inputs:
   StackTraceVerbosity:
     description: "Verbosity level of the stack trace. Allowed values: 'None', 'FirstLine', 'Filtered', 'Full'."
     required: false
-    default: 'Filtered'
+    default: 'Full'
   Verbosity:
     description: "Verbosity level of the test output. Allowed values: 'None', 'Normal', 'Detailed', 'Diagnostic'."
     required: false

scripts/helpers/Test-PSModule.ps1

@@ -59,7 +59,8 @@
             Data = @{
                 Path             = $Path
                 SettingsFilePath = $settingsFilePath
-                Verbose          = $true
+                Verbose          = $env:GITHUB_ACTION_INPUT_VerbosePreference -eq 'Continue'
+                Debug            = $env:GITHUB_ACTION_INPUT_DebugPreference -eq 'Continue'
             }
         }
         Write-Verbose 'ContainerParams:'
@@ -72,7 +73,8 @@
             Path = Join-Path -Path $PSScriptRoot -ChildPath '..\tests\PSModule\Common.Tests.ps1'
             Data = @{
                 Path    = $Path
-                Verbose = $true
+                Verbose = $env:GITHUB_ACTION_INPUT_VerbosePreference -eq 'Continue'
+                Debug   = $env:GITHUB_ACTION_INPUT_DebugPreference -eq 'Continue'
             }
         }
         Write-Verbose 'ContainerParams:'
@@ -86,7 +88,8 @@
                 Path = Join-Path -Path $PSScriptRoot -ChildPath '..\tests\PSModule\Module.Tests.ps1'
                 Data = @{
                     Path    = $Path
-                    Verbose = $true
+                    Verbose = $env:GITHUB_ACTION_INPUT_VerbosePreference -eq 'Continue'
+                    Debug   = $env:GITHUB_ACTION_INPUT_DebugPreference -eq 'Continue'
                 }
             }
             Write-Verbose 'ContainerParams:'
@@ -102,7 +105,8 @@
                 Data = @{
                     Path      = $Path
                     TestsPath = $moduleTestsPath
-                    Verbose   = $true
+                    Verbose   = $env:GITHUB_ACTION_INPUT_VerbosePreference -eq 'Continue'
+                    Debug     = $env:GITHUB_ACTION_INPUT_DebugPreference -eq 'Continue'
                 }
             }
             Write-Verbose 'ContainerParams:'
@@ -115,7 +119,9 @@
         if (Test-Path -Path $moduleTestsPath) {
             LogGroup "Add test - Module - $moduleName" {
                 $containerParams = @{
-                    Path = $moduleTestsPath
+                    Path    = $moduleTestsPath
+                    Verbose = $env:GITHUB_ACTION_INPUT_VerbosePreference -eq 'Continue'
+                    Debug   = $env:GITHUB_ACTION_INPUT_DebugPreference -eq 'Continue'
                 }
                 Write-Verbose 'ContainerParams:'
                 Write-Verbose "$($containerParams | ConvertTo-Json)"
@@ -134,7 +140,10 @@
 
         LogGroup "Importing module: $moduleName" {
             Add-PSModulePath -Path (Split-Path $Path -Parent)
-            Get-Module -Name $moduleName -ListAvailable | Remove-Module -Force
+            $existingModule = Get-Module -Name $ModuleName -ListAvailable
+            $existingModule | Remove-Module -Force -Verbose
+            $existingModule.RequiredModules | ForEach-Object { $_ | Remove-Module -Force -Verbose -ErrorAction SilentlyContinue }
+            $existingModule.NestedModules | ForEach-Object { $_ | Remove-Module -Force -Verbose -ErrorAction SilentlyContinue }
             Import-Module -Name $moduleName -Force -RequiredVersion '999.0.0' -Global
         }
     }
@@ -147,6 +156,9 @@
                     Container = $containers
                     PassThru  = $true
                 }
+                Debug        = @{
+                    WriteDebugMessages = $env:GITHUB_ACTION_INPUT_DebugPreference = 'Continue'
+                }
                 TestResult   = @{
                     Enabled       = $testModule
                     OutputFormat  = 'NUnitXml'
@@ -173,9 +185,12 @@
 
     #region Run tests
     $verbosepref = $VerbosePreference
-    $VerbosePreference = 'SilentlyContinue'
+    $debugpref = $DebugPreference
+    $VerbosePreference = $env:GITHUB_ACTION_INPUT_VerbosePreference
+    $DebugPreference = $env:GITHUB_ACTION_INPUT_DebugPreference
     $results = Invoke-Pester @pesterParams
     $VerbosePreference = $verbosepref
+    $DebugPreference = $debugpref
     #endregion
 
     $results