Adding public API test coverage for Aspire.Hosting.Keycloak

src/Aspire.Hosting.Keycloak/KeycloakResource.cs

@@ -1,31 +1,27 @@
-// Licensed to the .NET Foundation under one or more agreements.
+// 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 Keycloak resource.
+/// <param name="name">The name of the resource.</param>
+/// <param name="admin">A parameter that contains the Keycloak admin, or <see langword="null"/> to use a default value.</param>
+/// <param name="adminPassword">A parameter that contains the Keycloak admin password.</param>
 /// </summary>
-public sealed class KeycloakResource : ContainerResource, IResourceWithServiceDiscovery
+public sealed class KeycloakResource(string name, ParameterResource? admin, ParameterResource adminPassword)
+    : ContainerResource(ThrowIfNull(name)), IResourceWithServiceDiscovery
 {
     private const string DefaultAdmin = "admin";
     internal const string PrimaryEndpointName = "tcp";
 
-    /// <param name="name">The name of the resource.</param>
-    /// <param name="admin">A parameter that contains the Keycloak admin, or <see langword="null"/> to use a default value.</param>
-    /// <param name="adminPassword">A parameter that contains the Keycloak admin password.</param>
-    public KeycloakResource(string name, ParameterResource? admin, ParameterResource adminPassword) : base(name)
-    {
-        ArgumentNullException.ThrowIfNull(adminPassword);
-
-        AdminUserNameParameter = admin;
-        AdminPasswordParameter = adminPassword;
-    }
-
     /// <summary>
     /// Gets the parameter that contains the Keycloak admin.
     /// </summary>
-    public ParameterResource? AdminUserNameParameter { get; }
+    public ParameterResource? AdminUserNameParameter { get; } = admin;
 
     internal ReferenceExpression AdminReference =>
         AdminUserNameParameter is not null ?
@@ -35,5 +31,8 @@ AdminUserNameParameter is not null ?
     /// <summary>
     /// Gets the parameter that contains the Keycloak admin password.
     /// </summary>
-    public ParameterResource AdminPasswordParameter { get; }
-}
+    public ParameterResource AdminPasswordParameter { get; } = ThrowIfNull(adminPassword);
+
+    private static T ThrowIfNull<T>([NotNull] T? argument, [CallerArgumentExpression(nameof(argument))] string? paramName = null)
+        => argument ?? throw new ArgumentNullException(paramName);
+}

src/Aspire.Hosting.Keycloak/KeycloakResourceBuilderExtensions.cs

@@ -1,4 +1,4 @@
-// Licensed to the .NET Foundation under one or more agreements.
+// 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;
@@ -46,6 +46,9 @@ public static IResourceBuilder<KeycloakResource> AddKeycloak(
         IResourceBuilder<ParameterResource>? adminUsername = null,
         IResourceBuilder<ParameterResource>? adminPassword = null)
     {
+        ArgumentNullException.ThrowIfNull(builder);
+        ArgumentNullException.ThrowIfNull(name);
+
         var passwordParameter = adminPassword?.Resource ?? ParameterResourceBuilderExtensions.CreateDefaultPasswordParameter(builder, $"{name}-password");
 
         var resource = new KeycloakResource(name, adminUsername?.Resource, passwordParameter);
@@ -93,7 +96,12 @@ public static IResourceBuilder<KeycloakResource> AddKeycloak(
     /// </code>
     /// </example>
     public static IResourceBuilder<KeycloakResource> WithDataVolume(this IResourceBuilder<KeycloakResource> builder, string? name = null)
-        => builder.WithVolume(name ?? VolumeNameGenerator.CreateVolumeName(builder, "data"), "/opt/keycloak/data", false);
+    {
+        ArgumentNullException.ThrowIfNull(builder);
+
+        return builder.WithVolume(name ?? VolumeNameGenerator.CreateVolumeName(builder, "data"), "/opt/keycloak/data",
+            false);
+    }
 
     /// <summary>
     /// Adds a bind mount for the data folder to a Keycloak container resource.
@@ -112,7 +120,12 @@ public static IResourceBuilder<KeycloakResource> WithDataVolume(this IResourceBu
     /// </code>
     /// </example>
     public static IResourceBuilder<KeycloakResource> WithDataBindMount(this IResourceBuilder<KeycloakResource> builder, string source)
-        => builder.WithBindMount(source, "/opt/keycloak/data", false);
+    {
+        ArgumentNullException.ThrowIfNull(builder);
+        ArgumentNullException.ThrowIfNull(source);
+
+        return builder.WithBindMount(source, "/opt/keycloak/data", false);
+    }
 
     /// <summary>
     /// Adds a realm import to a Keycloak container resource.
@@ -136,6 +149,7 @@ public static IResourceBuilder<KeycloakResource> WithRealmImport(
         string importDirectory,
         bool isReadOnly = false)
     {
+        ArgumentNullException.ThrowIfNull(builder);
         ArgumentNullException.ThrowIfNull(importDirectory);
 
         if (!Directory.Exists(importDirectory))

tests/Aspire.Hosting.Keycloak.Tests/KeycloakPublicApiTests.cs

@@ -0,0 +1,121 @@
+// 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.Keycloak.Tests;
+
+public class KeycloakPublicApiTests
+{
+    [Fact]
+    public void CtorKeycloakResourceShouldThrowWhenNameIsNull()
+    {
+        string name = null!;
+        var builder = TestDistributedApplicationBuilder.Create();
+        var adminPassword = builder.AddParameter("Password");
+
+        var action = () => new KeycloakResource(name, default(ParameterResource?), adminPassword.Resource);
+
+        var exception = Assert.Throws<ArgumentNullException>(action);
+        Assert.Equal(nameof(name), exception.ParamName);
+    }
+
+    [Fact]
+    public void CtorKeycloakResourceShouldThrowWhenAdminPasswordIsNull()
+    {
+        const string name = "Keycloak";
+        ParameterResource adminPassword = null!;
+
+        var action = () => new KeycloakResource(name, default(ParameterResource?), adminPassword);
+
+        var exception = Assert.Throws<ArgumentNullException>(action);
+        Assert.Equal(nameof(adminPassword), exception.ParamName);
+    }
+
+    [Fact]
+    public void AddKeycloakContainerShouldThrowWhenBuilderIsNull()
+    {
+        IDistributedApplicationBuilder builder =  null!;
+        const string name = "Keycloak";
+
+        var action = () => builder.AddKeycloak(name);
+
+        var exception = Assert.Throws<ArgumentNullException>(action);
+        Assert.Equal(nameof(builder), exception.ParamName);
+    }
+
+    [Fact]
+    public void AddKeycloakContainerShouldThrowWhenNameIsNull()
+    {
+        var builder = TestDistributedApplicationBuilder.Create();
+        string name = null!;
+
+        var action = () => builder.AddKeycloak(name);
+
+        var exception = Assert.Throws<ArgumentNullException>(action);
+        Assert.Equal(nameof(name), exception.ParamName);
+    }
+
+    [Fact]
+    public void WithDataVolumeShouldThrowWhenBuilderIsNull()
+    {
+        IResourceBuilder<KeycloakResource> builder = null!;
+
+        var action = () => builder.WithDataVolume();
+
+        var exception = Assert.Throws<ArgumentNullException>(action);
+        Assert.Equal(nameof(builder), exception.ParamName);
+    }
+
+    [Fact]
+    public void WithDataBindMountShouldThrowWhenBuilderIsNull()
+    {
+        IResourceBuilder<KeycloakResource> builder = null!;
+        const string source = "/opt/keycloak/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 keycloak = builder.AddKeycloak("Keycloak");
+        string source = null!;
+
+        var action = () => keycloak.WithDataBindMount(source);
+
+        var exception = Assert.Throws<ArgumentNullException>(action);
+        Assert.Equal(nameof(source), exception.ParamName);
+    }
+
+    [Fact]
+    public void WithRealmImportShouldThrowWhenBuilderIsNull()
+    {
+        IResourceBuilder<KeycloakResource> builder = null!;
+        const string importDirectory = "/opt/keycloak/data/import";
+
+        var action = () => builder.WithRealmImport(importDirectory);
+
+        var exception = Assert.Throws<ArgumentNullException>(action);
+        Assert.Equal(nameof(builder), exception.ParamName);
+    }
+
+    [Fact]
+    public void WithRealmImportShouldThrowWhenImportDirectoryIsNull()
+    {
+        var builder = TestDistributedApplicationBuilder.Create();
+        var keycloak = builder.AddKeycloak("Keycloak");
+        string importDirectory = null!;
+
+        var action = () => keycloak.WithRealmImport(importDirectory);
+
+        var exception = Assert.Throws<ArgumentNullException>(action);
+        Assert.Equal(nameof(importDirectory), exception.ParamName);
+    }
+}