Pester 5 migration

CHANGELOG.md

@@ -5,6 +5,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+
+- `DhcpServerDsc`
+  - Migrate unit tests to Pester 5
+  - IPv6 preparation work
+  - Increased code coverage to >85% fixes [#60](https://github.com/dsccommunity/DhcpServerDsc/issues/60).
+
+### Added
+
+- Unit tests for `DhcpServerDsc.OptionValueHelper`
+- Unit tests for `DSC_xDhcpServerReservation`
+
 ## [4.0.0] - 2025-01-20
 
 ### Changed

RequiredModules.psd1

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

Resolve-Dependency.psd1

@@ -1,15 +1,15 @@
 @{
-    Gallery         = 'PSGallery'
-    AllowPrerelease = $false
-    WithYAML        = $true
+    Gallery                                    = 'PSGallery'
+    AllowPrerelease                            = $false
+    WithYAML                                   = $true
 
-    #UseModuleFast = $true
+    UseModuleFast                              = $true
     #ModuleFastVersion = '0.1.2'
     #ModuleFastBleedingEdge = $true
 
-    UsePSResourceGet = $true
+    UsePSResourceGet                           = $true
     #PSResourceGetVersion = '1.0.1'
 
-    UsePowerShellGetCompatibilityModule = $true
+    UsePowerShellGetCompatibilityModule        = $true
     UsePowerShellGetCompatibilityModuleVersion = '3.0.23-beta23'
 }

build.yaml

@@ -49,7 +49,7 @@ BuildWorkflow:
     - package_module_nupkg
 
   hqrmtest:
-    - DscResource_Tests_Stop_On_Fail
+    - Invoke_HQRM_Tests_Stop_On_Fail
 
   test:
     - Pester_Tests_Stop_On_Fail
@@ -69,29 +69,51 @@ BuildWorkflow:
 ####################################################
 
 Pester:
-  OutputFormat: NUnitXML
+  Configuration:
+    Run:
+      Path:
+        - tests/Unit
+    Output:
+      Verbosity: Detailed
+      StackTraceVerbosity: Full
+      CIFormat: Auto
+    CodeCoverage:
+      CoveragePercentTarget: 85
+      OutputPath: CodeCoverage.xml
+      OutputEncoding: ascii
+      UseBreakpoints: false
+    TestResult:
+      OutputFormat: NUnitXML
+      OutputEncoding: ascii
   ExcludeFromCodeCoverage:
     - Modules/DscResource.Common
-  Script:
-    - tests/Unit
-  Tag:
-  CodeCoverageThreshold: 65
-  CodeCoverageOutputFile: CodeCoverage.xml
-  CodeCoverageOutputFileEncoding: ascii
 
 CodeCoverage:
   CodeCoverageMergedOutputFile: CodeCov_Merged.xml
   CodeCoverageFilePattern: Codecov*.xml
 
 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
+      - DhcpServerDsc.psm1
+    MainGitBranch: main
 
 ModuleBuildTasks:
   Sampler:
@@ -100,6 +122,8 @@ ModuleBuildTasks:
     - '*.ib.tasks'
   DscResource.DocGenerator:
     - 'Task.*'
+  DscResource.Test:
+    - 'Task.*'
 
 TaskHeader: |
   param($Path)
@@ -115,6 +139,8 @@ TaskHeader: |
 GitHubConfig:
   GitHubFilesToAdd:
     - 'CHANGELOG.md'
+  ReleaseAssets:
+    - output/WikiContent.zip
   GitHubConfigUserName: dscbot
   GitHubConfigUserEmail: [email protected]
   UpdateChangelogOnPrerelease: false

source/DSCResources/DSC_DhcpServerBinding/DSC_DhcpServerBinding.psm1

@@ -42,7 +42,7 @@ function Get-TargetResource
 
     if ($bindings.InterfaceAlias -inotcontains $InterfaceAlias)
     {
-        $errorMessage = $script:localizedData.InterfaceAliasIsMissing -f $InterfaceAlias, $env:COMPUTERNAME
+        $errorMessage = $script:localizedData.InterfaceAliasIsMissing -f $InterfaceAlias, (Get-ComputerName)
 
         New-ObjectNotFoundException -Message $errorMessage
     }
@@ -149,5 +149,3 @@ function Test-TargetResource
         return $false
     }
 }
-
-Export-ModuleMember -Function *-TargetResource

source/DSCResources/DSC_DhcpServerExclusionRange/DSC_DhcpServerExclusionRange.psm1

@@ -51,16 +51,16 @@ function Get-TargetResource
     # Check for DhcpServer module/role
     Assert-Module -ModuleName 'DHCPServer'
 
-    $ScopeId = (Get-ValidIpAddress -IpString $ScopeId -AddressFamily $AddressFamily -ParameterName 'ScopeId').IPAddressToString
-    $IPStartRange = (Get-ValidIpAddress -IpString $IPStartRange -AddressFamily $AddressFamily -ParameterName 'StartRange').IPAddressToString
-    $IPEndRange = (Get-ValidIpAddress -IpString $IPEndRange -AddressFamily $AddressFamily -ParameterName 'EndRange').IPAddressToString
+    $ScopeId = Get-ValidIpAddress -IpString $ScopeId -AddressFamily $AddressFamily -ParameterName 'ScopeId'
+    $StartRange = Get-ValidIpAddress -IpString $IPStartRange -AddressFamily $AddressFamily -ParameterName 'StartRange'
+    $EndRange = Get-ValidIpAddress -IpString $IPEndRange -AddressFamily $AddressFamily -ParameterName 'EndRange'
 
     # Check to ensure startRange is smaller than endRange
-    if ($IPEndRange.Address -lt $IPStartRange.Address)
+    if ($EndRange.Address -lt $StartRange.Address)
     {
         $errorMessage = $script:localizedData.InvalidStartAndEndRange
 
-        New-InvalidArgumentException -ArgumentName 'StartRange' -Message $errorMessage
+        New-ArgumentException -ArgumentName 'StartRange' -Message $errorMessage
     }
 
     # Retrieve exclusions for the scope
@@ -69,8 +69,8 @@ function Get-TargetResource
     [System.Array] $dhcpExclusionRange = Get-DhcpServerv4ExclusionRange -ScopeId $ScopeId -ErrorAction 'SilentlyContinue'
 
     $testExclusionRange = $dhcpExclusionRange |
-        Where-Object -FIlterScript {
-            $_.StartRange -eq $IPStartRange -and $_.EndRange -eq $IPEndRange
+        Where-Object -FilterScript {
+            $_.StartRange -eq $StartRange -and $_.EndRange -eq $EndRange
     }
 
     $ipStart = $testExclusionRange.StartRange.IPAddressToString
@@ -223,7 +223,7 @@ function Test-TargetResource
     {
         $errorMessage = $script:localizedData.InvalidStartAndEndRange
 
-        New-InvalidArgumentException -ArgumentName 'StartRange' -Message $errorMessage
+        New-ArgumentException -ArgumentName 'StartRange' -Message $errorMessage
     }
 
     # Retrieve exclusions for the scope
@@ -233,13 +233,13 @@ function Test-TargetResource
 
     $testExclusionRange = $dhcpExclusionRange |
         Where-Object -FilterScript {
-            $_.StartRange -eq $IPStartRange -and $_.EndRange -eq $IPEndRange
+            $_.StartRange -eq $validStartRange -and $_.EndRange -eq $validEndRange
         }
 
     $ipStart = $testExclusionRange.StartRange.IPAddressToString
     $ipEnd = $testExclusionRange.EndRange.IPAddressToString
 
-    if ($Ensure -ieq 'Present')
+    if ($Ensure -eq 'Present')
     {
         if ($testExclusionRange)
         {
@@ -251,12 +251,12 @@ function Test-TargetResource
         else
         {
             Write-Verbose -Message ($script:localizedData.ExclusionNotFound -f $IPStartRange, $IPEndRange)
-            Write-Verbose -Message ($script:localizedData.NotInDesiredState -f $ScopeId, $Ensure, "Absent")
+            Write-Verbose -Message ($script:localizedData.NotInDesiredState -f $ScopeId, $Ensure, 'Absent')
 
             return $false
         }
     }
-    elseif ($Ensure -ieq 'Absent')
+    elseif ($Ensure -eq 'Absent')
     {
         if (-not $testExclusionRange)
         {
@@ -268,11 +268,9 @@ function Test-TargetResource
         else
         {
             Write-Verbose -Message ($script:localizedData.FoundExclusion -f $ScopeId, $ipStart, $ipEnd)
-            Write-Verbose -Message ($script:localizedData.NotInDesiredState -f $ScopeId, $Ensure, "Present")
+            Write-Verbose -Message ($script:localizedData.NotInDesiredState -f $ScopeId, $Ensure, 'Present')
 
             return $false
         }
     }
 }
-
-Export-ModuleMember -Function *-TargetResource

source/DSCResources/DSC_xDhcpServerAuthorization/DSC_xDhcpServerAuthorization.psm1

@@ -25,7 +25,7 @@ function Get-TargetResource
         [Parameter()]
         [ValidateNotNullOrEmpty()]
         [System.String]
-        $DnsName = (Get-Hostname),
+        $DnsName = (Get-ComputerName),
 
         [Parameter()]
         [ValidateNotNullOrEmpty()]
@@ -34,7 +34,7 @@ function Get-TargetResource
     )
 
     Write-Verbose -Message (
-        $script:localizedData.GetServerAuthorizationMessage -f $ScopeId
+        $script:localizedData.GetServerAuthorizationMessage -f $DnsName
     )
 
     Assert-Module -ModuleName 'DHCPServer'
@@ -84,7 +84,7 @@ function Set-TargetResource
         [Parameter()]
         [ValidateNotNullOrEmpty()]
         [System.String]
-        $DnsName = (Get-Hostname),
+        $DnsName = (Get-ComputerName),
 
         [Parameter()]
         [ValidateNotNullOrEmpty()]
@@ -93,7 +93,7 @@ function Set-TargetResource
     )
 
     Write-Verbose -Message (
-        $script:localizedData.SetServerAuthorizationMessage -f $ScopeId
+        $script:localizedData.SetServerAuthorizationMessage -f $DnsName
     )
 
     Assert-Module -ModuleName 'DHCPServer'
@@ -110,9 +110,14 @@ function Set-TargetResource
     {
         Write-Verbose ($script:localizedData.UnauthorizingServer -f $DnsName, $IPAddress)
 
-        Get-DhcpServerInDC | Where-Object -FilterScript {
+        $dhcpServers = Get-DhcpServerInDC | Where-Object -FilterScript {
             ($_.DnsName -eq $DnsName) -and ($_.IPAddress -eq $IPAddress)
-        } | Remove-DhcpServerInDc
+        }
+
+        foreach ($dhcpServer in $dhcpServers)
+        {
+            Remove-DhcpServerInDc -DnsName $dhcpServer.DnsName -IPAddress $dhcpServer.IPAddress
+        }
     }
 }
 
@@ -135,7 +140,7 @@ function Test-TargetResource
         [Parameter()]
         [ValidateNotNullOrEmpty()]
         [System.String]
-        $DnsName = (Get-Hostname),
+        $DnsName = (Get-ComputerName),
 
         [Parameter()]
         [ValidateNotNullOrEmpty()]
@@ -144,7 +149,7 @@ function Test-TargetResource
     )
 
     Write-Verbose -Message (
-        $script:localizedData.TestServerAuthorizationMessage -f $ScopeId
+        $script:localizedData.TestServerAuthorizationMessage -f $DnsName
     )
 
     $targetResource = Get-TargetResource @PSBoundParameters
@@ -198,7 +203,7 @@ function Get-IPv4Address
             Where-Object -FilterScript {
                 $_.IPEnabled -eq 'True' -and $_.IPAddress -notmatch ':'
             } |
-                Select-Object -ExpandProperty 'IPAddress'
+            Select-Object -ExpandProperty 'IPAddress'
     } #end process
 } #end function Get-IPv4Address
 
@@ -224,5 +229,3 @@ function Get-Hostname
         }
     } #end process
 } #end function Get-Hostname
-
-Export-ModuleMember -Function *-TargetResource

source/DSCResources/DSC_xDhcpServerClass/DSC_xDhcpServerClass.psm1

@@ -132,7 +132,7 @@ function Set-TargetResource
             $scopeIDMessage = $script:localizedData.SettingClassIDMessage -f $Name
             Write-Verbose -Message $scopeIDMessage
 
-            set-DhcpServerv4Class -Name $Name -Type $Type -Data $AsciiData -Description $Description
+            Set-DhcpServerv4Class -Name $Name -Type $Type -Data $AsciiData -Description $Description
         }
         else
         {

source/DSCResources/DSC_xDhcpServerReservation/DSC_xDhcpServerReservation.psm1

@@ -402,5 +402,3 @@ function Update-ResourceProperties
 }
 
 #endregion
-
-Export-ModuleMember -Function *-TargetResource

source/DSCResources/DSC_xDhcpServerScope/DSC_xDhcpServerScope.psm1

@@ -227,6 +227,7 @@ function Set-TargetResource
         SubnetMask    = $SubnetMask
         AddressFamily = $AddressFamily
     }
+
     Assert-ScopeParameter @ipAddressesAssertionParameters
 
     #endregion Input Validation
@@ -712,5 +713,3 @@ function Update-ResourceProperties
         }
     } # else !dhcpscope
 }
-
-Export-ModuleMember -Function *-TargetResource