ContainerResource.cs

using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using System.Threading.Tasks;

namespace Squadron;

/// <summary>
/// Base resource for container based resources
/// </summary>
/// <typeparam name="TOptions">The type of the options.</typeparam>
public class ContainerResource<TOptions>
    where TOptions : ContainerResourceOptions, new()
{
    /// <summary>
    /// Gets or sets the continer settings.
    /// </summary>
    /// <value>
    /// The settings.
    /// </value>
    protected ContainerResourceSettings Settings { get; set; }

    /// <summary>
    /// The container manager
    /// </summary>
    protected IDockerContainerManager Manager;

    /// <summary>
    /// The container initializer
    /// </summary>
    protected ContainerInitializer Initializer;

    /// <summary>
    /// The resource options
    /// </summary>
    protected TOptions ResourceOptions;

    private List<string> _composeVariables;

    private IEnumerable<string> _composeNetworks = new List<string>();

    public ContainerInstance Instance => Manager.Instance;

    /// <summary>
    /// Initializes the resources
    /// </summary>
    public virtual async Task InitializeAsync()
    {
        SetupContainerResource();

        await Manager.CreateAndStartContainerAsync();
    }

    protected virtual void SetupContainerResource()
    {
        ResourceOptions = new TOptions();
        var builder = ContainerResourceBuilder.New();
        ResourceOptions.Configure(builder);
        AddNetworksToBuilder(builder);
        Settings = builder.Build();

        SetComposeVariables();
        OnSettingsBuilded(Settings);
        ValidateSettings(Settings);

        Manager = new TestcontainersDockerManager(Settings);
        Initializer = new ContainerInitializer(Manager, Settings);
    }

    private void AddNetworksToBuilder(ContainerResourceBuilder builder)
    {
        foreach(string network in _composeNetworks)
        {
            builder.AddNetwork(network);
        }
    }

    private void SetComposeVariables()
    {
        if (_composeVariables != null)
        {
            foreach (var envVar in _composeVariables)
            {
                Settings.EnvironmentVariables.Add(envVar);
            }
        }

        // Add docker hostname variable
        Settings.EnvironmentVariables.Add($"DockerHost:Name={Settings.UniqueContainerName}");
    }

    public void SetEnvironmentVariables(IEnumerable<string> variables)
    {
        _composeVariables = variables.ToList();
    }

    public void SetNetworks(IEnumerable<string> composeNetworks)
    {
        _composeNetworks = composeNetworks;
    }

    private void ValidateSettings(ContainerResourceSettings settings)
    {
        if (string.IsNullOrEmpty(settings.Name))
            throw new ArgumentException("Can not be null or empty.", nameof(settings.Name));

        if (string.IsNullOrEmpty(settings.Image))
            throw new ArgumentException("Can not be null or empty.", nameof(settings.Image));

        if (settings.InternalPort == 0)
            throw new ArgumentException("Can not be 0", nameof(settings.InternalPort));
    }

    /// <summary>
    /// Called when after settings are build
    /// </summary>
    /// <param name="settings">The settings.</param>
    protected virtual void OnSettingsBuilded(ContainerResourceSettings settings)
    { }


    public Task PauseContainer(TimeSpan pauseTime)
    {
        return Task.CompletedTask;
    }

    public virtual Dictionary<string, string> GetComposeExports()
    {
        return new Dictionary<string, string>
        {
            { "ADDRESS", Manager.Instance.Address },
            { "NAME", Manager.Instance.Name },
            { "PORT", Manager.Instance.HostPort.ToString() },
        };
    }

    /// <summary>
    /// Cleans up the resource
    /// </summary>
    public async Task DisposeAsync()
    {
        try
        {
            await Manager.StopContainerAsync();
            await Manager.RemoveContainerAsync();
            Manager.Dispose();
        }
        catch (Exception ex)
        {
            Settings.Logger.Error($"Could not cleanup container [id: {Manager.Instance.Id}]", ex);
        }
    }
}