Updated pester test to support pester v5 (#74)

Co-authored-by: Gael <[email protected]>
dsccommunity · Feb 7, 2023 · e74846a · e74846a
1 parent b280512
commit e74846a
Show file tree

Hide file tree

Showing 7 changed files with 533 additions and 473 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   of pipeline artifact
 - Updated build.ps1 script and build.yaml.
 - Changed default timeout in Wait-Win32ProcessStart function for cab installation.
+- Updated pester test to support pester v5
 - Updated ReadMe.md to removed `RunRuleNow` parameter.
 
 ### Added

diff --git a/RequiredModules.psd1 b/RequiredModules.psd1
@@ -11,7 +11,7 @@
     'powershell-yaml'           = 'latest'
     InvokeBuild                 = 'latest'
     PSScriptAnalyzer            = 'latest'
-    Pester                      = '4.10.1'
+    Pester                      = '5.3.3'
     Plaster                     = 'latest'
     ModuleBuilder               = '1.0.0'
     ChangelogManagement         = 'latest'

diff --git a/Tests/Unit/MSFT_UpdateServicesApprovalRule.tests.ps1 b/Tests/Unit/MSFT_UpdateServicesApprovalRule.tests.ps1
diff --git a/Tests/Unit/MSFT_UpdateServicesCleanup.tests.ps1 b/Tests/Unit/MSFT_UpdateServicesCleanup.tests.ps1
diff --git a/Tests/Unit/MSFT_UpdateServicesServer.tests.ps1 b/Tests/Unit/MSFT_UpdateServicesServer.tests.ps1
diff --git a/build.yaml b/build.yaml
@@ -38,10 +38,11 @@ BuildWorkflow:
     - package_module_nupkg
 
   hqrmtest:
-    - DscResource_Tests_Stop_On_Fail
+    - Invoke_HQRM_Tests_Stop_On_Fail
 
   test:
     - Pester_Tests_Stop_On_Fail
+    - Convert_Pester_Coverage
     - Pester_if_Code_Coverage_Under_Threshold
 
   publish:
@@ -51,35 +52,54 @@ BuildWorkflow:
 
 
 Pester: #Passthru, OutputFile, CodeCoverageOutputFile not supported
-  OutputFormat: NUnitXML
+  Configuration:
+    Run:
+      Path:
+        - tests/Unit
+        - tests/QA
+    Output:
+      Verbosity: Detailed
+      StackTraceVerbosity: Full
+      CIFormat: Auto
+    CodeCoverage:
+      CoveragePercentTarget: 50
+      OutputPath: JaCoCo_coverage.xml
+      OutputEncoding: ascii
+      # There is a bug in Pester when running unit tests for classes when 'UseBreakpoints' is turned off.
+      # See error in gist: https://gist.github.com/johlju/c16dfd9587c7e066e8825fc54b33a703
+      UseBreakpoints: true
+    TestResult:
+      OutputFormat: NUnitXML
+      OutputEncoding: ascii
   ExcludeFromCodeCoverage:
     - Modules/DscResource.Common
-  Script:
-    # - tests/Unit/MSFT_UpdateServicesCleanup.tests.ps1
-    # - tests/Unit/MSFT_UpdateServicesServer.tests.ps1
-    # - tests/Unit/MSFT_UpdateServicesApprovalRule.tests.ps1
-    - tests/Unit
-    - tests/QA
-    # - tests/Integration
   ExcludeTag:
     - helpQuality
     - FunctionalQuality
     - TestQuality
-  Tag:
-  CodeCoverageThreshold: 50 # Set to 0 to bypass
-  # CodeCoverageOutputFile: JaCoCo_$OsShortName.xml
-  # CodeCoverageOutputFileEncoding: ascii
-  # CodeCoverageMergedOutputFile: JaCoCo_Merged.xml
 
+####################################################
+#      Pester Configuration (DscResource.Test)     #
+####################################################
 DscTest:
-  ExcludeTag:
-    - "Common Tests - New Error-Level Script Analyzer Rules"
-  Tag:
-  ExcludeSourceFile:
-    - output
-  ExcludeModuleFile:
-    - Modules/DscResource.Common
-
+  Pester:
+    Configuration:
+      Filter:
+        ExcludeTag:
+          - "Common Tests - New Error-Level Script Analyzer Rules"
+      Output:
+        Verbosity: Detailed
+        CIFormat: Auto
+      TestResult:
+        OutputFormat: NUnitXML
+        OutputEncoding: ascii
+        OutputPath: ./output/testResults/NUnitXml_HQRM_Tests.xml
+  Script:
+    ExcludeSourceFile:
+      - output
+    ExcludeModuleFile:
+      - Modules/DscResource.Common
+    MainGitBranch: main
 
 ModuleBuildTasks:
   Sampler:
@@ -88,6 +108,8 @@ ModuleBuildTasks:
     - '*.ib.tasks'
   DscResource.DocGenerator:
     - 'Task.*'
+  DscResource.Test:
+    - 'Task.*'
 
 
 # Invoke-Build Header to be used to 'decorate' the terminal output of the tasks.

diff --git a/source/Modules/PDT/PDT.psm1 b/source/Modules/PDT/PDT.psm1
@@ -4,17 +4,19 @@ $script:localizedData = Get-LocalizedData -DefaultUICulture 'en-US' -FileName 'P
 
 # New-InvalidArgumentError
 # New-InvalidArgumentException -ArgumentName 'Action' -Message $errorMessage
+
 <#
     .SYNOPSIS
         Resolves a path and verifies it exists.
 
     .PARAMETER Path
-        Path to resolve
+        Path to resolve and return to caller.
 
 #>
 function Invoke-ResolvePath
 {
     [CmdletBinding()]
+    [OutputType([string])]
     param
     (
         [Parameter(Mandatory = $true)]
@@ -152,6 +154,7 @@ function Test-RootedPath
 function Get-Arguments
 {
     [CmdletBinding()]
+    [OutputType([System.Collections.Hashtable])]
     param
     (
         [Parameter(Mandatory = $true)]
@@ -166,7 +169,7 @@ function Get-Arguments
         $NewArgumentNames
     )
 
-    $returnValue = @{ }
+    $returnValue = @{}
 
     for ($i = 0; $i -lt $ArgumentNames.Count; $i++)
     {