Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/jke94/netcorecoverage

A .NET 5 solution example, to get metric coverage from the different project of the solution.
https://github.com/jke94/netcorecoverage

coverage coverlet csharp net5 reportgenerator

Last synced: about 1 month ago
JSON representation

A .NET 5 solution example, to get metric coverage from the different project of the solution.

Host: GitHub
URL: https://github.com/jke94/netcorecoverage
Owner: jke94
License: mit
Created: 2021-05-08T15:07:50.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2022-04-05T08:07:00.000Z (over 2 years ago)
Last Synced: 2023-03-08T18:18:46.786Z (almost 2 years ago)
Topics: coverage, coverlet, csharp, net5, reportgenerator
Language: C#
Homepage: https://jke94.medium.com/code-coverage-in-net-core-840bcd96b1e9
Size: 212 KB
Stars: 0
Watchers: 1
Forks: 3
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Code coverage in .NET 5 (C#)
A .NET 5 solution example, to get metric coverage from the differents projects of the solution.
# Medium Post
[Code coverage in .NET 5 (C#)](https://jke94.medium.com/code-coverage-in-net-core-840bcd96b1e9)

## Description

In this project has been used the following tools and NuGet Packages to extract the metric solutions:

- [Coverlet](https://github.com/coverlet-coverage/coverlet)
- [NUnit](https://github.com/nunit/nunit)
- [ReportGenerator](https://github.com/danielpalme/ReportGenerator)

## Getting Started

### Dependencies or tool necessaries

* Visual Studio Community 2019
* .NET 5.0

### Installing

* Clone project.
* Open NetCoreCoverage.sln

### Steps (using dotnet command)

#### 1. Build the solution in release target (from the base repository folder).

```
>dotnet build NetCoreCoverage.sln --configuration Release
```

#### 2. Run the unit tests from the solution in relase target (from the base repository folder) and generate results. This command will displayed in the command line the results of the coverage, and futhermore, this command will generate a file (.\TestResults\coverage.cobertura.xml)

```
>dotnet test NetCoreCoverage.sln --configuration Release /p:CollectCoverage=true /p:CoverletOutputFormat=cobertura /p:Exclude="[xunit*]\*" /p:CoverletOutput="../TestResults/"

```
![dotnet test](https://github.com/jke94/NetCoreCoverage/blob/dev/Images/dotnetTestsRun.PNG)

#### 3. Generate report coverage metrics in html format. This command consume the '.\TestResults\coverage.cobertura.xml' file and generate a output folder with a index.hmtl file to visualize the results in a browser.

```
>reportgenerator "-reports:TestResults\coverage.cobertura.xml" "-targetdir:TestResults\html" -reporttypes:Html
```
![reportgenerator](https://github.com/jke94/NetCoreCoverage/blob/dev/Images/ReportGeneratorToolGenerateReport.PNG)

#### 4. Visualize the results with in the browser.
![reportgenerator](https://github.com/jke94/NetCoreCoverage/blob/dev/Images/ExampleOfReports.PNG)

## Help

Any advice for common problems or issues.

## Authors

Javier Carracedo

Twitter Profile: [@JaviKarra94](https://twitter.com/JaviKarra94)

## Version History

## License

This project is licensed under the [Mit License](https://github.com/jke94/NetCoreCoverage/blob/dev/LICENSE), see the LICENSE.md file for details.