CustomConfigurationTest.cs

namespace DotNet.Testcontainers.Tests.Unit
{
  using System;
  using System.Collections.Generic;
  using DotNet.Testcontainers.Configurations;
  using Xunit;

  public static class CustomConfigurationTest
  {
    [CollectionDefinition(nameof(EnvironmentConfigurationTest), DisableParallelization = true)]
    [Collection(nameof(EnvironmentConfigurationTest))]
    public sealed class EnvironmentConfigurationTest : IDisposable
    {
      private static readonly IList<string> EnvironmentVariables = new List<string>();

      static EnvironmentConfigurationTest()
      {
        EnvironmentVariables.Add("DOCKER_API_VERSION");
        EnvironmentVariables.Add("DOCKER_CONFIG");
        EnvironmentVariables.Add("DOCKER_HOST");
        EnvironmentVariables.Add("DOCKER_CONTEXT");
        EnvironmentVariables.Add("DOCKER_AUTH_CONFIG");
        EnvironmentVariables.Add("DOCKER_CERT_PATH");
        EnvironmentVariables.Add("DOCKER_TLS");
        EnvironmentVariables.Add("DOCKER_TLS_VERIFY");
        EnvironmentVariables.Add("TESTCONTAINERS_HOST_OVERRIDE");
        EnvironmentVariables.Add("TESTCONTAINERS_DOCKER_SOCKET_OVERRIDE");
        EnvironmentVariables.Add("TESTCONTAINERS_RYUK_DISABLED");
        EnvironmentVariables.Add("TESTCONTAINERS_RYUK_CONTAINER_PRIVILEGED");
        EnvironmentVariables.Add("TESTCONTAINERS_RYUK_CONTAINER_IMAGE");
        EnvironmentVariables.Add("TESTCONTAINERS_HUB_IMAGE_NAME_PREFIX");
        EnvironmentVariables.Add("TESTCONTAINERS_WAIT_STRATEGY_RETRIES");
        EnvironmentVariables.Add("TESTCONTAINERS_WAIT_STRATEGY_INTERVAL");
        EnvironmentVariables.Add("TESTCONTAINERS_WAIT_STRATEGY_TIMEOUT");
        EnvironmentVariables.Add("TESTCONTAINERS_NAMED_PIPE_CONNECTION_TIMEOUT");
      }

      [Theory]
      [InlineData("", "", null)]
      [InlineData("DOCKER_API_VERSION", "", null)]
      [InlineData("DOCKER_API_VERSION", "version", null)]
      [InlineData("DOCKER_API_VERSION", "1.52", "1.52")]
      public void GetDockerApiVersionCustomConfiguration(string propertyName, string propertyValue, string expected)
      {
        SetEnvironmentVariable(propertyName, propertyValue);
        ICustomConfiguration customConfiguration = new EnvironmentConfiguration();
        Assert.Equal(expected, customConfiguration.GetDockerApiVersion()?.ToString());
      }

      [Theory]
      [InlineData("", "", null)]
      [InlineData("DOCKER_CONFIG", "", null)]
      [InlineData("DOCKER_CONFIG", "~/.docker/", "~/.docker/")]
      public void GetDockerConfigCustomConfiguration(string propertyName, string propertyValue, string expected)
      {
        SetEnvironmentVariable(propertyName, propertyValue);
        ICustomConfiguration customConfiguration = new EnvironmentConfiguration();
        Assert.Equal(expected, customConfiguration.GetDockerConfig());
      }

      [Theory]
      [InlineData("", "", null)]
      [InlineData("DOCKER_HOST", "", null)]
      [InlineData("DOCKER_HOST", "tcp://127.0.0.1:2375/", "tcp://127.0.0.1:2375/")]
      public void GetDockerHostCustomConfiguration(string propertyName, string propertyValue, string expected)
      {
        SetEnvironmentVariable(propertyName, propertyValue);
        ICustomConfiguration customConfiguration = new EnvironmentConfiguration();
        Assert.Equal(expected, customConfiguration.GetDockerHost()?.ToString());
      }

      [Theory]
      [InlineData("", "", null)]
      [InlineData("DOCKER_CONTEXT", "", null)]
      [InlineData("DOCKER_CONTEXT", "default", "default")]
      public void GetDockerContextCustomConfiguration(string propertyName, string propertyValue, string expected)
      {
        SetEnvironmentVariable(propertyName, propertyValue);
        ICustomConfiguration customConfiguration = new EnvironmentConfiguration();
        Assert.Equal(expected, customConfiguration.GetDockerContext());
      }

      [Theory]
      [InlineData("", "", null)]
      [InlineData("TESTCONTAINERS_HOST_OVERRIDE", "", null)]
      [InlineData("TESTCONTAINERS_HOST_OVERRIDE", "docker.svc.local", "docker.svc.local")]
      public void GetDockerHostOverrideCustomConfiguration(string propertyName, string propertyValue, string expected)
      {
        SetEnvironmentVariable(propertyName, propertyValue);
        ICustomConfiguration customConfiguration = new EnvironmentConfiguration();
        Assert.Equal(expected, customConfiguration.GetDockerHostOverride());
      }

      [Theory]
      [InlineData("", "", null)]
      [InlineData("TESTCONTAINERS_DOCKER_SOCKET_OVERRIDE", "", null)]
      [InlineData("TESTCONTAINERS_DOCKER_SOCKET_OVERRIDE", "/var/run/docker.sock", "/var/run/docker.sock")]
      public void GetDockerSocketOverrideCustomConfiguration(string propertyName, string propertyValue, string expected)
      {
        SetEnvironmentVariable(propertyName, propertyValue);
        ICustomConfiguration customConfiguration = new EnvironmentConfiguration();
        Assert.Equal(expected, customConfiguration.GetDockerSocketOverride());
      }

      [Theory]
      [InlineData("", "", null)]
      [InlineData("DOCKER_AUTH_CONFIG", "", null)]
      [InlineData("DOCKER_AUTH_CONFIG", "{jsonReaderException}", null)]
      [InlineData("DOCKER_AUTH_CONFIG", "{}", "{}")]
      [InlineData("DOCKER_AUTH_CONFIG", "{\"auths\":null}", "{\"auths\":null}")]
      [InlineData("DOCKER_AUTH_CONFIG", "{\"auths\":{}}", "{\"auths\":{}}")]
      [InlineData("DOCKER_AUTH_CONFIG", "{\"auths\":{\"ghcr.io\":{}}}", "{\"auths\":{\"ghcr.io\":{}}}")]
      public void GetDockerAuthConfigCustomConfiguration(string propertyName, string propertyValue, string expected)
      {
        SetEnvironmentVariable(propertyName, propertyValue);
        ICustomConfiguration customConfiguration = new EnvironmentConfiguration();
        Assert.Equal(expected, customConfiguration.GetDockerAuthConfig()?.RootElement.ToString());
      }

      [Theory]
      [InlineData("", "", null)]
      [InlineData("DOCKER_CERT_PATH", "", null)]
      [InlineData("DOCKER_CERT_PATH", "/home/docker/.docker/certs", "/home/docker/.docker/certs")]
      public void GetDockerCertPathCustomConfiguration(string propertyName, string propertyValue, string expected)
      {
        SetEnvironmentVariable(propertyName, propertyValue);
        ICustomConfiguration customConfiguration = new EnvironmentConfiguration();
        Assert.Equal(expected, customConfiguration.GetDockerCertPath());
      }

      [Theory]
      [InlineData("", "", false)]
      [InlineData("DOCKER_TLS", "", false)]
      [InlineData("DOCKER_TLS", "0", false)]
      [InlineData("DOCKER_TLS", "FALSE", false)]
      [InlineData("DOCKER_TLS", "false", false)]
      [InlineData("DOCKER_TLS", "1", true)]
      [InlineData("DOCKER_TLS", "TRUE", true)]
      [InlineData("DOCKER_TLS", "true", true)]
      public void GetDockerTlsCustomConfiguration(string propertyName, string propertyValue, bool expected)
      {
        SetEnvironmentVariable(propertyName, propertyValue);
        ICustomConfiguration customConfiguration = new EnvironmentConfiguration();
        Assert.Equal(expected, customConfiguration.GetDockerTls());
      }

      [Theory]
      [InlineData("", "", false)]
      [InlineData("DOCKER_TLS_VERIFY", "", false)]
      [InlineData("DOCKER_TLS_VERIFY", "0", false)]
      [InlineData("DOCKER_TLS_VERIFY", "FALSE", false)]
      [InlineData("DOCKER_TLS_VERIFY", "false", false)]
      [InlineData("DOCKER_TLS_VERIFY", "1", true)]
      [InlineData("DOCKER_TLS_VERIFY", "TRUE", true)]
      [InlineData("DOCKER_TLS_VERIFY", "true", true)]
      public void GetDockerTlsVerifyCustomConfiguration(string propertyName, string propertyValue, bool expected)
      {
        SetEnvironmentVariable(propertyName, propertyValue);
        ICustomConfiguration customConfiguration = new EnvironmentConfiguration();
        Assert.Equal(expected, customConfiguration.GetDockerTlsVerify());
      }

      [Theory]
      [InlineData("", "", false)]
      [InlineData("TESTCONTAINERS_RYUK_DISABLED", "", false)]
      [InlineData("TESTCONTAINERS_RYUK_DISABLED", "false", false)]
      [InlineData("TESTCONTAINERS_RYUK_DISABLED", "true", true)]
      public void GetRyukDisabledCustomConfiguration(string propertyName, string propertyValue, bool expected)
      {
        SetEnvironmentVariable(propertyName, propertyValue);
        ICustomConfiguration customConfiguration = new EnvironmentConfiguration();
        Assert.Equal(expected, customConfiguration.GetRyukDisabled());
      }

      [Theory]
      [InlineData("", "", null)]
      [InlineData("TESTCONTAINERS_RYUK_CONTAINER_PRIVILEGED", "", null)]
      [InlineData("TESTCONTAINERS_RYUK_CONTAINER_PRIVILEGED", "false", false)]
      [InlineData("TESTCONTAINERS_RYUK_CONTAINER_PRIVILEGED", "true", true)]
      public void GetRyukContainerPrivilegedCustomConfiguration(string propertyName, string propertyValue, bool? expected)
      {
        SetEnvironmentVariable(propertyName, propertyValue);
        ICustomConfiguration customConfiguration = new EnvironmentConfiguration();
        Assert.Equal(expected, customConfiguration.GetRyukContainerPrivileged());
      }

      [Theory]
      [InlineData("", "", null)]
      [InlineData("TESTCONTAINERS_RYUK_CONTAINER_IMAGE", "", null)]
      [InlineData("TESTCONTAINERS_RYUK_CONTAINER_IMAGE", "alpine:latest", "alpine:latest")]
      public void GetRyukContainerImageCustomConfiguration(string propertyName, string propertyValue, string expected)
      {
        SetEnvironmentVariable(propertyName, propertyValue);
        ICustomConfiguration customConfiguration = new EnvironmentConfiguration();
        Assert.Equal(expected, customConfiguration.GetRyukContainerImage()?.FullName);
      }

      [Theory]
      [InlineData("", "", null)]
      [InlineData("TESTCONTAINERS_HUB_IMAGE_NAME_PREFIX", "", null)]
      [InlineData("TESTCONTAINERS_HUB_IMAGE_NAME_PREFIX", "my.proxy.com", "my.proxy.com")]
      public void GetHubImageNamePrefixCustomConfiguration(string propertyName, string propertyValue, string expected)
      {
        SetEnvironmentVariable(propertyName, propertyValue);
        ICustomConfiguration customConfiguration = new EnvironmentConfiguration();
        Assert.Equal(expected, customConfiguration.GetHubImageNamePrefix());
      }

      [Theory]
      [InlineData("", "", null)]
      [InlineData("TESTCONTAINERS_WAIT_STRATEGY_RETRIES", "", null)]
      [InlineData("TESTCONTAINERS_WAIT_STRATEGY_RETRIES", "1", 1)]
      public void GetWaitStrategyRetriesCustomConfiguration(string propertyName, string propertyValue, int? expected)
      {
        SetEnvironmentVariable(propertyName, propertyValue);
        ICustomConfiguration customConfiguration = new EnvironmentConfiguration();
        Assert.Equal(expected, customConfiguration.GetWaitStrategyRetries());
      }

      [Theory]
      [InlineData("", "", null)]
      [InlineData("TESTCONTAINERS_WAIT_STRATEGY_INTERVAL", "", null)]
      [InlineData("TESTCONTAINERS_WAIT_STRATEGY_INTERVAL", "-00:00:00.001", null)]
      [InlineData("TESTCONTAINERS_WAIT_STRATEGY_INTERVAL", "00:00:01", "00:00:01")]
      public void GetWaitStrategyIntervalCustomConfiguration(string propertyName, string propertyValue, string expected)
      {
        SetEnvironmentVariable(propertyName, propertyValue);
        ICustomConfiguration customConfiguration = new EnvironmentConfiguration();
        Assert.Equal(expected, customConfiguration.GetWaitStrategyInterval()?.ToString());
      }

      [Theory]
      [InlineData("", "", null)]
      [InlineData("TESTCONTAINERS_WAIT_STRATEGY_TIMEOUT", "", null)]
      [InlineData("TESTCONTAINERS_WAIT_STRATEGY_TIMEOUT", "-00:00:00.001", null)]
      [InlineData("TESTCONTAINERS_WAIT_STRATEGY_TIMEOUT", "00:00:01", "00:00:01")]
      public void GetWaitStrategyTimeoutCustomConfiguration(string propertyName, string propertyValue, string expected)
      {
        SetEnvironmentVariable(propertyName, propertyValue);
        ICustomConfiguration customConfiguration = new EnvironmentConfiguration();
        Assert.Equal(expected, customConfiguration.GetWaitStrategyTimeout()?.ToString());
      }

      [Theory]
      [InlineData("", "", null)]
      [InlineData("TESTCONTAINERS_NAMED_PIPE_CONNECTION_TIMEOUT", "", null)]
      [InlineData("TESTCONTAINERS_NAMED_PIPE_CONNECTION_TIMEOUT", "-00:00:00.001", null)]
      [InlineData("TESTCONTAINERS_NAMED_PIPE_CONNECTION_TIMEOUT", "00:00:01", "00:00:01")]
      public void GetNamedPipeConnectionTimeoutCustomConfiguration(string propertyName, string propertyValue, string expected)
      {
        SetEnvironmentVariable(propertyName, propertyValue);
        ICustomConfiguration customConfiguration = new EnvironmentConfiguration();
        Assert.Equal(expected, customConfiguration.GetNamedPipeConnectionTimeout()?.ToString());
      }

      public void Dispose()
      {
        foreach (var propertyName in EnvironmentVariables)
        {
          SetEnvironmentVariable(propertyName, null);
        }
      }

      private static void SetEnvironmentVariable(string propertyName, string propertyValue)
      {
        if (!string.IsNullOrEmpty(propertyName))
        {
          Environment.SetEnvironmentVariable(propertyName, propertyValue);
        }
      }
    }

    public sealed class PropertiesFileConfigurationTest
    {
      [Theory]
      [InlineData("", null)]
      [InlineData("docker.api.version=", null)]
      [InlineData("docker.api.version=version", null)]
      [InlineData("docker.api.version=1.52", "1.52")]
      public void GetDockerApiVersionCustomConfiguration(string configuration, string expected)
      {
        ICustomConfiguration customConfiguration = new PropertiesFileConfiguration(new[] { configuration });
        Assert.Equal(expected, customConfiguration.GetDockerApiVersion()?.ToString());
      }

      [Theory]
      [InlineData("", null)]
      [InlineData("docker.config=", null)]
      [InlineData("docker.config=~/.docker/", "~/.docker/")]
      public void GetDockerConfigCustomConfiguration(string configuration, string expected)
      {
        ICustomConfiguration customConfiguration = new PropertiesFileConfiguration(new[] { configuration });
        Assert.Equal(expected, customConfiguration.GetDockerConfig());
      }

      [Theory]
      [InlineData("", null)]
      [InlineData("docker.host=", null)]
      [InlineData("docker.host=tcp://127.0.0.1:2375/", "tcp://127.0.0.1:2375/")]
      public void GetDockerHostCustomConfiguration(string configuration, string expected)
      {
        ICustomConfiguration customConfiguration = new PropertiesFileConfiguration(new[] { configuration });
        Assert.Equal(expected, customConfiguration.GetDockerHost()?.ToString());
      }

      [Theory]
      [InlineData("", null)]
      [InlineData("docker.context=", null)]
      [InlineData("docker.context=default", "default")]
      public void GetDockerContextCustomConfiguration(string configuration, string expected)
      {
        ICustomConfiguration customConfiguration = new PropertiesFileConfiguration(new[] { configuration });
        Assert.Equal(expected, customConfiguration.GetDockerContext());
      }

      [Theory]
      [InlineData("", null)]
      [InlineData("host.override=", null)]
      [InlineData("host.override=docker.svc.local", "docker.svc.local")]
      public void GetDockerHostOverrideCustomConfiguration(string configuration, string expected)
      {
        ICustomConfiguration customConfiguration = new PropertiesFileConfiguration(new[] { configuration });
        Assert.Equal(expected, customConfiguration.GetDockerHostOverride());
      }

      [Theory]
      [InlineData("", null)]
      [InlineData("docker.socket.override=", null)]
      [InlineData("docker.socket.override=/var/run/docker.sock", "/var/run/docker.sock")]
      public void GetDockerSocketOverrideCustomConfiguration(string configuration, string expected)
      {
        ICustomConfiguration customConfiguration = new PropertiesFileConfiguration(new[] { configuration });
        Assert.Equal(expected, customConfiguration.GetDockerSocketOverride());
      }

      [Theory]
      [InlineData("", null)]
      [InlineData("docker.auth.config=", null)]
      [InlineData("docker.auth.config={jsonReaderException}", null)]
      [InlineData("docker.auth.config={}", "{}")]
      [InlineData("docker.auth.config={\"auths\":null}", "{\"auths\":null}")]
      [InlineData("docker.auth.config={\"auths\":{}}", "{\"auths\":{}}")]
      [InlineData("docker.auth.config={\"auths\":{\"ghcr.io\":{}}}", "{\"auths\":{\"ghcr.io\":{}}}")]
      public void GetDockerAuthConfigCustomConfiguration(string configuration, string expected)
      {
        ICustomConfiguration customConfiguration = new PropertiesFileConfiguration(new[] { configuration });
        Assert.Equal(expected, customConfiguration.GetDockerAuthConfig()?.RootElement.ToString());
      }

      [Theory]
      [InlineData("", null)]
      [InlineData("docker.cert.path=", null)]
      [InlineData("docker.cert.path=/home/docker/.docker/certs", "/home/docker/.docker/certs")]
      public void GetDockerCertPathCustomConfiguration(string configuration, string expected)
      {
        ICustomConfiguration customConfiguration = new PropertiesFileConfiguration(new[] { configuration });
        Assert.Equal(expected, customConfiguration.GetDockerCertPath());
      }

      [Theory]
      [InlineData("", false)]
      [InlineData("docker.tls=", false)]
      [InlineData("docker.tls=0", false)]
      [InlineData("docker.tls=FALSE", false)]
      [InlineData("docker.tls=false", false)]
      [InlineData("docker.tls=1", true)]
      [InlineData("docker.tls=TRUE", true)]
      [InlineData("docker.tls=true", true)]
      public void GetDockerTlsCustomConfiguration(string configuration, bool expected)
      {
        ICustomConfiguration customConfiguration = new PropertiesFileConfiguration(new[] { configuration });
        Assert.Equal(expected, customConfiguration.GetDockerTls());
      }

      [Theory]
      [InlineData("", false)]
      [InlineData("docker.tls.verify=", false)]
      [InlineData("docker.tls.verify=0", false)]
      [InlineData("docker.tls.verify=FALSE", false)]
      [InlineData("docker.tls.verify=false", false)]
      [InlineData("docker.tls.verify=1", true)]
      [InlineData("docker.tls.verify=TRUE", true)]
      [InlineData("docker.tls.verify=true", true)]
      public void GetDockerTlsVerifyCustomConfiguration(string configuration, bool expected)
      {
        ICustomConfiguration customConfiguration = new PropertiesFileConfiguration(new[] { configuration });
        Assert.Equal(expected, customConfiguration.GetDockerTlsVerify());
      }

      [Theory]
      [InlineData("", false)]
      [InlineData("ryuk.disabled=", false)]
      [InlineData("ryuk.disabled=false", false)]
      [InlineData("ryuk.disabled=true", true)]
      public void GetRyukDisabledCustomConfiguration(string configuration, bool expected)
      {
        ICustomConfiguration customConfiguration = new PropertiesFileConfiguration(new[] { configuration });
        Assert.Equal(expected, customConfiguration.GetRyukDisabled());
      }

      [Theory]
      [InlineData("", null)]
      [InlineData("ryuk.container.privileged=", null)]
      [InlineData("ryuk.container.privileged=false", false)]
      [InlineData("ryuk.container.privileged=true", true)]
      public void GetRyukContainerPrivilegedCustomConfiguration(string configuration, bool? expected)
      {
        ICustomConfiguration customConfiguration = new PropertiesFileConfiguration(new[] { configuration });
        Assert.Equal(expected, customConfiguration.GetRyukContainerPrivileged());
      }

      [Theory]
      [InlineData("", null)]
      [InlineData("ryuk.container.image=", null)]
      [InlineData("ryuk.container.image=alpine:latest", "alpine:latest")]
      public void GetRyukContainerImageCustomConfiguration(string configuration, string expected)
      {
        ICustomConfiguration customConfiguration = new PropertiesFileConfiguration(new[] { configuration });
        Assert.Equal(expected, customConfiguration.GetRyukContainerImage()?.FullName);
      }

      [Theory]
      [InlineData("", null)]
      [InlineData("hub.image.name.prefix=", null)]
      [InlineData("hub.image.name.prefix=my.proxy.com", "my.proxy.com")]
      public void GetHubImageNamePrefixCustomConfiguration(string configuration, string expected)
      {
        ICustomConfiguration customConfiguration = new PropertiesFileConfiguration(new[] { configuration });
        Assert.Equal(expected, customConfiguration.GetHubImageNamePrefix());
      }

      [Theory]
      [InlineData("", null)]
      [InlineData("wait.strategy.retries=", null)]
      [InlineData("wait.strategy.retries=1", 1)]
      public void GetWaitStrategyRetriesCustomConfiguration(string configuration, int? expected)
      {
        ICustomConfiguration customConfiguration = new PropertiesFileConfiguration(new[] { configuration });
        Assert.Equal(expected, customConfiguration.GetWaitStrategyRetries());
      }

      [Theory]
      [InlineData("", null)]
      [InlineData("wait.strategy.interval=", null)]
      [InlineData("wait.strategy.interval=-00:00:00.001", null)]
      [InlineData("wait.strategy.interval=00:00:01", "00:00:01")]
      public void GetWaitStrategyIntervalCustomConfiguration(string configuration, string expected)
      {
        ICustomConfiguration customConfiguration = new PropertiesFileConfiguration(new[] { configuration });
        Assert.Equal(expected, customConfiguration.GetWaitStrategyInterval()?.ToString());
      }

      [Theory]
      [InlineData("", null)]
      [InlineData("wait.strategy.timeout=", null)]
      [InlineData("wait.strategy.timeout=-00:00:00.001", null)]
      [InlineData("wait.strategy.timeout=00:00:01", "00:00:01")]
      public void GetWaitStrategyTimeoutCustomConfiguration(string configuration, string expected)
      {
        ICustomConfiguration customConfiguration = new PropertiesFileConfiguration(new[] { configuration });
        Assert.Equal(expected, customConfiguration.GetWaitStrategyTimeout()?.ToString());
      }

      [Theory]
      [InlineData("", null)]
      [InlineData("named.pipe.connection.timeout=", null)]
      [InlineData("named.pipe.connection.timeout=-00:00:00.001", null)]
      [InlineData("named.pipe.connection.timeout=00:00:01", "00:00:01")]
      public void GetNamedPipeConnectionTimeoutCustomConfiguration(string configuration, string expected)
      {
        ICustomConfiguration customConfiguration = new PropertiesFileConfiguration(new[] { configuration });
        Assert.Equal(expected, customConfiguration.GetNamedPipeConnectionTimeout()?.ToString());
      }
    }
  }
}