Make it so the artifacts folders register files for cleanup

Author: baronfel

src/Tasks/Microsoft.NET.Build.Tasks/targets/Microsoft.NET.DefaultOutputPaths.targets

@@ -51,6 +51,8 @@ Copyright (c) .NET Foundation. All rights reserved.
     <ArtifactsBinOutputName Condition="'$(ArtifactsBinOutputName)' == ''">bin</ArtifactsBinOutputName>
     <ArtifactsPublishOutputName Condition="'$(ArtifactsPublishOutputName)' == ''">publish</ArtifactsPublishOutputName>
     <ArtifactsPackageOutputName Condition="'$(ArtifactsPackageOutputName)' == ''">package</ArtifactsPackageOutputName>
+    <!-- When using artifacts output, we need to track file writes  with a bit more knowledge than the MSBuild Common targets have-->
+    <IncrementalCleanDependsOn>$(IncrementalCleanDependsOn);_TrackFileWritesShareableUnderArtifactsPath</IncrementalCleanDependsOn>
   </PropertyGroup>
 
   <PropertyGroup Condition="'$(UseArtifactsOutput)' == 'true' And '$(ArtifactsPivots)' == ''">
@@ -90,9 +92,9 @@ Copyright (c) .NET Foundation. All rights reserved.
 
     <!-- The package output path does not include the project name, and only includes the Configuration as a pivot -->
     <PackageOutputPath Condition="'$(PackageOutputPath)' == ''">$(ArtifactsPath)\$(ArtifactsPackageOutputName)\$(Configuration.ToLowerInvariant())\</PackageOutputPath>
-    
+
   </PropertyGroup>
-  
+
   <PropertyGroup Condition="'$(UseArtifactsOutput)' != 'true'">
     <BaseOutputPath Condition="'$(BaseOutputPath)' == ''">bin\</BaseOutputPath>
     <BaseOutputPath Condition="!HasTrailingSlash('$(BaseOutputPath)')">$(BaseOutputPath)\</BaseOutputPath>
@@ -155,10 +157,31 @@ Copyright (c) .NET Foundation. All rights reserved.
 
     <NetSdkError Condition="'$(UseArtifactsOutput)' == 'true' and '$(_ArtifactsPathSetEarly)' != 'true'"
                  ResourceName="ArtifactsPathCannotBeSetInProject" />
-    
+
     <NetSdkError Condition="'$(_ArtifactsPathLocationType)' == 'ProjectFolder'"
                  ResourceName="UseArtifactsOutputRequiresDirectoryBuildProps" />
 
   </Target>
 
+
+  <!-- Addresses a gap in the _CleanGetCurrentAndPriorFileWrites:
+       https://github.com/dotnet/msbuild/blob/25d1e4c409f9efd81c345fb41fbee6d2af83bed6/src/Tasks/Microsoft.Common.CurrentVersion.targets#L5765-L5777
+
+       This Target won't remove FileWritesShareable if they aren't under the Project's own directory,
+       but in Artifacts layout that will never be the case. So we allow finding the FileWritesShareable under our output
+       paths as well -->
+  <Target Name="_TrackFileWritesShareableUnderArtifactsPath">
+    <FindUnderPath Path="$(OutputPath)" Files="@(FileWritesShareable)" UpdateToAbsolutePaths="true">
+      <Output TaskParameter="InPath" ItemName="_LocatedFileWritesShareable"/>
+    </FindUnderPath>
+    <FindUnderPath Path="$(IntermediateOutputPath)" Files="@(FileWritesShareable)" UpdateToAbsolutePaths="true">
+      <Output TaskParameter="InPath" ItemName="_LocatedFileWritesShareable"/>
+    </FindUnderPath>
+
+    <!-- Remove duplicates from files produced in this build. -->
+    <RemoveDuplicates Inputs="@(_LocatedFileWritesShareable)" >
+      <Output TaskParameter="Filtered" ItemName="_CleanCurrentFileWrites"/>
+    </RemoveDuplicates>
+  </Target>
+
 </Project>

test/Microsoft.NET.Build.Tests/ArtifactsOutputPathTests.cs

@@ -531,6 +531,74 @@ public void ItCanBuildWithMicrosoftBuildArtifactsSdk()
             new FileInfo(Path.Combine(testAsset.Path, "MSBuildSdk", "obj", "Debug", ToolsetInfo.CurrentTargetFramework, "MSBuildSdk.dll")).Should().Exist();
 
         }
+
+        [Fact]
+        public void PublishingRegistersWrittenFilesForProperCleanup()
+        {
+            var testProject = new TestProject()
+            {
+                IsExe = true,
+                UseArtifactsOutput = true,
+            };
+
+            var testAsset = _testAssetsManager.CreateTestProject(testProject);
+
+            //  Now add a Directory.Build.props file setting UseArtifactsOutput to true
+            File.WriteAllText(Path.Combine(testAsset.Path, "Directory.Build.props"), """
+                <Project>
+                  <PropertyGroup>
+                    <UseArtifactsOutput>true</UseArtifactsOutput>
+                  </PropertyGroup>
+                </Project>
+                """);
+
+            var projectDir = Path.Combine(testAsset.Path, testAsset.TestProject.Name);
+
+            // publish the app
+            // we publish self-contained so that we include hostfxr.dll.
+            // if we don't clean up this file, when we build in Release,
+            // the generated exe will pick up the hostfxr and fail to run.
+            // so the only way to successfully run the exe is to clean up
+            // the hostfxr.dll and other self-contained files.
+            new DotnetPublishCommand(Log)
+                .WithWorkingDirectory(projectDir)
+                .Execute("--self-contained")
+                .Should()
+                .Pass();
+
+            var outputDir = new DirectoryInfo(OutputPathCalculator.FromProject(testAsset.Path, testProject).GetOutputDirectory(configuration: "release"));
+            outputDir.Should().Exist().And.HaveFile("hostfxr.dll");
+            LocateAndRunApp(outputDir);
+
+            var publishDir = new DirectoryInfo(OutputPathCalculator.FromProject(testAsset.Path, testProject).GetPublishDirectory(configuration: "release"));
+            publishDir.Should().Exist().And.HaveFile("hostfxr.dll");
+            LocateAndRunApp(publishDir);
+
+            // now build the app in Release configuration.
+            // now self-contained, so that we are forced to clean up the runtime
+            // files that were published.
+            new DotnetBuildCommand(Log)
+                .WithWorkingDirectory(projectDir)
+                .Execute("-c", "Release")
+                .Should()
+                .Pass();
+            outputDir.Should().Exist();
+            outputDir.Should().NotHaveFiles(["hostfxr.dll"]);
+            LocateAndRunApp(outputDir);
+
+            void LocateAndRunApp(DirectoryInfo root)
+            {
+                var appBinaryName = RuntimeInformation.IsOSPlatform(OSPlatform.Windows)
+                ? $"{testProject.Name}.exe"
+                : testProject.Name;
+                root.Should().HaveFiles([appBinaryName]);
+                var binary = root.GetFiles(appBinaryName).First();
+                new RunExeCommand(Log, binary.FullName)
+                    .Execute()
+                    .Should()
+                    .Pass();
+            }
+        }
     }
 
     namespace ArtifactsTestExtensions