kotlinx.kover.gradle.plugin.tools.jacoco.JacocoTool.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kover-gradle-plugin Show documentation

Kotlin code coverage plugin

There is a newer version: 0.9.0-RC

/*
 * Copyright 2017-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
 */

package kotlinx.kover.gradle.plugin.tools.jacoco

import kotlinx.kover.gradle.plugin.commons.ReportContext
import kotlinx.kover.gradle.plugin.commons.VerificationRule
import kotlinx.kover.gradle.plugin.tools.CoverageRequest
import kotlinx.kover.gradle.plugin.tools.CoverageTool
import kotlinx.kover.gradle.plugin.tools.CoverageToolVariant
import org.gradle.api.GradleException
import org.gradle.api.file.ArchiveOperations
import org.gradle.api.file.FileCollection
import java.io.File


internal class JacocoTool(override val variant: CoverageToolVariant) : CoverageTool {
    override val jvmAgentDependency: String = "org.jacoco:org.jacoco.agent:${variant.version}"

    override val jvmReporterDependency: String = "org.jacoco:org.jacoco.report:${variant.version}"
    override val jvmReporterExtraDependency: String = "org.jacoco:org.jacoco.report:${variant.version}"

    override fun findJvmAgentJar(classpath: FileCollection, archiveOperations: ArchiveOperations): File {
        val fatJar = classpath.filter { it.name.startsWith("org.jacoco.agent") }.singleFile
        return archiveOperations.zipTree(fatJar).filter { it.name == "jacocoagent.jar" }.singleFile
    }

    override fun jvmAgentArgs(
        jarFile: File,
        tempDir: File,
        binReportFile: File,
        excludedClasses: Set,
        includedClasses: Set
    ): List {
        return buildJvmAgentArgs(jarFile, binReportFile, excludedClasses, includedClasses)
    }

    override fun xmlReport(xmlFile: File, title: String, context: ReportContext) {
        context.jacocoXmlReport(xmlFile, title)
    }

    override fun htmlReport(htmlDir: File, title: String, charset: String?, context: ReportContext) {
        context.jacocoHtmlReport(htmlDir, title, charset)
    }

    override fun binaryReport(binary: File, context: ReportContext) {
        throw GradleException("It is not possible to generate an Kover binary report for JaCoCo. Please use Kover toolset")
    }

    override fun verify(rules: List, output: File, context: ReportContext) {
        return context.doJacocoVerify(rules, output)
    }

    override fun collectCoverage(
        request: CoverageRequest,
        outputFile: File,
        context: ReportContext
    ) {
        context.printJacocoCoverage(request, outputFile)
    }

}