Migrate HealthChecks.Elasticsearch tests to Testcontainers

.github/workflows/healthchecks_elasticsearch_ci.yml

@@ -29,47 +29,8 @@ on:
 
 jobs:
   build:
-    runs-on: ubuntu-latest
-    services:
-      elasticsearch:
-        image: docker.elastic.co/elasticsearch/elasticsearch:6.3.2
-        ports:
-          - 9300:9300
-          - 9201:9200
-    steps:
-      - uses: actions/checkout@v3
-      - name: Setup .NET
-        uses: actions/setup-dotnet@v4
-        with:
-          dotnet-version: |
-            8.0.x
-            9.0.x
-      - run:
-          ln -s /usr/libexec/docker/cli-plugins/docker-compose /usr/local/bin/docker-compose
-      - name: Restore
-        run: |
-          dotnet restore ./src/HealthChecks.Elasticsearch/HealthChecks.Elasticsearch.csproj &&
-          dotnet restore ./test/HealthChecks.Elasticsearch.Tests/HealthChecks.Elasticsearch.Tests.csproj
-      - name: Check formatting
-        run: |
-          dotnet format --no-restore --verify-no-changes --severity warn ./src/HealthChecks.Elasticsearch/HealthChecks.Elasticsearch.csproj || (echo "Run 'dotnet format' to fix issues" && exit 1) &&
-          dotnet format --no-restore --verify-no-changes --severity warn ./test/HealthChecks.Elasticsearch.Tests/HealthChecks.Elasticsearch.Tests.csproj || (echo "Run 'dotnet format' to fix issues" && exit 1)
-      - name: Build
-        run: |
-          dotnet build --no-restore ./src/HealthChecks.Elasticsearch/HealthChecks.Elasticsearch.csproj &&
-          dotnet build --no-restore ./test/HealthChecks.Elasticsearch.Tests/HealthChecks.Elasticsearch.Tests.csproj
-      - name: Test
-        run: >
-          dotnet test
-          ./test/HealthChecks.Elasticsearch.Tests/HealthChecks.Elasticsearch.Tests.csproj
-          --no-restore
-          --no-build
-          --collect "XPlat Code Coverage"
-          --results-directory .coverage
-          --
-          DataCollectionRunSettings.DataCollectors.DataCollector.Configuration.Format=opencover
-      - name: Upload Coverage
-        uses: codecov/codecov-action@v5
-        with:
-          flags: Elasticsearch
-          directory: .coverage
+    uses: ./.github/workflows/reusable_ci_workflow.yml
+    with:
+      PROJECT_PATH: ./src/HealthChecks.Elasticsearch/HealthChecks.Elasticsearch.csproj
+      TEST_PROJECT_PATH: ./test/HealthChecks.Elasticsearch.Tests/HealthChecks.Elasticsearch.Tests.csproj
+      CODECOV_FLAGS: Elasticsearch

Directory.Packages.props

@@ -29,7 +29,6 @@
     <PackageVersion Include="coverlet.collector" Version="6.0.0" />
     <PackageVersion Include="Dapr.Client" Version="1.12.0" />
     <PackageVersion Include="DogStatsD-CSharp-Client" Version="8.0.0" />
-    <PackageVersion Include="Ductus.FluentDocker" Version="2.10.59" />
     <PackageVersion Include="Elastic.Clients.Elasticsearch" Version="8.14.3" />
     <PackageVersion Include="EventStore.Client" Version="22.0.0" />
     <PackageVersion Include="EventStore.Client.Grpc.Streams" Version="23.1.0" />
@@ -104,6 +103,7 @@
     <PackageVersion Include="System.Threading.Channels" Version="8.0.0" />
     <PackageVersion Include="Testcontainers" Version="$(TestcontainersVersion)" />
     <PackageVersion Include="Testcontainers.ClickHouse" Version="$(TestcontainersVersion)" />
+    <PackageVersion Include="Testcontainers.Elasticsearch" Version="$(TestcontainersVersion)" />
     <PackageVersion Include="Testcontainers.Kafka" Version="$(TestcontainersVersion)" />
     <PackageVersion Include="Testcontainers.Milvus" Version="$(TestcontainersVersion)" />
     <PackageVersion Include="Testcontainers.PostgreSql" Version="$(TestcontainersVersion)" />
@@ -119,4 +119,4 @@
   <ItemGroup Condition="'$(IsPackable)' == 'true'">
     <PackageVersion Include="Microsoft.SourceLink.GitHub" Version="8.0.0" />
   </ItemGroup>
-</Project>
+</Project>

test/HealthChecks.Elasticsearch.Tests/ElasticsearchContainerFixture.cs

@@ -0,0 +1,107 @@
+using System.Net;
+using System.Net.Http.Headers;
+using System.Net.Http.Json;
+using System.Text;
+using System.Text.Json;
+using Testcontainers.Elasticsearch;
+
+namespace HealthChecks.Elasticsearch.Tests;
+
+public class ElasticsearchContainerFixture : IAsyncLifetime
+{
+    private const string Registry = "docker.io";
+
+    private const string Image = "library/elasticsearch";
+
+    private const string Tag = "8.19.2";
+
+    private const string ApiKeyName = "healthchecks";
+
+    private string? _apiKey;
+
+    public string Username => ElasticsearchBuilder.DefaultUsername;
+
+    public string Password => ElasticsearchBuilder.DefaultPassword;
+
+    public ElasticsearchContainer? Container { get; private set; }
+
+    public string GetConnectionString()
+    {
+        if (Container is null)
+        {
+            throw new InvalidOperationException("The test container was not initialized.");
+        }
+
+        return Container.GetConnectionString();
+    }
+
+    public string GetApiKey()
+    {
+        if (Container is null)
+        {
+            throw new InvalidOperationException("The test container was not initialized.");
+        }
+
+        return _apiKey ?? throw new InvalidOperationException("The API key was not initialized.");
+    }
+
+    public async Task InitializeAsync()
+    {
+        Container = await CreateContainerAsync();
+
+        await SetupApiKeyAsync();
+    }
+
+    public Task DisposeAsync() => Container?.DisposeAsync().AsTask() ?? Task.CompletedTask;
+
+    private static async Task<ElasticsearchContainer?> CreateContainerAsync()
+    {
+        var container = new ElasticsearchBuilder()
+            .WithImage($"{Registry}/{Image}:{Tag}")
+            .Build();
+
+        await container.StartAsync();
+
+        return container;
+    }
+
+    private async Task SetupApiKeyAsync()
+    {
+        if (Container is null)
+        {
+            throw new InvalidOperationException("The test container was not initialized.");
+        }
+
+        var handler = new HttpClientHandler
+        {
+            ServerCertificateCustomValidationCallback = delegate
+            {
+                return true;
+            }
+        };
+
+        using var httpClient = new HttpClient(handler);
+
+        httpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue(
+            nameof(AuthenticationSchemes.Basic),
+            Convert.ToBase64String(Encoding.ASCII.GetBytes(
+                $"{ElasticsearchBuilder.DefaultUsername}:{ElasticsearchBuilder.DefaultPassword}")));
+
+        var uriBuilder = new UriBuilder(
+            Uri.UriSchemeHttps,
+            Container.Hostname,
+            Container.GetMappedPublicPort(ElasticsearchBuilder.ElasticsearchHttpsPort),
+            "/_security/api_key");
+
+        using var response = await httpClient
+            .PostAsJsonAsync(uriBuilder.Uri, new { name = ApiKeyName })
+            .ConfigureAwait(false);
+
+        var apiKeyResponse = await response.Content.ReadFromJsonAsync<ApiKeyResponse>().ConfigureAwait(false)
+                             ?? throw new JsonException();
+
+        _apiKey = apiKeyResponse.Encoded;
+    }
+
+    private record ApiKeyResponse(string Encoded);
+}

test/HealthChecks.Elasticsearch.Tests/Functional/ElasticsearchAuthenticationTests.cs

@@ -1,21 +1,14 @@
 using System.Net;
-using HealthChecks.Elasticsearch.Tests.Fixtures;
 
 namespace HealthChecks.Elasticsearch.Tests.Functional;
 
-public class ElasticsearchAuthenticationTests : IClassFixture<ElasticContainerFixture>
+public class ElasticsearchAuthenticationTests(ElasticsearchContainerFixture elasticsearchFixture) : IClassFixture<ElasticsearchContainerFixture>
 {
-    private readonly ElasticContainerFixture _fixture;
-
-    public ElasticsearchAuthenticationTests(ElasticContainerFixture fixture)
-    {
-        _fixture = fixture;
-    }
-
     [Fact]
     public async Task be_healthy_if_elasticsearch_is_using_valid_api_key()
     {
-        var connectionString = @"https://localhost:9200";
+        string connectionString = elasticsearchFixture.GetConnectionString();
+        string apiKey = elasticsearchFixture.GetApiKey();
 
         var webHostBuilder = new WebHostBuilder()
             .ConfigureServices(services =>
@@ -24,7 +17,7 @@ public async Task be_healthy_if_elasticsearch_is_using_valid_api_key()
                     .AddElasticsearch(options =>
                     {
                         options.UseServer(connectionString);
-                        options.UseApiKey(_fixture.ApiKey!);
+                        options.UseApiKey(apiKey);
                         options.UseCertificateValidationCallback(delegate
                         {
                             return true;
@@ -50,7 +43,7 @@ public async Task be_healthy_if_elasticsearch_is_using_valid_api_key()
     [Fact]
     public async Task be_healthy_if_elasticsearch_is_using_valid_user_and_password()
     {
-        var connectionString = @"https://localhost:9200";
+        string connectionString = elasticsearchFixture.GetConnectionString();
 
         var webHostBuilder = new WebHostBuilder()
             .ConfigureServices(services =>
@@ -59,7 +52,7 @@ public async Task be_healthy_if_elasticsearch_is_using_valid_user_and_password()
                     .AddElasticsearch(options =>
                     {
                         options.UseServer(connectionString);
-                        options.UseBasicAuthentication("elastic", ElasticContainerFixture.ELASTIC_PASSWORD);
+                        options.UseBasicAuthentication(elasticsearchFixture.Username, elasticsearchFixture.Password);
                         options.UseCertificateValidationCallback(delegate
                         {
                             return true;

test/HealthChecks.Elasticsearch.Tests/Functional/ElasticsearchHealthCheckTests.cs

@@ -2,18 +2,20 @@
 
 namespace HealthChecks.Elasticsearch.Tests.Functional;
 
-public class elasticsearch_healthcheck_should
+public class elasticsearch_healthcheck_should(ElasticsearchContainerFixture elasticsearchFixture) : IClassFixture<ElasticsearchContainerFixture>
 {
     [Fact]
     public async Task be_healthy_if_elasticsearch_is_available()
     {
-        var connectionString = @"http://localhost:9201";
+        string connectionString = elasticsearchFixture.GetConnectionString();
 
         var webHostBuilder = new WebHostBuilder()
         .ConfigureServices(services =>
         {
             services.AddHealthChecks()
-             .AddElasticsearch(connectionString, tags: ["elasticsearch"]);
+             .AddElasticsearch(options => options
+                 .UseServer(connectionString)
+                 .UseCertificateValidationCallback((_, _, _, _) => true), tags: ["elasticsearch"]);
         })
         .Configure(app =>
         {

test/HealthChecks.Elasticsearch.Tests/HealthChecks.Elasticsearch.Tests.csproj

@@ -7,7 +7,6 @@
 
   <ItemGroup>
     <ProjectReference Include="..\..\src\HealthChecks.Elasticsearch\HealthChecks.Elasticsearch.csproj" />
-    <PackageReference Include="Ductus.FluentDocker" />
   </ItemGroup>
 
   <ItemGroup>
@@ -16,4 +15,8 @@
     </None>
   </ItemGroup>
 
+  <ItemGroup>
+    <PackageReference Include="Testcontainers.Elasticsearch" />
+  </ItemGroup>
+
 </Project>