Add Diagnostics and Warnings to Deployments WhatIf/Validate cmdlets (Azure#26732)

tsmallig33 · VeryEarly · web-flow · commit 9123a99fa2ea · 2024-11-21T13:24:16.000+08:00
* Add diagnostics to what if output

* Update ChangeLog.md

* Add unsupportedReason to diagnostics

* Add Diagnostics to TestDeployments

* Remove comments

* Update Test cmdlets to match WhatIf output

* Update with Environment.NewLine

* Update src/Resources/Resources/ChangeLog.md

---------

Co-authored-by: Tate Smalligan &lt;tasmalligan@microsoft.com&gt;
Co-authored-by: Yabo Hu &lt;yabhu@microsoft.com&gt;
diff --git a/src/Resources/ResourceManager/Extensions/DiagnosticExtensions.cs b/src/Resources/ResourceManager/Extensions/DiagnosticExtensions.cs
@@ -0,0 +1,32 @@
+﻿using Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.Deployments;
+using System;
+using System.Collections.Generic;
+using Microsoft.Azure.Commands.ResourceManager.Cmdlets.Formatters;
+using System.Text;
+using Microsoft.Azure.Management.Resources.Models;
+
+namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Extensions
+{
+    public static class DiagnosticExtensions
+    {
+        private static readonly IReadOnlyDictionary<string, Color> ColorsByDiagnosticLevel =
+            new Dictionary<string, Color>
+            {
+                [Level.Error] = Color.Red,
+                [Level.Warning] = Color.DarkYellow,
+                [Level.Info] = Color.Reset,
+            };
+
+        public static Color ToColor(this string level)
+        {
+            bool success = ColorsByDiagnosticLevel.TryGetValue(level, out Color colorCode);
+
+            if (!success)
+            {
+                return Color.Gray;
+            }
+
+            return colorCode;
+        }
+    }
+}
diff --git a/src/Resources/ResourceManager/Formatters/Color.cs b/src/Resources/ResourceManager/Formatters/Color.cs
@@ -34,6 +34,10 @@ public class Color : IEquatable<Color>
 
         public static Color Reset { get; } = new Color($"{Esc}[0m");
 
+        public static Color Red { get; } = new Color($"{Esc}[38;5;196m");
+
+        public static Color DarkYellow { get; } = new Color($"{Esc}[38;5;136m");
+
         private Color(string colorCode)
         {
             this.colorCode = colorCode;
diff --git a/src/Resources/ResourceManager/Formatters/WhatIfOperationResultFormatter.cs b/src/Resources/ResourceManager/Formatters/WhatIfOperationResultFormatter.cs
@@ -28,7 +28,7 @@ namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Formatters
 
     public class WhatIfOperationResultFormatter : WhatIfJsonFormatter
     {
-        private WhatIfOperationResultFormatter(ColoredStringBuilder builder)
+        public WhatIfOperationResultFormatter(ColoredStringBuilder builder)
             : base(builder)
         {
         }
@@ -47,6 +47,7 @@ public static string Format(PSWhatIfOperationResult result)
             formatter.FormatLegend(result.Changes);
             formatter.FormatResourceChanges(result.Changes);
             formatter.FormatStats(result.Changes);
+            formatter.FormatDiagnostics(result.Diagnostics, result.Changes);
 
             return builder.ToString();
         }
@@ -112,6 +113,45 @@ private void FormatStats(IList<PSWhatIfChange> resourceChanges)
             this.Builder.Append(".");
         }
 
+        public void FormatDiagnostics(IList<DeploymentDiagnosticsDefinition> diagnostics, IList<PSWhatIfChange> changes)
+        {
+            if (changes != null)
+            {
+                var unsupportedChanges = changes
+                    .Where(c => c.ChangeType == ChangeType.Unsupported)
+                    .ToList();
+
+                if (diagnostics == null)
+                {
+                    diagnostics = new List<DeploymentDiagnosticsDefinition>();
+                }
+                foreach (var change in unsupportedChanges)
+                {
+                    diagnostics.Add(new DeploymentDiagnosticsDefinition(level: Level.Warning, code: "Unsupported", message: change.UnsupportedReason, target: change.FullyQualifiedResourceId));
+                }
+            }
+            
+            if (diagnostics == null || diagnostics.Count == 0)
+            {
+                return;
+            }
+
+            this.Builder.AppendLine().AppendLine();
+
+            this.Builder.Append($"Diagnostics ({diagnostics.Count}): ").AppendLine();
+            
+            diagnostics.ForEach(d =>
+            {
+                using (this.Builder.NewColorScope(DiagnosticExtensions.ToColor(d.Level)))
+                {
+                    this.Builder.Append($"({d.Target})").Append(Symbol.WhiteSpace);
+                    this.Builder.Append(d.Message).Append(Symbol.WhiteSpace);
+                    this.Builder.Append($"({d.Code})");
+                    this.Builder.AppendLine();
+                }
+            });
+        }
+
         private string FormatChangeTypeCount(ChangeType changeType, int count)
         {
             switch (changeType)
@@ -141,7 +181,6 @@ private void FormatLegend(IList<PSWhatIfChange> resourceChanges)
             {
                 return;
             }
-
             var psChangeTypeSet = new HashSet<PSChangeType>();
 
             void PopulateChangeTypeSet(IList<PSWhatIfPropertyChange> propertyChanges)
diff --git a/src/Resources/ResourceManager/Implementation/CmdletBase/TestDeploymentCmdletBase.cs b/src/Resources/ResourceManager/Implementation/CmdletBase/TestDeploymentCmdletBase.cs
@@ -1,7 +1,10 @@
 ﻿using System;
+using System.Collections.Generic;
+using System.Linq;
 using System.Management.Automation;
 using Microsoft.Azure.Commands.Common.Strategies;
 using Microsoft.Azure.Commands.ResourceManager.Cmdlets.Formatters;
+using Microsoft.Azure.Commands.ResourceManager.Cmdlets.NewSdkExtensions;
 using Microsoft.Azure.Commands.ResourceManager.Cmdlets.Properties;
 using Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels;
 using Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.Deployments;
@@ -23,5 +26,23 @@ public override object GetDynamicParameters()
             return base.GetDynamicParameters();
         }
 
+        public void WriteOutput(TemplateValidationInfo validationInfo)
+        {
+            if (validationInfo.Errors.Count == 0)
+            {
+                var builder = new ColoredStringBuilder();
+
+                var formatter = new WhatIfOperationResultFormatter(builder);
+
+                formatter.FormatDiagnostics(validationInfo.Diagnostics, new List<PSWhatIfChange>());
+
+                WriteObject(builder.ToString());
+            }
+            else
+            {
+                WriteObject(validationInfo.Errors.Select(e => e.ToPSResourceManagerError()).ToList());
+            }
+        }
+
     }
 }
diff --git a/src/Resources/ResourceManager/Implementation/Deployments/TestAzureManagementGroupDeploymentCmdlet.cs b/src/Resources/ResourceManager/Implementation/Deployments/TestAzureManagementGroupDeploymentCmdlet.cs
@@ -58,7 +58,9 @@ protected override void OnProcessRecord()
                 ParameterUri = this.TemplateParameterUri
             };
 
-            WriteObject(NewResourceManagerSdkClient.ValidateDeployment(parameters));
+            var validationInfo = NewResourceManagerSdkClient.ValidateDeployment(parameters);
+
+            WriteOutput(validationInfo);
         }
     }
 }
diff --git a/src/Resources/ResourceManager/Implementation/Deployments/TestAzureSubscriptionDeploymentCmdlet.cs b/src/Resources/ResourceManager/Implementation/Deployments/TestAzureSubscriptionDeploymentCmdlet.cs
@@ -54,7 +54,9 @@ protected override void OnProcessRecord()
                 ParameterUri = TemplateParameterUri
             };
 
-            WriteObject(NewResourceManagerSdkClient.ValidateDeployment(parameters));
+            var validationInfo = NewResourceManagerSdkClient.ValidateDeployment(parameters);
+
+            WriteOutput(validationInfo);
         }
     }
 }
diff --git a/src/Resources/ResourceManager/Implementation/Deployments/TestAzureTenantDeploymentCmdlet.cs b/src/Resources/ResourceManager/Implementation/Deployments/TestAzureTenantDeploymentCmdlet.cs
@@ -54,7 +54,9 @@ protected override void OnProcessRecord()
                 ParameterUri = this.TemplateParameterUri
             };
 
-            WriteObject(NewResourceManagerSdkClient.ValidateDeployment(parameters));
+            var validationInfo = NewResourceManagerSdkClient.ValidateDeployment(parameters);
+
+            WriteOutput(validationInfo);
         }
     }
 }
diff --git a/src/Resources/ResourceManager/Implementation/ResourceGroupDeployments/TestAzureResourceGroupDeploymentCmdlet.cs b/src/Resources/ResourceManager/Implementation/ResourceGroupDeployments/TestAzureResourceGroupDeploymentCmdlet.cs
@@ -79,7 +79,9 @@ protected override void OnProcessRecord()
                     : null
             };
 
-            WriteObject(NewResourceManagerSdkClient.ValidateDeployment(parameters));
+            var validationInfo = NewResourceManagerSdkClient.ValidateDeployment(parameters);
+
+            WriteOutput(validationInfo);
         }
     }
 }
diff --git a/src/Resources/ResourceManager/SdkClient/NewResourceManagerSdkClient.cs b/src/Resources/ResourceManager/SdkClient/NewResourceManagerSdkClient.cs
@@ -491,17 +491,17 @@ private TemplateValidationInfo GetTemplateValidationResult(PSDeploymentCmdletPar
                 switch (validationResult)
                 {
                     case DeploymentExtended deploymentExtended:
-                        return new TemplateValidationInfo(deploymentExtended.Properties?.Providers?.ToList() ?? new List<Provider>(), new List<ErrorDetail>());
+                        return new TemplateValidationInfo(deploymentExtended.Properties?.Providers?.ToList() ?? new List<Provider>(), new List<ErrorDetail>(), deploymentExtended.Properties?.Diagnostics?.ToList() ?? new List<DeploymentDiagnosticsDefinition>());
                     case DeploymentValidationError deploymentValidationError:
-                        return new TemplateValidationInfo(new List<Provider>(), new List<ErrorDetail>(deploymentValidationError.Error.AsArray()));
+                        return new TemplateValidationInfo(new List<Provider>(), new List<ErrorDetail>(deploymentValidationError.Error.AsArray()), new List<DeploymentDiagnosticsDefinition>());
                     default:
                         throw new InvalidOperationException($"Received unexpected type {validationResult.GetType()}");
                 }
             }
             catch (Exception ex)
             {
                 var error = HandleError(ex).FirstOrDefault();
-                return new TemplateValidationInfo(new List<Provider>(), error.AsArray().ToList());
+                return new TemplateValidationInfo(new List<Provider>(), error.AsArray().ToList(), new List<DeploymentDiagnosticsDefinition>());
             }
         }
 
@@ -1716,8 +1716,8 @@ private void CancelDeploymentAtResourceGroup(List<PSDeployment> deployments, str
         /// Validates a given deployment.
         /// </summary>
         /// <param name="parameters">The deployment create options</param>
-        /// <returns>The validation errors if there's any, or empty list otherwise.</returns>
-        public virtual List<PSResourceManagerError> ValidateDeployment(PSDeploymentCmdletParameters parameters)
+        /// <returns>The validation info</returns>
+        public virtual TemplateValidationInfo ValidateDeployment(PSDeploymentCmdletParameters parameters)
         {
             if (parameters.DeploymentName == null)
             {
@@ -1731,7 +1731,7 @@ public virtual List<PSResourceManagerError> ValidateDeployment(PSDeploymentCmdle
             {
                 WriteVerbose(ProjectResources.TemplateValid);
             }
-            return validationInfo.Errors.Select(e => e.ToPSResourceManagerError()).ToList();
+            return validationInfo;
         }
 
         public string GetDeploymentErrorMessagesWithOperationId(DeploymentOperationErrorInfo errorInfo, string deploymentName = null, string correlationId = null)
diff --git a/src/Resources/ResourceManager/SdkModels/Deployments/PSWhatIfChange.cs b/src/Resources/ResourceManager/SdkModels/Deployments/PSWhatIfChange.cs
@@ -41,6 +41,7 @@ public PSWhatIfChange(WhatIfChange whatIfChange)
             (string scope, string relativeResourceId) = ResourceIdUtility.SplitResourceId(whatIfChange.ResourceId);
             this.Scope = scope;
             this.RelativeResourceId = relativeResourceId;
+            this.UnsupportedReason = whatIfChange.UnsupportedReason;
 
             this.apiVersion = new Lazy<string>(() =>
                 this.Before?["apiVersion"]?.Value<string>() ?? this.After?["apiVersion"]?.Value<string>());
@@ -54,6 +55,8 @@ public PSWhatIfChange(WhatIfChange whatIfChange)
 
         public string RelativeResourceId { get; }
 
+        public string UnsupportedReason { get; }
+
         public string FullyQualifiedResourceId => this.whatIfChange.ResourceId;
 
         public ChangeType ChangeType => this.whatIfChange.ChangeType;
diff --git a/src/Resources/ResourceManager/SdkModels/Deployments/PSWhatIfDiagnostic.cs b/src/Resources/ResourceManager/SdkModels/Deployments/PSWhatIfDiagnostic.cs
@@ -0,0 +1,27 @@
+﻿using Microsoft.Azure.Management.Resources.Models;
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.Deployments
+{
+    public class PSWhatIfDiagnostic
+    {
+        public string Code { get; set; }
+
+        public string Message { get; set; }
+
+        public string Severity { get; set; }
+
+        public string Target { get; set; }
+
+        public string Details { get; set; }
+
+        public PSWhatIfDiagnostic(DeploymentDiagnosticsDefinition deploymentDiagnosticsDefinition)
+        {
+            this.Code = deploymentDiagnosticsDefinition.Code;
+            this.Message = deploymentDiagnosticsDefinition.Message;
+            this.Target = deploymentDiagnosticsDefinition.Target;
+        }
+    }
+}
diff --git a/src/Resources/ResourceManager/SdkModels/Deployments/PSWhatIfOperationResult.cs b/src/Resources/ResourceManager/SdkModels/Deployments/PSWhatIfOperationResult.cs
@@ -18,24 +18,31 @@ namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.Deployments
     using System.Collections.Generic;
     using System.Linq;
     using Management.Resources.Models;
+    using Newtonsoft.Json.Linq;
 
     public class PSWhatIfOperationResult
     {
         private readonly WhatIfOperationResult whatIfOperationResult;
 
         private readonly Lazy<IList<PSWhatIfChange>> changes;
 
+        private readonly Lazy<IList<DeploymentDiagnosticsDefinition>> diagnostics;
+
         public PSWhatIfOperationResult(WhatIfOperationResult whatIfOperationResult)
         {
             this.whatIfOperationResult = whatIfOperationResult;
             this.changes = new Lazy<IList<PSWhatIfChange>>(() =>
                 whatIfOperationResult.Changes?.Select(c => new PSWhatIfChange(c)).ToList());
+            this.diagnostics = new Lazy<IList<DeploymentDiagnosticsDefinition>>(() =>
+                whatIfOperationResult.Diagnostics);
         }
 
         public string Status => this.whatIfOperationResult.Status;
 
         public ErrorResponse Error => this.whatIfOperationResult.Error;
 
         public IList<PSWhatIfChange> Changes => this.changes.Value;
+
+        public IList<DeploymentDiagnosticsDefinition> Diagnostics => this.diagnostics.Value;
     }
 }
diff --git a/src/Resources/ResourceManager/SdkModels/Deployments/TemplateValidationInfo.cs b/src/Resources/ResourceManager/SdkModels/Deployments/TemplateValidationInfo.cs
@@ -17,16 +17,19 @@
 
 namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels
 {
-    internal class TemplateValidationInfo
+    public class TemplateValidationInfo
     {
-        public TemplateValidationInfo(List<Provider> requiredProviders, List<ErrorDetail> errors)
+        public TemplateValidationInfo(List<Provider> requiredProviders, List<ErrorDetail> errors, List<DeploymentDiagnosticsDefinition> diagnostics)
         {
             Errors = errors;
             RequiredProviders = requiredProviders;
+            Diagnostics = diagnostics;
         }
 
         public List<ErrorDetail> Errors { get; set; }
 
         public List<Provider> RequiredProviders { get; set; }
+
+        public List<DeploymentDiagnosticsDefinition> Diagnostics { get; set; }
     }
 }
diff --git a/src/Resources/Resources.Test/Formatters/WhatIfOperationResultFormatterTests.cs b/src/Resources/Resources.Test/Formatters/WhatIfOperationResultFormatterTests.cs
diff --git a/src/Resources/Resources.Test/Models.ResourceGroups/ResourceClientTests.cs b/src/Resources/Resources.Test/Models.ResourceGroups/ResourceClientTests.cs
diff --git a/src/Resources/Resources.Test/ResourceGroupDeployments/TestAzureResourceGroupDeploymentCommandTests.cs b/src/Resources/Resources.Test/ResourceGroupDeployments/TestAzureResourceGroupDeploymentCommandTests.cs
diff --git a/src/Resources/Resources/ChangeLog.md b/src/Resources/Resources/ChangeLog.md

Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,10 @@ public class Color : IEquatable<Color>`
`34`	`34`
`35`	`35`	`public static Color Reset { get; } = new Color($"{Esc}[0m");`
`36`	`36`
	`37`	`+ public static Color Red { get; } = new Color($"{Esc}[38;5;196m");`
	`38`	`+`
	`39`	`+ public static Color DarkYellow { get; } = new Color($"{Esc}[38;5;136m");`
	`40`	`+`
`37`	`41`	`private Color(string colorCode)`
`38`	`42`	`{`
`39`	`43`	`this.colorCode = colorCode;`
Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,9 @@ protected override void OnProcessRecord()`
`58`	`58`	`ParameterUri = this.TemplateParameterUri`
`59`	`59`	`};`
`60`	`60`
`61`		`- WriteObject(NewResourceManagerSdkClient.ValidateDeployment(parameters));`
	`61`	`+ var validationInfo = NewResourceManagerSdkClient.ValidateDeployment(parameters);`
	`62`	`+`
	`63`	`+ WriteOutput(validationInfo);`
`62`	`64`	`}`
`63`	`65`	`}`
`64`	`66`	`}`
Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,9 @@ protected override void OnProcessRecord()`
`54`	`54`	`ParameterUri = TemplateParameterUri`
`55`	`55`	`};`
`56`	`56`
`57`		`- WriteObject(NewResourceManagerSdkClient.ValidateDeployment(parameters));`
	`57`	`+ var validationInfo = NewResourceManagerSdkClient.ValidateDeployment(parameters);`
	`58`	`+`
	`59`	`+ WriteOutput(validationInfo);`
`58`	`60`	`}`
`59`	`61`	`}`
`60`	`62`	`}`
Original file line number	Diff line number	Diff line change
`@@ -79,7 +79,9 @@ protected override void OnProcessRecord()`
`79`	`79`	`: null`
`80`	`80`	`};`
`81`	`81`
`82`		`- WriteObject(NewResourceManagerSdkClient.ValidateDeployment(parameters));`
	`82`	`+ var validationInfo = NewResourceManagerSdkClient.ValidateDeployment(parameters);`
	`83`	`+`
	`84`	`+ WriteOutput(validationInfo);`
`83`	`85`	`}`
`84`	`86`	`}`
`85`	`87`	`}`
Original file line number	Diff line number	Diff line change
`@@ -491,17 +491,17 @@ private TemplateValidationInfo GetTemplateValidationResult(PSDeploymentCmdletPar`
`491`	`491`	`switch (validationResult)`
`492`	`492`	`{`
`493`	`493`	`case DeploymentExtended deploymentExtended:`
`494`		`- return new TemplateValidationInfo(deploymentExtended.Properties?.Providers?.ToList() ?? new List<Provider>(), new List<ErrorDetail>());`
	`494`	`+ return new TemplateValidationInfo(deploymentExtended.Properties?.Providers?.ToList() ?? new List<Provider>(), new List<ErrorDetail>(), deploymentExtended.Properties?.Diagnostics?.ToList() ?? new List<DeploymentDiagnosticsDefinition>());`
`495`	`495`	`case DeploymentValidationError deploymentValidationError:`
`496`		`- return new TemplateValidationInfo(new List<Provider>(), new List<ErrorDetail>(deploymentValidationError.Error.AsArray()));`
	`496`	`+ return new TemplateValidationInfo(new List<Provider>(), new List<ErrorDetail>(deploymentValidationError.Error.AsArray()), new List<DeploymentDiagnosticsDefinition>());`
`497`	`497`	`default:`
`498`	`498`	`throw new InvalidOperationException($"Received unexpected type {validationResult.GetType()}");`
`499`	`499`	`}`
`500`	`500`	`}`
`501`	`501`	`catch (Exception ex)`
`502`	`502`	`{`
`503`	`503`	`var error = HandleError(ex).FirstOrDefault();`
`504`		`- return new TemplateValidationInfo(new List<Provider>(), error.AsArray().ToList());`
	`504`	`+ return new TemplateValidationInfo(new List<Provider>(), error.AsArray().ToList(), new List<DeploymentDiagnosticsDefinition>());`
`505`	`505`	`}`
`506`	`506`	`}`
`507`	`507`
`@@ -1716,8 +1716,8 @@ private void CancelDeploymentAtResourceGroup(List<PSDeployment> deployments, str`
`1716`	`1716`	`/// Validates a given deployment.`
`1717`	`1717`	`/// </summary>`
`1718`	`1718`	`/// <param name="parameters">The deployment create options</param>`
`1719`		`- /// <returns>The validation errors if there's any, or empty list otherwise.</returns>`
`1720`		`- public virtual List<PSResourceManagerError> ValidateDeployment(PSDeploymentCmdletParameters parameters)`
	`1719`	`+ /// <returns>The validation info</returns>`
	`1720`	`+ public virtual TemplateValidationInfo ValidateDeployment(PSDeploymentCmdletParameters parameters)`
`1721`	`1721`	`{`
`1722`	`1722`	`if (parameters.DeploymentName == null)`
`1723`	`1723`	`{`
`@@ -1731,7 +1731,7 @@ public virtual List<PSResourceManagerError> ValidateDeployment(PSDeploymentCmdle`
`1731`	`1731`	`{`
`1732`	`1732`	`WriteVerbose(ProjectResources.TemplateValid);`
`1733`	`1733`	`}`
`1734`		`- return validationInfo.Errors.Select(e => e.ToPSResourceManagerError()).ToList();`
	`1734`	`+ return validationInfo;`
`1735`	`1735`	`}`
`1736`	`1736`
`1737`	`1737`	`public string GetDeploymentErrorMessagesWithOperationId(DeploymentOperationErrorInfo errorInfo, string deploymentName = null, string correlationId = null)`