Merge pull request #3403 from cormacpayne/regenerate-cmdlets

Post-release serialization of cmdlets for breaking change tool

Author: cormacpayne

tools/StaticAnalysis/BreakingChangeAnalyzer/BreakingChangeAnalyzer.cs

@@ -84,33 +84,46 @@ public void Analyze(
 
                 foreach (var directory in probingDirectories)
                 {
-                    var index = Path.GetFileName(directory).IndexOf(".");
-                    var service = Path.GetFileName(directory).Substring(index + 1);
+                    var service = Path.GetFileName(directory);
 
-                    var helpFiles = Directory.EnumerateFiles(directory, "*.dll-Help.xml")
-                        .Where(f => !processedHelpFiles.Contains(Path.GetFileName(f),
-                            StringComparer.OrdinalIgnoreCase)).ToList();
+                    var manifestFiles = Directory.EnumerateFiles(directory, "*.psd1").ToList();
 
-                    if (helpFiles.Count > 1)
+                    if (manifestFiles.Count > 1)
                     {
-                        helpFiles = helpFiles.Where(f => Path.GetFileName(f).IndexOf(service) >= 0).ToList();
+                        manifestFiles = manifestFiles.Where(f => Path.GetFileName(f).IndexOf(service) >= 0).ToList();
                     }
 
-                    if (helpFiles.Any())
+                    if (manifestFiles.Count == 0)
                     {
-                        Directory.SetCurrentDirectory(directory);
-                        foreach (var helpFile in helpFiles)
+                        continue;
+                    }
+
+                    var psd1 = manifestFiles.FirstOrDefault();
+
+                    var parentDirectory = Directory.GetParent(psd1);
+                    var psd1FileName = Path.GetFileName(psd1);
+
+                    PowerShell powershell = PowerShell.Create();
+                    powershell.AddScript("Import-LocalizedData -BaseDirectory " + parentDirectory + 
+                                        " -FileName " + psd1FileName + 
+                                        " -BindingVariable ModuleMetadata; $ModuleMetadata.NestedModules");
+
+                    var cmdletResult = powershell.Invoke();
+                    var cmdletFiles = cmdletResult.Select(c => c.ToString().Substring(2));
+
+                    if (cmdletFiles.Any())
+                    {
+                        foreach (var cmdletFileName in cmdletFiles)
                         {
-                            var cmdletFile = helpFile.Substring(0, helpFile.Length - "-Help.xml".Length);
-                            var helpFileName = Path.GetFileName(helpFile);
-                            var cmdletFileName = Path.GetFileName(cmdletFile);
-                            if (File.Exists(cmdletFile))
+                            var cmdletFileFullPath = Path.Combine(directory, Path.GetFileName(cmdletFileName));
+                            
+                            if (File.Exists(cmdletFileFullPath))
                             {
-                                issueLogger.Decorator.AddDecorator(a => a.AssemblyFileName = cmdletFileName, "AssemblyFileName");
-                                processedHelpFiles.Add(helpFileName);
+                                issueLogger.Decorator.AddDecorator(a => a.AssemblyFileName = cmdletFileFullPath, "AssemblyFileName");
+                                processedHelpFiles.Add(cmdletFileName);
                                 var proxy = 
                                     EnvironmentHelpers.CreateProxy<CmdletBreakingChangeLoader>(directory, out _appDomain);
-                                var newModuleMetadata = proxy.GetModuleMetadata(cmdletFile);
+                                var newModuleMetadata = proxy.GetModuleMetadata(cmdletFileFullPath);
 
                                 string fileName = cmdletFileName + ".json";
                                 string executingPath = 
@@ -129,8 +142,28 @@ public void Analyze(
 
                                     if (cmdletFilter != null)
                                     {
+                                        string output = "Before filter\nOld module cmdlet count: " + oldModuleMetadata.Cmdlets.Count +
+                                                                     "\nNew module cmdlet count: " + newModuleMetadata.Cmdlets.Count;
+
+                                        output += "\nCmdlet file: " + cmdletFileFullPath;
+
                                         oldModuleMetadata.FilterCmdlets(cmdletFilter);
                                         newModuleMetadata.FilterCmdlets(cmdletFilter);
+
+                                        output += "\nAfter filter\nOld module cmdlet count: " + oldModuleMetadata.Cmdlets.Count +
+                                                                "\nNew module cmdlet count: " + newModuleMetadata.Cmdlets.Count;
+
+                                        foreach (var cmdlet in oldModuleMetadata.Cmdlets)
+                                        {
+                                            output += "\n\tOld cmdlet - " + cmdlet.Name;
+                                        }
+
+                                        foreach (var cmdlet in newModuleMetadata.Cmdlets)
+                                        {
+                                            output += "\n\tNew cmdlet - " + cmdlet.Name;
+                                        }
+
+                                        issueLogger.WriteMessage(output + "\n");
                                     }
 
                                     RunBreakingChangeChecks(oldModuleMetadata, newModuleMetadata, issueLogger);

tools/StaticAnalysis/BreakingChangeAnalyzer/CmdletBreakingChangeLoader.cs

@@ -160,8 +160,9 @@ public ModuleMetadata GetModuleMetadata(string assemblyPath)
                     results.Add(cmdletMetadata);
                 }
             }
-            catch
+            catch (Exception ex)
             {
+                throw ex;
             }
 
             ModuleMetadata.Cmdlets = results;

tools/StaticAnalysis/BreakingChangeAnalyzer/TypeMetadata.cs

@@ -129,7 +129,10 @@ public TypeMetadata(Type inputType)
                 }
 
                 // Add the property to the dictionary
-                _properties.Add(property.Name, propertyType.ToString());
+                if (!_properties.ContainsKey(property.Name))
+                {
+                    _properties.Add(property.Name, propertyType.ToString());
+                }
             }
         }
 

tools/StaticAnalysis/Exceptions/BreakingChangeIssues.csv

@@ -1,3 +1,2 @@
-"AssemblyFileName","ClassName","Target","Severity","ProblemId","Description","Remediation"
-"Microsoft.Azure.Commands.Sql.dll","Microsoft.Azure.Commands.Sql.Auditing.Cmdlet.RemoveSqlDatabaseAuditing","Remove-AzureRmSqlDatabaseAuditing","0","1010","The cmdlet 'Remove-AzureRmSqlDatabaseAuditing' no longer supports the alias 'Remove-AzureRmSqlDatabaseAuditing'.","Add the alias 'Remove-AzureRmSqlDatabaseAuditing back to the cmdlet 'Remove-AzureRmSqlDatabaseAuditing'."
-"Microsoft.Azure.Commands.Sql.dll","Microsoft.Azure.Commands.Sql.ImportExport.Cmdlet.NewAzureSqlDatabaseImport","New-AzureRmSqlDatabaseImport","0","2020","The cmdlet 'New-AzureRmSqlDatabaseImport' no longer supports the type 'Int32' for parameter 'DatabaseMaxSizeBytes'.","Change the type for parameter 'DatabaseMaxSizeBytes' back to 'Int32'."
+"AssemblyFileName","ClassName","Target","Severity","ProblemId","Description","Remediation"
+"Microsoft.Azure.Commands.Sql.dll","Microsoft.Azure.Commands.Sql.ImportExport.Cmdlet.NewAzureSqlDatabaseImport","New-AzureRmSqlDatabaseImport","0","2020","The cmdlet 'New-AzureRmSqlDatabaseImport' no longer supports the type 'Int32' for parameter 'DatabaseMaxSizeBytes'.","Change the type for parameter 'DatabaseMaxSizeBytes' back to 'Int32'."