Skip to content

Commit b5f1433

Browse files
danegstakarolz-msCopilot
authored
[release/13.5] Fix DevTunnel endpoint URL publication (#19625)
* Fix DevTunnel endpoint URL publication (#19590) * Fix DevTunnel endpoint allocation Limit automatic proxyless port allocation to compute resources so integration-owned endpoints can publish their own addresses. Co-authored-by: Copilot App <[email protected]> Copilot-Session: e3b04d22-d265-49d0-861a-09aac8be80d6 * Address code review findings Co-authored-by: Copilot App <[email protected]> Copilot-Session: ec7aab9b-2163-45b7-89f6-c349fef7f07f --------- Co-authored-by: Copilot App <[email protected]> Copilot-Session: e3b04d22-d265-49d0-861a-09aac8be80d6 Copilot-Session: ec7aab9b-2163-45b7-89f6-c349fef7f07f * Adapt DevTunnel regression test for release/13.5 The release branch preserves a trailing slash on the inspect URL, unlike main's normalized URL behavior. Co-authored-by: Copilot App <[email protected]> Copilot-Session: 8d56e681-8c44-4dab-ba09-39ae0f6eacb2 --------- Co-authored-by: Karol Zadora-Przylecki <[email protected]> Co-authored-by: Copilot App <[email protected]> Copilot-Session: e3b04d22-d265-49d0-861a-09aac8be80d6 Copilot-Session: ec7aab9b-2163-45b7-89f6-c349fef7f07f Copilot-Session: 8d56e681-8c44-4dab-ba09-39ae0f6eacb2
1 parent 9e2f792 commit b5f1433

4 files changed

Lines changed: 155 additions & 2 deletions

File tree

‎src/Aspire.Hosting/Dcp/DcpExecutor.cs‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -837,7 +837,11 @@ private void EnsureProxylessEndpointPort(IResource resource, EndpointAnnotation
837837

838838
private static bool NeedsPublicPort(IResource resource, EndpointAnnotation endpoint)
839839
{
840-
return !endpoint.IsProxied && !TryGetEffectiveFixedPublicPort(resource, endpoint, randomizePorts: false, out _);
840+
// DCP can allocate a port only for resources it launches as workloads. This includes compute
841+
// resources and annotation-backed containers; integration-owned endpoints publish their own addresses.
842+
return (resource is IComputeResource || resource.IsContainer()) &&
843+
!endpoint.IsProxied &&
844+
!TryGetEffectiveFixedPublicPort(resource, endpoint, randomizePorts: false, out _);
841845
}
842846

843847
private int? TryGetPersistedProxylessEndpointPort(IResource resource, EndpointAnnotation endpoint)

‎tests/Aspire.Hosting.DevTunnels.Tests/DevTunnelResourceBuilderExtensionsTests.cs‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -404,6 +404,70 @@ public void GetEndpoint_WithMultipleEndpoints_ReturnsCorrectTunnelEndpoint()
404404
Assert.NotSame(httpTunnelEndpoint.EndpointAnnotation, httpsTunnelEndpoint.EndpointAnnotation);
405405
}
406406

407+
[Fact]
408+
public async Task DcpStartupPublishesDevTunnelUrls()
409+
{
410+
const int targetPort = 3000;
411+
const string tunnelUrl = "https://n4skq32k-3000.use.devtunnels.ms";
412+
const string inspectUrl = "https://n4skq32k-3000-inspect.use.devtunnels.ms/";
413+
using var cts = new CancellationTokenSource(TimeSpan.FromMinutes(2));
414+
var client = new TestDevTunnelClient
415+
{
416+
TunnelStatus = new("mytunnel", HostConnections: 1, ClientConnections: 0, Description: "", Labels: [])
417+
{
418+
Ports =
419+
[
420+
new(targetPort, "http")
421+
{
422+
PortUri = new Uri($"{tunnelUrl}/")
423+
}
424+
]
425+
}
426+
};
427+
var (command, arguments) = GetLongRunningCommand();
428+
using var builder = TestDistributedApplicationBuilder.Create();
429+
builder.Configuration["ASPIRE_DEVTUNNEL_CLI_PATH"] = command;
430+
builder.Services.AddSingleton<IDevTunnelClient>(client);
431+
builder.Services.AddSingleton<IRequiredCommandValidator, TestRequiredCommandValidator>();
432+
433+
var target = builder.AddExecutable("target", command, Environment.CurrentDirectory, arguments)
434+
.WithHttpEndpoint(targetPort: targetPort, name: "http");
435+
var tunnel = builder.AddDevTunnel("tunnel", "mytunnel")
436+
.WithReference(target);
437+
var tunnelPort = Assert.Single(tunnel.Resource.Ports);
438+
foreach (var annotation in tunnel.Resource.Annotations.OfType<CommandLineArgsCallbackAnnotation>().ToArray())
439+
{
440+
tunnel.Resource.Annotations.Remove(annotation);
441+
}
442+
tunnel.WithArgs(arguments);
443+
444+
using var app = builder.Build();
445+
446+
var startTask = app.StartAsync(cts.Token);
447+
var resourceEvent = await app.ResourceNotifications.WaitForResourceAsync(
448+
tunnelPort.Name,
449+
e => e.Snapshot.State?.Text == KnownResourceStates.Running &&
450+
e.Snapshot.Urls.Any(u => u.Url == tunnelUrl && !u.IsInactive) &&
451+
e.Snapshot.Urls.Any(u => u.Url == inspectUrl && !u.IsInactive),
452+
cts.Token);
453+
await startTask;
454+
455+
Assert.Equal("n4skq32k-3000.use.devtunnels.ms", tunnelPort.TunnelEndpointAnnotation.AllocatedEndpoint?.Address);
456+
Assert.Contains(resourceEvent.Snapshot.Urls, u => u.Url == tunnelUrl && !u.IsInactive);
457+
Assert.Contains(resourceEvent.Snapshot.Urls, u => u.Url == inspectUrl && !u.IsInactive);
458+
459+
await app.StopAsync(cts.Token);
460+
}
461+
462+
private static (string Command, string[] Arguments) GetLongRunningCommand()
463+
{
464+
// Windows has no sleep executable, and `timeout` exits immediately when stdin is redirected.
465+
// Loopback ping is dependency-free and remains bounded if test cleanup is interrupted.
466+
return OperatingSystem.IsWindows()
467+
? ("cmd.exe", ["/c", "ping", "-n", "180", "127.0.0.1"])
468+
: ("sleep", ["180"]);
469+
}
470+
407471
private sealed class ProjectA : IProjectMetadata
408472
{
409473
public string ProjectPath => "projectA";

‎tests/Aspire.Hosting.Dotnet.Tests/DotnetProjectResourceTests.cs‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,14 +83,15 @@ public void AddDotnetProject_UsesDotnetCommandAndProjectDirectoryAsWorkingDirect
8383
}
8484

8585
[Fact]
86-
public void AddDotnetProject_ResourceSupportsServiceDiscovery()
86+
public void AddDotnetProject_ResourceSupportsServiceDiscoveryAndIsComputeResource()
8787
{
8888
using var builder = TestDistributedApplicationBuilder.Create(DistributedApplicationOperation.Run);
8989

9090
var app = builder.AddDotnetProject("svc", "MyService.csproj", o => o.ExcludeLaunchProfile = true);
9191

9292
Assert.IsAssignableFrom<IResourceWithServiceDiscovery>(app.Resource);
9393
Assert.IsAssignableFrom<ExecutableResource>(app.Resource);
94+
Assert.IsAssignableFrom<IComputeResource>(app.Resource);
9495
}
9596

9697
[Fact]

‎tests/Aspire.Hosting.Tests/Dcp/DcpExecutorTests.cs‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
using Aspire.Dashboard.Model;
2020
using Aspire.Hosting.Dcp;
2121
using Aspire.Hosting.Dcp.Model;
22+
using Aspire.Hosting.DevTunnels;
2223
using Aspire.Hosting.Diagnostics;
2324
using Aspire.Hosting.Publishing;
2425
using Aspire.Hosting.Tests.Utils;
@@ -1051,6 +1052,88 @@ public async Task EndpointPortsExecutableNotReplicatedProxylessNoPortNoTargetPor
10511052
Assert.Equal(allocatedPort, int.Parse(envVarVal, CultureInfo.InvariantCulture));
10521053
}
10531054

1055+
[Fact]
1056+
public async Task ProxylessPortAllocatorOnlyAllocatesPortsForDcpWorkloads()
1057+
{
1058+
var (rangeStart, rangeEnd) = GetAvailableConsecutivePortPair();
1059+
var builder = DistributedApplication.CreateBuilder();
1060+
1061+
var compute = builder.AddExecutable("compute", "compute", Environment.CurrentDirectory)
1062+
.WithEndpoint(name: "tcp", isProxied: false);
1063+
var target = builder.AddExecutable("target", "target", Environment.CurrentDirectory)
1064+
.WithHttpEndpoint(targetPort: 8000, name: "http");
1065+
builder.AddDevTunnel("tunnel")
1066+
.WithReference(target);
1067+
1068+
var dcpOptions = new DcpOptions
1069+
{
1070+
DashboardPath = "./dashboard",
1071+
ProxylessEndpointPortRangeStart = rangeStart,
1072+
ProxylessEndpointPortRangeEnd = rangeEnd
1073+
};
1074+
var kubernetesService = new TestKubernetesService();
1075+
using var app = builder.Build();
1076+
var distributedAppModel = app.Services.GetRequiredService<DistributedApplicationModel>();
1077+
var tunnelPort = Assert.Single(distributedAppModel.Resources.OfType<DevTunnelPortResource>());
1078+
var computeEndpoint = compute.GetEndpoint("tcp").EndpointAnnotation;
1079+
var tunnelEndpoint = Assert.Single(tunnelPort.Annotations.OfType<EndpointAnnotation>());
1080+
var appExecutor = CreateAppExecutor(distributedAppModel, kubernetesService: kubernetesService, dcpOptions: dcpOptions);
1081+
1082+
await appExecutor.RunApplicationAsync();
1083+
1084+
Assert.NotNull(computeEndpoint.AllocatedEndpoint);
1085+
var computePort = Assert.IsType<int>(computeEndpoint.Port);
1086+
Assert.InRange(computePort, rangeStart, rangeEnd);
1087+
Assert.Equal(computePort, computeEndpoint.TargetPort);
1088+
Assert.Null(tunnelEndpoint.Port);
1089+
Assert.Null(tunnelEndpoint.TargetPort);
1090+
Assert.Null(tunnelEndpoint.AllocatedEndpoint);
1091+
}
1092+
1093+
[Fact]
1094+
public async Task ProxylessPortAllocatorAllocatesPortForNonComputeContainerResource()
1095+
{
1096+
const int targetPort = 10000;
1097+
var (allocatedPort, _) = GetAvailableConsecutivePortPair();
1098+
var builder = DistributedApplication.CreateBuilder();
1099+
1100+
var emulator = builder.AddResource(new TestContainerResource("emulator"))
1101+
.WithAnnotation(new ContainerImageAnnotation { Image = "image" })
1102+
.WithAnnotation(new ContainerLifetimeAnnotation { Lifetime = ContainerLifetime.Persistent })
1103+
.WithHttpEndpoint(targetPort: targetPort, name: "http");
1104+
1105+
var configuration = new ConfigurationBuilder()
1106+
.AddInMemoryCollection(new Dictionary<string, string?>
1107+
{
1108+
["AppHost:Sha256"] = "1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"
1109+
})
1110+
.Build();
1111+
var dcpOptions = new DcpOptions
1112+
{
1113+
DashboardPath = "./dashboard",
1114+
ProxylessEndpointPortRangeStart = allocatedPort,
1115+
ProxylessEndpointPortRangeEnd = allocatedPort
1116+
};
1117+
var kubernetesService = new TestKubernetesService();
1118+
using var app = builder.Build();
1119+
var distributedAppModel = app.Services.GetRequiredService<DistributedApplicationModel>();
1120+
var endpoint = emulator.GetEndpoint("http").EndpointAnnotation;
1121+
var appExecutor = CreateAppExecutor(
1122+
distributedAppModel,
1123+
configuration: configuration,
1124+
kubernetesService: kubernetesService,
1125+
dcpOptions: dcpOptions);
1126+
1127+
await appExecutor.RunApplicationAsync();
1128+
1129+
Assert.IsNotAssignableFrom<IComputeResource>(emulator.Resource);
1130+
Assert.True(emulator.Resource.IsContainer());
1131+
Assert.Equal(allocatedPort, endpoint.Port);
1132+
Assert.Equal(targetPort, endpoint.TargetPort);
1133+
Assert.Equal(allocatedPort, endpoint.AllocatedEndpoint?.Port);
1134+
Assert.Single(kubernetesService.CreatedResources.OfType<Container>(), c => c.AppModelResourceName == emulator.Resource.Name);
1135+
}
1136+
10541137
[Fact]
10551138
public async Task ProxylessPortAllocatorExcludesFixedPublicPorts()
10561139
{
@@ -9580,6 +9663,7 @@ private static X509Certificate2 CreateTestCertificate()
95809663

95819664
private sealed class TestExecutableResource(string directory) : ExecutableResource("TestExecutable", "test", directory);
95829665
private sealed class TestOtherExecutableResource(string directory) : ExecutableResource("TestOtherExecutable", "test-other", directory);
9666+
private sealed class TestContainerResource(string name) : Resource(name), IResourceWithEndpoints;
95839667

95849668
private sealed class NullValueProvider : IValueProvider
95859669
{

0 commit comments

Comments
 (0)