Jacoco Gradle中的最小代码覆盖率阈值

时间:2016-02-21 19:21:56

标签: gradle jacoco

如何在Jacoco Gradle中设置最小代码覆盖率?

如果不满足,我希望构建失败。

5 个答案:

答案 0 :(得分:25)

此功能现已推出。您只需要应用Gradle JaCoCo插件并定义覆盖验证,如下所示:

apply plugin: 'jacoco'

jacocoTestCoverageVerification {
    violationRules {
        rule {
            limit {
                minimum = 0.7
            }
        }
    }
}

// to run coverage verification during the build (and fail when appropriate)
check.dependsOn jacocoTestCoverageVerification

最后一行非常重要,因为除非您明确运行jacocoTestCoverageVerification任务,否则您的构建不会失败。

有关您可能添加的支票种类的更多信息,请参见documentation of the plugin

答案 1 :(得分:5)

此功能目前不适用于gradle Jacoco插件。请参阅未解决的问题here

然而,可以编写一个自定义任务来解析Jacoco报告,并根据coverage覆盖构建失败。有关实现此目的的一种方法,请参阅here

答案 2 :(得分:0)

这是竞争示例

task wrapper(type: Wrapper){ 
     gradleVersion = '4.8' 
} 

plugins { 
    id 'java' 
    id 'maven' 
    id "jacoco" 
} 

jacoco{ 
    toolVersion = '0.8.1' 
} 

jacocoTestCoverageVerification { 
    violationRules { 
        rule { 
            limit { 
                minimum = 0.5 
            } 
        } 
    } 
} 


jacocoTestReport { 
     reports { 
        csv.enabled false 
        xml.enabled false 
        html { 
            enabled true 
            destination file("$buildDir/reports/jacoco") 
        } 
    } 
   executionData(test) 
} 

tasks.build.dependsOn(jacocoTestReport) 

test{ 
    jacoco{ 
        append = false 
        destinationFile = file("$buildDir/jacoco/jacocoTest.exec") 
        classDumpDir = file("$buildDir/jacoco/classpathdumps") 
    } 
} 

答案 3 :(得分:0)

在Android应用程序中,此配置有效:

项目:build.gradle

buildscript {
    repositories {
        google()
        jcenter()
        maven { url 'https://plugins.gradle.org/m2/' }
    }
    dependencies {
        classpath "com.android.tools.build:gradle:3.1.4"
        classpath "org.jacoco:org.jacoco.core:0.8.2"
    }
}

应用:build.gradle

ext.jacoco_version = '0.8.2'
def configDir = "${project.rootDir}/config"
def reportDir = "${project.buildDir}/reports"
def mainSrc = "$project.projectDir/src/main/java"
def fileFilter = ['**/R.class', '**/R$*.class', '**/BuildConfig.*', '**/Manifest*.*', '**/*Test*.*', 'android/**/*.*']
def debugTree = fileTree(dir: "$project.buildDir/intermediates/classes/debug", excludes: fileFilter)
//Jacoco jacocoTestReport
apply plugin: 'jacoco'
jacoco.toolVersion = jacoco_version
task jacocoTestReport(type: JacocoReport, dependsOn: 'testDebugUnitTest') {
    reports {
        xml.enabled = false
        html.enabled = true
    }
    sourceDirectories = files([mainSrc])
    classDirectories = files([debugTree])
    executionData = fileTree(dir: project.buildDir, includes: [
            'jacoco/testDebugUnitTest.exec', 'outputs/code-coverage/connected/*coverage.ec'
    ])
}
task jacocoTestCoverageVerification(type: JacocoCoverageVerification, dependsOn: 'jacocoTestReport') {
    sourceDirectories = files([mainSrc])
    classDirectories = files([debugTree])
    executionData = files("${buildDir}/jacoco/testDebugUnitTest.exec")
    violationRules {
        failOnViolation = true
        rule {
            limit {
                minimum = 0.7
            }
        }
    }
}

我们可以在命令行中执行以下命令:

./gradlew jacocoTestCoverageVerification

我使用了gradle包装器4.4。

答案 4 :(得分:0)

Gradle Jacoco 插件默认会使用以下代码测试指令的覆盖范围:

jacocoTestCoverageVerification {
    violationRules {
        rule {
            limit {
                minimum = 0.85
            }
        }
    }
}

我需要测试LineBranch Coverage。为了向 Jacoco 提及这一点,我们必须使用 Counter。计数器可以具有各种值,例如:INSTRUCTION、LINE、BRANCH、COMPLEXITY、METHOD 和 CLASS。指令是默认的。

为了验证线路和分支覆盖率,可以使用以下代码:

jacocoTestCoverageVerification {
    violationRules {
        rule {
            limit {
                counter = 'LINE'
                minimum = 0.87
            }
            limit {
                counter = 'BRANCH'
                minimum = 0.80
            }
        }
    }
}

一个规则可以包含多个限制。

参考:https://docs.gradle.org/current/javadoc/org/gradle/testing/jacoco/tasks/rules/JacocoViolationRulesContainer.html