Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/edumserrano/dotnet-sdk-extensions

This repo contains extensions to help build .NET applications, as well as extensions for unit and integration tests. It supports applications targeting .NET 6 and higher.
https://github.com/edumserrano/dotnet-sdk-extensions

asp core csharp dotnet extensions guides integration-testing mocking sdk-net test testing tests unit-testing web webapp

Last synced: about 15 hours ago
JSON representation

This repo contains extensions to help build .NET applications, as well as extensions for unit and integration tests. It supports applications targeting .NET 6 and higher.

Host: GitHub
URL: https://github.com/edumserrano/dotnet-sdk-extensions
Owner: edumserrano
License: mit
Created: 2020-04-25T15:23:15.000Z (over 4 years ago)
Default Branch: main
Last Pushed: 2024-04-20T13:50:14.000Z (9 months ago)
Last Synced: 2024-05-01T14:39:58.051Z (9 months ago)
Topics: asp, core, csharp, dotnet, extensions, guides, integration-testing, mocking, sdk-net, test, testing, tests, unit-testing, web, webapp
Language: C#
Homepage:
Size: 2.83 MB
Stars: 11
Watchers: 1
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

        # Extensions for .NET SDK

[![codecov](https://codecov.io/gh/edumserrano/dotnet-sdk-extensions/branch/main/graph/badge.svg?token=KYW77A6UV9)](https://codecov.io/gh/edumserrano/dotnet-sdk-extensions)

[![Build, test and package](https://github.com/edumserrano/dotnet-sdk-extensions/actions/workflows/build-test-package.yml/badge.svg)](https://github.com/edumserrano/dotnet-sdk-extensions/actions/workflows/build-test-package.yml)

[![Build Status](https://github.com/edumserrano/dotnet-sdk-extensions/actions/workflows/nuget-publish.yml/badge.svg)](https://github.com/edumserrano/dotnet-sdk-extensions/actions/workflows/nuget-publish.yml)

[![dotnet format](https://github.com/edumserrano/dotnet-sdk-extensions/actions/workflows/dotnet-format.yml/badge.svg)](https://github.com/edumserrano/dotnet-sdk-extensions/actions/workflows/dotnet-format.yml)

[![CodeQL](https://github.com/edumserrano/dotnet-sdk-extensions/actions/workflows/codeql.yml/badge.svg)](https://github.com/edumserrano/dotnet-sdk-extensions/actions/workflows/codeql.yml)

[![Markdown link check](https://github.com/edumserrano/dotnet-sdk-extensions/actions/workflows/markdown-link-check.yml/badge.svg)](https://github.com/edumserrano/dotnet-sdk-extensions/actions/workflows/markdown-link-check.yml)

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](./LICENSE)

[![GitHub Sponsors](https://img.shields.io/github/sponsors/edumserrano)](https://github.com/sponsors/edumserrano)

[![LinkedIn](https://img.shields.io/badge/LinkedIn-Eduardo%20Serrano-blue.svg)](https://www.linkedin.com/in/eduardomserrano/)

- [Description](#description)

- [Installing](#installing)

- [Extensions list](#extensions-list)

  - [For apps](#for-apps)

  - [For integration tests](#for-integration-tests)

  - [For unit tests](#for-unit-tests)

  - [Other](#other)

- [Debugging](#debugging)

- [Dev notes](#dev-notes)

## Description

This repo contains extensions to help build .NET applications, as well as extensions for unit and [integration tests](https://docs.microsoft.com/en-us/aspnet/core/test/integration-tests?#introduction-to-integration-tests). It supports applications targeting .NET 6.0 or higher.

## Installing

This repo provides two NuGet packages:

| NuGet                                                                                         |                                                                               Version                                                                                |                                Downloads                                |

| --------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------: |

| [dotnet-sdk-extensions](https://www.nuget.org/packages/dotnet-sdk-extensions)                 |             [![Nuget dotnet-sdk-extensions](https://img.shields.io/nuget/v/dotnet-sdk-extensions)](https://www.nuget.org/packages/dotnet-sdk-extensions)             |     ![Nuget](https://img.shields.io/nuget/dt/dotnet-sdk-extensions)     |

| [dotnet-sdk-extensions-testing](https://www.nuget.org/packages/dotnet-sdk-extensions-testing) | [![Nuget dotnet-sdk-extensions-testing](https://img.shields.io/nuget/v/dotnet-sdk-extensions-testing)](https://www.nuget.org/packages/dotnet-sdk-extensions-testing) | ![Nuget](https://img.shields.io/nuget/dt/dotnet-sdk-extensions-testing) |

Installation is performed via NuGet and you can do it using the following commands:

```

dotnet add package dotnet-sdk-extensions

dotnet add package dotnet-sdk-extensions-testing

```

## Extensions list

The extensions available are split into two groups:

* Extensions to use on app code.

* Extensions to use when doing integration and unit tests.

For more information about each extension check its docs. You can find the link to each extension's documentation below.

### For apps

* [Using `T` options classes instead of `IOptions`](/docs/configuration/options-without-IOptions.md)

* Extending [Polly](https://github.com/App-vNext/Polly)

  * [Circuit breaker checker policy](/docs/polly/circuit-breaker-checker-policy.md)

  * [Add a timeout policy to an HttpClient](/docs/polly/httpclient-with-timeout-policy.md)

  * [Add a retry policy to an HttpClient](/docs/polly/httpclient-with-retry-policy.md)

  * [Add a circuit breaker policy to an HttpClient](/docs/polly/httpclient-with-circuit-breaker-policy.md)

  * [Add a fallback policy to an HttpClient](/docs/polly/httpclient-with-fallback-policy.md)

  * [Add a set of resilience policies to an HttpClient](/docs/polly/httpclient-with-resilience-policies.md)

  * [Extending the policy options validation](/docs/polly/extending-policy-options-validation.md)

### For integration tests

* [Providing test appsettings files to the test server](/docs/integration-tests/configuring-webhost.md)

* [Override configuration values on the test server](/docs/integration-tests/override-configuration-value.md)

* [Disable logs when doing integration tests](/docs/integration-tests/disable-logs-integration-tests.md)

* [Mocking HttpClient's responses in-process](/docs/integration-tests/http-mocking-in-process.md)

* [Mocking HttpClient's responses out-of-process](/docs/integration-tests/http-mocking-out-of-process.md)

* [Integration tests for HostedServices (Background Services)](/docs/integration-tests/hosted-services.md)

### For unit tests

* [Mocking HttpClient's responses for unit testing](/docs/unit-tests/http-mocking-unit-tests.md)

### Other

* [Notes on WebApplicationFactory regarding asp.net integration tests](/docs/integration-tests/web-application-factory.md)

## Debugging

The NuGet packages published include symbols generated with [sourcelink](https://github.com/dotnet/sourcelink).

For more information on how to debug the NuGet packages code from your application see:

- [Exploring .NET Core's SourceLink - Stepping into the Source Code of NuGet packages you don't own](https://www.hanselman.com/blog/exploring-net-cores-sourcelink-stepping-into-the-source-code-of-nuget-packages-you-dont-own)

- [How to Configure Visual Studio to Use SourceLink to Step into NuGet Package Source](https://aaronstannard.com/visual-studio-sourcelink-setup/).

- [Source Link - microsoft docs](https://docs.microsoft.com/en-us/dotnet/standard/library-guidance/sourcelink)

## Dev notes

For notes aimed at developers working on this repo or just trying to understand it go [here](/docs/dev-notes/README.md). It will show you how to build and run the solution among other things.