Testing: Set child project launch profile name based on AppHost launch profiles. Propagate ContentRoot. (dotnet#4287)

Author: ReubenBond

src/Aspire.Hosting.Testing/Aspire.Hosting.Testing.csproj

@@ -10,6 +10,12 @@
     <Description>Testing support for the .NET Aspire application model.</Description>
   </PropertyGroup>
 
+  <ItemGroup>
+    <Compile Include="$(SharedDir)LaunchSettings.cs" Link="LaunchSettings.cs" />
+    <Compile Include="$(SharedDir)LaunchProfile.cs" Link="LaunchProfile.cs" />
+    <Compile Include="$(SharedDir)LaunchSettingsSerializerContext.cs" Link="LaunchSettingsSerializerContext.cs" />
+  </ItemGroup>
+
   <ItemGroup>
     <ProjectReference Include="..\Aspire.Hosting\Aspire.Hosting.csproj" />
   </ItemGroup>

src/Aspire.Hosting.Testing/DistributedApplicationFactory.cs

@@ -5,6 +5,8 @@
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
 using System.Diagnostics;
+using System.Reflection;
+using System.Text.Json;
 
 namespace Aspire.Hosting.Testing;
 
@@ -154,16 +156,66 @@ private void OnBuilderCreatingCore(DistributedApplicationOptions applicationOpti
         applicationOptions.AssemblyName = _entryPoint.Assembly.GetName().Name ?? string.Empty;
         applicationOptions.DisableDashboard = true;
         var cfg = hostBuilderOptions.Configuration ??= new();
-        cfg.AddInMemoryCollection(new Dictionary<string, string?>
+        var additionalConfig = new Dictionary<string, string?>
         {
             ["DcpPublisher:RandomizePorts"] = "true",
             ["DcpPublisher:DeleteResourcesOnShutdown"] = "true",
             ["DcpPublisher:ResourceNameSuffix"] = $"{Random.Shared.Next():x}",
-        });
+        };
+
+        var appHostProjectPath = ResolveProjectPath(_entryPoint.Assembly);
+        if (!string.IsNullOrEmpty(appHostProjectPath))
+        {
+            hostBuilderOptions.ContentRootPath = appHostProjectPath;
+        }
+
+        var appHostLaunchSettings = GetLaunchSettings(appHostProjectPath);
+        if (appHostLaunchSettings?.Profiles.FirstOrDefault().Key is { } profileName)
+        {
+            additionalConfig["AppHost:DefaultLaunchProfileName"] = profileName;
+        }
+
+        cfg.AddInMemoryCollection(additionalConfig);
 
         OnBuilderCreating(applicationOptions, hostBuilderOptions);
     }
 
+    private static string? ResolveProjectPath(Assembly? assembly)
+    {
+        var assemblyMetadata = assembly?.GetCustomAttributes<AssemblyMetadataAttribute>();
+        return GetMetadataValue(assemblyMetadata, "AppHostProjectPath");
+    }
+
+    private static string? GetMetadataValue(IEnumerable<AssemblyMetadataAttribute>? assemblyMetadata, string key)
+    {
+        return assemblyMetadata?.FirstOrDefault(m => string.Equals(m.Key, key, StringComparison.OrdinalIgnoreCase))?.Value;
+    }
+
+    private static LaunchSettings? GetLaunchSettings(string? appHostPath)
+    {
+        if (appHostPath is null || !Directory.Exists(appHostPath))
+        {
+            return null;
+        }
+
+        var projectFileInfo = new DirectoryInfo(appHostPath);
+        var launchSettingsFilePath = projectFileInfo.FullName switch
+        {
+            null => Path.Combine("Properties", "launchSettings.json"),
+            _ => Path.Combine(projectFileInfo.FullName, "Properties", "launchSettings.json")
+        };
+
+        // It isn't mandatory that the launchSettings.json file exists!
+        if (!File.Exists(launchSettingsFilePath))
+        {
+            return null;
+        }
+
+        using var stream = File.OpenRead(launchSettingsFilePath);
+        var settings = JsonSerializer.Deserialize(stream, LaunchSettingsSerializerContext.Default.LaunchSettings);
+        return settings;
+    }
+
     private void OnBuilderCreatedCore(DistributedApplicationBuilder applicationBuilder)
     {
         OnBuilderCreated(applicationBuilder);
@@ -324,10 +376,10 @@ public virtual async ValueTask DisposeAsync()
             return;
         }
 
-        if (_hostApplicationLifetime is { } hostLifetime && hostLifetime.ApplicationStarted.IsCancellationRequested)
-        {
-            hostLifetime.StopApplication();
-        }
+        // If the application has started, or when it starts, stop it.
+        using var applicationStartedRegistration = _hostApplicationLifetime?.ApplicationStarted.Register(
+            static state => (state as IHostApplicationLifetime)?.StopApplication(),
+            _hostApplicationLifetime);
 
         await _exitTcs.Task.ConfigureAwait(false);
 

src/Aspire.Hosting/ApplicationModel/DefaultLaunchProfileAnnotation.cs

@@ -0,0 +1,19 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.Diagnostics;
+
+namespace Aspire.Hosting.ApplicationModel;
+
+[DebuggerDisplay("Type = {GetType().Name,nq}, LaunchProfileName = {LaunchProfileName}")]
+internal sealed class DefaultLaunchProfileAnnotation : IResourceAnnotation
+{
+    public DefaultLaunchProfileAnnotation(string launchProfileName)
+    {
+        ArgumentNullException.ThrowIfNull(launchProfileName);
+
+        LaunchProfileName = launchProfileName;
+    }
+
+    public string LaunchProfileName { get; }
+}

src/Aspire.Hosting/Aspire.Hosting.csproj

@@ -29,6 +29,9 @@
     <Compile Include="$(SharedDir)LoggingHelpers.cs" Link="Utils\LoggingHelpers.cs" />
     <Compile Include="$(SharedDir)StringUtils.cs" Link="Utils\StringUtils.cs" />
     <Compile Include="$(SharedDir)SchemaUtils.cs" Link="Utils\SchemaUtils.cs" />
+    <Compile Include="$(SharedDir)LaunchSettings.cs" Link="LaunchSettings.cs" />
+    <Compile Include="$(SharedDir)LaunchProfile.cs" Link="LaunchProfile.cs" />
+    <Compile Include="$(SharedDir)LaunchSettingsSerializerContext.cs" Link="LaunchSettingsSerializerContext.cs" />
   </ItemGroup>
 
   <ItemGroup>

src/Aspire.Hosting/Dcp/ApplicationExecutor.cs

@@ -687,7 +687,7 @@ appModelResource is IResourceWithEndpoints resourceWithEndpoints &&
 
                 if (ep.EndpointAnnotation.FromLaunchProfile &&
                     appModelResource is ProjectResource p &&
-                    p.GetEffectiveLaunchProfile() is LaunchProfile profile &&
+                    p.GetEffectiveLaunchProfile()?.LaunchProfile is LaunchProfile profile &&
                     profile.LaunchUrl is string launchUrl)
                 {
                     // Concat the launch url from the launch profile to the urls with IsFromLaunchProfile set to true
@@ -1078,7 +1078,7 @@ private void PrepareProjectExecutables()
                 // and the environment variables/application URLs inside CreateExecutableAsync().
                 exeSpec.Args.Add("--no-launch-profile");
 
-                var launchProfile = project.GetEffectiveLaunchProfile();
+                var launchProfile = project.GetEffectiveLaunchProfile()?.LaunchProfile;
                 if (launchProfile is not null && !string.IsNullOrWhiteSpace(launchProfile.CommandLineArgs))
                 {
                     var cmdArgs = CommandLineArgsParser.Parse(launchProfile.CommandLineArgs);

src/Aspire.Hosting/LaunchProfileExtensions.cs

@@ -4,7 +4,6 @@
 using System.Diagnostics.CodeAnalysis;
 using System.Globalization;
 using System.Text.Json;
-using System.Text.Json.Serialization;
 using Aspire.Hosting.ApplicationModel;
 using Aspire.Hosting.Properties;
 
@@ -29,7 +28,7 @@ internal static class LaunchProfileExtensions
         return projectMetadata.GetLaunchSettings();
     }
 
-    internal static LaunchProfile? GetEffectiveLaunchProfile(this ProjectResource projectResource, bool throwIfNotFound = false)
+    internal static NamedLaunchProfile? GetEffectiveLaunchProfile(this ProjectResource projectResource, bool throwIfNotFound = false)
     {
         string? launchProfileName = projectResource.SelectLaunchProfileName();
         if (string.IsNullOrEmpty(launchProfileName))
@@ -49,7 +48,8 @@ internal static class LaunchProfileExtensions
             var message = string.Format(CultureInfo.InvariantCulture, Resources.LaunchSettingsFileDoesNotContainProfileExceptionMessage, launchProfileName);
             throw new DistributedApplicationException(message);
         }
-        return found == true ? launchProfile : null;
+
+        return launchProfile is not null ? new (launchProfileName, launchProfile) : default;
     }
 
     private static LaunchSettings? GetLaunchSettings(this IProjectMetadata projectMetadata)
@@ -87,7 +87,7 @@ internal static class LaunchProfileExtensions
     private static readonly LaunchProfileSelector[] s_launchProfileSelectors =
     [
         TrySelectLaunchProfileFromAnnotation,
-        TrySelectLaunchProfileFromEnvironment,
+        TrySelectLaunchProfileFromDefaultAnnotation,
         TrySelectLaunchProfileByOrder
     ];
 
@@ -105,31 +105,30 @@ private static bool TrySelectLaunchProfileByOrder(ProjectResource projectResourc
         return true;
     }
 
-    private static bool TrySelectLaunchProfileFromEnvironment(ProjectResource projectResource, [NotNullWhen(true)] out string? launchProfileName)
+    private static bool TrySelectLaunchProfileFromDefaultAnnotation(ProjectResource projectResource, [NotNullWhen(true)] out string? launchProfileName)
     {
-        var launchProfileEnvironmentVariable = Environment.GetEnvironmentVariable("DOTNET_LAUNCH_PROFILE");
-
-        if (launchProfileEnvironmentVariable is null)
+        if (!projectResource.TryGetLastAnnotation<DefaultLaunchProfileAnnotation>(out var launchProfileAnnotation))
         {
             launchProfileName = null;
             return false;
         }
 
+        var appHostDefaultLaunchProfileName = launchProfileAnnotation.LaunchProfileName;
         var launchSettings = GetLaunchSettings(projectResource);
         if (launchSettings == null)
         {
             launchProfileName = null;
             return false;
         }
 
-        if (!launchSettings.Profiles.TryGetValue(launchProfileEnvironmentVariable, out var launchProfile))
+        if (!launchSettings.Profiles.TryGetValue(appHostDefaultLaunchProfileName, out var launchProfile) || launchProfile is null)
         {
             launchProfileName = null;
             return false;
         }
 
-        launchProfileName = launchProfileEnvironmentVariable;
-        return launchProfile != null;
+        launchProfileName = appHostDefaultLaunchProfileName;
+        return true;
     }
 
     private static bool TrySelectLaunchProfileFromAnnotation(ProjectResource projectResource, [NotNullWhen(true)] out string? launchProfileName)
@@ -166,11 +165,6 @@ private static bool TrySelectLaunchProfileFromAnnotation(ProjectResource project
     }
 }
 
-internal delegate bool LaunchProfileSelector(ProjectResource project, out string? launchProfile);
-
-[JsonSerializable(typeof(LaunchSettings))]
-[JsonSourceGenerationOptions(ReadCommentHandling = JsonCommentHandling.Skip)]
-internal sealed partial class LaunchSettingsSerializerContext : JsonSerializerContext
-{
+internal sealed record class NamedLaunchProfile(string Name, LaunchProfile LaunchProfile);
 
-}
+internal delegate bool LaunchProfileSelector(ProjectResource project, out string? launchProfile);

src/Aspire.Hosting/ProjectResourceBuilderExtensions.cs

@@ -220,10 +220,22 @@ private static IResourceBuilder<ProjectResource> WithProjectDefaults(this IResou
         {
             builder.WithAnnotation(new LaunchProfileAnnotation(launchProfileName));
         }
+        else
+        {
+            var appHostDefaultLaunchProfileName = builder.ApplicationBuilder.Configuration["AppHost:DefaultLaunchProfileName"]
+                ?? Environment.GetEnvironmentVariable("DOTNET_LAUNCH_PROFILE");
+            if (!string.IsNullOrEmpty(appHostDefaultLaunchProfileName))
+            {
+                builder.WithAnnotation(new DefaultLaunchProfileAnnotation(appHostDefaultLaunchProfileName));
+            }
+        }
+
+        var effectiveLaunchProfile = excludeLaunchProfile ? null : projectResource.GetEffectiveLaunchProfile(throwIfNotFound: true);
+        var launchProfile = effectiveLaunchProfile?.LaunchProfile;
 
+        // Process the launch profile and turn it into environment variables and endpoints.
         var config = GetConfiguration(projectResource);
         var kestrelEndpoints = config.GetSection("Kestrel:Endpoints").GetChildren();
-        var launchProfile = excludeLaunchProfile ? null : projectResource.GetEffectiveLaunchProfile(throwIfNotFound: true);
 
         // Get all the Kestrel configuration endpoint bindings, grouped by scheme
         var kestrelEndpointsByScheme = kestrelEndpoints
@@ -296,7 +308,10 @@ private static IResourceBuilder<ProjectResource> WithProjectDefaults(this IResou
             builder.WithEnvironment(context =>
             {
                 // Populate DOTNET_LAUNCH_PROFILE environment variable for consistency with "dotnet run" and "dotnet watch".
-                context.EnvironmentVariables.TryAdd("DOTNET_LAUNCH_PROFILE", launchProfileName!);
+                if (effectiveLaunchProfile is not null)
+                {
+                    context.EnvironmentVariables.TryAdd("DOTNET_LAUNCH_PROFILE", effectiveLaunchProfile.Name);
+                }
 
                 foreach (var envVar in launchProfile.EnvironmentVariables)
                 {

src/Aspire.Hosting/LaunchProfile.cs src/Shared/LaunchProfile.cs

@@ -0,0 +1,14 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.Text.Json;
+using System.Text.Json.Serialization;
+
+namespace Aspire.Hosting;
+
+[JsonSerializable(typeof(LaunchSettings))]
+[JsonSourceGenerationOptions(ReadCommentHandling = JsonCommentHandling.Skip)]
+internal sealed partial class LaunchSettingsSerializerContext : JsonSerializerContext
+{
+
+}

src/Aspire.Hosting/LaunchSettings.cs src/Shared/LaunchSettings.cs

@@ -9,17 +9,15 @@ namespace Aspire.Hosting.Testing.Tests;
 
 public class DistributedApplicationFixture<TEntryPoint> : DistributedApplicationFactory, IAsyncLifetime where TEntryPoint : class
 {
-    public DistributedApplicationFixture(string[] args)
-        : base(typeof(TEntryPoint), args)
+    public DistributedApplicationFixture()
+        : base(typeof(TEntryPoint), [])
     {
         if (Environment.GetEnvironmentVariable("BUILD_BUILDID") != null)
         {
             throw new SkipException("These tests can only run in local environments.");
         }
     }
 
-    public DistributedApplicationFixture() : this([]) { }
-
     protected override void OnBuilderCreating(DistributedApplicationOptions applicationOptions, HostApplicationBuilderSettings hostOptions)
     {
         base.OnBuilderCreating(applicationOptions, hostOptions);

src/Shared/LaunchSettingsSerializerContext.cs

@@ -3,7 +3,9 @@
 
 using System.Net.Http.Json;
 using Aspire.Hosting.Tests.Helpers;
+using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Hosting;
 using Xunit;
 
 namespace Aspire.Hosting.Testing.Tests;
@@ -78,6 +80,41 @@ public async Task GetHttpClientBeforeStart(bool genericEntryPoint)
         Assert.Throws<InvalidOperationException>(() => app.CreateHttpClient("mywebapp1"));
     }
 
+    [LocalOnlyTheory]
+    [InlineData(false)]
+    [InlineData(true)]
+    public async Task SetsCorrectContentRoot(bool genericEntryPoint)
+    {
+        var appHost = await (genericEntryPoint
+            ? DistributedApplicationTestingBuilder.CreateAsync<Projects.TestingAppHost1_AppHost>()
+            : DistributedApplicationTestingBuilder.CreateAsync(typeof(Projects.TestingAppHost1_AppHost)));
+        await using var app = await appHost.BuildAsync();
+        await app.StartAsync();
+        var hostEnvironment = app.Services.GetRequiredService<IHostEnvironment>();
+        Assert.Contains("TestingAppHost1", hostEnvironment.ContentRootPath);
+    }
+
+    [LocalOnlyTheory]
+    [InlineData(false)]
+    [InlineData(true)]
+    public async Task SelectsFirstLaunchProfile(bool genericEntryPoint)
+    {
+        var appHost = await (genericEntryPoint
+            ? DistributedApplicationTestingBuilder.CreateAsync<Projects.TestingAppHost1_AppHost>()
+            : DistributedApplicationTestingBuilder.CreateAsync(typeof(Projects.TestingAppHost1_AppHost)));
+        await using var app = await appHost.BuildAsync();
+        await app.StartAsync();
+        var config = app.Services.GetRequiredService<IConfiguration>();
+        var profileName = config["AppHost:DefaultLaunchProfileName"];
+        Assert.Equal("https", profileName);
+
+        // Explicitly get the HTTPS endpoint - this is only available on the "https" launch profile.
+        var httpClient = app.CreateHttpClient("mywebapp1", "https");
+        var result = await httpClient.GetFromJsonAsync<WeatherForecast[]>("/weatherforecast");
+        Assert.NotNull(result);
+        Assert.True(result.Length > 0);
+    }
+
     // Tests that DistributedApplicationTestingBuilder throws exceptions at the right times when the app crashes.
     [LocalOnlyTheory]
     [InlineData(true, "before-build")]