Add guard to public APIs.

GillesTourreau · GillesTourreau · commit f1eec4f4609e · 2025-09-24T09:11:46.000+02:00
diff --git a/PosInformatique.Testing.Databases.sln b/PosInformatique.Testing.Databases.sln
@@ -63,6 +63,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testing.Databases.SqlServer
 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
+Project("{D954291E-2A0B-460D-934E-DC6B0785DB48}") = "Testing.Databases.SqlServer.Shared", "src\Testing.Databases.SqlServer.Shared\Testing.Databases.SqlServer.Shared.shproj", "{B9F8C52D-4652-4FC6-A695-DC2F61BA05C9}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -133,4 +135,10 @@ Global
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {FAC64573-D665-48A8-AC75-7B82B692EC9E}
 	EndGlobalSection
+	GlobalSection(SharedMSBuildProjectFiles) = preSolution
+		src\Testing.Databases.SqlServer.Shared\Testing.Databases.SqlServer.Shared.projitems*{157ddf0d-9410-4646-94b9-9cee4c140f5e}*SharedItemsImports = 5
+		src\Testing.Databases.SqlServer.Shared\Testing.Databases.SqlServer.Shared.projitems*{8be60460-eba5-43de-b85d-c756e2988dc8}*SharedItemsImports = 5
+		src\Testing.Databases.SqlServer.Shared\Testing.Databases.SqlServer.Shared.projitems*{b9f8c52d-4652-4fc6-a695-dc2f61ba05c9}*SharedItemsImports = 13
+		src\Testing.Databases.SqlServer.Shared\Testing.Databases.SqlServer.Shared.projitems*{d3004122-ccdd-4ead-bd9e-da6dff470943}*SharedItemsImports = 5
+	EndGlobalSection
 EndGlobal
diff --git a/README.md b/README.md
@@ -177,12 +177,19 @@ For Entity Framework migration:
 ## 📦 NuGet package dependency versions
 
 These tools rely on a minimal set of NuGet dependencies to ensure broad compatibility.  
-They are built for **.NET 6.0** but also work seamlessly with newer versions of .NET:
-
-- .NET 7.0  
-- .NET 8.0  
-- .NET 9.0  
-- .NET 10.0  
+They are built for **.NET Core 6.0** and **.NET Framework 4.6.2** but also work seamlessly with newer versions of .NET:
+
+- .NET Framework 4.6.2  
+- .NET Framework 4.7
+- .NET Framework 4.7.1
+- .NET Framework 4.7.2  
+- .NET Framework 4.8
+- .NET Framework 4.8.1
+- .NET Core 6.0  
+- .NET Core 7.0  
+- .NET Core 8.0  
+- .NET Core 9.0  
+- .NET Core 10.0  
 
 ### Dependency versions
 
diff --git a/src/Testing.Databases.SqlServer.Dac/SqlServerDacDatabaseInitializer.cs b/src/Testing.Databases.SqlServer.Dac/SqlServerDacDatabaseInitializer.cs
@@ -24,9 +24,22 @@ public static class SqlServerDacDatabaseInitializer
         /// <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>
+        /// <exception cref="ArgumentNullException">If the specified <paramref name="initializer"/> argument is <see langword="null"/>.</exception>
+        /// <exception cref="ArgumentNullException">If the specified <paramref name="packageName"/> 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="packageName"/> 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 packageName, string connectionString, SqlServerDacDeploymentSettings? settings = null)
         {
+            Guard.ThrowIfNull(initializer, nameof(initializer));
+            Guard.ThrowIfNull(packageName, nameof(packageName));
+            Guard.ThrowIfNull(connectionString, nameof(connectionString));
+
+            if (!File.Exists(packageName))
+            {
+                throw new FileNotFoundException($"Could not find file '{packageName}'", packageName);
+            }
+
             var connectionStringBuilder = new SqlConnectionStringBuilder(connectionString);
 
             var server = new SqlServer(connectionString);
diff --git a/src/Testing.Databases.SqlServer.Dac/SqlServerDacExtensions.cs b/src/Testing.Databases.SqlServer.Dac/SqlServerDacExtensions.cs
@@ -22,9 +22,22 @@ public static class SqlServerDacExtensions
         /// <param name="fileName">File name (including the path) for the DACPAC file to deploy.</param>
         /// <param name="databaseName">Name of the database which will be created.</param>
         /// <param name="settings">Additional settings of the database to deploy.</param>
+        /// <exception cref="ArgumentNullException">If the specified <paramref name="server"/> 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="databaseName"/> 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 represents the deployed database.</returns>
         public static SqlServerDatabase DeployDacPackage(this SqlServer server, string fileName, string databaseName, SqlServerDacDeploymentSettings? settings = null)
         {
+            Guard.ThrowIfNull(server, nameof(server));
+            Guard.ThrowIfNull(fileName, nameof(fileName));
+            Guard.ThrowIfNull(databaseName, nameof(databaseName));
+
+            if (!File.Exists(fileName))
+            {
+                throw new FileNotFoundException($"Could not find file '{fileName}'", fileName);
+            }
+
             using (var package = DacPackage.Load(fileName))
             {
                 // Currently DacFx does not support to define explicitly the location of the database files.
diff --git a/src/Testing.Databases.SqlServer.Dac/Testing.Databases.SqlServer.Dac.csproj b/src/Testing.Databases.SqlServer.Dac/Testing.Databases.SqlServer.Dac.csproj
@@ -24,4 +24,6 @@
     <ProjectReference Include="..\Testing.Databases.SqlServer\Testing.Databases.SqlServer.csproj" />
   </ItemGroup>
 
+  <Import Project="..\Testing.Databases.SqlServer.Shared\Testing.Databases.SqlServer.Shared.projitems" Label="Shared" />
+
 </Project>
diff --git a/src/Testing.Databases.SqlServer.EntityFramework/EntityFrameworkDatabaseInitializerExtensions.cs b/src/Testing.Databases.SqlServer.EntityFramework/EntityFrameworkDatabaseInitializerExtensions.cs
@@ -21,8 +21,13 @@ public static class EntityFrameworkDatabaseInitializerExtensions
         /// <param name="initializer"><see cref="SqlServerDatabaseInitializer"/> which the initialization will be perform on.</param>
         /// <param name="context">Instance of the <see cref="DbContext"/> which represents the database schema to initialize.</param>
         /// <returns>An instance of the <see cref="SqlServerDatabase"/> which allows to perform query to initialize the data.</returns>
+        /// <exception cref="ArgumentNullException">If the specified <paramref name="initializer"/> argument is <see langword="null"/>.</exception>
+        /// <exception cref="ArgumentNullException">If the specified <paramref name="context"/> argument is <see langword="null"/>.</exception>
         public static SqlServerDatabase Initialize(this SqlServerDatabaseInitializer initializer, DbContext context)
         {
+            Guard.ThrowIfNull(initializer, nameof(initializer));
+            Guard.ThrowIfNull(context, nameof(context));
+
             var connectionString = context.Database.GetConnectionString();
 
             var connectionStringBuilder = new SqlConnectionStringBuilder(connectionString);
diff --git a/src/Testing.Databases.SqlServer.EntityFramework/EntityFrameworkSqlServerExtensions.cs b/src/Testing.Databases.SqlServer.EntityFramework/EntityFrameworkSqlServerExtensions.cs
@@ -21,9 +21,16 @@ public static class EntityFrameworkSqlServerExtensions
         /// <param name="server"><see cref="SqlServer"/> instance where the database will be created.</param>
         /// <param name="name">Name of the database to create.</param>
         /// <param name="context"><see cref="DbContext"/> which represents the database to create.</param>
+        /// <exception cref="ArgumentNullException">If the specified <paramref name="server"/> argument is <see langword="null"/>.</exception>
+        /// <exception cref="ArgumentNullException">If the specified <paramref name="name"/> argument is <see langword="null"/>.</exception>
+        /// <exception cref="ArgumentNullException">If the specified <paramref name="context"/> argument is <see langword="null"/>.</exception>
         /// <returns>An instance of the <see cref="SqlServerDatabase"/> which represents the deployed database.</returns>
         public static SqlServerDatabase CreateDatabase(this SqlServer server, string name, DbContext context)
         {
+            Guard.ThrowIfNull(server, nameof(server));
+            Guard.ThrowIfNull(name, nameof(name));
+            Guard.ThrowIfNull(context, nameof(context));
+
             var database = server.GetDatabase(name);
 
             context.Database.SetConnectionString(database.ConnectionString);
@@ -41,9 +48,16 @@ public static SqlServerDatabase CreateDatabase(this SqlServer server, string nam
         /// <param name="server"><see cref="SqlServer"/> instance where the database will be created.</param>
         /// <param name="name">Name of the database to create.</param>
         /// <param name="context"><see cref="DbContext"/> which represents the database to create.</param>
+        /// <exception cref="ArgumentNullException">If the specified <paramref name="server"/> argument is <see langword="null"/>.</exception>
+        /// <exception cref="ArgumentNullException">If the specified <paramref name="name"/> argument is <see langword="null"/>.</exception>
+        /// <exception cref="ArgumentNullException">If the specified <paramref name="context"/> argument is <see langword="null"/>.</exception>
         /// <returns>A <see cref="Task"/> which represents the asynchronous operation and contains an instance of the <see cref="SqlServerDatabase"/> that represents the deployed database.</returns>
         public static async Task<SqlServerDatabase> CreateDatabaseAsync(this SqlServer server, string name, DbContext context)
         {
+            Guard.ThrowIfNull(server, nameof(server));
+            Guard.ThrowIfNull(name, nameof(name));
+            Guard.ThrowIfNull(context, nameof(context));
+
             var database = server.GetDatabase(name);
 
             context.Database.SetConnectionString(database.ConnectionString);
diff --git a/src/Testing.Databases.SqlServer.EntityFramework/Testing.Databases.SqlServer.EntityFramework.csproj b/src/Testing.Databases.SqlServer.EntityFramework/Testing.Databases.SqlServer.EntityFramework.csproj
@@ -24,4 +24,6 @@
     <ProjectReference Include="..\Testing.Databases.SqlServer\Testing.Databases.SqlServer.csproj" />
   </ItemGroup>
 
+  <Import Project="..\Testing.Databases.SqlServer.Shared\Testing.Databases.SqlServer.Shared.projitems" Label="Shared" />
+
 </Project>
diff --git a/src/Testing.Databases.SqlServer.Shared/Guard.cs b/src/Testing.Databases.SqlServer.Shared/Guard.cs
@@ -0,0 +1,19 @@
+﻿//-----------------------------------------------------------------------
+// <copyright file="Guard.cs" company="P.O.S Informatique">
+//     Copyright (c) P.O.S Informatique. All rights reserved.
+// </copyright>
+//-----------------------------------------------------------------------
+
+namespace PosInformatique
+{
+    internal static class Guard
+    {
+        public static void ThrowIfNull(object? value, string paramName)
+        {
+            if (value is null)
+            {
+                throw new ArgumentNullException(paramName);
+            }
+        }
+    }
+}
diff --git a/src/Testing.Databases.SqlServer.Shared/Testing.Databases.SqlServer.Shared.projitems b/src/Testing.Databases.SqlServer.Shared/Testing.Databases.SqlServer.Shared.projitems
@@ -0,0 +1,14 @@
+﻿<?xml version="1.0" encoding="utf-8"?>
+<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <PropertyGroup>
+    <MSBuildAllProjects Condition="'$(MSBuildVersion)' == '' Or '$(MSBuildVersion)' &lt; '16.0'">$(MSBuildAllProjects);$(MSBuildThisFileFullPath)</MSBuildAllProjects>
+    <HasSharedItems>true</HasSharedItems>
+    <SharedGUID>b9f8c52d-4652-4fc6-a695-dc2f61ba05c9</SharedGUID>
+  </PropertyGroup>
+  <PropertyGroup Label="Configuration">
+    <Import_RootNamespace>Testing.Databases.SqlServer.Shared</Import_RootNamespace>
+  </PropertyGroup>
+  <ItemGroup>
+    <Compile Include="$(MSBuildThisFileDirectory)Guard.cs" />
+  </ItemGroup>
+</Project>
diff --git a/src/Testing.Databases.SqlServer.Shared/Testing.Databases.SqlServer.Shared.shproj b/src/Testing.Databases.SqlServer.Shared/Testing.Databases.SqlServer.Shared.shproj
@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project ToolsVersion="15.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <PropertyGroup Label="Globals">
+    <ProjectGuid>b9f8c52d-4652-4fc6-a695-dc2f61ba05c9</ProjectGuid>
+    <MinimumVisualStudioVersion>14.0</MinimumVisualStudioVersion>
+  </PropertyGroup>
+  <Import Project="$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props" Condition="Exists('$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props')" />
+  <Import Project="$(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion)\CodeSharing\Microsoft.CodeSharing.Common.Default.props" />
+  <Import Project="$(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion)\CodeSharing\Microsoft.CodeSharing.Common.props" />
+  <PropertyGroup />
+  <Import Project="Testing.Databases.SqlServer.Shared.projitems" Label="Shared" />
+  <Import Project="$(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion)\CodeSharing\Microsoft.CodeSharing.CSharp.targets" />
+</Project>
diff --git a/src/Testing.Databases.SqlServer.SqlCmd/SqlCmdDatabaseInitializer.cs b/src/Testing.Databases.SqlServer.SqlCmd/SqlCmdDatabaseInitializer.cs
@@ -33,9 +33,9 @@ public static class SqlCmdDatabaseInitializer
         /// <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));
+            Guard.ThrowIfNull(initializer, nameof(initializer));
+            Guard.ThrowIfNull(fileName, nameof(fileName));
+            Guard.ThrowIfNull(connectionString, nameof(connectionString));
 
             if (!File.Exists(fileName))
             {
diff --git a/src/Testing.Databases.SqlServer.SqlCmd/Testing.Databases.SqlServer.SqlCmd.csproj b/src/Testing.Databases.SqlServer.SqlCmd/Testing.Databases.SqlServer.SqlCmd.csproj
@@ -1,7 +1,7 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>net6.0</TargetFramework>
+    <TargetFrameworks>net6.0;net462</TargetFrameworks>
     <GenerateDocumentationFile>True</GenerateDocumentationFile>
 
     <Description>Testing.Databases.SqlServer.SqlCmd is a library that contains a set of tools for testing Data Access Layer using SQLCMD tool to initialize the database with a SQL script.</Description>
@@ -20,4 +20,6 @@
     <ProjectReference Include="..\Testing.Databases.SqlServer\Testing.Databases.SqlServer.csproj" />
   </ItemGroup>
 
+  <Import Project="..\Testing.Databases.SqlServer.Shared\Testing.Databases.SqlServer.Shared.projitems" Label="Shared" />
+
 </Project>
diff --git a/tests/Testing.Databases.SqlServer.Dac.Tests/SqlServerDacExtensionsTest.cs b/tests/Testing.Databases.SqlServer.Dac.Tests/SqlServerDacExtensionsTest.cs
@@ -84,6 +84,49 @@ public void DeployDacPackage_WithSpecificDataFileName()
             server.DeleteDatabase("SqlServerDacExtensionsTest_DeployDacPackage_WithSpecificDataFileName");
         }
 
+        [Fact]
+        public void DeployDacPackage_WithDatabaseArgumentNull()
+        {
+            var act = () =>
+            {
+                SqlServerDacExtensions.DeployDacPackage(null, default, default);
+            };
+
+            act.Should().ThrowExactly<ArgumentNullException>()
+               .WithParameterName("server");
+        }
+
+        [Fact]
+        public void DeployDacPackage_WithFileNameArgumentNull()
+        {
+            var server = new SqlServer(ConnectionString);
+
+            server.Invoking(s => s.DeployDacPackage(null, default))
+                .Should().ThrowExactly<ArgumentNullException>()
+                .WithParameterName("fileName");
+        }
+
+        [Fact]
+        public void DeployDacPackage_WithDatabaseNameArgumentNull()
+        {
+            var server = new SqlServer(ConnectionString);
+
+            server.Invoking(s => s.DeployDacPackage("C:/Directory/FileNotFound.sql", null))
+                .Should().ThrowExactly<ArgumentNullException>()
+                .WithParameterName("databaseName");
+        }
+
+        [Fact]
+        public void DeployDacPackage_WithFileNotFound()
+        {
+            var server = new SqlServer(ConnectionString);
+
+            server.Invoking(s => s.DeployDacPackage("C:/Directory/FileNotFound.sql", "The database"))
+                .Should().ThrowExactly<FileNotFoundException>()
+                .WithMessage("Could not find file 'C:/Directory/FileNotFound.sql'")
+                .Which.FileName.Should().Be("C:/Directory/FileNotFound.sql");
+        }
+
         private static void CreateDatabase(string name)
         {
             var server = new SqlServer(ConnectionString);
diff --git a/tests/Testing.Databases.SqlServer.Dac.Tests/SqlServerDatabaseInitializerTest.cs b/tests/Testing.Databases.SqlServer.Dac.Tests/SqlServerDatabaseInitializerTest.cs
@@ -168,6 +168,49 @@ public void Initialize_WithSpecificDataFileName()
             server.DeleteDatabase("SqlServerDatabaseInitializerTest_Initialize_WithSpecificDataFileName");
         }
 
+        [Fact]
+        public void Initialize_WithInitializerArgumentNull()
+        {
+            var act = () =>
+            {
+                SqlServerDacDatabaseInitializer.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("packageName");
+        }
+
+        [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_WithPackageNotFound()
+        {
+            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");
+        }
+
         private static void CreateDatabase(string name)
         {
             var server = new SqlServer(ConnectionString);
diff --git a/tests/Testing.Databases.SqlServer.EntityFramework.Tests/EntityFrameworkDatabaseInitializerExtensionsTest.cs b/tests/Testing.Databases.SqlServer.EntityFramework.Tests/EntityFrameworkDatabaseInitializerExtensionsTest.cs
@@ -74,6 +74,28 @@ public void Test2()
             this.database.InsertInto("MyTable", new { Id = 99, Name = "Should not be here for the next test" });
         }
 
+        [Fact]
+        public void Initialize_WithInitializerArgumentNull()
+        {
+            var act = () =>
+            {
+                EntityFrameworkDatabaseInitializerExtensions.Initialize(null, default);
+            };
+
+            act.Should().ThrowExactly<ArgumentNullException>()
+               .WithParameterName("initializer");
+        }
+
+        [Fact]
+        public void Initialize_WithFileNameArgumentNull()
+        {
+            var initializer = new SqlServerDatabaseInitializer();
+
+            initializer.Invoking(i => i.Initialize(null))
+                .Should().ThrowExactly<ArgumentNullException>()
+                .WithParameterName("context");
+        }
+
         private sealed class DbContextTest : DbContext
         {
             public DbContextTest(DbContextOptions<DbContextTest> options)
diff --git a/tests/Testing.Databases.SqlServer.EntityFramework.Tests/EntityFrameworkSqlServerExtensionsTest.cs b/tests/Testing.Databases.SqlServer.EntityFramework.Tests/EntityFrameworkSqlServerExtensionsTest.cs
diff --git a/tests/Testing.Databases.SqlServer.SqlCmd.Tests/SqlCmdDatabaseInitializerTest.cs b/tests/Testing.Databases.SqlServer.SqlCmd.Tests/SqlCmdDatabaseInitializerTest.cs
