Merge pull request #7675 from cormacpayne/renamed-param-fix

Fix bug in StaticAnalysis that threw when renaming a parameter

Author: markcowl

tools/StaticAnalysis/BreakingChangeAnalyzer/ParameterSetMetadataHelper.cs

@@ -13,6 +13,7 @@
 // ----------------------------------------------------------------------------------
 
 using System.Collections.Generic;
+using System.Linq;
 using Tools.Common.Loggers;
 using Tools.Common.Models;
 
@@ -115,7 +116,8 @@ public void CompareParameterSetMetadata(
                     bool foundAdditional = false;
                     foreach (var parameter in newParameterSet.Parameters)
                     {
-                        if (parameterDictionary.ContainsKey(parameter.ParameterMetadata.Name))
+                        if (parameterDictionary.ContainsKey(parameter.ParameterMetadata.Name) ||
+                            parameter.ParameterMetadata.AliasList.Any(a => parameterDictionary.ContainsKey(a)))
                         {
                             continue;
                         }

tools/StaticAnalysis/Exceptions/Az.Profile/BreakingChangeIssues.csv

@@ -1,3 +1 @@
-"AssemblyFileName","ClassName","Target","Severity","ProblemId","Description","Remediation"
-"Microsoft.Azure.Commands.Profile.dll","Microsoft.Azure.Commands.Profile.ConnectAzureRmAccountCommand","Connect-AzureRmAccount","0","1050","The parameter set 'ServicePrincipalWithSubscriptionId' for cmdlet 'Connect-AzureRmAccount' has been removed.","Add parameter set 'ServicePrincipalWithSubscriptionId' back to cmdlet 'Connect-AzureRmAccount'."
-"Microsoft.Azure.Commands.Profile.dll","Microsoft.Azure.Commands.Profile.ConnectAzureRmAccountCommand","Connect-AzureRmAccount","0","1050","The parameter set 'ServicePrincipalCertificateWithSubscriptionId' for cmdlet 'Connect-AzureRmAccount' has been removed.","Add parameter set 'ServicePrincipalCertificateWithSubscriptionId' back to cmdlet 'Connect-AzureRmAccount'."
+"AssemblyFileName","ClassName","Target","Severity","ProblemId","Description","Remediation"

tools/StaticAnalysis/Exceptions/AzureRM.Profile/BreakingChangeIssues.csv

@@ -1,3 +1 @@
-"AssemblyFileName","ClassName","Target","Severity","ProblemId","Description","Remediation"
-"Microsoft.Azure.Commands.Profile.dll","Microsoft.Azure.Commands.Profile.ConnectAzureRmAccountCommand","Connect-AzureRmAccount","0","1050","The parameter set 'ServicePrincipalWithSubscriptionId' for cmdlet 'Connect-AzureRmAccount' has been removed.","Add parameter set 'ServicePrincipalWithSubscriptionId' back to cmdlet 'Connect-AzureRmAccount'."
-"Microsoft.Azure.Commands.Profile.dll","Microsoft.Azure.Commands.Profile.ConnectAzureRmAccountCommand","Connect-AzureRmAccount","0","1050","The parameter set 'ServicePrincipalCertificateWithSubscriptionId' for cmdlet 'Connect-AzureRmAccount' has been removed.","Add parameter set 'ServicePrincipalCertificateWithSubscriptionId' back to cmdlet 'Connect-AzureRmAccount'."
+"AssemblyFileName","ClassName","Target","Severity","ProblemId","Description","Remediation"

tools/StaticAnalysis/StaticAnalysis.Test/BreakingChangeAnalyzerTests.cs

@@ -832,5 +832,19 @@ public void ChangeValidateRangeMaximum()
                 .Where<int>((problemId) => problemId.Equals(BreakingChangeProblemId.ChangedValidateRangeMaximum))
                             .SingleOrDefault<int>().Equals(BreakingChangeProblemId.ChangedValidateRangeMaximum));
         }
+
+        [Fact]
+        [Trait(Category.AcceptanceType, Category.CheckIn)]
+        public void ParameterReplacedByAlias()
+        {
+            cmdletBreakingChangeAnalyzer.Analyze(
+                new List<string> { _testCmdletDirPath },
+                ((dirList) => { return new List<string> { _testCmdletDirPath }; }),
+                (cmdletName) => cmdletName.Equals("Test-ParameterReplacedByAlias", StringComparison.OrdinalIgnoreCase));
+
+            AnalysisReport testReport = cmdletBreakingChangeAnalyzer.GetAnalysisReport();
+
+            Assert.Equal(0, testReport.ProblemIdList.Count);
+        }
     }
 }

tools/StaticAnalysis/StaticAnalysis.Test/TestCmdlets/BreakingChangeAnalyzer_Cmdlet.cs

@@ -477,7 +477,7 @@ namespace StaticAnalysis.Test.CmdletTest.BreakingChange.ChangeOutputGenericTypeA
     using System.Collections.Generic;
     using System.Management.Automation;
 
-    [Cmdlet(VerbsDiagnostic.Test, "ChangeOutputGenericTypeArgument"), OutputType(typeof(string))]
+    [Cmdlet(VerbsDiagnostic.Test, "ChangeOutputGenericTypeArgument"), OutputType(typeof(List<string>))]
     public class TestChangeOutputGenericTypeArgument : Cmdlet
     {
         protected override void BeginProcessing()
@@ -758,4 +758,24 @@ protected override void BeginProcessing()
             WriteInformation("Info", null);
         }
     }
+}
+
+namespace StaticAnalysis.Test.CmdletTest.BreakingChange.ParameterReplacedByAlias
+{
+    using System.Collections.Generic;
+    using System.Management.Automation;
+
+    [Cmdlet(VerbsDiagnostic.Test, "ParameterReplacedByAlias")]
+    public class TestDifferentGenericTypeArgumentSize : Cmdlet
+    {
+        [Parameter(Mandatory = true)]
+        [Alias("Parameter")]
+        public string Param { get; set; }
+
+        protected override void BeginProcessing()
+        {
+            WriteObject("Test-ParameterReplacedByAlias BeginProcessing()");
+            WriteInformation("Info", null);
+        }
+    }
 }