Fix serialization of exceptions by BinaryFormatter in .NET Framework

src/TestFramework/TestFramework/Constants.cs

@@ -9,4 +9,6 @@ namespace Microsoft.VisualStudio.TestTools.UnitTesting;
 internal static class Constants
 {
     internal const string PublicTypeObsoleteMessage = "We will remove or hide this type starting with v4. If you are using this type, reach out to our team on https://github.com/microsoft/testfx.";
+
+    internal const string LegacyFormatterImplementationMessage = "This API supports obsolete formatter-based serialization. It should not be called or extended by application code.";
 }

src/TestFramework/TestFramework/Exceptions/AssertFailedException.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 || NETSTANDARD2_0
+using System.ComponentModel;
+using System.Runtime.Serialization;
+#endif
+
 namespace Microsoft.VisualStudio.TestTools.UnitTesting;
 
 /// <summary>
@@ -35,4 +40,18 @@ public AssertFailedException()
         : base()
     {
     }
+
+#if NETFRAMEWORK || NETSTANDARD2_0
+    /// <summary>
+    /// Initializes a new instance of the <see cref="AssertFailedException"/> class.
+    /// </summary>
+    /// <param name="info">Serialization info.</param>
+    /// <param name="context">Streaming context.</param>
+    [Obsolete(Constants.LegacyFormatterImplementationMessage)]
+    [EditorBrowsable(EditorBrowsableState.Never)]
+    protected AssertFailedException(SerializationInfo info, StreamingContext context)
+        : base(info, context)
+    {
+    }
+#endif
 }

src/TestFramework/TestFramework/Exceptions/AssertInconclusiveException.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 || NETSTANDARD2_0
+using System.ComponentModel;
+using System.Runtime.Serialization;
+#endif
+
 namespace Microsoft.VisualStudio.TestTools.UnitTesting;
 
 /// <summary>
@@ -35,4 +40,18 @@ public AssertInconclusiveException()
         : base()
     {
     }
+
+#if NETFRAMEWORK || NETSTANDARD2_0
+    /// <summary>
+    /// Initializes a new instance of the <see cref="AssertInconclusiveException"/> class.
+    /// </summary>
+    /// <param name="info">Serialization info.</param>
+    /// <param name="context">Streaming context.</param>
+    [Obsolete(Constants.LegacyFormatterImplementationMessage)]
+    [EditorBrowsable(EditorBrowsableState.Never)]
+    protected AssertInconclusiveException(SerializationInfo info, StreamingContext context)
+        : base(info, context)
+    {
+    }
+#endif
 }

src/TestFramework/TestFramework/Exceptions/InternalTestFailureException.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 || NETSTANDARD2_0
+using System.ComponentModel;
+using System.Runtime.Serialization;
+#endif
+
 namespace Microsoft.VisualStudio.TestTools.UnitTesting;
 
 /// <summary>
@@ -46,4 +51,18 @@ public InternalTestFailureException()
         : base()
     {
     }
+
+#if NETFRAMEWORK || NETSTANDARD2_0
+    /// <summary>
+    /// Initializes a new instance of the <see cref="InternalTestFailureException"/> class.
+    /// </summary>
+    /// <param name="info">Serialization info.</param>
+    /// <param name="context">Streaming context.</param>
+    [Obsolete(Constants.LegacyFormatterImplementationMessage)]
+    [EditorBrowsable(EditorBrowsableState.Never)]
+    protected InternalTestFailureException(SerializationInfo info, StreamingContext context)
+        : base(info, context)
+    {
+    }
+#endif
 }

src/TestFramework/TestFramework/Exceptions/UnitTestAssertException.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 || NETSTANDARD2_0
+using System.ComponentModel;
+using System.Runtime.Serialization;
+#endif
+
 namespace Microsoft.VisualStudio.TestTools.UnitTesting;
 
 /// <summary>
@@ -34,4 +39,18 @@ protected UnitTestAssertException(string msg)
         : base(msg)
     {
     }
+
+#if NETFRAMEWORK || NETSTANDARD2_0
+    /// <summary>
+    /// Initializes a new instance of the <see cref="UnitTestAssertException"/> class.
+    /// </summary>
+    /// <param name="info">Serialization info.</param>
+    /// <param name="context">Streaming context.</param>
+    [Obsolete(Constants.LegacyFormatterImplementationMessage)]
+    [EditorBrowsable(EditorBrowsableState.Never)]
+    protected UnitTestAssertException(SerializationInfo info, StreamingContext context)
+        : base(info, context)
+    {
+    }
+#endif
 }

src/TestFramework/TestFramework/PublicAPI/netframework/PublicAPI.Shipped.txt

@@ -0,0 +1 @@
+#nullable enable

src/TestFramework/TestFramework/PublicAPI/netframework/PublicAPI.Unshipped.txt

@@ -0,0 +1,5 @@
+#nullable enable
+Microsoft.VisualStudio.TestTools.UnitTesting.AssertInconclusiveException.AssertInconclusiveException(System.Runtime.Serialization.SerializationInfo! info, System.Runtime.Serialization.StreamingContext context) -> void
+Microsoft.VisualStudio.TestTools.UnitTesting.AssertFailedException.AssertFailedException(System.Runtime.Serialization.SerializationInfo! info, System.Runtime.Serialization.StreamingContext context) -> void
+Microsoft.VisualStudio.TestTools.UnitTesting.InternalTestFailureException.InternalTestFailureException(System.Runtime.Serialization.SerializationInfo! info, System.Runtime.Serialization.StreamingContext context) -> void
+Microsoft.VisualStudio.TestTools.UnitTesting.UnitTestAssertException.UnitTestAssertException(System.Runtime.Serialization.SerializationInfo! info, System.Runtime.Serialization.StreamingContext context) -> void

src/TestFramework/TestFramework/PublicAPI/netstandard2.0/PublicAPI.Shipped.txt

@@ -0,0 +1 @@
+#nullable enable

src/TestFramework/TestFramework/PublicAPI/netstandard2.0/PublicAPI.Unshipped.txt

@@ -0,0 +1,5 @@
+#nullable enable
+Microsoft.VisualStudio.TestTools.UnitTesting.AssertInconclusiveException.AssertInconclusiveException(System.Runtime.Serialization.SerializationInfo! info, System.Runtime.Serialization.StreamingContext context) -> void
+Microsoft.VisualStudio.TestTools.UnitTesting.AssertFailedException.AssertFailedException(System.Runtime.Serialization.SerializationInfo! info, System.Runtime.Serialization.StreamingContext context) -> void
+Microsoft.VisualStudio.TestTools.UnitTesting.InternalTestFailureException.InternalTestFailureException(System.Runtime.Serialization.SerializationInfo! info, System.Runtime.Serialization.StreamingContext context) -> void
+Microsoft.VisualStudio.TestTools.UnitTesting.UnitTestAssertException.UnitTestAssertException(System.Runtime.Serialization.SerializationInfo! info, System.Runtime.Serialization.StreamingContext context) -> void

src/TestFramework/TestFramework/TestFramework.csproj

@@ -17,6 +17,12 @@
 
     <AdditionalFiles Include="PublicAPI\net\PublicAPI.Shipped.txt" Condition="$([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)', 'netcoreapp3.1'))" />
     <AdditionalFiles Include="PublicAPI\net\PublicAPI.Unshipped.txt" Condition="$([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)', 'netcoreapp3.1'))" />
+
+    <AdditionalFiles Include="PublicAPI\netframework\PublicAPI.Shipped.txt" Condition="$([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)', 'net462'))" />
+    <AdditionalFiles Include="PublicAPI\netframework\PublicAPI.Unshipped.txt" Condition="$([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)', 'net462'))" />
+
+    <AdditionalFiles Include="PublicAPI\netstandard2.0\PublicAPI.Shipped.txt" Condition="'$(TargetFramework)' == 'netstandard2.0'" />
+    <AdditionalFiles Include="PublicAPI\netstandard2.0\PublicAPI.Unshipped.txt" Condition="'$(TargetFramework)' == 'netstandard2.0'" />
   </ItemGroup>
 
   <ItemGroup>

test/UnitTests/TestFramework.UnitTests/Exceptions/BinaryFormatterExceptionSerializationTests.cs

@@ -0,0 +1,45 @@
+// 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.Runtime.Serialization.Formatters.Binary;
+
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+
+using TestFramework.ForTestingMSTest;
+
+namespace Microsoft.VisualStudio.TestPlatform.TestFramework.UnitTests.Attributes;
+
+public class BinaryFormatterExceptionSerializationTests : TestContainer
+{
+    public void AssertFailedExceptionCanBeSerializedAndDeserialized()
+        => VerifySerialization(Assert.Fail);
+
+    public void AssertInconclusiveExceptionCanBeSerializedAndDeserialized()
+        => VerifySerialization(Assert.Inconclusive);
+
+    public void InternalTestFailureExceptionCanBeSerializedAndDeserialized()
+        => VerifySerialization(() => throw new InternalTestFailureException("Some internal error."));
+
+    private void VerifySerialization(Action actionThatThrows)
+    {
+        try
+        {
+            actionThatThrows();
+        }
+        catch (Exception ex)
+        {
+            // Ensure the thrown exception can be serialized and deserialized by binary formatter to keep compatibility with it,
+            // even though it is obsoleted and removed in .NET.
+            var mem = new MemoryStream();
+            new BinaryFormatter().Serialize(mem, ex);
+            mem.Position = 0;
+            new BinaryFormatter().Deserialize(mem);
+
+            return;
+        }
+
+        throw new InvalidOperationException($"The provided '{nameof(actionThatThrows)}' did not throw any exception.");
+    }
+}
+#endif

test/UnitTests/TestFramework.UnitTests/TestFramework.UnitTests.csproj

@@ -14,7 +14,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <ProjectReference Include="$(RepoRoot)src\TestFramework\TestFramework\TestFramework.csproj"/>
+    <ProjectReference Include="$(RepoRoot)src\TestFramework\TestFramework\TestFramework.csproj" />
     <ProjectReference Include="$(RepoRoot)test\Utilities\TestFramework.ForTestingMSTest\TestFramework.ForTestingMSTest.csproj" />
   </ItemGroup>