https://github.com/jacobjmarks/dotnet-integration-testing
.NET Integration Testing
https://github.com/jacobjmarks/dotnet-integration-testing
Last synced: 12 months ago
JSON representation
.NET Integration Testing
- Host: GitHub
- URL: https://github.com/jacobjmarks/dotnet-integration-testing
- Owner: jacobjmarks
- Created: 2024-02-11T22:52:59.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-12T22:24:14.000Z (about 2 years ago)
- Last Synced: 2025-01-15T23:42:40.189Z (about 1 year ago)
- Language: C#
- Homepage:
- Size: 124 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# .NET Integration Testing
This repository houses a collection of reference solutions with the intent of demonstrating how to author integration tests against a .NET HTTP API which may utilise a range of external dependencies.
Each reference provides an example of how to manage a particular external dependency during integration testing — discussing recommendations and considerations — in .NET SDKs 6, 7 and 8 where applicable.
## Philosophy
### Black-box
Tests should be largely [black-box](https://en.wikipedia.org/wiki/Black-box_testing) in nature, and aim to push the boundaries of that box as far as possible. There should be as little mocking, stubbing and faking as possible (with the exception of external dependencies) to test the system under test in a production-like state.
### Idempotent
Tests should not produce any internal or external side-effects, and should reliably produce the same result when executed against an unmodified system under test.
### Isolated
Tests should be able to be run in parallel with no fear of state contamination. They should not utilise any resources they did not create, and should suitably cleanup any resources which they did.
### Effortless
Developers should have no trouble authoring, configuring and running the entirety of the test suite. There should be little to no prerequisite developer dependencies — other than a suitable .NET SDK — and the test suite should be able to be easily run in a CI/CD environment.
## Approach
### `WebApplicationFactory`
Solutions follow guidance as documented in [Integration tests in ASP.NET Core | Microsoft Learn](https://learn.microsoft.com/en-au/aspnet/core/test/integration-tests). In particular, the utilisation of a custom `WebApplicationFactory` to suitably bootstrap the system under test for integration testing. You'll find the following base utilised throughout all reference solutions:
``` csharp
public class CustomWebApplicationFactory : WebApplicationFactory
{
protected override IHost CreateHost(IHostBuilder builder)
{
// set your required application configuration
builder.ConfigureHostConfiguration(configurationBuilder =>
{
// ...
});
return base.CreateHost(builder);
}
protected override void ConfigureWebHost(IWebHostBuilder builder)
{
// configure your test services
builder.ConfigureTestServices(services =>
{
// ...
});
}
}
```
> Note that `ConfigureHostConfiguration()` is utilised to set application configuration — instead of `ConfigureAppConfiguration()` — as to make this desired configuration visible during application startup. See [dotnet/aspnetcore #37680](https://github.com/dotnet/aspnetcore/issues/37680) and [this comment](https://github.com/dotnet/aspnetcore/issues/37680#issuecomment-1032922656).
## Common Libraries
All solutions utilise the following libraries:
| Library | Concern | Alternatives |
| ------------------------------------------------------------------------ | ------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| [xUnit](https://github.com/xunit/xunit) | Test framework | [NUnit](https://github.com/nunit/nunit), [MSTest](https://github.com/microsoft/testfx) |
| [Moq](https://github.com/moq/moq) | Mocking | [NSubstitute](https://github.com/nsubstitute/nsubstitute), [FakeItEasy](https://github.com/FakeItEasy/FakeItEasy) |
| [FluentAssertions](https://github.com/fluentassertions/fluentassertions) | Semantic assertion syntax | [Shouldy](https://github.com/shouldly/shouldly) |
| [Snapshooter](https://github.com/SwissLife-OSS/snapshooter) | Snapshot assertions | [Verify](https://github.com/VerifyTests/Verify) |
## Solutions
### [Reference A - No external dependencies](<./Reference A - No external dependencies>)
Integration testing a .NET HTTP API which does not utilise any external dependencies.
This project can be considered a base template for all other reference solutions.
### [Reference B - Entity Framework Core](<./Reference B - Entity Framework Core>)
Integration testing a .NET HTTP API which utilises Entity Framework Core.
### [Reference C - External HTTP API](<./Reference C - External HTTP API>)
Integration testing a .NET HTTP API which utilises an external/third-party HTTP API.