Migrate Tests to Pester 5 (#296)

Author: dan-hughes

.vscode/settings.json

@@ -10,6 +10,7 @@
     "powershell.codeFormatting.pipelineIndentationStyle": "IncreaseIndentationForFirstPipeline",
     "powershell.codeFormatting.preset": "Custom",
     "powershell.codeFormatting.alignPropertyValuePairs": true,
+    "powershell.codeFormatting.useConstantStrings": true,
     "powershell.developer.bundledModulesPath": "${cwd}/output/RequiredModules",
     "powershell.scriptAnalysis.settingsPath": ".vscode\\analyzersettings.psd1",
     "powershell.scriptAnalysis.enable": true,
@@ -43,5 +44,15 @@
     "[markdown]": {
         "files.trimTrailingWhitespace": false,
         "files.encoding": "utf8"
-    }
+    },
+    "powershell.pester.useLegacyCodeLens": false,
+    "pester.testFilePath": [
+        "[tT]ests/[qQ][aA]/*.[tT]ests.[pP][sS]1",
+        "[tT]ests/[uU]nit/**/*.[tT]ests.[pP][sS]1",
+        "[tT]ests/[uU]nit/*.[tT]ests.[pP][sS]1"
+    ],
+    "pester.runTestsInNewProcess": true,
+    "pester.pesterModulePath": "./output/RequiredModules/Pester",
+    "powershell.pester.codeLens": true,
+    "pester.suppressCodeLensNotice": true,
 }

CHANGELOG.md

@@ -11,6 +11,13 @@ For older change log history see the [historic changelog](HISTORIC_CHANGELOG.md)
 
 - `azure-pipelines.yml`
   - Remove windows 2019 image fixes [#294](https://github.com/dsccommunity/FailoverClusterDsc/issues/294).
+- Migrate tests to Pester 5.
+- Updated to single stubs module.
+
+### Removed
+
+- Removed CommonTestHelper as functions are now provided by DscResource.Test.
+- Removed OS specific (mainly 2012R2) tests.
 
 ## [2.2.0] - 2025-05-22
 

RequiredModules.psd1

@@ -9,7 +9,7 @@
 
     InvokeBuild                 = 'latest'
     PSScriptAnalyzer            = 'latest'
-    Pester                      = '4.10.1'
+    Pester                      = 'latest'
     Plaster                     = 'latest'
     ModuleBuilder               = 'latest'
     ChangelogManagement         = 'latest'

build.yaml

@@ -46,11 +46,12 @@ BuildWorkflow:
     - package_module_nupkg
 
   hqrmtest:
-    - DscResource_Tests_Stop_On_Fail
+    - Invoke_HQRM_Tests_Stop_On_Fail
 
   test:
     - Pester_Tests_Stop_On_Fail
-    - Pester_if_Code_Coverage_Under_Threshold
+    - Convert_Pester_Coverage
+    - Pester_If_Code_Coverage_Under_Threshold
 
   merge:
     - Merge_CodeCoverage_Files
@@ -64,14 +65,23 @@ BuildWorkflow:
 #       PESTER  Configuration                      #
 ####################################################
 Pester:
-  OutputFormat: NUnitXML
+  Configuration:
+    Run:
+      Path:
+        - tests/Unit
+    Output:
+      Verbosity: Detailed
+      StackTraceVerbosity: Full
+      CIFormat: Auto
+    CodeCoverage:
+      CoveragePercentTarget: 85
+      OutputEncoding: ascii
+      UseBreakpoints: false
+    TestResult:
+      OutputFormat: NUnitXML
+      OutputEncoding: ascii
   ExcludeFromCodeCoverage:
     - Modules/DscResource.Common
-  Script:
-    - tests/Unit
-  Tag:
-  CodeCoverageThreshold: 85
-  CodeCoverageOutputFileEncoding: ascii
 
 ####################################################
 #           Code Coverage Configuration            #
@@ -87,14 +97,27 @@ CodeCoverage:
 #      Pester Configuration (DscResource.Test)     #
 ####################################################
 DscTest:
-  ExcludeTag:
-    - "Common Tests - New Error-Level Script Analyzer Rules"
-  Tag:
-  ExcludeSourceFile:
-    - output
-  ExcludeModuleFile:
-    - Modules/DscResource.Common
-  MainGitBranch: main
+  Pester:
+    Configuration:
+      Filter:
+        ExcludeTag:
+          - "Common Tests - New Error-Level Script Analyzer Rules"
+      Output:
+        Verbosity: Detailed
+        CIFormat: Auto
+      TestResult:
+        Enabled: true
+        OutputFormat: NUnitXML
+        OutputEncoding: ascii
+        OutputPath: ./output/testResults/NUnitXml_HQRM_Tests.xml
+  Script:
+    ExcludeSourceFile:
+      - output
+    ExcludeModuleFile:
+      - Modules/DscResource.Common
+      # Must exclude built module file because it should not be tested like MOF-based resources
+      - FailoverClusterDsc.psm1
+    MainGitBranch: main
 
 ModuleBuildTasks:
   Sampler:
@@ -103,6 +126,8 @@ ModuleBuildTasks:
     - '*.ib.tasks'
   DscResource.DocGenerator:
     - 'Task.*'
+  DscResource.Test:
+    - 'Task.*'
 
 TaskHeader: |
   param($Path)

source/DSCResources/DSC_Cluster/DSC_Cluster.psm1

@@ -65,6 +65,7 @@ function Get-TargetResource
         New-InvalidOperationException -Message $errorMessage
     }
     $context = $null
+    $address = $null
     try
     {
         if ($PSBoundParameters.ContainsKey('DomainAdministratorCredential'))
@@ -100,7 +101,6 @@ function Get-TargetResource
         IgnoreNetwork                 = $IgnoreNetwork
         DomainAdministratorCredential = $DomainAdministratorCredential
     }
-
 }
 
 <#
@@ -374,7 +374,7 @@ function Test-TargetResource
 
         if ($cluster)
         {
-            $targetNodeName = $env:COMPUTERNAME
+            $targetNodeName = Get-ComputerName
 
             Write-Verbose -Message ($script:localizedData.CheckClusterNodeIsUp -f $targetNodeName, $Name)
 

source/DSCResources/DSC_ClusterIPAddress/DSC_ClusterIPAddress.psm1

@@ -37,7 +37,7 @@ function Get-TargetResource
         Ensure      = 'Absent'
     }
 
-    $ipResources = Get-ClusterResource | Where-Object {$_.ResourceType -eq 'IP Address'}
+    $ipResources = Get-ClusterResource | Where-Object { $_.ResourceType -eq 'IP Address' }
 
     foreach ( $ipResource in $ipResources )
     {
@@ -46,9 +46,9 @@ function Get-TargetResource
         if ( $ipResourceDetails.Address -eq $IPAddress )
         {
             Write-Verbose -Message ($script:localizedData.FoundIPResource -f $IPAddress)
-            $result.IPAddress   = $ipResourceDetails.Address
+            $result.IPAddress = $ipResourceDetails.Address
             $result.AddressMask = $ipResourceDetails.AddressMask
-            $result.Ensure      = 'Present'
+            $result.Ensure = 'Present'
         }
     }
     $result
@@ -98,15 +98,15 @@ function Set-TargetResource
         # We need to Check if the network is added to the cluster. If not, we fail. If it is, we can append the IPAddress
         if ( -not $(Test-ClusterNetwork -IPAddress $IPAddress -AddressMask $AddressMask) )
         {
-            New-InvalidArgumentException `
-                -Message ($script:localizedData.NonExistantClusterNetwork -f $IPAddress,$AddressMask) `
+            New-ArgumentException `
+                -Message ($script:localizedData.NonExistentClusterNetwork -f $IPAddress, $AddressMask) `
                 -ArgumentName 'IPAddress'
         }
         else
         {
             $params = @{
                 IPAddress   = $IPAddress
-                AddressMask  = $AddressMask
+                AddressMask = $AddressMask
                 ErrorAction = 'Stop'
             }
             Add-ClusterIPAddressDependency @params
@@ -219,15 +219,15 @@ function Get-Subnet
     Test-IPAddress -IPAddress $AddressMask
 
     $subnet = ([IPAddress](([IPAddress]$Ipaddress).Address -band ([IPAddress]$AddressMask).Address)).IPAddressToString
-    Write-Verbose -Message ($script:localizedData.FoundSubnetfromIPAddressandAddressMask -f $IPAddress, $AddressMask, $subnet)
+    Write-Verbose -Message ($script:localizedData.FoundSubnetFromIPAddressAndAddressMask -f $IPAddress, $AddressMask, $subnet)
     return $subnet
 }
 
 <#
     .Synopsis
         Adds an IPAddress as a Dependency to a Windows Cluster
     .DESCRIPTION
-        Adds an IP Address resource to a Windows Cluster's Dependecy Expression
+        Adds an IP Address resource to a Windows Cluster's Dependency Expression
     .PARAMETER IPAddress
         IP address to add to the Cluster's DependencyExpression
     .PARAMETER AddressMask
@@ -274,15 +274,13 @@ function Add-ClusterIPAddressDependency
     }
     Write-Verbose -Message ($script:localizedData.SetDependencyExpression -f $dependencyExpression)
     Set-ClusterResourceDependency @params
-
 }
 
-
 <#
     .Synopsis
         Removes an IPAddress as a Dependency to a Windows Cluster
     .DESCRIPTION
-        Removes an IP Address resource to a Windows Cluster's Dependecy Expression
+        Removes an IP Address resource to a Windows Cluster's Dependency Expression
     .PARAMETER IPAddress
         IP address to remove to the Cluster's DependencyExpression
     .PARAMETER AddressMask
@@ -364,7 +362,7 @@ function Test-ClusterNetwork
     Test-IPAddress -IPAddress $AddressMask
 
     $clusterNetworks = Get-ClusterNetworkList
-    Write-Verbose -Message ($script:localizedData.GetSubnetfromIPAddressandAddressMask -f $IPAddress, $AddressMask)
+    Write-Verbose -Message ($script:localizedData.GetSubnetFromIPAddressAndAddressMask -f $IPAddress, $AddressMask)
     $subnet = $(Get-Subnet -IPAddress $IPAddress -AddressMask $AddressMask -ErrorAction Stop)
 
     foreach ( $network in $clusterNetworks )
@@ -394,12 +392,15 @@ function Get-ClusterNetworkList
 
     Write-Verbose -Message ($script:localizedData.GetClusterNetworks)
     $networks = New-Object -TypeName "System.Collections.Generic.List[PSCustomObject]"
-    foreach ( $network in Get-ClusterNetwork )
+    foreach ($network in Get-ClusterNetwork)
     {
-        $networks.Add([PSCustomObject]@{
-            Address     = $network.Address
-            AddressMask = $network.AddressMask
-        })
+        $networks.Add(
+            [PSCustomObject]@{
+                Address     = $network.Address
+                AddressMask = $network.AddressMask
+            }
+        )
+
         Write-Verbose -Message ($script:localizedData.FoundClusterNetwork -f $($network.Address), $($network.AddressMask))
     }
 
@@ -442,7 +443,8 @@ function Add-ClusterIPResource
         Group        = $OwnerGroup
         ErrorAction  = 'Stop'
     }
-    $resource = Add-ClusterResource @params
+
+    $null = Add-ClusterResource @params
 
     return $resourceName
 }
@@ -477,11 +479,12 @@ function Get-ClusterIPResource
     .Synopsis
         Gets the IP resource information of a Given Cluster IP address Resource
     .PARAMETER IPAddressResource
-        IP cddress resource to get to information from
+        IP address resource to get to information from
 #>
 function Get-ClusterIPResourceParameters
 {
     [CmdletBinding()]
+    [OutputType([System.Collections.Hashtable])]
     param
     (
         # IPAddress to add to Cluster
@@ -494,9 +497,10 @@ function Get-ClusterIPResourceParameters
 
     $address = (Get-ClusterParameter -InputObject $ipObj -Name Address).Value
     $addressMask = (Get-ClusterParameter -InputObject $ipObj -Name SubnetMask).Value
-    $network =  (Get-ClusterParameter -InputObject $ipObj -Name Network).Value
+    $network = (Get-ClusterParameter -InputObject $ipObj -Name Network).Value
     Write-Verbose -Message ($script:localizedData.FoundIPAddressResource -f $address, $addressMask, $network)
-    @{
+
+    return @{
         Address     = $address
         AddressMask = $addressMask
         Network     = $network
@@ -507,7 +511,7 @@ function Get-ClusterIPResourceParameters
     .Synopsis
         Adds an IP address resource to cluster parameter
     .PARAMETER IPAddressResource
-        IP cddress resource to add to the cluster parameter
+        IP address resource to add to the cluster parameter
     .PARAMETER IPAddress
         IP address to add to the cluster parameter
     .PARAMETER AddressMask
@@ -537,13 +541,12 @@ function Add-ClusterIPParameter
 
     $ipAddressResource = Get-ClusterResource -Name $IPAddressResourceName
 
-    $parameter1 = New-Object Microsoft.FailoverClusters.PowerShell.ClusterParameter $iPAddressResource,Address,$IPAddress
-    $parameter2 = New-Object Microsoft.FailoverClusters.PowerShell.ClusterParameter $iPAddressResource,SubnetMask,$AddressMask
-    $parameterList = $parameter1,$parameter2
+    $parameter1 = New-Object Microsoft.FailoverClusters.PowerShell.ClusterParameter $iPAddressResource, Address, $IPAddress
+    $parameter2 = New-Object Microsoft.FailoverClusters.PowerShell.ClusterParameter $iPAddressResource, SubnetMask, $AddressMask
+    $parameterList = $parameter1, $parameter2
 
-    Write-Verbose -Message ($script:localizedData.AddIPAddressResource -f $IPAddress,$AddressMask)
+    Write-Verbose -Message ($script:localizedData.AddIPAddressResource -f $IPAddress, $AddressMask)
     $parameterList | Set-ClusterParameter -ErrorAction Stop
-
 }
 
 <#
@@ -596,14 +599,14 @@ function New-ClusterIPDependencyExpression
         while ( $i -le $clusterResourceCount )
         {
             if ( $i -eq $clusterResourceCount )
-        {
-            $dependencyExpression += "[$($ClusterResource[$i])]"
-        }
-        else
-        {
-            $dependencyExpression += "[$($ClusterResource[$i])] or "
-        }
-        $i++
+            {
+                $dependencyExpression += "[$($ClusterResource[$i])]"
+            }
+            else
+            {
+                $dependencyExpression += "[$($ClusterResource[$i])] or "
+            }
+            $i++
         }
     }
     Write-Verbose -Message ($script:localizedData.NewDependencyExpression -f $dependencyExpression)
@@ -621,7 +624,7 @@ function Get-ClusterObject
     (
     )
 
-    $cluster = Get-ClusterResource | Where-Object { $_.name -eq 'Cluster Name'}
+    $cluster = Get-ClusterResource | Where-Object { $_.name -eq 'Cluster Name' }
 
     return $cluster
 }

source/DSCResources/DSC_ClusterIPAddress/en-US/DSC_ClusterIPAddress.strings.psd1

@@ -3,11 +3,11 @@
 ConvertFrom-StringData @'
     GetClusterNetworks = Getting all networks added to this cluster.
     FoundClusterNetwork = Found cluster network with address {0} and address mask {1}.
-    GetSubnetfromIPAddressandAddressMask = Getting the subnet of the given IPAddress {0} with subnet mask {1}.
-    FoundSubnetfromIPAddressandAddressMask = IP address {0} with subnet mask {1} is in subnet {2}.
+    GetSubnetFromIPAddressAndAddressMask = Getting the subnet of the given IPAddress {0} with subnet mask {1}.
+    FoundSubnetFromIPAddressAndAddressMask = IP address {0} with subnet mask {1} is in subnet {2}.
     NetworkAlreadyInCluster = Subnet {0} for IPAddress {1} network {2} is added to the cluster.
     AddIPAddressResource = Adding IP address {0} with address mask {1} to the cluster parameters.
-    NonExistantClusterNetwork =  Cluster Network for IP address {0} and address mask {1} is not part of this cluster".
+    NonExistentClusterNetwork =  Cluster Network for IP address {0} and address mask {1} is not part of this cluster".
     CreateNewIPResource = Created new IP resource with IP address {0} and owner group {1}.
     SetDependencyExpression = Set cluster resource dependency to {0}.
     GetTargetResourceMessage = Getting target resource state for IP address {0} and address mask {1}.

source/DSCResources/DSC_ClusterNetwork/DSC_ClusterNetwork.psm1

@@ -29,7 +29,7 @@ function Get-TargetResource
         $AddressMask
     )
 
-    Write-Verbose -Message ($script:localizedData.GetClusterNetworkInformation -f $Name)
+    Write-Verbose -Message ($script:localizedData.GetClusterNetworkInformation -f $Address)
 
     $NetworkResource = Get-ClusterNetwork | Where-Object -FilterScript {
         $_.Address -eq $Address -and $_.AddressMask -eq $AddressMask
@@ -227,7 +227,7 @@ function Test-TargetResource
         $Metric
     )
 
-    Write-Verbose -Message ($script:localizedData.EvaluatingClusterNetworkInformation -f $Name)
+    Write-Verbose -Message ($script:localizedData.EvaluatingClusterNetworkInformation -f $Address)
 
     $getTargetResourceResult = Get-TargetResource -Address $Address -AddressMask $AddressMask