A GitHub Action that gathers Pester test results for the PSModule process by analyzing test artifacts from the workflow run. It validates test execution and results, providing a summary and failing if any tests are unsuccessful.

This GitHub Action is a part of the PSModule framework. It is recommended to use the Process-PSModule workflow to automate the whole process of managing the PowerShell module.

This action retrieves test artifacts named *-TestResults, processes the contained JSON files, and checks for test failures, unexecuted tests, or missing results. It supports three categories of test suites: Source Code, PSModule, and Module tests.

No secrets are required if the action runs in the same repository. The action uses the default GITHUB_TOKEN provided by GitHub Actions to access workflow artifacts.

This action does not define explicit outputs. Instead:

• If any tests fail or errors occur, the action exits with a non-zero code, marking the workflow step as failed.
• Detailed results are logged in the workflow run's output.

- name: Run and Collect Pester Tests
  uses: PSModule/Get-PesterTestResults@v1
  with:
    SourceCodeTestSuites: '[{"OSName": "Windows"}, {"OSName": "Linux"}]'
    PSModuleTestSuites: '[{"OSName": "Windows"}]'
    ModuleTestSuites: '[{"TestName": "Integration", "OSName": "Windows"}]'

• Test Suite Inputs: Must be valid JSON arrays.
  • SourceCodeTestSuites and PSModuleTestSuites require OSName.
  • ModuleTestSuites requires both TestName and OSName.
• Artifact Names: The action expects artifacts named *-TestResults containing Pester JSON reports.
• Failure Conditions: The action fails if tests are unexecuted, explicitly failed, or if result files are missing.