feat: Add Consul module

Testcontainers.sln

@@ -17,6 +17,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.Azurite", "s
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.ClickHouse", "src\Testcontainers.ClickHouse\Testcontainers.ClickHouse.csproj", "{B061A78E-536E-4CA1-8401-234D5FBFBAB7}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.Consul", "src\Testcontainers.Consul\Testcontainers.Consul.csproj", "{51ED33B9-B688-401E-85F2-329D3C935BD1}"
+EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.CosmosDb", "src\Testcontainers.CosmosDb\Testcontainers.CosmosDb.csproj", "{A724806F-8C94-4438-8011-04A9A1575318}"
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.Couchbase", "src\Testcontainers.Couchbase\Testcontainers.Couchbase.csproj", "{58E94721-2681-4D82-8D94-0B2F9DB0D575}"
@@ -85,6 +87,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.ClickHouse.T
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.Commons", "tests\Testcontainers.Commons\Testcontainers.Commons.csproj", "{2478673C-B063-469D-ABD1-0C3E0A25541B}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.Consul.Tests", "tests\Testcontainers.Consul.Tests\Testcontainers.Consul.Tests.csproj", "{91B23679-A2A5-4132-8AFA-740CE40A88B6}"
+EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.CosmosDb.Tests", "tests\Testcontainers.CosmosDb.Tests\Testcontainers.CosmosDb.Tests.csproj", "{BD445A54-F411-4758-955E-397A1E98680C}"
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.Couchbase.Tests", "tests\Testcontainers.Couchbase.Tests\Testcontainers.Couchbase.Tests.csproj", "{809322BA-D690-4F2B-B884-23F895663963}"
@@ -172,6 +176,10 @@ Global
 		{B061A78E-536E-4CA1-8401-234D5FBFBAB7}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{B061A78E-536E-4CA1-8401-234D5FBFBAB7}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{B061A78E-536E-4CA1-8401-234D5FBFBAB7}.Release|Any CPU.Build.0 = Release|Any CPU
+		{51ED33B9-B688-401E-85F2-329D3C935BD1}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{51ED33B9-B688-401E-85F2-329D3C935BD1}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{51ED33B9-B688-401E-85F2-329D3C935BD1}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{51ED33B9-B688-401E-85F2-329D3C935BD1}.Release|Any CPU.Build.0 = Release|Any CPU
 		{A724806F-8C94-4438-8011-04A9A1575318}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{A724806F-8C94-4438-8011-04A9A1575318}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{A724806F-8C94-4438-8011-04A9A1575318}.Release|Any CPU.ActiveCfg = Release|Any CPU
@@ -308,6 +316,10 @@ Global
 		{2478673C-B063-469D-ABD1-0C3E0A25541B}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{2478673C-B063-469D-ABD1-0C3E0A25541B}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{2478673C-B063-469D-ABD1-0C3E0A25541B}.Release|Any CPU.Build.0 = Release|Any CPU
+		{91B23679-A2A5-4132-8AFA-740CE40A88B6}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{91B23679-A2A5-4132-8AFA-740CE40A88B6}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{91B23679-A2A5-4132-8AFA-740CE40A88B6}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{91B23679-A2A5-4132-8AFA-740CE40A88B6}.Release|Any CPU.Build.0 = Release|Any CPU
 		{BD445A54-F411-4758-955E-397A1E98680C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{BD445A54-F411-4758-955E-397A1E98680C}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{BD445A54-F411-4758-955E-397A1E98680C}.Release|Any CPU.ActiveCfg = Release|Any CPU
@@ -452,6 +464,7 @@ Global
 	GlobalSection(NestedProjects) = preSolution
 		{3F2E254F-C203-43FD-A078-DC3E2CBC0F9F} = {673F23AE-7694-4BB9-ABD4-136D6C13634E}
 		{B061A78E-536E-4CA1-8401-234D5FBFBAB7} = {673F23AE-7694-4BB9-ABD4-136D6C13634E}
+		{51ED33B9-B688-401E-85F2-329D3C935BD1} = {673F23AE-7694-4BB9-ABD4-136D6C13634E}
 		{A724806F-8C94-4438-8011-04A9A1575318} = {673F23AE-7694-4BB9-ABD4-136D6C13634E}
 		{58E94721-2681-4D82-8D94-0B2F9DB0D575} = {673F23AE-7694-4BB9-ABD4-136D6C13634E}
 		{DCECB1F6-D9AA-431F-AE42-25D56B9E7DFC} = {673F23AE-7694-4BB9-ABD4-136D6C13634E}
@@ -486,6 +499,7 @@ Global
 		{B272FDDE-5E01-425D-B9E1-10FF883DDAAA} = {7164F1FB-7F24-444A-ACD2-2C329C2B3CCF}
 		{9D0A0B32-4921-400C-99CB-8650677E3E44} = {7164F1FB-7F24-444A-ACD2-2C329C2B3CCF}
 		{2478673C-B063-469D-ABD1-0C3E0A25541B} = {7164F1FB-7F24-444A-ACD2-2C329C2B3CCF}
+		{91B23679-A2A5-4132-8AFA-740CE40A88B6} = {7164F1FB-7F24-444A-ACD2-2C329C2B3CCF}
 		{BD445A54-F411-4758-955E-397A1E98680C} = {7164F1FB-7F24-444A-ACD2-2C329C2B3CCF}
 		{809322BA-D690-4F2B-B884-23F895663963} = {7164F1FB-7F24-444A-ACD2-2C329C2B3CCF}
 		{E4520FB1-4466-4DCA-AD08-4075102C68D3} = {7164F1FB-7F24-444A-ACD2-2C329C2B3CCF}

src/Testcontainers.Consul/.editorconfig

@@ -0,0 +1 @@
+root = true

src/Testcontainers.Consul/ConsulBuilder.cs

@@ -0,0 +1,72 @@
+namespace Testcontainers.Consul;
+
+/// <inheritdoc cref="ContainerBuilder{TBuilderEntity, TContainerEntity, TConfigurationEntity}" />
+[PublicAPI]
+public sealed class ConsulBuilder : ContainerBuilder<ConsulBuilder, ConsulContainer, ConsulConfiguration>
+{
+    public const string ConsulImage = "consul:1.15";
+
+    public const int ConsulHttpPort = 8500;
+
+    public const int ConsulGrpcPort = 8502;
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="ConsulBuilder" /> class.
+    /// </summary>
+    public ConsulBuilder()
+        : this(new ConsulConfiguration())
+    {
+        DockerResourceConfiguration = Init().DockerResourceConfiguration;
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="ConsulBuilder" /> class.
+    /// </summary>
+    /// <param name="resourceConfiguration">The Docker resource configuration.</param>
+    private ConsulBuilder(ConsulConfiguration resourceConfiguration)
+        : base(resourceConfiguration)
+    {
+        DockerResourceConfiguration = resourceConfiguration;
+    }
+
+    /// <inheritdoc />
+    protected override ConsulConfiguration DockerResourceConfiguration { get; }
+
+    /// <inheritdoc />
+    public override ConsulContainer Build()
+    {
+        Validate();
+        return new ConsulContainer(DockerResourceConfiguration, TestcontainersSettings.Logger);
+    }
+
+    /// <inheritdoc />
+    protected override ConsulBuilder Init()
+    {
+        return base.Init()
+            .WithImage(ConsulImage)
+            .WithPortBinding(ConsulHttpPort, true)
+            .WithPortBinding(ConsulGrpcPort, true)
+            .WithCommand("agent", "-dev", "-client", "0.0.0.0")
+            .WithCreateParameterModifier(cmd => cmd.HostConfig.CapAdd = new[] { "IPC_LOCK" })
+            .WithWaitStrategy(Wait.ForUnixContainer().UntilHttpRequestIsSucceeded(request =>
+                request.ForPath("/v1/status/leader").ForPort(ConsulHttpPort)));
+    }
+
+    /// <inheritdoc />
+    protected override ConsulBuilder Clone(IResourceConfiguration<CreateContainerParameters> resourceConfiguration)
+    {
+        return Merge(DockerResourceConfiguration, new ConsulConfiguration(resourceConfiguration));
+    }
+
+    /// <inheritdoc />
+    protected override ConsulBuilder Clone(IContainerConfiguration resourceConfiguration)
+    {
+        return Merge(DockerResourceConfiguration, new ConsulConfiguration(resourceConfiguration));
+    }
+
+    /// <inheritdoc />
+    protected override ConsulBuilder Merge(ConsulConfiguration oldValue, ConsulConfiguration newValue)
+    {
+        return new ConsulBuilder(new ConsulConfiguration(oldValue, newValue));
+    }
+}

src/Testcontainers.Consul/ConsulConfiguration.cs

@@ -0,0 +1,53 @@
+namespace Testcontainers.Consul;
+
+/// <inheritdoc cref="ContainerConfiguration" />
+[PublicAPI]
+public sealed class ConsulConfiguration : ContainerConfiguration
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="ConsulConfiguration" /> class.
+    /// </summary>
+    public ConsulConfiguration()
+    {
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="ConsulConfiguration" /> class.
+    /// </summary>
+    /// <param name="resourceConfiguration">The Docker resource configuration.</param>
+    public ConsulConfiguration(IResourceConfiguration<CreateContainerParameters> resourceConfiguration)
+        : base(resourceConfiguration)
+    {
+        // Passes the configuration upwards to the base implementations to create an updated immutable copy.
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="ConsulConfiguration" /> class.
+    /// </summary>
+    /// <param name="resourceConfiguration">The Docker resource configuration.</param>
+    public ConsulConfiguration(IContainerConfiguration resourceConfiguration)
+        : base(resourceConfiguration)
+    {
+        // Passes the configuration upwards to the base implementations to create an updated immutable copy.
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="ConsulConfiguration" /> class.
+    /// </summary>
+    /// <param name="resourceConfiguration">The Docker resource configuration.</param>
+    public ConsulConfiguration(ConsulConfiguration resourceConfiguration)
+        : this(new ConsulConfiguration(), resourceConfiguration)
+    {
+        // Passes the configuration upwards to the base implementations to create an updated immutable copy.
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="ConsulConfiguration" /> class.
+    /// </summary>
+    /// <param name="oldValue">The old Docker resource configuration.</param>
+    /// <param name="newValue">The new Docker resource configuration.</param>
+    public ConsulConfiguration(ConsulConfiguration oldValue, ConsulConfiguration newValue)
+        : base(oldValue, newValue)
+    {
+    }
+}

src/Testcontainers.Consul/ConsulContainer.cs

@@ -0,0 +1,25 @@
+namespace Testcontainers.Consul;
+
+/// <inheritdoc cref="DockerContainer" />
+[PublicAPI]
+public sealed class ConsulContainer : DockerContainer
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="ConsulContainer" /> class.
+    /// </summary>
+    /// <param name="configuration">The container configuration.</param>
+    /// <param name="logger">The logger.</param>
+    public ConsulContainer(ConsulConfiguration configuration, ILogger logger)
+        : base(configuration, logger)
+    {
+    }
+
+    /// <summary>
+    /// Gets the Consul base address.
+    /// </summary>
+    /// <returns>The Consul base address.</returns>
+    public string GetBaseAddress()
+    {
+        return new UriBuilder(Uri.UriSchemeHttp, Hostname, GetMappedPublicPort(ConsulBuilder.ConsulHttpPort)).ToString();
+    }
+}

src/Testcontainers.Consul/Testcontainers.Consul.csproj

@@ -0,0 +1,13 @@
+<Project Sdk="Microsoft.NET.Sdk">
+    <PropertyGroup>
+        <TargetFrameworks>netstandard2.0;netstandard2.1</TargetFrameworks>
+        <LangVersion>latest</LangVersion>
+    </PropertyGroup>
+    <ItemGroup>
+        <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1" PrivateAssets="All"/>
+        <PackageReference Include="JetBrains.Annotations" Version="2022.3.1" PrivateAssets="All"/>
+    </ItemGroup>
+    <ItemGroup>
+        <ProjectReference Include="$(SolutionDir)src/Testcontainers/Testcontainers.csproj"/>
+    </ItemGroup>
+</Project>

src/Testcontainers.Consul/Usings.cs

@@ -0,0 +1,8 @@
+global using System;
+global using System.Net;
+global using Docker.DotNet.Models;
+global using DotNet.Testcontainers.Builders;
+global using DotNet.Testcontainers.Configurations;
+global using DotNet.Testcontainers.Containers;
+global using JetBrains.Annotations;
+global using Microsoft.Extensions.Logging;

tests/Testcontainers.Consul.Tests/.editorconfig

@@ -0,0 +1 @@
+root = true

tests/Testcontainers.Consul.Tests/ConsulContainerTest.cs

@@ -0,0 +1,45 @@
+namespace Testcontainers.Consul;
+
+public sealed class ConsulContainerTest : IAsyncLifetime
+{
+    private readonly ConsulContainer _consulContainer = new ConsulBuilder().Build();
+
+    public Task InitializeAsync()
+    {
+        return _consulContainer.StartAsync();
+    }
+
+    public Task DisposeAsync()
+    {
+        return _consulContainer.DisposeAsync().AsTask();
+    }
+
+    [Fact]
+    [Trait(nameof(DockerCli.DockerPlatform), nameof(DockerCli.DockerPlatform.Linux))]
+    public async Task GetItemReturnsPutItem()
+    {
+        // Given
+        const string helloWorld = "Hello, World!";
+
+        var key = Guid.NewGuid().ToString("D");
+
+        var expected = new KVPair(key);
+        expected.Value = Encoding.Default.GetBytes(helloWorld);
+
+        var consulClientConfiguration = new ConsulClientConfiguration();
+        consulClientConfiguration.Address = new Uri(_consulContainer.GetBaseAddress());
+
+        using var consulClient = new ConsulClient(consulClientConfiguration);
+
+        // When
+        _ = await consulClient.KV.Put(expected)
+            .ConfigureAwait(false);
+
+        var actual = await consulClient.KV.Get(key)
+            .ConfigureAwait(false);
+
+        // Then
+        Assert.Equal(HttpStatusCode.OK, actual.StatusCode);
+        Assert.Equal(helloWorld, Encoding.Default.GetString(actual.Response.Value));
+    }
+}

tests/Testcontainers.Consul.Tests/Testcontainers.Consul.Tests.csproj

@@ -0,0 +1,18 @@
+<Project Sdk="Microsoft.NET.Sdk">
+    <PropertyGroup>
+        <TargetFrameworks>net6.0</TargetFrameworks>
+        <IsPackable>false</IsPackable>
+        <IsPublishable>false</IsPublishable>
+    </PropertyGroup>
+    <ItemGroup>
+        <PackageReference Include="Consul" Version="1.6.10.9" />
+        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.7.2" />
+        <PackageReference Include="coverlet.collector" Version="6.0.0" />
+        <PackageReference Include="xunit.runner.visualstudio" Version="2.5.0" />
+        <PackageReference Include="xunit" Version="2.5.0" />
+    </ItemGroup>
+    <ItemGroup>
+        <ProjectReference Include="$(SolutionDir)src/Testcontainers.Consul/Testcontainers.Consul.csproj" />
+        <ProjectReference Include="$(SolutionDir)tests/Testcontainers.Commons/Testcontainers.Commons.csproj" />
+    </ItemGroup>
+</Project>

tests/Testcontainers.Consul.Tests/Usings.cs

@@ -0,0 +1,7 @@
+global using System;
+global using System.Net;
+global using System.Text;
+global using System.Threading.Tasks;
+global using Consul;
+global using DotNet.Testcontainers.Commons;
+global using Xunit;