Enlighten RAR task

documentation/wiki/ChangeWaves.md

@@ -29,6 +29,9 @@ Change wave checks around features will be removed in the release that accompani
 
 ## Current Rotation of Change Waves
 
+### 18.8
+- [RAR task: across multiple input properties, resolve relative paths against the project directory (not the process current directory)](https://github.com/dotnet/msbuild/pull/13319)
+
 ### 18.7
 - [Copy task retries on ERROR_ACCESS_DENIED on non-Windows platforms to handle transient lock conflicts (e.g. macOS CoW filesystems)](https://github.com/dotnet/msbuild/issues/13463)
 - [Fix ASP.NET WebSite projects to resolve netstandard2.0 dependencies](https://github.com/dotnet/msbuild/pull/13058) - Pass TargetFrameworkVersion to RAR task and copy netstandard.dll facade for .NET Framework 4.7.1+ web projects.

src/Framework/ChangeWaves.cs

@@ -35,7 +35,8 @@ internal static class ChangeWaves
         internal static readonly Version Wave18_5 = new Version(18, 5);
         internal static readonly Version Wave18_6 = new Version(18, 6);
         internal static readonly Version Wave18_7 = new Version(18, 7);
-        internal static readonly Version[] AllWaves = [Wave17_10, Wave17_12, Wave17_14, Wave18_3, Wave18_4, Wave18_5, Wave18_6, Wave18_7];
+        internal static readonly Version Wave18_8 = new Version(18, 8);
+        internal static readonly Version[] AllWaves = [Wave17_10, Wave17_12, Wave17_14, Wave18_3, Wave18_4, Wave18_5, Wave18_6, Wave18_7, Wave18_8];
 
         /// <summary>
         /// Special value indicating that all features behind all Change Waves should be enabled.

src/Framework/TaskEnvironment.cs

@@ -33,6 +33,13 @@ internal TaskEnvironment(ITaskEnvironmentDriver driver)
         /// </remarks>
         public static TaskEnvironment Fallback { get; } = new(MultiProcessTaskEnvironmentDriver.Instance);
 
+        /// <summary>
+        /// Gets a value indicating whether this <see cref="TaskEnvironment"/> is providing
+        /// per-task isolated state (multithreaded mode). When <see langword="false"/>, the
+        /// environment delegates to the shared process environment (multi-process mode).
+        /// </summary>
+        internal bool IsMultiThreaded => _driver is MultiThreadedTaskEnvironmentDriver;
+
         /// <summary>
         /// Creates a new <see cref="TaskEnvironment"/> with isolated working directory and environment variables.
         /// </summary>

src/Tasks.UnitTests/AssemblyDependency/AssemblyFoldersFromConfig_Tests.cs

@@ -1,4 +1,4 @@
-// Licensed to the .NET Foundation under one or more agreements.
+// Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System.IO;

src/Tasks.UnitTests/AssemblyDependency/Miscellaneous.cs

@@ -1135,23 +1135,56 @@ public void Regress286699_InvalidSearchPath()
         }
 
         /// <summary>
-        /// Invalid app.config path should not crash.
+        /// Invalid or empty app.config paths should not crash.
+        /// Invalid path "|" causes a logged error and task failure.
+        /// Empty string is silently ignored (Wave18_8 behavior) and task succeeds.
         /// </summary>
-        [Fact]
-        public void Regress286699_InvalidAppConfig()
+        [Theory]
+        [InlineData("|", false)]
+        [InlineData("", true)]
+        public void InvalidOrEmptyAppConfig_DoesNotCrash(string appConfigFile, bool expectedSuccess)
         {
             ResolveAssemblyReference t = new ResolveAssemblyReference();
 
             t.BuildEngine = new MockEngine(_output);
-
-            t.Assemblies = new ITaskItem[] { new TaskItem("mscorlib") };
-            t.AppConfigFile = "|";
+            t.Assemblies = [new TaskItem("mscorlib")];
+            t.AppConfigFile = appConfigFile;
 
             bool retval = Execute(t);
 
-            Assert.False(retval);
+            retval.ShouldBe(expectedSuccess);
+        }
 
-            // Should not crash.
+        /// <summary>
+        /// When Wave18_8 is disabled, empty AppConfigFile should cause the task to fail
+        /// with an error, preserving backward-compatible behavior.
+        /// </summary>
+        [Fact]
+        public void EmptyAppConfigFile_Wave18_8_Disabled_Fails()
+        {            
+            try
+            {
+                using TestEnvironment env = TestEnvironment.Create(_output);
+
+                ChangeWaves.ResetStateForTests();
+                env.SetEnvironmentVariable("MSBUILDDISABLEFEATURESFROMVERSION", ChangeWaves.Wave18_8.ToString());
+                BuildEnvironmentHelper.ResetInstance_ForUnitTestsOnly();
+
+                ResolveAssemblyReference t = new ResolveAssemblyReference();
+
+                MockEngine engine = new MockEngine(_output);
+                t.BuildEngine = engine;
+                t.Assemblies = new ITaskItem[] { new TaskItem("mscorlib") };
+                t.AppConfigFile = string.Empty;
+
+                bool retval = Execute(t);
+                retval.ShouldBeFalse();
+                engine.Errors.ShouldBe(1);
+            }
+            finally
+            {
+                ChangeWaves.ResetStateForTests();
+            }
         }
 
         /// <summary>
@@ -6702,7 +6735,7 @@ public void ReferenceTableDependentItemsInDenyList4()
 #if FEATURE_WIN32_REGISTRY
                 null, null, null,
 #endif
-                null, null, null, new Version("4.0"), null, null, null, true, false, null, null, false, null, WarnOrErrorOnTargetArchitectureMismatchBehavior.None, false, false, null, Array.Empty<string>());
+                null, null, null, new Version("4.0"), null, null, null, true, false, null, null, false, null, WarnOrErrorOnTargetArchitectureMismatchBehavior.None, false, false, null, Array.Empty<string>(), TaskEnvironmentHelper.CreateForTest());
             MockEngine mockEngine;
             ResolveAssemblyReference rar;
             Dictionary<string, string> denyList;
@@ -6880,7 +6913,7 @@ private static ReferenceTable MakeEmptyReferenceTable(TaskLoggingHelper log)
 #if FEATURE_WIN32_REGISTRY
                 null, null, null,
 #endif
-                null, null, new Version("4.0"), null, log, null, true, false, null, null, false, null, WarnOrErrorOnTargetArchitectureMismatchBehavior.None, false, false, null, Array.Empty<string>());
+                null, null, new Version("4.0"), null, log, null, true, false, null, null, false, null, WarnOrErrorOnTargetArchitectureMismatchBehavior.None, false, false, null, Array.Empty<string>(), TaskEnvironmentHelper.CreateForTest());
             return referenceTable;
         }
 

src/Tasks.UnitTests/AssemblyDependency/Node/RarNodeExecuteRequest_Tests.cs

@@ -57,26 +57,6 @@ public void TaskInputsArePropagated()
             Assert.Equal(clientRar.StateFile, nodeRar.StateFile);
         }
 
-        [Fact]
-        public void KnownRelativePathsAreResolvedToFullPaths()
-        {
-            const string AppConfigFileName = "App.config";
-            const string StateFileName = "AssemblyReference.cache";
-            ResolveAssemblyReference clientRar = new()
-            {
-                BuildEngine = new MockEngine(),
-                AppConfigFile = AppConfigFileName,
-                StateFile = StateFileName,
-            };
-            RarNodeExecuteRequest request = new(clientRar);
-
-            ResolveAssemblyReference nodeRar = new();
-            request.SetTaskInputs(nodeRar, CreateBuildEngine());
-
-            Assert.Equal(Path.GetFullPath(AppConfigFileName), nodeRar.AppConfigFile);
-            Assert.Equal(Path.GetFullPath(StateFileName), nodeRar.StateFile);
-        }
-
         [Fact]
         public void BuildEngineSettingsArePropagated()
         {

src/Tasks.UnitTests/AssemblyDependency/ResolveAssemblyReferenceCacheSerialization.cs

@@ -192,5 +192,97 @@ public void OutgoingCacheIsEmpty()
             // The new cache was not written to disk at all because none of the entries were actually used.
             sysState2.ShouldBeNull();
         }
+
+        /// <summary>
+        /// SystemState.DeserializePrecomputedCaches absolutizes the state file path via TaskEnvironment
+        /// (relative to the project directory), not via the process current working directory.
+        /// A relative state file path that exists in CWD but not in the project directory should
+        /// fail to deserialize.
+        /// </summary>
+        [Fact]
+        public void DeserializePrecomputedCaches_AbsolutizesStateFilePathViaTaskEnvironment()
+        {
+            using TestEnvironment env = TestEnvironment.Create();
+
+            // cacheDir holds the real cache file (and becomes CWD); projectDir is empty.
+            string cacheDir = env.CreateFolder().Path;
+            string projectDir = env.CreateFolder().Path;
+            string cacheFileName = "rar.cache";
+            string cacheFullPath = Path.Combine(cacheDir, cacheFileName);
+
+            WriteCacheFileWithSingleEntry(cacheFullPath, "TestAssembly.dll");
+
+            env.SetCurrentDirectory(cacheDir);
+
+            ITaskItem[] stateFiles = [new TaskItem(cacheFileName)];
+            TaskEnvironment taskEnvironment = TaskEnvironment.CreateWithProjectDirectoryAndEnvironment(projectDir);
+
+            SystemState result = SystemState.DeserializePrecomputedCaches(
+                stateFiles,
+                null,
+                _ => true,
+                taskEnvironment);
+
+            // The relative path is resolved via TaskEnvironment to projectDir/rar.cache, which doesn't
+            // exist. If the implementation incorrectly used CWD, it would have found the cache and
+            // populated entries.
+            result.ShouldNotBeNull();
+            result.instanceLocalFileStateCache.ShouldBeEmpty();
+        }
+
+        /// <summary>
+        /// With Wave18_8 disabled, SystemState.DeserializePrecomputedCaches uses the raw
+        /// stateFile.ToString() path which means a relative state file path is opened relative
+        /// to the process current working directory — NOT relative to TaskEnvironment.ProjectDirectory.
+        /// </summary>
+        [Fact]
+        public void DeserializePrecomputedCaches_Wave18_8_Disabled_UsesRawPathRelativeToCwd()
+        {
+            using TestEnvironment env = TestEnvironment.Create();
+
+            ChangeWaves.ResetStateForTests();
+            env.SetEnvironmentVariable("MSBUILDDISABLEFEATURESFROMVERSION", ChangeWaves.Wave18_8.ToString());
+            BuildEnvironmentHelper.ResetInstance_ForUnitTestsOnly();
+            try
+            {
+                // cacheDir holds the real cache file (and becomes CWD); projectDir is empty.
+                string cacheDir = env.CreateFolder().Path;
+                string projectDir = env.CreateFolder().Path;
+                string cacheFileName = "rar.cache";
+                string cacheFullPath = Path.Combine(cacheDir, cacheFileName);
+
+                WriteCacheFileWithSingleEntry(cacheFullPath, "TestAssembly.dll");
+
+                env.SetCurrentDirectory(cacheDir);
+
+                ITaskItem[] stateFiles = [new TaskItem(cacheFileName)];
+                TaskEnvironment taskEnvironment = TaskEnvironment.CreateWithProjectDirectoryAndEnvironment(projectDir);
+
+                SystemState result = SystemState.DeserializePrecomputedCaches(
+                    stateFiles,
+                    null,
+                    _ => true,
+                    taskEnvironment);
+
+                // Under wave-off, the bare relative path is resolved via CWD (= cacheDir),
+                // where the cache exists, so deserialization succeeded and the entry was processed.
+                result.ShouldNotBeNull();
+                result.instanceLocalFileStateCache.ShouldNotBeEmpty();
+            }
+            finally
+            {
+                ChangeWaves.ResetStateForTests();
+            }
+        }
+
+        /// <summary>
+        /// Writes a serialized SystemState cache with a single entry to <paramref name="cacheFullPath"/>.
+        /// </summary>
+        private static void WriteCacheFileWithSingleEntry(string cacheFullPath, string relativeKey)
+        {
+            SystemState sysState = new();
+            sysState.instanceLocalOutgoingFileStateCache[relativeKey] = new SystemState.FileState(DateTime.UtcNow);
+            sysState.SerializeCache(cacheFullPath, log: null);
+        }
     }
 }

src/Tasks.UnitTests/AssemblyDependency/ResolveAssemblyReferenceTestFixture.cs

@@ -854,10 +854,8 @@ internal static bool FileExists(string path)
                 return false;
             }
 
-            if (!Path.IsPathRooted(path))
-            {
-                path = Path.GetFullPath(path);
-            }
+            // Canonicalize the path (resolve ".." segments etc.) so it matches s_existentFiles entries.
+            path = Path.GetFullPath(path);
 
             foreach (string file in s_existentFiles)
             {
@@ -1048,10 +1046,8 @@ internal static AssemblyNameExtension GetAssemblyName(string path)
                 throw new FileNotFoundException(path);
             }
 
-            if (!Path.IsPathRooted(path))
-            {
-                path = Path.GetFullPath(path);
-            }
+            // Canonicalize the path (resolve ".." segments etc.) so it matches expected entries.
+            path = Path.GetFullPath(path);
 
             if
             (

src/Tasks.UnitTests/HintPathResolver_Tests.cs

@@ -1,4 +1,4 @@
-// Licensed to the .NET Foundation under one or more agreements.
+// Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System;
@@ -71,7 +71,8 @@ private bool ResolveHintPath(string hintPath)
                 getAssemblyName: (path) => throw new NotImplementedException(), // not called in this code path
                 fileExists: p => FileUtilities.FileExistsNoThrow(p),
                 getRuntimeVersion: (path) => throw new NotImplementedException(), // not called in this code path
-                targetedRuntimeVesion: Version.Parse("4.0.30319"));
+                targetedRuntimeVesion: Version.Parse("4.0.30319"),
+                taskEnvironment: TaskEnvironmentHelper.CreateForTest());
 
             var result = hintPathResolver.Resolve(new AssemblyNameExtension("FakeSystem.Net.Http"),
                 sdkName: "",

src/Tasks.UnitTests/RARPrecomputedCache_Tests.cs

@@ -87,7 +87,9 @@ public void StandardCacheTakesPrecedence()
                 // Write precomputed cache
                 rarWriterTask.WriteStateFile();
 
-                ResolveAssemblyReference rarReaderTask = new ResolveAssemblyReference();
+                ResolveAssemblyReference rarReaderTask = new ResolveAssemblyReference()
+                {
+                };
                 rarReaderTask.StateFile = standardCache.Path;
                 rarReaderTask.AssemblyInformationCachePaths = new ITaskItem[]
                 {
@@ -131,7 +133,9 @@ public void TestPreComputedCacheInputMatchesOutput()
                 File.Delete(precomputedCache.Path);
                 rarWriterTask.WriteStateFile();
 
-                ResolveAssemblyReference rarReaderTask = new ResolveAssemblyReference();
+                ResolveAssemblyReference rarReaderTask = new ResolveAssemblyReference()
+                {
+                };
                 rarReaderTask.StateFile = precomputedCache.Path.Substring(0, precomputedCache.Path.Length - 6); // Not a real path; should not be used.
                 rarReaderTask.AssemblyInformationCachePaths = new ITaskItem[]
                 {