Skip to content
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions src/Aspire.Hosting.Qdrant/QdrantBuilderExtensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@ public static IResourceBuilder<QdrantServerResource> AddQdrant(this IDistributed
int? grpcPort = null,
int? httpPort = null)
{
ArgumentNullException.ThrowIfNull(builder);
ArgumentNullException.ThrowIfNull(name);

var apiKeyParameter = apiKey?.Resource ??
ParameterResourceBuilderExtensions.CreateDefaultPasswordParameter(builder, $"{name}-Key", special: false);
var qdrant = new QdrantServerResource(name, apiKeyParameter);
Expand Down Expand Up @@ -69,7 +72,12 @@ public static IResourceBuilder<QdrantServerResource> AddQdrant(this IDistributed
/// <param name="isReadOnly">A flag that indicates if this is a read-only volume.</param>
/// <returns>The <see cref="IResourceBuilder{T}"/>.</returns>
public static IResourceBuilder<QdrantServerResource> WithDataVolume(this IResourceBuilder<QdrantServerResource> builder, string? name = null, bool isReadOnly = false)
=> builder.WithVolume(name ?? VolumeNameGenerator.CreateVolumeName(builder, "data"), "/qdrant/storage", isReadOnly);
{
ArgumentNullException.ThrowIfNull(builder);

return builder.WithVolume(name ?? VolumeNameGenerator.CreateVolumeName(builder, "data"), "/qdrant/storage",
isReadOnly);
}

/// <summary>
/// Adds a bind mount for the data folder to a Qdrant container resource.
Expand All @@ -79,7 +87,12 @@ public static IResourceBuilder<QdrantServerResource> WithDataVolume(this IResour
/// <param name="isReadOnly">A flag that indicates if this is a read-only mount.</param>
/// <returns>The <see cref="IResourceBuilder{T}"/>.</returns>
public static IResourceBuilder<QdrantServerResource> WithDataBindMount(this IResourceBuilder<QdrantServerResource> builder, string source, bool isReadOnly = false)
=> builder.WithBindMount(source, "/qdrant/storage", isReadOnly);
{
ArgumentNullException.ThrowIfNull(builder);
ArgumentNullException.ThrowIfNull(source);

return builder.WithBindMount(source, "/qdrant/storage", isReadOnly);
}

/// <summary>
/// Add a reference to a Qdrant server to the resource.
Expand All @@ -90,6 +103,9 @@ public static IResourceBuilder<QdrantServerResource> WithDataBindMount(this IRes
public static IResourceBuilder<TDestination> WithReference<TDestination>(this IResourceBuilder<TDestination> builder, IResourceBuilder<QdrantServerResource> qdrantResource)
where TDestination : IResourceWithEnvironment
{
ArgumentNullException.ThrowIfNull(builder);
ArgumentNullException.ThrowIfNull(qdrantResource);

builder.WithEnvironment(context =>
{
// primary endpoint (gRPC)
Expand Down
166 changes: 166 additions & 0 deletions tests/Aspire.Hosting.Qdrant.Tests/QdrantPublicApiTests.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,166 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using Aspire.Hosting.ApplicationModel;
using Xunit;

namespace Aspire.Hosting.Qdrant.Tests;

public class QdrantPublicApiTests
{
#region QdrantBuilderExtensions

[Fact]
public void AddQdrantContainerShouldThrowsWhenBuilderIsNull()
{
IDistributedApplicationBuilder builder = null!;
const string name = "Qdrant";

var action = () => builder.AddQdrant(name);

Assert.Multiple(() =>
{
var exception = Assert.Throws<ArgumentNullException>(action);
Assert.Equal(nameof(builder), exception.ParamName);
});
}

[Fact]
public void AddQdrantContainerShouldThrowsWhenNameIsNull()
{
var builder = DistributedApplication.CreateBuilder([]);
string name = null!;

var action = () => builder.AddQdrant(name);

Assert.Multiple(() =>
{
var exception = Assert.Throws<ArgumentNullException>(action);
Assert.Equal(nameof(name), exception.ParamName);
});
}

[Fact]
public void WithDataVolumeShouldThrowsWhenBuilderIsNull()
{
IResourceBuilder<QdrantServerResource> builder = null!;

var action = () => builder.WithDataVolume();

Assert.Multiple(() =>
{
var exception = Assert.Throws<ArgumentNullException>(action);
Assert.Equal(nameof(builder), exception.ParamName);
});
}

[Fact]
public void WithDataBindMountShouldThrowsWhenBuilderIsNull()
{
IResourceBuilder<QdrantServerResource> builder = null!;
const string source = "/qdrant/storage";

var action = () => builder.WithDataBindMount(source);

Assert.Multiple(() =>
{
var exception = Assert.Throws<ArgumentNullException>(action);
Assert.Equal(nameof(builder), exception.ParamName);
});
}

[Fact]
public void WithDataBindMountShouldThrowsWhenNameIsNull()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is testing the source (source directory) parameter, and not name.

{
var distributedApplicationBuilder = DistributedApplication.CreateBuilder([]);
const string name = "Qdrant";
var apiKeyParameter = ParameterResourceBuilderExtensions.CreateDefaultPasswordParameter(distributedApplicationBuilder, $"{name}-Key", special: false);
var resource = new QdrantServerResource(name, apiKeyParameter);
var builder = distributedApplicationBuilder.AddResource(resource);
string source = null!;

var action = () => builder.WithDataBindMount(source);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need all this or would something like this be enough?:

        IResourceBuilder<QdrantServerResource> builder = null!;
        string source = null!;
        var action = () => builder.WithDataBindMount(source);

@eerhardt @sebastienros thoughts?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree, it doesn't need to be that complicated. Even the Multiple usage in all these tests, since the second assertion depends on the first, we don't care about the second result if the first one failed.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Multiple

Indeed, I will remove Multiple.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need all this or would something like this be enough?:

        IResourceBuilder<QdrantServerResource> builder = null!;
        string source = null!;
        var action = () => builder.WithDataBindMount(source);

@eerhardt @sebastienros thoughts?

But in this case. We will not handle the error when builder 'is not null' and source 'is null'

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Full test

var builder = TestDistributedApplicationBuilder.Create();
var qdrant = builder.AddQdrant("qdrant");
string source = null!;

var action = () => qdrant.WithDataBindMount(source);
var exception = Assert.Throws<ArgumentNullException>(action);
Assert.Equal(nameof(source), exception.ParamName);


Assert.Multiple(() =>
{
var exception = Assert.Throws<ArgumentNullException>(action);
Assert.Equal(nameof(source), exception.ParamName);
});
}

[Fact]
public void WithReferenceShouldThrowsWhenBuilderIsNull()
{
IResourceBuilder<IResourceWithEnvironment> builder = null!;
var distributedApplicationBuilder = DistributedApplication.CreateBuilder([]);
const string name = "Qdrant";
var apiKeyParameter = ParameterResourceBuilderExtensions.CreateDefaultPasswordParameter(distributedApplicationBuilder, $"{name}-Key", special: false);
var resource = new QdrantServerResource(name, apiKeyParameter);
var qdrantResource = distributedApplicationBuilder.AddResource(resource);

var action = () => builder.WithReference(qdrantResource);

Assert.Multiple(() =>
{
var exception = Assert.Throws<ArgumentNullException>(action);
Assert.Equal(nameof(builder), exception.ParamName);
});
}

[Fact]
public void WithReferenceShouldThrowsWhenQdrantResourceIsNull()
{
var distributedApplicationBuilder = DistributedApplication.CreateBuilder([]);
const string name = "Qdrant";
var apiKeyParameter = ParameterResourceBuilderExtensions.CreateDefaultPasswordParameter(distributedApplicationBuilder, $"{name}-Key", special: false);
var resource = new QdrantServerResource(name, apiKeyParameter);
var builder = distributedApplicationBuilder.AddResource(resource);
IResourceBuilder<QdrantServerResource> qdrantResource = null!;

var action = () => builder.WithReference(qdrantResource);

Assert.Multiple(() =>
{
var exception = Assert.Throws<ArgumentNullException>(action);
Assert.Equal(nameof(qdrantResource), exception.ParamName);
});
}

#endregion

#region QdrantServerResource

[Fact]
public void CtorQdrantServerResourceShouldThrowsWhenNameIsNull()
{
var distributedApplicationBuilder = DistributedApplication.CreateBuilder([]);
string name = null!;
const string key = nameof(key);
var apiKey = ParameterResourceBuilderExtensions.CreateDefaultPasswordParameter(distributedApplicationBuilder, key, special: false);

var action = () => new QdrantServerResource(name, apiKey);

Assert.Multiple(() =>
{
var exception = Assert.Throws<ArgumentNullException>(action);
Assert.Equal(nameof(name), exception.ParamName);
});
}

[Fact]
public void CtorQdrantServerResourceShouldThrowsWhenApiKeyIsNull()
{
const string name = "Qdrant";
ParameterResource apiKey = null!;

var action = () => new QdrantServerResource(name, apiKey);

Assert.Multiple(() =>
{
var exception = Assert.Throws<ArgumentNullException>(action);
Assert.Equal(nameof(apiKey), exception.ParamName);
});
}

#endregion
}