Fix deserializers for DiscoveryRequestArgs and RunRequestArgs (#2768)

Co-authored-by: Amaury Levé <amauryleve@microsoft.com>

src/Platform/Microsoft.Testing.Platform/ServerMode/Json/Json.cs

@@ -550,7 +550,7 @@ internal sealed class Json
             string runId = json.Bind<string>(jsonElement, JsonRpcStrings.RunId);
             _ = Guid.TryParse(runId, out Guid result);
 
-            json.TryBind(jsonElement, out ICollection<TestNode>? testNodes, JsonRpcStrings.Tests);
+            json.TryArrayBind(jsonElement, out TestNode[]? testNodes, JsonRpcStrings.Tests);
             json.TryBind(jsonElement, out string? graphFilter, JsonRpcStrings.Filter);
 
             return new DiscoverRequestArgs(
@@ -564,7 +564,7 @@ internal sealed class Json
             string runId = json.Bind<string>(jsonElement, JsonRpcStrings.RunId);
             _ = Guid.TryParse(runId, out Guid result);
 
-            json.TryBind(jsonElement, out ICollection<TestNode>? testNodes, JsonRpcStrings.Tests);
+            json.TryArrayBind(jsonElement, out TestNode[]? testNodes, JsonRpcStrings.Tests);
             json.TryBind(jsonElement, out string? graphFilter, JsonRpcStrings.Filter);
 
             return new RunRequestArgs(
@@ -726,6 +726,18 @@ internal sealed class Json
         return true;
     }
 
+    internal bool TryArrayBind<T>(JsonElement element, out T[]? value, string? property = null)
+    {
+        if (property is not null && !element.TryGetProperty(property, out element))
+        {
+            value = default;
+            return false;
+        }
+
+        value = element.EnumerateArray().Select(x => Deserialize<T>(x)).ToArray();
+        return true;
+    }
+
     private T Deserialize<T>(JsonElement element)
     {
         bool deserializerFound = _deserializers.TryGetValue(typeof(T), out JsonDeserializer? deserializer);

test/UnitTests/Microsoft.Testing.Platform.UnitTests/ServerMode/FormatterUtilitiesTests.cs

@@ -7,6 +7,7 @@ using Microsoft.Testing.Platform.ServerMode;
 using Microsoft.Testing.TestInfrastructure;
 
 using TestNode = Microsoft.Testing.Platform.Extensions.Messages.TestNode;
+using TestNodeUid = Microsoft.Testing.Platform.Extensions.Messages.TestNodeUid;
 
 namespace Microsoft.Testing.Platform.UnitTests;
 
@@ -70,16 +71,61 @@ public class FormatterUtilitiesTests : TestBase
         }
 
         static bool HasCustomDeserializeAssert(Type type) => type == typeof(TestNode);
-        static void CustomAssert(Type type, object instanceDeserialized, object originalObject)
+    }
+
+    [Arguments(typeof(DiscoverRequestArgs))]
+    [Arguments(typeof(RunRequestArgs))]
+    public void DeserializeSpecificTypes(Type type)
+    {
+        var json = CreateSerializedInstance(type);
+        Type? deserializer = SerializerUtilities.DeserializerTypes.SingleOrDefault(x => x == type);
+
+        if (deserializer is not null)
         {
-            if (type == typeof(TestNode))
+            var actual = Deserialize(deserializer, json);
+            object expected = CreateInstance(type);
+
+            if (type == typeof(DiscoverRequestArgs))
             {
-                var deserialized = (TestNode)instanceDeserialized;
-                var original = (TestNode)originalObject;
-                Assert.AreEqual(original.Uid, deserialized.Uid);
-                Assert.AreEqual(original.DisplayName, deserialized.DisplayName);
-                Assert.AreEqual(original.Properties.Single<TestFileLocationProperty>(), deserialized.Properties.Single<TestFileLocationProperty>());
+                AssertRequestArgs(type, (DiscoverRequestArgs)actual, (DiscoverRequestArgs)expected);
             }
+            else if (type == typeof(RunRequestArgs))
+            {
+                AssertRequestArgs(type, (RunRequestArgs)actual, (RunRequestArgs)expected);
+            }
+            else
+            {
+                Assert.AreEqual(actual, expected);
+            }
+        }
+    }
+
+    private void AssertRequestArgs<TRequestArgs>(Type type, TRequestArgs actualRequest, TRequestArgs expectedRequest)
+        where TRequestArgs : RequestArgsBase
+    {
+        Assert.AreEqual(expectedRequest.RunId, actualRequest.RunId);
+        Assert.AreEqual(expectedRequest.TestNodes?.Count, actualRequest.TestNodes?.Count);
+
+        var actualTestNodes = actualRequest.TestNodes?.ToArray();
+        var expectedTestNodes = expectedRequest.TestNodes?.ToArray();
+
+        for (int i = 0; i < actualRequest.TestNodes?.Count; i++)
+        {
+            CustomAssert(typeof(TestNode), actualTestNodes?[i]!, expectedTestNodes?[i]!);
+        }
+
+        Assert.AreEqual(expectedRequest.GraphFilter, actualRequest.GraphFilter);
+    }
+
+    private static void CustomAssert(Type type, object instanceDeserialized, object originalObject)
+    {
+        if (type == typeof(TestNode))
+        {
+            var deserialized = (TestNode)instanceDeserialized;
+            var original = (TestNode)originalObject;
+            Assert.AreEqual(original.Uid, deserialized.Uid);
+            Assert.AreEqual(original.DisplayName, deserialized.DisplayName);
+            Assert.AreEqual(original.Properties.Single<TestFileLocationProperty>(), deserialized.Properties.Single<TestFileLocationProperty>());
         }
     }
 
@@ -218,6 +264,26 @@ public class FormatterUtilitiesTests : TestBase
         throw new NotImplementedException($"Assertion not implemented '{type}', value to assert:\n{instanceSerialized}");
     }
 
+    private static string CreateSerializedInstance(Type type)
+    {
+        return type == typeof(DiscoverRequestArgs) || type == typeof(RunRequestArgs)
+            ? """
+            {
+                "runId":"00000000-0000-0000-0000-000000000000",
+                "tests":[
+                    {
+                        "uid":"UnitTest1.TestMethod1",
+                        "display-name":"test1",
+                        "location.file":"filePath",
+                        "location.line-start":1,
+                        "location.line-end":2
+                    }
+                    ]
+                }
+            """
+            : throw new NotImplementedException($"Serialized instance doesn't exist for '{type}'");
+    }
+
     private static object CreateInstance(Type type)
     {
         if (type == typeof(AttachDebuggerInfoArgs))
@@ -323,6 +389,38 @@ public class FormatterUtilitiesTests : TestBase
             return new RequestMessage(1, "testing/discoverTests", null);
         }
 
+        if (type == typeof(DiscoverRequestArgs))
+        {
+            return new DiscoverRequestArgs(
+                Guid.Empty,
+                new TestNode[]
+                {
+                    new()
+                    {
+                        Uid = new TestNodeUid("UnitTest1.TestMethod1"),
+                        DisplayName = "test1",
+                        Properties = new PropertyBag(new TestFileLocationProperty("filePath", new LinePositionSpan(new(1, 0), new(2, 0)))),
+                    },
+                },
+                null);
+        }
+
+        if (type == typeof(RunRequestArgs))
+        {
+            return new RunRequestArgs(
+                Guid.Empty,
+                new TestNode[]
+                {
+                    new()
+                    {
+                        Uid = new TestNodeUid("UnitTest1.TestMethod1"),
+                        DisplayName = "test1",
+                        Properties = new PropertyBag(new TestFileLocationProperty("filePath", new LinePositionSpan(new(1, 0), new(2, 0)))),
+                    },
+                },
+                null);
+        }
+
         // Last resort, try to create an instance of the type
         return type == typeof(object)
             ? new object()
@@ -396,6 +494,24 @@ public class FormatterUtilitiesTests : TestBase
 #endif
         }
 
+        if (type == typeof(DiscoverRequestArgs))
+        {
+#if NETCOREAPP
+            return _formatter.Deserialize<DiscoverRequestArgs>(instanceSerialized.AsMemory());
+#else
+            return _formatter.Deserialize<DiscoverRequestArgs>(instanceSerialized);
+#endif
+        }
+
+        if (type == typeof(RunRequestArgs))
+        {
+#if NETCOREAPP
+            return _formatter.Deserialize<RunRequestArgs>(instanceSerialized.AsMemory());
+#else
+            return _formatter.Deserialize<RunRequestArgs>(instanceSerialized);
+#endif
+        }
+
         if (type == typeof(ServerCapabilities))
         {
 #if NETCOREAPP

test/UnitTests/Microsoft.Testing.Platform.UnitTests/testsbaseline.netfx.txt

@@ -114,6 +114,8 @@ Microsoft.Testing.Platform.UnitTests.Microsoft.Testing.Platform.UnitTests.FileLo
 Microsoft.Testing.Platform.UnitTests.Microsoft.Testing.Platform.UnitTests.FileLoggerTests.Log_WhenSyncFlush_StreamWriterIsCalledOnlyWhenLogLevelAllowsIt(Microsoft.Testing.Platform.Logging.LogLevel, Microsoft.Testing.Platform.Logging.LogLevel) [6]
 Microsoft.Testing.Platform.UnitTests.Microsoft.Testing.Platform.UnitTests.FileLoggerTests.Write_IfMalformedUTF8_ShouldNotCrash()
 Microsoft.Testing.Platform.UnitTests.Microsoft.Testing.Platform.UnitTests.FormatterUtilitiesTests.CanDeserializeTaskResponse()
+Microsoft.Testing.Platform.UnitTests.Microsoft.Testing.Platform.UnitTests.FormatterUtilitiesTests.DeserializeSpecificTypes(System.Type) (type: typeof(Microsoft.Testing.Platform.ServerMode.DiscoverRequestArgs))
+Microsoft.Testing.Platform.UnitTests.Microsoft.Testing.Platform.UnitTests.FormatterUtilitiesTests.DeserializeSpecificTypes(System.Type) (type: typeof(Microsoft.Testing.Platform.ServerMode.RunRequestArgs))
 Microsoft.Testing.Platform.UnitTests.Microsoft.Testing.Platform.UnitTests.FormatterUtilitiesTests.SerializeDeserialize_Succeed(System.Type) (Artifact)
 Microsoft.Testing.Platform.UnitTests.Microsoft.Testing.Platform.UnitTests.FormatterUtilitiesTests.SerializeDeserialize_Succeed(System.Type) (AttachDebuggerInfoArgs)
 Microsoft.Testing.Platform.UnitTests.Microsoft.Testing.Platform.UnitTests.FormatterUtilitiesTests.SerializeDeserialize_Succeed(System.Type) (CancelRequestArgs)

test/UnitTests/Microsoft.Testing.Platform.UnitTests/testsbaseline.txt

@@ -114,6 +114,8 @@ Microsoft.Testing.Platform.UnitTests.Microsoft.Testing.Platform.UnitTests.FileLo
 Microsoft.Testing.Platform.UnitTests.Microsoft.Testing.Platform.UnitTests.FileLoggerTests.Log_WhenSyncFlush_StreamWriterIsCalledOnlyWhenLogLevelAllowsIt(Microsoft.Testing.Platform.Logging.LogLevel, Microsoft.Testing.Platform.Logging.LogLevel) [6]
 Microsoft.Testing.Platform.UnitTests.Microsoft.Testing.Platform.UnitTests.FileLoggerTests.Write_IfMalformedUTF8_ShouldNotCrash()
 Microsoft.Testing.Platform.UnitTests.Microsoft.Testing.Platform.UnitTests.FormatterUtilitiesTests.CanDeserializeTaskResponse()
+Microsoft.Testing.Platform.UnitTests.Microsoft.Testing.Platform.UnitTests.FormatterUtilitiesTests.DeserializeSpecificTypes(System.Type) (type: typeof(Microsoft.Testing.Platform.ServerMode.DiscoverRequestArgs))
+Microsoft.Testing.Platform.UnitTests.Microsoft.Testing.Platform.UnitTests.FormatterUtilitiesTests.DeserializeSpecificTypes(System.Type) (type: typeof(Microsoft.Testing.Platform.ServerMode.RunRequestArgs))
 Microsoft.Testing.Platform.UnitTests.Microsoft.Testing.Platform.UnitTests.FormatterUtilitiesTests.SerializeDeserialize_Succeed(System.Type) (Artifact)
 Microsoft.Testing.Platform.UnitTests.Microsoft.Testing.Platform.UnitTests.FormatterUtilitiesTests.SerializeDeserialize_Succeed(System.Type) (AttachDebuggerInfoArgs)
 Microsoft.Testing.Platform.UnitTests.Microsoft.Testing.Platform.UnitTests.FormatterUtilitiesTests.SerializeDeserialize_Succeed(System.Type) (CancelRequestArgs)