show snapshot testing (#620)

Author: SimonCropp

.gitignore

@@ -21,3 +21,5 @@ docs/api/*
 docs/_site/*
 docs/docfx/*
 docs/docfx.zip
+
+*.received.*

test/Sentry.Tests/ModuleInit.cs

@@ -0,0 +1,34 @@
+using System.Collections.Generic;
+using System.Runtime.CompilerServices;
+using Sentry.Protocol;
+using VerifyTests;
+
+namespace Sentry.Tests
+{
+    public static class ModuleInit
+    {
+        [ModuleInitializer]
+        public static void Init()
+        {
+            VerifierSettings.ModifySerialization(
+                settings => settings.MemberConverter<Breadcrumb, IReadOnlyDictionary<string, string>>(
+                    target => target.Data,
+                    (_, value) =>
+                    {
+                        var dictionary = new Dictionary<string, string>();
+                        foreach (var pair in value)
+                        {
+                            if (pair.Key == "stackTrace")
+                            {
+                                dictionary[pair.Key] = Scrubbers.ScrubStackTrace(pair.Value, true);
+                            }
+                            else
+                            {
+                                dictionary[pair.Key] = pair.Value.Replace('\\','/');
+                            }
+                        }
+                        return dictionary;
+                    }));
+        }
+    }
+}

test/Sentry.Tests/ModuleInitializerAttribute.cs

@@ -0,0 +1,9 @@
+#if(!NET5_0)
+namespace System.Runtime.CompilerServices
+{
+    [AttributeUsage(AttributeTargets.Method, Inherited = false)]
+    public sealed class ModuleInitializerAttribute : Attribute
+    {
+    }
+}
+#endif

test/Sentry.Tests/Sentry.Tests.csproj

@@ -8,6 +8,10 @@
     <DefineConstants>NETFX;$(AdditionalConstants)</DefineConstants>
   </PropertyGroup>
 
+  <ItemGroup>
+    <PackageReference Include="Verify.Xunit" Version="8.11.0" />
+  </ItemGroup>
+
   <ItemGroup>
     <ProjectReference Include="../../src/Sentry/Sentry.csproj" />
     <ProjectReference Include="../Sentry.Testing/Sentry.Testing.csproj" />

test/Sentry.Tests/SentryClientTests.CaptureEvent_BeforeEventThrows_ErrorToEventBreadcrumb.verified.txt

@@ -0,0 +1,14 @@
+[
+  {
+    Timestamp: DateTimeOffset_1,
+    Message: BeforeSend callback failed.,
+    Data: {
+      message: Exception message!,
+      stackTrace: 
+at Sentry.Tests.SentryClientTests.<>c__DisplayClass18_0.<CaptureEvent_BeforeEventThrows_ErrorToEventBreadcrumb>b__0(...)
+at Sentry.SentryClient.BeforeSend(...)
+    },
+    Category: SentryClient,
+    Level: error
+  }
+]

test/Sentry.Tests/SentryClientTests.cs

@@ -1,15 +1,19 @@
 using System;
 using System.Linq;
 using System.Net.Http;
+using System.Threading.Tasks;
 using NSubstitute;
 using Sentry.Extensibility;
 using Sentry.Internal;
 using Sentry.Protocol;
 using Sentry.Protocol.Envelopes;
+using VerifyXunit;
+using VerifyTests;
 using Xunit;
 
 namespace Sentry.Tests
 {
+    [UsesVerify]
     public class SentryClientTests
     {
         private class Fixture
@@ -252,7 +256,7 @@ public void CaptureEvent_SamplingNull_DropEvent()
         }
 
         [Fact]
-        public void CaptureEvent_BeforeEventThrows_ErrorToEventBreadcrumb()
+        public Task CaptureEvent_BeforeEventThrows_ErrorToEventBreadcrumb()
         {
             var error = new Exception("Exception message!");
             _fixture.SentryOptions.BeforeSend = e => throw error;
@@ -262,10 +266,7 @@ public void CaptureEvent_BeforeEventThrows_ErrorToEventBreadcrumb()
             var sut = _fixture.GetSut();
             _ = sut.CaptureEvent(@event);
 
-            var crumb = @event.Breadcrumbs.First();
-            Assert.Equal("BeforeSend callback failed.", crumb.Message);
-            Assert.Equal(error.Message, crumb.Data["message"]);
-            Assert.Equal(error.StackTrace, crumb.Data["stackTrace"]);
+            return Verifier.Verify(@event.Breadcrumbs);
         }
 
         [Fact]