dsccommunity · dan-hughes · Oct 15, 2025 · Oct 15, 2025 · Oct 15, 2025 · Oct 15, 2025
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -44,5 +44,15 @@
     "[markdown]": {
         "files.trimTrailingWhitespace": true,
         "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,
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -32,6 +32,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Fixed formatting in all source files, [issue #113](https://github.com/dsccommunity/xRemoteDesktopSessionHost/issues/113).
 - Update repo files to latest versions in Sampler. Fixes [issue #118](https://github.com/dsccommunity/xRemoteDesktopSessionHost/issues/118).
 - Enable DocGenerator and move docs to wiki. Fixes [issue #101](https://github.com/dsccommunity/xRemoteDesktopSessionHost/issues/101).
+- Migrated tests to Pester 5. Fixes [issue #119](https://github.com/dsccommunity/xRemoteDesktopSessionHost/issues/119).
 
 ## [2.1.0] - 2022-08-07
 

diff --git a/RequiredModules.psd1 b/RequiredModules.psd1
@@ -9,7 +9,7 @@
 
     InvokeBuild                 = 'latest'
     PSScriptAnalyzer            = 'latest'
-    Pester                      = '4.10.1'
+    Pester                      = 'latest'
     Plaster                     = 'latest'
     ModuleBuilder               = 'latest'
     ChangelogManagement         = 'latest'
@@ -24,6 +24,7 @@
 
     # Analyzer rules
     'DscResource.AnalyzerRules'    = 'latest'
+    'Indented.ScriptAnalyzerRules' = 'latest'
 
     # Prerequisite modules for documentation.
     'DscResource.DocGenerator'  = 'latest'

diff --git a/azure-pipelines.yml b/azure-pipelines.yml
@@ -110,7 +110,7 @@ stages:
             inputs:
               filePath: './build.ps1'
               arguments: "-Tasks test -PesterScript 'tests/Unit'"
-              pwsh: false
+              pwsh: true
 
           - task: PublishTestResults@2
             displayName: 'Publish Test Results'

diff --git a/build.yaml b/build.yaml
@@ -13,13 +13,20 @@ VersionedOutputDirectory: true
 ####################################################
 #      ModuleBuilder Submodules Configuration      #
 ####################################################
-
 NestedModule:
   DscResource.Common:
     CopyOnly: true
     Path: ./output/RequiredModules/DscResource.Common
     AddToManifest: false
     Exclude: PSGetModuleInfo.xml
+  xRemoteDesktopSessionHost.Common:
+    Prefix: prefix.ps1
+    VersionedOutputDirectory: false
+    CopyPaths:
+      - en-US
+    Encoding: UTF8
+    AddToManifest: false
+    Exclude: PSGetModuleInfo.xml
 
 ####################################################
 #       Sampler Pipeline Configuration             #
@@ -48,11 +55,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
@@ -66,16 +74,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
-  ExcludeTag:
-  Tag:
-  CodeCoverageThreshold: 85
-  CodeCoverageOutputFileEncoding: ascii
-
 
 ####################################################
 #           Code Coverage Configuration            #
@@ -91,13 +106,27 @@ CodeCoverage:
 #      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:
+        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
+      - xRemoteDesktopSessionHost.psm1
+    MainGitBranch: master
 
 ModuleBuildTasks:
   Sampler:

diff --git a/source/DSCResources/MSFT_xRDCertificateConfiguration/MSFT_xRDCertificateConfiguration.psm1 b/source/DSCResources/MSFT_xRDCertificateConfiguration/MSFT_xRDCertificateConfiguration.psm1
@@ -1,10 +1,15 @@
-Import-Module -Name "$PSScriptRoot\..\..\Modules\xRemoteDesktopSessionHostCommon.psm1"
+$modulePath = Join-Path -Path (Split-Path -Path (Split-Path -Path $PSScriptRoot -Parent) -Parent) -ChildPath 'Modules'
+
+# Import the Common Modules
+Import-Module -Name (Join-Path -Path $modulePath -ChildPath 'xRemoteDesktopSessionHost.Common')
+Import-Module -Name (Join-Path -Path $modulePath -ChildPath 'DscResource.Common')
+
 if (-not (Test-xRemoteDesktopSessionHostOsRequirement))
 {
     throw 'The minimum OS requirement was not met.'
 }
-Import-Module RemoteDesktop -Global
-$script:localizedData = Get-LocalizedData -ResourceName 'MSFT_xRDCertificateConfiguration'
+
+$script:localizedData = Get-LocalizedData -DefaultUICulture 'en-US'
 
 #######################################################################
 # The Get-TargetResource cmdlet.
@@ -34,6 +39,8 @@ function Get-TargetResource
         $Credential
     )
 
+    Assert-Module -ModuleName 'RemoteDesktop' -ImportModule
+
     Write-Verbose -Message (
         $script:localizedData.VerboseGetCertificate -f $Role, $ConnectionBroker
     )
@@ -70,6 +77,8 @@ function Set-TargetResource
         $Credential
     )
 
+    Assert-Module -ModuleName 'RemoteDesktop' -ImportModule
+
     $rdCertificateSplat = @{
         Role             = $Role
         ConnectionBroker = $ConnectionBroker

diff --git a/source/DSCResources/MSFT_xRDConnectionBrokerHAMode/MSFT_xRDConnectionBrokerHAMode.psm1 b/source/DSCResources/MSFT_xRDConnectionBrokerHAMode/MSFT_xRDConnectionBrokerHAMode.psm1
@@ -1,9 +1,16 @@
-Import-Module -Name "$PSScriptRoot\..\..\Modules\xRemoteDesktopSessionHostCommon.psm1"
+$modulePath = Join-Path -Path (Split-Path -Path (Split-Path -Path $PSScriptRoot -Parent) -Parent) -ChildPath 'Modules'
+
+# Import the Common Modules
+Import-Module -Name (Join-Path -Path $modulePath -ChildPath 'xRemoteDesktopSessionHost.Common')
+Import-Module -Name (Join-Path -Path $modulePath -ChildPath 'DscResource.Common')
+
 if (-not (Test-xRemoteDesktopSessionHostOsRequirement))
 {
     throw 'The minimum OS requirement was not met.'
 }
-Import-Module -Name RemoteDesktop
+
+Assert-Module -ModuleName 'RemoteDesktop'
+
 $localhost = [System.Net.Dns]::GetHostByName((hostname)).HostName
 
 #######################################################################
@@ -31,6 +38,7 @@ function Get-TargetResource
         [ValidateLength(1, 256)]
         [string] $ClientAccessName
     )
+
     Write-Verbose -Message ($script:localizedData.VerboseGetHAMode -f $ConnectionBroker, $ClientAccessName)
 
     if ([string]::IsNullOrWhiteSpace($ConnectionBroker))
@@ -126,6 +134,7 @@ function Test-TargetResource
         [ValidateLength(1, 256)]
         [string] $ClientAccessName
     )
+
     Write-Verbose ($script:localizedData.VerboseTestHAMode -f $ConnectionBroker, $ClientAccessName)
 
     if ([string]::IsNullOrWhiteSpace($ConnectionBroker))

diff --git a/source/DSCResources/MSFT_xRDGatewayConfiguration/MSFT_xRDGatewayConfiguration.psm1 b/source/DSCResources/MSFT_xRDGatewayConfiguration/MSFT_xRDGatewayConfiguration.psm1
@@ -1,9 +1,15 @@
-Import-Module -Name "$PSScriptRoot\..\..\Modules\xRemoteDesktopSessionHostCommon.psm1"
+$modulePath = Join-Path -Path (Split-Path -Path (Split-Path -Path $PSScriptRoot -Parent) -Parent) -ChildPath 'Modules'
+
+# Import the Common Modules
+Import-Module -Name (Join-Path -Path $modulePath -ChildPath 'xRemoteDesktopSessionHost.Common')
+Import-Module -Name (Join-Path -Path $modulePath -ChildPath 'DscResource.Common')
+
 if (-not (Test-xRemoteDesktopSessionHostOsRequirement))
 {
     throw 'The minimum OS requirement was not met.'
 }
-Import-Module RemoteDesktop
+
+Assert-Module -ModuleName 'RemoteDesktop'
 
 function ValidateCustomModeParameters
 {
@@ -197,7 +203,7 @@ function Set-TargetResource
     Write-Verbose "Starting RD Gateway configuration for the RD deployment at broker '$ConnectionBroker'..."
 
     # validate parameters
-    ValidateCustomModeParameters $GatewayMode $ExternalFqdn $LogonMethod $UseCachedCredentials $BypassLocal
+    ValidateCustomModeParameters -mode $GatewayMode -ExternalFqdn $ExternalFqdn -LogonMethod $LogonMethod -UseCachedCredentials $UseCachedCredentials -BypassLocal $BypassLocal
 
     if ($GatewayServer)
     {

diff --git a/source/DSCResources/MSFT_xRDLicenseConfiguration/MSFT_xRDLicenseConfiguration.psm1 b/source/DSCResources/MSFT_xRDLicenseConfiguration/MSFT_xRDLicenseConfiguration.psm1
@@ -1,9 +1,15 @@
-Import-Module -Name "$PSScriptRoot\..\..\Modules\xRemoteDesktopSessionHostCommon.psm1"
+$modulePath = Join-Path -Path (Split-Path -Path (Split-Path -Path $PSScriptRoot -Parent) -Parent) -ChildPath 'Modules'
+
+# Import the Common Modules
+Import-Module -Name (Join-Path -Path $modulePath -ChildPath 'xRemoteDesktopSessionHost.Common')
+Import-Module -Name (Join-Path -Path $modulePath -ChildPath 'DscResource.Common')
+
 if (-not (Test-xRemoteDesktopSessionHostOsRequirement))
 {
     throw 'The minimum OS requirement was not met.'
 }
-Import-Module RemoteDesktop
+
+Assert-Module -ModuleName 'RemoteDesktop'
 
 #######################################################################
 # The Get-TargetResource cmdlet.

diff --git a/source/DSCResources/MSFT_xRDRemoteApp/MSFT_xRDRemoteApp.psm1 b/source/DSCResources/MSFT_xRDRemoteApp/MSFT_xRDRemoteApp.psm1
@@ -1,17 +1,15 @@
-$resourceModulePath = Split-Path -Path (Split-Path -Path $PSScriptRoot -Parent) -Parent
-$modulesFolderPath = Join-Path -Path $resourceModulePath -ChildPath 'Modules'
+$modulePath = Join-Path -Path (Split-Path -Path (Split-Path -Path $PSScriptRoot -Parent) -Parent) -ChildPath 'Modules'
 
-$rdCommonModulePath = Join-Path -Path $modulesFolderPath -ChildPath 'xRemoteDesktopSessionHostCommon.psm1'
-Import-Module -Name $rdCommonModulePath
-
-$dscResourceCommonModulePath = Join-Path -Path $modulesFolderPath -ChildPath 'DscResource.Common'
-Import-Module -Name $dscResourceCommonModulePath
+# Import the Common Modules
+Import-Module -Name (Join-Path -Path $modulePath -ChildPath 'xRemoteDesktopSessionHost.Common')
+Import-Module -Name (Join-Path -Path $modulePath -ChildPath 'DscResource.Common')
 
 if (-not (Test-xRemoteDesktopSessionHostOsRequirement))
 {
     throw 'The minimum OS requirement was not met.'
 }
-Import-Module RemoteDesktop
+
+Assert-Module -ModuleName 'RemoteDesktop'
 
 #######################################################################
 # The Get-TargetResource cmdlet.

diff --git a/source/DSCResources/MSFT_xRDServer/MSFT_xRDServer.psm1 b/source/DSCResources/MSFT_xRDServer/MSFT_xRDServer.psm1
@@ -1,9 +1,16 @@
-Import-Module -Name "$PSScriptRoot\..\..\Modules\xRemoteDesktopSessionHostCommon.psm1"
+$modulePath = Join-Path -Path (Split-Path -Path (Split-Path -Path $PSScriptRoot -Parent) -Parent) -ChildPath 'Modules'
+
+# Import the Common Modules
+Import-Module -Name (Join-Path -Path $modulePath -ChildPath 'xRemoteDesktopSessionHost.Common')
+Import-Module -Name (Join-Path -Path $modulePath -ChildPath 'DscResource.Common')
+
 if (-not (Test-xRemoteDesktopSessionHostOsRequirement))
 {
     throw 'The minimum OS requirement was not met.'
 }
-Import-Module RemoteDesktop
+
+Assert-Module -ModuleName 'RemoteDesktop'
+
 $localhost = [System.Net.Dns]::GetHostByName((hostname)).HostName
 
 function ValidateCustomModeParameters

diff --git a/source/DSCResources/MSFT_xRDSessionCollection/MSFT_xRDSessionCollection.psm1 b/source/DSCResources/MSFT_xRDSessionCollection/MSFT_xRDSessionCollection.psm1
@@ -1,9 +1,15 @@
-Import-Module -Name "$PSScriptRoot\..\..\Modules\xRemoteDesktopSessionHostCommon.psm1"
+$modulePath = Join-Path -Path (Split-Path -Path (Split-Path -Path $PSScriptRoot -Parent) -Parent) -ChildPath 'Modules'
+
+# Import the Common Modules
+Import-Module -Name (Join-Path -Path $modulePath -ChildPath 'xRemoteDesktopSessionHost.Common')
+Import-Module -Name (Join-Path -Path $modulePath -ChildPath 'DscResource.Common')
+
 if (-not (Test-xRemoteDesktopSessionHostOsRequirement))
 {
     throw 'The minimum OS requirement was not met.'
 }
-Import-Module RemoteDesktop
+
+Assert-Module -ModuleName 'RemoteDesktop'
 
 #######################################################################
 # The Get-TargetResource cmdlet.

diff --git a/...ources/MSFT_xRDSessionCollectionConfiguration/MSFT_xRDSessionCollectionConfiguration.psm1 b/...ources/MSFT_xRDSessionCollectionConfiguration/MSFT_xRDSessionCollectionConfiguration.psm1
@@ -1,17 +1,15 @@
-$resourceModulePath = Split-Path -Path (Split-Path -Path $PSScriptRoot -Parent) -Parent
-$modulesFolderPath = Join-Path -Path $resourceModulePath -ChildPath 'Modules'
+$modulePath = Join-Path -Path (Split-Path -Path (Split-Path -Path $PSScriptRoot -Parent) -Parent) -ChildPath 'Modules'
 
-$rdCommonModulePath = Join-Path -Path $modulesFolderPath -ChildPath 'xRemoteDesktopSessionHostCommon.psm1'
-Import-Module -Name $rdCommonModulePath
-
-$dscResourceCommonModulePath = Join-Path -Path $modulesFolderPath -ChildPath 'DscResource.Common'
-Import-Module -Name $dscResourceCommonModulePath
+# Import the Common Modules
+Import-Module -Name (Join-Path -Path $modulePath -ChildPath 'xRemoteDesktopSessionHost.Common')
+Import-Module -Name (Join-Path -Path $modulePath -ChildPath 'DscResource.Common')
 
 if (-not (Test-xRemoteDesktopSessionHostOsRequirement))
 {
     throw 'The minimum OS requirement was not met.'
 }
-Import-Module RemoteDesktop
+
+Assert-Module -ModuleName 'RemoteDesktop'
 
 #######################################################################
 # The Get-TargetResource cmdlet.

diff --git a/source/DSCResources/MSFT_xRDSessionDeployment/MSFT_xRDSessionDeployment.psm1 b/source/DSCResources/MSFT_xRDSessionDeployment/MSFT_xRDSessionDeployment.psm1
@@ -1,10 +1,15 @@
-Import-Module -Name "$PSScriptRoot\..\..\Modules\xRemoteDesktopSessionHostCommon.psm1"
+$modulePath = Join-Path -Path (Split-Path -Path (Split-Path -Path $PSScriptRoot -Parent) -Parent) -ChildPath 'Modules'
+
+# Import the Common Modules
+Import-Module -Name (Join-Path -Path $modulePath -ChildPath 'xRemoteDesktopSessionHost.Common')
+Import-Module -Name (Join-Path -Path $modulePath -ChildPath 'DscResource.Common')
 
 if (-not (Test-xRemoteDesktopSessionHostOsRequirement))
 {
     throw 'The minimum OS requirement was not met.'
 }
-Import-Module RemoteDesktop
+
+Assert-Module -ModuleName 'RemoteDesktop'
 
 #######################################################################
 # The Get-TargetResource cmdlet.

diff --git a/source/Modules/en-US/xRemoteDesktopSessionHostCommon.strings.psd1 b/source/Modules/en-US/xRemoteDesktopSessionHostCommon.strings.psd1
diff --git a/...odules/xRemoteDesktopSessionHost.Common/Public/Get-xRemoteDesktopSessionHostOsVersion.ps1 b/...odules/xRemoteDesktopSessionHost.Common/Public/Get-xRemoteDesktopSessionHostOsVersion.ps1
@@ -0,0 +1,4 @@
+function Get-xRemoteDesktopSessionHostOsVersion
+{
+    return [Environment]::OSVersion.Version
+}
diff --git a/...s/xRemoteDesktopSessionHost.Common/Public/Test-xRemoteDesktopSessionHostOsRequirement.ps1 b/...s/xRemoteDesktopSessionHost.Common/Public/Test-xRemoteDesktopSessionHostOsRequirement.ps1
@@ -0,0 +1,4 @@
+function Test-xRemoteDesktopSessionHostOsRequirement
+{
+    return (Get-xRemoteDesktopSessionHostOsVersion) -ge (New-Object 'Version' 6, 2, 9200, 0)
+}
diff --git a/...ules/xRemoteDesktopSessionHost.Common/en-US/xRemoteDesktopSessionHost.Common.strings.psd1 b/...ules/xRemoteDesktopSessionHost.Common/en-US/xRemoteDesktopSessionHost.Common.strings.psd1
@@ -0,0 +1,4 @@
+# Localized resources for xRemoteDesktopSessionHost.Common
+
+ConvertFrom-StringData @'
+'@