Fix for issues #86 and #89. Same fix for both where we need to unwrap PSObject when getting a variable's child variables. Also added some more unit tests for variables.

Author: rkeithhill

src/PowerShellEditorServices/Debugging/VariableDetails.cs

@@ -233,23 +233,30 @@ private static VariableDetails[] GetChildren(object obj)
                 return childVariables.ToArray();
             }
 
-            PSObject psObject = obj as PSObject;
-            IDictionary dictionary = obj as IDictionary;
-            IEnumerable enumerable = obj as IEnumerable;
-
             try
             {
-                if (psObject != null)
+                PSObject psObject = obj as PSObject;
+
+                if ((psObject != null) && 
+                    (psObject.TypeNames[0] == typeof(PSCustomObject).ToString()))
                 {
-                    // PowerShell wrapped objects can have extra ETS properties so let's use
-                    // PowerShell's infrastructure to get those properties.
+                    // PowerShell PSCustomObject's properties are completely defined by the ETS type system.
                     childVariables.AddRange(
                         psObject
                             .Properties
                             .Select(p => new VariableDetails(p)));
                 }
                 else 
                 {
+                    // If a PSObject other than a PSCustomObject, unwrap it.
+                    if (psObject != null)
+                    {
+                        obj = psObject.BaseObject;
+                    }
+
+                    IDictionary dictionary = obj as IDictionary;
+                    IEnumerable enumerable = obj as IEnumerable;
+
                     // We're in the realm of regular, unwrapped .NET objects
                     if (dictionary != null)
                     { 

test/PowerShellEditorServices.Test.Shared/Debugging/VariableTest.ps1

@@ -6,11 +6,15 @@
 function Test-Variables
 {
 	$strVar = "Hello"
-	$objVar = @{ firstChild = "Child"; secondChild = 42 }
 	$arrVar = @(1, 2, $strVar, $objVar)
+	$assocArrVar = @{ firstChild = "Child"; secondChild = 42 }
 	$classVar = [MyClass]::new();
 	$classVar.Name = "Test"
 	$classVar.Number = 42;
+    $enumVar = $ErrorActionPreference
+    $psObjVar = New-Object -TypeName PSObject -Property @{Name = 'John';  Age = 75}
+    $psCustomObjVar = [PSCustomObject] @{Name = 'Paul'; Age = 73}
+    $procVar = Get-Process system
 	Write-Output "Done"
 }
 

test/PowerShellEditorServices.Test/Debugging/DebugServiceTests.cs

@@ -167,6 +167,38 @@ await this.AssertStateChange(
                 PowerShellExecutionResult.Aborted);
         }
 
+        [Fact]
+        public async Task DebuggerVariableStringDisplaysCorrectly()
+        {
+            ScriptFile variablesFile =
+                this.workspace.GetFile(
+                    @"..\..\..\PowerShellEditorServices.Test.Shared\Debugging\VariableTest.ps1");
+
+            await this.debugService.SetBreakpoints(
+                variablesFile,
+                new int[] { 18 });
+
+            // Execute the script and wait for the breakpoint to be hit
+            Task executeTask =
+                this.powerShellContext.ExecuteScriptString(
+                    variablesFile.FilePath);
+
+            await this.AssertDebuggerStopped(variablesFile.FilePath);
+
+            StackFrameDetails[] stackFrames = debugService.GetStackFrames();
+
+            VariableDetailsBase[] variables =
+                debugService.GetVariables(stackFrames[0].LocalVariables.Id);
+
+            var var = variables.FirstOrDefault(v => v.Name == "$strVar");
+            Assert.NotNull(var);
+            Assert.Equal("\"Hello\"", var.ValueString);
+            Assert.False(var.IsExpandable);
+
+            // Abort execution of the script
+            this.powerShellContext.AbortExecution();
+        }
+
         [Fact]
         public async Task DebuggerGetsVariables()
         {
@@ -196,7 +228,7 @@ await this.debugService.SetBreakpoints(
             Assert.NotNull(strVar);
             Assert.False(strVar.IsExpandable);
 
-            var objVar = variables.FirstOrDefault(v => v.Name == "$objVar");
+            var objVar = variables.FirstOrDefault(v => v.Name == "$assocArrVar");
             Assert.NotNull(objVar);
             Assert.True(objVar.IsExpandable);
 
@@ -221,6 +253,192 @@ await this.debugService.SetBreakpoints(
             this.powerShellContext.AbortExecution();
         }
 
+        [Fact]
+        public async Task DebuggerVariableEnumDisplaysCorrectly()
+        {
+            ScriptFile variablesFile =
+                this.workspace.GetFile(
+                    @"..\..\..\PowerShellEditorServices.Test.Shared\Debugging\VariableTest.ps1");
+
+            await this.debugService.SetBreakpoints(
+                variablesFile,
+                new int[] { 18 });
+
+            // Execute the script and wait for the breakpoint to be hit
+            Task executeTask =
+                this.powerShellContext.ExecuteScriptString(
+                    variablesFile.FilePath);
+
+            await this.AssertDebuggerStopped(variablesFile.FilePath);
+
+            StackFrameDetails[] stackFrames = debugService.GetStackFrames();
+
+            VariableDetailsBase[] variables =
+                debugService.GetVariables(stackFrames[0].LocalVariables.Id);
+
+            var var = variables.FirstOrDefault(v => v.Name == "$enumVar");
+            Assert.NotNull(var);
+            Assert.Equal("Continue", var.ValueString);
+            Assert.False(var.IsExpandable);
+
+            // Abort execution of the script
+            this.powerShellContext.AbortExecution();
+        }
+
+        [Fact]
+        public async Task DebuggerVariableHashtableDisplaysCorrectly()
+        {
+            ScriptFile variablesFile =
+                this.workspace.GetFile(
+                    @"..\..\..\PowerShellEditorServices.Test.Shared\Debugging\VariableTest.ps1");
+
+            await this.debugService.SetBreakpoints(
+                variablesFile,
+                new int[] { 18 });
+
+            // Execute the script and wait for the breakpoint to be hit
+            Task executeTask =
+                this.powerShellContext.ExecuteScriptString(
+                    variablesFile.FilePath);
+
+            await this.AssertDebuggerStopped(variablesFile.FilePath);
+
+            StackFrameDetails[] stackFrames = debugService.GetStackFrames();
+
+            VariableDetailsBase[] variables =
+                debugService.GetVariables(stackFrames[0].LocalVariables.Id);
+
+            var var = variables.FirstOrDefault(v => v.Name == "$assocArrVar");
+            Assert.NotNull(var);
+            Assert.Equal("[Hashtable: 2]", var.ValueString);
+            Assert.True(var.IsExpandable);
+
+            var childVars = debugService.GetVariables(var.Id);
+            Assert.Equal(9, childVars.Length);
+            Assert.Equal("[0]", childVars[0].Name);
+            Assert.Equal("[secondChild, 42]", childVars[0].ValueString);
+            Assert.Equal("[1]", childVars[1].Name);
+            Assert.Equal("[firstChild, \"Child\"]", childVars[1].ValueString);
+
+            // Abort execution of the script
+            this.powerShellContext.AbortExecution();
+        }
+
+        [Fact]
+        public async Task DebuggerVariablePSObjectDisplaysCorrectly()
+        {
+            ScriptFile variablesFile =
+                this.workspace.GetFile(
+                    @"..\..\..\PowerShellEditorServices.Test.Shared\Debugging\VariableTest.ps1");
+
+            await this.debugService.SetBreakpoints(
+                variablesFile,
+                new int[] { 18 });
+
+            // Execute the script and wait for the breakpoint to be hit
+            Task executeTask =
+                this.powerShellContext.ExecuteScriptString(
+                    variablesFile.FilePath);
+
+            await this.AssertDebuggerStopped(variablesFile.FilePath);
+
+            StackFrameDetails[] stackFrames = debugService.GetStackFrames();
+
+            VariableDetailsBase[] variables =
+                debugService.GetVariables(stackFrames[0].LocalVariables.Id);
+
+            var var = variables.FirstOrDefault(v => v.Name == "$psObjVar");
+            Assert.NotNull(var);
+            Assert.Equal("@{Age=75; Name=John}", var.ValueString);
+            Assert.True(var.IsExpandable);
+
+            var childVars = debugService.GetVariables(var.Id);
+            Assert.Equal(2, childVars.Length);
+            Assert.Equal("Age", childVars[0].Name);
+            Assert.Equal("75", childVars[0].ValueString);
+            Assert.Equal("Name", childVars[1].Name);
+            Assert.Equal("\"John\"", childVars[1].ValueString);
+
+            // Abort execution of the script
+            this.powerShellContext.AbortExecution();
+        }
+
+        [Fact]
+        public async Task DebuggerVariablePSCustomObjectDisplaysCorrectly()
+        {
+            ScriptFile variablesFile =
+                this.workspace.GetFile(
+                    @"..\..\..\PowerShellEditorServices.Test.Shared\Debugging\VariableTest.ps1");
+
+            await this.debugService.SetBreakpoints(
+                variablesFile,
+                new int[] { 18 });
+
+            // Execute the script and wait for the breakpoint to be hit
+            Task executeTask =
+                this.powerShellContext.ExecuteScriptString(
+                    variablesFile.FilePath);
+
+            await this.AssertDebuggerStopped(variablesFile.FilePath);
+
+            StackFrameDetails[] stackFrames = debugService.GetStackFrames();
+
+            VariableDetailsBase[] variables =
+                debugService.GetVariables(stackFrames[0].LocalVariables.Id);
+
+            var var = variables.FirstOrDefault(v => v.Name == "$psCustomObjVar");
+            Assert.NotNull(var);
+            Assert.Equal("@{Name=Paul; Age=73}", var.ValueString);
+            Assert.True(var.IsExpandable);
+
+            var childVars = debugService.GetVariables(var.Id);
+            Assert.Equal(2, childVars.Length);
+            Assert.Equal("Name", childVars[0].Name);
+            Assert.Equal("\"Paul\"", childVars[0].ValueString);
+            Assert.Equal("Age", childVars[1].Name);
+            Assert.Equal("73", childVars[1].ValueString);
+
+            // Abort execution of the script
+            this.powerShellContext.AbortExecution();
+        }
+
+        // Verifies fix for issue #86, $proc = Get-Process foo displays just the
+        // ETS property set and not all process properties.
+        [Fact]
+        public async Task DebuggerVariableProcessObjDisplaysCorrectly()
+        {
+            ScriptFile variablesFile =
+                this.workspace.GetFile(
+                    @"..\..\..\PowerShellEditorServices.Test.Shared\Debugging\VariableTest.ps1");
+
+            await this.debugService.SetBreakpoints(
+                variablesFile,
+                new int[] { 18 });
+
+            // Execute the script and wait for the breakpoint to be hit
+            Task executeTask =
+                this.powerShellContext.ExecuteScriptString(
+                    variablesFile.FilePath);
+
+            await this.AssertDebuggerStopped(variablesFile.FilePath);
+
+            StackFrameDetails[] stackFrames = debugService.GetStackFrames();
+
+            VariableDetailsBase[] variables =
+                debugService.GetVariables(stackFrames[0].LocalVariables.Id);
+
+            var var = variables.FirstOrDefault(v => v.Name == "$procVar");
+            Assert.NotNull(var);
+            Assert.Equal("System.Diagnostics.Process (System)", var.ValueString);
+            Assert.True(var.IsExpandable);
+
+            var childVars = debugService.GetVariables(var.Id);
+            Assert.Equal(52, childVars.Length);
+
+            // Abort execution of the script
+            this.powerShellContext.AbortExecution();
+        }
+
         public async Task AssertDebuggerStopped(
             string scriptPath,
             int lineNumber = -1)