Separate testing of SA1600 and CS1591

Author: sharwell

StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/InheritdocCodeFixProviderUnitTests.cs

@@ -20,7 +20,7 @@ public class InheritdocCodeFixProviderUnitTests
     {
         private static readonly DiagnosticDescriptor SA1600 = new SA1600ElementsMustBeDocumented().SupportedDiagnostics[0];
         private static readonly DiagnosticDescriptor CS1591 =
-            new DiagnosticDescriptor(nameof(CS1591), "Title", "Missing XML comment for publicly visible type or member '{0}'", "Category", DiagnosticSeverity.Error, AnalyzerConstants.EnabledByDefault);
+            new DiagnosticDescriptor(nameof(CS1591), "Title", "Missing XML comment for publicly visible type or member '{0}'", "Category", DiagnosticSeverity.Warning, AnalyzerConstants.EnabledByDefault);
 
         [Theory]
         [InlineData(false, null, "string             TestMember { get; set; }")]
@@ -83,12 +83,7 @@ public override {memberData}
                 },
             };
 
-            if (compilerWarning)
-            {
-                test.DisabledDiagnostics.Add(SA1600.Id);
-                test.SolutionTransforms.Add(SetCompilerDocumentationWarningToError);
-            }
-
+            test.DisabledDiagnostics.Add(compilerWarning ? SA1600.Id : CS1591.Id);
             await test.RunAsync(CancellationToken.None).ConfigureAwait(false);
         }
 
@@ -153,12 +148,7 @@ public class ChildClass : IParent
                 },
             };
 
-            if (compilerWarning)
-            {
-                test.DisabledDiagnostics.Add(SA1600.Id);
-                test.SolutionTransforms.Add(SetCompilerDocumentationWarningToError);
-            }
-
+            test.DisabledDiagnostics.Add(compilerWarning ? SA1600.Id : CS1591.Id);
             await test.RunAsync(CancellationToken.None).ConfigureAwait(false);
         }
 
@@ -193,6 +183,7 @@ public class ChildClass : ParentClass
                     Diagnostic(SA1600).WithLocation(10, 14),
                     Diagnostic(SA1600).WithLocation(12, 35),
                 },
+                DisabledDiagnostics = { CS1591.Id },
                 FixedCode = testCode,
                 NumberOfIncrementalIterations = 1,
                 NumberOfFixAllIterations = 1,
@@ -230,21 +221,11 @@ public class ChildClass : ParentClass
                     Diagnostic(SA1600).WithLocation(10, 14),
                     Diagnostic(SA1600).WithLocation(12, 35),
                 },
+                DisabledDiagnostics = { CS1591.Id },
                 FixedCode = testCode,
                 NumberOfIncrementalIterations = 1,
                 NumberOfFixAllIterations = 1,
             }.RunAsync(CancellationToken.None).ConfigureAwait(false);
         }
-
-        private static Solution SetCompilerDocumentationWarningToError(Solution solution, ProjectId projectId)
-        {
-            var project = solution.GetProject(projectId);
-
-            // update the project compilation options
-            var modifiedSpecificDiagnosticOptions = project.CompilationOptions.SpecificDiagnosticOptions.SetItem(CS1591.Id, ReportDiagnostic.Error);
-            var modifiedCompilationOptions = project.CompilationOptions.WithSpecificDiagnosticOptions(modifiedSpecificDiagnosticOptions);
-
-            return solution.WithProjectCompilationOptions(projectId, modifiedCompilationOptions);
-        }
     }
 }

StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1600UnitTests.cs

@@ -613,14 +613,18 @@ public Test2(int param1, bool param2)
 }
 ";
 
-            DiagnosticResult[] expectedResults =
+            await new CSharpTest(this.LanguageVersion)
             {
-                Diagnostic().WithLocation(7, 12),
-                Diagnostic().WithLocation(11, 12),
-                Diagnostic().WithLocation(21, 12),
-            };
-
-            await VerifyCSharpFixAsync(this.LanguageVersion, testCode, expectedResults, fixedTestCode, CancellationToken.None).ConfigureAwait(false);
+                TestCode = testCode,
+                ExpectedDiagnostics =
+                {
+                    Diagnostic().WithLocation(7, 12),
+                    Diagnostic().WithLocation(11, 12),
+                    Diagnostic().WithLocation(21, 12),
+                },
+                FixedCode = fixedTestCode,
+                DisabledDiagnostics = { "CS1591" },
+            }.RunAsync(CancellationToken.None).ConfigureAwait(false);
         }
 
         /// <summary>
@@ -657,12 +661,16 @@ public class TestClass
 }
 ";
 
-            DiagnosticResult[] expectedResults =
+            await new CSharpTest(this.LanguageVersion)
             {
-                Diagnostic().WithLocation(7, 6),
-            };
-
-            await VerifyCSharpFixAsync(this.LanguageVersion, testCode, expectedResults, fixedTestCode, CancellationToken.None).ConfigureAwait(false);
+                TestCode = testCode,
+                ExpectedDiagnostics =
+                {
+                    Diagnostic().WithLocation(7, 6),
+                },
+                FixedCode = fixedTestCode,
+                DisabledDiagnostics = { "CS1591" },
+            }.RunAsync(CancellationToken.None).ConfigureAwait(false);
         }
 
         /// <summary>
@@ -689,13 +697,17 @@ public int DoSomething2()
 }
 ";
 
-            DiagnosticResult[] expectedResults =
+            await new CSharpTest(this.LanguageVersion)
             {
-                Diagnostic().WithLocation(7, 17),
-                Diagnostic().WithLocation(11, 16),
-            };
-
-            await VerifyCSharpFixAsync(this.LanguageVersion, testCode, expectedResults, testCode, CancellationToken.None).ConfigureAwait(false);
+                TestCode = testCode,
+                ExpectedDiagnostics =
+                {
+                    Diagnostic().WithLocation(7, 17),
+                    Diagnostic().WithLocation(11, 16),
+                },
+                FixedCode = testCode,
+                DisabledDiagnostics = { "CS1591" },
+            }.RunAsync(CancellationToken.None).ConfigureAwait(false);
         }
 
         /// <summary>
@@ -820,17 +832,21 @@ public Task<T> TestMethod6<T>(T param1, int param2)
 }}
 ";
 
-            DiagnosticResult[] expectedResults =
+            await new CSharpTest(this.LanguageVersion)
             {
-                Diagnostic().WithLocation(9, 17),
-                Diagnostic().WithLocation(14, 22),
-                Diagnostic().WithLocation(19, 20),
-                Diagnostic().WithLocation(24, 17),
-                Diagnostic().WithLocation(29, 22),
-                Diagnostic().WithLocation(34, 20),
-            };
-
-            await VerifyCSharpFixAsync(this.LanguageVersion, testCode, expectedResults, fixedTestCode, CancellationToken.None).ConfigureAwait(false);
+                TestCode = testCode,
+                ExpectedDiagnostics =
+                {
+                    Diagnostic().WithLocation(9, 17),
+                    Diagnostic().WithLocation(14, 22),
+                    Diagnostic().WithLocation(19, 20),
+                    Diagnostic().WithLocation(24, 17),
+                    Diagnostic().WithLocation(29, 22),
+                    Diagnostic().WithLocation(34, 20),
+                },
+                FixedCode = fixedTestCode,
+                DisabledDiagnostics = { "CS1591" },
+            }.RunAsync(CancellationToken.None).ConfigureAwait(false);
         }
 
         protected async Task TestTypeDeclarationDocumentationAsync(string type, string modifiers, bool requiresDiagnostic, bool hasDocumentation)
@@ -1333,6 +1349,7 @@ public class OuterClass
             {
                 TestCode = string.Format(hasDocumentation ? testCodeWithDocumentation : testCodeWithoutDocumentation, modifiers),
                 Settings = testSettings,
+                DisabledDiagnostics = { "CS1591" },
             };
 
             if (requiresDiagnostic)