Try finalizer on RemoteInvokeHandle (#27087)

* Try finalizer on RemoteInvokeHandle

* Adding missing Dispose call to RemoteInvoke's in different test projects

* Fixing tests in System.Diagnostics.Process missing Dispose on RemoteInvokeHandle

* Add missing Dispose call to System.Data.Common.XsdSchemaDeserializationIgnoresLocale()

* Fixing netfx failure in System.Runtime

* Adding missing Dispose call after using RemoteInvokeHandle in System.Net.ServicePoint project

Author: danmoseley

src/CoreFx.Private.TestUtilities/ref/CoreFx.Private.TestUtilities.cs

@@ -144,9 +144,9 @@ protected RemoteExecutorTestBase() { }
         public static System.Diagnostics.RemoteExecutorTestBase.RemoteInvokeHandle RemoteInvokeRaw(System.Delegate method, string unparsedArg, System.Diagnostics.RemoteInvokeOptions options = null) { throw null; }
         public sealed partial class RemoteInvokeHandle : System.IDisposable
         {
-            public RemoteInvokeHandle(System.Diagnostics.Process process, System.Diagnostics.RemoteInvokeOptions options) { }
+            public RemoteInvokeHandle(System.Diagnostics.Process process, System.Diagnostics.RemoteInvokeOptions options, string assemblyName, string className, string methodName) { }
             public System.Diagnostics.RemoteInvokeOptions Options { [System.Runtime.CompilerServices.CompilerGeneratedAttribute]get { throw null; } }
-            public System.Diagnostics.Process Process { [System.Runtime.CompilerServices.CompilerGeneratedAttribute]get { throw null; } }
+            public System.Diagnostics.Process Process { [System.Runtime.CompilerServices.CompilerGeneratedAttribute]get { throw null; } [System.Runtime.CompilerServices.CompilerGeneratedAttribute]set { } }
             public void Dispose() { }
         }
     }

src/CoreFx.Private.TestUtilities/src/System/Diagnostics/RemoteExecutorTestBase.Process.cs

@@ -72,7 +72,9 @@ private static RemoteInvokeHandle RemoteInvoke(MethodInfo method, string[] args,
             // Return the handle to the process, which may or not be started
             return new RemoteInvokeHandle(options.Start ?
                 Process.Start(psi) :
-                new Process() { StartInfo = psi }, options);
+                new Process() { StartInfo = psi }, options,
+                a.FullName, t.FullName, method.Name
+                );
         }
     }
 }

src/CoreFx.Private.TestUtilities/src/System/Diagnostics/RemoteExecutorTestBase.cs

@@ -186,17 +186,31 @@ private static MethodInfo GetMethodInfo(Delegate d)
         /// <summary>A cleanup handle to the Process created for the remote invocation.</summary>
         public sealed class RemoteInvokeHandle : IDisposable
         {
-            public RemoteInvokeHandle(Process process, RemoteInvokeOptions options)
+            public RemoteInvokeHandle(Process process, RemoteInvokeOptions options, string assemblyName = null, string className = null, string methodName = null)
             {
                 Process = process;
                 Options = options;
+                AssemblyName = assemblyName;
+                ClassName = className;
+                MethodName = methodName;
             }
 
-            public Process Process { get; private set; }
+            public Process Process { get; set; }
             public RemoteInvokeOptions Options { get; private set; }
+            public string AssemblyName { get; private set; }
+            public string ClassName { get; private set; }
+            public string MethodName { get; private set; }
 
             public void Dispose()
             {
+                Dispose(disposing: true);
+                GC.SuppressFinalize(this);
+            }
+
+            private void Dispose(bool disposing)
+            {
+                Assert.True(disposing, $"A test {AssemblyName}!{ClassName}.{MethodName} forgot to Dispose() the result of RemoteInvoke()");
+
                 if (Process != null)
                 {
                     // A bit unorthodox to do throwing operations in a Dispose, but by doing it here we avoid
@@ -236,6 +250,13 @@ public void Dispose()
                 }
             }
 
+            ~RemoteInvokeHandle()
+            {
+                // Finalizer flags tests that omitted the explicit Dispose() call; they must have it, or they aren't
+                // waiting on the remote execution
+                Dispose(disposing: false);
+            }
+
             private sealed class RemoteExecutionException : XunitException
             {
                 internal RemoteExecutionException(string stackTrace) : base("Remote process failed with an unhandled exception.", stackTrace) { }

src/CoreFx.Private.TestUtilities/src/System/Diagnostics/RemoteExecutorTestBase.uap.cs

@@ -70,7 +70,7 @@ private static RemoteInvokeHandle RemoteInvoke(MethodInfo method, string[] args,
             }
 
             // RemoteInvokeHandle is not really needed in the UAP scenario but we use it just to have consistent interface as non UAP
-            return new RemoteInvokeHandle(null, options);
+            return new RemoteInvokeHandle(null, options, null, null, null);
         }
     }
 }

src/System.ComponentModel.TypeConverter/tests/DateTimeConverterTests.cs

@@ -66,7 +66,7 @@ public static void ConvertTo_WithContext()
                     DateTimeConverterTests.s_converter);
 
                 return SuccessExitCode;
-            });
+            }).Dispose();
         }
     }
 }

src/System.ComponentModel.TypeConverter/tests/DateTimeOffsetConverterTests.cs

@@ -68,7 +68,7 @@ public static void ConvertTo_WithContext()
                     DateTimeOffsetConverterTests.s_converter);
 
                 return SuccessExitCode;
-            });
+            }).Dispose();
         }
     }
 }

src/System.ComponentModel.TypeConverter/tests/TypeConverterTests.cs

@@ -110,7 +110,7 @@ public static void ConvertTo_WithContext()
                 Assert.NotNull(s);
                 Assert.Equal(FormattableClass.Token, s);
                 return SuccessExitCode;
-            });
+            }).Dispose();
         }
 
         [Fact]

src/System.Data.Common/tests/System/Data/DataTableReadXmlSchemaTest.cs

@@ -485,7 +485,7 @@ public void XsdSchemaSerializationIgnoresLocale()
                 Assert.Contains(@"AutoIncrementStep=""-2""", rawSchemaXML);
                 Assert.DoesNotContain("()1", rawSchemaXML);
                 Assert.DoesNotContain("()2", rawSchemaXML);
-            });
+            }).Dispose();
         }
 
         [Fact]
@@ -600,7 +600,7 @@ incorrectly uses the current culture instead of the invariant culture when parsi
                 DataColumn rowIDColumn = table.Columns["RowID"];
                 Assert.Equal(-1, rowIDColumn.AutoIncrementSeed);
                 Assert.Equal(-2, rowIDColumn.AutoIncrementStep);
-            });
+            }).Dispose();
         }
 
         [Fact]

src/System.Diagnostics.Process/tests/ProcessTestBase.cs

@@ -51,14 +51,20 @@ protected void AddProcessForDispose(Process p)
 
         protected Process CreateProcess(Func<int> method = null)
         {
-            Process p = RemoteInvoke(method ?? (() => SuccessExitCode), new RemoteInvokeOptions { Start = false }).Process;
+            RemoteInvokeHandle handle = RemoteInvoke(method ?? (() => SuccessExitCode), new RemoteInvokeOptions { Start = false });
+            Process p = handle.Process;
+            handle.Process = null;
+            handle.Dispose();
             AddProcessForDispose(p);
             return p;
         }
 
         protected Process CreateProcess(Func<string, int> method, string arg)
         {
-            Process p = RemoteInvoke(method, arg, new RemoteInvokeOptions { Start = false }).Process;
+            RemoteInvokeHandle handle = RemoteInvoke(method, arg, new RemoteInvokeOptions { Start = false });
+            Process p = handle.Process;
+            handle.Process = null;
+            handle.Dispose();
             AddProcessForDispose(p);
             return p;
         }

src/System.IO/tests/StringWriter/StringWriterTests.cs

@@ -308,7 +308,7 @@ public static void TestWriteMisc()
                 sw.Write((ulong)ulong.MaxValue);
 
                 Assert.Equal("Truea1234.013452342.0123456-92233720368547758081234.5429496729518446744073709551615", sw.ToString());
-            });
+            }).Dispose();
         }
 
         [Fact]
@@ -337,7 +337,7 @@ public static void TestWriteLineMisc()
                 Assert.Equal(
                     string.Format("False{0}B{0}987{0}875634{0}1.23457{0}45634563{0}18446744073709551615{0}", Environment.NewLine),
                     sw.ToString());
-            });
+            }).Dispose();
         }
 
         [Fact]