DFSReplicationGroupMembership: Fails when trying to create a new DFS group and running Test first

[Borgquite]

Problem description

If the DFSReplicationGroupMembership is used on a new setup where the replication group does not yet exist with the Test-TargetResource executed before the configuration is applied for the first time, it will fail with 'System.InvalidOperationException: DFS Replication Group "" folder "" on "" is missing.'

Verbose logs

VERBOSE: [Test-VM]: LCM:  [ Start  Resource ]  [DFSReplicationGroupMembership]RGPublicSoftwareFS1
VERBOSE: [Test-VM]: LCM:  [ Start  Test     ]  [DFSReplicationGroupMembership]RGPublicSoftwareFS1
VERBOSE: [Test-VM]:                            [DFSReplicationGroupMembership]RGPublicSoftwareFS1 Test-TargetResource: Testing DFS Replication Group "DC 'Programs' Share"
folder "Folder" on "Test-VM.ad.mafint.org".
VERBOSE: [Test-VM]: LCM:  [ End    Test     ]  [DFSReplicationGroupMembership]RGPublicSoftwareFS1 False in 0.0620 seconds.
VERBOSE: [Test-VM]: LCM:  [ *FAILED*Compare  ]     Completed processing compare operation. The operation returned
False.
PowerShell DSC resource DSC_DFSReplicationGroupMembership  failed to execute Test-TargetResource functionality with
error message: System.InvalidOperationException: DFS Replication Group "DFS Replication Group" folder "Folder" on
"Test-VM.test.domain" is missing.
    + CategoryInfo          : InvalidOperation: (root/Microsoft/...gurationManager:String) [], CimException
    + FullyQualifiedErrorId : ProviderOperationExecutionFailure
    + PSComputerName        : Test-VM

DSC configuration

DFSReplicationGroup RGPublic
{
	GroupName = 'DFS Replication Group'
	Description = 'Public files for use by all departments'
	Ensure = 'Present'
	Members = 'FileServer1','FileServer2'
	Folders = 'Folder'
	Topology = 'Fullmesh'
	PSDSCRunAsCredential = $Credential
}

DFSReplicationGroupFolder RGSoftwareFolder
{
	GroupName = 'DFS Replication Group'
	FolderName = 'Folder'
	Description = 'DFS Share for storing software installers'
	DirectoryNameToExclude = 'Temp'
	PSDSCRunAsCredential = $Credential
	DependsOn = '[DFSReplicationGroup]RGPublic'
}

DFSReplicationGroupMembership RGPublicSoftwareFS1
{
	GroupName = 'DFS Replication Group'
	FolderName = 'Folder'
	ComputerName = 'FileServer1'
	ContentPath = 'd:\Public\Software'
	StagingPathQuotaInMB = 4096
	PrimaryMember = $true
	PSDSCRunAsCredential = $Credential
	DependsOn = '[DFSReplicationGroupFolder]RGSoftwareFolder'
} # End of RGPublicSoftwareFS1 Resource

DFSReplicationGroupMembership RGPublicSoftwareFS2
{
	GroupName = 'DFS Replication Group'
	FolderName = 'Folder'
	ComputerName = 'FileServer2'
	ContentPath = 'e:\Data\Public\Folder'
	StagingPathQuotaInMB = 4096
	PSDSCRunAsCredential = $Credential
	DependsOn = '[DFSReplicationGroupFolder]RGSoftwareFolder'
}

Suggested solution

The DFSReplicationGroupMembership resource does not need to return a terminating error when the specifed replication group folder membership does not exist - instead, it should just return that the resource is not in the desired state. There is no need to tank the entire Test-TargetResource process.

Operating system the target node is running

OsName               : Microsoft Windows Server 2022 Datacenter Azure Edition
OsOperatingSystemSKU : 407
OsArchitecture       : 64-bit
WindowsVersion       : 2009
WindowsBuildLabEx    : 20348.1.amd64fre.fe_release.210507-1500
OsLanguage           : en-US
OsMuiLanguages       : {en-US}

PowerShell version and build the target node is running

Name                           Value
----                           -----
PSVersion                      5.1.20348.558
PSEdition                      Desktop
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0...}
BuildVersion                   10.0.20348.558
CLRVersion                     4.0.30319.42000
WSManStackVersion              3.0
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1

DFSDsc version

Name   Version Path
----   ------- ----
DFSDsc 4.5.0   C:\Program Files\WindowsPowerShell\Modules\DFSDsc\4.5.0\DFSDsc.psd1