Bring code in line with latest Code Analysis rules

natsnudasoft · Apr 3, 2019 · 9248117 · 9248117
1 parent 492cb97
commit 9248117
Show file tree

Hide file tree

Showing 18 changed files with 71 additions and 27 deletions.
diff --git a/_CodeAnalysis.docx b/_CodeAnalysis.docx
diff --git a/src/NatsnudaLibrary/IRandom.cs b/src/NatsnudaLibrary/IRandom.cs
@@ -26,6 +26,10 @@ public interface IRandom
         /// </summary>
         /// <returns>A 32-bit signed integer that is greater than or equal to 0 and less than
         /// <see cref="int.MaxValue"/>.</returns>
+        [System.Diagnostics.CodeAnalysis.SuppressMessage(
+            "Microsoft.Naming",
+            "CA1716:IdentifiersShouldNotMatchKeywords",
+            Justification = "Matching existing interface with reserved language keyword.")]
         int Next();
 
         /// <summary>
@@ -35,6 +39,10 @@ public interface IRandom
         /// </param>
         /// <returns>A 32-bit signed integer that is greater than or equal to 0, and less than
         /// <paramref name="maxValue"/>.</returns>
+        [System.Diagnostics.CodeAnalysis.SuppressMessage(
+            "Microsoft.Naming",
+            "CA1716:IdentifiersShouldNotMatchKeywords",
+            Justification = "Matching existing interface with reserved language keyword.")]
         int Next(int maxValue);
 
         /// <summary>
@@ -46,6 +54,10 @@ public interface IRandom
         /// </param>
         /// <returns>A 32-bit signed integer that is greater than or equal to
         /// <paramref name="minValue"/>, and less than <paramref name="maxValue"/>.</returns>
+        [System.Diagnostics.CodeAnalysis.SuppressMessage(
+            "Microsoft.Naming",
+            "CA1716:IdentifiersShouldNotMatchKeywords",
+            Justification = "Matching existing interface with reserved language keyword.")]
         int Next(int minValue, int maxValue);
 
         /// <summary>

diff --git a/src/NatsnudaLibrary/NatsnudaLibrary.ruleset b/src/NatsnudaLibrary/NatsnudaLibrary.ruleset
@@ -18,5 +18,6 @@
   </Rules>
   <Rules AnalyzerId="Microsoft.CodeAnalysis.CSharp.Features" RuleNamespace="Microsoft.CodeAnalysis.CSharp.Features">
     <Rule Id="IDE0003" Action="None" />
+    <Rule Id="IDE0041" Action="None" />
   </Rules>
 </RuleSet>
diff --git a/src/NatsnudaLibrary/SystemDateTimeProvider.cs b/src/NatsnudaLibrary/SystemDateTimeProvider.cs
@@ -27,9 +27,17 @@ namespace Natsnudasoft.NatsnudaLibrary
     public class SystemDateTimeProvider : IDateTimeProvider
     {
         /// <inheritdoc/>
+        [System.Diagnostics.CodeAnalysis.SuppressMessage(
+            "Menees.Analyzers",
+            "MEN013:UseUTCTime",
+            Justification = "Matching existing implementation.")]
         public DateTime Now => DateTime.Now;
 
         /// <inheritdoc/>
+        [System.Diagnostics.CodeAnalysis.SuppressMessage(
+            "Menees.Analyzers",
+            "MEN013:UseUTCTime",
+            Justification = "Matching existing implementation.")]
         public DateTime Today => DateTime.Today;
 
         /// <inheritdoc/>

diff --git a/src/TestExtensions/EqualsOverrideTheoriesSuccessiveAssertion.cs b/src/TestExtensions/EqualsOverrideTheoriesSuccessiveAssertion.cs
@@ -97,8 +97,7 @@ protected override void VerifyEqualsMethod(MethodInfo methodInfo)
                         methodInfo.ReflectedType.Name,
                         i));
                 }
-                else if (methodInfo.GetParameters().Single().ParameterType
-                    .IsAssignableFrom(right.GetType()))
+                else if (methodInfo.GetParameters().Single().ParameterType.IsInstanceOfType(right))
                 {
                     var expectedResult = equalsOverrideTheory.ExpectedResult;
                     var resultsMatchExpected = Enumerable.Range(0, this.SuccessiveCount)

diff --git a/src/TestExtensions/ExceptionBehaviorExpectation.cs b/src/TestExtensions/ExceptionBehaviorExpectation.cs
@@ -113,6 +113,10 @@ public class ExceptionBehaviorExpectation<T> : IBehaviorExpectation
         /// <param name="command">The command whose behaviour must be examined.</param>
         /// <exception cref="ArgumentNullException"><paramref name="command"/> is
         /// <see langword="null"/>.</exception>
+        [System.Diagnostics.CodeAnalysis.SuppressMessage(
+            "Microsoft.Design",
+            "CA1031:DoNotCatchGeneralExceptionTypes",
+            Justification = "Exception is propagated by guard clause.")]
         public void Verify(IGuardClauseCommand command)
         {
             ParameterValidation.IsNotNull(command, nameof(command));

diff --git a/src/TestExtensions/ParameterNullReferenceBehaviorExpectation.cs b/src/TestExtensions/ParameterNullReferenceBehaviorExpectation.cs
@@ -71,6 +71,10 @@ public ParameterNullReferenceBehaviorExpectation(ISpecimenBuilder specimenBuilde
         /// <param name="command">The command whose behaviour must be examined.</param>
         /// <exception cref="ArgumentNullException"><paramref name="command"/> is
         /// <see langword="null"/>.</exception>
+        [System.Diagnostics.CodeAnalysis.SuppressMessage(
+            "Microsoft.Design",
+            "CA1031:DoNotCatchGeneralExceptionTypes",
+            Justification = "Exception is propagated by guard clause.")]
         public void Verify(IGuardClauseCommand command)
         {
             ParameterValidation.IsNotNull(command, nameof(command));

diff --git a/src/TestExtensions/ParameterSpecimenBuilder.cs b/src/TestExtensions/ParameterSpecimenBuilder.cs
@@ -108,7 +108,7 @@ public object Create(object request, ISpecimenContext context)
             var parameterInfo = request as ParameterInfo;
             if (parameterInfo != null &&
                 parameterInfo.Member.DeclaringType == this.DeclaringType &&
-                parameterInfo.ParameterType.IsAssignableFrom(this.SpecimenValue.GetType()) &&
+                parameterInfo.ParameterType.IsInstanceOfType(this.SpecimenValue) &&
                 parameterInfo.Name == this.ParameterName)
             {
                 specimen = this.SpecimenValue;

diff --git a/src/TestExtensions/PropertyChangedRaisedException.cs b/src/TestExtensions/PropertyChangedRaisedException.cs
@@ -30,8 +30,13 @@ namespace Natsnudasoft.NatsnudaLibrary.TestExtensions
     [Serializable]
     public sealed class PropertyChangedRaisedException : Exception
     {
+        private const string PropertyInfoTypeName = nameof(PropertyInfo) + "TypeName";
+        private const string PropertyInfoMemberName = nameof(PropertyInfo) + "MemberName";
         private const string DefaultMessage = "A property did not raise the PropertyChanged event.";
 
+        [NonSerialized]
+        private readonly PropertyInfo propertyInfo;
+
         /// <summary>
         /// Initializes a new instance of the <see cref="PropertyChangedRaisedException"/> class.
         /// </summary>
@@ -75,7 +80,7 @@ public PropertyChangedRaisedException(string message, Exception innerException)
         public PropertyChangedRaisedException(PropertyInfo propertyInfo)
             : base(CreateMessage(propertyInfo))
         {
-            this.PropertyInfo = propertyInfo;
+            this.propertyInfo = propertyInfo;
         }
 
         /// <summary>
@@ -90,29 +95,35 @@ public PropertyChangedRaisedException(PropertyInfo propertyInfo)
             Exception innerException)
             : base(CreateMessage(propertyInfo), innerException)
         {
-            this.PropertyInfo = propertyInfo;
+            this.propertyInfo = propertyInfo;
         }
 
         [SecurityPermission(SecurityAction.Demand, SerializationFormatter = true)]
         private PropertyChangedRaisedException(SerializationInfo info, StreamingContext context)
             : base(info, context)
         {
-            this.PropertyInfo = (PropertyInfo)info
-                .GetValue(nameof(this.PropertyInfo), typeof(PropertyInfo));
+            var typeName = info.GetString(PropertyInfoTypeName);
+            var memberName = info.GetString(PropertyInfoMemberName);
+            const BindingFlags bindingFlags = BindingFlags.Static |
+                BindingFlags.Instance |
+                BindingFlags.Public |
+                BindingFlags.NonPublic;
+            this.propertyInfo = Type.GetType(typeName).GetProperty(memberName, bindingFlags);
         }
 
         /// <summary>
         /// Gets the property information for the property that did correctly raise the
         /// PropertyChanged event.
         /// </summary>
-        public PropertyInfo PropertyInfo { get; }
+        public PropertyInfo PropertyInfo => this.propertyInfo;
 
         /// <inheritdoc/>
         [SecurityPermission(SecurityAction.Demand, SerializationFormatter = true)]
         public override void GetObjectData(SerializationInfo info, StreamingContext context)
         {
             base.GetObjectData(info, context);
-            info.AddValue(nameof(this.PropertyInfo), this.PropertyInfo);
+            info.AddValue(PropertyInfoTypeName, this.PropertyInfo.DeclaringType.FullName);
+            info.AddValue(PropertyInfoMemberName, this.PropertyInfo.Name);
         }
 
         private static string CreateMessage(PropertyInfo propertyInfo)

diff --git a/src/TestExtensions/TestExtensions.ruleset b/src/TestExtensions/TestExtensions.ruleset
@@ -18,5 +18,6 @@
   </Rules>
   <Rules AnalyzerId="Microsoft.CodeAnalysis.CSharp.Features" RuleNamespace="Microsoft.CodeAnalysis.CSharp.Features">
     <Rule Id="IDE0003" Action="None" />
+    <Rule Id="IDE0041" Action="None" />
   </Rules>
 </RuleSet>
diff --git a/test/unit/NatsnudasoftTests/TestExtension/EqualsOverrideAssertionTests.cs b/test/unit/NatsnudasoftTests/TestExtension/EqualsOverrideAssertionTests.cs
@@ -89,7 +89,7 @@ public void VerifyWithMethodThatIsNotEqualsMethodIsNotInvoked()
         {
             var sutMock = new Mock<EqualsOverrideAssertion>(new Mock<ISpecimenBuilder>().Object)
             {
-                CallBase = true
+                CallBase = true,
             };
             var sut = sutMock.Object;
 
@@ -105,7 +105,7 @@ public void VerifyWithMethodThatIsEqualsMethodIsInvoked()
         {
             var sutMock = new Mock<EqualsOverrideAssertion>(new Mock<ISpecimenBuilder>().Object)
             {
-                CallBase = true
+                CallBase = true,
             };
             var sut = sutMock.Object;
 

diff --git a/test/unit/NatsnudasoftTests/TestExtension/EqualsOverrideNewObjectAssertionTests.cs b/test/unit/NatsnudasoftTests/TestExtension/EqualsOverrideNewObjectAssertionTests.cs
@@ -64,7 +64,7 @@ public void VerifyEqualsMethodWithNonObjectParameterTypeDoesNotInvokeEquals()
 
             var verifyHelperMock = new Mock<EqualsOverrideAssertionVerifyHelper>(false, true, false)
             {
-                CallBase = true
+                CallBase = true,
             };
             fixture.Inject(verifyHelperMock.Object);
             var sut = fixture.Create<SutAlias>();
@@ -97,7 +97,7 @@ public void VerifyEqualsMethodCorrectBehaviourInvokesEquals()
 
             var verifyHelperMock = new Mock<EqualsOverrideAssertionVerifyHelper>(false, true, false)
             {
-                CallBase = true
+                CallBase = true,
             };
             fixture.Inject(verifyHelperMock.Object);
             var sut = fixture.Create<SutAlias>();

diff --git a/test/unit/NatsnudasoftTests/TestExtension/EqualsOverrideNullAssertionTests.cs b/test/unit/NatsnudasoftTests/TestExtension/EqualsOverrideNullAssertionTests.cs
@@ -64,7 +64,7 @@ public void VerifyEqualsMethodWithNonNullableParameterTypeDoesNotInvokeEquals()
             var fixture = new Fixture();
             var verifyHelperMock = new Mock<EqualsOverrideAssertionVerifyHelper>(false, true, false)
             {
-                CallBase = true
+                CallBase = true,
             };
             fixture.Inject(verifyHelperMock.Object);
             var sut = fixture.Create<SutAlias>();
@@ -96,7 +96,7 @@ public void VerifyEqualsMethodCorrectBehaviourInvokesEquals()
             var fixture = new Fixture();
             var verifyHelperMock = new Mock<EqualsOverrideAssertionVerifyHelper>(false, true, false)
             {
-                CallBase = true
+                CallBase = true,
             };
             fixture.Inject(verifyHelperMock.Object);
             var sut = fixture.Create<SutAlias>();

diff --git a/test/unit/NatsnudasoftTests/TestExtension/EqualsOverrideOtherSuccessiveAssertionTests.cs b/test/unit/NatsnudasoftTests/TestExtension/EqualsOverrideOtherSuccessiveAssertionTests.cs
@@ -65,7 +65,7 @@ public void VerifyEqualsMethodWithObjectParameterTypeDoesNotInvokeEquals()
             var fixture = new Fixture();
             var verifyHelperMock = new Mock<EqualsOverrideAssertionVerifyHelper>(false, true, false)
             {
-                CallBase = true
+                CallBase = true,
             };
             fixture.Inject(verifyHelperMock.Object);
             var sut = fixture.Create<SutAlias>();
@@ -88,7 +88,7 @@ public void VerifyEqualsMethodViolatesEqualsSuccessiveContractThrows()
                 new EqualsOverrideAssertionVerifyHelper(
                     false,
                     false,
-                    () => equalsResultQueue.Dequeue())
+                    () => equalsResultQueue.Dequeue()),
             });
             fixture.Register(() => verifyHelperQueue.Dequeue());
             var sut = fixture.Create<SutAlias>();
@@ -106,12 +106,12 @@ public void VerifyEqualsMethodCorrectBehaviourInvokesEquals()
             var fixture = new Fixture();
             var verifyHelperMock = new Mock<EqualsOverrideAssertionVerifyHelper>(false, false, true)
             {
-                CallBase = true
+                CallBase = true,
             };
             var verifyHelperQueue = new Queue<EqualsOverrideAssertionVerifyHelper>(new[]
             {
                 verifyHelperMock.Object,
-                new EqualsOverrideAssertionVerifyHelper(false, false, true)
+                new EqualsOverrideAssertionVerifyHelper(false, false, true),
             });
             fixture.Register(() => verifyHelperQueue.Dequeue());
             var sut = fixture.Create<SutAlias>();

diff --git a/test/unit/NatsnudasoftTests/TestExtension/EqualsOverrideSelfAssertionTests.cs b/test/unit/NatsnudasoftTests/TestExtension/EqualsOverrideSelfAssertionTests.cs
@@ -64,7 +64,7 @@ public void VerifyEqualsMethodViolatesEqualsSelfContractThrows()
             var fixture = new Fixture();
             var verifyHelperMock = new Mock<EqualsOverrideAssertionVerifyHelper>(false, false, true)
             {
-                CallBase = true
+                CallBase = true,
             };
             fixture.Inject(verifyHelperMock.Object);
             var sut = fixture.Create<SutAlias>();
@@ -82,7 +82,7 @@ public void VerifyEqualsMethodCorrectBehaviourInvokesEquals()
             var fixture = new Fixture();
             var verifyHelperMock = new Mock<EqualsOverrideAssertionVerifyHelper>(false, true, true)
             {
-                CallBase = true
+                CallBase = true,
             };
             fixture.Inject(verifyHelperMock.Object);
             var sut = fixture.Create<SutAlias>();

diff --git a/test/unit/NatsnudasoftTests/TestExtension/EqualsOverrideTheoriesSuccessiveAssertionTests.cs b/test/unit/NatsnudasoftTests/TestExtension/EqualsOverrideTheoriesSuccessiveAssertionTests.cs
@@ -85,7 +85,7 @@ public void VerifyEqualsMethodWithTheoryWithRightThatCannotBeAssignedDoesNotInvo
             var fixture = new Fixture();
             var verifyHelperMock = new Mock<EqualsOverrideAssertionVerifyHelper>(false, true, false)
             {
-                CallBase = true
+                CallBase = true,
             };
             var equalsOverrideTheory = new EqualsOverrideTheory(
                 verifyHelperMock.Object,
@@ -131,12 +131,12 @@ public void VerifyEqualsMethodCorrectBehaviourInvokesEquals()
             var fixture = new Fixture();
             var verifyHelperMock = new Mock<EqualsOverrideAssertionVerifyHelper>(false, false, true)
             {
-                CallBase = true
+                CallBase = true,
             };
             var verifyHelperQueue = new Queue<EqualsOverrideAssertionVerifyHelper>(new[]
             {
                 verifyHelperMock.Object,
-                new EqualsOverrideAssertionVerifyHelper(false, false, true)
+                new EqualsOverrideAssertionVerifyHelper(false, false, true),
             });
             fixture.Register(() => verifyHelperQueue.Dequeue());
             var equalsOverrideTheory = new EqualsOverrideTheory(

diff --git a/test/unit/NatsnudasoftTests/TestExtension/ExceptionBehaviorExpectationTests.cs b/test/unit/NatsnudasoftTests/TestExtension/ExceptionBehaviorExpectationTests.cs
@@ -85,7 +85,7 @@ public void ConstructorEmptyValuesThrows()
             var ex = Record.Exception(() => new ExceptionBehaviorExpectation<Exception>(
                 new Mock<ISpecimenBuilder>().Object,
                 fixture.Create<string>(),
-                new object[] { }));
+                Array.Empty<object>()));
 
             Assert.IsType<ArgumentException>(ex);
         }
@@ -100,7 +100,7 @@ public void Constructor2EmptyValuesThrows()
                 new Mock<ISpecimenBuilder>().Object,
                 new Mock<IGuardClauseExtensions>().Object,
                 fixture.Create<string>(),
-                new object[] { }));
+                Array.Empty<object>()));
 
             Assert.IsType<ArgumentException>(ex);
         }

diff --git a/test/unit/NatsnudasoftTests/TestExtension/ParameterTypeFavoringConstructorQueryTests.cs b/test/unit/NatsnudasoftTests/TestExtension/ParameterTypeFavoringConstructorQueryTests.cs
@@ -78,11 +78,15 @@ public void SelectMethodsConstructorFoundReturnsSingleConstructor()
 
             var actual = sut.SelectMethods(typeof(SelectConstructorTestClass));
 
-            Assert.Equal(1, actual.Count());
+            Assert.Single(actual);
             Assert.IsType<ConstructorMethod>(actual.First());
             Assert.Equal(expected, ((ConstructorMethod)actual.First()).Constructor);
         }
 
+        [System.Diagnostics.CodeAnalysis.SuppressMessage(
+            "Microsoft.Performance",
+            "CA1812:AvoidUninstantiatedInternalClasses",
+            Justification = "Class is used via reflection.")]
         private sealed class SelectConstructorTestClass
         {
             public SelectConstructorTestClass(int intParameter)