https://github.com/romanx/cake.coverlet

Coverlet extensions for Cake Build
https://github.com/romanx/cake.coverlet

build cake coverage coverlet script

Last synced: 23 days ago
JSON representation

Coverlet extensions for Cake Build

• Host: GitHub
• URL: https://github.com/romanx/cake.coverlet
• Owner: Romanx
• License: mit
• Created: 2018-06-27T19:33:03.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-03-09T15:51:49.000Z (10 months ago)
• Last Synced: 2024-11-12T23:51:31.986Z (about 1 month ago)
• Topics: build, cake, coverage, coverlet, script
• Language: C#
• Size: 75.2 KB
• Stars: 40
• Watchers: 4
• Forks: 15
• Open Issues: 4
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# Cake.Coverlet

[![Build status](https://ci.appveyor.com/api/projects/status/pr3lyh3baynax8gx/branch/master?svg=true)](https://ci.appveyor.com/project/Romanx/cake-coverlet/branch/master)

[![NuGet version](https://img.shields.io/nuget/v/Cake.Coverlet.svg)](https://www.nuget.org/packages/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

```csharp

#addin nuget:?package=Cake.Coverlet

```

You can also install coverlet as a global tool on your machine or with the [Cake.DotNetTool.Module](https://github.com/cake-contrib/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

```csharp

Task("Test")

    .IsDependentOn("Build")

    .Does((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:

```csharp

Task("Test")

    .IsDependentOn("Build")

    .Does((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);

}

```

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` being passed the `CoverletOutputName` and the return is used for the filename.

```csharp

Task("Test")

    .IsDependentOn("Build")

    .Does((data) =>

{

    var testSettings = new DotNetTestSettings {

    };

    var coverletSettings = new CoverletSettings {

        CollectCoverage = true,

        CoverletOutputFormat = CoverletOutputFormat.opencover,

        CoverletOutputDirectory = Directory(@".\coverage-results\"),

        CoverletOutputName = $"results"

        OutputNameTransformer = (fileName, directory) => $@"{directory}\{fileName}-HelloWorld"

    };

    DotNetTest("./test/Stubble.Core.Tests/Stubble.Core.Tests.csproj", testSetting, coverletSettings);

}

```

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.

## Setting more than one output format

You can support multiple coverlet formats by providing them like this:

```csharp

var coverletSettings = new CoverletSettings {

        CollectCoverage = true,

        CoverletOutputFormat = CoverletOutputFormat.opencover | CoverletOutputFormat.cobertura,

        CoverletOutputDirectory = Directory(@".\coverage-results\"),

        CoverletOutputName = $"results-{DateTime.UtcNow:dd-MM-yyyy-HH-mm-ss-FFF}"

    };

```

Or by using the method on the settings class like this:

```csharp

var coverletSettings = new CoverletSettings {

        CollectCoverage = true,

        CoverletOutputFormat = CoverletOutputFormat.opencover,

        CoverletOutputDirectory = Directory(@".\coverage-results\"),

        CoverletOutputName = $"results-{DateTime.UtcNow:dd-MM-yyyy-HH-mm-ss-FFF}"

    }.WithFormat(CoverletOutputFormat.cobertura);

```