Migrate Tests to Pester 5 (#296)

Author: dan-hughes

.vscode/settings.json

@@ -36,7 +36,11 @@
         "keepachangelog",
         "notin",
         "pscmdlet",
-        "steppable"
+        "steppable",
+        "vhdx",
+        "cdrom",
+        "ntfs",
+        "PHYSICALDRIVE"
     ],
     "cSpell.ignorePaths": [
         ".git"

CHANGELOG.md

@@ -5,6 +5,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+
+- Unit tests converted to Pester 5. Fixes [#265](https://github.com/dsccommunity/StorageDsc/issues/265).
+- Split bundled modules into buildable modules and separate files.
+
+### Removed
+
+- `CommonTestHelper`
+  - Use versions from `DscResource.Test`
+    - Get-InvalidArgumentRecord
+    - Get-InvalidOperationRecord
+
 ### Fixed
 
 - Azure DevOps Build Pipeline:

RequiredModules.psd1

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

azure-pipelines.yml

@@ -1,15 +1,15 @@
 trigger:
   branches:
     include:
-    - main
+      - main
   paths:
     include:
-    - source/*
+      - source/*
   tags:
     include:
-    - "v*"
+      - 'v*'
     exclude:
-    - "*-*"
+      - '*-*'
 
 variables:
   buildFolderName: output
@@ -91,8 +91,6 @@ stages:
         displayName: 'Unit'
         strategy:
           matrix:
-            Windows Server 2019:
-              vmImage: windows-2019
             Windows Server 2022:
               vmImage: windows-2022
             Windows Server 2025:

build.yaml

@@ -26,7 +26,7 @@ BuildWorkflow:
     - package_module_nupkg
 
   hqrmtest:
-    - DscResource_Tests_Stop_On_Fail
+    - Invoke_HQRM_Tests_Stop_On_Fail
 
   test:
     - Pester_Tests_Stop_On_Fail
@@ -40,7 +40,6 @@ BuildWorkflow:
     - publish_module_to_gallery
     - Publish_Release_To_GitHub
     - Publish_GitHub_Wiki_Content
-    - Create_ChangeLog_GitHub_PR
 
 ####################################################
 #          ModuleBuilder Configuration             #
@@ -88,15 +87,6 @@ NestedModule:
 #          Pester Configuration (Sampler)          #
 ####################################################
 Pester:
-  # Pester 4 configuration
-  Script:
-    - tests/Unit
-  ExcludeTag:
-  Tag:
-  CodeCoverageOutputFileEncoding: ascii
-  CodeCoverageThreshold: 80
-
-  # Pester 5 configuration
   Configuration:
     Run:
       Path:
@@ -106,7 +96,7 @@ Pester:
       StackTraceVerbosity: Full
       CIFormat: Auto
     CodeCoverage:
-      CoveragePercentTarget: 80
+      CoveragePercentTarget: 85
       OutputEncoding: ascii
       UseBreakpoints: false
     TestResult:
@@ -130,14 +120,27 @@ CodeCoverage:
 #      Pester Configuration (DscResource.Test)     #
 ####################################################
 DscTest:
-  OutputFormat: NUnitXML
-  ExcludeTag:
-    - 'Common Tests - New Error-Level Script Analyzer Rules'
-  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
+      - StorageDsc.psm1
+    MainGitBranch: main
 
 ####################################################
 #              PSDepend Configuration              #

source/Build.psd1

@@ -372,7 +372,7 @@ function Set-TargetResource
     # Check if existing partition already has file system on it
     if ($null -eq $assignedPartition)
     {
-        # There is no partiton with this drive letter
+        # There is no partition with this drive letter
         Write-Verbose -Message ( @(
                 "$($MyInvocation.MyCommand): "
                 $($script:localizedData.DriveNotFoundOnPartitionMessage `
@@ -631,11 +631,12 @@ function Set-TargetResource
 
             <#
                 After creating the partition it can take a few seconds for it to become writeable
-                Wait for up to 30 seconds for the parition to become writeable
+                Wait for up to 30 seconds for the partition to become writeable
             #>
             $timeAtStart = Get-Date
-            $minimumTimeToWait = $timeAtStart + (New-Timespan -Second 3)
-            $maximumTimeToWait = $timeAtStart + (New-Timespan -Second 30)
+            $minimumTimeToWait = $timeAtStart + (New-TimeSpan -Second 3)
+            $maximumTimeToWait = $timeAtStart + (New-TimeSpan -Second 30)
+            $partitionstate = $null
 
             while (($partitionstate.IsReadOnly -and (Get-Date) -lt $maximumTimeToWait) `
                 -or ((Get-Date) -lt $minimumTimeToWait))
@@ -657,7 +658,7 @@ function Set-TargetResource
         {
             # The partition is still readonly - throw an exception
             New-InvalidOperationException `
-                -Message ($script:localizedData.NewParitionIsReadOnlyError `
+                -Message ($script:localizedData.NewPartitionIsReadOnlyError `
                     -f $DiskIdType, $DiskId, $partition.PartitionNumber)
         } # if
 
@@ -709,7 +710,7 @@ function Set-TargetResource
 
                     if ($Size -gt $supportedSize.SizeMax)
                     {
-                        New-InvalidArgumentException -Message ( @(
+                        New-ArgumentException -Message ( @(
                                 "$($MyInvocation.MyCommand): "
                                 $($script:localizedData.FreeSpaceViolationError `
                                         -f $DriveLetter, $assignedPartition.Size, $Size, $supportedSize.SizeMax)
@@ -837,7 +838,7 @@ function Set-TargetResource
             # The volume should have a label assigned
             if ($volume.FileSystemLabel -ne $FSLabel)
             {
-                # The volume lable needs to be changed because it is different.
+                # The volume label needs to be changed because it is different.
                 Write-Verbose -Message ( @(
                         "$($MyInvocation.MyCommand): "
                         $($script:localizedData.ChangingVolumeLabelMessage `
@@ -891,7 +892,7 @@ function Set-TargetResource
 
 <#
     .SYNOPSIS
-        Tests if the disk is initialized, the partion exists and the drive letter is assigned.
+        Tests if the disk is initialized, the partition exists and the drive letter is assigned.
 
     .PARAMETER DriveLetter
         Specifies the preferred letter to assign to the disk volume.
@@ -1074,7 +1075,7 @@ function Test-TargetResource
             If the difference in size between the supported partition size
             and the current partition size is less than 1MB then set the
             desired partition size to the current size. This will prevent
-            any size difference less than 1MB from trying to contiuously
+            any size difference less than 1MB from trying to continuously
             resize. See https://github.com/dsccommunity/StorageDsc/issues/181
         #>
         if (($supportedSize.SizeMax - $partition.Size) -lt 1MB)
@@ -1114,7 +1115,7 @@ function Test-TargetResource
                         https://learn.microsoft.com/en-us/windows-hardware/drivers/storage/createpartition-msft-disk
                         for more information. But to some it up, what the user enters and what the New-Partition
                         cmdlet is able to allocate can be different in bytes. So to keep idempotence, we only
-                        return false when they arent the same in GB. Also if the volume already is formatted as
+                        return false when they are not the same in GB. Also if the volume already is formatted as
                         a ReFS, there is no point in returning false for size mismatches since they can't be
                         resized with resize-partition.
                     #>

source/DSCResources/DSC_Disk/DSC_Disk.psm1

@@ -1,4 +1,4 @@
-ConvertFrom-StringData @'
+ConvertFrom-StringData @'
     GettingDiskMessage = Getting disk with {0} '{1}' status for drive letter '{2}'.
     SettingDiskMessage = Setting disk with {0} '{1}' status for drive letter '{2}'.
     SetDiskOnlineMessage = Setting disk with {0} '{1}' online.
@@ -33,7 +33,7 @@
     MatchingPartitionFoundMessage = Disk with {0} '{1}' already contains partitions, and partition '{2}' matches required size.
     DriveNotFoundOnPartitionMessage = Disk with {0} '{1}' does not contain a partition assigned to drive letter '{2}'.
     ClearingDiskMessage = Clearing disk with {0} '{1}' of all existing partitions and volumes.
-    NewParitionIsReadOnlyError = New partition '{2}' on disk with {0} '{1}' did not become writable in the expected time.
+    NewPartitionIsReadOnlyError = New partition '{2}' on disk with {0} '{1}' did not become writable in the expected time.
     VolumeFormatInProgressMessage = Switch AllowDestructive is specified. Attempting to format volume on {0} with '{2}', was '{1}'.
     SizeMismatchCorrectionMessage = Switch AllowDestructive is specified. Attempting to resize partition {0} from {1} to {2}.
     FreeSpaceViolationError = Attempted to resize partition {0} from {1} to {2} while maximum allowed size was {3}.

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

@@ -1,4 +1,4 @@
-ConvertFrom-StringData @'
+ConvertFrom-StringData @'
     GettingDiskMessage = Getting disk with {0} '{1}' status for access path '{2}'.
     SettingDiskMessage = Setting disk with {0} '{1}' status for access path '{2}'.
     SetDiskOnlineMessage = Setting disk with {0} '{1}' online.

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

@@ -461,7 +461,7 @@ function Test-ParameterValid
         if ($PSBoundParameters.ContainsKey('DriveLetter'))
         {
             # Test the Drive Letter to ensure it is valid
-            $normalizedDriveLetter = Assert-DriveLetterValid -DriveLetter $DriveLetter
+            Assert-DriveLetterValid -DriveLetter $DriveLetter
         }
         else
         {