Merge pull request #1218 from json-api-dotnet/xunit-perf-throttling

Improve speed of running tests

Author: maurei

Diff for: test/AnnotationTests/AnnotationTests.csproj

@@ -4,12 +4,6 @@
     <LangVersion>latest</LangVersion>
   </PropertyGroup>
 
-  <ItemGroup>
-    <None Update="xunit.runner.json">
-      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
-    </None>
-  </ItemGroup>
-
   <ItemGroup Condition=" '$(TargetFramework)' == 'netstandard1.0' ">
     <Using Remove="System.Net.Http" />
   </ItemGroup>

Diff for: test/DiscoveryTests/DiscoveryTests.csproj

@@ -3,12 +3,6 @@
     <TargetFramework>$(TargetFrameworkName)</TargetFramework>
   </PropertyGroup>
 
-  <ItemGroup>
-    <None Update="xunit.runner.json">
-      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
-    </None>
-  </ItemGroup>
-
   <ItemGroup>
     <ProjectReference Include="..\..\src\Examples\JsonApiDotNetCoreExample\JsonApiDotNetCoreExample.csproj" />
     <ProjectReference Include="..\TestBuildingBlocks\TestBuildingBlocks.csproj" />

Diff for: test/DiscoveryTests/xunit.runner.json

@@ -31,5 +31,7 @@ protected override void OnModelCreating(ModelBuilder builder)
         builder.Entity<MusicTrack>()
             .HasMany(musicTrack => musicTrack.OccursIn)
             .WithMany(playlist => playlist.Tracks);
+
+        base.OnModelCreating(builder);
     }
 }

Diff for: test/JsonApiDotNetCoreTests/IntegrationTests/AtomicOperations/OperationsDbContext.cs

@@ -9,7 +9,8 @@
 
 namespace JsonApiDotNetCoreTests.IntegrationTests.AtomicOperations.Transactions;
 
-public sealed class AtomicTransactionConsistencyTests : IClassFixture<IntegrationTestContext<TestableStartup<OperationsDbContext>, OperationsDbContext>>
+public sealed class AtomicTransactionConsistencyTests
+    : IClassFixture<IntegrationTestContext<TestableStartup<OperationsDbContext>, OperationsDbContext>>, IAsyncLifetime
 {
     private readonly IntegrationTestContext<TestableStartup<OperationsDbContext>, OperationsDbContext> _testContext;
     private readonly OperationsFakers _fakers = new();
@@ -27,7 +28,7 @@ public AtomicTransactionConsistencyTests(IntegrationTestContext<TestableStartup<
             services.AddResourceRepository<LyricRepository>();
 
             string postgresPassword = Environment.GetEnvironmentVariable("PGPASSWORD") ?? "postgres";
-            string dbConnectionString = $"Host=localhost;Port=5432;Database=JsonApiTest-{Guid.NewGuid():N};User ID=postgres;Password={postgresPassword}";
+            string dbConnectionString = $"Host=localhost;Port=5432;Database=JsonApiTest-Extra-{Guid.NewGuid():N};User ID=postgres;Password={postgresPassword}";
 
             services.AddDbContext<ExtraDbContext>(options => options.UseNpgsql(dbConnectionString));
         });
@@ -158,4 +159,22 @@ public async Task Cannot_use_distributed_transaction()
         error.Source.ShouldNotBeNull();
         error.Source.Pointer.Should().Be("/atomic:operations[0]");
     }
+
+    public Task InitializeAsync()
+    {
+        return Task.CompletedTask;
+    }
+
+    Task IAsyncLifetime.DisposeAsync()
+    {
+        return DeleteExtraDatabaseAsync();
+    }
+
+    private async Task DeleteExtraDatabaseAsync()
+    {
+        await using AsyncServiceScope scope = _testContext.Factory.Services.CreateAsyncScope();
+        var dbContext = scope.ServiceProvider.GetRequiredService<ExtraDbContext>();
+
+        await dbContext.Database.EnsureDeletedAsync();
+    }
 }

Diff for: test/JsonApiDotNetCoreTests/IntegrationTests/AtomicOperations/Transactions/AtomicTransactionConsistencyTests.cs

@@ -39,5 +39,7 @@ protected override void OnModelCreating(ModelBuilder builder)
         builder.Entity<Car>()
             .HasMany(car => car.PreviousDealerships)
             .WithMany(dealership => dealership.SoldCars);
+
+        base.OnModelCreating(builder);
     }
 }

Diff for: test/JsonApiDotNetCoreTests/IntegrationTests/CompositeKeys/CompositeDbContext.cs

@@ -34,5 +34,7 @@ protected override void OnModelCreating(ModelBuilder builder)
             .HasOne(building => building.SecondaryDoor)
             .WithOne()
             .HasForeignKey<Building>("SecondaryDoorId");
+
+        base.OnModelCreating(builder);
     }
 }

Diff for: test/JsonApiDotNetCoreTests/IntegrationTests/EagerLoading/EagerLoadingDbContext.cs

@@ -37,5 +37,7 @@ protected override void OnModelCreating(ModelBuilder builder)
         builder.Entity<SystemDirectory>()
             .HasOne(systemDirectory => systemDirectory.AlsoSelf)
             .WithOne();
+
+        base.OnModelCreating(builder);
     }
 }

Diff for: test/JsonApiDotNetCoreTests/IntegrationTests/InputValidation/ModelState/ModelStateDbContext.cs

@@ -24,5 +24,7 @@ protected override void OnModelCreating(ModelBuilder builder)
             .HasOne(photo => photo.Location)
             .WithOne(location => location.Photo)
             .HasForeignKey<Photo>("LocationId");
+
+        base.OnModelCreating(builder);
     }
 }

Diff for: test/JsonApiDotNetCoreTests/IntegrationTests/Links/LinksDbContext.cs

@@ -31,5 +31,7 @@ protected override void OnModelCreating(ModelBuilder builder)
 
         builder.Entity<WebProduct>()
             .HasQueryFilter(webProduct => webProduct.Shop.TenantId == _tenantProvider.TenantId);
+
+        base.OnModelCreating(builder);
     }
 }

Diff for: test/JsonApiDotNetCoreTests/IntegrationTests/MultiTenancy/MultiTenancyDbContext.cs

@@ -21,5 +21,7 @@ protected override void OnModelCreating(ModelBuilder builder)
         builder.Entity<FilterableResource>()
             .Property(resource => resource.SomeDateTimeInLocalZone)
             .HasColumnType("timestamp without time zone");
+
+        base.OnModelCreating(builder);
     }
 }

Diff for: test/JsonApiDotNetCoreTests/IntegrationTests/QueryStrings/Filtering/FilterDbContext.cs

@@ -37,5 +37,7 @@ protected override void OnModelCreating(ModelBuilder builder)
             .HasOne(man => man.Wife)
             .WithOne(woman => woman.Husband)
             .HasForeignKey<Man>();
+
+        base.OnModelCreating(builder);
     }
 }

Diff for: test/JsonApiDotNetCoreTests/IntegrationTests/QueryStrings/QueryStringDbContext.cs

@@ -49,5 +49,7 @@ protected override void OnModelCreating(ModelBuilder builder)
                 left => left
                     .HasOne(joinEntity => joinEntity.ToItem)
                     .WithMany());
+
+        base.OnModelCreating(builder);
     }
 }

Diff for: test/JsonApiDotNetCoreTests/IntegrationTests/ReadWrite/ReadWriteDbContext.cs

@@ -33,5 +33,7 @@ protected override void OnModelCreating(ModelBuilder builder)
             .HasOne(order => order.Shipment)
             .WithOne(shipment => shipment.Order)
             .HasForeignKey<Shipment>("OrderId");
+
+        base.OnModelCreating(builder);
     }
 }

Diff for: test/JsonApiDotNetCoreTests/IntegrationTests/RequiredRelationships/DefaultBehaviorDbContext.cs

@@ -22,5 +22,7 @@ protected override void OnModelCreating(ModelBuilder builder)
         builder.Entity<Scholarship>()
             .HasMany(scholarship => scholarship.Participants)
             .WithOne(student => student.Scholarship!);
+
+        base.OnModelCreating(builder);
     }
 }

Diff for: test/JsonApiDotNetCoreTests/IntegrationTests/ResourceDefinitions/Serialization/SerializationDbContext.cs

@@ -2429,7 +2429,7 @@ public async Task Can_sort_on_derived_attribute_from_resource_definition_using_e
 
         await _testContext.RunOnDatabaseAsync(async dbContext =>
         {
-            await dbContext.ClearTableAsync<Vehicle>();
+            await dbContext.ClearTableAsync<Wheel>();
             dbContext.Wheels.AddRange(chromeWheel1, chromeWheel2, chromeWheel3, carbonWheel1, carbonWheel2);
             await dbContext.SaveChangesAsync();
         });
@@ -2487,7 +2487,7 @@ public async Task Can_sort_on_derived_attribute_from_resource_definition_using_l
 
         await _testContext.RunOnDatabaseAsync(async dbContext =>
         {
-            await dbContext.ClearTableAsync<Vehicle>();
+            await dbContext.ClearTableAsync<Wheel>();
             dbContext.Wheels.AddRange(chromeWheel1, chromeWheel2, chromeWheel3, carbonWheel1, carbonWheel2);
             await dbContext.SaveChangesAsync();
         });

Diff for: test/JsonApiDotNetCoreTests/IntegrationTests/ResourceInheritance/ResourceInheritanceReadTests.cs

@@ -32,5 +32,7 @@ protected override void OnModelCreating(ModelBuilder builder)
         builder.Entity<GenericProperty>().ToTable("GenericProperties");
         builder.Entity<StringProperty>().ToTable("StringProperties");
         builder.Entity<NumberProperty>().ToTable("NumberProperties");
+
+        base.OnModelCreating(builder);
     }
 }

Diff for: test/JsonApiDotNetCoreTests/IntegrationTests/ResourceInheritance/TablePerType/TablePerTypeDbContext.cs

@@ -24,5 +24,7 @@ protected override void OnModelCreating(ModelBuilder builder)
 
         builder.Entity<Department>()
             .HasQueryFilter(department => department.SoftDeletedAt == null);
+
+        base.OnModelCreating(builder);
     }
 }

Diff for: test/JsonApiDotNetCoreTests/IntegrationTests/SoftDeletion/SoftDeletionDbContext.cs

@@ -27,5 +27,7 @@ protected override void OnModelCreating(ModelBuilder builder)
         builder.Entity<Player>()
             .HasOne(player => player.ActiveGame)
             .WithMany(game => game.ActivePlayers);
+
+        base.OnModelCreating(builder);
     }
 }

Diff for: test/JsonApiDotNetCoreTests/IntegrationTests/ZeroKeys/ZeroKeyDbContext.cs

@@ -3,12 +3,6 @@
     <TargetFramework>$(TargetFrameworkName)</TargetFramework>
   </PropertyGroup>
 
-  <ItemGroup>
-    <None Update="xunit.runner.json">
-      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
-    </None>
-  </ItemGroup>
-
   <ItemGroup>
     <ProjectReference Include="..\TestBuildingBlocks\TestBuildingBlocks.csproj" />
     <ProjectReference Include="..\..\src\JsonApiDotNetCore.SourceGenerators\JsonApiDotNetCore.SourceGenerators.csproj" OutputItemType="Analyzer"

Diff for: test/JsonApiDotNetCoreTests/JsonApiDotNetCoreTests.csproj

@@ -74,7 +74,7 @@ private static IHostBuilder CreateValidatingHostBuilder()
         IHostBuilder hostBuilder = Host.CreateDefaultBuilder().ConfigureWebHostDefaults(webBuilder =>
         {
             webBuilder.ConfigureServices(services =>
-                services.AddDbContext<DependencyContainerRegistrationDbContext>(options => options.UseInMemoryDatabase("db")));
+                services.AddDbContext<DependencyContainerRegistrationDbContext>(options => options.UseInMemoryDatabase(Guid.NewGuid().ToString())));
 
             webBuilder.UseStartup<TestableStartup<DependencyContainerRegistrationDbContext>>();
 

Diff for: test/JsonApiDotNetCoreTests/UnitTests/Configuration/DependencyContainerRegistrationTests.cs

@@ -3,12 +3,6 @@
     <TargetFramework>$(TargetFrameworkName)</TargetFramework>
   </PropertyGroup>
 
-  <ItemGroup>
-    <None Update="xunit.runner.json">
-      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
-    </None>
-  </ItemGroup>
-
   <ItemGroup>
     <ProjectReference Include="..\..\src\Examples\MultiDbContextExample\MultiDbContextExample.csproj" />
     <ProjectReference Include="..\TestBuildingBlocks\TestBuildingBlocks.csproj" />

Diff for: test/JsonApiDotNetCoreTests/xunit.runner.json

@@ -1,6 +1,5 @@
 using Microsoft.EntityFrameworkCore;
 using Microsoft.EntityFrameworkCore.Metadata;
-using Npgsql;
 
 namespace TestBuildingBlocks;
 
@@ -36,17 +35,7 @@ private static async Task ClearTablesAsync(this DbContext dbContext, params Type
             }
 
             string tableName = entityType.GetTableName()!;
-
-            // PERF: We first try to clear the table, which is fast and usually succeeds, unless foreign key constraints are violated.
-            // In that case, we recursively delete all related data, which is slow.
-            try
-            {
-                await dbContext.Database.ExecuteSqlRawAsync($"delete from \"{tableName}\"");
-            }
-            catch (PostgresException)
-            {
-                await dbContext.Database.ExecuteSqlRawAsync($"truncate table \"{tableName}\" cascade");
-            }
+            await dbContext.Database.ExecuteSqlRawAsync($"delete from \"{tableName}\"");
         }
     }
 }

Diff for: test/MultiDbContextTests/MultiDbContextTests.csproj

@@ -2,14 +2,18 @@
 using System.Text;
 using System.Text.Json;
 using JsonApiDotNetCore.Middleware;
+using Xunit;
 
 namespace TestBuildingBlocks;
 
 /// <summary>
-/// A base class for tests that conveniently enables to execute HTTP requests against JSON:API endpoints.
+/// A base class for tests that conveniently enables to execute HTTP requests against JSON:API endpoints. It throttles tests that are running in parallel
+/// to avoid exceeding the maximum active database connections.
 /// </summary>
-public abstract class IntegrationTest
+public abstract class IntegrationTest : IAsyncLifetime
 {
+    private static readonly SemaphoreSlim ThrottleSemaphore = new(64);
+
     protected abstract JsonSerializerOptions SerializerOptions { get; }
 
     public async Task<(HttpResponseMessage httpResponse, TResponseDocument responseDocument)> ExecuteHeadAsync<TResponseDocument>(string requestUrl,
@@ -105,4 +109,15 @@ public abstract class IntegrationTest
             throw new FormatException($"Failed to deserialize response body to JSON:\n{responseText}", exception);
         }
     }
+
+    public async Task InitializeAsync()
+    {
+        await ThrottleSemaphore.WaitAsync();
+    }
+
+    public virtual Task DisposeAsync()
+    {
+        _ = ThrottleSemaphore.Release();
+        return Task.CompletedTask;
+    }
 }

Diff for: test/MultiDbContextTests/xunit.runner.json

@@ -24,7 +24,7 @@ namespace TestBuildingBlocks;
 /// The Entity Framework Core database context, which can be defined in the test project or API project.
 /// </typeparam>
 [UsedImplicitly(ImplicitUseKindFlags.InstantiatedNoFixedConstructorSignature)]
-public class IntegrationTestContext<TStartup, TDbContext> : IntegrationTest, IDisposable
+public class IntegrationTestContext<TStartup, TDbContext> : IntegrationTest
     where TStartup : class
     where TDbContext : TestableDbContext
 {
@@ -103,16 +103,6 @@ private WebApplicationFactory<TStartup> CreateFactory()
         return factoryWithConfiguredContentRoot;
     }
 
-    public void Dispose()
-    {
-        if (_lazyFactory.IsValueCreated)
-        {
-            RunOnDatabaseAsync(async dbContext => await dbContext.Database.EnsureDeletedAsync()).Wait();
-
-            _lazyFactory.Value.Dispose();
-        }
-    }
-
     public void ConfigureLogging(Action<ILoggingBuilder> loggingConfiguration)
     {
         _loggingConfiguration = loggingConfiguration;
@@ -136,6 +126,22 @@ public async Task RunOnDatabaseAsync(Func<TDbContext, Task> asyncAction)
         await asyncAction(dbContext);
     }
 
+    public override async Task DisposeAsync()
+    {
+        try
+        {
+            if (_lazyFactory.IsValueCreated)
+            {
+                await RunOnDatabaseAsync(async dbContext => await dbContext.Database.EnsureDeletedAsync());
+                await _lazyFactory.Value.DisposeAsync();
+            }
+        }
+        finally
+        {
+            await base.DisposeAsync();
+        }
+    }
+
     private sealed class IntegrationTestWebApplicationFactory : WebApplicationFactory<TStartup>
     {
         private Action<ILoggingBuilder>? _loggingConfiguration;

Diff for: test/TestBuildingBlocks/DbContextExtensions.cs

@@ -1,6 +1,7 @@
 using System.Diagnostics;
 using JsonApiDotNetCore;
 using Microsoft.EntityFrameworkCore;
+using Microsoft.EntityFrameworkCore.Metadata;
 using Microsoft.Extensions.Logging;
 
 namespace TestBuildingBlocks;
@@ -17,4 +18,15 @@ protected override void OnConfiguring(DbContextOptionsBuilder builder)
         // Writes SQL statements to the Output Window when debugging.
         builder.LogTo(message => Debug.WriteLine(message), DbLoggerCategory.Database.Name.AsArray(), LogLevel.Information);
     }
+
+    protected override void OnModelCreating(ModelBuilder builder)
+    {
+        foreach (IMutableForeignKey foreignKey in builder.Model.GetEntityTypes().SelectMany(entityType => entityType.GetForeignKeys()))
+        {
+            if (foreignKey.DeleteBehavior == DeleteBehavior.ClientSetNull)
+            {
+                foreignKey.DeleteBehavior = DeleteBehavior.SetNull;
+            }
+        }
+    }
 }

Diff for: test/TestBuildingBlocks/IntegrationTest.cs

@@ -25,7 +25,7 @@ public void RegisterResource_DeviatingDbContextPropertyName_RegistersCorrectly()
         // Arrange
         var services = new ServiceCollection();
         services.AddLogging();
-        services.AddDbContext<TestDbContext>(options => options.UseInMemoryDatabase("UnitTestDb"));
+        services.AddDbContext<TestDbContext>(options => options.UseInMemoryDatabase(Guid.NewGuid().ToString()));
 
         // Act
         services.AddJsonApi<TestDbContext>();