🩹 [CI]: Refactor Get-TestSuites workflow to include SkipTests input and separate outputs for SourceCode and Module test suites

Author: MariusStorhaug

.github/workflows/CI.yml

@@ -69,18 +69,25 @@ permissions:
   statuses: write      # to update the status of the workflow from linter
 
 jobs:
+  Get-TestSuites:
+    name: Get-TestSuites
+    uses: ./.github/workflows/Get-TestSuites.yml
+    with:
+      SkipTests: ${{ inputs.SkipTests }}
+      Debug: ${{ inputs.Debug }}
+      Prerelease: ${{ inputs.Prerelease }}
+      Verbose: ${{ inputs.Verbose }}
+      Version: ${{ inputs.Version }}
+      WorkingDirectory: ${{ inputs.WorkingDirectory }}
+
   Test-SourceCode:
     name: Test-SourceCode
+    needs:
+      - Get-TestSuites
     strategy:
       fail-fast: false
       matrix:
-        include:
-          - OSName: Linux
-            RunsOn: ubuntu-latest
-          - OSName: macOS
-            RunsOn: macos-latest
-          - OSName: Windows
-            RunsOn: windows-latest
+        include: ${{ fromJson(needs.Get-TestSuites.outputs.SourceCodeTestSuites) }}
     uses: ./.github/workflows/Test-SourceCode.yml
     with:
       RunsOn: ${{ matrix.RunsOn }}
@@ -143,16 +150,6 @@ jobs:
       Version: ${{ inputs.Version }}
       WorkingDirectory: ${{ inputs.WorkingDirectory }}
 
-  Get-TestSuites:
-    name: Get-TestSuites
-    uses: ./.github/workflows/Get-TestSuites.yml
-    with:
-      Debug: ${{ inputs.Debug }}
-      Prerelease: ${{ inputs.Prerelease }}
-      Verbose: ${{ inputs.Verbose }}
-      Version: ${{ inputs.Version }}
-      WorkingDirectory: ${{ inputs.WorkingDirectory }}
-
   Test-ModuleLocal:
     name: ${{ matrix.TestName }}
     if: ${{ needs.Build-Module.result == 'success' && !cancelled() }}
@@ -162,7 +159,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        include: ${{ fromJson(needs.Get-TestSuites.outputs.TestSuites) }}
+        include: ${{ fromJson(needs.Get-TestSuites.outputs.ModuleTestSuites) }}
     uses: ./.github/workflows/Test-ModuleLocal.yml
     secrets: inherit
     with:

.github/workflows/Get-TestSuites.yml

@@ -3,6 +3,11 @@ name: Get-TestSuites
 on:
   workflow_call:
     inputs:
+      SkipTests:
+        type: string
+        description: Defines what types of tests to skip. Allowed values are 'All', 'SourceCode', 'Module', 'None', 'macOS', 'Windows', 'Linux'.
+        required: false
+        default: None
       Debug:
         type: boolean
         description: Enable debug output.
@@ -30,9 +35,12 @@ on:
         default: '.'
 
     outputs:
-      TestSuites:
-        description: The test suites to run.
-        value: ${{ jobs.Get-TestSuites.outputs.TestSuites }}
+      SourceCodeTestSuites:
+        description: Source Code test suites to run.
+        value: ${{ jobs.Get-TestSuites.outputs.SourceCodeTestSuites }}
+      ModuleTestSuites:
+        description: Module test suites to run.
+        value: ${{ jobs.Get-TestSuites.outputs.ModuleTestSuites }}
 
 permissions:
   contents: read # to checkout the repo
@@ -42,14 +50,17 @@ jobs:
     name: Get-TestSuites
     runs-on: ubuntu-latest
     outputs:
-      TestSuites: ${{ fromJson(steps.Get-TestSuites.outputs.result).TestSuites }}
+      SourceCodeTestSuites: ${{ fromJson(steps.Get-TestSuites.outputs.result).SourceCodeTestSuites }}
+      ModuleTestSuites: ${{ fromJson(steps.Get-TestSuites.outputs.result).ModuleTestSuites }}
     steps:
       - name: Checkout Code
         uses: actions/checkout@v4
 
       - name: Get-TestSuites
         uses: PSModule/GitHub-Script@v1
         id: Get-TestSuites
+        env:
+          PSMODULE_GET_TESTSUITES_INPUT_SkipTests: ${{ inputs.SkipTests }}
         with:
           ShowOutput: true
           Debug: ${{ inputs.Debug }}
@@ -60,9 +71,9 @@ jobs:
           Script: |
             # Define test configurations as an array of hashtables.
             $osConfigs = @(
-                @{ runson = 'ubuntu-latest'; name = 'Linux' }
-                @{ runson = 'macos-latest';  name = 'macOS' }
-                @{ runson = 'windows-latest'; name = 'Windows' }
+                @{ RunsOn = 'ubuntu-latest'; OSName = 'Linux' }
+                @{ RunsOn = 'macos-latest';  OSName = 'macOS' }
+                @{ RunsOn = 'windows-latest'; OSName = 'Windows' }
             )
 
             # Locate the tests directory.
@@ -113,17 +124,24 @@ jobs:
                 foreach ($item in $testItems) {
                     foreach ($osConfig in $osConfigs) {
                         [pscustomobject]@{
-                            RunsOn   = $osConfig.runson
-                            OSName   = $osConfig.name
+                            RunsOn   = $osConfig.RunsOn
+                            OSName   = $osConfig.OSName
                             TestPath = Resolve-Path -Path $item.FullName -Relative
                             TestName = $item.BaseName
                         }
                     }
                 }
             }
 
-            # (Optional) Display the generated matrix in a table for verification.
-            $testSuites | Format-Table -AutoSize
+            # Create separate outputs for source code tests (OS only) and module tests (existing detailed output)
+            $sourceCodeTestSuites = $osConfigs | Select-Object -Property RunsOn, OSName -Unique
+
+            # Display the generated matrices for verification.
+            Write-Host "Source Code Test Suites:"
+            $sourceCodeTestSuites | Format-Table -AutoSize | Out-String
+            Write-Host "Module Test Suites:"
+            $testSuites | Format-Table -AutoSize | Out-String
 
-            # Pass the final object to GitHub Actions output.
-            Set-GitHubOutput -Name TestSuites -Value $testSuites
+            # Pass the final objects to GitHub Actions output.
+            Set-GitHubOutput -Name SourceCodeTestSuites -Value $sourceCodeTestSuites
+            Set-GitHubOutput -Name ModuleTestSuites -Value $testSuites