Allow serialization of DateOnly/TimeOnly for parameterized tests (#5676)

Author: Youssef1313

src/Adapter/MSTest.TestAdapter/Helpers/DataSerializationHelper.cs

@@ -1,6 +1,11 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
+#if NETFRAMEWORK
+using System.CodeDom;
+using System.Collections.ObjectModel;
+#endif
+using System.Runtime.Serialization;
 using System.Runtime.Serialization.Json;
 
 namespace Microsoft.VisualStudio.TestPlatform.MSTest.TestAdapter.Helpers;
@@ -13,6 +18,10 @@ internal static class DataSerializationHelper
         UseSimpleDictionaryFormat = true,
         EmitTypeInformation = System.Runtime.Serialization.EmitTypeInformation.Always,
         DateTimeFormat = new System.Runtime.Serialization.DateTimeFormat("O", CultureInfo.InvariantCulture),
+#if NETFRAMEWORK
+        DataContractSurrogate = SerializationSurrogateProvider.Instance,
+#endif
+        KnownTypes = [typeof(SurrogatedDateOnly), typeof(SurrogatedTimeOnly)],
     };
 
     /// <summary>
@@ -47,6 +56,9 @@ internal static class DataSerializationHelper
             serializedData[typeIndex] = typeName;
 
             DataContractJsonSerializer serializer = GetSerializer(type);
+#if NET7_0_OR_GREATER
+            serializer.SetSerializationSurrogateProvider(SerializationSurrogateProvider.Instance);
+#endif
 
             using var memoryStream = new MemoryStream();
             // This should be safe as long as our generator mentions
@@ -93,6 +105,9 @@ internal static class DataSerializationHelper
             }
 
             DataContractJsonSerializer serializer = GetSerializer(assemblyQualifiedName);
+#if NET7_0_OR_GREATER
+            serializer.SetSerializationSurrogateProvider(SerializationSurrogateProvider.Instance);
+#endif
 
             byte[] serializedDataBytes = Encoding.UTF8.GetBytes(serializedValue);
             using var memoryStream = new MemoryStream(serializedDataBytes);
@@ -104,6 +119,9 @@ internal static class DataSerializationHelper
             data[i] = serializer.ReadObject(memoryStream);
 #pragma warning restore IL3050 // IL3050: Avoid calling members annotated with 'RequiresDynamicCodeAttribute' when publishing as Native AOT
 #pragma warning restore IL2026 // IL2026: Members attributed with RequiresUnreferencedCode may break when trimming
+            // For some reason, we don't get SerializationSurrogateProvider.GetDeserializedObject to be called by .NET runtime.
+            // So we manually call it.
+            data[i] = SerializationSurrogateProvider.GetDeserializedObject(data[i]!);
         }
 
         return data;
@@ -130,6 +148,93 @@ private static DataContractJsonSerializer GetSerializer(Type type)
 #pragma warning disable IL3050 // IL3050: Avoid calling members annotated with 'RequiresDynamicCodeAttribute' when publishing as Native AOT
 #pragma warning disable IL2026 // IL2026: Members attributed with RequiresUnreferencedCode may break when trimming
             _ => new DataContractJsonSerializer(type, SerializerSettings));
+
+    [DataContract]
+    private sealed class SurrogatedDateOnly
+    {
+        [DataMember]
+        public int DayNumber { get; set; }
+    }
+
+    [DataContract]
+    private sealed class SurrogatedTimeOnly
+    {
+        [DataMember]
+        public long Ticks { get; set; }
+    }
+
+    private sealed class SerializationSurrogateProvider
+#if NETFRAMEWORK
+        : IDataContractSurrogate
+#else
+        : ISerializationSurrogateProvider
+#endif
+    {
+        public static SerializationSurrogateProvider Instance { get; } = new();
+
+#if NETFRAMEWORK
+        public object GetCustomDataToExport(MemberInfo memberInfo, Type dataContractType) => null!;
+
+        public object GetCustomDataToExport(Type clrType, Type dataContractType) => null!;
+
+        public void GetKnownCustomDataTypes(Collection<Type> customDataTypes)
+        {
+        }
+
+        public Type GetReferencedTypeOnImport(string typeName, string typeNamespace, object customData) => null!;
+
+        public CodeTypeDeclaration ProcessImportedType(CodeTypeDeclaration typeDeclaration, CodeCompileUnit compileUnit) => typeDeclaration;
+#endif
+
+        public object GetDeserializedObject(object obj, Type targetType)
+            => GetDeserializedObject(obj);
+
+        internal static object GetDeserializedObject(object obj)
+        {
+#if NET6_0_OR_GREATER
+            if (obj is SurrogatedDateOnly surrogatedDateOnly)
+            {
+                return DateOnly.FromDayNumber(surrogatedDateOnly.DayNumber);
+            }
+            else if (obj is SurrogatedTimeOnly surrogatedTimeOnly)
+            {
+                return new TimeOnly(surrogatedTimeOnly.Ticks);
+            }
+#endif
+
+            return obj;
+        }
+
+        public object GetObjectToSerialize(object obj, Type targetType)
+            => obj switch
+            {
+#if NET6_0_OR_GREATER
+                DateOnly dateOnly => new SurrogatedDateOnly() { DayNumber = dateOnly.DayNumber },
+                TimeOnly timeOnly => new SurrogatedTimeOnly() { Ticks = timeOnly.Ticks },
+#endif
+                _ => obj,
+            };
+
+#if NETFRAMEWORK
+        public Type GetDataContractType(Type type)
+#else
+        public Type GetSurrogateType(Type type)
+#endif
+        {
+#if NET6_0_OR_GREATER
+            if (type == typeof(DateOnly))
+            {
+                return typeof(SurrogatedDateOnly);
+            }
+            else if (type == typeof(TimeOnly))
+            {
+                return typeof(SurrogatedTimeOnly);
+            }
+#endif
+
+            return type;
+        }
+    }
 #pragma warning restore IL3050 // IL3050: Avoid calling members annotated with 'RequiresDynamicCodeAttribute' when publishing as Native AOT
 #pragma warning restore IL2026 // IL2026: Members attributed with RequiresUnreferencedCode may break when trimming
 }

src/TestFramework/TestFramework/Attributes/DataSource/DynamicDataOperations.cs

@@ -118,13 +118,7 @@ private static bool TryGetData(object dataSource, [NotNullWhen(true)] out IEnume
             List<object[]> objects = [];
             foreach (object? entry in enumerable)
             {
-                if (entry is null)
-                {
-                    data = null;
-                    return false;
-                }
-
-                objects.Add([entry]);
+                objects.Add([entry!]);
             }
 
             data = objects;

test/UnitTests/MSTestAdapter.UnitTests/Helpers/DataSerializationHelperTests.cs

@@ -55,4 +55,28 @@ public void DataSerializerShouldRoundTripDateTimeOfKindUtc()
         Verify(actual[0]!.Equals(source));
         Verify(((DateTime)actual[0]!).Kind.Equals(source.Kind));
     }
+
+#if NET7_0_OR_GREATER
+    public void DataSerializerShouldRoundTripDateOnly()
+    {
+        var source = new DateOnly(1999, 11, 3);
+
+        object?[]? actual = DataSerializationHelper.Deserialize(DataSerializationHelper.Serialize([source]));
+
+        Verify(actual!.Length == 1);
+        Verify(actual[0]!.GetType() == typeof(DateOnly));
+        Verify(actual[0]!.Equals(source));
+    }
+
+    public void DataSerializerShouldRoundTripTimeOnly()
+    {
+        var source = new TimeOnly(hour: 14, minute: 50, second: 13, millisecond: 15);
+
+        object?[]? actual = DataSerializationHelper.Deserialize(DataSerializationHelper.Serialize([source]));
+
+        Verify(actual!.Length == 1);
+        Verify(actual[0]!.GetType() == typeof(TimeOnly));
+        Verify(actual[0]!.Equals(source));
+    }
+#endif
 }

test/UnitTests/MSTestAdapter.UnitTests/MSTestAdapter.UnitTests.csproj

@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <NetStandardNetFrameworkHolder>net48</NetStandardNetFrameworkHolder>
-    <TargetFrameworks>net6.0;net462;$(NetStandardNetFrameworkHolder);netcoreapp3.1</TargetFrameworks>
+    <TargetFrameworks>net6.0;net7.0;net462;$(NetStandardNetFrameworkHolder);netcoreapp3.1</TargetFrameworks>
     <TargetFrameworks Condition=" '$(OS)' == 'Windows_NT' ">$(TargetFrameworks);$(WinUiMinimum)</TargetFrameworks>
     <IsNetCoreApp Condition=" '$(TargetFramework)' == 'netcoreapp3.1' OR '$(TargetFramework)' == 'net6.0' OR '$(TargetFramework)' == '$(WinUiMinimum)' ">true</IsNetCoreApp>
     <RootNamespace>Microsoft.VisualStudio.TestPlatform.MSTestAdapter.UnitTests</RootNamespace>