-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
f25295a
commit f0446a6
Showing
2 changed files
with
55 additions
and
53 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,100 +1,102 @@ | ||
| # PosInformatique.UnitTests.Databases | ||
| PosInformatique.UnitTests.Databases is a set of tools for unit testing databases. | ||
| It simplifies writing and executing tests, helping ensure your database and data access code is reliable and bug-free. | ||
| Ideal for developers who want to validate data access based on SQL Server code during their development. | ||
|
|
||
| This set of tools support to perform unit tests of the data access layer based on SQL Server. Any kind of the | ||
| data access framework can be used with theses tools: | ||
| **PosInformatique.UnitTests.Databases** is a set of tools for unit testing databases. | ||
| It simplifies writing and executing tests, helping ensure your database and data access code are reliable and bug-free. | ||
| It is ideal for developers who want to validate data access based on SQL Server code during their development. | ||
|
|
||
| This set of tools supports unit testing of the data access layer based on SQL Server. | ||
| Any kind of data access framework can be used with these tools: | ||
| - Raw ADO .NET queries. | ||
| - Entity Framework | ||
| - Dapper | ||
| - Entity Framework. | ||
| - Dapper. | ||
| - ... | ||
|
|
||
| ## The approach of this tools | ||
| ## The approach of these tools | ||
|
|
||
| The main approach of these tools is to perform unit tests without using mocking or in-memory alternatives for ADO .NET code or Entity Framework `DbContext`, instead using a real SQL Server database. | ||
|
|
||
| The main approach of this tools is to perform unit tests without using mocking or in-memory the ADO .NET code or Entity Framework `DbContext` and using a real SQL Server database. | ||
| ### Why is this approach recommended? | ||
|
|
||
| Why this approach is recommanded? | ||
| - Around 30% / 40% of the code is the applications is located in the Data Access layer / repositories components. Because it is hard to unit tests, developers do not perform unit tests | ||
| and 30% / 40% of code coverage. | ||
| - When using a mock or in-memory approach of a `DbContext` you don't really test the Entity Framework mapping to your database and specially additional SQL constraints like nullability, unicity, foreign key cascade,... And | ||
| also all technical behavior like transactions, opening/closing connections,... | ||
| - When inserting data, we want to be sure that the data in the columns are stored correctly (null / not null values, enum values to numerical values, customer or JSON serialized data,...) | ||
| - If you use Entity Framework, you can detect warnings / errors raised by the `DbContext` (and not in the logs when deploying the application). | ||
| - You perform unit tests cases, it is mean you write simple tests to test small feature instead to write a complex integration test. | ||
| - Around 30% to 40% of the code in applications is located in the Data Access layer or repository components. Because it is hard to unit test, developers often skip testing, | ||
| - resulting in lower code coverage (30%-40%). | ||
| - When using a mock or in-memory approach for a `DbContext`, you don't truly test the Entity Framework mapping to your database, especially additional SQL constraints like nullability, uniqueness, foreign key cascades, etc. | ||
| - You also miss technical behaviors like transactions, connection management, etc. | ||
| - When inserting data, it is crucial to ensure that the data in the columns are stored correctly (null/not null values, enum values to numerical values, custom or JSON serialized data, etc.). | ||
| - If you use Entity Framework, you can detect warnings/errors raised by the `DbContext` that might not appear in logs when deploying the application. | ||
| - You perform unit test cases, meaning you write simple tests to validate small features instead of writing complex integration tests. | ||
|
|
||
| ## How to unit tests a Data Access Layer. | ||
| ## How to unit test a Data Access Layer | ||
|
|
||
| To perform unit tests of a Data Access Layer the approach is easily using the Arrange / Act / Assert pattern: | ||
| To perform unit tests of a Data Access Layer, the approach is straightforward using the Arrange/Act/Assert pattern: | ||
|
|
||
| Before each unit test (`TestMethod` or `Fact` methods): | ||
|
|
||
| Before each units (`TestMethod` or `Fact` methods): | ||
| 1. Create an empty database with the SQL schema of the application. | ||
|
|
||
| There is two ways to do it: | ||
| - Deploying a DACPAC file (built by an SQL Server Database project). | ||
| - Or executing creating a database from a `DbContext` using Entity Framework. | ||
| There are two ways to do this: | ||
| - Deploy a DACPAC file (built by a SQL Server Database project). | ||
| - Or create a database from a `DbContext` using Entity Framework. | ||
|
|
||
| 1. Fill the tables with sample of data that we need. | ||
| 2. Fill the tables with the sample data needed. | ||
|
|
||
| 1. Executing the code (the method of the repository to test). | ||
| 3. Execute the code (the method of the repository to be tested). | ||
|
|
||
| 1. Assert the results of the code executed. | ||
| 4. Assert the results of the executed code. | ||
|
|
||
| If the method tested returns data (perform a SELECT query), we assert the objects returned with your favorite assert framework (FluentAssertions for example). | ||
| If the method insert, update or delete data, we assert the content of the tables to check that all the data is stored correctly. | ||
| - If the tested method returns data (performs a SELECT query), assert the returned objects using your favorite assertion framework (e.g., FluentAssertions). | ||
| - If the method inserts, updates, or deletes data, assert the content of the tables to check that all data is stored correctly. | ||
|
|
||
| To write an unit test using this approach with the [PosInformatique.UnitTests.Databases](https://github.com/PosInformatique/PosInformatique.UnitTests.Databases) tools | ||
| see the [Write unit tests to test the Data Access Layer](./docs/WriteUnitTests.md) page. | ||
| To write a unit test using this approach with the [PosInformatique.UnitTests.Databases](https://github.com/PosInformatique/PosInformatique.UnitTests.Databases) tools, see the [Write unit tests to test the Data Access Layer](./docs/WriteUnitTests.md) page. | ||
|
|
||
| ## What provides the PosInformatique.UnitTests.Databases tools? | ||
| ## What do the PosInformatique.UnitTests.Databases tools provide? | ||
|
|
||
| Using the previous approach, the [PosInformatique.UnitTests.Databases](https://github.com/PosInformatique/PosInformatique.UnitTests.Databases) libraries allows to: | ||
| Using the previous approach, the [PosInformatique.UnitTests.Databases](https://github.com/PosInformatique/PosInformatique.UnitTests.Databases) libraries allow you to: | ||
|
|
||
| - Deploy easily a database before each unit tests execution. | ||
| Database and the schema creation is an operation that can take lot of time (around 5 to 10 seconds), the [PosInformatique.UnitTests.Databases](https://github.com/PosInformatique/PosInformatique.UnitTests.Databases) libraries | ||
| create physically the database at the first unit test execution. For the other unit tests execution, all the data are deleted in the database which allows to increase the speed of the unit tests execution. | ||
| - Easily deploy a database before each unit test execution. | ||
| Database and schema creation can take a lot of time (around 5 to 10 seconds). The [PosInformatique.UnitTests.Databases](https://github.com/PosInformatique/PosInformatique.UnitTests.Databases) libraries physically create the database during the first unit test execution. For subsequent tests, all data is deleted in the database, which speeds up the unit test execution. | ||
|
|
||
| - Provides a simple syntax to fill the tables with sample of data. | ||
| - Provide a simple syntax to fill the tables with sample data. | ||
|
|
||
| - Provides helpers to query and retrieve easily data in SQL tables (to perform assertions). | ||
| - Offer helpers to easily query and retrieve data from SQL tables (for assertions). | ||
|
|
||
| ## NuGet packages | ||
|
|
||
| The [PosInformatique.UnitTests.Databases](https://github.com/PosInformatique/PosInformatique.UnitTests.Databases) are provided into two NuGet packages: | ||
| The [PosInformatique.UnitTests.Databases](https://github.com/PosInformatique/PosInformatique.UnitTests.Databases) tools are provided in two NuGet packages: | ||
|
|
||
| - [](https://www.nuget.org/packages/PosInformatique.UnitTests.Databases.SqlServer) which contains: | ||
| - Tools to deploy a SQL Server database using a DACPAC file before each unit tests. | ||
| - Helper to initialize the SQL Server databases with sample data. | ||
| - Helper to query easily SQL Server databases. | ||
| - Tools to deploy a SQL Server database using a DACPAC file before each unit test. | ||
| - Helpers to initialize SQL Server databases with sample data. | ||
| - Helpers to easily query SQL Server databases. | ||
|
|
||
| - [](https://www.nuget.org/packages/PosInformatique.UnitTests.Databases.SqlServer.EntityFramework) which contains: | ||
| - Tools to deploy a SQL Server database using a DbContext. | ||
|
|
||
| This package use and contains the previous [PosInformatique.UnitTests.Databases.SqlServer](https://www.nuget.org/packages/PosInformatique.UnitTests.Databases.SqlServer) NuGet package. | ||
| This package uses and includes the previous [PosInformatique.UnitTests.Databases.SqlServer](https://www.nuget.org/packages/PosInformatique.UnitTests.Databases.SqlServer) NuGet package. | ||
|
|
||
| ## Samples / Demo | ||
|
|
||
| A complete sample solution is available in this repository in the [./samples](./samples) folder. | ||
|
|
||
| The solution contains the following projects: | ||
| - [DemoApp.Domain](./samples/DemoApp.Domain/DemoApp.Domain.csproj): Represents the domain of the application with a set of sample business entities. | ||
| - [DemoApp.DataAccessLayer](./samples/DemoApp.DataAccessLayer/DemoApp.DataAccessLayer.csproj): Represents a Data Access Layer with a set of repository to unit tests. | ||
| - [DemoApp.DataAccessLayer.Tests](./samples/DemoApp.DataAccessLayer.Tests/DemoApp.DataAccessLayer.Tests.csproj): Unit tests projects to test the [DemoApp.DataAccessLayer](./samples/DemoApp.DataAccessLayer/DemoApp.DataAccessLayer.csproj) | ||
| project using the [PosInformatique.UnitTests.Databases.SqlServer](https://www.nuget.org/packages/PosInformatique.UnitTests.Databases.SqlServer) package. | ||
| - [DemoApp.DataAccessLayer](./samples/DemoApp.DataAccessLayer/DemoApp.DataAccessLayer.csproj): Represents a Data Access Layer with a set of repositories to unit test. | ||
| - [DemoApp.DataAccessLayer.Tests](./samples/DemoApp.DataAccessLayer.Tests/DemoApp.DataAccessLayer.Tests.csproj): Unit test project to test the [DemoApp.DataAccessLayer](./samples/DemoApp.DataAccessLayer/DemoApp.DataAccessLayer.csproj) | ||
| - project using the [PosInformatique.UnitTests.Databases.SqlServer](https://www.nuget.org/packages/PosInformatique.UnitTests.Databases.SqlServer) package. | ||
|
|
||
| ## Write unit tests to test a Data Access Layer. | ||
| ## Writing unit tests for a Data Access Layer | ||
|
|
||
| To write unit tests for a Data Access Layer follows [Write unit tests to test the Data Access Layer](./docs/WriteUnitTests.md) documentation page, which explain the different steps to perform | ||
| To write unit tests for a Data Access Layer, follow the [Write unit tests to test the Data Access Layer](./docs/WriteUnitTests.md) documentation page, which explains the different steps to perform | ||
| using the [PosInformatique.UnitTests.Databases.SqlServer.EntityFramework](https://www.nuget.org/packages/PosInformatique.UnitTests.Databases.SqlServer.EntityFramework) library: | ||
|
|
||
| - [Create the SQL Server instance](./docs/WriteUnitTests.md#create-the-sql-server-instance) | ||
| - [Create the LocalDB instance](./docs/WriteUnitTests.md#create-the-localdb-instance) | ||
| - [Create an unit tests project](./docs/WriteUnitTests.md#create-the-unit-tests-project) | ||
| - [Create the unit tests project](./docs/WriteUnitTests.md#create-the-unit-tests-project) | ||
| - [Add the NuGet packages](./docs/WriteUnitTests.md#add-the-nuget-packages) | ||
| - [Unit test class](./docs/WriteUnitTests.md#unit-test-class) | ||
| - [Deploy a new instance of the database from a DbContext](./docs/WriteUnitTests.md#deploy-a-new-instance-of-the-database-from-a-dbcontext) | ||
| - [Parallelism execution of the unit tests](./docs/WriteUnitTests.md#parallelism-execution-of-the-unit-tests) | ||
| - [Initializes the data of the database](./docs/WriteUnitTests.md#initializes-the-data-of-the-database) | ||
| - [Parallel execution of the unit tests](./docs/WriteUnitTests.md#parallel-execution-of-the-unit-tests) | ||
| - [Initialize the database data](./docs/WriteUnitTests.md#initializes-the-data-of-the-database) | ||
| - [Write the unit tests for methods that retrieve data](./docs/WriteUnitTests.md#write-the-unit-tests-for-methods-that-retrieve-data) | ||
| - [Write the unit tests for methods that update the data](./docs/WriteUnitTests.md#write-the-unit-tests-for-methods-that-update-the-data) | ||
| - [Execute the unit tests](./docs/WriteUnitTests.md#execute-the-unit-tests) | ||
| - [Check the database state after an unit test has been failed](./docs/WriteUnitTests.md#check-the-database-state-after-an-unit-test-has-been-failed) | ||
| - [Check the database state after a unit test has failed](./docs/WriteUnitTests.md#check-the-database-state-after-an-unit-test-has-been-failed) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters