mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
powershell.ps1: Ensure Fail-Json() works with Hashtables (#21697)
Without this change a dictionary $result object would be emptied if it is anything but a PSCustomObject. Now we also support Hashtables.
This commit is contained in:
parent
01afed4dc5
commit
aebf6c8c92
3 changed files with 34 additions and 30 deletions
|
@ -38,7 +38,7 @@ Function Set-Attr($obj, $name, $value)
|
||||||
# If the provided $obj is undefined, define one to be nice
|
# If the provided $obj is undefined, define one to be nice
|
||||||
If (-not $obj.GetType)
|
If (-not $obj.GetType)
|
||||||
{
|
{
|
||||||
$obj = New-Object psobject
|
$obj = @{ }
|
||||||
}
|
}
|
||||||
|
|
||||||
Try
|
Try
|
||||||
|
@ -59,7 +59,7 @@ Function Exit-Json($obj)
|
||||||
# If the provided $obj is undefined, define one to be nice
|
# If the provided $obj is undefined, define one to be nice
|
||||||
If (-not $obj.GetType)
|
If (-not $obj.GetType)
|
||||||
{
|
{
|
||||||
$obj = New-Object psobject
|
$obj = @{ }
|
||||||
}
|
}
|
||||||
|
|
||||||
echo $obj | ConvertTo-Json -Compress -Depth 99
|
echo $obj | ConvertTo-Json -Compress -Depth 99
|
||||||
|
@ -67,25 +67,27 @@ Function Exit-Json($obj)
|
||||||
}
|
}
|
||||||
|
|
||||||
# Helper function to add the "msg" property and "failed" property, convert the
|
# Helper function to add the "msg" property and "failed" property, convert the
|
||||||
# powershell object to JSON and echo it, exiting the script
|
# powershell Hashtable to JSON and echo it, exiting the script
|
||||||
# Example: Fail-Json $result "This is the failure message"
|
# Example: Fail-Json $result "This is the failure message"
|
||||||
Function Fail-Json($obj, $message = $null)
|
Function Fail-Json($obj, $message = $null)
|
||||||
{
|
{
|
||||||
# If we weren't given 2 args, and the only arg was a string, create a new
|
if ($obj -is [hashtable] -or $obj -is [psobject]) {
|
||||||
# psobject and use the arg as the failure message
|
# Nothing to do
|
||||||
If ($message -eq $null -and $obj.GetType().Name -eq "String")
|
} elseif ($obj -is [string] -and $message -eq $null) {
|
||||||
{
|
# If we weren't given 2 args, and the only arg was a string,
|
||||||
|
# create a new Hashtable and use the arg as the failure message
|
||||||
$message = $obj
|
$message = $obj
|
||||||
$obj = New-Object psobject
|
$obj = @{ }
|
||||||
}
|
} else {
|
||||||
# If the first args is undefined or not an object, make it an object
|
# If the first argument is undefined or a different type,
|
||||||
ElseIf (-not $obj -or -not $obj.GetType -or $obj.GetType().Name -ne "PSCustomObject")
|
# make it a Hashtable
|
||||||
{
|
$obj = @{ }
|
||||||
$obj = New-Object psobject
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
# Still using Set-Attr for PSObject compatibility
|
||||||
Set-Attr $obj "msg" $message
|
Set-Attr $obj "msg" $message
|
||||||
Set-Attr $obj "failed" $true
|
Set-Attr $obj "failed" $true
|
||||||
|
|
||||||
echo $obj | ConvertTo-Json -Compress -Depth 99
|
echo $obj | ConvertTo-Json -Compress -Depth 99
|
||||||
Exit 1
|
Exit 1
|
||||||
}
|
}
|
||||||
|
@ -96,7 +98,7 @@ Function Fail-Json($obj, $message = $null)
|
||||||
Function Add-Warning($obj, $message)
|
Function Add-Warning($obj, $message)
|
||||||
{
|
{
|
||||||
if (Get-Member -InputObject $obj -Name "warnings") {
|
if (Get-Member -InputObject $obj -Name "warnings") {
|
||||||
if ($obj.warnings -is [System.Array]) {
|
if ($obj.warnings -is [array]) {
|
||||||
$obj.warnings += $message
|
$obj.warnings += $message
|
||||||
} else {
|
} else {
|
||||||
throw "warnings attribute is not an array"
|
throw "warnings attribute is not an array"
|
||||||
|
@ -112,7 +114,7 @@ Function Add-Warning($obj, $message)
|
||||||
Function Add-DeprecationWarning($obj, $message, $version = $null)
|
Function Add-DeprecationWarning($obj, $message, $version = $null)
|
||||||
{
|
{
|
||||||
if (Get-Member -InputObject $obj -Name "deprecations") {
|
if (Get-Member -InputObject $obj -Name "deprecations") {
|
||||||
if ($obj.deprecations -is [System.Array]) {
|
if ($obj.deprecations -is [array]) {
|
||||||
$obj.deprecations += @{
|
$obj.deprecations += @{
|
||||||
msg = $message
|
msg = $message
|
||||||
version = $version
|
version = $version
|
||||||
|
@ -238,12 +240,9 @@ Function ConvertTo-Bool
|
||||||
$boolean_strings = "yes", "on", "1", "true", 1
|
$boolean_strings = "yes", "on", "1", "true", 1
|
||||||
$obj_string = [string]$obj
|
$obj_string = [string]$obj
|
||||||
|
|
||||||
if (($obj.GetType().Name -eq "Boolean" -and $obj) -or $boolean_strings -contains $obj_string.ToLower())
|
if (($obj -is [boolean] -and $obj) -or $boolean_strings -contains $obj_string.ToLower()) {
|
||||||
{
|
|
||||||
return $true
|
return $true
|
||||||
}
|
} else {
|
||||||
Else
|
|
||||||
{
|
|
||||||
return $false
|
return $false
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -328,3 +327,4 @@ Function Get-PendingRebootStatus
|
||||||
|
|
||||||
# this line must stay at the bottom to ensure all defined module parts are exported
|
# this line must stay at the bottom to ensure all defined module parts are exported
|
||||||
Export-ModuleMember -Alias * -Function * -Cmdlet *
|
Export-ModuleMember -Alias * -Function * -Cmdlet *
|
||||||
|
|
||||||
|
|
|
@ -19,14 +19,18 @@
|
||||||
|
|
||||||
$parsed_args = Parse-Args $args
|
$parsed_args = Parse-Args $args
|
||||||
|
|
||||||
$sleep_delay_sec = Get-AnsibleParam $parsed_args "sleep_delay_sec" -default 0
|
$sleep_delay_sec = Get-AnsibleParam -obj $parsed_args -name "sleep_delay_sec" -type "int" -default 0
|
||||||
$fail_mode = Get-AnsibleParam $parsed_args "fail_mode" -default "success" -validateset "success","graceful","exception"
|
$fail_mode = Get-AnsibleParam -obj $parsed_args -name "fail_mode" -type "str" -default "success" -validateset "success","graceful","exception"
|
||||||
|
|
||||||
If($fail_mode -isnot [array]) {
|
If($fail_mode -isnot [array]) {
|
||||||
$fail_mode = @($fail_mode)
|
$fail_mode = @($fail_mode)
|
||||||
}
|
}
|
||||||
|
|
||||||
$result = @{changed=$true; module_pid=$pid; module_tempdir=$PSScriptRoot}
|
$result = @{
|
||||||
|
changed = $true
|
||||||
|
module_pid = $pid
|
||||||
|
module_tempdir = $PSScriptRoot
|
||||||
|
}
|
||||||
|
|
||||||
If($sleep_delay_sec -gt 0) {
|
If($sleep_delay_sec -gt 0) {
|
||||||
Sleep -Seconds $sleep_delay_sec
|
Sleep -Seconds $sleep_delay_sec
|
||||||
|
@ -37,13 +41,13 @@ If($fail_mode -contains "leading_junk") {
|
||||||
Write-Output "leading junk before module output"
|
Write-Output "leading junk before module output"
|
||||||
}
|
}
|
||||||
|
|
||||||
Try {
|
|
||||||
|
|
||||||
If($fail_mode -contains "graceful") {
|
If($fail_mode -contains "graceful") {
|
||||||
Fail-Json $result "failed gracefully"
|
Fail-Json $result "failed gracefully"
|
||||||
}
|
}
|
||||||
|
|
||||||
If($fail_mode -eq "exception") {
|
Try {
|
||||||
|
|
||||||
|
If($fail_mode -contains "exception") {
|
||||||
Throw "failing via exception"
|
Throw "failing via exception"
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -116,7 +116,7 @@
|
||||||
that:
|
that:
|
||||||
- asyncresult.ansible_job_id is match('\d+\.\d+')
|
- asyncresult.ansible_job_id is match('\d+\.\d+')
|
||||||
- asyncresult.finished == 1
|
- asyncresult.finished == 1
|
||||||
- asyncresult.changed == false
|
- asyncresult.changed == true
|
||||||
- asyncresult | failed == true
|
- asyncresult | failed == true
|
||||||
- asyncresult.msg == 'failed gracefully'
|
- asyncresult.msg == 'failed gracefully'
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue