Skip to content

Don't emit SA1414 for interface implementations #3644

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
merged 6 commits into from
May 18, 2023
Merged

Don't emit SA1414 for interface implementations #3644

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f395c71
Don't emit SA1414 for interface implementations
CollinAlpert Apr 19, 2023
22e8d6b
Added tests for explicit interface implementations and base classes.
CollinAlpert Apr 20, 2023
89e104f
Use DiagnosticResult.EmptyDiagnosticResults
CollinAlpert Apr 20, 2023
339938b
Extend test cases to cover return types.
CollinAlpert Apr 21, 2023
2543742
Only query semantic model when absolutely necessary.
CollinAlpert Apr 26, 2023
bda8c5a
Apply suggestions from code review
sharwell May 18, 2023
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
57 changes: 57 additions & 0 deletions ....Analyzers/StyleCop.Analyzers.Test.CSharp7/MaintainabilityRules/SA1414CSharp7UnitTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

namespace StyleCop.Analyzers.Test.CSharp7.MaintainabilityRules
{
using System;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.CodeAnalysis.Testing;
Expand Down Expand Up @@ -117,5 +118,61 @@ public static explicit operator TestClass({typeExpression} p1)

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

[Fact]
public async Task ValidateTuplesFromInterfaceAsync()
{
const string testCode = @"
using System.Collections.Generic;

namespace Test {
class StringTupleComparer : IEqualityComparer<(string, string)>
{
public bool Equals((string, string) x, (string, string) y) => throw null;

public int GetHashCode((string, string) obj) => throw null;
}
}";
await VerifyCSharpDiagnosticAsync(testCode, DiagnosticResult.EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
}

[Fact]
public async Task ValidateTuplesFromExplicitInterfaceImplementationAsync()
{
const string testCode = @"
using System.Collections.Generic;

namespace Test {
class StringTupleComparer : IEqualityComparer<(string, string)>
{
bool IEqualityComparer<(string, string)>.Equals((string, string) x, (string, string) y) => throw null;

int IEqualityComparer<(string, string)>.GetHashCode((string, string) obj) => throw null;
}
}";
await VerifyCSharpDiagnosticAsync(testCode, DiagnosticResult.EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
}

[Fact]
public async Task ValidateTuplesFromBaseClassAsync()
{
const string testCode = @"
namespace Test {
class A : B
{
public override (string, string) Run((string, string) x) => throw null;

public override (int, int) Run((int, int) y) => throw null;
}

abstract class B
{
public abstract ([|string|], [|string|]) Run(([|string|], [|string|]) x);

public virtual ([|int|], [|int|]) Run(([|int|], [|int|]) y) => throw null;
}
}";
await VerifyCSharpDiagnosticAsync(testCode, DiagnosticResult.EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
}
}
}
7 changes: 6 additions & 1 deletion ...eCop.Analyzers/MaintainabilityRules/SA1414TupleTypesInSignaturesShouldHaveElementNames.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ namespace StyleCop.Analyzers.MaintainabilityRules
{
using System;
using System.Collections.Immutable;
using System.Linq;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CSharp;
using Microsoft.CodeAnalysis.CSharp.Syntax;
Expand Down Expand Up @@ -62,6 +63,10 @@ private static void HandleMethodDeclaration(SyntaxNodeAnalysisContext context)
}

var methodDeclaration = (MethodDeclarationSyntax)context.Node;
if (methodDeclaration.Modifiers.Any(SyntaxKind.OverrideKeyword))
{
return;
}

CheckType(context, methodDeclaration.ReturnType);
CheckParameterList(context, methodDeclaration.ParameterList);
Expand Down Expand Up @@ -161,7 +166,7 @@ private static void CheckTupleType(SyntaxNodeAnalysisContext context, TupleTypeS
{
CheckType(context, tupleElementSyntax.Type);

if (tupleElementSyntax.Identifier.IsKind(SyntaxKind.None))
if (tupleElementSyntax.Identifier.IsKind(SyntaxKind.None) && !NamedTypeHelpers.IsImplementingAnInterfaceMember(context.SemanticModel.GetDeclaredSymbol(context.Node)))
{
var location = tupleElementSyntax.SyntaxNode.GetLocation();
context.ReportDiagnostic(Diagnostic.Create(Descriptor, location));
Expand Down