Merge pull request #203 from nsubstitute/GH-202-received-event-subscr…

…iption GH-202 - do not report NS500 for event subscriptions
nsubstitute · Jul 30, 2023 · 3edadcb · 3edadcb
2 parents abe5b9f + 60d6225
commit 3edadcb
Show file tree

Hide file tree

Showing 8 changed files with 105 additions and 1 deletion.
diff --git a/src/NSubstitute.Analyzers.Shared/DiagnosticAnalyzers/AbstractUnusedReceivedAnalyzer.cs b/src/NSubstitute.Analyzers.Shared/DiagnosticAnalyzers/AbstractUnusedReceivedAnalyzer.cs
@@ -21,7 +21,7 @@ protected AbstractUnusedReceivedAnalyzer(IDiagnosticDescriptorsProvider diagnost
     public sealed override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics { get; }
 
     private static readonly ImmutableHashSet<OperationKind> PossibleParents =
-        ImmutableHashSet.Create(OperationKind.PropertyReference, OperationKind.Invocation);
+        ImmutableHashSet.Create(OperationKind.PropertyReference, OperationKind.Invocation, OperationKind.EventReference);
 
     protected sealed override void InitializeAnalyzer(AnalysisContext context)
     {

diff --git a/...arp/DiagnosticAnalyzerTests/UnusedReceivedAnalyzerTests/ReceivedAsExtensionMethodTests.cs b/...arp/DiagnosticAnalyzerTests/UnusedReceivedAnalyzerTests/ReceivedAsExtensionMethodTests.cs
@@ -239,6 +239,30 @@ public void Test()
             substitute.{method};
         }}
     }}
+}}";
+        await VerifyNoDiagnostic(source);
+    }
+
+    public override async Task ReportsNoDiagnostics_WhenSubscribingToEvent(string method)
+    {
+        var source = $@"using NSubstitute;
+using NSubstitute.ReceivedExtensions;
+using System;
+namespace MyNamespace
+{{
+    public class Foo
+    {{
+        public event Action SomeEvent;
+    }}
+
+    public class FooTests
+    {{
+        public void Test()
+        {{
+            var substitute = NSubstitute.Substitute.For<Foo>();
+            substitute.{method}.SomeEvent += Arg.Any<Action>();
+        }}
+    }}
 }}";
         await VerifyNoDiagnostic(source);
     }

diff --git a/...harp/DiagnosticAnalyzerTests/UnusedReceivedAnalyzerTests/ReceivedAsOrdinaryMethodTests.cs b/...harp/DiagnosticAnalyzerTests/UnusedReceivedAnalyzerTests/ReceivedAsOrdinaryMethodTests.cs
@@ -300,6 +300,30 @@ public void Test()
             {method};
         }}
     }}
+}}";
+            await VerifyNoDiagnostic(source);
+        }
+
+        public override async Task ReportsNoDiagnostics_WhenSubscribingToEvent(string method)
+        {
+            var source = $@"using NSubstitute;
+using NSubstitute.ReceivedExtensions;
+using System;
+namespace MyNamespace
+{{
+    public class Foo
+    {{
+        public event Action SomeEvent;
+    }}
+
+    public class FooTests
+    {{
+        public void Test()
+        {{
+            var substitute = NSubstitute.Substitute.For<Foo>();
+            {method}.SomeEvent += Arg.Any<Action>();
+        }}
+    }}
 }}";
             await VerifyNoDiagnostic(source);
         }

diff --git a/...p/DiagnosticAnalyzerTests/UnusedReceivedAnalyzerTests/UnusedReceivedDiagnosticVerifier.cs b/...p/DiagnosticAnalyzerTests/UnusedReceivedAnalyzerTests/UnusedReceivedDiagnosticVerifier.cs
@@ -39,4 +39,8 @@ public abstract class UnusedReceivedDiagnosticVerifier : CSharpDiagnosticVerifie
     [CombinatoryTheory]
     [InlineData]
     public abstract Task ReportsNoDiagnostics_WhenUsedWithUnfortunatelyNamedMethod(string method);
+
+    [CombinatoryTheory]
+    [InlineData]
+    public abstract Task ReportsNoDiagnostics_WhenSubscribingToEvent(string method);
 }
diff --git a/...ubstitute.Analyzers.Tests.Shared/DiagnosticAnalyzers/IUnusedReceivedDiagnosticVerifier.cs b/...ubstitute.Analyzers.Tests.Shared/DiagnosticAnalyzers/IUnusedReceivedDiagnosticVerifier.cs
@@ -15,4 +15,6 @@ public interface IUnusedReceivedDiagnosticVerifier
     Task ReportNoDiagnostics_WhenUsedWithInvokingDelegate(string method);
 
     Task ReportsNoDiagnostics_WhenUsedWithUnfortunatelyNamedMethod(string method);
+
+    Task ReportsNoDiagnostics_WhenSubscribingToEvent(string method);
 }
diff --git a/...ic/DiagnosticAnalyzersTests/UnusedReceivedAnalyzerTests/ReceivedAsExtensionMethodTests.cs b/...ic/DiagnosticAnalyzersTests/UnusedReceivedAnalyzerTests/ReceivedAsExtensionMethodTests.cs
@@ -208,4 +208,27 @@ End Namespace
 ";
         await VerifyNoDiagnostic(source);
     }
+
+    public override async Task ReportsNoDiagnostics_WhenSubscribingToEvent(string method)
+    {
+        var source = @$"Imports NSubstitute
+Imports System
+Imports NSubstitute.ReceivedExtensions
+Imports NUnit.Framework
+
+Namespace MyNamespace
+    Public Class Foo
+        Public Event SomeEvent As Action
+    End Class
+
+    Public Class FooTests
+        Public Sub Test()
+            Dim substitute = NSubstitute.Substitute.[For] (Of Foo)()
+            AddHandler substitute.{method}.SomeEvent, Arg.Any (Of Action)()
+        End Sub
+    End Class
+End Namespace";
+
+        await VerifyNoDiagnostic(source);
+    }
 }
diff --git a/...sic/DiagnosticAnalyzersTests/UnusedReceivedAnalyzerTests/ReceivedAsOrdinaryMethodTests.cs b/...sic/DiagnosticAnalyzersTests/UnusedReceivedAnalyzerTests/ReceivedAsOrdinaryMethodTests.cs
@@ -288,4 +288,27 @@ End Namespace
 ";
         await VerifyNoDiagnostic(source);
     }
+
+    public override async Task ReportsNoDiagnostics_WhenSubscribingToEvent(string method)
+    {
+        var source = @$"Imports NSubstitute
+Imports System
+Imports NSubstitute.ReceivedExtensions
+Imports NUnit.Framework
+
+Namespace MyNamespace
+    Public Class Foo
+        Public Event SomeEvent As Action
+    End Class
+
+    Public Class FooTests
+        Public Sub Test()
+            Dim substitute = NSubstitute.Substitute.[For] (Of Foo)()
+            AddHandler {method}.SomeEvent, Arg.Any (Of Action)()
+        End Sub
+    End Class
+End Namespace";
+
+        await VerifyNoDiagnostic(source);
+    }
 }
diff --git a/.../DiagnosticAnalyzersTests/UnusedReceivedAnalyzerTests/UnusedReceivedDiagnosticVerifier.cs b/.../DiagnosticAnalyzersTests/UnusedReceivedAnalyzerTests/UnusedReceivedDiagnosticVerifier.cs
@@ -39,4 +39,8 @@ public abstract class UnusedReceivedDiagnosticVerifier : VisualBasicDiagnosticVe
     [CombinatoryTheory]
     [InlineData]
     public abstract Task ReportsNoDiagnostics_WhenUsedWithUnfortunatelyNamedMethod(string method);
+
+    [CombinatoryTheory]
+    [InlineData]
+    public abstract Task ReportsNoDiagnostics_WhenSubscribingToEvent(string method);
 }