test fixes

Author: FriedrichWeinmann

PSFramework/bin/PSFramework.dll

@@ -0,0 +1,92 @@
+function HaveParameters {
+	[CmdletBinding()]
+	param (
+		$ActualValue,
+
+		[string[]]
+		$Parameters,
+
+		[switch]
+		$Negate,
+
+		$CallerSessionState
+	)
+	end {
+		$commonParameters = 'Verbose', 'Debug', 'ErrorAction', 'WarningAction', 'InformationAction', 'ErrorVariable', 'WarningVariable', 'InformationVariable', 'OutVariable', 'OutBuffer', 'PipelineVariable', 'ProgressAction'
+		if ($global:__pester_data.CommonParameters) { $commonParameters = $global:__pester_data.CommonParameters }
+
+		#region Resolve Command
+		if ($null -eq $ActualValue) {
+			return [PSCustomObject]@{
+				Succeeded      = $false
+				FailureMessage = "Did not receive a command to test"
+			}
+		}
+
+		$command = $ActualValue
+		if ($command -isnot [System.Management.Automation.CommandInfo]) {
+			try { $command = Get-Command $ActualValue -ErrorAction Stop }
+			catch {
+				return [PSCustomObject]@{
+					Succeeded      = $false
+					FailureMessage = "Unable to resolve command: $ActualValue"
+				}
+			}
+		}
+		#endregion Resolve Command
+
+		#region Negation
+		if ($Negate) {
+			$found = @()
+			foreach ($parameter in $Parameters) {
+				if ($parameter -notin $command.Parameters.Keys) { continue }
+				$found += $parameter
+			}
+
+			if ($found) {
+				return [PSCustomObject]@{
+					Succeeded      = $false
+					FailureMessage = "Parameters found on $($command.Name): $($found -join ', ')"
+				}
+			}
+			return [PSCustomObject]@{
+				Succeeded      = $true
+				FailureMessage = "None of the forbidden parameters found on $($command.Name) (Forbidden: $($Parameters -join ', '))"
+			}
+		}
+		#endregion Negation
+
+		#region Regular Parameter Test
+		$notFound = @()
+		$excessFound = @()
+
+		foreach ($parameter in $command.Parameters.Keys) {
+			if ($parameter -in $commonParameters) { continue }
+			if ($parameter -in $Parameters) { continue }
+			$excessFound += $parameter
+		}
+
+		foreach ($parameter in $Parameters) {
+			if ($parameter -in $command.Parameters.Keys) { continue }
+			$notFound += $parameter
+		}
+
+		if (-not $notFound -and -not $excessFound) {
+			return [PSCustomObject]@{
+				Succeeded      = $true
+				FailureMessage = "All expected parameters found on $($command.Name) (Expected: $($Parameters -join ', '))"
+			}
+		}
+
+		$fragments = @()
+		if ($notFound) { $fragments += "Missing: $($notFound -join ', ')" }
+		if ($excessFound) { $fragments += "Unexpected: $($excessFound -join ', ')" }
+
+		return [PSCustomObject]@{
+			Succeeded      = $false
+			FailureMessage = "Parameters found on $($command.Name) not as desired | Expected: $($Parameters -join ', ') | $($fragments -join ' | ')"
+		}
+		#endregion Regular Parameter Test
+	}
+}
+Add-ShouldOperator -Name HaveParameters -Test $function:HaveParameters

PSFramework/bin/PSFramework.pdb

@@ -13,7 +13,7 @@
 	# Catch any signature changes to force revisiting the command
 	It "Should have the designed for parameters & sets" {
 		(Get-Command Get-PSFConfig).ParameterSets.Name | Should -Be 'FullName', 'Module'
-		(Get-Command Get-PSFConfig).Parameters.Keys | Should -Be 'FullName', 'Name', 'Module', 'Persisted', 'Force', 'Verbose', 'Debug', 'ErrorAction', 'WarningAction', 'InformationAction', 'ErrorVariable', 'WarningVariable', 'InformationVariable', 'OutVariable', 'OutBuffer', 'PipelineVariable', 'ProgressAction'
+		Get-Command Get-PSFConfig | Should -HaveParameters 'FullName', 'Name', 'Module', 'Persisted', 'Force'
 	}
 
 	It "Should find the correct Configuration item" {

…ions/data/Register-PSFPsd1Converter.psd1 …tions/data/Register-PSFPsd1Converter.ps1PSFramework/functions/data/Register-PSFPsd1Converter.psd1 renamed to PSFramework/functions/data/Register-PSFPsd1Converter.ps1 PSFramework/functions/data/Register-PSFPsd1Converter.psd1 renamed to PSFramework/functions/data/Register-PSFPsd1Converter.ps1

@@ -13,8 +13,7 @@
 	# Catch any signature changes to force revisiting the command
 	It "Should have the designed for parameters & sets" {
 		(Get-Command Register-PSFConfig).ParameterSets.Name | Should -Be 'Default', 'Name'
-		$properties = 'Config', 'FullName', 'Module', 'Name', 'Scope', 'EnableException', 'Verbose', 'Debug', 'ErrorAction', 'WarningAction', 'InformationAction', 'ErrorVariable', 'WarningVariable', 'InformationVariable', 'OutVariable', 'OutBuffer', 'PipelineVariable', 'ProgressAction'
-		Compare-Object $properties ((Get-Command Register-PSFConfig).Parameters.Keys | Remove-PSFNull -Enumerate) | Should -BeNullOrEmpty
+		Get-Command Register-PSFConfig | Should -HaveParameters 'Config', 'FullName', 'Module', 'Name', 'Scope', 'EnableException'
 	}
 
 	Context "Validating registry persistence" {

PSFramework/tests/extensions/HaveParameters.ps1

@@ -13,8 +13,7 @@
 	# Catch any signature changes to force revisiting the command
 	It "Should have the designed for parameters & sets" {
 		(Get-Command Register-PSFConfigValidation).ParameterSets.Name | Should -Be '__AllParameterSets'
-		$properties = 'Name', 'ScriptBlock', 'Verbose', 'Debug', 'ErrorAction', 'WarningAction', 'InformationAction', 'ErrorVariable', 'WarningVariable', 'InformationVariable', 'OutVariable', 'OutBuffer', 'PipelineVariable', 'ProgressAction'
-		Compare-Object $properties ((Get-Command Register-PSFConfigValidation).Parameters.Keys | Remove-PSFNull -Enumerate) | Should -BeNullOrEmpty
+		Get-Command Register-PSFConfigValidation | Should -HaveParameters  'Name', 'ScriptBlock'
 	}
 
 	Context "Ensuring validation can be created, assigned and used" {

PSFramework/tests/functions/configuration/Get-PSFConfig.Tests.ps1

@@ -16,7 +16,7 @@
 	# Catch any signature changes to force revisiting the command
 	It "Should have the designed for parameters & sets" {
 		(Get-Command Set-PSFConfig).ParameterSets.Name | Should -Be 'FullName', 'Persisted', 'Module'
-		(Get-Command Set-PSFConfig).Parameters.Keys | Should -Be 'FullName', 'Module', 'Name', 'Value', 'PersistedValue', 'PersistedType', 'Description', 'Validation', 'Handler', 'Hidden', 'Default', 'Initialize', 'SimpleExport', 'ModuleExport', 'AllowDelete', 'DisableValidation', 'DisableHandler', 'PassThru', 'EnableException', 'Verbose', 'Debug', 'ErrorAction', 'WarningAction', 'InformationAction', 'ErrorVariable', 'WarningVariable', 'InformationVariable', 'OutVariable', 'OutBuffer', 'PipelineVariable', 'ProgressAction'
+		Get-Command Set-PSFConfig | Should -HaveParameters 'FullName', 'Module', 'Name', 'Value', 'PersistedValue', 'PersistedType', 'Description', 'Validation', 'Handler', 'Hidden', 'Default', 'Initialize', 'SimpleExport', 'ModuleExport', 'AllowDelete', 'DisableValidation', 'DisableHandler', 'PassThru', 'EnableException'
 	}
 
 	Describe "Basic functionality tests" {

PSFramework/tests/functions/configuration/Register-PSFConfig.Tests.ps1

@@ -13,8 +13,7 @@
 	# Catch any signature changes to force revisiting the command
 	It "Should have the designed for parameters & sets" {
 		(Get-Command Unregister-PSFConfig).ParameterSets.Name | Should -Be 'Pipeline', 'Module'
-		$properties = 'ConfigurationItem', 'PersistedItem', 'FullName', 'Module', 'Name', 'Scope', 'Verbose', 'Debug', 'ErrorAction', 'WarningAction', 'InformationAction', 'ErrorVariable', 'WarningVariable', 'InformationVariable', 'OutVariable', 'OutBuffer', 'PipelineVariable', 'ProgressAction'
-		Compare-Object $properties ((Get-Command Unregister-PSFConfig).Parameters.Keys | Remove-PSFNull -Enumerate) | Should -BeNullOrEmpty
+		Get-Command Unregister-PSFConfig | Should -HaveParameters 'ConfigurationItem', 'PersistedItem', 'FullName', 'Module', 'Name', 'Scope'
 	}
 
 	function New-Location

PSFramework/tests/functions/configuration/Register-PSFConfigValidation.Tests.ps1

@@ -23,7 +23,9 @@ Write-Host "Starting Tests"
 Write-Host "Importing Module"
 
 $global:testroot = $PSScriptRoot
-$global:__pester_data = @{ }
+$global:__pester_data = @{
+	CommonParameters = 'Verbose', 'Debug', 'ErrorAction', 'WarningAction', 'InformationAction', 'ErrorVariable', 'WarningVariable', 'InformationVariable', 'OutVariable', 'OutBuffer', 'PipelineVariable', 'ProgressAction'
+}
 
 if (-not $NoImport) {
 	Remove-Module PSFramework -ErrorAction Ignore