[WIP] BinaryFormatter - Reenable sanity check (#21507)

* Reenable sanity check

* Avoid different blobs for CookieContainer dependent on machine configuration

* Fixing diffent blobs for CompareInfo as it used machine config depdent values

* Fixing different in DataTable and DataSet

* Fixing CookieCollection missing field in serialization

Author: ViktorHofer

src/System.Net.Primitives/src/System/Net/CookieCollection.cs

@@ -4,6 +4,7 @@
 
 using System.Collections;
 using System.Collections.Generic;
+using System.Runtime.Serialization;
 
 namespace System.Net
 {
@@ -24,9 +25,7 @@ internal enum Stamp
 
         private readonly ArrayList m_list = new ArrayList();
 
-#pragma warning disable 0414
-        private int m_version = 0; // Do not rename (binary serialization). This field only exists for netfx serialization compatibility.
-#pragma warning restore 0414
+        private int m_version; // Do not rename (binary serialization). This field only exists for netfx serialization compatibility.
         private DateTime m_TimeStamp = DateTime.MinValue; // Do not rename (binary serialization)
         private bool m_has_other_versions; // Do not rename (binary serialization)
 
@@ -61,6 +60,12 @@ public Cookie this[string name]
             }
         }
 
+        [OnSerializing]
+        private void OnSerializing(StreamingContext context)
+        {
+            m_version = m_list.Count;
+        }
+
         public void Add(Cookie cookie)
         {
             if (cookie == null)

src/System.Runtime.Serialization.Formatters/tests/BinaryFormatterHelper.cs

@@ -127,6 +127,26 @@ public static void ValidateEqualityComparer(object obj)
             Assert.Equal(obj.GetType().GetGenericArguments()[0], objType.GetGenericArguments()[0]);
         }
 
+        private static void SanityCheckBlob(object obj, string[] blobs)
+        {
+            // Check if runtime generated blob is the same as the stored one
+            int frameworkBlobNumber = PlatformDetection.IsFullFramework ? 1 : 0;
+            if (frameworkBlobNumber < blobs.Length &&
+                // WeakReference<Point> and HybridDictionary with default constructor are generating
+                // different blobs at runtime for some obscure reason. Excluding those from the check.
+                !(obj is WeakReference<Point>) &&
+                !(obj is Collections.Specialized.HybridDictionary))
+            {
+                string runtimeBlob = SerializeObjectToBlob(obj, FormatterAssemblyStyle.Full);
+
+                string storedComparableBlob = CreateComparableBlobInfo(blobs[frameworkBlobNumber]);
+                string runtimeComparableBlob = CreateComparableBlobInfo(runtimeBlob);
+
+                Assert.True(storedComparableBlob == runtimeComparableBlob,
+                    $"The stored blob for type {obj.GetType().FullName} is outdated and needs to be updated.{Environment.NewLine}Stored blob: {blobs[frameworkBlobNumber]}{Environment.NewLine}Generated runtime blob: {runtimeBlob}");
+            }
+        }
+
         public static string GetTestDataFilePath()
         {
             string GetRepoRootPath()
@@ -171,9 +191,18 @@ public static IEnumerable<string> GetCoreTypeBlobs(IEnumerable<object[]> records
 
         public static string CreateComparableBlobInfo(string base64Blob)
         {
+            string lineSeparator = ((char)0x2028).ToString();
+            string paragraphSeparator = ((char)0x2029).ToString();
+
             byte[] data = Convert.FromBase64String(base64Blob);
-            string decodedString = Encoding.UTF8.GetString(data);
-            return Regex.Replace(decodedString, @"Version=\d.\d.\d.\d.", "Version=0.0.0.0", RegexOptions.Multiline);
+            base64Blob = Encoding.UTF8.GetString(data);
+
+            return Regex.Replace(base64Blob, @"Version=\d.\d.\d.\d.", "Version=0.0.0.0", RegexOptions.Multiline)
+                .Replace("\r\n", string.Empty)
+                .Replace("\n", string.Empty)
+                .Replace("\r", string.Empty)
+                .Replace(lineSeparator, string.Empty)
+                .Replace(paragraphSeparator, string.Empty);
         }
 
         public static (int blobs, int foundBlobs, int updatedBlobs) UpdateCoreTypeBlobs(string testDataFilePath, string[] blobs)