https://github.com/appsynth-org/danger-kotlin-jacoco

Plugin for danger-kotlin that reads JaCoCo reports and posts summary as PR comments
https://github.com/appsynth-org/danger-kotlin-jacoco

danger danger-kotlin jacoco

Last synced: about 1 month ago
JSON representation

Plugin for danger-kotlin that reads JaCoCo reports and posts summary as PR comments

• Host: GitHub
• URL: https://github.com/appsynth-org/danger-kotlin-jacoco
• Owner: appsynth-org
• License: mit
• Created: 2022-04-29T05:18:00.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-08-09T05:14:08.000Z (over 2 years ago)
• Last Synced: 2024-08-03T14:07:45.111Z (5 months ago)
• Topics: danger, danger-kotlin, jacoco
• Language: Kotlin
• Homepage:
• Size: 101 KB
• Stars: 5
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-danger - danger-kotlin-jacoco - Process JaCoCo code coverage reports (Plugins / Kotlin (danger-kotlin))

README

        
# danger-kotlin JaCoCo plugin

![Maven Central](https://img.shields.io/maven-central/v/net.appsynth.danger/danger-kotlin-jacoco)

Plugin for [danger-kotlin](https://github.com/danger/kotlin) that can parse JaCoCo code coverage reports

and post results as PR comments.

## Usage

To use this plugin, first put

```kotlin

@file:DependsOn("net.appsynth.danger:danger-kotlin-jacoco:X.Y.Z")

```

and

```kotlin

register plugin JaCoCoPlugin

```

in your `Dangerfile.df.kts`.

After this, you can use `JaCoCoPlugin` class, which provides 2 main methods:

```kotlin

JaCoCoPlugin.parse(vararg reportFiles: File)

JaCoCoPlugin.report(filePaths: List)

```

Alternatively you can use `jacoco {}` to keep danger file more organized:

```kotlin

jacoco {

    parse(File("app/build/reports/jacoco/jacoco.xml"))

    report(git.modifiedFiles + git.createdFiles)

}

```

To produce coverage summary that would show coverage value changes, you can use

`JaCoCoPlugin.reference(vararg reportFiles: File)` method.

For additional control, there are some useful configuration options you can set:

```kotlin

jacoco {

    // exclude files matching any of listed regular expressions

    // if not set, the list is empty

    excludePatterns = listOf(

        Regex(".*Test\\.(kt|java)")

    )

    // to reduce the size of the summary, there is a limit of 20 reported files

    // you can override this value with below parameter

    maxReportedFiles = 10

    // files that don't have any entries in JaCoCo report, are marked as not covered

    // by default there will be a warning added about this

    // to turn it off, set as below

    noCoverageWarning = false

}

```

### Snapshot versions

To use snapshot versions of this plugin, just add repository annotation to your `Dangerfile.df.kts`.

```kotlin

@file:Repository("https://oss.sonatype.org/content/repositories/snapshots/")

```

## Examples

```kotlin

@file:DependsOn("net.appsynth.danger:danger-kotlin-jacoco:X.Y.Z")

import net.appsynth.danger.JaCoCoPlugin

import net.appsynth.danger.jacoco

import systems.danger.kotlin.*

import java.io.File

import kotlin.io.walk

register plugin JaCoCoPlugin

danger(args) {

    val changedFiles =  git.modifiedFiles + git.createdFiles

    jacoco {

        val coverageReports = File(".")

            .walk()

            .maxDepth(10)

            .filter { it.name == "jacoco.xml" }

            .toList()

        parse(*coverageReports.toTypedArray())

        report(changedFiles.filter { it.endsWith(".kt") || it.endsWith(".java") })

    }

}

```

This will try to find all jacoco.xml files by traversing directory structure up to 10 levels deep.

Then it will parse all found reports into internal format. At the end it will post summary for modified

or added Kotlin/Java source files as PR comment.

```kotlin

@file:DependsOn("net.appsynth.danger:danger-kotlin-jacoco:X.Y.Z")

import net.appsynth.danger.JaCoCoPlugin

import net.appsynth.danger.jacoco

import systems.danger.kotlin.*

import java.io.File

import kotlin.io.walk

register plugin JaCoCoPlugin

danger(args) {

    val changedFiles =  git.modifiedFiles + git.createdFiles

    jacoco {

        val coverageReports = File(".")

            .walk()

            .maxDepth(10)

            .filter {

                it.name == "jacoco.xml" && !it.path.contains("ref-report")

            }

            .toList()

        parse(*coverageReports.toTypedArray())

        reference(File("ref-report/jacoco.xml"))

        report(changedFiles.filter { it.endsWith(".kt") || it.endsWith(".java") })

    }

}

```

This example, is almost same like the previous one, but will display more detailed code coverage summary. It will

additionally load reference report to produce information about coverage value difference.