Update the SqlServerDacDatabaseInitializer to add the support of additional settings to specify the locations of the database.

Author: GillesTourreau

src/Testing.Databases.SqlServer.Dac/SqlServerDacDatabaseInitializer.cs

@@ -10,10 +10,10 @@ namespace PosInformatique.Testing.Databases.SqlServer
 
     /// <summary>
     /// Initializer used to initialize the database for the tests.
-    /// Call the <see cref="Initialize(SqlServerDatabaseInitializer, string, string)"/> method to initialize a database from
+    /// Call the <see cref="Initialize(SqlServerDatabaseInitializer, string, string, SqlServerDacDeploymentSettings?)"/> method to initialize a database from
     /// a DACPAC file.
     /// </summary>
-    /// <remarks>The database will be created the call of the <see cref="Initialize(SqlServerDatabaseInitializer, string, string)"/> method. For the next calls
+    /// <remarks>The database will be created the call of the <see cref="Initialize(SqlServerDatabaseInitializer, string, string, SqlServerDacDeploymentSettings?)"/> method. For the next calls
     /// the database is preserved but all the data are deleted.</remarks>
     public static class SqlServerDacDatabaseInitializer
     {
@@ -23,8 +23,9 @@ public static class SqlServerDacDatabaseInitializer
         /// <param name="initializer"><see cref="SqlServerDatabaseInitializer"/> which the initialization will be perform on.</param>
         /// <param name="packageName">Full path of the DACPAC file.</param>
         /// <param name="connectionString">Connection string to the SQL Server with administrator rights.</param>
+        /// <param name="settings">Additionnal settings for the DACPAC <paramref name="packageName"/> to deploy.</param>
         /// <returns>An instance of the <see cref="SqlServerDatabase"/> which allows to perform query to initialize the data.</returns>
-        public static SqlServerDatabase Initialize(this SqlServerDatabaseInitializer initializer, string packageName, string connectionString)
+        public static SqlServerDatabase Initialize(this SqlServerDatabaseInitializer initializer, string packageName, string connectionString, SqlServerDacDeploymentSettings? settings = null)
         {
             var connectionStringBuilder = new SqlConnectionStringBuilder(connectionString);
 
@@ -34,7 +35,7 @@ public static SqlServerDatabase Initialize(this SqlServerDatabaseInitializer ini
 
             if (!initializer.IsInitialized)
             {
-                database = server.DeployDacPackage(packageName, connectionStringBuilder.InitialCatalog);
+                database = server.DeployDacPackage(packageName, connectionStringBuilder.InitialCatalog, settings);
 
                 initializer.IsInitialized = true;
             }

tests/Testing.Databases.SqlServer.Dac.Tests/SqlServerDacExtensionsTest.cs

@@ -40,10 +40,10 @@ public void DeployDacPackage(bool withSettings)
         }
 
         [Fact]
-        public void DeployDacPackage_WithSpecificFile()
+        public void DeployDacPackage_WithSpecificDataFileName()
         {
             // Create existing database to be sure the database is recreated when deploying the database with a DACPAC
-            CreateDatabase("SqlServerDacExtensionsTest_DeployDacPackage_WithSpecificFile");
+            CreateDatabase("SqlServerDacExtensionsTest_DeployDacPackage_WithSpecificDataFileName");
 
             using var temporaryFolder = TemporaryFolder.Create();
 
@@ -54,7 +54,7 @@ public void DeployDacPackage_WithSpecificFile()
                 DataFileName = Path.Combine(temporaryFolder.Path, "TheSpecificDataFileName.mdf"),
             };
 
-            var database = server.DeployDacPackage("Testing.Databases.SqlServer.Tests.DacPac.dacpac", "SqlServerDacExtensionsTest_DeployDacPackage_WithSpecificFile", settings);
+            var database = server.DeployDacPackage("Testing.Databases.SqlServer.Tests.DacPac.dacpac", "SqlServerDacExtensionsTest_DeployDacPackage_WithSpecificDataFileName", settings);
 
             var table = database.ExecuteQuery("SELECT * FROM MyTable");
 
@@ -72,7 +72,7 @@ public void DeployDacPackage_WithSpecificFile()
 
             result.Rows.Should().HaveCount(2);
 
-            result.Rows[0]["name"].Should().Be("SqlServerDacExtensionsTest_DeployDacPackage_WithSpecificFile");
+            result.Rows[0]["name"].Should().Be("SqlServerDacExtensionsTest_DeployDacPackage_WithSpecificDataFileName");
             result.Rows[0]["physical_name"].Should().Be(Path.Combine(temporaryFolder.Path, "TheSpecificDataFileName.mdf"));
             result.Rows[0]["type_desc"].Should().Be("ROWS");
 
@@ -81,7 +81,7 @@ public void DeployDacPackage_WithSpecificFile()
             result.Rows[1]["type_desc"].Should().Be("LOG");
 
             // Delete the database (for deleting the temporary folder).
-            server.DeleteDatabase("SqlServerDacExtensionsTest_DeployDacPackage_WithSpecificFile");
+            server.DeleteDatabase("SqlServerDacExtensionsTest_DeployDacPackage_WithSpecificDataFileName");
         }
 
         private static void CreateDatabase(string name)

tests/Testing.Databases.SqlServer.Dac.Tests/SqlServerDatabaseInitializerTest.cs

@@ -13,8 +13,11 @@ public class SqlServerDatabaseInitializerTest : IClassFixture<SqlServerDatabaseI
 
         private readonly SqlServerDatabase database;
 
+        private readonly SqlServerDatabaseInitializer initializer;
+
         public SqlServerDatabaseInitializerTest(SqlServerDatabaseInitializer initializer)
         {
+            this.initializer = initializer;
             this.database = initializer.Initialize("Testing.Databases.SqlServer.Tests.DacPac.dacpac", ConnectionString);
 
             var table = this.database.ExecuteQuery("SELECT * FROM MyTable");
@@ -29,6 +32,8 @@ public SqlServerDatabaseInitializerTest(SqlServerDatabaseInitializer initializer
         [Fact]
         public void Test1()
         {
+            this.initializer.IsInitialized.Should().BeTrue();
+
             var currentUser = this.database.ExecuteQuery("SELECT SUSER_NAME()");
             currentUser.Rows[0][0].Should().Be($"{Environment.UserDomainName}\\{Environment.UserName}");
 
@@ -50,6 +55,8 @@ public void Test1()
         [Fact]
         public void Test2()
         {
+            this.initializer.IsInitialized.Should().BeTrue();
+
             var currentUser = this.database.ExecuteQuery("SELECT SUSER_NAME()");
             currentUser.Rows[0][0].Should().Be($"{Environment.UserDomainName}\\{Environment.UserName}");
 
@@ -71,6 +78,8 @@ public void Test2()
         [Fact]
         public async Task Test1Async()
         {
+            this.initializer.IsInitialized.Should().BeTrue();
+
             var currentUser = await this.database.ExecuteQueryAsync("SELECT SUSER_NAME()");
             currentUser.Rows[0][0].Should().Be($"{Environment.UserDomainName}\\{Environment.UserName}");
 
@@ -92,6 +101,8 @@ public async Task Test1Async()
         [Fact]
         public async Task Test2Async()
         {
+            this.initializer.IsInitialized.Should().BeTrue();
+
             var currentUser = await this.database.ExecuteQueryAsync("SELECT SUSER_NAME()");
             currentUser.Rows[0][0].Should().Be($"{Environment.UserDomainName}\\{Environment.UserName}");
 
@@ -109,5 +120,61 @@ public async Task Test2Async()
             // Insert a row which should not be use in other tests.
             await this.database.InsertIntoAsync("MyTable", new { Id = 99, Name = "Should not be here for the next test" });
         }
+
+        [Fact]
+        public void Initialize_WithSpecificDataFileName()
+        {
+            this.initializer.IsInitialized.Should().BeTrue();
+
+            // Create existing database to be sure the database is recreated when deploying the database with a DACPAC
+            CreateDatabase("SqlServerDatabaseInitializerTest_Initialize_WithSpecificDataFileName");
+
+            using var temporaryFolder = TemporaryFolder.Create();
+
+            var server = new SqlServer(ConnectionString);
+
+            var settings = new SqlServerDacDeploymentSettings()
+            {
+                DataFileName = Path.Combine(temporaryFolder.Path, "TheSpecificDataFileName.mdf"),
+            };
+
+            var database = server.DeployDacPackage("Testing.Databases.SqlServer.Tests.DacPac.dacpac", "SqlServerDatabaseInitializerTest_Initialize_WithSpecificDataFileName", settings);
+
+            var table = database.ExecuteQuery("SELECT * FROM MyTable");
+
+            table.Rows.Should().BeEmpty();
+
+            // Insert data to check the connection.
+            database.InsertInto("MyTable", new { Id = 1, Name = "Name 1" });
+            database.InsertInto("MyTable", new { Id = 2, Name = "Name 2" });
+
+            // Check the location of the database
+            File.Exists(Path.Combine(temporaryFolder.Path, "TheSpecificDataFileName.mdf")).Should().BeTrue();
+            File.Exists(Path.Combine(temporaryFolder.Path, "TheSpecificDataFileName_log.ldf")).Should().BeTrue();
+
+            var result = database.ExecuteQuery("SELECT * FROM [sys].[database_files] ORDER BY [physical_name]");
+
+            result.Rows.Should().HaveCount(2);
+
+            result.Rows[0]["name"].Should().Be("SqlServerDatabaseInitializerTest_Initialize_WithSpecificDataFileName");
+            result.Rows[0]["physical_name"].Should().Be(Path.Combine(temporaryFolder.Path, "TheSpecificDataFileName.mdf"));
+            result.Rows[0]["type_desc"].Should().Be("ROWS");
+
+            result.Rows[1]["name"].Should().Be("TheSpecificDataFileName_log");
+            result.Rows[1]["physical_name"].Should().Be(Path.Combine(temporaryFolder.Path, "TheSpecificDataFileName_log.ldf"));
+            result.Rows[1]["type_desc"].Should().Be("LOG");
+
+            // Delete the database (for deleting the temporary folder).
+            server.DeleteDatabase("SqlServerDatabaseInitializerTest_Initialize_WithSpecificDataFileName");
+        }
+
+        private static void CreateDatabase(string name)
+        {
+            var server = new SqlServer(ConnectionString);
+
+            var database = server.CreateEmptyDatabase(name);
+
+            database.ExecuteNonQuery("CREATE TABLE OtherTable (Id INT)");
+        }
     }
 }