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

// Copyright © WireMock.Net

#if NET8_0_OR_GREATER
using System.Runtime.InteropServices;
using AwesomeAssertions.Execution;
using DotNet.Testcontainers.Builders;
using Meziantou.Extensions.Logging.Xunit.v3;
using Microsoft.Extensions.Logging;
using WireMock.Net.Testcontainers;
using WireMock.Net.Testcontainers.Utils;
using WireMock.Net.Tests.Facts;

namespace WireMock.Net.Tests.Testcontainers;

public class TestcontainersTests(ITestOutputHelper testOutputHelper, ITestContextAccessor testContext)
{
    private readonly CancellationToken _ct = testContext.Current.CancellationToken;

    private readonly ILogger _logger = new XUnitLogger(testOutputHelper, new LoggerExternalScopeProvider(), nameof(TestcontainersTests), new XUnitLoggerOptions
    {
        IncludeCategory = true,
        TimestampFormat = "yyy-MM-dd HH:mm:ss.fff"
    });

    [RunOnDockerFact]
    public async Task WireMockContainer_Build_And_StartAsync_and_StopAsync()
    {
        // Act
        var adminUsername = $"username_{Guid.NewGuid()}";
        var adminPassword = $"password_{Guid.NewGuid()}";
        var wireMockContainer = new WireMockContainerBuilder()
            .WithLogger(_logger)
            .WithAdminUserNameAndPassword(adminUsername, adminPassword)
            .WithAutoRemove(true)
            .WithCleanUp(true)
            .Build();

        await StartTestAsync(wireMockContainer);
        await StopAsync(wireMockContainer);
    }

    // https://github.com/testcontainers/testcontainers-dotnet/issues/1322
    [RunOnDockerPlatformFact("Linux")]
    public async Task WireMockContainer_Build_WithNetwork_And_StartAsync_and_StopAsync()
    {
        // Act
        var dummyNetwork = new NetworkBuilder()
            .WithName("Dummy Network for TestcontainersTests")
            .Build();

        var wireMockContainer = new WireMockContainerBuilder()
            .WithLogger(_logger)
            .WithNetwork(dummyNetwork)
            .WithWatchStaticMappings(true)
            .Build();

        await Task.Delay(500, _ct);

        await StartTestAsync(wireMockContainer);
        await StopAsync(wireMockContainer);
    }

    [RunOnDockerFact]
    public async Task WireMockContainer_Build_WithImage_And_StartAsync_and_StopAsync()
    {
        // Arrange
        var adminUsername = $"username_{Guid.NewGuid()}";
        var adminPassword = $"password_{Guid.NewGuid()}";
        var wireMockContainerBuilder = new WireMockContainerBuilder()
            .WithLogger(_logger)
            .WithAdminUserNameAndPassword(adminUsername, adminPassword);

        var imageOS = await TestcontainersUtils.GetImageOSAsync.Value;
        if (imageOS == OSPlatform.Windows)
        {
            wireMockContainerBuilder = wireMockContainerBuilder.WithWindowsImage();
        }
        else
        {
            wireMockContainerBuilder = wireMockContainerBuilder.WithLinuxImage();
        }

        var wireMockContainer = wireMockContainerBuilder.Build();

        await Task.Delay(500, _ct);

        await StartTestAsync(wireMockContainer);
        await StopAsync(wireMockContainer);
    }

    [RunOnDockerFact]
    public async Task WireMockContainer_Build_WithImageAsText_And_StartAsync_and_StopAsync()
    {
        // Arrange
        var adminUsername = $"username_{Guid.NewGuid()}";
        var adminPassword = $"password_{Guid.NewGuid()}";
        var wireMockContainerBuilder = new WireMockContainerBuilder()
            .WithLogger(_logger)
            .WithAdminUserNameAndPassword(adminUsername, adminPassword);

        var imageOS = await TestcontainersUtils.GetImageOSAsync.Value;
        if (imageOS == OSPlatform.Windows)
        {
            wireMockContainerBuilder = wireMockContainerBuilder.WithImage("sheyenrath/wiremock.net-windows");
        }
        else
        {
            wireMockContainerBuilder = wireMockContainerBuilder.WithImage("sheyenrath/wiremock.net-alpine");
        }

        var wireMockContainer = wireMockContainerBuilder.Build();

        await Task.Delay(500, _ct);

        await StartTestAsync(wireMockContainer);
        await StopAsync(wireMockContainer);
    }

    private async Task StartTestAsync(WireMockContainer wireMockContainer)
    {
        // Start
        await wireMockContainer.StartAsync(_ct);

        await Task.Delay(500, _ct);

        // Assert
        using (new AssertionScope())
        {
            var url = wireMockContainer.GetPublicUrl();
            url.Should().NotBeNullOrWhiteSpace();

            var adminClient = wireMockContainer.CreateWireMockAdminClient();

            var settings = await adminClient.GetSettingsAsync();
            settings.Should().NotBeNull();
        }
    }

    private async Task StopAsync(WireMockContainer wireMockContainer)
    {
        try
        {
            await wireMockContainer.StopAsync();
        }
        catch (Exception ex)
        {
            // Sometimes we get this exception, so for now ignore it.
            /*
            Failed WireMock.Net.Tests.Testcontainers.TestcontainersTests.WireMockContainer_Build_WithImageAsText_And_StartAsync_and_StopAsync [9 s]
               Error Message:
                System.NullReferenceException : Object reference not set to an instance of an object.
               Stack Trace:
                  at DotNet.Testcontainers.Containers.DockerContainer.UnsafeStopAsync(CancellationToken ct) in /_/src/Testcontainers/Containers/DockerContainer.cs:line 567
                at DotNet.Testcontainers.Containers.DockerContainer.StopAsync(CancellationToken ct) in /_/src/Testcontainers/Containers/DockerContainer.cs:line 319
            */

            testOutputHelper.WriteLine($"Exception during StopAsync: {ex}");
        }
    }
}
#endif