set env vars from resolver APIs

Author: baronfel

src/Resolvers/Microsoft.DotNet.MSBuildSdkResolver/MSBuildSdkResolver.cs

@@ -32,9 +32,11 @@ public sealed class DotNetMSBuildSdkResolver : SdkResolver
         private readonly Func<string, string, string?> _getMsbuildRuntime;
         private readonly NETCoreSdkResolver _netCoreSdkResolver;
 
+        private const string DOTNET_HOST = nameof(DOTNET_HOST);
         private const string DotnetHostExperimentalKey = "DOTNET_EXPERIMENTAL_HOST_PATH";
         private const string MSBuildTaskHostRuntimeVersion = "SdkResolverMSBuildTaskHostRuntimeVersion";
-
+        private const string SdkResolverHonoredGlobalJson = "SdkResolverHonoredGlobalJson";
+        private const string SdkResolverGlobalJsonPath = "SdkResolverGlobalJsonPath";
         private static CachingWorkloadResolver _staticWorkloadResolver = new();
 
         private bool _shouldLog = false;
@@ -68,6 +70,7 @@ private sealed class CachedState
             public string? GlobalJsonPath;
             public IDictionary<string, string?>? PropertiesToAdd;
             public CachingWorkloadResolver? WorkloadResolver;
+            public IDictionary<string, string?>? EnvironmentVariablesToAdd;
         }
 
         public override SdkResult? Resolve(SdkReference sdkReference, SdkResolverContext context, SdkResultFactory factory)
@@ -78,6 +81,7 @@ private sealed class CachedState
             string? globalJsonPath = null;
             IDictionary<string, string?>? propertiesToAdd = null;
             IDictionary<string, SdkResultItem>? itemsToAdd = null;
+            IDictionary<string, string?>? environmentVariablesToAdd = null;
             List<string>? warnings = null;
             CachingWorkloadResolver? workloadResolver = null;
 
@@ -99,6 +103,7 @@ private sealed class CachedState
                 globalJsonPath = priorResult.GlobalJsonPath;
                 propertiesToAdd = priorResult.PropertiesToAdd;
                 workloadResolver = priorResult.WorkloadResolver;
+                environmentVariablesToAdd = priorResult.EnvironmentVariablesToAdd;
 
                 logger?.LogMessage($"\tDotnet root: {dotnetRoot}");
                 logger?.LogMessage($"\tMSBuild SDKs Dir: {msbuildSdksDir}");
@@ -139,9 +144,9 @@ private sealed class CachedState
                 logger?.LogMessage($"\tResolved SDK directory: {resolverResult.ResolvedSdkDirectory}");
                 logger?.LogMessage($"\tglobal.json path: {resolverResult.GlobalJsonPath}");
                 logger?.LogMessage($"\tFailed to resolve SDK from global.json: {resolverResult.FailedToResolveSDKSpecifiedInGlobalJson}");
-
-                msbuildSdksDir = Path.Combine(resolverResult.ResolvedSdkDirectory, "Sdks");
-                netcoreSdkVersion = new DirectoryInfo(resolverResult.ResolvedSdkDirectory).Name;
+                string dotnetSdkDir = resolverResult.ResolvedSdkDirectory;
+                msbuildSdksDir = Path.Combine(dotnetSdkDir, "Sdks");
+                netcoreSdkVersion = new DirectoryInfo(dotnetSdkDir).Name;
                 globalJsonPath = resolverResult.GlobalJsonPath;
 
                 // These are overrides that are used to force the resolved SDK tasks and targets to come from a given
@@ -197,20 +202,22 @@ private sealed class CachedState
                 }
 
                 string? fullPathToMuxer =
-                    TryResolveMuxerFromSdkResolution(resolverResult)
+                    TryResolveMuxerFromSdkResolution(dotnetSdkDir)
                     ?? Path.Combine(dotnetRoot, RuntimeInformation.IsOSPlatform(OSPlatform.Windows) ? Constants.DotNetExe : Constants.DotNet);
                 if (File.Exists(fullPathToMuxer))
                 {
-                    propertiesToAdd ??= new Dictionary<string, string?>();
-                    propertiesToAdd.Add(DotnetHostExperimentalKey, fullPathToMuxer);
+                    environmentVariablesToAdd ??= new Dictionary<string, string?>(1)
+                    {
+                        [DOTNET_HOST] = fullPathToMuxer
+                    };
                 }
                 else
                 {
-                    logger?.LogMessage($"Could not set '{DotnetHostExperimentalKey}' because dotnet executable '{fullPathToMuxer}' does not exist.");
+                    logger?.LogMessage($"Could not set '{DOTNET_HOST}' environment variable because dotnet executable '{fullPathToMuxer}' does not exist.");
                 }
 
                 string? runtimeVersion = dotnetRoot != null ?
-                    _getMsbuildRuntime(resolverResult.ResolvedSdkDirectory, dotnetRoot) :
+                    _getMsbuildRuntime(dotnetSdkDir, dotnetRoot) :
                     null;
                 if (!string.IsNullOrEmpty(runtimeVersion))
                 {
@@ -224,7 +231,7 @@ private sealed class CachedState
 
                 if (resolverResult.FailedToResolveSDKSpecifiedInGlobalJson)
                 {
-                    logger?.LogMessage($"Could not resolve SDK specified in '{resolverResult.GlobalJsonPath}'. Ignoring global.json for this resolution.");
+                    logger?.LogMessage($"Could not resolve SDK specified in '{globalJsonPath}'. Ignoring global.json for this resolution.");
 
                     if (warnings == null)
                     {
@@ -241,8 +248,9 @@ private sealed class CachedState
                     }
 
                     propertiesToAdd ??= new Dictionary<string, string?>();
-                    propertiesToAdd.Add("SdkResolverHonoredGlobalJson", "false");
-                    propertiesToAdd.Add("SdkResolverGlobalJsonPath", resolverResult.GlobalJsonPath);
+                    propertiesToAdd.Add(SdkResolverHonoredGlobalJson, "false");
+                    // TODO: this would ideally be reported anytime it was non-null - that may cause more imports though?
+                    propertiesToAdd.Add(SdkResolverGlobalJsonPath, globalJsonPath);
 
                     if (logger != null)
                     {
@@ -258,7 +266,8 @@ private sealed class CachedState
                 NETCoreSdkVersion = netcoreSdkVersion,
                 GlobalJsonPath = globalJsonPath,
                 PropertiesToAdd = propertiesToAdd,
-                WorkloadResolver = workloadResolver
+                WorkloadResolver = workloadResolver,
+                EnvironmentVariablesToAdd = environmentVariablesToAdd
             };
 
             //  First check if requested SDK resolves to a workload SDK pack
@@ -285,7 +294,7 @@ private sealed class CachedState
                     msbuildSdkDir);
             }
 
-            return factory.IndicateSuccess(msbuildSdkDir, netcoreSdkVersion, propertiesToAdd, itemsToAdd, warnings);
+            return factory.IndicateSuccess(msbuildSdkDir, netcoreSdkVersion, propertiesToAdd, itemsToAdd, warnings, environmentVariablesToAdd: environmentVariablesToAdd);
         }
 
         /// <summary>
@@ -295,10 +304,10 @@ private sealed class CachedState
         /// SDK layouts always have a defined relationship to the location of the muxer -
         /// the muxer binary should be exactly two directories above the SDK directory.
         /// </remarks>
-        private static string? TryResolveMuxerFromSdkResolution(SdkResolutionResult resolverResult)
+        private static string? TryResolveMuxerFromSdkResolution(string resolvedSdkDirectory)
         {
             var expectedFileName = RuntimeInformation.IsOSPlatform(OSPlatform.Windows) ? Constants.DotNetExe : Constants.DotNet;
-            var currentDir = resolverResult.ResolvedSdkDirectory;
+            var currentDir = resolvedSdkDirectory;
             var expectedDotnetRoot = Path.GetDirectoryName(Path.GetDirectoryName(currentDir));
             var expectedMuxerPath = Path.Combine(expectedDotnetRoot, expectedFileName);
             if (File.Exists(expectedMuxerPath))

test/Microsoft.DotNet.MSBuildSdkResolver.Tests/GivenAnMSBuildSdkResolver.cs

@@ -205,8 +205,14 @@ public void ItReturnsHighestSdkAvailableThatIsCompatibleWithMSBuild(bool disallo
             if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
             {
                 // DotnetHost is the path to dotnet.exe. Can be only on Windows.
-                result.PropertiesToAdd.Should().NotBeNull().And.HaveCount(2);
-                result.PropertiesToAdd.Should().ContainKey(DotnetHostExperimentalKey);
+                result.PropertiesToAdd.Should().NotBeNull()
+                                        .And.HaveCount(1)
+                                        .And.NotContainKey(DotnetHostExperimentalKey);
+                result.EnvironmentVariablesToAdd.Should().NotBeNull()
+                                                .And.BeEquivalentTo(new Dictionary<string, string?>
+                                                {
+                                                    ["DOTNET_HOST"] = Path.Combine(environment.GetProgramFilesDirectory(ProgramFiles.X64).FullName, "dotnet", "dotnet.exe")
+                                                });
             }
             else
             {
@@ -231,9 +237,9 @@ public void WhenALocalSdkIsResolvedItReturnsHostFromThatSDKInsteadOfAmbientGloba
             var localSdkRoot = Path.Combine("some", "local", "dir");
             var localSdkDotnetRoot = Path.Combine(environment.TestDirectory.FullName, localSdkRoot, "dotnet");
             var ambientSdkDotnetRoot = Path.Combine(environment.GetProgramFilesDirectory(ProgramFiles.X64).FullName, "dotnet");
-            var ambientMSBuildSkRoot = environment.CreateSdkDirectory(ProgramFiles.X64, "Some.Test.Sdk", "1.2.3");
-            var localPathMSBuildSdkRoot = environment.CreateSdkDirectory(localSdkRoot, "Some.Test.Sdk", "1.2.4");
-            var ambientDotnetBinary = environment.CreateMuxerAndAddToPath(ProgramFiles.X64);
+            var _ambientMSBuildSkRoot = environment.CreateSdkDirectory(ProgramFiles.X64, "Some.Test.Sdk", "1.2.3");
+            var _localPathMSBuildSdkRoot = environment.CreateSdkDirectory(localSdkRoot, "Some.Test.Sdk", "1.2.4");
+            var _ambientDotnetBinary = environment.CreateMuxerAndAddToPath(ProgramFiles.X64);
             var localDotnetBinary = environment.CreateMuxer(localSdkRoot);
             environment.CreateGlobalJson(environment.TestDirectory, "1.2.3", [localSdkDotnetRoot, ambientSdkDotnetRoot]);
 
@@ -249,9 +255,11 @@ public void WhenALocalSdkIsResolvedItReturnsHostFromThatSDKInsteadOfAmbientGloba
                 context,
                 new MockFactory());
             result.Success.Should().BeTrue();
-            result.PropertiesToAdd.Should().NotBeNull().And.HaveCount(2);
-            result.PropertiesToAdd.Should().ContainKey(DotnetHostExperimentalKey);
-            result.PropertiesToAdd[DotnetHostExperimentalKey].Should().Be(localDotnetBinary);
+            result.PropertiesToAdd.Should().NotBeNull().And.HaveCount(1).And.ContainKey(MSBuildTaskHostRuntimeVersion);
+            result.EnvironmentVariablesToAdd.Should().NotBeNull().And.BeEquivalentTo(new Dictionary<string, string?>
+            {
+                [DotnetHostExperimentalKey] = localDotnetBinary
+            });
         }
 
         [Theory]
@@ -325,8 +333,13 @@ public void ItReturnsHighestSdkAvailableThatIsCompatibleWithMSBuildWhenVersionIn
             if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
             {
                 // DotnetHost is the path to dotnet.exe. Can be only on Windows.
-                result.PropertiesToAdd.Should().NotBeNull().And.HaveCount(4);
-                result.PropertiesToAdd.Should().ContainKey(DotnetHostExperimentalKey);
+                result.PropertiesToAdd.Should().NotBeNull().And.HaveCount(3);
+                result.PropertiesToAdd.Should().NotContainKey(DotnetHostExperimentalKey);
+                result.EnvironmentVariablesToAdd.Should().NotBeNull()
+                                                .And.BeEquivalentTo(new Dictionary<string, string?>
+                                                {
+                                                    ["DOTNET_HOST"] = Path.Combine(environment.GetProgramFilesDirectory(ProgramFiles.X64).FullName, "dotnet", "dotnet.exe")
+                                                });
             }
             else
             {