Skip to content

Make SA1117 work with multiline arguments #3115

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sharwell merged 4 commits into from
Sep 28, 2020
Merged

Make SA1117 work with multiline arguments #3115

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0b2b098
Make SA1117 work with multiline arguments (fix #3106)
pantosha Feb 7, 2020
db9d500
Merge remote-tracking branch 'DotNetAnalyzers/master' into fix-3106
sharwell Sep 28, 2020
ce0b2b0
Avoid boxing SeparatedSyntaxList<T>
sharwell Sep 28, 2020
0234741
Only compare starting positions for "on same line"
sharwell Sep 28, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
115 changes: 87 additions & 28 deletions StyleCop.Analyzers/StyleCop.Analyzers.Test/ReadabilityRules/SA1117UnitTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,26 @@ public static IEnumerable<object[]> GetTestDeclarations(string delimiter)
yield return new object[] { $"public delegate void Bar(int a, int b,{delimiter} {{|#0:string s|}});" };
}

public static IEnumerable<object[]> GetMultilineTestDeclarations(string delimiter)
{
yield return new object[] { $"public Foo(int a,{delimiter} {{|#0:string\r\ns|}}) {{ }}" };
yield return new object[] { $"public object Bar(int a,{delimiter} {{|#0:string\r\ns|}}) => null;" };
yield return new object[] { $"public object this[int a,{delimiter} {{|#0:string\r\ns|}}] => null;" };
yield return new object[] { $"public delegate void Bar(int a,{delimiter} {{|#0:string\r\ns|}});" };
}

public static IEnumerable<object[]> GetTestConstructorInitializers(string delimiter)
{
yield return new object[] { $"this(42, 43, {delimiter} {{|#0:\"hello\"|}})" };
yield return new object[] { $"base(42, 43, {delimiter} {{|#0:\"hello\"|}})" };
}

public static IEnumerable<object[]> GetMultilineTestConstructorInitializers(string delimiter)
{
yield return new object[] { $"this(42\r\n+ 1, {delimiter} {{|#0:43|}}, {delimiter} \"hello\")" };
yield return new object[] { $"base(42\r\n+ 1, {delimiter} {{|#0:43|}}, {delimiter} \"hello\")" };
}

public static IEnumerable<object[]> GetTestExpressions(string delimiter)
{
yield return new object[] { $"Bar(1, 2, {delimiter} {{|#0:2|}})" };
Expand All @@ -38,6 +52,29 @@ public static IEnumerable<object[]> GetTestExpressions(string delimiter)
yield return new object[] { $"long ll = this[2, 2,{delimiter} {{|#0:2|}}];" };
}

public static IEnumerable<object[]> GetMultilineTestExpressions(string delimiter)
{
yield return new object[] { $"System.Action<int, int, int> func = (int x, {delimiter} int y, {delimiter} {{|#0:int\r\nz|}}) => Bar(x, y, z)" };
yield return new object[] { $"System.Action<int, int, int> func = delegate(int x, {delimiter} int y, {delimiter} {{|#0:int\r\nz|}}) {{ Bar(x, y, z); }}" };
yield return new object[] { $"var arr = new string[2, {delimiter} {{|#0:2\r\n+ 2|}}];" };
yield return new object[] { $"char cc = (new char[3, 3])[2, {delimiter} {{|#0:2\r\n+ 2|}}];" };
yield return new object[] { $"char? c = (new char[3, 3])?[2, {delimiter} {{|#0:2\r\n+ 2|}}];" };
yield return new object[] { $"long ll = this[2,{delimiter} 2,{delimiter} {{|#0:2\r\n+ 1|}}];" };
yield return new object[] { $"var str = string.Join(\r\n\"abc\"\r\n + \"cba\",{delimiter}{{|#0:\"def\"|}});" };
yield return new object[] { $"var str = string.Join(\r\n\"def\",{delimiter}{{|#0:\"abc\"\r\n + \"cba\"|}});" };
yield return new object[] { $"Bar(\r\n1\r\n + 2,{delimiter}{{|#0:3|}},\r\n 4);" };
}

public static IEnumerable<object[]> GetTestAttributes(string delimiter)
{
yield return new object[] { $"[MyAttribute(1, {delimiter}2, {{|#0:3|}})]" };
}

public static IEnumerable<object[]> GetMultilineTestAttributes(string delimiter)
{
yield return new object[] { $"[MyAttribute(1, {delimiter}2, {delimiter}{{|#0:3\r\n+ 5|}})]" };
}

public static IEnumerable<object[]> ValidTestExpressions()
{
yield return new object[] { $"System.Action func = () => Bar(0, 2, 3)" };
Expand All @@ -62,8 +99,27 @@ public static IEnumerable<object[]> ValidTestDeclarations()
};
}

public static IEnumerable<object[]> ValidTestAttribute()
{
// This is a regression test for https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/1211
yield return new object[] { @"[System.Obsolete]" };
yield return new object[]
{
@"[MyAttribute(
1, 2, 3)]",
};
yield return new object[]
{
@"[MyAttribute(
1,
2,
3)]",
};
}

[Theory]
[MemberData(nameof(GetTestDeclarations), "")]
[MemberData(nameof(GetMultilineTestDeclarations), "\r\n")]
[MemberData(nameof(ValidTestDeclarations))]
public async Task TestValidDeclarationAsync(string declaration)
{
Expand All @@ -77,6 +133,7 @@ class Foo

[Theory]
[MemberData(nameof(GetTestDeclarations), "\r\n")]
[MemberData(nameof(GetMultilineTestDeclarations), "")]
public async Task TestInvalidDeclarationAsync(string declaration)
{
var testCode = $@"
Expand All @@ -91,6 +148,7 @@ class Foo

[Theory]
[MemberData(nameof(GetTestConstructorInitializers), "")]
[MemberData(nameof(GetMultilineTestConstructorInitializers), "\r\n")]
public async Task TestValidConstructorInitializerAsync(string initializer)
{
var testCode = $@"
Expand Down Expand Up @@ -119,6 +177,7 @@ public Derived(int i, int j, string z)

[Theory]
[MemberData(nameof(GetTestConstructorInitializers), "\r\n")]
[MemberData(nameof(GetMultilineTestConstructorInitializers), "")]
public async Task TestInvalidConstructorInitializerAsync(string initializer)
{
var testCode = $@"
Expand Down Expand Up @@ -148,6 +207,7 @@ public Derived(int i, int j, string z)

[Theory]
[MemberData(nameof(GetTestExpressions), "")]
[MemberData(nameof(GetMultilineTestExpressions), "\r\n")]
[MemberData(nameof(ValidTestExpressions))]
public async Task TestValidExpressionAsync(string expression)
{
Expand All @@ -171,6 +231,7 @@ public void Baz()

[Theory]
[MemberData(nameof(GetTestExpressions), "\r\n")]
[MemberData(nameof(GetMultilineTestExpressions), "")]
public async Task TestInvalidExpressionAsync(string expression)
{
var testCode = $@"
Expand All @@ -192,52 +253,50 @@ public void Baz()
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)
{
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
{
}

// 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)
{
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, {|#0:3|})]
{attribute}
class Foo
{
}";
{{
}}";

DiagnosticResult expected = Diagnostic().WithLocation(0);

await VerifyCSharpDiagnosticAsync(testCode, expected, CancellationToken.None).ConfigureAwait(false);
}
}
Expand Down
Loading