Propagate error info from Hyper-V manager to the callers and telemetr…

…y for configuration operation
microsoft · Sep 14, 2024 · 4684e90 · 4684e90
1 parent 9e0592b
commit 4684e90
Show file tree

Hide file tree

Showing 11 changed files with 93 additions and 16 deletions.
diff --git a/...ns/HyperVExtension/src/HyperVExtension.HostGuestCommunication/ApplyConfigurationResult.cs b/...ns/HyperVExtension/src/HyperVExtension.HostGuestCommunication/ApplyConfigurationResult.cs
@@ -1,6 +1,8 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
+using System.Xml.Serialization;
+
 namespace HyperVExtension.HostGuestCommunication;
 
 // Helper class to convert from the DevSetupEngine COM types to the .NET types and use them
@@ -55,16 +57,19 @@ public ApplyConfigurationResult()
     {
     }
 
-    public ApplyConfigurationResult(int resultCode, string? resultDescription = null)
+    public ApplyConfigurationResult(int resultCode, string? resultDescription = null, string? resultDiagnosticText = null)
     {
         ResultCode = resultCode;
         ResultDescription = resultDescription ?? string.Empty;
+        ResultDiagnosticText = resultDiagnosticText ?? string.Empty;
     }
 
     public int ResultCode { get; set; }
 
     public string ResultDescription { get; set; } = string.Empty;
 
+    public string ResultDiagnosticText { get; set; } = string.Empty;
+
     public OpenConfigurationSetResult? OpenConfigurationSetResult { get; set; }
 
     public ApplyConfigurationSetResult? ApplyConfigurationSetResult { get; set; }

diff --git a/...HyperVExtension/src/HyperVExtension/CommunicationWithGuest/ApplyConfigurationOperation.cs b/...HyperVExtension/src/HyperVExtension/CommunicationWithGuest/ApplyConfigurationOperation.cs
@@ -192,7 +192,7 @@ private SDK.ConfigurationSetChangeData GetSdkProgressData(
                 return new SDK.ApplyConfigurationResult(sdkOpenConfigurationSetResult, sdkApplyConfigurationSetResult);
             }
 
-            var hresultException = new HResultException(completionStatus.ResultCode);
+            var hresultException = new HResultException(completionStatus.ResultCode, completionStatus.ResultDiagnosticText);
 
             return new SDK.ApplyConfigurationResult(hresultException, completionStatus.ResultDescription, hresultException.Message);
         }

diff --git a/extensions/HyperVExtension/src/HyperVExtension/Exceptions/HyperVManagerException.cs b/extensions/HyperVExtension/src/HyperVExtension/Exceptions/HyperVManagerException.cs
@@ -5,13 +5,15 @@ namespace HyperVExtension.Exceptions;
 
 public class HyperVManagerException : Exception
 {
-    public HyperVManagerException(string? message)
+    public HyperVManagerException(string? message, int hresult = 0)
         : base(message)
     {
+        HResult = hresult;
     }
 
     public HyperVManagerException(string? message, Exception? innerException)
     : base(message, innerException)
     {
+        HResult = innerException?.HResult ?? 0;
     }
 }
diff --git a/extensions/HyperVExtension/src/HyperVExtension/Models/HyperVVirtualMachine.cs b/extensions/HyperVExtension/src/HyperVExtension/Models/HyperVVirtualMachine.cs
@@ -621,7 +621,10 @@ public SDK.ApplyConfigurationResult ApplyConfiguration(ApplyConfigurationOperati
             var startResult = Start(string.Empty);
             if (startResult.Result.Status == ProviderOperationStatus.Failure)
             {
-                return operation.CompleteOperation(new HostGuestCommunication.ApplyConfigurationResult(startResult.Result.ExtendedError.HResult, startResult.Result.DisplayMessage));
+                return operation.CompleteOperation(new HostGuestCommunication.ApplyConfigurationResult(
+                    startResult.Result.ExtendedError.HResult,
+                    startResult.Result.DisplayMessage,
+                    startResult.Result.DiagnosticText));
             }
 
             using var guestSession = new GuestKvpSession(Guid.Parse(Id));

diff --git a/extensions/HyperVExtension/src/HyperVExtension/Models/IPowerShellSession.cs b/extensions/HyperVExtension/src/HyperVExtension/Models/IPowerShellSession.cs
@@ -37,4 +37,7 @@ public interface IPowerShellSession
 
     /// <summary> Gets the error messages associated with this instance of the PowerShell session. </summary>
     public string GetErrorMessages();
+
+    /// <summary> Gets the first error HRESULT associated with this instance of the PowerShell session. </summary>
+    public int GetErrorFirstHResult();
 }
diff --git a/extensions/HyperVExtension/src/HyperVExtension/Models/PowerShellResult.cs b/extensions/HyperVExtension/src/HyperVExtension/Models/PowerShellResult.cs
@@ -14,4 +14,7 @@ public class PowerShellResult : PowerShellResultBase
 
     /// <inheritdoc cref="PowerShellResultBase.CommandOutputErrorMessage"/>
     public override string CommandOutputErrorMessage { get; set; } = string.Empty;
+
+    /// <inheritdoc cref="PowerShellResultBase.CommandOutputErrorFirstHresult"/>
+    public override int CommandOutputErrorFirstHResult { get; set; }
 }
diff --git a/extensions/HyperVExtension/src/HyperVExtension/Models/PowerShellResultBase.cs b/extensions/HyperVExtension/src/HyperVExtension/Models/PowerShellResultBase.cs
@@ -22,4 +22,12 @@ public abstract class PowerShellResultBase
     /// in the PowerShell runspace. This is used for logging and debugging purposes.
     /// </remark>
     public abstract string CommandOutputErrorMessage { get; set; }
+
+    /// <summary> Gets or sets HRESULT from the first error return by PowerShell. </summary>
+    /// <remark>
+    /// This is the error HRESULT that is returned when the command returns an error
+    /// in the PowerShell runspace. PowerShell can return a list of exceptions. This is the HRESULT
+    /// from the first exception in the list. This is used for logging and debugging purposes.
+    /// </remark>
+    public abstract int CommandOutputErrorFirstHResult { get; set; }
 }
diff --git a/extensions/HyperVExtension/src/HyperVExtension/Models/PowerShellSession.cs b/extensions/HyperVExtension/src/HyperVExtension/Models/PowerShellSession.cs
@@ -3,6 +3,7 @@
 
 using System.Collections;
 using System.Collections.ObjectModel;
+using System.Globalization;
 using System.Management.Automation;
 
 namespace HyperVExtension.Models;
@@ -55,7 +56,30 @@ public void ClearSession()
     /// <inheritdoc cref="IPowerShellSession.GetErrorMessages"/>
     public string GetErrorMessages()
     {
-        return string.Join(Environment.NewLine, _powerShellSession.Streams.Error.Select(err => err.Exception.Message));
+        if (_powerShellSession.Streams.Error.Count > 0)
+        {
+            List<string> errors = new List<string>();
+            for (int i = 0; i < _powerShellSession.Streams.Error.Count; i++)
+            {
+                var exception = _powerShellSession.Streams.Error[i].Exception;
+                errors.Add($"{exception.Message} (0x{exception.HResult.ToString("X", CultureInfo.InvariantCulture)})");
+            }
+
+            return string.Join(Environment.NewLine, errors);
+        }
+
+        return string.Empty;
+    }
+
+    /// <inheritdoc cref="IPowerShellSession.GetErrorFirstHResult"/>
+    public int GetErrorFirstHResult()
+    {
+        if (_powerShellSession.Streams.Error.Count > 0)
+        {
+            return _powerShellSession.Streams.Error[0].Exception.HResult;
+        }
+
+        return 0;
     }
 
     protected virtual void Dispose(bool disposing)

diff --git a/extensions/HyperVExtension/src/HyperVExtension/Services/HyperVManager.cs b/extensions/HyperVExtension/src/HyperVExtension/Services/HyperVManager.cs
@@ -9,6 +9,7 @@
 using HyperVExtension.Models;
 using Microsoft.Extensions.Hosting;
 using Serilog;
+using Windows.Win32.Foundation;
 
 namespace HyperVExtension.Services;
 
@@ -136,7 +137,9 @@ public HyperVVirtualMachine GetVirtualMachine(Guid vmId)
 
             if (!string.IsNullOrEmpty(result.CommandOutputErrorMessage))
             {
-                throw new HyperVManagerException($"Unable to get VM with Id {vmId} due to PowerShell error: {result.CommandOutputErrorMessage}");
+                throw new HyperVManagerException(
+                    $"Unable to get VM with Id {vmId} due to PowerShell error: {result.CommandOutputErrorMessage}",
+                    result.CommandOutputErrorFirstHResult);
             }
 
             // If we found the VM there should only be one psObject in the list.
@@ -146,7 +149,9 @@ public HyperVVirtualMachine GetVirtualMachine(Guid vmId)
                 return _hyperVVirtualMachineFactory(psObject);
             }
 
-            throw new HyperVManagerException($"Unable to get VM with Id {vmId} due to PowerShell returning a null PsObject");
+            throw new HyperVManagerException(
+                $"Unable to get VM with Id {vmId} due to PowerShell returning a null PsObject",
+                HRESULT.E_UNEXPECTED);
         }
         finally
         {
@@ -188,7 +193,9 @@ public bool StopVirtualMachine(Guid vmId, StopVMKind stopVMKind)
 
             if (!string.IsNullOrEmpty(result.CommandOutputErrorMessage))
             {
-                throw new HyperVManagerException($"Unable to stop VM with Id {vmId} due to PowerShell error: {result.CommandOutputErrorMessage}");
+                throw new HyperVManagerException(
+                    $"Unable to stop VM with Id {vmId} due to PowerShell error: {result.CommandOutputErrorMessage}",
+                    result.CommandOutputErrorFirstHResult);
             }
 
             // The VM will be the returned object since we used the "PassThru" parameter.
@@ -229,7 +236,9 @@ public bool StartVirtualMachine(Guid vmId)
 
             if (!string.IsNullOrEmpty(result.CommandOutputErrorMessage))
             {
-                throw new HyperVManagerException($"Unable to start VM with Id {vmId} due to PowerShell error: {result.CommandOutputErrorMessage}");
+                throw new HyperVManagerException(
+                    $"Unable to start VM with Id {vmId} due to PowerShell error: {result.CommandOutputErrorMessage}",
+                    result.CommandOutputErrorFirstHResult);
             }
 
             // The VM will be the returned object since we used the "PassThru" parameter.
@@ -270,7 +279,9 @@ public bool PauseVirtualMachine(Guid vmId)
 
             if (!string.IsNullOrEmpty(result.CommandOutputErrorMessage))
             {
-                throw new HyperVManagerException($"Unable to pause VM with Id {vmId} due to PowerShell error: {result.CommandOutputErrorMessage}");
+                throw new HyperVManagerException(
+                    $"Unable to pause VM with Id {vmId} due to PowerShell error: {result.CommandOutputErrorMessage}",
+                    result.CommandOutputErrorFirstHResult);
             }
 
             // The VM will be the returned object since we used the "PassThru" parameter.
@@ -313,7 +324,9 @@ public bool ResumeVirtualMachine(Guid vmId)
 
             if (!string.IsNullOrEmpty(result.CommandOutputErrorMessage))
             {
-                throw new HyperVManagerException($"Unable to resume VM with Id {vmId} due to PowerShell error: {result.CommandOutputErrorMessage}");
+                throw new HyperVManagerException(
+                    $"Unable to resume VM with Id {vmId} due to PowerShell error: {result.CommandOutputErrorMessage}",
+                    result.CommandOutputErrorFirstHResult);
             }
 
             // The VM will be the returned object since we used the "PassThru" parameter.
@@ -356,7 +369,9 @@ public bool RemoveVirtualMachine(Guid vmId)
             var result = _powerShellService.Execute(commandLineStatements, PipeType.PipeOutput);
             if (!string.IsNullOrEmpty(result.CommandOutputErrorMessage))
             {
-                throw new HyperVManagerException($"Unable to remove VM with Id {vmId} due to PowerShell error: {result.CommandOutputErrorMessage}");
+                throw new HyperVManagerException(
+                    $"Unable to remove VM with Id {vmId} due to PowerShell error: {result.CommandOutputErrorMessage}",
+                    result.CommandOutputErrorFirstHResult);
             }
 
             // The VM will be the returned object since we used the "PassThru" parameter.
@@ -544,7 +559,7 @@ public bool CreateCheckpoint(Guid vmId)
             if (!string.IsNullOrEmpty(result.CommandOutputErrorMessage))
             {
                 throw new HyperVManagerException(
-                    $"Unable to create a new checkpoint for VM with Id: {vmId} due to PowerShell error: {result.CommandOutputErrorMessage}");
+                    $"Unable to create a new checkpoint for VM with Id: {vmId} due to PowerShell error: {result.CommandOutputErrorMessage}", result.CommandOutputErrorFirstHResult);
             }
 
             var newCheckpoint = result.PsObjects.FirstOrDefault();
@@ -587,7 +602,9 @@ public bool RestartVirtualMachine(Guid vmId)
 
             if (!string.IsNullOrEmpty(result.CommandOutputErrorMessage))
             {
-                throw new HyperVManagerException($"Unable to start VM with Id {vmId} due to PowerShell error: {result.CommandOutputErrorMessage}");
+                throw new HyperVManagerException(
+                    $"Unable to start VM with Id {vmId} due to PowerShell error: {result.CommandOutputErrorMessage}",
+                    result.CommandOutputErrorFirstHResult);
             }
 
             // The VM will be the returned object since we used the "PassThru" parameter.
@@ -644,7 +661,9 @@ public HyperVVirtualMachineHost GetVirtualMachineHost()
 
         if (!string.IsNullOrEmpty(result.CommandOutputErrorMessage))
         {
-            throw new HyperVManagerException($"Unable to get Local Hyper-V host: {result.CommandOutputErrorMessage}");
+            throw new HyperVManagerException(
+                $"Unable to get Local Hyper-V host: {result.CommandOutputErrorMessage}",
+                result.CommandOutputErrorFirstHResult);
         }
 
         // return the host object. It should be the only object in the list.
@@ -668,7 +687,9 @@ public HyperVVirtualMachine CreateVirtualMachineFromGallery(VirtualMachineCreati
         var result = _powerShellService.Execute(statementBuilderForNewVm, PipeType.None);
         if (!string.IsNullOrEmpty(result.CommandOutputErrorMessage))
         {
-            throw new HyperVManagerException($"Unable to create the virtual machine: {result.CommandOutputErrorMessage}");
+            throw new HyperVManagerException(
+                $"Unable to create the virtual machine: {result.CommandOutputErrorMessage}",
+                result.CommandOutputErrorFirstHResult);
         }
 
         var returnedPsObject = result.PsObjects.First();

diff --git a/extensions/HyperVExtension/src/HyperVExtension/Services/PowerShellService.cs b/extensions/HyperVExtension/src/HyperVExtension/Services/PowerShellService.cs
@@ -49,11 +49,13 @@ public PowerShellResult Execute(IEnumerable<PowerShellCommandlineStatement> comm
                 _powerShellSession.ClearSession();
                 var psObjectList = ExecuteStatements(commandLineStatements, pipeType);
                 var commandOutputErrorMessage = _powerShellSession.GetErrorMessages();
+                var hresult = _powerShellSession.GetErrorFirstHResult();
 
                 return new PowerShellResult
                 {
                     PsObjects = psObjectList,
                     CommandOutputErrorMessage = commandOutputErrorMessage,
+                    CommandOutputErrorFirstHResult = hresult,
                 };
             }
         }

diff --git a/extensions/HyperVExtension/test/HyperVExtension/Mocks/PowerShellSessionMock.cs b/extensions/HyperVExtension/test/HyperVExtension/Mocks/PowerShellSessionMock.cs
@@ -45,4 +45,10 @@ public string GetErrorMessages()
     {
         return ErrorText;
     }
+
+    /// <inheritdoc cref="IPowerShellSession.GetErrorFirstHResult"/>
+    public int GetErrorFirstHResult()
+    {
+        return 0;
+    }
 }