Add test throttling (reduces the duration of running all tests from 2:37 to 0:30 on my system)

Author: bkoelman

test/JsonApiDotNetCoreMongoDbTests/IntegrationTests/AtomicOperations/AtomicOperationsFixture.cs

@@ -1,11 +1,12 @@
 using JetBrains.Annotations;
 using Microsoft.Extensions.DependencyInjection;
 using TestBuildingBlocks;
+using Xunit;
 
 namespace JsonApiDotNetCoreMongoDbTests.IntegrationTests.AtomicOperations;
 
 [UsedImplicitly(ImplicitUseKindFlags.InstantiatedNoFixedConstructorSignature)]
-public sealed class AtomicOperationsFixture : IDisposable
+public sealed class AtomicOperationsFixture : IAsyncLifetime
 {
     internal IntegrationTestContext<TestableStartup, OperationsDbContext> TestContext { get; }
 
@@ -21,8 +22,13 @@ public AtomicOperationsFixture()
         TestContext.ConfigureServicesAfterStartup(services => services.AddSingleton<ResourceDefinitionHitCounter>());
     }
 
-    public void Dispose()
+    public Task InitializeAsync()
     {
-        TestContext.Dispose();
+        return Task.CompletedTask;
+    }
+
+    public async Task DisposeAsync()
+    {
+        await TestContext.DisposeAsync();
     }
 }

test/JsonApiDotNetCoreMongoDbTests/JsonApiDotNetCoreMongoDbTests.csproj

@@ -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.MongoDb\JsonApiDotNetCore.MongoDb.csproj" />

test/JsonApiDotNetCoreMongoDbTests/xunit.runner.json

@@ -2,16 +2,26 @@
 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;
+
     protected abstract JsonSerializerOptions SerializerOptions { get; }
 
+    static IntegrationTest()
+    {
+        int maxConcurrentTestRuns = Environment.GetEnvironmentVariable("APPVEYOR") != null ? 32 : 64;
+        ThrottleSemaphore = new SemaphoreSlim(maxConcurrentTestRuns);
+    }
+
     public async Task<(HttpResponseMessage httpResponse, TResponseDocument responseDocument)> ExecuteGetAsync<TResponseDocument>(string requestUrl,
         Action<HttpRequestHeaders>? setRequestHeaders = null)
     {
@@ -99,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;
+    }
 }

test/TestBuildingBlocks/IntegrationTest.cs

@@ -28,7 +28,7 @@ namespace TestBuildingBlocks;
 /// <see cref="MongoDbContextShim" />.
 /// </typeparam>
 [UsedImplicitly(ImplicitUseKindFlags.InstantiatedNoFixedConstructorSignature)]
-public class IntegrationTestContext<TStartup, TMongoDbContextShim> : IntegrationTest, IDisposable
+public class IntegrationTestContext<TStartup, TMongoDbContextShim> : IntegrationTest
     where TStartup : class
     where TMongoDbContextShim : MongoDbContextShim
 {
@@ -125,19 +125,6 @@ private void ConfigureJsonApiOptions(JsonApiOptions options)
         options.SerializerOptions.WriteIndented = true;
     }
 
-    public void Dispose()
-    {
-        if (_lazyFactory.IsValueCreated)
-        {
-            _lazyFactory.Value.Dispose();
-        }
-
-        if (_runner.IsValueCreated)
-        {
-            _runner.Value.Dispose();
-        }
-    }
-
     public void ConfigureServicesAfterStartup(Action<IServiceCollection> servicesConfiguration)
     {
         _afterServicesConfiguration = servicesConfiguration;
@@ -151,6 +138,26 @@ public async Task RunOnDatabaseAsync(Func<TMongoDbContextShim, Task> asyncAction
         await asyncAction(mongoDbContextShim);
     }
 
+    public override async Task DisposeAsync()
+    {
+        try
+        {
+            if (_lazyFactory.IsValueCreated)
+            {
+                await _lazyFactory.Value.DisposeAsync();
+            }
+
+            if (_runner.IsValueCreated)
+            {
+                _runner.Value.Dispose();
+            }
+        }
+        finally
+        {
+            await base.DisposeAsync();
+        }
+    }
+
     private sealed class IntegrationTestWebApplicationFactory : WebApplicationFactory<TStartup>
     {
         private Action<IServiceCollection>? _beforeServicesConfiguration;