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.CoverletNote: 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 DotNetCoreTestSettings {
};
var coveletSettings = new CoverletSettings {
CollectCoverage = true,
CoverletOutputFormat = CoverletOutputFormat.opencover,
CoverletOutputDirectory = Directory(@".\coverage-results\"),
CoverletOutputName = $"results-{DateTime.UtcNow:dd-MM-yyyy-HH-mm-ss-FFF}"
};
DotNetCoreTest("./test/Stubble.Core.Tests/Stubble.Core.Tests.csproj", testSetting, coveletSettings);
}There is an additional api exposed for transforming the output name of the coverage file at the time of calling dotnet test.
This transform function follows the form Func<string, string> being passed the CoverletOutputName and the return is used for the filename.
Task("Test")
.IsDependentOn("Build")
.Does<MyBuildData>((data) =>
{
var testSettings = new DotNetCoreTestSettings {
};
var coveletSettings = new CoverletSettings {
CollectCoverage = true,
CoverletOutputFormat = CoverletOutputFormat.opencover,
CoverletOutputDirectory = Directory(@".\coverage-results\"),
CoverletOutputName = $"results"
OutputNameTransformer = (fileName, directory) => $@"{directory}\{fileName}-HelloWorld"
};
DotNetCoreTest("./test/Stubble.Core.Tests/Stubble.Core.Tests.csproj", testSetting, coveletSettings);
}We expose a default transformer for the standard practice of appending the current datetime to the file as WithDateTimeTransformer()
If you wish to only change the directory that the output is written to then set the CoverletOutputDirectory and the filename handling will be done by coverlet as usual.