Migrate HealthChecks.Nats tests to Testcontainers

monofunc · monofunc · commit 211528e72323 · 2025-08-18T19:03:36.000+04:00
diff --git a/.github/workflows/healthchecks_nats_ci.yml b/.github/workflows/healthchecks_nats_ci.yml
@@ -29,46 +29,8 @@ on:
 
 jobs:
   build:
-    runs-on: ubuntu-latest
-    services:
-      nats:
-        image: nats:latest
-        ports:
-        - "4222:4222"
-        - "8222:8222"
-        - "6222:6222"
-    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.Nats/HealthChecks.Nats.csproj &&
-          dotnet restore ./test/HealthChecks.Nats.Tests/HealthChecks.Nats.Tests.csproj
-      - name: Check formatting
-        run: |
-          dotnet format --no-restore --verify-no-changes --severity warn ./src/HealthChecks.Nats/HealthChecks.Nats.csproj || (echo "Run 'dotnet format' to fix issues" && exit 1) &&
-          dotnet format --no-restore --verify-no-changes --severity warn ./test/HealthChecks.Nats.Tests/HealthChecks.Nats.Tests.csproj || (echo "Run 'dotnet format' to fix issues" && exit 1)
-      - name: Build
-        run: |
-          dotnet build --no-restore ./src/HealthChecks.Nats/HealthChecks.Nats.csproj &&
-          dotnet build --no-restore ./test/HealthChecks.Nats.Tests/HealthChecks.Nats.Tests.csproj
-      - name: Test
-        run: >
-          dotnet test
-          ./test/HealthChecks.Nats.Tests/HealthChecks.Nats.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: Nats
-          directory: .coverage
+    uses: ./.github/workflows/reusable_ci_workflow.yml
+    with:
+      PROJECT_PATH: ./src/HealthChecks.Nats/HealthChecks.Nats.csproj
+      TEST_PROJECT_PATH: ./test/HealthChecks.Nats.Tests/HealthChecks.Nats.Tests.csproj
+      CODECOV_FLAGS: Nats
diff --git a/Directory.Packages.props b/Directory.Packages.props
@@ -106,6 +106,7 @@
     <PackageVersion Include="Testcontainers.ClickHouse" Version="$(TestcontainersVersion)" />
     <PackageVersion Include="Testcontainers.Kafka" Version="$(TestcontainersVersion)" />
     <PackageVersion Include="Testcontainers.Milvus" Version="$(TestcontainersVersion)" />
+    <PackageVersion Include="Testcontainers.Nats" Version="$(TestcontainersVersion)" />
     <PackageVersion Include="Testcontainers.PostgreSql" Version="$(TestcontainersVersion)" />
     <PackageVersion Include="TestContainers.MongoDb" Version="$(TestcontainersVersion)" />
     <PackageVersion Include="Testcontainers.MsSql" Version="$(TestcontainersVersion)" />
diff --git a/test/HealthChecks.Nats.Tests/Defines.cs b/test/HealthChecks.Nats.Tests/Defines.cs
diff --git a/test/HealthChecks.Nats.Tests/DependencyInjection/RegistrationTests.cs b/test/HealthChecks.Nats.Tests/DependencyInjection/RegistrationTests.cs
@@ -1,10 +1,11 @@
 using NATS.Client.Core;
-using static HealthChecks.Nats.Tests.Defines;
 
 namespace HealthChecks.Nats.Tests.DependencyInjection;
 
 public class nats_registration_should
 {
+    private const string ConnectionString = "nats://localhost:4222";
+
     [Fact]
     public void add_health_check_when_properly_configured()
     {
@@ -47,7 +48,7 @@ public void add_health_check_when_properly_configured_by_using_singlton_regestra
         var services = new ServiceCollection();
         var natsOpts = NatsOpts.Default with
         {
-            Url = DefaultLocalConnectionString,
+            Url = ConnectionString,
         };
         var connection = new NatsConnection(natsOpts);
 
@@ -86,7 +87,7 @@ private NatsConnection ClientFactory(IServiceProvider _)
     {
         var options = NatsOpts.Default with
         {
-            Url = DefaultLocalConnectionString,
+            Url = ConnectionString,
         };
         return new NatsConnection(options);
     }
diff --git a/test/HealthChecks.Nats.Tests/Functional/NatsHealthCheckTests.cs b/test/HealthChecks.Nats.Tests/Functional/NatsHealthCheckTests.cs
@@ -1,21 +1,21 @@
 using System.Net;
 using NATS.Client.Core;
-using NATS.Client.Hosting;
-using static HealthChecks.Nats.Tests.Defines;
 
 namespace HealthChecks.Nats.Tests.Functional;
 
-public class nats_healthcheck_should
+public class nats_healthcheck_should(NatsContainerFixture natsFixture) : IClassFixture<NatsContainerFixture>
 {
     [Fact]
     public async Task be_healthy_when_nats_is_available_using_client_factory()
     {
+        string connectionString = natsFixture.GetConnectionString();
+
         var webHostBuilder = new WebHostBuilder()
             .ConfigureServices(services =>
             {
                 var options = NatsOpts.Default with
                 {
-                    Url = DefaultLocalConnectionString,
+                    Url = connectionString,
                 };
                 var natsConnection = new NatsConnection(options);
 
@@ -42,12 +42,14 @@ public async Task be_healthy_when_nats_is_available_using_client_factory()
     [Fact]
     public async Task be_healthy_when_nats_is_available_using_singleton()
     {
+        string connectionString = natsFixture.GetConnectionString();
+
         var webHostBuilder = new WebHostBuilder()
             .ConfigureServices(services =>
             {
                 var options = NatsOpts.Default with
                 {
-                    Url = DefaultLocalConnectionString,
+                    Url = connectionString
                 };
 
                 services
@@ -83,7 +85,7 @@ public async Task be_unhealthy_when_nats_is_unavailable()
                         {
                             var options = NatsOpts.Default with
                             {
-                                Url = ConnectionStringDoesNotExistOrStopped,
+                                Url = "nats://DoesNotExist:4222",
                             };
                             return new NatsConnection(options);
                         }, tags: new string[] { "nats" });
diff --git a/test/HealthChecks.Nats.Tests/HealthChecks.Nats.Tests.csproj b/test/HealthChecks.Nats.Tests/HealthChecks.Nats.Tests.csproj
@@ -4,4 +4,8 @@
     <ProjectReference Include="..\..\src\HealthChecks.Nats\HealthChecks.Nats.csproj" />
   </ItemGroup>
 
+  <ItemGroup>
+    <PackageReference Include="Testcontainers.Nats" />
+  </ItemGroup>
+
 </Project>
diff --git a/test/HealthChecks.Nats.Tests/NatsContainerFixture.cs b/test/HealthChecks.Nats.Tests/NatsContainerFixture.cs
@@ -0,0 +1,39 @@
+using Testcontainers.Nats;
+
+namespace HealthChecks.Nats.Tests;
+
+public class NatsContainerFixture : IAsyncLifetime
+{
+    private const string Registry = "docker.io";
+
+    private const string Image = "library/nats";
+
+    private const string Tag = "2.11.8";
+
+    public NatsContainer? Container { get; private set; }
+
+    public string GetConnectionString()
+    {
+        if (Container is null)
+        {
+            throw new InvalidOperationException("The test container was not initialized.");
+        }
+
+        return Container.GetConnectionString();
+    }
+
+    public async Task InitializeAsync() => Container = await CreateContainerAsync();
+
+    public Task DisposeAsync() => Container?.DisposeAsync().AsTask() ?? Task.CompletedTask;
+
+    private static async Task<NatsContainer> CreateContainerAsync()
+    {
+        var container = new NatsBuilder()
+            .WithImage($"{Registry}/{Image}:{Tag}")
+            .Build();
+
+        await container.StartAsync();
+
+        return container;
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,11 @@`
`1`	`1`	`using NATS.Client.Core;`
`2`		`-using static HealthChecks.Nats.Tests.Defines;`
`3`	`2`
`4`	`3`	`namespace HealthChecks.Nats.Tests.DependencyInjection;`
`5`	`4`
`6`	`5`	`public class nats_registration_should`
`7`	`6`	`{`
	`7`	`+ private const string ConnectionString = "nats://localhost:4222";`
	`8`	`+`
`8`	`9`	`[Fact]`
`9`	`10`	`public void add_health_check_when_properly_configured()`
`10`	`11`	`{`
`@@ -47,7 +48,7 @@ public void add_health_check_when_properly_configured_by_using_singlton_regestra`
`47`	`48`	`var services = new ServiceCollection();`
`48`	`49`	`var natsOpts = NatsOpts.Default with`
`49`	`50`	`{`
`50`		`- Url = DefaultLocalConnectionString,`
	`51`	`+ Url = ConnectionString,`
`51`	`52`	`};`
`52`	`53`	`var connection = new NatsConnection(natsOpts);`
`53`	`54`
`@@ -86,7 +87,7 @@ private NatsConnection ClientFactory(IServiceProvider _)`
`86`	`87`	`{`
`87`	`88`	`var options = NatsOpts.Default with`
`88`	`89`	`{`
`89`		`- Url = DefaultLocalConnectionString,`
	`90`	`+ Url = ConnectionString,`
`90`	`91`	`};`
`91`	`92`	`return new NatsConnection(options);`
`92`	`93`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,21 +1,21 @@`
`1`	`1`	`using System.Net;`
`2`	`2`	`using NATS.Client.Core;`
`3`		`-using NATS.Client.Hosting;`
`4`		`-using static HealthChecks.Nats.Tests.Defines;`
`5`	`3`
`6`	`4`	`namespace HealthChecks.Nats.Tests.Functional;`
`7`	`5`
`8`		`-public class nats_healthcheck_should`
	`6`	`+public class nats_healthcheck_should(NatsContainerFixture natsFixture) : IClassFixture<NatsContainerFixture>`
`9`	`7`	`{`
`10`	`8`	`[Fact]`
`11`	`9`	`public async Task be_healthy_when_nats_is_available_using_client_factory()`
`12`	`10`	`{`
	`11`	`+ string connectionString = natsFixture.GetConnectionString();`
	`12`	`+`
`13`	`13`	`var webHostBuilder = new WebHostBuilder()`
`14`	`14`	`.ConfigureServices(services =>`
`15`	`15`	`{`
`16`	`16`	`var options = NatsOpts.Default with`
`17`	`17`	`{`
`18`		`- Url = DefaultLocalConnectionString,`
	`18`	`+ Url = connectionString,`
`19`	`19`	`};`
`20`	`20`	`var natsConnection = new NatsConnection(options);`
`21`	`21`
`@@ -42,12 +42,14 @@ public async Task be_healthy_when_nats_is_available_using_client_factory()`
`42`	`42`	`[Fact]`
`43`	`43`	`public async Task be_healthy_when_nats_is_available_using_singleton()`
`44`	`44`	`{`
	`45`	`+ string connectionString = natsFixture.GetConnectionString();`
	`46`	`+`
`45`	`47`	`var webHostBuilder = new WebHostBuilder()`
`46`	`48`	`.ConfigureServices(services =>`
`47`	`49`	`{`
`48`	`50`	`var options = NatsOpts.Default with`
`49`	`51`	`{`
`50`		`- Url = DefaultLocalConnectionString,`
	`52`	`+ Url = connectionString`
`51`	`53`	`};`
`52`	`54`
`53`	`55`	`services`
`@@ -83,7 +85,7 @@ public async Task be_unhealthy_when_nats_is_unavailable()`
`83`	`85`	`{`
`84`	`86`	`var options = NatsOpts.Default with`
`85`	`87`	`{`
`86`		`- Url = ConnectionStringDoesNotExistOrStopped,`
	`88`	`+ Url = "nats://DoesNotExist:4222",`
`87`	`89`	`};`
`88`	`90`	`return new NatsConnection(options);`
`89`	`91`	`}, tags: new string[] { "nats" });`