Allow multiple compute environment resources in an app model (#8820)

eerhardt · web-flow · commit bd6da41ffdda · 2025-04-16T17:09:57.000-07:00
* Allow multiple compute environment resources in an app model Contributes to #8786 * Add tests * Add IComputeResource and implement it on Project, Container, and Executable. * Tweak tests * PR feedback
diff --git a/src/Aspire.Hosting.Azure.AppContainers/AzureContainerAppEnvironmentResource.cs b/src/Aspire.Hosting.Azure.AppContainers/AzureContainerAppEnvironmentResource.cs
@@ -12,7 +12,7 @@ namespace Aspire.Hosting.Azure.AppContainers;
 /// <param name="configureInfrastructure">The callback to configure the Azure infrastructure for this resource.</param>
 public class AzureContainerAppEnvironmentResource(string name, Action<AzureResourceInfrastructure> configureInfrastructure) :
 #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.
-    AzureProvisioningResource(name, configureInfrastructure), IAzureContainerAppEnvironment, IAzureContainerRegistry
+    AzureProvisioningResource(name, configureInfrastructure), IComputeEnvironmentResource, IAzureContainerAppEnvironment, IAzureContainerRegistry
 #pragma warning restore ASPIRECOMPUTE001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
 {
     internal bool UseAzdNamingConvention { get; set; }
diff --git a/src/Aspire.Hosting.Azure.AppContainers/AzureContainerAppsInfrastructure.cs b/src/Aspire.Hosting.Azure.AppContainers/AzureContainerAppsInfrastructure.cs
@@ -68,7 +68,8 @@ public async Task BeforeStartAsync(DistributedApplicationModel appModel, Cancell
 #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.
             r.Annotations.Add(new DeploymentTargetAnnotation(containerApp)
             {
-                ContainerRegistryInfo = caes.FirstOrDefault()
+                ContainerRegistryInfo = caes.FirstOrDefault(),
+                ComputeEnvironment = environment as IComputeEnvironmentResource // will be null if azd
             });
 #pragma warning restore ASPIRECOMPUTE001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
         }
diff --git a/src/Aspire.Hosting.Azure/AzurePublishingContext.cs b/src/Aspire.Hosting.Azure/AzurePublishingContext.cs
@@ -219,8 +219,7 @@ static BicepValue<string> ResolveValue(object val)
 
         foreach (var resource in model.Resources)
         {
-            if (resource.TryGetLastAnnotation<DeploymentTargetAnnotation>(out var targetAnnotation) &&
-                targetAnnotation.DeploymentTarget is AzureBicepResource br)
+            if (resource.GetDeploymentTargetAnnotation()?.DeploymentTarget is AzureBicepResource br)
             {
                 var moduleDirectory = outputDirectory.CreateSubdirectory(resource.Name);
 
diff --git a/src/Aspire.Hosting/ApplicationModel/ComputeEnvironmentAnnotation.cs b/src/Aspire.Hosting/ApplicationModel/ComputeEnvironmentAnnotation.cs
@@ -0,0 +1,12 @@
+// 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.CodeAnalysis;
+
+namespace Aspire.Hosting.ApplicationModel;
+
+[Experimental("ASPIRECOMPUTE001")]
+internal sealed class ComputeEnvironmentAnnotation(IComputeEnvironmentResource computeEnvironment) : IResourceAnnotation
+{
+    public IComputeEnvironmentResource ComputeEnvironment { get; } = computeEnvironment;
+}
diff --git a/src/Aspire.Hosting/ApplicationModel/ContainerResource.cs b/src/Aspire.Hosting/ApplicationModel/ContainerResource.cs
@@ -8,7 +8,11 @@ namespace Aspire.Hosting.ApplicationModel;
 /// </summary>
 /// <param name="name">The name of the resource.</param>
 /// <param name="entrypoint">An optional container entrypoint.</param>
-public class ContainerResource(string name, string? entrypoint = null) : Resource(name), IResourceWithEnvironment, IResourceWithArgs, IResourceWithEndpoints, IResourceWithWaitSupport
+public class ContainerResource(string name, string? entrypoint = null)
+    : Resource(name), IResourceWithEnvironment, IResourceWithArgs, IResourceWithEndpoints, IResourceWithWaitSupport,
+#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.
+    IComputeResource
+#pragma warning restore ASPIRECOMPUTE001
 {
     /// <summary>
     /// The container Entrypoint.
diff --git a/src/Aspire.Hosting/ApplicationModel/DeploymentTargetAnnotation.cs b/src/Aspire.Hosting/ApplicationModel/DeploymentTargetAnnotation.cs
@@ -21,4 +21,10 @@ public sealed class DeploymentTargetAnnotation(IResource target) : IResourceAnno
     /// </summary>
     [Experimental("ASPIRECOMPUTE001")]
     public IContainerRegistry? ContainerRegistryInfo { get; set; }
+
+    /// <summary>
+    /// Gets or sets the compute environment resource associated with the deployment target.
+    /// </summary>
+    [Experimental("ASPIRECOMPUTE001")]
+    public IComputeEnvironmentResource? ComputeEnvironment { get; set; }
 }
diff --git a/src/Aspire.Hosting/ApplicationModel/ExecutableResource.cs b/src/Aspire.Hosting/ApplicationModel/ExecutableResource.cs
@@ -13,7 +13,10 @@ namespace Aspire.Hosting.ApplicationModel;
 /// <param name="command">The command to execute.</param>
 /// <param name="workingDirectory">The working directory of the executable.</param>
 public class ExecutableResource(string name, string command, string workingDirectory)
-    : Resource(name), IResourceWithEnvironment, IResourceWithArgs, IResourceWithEndpoints, IResourceWithWaitSupport
+    : Resource(name), IResourceWithEnvironment, IResourceWithArgs, IResourceWithEndpoints, IResourceWithWaitSupport,
+#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.
+    IComputeResource
+#pragma warning restore ASPIRECOMPUTE001
 {
     /// <summary>
     /// Gets the command associated with this executable resource.
diff --git a/src/Aspire.Hosting/ApplicationModel/IComputeEnvironmentResource.cs b/src/Aspire.Hosting/ApplicationModel/IComputeEnvironmentResource.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.Diagnostics.CodeAnalysis;
+
+namespace Aspire.Hosting.ApplicationModel;
+
+/// <summary>
+/// Represents a compute environment resource.
+/// </summary>
+[Experimental("ASPIRECOMPUTE001")]
+public interface IComputeEnvironmentResource : IResource
+{
+}
diff --git a/src/Aspire.Hosting/ApplicationModel/IComputeResource.cs b/src/Aspire.Hosting/ApplicationModel/IComputeResource.cs
@@ -0,0 +1,18 @@
+// 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.CodeAnalysis;
+
+namespace Aspire.Hosting.ApplicationModel;
+
+/// <summary>
+/// Represents a compute resource.
+/// </summary>
+/// <remarks>
+/// A compute resource is a resource that can be hosted/executed on an <see cref="IComputeEnvironmentResource"/>. Examples
+/// include projects, containers, and other resources that can be executed on a compute environment.
+/// </remarks>
+[Experimental("ASPIRECOMPUTE001")]
+public interface IComputeResource : IResource
+{
+}
diff --git a/src/Aspire.Hosting/ApplicationModel/ProjectResource.cs b/src/Aspire.Hosting/ApplicationModel/ProjectResource.cs
@@ -7,7 +7,11 @@ namespace Aspire.Hosting.ApplicationModel;
 /// A resource that represents a specified .NET project.
 /// </summary>
 /// <param name="name">The name of the resource.</param>
-public class ProjectResource(string name) : Resource(name), IResourceWithEnvironment, IResourceWithArgs, IResourceWithServiceDiscovery, IResourceWithWaitSupport
+public class ProjectResource(string name)
+    : Resource(name), IResourceWithEnvironment, IResourceWithArgs, IResourceWithServiceDiscovery, IResourceWithWaitSupport,
+#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.
+    IComputeResource
+#pragma warning restore ASPIRECOMPUTE001
 {
     // Keep track of the config host for each Kestrel endpoint annotation
     internal Dictionary<EndpointAnnotation, string> KestrelEndpointAnnotationHosts { get; } = new();
diff --git a/src/Aspire.Hosting/ApplicationModel/ResourceExtensions.cs b/src/Aspire.Hosting/ApplicationModel/ResourceExtensions.cs
@@ -571,6 +571,42 @@ public static int GetReplicaCount(this IResource resource)
         }
     }
 
+    /// <summary>
+    /// Gets the deployment target for the specified resource, if any. Throws an exception if
+    /// there are multiple compute environments and a compute environment is not explicitly specified.
+    /// </summary>
+    public static DeploymentTargetAnnotation? GetDeploymentTargetAnnotation(this IResource resource)
+    {
+#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.
+        if (resource.TryGetLastAnnotation<ComputeEnvironmentAnnotation>(out var computeEnvironmentAnnotation))
+        {
+            // find the deployment target for the compute environment
+            return resource.Annotations
+                .OfType<DeploymentTargetAnnotation>()
+                .LastOrDefault(a => a.ComputeEnvironment == computeEnvironmentAnnotation.ComputeEnvironment);
+        }
+        else
+        {
+            DeploymentTargetAnnotation? result = null;
+            var computeEnvironments = resource.Annotations.OfType<DeploymentTargetAnnotation>();
+            foreach (var annotation in computeEnvironments)
+            {
+                if (result is null)
+                {
+                    result = annotation;
+                }
+                else
+                {
+                    var computeEnvironmentNames = string.Join(", ", computeEnvironments.Select(a => a.ComputeEnvironment?.Name));
+                    throw new InvalidOperationException($"Resource '{resource.Name}' has multiple compute environments - '{computeEnvironmentNames}'. Please specify a single compute environment using 'WithComputeEnvironment'.");
+                }
+            }
+
+            return result;
+        }
+#pragma warning restore ASPIRECOMPUTE001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
+    }
+
     /// <summary>
     /// Gets the lifetime type of the container for the specified resource.
     /// Defaults to <see cref="ContainerLifetime.Session"/> if no <see cref="ContainerLifetimeAnnotation"/> is found.
diff --git a/src/Aspire.Hosting/Publishing/ManifestPublishingContext.cs b/src/Aspire.Hosting/Publishing/ManifestPublishingContext.cs
@@ -155,7 +155,8 @@ private async Task WriteProjectAsync(ProjectResource project)
 
         var relativePathToProjectFile = GetManifestRelativePath(metadata.ProjectPath);
 
-        if (project.TryGetLastAnnotation<DeploymentTargetAnnotation>(out var deploymentTarget))
+        var deploymentTarget = project.GetDeploymentTargetAnnotation();
+        if (deploymentTarget is not null)
         {
             Writer.WriteString("type", "project.v1");
         }
@@ -250,7 +251,7 @@ internal Task WriteParameterAsync(ParameterResource parameter)
     /// <exception cref="DistributedApplicationException">Thrown if the container resource does not contain a <see cref="ContainerImageAnnotation"/>.</exception>
     public async Task WriteContainerAsync(ContainerResource container)
     {
-        container.TryGetLastAnnotation<DeploymentTargetAnnotation>(out var deploymentTarget);
+        var deploymentTarget = container.GetDeploymentTargetAnnotation();
 
         if (container.Annotations.OfType<DockerfileBuildAnnotation>().Any())
         {
diff --git a/src/Aspire.Hosting/ResourceBuilderExtensions.cs b/src/Aspire.Hosting/ResourceBuilderExtensions.cs
@@ -1,6 +1,7 @@
 // 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.CodeAnalysis;
 using System.Net.Sockets;
 using Aspire.Dashboard.Model;
 using Aspire.Hosting.ApplicationModel;
@@ -1933,4 +1934,24 @@ public static IResourceBuilder<T> WithParentRelationship<T>(
     {
         return builder.WithRelationship(parent, KnownRelationshipTypes.Parent);
     }
+
+    /// <summary>
+    /// Configures the compute environment for the compute resource.
+    /// </summary>
+    /// <param name="builder">The compute resource builder.</param>
+    /// <param name="computeEnvironmentResource">The compute environment resource to associate with the compute resource.</param>
+    /// <returns>A reference to the <see cref="IResourceBuilder{T}"/>.</returns>
+    /// <remarks>
+    /// This method allows associating a specific compute environment with the compute resource.
+    /// </remarks>
+    [Experimental("ASPIRECOMPUTE001")]
+    public static IResourceBuilder<T> WithComputeEnvironment<T>(this IResourceBuilder<T> builder, IResourceBuilder<IComputeEnvironmentResource> computeEnvironmentResource)
+        where T : IComputeResource
+    {
+        ArgumentNullException.ThrowIfNull(builder);
+        ArgumentNullException.ThrowIfNull(computeEnvironmentResource);
+
+        builder.WithAnnotation(new ComputeEnvironmentAnnotation(computeEnvironmentResource.Resource));
+        return builder;
+    }
 }
diff --git a/tests/Aspire.Hosting.Azure.Tests/AzureContainerAppsTests.cs b/tests/Aspire.Hosting.Azure.Tests/AzureContainerAppsTests.cs
@@ -2,6 +2,7 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 #pragma warning disable ASPIREACADOMAINS001 // 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.
 
 using System.Text.Json.Nodes;
 using Aspire.Hosting.ApplicationModel;
@@ -201,11 +202,11 @@ param api_containerimage string
     }
 
     [Fact]
-    public async Task AddContainerAppsInfrastructureAddsDeploymentTargetWithContainerAppToProjectResources()
+    public async Task AddContainerAppEnvironmentAddsDeploymentTargetWithContainerAppToProjectResources()
     {
         var builder = TestDistributedApplicationBuilder.Create(DistributedApplicationOperation.Publish);
 
-        builder.AddAzureContainerAppEnvironment("env");
+        var env = builder.AddAzureContainerAppEnvironment("env");
 
         builder.AddProject<Project>("api", launchProfileName: null)
             .WithHttpEndpoint();
@@ -218,10 +219,11 @@ public async Task AddContainerAppsInfrastructureAddsDeploymentTargetWithContaine
 
         var container = Assert.Single(model.GetProjectResources());
 
-        container.TryGetLastAnnotation<DeploymentTargetAnnotation>(out var target);
+        var target = container.GetDeploymentTargetAnnotation();
 
-        var resource = target?.DeploymentTarget as AzureProvisioningResource;
+        Assert.Same(env.Resource, target?.ComputeEnvironment);
 
+        var resource = target?.DeploymentTarget as AzureProvisioningResource;
         Assert.NotNull(resource);
 
         var (manifest, bicep) = await GetManifestWithBicep(resource);
@@ -333,7 +335,7 @@ public async Task AddExecutableResourceWithPublishAsDockerFileWithAppsInfrastruc
     {
         var builder = TestDistributedApplicationBuilder.Create(DistributedApplicationOperation.Publish);
 
-        builder.AddAzureContainerAppEnvironment("infra");
+        var infra = builder.AddAzureContainerAppEnvironment("infra");
 
         var env = builder.AddParameter("env");
 
@@ -356,10 +358,11 @@ public async Task AddExecutableResourceWithPublishAsDockerFileWithAppsInfrastruc
 
         var container = Assert.Single(model.GetContainerResources());
 
-        container.TryGetLastAnnotation<DeploymentTargetAnnotation>(out var target);
+        var target = container.GetDeploymentTargetAnnotation();
 
-        var resource = target?.DeploymentTarget as AzureProvisioningResource;
+        Assert.Same(infra.Resource, target?.ComputeEnvironment);
 
+        var resource = target?.DeploymentTarget as AzureProvisioningResource;
         Assert.NotNull(resource);
 
         var (manifest, bicep) = await GetManifestWithBicep(resource);
@@ -450,7 +453,7 @@ public async Task CanTweakContainerAppEnvironmentUsingPublishAsContainerAppOnExe
     {
         var builder = TestDistributedApplicationBuilder.Create(DistributedApplicationOperation.Publish);
 
-        builder.AddAzureContainerAppEnvironment("env");
+        var env = builder.AddAzureContainerAppEnvironment("env");
 
         builder.AddExecutable("api", "node.exe", Environment.CurrentDirectory)
                .PublishAsDockerFile();
@@ -463,10 +466,11 @@ public async Task CanTweakContainerAppEnvironmentUsingPublishAsContainerAppOnExe
 
         var container = Assert.Single(model.GetContainerResources());
 
-        container.TryGetLastAnnotation<DeploymentTargetAnnotation>(out var target);
+        var target = container.GetDeploymentTargetAnnotation();
 
-        var resource = target?.DeploymentTarget as AzureProvisioningResource;
+        Assert.Same(env.Resource, target?.ComputeEnvironment);
 
+        var resource = target?.DeploymentTarget as AzureProvisioningResource;
         Assert.NotNull(resource);
 
         var (manifest, bicep) = await GetManifestWithBicep(resource);
diff --git a/tests/Aspire.Hosting.Tests/ResourceExtensionsTests.cs b/tests/Aspire.Hosting.Tests/ResourceExtensionsTests.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 ASPIRECOMPUTE001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
+
 using Aspire.Hosting.Utils;
 using Microsoft.AspNetCore.InternalTesting;
 using Xunit;
@@ -290,6 +292,37 @@ public async Task GetArgumentValuesAsync_ReturnsCorrectValuesForSpecialCases()
         Assert.Equal<IEnumerable<string>>(["ConnectionString", "SecretParameter", "NonSecretParameter"], executableArgs);
     }
 
+    [Fact]
+    public void GetDeploymentTargetAnnotationWorks()
+    {
+        var builder = DistributedApplication.CreateBuilder();
+
+        var compute1 = builder.AddResource(new ComputeEnvironmentResource("compute1"));
+        var compute2 = builder.AddResource(new ComputeEnvironmentResource("compute2"));
+
+        void RunTest<T>(IResourceBuilder<T> resourceBuilder) where T : IComputeResource
+        {
+            resourceBuilder
+                .WithAnnotation(new DeploymentTargetAnnotation(compute1.Resource) { ComputeEnvironment = compute1.Resource })
+                .WithAnnotation(new DeploymentTargetAnnotation(compute2.Resource) { ComputeEnvironment = compute2.Resource });
+
+            var ex = Assert.Throws<InvalidOperationException>(resourceBuilder.Resource.GetDeploymentTargetAnnotation);
+            Assert.Contains("'compute1, compute2'", ex.Message);
+
+            resourceBuilder.WithComputeEnvironment(compute2);
+
+            Assert.Equal(compute2.Resource, resourceBuilder.Resource.GetDeploymentTargetAnnotation()!.ComputeEnvironment);
+        }
+
+        RunTest(builder.AddContainer("myContainer", "nginx"));
+        RunTest(builder.AddProject<Projects.ServiceA>("ServiceA"));
+        RunTest(builder.AddExecutable("myExecutable", "nginx", string.Empty));
+    }
+
+    private sealed class ComputeEnvironmentResource(string name) : Resource(name), IComputeEnvironmentResource
+    {
+    }
+
     private sealed class ParentResource(string name) : Resource(name)
     {
 

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ namespace Aspire.Hosting.Azure.AppContainers;`
`12`	`12`	`/// <param name="configureInfrastructure">The callback to configure the Azure infrastructure for this resource.</param>`
`13`	`13`	`public class AzureContainerAppEnvironmentResource(string name, Action<AzureResourceInfrastructure> configureInfrastructure) :`
`14`	`14`	`#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.`
`15`		`- AzureProvisioningResource(name, configureInfrastructure), IAzureContainerAppEnvironment, IAzureContainerRegistry`
	`15`	`+ AzureProvisioningResource(name, configureInfrastructure), IComputeEnvironmentResource, IAzureContainerAppEnvironment, IAzureContainerRegistry`
`16`	`16`	`#pragma warning restore ASPIRECOMPUTE001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.`
`17`	`17`	`{`
`18`	`18`	`internal bool UseAzdNamingConvention { get; set; }`
Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,8 @@ public async Task BeforeStartAsync(DistributedApplicationModel appModel, Cancell`
`68`	`68`	`#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.`
`69`	`69`	`r.Annotations.Add(new DeploymentTargetAnnotation(containerApp)`
`70`	`70`	`{`
`71`		`- ContainerRegistryInfo = caes.FirstOrDefault()`
	`71`	`+ ContainerRegistryInfo = caes.FirstOrDefault(),`
	`72`	`+ ComputeEnvironment = environment as IComputeEnvironmentResource // will be null if azd`
`72`	`73`	`});`
`73`	`74`	`#pragma warning restore ASPIRECOMPUTE001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.`
`74`	`75`	`}`
Original file line number	Diff line number	Diff line change
`@@ -219,8 +219,7 @@ static BicepValue<string> ResolveValue(object val)`
`219`	`219`
`220`	`220`	`foreach (var resource in model.Resources)`
`221`	`221`	`{`
`222`		`- if (resource.TryGetLastAnnotation<DeploymentTargetAnnotation>(out var targetAnnotation) &&`
`223`		`- targetAnnotation.DeploymentTarget is AzureBicepResource br)`
	`222`	`+ if (resource.GetDeploymentTargetAnnotation()?.DeploymentTarget is AzureBicepResource br)`
`224`	`223`	`{`
`225`	`224`	`var moduleDirectory = outputDirectory.CreateSubdirectory(resource.Name);`
`226`	`225`