Skip to content
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.

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

Fix S1144: False Positive when private member is only used in a gener… #2320

Merged
merged 1 commit into from
Mar 6, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ protected override void Initialize(SonarAnalysisContext context)
// Collect symbols of private members that could potentially be removed
var removableSymbolsCollector = new CSharpRemovableSymbolWalker(c.Compilation.GetSemanticModel);

if (!VisitDeclaringReferences(namedType, removableSymbolsCollector, c.Compilation))
if (!VisitDeclaringReferences(namedType, removableSymbolsCollector, c.Compilation, includeGeneratedFile: false))
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't need to collect the members declared in generated files as we don't want to report about them...

{
return;
}
Expand All @@ -100,7 +100,7 @@ protected override void Initialize(SonarAnalysisContext context)
c.Compilation.GetSemanticModel,
removableSymbolsCollector.PrivateSymbols.Select(s => s.Name).ToHashSet());

if (!VisitDeclaringReferences(namedType, usageCollector, c.Compilation))
if (!VisitDeclaringReferences(namedType, usageCollector, c.Compilation, includeGeneratedFile: true))
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

... But we do want to collect the usages of other members even in generated files.

{
return;
}
Expand Down Expand Up @@ -286,9 +286,14 @@ private static string GetMemberType(ISymbol symbol)
}
}

private static bool VisitDeclaringReferences(INamedTypeSymbol namedType, CSharpSyntaxWalker visitor, Compilation compilation)
private static bool VisitDeclaringReferences(INamedTypeSymbol namedType, CSharpSyntaxWalker visitor, Compilation compilation,
bool includeGeneratedFile)
{
foreach (var reference in namedType.DeclaringSyntaxReferences.Where(r => !IsGenerated(r)))
var syntaxReferencesToVisit = includeGeneratedFile
? namedType.DeclaringSyntaxReferences
: namedType.DeclaringSyntaxReferences.Where(r => !IsGenerated(r));

foreach (var reference in syntaxReferencesToVisit)
{
if (!visitor.SafeVisit(reference.GetSyntax()))
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -190,5 +190,18 @@ public void UnusedPrivateMember_CodeFix()
new CS.UnusedPrivateMember(),
new CS.UnusedPrivateMemberCodeFixProvider());
}

[TestMethod]
[TestCategory("Rule")]
public void UnusedPrivateMember_UsedInGeneratedFile()
{
Verifier.VerifyAnalyzer(
new[]
{
@"TestCases\UnusedPrivateMember.CalledFromGenerated.cs",
@"TestCases\UnusedPrivateMember.Generated.cs"
},
new CS.UnusedPrivateMember());
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
using System;

namespace Tests.Diagnostics
{
public partial class MyClass
{
private void PrivateMethodOnlyCalledFromGenerated()
{
}

internal void InternalMethodOnlyCalledFromGenerated()
{
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
// <AUTO-GENERATED>
using System;

namespace Tests.Diagnostics
{
public partial class MyClass
{
public void Foo()
{
PrivateMethodOnlyCalledFromGenerated();
InternalMethodOnlyCalledFromGenerated();
}
}
}