https://github.com/forevolve/forevolve.testing
Testing utilities for .Net Core and Asp.Net Core
https://github.com/forevolve/forevolve.testing
Last synced: 10 months ago
JSON representation
Testing utilities for .Net Core and Asp.Net Core
- Host: GitHub
- URL: https://github.com/forevolve/forevolve.testing
- Owner: ForEvolve
- License: mit
- Created: 2019-02-25T03:35:04.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-20T14:03:22.000Z (over 3 years ago)
- Last Synced: 2025-07-12T21:32:21.225Z (11 months ago)
- Language: C#
- Size: 69.3 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ForEvolve.Testing
[](https://f.feedz.io/forevolve/testing/packages/ForEvolve.Testing/latest/download)
[](https://www.nuget.org/packages/ForEvolve.Testing/)
There is always something unexpected that happens or something that requires a complex mock setup or whatnot when testing web applications. This project aim at regrouping as many of those solutions as possible, ready to use, as well as multiple small utilities.
If your specific use-case is not covered, you can open an issue then even contribute it.
## Versioning
The packages follows _semantic versioning_ and uses [Nerdbank.GitVersioning](https://github.com/dotnet/Nerdbank.GitVersioning) under the hood to automate versioning based on Git commits.
## Hot to use
### NuGet
All packages are available on [https://www.nuget.org/profiles/ForEvolve](https://www.nuget.org/profiles/ForEvolve).
To load all testing packages, reference the `ForEvolve.Testing` package:
```PowerShell
Install-Package ForEvolve.Testing
```
or
```PowerShell
dotnet add package ForEvolve.Testing
```
#### Individual packages (App)
To load individual packages, you can:
```PowerShell
Install-Package ForEvolve.Testing.Core
Install-Package ForEvolve.Testing.AspNetCore
```
or
```PowerShell
dotnet add package ForEvolve.Testing.Core
dotnet add package ForEvolve.Testing.AspNetCore
```
### Prerelease packages
For the pre-release packages, use the ForEvolve/Testing [feedz.io](https://f.feedz.io/forevolve/testing/nuget/index.json) packages source.
## Content
The repository is divided into multiple projects, with `ForEvolve.Testing` that references the others.
### ForEvolve.Testing
This project load all of the other projects to create "a NuGet package to rule them all"!
### ForEvolve.Testing.Core
This project contains multiple test helpers.
#### General assertion extensions
- An extension on `KeyValuePair` to `keyValue.AssertEqual("some key", "some object")` that assert the equalities.
- An extension on `Stream` to `stream.ShouldEqual("some string")` that read the `Stream` then `Assert.Equal` its value against the specified `expectedResult`.
-
#### `IServiceCollection` extensions
- `services.AddSingletonMock()` or `services.AddSingletonMock(mock => { /*some setup code*/ })` that add a mock with a singleton lifetime to the `IServiceCollection`.
- `services.AddScopedMock()` or `services.AddScopedMock(mock => { /*some setup code*/ })` that add a mock with a scoped lifetime to the `IServiceCollection`.
- `services.AddTransientMock()` or `services.AddTransientMock(mock => { /*some setup code*/ })` that add a mock with a transient lifetime to the `IServiceCollection`.
#### `IServiceProvider` assertion extensions
- `serviceProvider.AssertServiceExists()` that `GetRequiredService()`, throwing an exception if the dependency does not exist.
- `serviceProvider.AssertServiceImplementationExists()` that `GetRequiredService()`, throwing an exception if the dependency does not exist, then validate that its implementation is of type `TImplementation`.
- `serviceProvider.AssertServicesImplementationExists()` that `GetServices()`, make sure there is at least one implementation of type `TImplementation`. Throw a `TrueException` when no binding are of type `TImplementation`.
- Multiple other useful method to test the content of the `IServiceCollection` to ensure that dependencies are registered against the DI Container, under the expected scope. Moreover, those methods are chainable. For example, we could:
```csharp
services
.AssertSingletonServiceExists()
.AssertSingletonServiceImplementationExists()
.AssertScopedServiceExists()
;
```
### ForEvolve.Testing.AspNetCore
This project contains some Asp.Net Core test utilities like:
- `IdentityHelper` that creates the plumbing to mock `SignInManager` and `UserManager`. Multiple authentication scenarios are supported.
- `HttpContextHelper` that creates the plumbing to mock `HttpContext`, `HttpRequest`, and `HttpResponse`.
- `MvcContextHelper` at creates the plumbing to mock `IUrlHelper` and `ActionContext`; including support for `RouteData`, `ActionDescriptor`, and `ModelStateDictionary`.
- An extension method on `HttpResponse` to `httpResponse.BodyShouldEqual("Some value")`
- An extension on `WebApplicationFactory` to `webApplicationFactory.FindServiceCollection()` that returns the current `IServiceCollection` from the specified `WebApplicationFactory`; this is useful to assert service registration.
- An extension on `IServiceCollection` to `services.RemoveFilter()` that remove the specified filter from `MvcOptions`. The method rely on `PostConfigure(...)`.
## History
I started this project to share test utilities between projects and it now includes multiple testing utilities for .Net Core and Asp.Net Core.
The initial code comes from the `ForEvolve.XUnit` project, see [ForEvolve-Framework](https://github.com/ForEvolve/ForEvolve-Framework).
## The future
There is a lot of stuff that I want to improve or add to this library in the future, I will do when I have the time to.
## How to contribute?
If you would like to contribute to the project, first, thank you for your interest and please read [Contributing to ForEvolve open source projects](https://github.com/ForEvolve/ForEvolve-Framework/tree/master/CONTRIBUTING.md) for more information.
### Contributor Covenant Code of Conduct
Also, please read the [Contributor Covenant Code of Conduct](https://github.com/ForEvolve/ForEvolve-Framework/tree/master/CODE_OF_CONDUCT.md) that applies to all ForEvolve repositories.