How to measure Code Coverage in ASP.NET Core proje

Question

I want to measure the Code Coverage of my XUnit-Tests in an ASP.NET Core application. The Tooling for .NET Core in Visual Studio 2015 is preview 2 and code coverage does not work so far.

The blog post http://dotnetthoughts.net/measuring-code-coverage-of-aspnet-core-applications-using-opencover/ from February shows a workaround by using the command line of open cover. I am looking for a more integrated way inside of Visual Studio.

Has anybody heard of a better / more integrated way of measuring Code Coverage in combination with XUnit ?

Answer 1

Coverlet (https://github.com/tonerdo/coverlet) is a new project that has recently emerged. It works alongside msbuild and gives a straight forward solution for coverage

Answer 2

The codecoverage works for me, for .Net Core using Microsoft.CodeCoverage as mentioned above.

Check you have Microsoft.CodeCoverage nuget added to your test project

Also check the project.json file on you main project, the debugType attribute should be "full" instead of "portable"

  "buildOptions": {
    "emitEntryPoint": true,
    "preserveCompilationContext": true,
    "debugType": "full"
  },

This fixed for me

Answer 3

I have just tried the ReSharper version 2016.3 EAP 4 (Early access preview). Besides unit test execution now dotCover returns code coverage information for my .net core test projects.

Answer 4

OpenCover+ReportGenerator. Install as NUGET packages to one of your test projects (once, because they just need to appear in package folder).

Then you can put this powershel https://github.com/rpokrovskij/opencover4vs.ps1 to your solution folder, and setup it with your Test projects using path globing e.g.

$TestProjectsGlobbing = @(,'*.Test.csproj')

Then you can run it as a regular Powershel script. Result should appear in Solution Folder in \TestsResults\report\index.html

Answer 5

Add the NuGet package Microsoft.CodeCoverage 1.0.1 to your project.json.

I am working on Template for Asp.NET and right now I am working on Unit Tests so I saw your post. You could see project/configuration here.

Answer 6

Disclaimer: These steps were given from Measuring ASP.NET Core Coverage with OpenCover - DotNetThoughts.

Even though the poster says about this site, I thought it would still be best to have these steps here for prosperity.

NOTE: These instructions while tailored to a windows operating system, should easily work for any O/S supported by OpenCover and ReportGenerator.

1. Create your ASP.NET Core MVC Website
2. Ensure global.json has "test" in projects
3. Right click test folder in solution and add a new project
4. Make sure the project type is an .NET Core Class library
5. Add the following to your project.json dependencies node:
   • "dotnet-test-xunit": "2.2.0-preview2-build1029",
   • "xunit": "2.2.0-beta3-build3402"
   • "Microsoft.CodeCoverage": "1.0.2"
6. Add the following to your project.json under version
   • "testRunner": "xunit",
7. Write your unit tests
8. Download OpenCover and Report Generator
9. Install OpenCover
10. Extract Report Generator into OpenCover install dir in folder called Report Generator
11. Create a BAT file in your project and call it cover.bat
12. Add the following contents:

@echo off

SET dotnet="C:\Program Files\dotnet\dotnet.exe"  
SET opencover="C:\Program Files (x86)\OpenCover\OpenCover.Console.exe"
SET reportgenerator="C:\Program Files (x86)\OpenCover\ReportGenerator\ReportGenerator.exe"

SET targetargs="test"  
SET filter="+[*]NAMESPACE.* -[*.Test]* -[xunit.*]* -[FluentValidation]*"  
SET coveragefile=Coverage.xml  
SET coveragedir=Coverage

REM Run code coverage analysis  
%opencover% -oldStyle -register:user -target:%dotnet% -output:%coveragefile% -targetargs:%targetargs% -filter:%filter% -skipautoprops -hideskipped:All

REM Generate the report  
%reportgenerator% -targetdir:%coveragedir% -reporttypes:Html;Badges -reports:%coveragefile% -verbosity:Error

REM Open the report  
start "report" "%coveragedir%\index.htm"

13. Replace the NAMESPACE with your projects namespace.
14. If more than one project, duplicate the regex +[*]NAMESPACE.* as many times as needed for each namespace
15. Save the file
16. Open a command prompt and ensure in your test project
17. Type cover to get your unit tests running and your coverage results in HTML format, or whatever you named your bat file in step 11.