Replace function Test-OosDscParameterState with Test-DscParameterState or Compare-DscParameterState

[johlju]

Suggest replacing the function Test-OosDscParameterState with the Test-DscParameterState or Compare-DscParameterState from the common module DscResource.Common.

OfficeOnlineServerDsc/src/Modules/OfficeOnlineServerDsc.Util/OfficeOnlineServerDsc.Util.psm1

Lines 291 to 474 in 6b6ce1f

	<#
	.SYNOPSIS
	This method is used to compare current and desired values for any DSC resource
	.PARAMETER CurrentValues
	This is hashtable of the current values that are applied to the resource
	.PARAMETER DesiredValues
	This is a PSBoundParametersDictionary of the desired values for the resource
	.PARAMETER ValuesToCheck
	This is a list of which properties in the desired values list should be checkked.
	If this is empty then all values in DesiredValues are checked.
	#>
	function Test-OosDscParameterState()
	{
	[CmdletBinding()]
	[OutputType([System.Boolean])]
	param
	(
	[Parameter(Mandatory = $true, Position = 1)]
	[HashTable]
	$CurrentValues,
	[Parameter(Mandatory = $true, Position = 2)]
	[Object]
	$DesiredValues,
	[Parameter(Position = 3)]
	[Array]
	$ValuesToCheck
	)
	$returnValue = $true
	if (($DesiredValues.GetType().Name -ne "HashTable") `
	-and ($DesiredValues.GetType().Name -ne "CimInstance") `
	-and ($DesiredValues.GetType().Name -ne "PSBoundParametersDictionary"))
	{
	throw ("Property 'DesiredValues' in Test-OOSDscParameterState must be either a " + `
	"Hashtable or CimInstance. Type detected was $($DesiredValues.GetType().Name)")
	}
	if (($DesiredValues.GetType().Name -eq "CimInstance") -and ($null -eq $ValuesToCheck))
	{
	throw ("If 'DesiredValues' is a Hashtable then property 'ValuesToCheck' must contain " + `
	"a value")
	}
	if (($null -eq $ValuesToCheck) -or ($ValuesToCheck.Count -lt 1))
	{
	$KeyList = $DesiredValues.Keys
	}
	else
	{
	$KeyList = $ValuesToCheck
	}
	$KeyList | ForEach-Object -Process {
	if ($_ -ne "Verbose")
	{
	if (($CurrentValues.ContainsKey($_) -eq $false) `
	-or ($CurrentValues.$_ -ne $DesiredValues.$_) `
	-or (($DesiredValues.ContainsKey($_) -eq $true) -and ($DesiredValues.$_.GetType().IsArray)))
	{
	if ($DesiredValues.GetType().Name -eq "HashTable" -or `
	$DesiredValues.GetType().Name -eq "PSBoundParametersDictionary")
	{
	$CheckDesiredValue = $DesiredValues.ContainsKey($_)
	}
	else
	{
	$CheckDesiredValue = Test-OOSDscObjectHasProperty $DesiredValues $_
	}
	if ($CheckDesiredValue)
	{
	$desiredType = $DesiredValues.$_.GetType()
	$fieldName = $_
	if ($desiredType.IsArray -eq $true)
	{
	if (($CurrentValues.ContainsKey($fieldName) -eq $false) `
	-or ($null -eq $CurrentValues.$fieldName))
	{
	Write-Verbose -Message ("Expected to find an array value for " + `
	"property $fieldName in the current " + `
	"values, but it was either not present or " + `
	"was null. This has caused the test method " + `
	"to return false.")
	$returnValue = $false
	}
	else
	{
	$arrayCompare = Compare-Object -ReferenceObject $CurrentValues.$fieldName `
	-DifferenceObject $DesiredValues.$fieldName
	if ($null -ne $arrayCompare)
	{
	Write-Verbose -Message ("Found an array for property $fieldName " + `
	"in the current values, but this array " + `
	"does not match the desired state. " + `
	"Details of the changes are below.")
	$arrayCompare | ForEach-Object -Process {
	Write-Verbose -Message "$($_.InputObject) - $($_.SideIndicator)"
	}
	$returnValue = $false
	}
	}
	}
	else
	{
	switch ($desiredType.Name)
	{
	"String"
	{
	if ([string]::IsNullOrEmpty($CurrentValues.$fieldName) `
	-and [string]::IsNullOrEmpty($DesiredValues.$fieldName))
	{
	}
	else
	{
	Write-Verbose -Message ("String value for property " + `
	"$fieldName does not match. " + `
	"Current state is " + `
	"'$($CurrentValues.$fieldName)' " + `
	"and desired state is " + `
	"'$($DesiredValues.$fieldName)'")
	$returnValue = $false
	}
	}
	"Int32"
	{
	if (($DesiredValues.$fieldName -eq 0) `
	-and ($null -eq $CurrentValues.$fieldName))
	{
	}
	else
	{
	Write-Verbose -Message ("Int32 value for property " + `
	"$fieldName does not match. " + `
	"Current state is " + `
	"'$($CurrentValues.$fieldName)' " + `
	"and desired state is " + `
	"'$($DesiredValues.$fieldName)'")
	$returnValue = $false
	}
	}
	"Int16"
	{
	if (($DesiredValues.$fieldName -eq 0) `
	-and ($null -eq $CurrentValues.$fieldName))
	{
	}
	else
	{
	Write-Verbose -Message ("Int16 value for property " + `
	"$fieldName does not match. " + `
	"Current state is " + `
	"'$($CurrentValues.$fieldName)' " + `
	"and desired state is " + `
	"'$($DesiredValues.$fieldName)'")
	$returnValue = $false
	}
	}
	default
	{
	Write-Verbose -Message ("Unable to compare property $fieldName " + `
	"as the type ($($desiredType.Name)) is " + `
	"not handled by the " + `
	"Test-OOSDscParameterState cmdlet")
	$returnValue = $false
	}
	}
	}
	}
	}
	}
	}
	return $returnValue
	}