Add IFileSystemService abstraction for simplified temp file management (#13282)

* Initial plan

* Add IFileSystemService interfaces with adjusted APIs

Co-authored-by: davidfowl <[email protected]>

Update DistributedApplicationBuilder to register and expose IFileSystemService

Co-authored-by: davidfowl <[email protected]>

Update AspireStore and Locations to use IFileSystemService

Co-authored-by: davidfowl <[email protected]>

Add implementation status document with remaining work

Co-authored-by: davidfowl <[email protected]>

Fix invalid XML doc comment syntax for TempFile.Dispose

Co-authored-by: davidfowl <[email protected]>

Simplify CreateTempFile API to take no parameters

Co-authored-by: davidfowl <[email protected]>

Fix test compilation errors - add experimental warnings and fix constructor calls

Co-authored-by: davidfowl <[email protected]>

Update high priority files to use IFileSystemService

Co-authored-by: davidfowl <[email protected]>

Add optional fileName parameter to CreateTempFile

Co-authored-by: davidfowl <[email protected]>

Rename shared TempDirectory helper class to TestTempDirectory

Co-authored-by: davidfowl <[email protected]>

Refactor file handling to use IFileSystemService for temporary file management in Maui environment annotations and MySql builder extensions

Update implementation status to reflect IFileSystemService integration across MySQL and MAUI components

* Refactor user secrets management and file system service integration

* Refactor tests to use TestTempDirectory instead of TempDirectory

- Updated multiple test files across MySql, PostgreSQL, Python, and Yarp tests to replace instances of TempDirectory with TestTempDirectory for improved test isolation and resource management.
- Ensured consistent usage of TestTempDirectory in various test scenarios, including configuration file generation and environment variable handling.

* Add tests for FileSystemService methods and temp directory management

* Remove implementation status document for IFileSystemService adjustments

* Add IUserSecretsManager support and suppress related warnings

* Add missing FileSystemService and UserSecretsManager properties to IDistributedApplicationTestingBuilder

* Specify filename for temporary runtime config files in CreateCustomRuntimeConfig method

---------

Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: David Fowler <[email protected]>

Author: Copilot

src/Aspire.Hosting.Azure/AzurePublishingContext.cs

@@ -1,10 +1,13 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+#pragma warning disable ASPIREFILESYSTEM001 // Type is for evaluation purposes only
+
 using System.Diagnostics.CodeAnalysis;
 using System.Runtime.CompilerServices;
 using Aspire.Hosting.ApplicationModel;
 using Aspire.Hosting.Pipelines;
+using Microsoft.Extensions.DependencyInjection;
 using Azure.Provisioning;
 using Azure.Provisioning.Expressions;
 using Azure.Provisioning.Primitives;
@@ -118,6 +121,9 @@ private async Task WriteAzureArtifactsOutputAsync(IReportingStep step, Distribut
             outputDirectory.Create();
         }
 
+        var fileSystemService = ServiceProvider.GetRequiredService<IFileSystemService>();
+        var tempDirectory = fileSystemService.TempDirectory.CreateTempSubdirectory("aspire-bicep").Path;
+
         var bicepResourcesToPublish = model.Resources.OfType<AzureBicepResource>()
             .Where(r => !r.IsExcludedFromPublish())
             .ToList();
@@ -145,7 +151,7 @@ private async Task WriteAzureArtifactsOutputAsync(IReportingStep step, Distribut
 
         foreach (var resource in bicepResourcesToPublish)
         {
-            var file = resource.GetBicepTemplateFile();
+            var file = resource.GetBicepTemplateFile(tempDirectory);
 
             var moduleDirectory = outputDirectory.CreateSubdirectory(resource.Name);
 
@@ -336,7 +342,7 @@ void CaptureBicepOutputsFromParameters(IResourceWithParameters resource)
 
                 var modulePath = Path.Combine(moduleDirectory.FullName, $"{resource.Name}.bicep");
 
-                var file = br.GetBicepTemplateFile();
+                var file = br.GetBicepTemplateFile(tempDirectory);
 
                 File.Copy(file.Path, modulePath, true);
 

src/Aspire.Hosting.Azure/Provisioning/Provisioners/BicepProvisioner.cs

@@ -1,5 +1,8 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
+
+#pragma warning disable ASPIREFILESYSTEM001 // Type is for evaluation purposes only
+
 using System.Collections.Immutable;
 using System.Diagnostics;
 using System.Text.Json.Nodes;
@@ -23,6 +26,7 @@ internal sealed class BicepProvisioner(
     ISecretClientProvider secretClientProvider,
     IDeploymentStateManager deploymentStateManager,
     DistributedApplicationExecutionContext executionContext,
+    IFileSystemService fileSystemService,
     ILogger<BicepProvisioner> logger) : IBicepProvisioner
 {
     /// <inheritdoc />
@@ -135,7 +139,8 @@ await notificationService.PublishUpdateAsync(resource, state => state with
             ])
         }).ConfigureAwait(false);
 
-        var template = resource.GetBicepTemplateFile();
+        var tempDirectory = fileSystemService.TempDirectory.CreateTempSubdirectory("aspire-bicep").Path;
+        var template = resource.GetBicepTemplateFile(tempDirectory);
         var path = template.Path;
 
         // GetBicepTemplateFile may have added new well-known parameters, so we need

src/Aspire.Hosting.Maui/Utilities/MauiAndroidEnvironmentAnnotation.cs

@@ -1,9 +1,12 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+#pragma warning disable ASPIREFILESYSTEM001 // Type is for evaluation purposes only
+
 using Aspire.Hosting.ApplicationModel;
 using Aspire.Hosting.Eventing;
 using Aspire.Hosting.Lifecycle;
+using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
 
 namespace Aspire.Hosting.Maui.Utilities;
@@ -38,7 +41,8 @@ internal sealed class MauiAndroidEnvironmentProcessedAnnotation : IResourceAnnot
 internal sealed class MauiAndroidEnvironmentSubscriber(
     DistributedApplicationExecutionContext executionContext,
     ResourceLoggerService loggerService,
-    ResourceNotificationService notificationService) : IDistributedApplicationEventingSubscriber
+    ResourceNotificationService notificationService,
+    IFileSystemService fileSystemService) : IDistributedApplicationEventingSubscriber
 {
     public Task SubscribeAsync(IDistributedApplicationEventing eventing, DistributedApplicationExecutionContext execContext, CancellationToken cancellationToken)
     {
@@ -83,6 +87,7 @@ private async Task OnBeforeResourceStartedAsync(BeforeResourceStartedEvent @even
                 if (generatedFilePath is null)
                 {
                     generatedFilePath = await MauiEnvironmentHelper.CreateAndroidEnvironmentTargetsFileAsync(
+                        fileSystemService,
                         resource,
                         executionContext,
                         logger,

src/Aspire.Hosting.Maui/Utilities/MauiEnvironmentHelper.cs

@@ -1,6 +1,8 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+#pragma warning disable ASPIREFILESYSTEM001 // Type is for evaluation purposes only
+
 using System.Globalization;
 using System.Text;
 using System.Xml.Linq;
@@ -22,12 +24,14 @@ internal static class MauiEnvironmentHelper
     /// <summary>
     /// Creates an MSBuild targets file for Android that sets environment variables.
     /// </summary>
+    /// <param name="fileSystemService">The file system service for managing temp files.</param>
     /// <param name="resource">The resource to collect environment variables from.</param>
     /// <param name="executionContext">The execution context.</param>
     /// <param name="logger">Logger for diagnostic output.</param>
     /// <param name="cancellationToken">Cancellation token.</param>
     /// <returns>The path to the generated targets file, or null if no environment variables are present.</returns>
     public static async Task<string?> CreateAndroidEnvironmentTargetsFileAsync(
+        IFileSystemService fileSystemService,
         IResource resource,
         DistributedApplicationExecutionContext executionContext,
         ILogger logger,
@@ -62,8 +66,7 @@ internal static class MauiEnvironmentHelper
         }
 
         // Create a temporary targets file
-        var tempDirectory = Path.Combine(Path.GetTempPath(), "aspire", "maui", "android-env");
-        Directory.CreateDirectory(tempDirectory);
+        var tempDirectory = fileSystemService.TempDirectory.CreateTempSubdirectory("aspire-maui-android-env").Path;
 
         // Prune old targets files
         PruneOldTargets(tempDirectory, logger);
@@ -209,12 +212,14 @@ private static string EncodeSemicolons(string value, out bool wasEncoded)
     /// <summary>
     /// Creates an MSBuild targets file for iOS that sets environment variables.
     /// </summary>
+    /// <param name="fileSystemService">The file system service for managing temp files.</param>
     /// <param name="resource">The resource to collect environment variables from.</param>
     /// <param name="executionContext">The execution context.</param>
     /// <param name="logger">Logger for diagnostic output.</param>
     /// <param name="cancellationToken">Cancellation token.</param>
     /// <returns>The path to the generated targets file, or null if no environment variables are present.</returns>
     public static async Task<string?> CreateiOSEnvironmentTargetsFileAsync(
+        IFileSystemService fileSystemService,
         IResource resource,
         DistributedApplicationExecutionContext executionContext,
         ILogger logger,
@@ -232,8 +237,7 @@ private static string EncodeSemicolons(string value, out bool wasEncoded)
         }
 
         // Create a temporary targets file
-        var tempDirectory = Path.Combine(Path.GetTempPath(), "aspire", "maui", "mlaunch-env");
-        Directory.CreateDirectory(tempDirectory);
+        var tempDirectory = fileSystemService.TempDirectory.CreateTempSubdirectory("aspire-maui-mlaunch-env").Path;
 
         // Prune old targets files
         PruneOldTargetsiOS(tempDirectory, logger);

src/Aspire.Hosting.Maui/Utilities/MauiiOSEnvironmentAnnotation.cs

@@ -1,9 +1,12 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+#pragma warning disable ASPIREFILESYSTEM001 // Type is for evaluation purposes only
+
 using Aspire.Hosting.ApplicationModel;
 using Aspire.Hosting.Eventing;
 using Aspire.Hosting.Lifecycle;
+using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
 
 namespace Aspire.Hosting.Maui.Utilities;
@@ -38,7 +41,8 @@ internal sealed class MauiiOSEnvironmentProcessedAnnotation : IResourceAnnotatio
 internal sealed class MauiiOSEnvironmentSubscriber(
     DistributedApplicationExecutionContext executionContext,
     ResourceLoggerService loggerService,
-    ResourceNotificationService notificationService) : IDistributedApplicationEventingSubscriber
+    ResourceNotificationService notificationService,
+    IFileSystemService fileSystemService) : IDistributedApplicationEventingSubscriber
 {
     public Task SubscribeAsync(IDistributedApplicationEventing eventing, DistributedApplicationExecutionContext execContext, CancellationToken cancellationToken)
     {
@@ -83,6 +87,7 @@ private async Task OnBeforeResourceStartedAsync(BeforeResourceStartedEvent @even
                 if (generatedFilePath is null)
                 {
                     generatedFilePath = await MauiEnvironmentHelper.CreateiOSEnvironmentTargetsFileAsync(
+                        fileSystemService,
                         resource,
                         executionContext,
                         logger,

src/Aspire.Hosting.MySql/MySqlBuilderExtensions.cs

@@ -1,6 +1,8 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+#pragma warning disable ASPIREFILESYSTEM001 // Type is for evaluation purposes only
+
 using Aspire.Hosting;
 using Aspire.Hosting.ApplicationModel;
 using Aspire.Hosting.MySql;
@@ -260,7 +262,8 @@ public static IResourceBuilder<T> WithPhpMyAdmin<T>(this IResourceBuilder<T> bui
             }
             else
             {
-                var tempConfigFile = await WritePhpMyAdminConfiguration(mySqlInstances, ct).ConfigureAwait(false);
+                var fileSystemService = e.Services.GetRequiredService<IFileSystemService>();
+                var tempConfigFile = await WritePhpMyAdminConfiguration(fileSystemService, mySqlInstances, ct).ConfigureAwait(false);
 
                 try
                 {
@@ -374,10 +377,10 @@ public static IResourceBuilder<MySqlServerResource> WithInitFiles(this IResource
         return builder.WithContainerFiles(initPath, importFullPath);
     }
 
-    private static async Task<string> WritePhpMyAdminConfiguration(IEnumerable<MySqlServerResource> mySqlInstances, CancellationToken cancellationToken)
+    private static async Task<string> WritePhpMyAdminConfiguration(IFileSystemService fileSystemService, IEnumerable<MySqlServerResource> mySqlInstances, CancellationToken cancellationToken)
     {
         // This temporary file is not used by the container, it will be copied and then deleted
-        var filePath = Path.GetTempFileName();
+        var filePath = fileSystemService.TempDirectory.CreateTempFile().Path;
 
         using var writer = new StreamWriter(filePath);
 

src/Aspire.Hosting.Testing/DistributedApplicationTestingBuilder.cs

@@ -2,13 +2,16 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 #pragma warning disable ASPIREPIPELINES001
+#pragma warning disable ASPIREUSERSECRETS001
+#pragma warning disable ASPIREFILESYSTEM001
 
 using System.Diagnostics;
 using System.Diagnostics.CodeAnalysis;
 using System.Reflection;
 using Aspire.Hosting.ApplicationModel;
 using Aspire.Hosting.Eventing;
 using Aspire.Hosting.Pipelines;
+using Aspire.Hosting.UserSecrets;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
@@ -244,6 +247,8 @@ private sealed class Builder(SuspendingDistributedApplicationFactory factory, Di
 
             public IDistributedApplicationPipeline Pipeline => innerBuilder.Pipeline;
 
+            public IUserSecretsManager UserSecretsManager => innerBuilder.UserSecretsManager;
+
             public IResourceBuilder<T> AddResource<T>(T resource) where T : IResource => innerBuilder.AddResource(resource);
 
             public DistributedApplication Build() => BuildAsync(CancellationToken.None).Result;
@@ -396,6 +401,8 @@ static Assembly FindApplicationAssembly()
 
         public IDistributedApplicationPipeline Pipeline => _innerBuilder.Pipeline;
 
+        public IUserSecretsManager UserSecretsManager => _innerBuilder.UserSecretsManager;
+
         public IResourceBuilder<T> AddResource<T>(T resource) where T : IResource => _innerBuilder.AddResource(resource);
 
         [MemberNotNull(nameof(_app))]
@@ -486,6 +493,12 @@ public interface IDistributedApplicationTestingBuilder : IDistributedApplication
     /// <inheritdoc cref="IDistributedApplicationBuilder.Resources" />
     new IResourceCollection Resources => ((IDistributedApplicationBuilder)this).Resources;
 
+    /// <inheritdoc cref="IDistributedApplicationBuilder.FileSystemService" />
+    new IFileSystemService FileSystemService => ((IDistributedApplicationBuilder)this).FileSystemService;
+
+    /// <inheritdoc cref="IDistributedApplicationBuilder.UserSecretsManager" />
+    new IUserSecretsManager UserSecretsManager => ((IDistributedApplicationBuilder)this).UserSecretsManager;
+
     /// <inheritdoc cref="IDistributedApplicationBuilder.AddResource{T}(T)" />
     new IResourceBuilder<T> AddResource<T>(T resource) where T : IResource => ((IDistributedApplicationBuilder)this).AddResource(resource);
 

src/Aspire.Hosting/ApplicationModel/AspireStore.cs

@@ -1,6 +1,8 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+#pragma warning disable ASPIREFILESYSTEM001 // Type is for evaluation purposes only
+
 using System.IO.Hashing;
 using Aspire.Hosting.Utils;
 
@@ -11,22 +13,26 @@ internal sealed class AspireStore : IAspireStore
     internal const string AspireStorePathKeyName = "Aspire:Store:Path";
 
     private readonly string _basePath;
+    private readonly IFileSystemService _directoryService;
 
     /// <summary>
     /// Initializes a new instance of the <see cref="AspireStore"/> class with the specified base path.
     /// </summary>
     /// <param name="basePath">The base path for the store.</param>
+    /// <param name="directoryService">The directory service for creating temp directories.</param>
     /// <returns>A new instance of <see cref="AspireStore"/>.</returns>
-    public AspireStore(string basePath)
+    public AspireStore(string basePath, IFileSystemService directoryService)
     {
         ArgumentNullException.ThrowIfNull(basePath);
+        ArgumentNullException.ThrowIfNull(directoryService);
 
         if (!Path.IsPathRooted(basePath))
         {
             throw new ArgumentException($"An absolute path is required: '${basePath}'", nameof(basePath));
         }
 
         _basePath = basePath;
+        _directoryService = directoryService;
         EnsureDirectory();
     }
 
@@ -43,7 +49,7 @@ public string GetFileNameWithContent(string filenameTemplate, Stream contentStre
         filenameTemplate = Path.GetFileName(filenameTemplate);
 
         // Create a temporary file to write the content to.
-        var tempFileName = Path.GetTempFileName();
+        var tempFileName = _directoryService.TempDirectory.CreateTempFile().Path;
 
         // Fast, non-cryptographic hash.
         var hash = new XxHash3();

src/Aspire.Hosting/ApplicationModel/ProjectResource.cs

@@ -4,6 +4,7 @@
 #pragma warning disable ASPIREDOCKERFILEBUILDER001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
 #pragma warning disable ASPIRECONTAINERRUNTIME001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
 #pragma warning disable ASPIRECOMPUTE001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
+#pragma warning disable ASPIREFILESYSTEM001 // Type is for evaluation purposes only
 
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
@@ -137,9 +138,10 @@ private async Task BuildProjectImage(PipelineStepContext ctx)
         // Add COPY --from: statements for each source
         stage.AddContainerFiles(this, containerWorkingDir, logger);
 
-        // Write the Dockerfile to a temporary location
+        // Get the directory service to create temp Dockerfile
         var projectDir = Path.GetDirectoryName(projectMetadata.ProjectPath)!;
-        var tempDockerfilePath = Path.GetTempFileName();
+        var directoryService = ctx.Services.GetRequiredService<IFileSystemService>();
+        var tempDockerfilePath = directoryService.TempDirectory.CreateTempFile().Path;
 
         var builtSuccessfully = false;
         try

src/Aspire.Hosting/ApplicationModel/UserSecretsParameterDefault.cs

@@ -1,8 +1,9 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+#pragma warning disable ASPIREUSERSECRETS001
+
 using System.Diagnostics;
-using System.Reflection;
 using Aspire.Hosting.Publishing;
 using Aspire.Hosting.UserSecrets;
 
@@ -11,27 +12,20 @@ namespace Aspire.Hosting.ApplicationModel;
 /// <summary>
 /// Wraps a <see cref="ParameterDefault"/> such that the default value is saved to the project's user secrets store.
 /// </summary>
-/// <param name="appHostAssembly">The app host assembly.</param>
 /// <param name="applicationName">The application name.</param>
 /// <param name="parameterName">The parameter name.</param>
 /// <param name="parameterDefault">The <see cref="ParameterDefault"/> that will produce the default value when it isn't found in the project's user secrets store.</param>
-/// <param name="factory">The factory to use for creating user secrets managers.</param>
-internal sealed class UserSecretsParameterDefault(Assembly appHostAssembly, string applicationName, string parameterName, ParameterDefault parameterDefault, UserSecretsManagerFactory factory)
+/// <param name="userSecretsManager">The user secrets manager.</param>
+internal sealed class UserSecretsParameterDefault(string applicationName, string parameterName, ParameterDefault parameterDefault, IUserSecretsManager userSecretsManager)
     : ParameterDefault
 {
-    public UserSecretsParameterDefault(Assembly appHostAssembly, string applicationName, string parameterName, ParameterDefault parameterDefault)
-        : this(appHostAssembly, applicationName, parameterName, parameterDefault, UserSecretsManagerFactory.Instance)
-    {
-    }
-
     /// <inheritdoc/>
     public override string GetDefaultValue()
     {
         var value = parameterDefault.GetDefaultValue();
         var configurationKey = $"Parameters:{parameterName}";
-        
-        var manager = factory.GetOrCreate(appHostAssembly);
-        if (!manager.TrySetSecret(configurationKey, value))
+
+        if (!userSecretsManager.TrySetSecret(configurationKey, value))
         {
             // This is a best-effort operation, so we don't throw if it fails. Common reason for failure is that the user secrets ID is not set
             // in the application's assembly. Note there's no ILogger available this early in the application lifecycle.