From 7c9889a72bae215c01db278c686a24148afd4124 Mon Sep 17 00:00:00 2001
From: Jordan Borean <jborean93@gmail.com>
Date: Sat, 21 Mar 2020 13:24:11 +1000
Subject: [PATCH] validate-modules - fix ps module delegate type inspection

---
 changelogs/fragments/ps-argspec-type.yaml     |  2 +
 .../validate_modules/ps_argspec.ps1           | 49 +++++++++++++++++--
 2 files changed, 48 insertions(+), 3 deletions(-)
 create mode 100644 changelogs/fragments/ps-argspec-type.yaml

diff --git a/changelogs/fragments/ps-argspec-type.yaml b/changelogs/fragments/ps-argspec-type.yaml
new file mode 100644
index 00000000000..71c72b7539f
--- /dev/null
+++ b/changelogs/fragments/ps-argspec-type.yaml
@@ -0,0 +1,2 @@
+bugfixes:
+- validate-modules - Fix hang when inspecting module with a delegate args spec type
diff --git a/test/lib/ansible_test/_data/sanity/validate-modules/validate_modules/ps_argspec.ps1 b/test/lib/ansible_test/_data/sanity/validate-modules/validate_modules/ps_argspec.ps1
index 4293d2d8544..49491634a30 100755
--- a/test/lib/ansible_test/_data/sanity/validate-modules/validate_modules/ps_argspec.ps1
+++ b/test/lib/ansible_test/_data/sanity/validate-modules/validate_modules/ps_argspec.ps1
@@ -5,6 +5,45 @@ Set-StrictMode -Version 2.0
 $ErrorActionPreference = "Stop"
 $WarningPreference = "Stop"
 
+Function Resolve-CircularReference {
+    <#
+    .SYNOPSIS
+    Removes known types that cause a circular reference in their json serialization.
+
+    .PARAMETER Hash
+    The hash to scan for circular references
+    #>
+    [CmdletBinding()]
+    param (
+        [Parameter(Mandatory=$true)]
+        [System.Collections.IDictionary]
+        $Hash
+    )
+
+    foreach ($key in [String[]]$Hash.Keys) {
+        $value = $Hash[$key]
+        if ($value -is [System.Collections.IDictionary]) {
+            Resolve-CircularReference -Hash $value
+        } elseif ($value -is [Array] -or $value -is [System.Collections.IList]) {
+            $values = @(foreach ($v in $value) {
+                if ($v -is [System.Collections.IDictionary]) {
+                    Resolve-CircularReference -Hash $v
+                }
+                ,$v
+            })
+            $Hash[$key] = $values
+        } elseif ($value -is [delegate]) {
+            # Type can be set to a delegate function which defines it's own type. For the documentation we just
+            # reflection that as raw
+            if ($key -eq 'type') {
+                $Hash[$key] = 'raw'
+            } else {
+                $Hash[$key] = $value.ToString()  # Shouldn't ever happen but just in case.
+            }
+        }
+    }
+}
+
 $manifest = ConvertFrom-Json -InputObject $args[0] -AsHashtable
 if (-not $manifest.Contains('module_path') -or -not $manifest.module_path) {
     Write-Error -Message "No module specified."
@@ -33,9 +72,8 @@ namespace Ansible.Basic
     {
         public AnsibleModule(string[] args, IDictionary argumentSpec)
         {
-            PSObject rawOut = ScriptBlock.Create("ConvertTo-Json -InputObject $args[0] -Depth 99 -Compress").Invoke(argumentSpec)[0];
-            Console.WriteLine(rawOut.BaseObject.ToString());
-            ScriptBlock.Create("Set-Variable -Name LASTEXITCODE -Value 0 -Scope Global; exit 0").Invoke();
+            ScriptBlock.Create("Set-Variable -Name arg_spec -Value $args[0] -Scope Global; exit 0"
+                ).Invoke(new Object[] { argumentSpec });
         }
 
         public static AnsibleModule Create(string[] args, IDictionary argumentSpec)
@@ -81,3 +119,8 @@ if ($powershell.HadErrors) {
     $powershell.Streams.Error
     exit 1
 }
+
+$arg_spec = $powershell.Runspace.SessionStateProxy.GetVariable('arg_spec')
+Resolve-CircularReference -Hash $arg_spec
+
+ConvertTo-Json -InputObject $arg_spec -Compress -Depth 99
\ No newline at end of file