Testing: more flexibility for cleanup

Author: PawelGerr

Directory.Build.props

@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <Copyright>(c) $([System.DateTime]::Now.Year), Pawel Gerr. All rights reserved.</Copyright>
-    <VersionPrefix>4.2.3</VersionPrefix>
+    <VersionPrefix>4.3.0</VersionPrefix>
     <Authors>Pawel Gerr</Authors>    
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <PackageProjectUrl>https://dev.azure.com/pawelgerr/Thinktecture.EntityFrameworkCore</PackageProjectUrl>

src/Thinktecture.EntityFrameworkCore.SqlServer.Testing/EntityFrameworkCore/Testing/ITestIsolationOptions.cs

@@ -0,0 +1,169 @@
+using Microsoft.Data.SqlClient;
+using Microsoft.EntityFrameworkCore.Infrastructure;
+using Microsoft.EntityFrameworkCore.Migrations;
+using Microsoft.EntityFrameworkCore.Storage;
+
+namespace Thinktecture.EntityFrameworkCore.Testing;
+
+/// <summary>
+/// Options for test isolation behavior.
+/// </summary>
+public interface ITestIsolationOptions
+{
+   /// <summary>
+   /// Test isolation via ambient transaction.
+   /// </summary>
+   public static readonly ITestIsolationOptions SharedTablesAmbientTransaction = new ShareTablesIsolation();
+
+   /// <summary>
+   /// Rollbacks migrations and then deletes database objects (like tables).
+   /// </summary>
+   public static readonly ITestIsolationOptions RollbackMigrationsAndCleanup = new RollbackMigrationsAndCleanupDatabase();
+
+   /// <summary>
+   /// Deletes database objects (like tables).
+   /// </summary>
+   public static readonly ITestIsolationOptions CleanupOnly = new CleanupDatabase();
+
+   /// <summary>
+   /// Indicator, whether the database needs cleanup.
+   /// </summary>
+   bool NeedsCleanup { get; }
+
+   /// <summary>
+   /// Cleanup of the database.
+   /// </summary>
+   void Cleanup(DbContext dbContext, string schema);
+
+   private class ShareTablesIsolation : ITestIsolationOptions
+   {
+      public bool NeedsCleanup => false;
+
+      public void Cleanup(DbContext dbContext, string schema)
+      {
+      }
+   }
+
+   private class RollbackMigrationsAndCleanupDatabase : ITestIsolationOptions
+   {
+      public bool NeedsCleanup => true;
+
+      public void Cleanup(DbContext dbContext, string schema)
+      {
+         RollbackMigrations(dbContext);
+         DeleteDatabaseObjects(dbContext, schema);
+      }
+   }
+
+   private class CleanupDatabase : ITestIsolationOptions
+   {
+      public bool NeedsCleanup => true;
+
+      public void Cleanup(DbContext dbContext, string schema)
+      {
+         DeleteDatabaseObjects(dbContext, schema);
+      }
+   }
+
+   /// <summary>
+   /// Rollbacks all migrations.
+   /// </summary>
+   protected static void RollbackMigrations(DbContext dbContext)
+   {
+      ArgumentNullException.ThrowIfNull(dbContext);
+
+      dbContext.GetService<IMigrator>().Migrate("0");
+   }
+
+   /// <summary>
+   /// Deletes database objects (like tables) with provided <paramref name="schema"/>.
+   /// </summary>
+   protected static void DeleteDatabaseObjects(DbContext ctx, string schema)
+   {
+      ArgumentNullException.ThrowIfNull(ctx);
+      ArgumentNullException.ThrowIfNull(schema);
+
+      var sqlHelper = ctx.GetService<ISqlGenerationHelper>();
+
+      ctx.Database.ExecuteSqlRaw(GetSqlForCleanup(), new SqlParameter("@schema", schema));
+      ctx.Database.ExecuteSqlRaw(GetDropSchemaSql(sqlHelper, schema));
+   }
+
+   private static string GetSqlForCleanup()
+   {
+      return @"
+DECLARE @crlf NVARCHAR(MAX) = CHAR(13) + CHAR(10);
+DECLARE @sql NVARCHAR(MAX);
+DECLARE @cursor CURSOR
+
+-- Drop Constraints
+SET @cursor = CURSOR FAST_FORWARD FOR
+SELECT DISTINCT sql = 'ALTER TABLE ' + QUOTENAME(tc.TABLE_SCHEMA) + '.' +  QUOTENAME(tc.TABLE_NAME) + ' DROP ' + QUOTENAME(rc.CONSTRAINT_NAME) + ';' + @crlf
+FROM
+	INFORMATION_SCHEMA.REFERENTIAL_CONSTRAINTS rc
+	LEFT JOIN
+		INFORMATION_SCHEMA.TABLE_CONSTRAINTS tc
+		ON tc.CONSTRAINT_NAME = rc.CONSTRAINT_NAME
+WHERE
+   tc.TABLE_SCHEMA = @schema
+
+OPEN @cursor FETCH NEXT FROM @cursor INTO @sql
+
+WHILE (@@FETCH_STATUS = 0)
+BEGIN
+Exec sp_executesql @sql
+FETCH NEXT FROM @cursor INTO @sql
+END
+
+CLOSE @cursor
+DEALLOCATE @cursor
+
+-- Drop Views
+SELECT	@sql = N'';
+SELECT @sql = @sql + 'DROP VIEW ' + QUOTENAME(SCHEMA_NAME(schema_id)) + '.' + QUOTENAME(name) +';' + @crlf
+FROM
+	SYS.VIEWS
+WHERE
+   schema_id = SCHEMA_ID(@schema)
+
+EXEC(@sql);
+
+-- Drop Functions
+SELECT @sql = N'';
+SELECT @sql = @sql + N' DROP FUNCTION ' + QUOTENAME(SCHEMA_NAME(schema_id)) + N'.' + QUOTENAME(name)
+FROM sys.objects
+WHERE type_desc LIKE '%FUNCTION%'
+   AND schema_id = SCHEMA_ID(@schema);
+
+EXEC(@sql);
+
+-- Disable temporal tables
+SELECT	@sql = N'';
+SELECT @sql = @sql + 'IF OBJECTPROPERTY(OBJECT_ID(''' + QUOTENAME(SCHEMA_NAME(schema_id)) + '.' + QUOTENAME(name) +'''), ''TableTemporalType'') = 2' + @crlf
+            + ' ALTER TABLE ' + QUOTENAME(SCHEMA_NAME(schema_id)) + '.' + QUOTENAME(name) +' SET (SYSTEM_VERSIONING = OFF);' + @crlf
+FROM
+	SYS.TABLES
+WHERE
+   schema_id = SCHEMA_ID(@schema)
+
+EXEC(@sql);
+
+-- Drop tables
+SELECT	@sql = N'';
+SELECT @sql = @sql + 'DROP TABLE ' + QUOTENAME(SCHEMA_NAME(schema_id)) + '.' + QUOTENAME(name) +';' + @crlf
+FROM
+	SYS.TABLES
+WHERE
+   schema_id = SCHEMA_ID(@schema)
+
+EXEC(@sql);
+";
+   }
+
+   private static string GetDropSchemaSql(ISqlGenerationHelper sqlHelper, string schema)
+   {
+      ArgumentNullException.ThrowIfNull(sqlHelper);
+
+      return $"DROP SCHEMA {sqlHelper.DelimitIdentifier(schema)}";
+   }
+}

src/Thinktecture.EntityFrameworkCore.SqlServer.Testing/EntityFrameworkCore/Testing/SqlServerDbContextIntegrationTests.cs

@@ -51,12 +51,29 @@ protected SqlServerTestDbContextProviderBuilder<T> TestCtxProviderBuilder
    /// <param name="connectionString">Connection string to use.</param>
    /// <param name="useSharedTables">Indication whether to create new tables with a new schema or use the existing ones.</param>
    /// <param name="testOutputHelper">Output helper to use for logging.</param>
+   [Obsolete($"Use the overload with '{nameof(ITestIsolationOptions)}' instead.")]
    protected SqlServerDbContextIntegrationTests(
       string connectionString,
       bool useSharedTables = true,
       ITestOutputHelper? testOutputHelper = null)
+      : this(connectionString,
+             useSharedTables ? ITestIsolationOptions.SharedTablesAmbientTransaction : ITestIsolationOptions.RollbackMigrationsAndCleanup,
+             testOutputHelper)
    {
-      _testCtxProviderBuilder = new SqlServerTestDbContextProviderBuilder<T>(connectionString, useSharedTables)
+   }
+
+   /// <summary>
+   /// Initializes new instance of <see cref="SqlServerDbContextIntegrationTests{T}"/>.
+   /// </summary>
+   /// <param name="connectionString">Connection string to use.</param>
+   /// <param name="isolationOptions">Test isolation behavior.</param>
+   /// <param name="testOutputHelper">Output helper to use for logging.</param>
+   protected SqlServerDbContextIntegrationTests(
+      string connectionString,
+      ITestIsolationOptions isolationOptions,
+      ITestOutputHelper? testOutputHelper = null)
+   {
+      _testCtxProviderBuilder = new SqlServerTestDbContextProviderBuilder<T>(connectionString, isolationOptions)
          .UseLogging(testOutputHelper);
    }