Substitute both ConfigureScope overloads in tests

Author: KnapSac

test/Sentry.AspNetCore.Tests/SentryMiddlewareTests.cs

@@ -31,8 +31,7 @@ private class Fixture
         public Fixture()
         {
             Scope = new();
-            Hub.When(hub => hub.ConfigureScope(Arg.Any<Action<Scope>>()))
-                .Do(callback => callback.Arg<Action<Scope>>().Invoke(Scope));
+            Hub.SubstituteConfigureScope(Scope);
 
             Hub.When(hub => hub.CaptureEvent(Arg.Any<SentryEvent>(), Arg.Any<Scope>()))
                 .Do(_ => Scope.Evaluate());
@@ -157,23 +156,16 @@ public async Task InvokeAsync_ScopePushed_BeforeConfiguringScope()
     [Fact]
     public async Task InvokeAsync_LocksScope_BeforeConfiguringScope()
     {
-        var verified = false;
-        var scope = new Scope();
-        _fixture.Hub
-            .When(h => h.ConfigureScope(Arg.Any<Action<Scope>>()))
-            .Do(Callback
-                .First(c => c.ArgAt<Action<Scope>>(0)(scope))
-                .Then(_ =>
-                {
-                    Assert.True(scope.Locked);
-                    verified = true;
-                }));
+        var scopeLocked = false;
+        _fixture.Hub.When(h => h.PushAndLockScope()).Do(_ => scopeLocked = true);
+        _fixture.Hub.When(h => h.ConfigureScope(Arg.Any<Action<Scope>>()))
+            .Do(_ => Assert.True(scopeLocked));
 
         var sut = _fixture.GetSut();
 
         await sut.InvokeAsync(_fixture.HttpContext, _fixture.RequestDelegate);
 
-        Assert.True(verified);
+        _fixture.Hub.Received().ConfigureScope(Arg.Any<Action<Scope>>());
     }
 
     [Fact]
@@ -182,8 +174,7 @@ public async Task InvokeAsync_OnEvaluating_HttpContextDataSet()
         const string expectedTraceIdentifier = "trace id";
         _ = _fixture.HttpContext.TraceIdentifier.Returns(expectedTraceIdentifier);
         var scope = new Scope();
-        _fixture.Hub.When(h => h.ConfigureScope(Arg.Any<Action<Scope>>()))
-            .Do(c => c.Arg<Action<Scope>>()(scope));
+        _fixture.Hub.SubstituteConfigureScope(scope);
 
         var sut = _fixture.GetSut();
 
@@ -200,8 +191,7 @@ public async Task InvokeAsync_OnEvaluatingClonedScope_HttpContextDataSet()
         const string expectedTraceIdentifier = "trace id";
         _ = _fixture.HttpContext.TraceIdentifier.Returns(expectedTraceIdentifier);
         var scope = new Scope();
-        _fixture.Hub.When(h => h.ConfigureScope(Arg.Any<Action<Scope>>()))
-            .Do(c => c.Arg<Action<Scope>>()(scope));
+        _fixture.Hub.SubstituteConfigureScope(scope);
 
         var sut = _fixture.GetSut();
 
@@ -664,7 +654,7 @@ public async Task InvokeAsync_InstrumenterOpenTelemetry_SavesScope()
         // Arrange
         _fixture.Options.Instrumenter = Instrumenter.OpenTelemetry;
         var scope = new Scope();
-        _fixture.Hub.ConfigureScope(Arg.Do<Action<Scope>>(action => action.Invoke(scope)));
+        _fixture.Hub.SubstituteConfigureScope(scope);
         var sut = _fixture.GetSut();
         var activity = new Activity("test").Start();
 

test/Sentry.EntityFramework.Tests/SentryQueryLoggerTests.cs

@@ -8,7 +8,7 @@ public void Log_QueryLogger_CaptureEvent()
         var scope = new Scope(new SentryOptions());
         var hub = Substitute.For<IHub>();
         hub.IsEnabled.Returns(true);
-        hub.ConfigureScope(Arg.Invoke(scope));
+        hub.SubstituteConfigureScope(scope);
 
         var expected = new
         {

test/Sentry.Extensions.Logging.Tests/SentryLoggerTests.cs

@@ -14,7 +14,7 @@ private class Fixture
         public Fixture()
         {
             _ = Hub.IsEnabled.Returns(true);
-            Hub.ConfigureScope(Arg.Invoke(Scope));
+            Hub.SubstituteConfigureScope(Scope);
         }
 
         public SentryLogger GetSut() => new(CategoryName, Options, new MockClock(), Hub);

test/Sentry.Log4Net.Tests/SentryAppenderTests.cs

@@ -16,7 +16,7 @@ private class Fixture
         public Fixture()
         {
             HubAccessor = () => Hub;
-            Hub.ConfigureScope(Arg.Invoke(Scope));
+            Hub.SubstituteConfigureScope(Scope);
             InitAction = s =>
             {
                 DsnReceivedOnInit = s;

test/Sentry.NLog.Tests/SentryTargetTests.cs

@@ -23,7 +23,7 @@ public Fixture()
             Hub.IsEnabled.Returns(true);
             HubAccessor = () => Hub;
             Scope = new Scope(new SentryOptions());
-            Hub.ConfigureScope(Arg.Invoke(Scope));
+            Hub.SubstituteConfigureScope(Scope);
         }
 
         public Target GetTarget(bool asyncTarget = false)

test/Sentry.OpenTelemetry.Tests/AspNetCoreEnricherTests.cs

@@ -9,7 +9,7 @@ public void Enrich_SendDefaultPii_UserOnScope()
         var scope = new Scope();
         var options = new SentryOptions { SendDefaultPii = true };
         var hub = Substitute.For<IHub>();
-        hub.ConfigureScope(Arg.Do<Action<Scope>>(action => action(scope)));
+        hub.SubstituteConfigureScope(scope);
 
         var user = new SentryUser { Id = "foo" };
         var userFactory = Substitute.For<ISentryUserFactory>();

test/Sentry.Serilog.Tests/SentrySinkTests.cs

@@ -14,7 +14,7 @@ public Fixture()
         {
             Hub.IsEnabled.Returns(true);
             HubAccessor = () => Hub;
-            Hub.ConfigureScope(Arg.Invoke(Scope));
+            Hub.SubstituteConfigureScope(Scope);
         }
 
         public SentrySink GetSut()

test/Sentry.Testing/HubSubstituteExtensions.cs

@@ -0,0 +1,23 @@
+namespace Sentry.Testing;
+
+public static class HubSubstituteExtensions
+{
+    public static void SubstituteConfigureScope(
+        this IHub hub,
+        Scope scope)
+    {
+        hub.When(h => h.ConfigureScope(Arg.Any<Action<Scope>>()))
+           .Do(c => c.Arg<Action<Scope>>().Invoke(scope));
+
+        hub.When(h => h.ConfigureScope(Arg.Any<Action<Scope, Arg.AnyType>>(), Arg.Any<Arg.AnyType>()))
+           .Do(c =>
+               {
+                   // If we use Arg.AnyType to look up the arguments, NSubstitute is unable to find
+                   // them. So as a workaround, we get the arguments directly and use reflection to
+                   // invoke the method.
+                   var action = c[0];
+                   var arg = c[1];
+                   action.GetType().GetMethod("Invoke")!.Invoke(action, [scope, arg]);
+               });
+    }
+}

test/Sentry.Tests/Extensibility/HubAdapterTests.cs

@@ -162,8 +162,7 @@ private void TestAddBreadcrumbExtension(
         const BreadcrumbLevel level = BreadcrumbLevel.Critical;
 
         var scope = new Scope();
-        Hub.When(h => h.ConfigureScope(Arg.Any<Action<Scope>>()))
-            .Do(c => c.Arg<Action<Scope>>()(scope));
+        Hub.SubstituteConfigureScope(scope);
 
         action(message, category, type, data, level);
 

test/Sentry.Tests/HubExtensionsTests.cs

@@ -7,8 +7,7 @@ public class HubExtensionsTests
 
     public HubExtensionsTests()
     {
-        Sut.When(h => h.ConfigureScope(Arg.Any<Action<Scope>>()))
-            .Do(c => c.Arg<Action<Scope>>()(Scope));
+        Sut.SubstituteConfigureScope(Scope);
     }
 
     [Fact]