Support Pester 5 coverage and more options for test pipeline

[johlju]

Pull Request

This PR continues the work of @NicolasBn.

• Fixes #223

Pull Request (PR) description

Added

• Added new build task Import_Pester (issue #223).
• Added new build task Invoke_Pester_Tests_v5 (issue #223).
  • Task Invoke_Pester_Tests_v5 will not run if Pester 4 is used in the pipeline.

Changed

• Task Invoke_Pester_Test was renamed to Invoke_Pester_Tests_v4.
  • Pester 5 support was removed from the task and replaced with Invoke_Pester_Tests_v5
  • Task Invoke_Pester_Tests_v4 will not run if Pester 5 is used in the pipeline.
• Meta build task Pester_Tests_Stop_On_Fail was change to run Import_Pester, Invoke_Pester_Tests_v4 (previously Invoke_Pester_Test), and Invoke_Pester_Tests_v5.
  • Task Invoke_Pester_Tests_v4 will not run if Pester 5 is used in the pipeline.
  • Task Invoke_Pester_Tests_v5 will not run if Pester 4 is used in the pipeline.

Task list

• [x] The PR represents a single logical change. i.e. Cosmetic updates should go in different PRs.
• [x] Added an entry under the Unreleased section of in the CHANGELOG.md as per format.
• [x] Local clean build passes without issue or fail tests (build.ps1 -ResolveDependency).
• [ ] Resource documentation added/updated in README.md.
• [ ] Resource parameter descriptions added/updated in README.md, schema.mof and comment-based help.
• [ ] Comment-based help added/updated.
• [ ] Localization strings added/updated in all localization files as appropriate.
• [ ] Examples appropriately added/updated.
• [ ] Unit tests added/updated. See DSC Resource Testing Guidelines.
• [ ] Integration tests added/updated (where possible). See DSC Resource Testing Guidelines.
• [ ] New/changed code adheres to DSC Resource Style Guidelines and Best Practices.

---

This change is 

[johlju]

@gaelcolas this works perfectly in FileSystemDsc with both the deprecated build configuration and the new build configuration. See output from two runs in the gist https://gist.github.com/johlju/056ae24843d15b1398f9311301993906.

The new build configuration is outputted in the test run if the repo hasn't opt-in to it yet, since we might not be able to change the templates for a while. See output above.

New build configuration gives more options and support all properties in the PesterConfiguration object.

Pester:
  # Pester Advanced configuration.
  # If a key is not set it will be using Sampler pipeline default value.
  Configuration:
    Run:
      Path:
        - tests/Unit
      ExcludePath:
    Filter:
      Tag:
      ExcludeTag:
    Output:
      Verbosity:
    CodeCoverage:
      Path:
      OutputFormat:
      CoveragePercentTarget: 85
      OutputPath: JaCoCo_coverage.xml
      OutputEncoding: ascii
      ExcludeTests:
    TestResult:
      OutputFormat: NUnitXML
      OutputPath:
      OutputEncoding:
      TestSuiteName:
  # Sampler pipeline configuration
  ExcludeFromCodeCoverage:
    - Modules/DscResource.Common

[codecov[bot]]

Codecov Report

Merging #283 (84fec55) into main (774e6ef) will decrease coverage by 2%. The diff coverage is 0%.

@@         Coverage Diff          @@
##           main   #283    +/-   ##
====================================
- Coverage    29%    26%    -3%     
====================================
  Files        38     38            
  Lines      1744   1894   +150     
====================================
  Hits        506    506            
- Misses     1238   1388   +150     

Impacted Files	Coverage Δ
.build/tasks/Invoke-Pester.pester.build.ps1	0% <0%> (ø)