|
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
using System.Net.Sockets;
using Aspire.Hosting.ApplicationModel;
using Aspire.Hosting.Tests.Utils;
using Aspire.Hosting.Utils;
using Microsoft.Extensions.DependencyInjection;
using Xunit;
namespace Aspire.Hosting.Valkey.Tests;
public class AddValkeyTests
{
[Fact]
public void AddValkeyContainerWithDefaultsAddsAnnotationMetadata()
{
var appBuilder = DistributedApplication.CreateBuilder();
appBuilder.AddValkey("myValkey").PublishAsContainer();
using var app = appBuilder.Build();
var appModel = app.Services.GetRequiredService<DistributedApplicationModel>();
var containerResource = Assert.Single(appModel.Resources.OfType<ValkeyResource>());
Assert.Equal("myValkey", containerResource.Name);
var endpoint = Assert.Single(containerResource.Annotations.OfType<EndpointAnnotation>());
Assert.Equal(6379, endpoint.TargetPort);
Assert.False(endpoint.IsExternal);
Assert.Equal("tcp", endpoint.Name);
Assert.Null(endpoint.Port);
Assert.Equal(ProtocolType.Tcp, endpoint.Protocol);
Assert.Equal("tcp", endpoint.Transport);
Assert.Equal("tcp", endpoint.UriScheme);
var containerAnnotation = Assert.Single(containerResource.Annotations.OfType<ContainerImageAnnotation>());
Assert.Equal(ValkeyContainerImageTags.Tag, containerAnnotation.Tag);
Assert.Equal(ValkeyContainerImageTags.Image, containerAnnotation.Image);
Assert.Equal(ValkeyContainerImageTags.Registry, containerAnnotation.Registry);
}
[Fact]
public void AddValkeyContainerAddsAnnotationMetadata()
{
var appBuilder = DistributedApplication.CreateBuilder();
appBuilder.AddValkey("myValkey", port: 8813);
using var app = appBuilder.Build();
var appModel = app.Services.GetRequiredService<DistributedApplicationModel>();
var containerResource = Assert.Single(appModel.Resources.OfType<ValkeyResource>());
Assert.Equal("myValkey", containerResource.Name);
var endpoint = Assert.Single(containerResource.Annotations.OfType<EndpointAnnotation>());
Assert.Equal(6379, endpoint.TargetPort);
Assert.False(endpoint.IsExternal);
Assert.Equal("tcp", endpoint.Name);
Assert.Equal(8813, endpoint.Port);
Assert.Equal(ProtocolType.Tcp, endpoint.Protocol);
Assert.Equal("tcp", endpoint.Transport);
Assert.Equal("tcp", endpoint.UriScheme);
var containerAnnotation = Assert.Single(containerResource.Annotations.OfType<ContainerImageAnnotation>());
Assert.Equal(ValkeyContainerImageTags.Tag, containerAnnotation.Tag);
Assert.Equal(ValkeyContainerImageTags.Image, containerAnnotation.Image);
Assert.Equal(ValkeyContainerImageTags.Registry, containerAnnotation.Registry);
}
[Fact]
public async Task ValkeyCreatesConnectionStringWithDefaultPassword()
{
var appBuilder = DistributedApplication.CreateBuilder();
appBuilder.AddValkey("myValkey")
.WithEndpoint("tcp", e => e.AllocatedEndpoint = new AllocatedEndpoint(e, "localhost", 2000));
await using var app = appBuilder.Build();
var appModel = app.Services.GetRequiredService<DistributedApplicationModel>();
var connectionStringResource = Assert.Single(appModel.Resources.OfType<IResourceWithConnectionString>());
var connectionString = await connectionStringResource.GetConnectionStringAsync(default);
Assert.Equal("{myValkey.bindings.tcp.host}:{myValkey.bindings.tcp.port},password={myValkey-password.value}", connectionStringResource.ConnectionStringExpression.ValueExpression);
Assert.StartsWith("localhost:2000", connectionString);
}
[Fact]
public void ValkeyCreatesConnectionStringWithPassword()
{
var appBuilder = DistributedApplication.CreateBuilder();
var password = "p@ssw0rd1";
var pass = appBuilder.AddParameter("pass", password);
appBuilder.AddValkey("myValkey", password: pass);
using var app = appBuilder.Build();
var appModel = app.Services.GetRequiredService<DistributedApplicationModel>();
var connectionStringResource = Assert.Single(appModel.Resources.OfType<IResourceWithConnectionString>());
Assert.Equal("{myValkey.bindings.tcp.host}:{myValkey.bindings.tcp.port},password={pass.value}", connectionStringResource.ConnectionStringExpression.ValueExpression);
}
[Fact]
public void ValkeyCreatesConnectionStringWithPasswordAndPort()
{
var appBuilder = DistributedApplication.CreateBuilder();
var password = "p@ssw0rd1";
var pass = appBuilder.AddParameter("pass", password);
appBuilder.AddValkey("myValkey", port: 3000, password: pass);
using var app = appBuilder.Build();
var appModel = app.Services.GetRequiredService<DistributedApplicationModel>();
var connectionStringResource = Assert.Single(appModel.Resources.OfType<IResourceWithConnectionString>());
Assert.Equal("{myValkey.bindings.tcp.host}:{myValkey.bindings.tcp.port},password={pass.value}", connectionStringResource.ConnectionStringExpression.ValueExpression);
}
[Fact]
public async Task VerifyWithoutPasswordManifest()
{
using var builder = TestDistributedApplicationBuilder.Create();
var valkey = builder.AddValkey("myValkey");
var manifest = await ManifestUtils.GetManifest(valkey.Resource);
var expectedManifest = $$"""
{
"type": "container.v0",
"connectionString": "{myValkey.bindings.tcp.host}:{myValkey.bindings.tcp.port},password={myValkey-password.value}",
"image": "{{ValkeyContainerImageTags.Registry}}/{{ValkeyContainerImageTags.Image}}:{{ValkeyContainerImageTags.Tag}}",
"entrypoint": "/bin/sh",
"args": [
"-c",
"valkey-server --requirepass $VALKEY_PASSWORD"
],
"env": {
"VALKEY_PASSWORD": "{myValkey-password.value}"
},
"bindings": {
"tcp": {
"scheme": "tcp",
"protocol": "tcp",
"transport": "tcp",
"targetPort": 6379
}
}
}
""";
Assert.Equal(expectedManifest, manifest.ToString());
}
[Fact]
public async Task VerifyWithPasswordManifest()
{
using var builder = TestDistributedApplicationBuilder.Create();
var password = "p@ssw0rd1";
builder.Configuration["Parameters:pass"] = password;
var pass = builder.AddParameter("pass");
var valkey = builder.AddValkey("myValkey", password: pass);
var manifest = await ManifestUtils.GetManifest(valkey.Resource);
var expectedManifest = $$"""
{
"type": "container.v0",
"connectionString": "{myValkey.bindings.tcp.host}:{myValkey.bindings.tcp.port},password={pass.value}",
"image": "{{ValkeyContainerImageTags.Registry}}/{{ValkeyContainerImageTags.Image}}:{{ValkeyContainerImageTags.Tag}}",
"entrypoint": "/bin/sh",
"args": [
"-c",
"valkey-server --requirepass $VALKEY_PASSWORD"
],
"env": {
"VALKEY_PASSWORD": "{pass.value}"
},
"bindings": {
"tcp": {
"scheme": "tcp",
"protocol": "tcp",
"transport": "tcp",
"targetPort": 6379
}
}
}
""";
Assert.Equal(expectedManifest, manifest.ToString());
}
[Theory]
[InlineData(null)]
[InlineData(true)]
[InlineData(false)]
public void WithDataVolumeAddsVolumeAnnotation(bool? isReadOnly)
{
using var builder = TestDistributedApplicationBuilder.Create();
var valkey = builder.AddValkey("myValkey");
if (isReadOnly.HasValue)
{
valkey.WithDataVolume(isReadOnly: isReadOnly.Value);
}
else
{
valkey.WithDataVolume();
}
var volumeAnnotation = valkey.Resource.Annotations.OfType<ContainerMountAnnotation>().Single();
Assert.Equal($"{builder.GetVolumePrefix()}-myValkey-data", volumeAnnotation.Source);
Assert.Equal("/data", volumeAnnotation.Target);
Assert.Equal(ContainerMountType.Volume, volumeAnnotation.Type);
Assert.Equal(isReadOnly ?? false, volumeAnnotation.IsReadOnly);
}
[Theory]
[InlineData(null)]
[InlineData(true)]
[InlineData(false)]
public void WithDataBindMountAddsMountAnnotation(bool? isReadOnly)
{
using var builder = TestDistributedApplicationBuilder.Create();
var valkey = builder.AddValkey("myValkeydata");
if (isReadOnly.HasValue)
{
valkey.WithDataBindMount("myValkeydata", isReadOnly: isReadOnly.Value);
}
else
{
valkey.WithDataBindMount("myValkeydata");
}
var volumeAnnotation = valkey.Resource.Annotations.OfType<ContainerMountAnnotation>().Single();
Assert.Equal(Path.Combine(builder.AppHostDirectory, "myValkeydata"), volumeAnnotation.Source);
Assert.Equal("/data", volumeAnnotation.Target);
Assert.Equal(ContainerMountType.BindMount, volumeAnnotation.Type);
Assert.Equal(isReadOnly ?? false, volumeAnnotation.IsReadOnly);
}
[Fact]
public async Task WithDataVolumeAddsPersistenceAnnotation()
{
using var builder = TestDistributedApplicationBuilder.Create();
var valkey = builder.AddValkey("myValkey")
.WithDataVolume();
Assert.True(valkey.Resource.TryGetAnnotationsOfType<CommandLineArgsCallbackAnnotation>(out var argsCallbacks));
var args = await GetCommandLineArgs(valkey);
Assert.Contains("--save 60 1", args);
}
[Fact]
public async Task WithDataVolumeDoesNotAddPersistenceAnnotationIfIsReadOnly()
{
using var builder = TestDistributedApplicationBuilder.Create();
var valkey = builder.AddValkey("myValkey")
.WithDataVolume(isReadOnly: true);
var args = await GetCommandLineArgs(valkey);
Assert.DoesNotContain("--save", args);
}
[Fact]
public async Task WithDataBindMountAddsPersistenceAnnotation()
{
using var builder = TestDistributedApplicationBuilder.Create();
var valkey = builder.AddValkey("myValkey")
.WithDataBindMount("myvalkeydata");
Assert.True(valkey.Resource.TryGetAnnotationsOfType<CommandLineArgsCallbackAnnotation>(out var argsCallbacks));
var args = await GetCommandLineArgs(valkey);
Assert.Contains("--save 60 1", args);
}
[Fact]
public async Task WithDataBindMountDoesNotAddPersistenceAnnotationIfIsReadOnly()
{
using var builder = TestDistributedApplicationBuilder.Create();
var valkey = builder.AddValkey("myValkey")
.WithDataBindMount("myvalkeydata", isReadOnly: true);
var args = await GetCommandLineArgs(valkey);
Assert.DoesNotContain("--save", args);
}
[Fact]
public async Task WithPersistenceReplacesPreviousAnnotationInstances()
{
using var builder = TestDistributedApplicationBuilder.Create();
var valkey = builder.AddValkey("myValkey")
.WithDataVolume()
.WithPersistence(TimeSpan.FromSeconds(10), 2);
Assert.True(valkey.Resource.TryGetAnnotationsOfType<CommandLineArgsCallbackAnnotation>(out var argsCallbacks));
var args = await GetCommandLineArgs(valkey);
Assert.Contains("--save 10 2", args);
// ensure `--save` is not added twice
var saveIndex = args.IndexOf("--save");
Assert.DoesNotContain("--save", args.Substring(saveIndex + 1));
}
[Fact]
public void WithPersistenceAddsCommandLineArgsAnnotation()
{
using var builder = TestDistributedApplicationBuilder.Create();
var valkey = builder.AddValkey("myValkey")
.WithPersistence(TimeSpan.FromSeconds(60));
Assert.True(valkey.Resource.TryGetAnnotationsOfType<CommandLineArgsCallbackAnnotation>(out var argsAnnotations));
Assert.NotNull(argsAnnotations.SingleOrDefault());
}
[Fact]
public async Task AddValkeyContainerWithPasswordAnnotationMetadata()
{
using var builder = TestDistributedApplicationBuilder.Create();
var password = "p@ssw0rd1";
var pass = builder.AddParameter("pass", password);
var valkey = builder.
AddValkey("myValkey", password: pass)
.WithEndpoint("tcp", e => e.AllocatedEndpoint = new AllocatedEndpoint(e, "localhost", 5001));
using var app = builder.Build();
var appModel = app.Services.GetRequiredService<DistributedApplicationModel>();
var containerResource = Assert.Single(appModel.Resources.OfType<ValkeyResource>());
var connectionStringResource = Assert.Single(appModel.Resources.OfType<IResourceWithConnectionString>());
var connectionString = await connectionStringResource.GetConnectionStringAsync(default);
Assert.Equal("{myValkey.bindings.tcp.host}:{myValkey.bindings.tcp.port},password={pass.value}", connectionStringResource.ConnectionStringExpression.ValueExpression);
Assert.StartsWith($"localhost:5001,password={password}", connectionString);
}
private static async Task<string> GetCommandLineArgs(IResourceBuilder<ValkeyResource> builder)
{
var args = await ArgumentEvaluator.GetArgumentListAsync(builder.Resource);
return string.Join(" ", args);
}
}
|