Adding public API test coverage for Aspire.Hosting.Nats (#5129)

* CA1062#Aspire.Hosting.Nats

* Remove Address

src/Aspire.Hosting.Nats/NatsBuilderExtensions.cs

@@ -21,6 +21,9 @@ public static class NatsBuilderExtensions
     /// <returns>The <see cref="IResourceBuilder{T}"/>.</returns>
     public static IResourceBuilder<NatsServerResource> AddNats(this IDistributedApplicationBuilder builder, string name, int? port = null)
     {
+        ArgumentNullException.ThrowIfNull(builder);
+        ArgumentNullException.ThrowIfNull(name);
+
         var nats = new NatsServerResource(name);
         return builder.AddResource(nats)
                       .WithEndpoint(targetPort: 4222, port: port, name: NatsServerResource.PrimaryEndpointName)
@@ -54,7 +57,11 @@ public static IResourceBuilder<NatsServerResource> WithJetStream(this IResourceB
     /// <param name="builder">The resource builder.</param>
     /// <returns>The <see cref="IResourceBuilder{T}"/>.</returns>
     public static IResourceBuilder<NatsServerResource> WithJetStream(this IResourceBuilder<NatsServerResource> builder)
-        => builder.WithArgs("-js");
+    {
+        ArgumentNullException.ThrowIfNull(builder);
+
+        return builder.WithArgs("-js");
+    }
 
     /// <summary>
     /// Adds a named volume for the data folder to a NATS container resource.
@@ -64,8 +71,13 @@ public static IResourceBuilder<NatsServerResource> WithJetStream(this IResourceB
     /// <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<NatsServerResource> WithDataVolume(this IResourceBuilder<NatsServerResource> builder, string? name = null, bool isReadOnly = false)
-        => builder.WithVolume(name ?? VolumeNameGenerator.CreateVolumeName(builder, "data"), "/var/lib/nats", isReadOnly)
-                  .WithArgs("-sd", "/var/lib/nats");
+    {
+        ArgumentNullException.ThrowIfNull(builder);
+
+        return builder.WithVolume(name ?? VolumeNameGenerator.CreateVolumeName(builder, "data"), "/var/lib/nats",
+                isReadOnly)
+            .WithArgs("-sd", "/var/lib/nats");
+    }
 
     /// <summary>
     /// Adds a bind mount for the data folder to a NATS container resource.
@@ -75,7 +87,11 @@ public static IResourceBuilder<NatsServerResource> WithDataVolume(this IResource
     /// <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<NatsServerResource> WithDataBindMount(this IResourceBuilder<NatsServerResource> builder, string source, bool isReadOnly = false)
-        => builder.WithBindMount(source, "/var/lib/nats", isReadOnly)
-                  .WithArgs("-sd", "/var/lib/nats");
+    {
+        ArgumentNullException.ThrowIfNull(builder);
+        ArgumentNullException.ThrowIfNull(source);
 
+        return builder.WithBindMount(source, "/var/lib/nats", isReadOnly)
+            .WithArgs("-sd", "/var/lib/nats");
+    }
 }

src/Aspire.Hosting.Nats/NatsServerResource.cs

@@ -1,14 +1,17 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+using System.Diagnostics.CodeAnalysis;
+using System.Runtime.CompilerServices;
+
 namespace Aspire.Hosting.ApplicationModel;
 
 /// <summary>
 /// A resource that represents a NATS server container.
 /// </summary>
 /// <param name="name">The name of the resource.</param>
 
-public class NatsServerResource(string name) : ContainerResource(name), IResourceWithConnectionString
+public class NatsServerResource(string name) : ContainerResource(ThrowIfNull(name)), IResourceWithConnectionString
 {
     internal const string PrimaryEndpointName = "tcp";
     internal const string PrimaryNatsSchemeName = "nats";
@@ -26,4 +29,7 @@ public class NatsServerResource(string name) : ContainerResource(name), IResourc
     public ReferenceExpression ConnectionStringExpression =>
         ReferenceExpression.Create(
             $"{PrimaryNatsSchemeName}://{PrimaryEndpoint.Property(EndpointProperty.Host)}:{PrimaryEndpoint.Property(EndpointProperty.Port)}");
+
+    private static string ThrowIfNull([NotNull] string? argument, [CallerArgumentExpression(nameof(argument))] string? paramName = null)
+        => argument ?? throw new ArgumentNullException(paramName);
 }

tests/Aspire.Hosting.Nats.Tests/NatsPublicApiTests.cs

@@ -0,0 +1,93 @@
+// 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 Aspire.Hosting.Utils;
+using Xunit;
+
+namespace Aspire.Hosting.Nats.Tests;
+
+public class NatsPublicApiTests
+{
+    [Fact]
+    public void AddNatsContainerShouldThrowWhenBuilderIsNull()
+    {
+        IDistributedApplicationBuilder builder = null!;
+        const string name = "Nats";
+
+        var action = () => builder.AddNats(name);
+
+        var exception = Assert.Throws<ArgumentNullException>(action);
+        Assert.Equal(nameof(builder), exception.ParamName);
+    }
+
+    [Fact]
+    public void AddNatsContainerShouldThrowWhenNameIsNull()
+    {
+        var builder = TestDistributedApplicationBuilder.Create();
+        string name = null!;
+
+        var action = () => builder.AddNats(name);
+
+        var exception = Assert.Throws<ArgumentNullException>(action);
+        Assert.Equal(nameof(name), exception.ParamName);
+    }
+
+    [Fact]
+    public void WithJetStreamShouldThrowWhenBuilderIsNull()
+    {
+        IResourceBuilder<NatsServerResource> builder = null!;
+
+        var action = () => builder.WithJetStream();
+
+        var exception = Assert.Throws<ArgumentNullException>(action);
+        Assert.Equal(nameof(builder), exception.ParamName);
+    }
+
+    [Fact]
+    public void WithDataVolumeShouldThrowWhenBuilderIsNull()
+    {
+        IResourceBuilder<NatsServerResource> builder = null!;
+
+        var action = () => builder.WithDataVolume();
+
+        var exception = Assert.Throws<ArgumentNullException>(action);
+        Assert.Equal(nameof(builder), exception.ParamName);
+    }
+
+    [Fact]
+    public void WithDataBindMountShouldThrowWhenBuilderIsNull()
+    {
+        IResourceBuilder<NatsServerResource> builder = null!;
+        const string source = "/data";
+
+        var action = () => builder.WithDataBindMount(source);
+
+        var exception = Assert.Throws<ArgumentNullException>(action);
+        Assert.Equal(nameof(builder), exception.ParamName);
+    }
+
+    [Fact]
+    public void WithDataBindMountShouldThrowWhenSourceIsNull()
+    {
+        var builder = TestDistributedApplicationBuilder.Create();
+        var nats = builder.AddNats("Nats");
+        string source = null!;
+
+        var action = () => nats.WithDataBindMount(source);
+
+        var exception = Assert.Throws<ArgumentNullException>(action);
+        Assert.Equal(nameof(source), exception.ParamName);
+    }
+
+    [Fact]
+    public void CtorNatsServerResourceShouldThrowWhenNameIsNull()
+    {
+        string name = null!;
+
+        var action = () => new NatsServerResource(name);
+
+        var exception = Assert.Throws<ArgumentNullException>(action);
+        Assert.Equal(nameof(name), exception.ParamName);
+    }
+}