Add some Extension methods to IWireMockAdminApi (#1113)

src/WireMock.Net.RestClient/Extensions/WireMockAdminApiExtensions.cs

@@ -1,3 +1,9 @@
+using System;
+using System.Net.Http.Headers;
+using System.Text;
+using System.Threading;
+using System.Threading.Tasks;
+using Stef.Validation;
 using WireMock.Client.Builders;
 
 namespace WireMock.Client.Extensions;
@@ -7,13 +13,77 @@ namespace WireMock.Client.Extensions;
 /// </summary>
 public static class WireMockAdminApiExtensions
 {
+    private const int MaxRetries = 5;
+    private const int InitialWaitingTimeInMilliSeconds = 500;
+    private const string HealthStatusHealthy = "Healthy";
+
     /// <summary>
     /// Get a new <see cref="AdminApiMappingBuilder"/> for the <see cref="IWireMockAdminApi"/>.
     /// </summary>
-    /// <param name="api">See <see cref="IWireMockAdminApi"/>.</param>
+    /// <param name="adminApi">See <see cref="IWireMockAdminApi"/>.</param>
     /// <returns></returns>
-    public static AdminApiMappingBuilder GetMappingBuilder(this IWireMockAdminApi api)
+    public static AdminApiMappingBuilder GetMappingBuilder(this IWireMockAdminApi adminApi)
     {
-        return new AdminApiMappingBuilder(api);
+        return new AdminApiMappingBuilder(adminApi);
+    }
+
+    /// <summary>
+    /// Set basic authentication to access the <see cref="IWireMockAdminApi"/>.
+    /// </summary>
+    /// <param name="adminApi">See <see cref="IWireMockAdminApi"/>.</param>
+    /// <param name="username">The admin username.</param>
+    /// <param name="password">The admin password.</param>
+    /// <returns><see cref="IWireMockAdminApi"/></returns>
+    public static IWireMockAdminApi WithAuthorization(this IWireMockAdminApi adminApi, string username, string password)
+    {
+        Guard.NotNull(adminApi);
+        Guard.NotNullOrEmpty(username);
+        Guard.NotNullOrEmpty(password);
+
+        adminApi.Authorization = new AuthenticationHeaderValue("Basic", Convert.ToBase64String(Encoding.UTF8.GetBytes($"{username}:{password}")));
+        return adminApi;
+    }
+
+    /// <summary>
+    /// Wait for the WireMock.Net server to be healthy. (The "/__admin/health" returns "Healthy").
+    /// </summary>
+    /// <param name="adminApi">See <see cref="IWireMockAdminApi"/>.</param>
+    /// <param name="maxRetries">The maximum number of retries. Default is <c>5</c>.</param>
+    /// <param name="cancellationToken">The optional <see cref="CancellationToken"/>.</param>
+    /// <returns>A completed Task in case the health endpoint is available, else throws a <see cref="InvalidOperationException"/>.</returns>
+    public static async Task WaitForHealthAsync(this IWireMockAdminApi adminApi, int maxRetries = MaxRetries, CancellationToken cancellationToken = default)
+    {
+        Guard.NotNull(adminApi);
+
+        var retries = 0;
+        var waitTime = InitialWaitingTimeInMilliSeconds;
+        var totalWaitTime = waitTime;
+        var isHealthy = await IsHealthyAsync(adminApi, cancellationToken);
+        while (!isHealthy && retries < MaxRetries && !cancellationToken.IsCancellationRequested)
+        {
+            waitTime = (int)(InitialWaitingTimeInMilliSeconds * Math.Pow(2, retries));
+            await Task.Delay(waitTime, cancellationToken);
+            isHealthy = await IsHealthyAsync(adminApi, cancellationToken);
+            retries++;
+            totalWaitTime += waitTime;
+        }
+
+        if (retries >= MaxRetries)
+        {
+            throw new InvalidOperationException($"The /__admin/health endpoint did not return 'Healthy' after {MaxRetries} retries and {totalWaitTime / 1000.0:0.0} seconds.");
+        }
+    }
+
+    private static async Task<bool> IsHealthyAsync(IWireMockAdminApi adminApi, CancellationToken cancellationToken)
+    {
+        try
+        {
+            var status = await adminApi.GetHealthAsync(cancellationToken);
+            return string.Equals(status, HealthStatusHealthy, StringComparison.OrdinalIgnoreCase);
+        }
+        catch
+        {
+            return false;
+        }
     }
 }

src/WireMock.Net.Testcontainers/WireMockContainer.cs

@@ -8,6 +8,7 @@ using Microsoft.Extensions.Logging;
 using RestEase;
 using Stef.Validation;
 using WireMock.Client;
+using WireMock.Client.Extensions;
 using WireMock.Http;
 
 namespace WireMock.Net.Testcontainers;
@@ -47,13 +48,7 @@ public sealed class WireMockContainer : DockerContainer
         ValidateIfRunning();
 
         var api = RestClient.For<IWireMockAdminApi>(GetPublicUri());
-
-        if (_configuration.HasBasicAuthentication)
-        {
-            api.Authorization = new AuthenticationHeaderValue("Basic", Convert.ToBase64String(Encoding.ASCII.GetBytes($"{_configuration.Username}:{_configuration.Password}")));
-        }
-
-        return api;
+        return _configuration.HasBasicAuthentication ? api.WithAuthorization(_configuration.Username!, _configuration.Password!) : api;
     }
 
     /// <summary>

test/WireMock.Net.Tests/AdminApi/WireMockAdminApiTests.cs

@@ -17,6 +17,7 @@ using VerifyXunit;
 using WireMock.Admin.Mappings;
 using WireMock.Admin.Settings;
 using WireMock.Client;
+using WireMock.Client.Extensions;
 using WireMock.Handlers;
 using WireMock.Logging;
 using WireMock.Matchers;
@@ -42,15 +43,44 @@ public partial class WireMockAdminApiTests
     }
 
     [Fact]
-    public async Task IWireMockAdminApi_GetHealthAsync()
+    public async Task IWireMockAdminApi_WaitForHealthAsync_AndCall_GetHealthAsync_OK()
     {
         // Arrange
-        var server = WireMockServer.StartWithAdminInterface();
+        var adminUsername = $"username_{Guid.NewGuid()}";
+        var adminPassword = $"password_{Guid.NewGuid()}";
+        var server = WireMockServer.Start(w =>
+        {
+            w.StartAdminInterface = true;
+            w.AdminUsername = adminUsername;
+            w.AdminPassword = adminPassword;
+        });
+        var api = RestClient.For<IWireMockAdminApi>(server.Urls[0])
+            .WithAuthorization(adminUsername, adminPassword);
+
+        // Act 1
+        await api.WaitForHealthAsync().ConfigureAwait(false);
+
+        // Act 2
+        var status = await api.GetHealthAsync().ConfigureAwait(false);
+        status.Should().Be("Healthy");
+    }
+
+    [Fact]
+    public async Task IWireMockAdminApi_WaitForHealthAsync_AndCall_GetHealthAsync_ThrowsException()
+    {
+        // Arrange
+        var server = WireMockServer.Start(w =>
+        {
+            w.StartAdminInterface = true;
+            w.AdminUsername = $"username_{Guid.NewGuid()}";
+            w.AdminPassword = $"password_{Guid.NewGuid()}";
+        });
+
         var api = RestClient.For<IWireMockAdminApi>(server.Urls[0]);
 
         // Act
-        var status = await api.GetHealthAsync().ConfigureAwait(false);
-        status.Should().Be("Healthy");
+        Func<Task> act = () => api.WaitForHealthAsync(maxRetries: 3);
+        await act.Should().ThrowAsync<InvalidOperationException>();
     }
 
     [Fact]

test/WireMock.Net.Tests/Testcontainers/TestcontainersTests.cs

@@ -1,4 +1,5 @@
 #if NET6_0_OR_GREATER
+using System;
 using System.Threading.Tasks;
 using FluentAssertions;
 using FluentAssertions.Execution;
@@ -13,9 +14,12 @@ public class TestcontainersTests
     public async Task WireMockContainer_Build_and_StartAsync_and_StopAsync()
     {
         // Act
+        var adminUsername = $"username_{Guid.NewGuid()}";
+        var adminPassword = $"password_{Guid.NewGuid()}";
         var wireMockContainer = new WireMockContainerBuilder()
             .WithAutoRemove(true)
             .WithCleanUp(true)
+            .WithAdminUserNameAndPassword(adminUsername, adminPassword)
             .Build();
 
         try