Migrate HealthChecks.SurrealDb tests to Testcontainers (#2402)

Author: monofunc

.github/workflows/healthchecks_surrealdb_ci.yml

@@ -29,47 +29,8 @@ on:
 
 jobs:
   build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - name: Start SurrealDB
-        uses: surrealdb/setup-surreal@v2
-        with:
-          surrealdb_version: latest
-          surrealdb_port: 8000
-          surrealdb_username: root
-          surrealdb_password: root
-          surrealdb_auth: true
-      - name: Setup .NET
-        uses: actions/setup-dotnet@v4
-        with:
-          dotnet-version: |
-            8.0.x
-            9.0.x
-      - name: Restore
-        run: |
-          dotnet restore ./src/HealthChecks.SurrealDb/HealthChecks.SurrealDb.csproj &&
-          dotnet restore ./test/HealthChecks.SurrealDb.Tests/HealthChecks.SurrealDb.Tests.csproj
-      - name: Check formatting
-        run: |
-          dotnet format --no-restore --verify-no-changes --severity warn ./src/HealthChecks.SurrealDb/HealthChecks.SurrealDb.csproj || (echo "Run 'dotnet format' to fix issues" && exit 1) &&
-          dotnet format --no-restore --verify-no-changes --severity warn ./test/HealthChecks.SurrealDb.Tests/HealthChecks.SurrealDb.Tests.csproj || (echo "Run 'dotnet format' to fix issues" && exit 1)
-      - name: Build
-        run: |
-          dotnet build --no-restore ./src/HealthChecks.SurrealDb/HealthChecks.SurrealDb.csproj &&
-          dotnet build --no-restore ./test/HealthChecks.SurrealDb.Tests/HealthChecks.SurrealDb.Tests.csproj
-      - name: Test
-        run: >
-          dotnet test
-          ./test/HealthChecks.SurrealDb.Tests/HealthChecks.SurrealDb.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: SurrealDb
-          directory: .coverage
+    uses: ./.github/workflows/reusable_ci_workflow.yml
+    with:
+      PROJECT_PATH: ./src/HealthChecks.SurrealDb/HealthChecks.SurrealDb.csproj
+      TEST_PROJECT_PATH: ./test/HealthChecks.SurrealDb.Tests/HealthChecks.SurrealDb.Tests.csproj
+      CODECOV_FLAGS: SurrealDb

test/HealthChecks.SurrealDb.Tests/Functional/SurrealDbHealthCheckTests.cs

@@ -2,12 +2,12 @@
 
 namespace HealthChecks.SurrealDb.Tests.Functional;
 
-public class surrealdb_healthcheck_should
+public class surrealdb_healthcheck_should(SurrealDbContainerFixture surrealDbFixture) : IClassFixture<SurrealDbContainerFixture>
 {
     [Fact]
     public async Task be_healthy_if_surrealdb_is_available()
     {
-        const string connectionString = "Server=http://localhost:8000;Namespace=test;Database=test;Username=root;Password=root";
+        string connectionString = surrealDbFixture.GetConnectionString();
 
         var webHostBuilder = new WebHostBuilder()
             .ConfigureServices(services =>
@@ -36,7 +36,7 @@ public async Task be_healthy_if_surrealdb_is_available()
     [Fact]
     public async Task be_unhealthy_if_surrealdb_is_not_available()
     {
-        const string connectionString = "Server=http://localhost:1234;Namespace=test;Database=test;Username=root;Password=root";
+        const string connectionString = "Server=http://localhost:1234;Username=root;Password=root";
 
         var webHostBuilder = new WebHostBuilder()
             .ConfigureServices(services =>

test/HealthChecks.SurrealDb.Tests/HealthChecks.SurrealDb.Tests.csproj

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

test/HealthChecks.SurrealDb.Tests/SurrealDbContainerFixture.cs

@@ -0,0 +1,63 @@
+using System.Data.Common;
+using DotNet.Testcontainers.Builders;
+using DotNet.Testcontainers.Containers;
+
+namespace HealthChecks.SurrealDb.Tests;
+
+public class SurrealDbContainerFixture : IAsyncLifetime
+{
+    private const string Registry = "docker.io";
+
+    private const string Image = "surrealdb/surrealdb";
+
+    private const string Tag = "v2.3.7";
+
+    private const int Port = 8000;
+
+    private const string Username = "root";
+
+    private const string Password = "root";
+
+    public IContainer? Container { get; private set; }
+
+    public string GetConnectionString()
+    {
+        if (Container is null)
+        {
+            throw new InvalidOperationException("The test container was not initialized.");
+        }
+
+        string endpoint = new UriBuilder("http", Container.Hostname, Container.GetMappedPublicPort(Port)).ToString();
+
+        var builder = new DbConnectionStringBuilder
+        {
+            { "Server", endpoint },
+            { "Username", Username },
+            { "Password", Password }
+        };
+
+        return builder.ConnectionString;
+    }
+
+    public async Task InitializeAsync() => Container = await CreateContainerAsync();
+
+    public Task DisposeAsync() => Container?.DisposeAsync().AsTask() ?? Task.CompletedTask;
+
+    private static async Task<IContainer> CreateContainerAsync()
+    {
+        var waitStrategy = Wait
+            .ForUnixContainer()
+            .UntilHttpRequestIsSucceeded(x => x.ForPath("/health").ForPort(Port));
+
+        var container = new ContainerBuilder()
+            .WithImage($"{Registry}/{Image}:{Tag}")
+            .WithPortBinding(Port, true)
+            .WithCommand("start", "--user", Username, "--pass", Password, "memory")
+            .WithWaitStrategy(waitStrategy)
+            .Build();
+
+        await container.StartAsync();
+
+        return container;
+    }
+}