Migrate HealthChecks.Npgsql tests to Testcontainers

Xabaril · Dec 17, 2024 · 9ad3389 · 9ad3389
1 parent f54852f
commit 9ad3389
Show file tree

Hide file tree

Showing 5 changed files with 44 additions and 13 deletions.
diff --git a/.github/workflows/healthchecks_npgsql_ci.yml b/.github/workflows/healthchecks_npgsql_ci.yml
@@ -30,14 +30,6 @@ on:
 jobs:
   build:
     runs-on: ubuntu-latest
-    services:
-      npgsql:
-        image: postgres
-        ports:
-          - 8010:5432
-        env:
-          POSTGRES_USER: postgres
-          POSTGRES_PASSWORD: Password12!
     steps:
       - uses: actions/checkout@v3
       - name: Setup .NET

diff --git a/Directory.Packages.props b/Directory.Packages.props
@@ -102,6 +102,7 @@
     <PackageVersion Include="System.Text.Json" Version="8.0.5" />
     <PackageVersion Include="System.Text.RegularExpressions" Version="4.3.1" />
     <PackageVersion Include="System.Threading.Channels" Version="8.0.0" />
+    <PackageVersion Include="Testcontainers.PostgreSql" Version="$(TestcontainersVersion)" />
     <PackageVersion Include="Testcontainers.Redis" Version="$(TestcontainersVersion)" />
     <PackageVersion Include="xunit" Version="2.9.2" />
     <PackageVersion Include="xunit.runner.visualstudio" Version="2.8.2" />

diff --git a/test/HealthChecks.Npgsql.Tests/Functional/NpgsqlHealthCheckTests.cs b/test/HealthChecks.Npgsql.Tests/Functional/NpgsqlHealthCheckTests.cs
@@ -9,12 +9,12 @@ public class DBConfigSetting
     public string ConnectionString { get; set; } = null!;
 }
 
-public class npgsql_healthcheck_should
+public class npgsql_healthcheck_should(PostgreSQLContainerFixture postgreSQLContainerFixture) : IClassFixture<PostgreSQLContainerFixture>
 {
     [Fact]
     public async Task be_healthy_if_npgsql_is_available()
     {
-        var connectionString = "Server=127.0.0.1;Port=8010;User ID=postgres;Password=Password12!;database=postgres";
+        var connectionString = postgreSQLContainerFixture.GetConnectionString();
 
         var webHostBuilder = new WebHostBuilder()
             .ConfigureServices(services =>
@@ -40,7 +40,7 @@ public async Task be_healthy_if_npgsql_is_available()
     [Fact]
     public async Task be_unhealthy_if_sql_query_is_not_valid()
     {
-        var connectionString = "Server=127.0.0.1;Port=8010;User ID=postgres;Password=Password12!;database=postgres";
+        var connectionString = postgreSQLContainerFixture.GetConnectionString();
 
         var webHostBuilder = new WebHostBuilder()
             .ConfigureServices(services =>
@@ -90,12 +90,14 @@ public async Task be_unhealthy_if_npgsql_is_not_available()
     [Fact]
     public async Task be_healthy_if_npgsql_is_available_by_iServiceProvider_registered()
     {
+        var connectionString = postgreSQLContainerFixture.GetConnectionString();
+
         var webHostBuilder = new WebHostBuilder()
             .ConfigureServices(services =>
             {
                 services.AddSingleton(new DBConfigSetting
                 {
-                    ConnectionString = "Server=127.0.0.1;Port=8010;User ID=postgres;Password=Password12!;database=postgres"
+                    ConnectionString = connectionString
                 });
 
                 services.AddHealthChecks()
@@ -148,7 +150,7 @@ public async Task be_unhealthy_if_npgsql_is_not_available_registered()
     [Fact]
     public async Task unhealthy_check_log_detailed_messages()
     {
-        var connectionString = "Server=127.0.0.1;Port=8010;User ID=postgres;Password=Password12!;database=postgres";
+        var connectionString = postgreSQLContainerFixture.GetConnectionString();
 
         var webHostBuilder = new WebHostBuilder()
             .ConfigureServices(services =>

diff --git a/test/HealthChecks.Npgsql.Tests/HealthChecks.Npgsql.Tests.csproj b/test/HealthChecks.Npgsql.Tests/HealthChecks.Npgsql.Tests.csproj
@@ -2,6 +2,7 @@
 
   <ItemGroup>
     <PackageReference Include="Npgsql.DependencyInjection" />
+    <PackageReference Include="Testcontainers.PostgreSql" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/test/HealthChecks.Npgsql.Tests/PostgreSQLContainerFixture.cs b/test/HealthChecks.Npgsql.Tests/PostgreSQLContainerFixture.cs
@@ -0,0 +1,35 @@
+using Testcontainers.PostgreSql;
+
+namespace HealthChecks.Npgsql.Tests;
+
+public sealed class PostgreSQLContainerFixture : IAsyncLifetime
+{
+    public const string Registry = "docker.io";
+
+    public const string Image = "library/postgres";
+
+    public const string Tag = "17.0";
+
+    public PostgreSqlContainer? Container { get; private set; }
+
+    public string GetConnectionString() => Container?.GetConnectionString() ??
+        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<PostgreSqlContainer> CreateContainerAsync()
+    {
+        var container = new PostgreSqlBuilder()
+            .WithImage($"{Registry}/{Image}:{Tag}")
+            .Build();
+        await container.StartAsync();
+
+        return container;
+    }
+}