Migrate to Pester 5 (#532)

Author: dan-hughes

.vscode/settings.json

@@ -36,7 +36,16 @@
         "keepachangelog",
         "notin",
         "pscmdlet",
-        "steppable"
+        "steppable",
+        "contoso",
+        "fabrikam",
+        "fourthcoffee",
+        "Lbfo",
+        "HKLM",
+        "HKCU",
+        "RDMA",
+        "Netbios",
+        "HQRM"
     ],
     "cSpell.ignorePaths": [
         ".git"

CHANGELOG.md

@@ -12,7 +12,31 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - CI Pipeline
   - Updated pipeline files to match current DSC Community patterns - fixes [Issue #528](https://github.com/dsccommunity/NetworkingDsc/issues/528).
   - Updated HQRM and build steps to use windows-latest image.
-  - Update build pieline to pin GitVersion v5.
+  - Update build pipeline to pin GitVersion v5.
+- Tests
+  - Update to use Pester 5.
+- `New-InvalidArgumentException` change to `New-ArgumentException` for HQRM.
+- `NetworkingDsc.Common`
+  - Changed to a buildable module.
+
+### Fixed
+
+- `DSC_Firewall`
+  - Fixed comment typo.
+  - Fixed `ParameterList` in `Set-TargetResource` typo.
+  - Remove `DisplayGroup` property when creating new firewall rule.
+  - `Test-RuleProperties`
+    - Fixed `Convert-CIDRToSubnetMask` function call typo.
+    -
+
+### Removed
+
+- `Build.psd1`
+  - Removed as not required.
+- `DSC_IPAddress`
+  - Remove IPv6 prefix length as unused.
+- `CommonTestHelper`
+  - Use `Get-InvalidArgumentRecord` from `DscResource.Test`.
 
 ## [9.0.0] - 2022-05-30
 

RequiredModules.psd1

@@ -1,24 +1,24 @@
 @{
-    PSDependOptions             = @{
+    PSDependOptions                = @{
         AddToPath  = $true
         Target     = 'output\RequiredModules'
         Parameters = @{
             Repository = ''
         }
     }
 
-    InvokeBuild                 = 'latest'
-    PSScriptAnalyzer            = 'latest'
-    Pester                      = '4.10.1'
-    Plaster                     = 'latest'
-    ModuleBuilder               = 'latest'
-    ChangelogManagement         = 'latest'
-    Sampler                     = 'latest'
-    'Sampler.GitHubTasks'       = 'latest'
-    MarkdownLinkCheck           = 'latest'
-    'DscResource.Test'          = 'latest'
-    xDscResourceDesigner        = 'latest'
-    LoopbackAdapter             = 'latest'
+    InvokeBuild                    = 'latest'
+    PSScriptAnalyzer               = 'latest'
+    Pester                         = 'latest'
+    Plaster                        = 'latest'
+    ModuleBuilder                  = 'latest'
+    ChangelogManagement            = 'latest'
+    Sampler                        = 'latest'
+    'Sampler.GitHubTasks'          = 'latest'
+    MarkdownLinkCheck              = 'latest'
+    'DscResource.Test'             = 'latest'
+    xDscResourceDesigner           = 'latest'
+    LoopbackAdapter                = 'latest'
 
     # Build dependencies needed for using the module
     'DscResource.Common'           = '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
@@ -105,7 +105,7 @@ stages:
             inputs:
               filePath: './build.ps1'
               arguments: "-Tasks test -PesterScript 'tests/Unit'"
-              pwsh: false
+              pwsh: true
 
           - task: PublishTestResults@2
             displayName: 'Publish Test Results'
@@ -210,7 +210,7 @@ stages:
             inputs:
               filePath: './build.ps1'
               arguments: "-Tasks test -PesterScript 'tests/Unit'"
-              pwsh: false
+              pwsh: true
 
           - task: PublishTestResults@2
             displayName: 'Publish Test Results'

build.yaml

@@ -26,29 +26,25 @@ 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:
     - publish_module_to_gallery
     - Publish_Release_To_GitHub
     - Publish_GitHub_Wiki_Content
-    - Create_ChangeLog_GitHub_PR
 
 ####################################################
 #          ModuleBuilder Configuration             #
 ####################################################
 CopyPaths:
   - en-US
   - DSCResources
-  - Modules
-Prefix: prefix.ps1
-Suffix: suffix.ps1
 Encoding: UTF8
-VersionedOutputDirectory: true
 BuiltModuleSubdirectory: builtModule
 
 ModuleBuildTasks:
@@ -81,22 +77,20 @@ NestedModule:
     Path: ./output/RequiredModules/DscResource.Common
     AddToManifest: false
     Exclude: PSGetModuleInfo.xml
+  NetworkingDsc.Common:
+    Prefix: prefix.ps1
+    VersionedOutputDirectory: false
+    CopyPaths:
+      - en-US
+    Encoding: UTF8
+    AddToManifest: false
+    Exclude: PSGetModuleInfo.xml
 
 ####################################################
 #          Pester Configuration (Sampler)          #
 ####################################################
 
 Pester:
-  # Pester 4 configuration
-  Script:
-    - tests/Unit
-  ExcludeTag:
-  Tag:
-  CodeCoverageOutputFile: JaCoCo_coverage.xml
-  CodeCoverageOutputFileEncoding: ascii
-  CodeCoverageThreshold: 80
-
-  # Pester 5 configuration
   Configuration:
     Run:
       Path:
@@ -120,14 +114,26 @@ Pester:
 #      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
+      - NetworkingDsc.psm1
+    MainGitBranch: main
 
 ####################################################
 #              PSDepend Configuration              #
@@ -163,7 +169,7 @@ DscResource.DocGenerator:
       - '\*(.+?)\*' # Match Italic (asterisk)
   Publish_GitHub_Wiki_Content:
     Debug: false
-  Generate_Wiki_Content:
+  Generate_Markdown_For_DSC_Resources:
     MofResourceMetadata:
       Type: MofResource
       Category: Resources
@@ -174,5 +180,5 @@ DscResource.DocGenerator:
       Type: CompositeResource
       Category: Resources
   Generate_Wiki_Sidebar:
-     Debug: false
-     AlwaysOverwrite: true
+    Debug: false
+    AlwaysOverwrite: true

source/Build.psd1

@@ -1,10 +1,7 @@
 $modulePath = Join-Path -Path (Split-Path -Path (Split-Path -Path $PSScriptRoot -Parent) -Parent) -ChildPath 'Modules'
 
 # Import the Networking Common Modules
-Import-Module -Name (Join-Path -Path $modulePath `
-        -ChildPath (Join-Path -Path 'NetworkingDsc.Common' `
-            -ChildPath 'NetworkingDsc.Common.psm1'))
-
+Import-Module -Name (Join-Path -Path $modulePath -ChildPath 'NetworkingDsc.Common')
 Import-Module -Name (Join-Path -Path $modulePath -ChildPath 'DscResource.Common')
 
 # Import Localization Strings
@@ -48,9 +45,6 @@ function Get-TargetResource
             $($script:localizedData.GettingDefaultGatewayAddressMessage)
         ) -join '' )
 
-    $destinationPrefix = Get-NetDefaultGatewayDestinationPrefix `
-        -AddressFamily $AddressFamily
-
     $defaultRoutes = Get-NetDefaultRoute `
         -InterfaceAlias $InterfaceAlias `
         -AddressFamily $AddressFamily
@@ -118,8 +112,8 @@ function Set-TargetResource
         ) -join '' )
 
     $defaultRoutes = @(Get-NetDefaultRoute `
-        -InterfaceAlias $InterfaceAlias `
-        -AddressFamily $AddressFamily)
+            -InterfaceAlias $InterfaceAlias `
+            -AddressFamily $AddressFamily)
 
     # Remove any existing default routes
     foreach ($defaultRoute in $defaultRoutes)
@@ -203,17 +197,17 @@ function Test-TargetResource
     Assert-ResourceProperty @PSBoundParameters
 
     $defaultRoutes = @(Get-NetDefaultRoute `
-        -InterfaceAlias $InterfaceAlias `
-        -AddressFamily $AddressFamily)
+            -InterfaceAlias $InterfaceAlias `
+            -AddressFamily $AddressFamily)
 
     # Test if the Default Gateway passed is equal to the current default gateway
     if ($Address)
     {
         if ($defaultRoutes)
         {
             $nextHopRoute = $defaultRoutes.Where( {
-                $_.NextHop -eq $Address
-            } )
+                    $_.NextHop -eq $Address
+                } )
 
             if ($nextHopRoute)
             {
@@ -302,7 +296,7 @@ function Assert-ResourceProperty
     {
         Assert-IPAddress -Address $Address -AddressFamily $AddressFamily
     }
-} # Assert-ResourceProperty
+}
 
 <#
     .SYNOPSIS
@@ -333,7 +327,7 @@ function Get-NetDefaultGatewayDestinationPrefix
     }
 
     return $destinationPrefix
-} # Get-NetDefaultGatewayDestinationPrefix
+}
 
 <#
     .SYNOPSIS
@@ -366,11 +360,9 @@ function Get-NetDefaultRoute
         -AddressFamily $AddressFamily
 
     return @(Get-NetRoute `
-        -InterfaceAlias $InterfaceAlias `
-        -AddressFamily $AddressFamily `
-        -ErrorAction Stop).Where({
+            -InterfaceAlias $InterfaceAlias `
+            -AddressFamily $AddressFamily `
+            -ErrorAction Stop).Where({
             $_.DestinationPrefix -eq $destinationPrefix
         })
-} # Get-NetDefaultRoute
-
-Export-ModuleMember -function *-TargetResource
+}

source/DSCResources/DSC_DefaultGatewayAddress/DSC_DefaultGatewayAddress.psm1

@@ -1,10 +1,7 @@
 $modulePath = Join-Path -Path (Split-Path -Path (Split-Path -Path $PSScriptRoot -Parent) -Parent) -ChildPath 'Modules'
 
 # Import the Networking Common Modules
-Import-Module -Name (Join-Path -Path $modulePath `
-        -ChildPath (Join-Path -Path 'NetworkingDsc.Common' `
-            -ChildPath 'NetworkingDsc.Common.psm1'))
-
+Import-Module -Name (Join-Path -Path $modulePath -ChildPath 'NetworkingDsc.Common')
 Import-Module -Name (Join-Path -Path $modulePath -ChildPath 'DscResource.Common')
 
 # Import Localization Strings
@@ -130,7 +127,7 @@ function Set-TargetResource
             Write-Verbose -Message ( @(
                     "$($MyInvocation.MyCommand): "
                     $($script:localizedData.DnsClientGlobalSettingUpdateParameterMessage) `
-                        -f $parameter.Name,($parameterNewValue -join ',')
+                        -f $parameter.Name, ($parameterNewValue -join ',')
                 ) -join '' )
         } # if
     } # foreach
@@ -263,5 +260,3 @@ function Test-TargetResource
 
     return $desiredConfigurationMatch
 } # Test-TargetResource
-
-Export-ModuleMember -Function *-TargetResource

source/DSCResources/DSC_DnsClientGlobalSetting/DSC_DnsClientGlobalSetting.psm1

@@ -1,10 +1,7 @@
 $modulePath = Join-Path -Path (Split-Path -Path (Split-Path -Path $PSScriptRoot -Parent) -Parent) -ChildPath 'Modules'
 
 # Import the Networking Common Modules
-Import-Module -Name (Join-Path -Path $modulePath `
-        -ChildPath (Join-Path -Path 'NetworkingDsc.Common' `
-            -ChildPath 'NetworkingDsc.Common.psm1'))
-
+Import-Module -Name (Join-Path -Path $modulePath -ChildPath 'NetworkingDsc.Common')
 Import-Module -Name (Join-Path -Path $modulePath -ChildPath 'DscResource.Common')
 
 # Import Localization Strings
@@ -266,5 +263,3 @@ function Test-TargetResource
 
     return $inDesiredState
 }
-
-Export-ModuleMember -function *-TargetResource