Add SetEntryAssembly() API to System.Reflection (#102271)

* Trying out JanK's approach to override the entry assembly...

* Fixed what was missing for this reflection scenario to work correctly.

* Reverted the compatibility suppressions added by the build script.

* Forgot to revert also the nativeaot part of the suppressions.

* Addressed PR comments: Updated the tests to use the new
"s_overriddenEntryAssembly", added an API doc to SetEntryAssembly(),
added validation for it to be a Runtime Assembly, and changed the type
to allow a null entry assembly.

* Added tests and addressed more comments on the PR.

* Added exception test case for SetEntryAssembly, and wrapped all its
test cases in a RemoteExecutor.Invoke() call, in order to avoid
potentially interferring with the GetEntryAssembly tests.

* Update src/libraries/System.Private.CoreLib/src/System/Reflection/Assembly.cs

Co-authored-by: Jan Kotas <[email protected]>

* Refactored further the tests that force a null entry assembly, and
fixed the issue with the remote executor.

* Apply Jan's suggestions

Co-authored-by: Jan Kotas <[email protected]>

* Fixed a sneaky trailing whitespace that was messing up with the code analyzers.

* Changed ConditionalTheory to ConditionalFact in the tests because we're not passing parameters to it.

* Disabled building the CustomHostTests test file when .NET Framework

---------

Co-authored-by: Jan Kotas <[email protected]>

Author: ivdiazsa

src/libraries/System.Configuration.ConfigurationManager/tests/System.Configuration.ConfigurationManager.Tests.csproj

@@ -59,7 +59,7 @@
     <Compile Include="System\Configuration\ConfigurationElementTests.cs" />
     <Compile Include="System\Configuration\ConfigurationPropertyAttributeTests.cs" />
     <Compile Include="System\Configuration\ConfigurationPathTests.cs" />
-    <Compile Include="System\Configuration\CustomHostTests.cs" />
+    <Compile Include="System\Configuration\CustomHostTests.cs" Condition="'$(TargetFrameworkIdentifier)' == '.NETCoreApp'" />
     <Compile Include="System\Configuration\ConfigurationPropertyTests.cs" />
     <Compile Include="System\Configuration\ConfigurationTests.cs" />
     <Compile Include="System\Configuration\BasicCustomSectionTests.cs" />

src/libraries/System.Configuration.ConfigurationManager/tests/System/Configuration/CustomHostTests.cs

@@ -19,7 +19,8 @@ public void FilePathIsPopulatedCorrectly()
         {
             RemoteExecutor.Invoke(() =>
             {
-                MakeAssemblyGetEntryAssemblyReturnNull();
+                Assembly.SetEntryAssembly(null);
+                Assert.Null(Assembly.GetEntryAssembly());
 
                 string expectedFilePathEnding = RuntimeInformation.IsOSPlatform(OSPlatform.Windows) ?
                     "dotnet.exe.config" :
@@ -29,17 +30,5 @@ public void FilePathIsPopulatedCorrectly()
                 Assert.EndsWith(expectedFilePathEnding, config.FilePath);
             }).Dispose();
         }
-
-        /// <summary>
-        /// Makes Assembly.GetEntryAssembly() return null using private reflection.
-        /// </summary>
-        private static void MakeAssemblyGetEntryAssemblyReturnNull()
-        {
-            typeof(Assembly)
-                .GetField("s_forceNullEntryPoint", BindingFlags.NonPublic | BindingFlags.Static)
-                .SetValue(null, true);
-
-            Assert.Null(Assembly.GetEntryAssembly());
-        }
     }
 }

src/libraries/System.Diagnostics.TraceSource/tests/System.Diagnostics.TraceSource.Tests/DefaultTraceListenerClassTests.cs

@@ -159,25 +159,14 @@ public void EntryAssemblyName_Null_NotIncludedInTrace()
         {
             RemoteExecutor.Invoke(() =>
             {
-                MakeAssemblyGetEntryAssemblyReturnNull();
+                Assembly.SetEntryAssembly(null);
+                Assert.Null(Assembly.GetEntryAssembly());
 
                 var listener = new TestDefaultTraceListener();
                 Trace.Listeners.Add(listener);
                 Trace.TraceError("hello world");
                 Assert.Equal("Error: 0 : hello world", listener.Output.Trim());
             }).Dispose();
         }
-
-        /// <summary>
-        /// Makes Assembly.GetEntryAssembly() return null using private reflection.
-        /// </summary>
-        private static void MakeAssemblyGetEntryAssemblyReturnNull()
-        {
-            typeof(Assembly)
-                .GetField("s_forceNullEntryPoint", BindingFlags.NonPublic | BindingFlags.Static)
-                .SetValue(null, true);
-
-            Assert.Null(Assembly.GetEntryAssembly());
-        }
     }
 }

src/libraries/System.Private.CoreLib/src/System/Reflection/Assembly.cs

@@ -217,13 +217,36 @@ public override string ToString()
             return type.Module?.Assembly;
         }
 
-        // internal test hook
-        private static bool s_forceNullEntryPoint;
+        private static object? s_overriddenEntryAssembly;
+
+        /// <summary>
+        /// Sets the application's entry assembly to the provided assembly object.
+        /// </summary>
+        /// <param name="assembly">
+        /// Assembly object that represents the application's new entry assembly.
+        /// </param>
+        /// <remarks>
+        /// The assembly passed to this function has to be a runtime defined Assembly
+        /// type object. Otherwise, an exception will be thrown.
+        /// </remarks>
+        public static void SetEntryAssembly(Assembly? assembly)
+        {
+            if (assembly is null)
+            {
+                s_overriddenEntryAssembly = string.Empty;
+                return;
+            }
+
+            if (assembly is not RuntimeAssembly)
+                throw new ArgumentException(SR.Argument_MustBeRuntimeAssembly);
+
+            s_overriddenEntryAssembly = assembly;
+        }
 
         public static Assembly? GetEntryAssembly()
         {
-            if (s_forceNullEntryPoint)
-                return null;
+            if (s_overriddenEntryAssembly is not null)
+                return s_overriddenEntryAssembly as Assembly;
 
             return GetEntryAssemblyInternal();
         }

src/libraries/System.Runtime/ref/System.Runtime.cs

@@ -11176,6 +11176,7 @@ public virtual void GetObjectData(System.Runtime.Serialization.SerializationInfo
         [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute("Types and members the loaded assembly depends on might be removed")]
         [System.ObsoleteAttribute("ReflectionOnly loading is not supported and throws PlatformNotSupportedException.", DiagnosticId="SYSLIB0018", UrlFormat="https://aka.ms/dotnet-warnings/{0}")]
         public static System.Reflection.Assembly ReflectionOnlyLoadFrom(string assemblyFile) { throw null; }
+        public static void SetEntryAssembly(System.Reflection.Assembly? assembly) { throw null; }
         public override string ToString() { throw null; }
         [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute("Types and members the loaded assembly depends on might be removed")]
         public static System.Reflection.Assembly UnsafeLoadFrom(string assemblyFile) { throw null; }

src/libraries/System.Runtime/tests/System.Reflection.Tests/AssemblyTests.cs

@@ -7,10 +7,12 @@
 using System.Globalization;
 using System.IO;
 using System.Linq;
+using System.Reflection.Emit;
 using System.Reflection.Tests;
 using System.Runtime.CompilerServices;
 using System.Security;
 using System.Text;
+using Microsoft.DotNet.RemoteExecutor;
 using Xunit;
 
 [assembly:
@@ -181,6 +183,32 @@ public void GetEntryAssembly()
             Assert.True(correct, $"Unexpected assembly name {assembly}");
         }
 
+        [ConditionalFact(typeof(RemoteExecutor), nameof(RemoteExecutor.IsSupported))]
+        public void SetEntryAssembly()
+        {
+            Assert.NotNull(Assembly.GetEntryAssembly());
+
+            RemoteExecutor.Invoke(() =>
+            {
+                Assembly.SetEntryAssembly(null);
+                Assert.Null(Assembly.GetEntryAssembly());
+
+                Assembly testAssembly = typeof(AssemblyTests).Assembly;
+
+                Assembly.SetEntryAssembly(testAssembly);
+                Assert.Equal(Assembly.GetEntryAssembly(), testAssembly);
+
+                var invalidAssembly = new PersistedAssemblyBuilder(
+                    new AssemblyName("NotaRuntimeAssemblyTest"),
+                    typeof(object).Assembly
+                );
+
+                Assert.Throws<ArgumentException>(
+                    () => Assembly.SetEntryAssembly(invalidAssembly)
+                );
+            }).Dispose();
+        }
+
         [Fact]
         public void GetFile()
         {

src/libraries/System.Runtime/tests/System.Reflection.Tests/System.Reflection.Tests.csproj

@@ -2,6 +2,7 @@
   <PropertyGroup>
     <TargetFramework>$(NetCoreAppCurrent)</TargetFramework>
     <TestRuntime>true</TestRuntime>
+    <IncludeRemoteExecutor>true</IncludeRemoteExecutor>
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
     <!-- SYSLIB0013: Uri.EscapeUriString is obsolete
          SYSLIB0037: AssemblyName members HashAlgorithm, ProcessorArchitecture, and VersionCompatibility are obsolete. -->