Add test containers for local test runs

Author: rbev

.github/workflows/ci.yml

@@ -18,7 +18,7 @@ jobs:
     strategy:
       matrix:
         os: [windows-latest, ubuntu-latest]
-        test-category: [ Default, SqlServer, AzureServiceBus, RabbitMQ, AzureStorageQueues, MSMQ, SQS, PrimaryRavenAcceptance, PrimaryRavenPersistence, PostgreSQL, IBMMQ ]
+        test-category: [ Default, SqlServer, AzureServiceBus, RabbitMQ, AzureStorageQueues, MSMQ, SQS, PrimaryRavenAcceptance, PrimaryRavenPersistence, PostgreSQL, IBMMQ, PrimarySqlServerPersistence, PrimaryPostgreSqlPersistence ]
         include:
           - os: windows-latest
             os-name: Windows
@@ -29,6 +29,8 @@ jobs:
             test-category: MSMQ
           - os: windows-latest
             test-category: IBMMQ
+          - os: windows-latest
+            test-category: PrimaryPostgreSqlPersistence
       fail-fast: false
     steps:
       - name: Check for secrets
@@ -75,6 +77,12 @@ jobs:
         with:
           connection-string-env-var: ServiceControl_TransportTests_SQL_ConnectionString
           catalog: nservicebus
+      - name: Setup SQL Server (persistence)
+        uses: Particular/install-sql-server-action@v1.4.0
+        if: matrix.test-category == 'PrimarySqlServerPersistence'
+        with:
+          connection-string-env-var: ServiceControl_Persistence_SqlServer_ConnectionString
+          catalog: ServiceControl
       - name: Setup PostgreSQL
         uses: Particular/setup-postgres-action@v1.1.0
         if: matrix.test-category == 'PostgreSQL'

src/Directory.Packages.props

@@ -75,6 +75,8 @@
     <PackageVersion Include="PropertyChanging.Fody" Version="1.31.0" />
     <PackageVersion Include="PublicApiGenerator" Version="11.5.4" />
     <PackageVersion Include="RavenDB.Embedded" Version="6.2.17" />
+    <PackageVersion Include="Testcontainers.MsSql" Version="4.13.0" />
+    <PackageVersion Include="Testcontainers.PostgreSql" Version="4.13.0" />
     <PackageVersion Include="ReactiveUI.WPF" Version="22.3.1" />
     <PackageVersion Include="Seq.Extensions.Logging" Version="9.0.0" />
     <PackageVersion Include="ServiceControl.Contracts" Version="5.1.0" />

src/ServiceControl.Persistence.Tests.PostgreSql/PersistenceTestsContext.cs

@@ -8,18 +8,17 @@ namespace ServiceControl.Persistence.Tests;
 
 public class PersistenceTestsContext : IPersistenceTestsContext
 {
-    public Task Setup(IHostApplicationBuilder hostBuilder)
+    public async Task Setup(IHostApplicationBuilder hostBuilder)
     {
-        PersistenceSettings = new PostgreSqlPersisterSettings()
+        PersistenceSettings = new PostgreSqlPersisterSettings
         {
-            ConnectionString = "Host=localhost;Database=ServiceControl;Username=postgres;Password=postgres"
+            ConnectionString = await PostgreSqlSharedContainer.GetConnectionStringAsync()
         };
 
         var persistence = new PostgreSqlPersistenceConfiguration().Create(PersistenceSettings);
 
         persistence.AddPersistence(hostBuilder.Services);
         persistence.AddInstaller(hostBuilder.Services);
-        return Task.CompletedTask;
     }
 
     public async Task PostSetup(IHost host)

src/ServiceControl.Persistence.Tests.PostgreSql/PostgreSqlSharedContainer.cs

@@ -0,0 +1,47 @@
+namespace ServiceControl.Persistence.Tests;
+
+using System;
+using System.Threading;
+using System.Threading.Tasks;
+using Testcontainers.PostgreSql;
+
+static class PostgreSqlSharedContainer
+{
+    public static async Task<string> GetConnectionStringAsync(CancellationToken ct = default)
+    {
+        var envConnStr = Environment.GetEnvironmentVariable("ServiceControl_Persistence_PostgreSql_ConnectionString");
+        if (!string.IsNullOrEmpty(envConnStr))
+        {
+            return envConnStr;
+        }
+
+        if (container != null)
+        {
+            return container.GetConnectionString();
+        }
+
+        await semaphore.WaitAsync(ct);
+        try
+        {
+            container ??= await StartContainerAsync(ct);
+            return container.GetConnectionString();
+        }
+        finally
+        {
+            semaphore.Release();
+        }
+    }
+
+    public static async Task Stop() => await (container?.DisposeAsync() ?? ValueTask.CompletedTask);
+
+    static async Task<PostgreSqlContainer> StartContainerAsync(CancellationToken ct)
+    {
+        var c = new PostgreSqlBuilder("postgres:16-alpine")
+            .Build();
+        await c.StartAsync(ct);
+        return c;
+    }
+
+    static PostgreSqlContainer container;
+    static readonly SemaphoreSlim semaphore = new(1, 1);
+}

src/ServiceControl.Persistence.Tests.PostgreSql/ServiceControl.Persistence.Tests.PostgreSql.csproj

@@ -21,6 +21,7 @@
     <PackageReference Include="NUnit3TestAdapter" />
     <PackageReference Include="Particular.Approvals" />
     <PackageReference Include="PublicApiGenerator" />
+    <PackageReference Include="Testcontainers.PostgreSql" />
   </ItemGroup>
 
   <ItemGroup>

src/ServiceControl.Persistence.Tests.PostgreSql/StopSharedPostgreSql.cs

@@ -0,0 +1,12 @@
+namespace ServiceControl;
+
+using System.Threading.Tasks;
+using NUnit.Framework;
+using Persistence.Tests;
+
+[SetUpFixture]
+public class StopSharedPostgreSql
+{
+    [OneTimeTearDown]
+    public async Task Teardown() => await PostgreSqlSharedContainer.Stop();
+}

src/ServiceControl.Persistence.Tests.SqlServer/PersistenceTestsContext.cs

@@ -8,18 +8,17 @@ namespace ServiceControl.Persistence.Tests;
 
 public class PersistenceTestsContext : IPersistenceTestsContext
 {
-    public Task Setup(IHostApplicationBuilder hostBuilder)
+    public async Task Setup(IHostApplicationBuilder hostBuilder)
     {
-        PersistenceSettings = new SqlServerPersisterSettings()
+        PersistenceSettings = new SqlServerPersisterSettings
         {
-            ConnectionString = "Server=localhost;Database=ServiceControl;User=sa;Password=Password1!;TrustServerCertificate=True"
+            ConnectionString = await SqlServerSharedContainer.GetConnectionStringAsync()
         };
 
         var persistence = new SqlServerPersistenceConfiguration().Create(PersistenceSettings);
 
         persistence.AddPersistence(hostBuilder.Services);
         persistence.AddInstaller(hostBuilder.Services);
-        return Task.CompletedTask;
     }
 
     public async Task PostSetup(IHost host)

src/ServiceControl.Persistence.Tests.SqlServer/ScrachTestDbContainer.cs

@@ -15,6 +15,6 @@ public async Task TestDbOperation()
         var db = scope.ServiceProvider.GetRequiredService<SqlServerServiceControlDbContext>();
 
         var result = await db.Database.ExecuteSqlAsync($"SELECT 1 as Hello");
-        Assert.That(result, Is.EqualTo(1));
+        Assert.That(result, Is.EqualTo(-1));
     }
 }

src/ServiceControl.Persistence.Tests.SqlServer/ServiceControl.Persistence.Tests.SqlServer.csproj

@@ -21,6 +21,7 @@
     <PackageReference Include="NUnit3TestAdapter" />
     <PackageReference Include="Particular.Approvals" />
     <PackageReference Include="PublicApiGenerator" />
+    <PackageReference Include="Testcontainers.MsSql" />
   </ItemGroup>
 
   <ItemGroup>

src/ServiceControl.Persistence.Tests.SqlServer/SqlServerSharedContainer.cs

@@ -0,0 +1,47 @@
+namespace ServiceControl.Persistence.Tests;
+
+using System;
+using System.Threading;
+using System.Threading.Tasks;
+using Testcontainers.MsSql;
+
+static class SqlServerSharedContainer
+{
+    public static async Task<string> GetConnectionStringAsync(CancellationToken ct = default)
+    {
+        var envConnStr = Environment.GetEnvironmentVariable("ServiceControl_Persistence_SqlServer_ConnectionString");
+        if (!string.IsNullOrEmpty(envConnStr))
+        {
+            return envConnStr;
+        }
+
+        if (container != null)
+        {
+            return container.GetConnectionString();
+        }
+
+        await semaphore.WaitAsync(ct);
+        try
+        {
+            container ??= await StartContainerAsync(ct);
+            return container.GetConnectionString();
+        }
+        finally
+        {
+            semaphore.Release();
+        }
+    }
+
+    public static async Task Stop() => await (container?.DisposeAsync() ?? ValueTask.CompletedTask);
+
+    static async Task<MsSqlContainer> StartContainerAsync(CancellationToken ct)
+    {
+        var c = new MsSqlBuilder("mcr.microsoft.com/mssql/server:2025-latest")
+            .Build();
+        await c.StartAsync(ct);
+        return c;
+    }
+
+    static MsSqlContainer container;
+    static readonly SemaphoreSlim semaphore = new(1, 1);
+}