coverage.md

Test coverage

Pitest

Pitest is the gold standard for test coverage. Failgood has great support for it. If your test suite it fast and lightweight enough you shoud really use it. Just use the pitest gradle plugin and a config like this:

plugins {
    // ...
    id("info.solidsoft.pitest")
}

plugins.withId("info.solidsoft.pitest") {
    configure<PitestPluginExtension> {
        //        verbose.set(true)
        jvmArgs.set(listOf("-Xmx512m")) // useful for CI
        avoidCallsTo.set(setOf("kotlin.jvm.internal", "kotlin.Result")) // filter out kotlin internal classes
        targetClasses.set(setOf("failgood.*")) // by default "${project.group}.*"
        targetTests.set(setOf("failgood.*Test", "failgood.**.*Test"))
        threads.set(
            System.getenv("PITEST_THREADS")?.toInt() ?: Runtime.getRuntime().availableProcessors()
        ) // useful to limit threads on CI
        outputFormats.set(setOf("XML", "HTML"))
    }
}

Kotlinx-Kover

Failgood also works well with the Kotlinx-Kover plugin. Just put it into your gradle plugins block and run test tasks as usual.

plugins {
    id("org.jetbrains.kotlinx.kover") version "0.6.1"
}