Make SA1117 work with multiline arguments (fix #3106)

Author: pantosha

StyleCop.Analyzers/StyleCop.Analyzers.Test/ReadabilityRules/SA1117UnitTests.cs

@@ -1,10 +1,6 @@
 // Copyright (c) Tunnel Vision Laboratories, LLC. All Rights Reserved.
 // Licensed under the Apache License, Version 2.0. See LICENSE in the project root for license information.
 
-// Several test methods in this file use the same member data, but in some cases the test does not use all of the
-// supported parameters. See https://github.com/xunit/xunit/issues/1556.
-#pragma warning disable xUnit1026 // Theory methods should use all of their parameters
-
 namespace StyleCop.Analyzers.Test.ReadabilityRules
 {
     using System.Collections.Generic;
@@ -19,36 +15,73 @@ public class SA1117UnitTests
     {
         public static IEnumerable<object[]> GetTestDeclarations(string delimiter)
         {
-            yield return new object[] { $"public Foo(int a, int b,{delimiter} string s) {{ }}" };
-            yield return new object[] { $"public object Bar(int a, int b,{delimiter} string s) => null;" };
-            yield return new object[] { $"public object this[int a, int b,{delimiter} string s] => null;" };
-            yield return new object[] { $"public delegate void Bar(int a, int b,{delimiter} string s);" };
+            yield return new object[] { $"public Foo(int a, int b,{delimiter} string s) {{ }}", 5, 2 };
+            yield return new object[] { $"public object Bar(int a, int b,{delimiter} string s) => null;", 5, 2 };
+            yield return new object[] { $"public object this[int a, int b,{delimiter} string s] => null;", 5, 2 };
+            yield return new object[] { $"public delegate void Bar(int a, int b,{delimiter} string s);", 5, 2 };
+        }
+
+        public static IEnumerable<object[]> GetMultilineTestDeclarations(string delimiter)
+        {
+            yield return new object[] { $"public Foo(int a,{delimiter} string\r\ns) {{ }}", 4, 23 };
+            yield return new object[] { $"public object Bar(int a,{delimiter} string\r\ns) => null;", 4, 30 };
+            yield return new object[] { $"public object this[int a,{delimiter} string\r\ns] => null;", 4, 31 };
+            yield return new object[] { $"public delegate void Bar(int a,{delimiter} string\r\ns);", 4, 37 };
         }
 
         public static IEnumerable<object[]> GetTestConstructorInitializers(string delimiter)
         {
-            yield return new object[] { $"this(42, 43, {delimiter} \"hello\")" };
-            yield return new object[] { $"base(42, 43, {delimiter} \"hello\")" };
+            yield return new object[] { $"this(42, 43, {delimiter} \"hello\")", 13, 2 };
+            yield return new object[] { $"base(42, 43, {delimiter} \"hello\")", 13, 2 };
+        }
+
+        public static IEnumerable<object[]> GetMultilineTestConstructorInitializers(string delimiter)
+        {
+            yield return new object[] { $"this(42\r\n+ 1, {delimiter} 43, {delimiter} \"hello\")", 13, 7 };
+            yield return new object[] { $"base(42\r\n+ 1, {delimiter} 43, {delimiter} \"hello\")", 13, 7 };
         }
 
         public static IEnumerable<object[]> GetTestExpressions(string delimiter)
         {
-            yield return new object[] { $"Bar(1, 2, {delimiter} 2)", 13 };
-            yield return new object[] { $"System.Action<int, int, int> func = (int x, int y, {delimiter} int z) => Bar(x, y, z)", 41 };
-            yield return new object[] { $"System.Action<int, int, int> func = delegate(int x, int y, {delimiter} int z) {{ Bar(x, y, z); }}", 49 };
-            yield return new object[] { $"new System.DateTime(2015, 9, {delimiter} 14)", 20 };
-            yield return new object[] { $"var arr = new string[2, 2, {delimiter} 2];", 30 };
-            yield return new object[] { $"char cc = (new char[3, 3, 3])[2, 2,{delimiter} 2];", 36 };
-            yield return new object[] { $"char? c = (new char[3, 3, 3])?[2, 2,{delimiter} 2];", 37 };
-            yield return new object[] { $"long ll = this[2, 2,{delimiter} 2];", 24 };
+            yield return new object[] { $"Bar(1, 2, {delimiter} 2)", 11, 2 };
+            yield return new object[] { $"System.Action<int, int, int> func = (int x, int y, {delimiter} int z) => Bar(x, y, z)", 11, 2 };
+            yield return new object[] { $"System.Action<int, int, int> func = delegate(int x, int y, {delimiter} int z) {{ Bar(x, y, z); }}", 11, 2 };
+            yield return new object[] { $"new System.DateTime(2015, 9, {delimiter} 14)", 11, 2 };
+            yield return new object[] { $"var arr = new string[2, 2, {delimiter} 2];", 11, 2 };
+            yield return new object[] { $"char cc = (new char[3, 3, 3])[2, 2,{delimiter} 2];", 11, 2 };
+            yield return new object[] { $"char? c = (new char[3, 3, 3])?[2, 2,{delimiter} 2];", 11, 2 };
+            yield return new object[] { $"long ll = this[2, 2,{delimiter} 2];", 11, 2 };
+        }
+
+        public static IEnumerable<object[]> GetMultilineTestExpressions(string delimiter)
+        {
+            yield return new object[] { $"System.Action<int, int, int> func = (int x, {delimiter} int y, {delimiter} int\r\nz) => Bar(x, y, z)", 10, 62 };
+            yield return new object[] { $"System.Action<int, int, int> func = delegate(int x, {delimiter} int y, {delimiter} int\r\nz) {{ Bar(x, y, z); }}", 10, 70 };
+            yield return new object[] { $"var arr = new string[2, {delimiter} 2\r\n+ 2];", 10, 34 };
+            yield return new object[] { $"char cc = (new char[3, 3])[2, {delimiter} 2\r\n+ 2];", 10, 40 };
+            yield return new object[] { $"char? c = (new char[3, 3])?[2, {delimiter} 2\r\n+ 2];", 10, 41 };
+            yield return new object[] { $"long ll = this[2,{delimiter} 2,{delimiter} 2\r\n+ 1];", 10, 30 };
+            yield return new object[] { $"var str = string.Join(\r\n\"abc\"\r\n + \"cba\",{delimiter}\"def\");", 12, 10 };
+            yield return new object[] { $"var str = string.Join(\r\n\"def\",{delimiter}\"abc\"\r\n + \"cba\");", 11, 7 };
+            yield return new object[] { $"Bar(\r\n1\r\n + 2,{delimiter}3,\r\n 4);", 12, 6 };
+        }
+
+        public static IEnumerable<object[]> GetTestAttributes(string delimiter)
+        {
+            yield return new object[] { $"[MyAttribute(1, {delimiter}2, 3)]", 11, 4 };
+        }
+
+        public static IEnumerable<object[]> GetMultilineTestAttributes(string delimiter)
+        {
+            yield return new object[] { $"[MyAttribute(1, {delimiter}2, {delimiter}3\r\n+ 5)]", 10, 20 };
         }
 
         public static IEnumerable<object[]> ValidTestExpressions()
         {
-            yield return new object[] { $"System.Action func = () => Bar(0, 2, 3)", 0 };
-            yield return new object[] { $"System.Action<int> func = x => Bar(x, 2, 3)", 0 };
-            yield return new object[] { $"System.Action func = delegate {{ Bar(0, 0, 0); }}", 0 };
-            yield return new object[] { "var weird = new int[10][,,,];", 0 };
+            yield return new object[] { $"System.Action func = () => Bar(0, 2, 3)", 0, 0 };
+            yield return new object[] { $"System.Action<int> func = x => Bar(x, 2, 3)", 0, 0 };
+            yield return new object[] { $"System.Action func = delegate {{ Bar(0, 0, 0); }}", 0, 0 };
+            yield return new object[] { "var weird = new int[10][,,,];", 0, 0 };
         }
 
         public static IEnumerable<object[]> ValidTestDeclarations()
@@ -57,21 +90,52 @@ public static IEnumerable<object[]> ValidTestDeclarations()
             {
                 $@"public Foo(
     int a, int b, string s) {{ }}",
+                0,
+                0,
             };
             yield return new object[]
             {
                 $@"public Foo(
     int a,
     int b,
     string s) {{ }}",
+                0,
+                0,
+            };
+        }
+
+        public static IEnumerable<object[]> ValidTestAttribute()
+        {
+            // This is a regression test for https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/1211
+            yield return new object[] { @"[System.Obsolete]", 0, 0 };
+            yield return new object[]
+            {
+                @"[MyAttribute(
+    1, 2, 3)]",
+                0,
+                0,
+            };
+            yield return new object[]
+            {
+                @"[MyAttribute(
+    1,
+    2,
+    3)]",
+                0,
+                0,
             };
         }
 
         [Theory]
         [MemberData(nameof(GetTestDeclarations), "")]
+        [MemberData(nameof(GetMultilineTestDeclarations), "\r\n")]
         [MemberData(nameof(ValidTestDeclarations))]
-        public async Task TestValidDeclarationAsync(string declaration)
+        public async Task TestValidDeclarationAsync(string declaration, int row, int column)
         {
+            // Not needed for this test
+            _ = row;
+            _ = column;
+
             var testCode = $@"
 class Foo
 {{
@@ -82,22 +146,28 @@ class Foo
 
         [Theory]
         [MemberData(nameof(GetTestDeclarations), "\r\n")]
-        public async Task TestInvalidDeclarationAsync(string declaration)
+        [MemberData(nameof(GetMultilineTestDeclarations), "")]
+        public async Task TestInvalidDeclarationAsync(string declaration, int row, int column)
         {
             var testCode = $@"
 class Foo
 {{
     {declaration}
 }}";
 
-            DiagnosticResult expected = Diagnostic().WithLocation(5, 2);
+            DiagnosticResult expected = Diagnostic().WithLocation(row, column);
             await VerifyCSharpDiagnosticAsync(testCode, expected, CancellationToken.None).ConfigureAwait(false);
         }
 
         [Theory]
         [MemberData(nameof(GetTestConstructorInitializers), "")]
-        public async Task TestValidConstructorInitializerAsync(string initializer)
+        [MemberData(nameof(GetMultilineTestConstructorInitializers), "\r\n")]
+        public async Task TestValidConstructorInitializerAsync(string initializer, int row, int column)
         {
+            // Not needed for this test
+            _ = row;
+            _ = column;
+
             var testCode = $@"
 class Base
 {{
@@ -124,7 +194,8 @@ public Derived(int i, int j, string z)
 
         [Theory]
         [MemberData(nameof(GetTestConstructorInitializers), "\r\n")]
-        public async Task TestInvalidConstructorInitializerAsync(string initializer)
+        [MemberData(nameof(GetMultilineTestConstructorInitializers), "")]
+        public async Task TestInvalidConstructorInitializerAsync(string initializer, int row, int column)
         {
             var testCode = $@"
 class Base
@@ -147,16 +218,18 @@ public Derived(int i, int j, string z)
     }}
 }}";
 
-            DiagnosticResult expected = Diagnostic().WithLocation(13, 2);
+            DiagnosticResult expected = Diagnostic().WithLocation(row, column);
             await VerifyCSharpDiagnosticAsync(testCode, expected, CancellationToken.None).ConfigureAwait(false);
         }
 
         [Theory]
         [MemberData(nameof(GetTestExpressions), "")]
+        [MemberData(nameof(GetMultilineTestExpressions), "\r\n")]
         [MemberData(nameof(ValidTestExpressions))]
-        public async Task TestValidExpressionAsync(string expression, int column)
+        public async Task TestValidExpressionAsync(string expression, int row, int column)
         {
             // Not needed for this test
+            _ = row;
             _ = column;
 
             var testCode = $@"
@@ -179,11 +252,9 @@ public void Baz()
 
         [Theory]
         [MemberData(nameof(GetTestExpressions), "\r\n")]
-        public async Task TestInvalidExpressionAsync(string expression, int column)
+        [MemberData(nameof(GetMultilineTestExpressions), "")]
+        public async Task TestInvalidExpressionAsync(string expression, int row, int column)
         {
-            // Not needed for this test
-            _ = column;
-
             var testCode = $@"
 class Foo
 {{
@@ -199,56 +270,58 @@ public void Baz()
     public long this[int a, int b, int s] => a + b + s;
 }}";
 
-            DiagnosticResult expected = Diagnostic().WithLocation(11, 2);
+            DiagnosticResult expected = Diagnostic().WithLocation(row, column);
             await VerifyCSharpDiagnosticAsync(testCode, expected, CancellationToken.None).ConfigureAwait(false);
         }
 
-        [Fact]
-        public async Task TestValidAttributeAsync()
+        [Theory]
+        [MemberData(nameof(GetTestAttributes), "")]
+        [MemberData(nameof(GetMultilineTestAttributes), "\r\n")]
+        [MemberData(nameof(ValidTestAttribute))]
+        public async Task TestValidAttributeAsync(string attribute, int row, int column)
         {
-            var testCode = @"
+            // Not needed for this test
+            _ = row;
+            _ = column;
+
+            var testCode = $@"
 [System.AttributeUsage(System.AttributeTargets.Class)]
 public class MyAttribute : System.Attribute
-{
+{{
     public MyAttribute(int a, int b, int c)
-    {
-    }
-}
+    {{
+    }}
+}}
 
-[MyAttribute(1, 2, 3)]
+{attribute}
 class Foo
-{
-}
-
-// This is a regression test for https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/1211
-[System.Obsolete]
-class ObsoleteType
-{
-}";
+{{
+}}";
 
             await VerifyCSharpDiagnosticAsync(testCode, DiagnosticResult.EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
         }
 
-        [Fact]
-        public async Task TestInvalidAttributeAsync()
+        [Theory]
+        [MemberData(nameof(GetTestAttributes), "\r\n")]
+        [MemberData(nameof(GetMultilineTestAttributes), "")]
+        public async Task TestInvalidAttributeAsync(string attribute, int row, int column)
         {
-            var testCode = @"
+            var testCode = $@"
 [System.AttributeUsage(System.AttributeTargets.Class)]
 public class MyAttribute : System.Attribute
-{
+{{
     public MyAttribute(int a, int b, int c)
-    {
-    }
-}
+    {{
+    }}
+}}
 
-[MyAttribute(
-    1,
-    2, 3)]
+{attribute}
 class Foo
-{
-}";
+{{
+}}";
+
+            DiagnosticResult expected = Diagnostic().WithLocation(row, column);
 
-            DiagnosticResult expected = Diagnostic().WithLocation(12, 8);
             await VerifyCSharpDiagnosticAsync(testCode, expected, CancellationToken.None).ConfigureAwait(false);
         }
     }