Adding Resource to CommandLineArgsCallbackContext (#10864)

* Adding new property to CommandLineArgsCallbackContext that exposes the resource

Fixes #10863

* Addressing the breaking change issue from code review

* Enhance endpoint handling in container and executable tests with HTTP scheme and allocated endpoints

---------

Co-authored-by: David Fowler <[email protected]>

Author: aaronpowell

src/Aspire.Hosting.Azure.AppContainers/ContainerAppContext.cs

@@ -422,7 +422,7 @@ private async Task ProcessArgumentsAsync(CancellationToken cancellationToken)
     {
         if (resource.TryGetAnnotationsOfType<CommandLineArgsCallbackAnnotation>(out var commandLineArgsCallbackAnnotations))
         {
-            var context = new CommandLineArgsCallbackContext(Args, cancellationToken: cancellationToken)
+            var context = new CommandLineArgsCallbackContext(Args, resource, cancellationToken: cancellationToken)
             {
                 ExecutionContext = _containerAppEnvironmentContext.ExecutionContext,
             };

src/Aspire.Hosting.Azure.AppService/AzureAppServiceWebsiteContext.cs

@@ -62,7 +62,7 @@ private async Task ProcessArgumentsAsync(CancellationToken cancellationToken)
     {
         if (resource.TryGetAnnotationsOfType<CommandLineArgsCallbackAnnotation>(out var commandLineArgsCallbackAnnotations))
         {
-            var context = new CommandLineArgsCallbackContext(Args, cancellationToken)
+            var context = new CommandLineArgsCallbackContext(Args, resource, cancellationToken)
             {
                 ExecutionContext = environmentContext.ExecutionContext
             };

src/Aspire.Hosting.Azure/AzureResourcePreparer.cs

@@ -380,7 +380,7 @@ private async Task<HashSet<IAzureResource>> GetAzureReferences(IResource resourc
 
         if (resource.TryGetAnnotationsOfType<CommandLineArgsCallbackAnnotation>(out var commandLineArgsCallbackAnnotations))
         {
-            var context = new CommandLineArgsCallbackContext([], cancellationToken: cancellationToken);
+            var context = new CommandLineArgsCallbackContext([], resource, cancellationToken: cancellationToken);
 
             foreach (var c in commandLineArgsCallbackAnnotations)
             {

src/Aspire.Hosting.Docker/DockerComposeEnvironmentContext.cs

@@ -144,7 +144,7 @@ private static async Task ProcessArgumentsAsync(DockerComposeServiceResource ser
     {
         if (serviceResource.TargetResource.TryGetAnnotationsOfType<CommandLineArgsCallbackAnnotation>(out var commandLineArgsCallbacks))
         {
-            var context = new CommandLineArgsCallbackContext(serviceResource.Args, cancellationToken: cancellationToken)
+            var context = new CommandLineArgsCallbackContext(serviceResource.Args, serviceResource.TargetResource, cancellationToken: cancellationToken)
             {
                 ExecutionContext = executionContext
             };

src/Aspire.Hosting.Kubernetes/KubernetesResource.cs

@@ -226,7 +226,7 @@ private async Task ProcessArgumentsAsync(KubernetesEnvironmentContext environmen
     {
         if (resource.TryGetAnnotationsOfType<CommandLineArgsCallbackAnnotation>(out var commandLineArgsCallbackAnnotations))
         {
-            var context = new CommandLineArgsCallbackContext([], cancellationToken: cancellationToken);
+            var context = new CommandLineArgsCallbackContext([], resource, cancellationToken: cancellationToken);
 
             foreach (var c in commandLineArgsCallbackAnnotations)
             {

src/Aspire.Hosting/ApplicationModel/CommandLineArgsCallbackAnnotation.cs

@@ -50,6 +50,17 @@ public CommandLineArgsCallbackAnnotation(Action<IList<object>> callback)
 /// <param name="cancellationToken"> The cancellation token associated with this execution.</param>
 public sealed class CommandLineArgsCallbackContext(IList<object> args, CancellationToken cancellationToken = default)
 {
+    private readonly IResource? _resource;
+
+    /// <summary>
+    /// Represents a callback context for the list of command-line arguments associated with an executable resource.
+    /// </summary>
+    /// <param name="args"> The list of command-line arguments.</param>
+    /// <param name="resource"> The resource associated with this callback context.</param>
+    /// <param name="cancellationToken"> The cancellation token associated with this execution.</param>
+    public CommandLineArgsCallbackContext(IList<object> args, IResource? resource = null, CancellationToken cancellationToken = default)
+        : this(args, cancellationToken) => _resource = resource;
+
     /// <summary>
     /// Gets the list of command-line arguments.
     /// </summary>
@@ -69,4 +80,13 @@ public sealed class CommandLineArgsCallbackContext(IList<object> args, Cancellat
     /// Gets or sets the logger for the distributed application.
     /// </summary>
     public ILogger Logger { get; init; } = NullLogger.Instance;
+
+    /// <summary>
+    /// The resource associated with this callback context.
+    /// </summary>
+    /// <remarks>
+    /// This will be set to the resource in all cases where .NET Aspire invokes the callback.
+    /// </remarks>
+    /// <exception cref="InvalidOperationException">Thrown when the EnvironmentCallbackContext was created without a specified resource.</exception>
+    public IResource Resource => _resource ?? throw new InvalidOperationException($"{nameof(Resource)} is not set. This callback context is not associated with a resource.");
 }

src/Aspire.Hosting/ApplicationModel/ResourceExtensions.cs

@@ -282,7 +282,7 @@ public static async ValueTask ProcessArgumentValuesAsync(
         if (resource.TryGetAnnotationsOfType<CommandLineArgsCallbackAnnotation>(out var callbacks))
         {
             var args = new List<object>();
-            var context = new CommandLineArgsCallbackContext(args, cancellationToken)
+            var context = new CommandLineArgsCallbackContext(args, resource, cancellationToken)
             {
                 Logger = logger,
                 ExecutionContext = executionContext

tests/Aspire.Hosting.Containers.Tests/ContainerResourceTests.cs

@@ -103,11 +103,17 @@ public async Task AddContainerWithArgs()
             });
 
         var c2 = appBuilder.AddContainer("container", "none")
+             .WithEndpoint("ep", e =>
+             {
+                 e.UriScheme = "http";
+                 e.AllocatedEndpoint = new(e, "localhost", 5678, targetPortExpression: "5678");
+             })
              .WithArgs(context =>
              {
                  context.Args.Add("arg1");
                  context.Args.Add(c1.GetEndpoint("ep"));
                  context.Args.Add(testResource);
+                 context.Args.Add(((IResourceWithEndpoints)context.Resource).GetEndpoint("ep"));
              });
 
         using var app = appBuilder.Build();
@@ -117,7 +123,8 @@ public async Task AddContainerWithArgs()
         Assert.Collection(args,
             arg => Assert.Equal("arg1", arg),
             arg => Assert.Equal("http://c1:1234", arg), // this is the container hostname
-            arg => Assert.Equal("connectionString", arg));
+            arg => Assert.Equal("connectionString", arg),
+            arg => Assert.Equal("http://container:5678", arg));
 
         // We don't yet process relationships set via the callbacks
         // so we don't see the testResource2 nor exe1
@@ -133,8 +140,17 @@ public async Task AddContainerWithArgs()
           "args": [
             "arg1",
             "{c1.bindings.ep.url}",
-            "{test.connectionString}"
-          ]
+            "{test.connectionString}",
+            "{container.bindings.ep.url}"
+          ],
+          "bindings": {
+            "ep": {
+              "scheme": "http",
+              "protocol": "tcp",
+              "transport": "http",
+              "targetPort": 8000
+            }
+          }
         }
         """;
 

tests/Aspire.Hosting.Tests/ExecutableResourceTests.cs

@@ -25,12 +25,18 @@ public async Task AddExecutableWithArgs()
             });
 
         var exe2 = appBuilder.AddExecutable("e2", "python", ".", "app.py", exe1.GetEndpoint("ep"))
+             .WithEndpoint("ep", e =>
+             {
+                 e.UriScheme = "http";
+                 e.AllocatedEndpoint = new(e, "localhost", 5678);
+             })
              .WithArgs("arg1", testResource)
              .WithArgs(context =>
              {
                  context.Args.Add("arg2");
                  context.Args.Add(exe1.GetEndpoint("ep"));
                  context.Args.Add(testResource2);
+                 context.Args.Add(((IResourceWithEndpoints)context.Resource).GetEndpoint("ep"));
              });
 
         using var app = appBuilder.Build();
@@ -44,7 +50,8 @@ public async Task AddExecutableWithArgs()
             arg => Assert.Equal("connectionString", arg),
             arg => Assert.Equal("arg2", arg),
             arg => Assert.Equal("http://localhost:1234", arg),
-            arg => Assert.Equal("anotherConnectionString", arg)
+            arg => Assert.Equal("anotherConnectionString", arg),
+            arg => Assert.Equal("http://localhost:5678", arg)
             );
 
         Assert.True(exe2.Resource.TryGetAnnotationsOfType<ResourceRelationshipAnnotation>(out var relationships));
@@ -58,6 +65,7 @@ public async Task AddExecutableWithArgs()
             });
 
         var manifest = await ManifestUtils.GetManifest(exe2.Resource).DefaultTimeout();
+
         // Note: resource working directory is <repo-root>\tests\Aspire.Hosting.Tests
         // Manifest directory is <repo-root>\artifacts\bin\Aspire.Hosting.Tests\Debug\net8.0
         var expectedManifest =
@@ -73,8 +81,17 @@ public async Task AddExecutableWithArgs()
             "{test.connectionString}",
             "arg2",
             "{e1.bindings.ep.url}",
-            "{test2.connectionString}"
-          ]
+            "{test2.connectionString}",
+            "{e2.bindings.ep.url}"
+          ],
+          "bindings": {
+            "ep": {
+              "scheme": "http",
+              "protocol": "tcp",
+              "transport": "http",
+              "targetPort": 8000
+            }
+          }
         }
         """;
 

tests/Aspire.Hosting.Tests/ProjectResourceTests.cs

@@ -580,10 +580,16 @@ public async Task AddProjectWithArgs()
             });
 
         var project = appBuilder.AddProject<TestProjectWithLaunchSettings>("projectName")
+             .WithEndpoint("ep", e =>
+             {
+                 e.UriScheme = "http";
+                 e.AllocatedEndpoint = new(e, "localhost", 8000);
+             })
              .WithArgs(context =>
              {
                  context.Args.Add("arg1");
                  context.Args.Add(c1.GetEndpoint("ep"));
+                 context.Args.Add(((IResourceWithEndpoints)context.Resource).GetEndpoint("ep"));
              });
 
         using var app = appBuilder.Build();
@@ -592,7 +598,8 @@ public async Task AddProjectWithArgs()
 
         Assert.Collection(args,
             arg => Assert.Equal("arg1", arg),
-            arg => Assert.Equal("http://localhost:1234", arg));
+            arg => Assert.Equal("http://localhost:1234", arg),
+            arg => Assert.Equal("http://localhost:8000", arg));
 
         // We don't yet process relationships set via the callbacks
         Assert.False(project.Resource.TryGetAnnotationsOfType<ResourceRelationshipAnnotation>(out var relationships));