Unit tests are now running using Pester 5

[johlju]

Pull Request (PR) description

• Unit tests are now running using Pester 5 (issue Convert tests to Pester 5 #40).
• Excludes the PowerShell module script file DscResource.Common.psm1 located
  in folder source from the HQRM testing.
• Now code coverage is uploaded to codecov.io.

This Pull Request (PR) fixes the following issues

• Fixes Convert tests to Pester 5 #40

Task list

• Added an entry to the change log under the Unreleased section of the
  file CHANGELOG.md. Entry should say what was changed and how that
  affects users (if applicable), and reference the issue being resolved
  (if applicable).
• Documentation added/updated in README.md.
• Comment-based help added/updated for all new/changed functions.
• Localization strings added/updated in all localization files as appropriate.
• Examples appropriately added/updated.
• Unit tests added/updated. See DSC Community Testing Guidelines.
• Integration tests added/updated (where possible). See
  DSC Community Testing Guidelines.
• New/changed code adheres to DSC Community Style Guidelines.

---

This change is 

[johlju]

This PR is waiting for pipeline fixes to support Pester 5.

[PlagueHO]

We'll need to release the new sampler version after that.

[johlju]

Yep, and then wait for the HQRM tests to be resolved (so they can be run in both Pester 4 and Pester 5).

[johlju]

Closing and reopening

[johlju]

I will fix the bugs in the unit tests. After that the HQRM tests are dependent on the PR dsccommunity/DscResource.Test#76.

[johlju]

The failing test have been refactored. This PR is now waiting for the HQRM tests to work in Pester 5.

[johlju]

There seems to be a bug in the HQRM tests that need to be sorted before this PR can be merged.

[johlju]

@PlagueHO do you have time to review this? No hurry at all. It is a bit large. But there have been no changes to code, just the tests have been modified to work with Pester 5.

[codecov]

Codecov Report

Merging #41 (dafb626) into main (28d4666) will increase coverage by 91.30%.
The diff coverage is n/a.

@@            Coverage Diff            @@
##           main      #41       +/-   ##
=========================================
+ Coverage      0   91.30%   +91.30%     
=========================================
  Files         0       26       +26     
  Lines         0      460      +460     
=========================================
+ Hits          0      420      +420     
- Misses        0       40       +40     

Impacted Files	Coverage Δ
source/Public/Assert-Module.ps1	100.00% <0.00%> (ø)
source/Public/Get-LocalizedData.ps1	85.41% <0.00%> (ø)
source/Public/Test-IsNanoServer.ps1	100.00% <0.00%> (ø)
source/Public/New-InvalidArgumentException.ps1	100.00% <0.00%> (ø)
source/Public/Get-TemporaryFolder.ps1	100.00% <0.00%> (ø)
source/Private/Test-DscObjectHasProperty.ps1	100.00% <0.00%> (ø)
source/suffix.ps1	100.00% <0.00%> (ø)
source/Public/Set-PSModulePath.ps1	100.00% <0.00%> (ø)
source/Public/Compare-DscParameterState.ps1	80.36% <0.00%> (ø)
source/Public/New-InvalidOperationException.ps1	100.00% <0.00%> (ø)
... and 16 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 28d4666...dafb626. Read the comment docs.

[johlju]

Now the correct code coverage is reported, so the missing code coverage have to be resolved in another PR (unless I messed up and accidently removed a test).

[PlagueHO]

Just some minor tweaks but looking good - I love the new test init structure (so much improved over the old one 😁).

Reviewed 25 of 28 files at r1, 2 of 3 files at r3, 1 of 1 files at r4, 1 of 1 files at r5.
Reviewable status: all files reviewed, 10 unresolved discussions (waiting on @johlju)

---

cocdecov.yml, line 3 at r5 (raw file):

codecov:
  require_ci_to_pass: no
  # master should be the baseline for reporting

Should be main here

---

tests/QA/module.tests.ps1, line 24 at r5 (raw file):

Describe 'General module control' -Tags 'FunctionalQuality' {
    It 'imports without errors' {

Message should be 'Should import without errors'

---

tests/QA/module.tests.ps1, line 63 at r5 (raw file):

            if ($ErrorActionPreference -ne 'Stop')
            {
                Write-Warning -Message "ScriptAnalyzer not found!"

Single quotes here.

---

tests/QA/module.tests.ps1, line 67 at r5 (raw file):

            else
            {
                throw "ScriptAnalyzer not found!"

Single quotes here.

---

tests/QA/module.tests.ps1, line 73 at r5 (raw file):

    It "<Name> has a unit test" -TestCases $testCases {
        Get-ChildItem "tests\" -Recurse -Include "$Name.Tests.ps1" | Should -Not -BeNullOrEmpty

Single quotes here and also needs parameter name

---

tests/QA/module.tests.ps1, line 77 at r5 (raw file):

    It "Script Analyzer for <Name>" -TestCases $testCases -Skip:(-not $scriptAnalyzerRules) {
        $functionFile = Get-ChildItem -path $sourcePath -Recurse -Include "$Name.ps1"

Path parameter name needs caps

---

tests/QA/module.tests.ps1, line 125 at r5 (raw file):

        $astSearchDelegate = { $args[0] -is [System.Management.Automation.Language.FunctionDefinitionAst] }
        $parsedFunction = $AbstractSyntaxTree.FindAll( $astSearchDelegate, $true ) |
            Where-Object -FilterScript { $_.Name -eq $Name }

{
    $_.Name -eq $Name
}

---

tests/QA/module.tests.ps1, line 143 at r5 (raw file):

        $astSearchDelegate = { $args[0] -is [System.Management.Automation.Language.FunctionDefinitionAst] }
        $parsedFunction = $AbstractSyntaxTree.FindAll( $astSearchDelegate, $true ) |
            Where-Object -FilterScript { $_.Name -eq $Name }

Can we use:

{
    $_.Name -eq $Name
}

---

tests/QA/module.tests.ps1, line 147 at r5 (raw file):

        $functionHelp = $parsedFunction.GetHelpContent()

        $parameters = $parsedFunction.Body.ParamBlock.Parameters.Name.VariablePath.ForEach{ $_.ToString() }

Nitpick: ForEach({})

---

tests/Unit/Public/Compare-DscParameterState.Tests.ps1, line 991 at r5 (raw file):

                It 'Should return $false for PSCredential InDesiredState' {
                    $script:result.where({$_.Property -eq 'PSCredential'}).InDesiredState | Should -BeFalse

Where should be capital 'W' - also can we use:

$script:result.Where({
    $_.Property -eq 'PSCredential'
}).InDesiredState | Should -BeFalse

and throughout.

[johlju]

Reviewed 24 of 28 files at r1, 1 of 3 files at r3, 1 of 1 files at r5, 3 of 3 files at r6.
Reviewable status: all files reviewed, 10 unresolved discussions (waiting on @PlagueHO)

---

cocdecov.yml, line 3 at r5 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Should be main here

Done.

---

tests/QA/module.tests.ps1, line 24 at r5 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Message should be 'Should import without errors'

Done.

---

tests/QA/module.tests.ps1, line 63 at r5 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Single quotes here.

Done.

---

tests/QA/module.tests.ps1, line 67 at r5 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Single quotes here.

Done.

---

tests/QA/module.tests.ps1, line 73 at r5 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Single quotes here and also needs parameter name

Done.

---

tests/QA/module.tests.ps1, line 77 at r5 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Path parameter name needs caps

Done.

---

tests/QA/module.tests.ps1, line 125 at r5 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

{
    $_.Name -eq $Name
}

Done.

---

tests/QA/module.tests.ps1, line 143 at r5 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Can we use:

{
    $_.Name -eq $Name
}

Done.

---

tests/QA/module.tests.ps1, line 147 at r5 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Nitpick: ForEach({})

Done.

---

tests/Unit/Public/Compare-DscParameterState.Tests.ps1, line 991 at r5 (raw file):

Previously, PlagueHO (Daniel Scott-Raynsford) wrote…

Where should be capital 'W' - also can we use:

$script:result.Where({
    $_.Property -eq 'PSCredential'
}).InDesiredState | Should -BeFalse

and throughout.

Done. And fixed everywhere... A LOT of them ;)

[PlagueHO]

Reviewed 3 of 3 files at r6.
Reviewable status: complete! all files reviewed, all discussions resolved (waiting on @johlju)