|
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
using System.Globalization;
using System.IO.Pipelines;
using System.Text;
using System.Threading.Channels;
using Aspire.Hosting.Dcp;
using Aspire.Hosting.Dcp.Model;
using Aspire.Hosting.Eventing;
using Aspire.Hosting.Lifecycle;
using Aspire.Hosting.Tests.Utils;
using k8s.Models;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging.Abstractions;
using Microsoft.Extensions.Options;
using Xunit;
namespace Aspire.Hosting.Tests.Dcp;
public class ApplicationExecutorTests
{
[Fact]
public async Task ContainersArePassedOtelServiceName()
{
// Arrange
var builder = DistributedApplication.CreateBuilder();
builder.AddContainer("CustomName", "container").WithOtlpExporter();
var kubernetesService = new TestKubernetesService();
using var app = builder.Build();
var distributedAppModel = app.Services.GetRequiredService<DistributedApplicationModel>();
var appExecutor = CreateAppExecutor(distributedAppModel, app.Services, kubernetesService: kubernetesService);
// Act
await appExecutor.RunApplicationAsync();
// Assert
var container = Assert.Single(kubernetesService.CreatedResources.OfType<Container>());
Assert.Equal("CustomName", container.Metadata.Annotations["otel-service-name"]);
}
[Fact]
public async Task EndpointPortsExecutableNotReplicatedProxiedNoPortNoTargetPort()
{
var builder = DistributedApplication.CreateBuilder();
var exe = builder.AddExecutable("CoolProgram", "cool", Environment.CurrentDirectory, "--alpha", "--bravo")
.WithEndpoint(name: "NoPortNoTargetPort", env: "NO_PORT_NO_TARGET_PORT", isProxied: true);
var kubernetesService = new TestKubernetesService();
using var app = builder.Build();
var distributedAppModel = app.Services.GetRequiredService<DistributedApplicationModel>();
var appExecutor = CreateAppExecutor(distributedAppModel, app.Services, kubernetesService: kubernetesService);
await appExecutor.RunApplicationAsync();
var dcpExe = Assert.Single(kubernetesService.CreatedResources.OfType<Executable>());
Assert.True(dcpExe.TryGetAnnotationAsObjectList<ServiceProducerAnnotation>(CustomResource.ServiceProducerAnnotation, out var spAnnList));
// Neither Port, nor TargetPort are set
// Clients use proxy, MAY have the proxy port injected.
// Proxy gets autogenerated port.
// Program gets (different) autogenerated port that MUST be injected via env var / startup param.
var svc = kubernetesService.CreatedResources.OfType<Service>().Single(s => s.Name() == "CoolProgram");
Assert.Equal(AddressAllocationModes.Localhost, svc.Spec.AddressAllocationMode);
Assert.True(svc.Status?.EffectivePort >= TestKubernetesService.StartOfAutoPortRange);
Assert.True(spAnnList.Single(ann => ann.ServiceName == "CoolProgram").Port is null,
"Expected service producer (target) port to not be set (leave allocation to DCP)");
var envVarVal = dcpExe.Spec.Env?.Single(v => v.Name == "NO_PORT_NO_TARGET_PORT").Value;
Assert.False(string.IsNullOrWhiteSpace(envVarVal));
Assert.Contains("""portForServing "CoolProgram" """, envVarVal);
}
[Fact]
public async Task EndpointPortsExecutableNotReplicatedProxiedPortSetNoTargetPort()
{
var builder = DistributedApplication.CreateBuilder();
const int desiredPort = TestKubernetesService.StartOfAutoPortRange - 1000;
var exe = builder.AddExecutable("CoolProgram", "cool", Environment.CurrentDirectory, "--alpha", "--bravo")
.WithEndpoint(name: "PortSetNoTargetPort", port: desiredPort, env: "PORT_SET_NO_TARGET_PORT", isProxied: true);
var kubernetesService = new TestKubernetesService();
using var app = builder.Build();
var distributedAppModel = app.Services.GetRequiredService<DistributedApplicationModel>();
var appExecutor = CreateAppExecutor(distributedAppModel, app.Services, kubernetesService: kubernetesService);
await appExecutor.RunApplicationAsync();
var dcpExe = Assert.Single(kubernetesService.CreatedResources.OfType<Executable>());
Assert.True(dcpExe.TryGetAnnotationAsObjectList<ServiceProducerAnnotation>(CustomResource.ServiceProducerAnnotation, out var spAnnList));
// Port is set, but TargetPort is empty
// Clients use proxy, MAY have the proxy port injected.
// Proxy uses Port.
// Program gets autogenerated port that MUST be injected via env var / startup param.
var svc = kubernetesService.CreatedResources.OfType<Service>().Single(s => s.Name() == "CoolProgram");
Assert.Equal(AddressAllocationModes.Localhost, svc.Spec.AddressAllocationMode);
Assert.Equal(desiredPort, svc.Status?.EffectivePort);
Assert.True(spAnnList.Single(ann => ann.ServiceName == "CoolProgram").Port is null,
"Expected service producer (target) port to not be set (leave allocation to DCP)");
var envVarVal = dcpExe.Spec.Env?.Single(v => v.Name == "PORT_SET_NO_TARGET_PORT").Value;
Assert.False(string.IsNullOrWhiteSpace(envVarVal));
Assert.Contains("""portForServing "CoolProgram" """, envVarVal);
}
[Fact]
public async Task EndpointPortsExecutableNotReplicatedProxiedNoPortTargetPortSet()
{
var builder = DistributedApplication.CreateBuilder();
const int desiredPort = TestKubernetesService.StartOfAutoPortRange - 999;
var exe = builder.AddExecutable("CoolProgram", "cool", Environment.CurrentDirectory, "--alpha", "--bravo")
.WithEndpoint(name: "NoPortTargetPortSet", targetPort: desiredPort, env: "NO_PORT_TARGET_PORT_SET", isProxied: true);
var kubernetesService = new TestKubernetesService();
using var app = builder.Build();
var distributedAppModel = app.Services.GetRequiredService<DistributedApplicationModel>();
var appExecutor = CreateAppExecutor(distributedAppModel, app.Services, kubernetesService: kubernetesService);
await appExecutor.RunApplicationAsync();
var dcpExe = Assert.Single(kubernetesService.CreatedResources.OfType<Executable>());
Assert.True(dcpExe.TryGetAnnotationAsObjectList<ServiceProducerAnnotation>(CustomResource.ServiceProducerAnnotation, out var spAnnList));
// Port is empty, TargetPort is set
// Clients use proxy, MAY have the proxy port injected.
// Proxy gets autogenerated port.
// Program uses TargetPort which MAY be injected via env var/ startup param.
var svc = kubernetesService.CreatedResources.OfType<Service>().Single(s => s.Name() == "CoolProgram");
Assert.Equal(AddressAllocationModes.Localhost, svc.Spec.AddressAllocationMode);
Assert.True(svc.Status?.EffectivePort >= TestKubernetesService.StartOfAutoPortRange);
// Desired port should be part of the service producer annotation.
Assert.Equal(desiredPort, spAnnList.Single(ann => ann.ServiceName == "CoolProgram").Port);
var envVarVal = dcpExe.Spec.Env?.Single(v => v.Name == "NO_PORT_TARGET_PORT_SET").Value;
Assert.False(string.IsNullOrWhiteSpace(envVarVal));
Assert.Equal(desiredPort, int.Parse(envVarVal, CultureInfo.InvariantCulture));
}
[Fact]
public async Task EndpointPortsExecutableNotReplicatedProxiedPortAndTargetPortSet()
{
var builder = DistributedApplication.CreateBuilder();
const int desiredPort = TestKubernetesService.StartOfAutoPortRange - 998;
const int desiredTargetPort = TestKubernetesService.StartOfAutoPortRange - 997;
var exe = builder.AddExecutable("CoolProgram", "cool", Environment.CurrentDirectory, "--alpha", "--bravo")
.WithEndpoint(name: "PortAndTargetPortSet", port: desiredPort, targetPort: desiredTargetPort, env: "PORT_AND_TARGET_PORT_SET", isProxied: true);
var kubernetesService = new TestKubernetesService();
using var app = builder.Build();
var distributedAppModel = app.Services.GetRequiredService<DistributedApplicationModel>();
var appExecutor = CreateAppExecutor(distributedAppModel, app.Services, kubernetesService: kubernetesService);
await appExecutor.RunApplicationAsync();
var dcpExe = Assert.Single(kubernetesService.CreatedResources.OfType<Executable>());
Assert.True(dcpExe.TryGetAnnotationAsObjectList<ServiceProducerAnnotation>(CustomResource.ServiceProducerAnnotation, out var spAnnList));
// Port and TargetPort set (MUST be different).
// Clients use proxy, MAY have the proxy port injected.
// Proxy uses Port.
// Program uses TargetPort with MAY be injected via env var/ startup param.
var svc = kubernetesService.CreatedResources.OfType<Service>().Single(s => s.Name() == "CoolProgram");
Assert.Equal(AddressAllocationModes.Localhost, svc.Spec.AddressAllocationMode);
Assert.Equal(desiredPort, svc.Status?.EffectivePort);
// Desired port should be part of the service producer annotation.
Assert.Equal(desiredTargetPort, spAnnList.Single(ann => ann.ServiceName == "CoolProgram").Port);
var envVarVal = dcpExe.Spec.Env?.Single(v => v.Name == "PORT_AND_TARGET_PORT_SET").Value;
Assert.False(string.IsNullOrWhiteSpace(envVarVal));
Assert.Equal(desiredTargetPort, int.Parse(envVarVal, CultureInfo.InvariantCulture));
}
/// <summary>
/// Verifies that applying unsupported endpoint port configuration to non-replicated, proxied Executable
/// results in an error.
/// </summary>
[Fact]
public async Task UnsupportedEndpointPortsExecutableNotReplicatedProxied()
{
// Invalid configuration: Port and TargetPort have the same value. This would result in a port conflict.
var builder = DistributedApplication.CreateBuilder();
const int desiredPort = TestKubernetesService.StartOfAutoPortRange - 1000;
builder.AddExecutable("CoolProgram", "cool", Environment.CurrentDirectory, "--alpha", "--bravo")
.WithEndpoint(name: "EqualPortAndTargetPort", port: desiredPort, targetPort: desiredPort, env: "EQUAL_PORT_AND_TARGET_PORT", isProxied: true);
var kubernetesService = new TestKubernetesService();
using var app = builder.Build();
var distributedAppModel = app.Services.GetRequiredService<DistributedApplicationModel>();
var appExecutor = CreateAppExecutor(distributedAppModel, app.Services, kubernetesService: kubernetesService);
var exception = await Assert.ThrowsAsync<InvalidOperationException>(() => appExecutor.RunApplicationAsync());
Assert.Contains("cannot be proxied when both TargetPort and Port are specified with the same value", exception.Message);
}
[Fact]
public async Task EndpointPortsExecutableNotReplicatedProxylessPortSetNoTargetPort()
{
var builder = DistributedApplication.CreateBuilder();
const int desiredPort = TestKubernetesService.StartOfAutoPortRange - 1000;
builder.AddExecutable("CoolProgram", "cool", Environment.CurrentDirectory, "--alpha", "--bravo")
.WithEndpoint(name: "PortSetNoTargetPort", port: desiredPort, env: "PORT_SET_NO_TARGET_PORT", isProxied: false);
// All these configurations are effectively the same because EndpointAnnotation constructor for proxy-less endpoints
// will make sure Port and TargetPort have the same value if one is specified but the other is not.
var kubernetesService = new TestKubernetesService();
using var app = builder.Build();
var distributedAppModel = app.Services.GetRequiredService<DistributedApplicationModel>();
var appExecutor = CreateAppExecutor(distributedAppModel, app.Services, kubernetesService: kubernetesService);
await appExecutor.RunApplicationAsync();
var dcpExe = Assert.Single(kubernetesService.CreatedResources.OfType<Executable>());
Assert.True(dcpExe.TryGetAnnotationAsObjectList<ServiceProducerAnnotation>(CustomResource.ServiceProducerAnnotation, out var spAnnList));
// Port is set, but TargetPort is empty
// Clients connect directly to the program, MAY have the program port injected.
// Program uses TargetPort, which MAY be injected via env var / startup param.
var svc = kubernetesService.CreatedResources.OfType<Service>().Single(s => s.Name() == "CoolProgram");
Assert.Equal(AddressAllocationModes.Proxyless, svc.Spec.AddressAllocationMode);
Assert.Equal(desiredPort, svc.Status?.EffectivePort);
// Desired port should be part of the service producer annotation.
Assert.Equal(desiredPort, spAnnList.Single(ann => ann.ServiceName == "CoolProgram").Port);
var envVarVal = dcpExe.Spec.Env?.Single(v => v.Name == "PORT_SET_NO_TARGET_PORT").Value;
Assert.False(string.IsNullOrWhiteSpace(envVarVal));
Assert.Equal(desiredPort, int.Parse(envVarVal, CultureInfo.InvariantCulture));
}
[Fact]
public async Task EndpointPortsExecutableNotReplicatedProxylessNoPortTargetPortSet()
{
var builder = DistributedApplication.CreateBuilder();
const int desiredPort = TestKubernetesService.StartOfAutoPortRange - 999;
builder.AddExecutable("CoolProgram", "cool", Environment.CurrentDirectory, "--alpha", "--bravo")
.WithEndpoint(name: "NoPortTargetPortSet", targetPort: desiredPort, env: "NO_PORT_TARGET_PORT_SET", isProxied: false);
// All these configurations are effectively the same because EndpointAnnotation constructor for proxy-less endpoints
// will make sure Port and TargetPort have the same value if one is specified but the other is not.
var kubernetesService = new TestKubernetesService();
using var app = builder.Build();
var distributedAppModel = app.Services.GetRequiredService<DistributedApplicationModel>();
var appExecutor = CreateAppExecutor(distributedAppModel, app.Services, kubernetesService: kubernetesService);
await appExecutor.RunApplicationAsync();
var dcpExe = Assert.Single(kubernetesService.CreatedResources.OfType<Executable>());
Assert.True(dcpExe.TryGetAnnotationAsObjectList<ServiceProducerAnnotation>(CustomResource.ServiceProducerAnnotation, out var spAnnList));
// Port is empty, TargetPort is set.
// Clients connect directly to the program, MAY have the program port injected.
// Program uses TargetPort, which MAY be injected via env var / startup param.
var svc = kubernetesService.CreatedResources.OfType<Service>().Single(s => s.Name() == "CoolProgram");
Assert.Equal(AddressAllocationModes.Proxyless, svc.Spec.AddressAllocationMode);
Assert.Equal(desiredPort, svc.Status?.EffectivePort);
// Desired port should be part of the service producer annotation.
Assert.Equal(desiredPort, spAnnList.Single(ann => ann.ServiceName == "CoolProgram").Port);
var envVarVal = dcpExe.Spec.Env?.Single(v => v.Name == "NO_PORT_TARGET_PORT_SET").Value;
Assert.False(string.IsNullOrWhiteSpace(envVarVal));
Assert.Equal(desiredPort, int.Parse(envVarVal, CultureInfo.InvariantCulture));
}
[Fact]
public async Task EndpointPortsExecutableNotReplicatedProxylessPortAndTargetPortSet()
{
var builder = DistributedApplication.CreateBuilder();
const int desiredPort = TestKubernetesService.StartOfAutoPortRange - 998;
builder.AddExecutable("CoolProgram", "cool", Environment.CurrentDirectory, "--alpha", "--bravo")
.WithEndpoint(name: "PortAndTargetPortSet", port: desiredPort, targetPort: desiredPort, env: "PORT_AND_TARGET_PORT_SET", isProxied: false);
// All these configurations are effectively the same because EndpointAnnotation constructor for proxy-less endpoints
// will make sure Port and TargetPort have the same value if one is specified but the other is not.
var kubernetesService = new TestKubernetesService();
using var app = builder.Build();
var distributedAppModel = app.Services.GetRequiredService<DistributedApplicationModel>();
var appExecutor = CreateAppExecutor(distributedAppModel, app.Services, kubernetesService: kubernetesService);
await appExecutor.RunApplicationAsync();
var dcpExe = Assert.Single(kubernetesService.CreatedResources.OfType<Executable>());
Assert.True(dcpExe.TryGetAnnotationAsObjectList<ServiceProducerAnnotation>(CustomResource.ServiceProducerAnnotation, out var spAnnList));
// Port and target port set (MUST be the same).
// Clients connect directly to the program, MAY have the program port injected.
// Program uses TargetPort, which MAY be injected via env var / startup param.
var svc = kubernetesService.CreatedResources.OfType<Service>().Single(s => s.Name() == "CoolProgram");
Assert.Equal(AddressAllocationModes.Proxyless, svc.Spec.AddressAllocationMode);
Assert.Equal(desiredPort, svc.Status?.EffectivePort);
// Desired port should be part of the service producer annotation.
Assert.Equal(desiredPort, spAnnList.Single(ann => ann.ServiceName == "CoolProgram").Port);
var envVarVal = dcpExe.Spec.Env?.Single(v => v.Name == "PORT_AND_TARGET_PORT_SET").Value;
Assert.False(string.IsNullOrWhiteSpace(envVarVal));
Assert.Equal(desiredPort, int.Parse(envVarVal, CultureInfo.InvariantCulture));
}
/// <summary>
/// Verifies that applying unsupported endpoint port configuration to non-replicated, proxy-less Executables
/// results in an error
/// </summary>
[Fact]
public async Task UnsupportedEndpointPortsExecutableNotReplicatedProxyless()
{
const int desiredPortOne = TestKubernetesService.StartOfAutoPortRange - 1000;
const int desiredPortTwo = TestKubernetesService.StartOfAutoPortRange - 999;
(Action<IResourceBuilder<ExecutableResource>> AddEndpoint, string ErrorMessageFragment)[] testcases = [
// Note: this configuration (neither Endpoint.Port, nor Endpoint.TargetPort set) COULD be supported as follows:
// Clients connect directly to the program, MAY have the program port injected.
// Program gets autogenerated port that MUST be injected via env var/startup param.
//
// BUT
//
// as of Aspire GA (May 2024) this is not supported due to how Aspire app model consumes autogenerated ports.
// Namely, the Aspire ApplicationExecutor creates Services and waits for Services to have ports allocated (by DCP)
// before creating Executables and Containers that implement these services.
// This does not work for proxy-less Services backed by Executables with auto-generated ports, because these Services
// get their ports from Executables that are backing them, and those Executables, in turn, get their ports when they get started.
// Delaying Executable creation like Aspire ApplicationExecutor does means the Services will never get their ports.
(
er => er.WithEndpoint(name: "NoPortNoTargetPort", env: "NO_PORT_NO_TARGET_PORT", isProxied: false),
"needs to specify a port for endpoint"
),
// Invalid configuration: both Port and TargetPort set, but to different values.
(
er => er.WithEndpoint(name: "PortAndTargetPortSetDifferently", port: desiredPortOne, targetPort: desiredPortTwo, env: "PORT_AND_TARGET_PORT_SET_DIFFERENTLY", isProxied: false),
"has a value of Port property that is different from the value of TargetPort property"
)
];
foreach (var tc in testcases)
{
var builder = DistributedApplication.CreateBuilder();
var exe = builder.AddExecutable("CoolProgram", "cool", Environment.CurrentDirectory, "--alpha", "--bravo");
tc.AddEndpoint(exe);
var kubernetesService = new TestKubernetesService();
using var app = builder.Build();
var distributedAppModel = app.Services.GetRequiredService<DistributedApplicationModel>();
var appExecutor = CreateAppExecutor(distributedAppModel, app.Services, kubernetesService: kubernetesService);
var exception = await Assert.ThrowsAsync<InvalidOperationException>(() => appExecutor.RunApplicationAsync());
Assert.Contains(tc.ErrorMessageFragment, exception.Message);
}
}
[Theory]
[InlineData(1, "ServiceA")]
[InlineData(2, "ServiceA-suffix")]
public async Task EndpointOtelServiceName(int replicaCount, string expectedName)
{
var builder = DistributedApplication.CreateBuilder(new DistributedApplicationOptions
{
AssemblyName = typeof(DistributedApplicationTests).Assembly.FullName
});
builder.AddProject<Projects.ServiceA>("ServiceA")
.WithReplicas(replicaCount);
var kubernetesService = new TestKubernetesService();
using var app = builder.Build();
var distributedAppModel = app.Services.GetRequiredService<DistributedApplicationModel>();
var dcpOptions = new DcpOptions { DashboardPath = "./dashboard", ResourceNameSuffix = "suffix" };
var appExecutor = CreateAppExecutor(distributedAppModel, app.Services, kubernetesService: kubernetesService, dcpOptions: dcpOptions);
await appExecutor.RunApplicationAsync();
var ers = Assert.Single(kubernetesService.CreatedResources.OfType<ExecutableReplicaSet>());
Assert.Equal(expectedName, ers.Spec?.Template.Annotations?[CustomResource.OtelServiceNameAnnotation]);
}
[Fact]
public async Task ResourceLogging_MultipleStreams_StreamedOverTime()
{
var builder = DistributedApplication.CreateBuilder(new DistributedApplicationOptions
{
AssemblyName = typeof(DistributedApplicationTests).Assembly.FullName
});
builder.AddContainer("database", "image");
var logStreamPipesChannel = Channel.CreateUnbounded<(string Type, Pipe Pipe)>();
var kubernetesService = new TestKubernetesService(startStream: (obj, logStreamType) =>
{
var s = new Pipe();
if (!logStreamPipesChannel.Writer.TryWrite((logStreamType, s)))
{
Assert.Fail("Pipe channel unexpectedly closed.");
}
return s.Reader.AsStream();
});
using var app = builder.Build();
var distributedAppModel = app.Services.GetRequiredService<DistributedApplicationModel>();
var dcpOptions = new DcpOptions { DashboardPath = "./dashboard" };
var resourceLoggerService = new ResourceLoggerService();
var appExecutor = CreateAppExecutor(distributedAppModel, app.Services, kubernetesService: kubernetesService, dcpOptions: dcpOptions, resourceLoggerService: resourceLoggerService);
await appExecutor.RunApplicationAsync();
var exeResource = Assert.Single(kubernetesService.CreatedResources.OfType<Container>());
// Start watching logs for container.
var watchCts = new CancellationTokenSource();
var watchSubscribers = resourceLoggerService.WatchAnySubscribersAsync();
var watchSubscribersEnumerator = watchSubscribers.GetAsyncEnumerator();
var watchLogs = resourceLoggerService.WatchAsync(exeResource.Metadata.Name);
var watchLogsEnumerator = watchLogs.GetAsyncEnumerator(watchCts.Token);
var moveNextTask = watchLogsEnumerator.MoveNextAsync().AsTask();
Assert.False(moveNextTask.IsCompletedSuccessfully, "No logs yet.");
await watchSubscribersEnumerator.MoveNextAsync();
Assert.Equal(exeResource.Metadata.Name, watchSubscribersEnumerator.Current.Name);
Assert.True(watchSubscribersEnumerator.Current.AnySubscribers);
exeResource.Status = new ContainerStatus { State = ContainerState.Running };
kubernetesService.PushResourceModified(exeResource);
var pipes = await GetStreamPipesAsync(logStreamPipesChannel);
// Write content to container output stream. This is read by logging and creates log lines.
await pipes.StandardOut.Writer.WriteAsync(Encoding.UTF8.GetBytes("2024-08-19T06:10:33.473275911Z Hello world" + Environment.NewLine));
Assert.True(await moveNextTask);
var logLine = watchLogsEnumerator.Current.Single();
Assert.Equal("2024-08-19T06:10:33.4732759Z Hello world", logLine.Content);
Assert.Equal(1, logLine.LineNumber);
Assert.False(logLine.IsErrorMessage);
moveNextTask = watchLogsEnumerator.MoveNextAsync().AsTask();
Assert.False(moveNextTask.IsCompletedSuccessfully, "No logs yet.");
// Note: This console log is earlier than the previous, but logs are displayed in real time as they're available.
await pipes.StandardErr.Writer.WriteAsync(Encoding.UTF8.GetBytes("2024-08-19T06:10:32.661Z Next" + Environment.NewLine));
Assert.True(await moveNextTask);
logLine = watchLogsEnumerator.Current.Single();
Assert.Equal("2024-08-19T06:10:32.6610000Z Next", logLine.Content);
Assert.Equal(2, logLine.LineNumber);
Assert.True(logLine.IsErrorMessage);
var loggerState = resourceLoggerService.GetResourceLoggerState(exeResource.Metadata.Name);
Assert.Collection(loggerState.GetBacklogSnapshot(),
l => Assert.Equal("Next", l.Content),
l => Assert.Equal("Hello world", l.Content));
// Stop watching.
moveNextTask = watchLogsEnumerator.MoveNextAsync().AsTask();
watchCts.Cancel();
await Assert.ThrowsAnyAsync<OperationCanceledException>(async () => await moveNextTask);
await watchSubscribersEnumerator.MoveNextAsync();
Assert.Equal(exeResource.Metadata.Name, watchSubscribersEnumerator.Current.Name);
Assert.False(watchSubscribersEnumerator.Current.AnySubscribers);
// State is clear when no longer watching.
await AsyncTestHelpers.AssertIsTrueRetryAsync(
() => loggerState.GetBacklogSnapshot().Length == 0,
"Backlog is asyncronously cleared after watch ends.");
}
[Fact]
public async Task ResourceLogging_ReplayBacklog_SentInBatch()
{
var builder = DistributedApplication.CreateBuilder(new DistributedApplicationOptions
{
AssemblyName = typeof(DistributedApplicationTests).Assembly.FullName
});
builder.AddContainer("database", "image");
var kubernetesService = new TestKubernetesService(startStream: (obj, logStreamType) =>
{
switch (logStreamType)
{
case Logs.StreamTypeStdOut:
return new MemoryStream(Encoding.UTF8.GetBytes("2024-08-19T06:10:01.000Z First" + Environment.NewLine));
case Logs.StreamTypeStdErr:
return new MemoryStream(Encoding.UTF8.GetBytes("2024-08-19T06:10:02.000Z Second" + Environment.NewLine));
case Logs.StreamTypeStartupStdOut:
return new MemoryStream(Encoding.UTF8.GetBytes("2024-08-19T06:10:03.000Z Third" + Environment.NewLine));
case Logs.StreamTypeStartupStdErr:
return new MemoryStream(Encoding.UTF8.GetBytes(
"2024-08-19T06:10:05.000Z Sixth" + Environment.NewLine +
"2024-08-19T06:10:05.000Z Seventh" + Environment.NewLine +
"2024-08-19T06:10:04.000Z Forth" + Environment.NewLine +
"2024-08-19T06:10:04.000Z Fifth" + Environment.NewLine));
default:
throw new InvalidOperationException("Unexpected type: " + logStreamType);
}
});
using var app = builder.Build();
var distributedAppModel = app.Services.GetRequiredService<DistributedApplicationModel>();
var dcpOptions = new DcpOptions { DashboardPath = "./dashboard" };
var resourceLoggerService = new ResourceLoggerService();
var appExecutor = CreateAppExecutor(distributedAppModel, app.Services, kubernetesService: kubernetesService, dcpOptions: dcpOptions, resourceLoggerService: resourceLoggerService);
await appExecutor.RunApplicationAsync();
var exeResource = Assert.Single(kubernetesService.CreatedResources.OfType<Container>());
// Start watching logs for container.
var watchCts = new CancellationTokenSource();
var watchSubscribers = resourceLoggerService.WatchAnySubscribersAsync();
var watchSubscribersEnumerator = watchSubscribers.GetAsyncEnumerator();
var watchLogs1 = resourceLoggerService.WatchAsync(exeResource.Metadata.Name);
var watchLogsTask1 = ConsoleLoggingTestHelpers.WatchForLogsAsync(watchLogs1, targetLogCount: 7);
Assert.False(watchLogsTask1.IsCompletedSuccessfully, "Logs not available yet.");
await watchSubscribersEnumerator.MoveNextAsync();
Assert.Equal(exeResource.Metadata.Name, watchSubscribersEnumerator.Current.Name);
Assert.True(watchSubscribersEnumerator.Current.AnySubscribers);
exeResource.Status = new ContainerStatus { State = ContainerState.Running };
kubernetesService.PushResourceModified(exeResource);
var watchLogsResults1 = await watchLogsTask1;
Assert.Equal(7, watchLogsResults1.Count);
Assert.Contains(watchLogsResults1, l => l.Content.Contains("First"));
Assert.Contains(watchLogsResults1, l => l.Content.Contains("Second"));
Assert.Contains(watchLogsResults1, l => l.Content.Contains("Third"));
Assert.Contains(watchLogsResults1, l => l.Content.Contains("Forth"));
Assert.Contains(watchLogsResults1, l => l.Content.Contains("Fifth"));
Assert.Contains(watchLogsResults1, l => l.Content.Contains("Sixth"));
Assert.Contains(watchLogsResults1, l => l.Content.Contains("Seventh"));
var watchLogs2 = resourceLoggerService.WatchAsync(exeResource.Metadata.Name);
var watchLogsTask2 = ConsoleLoggingTestHelpers.WatchForLogsAsync(watchLogs2, targetLogCount: 7);
var watchLogsResults2 = await watchLogsTask2;
Assert.Contains(watchLogsResults2, l => l.Content.Contains("First"));
Assert.Contains(watchLogsResults2, l => l.Content.Contains("Second"));
Assert.Contains(watchLogsResults2, l => l.Content.Contains("Third"));
Assert.Contains(watchLogsResults2, l => l.Content.Contains("Forth"));
Assert.Contains(watchLogsResults2, l => l.Content.Contains("Fifth"));
Assert.Contains(watchLogsResults2, l => l.Content.Contains("Sixth"));
Assert.Contains(watchLogsResults2, l => l.Content.Contains("Seventh"));
}
private sealed class LogStreamPipes
{
public Pipe StandardOut { get; set; } = default!;
public Pipe StandardErr { get; set; } = default!;
public Pipe StartupOut { get; set; } = default!;
public Pipe StartupErr { get; set; } = default!;
}
private static async Task<LogStreamPipes> GetStreamPipesAsync(Channel<(string Type, Pipe Pipe)> logStreamPipesChannel)
{
var pipeCount = 0;
var result = new LogStreamPipes();
await foreach (var item in logStreamPipesChannel.Reader.ReadAllAsync())
{
switch (item.Type)
{
case Logs.StreamTypeStdOut:
result.StandardOut = item.Pipe;
break;
case Logs.StreamTypeStdErr:
result.StandardErr = item.Pipe;
break;
case Logs.StreamTypeStartupStdOut:
result.StartupOut = item.Pipe;
break;
case Logs.StreamTypeStartupStdErr:
result.StartupErr = item.Pipe;
break;
default:
throw new InvalidOperationException("Unexpected type: " + item.Type);
}
pipeCount++;
if (pipeCount == 4)
{
logStreamPipesChannel.Writer.Complete();
}
}
return result;
}
[Fact]
public async Task EndpointPortsProjectNoPortNoTargetPort()
{
var builder = DistributedApplication.CreateBuilder(new DistributedApplicationOptions
{
AssemblyName = typeof(DistributedApplicationTests).Assembly.FullName
});
builder.AddProject<Projects.ServiceA>("ServiceA")
.WithEndpoint(name: "NoPortNoTargetPort", env: "NO_PORT_NO_TARGET_PORT", isProxied: true)
.WithHttpEndpoint(name: "hp1", port: 5001)
.WithHttpEndpoint(name: "dontinjectme", port: 5002)
.WithEndpointsInEnvironment(e => e.Name != "dontinjectme")
.WithReplicas(3);
var kubernetesService = new TestKubernetesService();
using var app = builder.Build();
var distributedAppModel = app.Services.GetRequiredService<DistributedApplicationModel>();
var appExecutor = CreateAppExecutor(distributedAppModel, app.Services, kubernetesService: kubernetesService);
await appExecutor.RunApplicationAsync();
var ers = Assert.Single(kubernetesService.CreatedResources.OfType<ExecutableReplicaSet>());
Assert.True(ers.Spec.Template.TryGetAnnotationAsObjectList<ServiceProducerAnnotation>(CustomResource.ServiceProducerAnnotation, out var spAnnList));
// Neither Port, nor TargetPort are set
// Clients use proxy, MAY have the proxy port injected.
// Proxy gets autogenerated port.
// Each replica gets a different autogenerated port that MUST be injected via env var/startup param.
var svc = kubernetesService.CreatedResources.OfType<Service>().Single(s => s.Name() == "ServiceA-NoPortNoTargetPort");
Assert.Equal(AddressAllocationModes.Localhost, svc.Spec.AddressAllocationMode);
Assert.True(svc.Status?.EffectivePort >= TestKubernetesService.StartOfAutoPortRange);
Assert.True(spAnnList.Single(ann => ann.ServiceName == "ServiceA-NoPortNoTargetPort").Port is null,
"Expected service producer (target) port to not be set (leave allocation to DCP)");
var envVarVal = ers.Spec.Template.Spec.Env?.Single(v => v.Name == "NO_PORT_NO_TARGET_PORT").Value;
Assert.False(string.IsNullOrWhiteSpace(envVarVal));
Assert.Contains("""portForServing "ServiceA-NoPortNoTargetPort" """, envVarVal);
// ASPNETCORE_URLS should not include dontinjectme, as it was excluded using WithEndpointsInEnvironment
var aspnetCoreUrls = ers.Spec.Template.Spec.Env?.Single(v => v.Name == "ASPNETCORE_URLS").Value;
Assert.Equal("http://localhost:{{- portForServing \"ServiceA-http\" -}};http://localhost:{{- portForServing \"ServiceA-hp1\" -}}", aspnetCoreUrls);
}
[Fact]
public async Task EndpointPortsProjectPortSetNoTargetPort()
{
var builder = DistributedApplication.CreateBuilder(new DistributedApplicationOptions
{
AssemblyName = typeof(DistributedApplicationTests).Assembly.FullName
});
const int desiredPortOne = TestKubernetesService.StartOfAutoPortRange - 1000;
builder.AddProject<Projects.ServiceA>("ServiceA")
.WithEndpoint(name: "PortSetNoTargetPort", port: desiredPortOne, env: "PORT_SET_NO_TARGET_PORT", isProxied: true)
.WithReplicas(3);
var kubernetesService = new TestKubernetesService();
using var app = builder.Build();
var distributedAppModel = app.Services.GetRequiredService<DistributedApplicationModel>();
var appExecutor = CreateAppExecutor(distributedAppModel, app.Services, kubernetesService: kubernetesService);
await appExecutor.RunApplicationAsync();
var ers = Assert.Single(kubernetesService.CreatedResources.OfType<ExecutableReplicaSet>());
Assert.True(ers.Spec.Template.TryGetAnnotationAsObjectList<ServiceProducerAnnotation>(CustomResource.ServiceProducerAnnotation, out var spAnnList));
// Port is set, but TargetPort is empty.
// Clients use proxy, MAY have the proxy port injected.
// Proxy uses Port.
// Each replica gets a different autogenerated port that MUST be injected via env var/startup param.
var svc = kubernetesService.CreatedResources.OfType<Service>().Single(s => s.Name() == "ServiceA-PortSetNoTargetPort");
Assert.Equal(AddressAllocationModes.Localhost, svc.Spec.AddressAllocationMode);
Assert.Equal(desiredPortOne, svc.Status?.EffectivePort);
Assert.True(spAnnList.Single(ann => ann.ServiceName == "ServiceA-PortSetNoTargetPort").Port is null,
"Expected service producer (target) port to not be set (leave allocation to DCP)");
var envVarVal = ers.Spec.Template.Spec.Env?.Single(v => v.Name == "PORT_SET_NO_TARGET_PORT").Value;
Assert.False(string.IsNullOrWhiteSpace(envVarVal));
Assert.Contains("""portForServing "ServiceA-PortSetNoTargetPort" """, envVarVal);
}
/// <summary>
/// Verifies that applying unsupported endpoint port configuration to a Project resource results in an error.
/// </summary>
/// <remarks>
/// Projects are run by DCP via ExecutableReplicaSet and must use a proxy to enable dynamic scaling.
/// Any Endpoint configuration that does not enable proxying should result in an error.
/// Similarly, specifying a TargetPort is not supported because each replica must get a distinct port.
/// </remarks>
[Fact]
public async Task UnsupportedEndpointPortsProject()
{
const int desiredPortOne = TestKubernetesService.StartOfAutoPortRange - 1000;
const int desiredPortTwo = TestKubernetesService.StartOfAutoPortRange - 999;
const int desiredPortThree = TestKubernetesService.StartOfAutoPortRange - 998;
(Action<IResourceBuilder<ProjectResource>> AddEndpoint, string ErrorMessageFragment)[] testcases = [
// Invalid configuration: TargetPort is set (Port left empty).
(
pr => pr.WithEndpoint(name: "NoPortTargetPortSet", targetPort: desiredPortOne, env: "NO_PORT_TARGET_PORT_SET", isProxied: true),
"setting TargetPort is not allowed"
),
// Invalid configuration: both TargetPort and Port are set.
(
pr => pr.WithEndpoint(name: "PortAndTargetPortSet", port: desiredPortTwo, targetPort: desiredPortThree, env: "PORT_AND_TARGET_PORT_SET", isProxied: true),
"setting TargetPort is not allowed"
),
// Invalid configuration: proxy-less endpoints and (replicated) projects do not work together
(
pr => pr.WithEndpoint(name: "NoPortNoTargetPort", env: "NO_PORT_NO_TARGET_PORT", isProxied: false),
"features do not work together"
)
];
foreach (var tc in testcases)
{
var builder = DistributedApplication.CreateBuilder(new DistributedApplicationOptions
{
AssemblyName = typeof(DistributedApplicationTests).Assembly.FullName
});
// Invalid configuration: TargetPort is set (Port left empty).
var pr = builder.AddProject<Projects.ServiceA>("ServiceA");
tc.AddEndpoint(pr);
pr.WithReplicas(3);
var kubernetesService = new TestKubernetesService();
using var app = builder.Build();
var distributedAppModel = app.Services.GetRequiredService<DistributedApplicationModel>();
var appExecutor = CreateAppExecutor(distributedAppModel, app.Services, kubernetesService: kubernetesService);
var exception = await Assert.ThrowsAsync<InvalidOperationException>(() => appExecutor.RunApplicationAsync());
Assert.Contains(tc.ErrorMessageFragment, exception.Message);
}
}
[Fact]
public async Task EndpointPortsConainerProxiedNoPortTargetPortSet()
{
var builder = DistributedApplication.CreateBuilder();
const int desiredTargetPort = TestKubernetesService.StartOfAutoPortRange - 999;
builder.AddContainer("database", "image")
.WithEndpoint(name: "NoPortTargetPortSet", targetPort: desiredTargetPort, env: "NO_PORT_TARGET_PORT_SET", isProxied: true);
var kubernetesService = new TestKubernetesService();
using var app = builder.Build();
var distributedAppModel = app.Services.GetRequiredService<DistributedApplicationModel>();
var appExecutor = CreateAppExecutor(distributedAppModel, app.Services, kubernetesService: kubernetesService);
await appExecutor.RunApplicationAsync();
var dcpCtr = Assert.Single(kubernetesService.CreatedResources.OfType<Container>());
Assert.True(dcpCtr.TryGetAnnotationAsObjectList<ServiceProducerAnnotation>(CustomResource.ServiceProducerAnnotation, out var spAnnList));
// Port is empty, TargetPort is set
// Clients use proxy, MAY have the proxy port injected.
// Proxy gets autogenerated port.
// Container is using TargetPort inside the container. Container host port is auto-allocated by Docker/Podman.
var svc = kubernetesService.CreatedResources.OfType<Service>().Single(s => s.Name() == "database");
Assert.Equal(AddressAllocationModes.Localhost, svc.Spec.AddressAllocationMode);
Assert.True(svc.Status?.EffectivePort >= TestKubernetesService.StartOfAutoPortRange);
Assert.NotNull(dcpCtr.Spec.Ports);
Assert.Contains(dcpCtr.Spec.Ports!, p => p.HostPort is null && p.ContainerPort == desiredTargetPort);
// Desired port should be part of the service producer annotation.
Assert.Equal(desiredTargetPort, spAnnList.Single(ann => ann.ServiceName == "database").Port);
var envVarVal = dcpCtr.Spec.Env?.Single(v => v.Name == "NO_PORT_TARGET_PORT_SET").Value;
Assert.False(string.IsNullOrWhiteSpace(envVarVal));
Assert.Equal(desiredTargetPort, int.Parse(envVarVal, CultureInfo.InvariantCulture));
}
[Fact]
public async Task EndpointPortsConainerProxiedPortAndTargetPortSet()
{
var builder = DistributedApplication.CreateBuilder();
const int desiredPort = TestKubernetesService.StartOfAutoPortRange - 998;
const int desiredTargetPort = TestKubernetesService.StartOfAutoPortRange - 997;
builder.AddContainer("database", "image")
.WithEndpoint(name: "PortAndTargetPortSet", port: desiredPort, targetPort: desiredTargetPort, env: "PORT_AND_TARGET_PORT_SET", isProxied: true);
var kubernetesService = new TestKubernetesService();
using var app = builder.Build();
var distributedAppModel = app.Services.GetRequiredService<DistributedApplicationModel>();
var appExecutor = CreateAppExecutor(distributedAppModel, app.Services, kubernetesService: kubernetesService);
await appExecutor.RunApplicationAsync();
var dcpCtr = Assert.Single(kubernetesService.CreatedResources.OfType<Container>());
Assert.True(dcpCtr.TryGetAnnotationAsObjectList<ServiceProducerAnnotation>(CustomResource.ServiceProducerAnnotation, out var spAnnList));
// Port and TargetPort are set.
// Clients use proxy, MAY have the proxy port injected.
// Proxy uses Port.
// Container is using TargetPort inside the container. Container host port is auto-allocated by Docker/Podman.
var svc = kubernetesService.CreatedResources.OfType<Service>().Single(s => s.Name() == "database");
Assert.Equal(AddressAllocationModes.Localhost, svc.Spec.AddressAllocationMode);
Assert.Equal(desiredPort, svc.Status?.EffectivePort);
Assert.NotNull(dcpCtr.Spec.Ports);
Assert.Contains(dcpCtr.Spec.Ports!, p => p.HostPort is null && p.ContainerPort == desiredTargetPort);
// Desired port should be part of the service producer annotation.
Assert.Equal(desiredTargetPort, spAnnList.Single(ann => ann.ServiceName == "database").Port);
var envVarVal = dcpCtr.Spec.Env?.Single(v => v.Name == "PORT_AND_TARGET_PORT_SET").Value;
Assert.False(string.IsNullOrWhiteSpace(envVarVal));
Assert.Equal(desiredTargetPort, int.Parse(envVarVal, CultureInfo.InvariantCulture));
}
/// <summary>
/// Verifies that applying unsupported endpoint port configuration to Containers results in an error.
/// </summary>
[Fact]
public async Task UnsupportedEndpointPortsContainer()
{
const int desiredPortOne = TestKubernetesService.StartOfAutoPortRange - 1000;
(Action<IResourceBuilder<ContainerResource>> AddEndpoint, string ErrorMessageFragment)[] testcases = [
// Invalid configuration: TargetPort is empty (and Port too) (proxied).
(
cr => cr.WithEndpoint(name: "NoPortNoTargetPortProxied", env: "NO_PORT_NO_TARGET_PORT_PROXIED", isProxied: true),
"must specify the TargetPort"
),
// Invalid configuration: TargetPort is empty (Port is set but it should not matter) (proxied).
(
cr => cr.WithEndpoint(name: "PortSetNoTargetPort", port: desiredPortOne, env: "PORT_SET_NO_TARGET_PORT", isProxied: true),
"must specify the TargetPort"
),
// Invalid configuration: TargetPort is empty (and Port too) (proxy-less).
(
cr => cr.WithEndpoint(name: "NoPortNoTargetPortProxyless", env: "NO_PORT_NO_TARGET_PORT_PROXYLESS", isProxied: false),
"must specify the TargetPort"
),
];
foreach (var tc in testcases)
{
var builder = DistributedApplication.CreateBuilder();
var ctr = builder.AddContainer("database", "image");
tc.AddEndpoint(ctr);
var kubernetesService = new TestKubernetesService();
using var app = builder.Build();
var distributedAppModel = app.Services.GetRequiredService<DistributedApplicationModel>();
var appExecutor = CreateAppExecutor(distributedAppModel, app.Services, kubernetesService: kubernetesService);
var exception = await Assert.ThrowsAsync<InvalidOperationException>(() => appExecutor.RunApplicationAsync());
Assert.Contains(tc.ErrorMessageFragment, exception.Message);
}
}
[Fact]
public async Task EndpointPortsContainerProxylessPortSetNoTargetPort()
{
var builder = DistributedApplication.CreateBuilder();
const int desiredPort = TestKubernetesService.StartOfAutoPortRange - 1000;
builder.AddContainer("database", "image")
.WithEndpoint(name: "PortSetNoTargetPort", port: desiredPort, env: "PORT_SET_NO_TARGET_PORT", isProxied: false);
// All these configurations are effectively the same because EndpointAnnotation constructor for proxy-less endpoints
// will make sure Port and TargetPort have the same value if one is specified but the other is not.
var kubernetesService = new TestKubernetesService();
using var app = builder.Build();
var distributedAppModel = app.Services.GetRequiredService<DistributedApplicationModel>();
var appExecutor = CreateAppExecutor(distributedAppModel, app.Services, kubernetesService: kubernetesService);
await appExecutor.RunApplicationAsync();
var dcpCtr = Assert.Single(kubernetesService.CreatedResources.OfType<Container>());
Assert.True(dcpCtr.TryGetAnnotationAsObjectList<ServiceProducerAnnotation>(CustomResource.ServiceProducerAnnotation, out var spAnnList));
// Neither Port, nor TargetPort are set.
// Clients connect directly to the container host port, MAY have the container host port injected.
// Container is using TargetPort for BOTH listening inside the container and as a host port.
var svc = kubernetesService.CreatedResources.OfType<Service>().Single(s => s.Name() == "database");
Assert.Equal(AddressAllocationModes.Proxyless, svc.Spec.AddressAllocationMode);
Assert.Equal(desiredPort, svc.Status?.EffectivePort);
Assert.NotNull(dcpCtr.Spec.Ports);
Assert.Contains(dcpCtr.Spec.Ports!, p => p.HostPort == desiredPort && p.ContainerPort == desiredPort);
// Desired port should be part of the service producer annotation.
Assert.Equal(desiredPort, spAnnList.Single(ann => ann.ServiceName == "database").Port);
var envVarVal = dcpCtr.Spec.Env?.Single(v => v.Name == "PORT_SET_NO_TARGET_PORT").Value;
Assert.False(string.IsNullOrWhiteSpace(envVarVal));
Assert.Equal(desiredPort, int.Parse(envVarVal, CultureInfo.InvariantCulture));
}
[Fact]
public async Task EndpointPortsContainerProxylessNoPortTargetPortSet()
{
var builder = DistributedApplication.CreateBuilder();
const int desiredTargetPort = TestKubernetesService.StartOfAutoPortRange - 999;
builder.AddContainer("database", "image")
.WithEndpoint(name: "NoPortTargetPortSet", targetPort: desiredTargetPort, env: "NO_PORT_TARGET_PORT_SET", isProxied: false);
// All these configurations are effectively the same because EndpointAnnotation constructor for proxy-less endpoints
// will make sure Port and TargetPort have the same value if one is specified but the other is not.
var kubernetesService = new TestKubernetesService();
using var app = builder.Build();
var distributedAppModel = app.Services.GetRequiredService<DistributedApplicationModel>();
var appExecutor = CreateAppExecutor(distributedAppModel, app.Services, kubernetesService: kubernetesService);
await appExecutor.RunApplicationAsync();
var dcpCtr = Assert.Single(kubernetesService.CreatedResources.OfType<Container>());
Assert.True(dcpCtr.TryGetAnnotationAsObjectList<ServiceProducerAnnotation>(CustomResource.ServiceProducerAnnotation, out var spAnnList));
// Port is empty, TargetPort is set
// Clients connect directly to the container host port, MAY have the container host port injected.
// Container is using TargetPort for BOTH listening inside the container and as a host port.
var svc = kubernetesService.CreatedResources.OfType<Service>().Single(s => s.Name() == "database");
Assert.Equal(AddressAllocationModes.Proxyless, svc.Spec.AddressAllocationMode);
Assert.Equal(desiredTargetPort, svc.Status?.EffectivePort);
Assert.NotNull(dcpCtr.Spec.Ports);
Assert.Contains(dcpCtr.Spec.Ports!, p => p.HostPort == desiredTargetPort && p.ContainerPort == desiredTargetPort);
// Desired port should be part of the service producer annotation.
Assert.Equal(desiredTargetPort, spAnnList.Single(ann => ann.ServiceName == "database").Port);
var envVarVal = dcpCtr.Spec.Env?.Single(v => v.Name == "NO_PORT_TARGET_PORT_SET").Value;
Assert.False(string.IsNullOrWhiteSpace(envVarVal));
Assert.Equal(desiredTargetPort, int.Parse(envVarVal, CultureInfo.InvariantCulture));
}
[Fact]
public async Task EndpointPortsContainerProxylessPortAndTargetPortSet()
{
var builder = DistributedApplication.CreateBuilder();
const int desiredPort = TestKubernetesService.StartOfAutoPortRange - 998;
const int desiredTargetPort = TestKubernetesService.StartOfAutoPortRange - 997;
builder.AddContainer("database", "image")
.WithEndpoint(name: "PortAndTargetPortSet", port: desiredPort, targetPort: desiredTargetPort, env: "PORT_AND_TARGET_PORT_SET", isProxied: false);
// All these configurations are effectively the same because EndpointAnnotation constructor for proxy-less endpoints
// will make sure Port and TargetPort have the same value if one is specified but the other is not.
var kubernetesService = new TestKubernetesService();
using var app = builder.Build();
var distributedAppModel = app.Services.GetRequiredService<DistributedApplicationModel>();
var appExecutor = CreateAppExecutor(distributedAppModel, app.Services, kubernetesService: kubernetesService);
await appExecutor.RunApplicationAsync();
var dcpCtr = Assert.Single(kubernetesService.CreatedResources.OfType<Container>());
Assert.True(dcpCtr.TryGetAnnotationAsObjectList<ServiceProducerAnnotation>(CustomResource.ServiceProducerAnnotation, out var spAnnList));
// Port and TargetPort are set.
// Clients connect directly to the container host port, MAY have the container host port injected.
// Container is using TargetPort for listening inside the container and the Port as the host port.
var svc = kubernetesService.CreatedResources.OfType<Service>().Single(s => s.Name() == "database");
Assert.Equal(AddressAllocationModes.Proxyless, svc.Spec.AddressAllocationMode);
Assert.Equal(desiredPort, svc.Status?.EffectivePort);
Assert.NotNull(dcpCtr.Spec.Ports);
Assert.Contains(dcpCtr.Spec.Ports!, p => p.HostPort == desiredPort && p.ContainerPort == desiredTargetPort);
// Desired port should be part of the service producer annotation.
Assert.Equal(desiredTargetPort, spAnnList.Single(ann => ann.ServiceName == "database").Port);
var envVarVal = dcpCtr.Spec.Env?.Single(v => v.Name == "PORT_AND_TARGET_PORT_SET").Value;
Assert.False(string.IsNullOrWhiteSpace(envVarVal));
Assert.Equal(desiredTargetPort, int.Parse(envVarVal, CultureInfo.InvariantCulture));
}
private static ApplicationExecutor CreateAppExecutor(
DistributedApplicationModel distributedAppModel,
IServiceProvider serviceProvider,
IConfiguration? configuration = null,
IKubernetesService? kubernetesService = null,
DcpOptions? dcpOptions = null,
ResourceLoggerService? resourceLoggerService = null)
{
if (configuration == null)
{
var builder = new ConfigurationBuilder();
builder.AddInMemoryCollection(new Dictionary<string, string?>
{
["DOTNET_DASHBOARD_OTLP_ENDPOINT_URL"] = "http://localhost",
["AppHost:BrowserToken"] = "TestBrowserToken!",
["AppHost:OtlpApiKey"] = "TestOtlpApiKey!"
});
configuration = builder.Build();
}
return new ApplicationExecutor(
NullLogger<ApplicationExecutor>.Instance,
NullLogger<DistributedApplication>.Instance,
distributedAppModel,
kubernetesService ?? new TestKubernetesService(),
Array.Empty<IDistributedApplicationLifecycleHook>(),
configuration,
new DistributedApplicationOptions(),
Options.Create(dcpOptions ?? new DcpOptions { DashboardPath = "./dashboard" }),
new DistributedApplicationExecutionContext(new DistributedApplicationExecutionContextOptions(DistributedApplicationOperation.Run)
{
ServiceProvider = TestServiceProvider.Instance
}),
new ResourceNotificationService(new NullLogger<ResourceNotificationService>(), new TestHostApplicationLifetime()),
resourceLoggerService ?? new ResourceLoggerService(),
new TestDcpDependencyCheckService(),
new DistributedApplicationEventing(),
serviceProvider
);
}
private sealed class TestHostApplicationLifetime : IHostApplicationLifetime
{
public CancellationToken ApplicationStarted { get; }
public CancellationToken ApplicationStopped { get; }
public CancellationToken ApplicationStopping { get; }
public void StopApplication()
{
throw new NotImplementedException();
}
}
}
|