Specify Ports for resources created by DistributedApplicationTestingBuilder

[gdodd1977]

I've created an Aspire-Xunit integration test project that is doing the following to create an app host off my Aspire project:
var appHost = await DistributedApplicationTestingBuilder.CreateAsync<Projects.CopilotFlow_LocalHost_StartHere>(); await using var app = await appHost.BuildAsync();

The Aspire project starts up three services:
builder.AddProject<Projects.CopilotFlow_LocalHelper_Service>($"{targetEnvironment}LocalHelperService"); builder.AddProject<Projects.Microsoft_PowerAutomate_CopilotFlow_Web_Service>($"{targetEnvironment}WebService"); builder.AddProject<Projects.Microsoft_PowerAutomate_CopilotFlow_Worker_Service>($"{targetEnvironment}WorkerService");

The issue is that the WebService requires a call to the LocalHelper_Service at a specific configured port. i.e. localhost:1234. But the code in the integration test using the DistributedApplicationTestingBuilder assigns a random port to the LocalHelper_Service.

So I have two questions.

1. Why wouldn't the launchSettings of the LocalHelper_Service be used when it's getting started, thus giving it the same port every time.
2. If that's not possible, how can I make sure that resource gets the right port every time DistributedApplicationTestingBuilder creates the app host?

[davidfowl]

Why wouldn't the launchSettings of the LocalHelper_Service be used when it's getting started, thus giving it the same port every time.

To make sure you can run tests concurrently and to avoid port usage issues when tests start and stop.

If that's not possible, how can I make sure that resource gets the right port every time DistributedApplicationTestingBuilder creates the app host?

If you don't hard code ports but instead resolve it from the resource it should work. Are you hard coding the port somewhere in your application?

You can turn off port randomization as well, but you probably also want to turn off test concurrency.

cc @ReubenBond

[gdodd1977]

Ok. Is there an example of that somewhere and how I would setup my xunit project to work with that?

[davidfowl]

From your apphost project, which service maps to ApiHubsClientConfiguration and FlowRpClientConfiguration?

[gdodd1977]

builder.AddProject<Projects.Microsoft_PowerAutomate_CopilotFlow_Web_Service>($"{targetEnvironment}WebService");

That's the one that has that config above and makes the call to those two clients.

[davidfowl]

var endpoint = project.GetEndpoint("http");

var localService = builder.AddProject<Projects.CopilotFlow_LocalHelper_Service>($"{targetEnvironment}LocalHelperService"); 

var httpEndpoint =  localService.GetEndpoint("http");

builder.AddProject<Projects.Microsoft_PowerAutomate_CopilotFlow_Worker_Service>($"{targetEnvironment}WorkerService");

builder.AddProject<Projects.Microsoft_PowerAutomate_CopilotFlow_Web_Service>($"{targetEnvironment}WebService")
           .WithEnvironment("ApiHubsClientConfiguration__ServiceUrl", httpEndpoint)
           .WithEnvironment("ApiHubsClientConfiguration__ServiceUrl", httpEndpoint);

[gdodd1977]

Thanks. I'll give that a shot.

[gdodd1977]

Ok. So I have another question. If I'm creating that new Env variable in the Web_Service, do I need to then use that to set my URL instead of the setting in my appsettings.local?

[gdodd1977]

I got this figured out. Thanks for the help!

[davidfowl]

Just to make sure I close the loop on this discussion. You don't have to change your application, the IConfiguration system translated environment variables to configuration entries. That format I have above e.g. ApiHubsClientConfiguration__ServiceUrl maps to ApiHubsClientConfiguration:ServiceUrl, which is the same as your JSON configuration.

https://learn.microsoft.com/en-us/aspnet/core/fundamentals/configuration/?view=aspnetcore-8.0#naming-of-environment-variables

[jhancock-taxa]

Is there a way to just resolve these directly? We're using OpenIddict and you have to set the issuer and it must be the exactly thing that the issuer responds with, which is the actual URL that it is on with port, not the virtual name: https://accounts. I need https://localhost:3424 (or whatever port was randomly assigned) and I need to keep random assignment.

[robbash]

@jhancock-taxa, I use this to specify a port:

1. Disable random ports:

var appHost = await DistributedApplicationTestingBuilder.CreateAsync<Projects.MyProj>(
  ["DcpPublisher:RandomizePorts=false"]
);

2. Create a launch profile on you MyProj. Copy the http profile for example and update as per your needs. This will also allow you to pass in different environment variables.

3. Set the launch profile env var (as used below) somewhere before your DistributedApplicationTestingBuilder.CreateAsync<>() call.

4. You need to choose the launch profile in your AppHost's Program.cs:

// Note: it's not a standard MS variable, you can name it however. I just stuck to the prefix...
var lp = Environment.GetEnvironmentVariable("ASPNETCORE_LAUNCH_PROFILE");

builder
    .AddProject<Projects.MyProj>("idm", launchProfileName: lp)
    .WithExternalHttpEndpoints();