Merge pull request #4048 from cormacpayne/sign-fix

Fix breaking change tool failures during sign job

Author: markcowl

tools/StaticAnalysis/BreakingChangeAnalyzer/CmdletMetadataHelper.cs

@@ -16,6 +16,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Text;
+using System.Text.RegularExpressions;
 using System.Threading.Tasks;
 
 namespace StaticAnalysis.BreakingChangeAnalyzer
@@ -215,7 +216,7 @@ private void CheckForChangedOutputType(
             ReportLogger<BreakingChangeIssue> issueLogger)
         {
             // This dictionary will map an output type name to the corresponding type metadata
-            Dictionary<string, TypeMetadata> outputDictionary = new Dictionary<string, TypeMetadata>();
+            Dictionary<string, TypeMetadata> outputDictionary = new Dictionary<string, TypeMetadata>(new TypeNameComparer());
 
             // Add each output in the new metadata to the dictionary
             foreach (var newOutput in newCmdlet.OutputTypes)
@@ -312,5 +313,25 @@ private void CheckDefaultParameterName(
                 }
             }
         }
+
+        /// <summary>
+        /// Comparer for assebly qualified names.  Parses of the PublicKeyToken, so that types from signed and unsigned assemblies match 
+        /// </summary>
+        class TypeNameComparer : IEqualityComparer<string>
+        {
+            Regex keyToken = new Regex(@", PublicKeyToken=\w+");
+            public bool Equals(string x, string y)
+            {
+                var newX = keyToken.Replace(x, "");
+                var newY = keyToken.Replace(y, "");
+                return StringComparer.OrdinalIgnoreCase.Equals(newX, newY);
+            }
+
+            public int GetHashCode(string obj)
+            {
+                var newObj = keyToken.Replace(obj, "");
+                return StringComparer.OrdinalIgnoreCase.GetHashCode(newObj);
+            }
+        }
     }
 }

tools/StaticAnalysis/StaticAnalysis.Test/BreakingChangeAnalyzerTests.cs

@@ -1,5 +1,7 @@
-using StaticAnalysis.ProblemIds;
+using StaticAnalysis.BreakingChangeAnalyzer;
+using StaticAnalysis.ProblemIds;
 using System;
+using System.Collections;
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;
@@ -856,5 +858,53 @@ public void ChangeValidateRangeMaximum()
                 .Where<int>((problemId) => problemId.Equals(BreakingChangeProblemId.ChangedValidateRangeMaximum))
                             .SingleOrDefault<int>().Equals(BreakingChangeProblemId.ChangedValidateRangeMaximum));
         }
+
+        [Fact]
+        [Trait(Category.AcceptanceType, Category.CheckIn)]
+        public void CheckDifferentPublicKeyToken()
+        {
+            TypeMetadata unsignedType = new TypeMetadata()
+            {
+                AssemblyQualifiedName = "StaticAnalysis.Test.BreakingChangeAnalyzerTests, StaticAnalysis.Test, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
+            };
+            TypeMetadata signedType = new TypeMetadata()
+            {
+                AssemblyQualifiedName = "StaticAnalysis.Test.BreakingChangeAnalyzerTests, StaticAnalysis.Test, Version=1.0.0.0, Culture=neutral, PublicKeyToken=h1ccnwzjxvldu787"
+            };
+
+            OutputMetadata unsignedOutputType = new OutputMetadata()
+            {
+                Type = unsignedType
+            };
+            OutputMetadata signedOutputType = new OutputMetadata()
+            {
+                Type = signedType
+            };
+
+            CmdletBreakingChangeMetadata unsignedCmdlet = new CmdletBreakingChangeMetadata()
+            {
+                VerbName = "Check",
+                NounName = "DifferentPublicKeyToken",
+                DefaultParameterSetName = "DefaultParameterSetName"
+            };
+            CmdletBreakingChangeMetadata signedCmdlet = new CmdletBreakingChangeMetadata()
+            {
+                VerbName = "Check",
+                NounName = "DifferentPublicKeyToken",
+                DefaultParameterSetName = "DefaultParameterSetName"
+            };
+
+            unsignedCmdlet.OutputTypes.Add(unsignedOutputType);
+            signedCmdlet.OutputTypes.Add(signedOutputType);
+            
+            var issueLogger = analysisLogger.CreateLogger<BreakingChangeIssue>("BreakingChangeIssues.csv");
+
+            CmdletMetadataHelper helper = new CmdletMetadataHelper();
+            helper.CompareCmdletMetadata(new List<CmdletBreakingChangeMetadata> { unsignedCmdlet }, 
+                                         new List<CmdletBreakingChangeMetadata> { signedCmdlet }, 
+                                         issueLogger);
+
+            Assert.Equal(0, issueLogger.Records.Count);
+        }
     }
 }