ปัญหา:

ฉันมีโครงการกับ จาโคโค่ และฉันต้องการกรองคลาสและ / หรือแพ็คเกจบางอย่าง

เอกสารที่เกี่ยวข้อง:

ฉันได้อ่านเอกสารดังต่อไปนี้:

เป็นทางการ จาโคโค่เว็บไซต์: http://www.eclemma.org/jacoco/index.html

เป็นทางการ จาโคโค่ เอกสารสำหรับ ไล่สี: https://gradle.org/docs/current/userguide/jacoco_plugin.html

เป็นทางการ จาโคโค่ Githubปัญหาเกี่ยวกับการรายงานข่าว: https://github.com/jacoco/jacoco/wiki/FilteringOptions https://github.com/jacoco/jacoco/issues/14

ลิงค์ StackOverflow ที่เกี่ยวข้อง:

JaCoCo & Gradle - ตัวเลือกการกรอง (ไม่มีคำตอบ)

ไม่รวมแพ็คเกจจากรายงาน Jacoco โดยใช้ Sonarrunner และ Gradle (ไม่ใช้ไฟล์โซนาร์)

JaCoCo - ไม่รวม JSP จากรายงาน (ดูเหมือนว่าจะใช้ได้กับมาเวน, ฉันใช้ ไล่สี)

การกำหนดค่า Maven Jacoco - ไม่รวมคลาส / แพ็คเกจจากรายงานไม่ทำงาน (ดูเหมือนว่าจะใช้ได้กับมาเวน, ฉันใช้ ไล่สี)

ไม่รวมปลั๊กอิน JaCoCo gradle (ไม่สามารถใช้งานได้)

Gradle Jacoco - รายงานความครอบคลุมรวมถึงคลาสที่ไม่รวมอยู่ในการกำหนดค่า (ดูเหมือนจะใกล้เคียงมากใช้doFirstแล้วไม่ได้ผลสำหรับฉัน)

ตัวอย่างสิ่งที่ฉันได้ลอง:

apply plugin: 'java'
apply plugin: 'jacoco'

buildscript {
    repositories {
        mavenCentral()
        jcenter()
    }
}

repositories {
    jcenter()
}

jacocoTestReport {
    reports {
        xml {
            enabled true // coveralls plugin depends on xml format report
        }

        html {
            enabled true
        }
    }

    test {
        jacoco {
            destinationFile = file("$buildDir/jacoco/jacocoTest.exec")
            classDumpFile = file("$buildDir/jacoco/classpathdumps")
            excludes = ["projecteuler/**"] // <-- does not work
            // excludes = ["projecteuler"]
        }
    }
}

คำถาม:

ฉันจะแยกแพ็คเกจและคลาสบางอย่างได้อย่างไรเมื่อสร้างไฟล์ จาโคโค่ รายงานความครอบคลุม?

ขอบคุณYannick Welsch:

หลังจากค้นหา Google อ่านเอกสาร Gradle และอ่านโพสต์ StackOverflow รุ่นเก่าฉันพบคำตอบนี้ใน Official ไล่สี เว็บบอร์ด!

jacocoTestReport {
    afterEvaluate {
        classDirectories = files(classDirectories.files.collect {
            fileTree(dir: it, exclude: 'com/blah/**')
        })
    }
}

ที่มา: https://issues.gradle.org/browse/GRADLE-2955

วิธีแก้ปัญหาbuild.gradleสำหรับโปรเจ็กต์ Java / Groovy ของฉัน:

apply plugin: 'java'
apply plugin: 'jacoco'

jacocoTestReport {
    reports {
        xml {
            enabled true // coveralls plugin depends on xml format report
        }

        html {
            enabled true
        }
    }

    afterEvaluate {
        classDirectories = files(classDirectories.files.collect {
            fileTree(dir: it,
                    exclude: ['codeeval/**',
                              'crackingthecode/part3knowledgebased/**',
                              '**/Chapter7ObjectOrientedDesign**',
                              '**/Chapter11Testing**',
                              '**/Chapter12SystemDesignAndMemoryLimits**',
                              'projecteuler/**'])
        })
    }
}

อย่างที่คุณเห็นฉันสามารถเพิ่มได้สำเร็จexclude:เพื่อกรองแพ็คเกจบางอย่าง

ที่มา: https://github.com/jaredsburrows/CS-Interview-Questions/blob/master/build.gradle

งานที่กำหนดเองสำหรับโครงการอื่น ๆ เช่น Android:

apply plugin: 'jacoco'

task jacocoReport(type: JacocoReport) {
    reports {
        xml {
            enabled true // coveralls plugin depends on xml format report
        }

        html {
            enabled true
        }
    }

    afterEvaluate {
        classDirectories = files(classDirectories.files.collect {
            fileTree(dir: it,
                    exclude: ['codeeval/**',
                              'crackingthecode/part3knowledgebased/**',
                              '**/Chapter7ObjectOrientedDesign**',
                              '**/Chapter11Testing**',
                              '**/Chapter12SystemDesignAndMemoryLimits**',
                              'projecteuler/**'])
        })
    }
}

ที่มา: https://github.com/jaredsburrows/android-gradle-java-app-template/blob/master/gradle/quality.gradle#L59

สำหรับ Gradle เวอร์ชัน 5.x classDirectories = files(...)คำเตือนการเลิกใช้งานจะไม่ทำงานเลยโดยเริ่มจาก Gradle 6.0 นี่เป็นวิธีที่ไม่ได้รับการสนับสนุนในการยกเว้นคลาส:

jacocoTestReport {
    afterEvaluate {
        classDirectories.setFrom(files(classDirectories.files.collect {
            fileTree(dir: it, exclude: 'com/exclude/**')
        }))
    }
}

สำหรับฉันมันใช้ได้ดีกับ

test {
  jacoco {
    excludes += ['codeeval/**',
                 'crackingthecode/part3knowledgebased/**',
                 '**/Chapter7ObjectOrientedDesign**',
                 '**/Chapter11Testing**',
                 '**/Chapter12SystemDesignAndMemoryLimits**',
                 'projecteuler/**']
  }
}

ตามที่ระบุไว้ในเอกสาร https://docs.gradle.org/current/userguide/jacoco_plugin.html#N16E62และถามเริ่มต้นดังนั้นคำตอบคือ:

ดังนั้นถ้าคุณถามฉัน: มันไม่ใช่คำถาม

excludes = ["projecteuler/**"]

หรือ

excludes += ["projecteuler/**"]

แต่

excludes = ["**/projecteuler/**"]

เพื่อไม่รวมแพ็คเกจ *.projecteuler.*

และtest {}ในระดับโครงการไม่ซ้อนกันjacocoTestReport

สำหรับ Gradle6 ให้ใช้สิ่งที่ต้องการด้านล่างเนื่องจากพวกเขาสร้างขึ้นclassDirectories as finalเราไม่สามารถกำหนดใหม่ได้ แต่มีเมธอด setter classDirectories.setFromซึ่งสามารถใช้ประโยชน์ได้

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

    afterEvaluate {
        classDirectories.setFrom(files(classDirectories.files.collect {
            fileTree(dir: it,
                    exclude: ['**/server/**',
                              '**/model/**',
                              '**/command/**'
                    ]
            )
        }))
    }
}

นี่คือวิธีแก้ปัญหานี้ใน ANT สิ่งนี้สามารถปรับให้เข้ากับการไล่ระดับสีได้โดยเพิ่มสิ่งต่อไปนี้ภายใต้jacocoTestReportงาน แม้ว่า jacoco จะไม่ได้บันทึกไว้ แต่ดูเหมือนว่าจะเป็นวิธีเดียวในการกรองผลการทดสอบในตอนนี้

afterEvaluate {
    classDirectories = files(classDirectories.files.collect {
        fileTree(dir: it, exclude: 'excluded/files/**')
    })
}

นี่ออกมาสักพักแล้ว แต่ฉันเพิ่งวิ่งข้ามสิ่งนี้ ฉันกำลังดิ้นรนกับการยกเว้นทั้งหมดที่จำเป็น ฉันพบว่ามันง่ายกว่ามากสำหรับฉัน หากคุณทำตามรูปแบบโครงร่างโครงการ Maven / src / main / java และ / src / test / java คุณก็ต้องใส่buildDir / class / main ในclassDirectories config ดังนี้:

afterEvaluate {
    jacocoTestReport {
        def coverageSourceDirs = ['src/main/java']
        reports {
            xml.enabled false
            csv.enabled false
            html.destination "${buildDir}/reports/jacocoHtml"
        }
        sourceDirectories = files(coverageSourceDirs)
        classDirectories = fileTree(
                dir: "${project.buildDir}/classes/main",
                excludes: [
                      //whatever here like JavaConfig etc. in /src/main/java
                     ]
        )
    }
}

รหัสด้านล่างนี้ไม่รวมคลาสจากการตรวจสอบความครอบคลุมเช่นกัน:

jacocoTestCoverageVerification {
    afterEvaluate {
        classDirectories = files(classDirectories.files.collect {
            fileTree(dir: "${project.buildDir}/classes/main",
                    exclude: ['**/packagename/**'])
        })
    }
}

ความคิดเห็นบางส่วนกล่าวถึงคำเตือนการเลิกใช้งาน ในการแก้ปัญหาเพียงแค่ใช้ getter:

afterEvaluate {
    getClassDirectories().from(files(classDirectories.files.collect {
        fileTree(dir: it, exclude: 'com/blah/**')
    }))
}

เพื่อที่จะกรองในรายงาน jacoco ยกเว้นความจำเป็นที่จะต้องทำในสองงานและjacocoTestReportjacocoTestCoverageVerification

โค้ดตัวอย่าง

    def jacocoExclude = ['**/example/**', '**/*Module*.class']

    jacocoTestReport {
        afterEvaluate {
            getClassDirectories().setFrom(classDirectories.files.collect {
                fileTree(dir: it, exclude: jacocoExclude)
            })
        }
    }

    jacocoTestCoverageVerification {
        afterEvaluate {
            getClassDirectories().setFrom(classDirectories.files.collect {
                fileTree(dir: it, exclude: jacocoExclude)
            })
        }

        ...
    }

เพิ่ม config ด้านล่างในไฟล์ gradle.properties

coverageExcludeClasses=["com.example.package.elasticsearch.*", "com.example.package2.*",]