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.

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

Jump to bottom

GH-219 - handling protected internal constructors when analyzing NS2001 diagnostic #221

Merged
merged 1 commit into from
May 3, 2024
Merged

GH-219 - handling protected internal constructors when analyzing NS2001 diagnostic #221

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
17 changes: 4 additions & 13 deletions src/NSubstitute.Analyzers.Shared/DiagnosticAnalyzers/SubstituteConstructorAnalysis.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,22 +93,13 @@ private IMethodSymbol[] GetAccessibleConstructors(ITypeSymbol genericArgument)
{
var internalsVisibleToProxy = genericArgument.InternalsVisibleToProxyGenerator();

bool IsAccessible(IMethodSymbol symbol) => symbol.DeclaredAccessibility is Accessibility.Protected or Accessibility.Public;

bool IsVisibleToProxy(IMethodSymbol symbol)
{
if (internalsVisibleToProxy == false)
{
return false;
}

return symbol.DeclaredAccessibility is Accessibility.Internal or Accessibility.ProtectedOrInternal;
}

return genericArgument.GetMembers().OfType<IMethodSymbol>().Where(symbol =>
symbol.MethodKind == MethodKind.Constructor &&
symbol.IsStatic == false &&
(IsAccessible(symbol) || IsVisibleToProxy(symbol))).ToArray();
(symbol.DeclaredAccessibility == Accessibility.Protected ||
symbol.DeclaredAccessibility == Accessibility.Public ||
symbol.DeclaredAccessibility == Accessibility.ProtectedOrInternal ||
(internalsVisibleToProxy && symbol.DeclaredAccessibility == Accessibility.Internal))).ToArray();
}

private ITypeSymbol[] GetTypeSymbols(IArrayCreationOperation arrayInitializerOperation)
Expand Down
30 changes: 27 additions & 3 deletions ...s.Tests.CSharp/DiagnosticAnalyzerTests/SubstituteAnalyzerTests/ForAsGenericMethodTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,7 @@ public void Test()
await VerifyDiagnostic(source, SubstituteForWithoutAccessibleConstructorDescriptor, "Could not find accessible constructor. Make sure that type MyNamespace.Foo exposes public or protected constructors.");
}

public override async Task ReportsDiagnostic_WhenUsedForClassWithProtectedInternalConstructor_AndInternalsVisibleToNotApplied()
public override async Task ReportsNoDiagnostics_WhenUsedForClassWithProtectedInternalConstructor_AndInternalsVisibleToNotApplied()
{
var source = @"using NSubstitute;

Expand All @@ -291,11 +291,11 @@ public class FooTests
{
public void Test()
{
var substitute = [|NSubstitute.Substitute.For<Foo>()|];
var substitute = NSubstitute.Substitute.For<Foo>();
}
}
}";
await VerifyDiagnostic(source, SubstituteForWithoutAccessibleConstructorDescriptor, "Could not find accessible constructor. Make sure that type MyNamespace.Foo exposes public or protected constructors.");
await this.VerifyNoDiagnostic(source);
}

public override async Task ReportsNoDiagnostic_WhenUsedForClassWithInternalConstructor_AndInternalsVisibleToApplied()
Expand Down Expand Up @@ -350,6 +350,30 @@ public void Test()
await VerifyNoDiagnostic(source);
}

public override async Task ReportsNoDiagnostic_WhenUsedForClassWithProtectedConstructor()
{
var source = @"using NSubstitute;

namespace MyNamespace
{
public class Foo
{
protected Foo()
{
}
}

public class FooTests
{
public void Test()
{
var substitute = NSubstitute.Substitute.For<Foo>();
}
}
}";
await VerifyNoDiagnostic(source);
}

[Fact]
public override async Task ReportsDiagnostic_WhenPassedParametersCount_GreaterThanCtorParametersCount()
{
Expand Down
36 changes: 31 additions & 5 deletions ...ests.CSharp/DiagnosticAnalyzerTests/SubstituteAnalyzerTests/ForAsNonGenericMethodTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -370,7 +370,7 @@ public void Test()
await VerifyDiagnostic(source, SubstituteForWithoutAccessibleConstructorDescriptor, "Could not find accessible constructor. Make sure that type MyNamespace.Foo exposes public or protected constructors.");
}

public override async Task ReportsDiagnostic_WhenUsedForClassWithProtectedInternalConstructor_AndInternalsVisibleToNotApplied()
public override async Task ReportsNoDiagnostics_WhenUsedForClassWithProtectedInternalConstructor_AndInternalsVisibleToNotApplied()
{
var source = @"using NSubstitute;

Expand All @@ -387,13 +387,13 @@ public class FooTests
{
public void Test()
{
var substitute = [|NSubstitute.Substitute.For(new [] { typeof(Foo) }, null)|];
var otherSubstitute = [|NSubstitute.Substitute.For(typesToProxy: new [] { typeof(Foo) }, constructorArguments: null)|];
var yetAnotherSubstitute = [|NSubstitute.Substitute.For(constructorArguments: null, typesToProxy: new [] { typeof(Foo) })|];
var substitute = NSubstitute.Substitute.For(new [] { typeof(Foo) }, null);
var otherSubstitute = NSubstitute.Substitute.For(typesToProxy: new [] { typeof(Foo) }, constructorArguments: null);
var yetAnotherSubstitute = NSubstitute.Substitute.For(constructorArguments: null, typesToProxy: new [] { typeof(Foo) });
}
}
}";
await VerifyDiagnostic(source, SubstituteForWithoutAccessibleConstructorDescriptor, "Could not find accessible constructor. Make sure that type MyNamespace.Foo exposes public or protected constructors.");
await VerifyNoDiagnostic(source);
}

public override async Task ReportsNoDiagnostic_WhenUsedForClassWithInternalConstructor_AndInternalsVisibleToApplied()
Expand Down Expand Up @@ -452,6 +452,32 @@ public void Test()
await VerifyNoDiagnostic(source);
}

public override async Task ReportsNoDiagnostic_WhenUsedForClassWithProtectedConstructor()
{
var source = @"using NSubstitute;

namespace MyNamespace
{
public class Foo
{
protected Foo()
{
}
}

public class FooTests
{
public void Test()
{
var substitute = NSubstitute.Substitute.For(new [] { typeof(Foo) }, null);
var otherSubstitute = NSubstitute.Substitute.For(typesToProxy: new [] { typeof(Foo) }, constructorArguments: null);
var yetAnotherSubstitute = NSubstitute.Substitute.For(constructorArguments: null, typesToProxy: new [] { typeof(Foo) });
}
}
}";
await VerifyNoDiagnostic(source);
}

[Fact]
public override async Task ReportsDiagnostic_WhenPassedParametersCount_GreaterThanCtorParametersCount()
{
Expand Down
30 changes: 27 additions & 3 deletions ...ers.Tests.CSharp/DiagnosticAnalyzerTests/SubstituteAnalyzerTests/ForPartsOfMethodTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ public void Test()
await VerifyDiagnostic(source, SubstituteForWithoutAccessibleConstructorDescriptor, "Could not find accessible constructor. Make sure that type MyNamespace.Foo exposes public or protected constructors.");
}

public override async Task ReportsDiagnostic_WhenUsedForClassWithProtectedInternalConstructor_AndInternalsVisibleToNotApplied()
public override async Task ReportsNoDiagnostics_WhenUsedForClassWithProtectedInternalConstructor_AndInternalsVisibleToNotApplied()
{
var source = @"using NSubstitute;

Expand All @@ -115,11 +115,11 @@ public class FooTests
{
public void Test()
{
var substitute = [|NSubstitute.Substitute.ForPartsOf<Foo>()|];
var substitute = NSubstitute.Substitute.ForPartsOf<Foo>();
}
}
}";
await VerifyDiagnostic(source, SubstituteForWithoutAccessibleConstructorDescriptor, "Could not find accessible constructor. Make sure that type MyNamespace.Foo exposes public or protected constructors.");
await VerifyNoDiagnostic(source);
}

public override async Task ReportsNoDiagnostic_WhenUsedForClassWithInternalConstructor_AndInternalsVisibleToApplied()
Expand Down Expand Up @@ -176,6 +176,30 @@ public void Test()
await VerifyNoDiagnostic(source);
}

public override async Task ReportsNoDiagnostic_WhenUsedForClassWithProtectedConstructor()
{
var source = @"using NSubstitute;

namespace MyNamespace
{
public class Foo
{
protected Foo()
{
}
}

public class FooTests
{
public void Test()
{
var substitute = NSubstitute.Substitute.ForPartsOf<Foo>();
}
}
}";
await VerifyNoDiagnostic(source);
}

[Fact]
public override async Task ReportsDiagnostic_WhenPassedParametersCount_GreaterThanCtorParametersCount()
{
Expand Down
5 changes: 4 additions & 1 deletion ...ts.CSharp/DiagnosticAnalyzerTests/SubstituteAnalyzerTests/SubstituteDiagnosticVerifier.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,17 @@ public abstract class SubstituteDiagnosticVerifier : CSharpDiagnosticVerifier, I
public abstract Task ReportsDiagnostic_WhenUsedForClassWithInternalConstructor_AndInternalsVisibleToNotApplied();

[Fact]
public abstract Task ReportsDiagnostic_WhenUsedForClassWithProtectedInternalConstructor_AndInternalsVisibleToNotApplied();
public abstract Task ReportsNoDiagnostics_WhenUsedForClassWithProtectedInternalConstructor_AndInternalsVisibleToNotApplied();

[Fact]
public abstract Task ReportsNoDiagnostic_WhenUsedForClassWithInternalConstructor_AndInternalsVisibleToApplied();

[Fact]
public abstract Task ReportsNoDiagnostic_WhenUsedForClassWithProtectedInternalConstructor_AndInternalsVisibleToApplied();

[Fact]
public abstract Task ReportsNoDiagnostic_WhenUsedForClassWithProtectedConstructor();

[Fact]
public abstract Task ReportsDiagnostic_WhenPassedParametersCount_GreaterThanCtorParametersCount();

Expand Down
36 changes: 31 additions & 5 deletions ...arp/DiagnosticAnalyzerTests/SubstituteAnalyzerTests/SubstituteFactoryCreateMethodTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,7 +323,7 @@ public void Test()
await VerifyDiagnostic(source, SubstituteForWithoutAccessibleConstructorDescriptor, "Could not find accessible constructor. Make sure that type MyNamespace.Foo exposes public or protected constructors.");
}

public override async Task ReportsDiagnostic_WhenUsedForClassWithProtectedInternalConstructor_AndInternalsVisibleToNotApplied()
public override async Task ReportsNoDiagnostics_WhenUsedForClassWithProtectedInternalConstructor_AndInternalsVisibleToNotApplied()
{
var source = @"using NSubstitute.Core;

Expand All @@ -340,13 +340,13 @@ public class FooTests
{
public void Test()
{
var substitute = [|SubstitutionContext.Current.SubstituteFactory.Create(new[] {typeof(Foo)}, null)|];
var otherSubstitute = [|SubstitutionContext.Current.SubstituteFactory.Create(typesToProxy: new[] {typeof(Foo)}, constructorArguments: null)|];
var yetAnotherSubstitute = [|SubstitutionContext.Current.SubstituteFactory.Create(constructorArguments: null, typesToProxy: new[] {typeof(Foo)})|];
var substitute = SubstitutionContext.Current.SubstituteFactory.Create(new[] {typeof(Foo)}, null);
var otherSubstitute = SubstitutionContext.Current.SubstituteFactory.Create(typesToProxy: new[] {typeof(Foo)}, constructorArguments: null);
var yetAnotherSubstitute = SubstitutionContext.Current.SubstituteFactory.Create(constructorArguments: null, typesToProxy: new[] {typeof(Foo)});
}
}
}";
await VerifyDiagnostic(source, SubstituteForWithoutAccessibleConstructorDescriptor, "Could not find accessible constructor. Make sure that type MyNamespace.Foo exposes public or protected constructors.");
await VerifyNoDiagnostic(source);
}

public override async Task ReportsNoDiagnostic_WhenUsedForClassWithInternalConstructor_AndInternalsVisibleToApplied()
Expand Down Expand Up @@ -405,6 +405,32 @@ public void Test()
await VerifyNoDiagnostic(source);
}

public override async Task ReportsNoDiagnostic_WhenUsedForClassWithProtectedConstructor()
{
var source = @"using NSubstitute.Core;

namespace MyNamespace
{
public class Foo
{
protected Foo()
{
}
}

public class FooTests
{
public void Test()
{
var substitute = SubstitutionContext.Current.SubstituteFactory.Create(new[] {typeof(Foo)}, null);
var otherSubstitute = SubstitutionContext.Current.SubstituteFactory.Create(typesToProxy: new[] {typeof(Foo)}, constructorArguments: null);
var yetAnotherSubstitute = SubstitutionContext.Current.SubstituteFactory.Create(constructorArguments: null, typesToProxy: new[] {typeof(Foo)});
}
}
}";
await VerifyNoDiagnostic(source);
}

[Fact]
public override async Task ReportsDiagnostic_WhenPassedParametersCount_GreaterThanCtorParametersCount()
{
Expand Down
37 changes: 32 additions & 5 deletions ...gnosticAnalyzerTests/SubstituteAnalyzerTests/SubstituteFactoryCreatePartialMethodTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ public void Test()
await VerifyDiagnostic(source, SubstituteForWithoutAccessibleConstructorDescriptor, "Could not find accessible constructor. Make sure that type MyNamespace.Foo exposes public or protected constructors.");
}

public override async Task ReportsDiagnostic_WhenUsedForClassWithProtectedInternalConstructor_AndInternalsVisibleToNotApplied()
public override async Task ReportsNoDiagnostics_WhenUsedForClassWithProtectedInternalConstructor_AndInternalsVisibleToNotApplied()
{
var source = @"using System;
using NSubstitute.Core;
Expand All @@ -150,13 +150,13 @@ public class FooTests
{
public void Test()
{
var substitute = [|SubstitutionContext.Current.SubstituteFactory.CreatePartial(new Type[] { typeof(Foo)}, null)|];
var otherSubstitute = [|SubstitutionContext.Current.SubstituteFactory.CreatePartial(typesToProxy: new Type[] { typeof(Foo)}, constructorArguments: null)|];
var yetAnotherSubstitute = [|SubstitutionContext.Current.SubstituteFactory.CreatePartial(constructorArguments: null, typesToProxy: new Type[] { typeof(Foo)})|];
var substitute = SubstitutionContext.Current.SubstituteFactory.CreatePartial(new Type[] { typeof(Foo)}, null);
var otherSubstitute = SubstitutionContext.Current.SubstituteFactory.CreatePartial(typesToProxy: new Type[] { typeof(Foo)}, constructorArguments: null);
var yetAnotherSubstitute = SubstitutionContext.Current.SubstituteFactory.CreatePartial(constructorArguments: null, typesToProxy: new Type[] { typeof(Foo)});
}
}
}";
await VerifyDiagnostic(source, SubstituteForWithoutAccessibleConstructorDescriptor, "Could not find accessible constructor. Make sure that type MyNamespace.Foo exposes public or protected constructors.");
await VerifyNoDiagnostic(source);
}

public override async Task ReportsNoDiagnostic_WhenUsedForClassWithInternalConstructor_AndInternalsVisibleToApplied()
Expand Down Expand Up @@ -217,6 +217,33 @@ public void Test()
await VerifyNoDiagnostic(source);
}

public override async Task ReportsNoDiagnostic_WhenUsedForClassWithProtectedConstructor()
{
var source = @"using System;
using NSubstitute.Core;

namespace MyNamespace
{
public class Foo
{
protected Foo()
{
}
}

public class FooTests
{
public void Test()
{
var substitute = SubstitutionContext.Current.SubstituteFactory.CreatePartial(new Type[] { typeof(Foo)}, null);
var otherSubstitute = SubstitutionContext.Current.SubstituteFactory.CreatePartial(typesToProxy: new Type[] { typeof(Foo)}, constructorArguments: null);
var yetAnotherSubstitute = SubstitutionContext.Current.SubstituteFactory.CreatePartial(constructorArguments: null, typesToProxy: new Type[] { typeof(Foo)});
}
}
}";
await VerifyNoDiagnostic(source);
}

[Fact]
public override async Task ReportsDiagnostic_WhenPassedParametersCount_GreaterThanCtorParametersCount()
{
Expand Down
4 changes: 3 additions & 1 deletion tests/NSubstitute.Analyzers.Tests.Shared/DiagnosticAnalyzers/ISubstituteAnalyzerVerifier.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,14 @@ public interface ISubstituteAnalyzerVerifier

Task ReportsDiagnostic_WhenUsedForClassWithInternalConstructor_AndInternalsVisibleToNotApplied();

Task ReportsDiagnostic_WhenUsedForClassWithProtectedInternalConstructor_AndInternalsVisibleToNotApplied();
Task ReportsNoDiagnostics_WhenUsedForClassWithProtectedInternalConstructor_AndInternalsVisibleToNotApplied();

Task ReportsNoDiagnostic_WhenUsedForClassWithInternalConstructor_AndInternalsVisibleToApplied();

Task ReportsNoDiagnostic_WhenUsedForClassWithProtectedInternalConstructor_AndInternalsVisibleToApplied();

Task ReportsNoDiagnostic_WhenUsedForClassWithProtectedConstructor();

Task ReportsDiagnostic_WhenPassedParametersCount_GreaterThanCtorParametersCount();

Task ReportsDiagnostic_WhenPassedParametersCount_LessThanCtorParametersCount();
Expand Down