Add guard for public methods in SqlCmd project.

Author: GillesTourreau

src/Directory.Build.props

@@ -11,6 +11,13 @@
     <PackageReadmeFile>README.md</PackageReadmeFile>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <PackageReleaseNotes>
+      3.0.0
+      - Add new PosInformatique.Testing.Databases.SqlCmd to initialize database using sqlcmd utility.
+      - For DACPAC deployment or database creation it is now possible to specify the location of the data and log files.
+
+      2.3.0
+      - Add the support to compare the seed and increment for the IDENTITY columns
+
       2.2.0
       - Add SqlServerDatabase.ClearDataAsync() method.
       - Add SqlServer.CreateDatabase() method to create database from an Entity Framework DbContext.

src/Testing.Databases.SqlServer.SqlCmd/SqlCmdDatabaseInitializer.cs

@@ -26,9 +26,22 @@ public static class SqlCmdDatabaseInitializer
         /// <param name="fileName">Full path of the T-SQL file to execute.</param>
         /// <param name="connectionString">Connection string to the SQL Server with administrator rights.</param>
         /// <param name="settings">Additionnal settings to run the <c>sqlcmd</c> tool.</param>
+        /// <exception cref="ArgumentNullException">If the specified <paramref name="initializer"/> argument is <see langword="null"/>.</exception>
+        /// <exception cref="ArgumentNullException">If the specified <paramref name="fileName"/> argument is <see langword="null"/>.</exception>
+        /// <exception cref="ArgumentNullException">If the specified <paramref name="connectionString"/> argument is <see langword="null"/>.</exception>
+        /// <exception cref="FileNotFoundException">If no file exists with the specified <paramref name="fileName"/> argument.</exception>
         /// <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 fileName, string connectionString, SqlCmdRunScriptSettings? settings = null)
         {
+            ArgumentNullException.ThrowIfNull(initializer, nameof(initializer));
+            ArgumentNullException.ThrowIfNull(fileName, nameof(fileName));
+            ArgumentNullException.ThrowIfNull(connectionString, nameof(connectionString));
+
+            if (!File.Exists(fileName))
+            {
+                throw new FileNotFoundException($"Could not find file '{fileName}'", fileName);
+            }
+
             var connectionStringBuilder = new SqlConnectionStringBuilder(connectionString);
 
             var server = new SqlServer(connectionString);

src/Testing.Databases.SqlServer.SqlCmd/SqlCmdProcess.cs

@@ -11,9 +11,9 @@ namespace PosInformatique.Testing.Databases.SqlServer
 
     internal sealed class SqlCmdProcess : IDisposable
     {
-        private Process? process;
+        private readonly List<string> output;
 
-        private List<string> output;
+        private Process? process;
 
         private SqlCmdProcess(string arguments)
         {

src/Testing.Databases.SqlServer.SqlCmd/SqlCmdSqlServerDatabaseExtensions.cs

@@ -19,10 +19,21 @@ public static class SqlCmdSqlServerDatabaseExtensions
         /// <param name="database"><paramref name="database"/> where the script will be executed on.</param>
         /// <param name="fileName">T-SQL script to execute on the <paramref name="database"/>.</param>
         /// <param name="settings">Additional settings to run the script.</param>
+        /// <exception cref="ArgumentNullException">If the specified <paramref name="database"/> argument is <see langword="null"/>.</exception>
+        /// <exception cref="ArgumentNullException">If the specified <paramref name="fileName"/> argument is <see langword="null"/>.</exception>
+        /// <exception cref="FileNotFoundException">If no file exists with the specified <paramref name="fileName"/> argument.</exception>
         /// <exception cref="SqlCmdException">If an error has been occured when running the T-SQL script. Check the <see cref="SqlCmdException.Output"/>
         /// to retrieve the output result of the script execution.</exception>
         public static void RunScript(this SqlServerDatabase database, string fileName, SqlCmdRunScriptSettings? settings = null)
         {
+            ArgumentNullException.ThrowIfNull(database, nameof(database));
+            ArgumentNullException.ThrowIfNull(fileName, nameof(fileName));
+
+            if (!File.Exists(fileName))
+            {
+                throw new FileNotFoundException($"Could not find file '{fileName}'", fileName);
+            }
+
             if (settings is null)
             {
                 settings = new SqlCmdRunScriptSettings();

tests/Testing.Databases.SqlServer.SqlCmd.Tests/SqlCmdDatabaseInitializerTest.cs

@@ -129,5 +129,48 @@ 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_WithDatabaseArgumentNull()
+        {
+            var act = () =>
+            {
+                SqlCmdDatabaseInitializer.Initialize(null, default, default);
+            };
+
+            act.Should().ThrowExactly<ArgumentNullException>()
+               .WithParameterName("initializer");
+        }
+
+        [Fact]
+        public void Initialize_WithFileNameArgumentNull()
+        {
+            var initializer = new SqlServerDatabaseInitializer();
+
+            initializer.Invoking(i => i.Initialize(null, default))
+                .Should().ThrowExactly<ArgumentNullException>()
+                .WithParameterName("fileName");
+        }
+
+        [Fact]
+        public void Initialize_WithConnectionStringArgumentNull()
+        {
+            var initializer = new SqlServerDatabaseInitializer();
+
+            initializer.Invoking(i => i.Initialize("The file name", null))
+                .Should().ThrowExactly<ArgumentNullException>()
+                .WithParameterName("connectionString");
+        }
+
+        [Fact]
+        public void Initialize_WithFileNotFound()
+        {
+            var initializer = new SqlServerDatabaseInitializer();
+
+            initializer.Invoking(i => i.Initialize("C:/Directory/FileNotFound.sql", "The connection stirng"))
+                .Should().ThrowExactly<FileNotFoundException>()
+                .WithMessage("Could not find file 'C:/Directory/FileNotFound.sql'")
+                .Which.FileName.Should().Be("C:/Directory/FileNotFound.sql");
+        }
     }
 }

tests/Testing.Databases.SqlServer.SqlCmd.Tests/SqlCmdRunScriptSettingsTest.cs

@@ -0,0 +1,19 @@
+//-----------------------------------------------------------------------
+// <copyright file="SqlCmdRunScriptSettingsTest.cs" company="P.O.S Informatique">
+//     Copyright (c) P.O.S Informatique. All rights reserved.
+// </copyright>
+//-----------------------------------------------------------------------
+
+namespace PosInformatique.Testing.Databases.SqlServer.Tests
+{
+    public class SqlCmdRunScriptSettingsTest
+    {
+        [Fact]
+        public void Constructor()
+        {
+            var settings = new SqlCmdRunScriptSettings();
+
+            settings.Variables.Should().BeEmpty();
+        }
+    }
+}

tests/Testing.Databases.SqlServer.SqlCmd.Tests/SqlCmdSqlServerExtensionsTest.cs

@@ -135,5 +135,38 @@ Changed database context to 'SqlCmdSqlServerExtensionsTest_RunScript_WithErros'.
 
             table.Rows.Should().BeEmpty();
         }
+
+        [Fact]
+        public void RunScript_WithDatabaseArgumentNull()
+        {
+            var act = () =>
+            {
+                SqlCmdSqlServerDatabaseExtensions.RunScript(null, default, default);
+            };
+
+            act.Should().ThrowExactly<ArgumentNullException>()
+               .WithParameterName("database");
+        }
+
+        [Fact]
+        public void RunScript_WithFileNameArgumentNull()
+        {
+            var server = new SqlServer(ConnectionString);
+
+            server.Master.Invoking(m => m.RunScript(null, default))
+                .Should().ThrowExactly<ArgumentNullException>()
+                .WithParameterName("fileName");
+        }
+
+        [Fact]
+        public void RunScript_WithFileNotFound()
+        {
+            var server = new SqlServer(ConnectionString);
+
+            server.Master.Invoking(m => m.RunScript("C:/Directory/FileNotFound.sql", default))
+                .Should().ThrowExactly<FileNotFoundException>()
+                .WithMessage("Could not find file 'C:/Directory/FileNotFound.sql'")
+                .Which.FileName.Should().Be("C:/Directory/FileNotFound.sql");
+        }
     }
 }