Skip to content

Fixes false positives with public methods which are not allowed #82

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
Oct 15, 2017
Merged

Fixes false positives with public methods which are not allowed #82

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
9a5fafd
Fixes false positive detection of public methods which are not allowe…
4creators Sep 22, 2017
4b59d5b
Fixes addressing review, support for public static, no white space ch…
4creators Sep 22, 2017
50037e9
Revert vsix version change as requested in code review
4creators Sep 22, 2017
45ef7c6
Merge branch 'master' of https://github.com/xunit/xunit.analyzers int…
4creators Oct 15, 2017
22ba739
Address code review feedback, add test, rebase to master HEAD
4creators Oct 15, 2017
9ccd153
Add comment explaining redundant usage of IsAbstract check in diagnos…
4creators Oct 15, 2017
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
9 changes: 7 additions & 2 deletions src/xunit.analyzers/PublicMethodShouldBeMarkedAsTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ internal override void AnalyzeCompilation(CompilationStartAnalysisContext compil
var type = (INamedTypeSymbol)symbolContext.Symbol;

if (type.TypeKind != TypeKind.Class ||
type.DeclaredAccessibility != Accessibility.Public)
type.DeclaredAccessibility != Accessibility.Public ||
type.IsAbstract)
return;

var methodsToIgnore = interfacesToIgnore.Where(i => i != null && type.AllInterfaces.Contains(i))
Expand All @@ -42,7 +43,11 @@ internal override void AnalyzeCompilation(CompilationStartAnalysisContext compil
symbolContext.CancellationToken.ThrowIfCancellationRequested();

var method = (IMethodSymbol)member;
if (method.MethodKind != MethodKind.Ordinary)
// Check for method.IsAbstract and earlier for type.IsAbstract is done
// twice to enable better diagnostics during code editing. It is useful with
// incomplete code for abstract types - missing abstract keyword on type
// or on abstract method
if (method.MethodKind != MethodKind.Ordinary || method.IsAbstract)
continue;

var isTestMethod = method.GetAttributes().ContainsAttributeType(xunitContext.FactAttributeType);
Expand Down
26 changes: 25 additions & 1 deletion test/xunit.analyzers.tests/PublicMethodShouldBeMarkedAsTestTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Microsoft.CodeAnalysis;
using System;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.Diagnostics;

namespace Xunit.Analyzers
Expand Down Expand Up @@ -37,6 +38,29 @@ public void Dispose() { }
Assert.Empty(diagnostics);
}

[Fact]
public async void DoesNotFindErrorForPublicAbstractMethod()
{
var diagnostics = await CodeAnalyzerHelper.GetDiagnosticsAsync(analyzer,
@"public abstract class TestClass {
[Xunit.Fact] public void TestMethod() { }
public abstract void AbstractMethod();
}");

Assert.Empty(diagnostics);
}

Copy link
Contributor

@jamesqo jamesqo Sep 25, 2017 •
edited
Loading

Choose a reason for hiding this comment

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

Would be good to also add this test:

        [Fact]
        public async void DoesNotFindErrorForPublicAbstractMethodMarkedWithFact()
        {
            var diagnostics = await CodeAnalyzerHelper.GetDiagnosticsAsync(analyzer,
@"public abstract class TestClass {
    [Xunit.Fact] public void TestMethod() { }
    [Xunit.Fact] public abstract void AbstractTestMethod();
}");
            Assert.Empty(diagnostics);
        }

I can't test right now but that should work fine at runtime, since the [Fact] attribute is inherited on overriding members.

Copy link
Contributor Author

@4creators 4creators Oct 15, 2017 •
edited
Loading

Choose a reason for hiding this comment

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

OK it makes sense

[Fact]
public async void DoesNotFindErrorForPublicAbstractMethodMarkedWithFact()
{
var diagnostics = await CodeAnalyzerHelper.GetDiagnosticsAsync(analyzer,
@"public abstract class TestClass {
[Xunit.Fact] public void TestMethod() { }
[Xunit.Fact] public abstract void AbstractMethod();
}");
Assert.Empty(diagnostics);
}

[Fact]
public async void DoesNotFindErrorForIDisposableDisposeMethodOverrideFromParentClass()
{
Expand Down