Follow-ups to Docker Compose as compute environment resource (#8834)

* Follow-ups to Docker Compose as compute environment resource

* Throw if DockerComposeEnvironmentResource not found

Author: captainsafia

playground/publishers/Publishers.AppHost/Program.cs

@@ -7,7 +7,7 @@
 
 builder.AddAzureContainerAppEnvironment("env");
 
-builder.AddDockerComposePublisher();
+builder.AddDockerComposeEnvironment("docker-env");
 
 builder.AddKubernetesPublisher();
 

src/Aspire.Hosting.Docker/DockerComposeEnvironmentExtensions.cs

@@ -28,6 +28,14 @@ public static IResourceBuilder<DockerComposeEnvironmentResource> AddDockerCompos
         var resource = new DockerComposeEnvironmentResource(name);
         builder.Services.TryAddLifecycleHook<DockerComposeInfrastructure>();
         builder.AddDockerComposePublisher(name);
+        if (builder.ExecutionContext.IsRunMode)
+        {
+
+            // Return a builder that isn't added to the top-level application builder
+            // so it doesn't surface as a resource.
+            return builder.CreateResourceBuilder(resource);
+
+        }
         return builder.AddResource(resource);
     }
 }

src/Aspire.Hosting.Docker/DockerComposeEnvironmentResource.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.ApplicationModel;
 
 namespace Aspire.Hosting.Docker;
@@ -12,7 +14,7 @@ namespace Aspire.Hosting.Docker;
 /// Initializes a new instance of the <see cref="DockerComposeEnvironmentResource"/> class.
 /// </remarks>
 /// <param name="name">The name of the Docker Compose environment.</param>
-public class DockerComposeEnvironmentResource(string name) : Resource(name)
+public class DockerComposeEnvironmentResource(string name) : Resource(name), IComputeEnvironmentResource
 {
     /// <summary>
     /// Gets the collection of environment variables captured from the Docker Compose environment.

src/Aspire.Hosting.Docker/DockerComposePublishingContext.cs

@@ -68,7 +68,7 @@ private async Task WriteDockerComposeOutputAsync(DistributedApplicationModel mod
         if (environment == null)
         {
             // No Docker Compose environment found
-            return;
+            throw new InvalidOperationException($"No Docker Compose environment found. Ensure a Docker Compose environment is registered by calling {nameof(DockerComposeEnvironmentExtensions.AddDockerComposeEnvironment)}.");
         }
 
         var defaultNetwork = new Network
@@ -99,6 +99,14 @@ private async Task WriteDockerComposeOutputAsync(DistributedApplicationModel mod
                     defaultNetwork.Name,
                 ];
 
+                if (serviceResource.TargetResource.TryGetAnnotationsOfType<DockerComposeServiceCustomizationAnnotation>(out var annotations))
+                {
+                    foreach (var a in annotations)
+                    {
+                        a.Configure(serviceResource, composeService);
+                    }
+                }
+
                 composeFile.AddService(composeService);
             }
         }

src/Aspire.Hosting.Docker/DockerComposeServiceExtensions.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.ApplicationModel;
 using Aspire.Hosting.Docker;
 using Aspire.Hosting.Docker.Resources.ComposeNodes;
@@ -32,7 +34,7 @@ public static class DockerComposeServiceExtensions
     /// </code>
     /// </example>
     public static IResourceBuilder<T> PublishAsDockerComposeService<T>(this IResourceBuilder<T> builder, Action<DockerComposeServiceResource, Service> configure)
-        where T : IResource
+        where T : IComputeResource
     {
         ArgumentNullException.ThrowIfNull(builder);
         ArgumentNullException.ThrowIfNull(configure);

src/Aspire.Hosting.Docker/DockerComposeServiceResource.cs

@@ -81,15 +81,6 @@ private Service GetComposeService()
         AddPorts(composeService);
         AddVolumes(composeService);
         SetDependsOn(composeService);
-
-        if (resource.TryGetAnnotationsOfType<DockerComposeServiceCustomizationAnnotation>(out var annotations))
-        {
-            foreach (var a in annotations)
-            {
-                a.Configure(this, composeService);
-            }
-        }
-
         return composeService;
     }
 

tests/Aspire.Hosting.Docker.Tests/DockerComposePublisherTests.cs

@@ -156,6 +156,37 @@ public async Task PublishAsync_GeneratesValidDockerComposeFile()
             envContent, ignoreAllWhiteSpace: true, ignoreLineEndingDifferences: true);
     }
 
+    [Fact]
+    public async Task PublishAsync_ThrowsWhenDockerComposeEnvironmentNotAdded()
+    {
+        using var tempDir = new TempDirectory();
+        // Arrange
+        var options = new OptionsMonitor(new DockerComposePublisherOptions { OutputPath = tempDir.Path });
+        var builder = TestDistributedApplicationBuilder.Create(DistributedApplicationOperation.Publish);
+
+        // Add a simple container resource
+        builder.AddContainer("cache", "redis");
+
+        var app = builder.Build();
+        var model = app.Services.GetRequiredService<DistributedApplicationModel>();
+
+        await ExecuteBeforeStartHooksAsync(app, default);
+
+        var publisher = new DockerComposePublisher("test",
+            options,
+            NullLogger<DockerComposePublisher>.Instance,
+            builder.ExecutionContext,
+            new MockImageBuilder()
+        );
+
+        // Act & Assert
+        var exception = await Assert.ThrowsAsync<InvalidOperationException>(
+            () => publisher.PublishAsync(model, default)
+        );
+
+        Assert.Contains("No Docker Compose environment found. Ensure a Docker Compose environment is registered by calling AddDockerComposeEnvironment.", exception.Message, StringComparison.OrdinalIgnoreCase);
+    }
+
     [Fact]
     public async Task DockerComposeCorrectlyEmitsPortMappings()
     {
@@ -267,6 +298,9 @@ public async Task DockerComposeAppliesServiceCustomizations()
 
                 // Set a restart policy
                 composeService.Restart = "always";
+
+                // Add a custom network
+                composeService.Networks.Add("custom-network");
             });
 
         var app = builder.Build();
@@ -301,6 +335,7 @@ public async Task DockerComposeAppliesServiceCustomizations()
                   CUSTOM_ENV: "custom-value"
                 networks:
                   - "aspire"
+                    - "custom-network"
                 restart: "always"
                 labels:
                   custom-label: "test-value"