Add SqlCmd library.

Author: GillesTourreau

.github/workflows/github-actions-release.yml

@@ -7,7 +7,7 @@ on:
         type: string
         description: The version of the library
         required: true
-        default: 2.4.0
+        default: 3.0.0
       VersionSuffix:
         type: string
         description: The version suffix of the library (for example rc.1)
@@ -32,19 +32,26 @@ jobs:
           --property:VersionSuffix=${{ github.event.inputs.VersionSuffix }}
           "src/Testing.Databases.SqlServer/Testing.Databases.SqlServer.csproj"
 
+      - name: Build Testing.Databases.SqlServer.Dac
+        run: dotnet pack 
+          --property:Configuration=Release
+          --property:VersionPrefix=${{ github.event.inputs.VersionPrefix }}
+          --property:VersionSuffix=${{ github.event.inputs.VersionSuffix }}
+          "src/Testing.Databases.SqlServer.Dac/Testing.Databases.SqlServer.Dac.csproj"
+
       - name: Build Testing.Databases.SqlServer.EntityFramework
         run: dotnet pack 
           --property:Configuration=Release
           --property:VersionPrefix=${{ github.event.inputs.VersionPrefix }}
           --property:VersionSuffix=${{ github.event.inputs.VersionSuffix }}
           "src/Testing.Databases.SqlServer.EntityFramework/Testing.Databases.SqlServer.EntityFramework.csproj"
 
-      - name: Build Testing.Databases.SqlServer.Dac
+      - name: Build Testing.Databases.SqlServer.SqlCmd
         run: dotnet pack 
           --property:Configuration=Release
           --property:VersionPrefix=${{ github.event.inputs.VersionPrefix }}
           --property:VersionSuffix=${{ github.event.inputs.VersionSuffix }}
-          "src/Testing.Databases.SqlServer.Dac/Testing.Databases.SqlServer.Dac.csproj"
+          "src/Testing.Databases.SqlServer.SqlCmd/Testing.Databases.SqlServer.SqlCmd.csproj"
 
       - name: Publish the package to nuget.org
         run: dotnet nuget push "src/**/bin/Release/*.nupkg" --api-key "${{ secrets.NUGET_APIKEY }}" --source https://api.nuget.org/v3/index.json

PosInformatique.Testing.Databases.sln

@@ -59,6 +59,10 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Testing.Databases.SqlServer
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testing.Databases.SqlServer.Dac.Tests", "tests\Testing.Databases.SqlServer.Dac.Tests\Testing.Databases.SqlServer.Dac.Tests.csproj", "{6751A585-1BB0-49A1-BF68-D7FBD3392DF6}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testing.Databases.SqlServer.SqlCmd", "src\Testing.Databases.SqlServer.SqlCmd\Testing.Databases.SqlServer.SqlCmd.csproj", "{D3004122-CCDD-4EAD-BD9E-DA6DFF470943}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testing.Databases.SqlServer.SqlCmd.Tests", "tests\Testing.Databases.SqlServer.SqlCmd.Tests\Testing.Databases.SqlServer.SqlCmd.Tests.csproj", "{F8E025D7-4E2F-437A-ABFA-C43A1368E15A}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -107,6 +111,14 @@ Global
 		{6751A585-1BB0-49A1-BF68-D7FBD3392DF6}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{6751A585-1BB0-49A1-BF68-D7FBD3392DF6}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{6751A585-1BB0-49A1-BF68-D7FBD3392DF6}.Release|Any CPU.Build.0 = Release|Any CPU
+		{D3004122-CCDD-4EAD-BD9E-DA6DFF470943}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{D3004122-CCDD-4EAD-BD9E-DA6DFF470943}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{D3004122-CCDD-4EAD-BD9E-DA6DFF470943}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{D3004122-CCDD-4EAD-BD9E-DA6DFF470943}.Release|Any CPU.Build.0 = Release|Any CPU
+		{F8E025D7-4E2F-437A-ABFA-C43A1368E15A}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{F8E025D7-4E2F-437A-ABFA-C43A1368E15A}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{F8E025D7-4E2F-437A-ABFA-C43A1368E15A}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{F8E025D7-4E2F-437A-ABFA-C43A1368E15A}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE

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

@@ -0,0 +1,91 @@
+//-----------------------------------------------------------------------
+// <copyright file="SqlCmdCommandLineArgumentsBuilder.cs" company="P.O.S Informatique">
+//     Copyright (c) P.O.S Informatique. All rights reserved.
+// </copyright>
+//-----------------------------------------------------------------------
+
+namespace PosInformatique.Testing.Databases.SqlServer
+{
+    using System.Text;
+    using Microsoft.Data.SqlClient;
+
+    internal sealed class SqlCmdCommandLineArgumentsBuilder
+    {
+        private readonly Dictionary<string, string> variables;
+
+        public SqlCmdCommandLineArgumentsBuilder(SqlConnectionStringBuilder connectionString)
+        {
+            this.Database = connectionString.InitialCatalog;
+            this.LoginId = connectionString.UserID;
+            this.Password = connectionString.Password;
+            this.Server = connectionString.DataSource;
+            this.TrustedConnection = connectionString.IntegratedSecurity;
+
+            this.variables = new Dictionary<string, string>();
+        }
+
+        public string? Database { get; set; }
+
+        public string? InputFile { get; set; }
+
+        public string? LoginId { get; set; }
+
+        public string? Password { get; set; }
+
+        public string? Server { get; set; }
+
+        public bool TrustedConnection { get; set; }
+
+        public IReadOnlyDictionary<string, string> Variables => this.variables;
+
+        public void AddVariable(string name, string value)
+        {
+            this.variables.Add(name, value);
+        }
+
+        public override string ToString()
+        {
+            var parameters = new StringBuilder();
+
+            if (!string.IsNullOrEmpty(this.Database))
+            {
+                parameters.Append($"-d \"{this.Database}\" ");
+            }
+
+            if (!string.IsNullOrEmpty(this.InputFile))
+            {
+                parameters.Append($"-i \"{this.InputFile}\" ");
+            }
+
+            if (!string.IsNullOrEmpty(this.LoginId))
+            {
+                parameters.Append($"-U \"{this.LoginId}\" ");
+            }
+
+            if (!string.IsNullOrEmpty(this.Password))
+            {
+                parameters.Append($"-P \"{this.Password}\" ");
+            }
+
+            if (this.TrustedConnection)
+            {
+                parameters.Append($"-E ");
+            }
+
+            if (!string.IsNullOrEmpty(this.Server))
+            {
+                parameters.Append($"-S \"{this.Server}\" ");
+            }
+
+            foreach (var variable in this.variables)
+            {
+                parameters.Append($"-v {variable.Key}=\"{variable.Value}\" ");
+            }
+
+            // To have exit error code when the script contains errors.
+            parameters.Append("-b");
+
+            return parameters.ToString();
+        }
+    }
+}

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

@@ -0,0 +1,51 @@
+//-----------------------------------------------------------------------
+// <copyright file="SqlCmdDatabaseInitializer.cs" company="P.O.S Informatique">
+//     Copyright (c) P.O.S Informatique. All rights reserved.
+// </copyright>
+//-----------------------------------------------------------------------
+
+namespace PosInformatique.Testing.Databases.SqlServer
+{
+    using Microsoft.Data.SqlClient;
+
+    /// <summary>
+    /// Initializer used to initialize the database for the tests.
+    /// Call the <see cref="Initialize(SqlServerDatabaseInitializer, string, string, SqlCmdRunScriptSettings?)"/> method to initialize a database from
+    /// a T-SQL script file using <c>sqlcmd</c>.
+    /// </summary>
+    /// <remarks>The database will be created the call of the <see cref="Initialize(SqlServerDatabaseInitializer, string, string, SqlCmdRunScriptSettings?)"/> method. For the next calls
+    /// the database is preserved but all the data are deleted.</remarks>
+    public static class SqlCmdDatabaseInitializer
+    {
+        /// <summary>
+        /// Initialize a SQL Server database by executing the T-SQL script specified in the <paramref name="fileName"/> argument.
+        /// The script will be executed on the <c>master</c> database specified in the <paramref name="connectionString"/>, so
+        /// you have to switch the connection if need in your script using the T-SQL <c>USE</c> directive.
+        /// </summary>
+        /// <param name="initializer"><see cref="SqlServerDatabaseInitializer"/> which the initialization will be perform on.</param>
+        /// <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>
+        /// <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)
+        {
+            var connectionStringBuilder = new SqlConnectionStringBuilder(connectionString);
+
+            var server = new SqlServer(connectionString);
+
+            SqlServerDatabase database;
+
+            if (!initializer.IsInitialized)
+            {
+                server.Master.RunScript(fileName, settings);
+
+                initializer.IsInitialized = true;
+            }
+
+            database = server.GetDatabase(connectionStringBuilder.InitialCatalog);
+            database.ClearAllData();
+
+            return database;
+        }
+    }
+}

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

@@ -0,0 +1,62 @@
+//-----------------------------------------------------------------------
+// <copyright file="SqlCmdException.cs" company="P.O.S Informatique">
+//     Copyright (c) P.O.S Informatique. All rights reserved.
+// </copyright>
+//-----------------------------------------------------------------------
+
+namespace PosInformatique.Testing.Databases.SqlServer
+{
+    /// <summary>
+    /// Occured when an error has been raised by the SQL Server <c>sqlcmd</c> tool.
+    /// </summary>
+    public class SqlCmdException : Exception
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="SqlCmdException"/> class.
+        /// </summary>
+        public SqlCmdException()
+            : base()
+        {
+        }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="SqlCmdException"/> class
+        /// with the specified <paramref name="message"/>.
+        /// </summary>
+        /// <param name="message">Exception message.</param>
+        public SqlCmdException(string message)
+            : base(message)
+        {
+        }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="SqlCmdException"/> class
+        /// with the specified <paramref name="message"/> and <paramref name="output"/>
+        /// of the <c>sqlcmd</c> process.
+        /// </summary>
+        /// <param name="message">Exception message.</param>
+        /// <param name="output">Output of the <c>sqlcmd</c> process.</param>
+        public SqlCmdException(string message, string output)
+            : base(message)
+        {
+            this.Output = output;
+        }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="SqlCmdException"/> class
+        /// with the specified <paramref name="message"/> raised by
+        /// an other <paramref name="innerException"/>.
+        /// </summary>
+        /// <param name="message">Exception message.</param>
+        /// <param name="innerException">Previous <see cref="Exception"/> which raised the <see cref="SqlCmdException"/>.</param>
+        public SqlCmdException(string message, Exception innerException)
+            : base(message, innerException)
+        {
+        }
+
+        /// <summary>
+        /// Gets the output of the <c>sqlcmd</c> execution.
+        /// </summary>
+        public string? Output { get; }
+    }
+}

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

@@ -0,0 +1,94 @@
+//-----------------------------------------------------------------------
+// <copyright file="SqlCmdProcess.cs" company="P.O.S Informatique">
+//     Copyright (c) P.O.S Informatique. All rights reserved.
+// </copyright>
+//-----------------------------------------------------------------------
+
+namespace PosInformatique.Testing.Databases.SqlServer
+{
+    using System.Diagnostics;
+    using Microsoft.Data.SqlClient;
+
+    internal sealed class SqlCmdProcess : IDisposable
+    {
+        private Process? process;
+
+        private List<string> output;
+
+        private SqlCmdProcess(string arguments)
+        {
+            this.output = new List<string>();
+
+            this.process = new Process()
+            {
+                StartInfo =
+                {
+                    Arguments = arguments,
+                    FileName = "sqlcmd",
+                    RedirectStandardError = true,
+                    RedirectStandardOutput = true,
+                    UseShellExecute = false,
+                },
+            };
+
+            this.process.ErrorDataReceived += this.OnOutputDataReceived;
+            this.process.OutputDataReceived += this.OnOutputDataReceived;
+
+            this.process.Start();
+
+            this.process.BeginErrorReadLine();
+            this.process.BeginOutputReadLine();
+        }
+
+        public string Output => string.Join(Environment.NewLine, this.output);
+
+        public static SqlCmdProcess RunScript(SqlConnectionStringBuilder connectionString, string inputFile, SqlCmdRunScriptSettings settings)
+        {
+            var commandLineBuilder = new SqlCmdCommandLineArgumentsBuilder(connectionString)
+            {
+                InputFile = inputFile,
+            };
+
+            foreach (var variable in settings.Variables)
+            {
+                commandLineBuilder.AddVariable(variable.Key, variable.Value);
+            }
+
+            var process = new SqlCmdProcess(commandLineBuilder.ToString());
+
+            return process;
+        }
+
+        public void Dispose()
+        {
+            if (this.process is not null)
+            {
+                this.process.Dispose();
+                this.process = null;
+            }
+        }
+
+        public int WaitForExit()
+        {
+            if (this.process is null)
+            {
+                throw new ObjectDisposedException(this.GetType().FullName);
+            }
+
+            this.process.WaitForExit();
+
+            return this.process.ExitCode;
+        }
+
+        private void OnOutputDataReceived(object sender, DataReceivedEventArgs e)
+        {
+            if (e.Data is not null)
+            {
+                lock (this.output)
+                {
+                    this.output.Add(e.Data);
+                }
+            }
+        }
+    }
+}

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

@@ -0,0 +1,29 @@
+//-----------------------------------------------------------------------
+// <copyright file="SqlCmdRunScriptSettings.cs" company="P.O.S Informatique">
+//     Copyright (c) P.O.S Informatique. All rights reserved.
+// </copyright>
+//-----------------------------------------------------------------------
+
+namespace PosInformatique.Testing.Databases.SqlServer
+{
+    /// <summary>
+    /// Contains additional settings when runing the <c>sqlcmd</c>.
+    /// </summary>
+    public class SqlCmdRunScriptSettings
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="SqlCmdRunScriptSettings"/> class.
+        /// </summary>
+        public SqlCmdRunScriptSettings()
+        {
+            this.Variables = new Dictionary<string, string>();
+        }
+
+        /// <summary>
+        /// Gets a collection of variables and associated values which will be applied
+        /// on the script to run. The variables can be referenced in the T-SQL script
+        /// using the <c>$(Variable)</c> syntax.
+        /// </summary>
+        public IDictionary<string, string> Variables { get; }
+    }
+}