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

// Copyright © WireMock.Net

using System.Net.Http.Headers;
using System.Text;
using Stef.Validation;
using WireMock.Admin.Mappings;
using WireMock.Admin.Requests;
using WireMock.Client.Builders;

namespace WireMock.Client.Extensions;

/// <summary>
/// Some extensions for <see cref="IWireMockAdminApi"/>.
/// </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="adminApi">See <see cref="IWireMockAdminApi"/>.</param>
    /// <returns></returns>
    public static AdminApiMappingBuilder GetMappingBuilder(this IWireMockAdminApi adminApi)
    {
        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 '{HealthStatusHealthy}' after {MaxRetries} retries and {totalWaitTime / 1000.0:0.0} seconds.");
        }
    }

    /// <summary>
    /// Find requests based on the criteria (<see cref="RequestModel"/>).
    /// </summary>
    /// <param name="adminApi">See <see cref="IWireMockAdminApi"/>.</param>
    /// <param name="builder">The <see cref="RequestModelBuilder"/> action to fluently build the request model.</param>
    /// <param name="cancellationToken">The optional cancellationToken.</param>
    public static Task<IList<LogEntryModel>> FindRequestsAsync(this IWireMockAdminApi adminApi, Action<RequestModelBuilder> builder, CancellationToken cancellationToken = default)
    {
        var modelBuilder = new RequestModelBuilder();
        builder(modelBuilder);

        var requestModel = modelBuilder.Build();
        return adminApi.FindRequestsAsync(requestModel, cancellationToken);
    }

    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;
        }
    }
}