Expose test data through a shared module-local action

Author: MariusStorhaug

.github/actions/Expose-TestData/action.yml

@@ -0,0 +1,24 @@
+name: Expose-TestData
+description: Exposes caller-provided Process-PSModule TestData as environment variables.
+author: PSModule
+branding:
+  icon: unlock
+  color: white
+
+inputs:
+  TestData:
+    description: |
+      Optional single-line JSON object with 'secrets' and 'variables' maps. Entries are validated by
+      Import-TestData and exported to GITHUB_ENV for later steps in the same job.
+    required: false
+    default: ''
+
+runs:
+  using: composite
+  steps:
+    - name: Expose caller-provided test data
+      shell: pwsh
+      env:
+        PSMODULE_TEST_DATA: ${{ inputs.TestData }}
+      run: |
+        Import-TestData

.github/workflows/AfterAll-ModuleLocal.yml

@@ -43,11 +43,9 @@ jobs:
         uses: ./_wf/.github/actions/Install-PSModuleHelpers
 
       - name: Expose caller-provided test data
-        shell: pwsh
-        env:
-          PSMODULE_TEST_DATA: ${{ secrets.TestData }}
-        run: |
-          Import-TestData
+        uses: ./_wf/.github/actions/Expose-TestData
+        with:
+          TestData: ${{ secrets.TestData }}
 
       - name: Run AfterAll Teardown Scripts
         if: always()

.github/workflows/BeforeAll-ModuleLocal.yml

@@ -43,11 +43,9 @@ jobs:
         uses: ./_wf/.github/actions/Install-PSModuleHelpers
 
       - name: Expose caller-provided test data
-        shell: pwsh
-        env:
-          PSMODULE_TEST_DATA: ${{ secrets.TestData }}
-        run: |
-          Import-TestData
+        uses: ./_wf/.github/actions/Expose-TestData
+        with:
+          TestData: ${{ secrets.TestData }}
 
       - name: Run BeforeAll Setup Scripts
         uses: PSModule/GitHub-Script@8083ec1f733f00357ee4d0db0c6056686e483bc0 # v1.9.0

.github/workflows/Test-ModuleLocal.yml

@@ -54,11 +54,9 @@ jobs:
         uses: ./_wf/.github/actions/Install-PSModuleHelpers
 
       - name: Expose caller-provided test data
-        shell: pwsh
-        env:
-          PSMODULE_TEST_DATA: ${{ secrets.TestData }}
-        run: |
-          Import-TestData
+        uses: ./_wf/.github/actions/Expose-TestData
+        with:
+          TestData: ${{ secrets.TestData }}
 
       - name: Import-Module
         id: import-module

.github/workflows/workflow.yml

@@ -15,7 +15,10 @@ on:
           $env:<name>. Values under "secrets" are masked in the logs; values under "variables" are not.
           Build it from secrets.<name> / vars.<name> in the calling workflow (see the README). Keep it
           on a single line so GitHub registers one mask for the whole value. Omit it when the module
-          needs no test data.
+          needs no test data. The same keys are exported before BeforeAll-ModuleLocal,
+          Test-ModuleLocal, and AfterAll-ModuleLocal run. If setup or teardown scripts see a missing
+          key, confirm the caller explicitly maps a TestData JSON value; secrets: inherit only passes
+          an already-created TestData secret and does not build JSON from individual secrets.
         required: false
     inputs:
       SettingsPath:

README.md

@@ -9,3 +9,30 @@ The full documentation lives on the MSX / Docs site:
 📖 **[Process-PSModule documentation](https://msxorg.github.io/docs/Frameworks/Process-PSModule/)**
 
 It covers getting started, the pipeline stages, usage, configuration, repository structure, and the principles behind the framework.
+
+## TestData phase parity
+
+Module-local setup, test, and teardown phases use the same `TestData` contract. Values under
+`secrets` are masked and values under `variables` are exported unmasked, and every key is available
+as `$env:<name>` in all three phases:
+
+- `BeforeAll-ModuleLocal` (`tests/BeforeAll.ps1`)
+- `Test-ModuleLocal` (Pester module tests)
+- `AfterAll-ModuleLocal` (`tests/AfterAll.ps1`)
+
+Pass `TestData` as a single-line JSON object from the calling workflow:
+
+```yaml
+jobs:
+  Process-PSModule:
+    uses: PSModule/Process-PSModule/.github/workflows/workflow.yml@v6
+    secrets:
+      APIKey: ${{ secrets.APIKey }}
+      TestData: >-
+        { "secrets": { "TEST_TOKEN": "${{ secrets.TEST_TOKEN }}" },
+          "variables": { "TEST_OWNER": ${{ toJSON(vars.TEST_OWNER) }} } }
+```
+
+If a key is missing in setup or teardown, verify that the caller explicitly maps `TestData` as JSON.
+`secrets: inherit` only passes a repository or environment secret already named `TestData`; it does not
+automatically build the JSON object from individual secrets.

tests/srcTestRepo/tests/AfterAll.ps1

@@ -1,6 +1,8 @@
 Write-Warning "=== AFTERALL TEARDOWN SCRIPT EXECUTING ==="
 Write-Warning "Tearing down test environment..."
 
+. "$PSScriptRoot/TestData.Assertions.ps1"
+
 # Example teardown tasks:
 # - Clean up test infrastructure
 # - Remove test data

tests/srcTestRepo/tests/BeforeAll.ps1

@@ -1,6 +1,8 @@
 Write-Warning "=== BEFOREALL SETUP SCRIPT EXECUTING ==="
 Write-Warning "Setting up test environment..."
 
+. "$PSScriptRoot/TestData.Assertions.ps1"
+
 # Example setup tasks:
 # - Deploy test infrastructure
 # - Download test data

tests/srcTestRepo/tests/TestData.Assertions.ps1

@@ -0,0 +1,16 @@
+$expectedTestData = @{
+    PSMODULE_TEST_SINGLELINE_SECRET = 'psmodule-public-nonsecret-test-fixture-single-line'
+    PSMODULE_TEST_VARIABLE          = 'psmodule-public-nonsecret-test-variable'
+}
+
+foreach ($entry in $expectedTestData.GetEnumerator()) {
+    $actual = [System.Environment]::GetEnvironmentVariable($entry.Key)
+    if ([string]::IsNullOrEmpty($actual)) {
+        throw "TestData key '$($entry.Key)' is not available in the current module-local phase."
+    }
+    if ($actual -cne $entry.Value) {
+        throw "TestData key '$($entry.Key)' has an unexpected value in the current module-local phase."
+    }
+}
+
+Write-Warning 'TestData secret and variable fixtures are available in this module-local phase.'

tests/srcWithManifestTestRepo/tests/AfterAll.ps1

@@ -1,6 +1,8 @@
 Write-Warning "=== AFTERALL TEARDOWN SCRIPT (Environments) EXECUTING ==="
 Write-Warning "Tearing down test environment for Environments..."
 
+. "$PSScriptRoot/TestData.Assertions.ps1"
+
 # Example teardown tasks for Environments directory:
 Write-Warning "Cleaning up Environments test environment..."