Apply global convention for all integration tests: change DeleteBehavior.ClientSetNull to DeleteBehavior.SetNull

bkoelman · bkoelman · commit 7cdf273076b8 · 2022-11-12T19:38:14.000+01:00
This improves speed and reduces the number of errors logged by the PostgreSQL server when running tests, because we no longer need the "truncate table cascade" fallback in DbContextExtensions.
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/AtomicOperations/OperationsDbContext.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/AtomicOperations/OperationsDbContext.cs
@@ -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 --git a/test/JsonApiDotNetCoreTests/IntegrationTests/CompositeKeys/CompositeDbContext.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/CompositeKeys/CompositeDbContext.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 --git a/test/JsonApiDotNetCoreTests/IntegrationTests/EagerLoading/EagerLoadingDbContext.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/EagerLoading/EagerLoadingDbContext.cs
@@ -34,5 +34,7 @@ protected override void OnModelCreating(ModelBuilder builder)
             .HasOne(building => building.SecondaryDoor)
             .WithOne()
             .HasForeignKey<Building>("SecondaryDoorId");
+
+        base.OnModelCreating(builder);
     }
 }
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/InputValidation/ModelState/ModelStateDbContext.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/InputValidation/ModelState/ModelStateDbContext.cs
@@ -37,5 +37,7 @@ protected override void OnModelCreating(ModelBuilder builder)
         builder.Entity<SystemDirectory>()
             .HasOne(systemDirectory => systemDirectory.AlsoSelf)
             .WithOne();
+
+        base.OnModelCreating(builder);
     }
 }
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/Links/LinksDbContext.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/Links/LinksDbContext.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 --git a/test/JsonApiDotNetCoreTests/IntegrationTests/MultiTenancy/MultiTenancyDbContext.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/MultiTenancy/MultiTenancyDbContext.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 --git a/test/JsonApiDotNetCoreTests/IntegrationTests/QueryStrings/Filtering/FilterDbContext.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/QueryStrings/Filtering/FilterDbContext.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 --git a/test/JsonApiDotNetCoreTests/IntegrationTests/QueryStrings/QueryStringDbContext.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/QueryStrings/QueryStringDbContext.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 --git a/test/JsonApiDotNetCoreTests/IntegrationTests/ReadWrite/ReadWriteDbContext.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/ReadWrite/ReadWriteDbContext.cs
@@ -49,5 +49,7 @@ protected override void OnModelCreating(ModelBuilder builder)
                 left => left
                     .HasOne(joinEntity => joinEntity.ToItem)
                     .WithMany());
+
+        base.OnModelCreating(builder);
     }
 }
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/RequiredRelationships/DefaultBehaviorDbContext.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/RequiredRelationships/DefaultBehaviorDbContext.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 --git a/test/JsonApiDotNetCoreTests/IntegrationTests/ResourceDefinitions/Serialization/SerializationDbContext.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/ResourceDefinitions/Serialization/SerializationDbContext.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 --git a/test/JsonApiDotNetCoreTests/IntegrationTests/ResourceInheritance/ResourceInheritanceReadTests.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/ResourceInheritance/ResourceInheritanceReadTests.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 --git a/test/JsonApiDotNetCoreTests/IntegrationTests/ResourceInheritance/TablePerType/TablePerTypeDbContext.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/ResourceInheritance/TablePerType/TablePerTypeDbContext.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 --git a/test/JsonApiDotNetCoreTests/IntegrationTests/SoftDeletion/SoftDeletionDbContext.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/SoftDeletion/SoftDeletionDbContext.cs
@@ -24,5 +24,7 @@ protected override void OnModelCreating(ModelBuilder builder)
 
         builder.Entity<Department>()
             .HasQueryFilter(department => department.SoftDeletedAt == null);
+
+        base.OnModelCreating(builder);
     }
 }
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/ZeroKeys/ZeroKeyDbContext.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/ZeroKeys/ZeroKeyDbContext.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 --git a/test/TestBuildingBlocks/DbContextExtensions.cs b/test/TestBuildingBlocks/DbContextExtensions.cs
@@ -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 --git a/test/TestBuildingBlocks/TestableDbContext.cs b/test/TestBuildingBlocks/TestableDbContext.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;
+            }
+        }
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -31,5 +31,7 @@ protected override void OnModelCreating(ModelBuilder builder)`
`31`	`31`	`builder.Entity<MusicTrack>()`
`32`	`32`	`.HasMany(musicTrack => musicTrack.OccursIn)`
`33`	`33`	`.WithMany(playlist => playlist.Tracks);`
	`34`	`+`
	`35`	`+ base.OnModelCreating(builder);`
`34`	`36`	`}`
`35`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -39,5 +39,7 @@ protected override void OnModelCreating(ModelBuilder builder)`
`39`	`39`	`builder.Entity<Car>()`
`40`	`40`	`.HasMany(car => car.PreviousDealerships)`
`41`	`41`	`.WithMany(dealership => dealership.SoldCars);`
	`42`	`+`
	`43`	`+ base.OnModelCreating(builder);`
`42`	`44`	`}`
`43`	`45`	`}`
Original file line number	Diff line number	Diff line change
`@@ -34,5 +34,7 @@ protected override void OnModelCreating(ModelBuilder builder)`
`34`	`34`	`.HasOne(building => building.SecondaryDoor)`
`35`	`35`	`.WithOne()`
`36`	`36`	`.HasForeignKey<Building>("SecondaryDoorId");`
	`37`	`+`
	`38`	`+ base.OnModelCreating(builder);`
`37`	`39`	`}`
`38`	`40`	`}`
Original file line number	Diff line number	Diff line change
`@@ -37,5 +37,7 @@ protected override void OnModelCreating(ModelBuilder builder)`
`37`	`37`	`builder.Entity<SystemDirectory>()`
`38`	`38`	`.HasOne(systemDirectory => systemDirectory.AlsoSelf)`
`39`	`39`	`.WithOne();`
	`40`	`+`
	`41`	`+ base.OnModelCreating(builder);`
`40`	`42`	`}`
`41`	`43`	`}`
Original file line number	Diff line number	Diff line change
`@@ -24,5 +24,7 @@ protected override void OnModelCreating(ModelBuilder builder)`
`24`	`24`	`.HasOne(photo => photo.Location)`
`25`	`25`	`.WithOne(location => location.Photo)`
`26`	`26`	`.HasForeignKey<Photo>("LocationId");`
	`27`	`+`
	`28`	`+ base.OnModelCreating(builder);`
`27`	`29`	`}`
`28`	`30`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,5 +21,7 @@ protected override void OnModelCreating(ModelBuilder builder)`
`21`	`21`	`builder.Entity<FilterableResource>()`
`22`	`22`	`.Property(resource => resource.SomeDateTimeInLocalZone)`
`23`	`23`	`.HasColumnType("timestamp without time zone");`
	`24`	`+`
	`25`	`+ base.OnModelCreating(builder);`
`24`	`26`	`}`
`25`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -49,5 +49,7 @@ protected override void OnModelCreating(ModelBuilder builder)`
`49`	`49`	`left => left`
`50`	`50`	`.HasOne(joinEntity => joinEntity.ToItem)`
`51`	`51`	`.WithMany());`
	`52`	`+`
	`53`	`+ base.OnModelCreating(builder);`
`52`	`54`	`}`
`53`	`55`	`}`
Original file line number	Diff line number	Diff line change
`@@ -33,5 +33,7 @@ protected override void OnModelCreating(ModelBuilder builder)`
`33`	`33`	`.HasOne(order => order.Shipment)`
`34`	`34`	`.WithOne(shipment => shipment.Order)`
`35`	`35`	`.HasForeignKey<Shipment>("OrderId");`
	`36`	`+`
	`37`	`+ base.OnModelCreating(builder);`
`36`	`38`	`}`
`37`	`39`	`}`