Migrate HealthChecks.Kafka tests to Testcontainers (#2365)

* Migrate HealthChecks.Kafka tests to Testcontainers

* Apply suggestions from code review

---------

Co-authored-by: Adam Sitnik <[email protected]>

Author: Alirexaa

.github/workflows/healthchecks_kafka_ci.yml

@@ -29,60 +29,8 @@ on:
 
 jobs:
   build:
-    runs-on: ubuntu-latest
-    services:
-      zookeeper:
-        image: confluentinc/cp-zookeeper:latest
-        ports:
-          - 2181:2181
-        env:
-         ZOOKEEPER_CLIENT_PORT: 2181
-         ZOOKEEPER_TICK_TIME: 2000
-      kafka:
-        image: confluentinc/cp-kafka:latest
-        ports:
-         - 9092:9092	
-         - 29092:29092
-        env:
-          KAFKA_ADVERTISED_HOST_NAME: localhost
-          KAFKA_ZOOKEEPER_CONNECT: zookeeper:2181
-          KAFKA_BROKER_ID: 1
-          KAFKA_ADVERTISED_LISTENERS: PLAINTEXT://localhost:9092,PLAINTEXT_HOST://localhost:29092
-          KAFKA_LISTENER_SECURITY_PROTOCOL_MAP: PLAINTEXT:PLAINTEXT,PLAINTEXT_HOST:PLAINTEXT
-          KAFKA_INTER_BROKER_LISTENER_NAME: PLAINTEXT
-          KAFKA_OFFSETS_TOPIC_REPLICATION_FACTOR: 1
-    steps:
-      - uses: actions/checkout@v3
-      - name: Setup .NET
-        uses: actions/setup-dotnet@v4
-        with:
-          dotnet-version: |
-            8.0.x
-            9.0.x
-      - name: Restore
-        run: |
-          dotnet restore ./src/HealthChecks.Kafka/HealthChecks.Kafka.csproj &&
-          dotnet restore ./test/HealthChecks.Kafka.Tests/HealthChecks.Kafka.Tests.csproj
-      - name: Check formatting
-        run: |
-          dotnet format --no-restore --verify-no-changes --severity warn ./src/HealthChecks.Kafka/HealthChecks.Kafka.csproj || (echo "Run 'dotnet format' to fix issues" && exit 1) &&
-          dotnet format --no-restore --verify-no-changes --severity warn ./test/HealthChecks.Kafka.Tests/HealthChecks.Kafka.Tests.csproj || (echo "Run 'dotnet format' to fix issues" && exit 1)
-      - name: Build
-        run: |
-          dotnet build --no-restore ./src/HealthChecks.Kafka/HealthChecks.Kafka.csproj &&
-          dotnet build --no-restore ./test/HealthChecks.Kafka.Tests/HealthChecks.Kafka.Tests.csproj
-      - name: Test
-        run: >
-          dotnet test
-          ./test/HealthChecks.Kafka.Tests/HealthChecks.Kafka.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: Kafka
-          directory: .coverage
+    uses: ./.github/workflows/reusable_ci_workflow.yml
+    with:
+      PROJECT_PATH: ./src/HealthChecks.Kafka/HealthChecks.Kafka.csproj
+      TEST_PROJECT_PATH: ./test/HealthChecks.Kafka.Tests/HealthChecks.Kafka.Tests.csproj
+      CODECOV_FLAGS: Kafka

Directory.Packages.props

@@ -103,6 +103,7 @@
     <PackageVersion Include="System.Text.RegularExpressions" Version="4.3.1" />
     <PackageVersion Include="System.Threading.Channels" Version="8.0.0" />
     <PackageVersion Include="Testcontainers" Version="$(TestcontainersVersion)" />
+    <PackageVersion Include="Testcontainers.Kafka" Version="$(TestcontainersVersion)" />
     <PackageVersion Include="Testcontainers.Milvus" Version="$(TestcontainersVersion)" />
     <PackageVersion Include="Testcontainers.PostgreSql" Version="$(TestcontainersVersion)" />
     <PackageVersion Include="TestContainers.MongoDb" Version="$(TestcontainersVersion)" />

docker-compose.yml

@@ -57,26 +57,12 @@ services:
             - MYSQL_ROOT_PASSWORD=${MYSQL_PASSWORD}
         ports:
             - ${MYSQL_PORT}:3306
-    zookeeper:
-        image: confluent/zookeeper
-        ports:
-            - ${ZOOKEEPER_PORT}:2181
     raven:
         image: ravendb/ravendb
         ports:
             - ${RAVENDB_PORT}:8080
         environment:
             - RAVEN_ARGS=--Setup.Mode=None
-    kafka:
-        image: confluent/kafka
-        environment:
-            - KAFKA_ADVERTISED_HOST_NAME=localhost
-            - KAFKA_ZOOKEEPER_CONNECT=zookeeper:2181
-            - KAFKA_ADVERTISED_PORT=9092
-        ports:
-          - ${KAFKA_PORT}:9092
-        links:
-          - zookeeper
     rabbitmq:
         image: rabbitmq
         ports:

test/HealthChecks.Kafka.Tests/Functional/KafkaHealthCheckTests.cs

@@ -3,7 +3,7 @@
 
 namespace HealthChecks.Kafka.Tests.Functional;
 
-public class kafka_healthcheck_should
+public class kafka_healthcheck_should(KafkaContainerFixture kafkaContainerFixture) : IClassFixture<KafkaContainerFixture>
 {
     [Fact]
     public async Task be_unhealthy_if_kafka_is_unavailable()
@@ -41,9 +41,11 @@ public async Task be_unhealthy_if_kafka_is_unavailable()
     [Fact]
     public async Task be_healthy_if_kafka_is_available()
     {
+        string connectionString = kafkaContainerFixture.GetConnectionString();
+
         var configuration = new ProducerConfig()
         {
-            BootstrapServers = "localhost:29092",
+            BootstrapServers = connectionString,
             MessageSendMaxRetries = 0
         };
 

test/HealthChecks.Kafka.Tests/HealthChecks.Kafka.Tests.csproj

@@ -4,4 +4,7 @@
     <ProjectReference Include="..\..\src\HealthChecks.Kafka\HealthChecks.Kafka.csproj" />
   </ItemGroup>
 
+  <ItemGroup>
+    <PackageReference Include="Testcontainers.Kafka" />
+  </ItemGroup>
 </Project>

test/HealthChecks.Kafka.Tests/KafkaContainerFixture.cs

@@ -0,0 +1,35 @@
+using Testcontainers.Kafka;
+
+namespace HealthChecks.Kafka.Tests;
+
+public sealed class KafkaContainerFixture : IAsyncLifetime
+{
+    public const string Registry = "docker.io";
+
+    public const string Image = "confluentinc/cp-kafka";
+
+    public const string Tag = "7.8.0";
+
+    public KafkaContainer? Container { get; private set; }
+
+    public string GetConnectionString() => Container?.GetBootstrapAddress() ??
+        throw new InvalidOperationException("The test container was not initialized.");
+
+    public async Task InitializeAsync() => Container = await CreateContainerAsync();
+
+    public async Task DisposeAsync()
+    {
+        if (Container is not null)
+            await Container.DisposeAsync();
+    }
+
+    public static async Task<KafkaContainer> CreateContainerAsync()
+    {
+        var container = new KafkaBuilder()
+            .WithImage($"{Registry}/{Image}:{Tag}")
+            .Build();
+        await container.StartAsync();
+
+        return container;
+    }
+}