Coverlet extensions for Cake Build
Get Started
$ dotnet add package Cake.CoverletReadme
Cake.Coverlet
Usage
In order to use the addin please make sure you've included Coverlet in the project you wish to cover and add the following to your cake build file
#addin nuget:?package=Cake.Coverlet
You can also install coverlet as a global tool on your machine or with the Cake.DotNetTool.Module and run the command separately from MSBuild.
Note: Works with Coverlet 2.1.1 and up
Then use one of the following snippets
Task("Test")
.IsDependentOn("Build")
.Does<MyBuildData>((data) =>
{
var testSettings = new DotNetTestSettings {
};
var coverletSettings = new CoverletSettings {
CollectCoverage = true,
CoverletOutputFormat = CoverletOutputFormat.opencover,
CoverletOutputDirectory = Directory(@".\coverage-results\"),
CoverletOutputName = $"results-{DateTime.UtcNow:dd-MM-yyyy-HH-mm-ss-FFF}"
};
DotNetTest("./test/My.Project.Tests/My.Project.Tests.csproj", testSetting, coverletSettings);
}
Or for when installed as a tool:
Task("Test")
.IsDependentOn("Build")
.Does<MyBuildData>((data) =>
{
var coverletSettings = new CoverletSettings {
CollectCoverage = true,
CoverletOutputFormat = CoverletOutputFormat.opencover,
CoverletOutputDirectory = Directory(@".\coverage-results\"),
CoverletOutputName = $"results-{DateTime.UtcNow:dd-MM-yyyy-HH-mm-ss-FFF}"
};
// I want to specify the specific dll file and the project exactly.
Coverlet(
"./test/My.Project.Tests/bin/Debug/net46/My.Project.Tests.dll",
"./test/My.Project.Tests/My.Project.Tests.csproj",
coverletSettings);
// I want to specify just the project file and the dll can be
// inferred from the name of the project file.
Coverlet(
"./test/My.Project.Tests/My.Project.Tests.csproj",
coverletSettings);
// I want to specify just the project directory, we will discover
// any proj file in the directory (take the first) and infer the
// name from the found project.
Coverlet(
"./test/My.Project.Tests",
coverletSettings);
}