Add module name to breaking changes (#405)

* Add module name to breaking changes

* format and refactor

* update from to in

Author: YanaXu

src/Common/CustomAttributes/BreakingChangeAttributeHelper.cs

@@ -89,7 +89,7 @@ public static void ProcessCustomAttributesAtRuntime(Type type, InvocationInfo in
 
                 foreach (GenericBreakingChangeWithVersionAttribute attribute in attributes)
                 {
-                    attribute.PrintCustomAttributeInfo(type, false, appendBreakingChangeInfo);
+                    attribute.PrintCustomAttributeInfo(type, false, invocationInfo?.MyCommand?.ModuleName, appendBreakingChangeInfo);
                 }
 
                 appendBreakingChangeInfo(string.Format(Resources.BreakingChangesAttributesFooterMessage, BREAKING_CHANGE_ATTRIBUTE_INFORMATION_LINK));
@@ -117,6 +117,20 @@ public static List<string> GetBreakingChangeMessagesForType(Type type)
             return messages;
         }
 
+        public static List<string> GetBreakingChangeMessagesForType(Type type, InvocationInfo invocationInfo)
+        {
+            List<string> messages = new List<string>();
+
+            //This is used as a migration guide, we need to process all properties/fields, moreover at this point of time we do not have a list of all the
+            //bound params anyways
+            foreach (GenericBreakingChangeWithVersionAttribute attribute in GetAllBreakingChangeAttributesInType(type, null))
+            {
+                messages.Add(attribute.GetBreakingChangeTextFromAttribute(type, true, invocationInfo?.MyCommand?.ModuleName));
+            }
+
+            return messages;
+        }
+
         /**
          * This function takes in a Type (expected to be a derevative of the AzurePSCmdlet)
          * And returns all the deprecation attributes attached to it

src/Common/CustomAttributes/GenericBreakingChangeWithVersionAttribute.cs

@@ -79,6 +79,16 @@ public DateTime getInEffectByDate()
          * We get the cmdlet name from the passed in Type (it is expected to have the Cmdlet attribute decorated on the class)
          */
         public string GetBreakingChangeTextFromAttribute(Type type, bool withCmdletName)
+        {
+            return GetBreakingChangeTextFromAttributeInternal(type, withCmdletName, null);
+        }
+
+        internal string GetBreakingChangeTextFromAttribute(Type type, bool withCmdletName, String moduleName)
+        {
+            return GetBreakingChangeTextFromAttributeInternal(type, withCmdletName, moduleName);
+        }
+
+        private string GetBreakingChangeTextFromAttributeInternal(Type type, bool withCmdletName, String moduleName)
         {
             StringBuilder breakingChangeMessage = new StringBuilder();
 
@@ -104,7 +114,14 @@ public string GetBreakingChangeTextFromAttribute(Type type, bool withCmdletName)
 
             if (!string.IsNullOrWhiteSpace(DeprecateByVersion))
             {
-                breakingChangeMessage.Append(string.Format(Resources.BreakingChangesAttributesInEffectByVersion, this.DeprecateByVersion));
+                if (moduleName != null)
+                {
+                    breakingChangeMessage.Append(string.Format(Resources.BreakingChangesAttributesInEffectByVersion2, moduleName, this.DeprecateByVersion));
+                }
+                else 
+                {
+                    breakingChangeMessage.Append(string.Format(Resources.BreakingChangesAttributesInEffectByVersion, this.DeprecateByVersion));
+                }
             }
 
             if (!string.IsNullOrWhiteSpace(OldWay) && !string.IsNullOrWhiteSpace(NewWay))
@@ -123,6 +140,16 @@ public string GetBreakingChangeTextFromAttribute(Type type, bool withCmdletName)
         * We get the cmdlet name from the passed in Type (it is expected to have the Cmdlet attribute decorated on the class)
         * */
         public void PrintCustomAttributeInfo(Type type, bool withCmdletName, Action<string> writeOutput)
+        {
+            PrintCustomAttributeInfoInternal(type, withCmdletName, null, writeOutput);
+        }
+
+        internal void PrintCustomAttributeInfo(Type type, bool withCmdletName, String moduleName, Action<string> writeOutput)
+        {
+            PrintCustomAttributeInfoInternal(type, withCmdletName, moduleName, writeOutput);
+        }
+
+        private void PrintCustomAttributeInfoInternal(Type type, bool withCmdletName, String moduleName, Action<string> writeOutput)
         {
             if (!withCmdletName)
             {
@@ -146,11 +173,18 @@ public void PrintCustomAttributeInfo(Type type, bool withCmdletName, Action<stri
             {
                 writeOutput(string.Format(Resources.BreakingChangesAttributesInEffectByDateMessage, this.ChangeInEffectByDate.ToShortDateString()));
             }
-            
+
             writeOutput(string.Format(Resources.BreakingChangesAttributesInEffectByAzVersion, this.DeprecateByAzVersion));
-            
-            writeOutput(string.Format(Resources.BreakingChangesAttributesInEffectByVersion, this.DeprecateByVersion));
-            
+
+            if (moduleName != null)
+            {
+                writeOutput(string.Format(Resources.BreakingChangesAttributesInEffectByVersion2, moduleName, this.DeprecateByVersion));
+            }
+            else 
+            {
+                writeOutput(string.Format(Resources.BreakingChangesAttributesInEffectByVersion, this.DeprecateByVersion));
+            }
+
             if (OldWay != null && NewWay != null)
             {
                 writeOutput(string.Format(Resources.BreakingChangesAttributesUsageChangeMessageConsole, OldWay, NewWay));

src/Common/Properties/Resources.Designer.cs

@@ -1702,7 +1702,7 @@ Use the Enable-AzureDataCollection cmdlet to turn the feature On. The cmdlet can
   </data>
   <data name="BreakingChangesAttributesInEffectByVersion" xml:space="preserve">
     <value>
-- The change is expected to take effect from version : '{0}'</value>
+- The change is expected to take effect in version : '{0}'</value>
   </data>
   <data name="BreakingChangesAttributesUsageChangeMessage" xml:space="preserve">
     <value>```powershell
@@ -1737,7 +1737,7 @@ Note : Go to {0} for steps to suppress this breaking change warning, and other i
   </data>
   <data name="BreakingChangesAttributesInEffectByAzVersion" xml:space="preserve">
     <value>
-- The change is expected to take effect from Az version : '{0}'</value>
+- The change is expected to take effect in Az version : '{0}'</value>
   </data>
   <data name="PreviewCmdletETAMessage" xml:space="preserve">
     <value> The estimated generally available date is '{0}'.</value>
@@ -1753,4 +1753,8 @@ Note : Go to {0} for steps to suppress this breaking change warning, and other i
   {3} {4} -WhatIf    -- Simulate updating your Az modules.
   {3} {4}            -- Update your Az modules.</value>
   </data>
+  <data name="BreakingChangesAttributesInEffectByVersion2" xml:space="preserve">
+    <value>
+- The change is expected to take effect in {0} version : '{1}'</value>
+  </data>
 </root>