Fixed StyleCop warnings in HighPerformance tests

Sergio0694 · Sergio0694 · commit 7e67a9c84bb8 · 2020-11-05T01:34:44.000+01:00
diff --git a/UnitTests/UnitTests.HighPerformance.Shared/Buffers/Test_StringPool.cs b/UnitTests/UnitTests.HighPerformance.Shared/Buffers/Test_StringPool.cs
@@ -38,13 +38,13 @@ public void Test_StringPool_Cctor_Ok(int minimumSize, int x, int y, int size)
 
             Assert.AreEqual(size, pool.Size);
 
-            Array maps = (Array)typeof(StringPool).GetField("maps", BindingFlags.Instance | BindingFlags.NonPublic).GetValue(pool);
+            Array maps = (Array)typeof(StringPool).GetField("maps", BindingFlags.Instance | BindingFlags.NonPublic)!.GetValue(pool)!;
 
             Assert.AreEqual(x, maps.Length);
 
-            Type bucketType = Type.GetType("Microsoft.Toolkit.HighPerformance.Buffers.StringPool+FixedSizePriorityMap, Microsoft.Toolkit.HighPerformance");
+            Type bucketType = Type.GetType("Microsoft.Toolkit.HighPerformance.Buffers.StringPool+FixedSizePriorityMap, Microsoft.Toolkit.HighPerformance")!;
 
-            int[] buckets = (int[])bucketType.GetField("buckets", BindingFlags.Instance | BindingFlags.NonPublic).GetValue(maps.GetValue(0));
+            int[] buckets = (int[])bucketType.GetField("buckets", BindingFlags.Instance | BindingFlags.NonPublic)!.GetValue(maps.GetValue(0))!;
 
             Assert.AreEqual(y, buckets.Length);
         }
@@ -64,7 +64,7 @@ public void Test_StringPool_Cctor_Fail(int size)
             }
             catch (ArgumentOutOfRangeException e)
             {
-                var cctor = typeof(StringPool).GetConstructor(new[] { typeof(int) });
+                var cctor = typeof(StringPool).GetConstructor(new[] { typeof(int) })!;
 
                 Assert.AreEqual(cctor.GetParameters()[0].Name, e.ParamName);
             }
@@ -158,7 +158,7 @@ public void Test_StringPool_Add_Overwrite()
         [MethodImpl(MethodImplOptions.NoInlining)]
         private static string ToStringNoInlining(object obj)
         {
-            return obj.ToString();
+            return obj.ToString()!;
         }
 
         [TestCategory("StringPool")]
@@ -285,15 +285,15 @@ public void Test_StringPool_GetOrAdd_Overflow()
             }
 
             // Get the buckets
-            Array maps = (Array)typeof(StringPool).GetField("maps", BindingFlags.Instance | BindingFlags.NonPublic).GetValue(pool);
+            Array maps = (Array)typeof(StringPool).GetField("maps", BindingFlags.Instance | BindingFlags.NonPublic)!.GetValue(pool)!;
 
-            Type bucketType = Type.GetType("Microsoft.Toolkit.HighPerformance.Buffers.StringPool+FixedSizePriorityMap, Microsoft.Toolkit.HighPerformance");
-            FieldInfo timestampInfo = bucketType.GetField("timestamp", BindingFlags.Instance | BindingFlags.NonPublic);
+            Type bucketType = Type.GetType("Microsoft.Toolkit.HighPerformance.Buffers.StringPool+FixedSizePriorityMap, Microsoft.Toolkit.HighPerformance")!;
+            FieldInfo timestampInfo = bucketType.GetField("timestamp", BindingFlags.Instance | BindingFlags.NonPublic)!;
 
             // Force the timestamp to be the maximum value, or the test would take too long
             for (int i = 0; i < maps.LongLength; i++)
             {
-                object map = maps.GetValue(i);
+                object map = maps.GetValue(i)!;
 
                 timestampInfo.SetValue(map, uint.MaxValue);
 
@@ -305,16 +305,16 @@ public void Test_StringPool_GetOrAdd_Overflow()
 
             _ = pool.GetOrAdd(text);
 
-            Type heapEntryType = Type.GetType("Microsoft.Toolkit.HighPerformance.Buffers.StringPool+FixedSizePriorityMap+HeapEntry, Microsoft.Toolkit.HighPerformance");
+            Type heapEntryType = Type.GetType("Microsoft.Toolkit.HighPerformance.Buffers.StringPool+FixedSizePriorityMap+HeapEntry, Microsoft.Toolkit.HighPerformance")!;
 
             foreach (var map in maps)
             {
                 // Get the heap for each bucket
-                Array heapEntries = (Array)bucketType.GetField("heapEntries", BindingFlags.Instance | BindingFlags.NonPublic).GetValue(map);
-                FieldInfo fieldInfo = heapEntryType.GetField("Timestamp");
+                Array heapEntries = (Array)bucketType.GetField("heapEntries", BindingFlags.Instance | BindingFlags.NonPublic)!.GetValue(map)!;
+                FieldInfo fieldInfo = heapEntryType.GetField("Timestamp")!;
 
                 // Extract the array with the timestamps in the heap nodes
-                uint[] array = heapEntries.Cast<object>().Select(entry => (uint)fieldInfo.GetValue(entry)).ToArray();
+                uint[] array = heapEntries.Cast<object>().Select(entry => (uint)fieldInfo.GetValue(entry)!).ToArray();
 
                 static bool IsMinHeap(uint[] array)
                 {
diff --git a/UnitTests/UnitTests.HighPerformance.Shared/Extensions/Test_ArrayExtensions.1D.cs b/UnitTests/UnitTests.HighPerformance.Shared/Extensions/Test_ArrayExtensions.1D.cs
@@ -2,13 +2,15 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for more information.
 
+using System.Diagnostics.CodeAnalysis;
 using System.Runtime.CompilerServices;
 using Microsoft.Toolkit.HighPerformance.Extensions;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
 
 namespace UnitTests.HighPerformance.Extensions
 {
     [TestClass]
+    [SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1601", Justification = "Partial test class")]
     public partial class Test_ArrayExtensions
     {
         [TestCategory("ArrayExtensions")]
diff --git a/UnitTests/UnitTests.HighPerformance.Shared/Extensions/Test_ArrayExtensions.2D.cs b/UnitTests/UnitTests.HighPerformance.Shared/Extensions/Test_ArrayExtensions.2D.cs
@@ -3,7 +3,6 @@
 // See the LICENSE file in the project root for more information.
 
 using System;
-using System.Diagnostics.CodeAnalysis;
 using System.Runtime.CompilerServices;
 using Microsoft.Toolkit.HighPerformance.Enumerables;
 using Microsoft.Toolkit.HighPerformance.Extensions;
@@ -167,8 +166,6 @@ public void Test_ArrayExtensions_2D_AsSpan2DAndFillArrayBottomRightCornerBoundar
 
         [TestCategory("ArrayExtensions")]
         [TestMethod]
-        [SuppressMessage("StyleCop.CSharp.NamingRules", "SA1312", Justification = "Dummy loop variable")]
-        [SuppressMessage("StyleCop.CSharp.LayoutRules", "SA1501", Justification = "Empty test loop")]
         public void Test_ArrayExtensions_2D_GetRow_Rectangle()
         {
             int[,] array =
@@ -201,8 +198,6 @@ public void Test_ArrayExtensions_2D_GetRow_Rectangle()
 
         [TestCategory("ArrayExtensions")]
         [TestMethod]
-        [SuppressMessage("StyleCop.CSharp.NamingRules", "SA1312", Justification = "Dummy loop variable")]
-        [SuppressMessage("StyleCop.CSharp.LayoutRules", "SA1501", Justification = "Empty test loop")]
         public void Test_ArrayExtensions_2D_GetColumn_Rectangle()
         {
             int[,] array =
@@ -239,8 +234,6 @@ public void Test_ArrayExtensions_2D_GetRow_Empty()
 
         [TestCategory("ArrayExtensions")]
         [TestMethod]
-        [SuppressMessage("StyleCop.CSharp.NamingRules", "SA1312", Justification = "Dummy loop variable")]
-        [SuppressMessage("StyleCop.CSharp.LayoutRules", "SA1501", Justification = "Empty test loop")]
         public void Test_ArrayExtensions_2D_GetRowOrColumn_Helpers()
         {
             int[,] array =
@@ -337,8 +330,6 @@ public void Test_ArrayExtensions_2D_GetRowOrColumn_Helpers()
 
         [TestCategory("ArrayExtensions")]
         [TestMethod]
-        [SuppressMessage("StyleCop.CSharp.NamingRules", "SA1312", Justification = "Dummy loop variable")]
-        [SuppressMessage("StyleCop.CSharp.LayoutRules", "SA1501", Justification = "Empty test loop")]
         public void Test_ArrayExtensions_2D_ReadOnlyGetRowOrColumn_Helpers()
         {
             int[,] array =
@@ -384,8 +375,6 @@ public void Test_ArrayExtensions_2D_ReadOnlyGetRowOrColumn_Helpers()
 
         [TestCategory("ArrayExtensions")]
         [TestMethod]
-        [SuppressMessage("StyleCop.CSharp.NamingRules", "SA1312", Justification = "Dummy loop variable")]
-        [SuppressMessage("StyleCop.CSharp.LayoutRules", "SA1501", Justification = "Empty test loop")]
         public void Test_ArrayExtensions_2D_RefEnumerable_Misc()
         {
             int[,] array1 =
diff --git a/UnitTests/UnitTests.HighPerformance.Shared/Extensions/Test_ReadOnlySpanExtensions.Count.cs b/UnitTests/UnitTests.HighPerformance.Shared/Extensions/Test_ReadOnlySpanExtensions.Count.cs
@@ -103,7 +103,7 @@ private sealed class Int : IEquatable<Int>
 
             public Int(int value) => Value = value;
 
-            public bool Equals(Int other)
+            public bool Equals(Int? other)
             {
                 if (other is null)
                 {
@@ -118,7 +118,7 @@ public bool Equals(Int other)
                 return this.Value == other.Value;
             }
 
-            public override bool Equals(object obj)
+            public override bool Equals(object? obj)
             {
                 return ReferenceEquals(this, obj) || (obj is Int other && Equals(other));
             }
diff --git a/UnitTests/UnitTests.HighPerformance.Shared/Extensions/Test_ReadOnlySpanExtensions.cs b/UnitTests/UnitTests.HighPerformance.Shared/Extensions/Test_ReadOnlySpanExtensions.cs
@@ -4,6 +4,7 @@
 
 using System;
 using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
 using System.Runtime.CompilerServices;
 using System.Runtime.InteropServices;
 using Microsoft.Toolkit.HighPerformance.Extensions;
@@ -12,6 +13,7 @@
 namespace UnitTests.HighPerformance.Extensions
 {
     [TestClass]
+    [SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1601", Justification = "Partial test class")]
     public partial class Test_ReadOnlySpanExtensions
     {
         [TestCategory("ReadOnlySpanExtensions")]
diff --git a/UnitTests/UnitTests.HighPerformance.Shared/Memory/Test_ReadOnlySpan2D{T}.cs b/UnitTests/UnitTests.HighPerformance.Shared/Memory/Test_ReadOnlySpan2D{T}.cs
@@ -847,8 +847,6 @@ public void Test_ReadOnlySpan2DT_GetEnumerator_Empty()
 
         [TestCategory("ReadOnlySpan2DT")]
         [TestMethod]
-        [SuppressMessage("StyleCop.CSharp.NamingRules", "SA1312", Justification = "Dummy loop variable")]
-        [SuppressMessage("StyleCop.CSharp.LayoutRules", "SA1501", Justification = "Empty test loop")]
         public void Test_ReadOnlySpan2DT_ReadOnlyRefEnumerable_Misc()
         {
             int[,] array1 =

Original file line number	Diff line number	Diff line change
`@@ -38,13 +38,13 @@ public void Test_StringPool_Cctor_Ok(int minimumSize, int x, int y, int size)`
`38`	`38`
`39`	`39`	`Assert.AreEqual(size, pool.Size);`
`40`	`40`
`41`		`- Array maps = (Array)typeof(StringPool).GetField("maps", BindingFlags.Instance \| BindingFlags.NonPublic).GetValue(pool);`
	`41`	`+ Array maps = (Array)typeof(StringPool).GetField("maps", BindingFlags.Instance \| BindingFlags.NonPublic)!.GetValue(pool)!;`
`42`	`42`
`43`	`43`	`Assert.AreEqual(x, maps.Length);`
`44`	`44`
`45`		`- Type bucketType = Type.GetType("Microsoft.Toolkit.HighPerformance.Buffers.StringPool+FixedSizePriorityMap, Microsoft.Toolkit.HighPerformance");`
	`45`	`+ Type bucketType = Type.GetType("Microsoft.Toolkit.HighPerformance.Buffers.StringPool+FixedSizePriorityMap, Microsoft.Toolkit.HighPerformance")!;`
`46`	`46`
`47`		`- int[] buckets = (int[])bucketType.GetField("buckets", BindingFlags.Instance \| BindingFlags.NonPublic).GetValue(maps.GetValue(0));`
	`47`	`+ int[] buckets = (int[])bucketType.GetField("buckets", BindingFlags.Instance \| BindingFlags.NonPublic)!.GetValue(maps.GetValue(0))!;`
`48`	`48`
`49`	`49`	`Assert.AreEqual(y, buckets.Length);`
`50`	`50`	`}`
`@@ -64,7 +64,7 @@ public void Test_StringPool_Cctor_Fail(int size)`
`64`	`64`	`}`
`65`	`65`	`catch (ArgumentOutOfRangeException e)`
`66`	`66`	`{`
`67`		`- var cctor = typeof(StringPool).GetConstructor(new[] { typeof(int) });`
	`67`	`+ var cctor = typeof(StringPool).GetConstructor(new[] { typeof(int) })!;`
`68`	`68`
`69`	`69`	`Assert.AreEqual(cctor.GetParameters()[0].Name, e.ParamName);`
`70`	`70`	`}`
`@@ -158,7 +158,7 @@ public void Test_StringPool_Add_Overwrite()`
`158`	`158`	`[MethodImpl(MethodImplOptions.NoInlining)]`
`159`	`159`	`private static string ToStringNoInlining(object obj)`
`160`	`160`	`{`
`161`		`- return obj.ToString();`
	`161`	`+ return obj.ToString()!;`
`162`	`162`	`}`
`163`	`163`
`164`	`164`	`[TestCategory("StringPool")]`
`@@ -285,15 +285,15 @@ public void Test_StringPool_GetOrAdd_Overflow()`
`285`	`285`	`}`
`286`	`286`
`287`	`287`	`// Get the buckets`
`288`		`- Array maps = (Array)typeof(StringPool).GetField("maps", BindingFlags.Instance \| BindingFlags.NonPublic).GetValue(pool);`
	`288`	`+ Array maps = (Array)typeof(StringPool).GetField("maps", BindingFlags.Instance \| BindingFlags.NonPublic)!.GetValue(pool)!;`
`289`	`289`
`290`		`- Type bucketType = Type.GetType("Microsoft.Toolkit.HighPerformance.Buffers.StringPool+FixedSizePriorityMap, Microsoft.Toolkit.HighPerformance");`
`291`		`- FieldInfo timestampInfo = bucketType.GetField("timestamp", BindingFlags.Instance \| BindingFlags.NonPublic);`
	`290`	`+ Type bucketType = Type.GetType("Microsoft.Toolkit.HighPerformance.Buffers.StringPool+FixedSizePriorityMap, Microsoft.Toolkit.HighPerformance")!;`
	`291`	`+ FieldInfo timestampInfo = bucketType.GetField("timestamp", BindingFlags.Instance \| BindingFlags.NonPublic)!;`
`292`	`292`
`293`	`293`	`// Force the timestamp to be the maximum value, or the test would take too long`
`294`	`294`	`for (int i = 0; i < maps.LongLength; i++)`
`295`	`295`	`{`
`296`		`- object map = maps.GetValue(i);`
	`296`	`+ object map = maps.GetValue(i)!;`
`297`	`297`
`298`	`298`	`timestampInfo.SetValue(map, uint.MaxValue);`
`299`	`299`
`@@ -305,16 +305,16 @@ public void Test_StringPool_GetOrAdd_Overflow()`
`305`	`305`
`306`	`306`	`_ = pool.GetOrAdd(text);`
`307`	`307`
`308`		`- Type heapEntryType = Type.GetType("Microsoft.Toolkit.HighPerformance.Buffers.StringPool+FixedSizePriorityMap+HeapEntry, Microsoft.Toolkit.HighPerformance");`
	`308`	`+ Type heapEntryType = Type.GetType("Microsoft.Toolkit.HighPerformance.Buffers.StringPool+FixedSizePriorityMap+HeapEntry, Microsoft.Toolkit.HighPerformance")!;`
`309`	`309`
`310`	`310`	`foreach (var map in maps)`
`311`	`311`	`{`
`312`	`312`	`// Get the heap for each bucket`
`313`		`- Array heapEntries = (Array)bucketType.GetField("heapEntries", BindingFlags.Instance \| BindingFlags.NonPublic).GetValue(map);`
`314`		`- FieldInfo fieldInfo = heapEntryType.GetField("Timestamp");`
	`313`	`+ Array heapEntries = (Array)bucketType.GetField("heapEntries", BindingFlags.Instance \| BindingFlags.NonPublic)!.GetValue(map)!;`
	`314`	`+ FieldInfo fieldInfo = heapEntryType.GetField("Timestamp")!;`
`315`	`315`
`316`	`316`	`// Extract the array with the timestamps in the heap nodes`
`317`		`- uint[] array = heapEntries.Cast<object>().Select(entry => (uint)fieldInfo.GetValue(entry)).ToArray();`
	`317`	`+ uint[] array = heapEntries.Cast<object>().Select(entry => (uint)fieldInfo.GetValue(entry)!).ToArray();`
`318`	`318`
`319`	`319`	`static bool IsMinHeap(uint[] array)`
`320`	`320`	`{`
Original file line number	Diff line number	Diff line change
`@@ -2,13 +2,15 @@`
`2`	`2`	`// The .NET Foundation licenses this file to you under the MIT license.`
`3`	`3`	`// See the LICENSE file in the project root for more information.`
`4`	`4`
	`5`	`+using System.Diagnostics.CodeAnalysis;`
`5`	`6`	`using System.Runtime.CompilerServices;`
`6`	`7`	`using Microsoft.Toolkit.HighPerformance.Extensions;`
`7`	`8`	`using Microsoft.VisualStudio.TestTools.UnitTesting;`
`8`	`9`
`9`	`10`	`namespace UnitTests.HighPerformance.Extensions`
`10`	`11`	`{`
`11`	`12`	`[TestClass]`
	`13`	`+ [SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1601", Justification = "Partial test class")]`
`12`	`14`	`public partial class Test_ArrayExtensions`
`13`	`15`	`{`
`14`	`16`	`[TestCategory("ArrayExtensions")]`
Original file line number	Diff line number	Diff line change
`@@ -103,7 +103,7 @@ private sealed class Int : IEquatable<Int>`
`103`	`103`
`104`	`104`	`public Int(int value) => Value = value;`
`105`	`105`
`106`		`- public bool Equals(Int other)`
	`106`	`+ public bool Equals(Int? other)`
`107`	`107`	`{`
`108`	`108`	`if (other is null)`
`109`	`109`	`{`
`@@ -118,7 +118,7 @@ public bool Equals(Int other)`
`118`	`118`	`return this.Value == other.Value;`
`119`	`119`	`}`
`120`	`120`
`121`		`- public override bool Equals(object obj)`
	`121`	`+ public override bool Equals(object? obj)`
`122`	`122`	`{`
`123`	`123`	`return ReferenceEquals(this, obj) \|\| (obj is Int other && Equals(other));`
`124`	`124`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`
`5`	`5`	`using System;`
`6`	`6`	`using System.Collections.Generic;`
	`7`	`+using System.Diagnostics.CodeAnalysis;`
`7`	`8`	`using System.Runtime.CompilerServices;`
`8`	`9`	`using System.Runtime.InteropServices;`
`9`	`10`	`using Microsoft.Toolkit.HighPerformance.Extensions;`
`@@ -12,6 +13,7 @@`
`12`	`13`	`namespace UnitTests.HighPerformance.Extensions`
`13`	`14`	`{`
`14`	`15`	`[TestClass]`
	`16`	`+ [SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1601", Justification = "Partial test class")]`
`15`	`17`	`public partial class Test_ReadOnlySpanExtensions`
`16`	`18`	`{`
`17`	`19`	`[TestCategory("ReadOnlySpanExtensions")]`
Original file line number	Diff line number	Diff line change
`@@ -847,8 +847,6 @@ public void Test_ReadOnlySpan2DT_GetEnumerator_Empty()`
`847`	`847`
`848`	`848`	`[TestCategory("ReadOnlySpan2DT")]`
`849`	`849`	`[TestMethod]`
`850`		`- [SuppressMessage("StyleCop.CSharp.NamingRules", "SA1312", Justification = "Dummy loop variable")]`
`851`		`- [SuppressMessage("StyleCop.CSharp.LayoutRules", "SA1501", Justification = "Empty test loop")]`
`852`	`850`	`public void Test_ReadOnlySpan2DT_ReadOnlyRefEnumerable_Misc()`
`853`	`851`	`{`
`854`	`852`	`int[,] array1 =`