Add default testcontainer support in the tests (#3753)

When the environment variable isn't defined

Author: roji

.github/workflows/build.yml

@@ -113,6 +113,8 @@ jobs:
       - name: Test
         run: dotnet test -c ${{ matrix.config }} --logger "GitHubActions;report-warnings=false"
         shell: bash
+        env:
+          Test__Npgsql__DefaultConnection: Server=localhost;Username=npgsql_tests;Password=npgsql_tests
 
       - id: analyze_tag
         name: Analyze tag

Directory.Packages.props

@@ -33,5 +33,6 @@
     <PackageVersion Include="xunit.core" Version="2.9.3" />
     <PackageVersion Include="xunit.runner.visualstudio" Version="3.1.5" />
     <PackageVersion Include="GitHubActionsTestLogger" Version="2.4.1" />
+    <PackageVersion Include="Testcontainers.PostgreSql" Version="4.10.0" />
   </ItemGroup>
 </Project>

test/EFCore.PG.FunctionalTests/EFCore.PG.FunctionalTests.csproj

@@ -18,11 +18,11 @@
     <PackageReference Include="Microsoft.EntityFrameworkCore.Relational.Specification.Tests" />
     <PackageReference Include="Microsoft.Extensions.Configuration.Json" />
     <PackageReference Include="Microsoft.Extensions.Configuration.EnvironmentVariables" />
+    <PackageReference Include="Testcontainers.PostgreSql" />
   </ItemGroup>
 
   <ItemGroup>
     <None Update="Northwind.sql" CopyToOutputDirectory="PreserveNewest" />
-    <None Update="config.json" CopyToOutputDirectory="PreserveNewest" />
   </ItemGroup>
 
 </Project>

test/EFCore.PG.FunctionalTests/Migrations/MigrationsInfrastructureNpgsqlTest.cs

@@ -217,7 +217,7 @@ public class Post
 public class BloggingContext : DbContext
 {
     protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
-        => optionsBuilder.UseNpgsql(TestEnvironment.DefaultConnection);
+        => optionsBuilder.UseNpgsql(TestEnvironment.ConnectionString);
 
     public DbSet<Blog> Blogs { get; set; }
 }

test/EFCore.PG.FunctionalTests/Query/NavigationTest.cs

@@ -83,7 +83,7 @@ public NavigationTestFixture()
             .AddEntityFrameworkNpgsql()
             .BuildServiceProvider();
 
-        var connStrBuilder = new NpgsqlConnectionStringBuilder(TestEnvironment.DefaultConnection) { Database = "StateManagerBug" };
+        var connStrBuilder = new NpgsqlConnectionStringBuilder(TestEnvironment.ConnectionString) { Database = "StateManagerBug" };
 
         _options = new DbContextOptionsBuilder()
             .UseNpgsql(connStrBuilder.ConnectionString)

test/EFCore.PG.FunctionalTests/TestUtilities/NpgsqlTestStore.cs

@@ -420,7 +420,7 @@ private static DbCommand CreateCommand(
 
     public static string CreateConnectionString(string name, string? options = null)
     {
-        var builder = new NpgsqlConnectionStringBuilder(TestEnvironment.DefaultConnection) { Database = name };
+        var builder = new NpgsqlConnectionStringBuilder(TestEnvironment.ConnectionString) { Database = name };
 
         if (options is not null)
         {

test/EFCore.PG.FunctionalTests/TestUtilities/TestEnvironment.cs

@@ -1,12 +1,18 @@
 using System.Globalization;
 using Microsoft.Extensions.Configuration;
+using Testcontainers.PostgreSql;
 
 namespace Microsoft.EntityFrameworkCore.TestUtilities;
 
 public static class TestEnvironment
 {
     public static IConfiguration Config { get; }
 
+    public static string ConnectionString { get; }
+
+    // Keep a reference to prevent GC from collecting (and finalizing/stopping) the container while tests are running.
+    private static readonly PostgreSqlContainer? _postgreSqlContainer;
+
     static TestEnvironment()
     {
         var configBuilder = new ConfigurationBuilder()
@@ -18,13 +24,37 @@ static TestEnvironment()
         Config = configBuilder.Build()
             .GetSection("Test:Npgsql");
 
-        Thread.CurrentThread.CurrentCulture = new CultureInfo("en-US");
-    }
+        if (Config["DefaultConnection"] is { } connectionString)
+        {
+            Console.WriteLine("Using connection string configured via Test:Npgsql:DefaultConnection: " + connectionString);
 
-    private const string DefaultConnectionString = "Server=localhost;Username=npgsql_tests;Password=npgsql_tests;Port=5432";
+            ConnectionString = connectionString;
+        }
+        else
+        {
+            Console.WriteLine("No connection string configured via Test:Npgsql:DefaultConnection, starting up testcontainer...");
 
-    public static string DefaultConnection
-        => Config["DefaultConnection"] ?? DefaultConnectionString;
+            _postgreSqlContainer = new PostgreSqlBuilder("postgres:latest")
+                .WithCommand("-c", "max_connections=200")
+                .Build();
+            _postgreSqlContainer.StartAsync().GetAwaiter().GetResult();
+            ConnectionString = _postgreSqlContainer.GetConnectionString();
+
+            AppDomain.CurrentDomain.ProcessExit += (_, _) =>
+            {
+                try
+                {
+                    _postgreSqlContainer?.DisposeAsync().AsTask().GetAwaiter().GetResult();
+                }
+                catch
+                {
+                    // Ignore exceptions during process-exit cleanup.
+                }
+            };
+        }
+
+        Thread.CurrentThread.CurrentCulture = new CultureInfo("en-US");
+    }
 
     private static Version? _postgresVersion;
 

test/EFCore.PG.FunctionalTests/TestUtilities/TestNpgsqlRetryingExecutionStrategy.cs

@@ -13,7 +13,7 @@ public TestNpgsqlRetryingExecutionStrategy()
             new DbContext(
                 new DbContextOptionsBuilder()
                     .EnableServiceProviderCaching(false)
-                    .UseNpgsql(TestEnvironment.DefaultConnection).Options),
+                    .UseNpgsql(TestEnvironment.ConnectionString).Options),
             DefaultMaxRetryCount, DefaultMaxDelay, AdditionalSqlStates)
     {
     }