JObject compatibility

Author: exyi

exampleTest/CheckTestOutput.Example.csproj

@@ -9,6 +9,7 @@
 
   <ItemGroup>
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.9.0" />
+    <PackageReference Include="Newtonsoft.Json" Version="13.0.1" />
     <PackageReference Include="xunit" Version="2.4.0" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.4.0" />
   </ItemGroup>

exampleTest/SomeTest.cs

@@ -2,6 +2,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Text.RegularExpressions;
+using Newtonsoft.Json.Linq;
 using Xunit;
 
 namespace CheckTestOutput.Example
@@ -93,6 +94,15 @@ public void JsonWithNormalizedOrder()
             check.CheckJsonObject(dict, normalizePropertyOrder: true);
         }
 
+        [Fact]
+        public void NewtonsoftJsonCompatibility()
+        {
+            check.CheckJsonObject(
+                JObject.FromObject(new { number = 3, str = "jaja", list = new List<object> { 1, "2313", new SomeTestObject { Prop = "hmm" } } })
+            );
+
+        }
+
         class SomeTestObject
         {
             public string Prop { get; set; }

exampleTest/testoutputs/SomeTest.NewtonsoftJsonCompatibility.json

@@ -0,0 +1,11 @@
+{
+	"number": 3,
+	"str": "jaja",
+	"list": [
+		1,
+		"2313",
+		{
+			"Prop": "hmm"
+		}
+	]
+}

src/BasicChecks.cs

@@ -7,6 +7,8 @@ namespace CheckTestOutput
 {
     public static class BasicChecks
     {
+        /// <summary> Verifies that the provided <paramref name="output" /> equals to the `outputDirectory/TestClass.TestMethod.txt` file. </summary>
+        /// <param name="checkName"> If not null, checkName will be appended to the calling <paramref name="memberName" />. Intended to be used when having multiple checks in one method. </param>
         public static void CheckString(
             this OutputChecker t,
             string output,
@@ -23,6 +25,8 @@ public static void CheckString(
             );
         }
 
+        /// <summary> Verifies that the provided <paramref name="output" /> equals to the `outputDirectory/TestClass.TestMethod.txt` file. File is compared line-by-line. </summary>
+        /// <param name="checkName"> If not null, checkName will be appended to the calling <paramref name="memberName" />. Intended to be used when having multiple checks in one method. </param>
         public static void CheckLines(
             this OutputChecker t,
             IEnumerable<string> output,

src/JsonChecks.cs

@@ -9,6 +9,10 @@ namespace CheckTestOutput
 {
     public static class JsonChecks
     {
+        /// <summary> Verifies that the provided object <paramref name="output" />, serialized as Json using System.Text.Json, is equal to the `outputDirectory/TestClass.TestMethod.json` file. </summary>
+        /// <param name="jsonOptions"> Json serialization options will be passed to <see cref="JsonSerializer.Serialize{TValue}(TValue, JsonSerializerOptions?)" />. </param>
+        /// <param name="normalizePropertyOrder"> If true, object properties will be sorted alphabetically. </param>
+        /// <param name="checkName"> If not null, checkName will be appended to the calling <paramref name="memberName" />. Intended to be used when having multiple checks in one method. </param>
         public static void CheckJsonObject(
             this OutputChecker t,
             object output,
@@ -20,8 +24,7 @@ public static void CheckJsonObject(
             [System.Runtime.CompilerServices.CallerFilePath] string sourceFilePath = null)
         {
             jsonOptions ??= new JsonSerializerOptions() { WriteIndented = true };
-            var strOutput =
-                JsonSerializer.Serialize(output, jsonOptions);
+            var strOutput = SerializeJson(output, jsonOptions);
 
             if (normalizePropertyOrder)
             {
@@ -34,7 +37,6 @@ public static void CheckJsonObject(
                 strOutput = System.Text.Encoding.UTF8.GetString(outputStream.ToArray());
             }
 
-
             // indent using tabs for back compatibility
             strOutput = Regex.Replace(strOutput, "^(  )+", m => new string('\t', m.Value.Length / 2), RegexOptions.Multiline);
             t.CheckOutputCore(
@@ -45,6 +47,28 @@ public static void CheckJsonObject(
             );
         }
 
+        static string SerializeJson(object obj, JsonSerializerOptions options)
+        {
+            if (obj is null) return "null";
+
+            var type = obj.GetType();
+            bool isToStringableObject = false;
+            while (type != null)
+            {
+                if (type.FullName == "Newtonsoft.Json.Linq.JToken")
+                {
+                    isToStringableObject = true;
+                    break;
+                }
+                type = type.BaseType;
+            }
+            if (isToStringableObject)
+                return obj.ToString();
+
+            return JsonSerializer.Serialize(obj, options);
+
+        }
+
         static void NormalizePropertyOrder(JsonElement e, Utf8JsonWriter output)
         {
             if (e.ValueKind == JsonValueKind.Object)

src/OutputChecker.cs

@@ -10,6 +10,7 @@ namespace CheckTestOutput
 {
     public class OutputChecker
     {
+        /// <summary> Checks that the provided test output matched a file from the <paramref name="directory"/>. Filename is a {callingClass}.{callingMethod}.fileExtension </summary>
         /// <param name="directory">Directory with the reference outputs, relative to the <see cref="calledFrom"/> parameter.</param>
         /// <param name="sanitizeGuids">Replace all strings that look like Guid by a sequential id. The sanitization preserves equality.</param>
         /// <param name="sanitizeQuotedGuids">Replace all strings that look like Guid and are in quotes by a sequential id. The sanitization preserves equality.</param>
@@ -142,6 +143,7 @@ private bool IsModified(string file)
             return !gitOut.All(string.IsNullOrEmpty);
         }
 
+        /// <summary> Applies the <see cref="NonDeterminismSanitizers" /> to the string. </summary>
         public string SanitizeString(string outputString)
         {
             var x = new Dictionary<string, string>();
@@ -192,11 +194,11 @@ internal void CheckOutputCore(string outputString, string checkName, string meth
                 {
                     var diff = RunGitCommand("diff", filename);
                     if (diff.All(string.IsNullOrEmpty))
-                        throw new Exception($"{Path.GetFileName(filename)} is not explicitly accepted - the file is untracked in git. View the file and stage to let this test pass. Confused? See https://github.com/exyi/CheckTestOutput/blob/master/trouble.md#untracked-file\n");
+                        throw new Exception($"{Path.GetFileName(filename)} is not explicitly accepted - the file is untracked in git. To let this test pass, view the file and stage it. Confused? See https://github.com/exyi/CheckTestOutput/blob/master/trouble.md#untracked-file\n");
                     throw new Exception(
                         $"{Path.GetFileName(filename)} has changed, the actual output differs from the previous accepted output:\n\n" +
                         string.Join("\n", diff) + "\n\n" +
-                        "If this change OK? Stage the file in git to let the test pass. Confused? See https://github.com/exyi/CheckTestOutput/blob/master/trouble.md#changed-file\n"
+                        "If this change OK? To let the test pass, stage the file in git. Confused? See https://github.com/exyi/CheckTestOutput/blob/master/trouble.md#changed-file\n"
 
                     );
                 }