Add WriteInformation Method in AzurePSCmdlet (#408)

* add writeinformation method

* polish

* fix

* fix

* add WriteHighlightedInformation function

* remove hardcoded ansicode color theme

* polish

* suppress warning as error for vuluneribility

* Revert style change for intercept survey and add predefine ansi color

* Rename WriteStringInformation

* polish code

* fix comments

* Update src/Common/AzurePSCmdlet.cs

* Update src/Common/AzurePSCmdlet.cs

Author: BethanyZhou

src/Common/AzurePSCmdlet.cs

@@ -20,6 +20,7 @@
 using Microsoft.Azure.ServiceManagement.Common.Models;
 using Microsoft.WindowsAzure.Commands.Common;
 using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
+using Microsoft.WindowsAzure.Commands.Common.Properties;
 using Microsoft.WindowsAzure.Commands.Common.Utilities;
 using System;
 using System.Collections.Concurrent;
@@ -57,12 +58,6 @@ public abstract class AzurePSCmdlet : PSCmdlet, IDisposable
         protected IList<Regex> _matchers { get;  private set; }  = new List<Regex>();
         private static readonly Regex _defaultMatcher = new Regex("(\\s*\"access_token\"\\s*:\\s*)\"[^\"]+\"");
 
-        // Using Ansi Code to control font color(97(Bold White)) and background color(0;120;212(RGB))
-        private static readonly string ansiCodePrefix = "\u001b[97;48;2;0;120;212m";
-
-        // using '[k' for erase in line. '[0m' to ending ansi code
-        private static readonly string ansiCodeSuffix = "\u001b[K\u001b[0m";
-
         protected AzurePSDataCollectionProfile _dataCollectionProfile
         {
             get
@@ -463,40 +458,16 @@ protected bool IsVerbose()
 
         protected void WriteSurvey()
         {
-            HostInformationMessage newLine = new HostInformationMessage()
-            {
-                Message = ansiCodePrefix + "\n" + ansiCodeSuffix
-            };
-            HostInformationMessage howWas = new HostInformationMessage()
-            {
-                Message = ansiCodePrefix + "[Survey] Help us improve Azure PowerShell by sharing your experience. This survey should take about 5 minutes. Run "+ ansiCodeSuffix,
-                NoNewLine = true
-            };
-            HostInformationMessage link = new HostInformationMessage()
-            {
-                Message = ansiCodePrefix + "'Open-AzSurveyLink'"+ ansiCodeSuffix,
-                NoNewLine = true,
-            };
-            HostInformationMessage action = new HostInformationMessage()
-            {
-                Message = ansiCodePrefix + " to open in browser. Learn more at "+ ansiCodeSuffix,
-                NoNewLine = true,
-
-            };
-            HostInformationMessage website = new HostInformationMessage()
-            {
-                Message = ansiCodePrefix + "https://go.microsoft.com/fwlink/?linkid=2202892"+ ansiCodeSuffix,
-                NoNewLine = true,
-            };
-            WriteInformation(newLine, new string[] { "PSHOST" });
-            WriteInformation(howWas, new string[] { "PSHOST" });
-            WriteInformation(link, new string[] { "PSHOST" });
-            WriteInformation(action, new string[] { "PSHOST" });
-            WriteInformation(website, new string[] { "PSHOST" });
-            WriteInformation(newLine, new string[] { "PSHOST" });
-
-
+            // Using color same with Azure brand event. 
+            // Using Ansi Code to control font color(97(Bold White)) and background color(0;120;212(RGB))
+            string ansiCodePrefix = "\u001b[97;48;2;0;120;212m";
+            // using '[k' for erase in line. '[0m' to ending ansi code
+            string ansiCodeSuffix = "\u001b[K\u001b[0m";
+            var website = "https://go.microsoft.com/fwlink/?linkid=2202892";
+            WriteInformation(Environment.NewLine);
+            WriteInformation(ansiCodePrefix + string.Format(Resources.SurveyPreface, website) + ansiCodeSuffix, false);
         }
+
         protected new void WriteError(ErrorRecord errorRecord)
         {
             FlushDebugMessages();
@@ -551,6 +522,18 @@ protected void WriteSurvey()
             base.WriteWarning(text);
         }
 
+        protected new void WriteInformation(object messageData, string[] tags)
+        {
+            FlushDebugMessages();
+            base.WriteInformation(messageData, tags);
+        }
+
+        protected void WriteInformation(string text, bool? noNewLine = null)
+        {
+            HostInformationMessage message = new HostInformationMessage { Message = text, NoNewLine = noNewLine };
+            WriteInformation(message, new string[1] { "PSHOST" });
+        }
+
         protected new void WriteCommandDetail(string text)
         {
             FlushDebugMessages();
@@ -593,6 +576,16 @@ protected void WriteWarningWithTimestamp(string message)
             }
         }
 
+        protected void WriteInformationWithTimestamp(string message)
+        {
+            if (CommandRuntime != null)
+            {
+                WriteInformation(
+                    new HostInformationMessage { Message = string.Format("{0:T} - {1}", DateTime.Now, message), NoNewLine = false },
+                    new string[1] { "PSHOST" });
+            }
+        }
+
         protected void WriteDebugWithTimestamp(string message, params object[] args)
         {
             if (CommandRuntime != null)

src/Common/ColorAndFormat/PSStyle.cs

@@ -0,0 +1,56 @@
+// ----------------------------------------------------------------------------------
+//
+// Copyright Microsoft Corporation
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// ----------------------------------------------------------------------------------
+
+namespace Microsoft.WindowsAzure.Commands.Common
+{
+    /// <summary>
+    /// Contains configuration for how PowerShell renders text.
+    /// A subset of https://github.com/PowerShell/PowerShell/blob/f0076b9d883aa0ed07fb2a5c2be5f38f5d945e1e/src/System.Management.Automation/FormatAndOutput/common/PSStyle.cs#L173
+    /// </summary>
+    public sealed class PSStyle
+    {
+        /// <summary>
+        /// Contains background colors.
+        /// </summary>
+        public sealed class BackgroundColor
+        {
+            /// <summary>
+            /// Gets the color blue.
+            /// </summary>
+            public static string Blue { get; } = "\x1b[44m";
+        }
+
+        public static string Reset { get; } = "\x1b[0m";
+
+        /// <summary>
+        /// Gets value to turn off underlined.
+        /// </summary>
+        public static string UnderlineOff { get; } = "\x1b[24m";
+
+        /// <summary>
+        /// Gets value to turn on underlined.
+        /// </summary>
+        public static string Underline { get; } = "\x1b[4m";
+
+        /// <summary>
+        /// Gets value to turn off bold.
+        /// </summary>
+        public static string BoldOff { get; } = "\x1b[22m";
+
+        /// <summary>
+        /// Gets value to turn on bold.
+        /// </summary>
+        public static string Bold { get; } = "\x1b[1m";
+    }
+}

src/Common/Properties/Resources.Designer.cs

@@ -1757,4 +1757,7 @@ Note : Go to {0} for steps to suppress this breaking change warning, and other i
     <value>
 - The change is expected to take effect in {0} version : '{1}'</value>
   </data>
+  <data name="SurveyPreface" xml:space="preserve">
+    <value>[Survey] Help us improve Azure PowerShell by sharing your experience. This survey should take about 5 minutes. Run 'Open-AzSurveyLink' to open in browser. Learn more at {0}</value>
+  </data>
 </root>

src/Common/Properties/Resources.resx

@@ -3,7 +3,9 @@
   <PropertyGroup>
     <IncludeSource>True</IncludeSource>
     <IncludeSymbols>True</IncludeSymbols>
-    <SymbolPackageFormat>snupkg</SymbolPackageFormat>
+    <SymbolPackageFormat>snupkg</SymbolPackageFormat>    
+    <!-- Suppress known NuGet package vulnerabilities to unblock build as we track this kind of security issues internally. -->
+    <WarningsNotAsErrors>NU1901;NU1902;NU1903;NU1904</WarningsNotAsErrors>
   </PropertyGroup>
   <ItemGroup Condition="'$(OmitJsonPackage)' != 'true'">
     <PackageReference Include="Newtonsoft.Json" Version="13.0.2" />

src/Dependencies.targets

@@ -53,6 +53,7 @@ public abstract class AzureRMCmdlet : AzurePSCmdlet, IDynamicParameters
         public const string WriteDebugKey = "WriteDebug";
         public const string WriteVerboseKey = "WriteVerbose";
         public const string WriteWarningKey = "WriteWarning";
+        public const string WriteInformationKey = "WriteInformation";
         public const string EnqueueDebugKey = "EnqueueDebug";
         private const string SubscriptionIdParameter = "SubscriptionId";
 
@@ -240,7 +241,6 @@ private List<IAzureSubscription> CheckAccessToSubscriptions(IEnumerable<string>
             return subscriptionObjects;
         }
 
-
         private IAccessToken GetTokenForTenant(string tenantId)
         {
             return Utilities.SubscriptionAndTenantHelper.AcquireAccessToken(DefaultContext.Account,
@@ -597,6 +597,7 @@ public bool ShouldGetByName(string resourceGroupName, string name)
         private event EventHandler<StreamEventArgs> _writeDebugEvent;
         private event EventHandler<StreamEventArgs> _writeVerboseEvent;
         private event EventHandler<StreamEventArgs> _writeWarningEvent;
+        private event EventHandler<StreamEventArgs> _writeInformationEvent;
         private event EventHandler<StreamEventArgs> _enqueueDebugEvent;
 
         private void InitializeEventHandlers()
@@ -607,11 +608,14 @@ private void InitializeEventHandlers()
             _writeVerboseEvent += WriteVerboseSender;
             _writeWarningEvent -= WriteWarningSender;
             _writeWarningEvent += WriteWarningSender;
+            _writeInformationEvent -= WriteInformationSender;
+            _writeInformationEvent += WriteInformationSender;
             _enqueueDebugEvent -= EnqueueDebugSender;
             _enqueueDebugEvent += EnqueueDebugSender;
             AzureSession.Instance.RegisterComponent(WriteDebugKey, () => _writeDebugEvent, true);
             AzureSession.Instance.RegisterComponent(WriteVerboseKey, () => _writeVerboseEvent, true);
             AzureSession.Instance.RegisterComponent(WriteWarningKey, () => _writeWarningEvent, true);
+            AzureSession.Instance.RegisterComponent(WriteInformationKey, () => _writeInformationEvent, true);
             AzureSession.Instance.RegisterComponent(EnqueueDebugKey, () => _enqueueDebugEvent, true);
         }
 
@@ -630,6 +634,11 @@ private void WriteWarningSender(object sender, StreamEventArgs args)
             WriteWarningWithTimestamp(args.Message);
         }
 
+        private void WriteInformationSender(object sender, StreamEventArgs args)
+        {
+            WriteInformationWithTimestamp(args.Message);
+        }
+
         private void EnqueueDebugSender(object sender, StreamEventArgs args)
         {
             DebugMessages.Enqueue(args.Message);