🚀 [Feature]: Add Shell parameter (#28)

## Description

- Add `Shell` parameter, as a preparation to test on `powershell` and
`pwsh`.
- Compatibility update for PS5.1.

## Type of change

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

- [ ] 📖 [Docs]
- [ ] 🪲 [Fix]
- [ ] 🩹 [Patch]
- [ ] ⚠️ [Security fix]
- [x] 🚀 [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.yml

@@ -5,13 +5,22 @@ run-name: "Action-Test - [${{ github.event.pull_request.title }} #${{ github.eve
 on: [pull_request]
 
 jobs:
-  ActionTestSrc:
+  ActionTest:
     strategy:
       fail-fast: false
       matrix:
+        shell: [pwsh]
+        os: [ubuntu-latest, macos-latest, windows-latest]
         path: [tests/src, tests/outputs/modules]
-    name: Action-Test - [${{ matrix.path }}]
-    runs-on: ubuntu-latest
+        include:
+          - shell: powershell
+            os: windows-latest
+            path: tests/src
+          - shell: powershell
+            os: windows-latest
+            path: tests/outputs/modules
+    name: Action-Test - [${{ matrix.os }}@${{ matrix.shell }}] - [${{ matrix.path }}]
+    runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout repo
         uses: actions/checkout@v4
@@ -24,6 +33,8 @@ jobs:
 
       - name: Initialize environment
         uses: PSModule/Initialize-PSModule@main
+        with:
+          Shell: ${{ matrix.shell }}
 
       - name: Action-Test
         uses: ./
@@ -32,3 +43,4 @@ jobs:
         with:
           Name: PSModule
           Path: ${{ matrix.path }}
+          Shell: ${{ matrix.shell }}

README.md

@@ -90,6 +90,7 @@ jobs:
 | `Name` | The name of the module to test. The name of the repository is used if not specified. | `false` | |
 | `Path` | The path to the module to test. | `true` | |
 | `RunModuleTests` | Run the module tests. | `false` | `true` |
+| `Shell` | The shell to use for running the tests. | `false` | `pwsh` |
 
 ## PSModule tests
 

action.yml

@@ -16,12 +16,16 @@ inputs:
     description: Run the module tests.
     required: false
     default: 'true'
+  Shell:
+    description: The shell to use for running the tests.
+    required: false
+    default: pwsh
 
 runs:
   using: composite
   steps:
     - name: Run Test-PSModule
-      shell: pwsh
+      shell: ${{ inputs.Shell }}
       env:
         GITHUB_ACTION_INPUT_Name: ${{ inputs.Name }}
         GITHUB_ACTION_INPUT_Path: ${{ inputs.Path }}

scripts/helpers/Test-PSModule.ps1

@@ -34,7 +34,7 @@ function Test-PSModule {
     #region Add test - Common - PSScriptAnalyzer
     Start-LogGroup 'Add test - Common - PSScriptAnalyzer'
     $containers = @()
-    $PSSATestsPath = Join-Path -Path $env:GITHUB_ACTION_PATH -ChildPath 'scripts' 'tests' 'PSScriptAnalyzer'
+    $PSSATestsPath = Join-Path -Path $env:GITHUB_ACTION_PATH -ChildPath 'scripts\tests\PSScriptAnalyzer'
     $containerParams = @{
         Path = Join-Path $PSSATestsPath 'PSScriptAnalyzer.Tests.ps1'
         Data = @{
@@ -50,7 +50,7 @@ function Test-PSModule {
 
     #region Add test - Common - PSModule
     Start-LogGroup 'Add test - Common - PSModule'
-    $PSModuleTestsPath = Join-Path -Path $env:GITHUB_ACTION_PATH -ChildPath 'scripts' 'tests' 'PSModule'
+    $PSModuleTestsPath = Join-Path -Path $env:GITHUB_ACTION_PATH -ChildPath 'scripts\tests\PSModule'
     $containerParams = @{
         Path = $PSModuleTestsPath
         Data = @{
@@ -90,8 +90,8 @@ function Test-PSModule {
     if ((Test-Path -Path $moduleTestsPath) -and $RunModuleTests) {
         Start-LogGroup "Importing module: $moduleName"
         Add-PSModulePath -Path (Split-Path $Path -Parent)
-        Remove-Module -Name $moduleName -ErrorAction SilentlyContinue -Force
-        Import-Module $Path -Force
+        Get-Module -Name $moduleName -ListAvailable | Remove-Module -Force -Verbose:$false
+        Import-Module -Name $moduleName -Force
         Stop-LogGroup
     }
     #endregion

scripts/main.ps1

@@ -4,15 +4,15 @@
 param()
 
 Start-LogGroup 'Loading helper scripts'
-Get-ChildItem -Path (Join-Path -Path $env:GITHUB_ACTION_PATH -ChildPath 'scripts' 'helpers') -Filter '*.ps1' -Recurse |
+Get-ChildItem -Path (Join-Path -Path $env:GITHUB_ACTION_PATH -ChildPath 'scripts\helpers') -Filter '*.ps1' -Recurse |
     ForEach-Object { Write-Verbose "[$($_.FullName)]"; . $_.FullName }
 Stop-LogGroup
 
 Start-LogGroup 'Loading inputs'
-$moduleName = ($env:GITHUB_ACTION_INPUT_Name | IsNullOrEmpty) ? $env:GITHUB_REPOSITORY_NAME : $env:GITHUB_ACTION_INPUT_Name
+$moduleName = if ($env:GITHUB_ACTION_INPUT_Name | IsNullOrEmpty) { $env:GITHUB_REPOSITORY_NAME } else { $env:GITHUB_ACTION_INPUT_Name }
 Write-Verbose "Module name:       [$moduleName]"
 
-$codeToTest = Join-Path -Path $env:GITHUB_WORKSPACE -ChildPath $env:GITHUB_ACTION_INPUT_Path $moduleName
+$codeToTest = Join-Path -Path $env:GITHUB_WORKSPACE -ChildPath "$env:GITHUB_ACTION_INPUT_Path\$moduleName"
 Write-Verbose "Code to test:      [$codeToTest]"
 if (-not (Test-Path -Path $codeToTest)) {
     throw "Path [$codeToTest] does not exist."
@@ -23,7 +23,7 @@ Write-Verbose "Run module tests:  [$runModuleTests]"
 Stop-LogGroup
 
 $params = @{
-    Path = $codeToTest
+    Path           = $codeToTest
     RunModuleTests = $runModuleTests
 }
 $results = Test-PSModule @params

scripts/tests/PSScriptAnalyzer/PSScriptAnalyzer.Tests.ps1

@@ -20,7 +20,15 @@ Param(
 )
 
 BeforeDiscovery {
-    $rules = Get-ScriptAnalyzerRule | Sort-Object -Property Severity | ConvertTo-Json | ConvertFrom-Json -AsHashtable
+    $rules = @()
+    $ruleObjects = Get-ScriptAnalyzerRule | Sort-Object -Property Severity
+    foreach ($ruleObject in $ruleObjects) {
+        $hashTable = @{}
+        foreach ($property in $ruleObject.PSObject.Properties) {
+            $hashTable[$property.Name] = $property.Value
+        }
+        $rules += $hashTable
+    }
     Write-Warning "Discovered [$($rules.Count)] rules"
     $relativeSettingsFilePath = $SettingsFilePath.Replace($PSScriptRoot, '').Trim('\').Trim('/')
 }