Add tests for records in types using SyntaxKinds.TypeDeclaration

sharwell · sharwell · commit 139c3c7b172c · 2020-12-05T10:38:26.000-08:00
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers.CodeFixes/OrderingRules/SA1205CodeFixProvider.cs b/StyleCop.Analyzers/StyleCop.Analyzers.CodeFixes/OrderingRules/SA1205CodeFixProvider.cs
@@ -13,6 +13,7 @@ namespace StyleCop.Analyzers.OrderingRules
     using Microsoft.CodeAnalysis.CSharp;
     using Microsoft.CodeAnalysis.CSharp.Syntax;
     using StyleCop.Analyzers.Helpers;
+    using StyleCop.Analyzers.Lightup;
 
     /// <summary>
     /// Implements code fixes for <see cref="SA1205PartialElementsMustDeclareAccess"/>.
@@ -108,6 +109,8 @@ private static TypeDeclarationSyntax ReplaceModifiers(TypeDeclarationSyntax node
                 return ((InterfaceDeclarationSyntax)node).WithModifiers(modifiers);
             case SyntaxKind.StructDeclaration:
                 return ((StructDeclarationSyntax)node).WithModifiers(modifiers);
+            case SyntaxKindEx.RecordDeclaration:
+                return ((RecordDeclarationSyntaxWrapper)node).WithModifiers(modifiers);
             }
 
             return node;
@@ -125,6 +128,8 @@ private static TypeDeclarationSyntax ReplaceKeyword(TypeDeclarationSyntax node,
                 return ((InterfaceDeclarationSyntax)node).WithKeyword(keyword);
             case SyntaxKind.StructDeclaration:
                 return ((StructDeclarationSyntax)node).WithKeyword(keyword);
+            case SyntaxKindEx.RecordDeclaration:
+                return ((RecordDeclarationSyntaxWrapper)node).WithKeyword(keyword);
             }
 
             return node;
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1605UnitTests.cs b/StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1605UnitTests.cs
@@ -3,10 +3,12 @@
 
 namespace StyleCop.Analyzers.Test.DocumentationRules
 {
+    using System.Collections.Generic;
     using System.Threading;
     using System.Threading.Tasks;
     using Microsoft.CodeAnalysis.Testing;
     using StyleCop.Analyzers.DocumentationRules;
+    using StyleCop.Analyzers.Lightup;
     using StyleCop.Analyzers.Test.Verifiers;
     using Xunit;
     using static StyleCop.Analyzers.Test.Verifiers.CustomDiagnosticVerifier<StyleCop.Analyzers.DocumentationRules.SA1605PartialElementDocumentationMustHaveSummary>;
@@ -26,10 +28,35 @@ public class SA1605UnitTests
 }
 ";
 
+        public static IEnumerable<object[]> TypeDeclarationKeywords
+        {
+            get
+            {
+                yield return new[] { "class" };
+                yield return new[] { "struct" };
+                yield return new[] { "interface" };
+                if (LightupHelpers.SupportsCSharp9)
+                {
+                    yield return new[] { "record" };
+                }
+            }
+        }
+
+        public static IEnumerable<object[]> BaseTypeDeclarationKeywords
+        {
+            get
+            {
+                foreach (var keyword in TypeDeclarationKeywords)
+                {
+                    yield return keyword;
+                }
+
+                yield return new[] { "enum" };
+            }
+        }
+
         [Theory]
-        [InlineData("class")]
-        [InlineData("struct")]
-        [InlineData("interface")]
+        [MemberData(nameof(TypeDeclarationKeywords))]
         public async Task TestTypeNoDocumentationAsync(string typeName)
         {
             var testCode = @"
@@ -40,9 +67,7 @@ public async Task TestTypeNoDocumentationAsync(string typeName)
         }
 
         [Theory]
-        [InlineData("class")]
-        [InlineData("struct")]
-        [InlineData("interface")]
+        [MemberData(nameof(TypeDeclarationKeywords))]
         public async Task TestTypeWithSummaryDocumentationAsync(string typeName)
         {
             var testCode = @"
@@ -56,9 +81,7 @@ public async Task TestTypeWithSummaryDocumentationAsync(string typeName)
         }
 
         [Theory]
-        [InlineData("class")]
-        [InlineData("struct")]
-        [InlineData("interface")]
+        [MemberData(nameof(TypeDeclarationKeywords))]
         public async Task TestTypeWithContentDocumentationAsync(string typeName)
         {
             var testCode = @"
@@ -72,9 +95,7 @@ public async Task TestTypeWithContentDocumentationAsync(string typeName)
         }
 
         [Theory]
-        [InlineData("class")]
-        [InlineData("struct")]
-        [InlineData("interface")]
+        [MemberData(nameof(TypeDeclarationKeywords))]
         public async Task TestTypeWithInheritedDocumentationAsync(string typeName)
         {
             var testCode = @"
@@ -86,9 +107,7 @@ public async Task TestTypeWithInheritedDocumentationAsync(string typeName)
         }
 
         [Theory]
-        [InlineData("class")]
-        [InlineData("struct")]
-        [InlineData("interface")]
+        [MemberData(nameof(TypeDeclarationKeywords))]
         public async Task TestTypeWithoutDocumentationAsync(string typeName)
         {
             var testCode = @"
@@ -104,10 +123,7 @@ public async Task TestTypeWithoutDocumentationAsync(string typeName)
         }
 
         [Theory]
-        [InlineData("enum")]
-        [InlineData("class")]
-        [InlineData("struct")]
-        [InlineData("interface")]
+        [MemberData(nameof(BaseTypeDeclarationKeywords))]
         public async Task TestNonPartialTypeWithoutDocumentationAsync(string typeName)
         {
             var testCode = @"
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1607UnitTests.cs b/StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1607UnitTests.cs
@@ -3,10 +3,12 @@
 
 namespace StyleCop.Analyzers.Test.DocumentationRules
 {
+    using System.Collections.Generic;
     using System.Threading;
     using System.Threading.Tasks;
     using Microsoft.CodeAnalysis.Testing;
     using StyleCop.Analyzers.DocumentationRules;
+    using StyleCop.Analyzers.Lightup;
     using StyleCop.Analyzers.Test.Verifiers;
     using Xunit;
     using static StyleCop.Analyzers.Test.Verifiers.CustomDiagnosticVerifier<StyleCop.Analyzers.DocumentationRules.SA1607PartialElementDocumentationMustHaveSummaryText>;
@@ -16,10 +18,35 @@ namespace StyleCop.Analyzers.Test.DocumentationRules
     /// </summary>
     public class SA1607UnitTests
     {
+        public static IEnumerable<object[]> TypeDeclarationKeywords
+        {
+            get
+            {
+                yield return new[] { "class" };
+                yield return new[] { "struct" };
+                yield return new[] { "interface" };
+                if (LightupHelpers.SupportsCSharp9)
+                {
+                    yield return new[] { "record" };
+                }
+            }
+        }
+
+        public static IEnumerable<object[]> BaseTypeDeclarationKeywords
+        {
+            get
+            {
+                foreach (var keyword in TypeDeclarationKeywords)
+                {
+                    yield return keyword;
+                }
+
+                yield return new[] { "enum" };
+            }
+        }
+
         [Theory]
-        [InlineData("class")]
-        [InlineData("struct")]
-        [InlineData("interface")]
+        [MemberData(nameof(TypeDeclarationKeywords))]
         public async Task TestTypeNoDocumentationAsync(string typeName)
         {
             var testCode = @"
@@ -30,9 +57,7 @@ public async Task TestTypeNoDocumentationAsync(string typeName)
         }
 
         [Theory]
-        [InlineData("class")]
-        [InlineData("struct")]
-        [InlineData("interface")]
+        [MemberData(nameof(TypeDeclarationKeywords))]
         public async Task TestTypeWithSummaryDocumentationAsync(string typeName)
         {
             var testCode = @"
@@ -46,9 +71,7 @@ public async Task TestTypeWithSummaryDocumentationAsync(string typeName)
         }
 
         [Theory]
-        [InlineData("class")]
-        [InlineData("struct")]
-        [InlineData("interface")]
+        [MemberData(nameof(TypeDeclarationKeywords))]
         public async Task TestTypeWithContentDocumentationAsync(string typeName)
         {
             var testCode = @"
@@ -62,9 +85,7 @@ public async Task TestTypeWithContentDocumentationAsync(string typeName)
         }
 
         [Theory]
-        [InlineData("class")]
-        [InlineData("struct")]
-        [InlineData("interface")]
+        [MemberData(nameof(TypeDeclarationKeywords))]
         public async Task TestTypeWithInheritedDocumentationAsync(string typeName)
         {
             var testCode = @"
@@ -76,9 +97,7 @@ public async Task TestTypeWithInheritedDocumentationAsync(string typeName)
         }
 
         [Theory]
-        [InlineData("class")]
-        [InlineData("struct")]
-        [InlineData("interface")]
+        [MemberData(nameof(TypeDeclarationKeywords))]
         public async Task TestTypeWithoutSummaryDocumentationAsync(string typeName)
         {
             var testCode = @"
@@ -96,10 +115,7 @@ public async Task TestTypeWithoutSummaryDocumentationAsync(string typeName)
         }
 
         [Theory]
-        [InlineData("enum")]
-        [InlineData("class")]
-        [InlineData("struct")]
-        [InlineData("interface")]
+        [MemberData(nameof(BaseTypeDeclarationKeywords))]
         public async Task TestNonPartialTypeWithoutSummaryDocumentationAsync(string typeName)
         {
             var testCode = @"
@@ -114,9 +130,7 @@ public async Task TestNonPartialTypeWithoutSummaryDocumentationAsync(string type
         }
 
         [Theory]
-        [InlineData("class")]
-        [InlineData("struct")]
-        [InlineData("interface")]
+        [MemberData(nameof(TypeDeclarationKeywords))]
         public async Task TestTypeWithoutContentDocumentationAsync(string typeName)
         {
             var testCode = @"
@@ -134,10 +148,7 @@ public async Task TestTypeWithoutContentDocumentationAsync(string typeName)
         }
 
         [Theory]
-        [InlineData("enum")]
-        [InlineData("class")]
-        [InlineData("struct")]
-        [InlineData("interface")]
+        [MemberData(nameof(BaseTypeDeclarationKeywords))]
         public async Task TestNonPartialTypeWithoutContentDocumentationAsync(string typeName)
         {
             var testCode = @"
@@ -388,10 +399,10 @@ public partial class ClassName
             await VerifyCSharpDiagnosticAsync(testCode, DiagnosticResult.EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
         }
 
-        private static Task VerifyCSharpDiagnosticAsync(string source, DiagnosticResult expected, CancellationToken cancellationToken)
+        protected static Task VerifyCSharpDiagnosticAsync(string source, DiagnosticResult expected, CancellationToken cancellationToken)
             => VerifyCSharpDiagnosticAsync(source, new[] { expected }, cancellationToken);
 
-        private static Task VerifyCSharpDiagnosticAsync(string source, DiagnosticResult[] expected, CancellationToken cancellationToken)
+        protected static Task VerifyCSharpDiagnosticAsync(string source, DiagnosticResult[] expected, CancellationToken cancellationToken)
         {
             string contentWithoutSummaryOrContent = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
 <ClassName>
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1618UnitTests.cs b/StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1618UnitTests.cs
@@ -8,6 +8,7 @@ namespace StyleCop.Analyzers.Test.DocumentationRules
     using System.Threading.Tasks;
     using Microsoft.CodeAnalysis.Testing;
     using StyleCop.Analyzers.DocumentationRules;
+    using StyleCop.Analyzers.Lightup;
     using StyleCop.Analyzers.Test.Verifiers;
     using Xunit;
     using static StyleCop.Analyzers.Test.Verifiers.CustomDiagnosticVerifier<StyleCop.Analyzers.DocumentationRules.SA1618GenericTypeParametersMustBeDocumented>;
@@ -39,6 +40,11 @@ public static IEnumerable<object[]> Types
                 yield return new object[] { "class     Foo<Ta, T\\u0062> { }" };
                 yield return new object[] { "struct    Foo<Ta, T\\u0062> { }" };
                 yield return new object[] { "interface Foo<Ta, T\\u0062> { }" };
+                if (LightupHelpers.SupportsCSharp9)
+                {
+                    yield return new object[] { "record    Foo<Ta, Tb> { }" };
+                    yield return new object[] { "record    Foo<Ta, T\\u0062> { }" };
+                }
             }
         }
 
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1619UnitTests.cs b/StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1619UnitTests.cs
@@ -8,6 +8,7 @@ namespace StyleCop.Analyzers.Test.DocumentationRules
     using System.Threading.Tasks;
     using Microsoft.CodeAnalysis.Testing;
     using StyleCop.Analyzers.DocumentationRules;
+    using StyleCop.Analyzers.Lightup;
     using StyleCop.Analyzers.Test.Verifiers;
     using Xunit;
     using static StyleCop.Analyzers.Test.Verifiers.CustomDiagnosticVerifier<StyleCop.Analyzers.DocumentationRules.SA1619GenericTypeParametersMustBeDocumentedPartialClass>;
@@ -27,6 +28,11 @@ public static IEnumerable<object[]> Types
                 yield return new object[] { "class     Foo<Ta, T\\u0062> { }" };
                 yield return new object[] { "struct    Foo<Ta, T\\u0062> { }" };
                 yield return new object[] { "interface Foo<Ta, T\\u0062> { }" };
+                if (LightupHelpers.SupportsCSharp9)
+                {
+                    yield return new object[] { "record    Foo<Ta, Tb> { }" };
+                    yield return new object[] { "record    Foo<Ta, T\\u0062> { }" };
+                }
             }
         }
 
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers.Test/OrderingRules/SA1205UnitTests.cs b/StyleCop.Analyzers/StyleCop.Analyzers.Test/OrderingRules/SA1205UnitTests.cs
@@ -7,6 +7,7 @@ namespace StyleCop.Analyzers.Test.OrderingRules
     using System.Threading;
     using System.Threading.Tasks;
     using Microsoft.CodeAnalysis.Testing;
+    using StyleCop.Analyzers.Lightup;
     using StyleCop.Analyzers.OrderingRules;
     using Xunit;
     using static StyleCop.Analyzers.Test.Verifiers.StyleCopCodeFixVerifier<
@@ -45,6 +46,14 @@ public static IEnumerable<object[]> ValidDeclarations
                 yield return new object[] { "class" };
                 yield return new object[] { "struct" };
                 yield return new object[] { "interface" };
+                if (LightupHelpers.SupportsCSharp9)
+                {
+                    yield return new object[] { "public partial record" };
+                    yield return new object[] { "internal partial record" };
+                    yield return new object[] { "public sealed partial record" };
+                    yield return new object[] { "internal sealed partial record" };
+                    yield return new object[] { "record" };
+                }
             }
         }
 
@@ -57,6 +66,11 @@ public static IEnumerable<object[]> InvalidDeclarations
                 yield return new object[] { "static partial class" };
                 yield return new object[] { "partial struct" };
                 yield return new object[] { "partial interface" };
+                if (LightupHelpers.SupportsCSharp9)
+                {
+                    yield return new object[] { "partial record" };
+                    yield return new object[] { "sealed partial record" };
+                }
             }
         }
 
@@ -81,6 +95,15 @@ public static IEnumerable<object[]> ValidNestedDeclarations
                 yield return new object[] { "internal", "interface" };
                 yield return new object[] { "protected internal", "interface" };
                 yield return new object[] { "private", "interface" };
+
+                if (LightupHelpers.SupportsCSharp9)
+                {
+                    yield return new object[] { "public", "record" };
+                    yield return new object[] { "protected", "record" };
+                    yield return new object[] { "internal", "record" };
+                    yield return new object[] { "protected internal", "record" };
+                    yield return new object[] { "private", "record" };
+                }
             }
         }
 
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers.Test/ReadabilityRules/SA1137UnitTests.cs b/StyleCop.Analyzers/StyleCop.Analyzers.Test/ReadabilityRules/SA1137UnitTests.cs
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/ReadabilityRules/SA1137ElementsShouldHaveTheSameIndentation.cs b/StyleCop.Analyzers/StyleCop.Analyzers/ReadabilityRules/SA1137ElementsShouldHaveTheSameIndentation.cs
