Snapshot testing (#208)

* snapshot testing with verify

* formatting

* add back old serialization tests

* pass verify

* use json correctly

* formatting

* Don't use Quibble and order ourselves because ordering doesn't matter

* whitespace on snapshot

* Better json diffing?  Quibble is back

* add common project

* add object unit tests to see how verify would work

* format

* move random exes to new solution folder

* update lock files

.editorconfig

@@ -316,3 +316,13 @@ dotnet_diagnostic.NUnit2039.severity = warning # Consider using Assert.That(actu
 indent_style = space
 indent_size = 2
 tab_width = 2
+
+# Verify
+[*.{received,verified}.{json}]
+charset = utf-8-bom
+end_of_line = lf
+indent_size = unset
+indent_style = unset
+insert_final_newline = false
+tab_width = unset
+trim_trailing_whitespace = false

.gitattributes

@@ -2,4 +2,7 @@
 * text=auto
 
 # need original files to be windows
-*.txt text eol=crlf
+*.txt text eol=crlf
+
+# Verify
+*.verified.json text eol=lf working-tree-encoding=UTF-8

.gitignore

@@ -18,4 +18,6 @@ tools
 
 .DS_Store
 *.snupkg
-coverage.xml
+coverage.xml
+
+*.received.*

Directory.Packages.props

@@ -25,11 +25,15 @@
     <PackageVersion Include="Speckle.DoubleNumerics" Version="4.0.1" />
     <PackageVersion Include="SimpleExec" Version="12.0.0" />
     <PackageVersion Include="System.Threading.Channels" Version="9.0.1" />
+    <PackageVersion Include="Verify" Version="28.9.0" />
+    <PackageVersion Include="Verify.Quibble" Version="2.1.1" />
+    <PackageVersion Include="Verify.Xunit" Version="28.9.0" />
     <PackageVersion Include="xunit" Version="2.9.3" />
+    <PackageVersion Include="xunit.assert" Version="2.9.3" />
     <PackageVersion Include="xunit.runner.visualstudio" Version="3.0.1" />
     <GlobalPackageReference Include="PolySharp" Version="1.15.0" />
     <GlobalPackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0" />
     <GlobalPackageReference Include="GitVersion.MsBuild" Version="5.12.0" />
     <GlobalPackageReference Include="Speckle.InterfaceGenerator" Version="0.9.6" />
   </ItemGroup>
-</Project>
+</Project>

tests/Speckle.Sdk.Serialization.Tests/DummyReceiveServerObjectManager.cs → Speckle.Sdk.Testing/Framework/DummyReceiveServerObjectManager.cs

@@ -4,7 +4,7 @@
 using Speckle.Sdk.Serialisation.V2.Send;
 using Speckle.Sdk.Transports;
 
-namespace Speckle.Sdk.Serialization.Tests;
+namespace Speckle.Sdk.Testing.Framework;
 
 public class DummyReceiveServerObjectManager(Dictionary<string, string> objects) : IServerObjectManager
 {

tests/Speckle.Sdk.Serialization.Tests/DummySendServerObjectManager.cs → Speckle.Sdk.Testing/Framework/DummySendServerObjectManager.cs

@@ -3,7 +3,7 @@
 using Speckle.Sdk.Serialisation.V2.Send;
 using Speckle.Sdk.Transports;
 
-namespace Speckle.Sdk.Serialization.Tests;
+namespace Speckle.Sdk.Testing.Framework;
 
 public class DummySendServerObjectManager(ConcurrentDictionary<string, string> savedObjects) : IServerObjectManager
 {

tests/Speckle.Sdk.Serialization.Tests/DummySqLiteReceiveManager.cs → Speckle.Sdk.Testing/Framework/DummySqLiteReceiveManager.cs

@@ -1,8 +1,8 @@
 using Speckle.Sdk.SQLite;
 
-namespace Speckle.Sdk.Serialization.Tests;
+namespace Speckle.Sdk.Testing.Framework;
 
-public class DummySqLiteReceiveManager(Dictionary<string, string> savedObjects) : ISqLiteJsonCacheManager
+public sealed class DummySqLiteReceiveManager(Dictionary<string, string> savedObjects) : ISqLiteJsonCacheManager
 {
   public void Dispose() { }
 

tests/Speckle.Sdk.Serialization.Tests/DummySqLiteSendManager.cs → Speckle.Sdk.Testing/Framework/DummySqLiteSendManager.cs

@@ -1,8 +1,8 @@
 using Speckle.Sdk.SQLite;
 
-namespace Speckle.Sdk.Serialization.Tests;
+namespace Speckle.Sdk.Testing.Framework;
 
-public class DummySqLiteSendManager : ISqLiteJsonCacheManager
+public sealed class DummySqLiteSendManager : ISqLiteJsonCacheManager
 {
   public string? GetObject(string id) => throw new NotImplementedException();
 

Speckle.Sdk.Testing/Framework/IdStringSerializer.cs

@@ -0,0 +1,24 @@
+using System.Diagnostics.CodeAnalysis;
+using Argon;
+using Speckle.Sdk.Common;
+using Speckle.Sdk.Serialisation;
+
+namespace Speckle.Sdk.Testing.Framework;
+
+[SuppressMessage("Design", "CA1062:Validate arguments of public methods")]
+public class IdStringSerializer : JsonConverter
+{
+  public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
+  {
+    var id = (Id)value;
+    writer.WriteValue(id.Value);
+  }
+
+  public override object? ReadJson(JsonReader reader, Type type, object? existingValue, JsonSerializer serializer)
+  {
+    var json = reader.ReadAsString();
+    return new Id(json.NotNull());
+  }
+
+  public override bool CanConvert(Type type) => typeof(Id) == type;
+}

Speckle.Sdk.Testing/Framework/JsonStringSerializer.cs

@@ -0,0 +1,24 @@
+using System.Diagnostics.CodeAnalysis;
+using Argon;
+using Speckle.Sdk.Common;
+using Speckle.Sdk.Serialisation;
+
+namespace Speckle.Sdk.Testing.Framework;
+
+[SuppressMessage("Design", "CA1062:Validate arguments of public methods")]
+public class JsonStringSerializer : JsonConverter
+{
+  public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
+  {
+    var json = (Json)value;
+    writer.WriteRawValue(JObject.Parse(json.Value).ToString(Formatting.Indented));
+  }
+
+  public override object? ReadJson(JsonReader reader, Type type, object? existingValue, JsonSerializer serializer)
+  {
+    var json = reader.ReadAsString();
+    return new Json(json.NotNull());
+  }
+
+  public override bool CanConvert(Type type) => typeof(Json) == type;
+}

Speckle.Sdk.Testing/Global.cs

@@ -0,0 +1 @@
+[assembly: CollectionBehavior(DisableTestParallelization = true)]

Speckle.Sdk.Testing/Speckle.Sdk.Testing.csproj

@@ -0,0 +1,19 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+    <PropertyGroup>
+      <TargetFramework>net8.0</TargetFramework>
+      <IsTestProject>true</IsTestProject>
+    </PropertyGroup>
+
+    <ItemGroup>
+      <PackageReference Include="Microsoft.NET.Test.Sdk"  />
+      <PackageReference Include="Verify.Quibble" />
+      <PackageReference Include="Verify.Xunit" />
+      <PackageReference Include="xunit.runner.visualstudio"/>
+    </ItemGroup>
+
+    <ItemGroup>
+      <ProjectReference Include="..\src\Speckle.Sdk\Speckle.Sdk.csproj" />
+    </ItemGroup>
+
+</Project>

Speckle.Sdk.Testing/SpeckleVerify.cs

@@ -0,0 +1,45 @@
+using System.Runtime.CompilerServices;
+using Argon;
+using Speckle.Sdk.Serialisation;
+using Speckle.Sdk.Testing.Framework;
+
+namespace Speckle.Sdk.Testing;
+
+public static class SpeckleVerify
+{
+  [ModuleInitializer]
+  public static void Initialize()
+  {
+    VerifierSettings.DontScrubGuids();
+    VerifierSettings.DontScrubDateTimes();
+
+    VerifierSettings.UseStrictJson();
+    VerifierSettings.DontIgnoreEmptyCollections();
+    VerifierSettings.SortPropertiesAlphabetically();
+    VerifierSettings.SortJsonObjects();
+    if (!VerifyQuibble.Initialized)
+    {
+      VerifyQuibble.Initialize();
+    }
+  }
+
+  private static readonly JsonSerializer _jsonSerializer = new()
+  {
+    NullValueHandling = NullValueHandling.Include,
+    Formatting = Formatting.Indented,
+    Converters = { new JsonStringSerializer() },
+  };
+
+  private static async Task VerifyJsonObjects(IDictionary<string, Json> objects, string sourceFile) =>
+    await VerifyJson(JObject.FromObject(objects, _jsonSerializer).ToString(), sourceFile: sourceFile);
+
+  public static async Task VerifyJsonDictionary(
+    IDictionary<string, string> objects,
+    [CallerFilePath] string sourceFile = ""
+  ) => await VerifyJsonObjects(objects.ToDictionary(x => x.Key, x => new Json(x.Value)), sourceFile);
+
+  public static async Task VerifyJsonDictionary(
+    IDictionary<Id, Json> objects,
+    [CallerFilePath] string sourceFile = ""
+  ) => await VerifyJsonObjects(objects.ToDictionary(x => x.Key.Value, x => x.Value), sourceFile);
+}

Speckle.Sdk.Testing/VerifyTests.cs

@@ -0,0 +1,7 @@
+namespace Speckle.Sdk.Testing;
+
+public class VerifyTests
+{
+  [Fact]
+  public Task TestVerify() => VerifyChecks.Run();
+}