Android使用acoco統計代碼行覆蓋率介紹

Posted on by

前言

jacoco是Java Code Coverage的縮寫，是Java代碼覆蓋率統計的主流工具之一。關於jacoco的原理介紹，在網上有很多文章，感興趣的同學可以去找別的博客看看，這裡不做贅述。
最近接到這個需求，需要提升代碼單測覆蓋率並統計上傳，瞭解到的實現方式是jacoco+Squaretest插件，在網上查瞭不少的資料，不得不說網上大部分的資料都非常老瞭，gradle插件一般都是2.3的，導致很多類文件路徑錯誤，浪費瞭我很多時間，就算有比較新的博文，也大都是需要安裝運行之後從手機存儲再提取相應的ec文件來執行分析才能得出結果，我們這邊目標是有腳本直接可以執行獲取相應的文件來統計並自動上傳，所以那種需要運行之後再提取相應的文件解析不是很方便，而且這種方案在不同手機上可能還會帶來各種問題，於是，在我經過一番實踐後終於實現瞭無需運行隻需執行gradle task便可得到覆蓋率文件，決定分享一下，為日後有需求的同學節省一些時間！

正文

請根據以下步驟細心耐心進行配置，中間如果出現任何錯誤都會影響到最後覆蓋率文件的生成！

1、項目 build.gradle

在項目的 build.gradle 中引入 jacoco core 依賴：

、、、

buildscript {
    repositories {
       、、、
        maven { url "https://oss.sonatype.org/content/repositories/snapshots" }
    }

    dependencies {
        、、、
        classpath 'com.android.tools.build:gradle:3.2.1' //可具體配置 本教程務必使用3.2以上
        classpath "org.jacoco:org.jacoco.core:0.8.5"
    }
}
、、、

2、jacoco-report.gradle

在項目根目錄新建一個 jacoco-report.gradle 文件，其中主要定義瞭一個 Gradle 任務：jacocoCoverageTestReport。代碼如下：

apply plugin: 'jacoco'

tasks.withType(Test) {
    jacoco.includeNoLocationClasses = true
}

ext {
    getFileFilter = { ->
        def jacocoSkipClasses = null
        if (project.hasProperty('jacocoSkipClasses')) {
            jacocoSkipClasses = project.property('jacocoSkipClasses')
        }
        //忽略類文件配置
        def fileFilter = ['**/R.class', '**/R$*.class', '**/BuildConfig.*', '**/Manifest*.*', '**/*$ViewInjector*.*']
        if (jacocoSkipClasses != null) {
            fileFilter.addAll(jacocoSkipClasses)
        }
        return fileFilter
    }
}

task jacocoTestReport(type: JacocoReport, dependsOn: ['testCoverageDebugUnitTest', 'createCoverageDebugCoverageReport']) {
    group = "Reporting"
    description = "Generate Jacoco coverage reports"
    reports {
        xml {
            enabled = true
            xml.destination file("build/reports/jacoco/jacoco.xml")
        }
        html {
            enabled = true
            html.destination file("build/reports/jacoco")
        }
    }

    def fileFilter = project.getFileFilter()
    //檢測覆蓋率的class所在目錄(以項目class所在目錄為準)
    //gradle2.3 class所在目錄
    def coverageDebugTree = fileTree(dir: "$project.buildDir/intermediates/classes/coverageDebug", excludes: fileFilter)
    //gradle3.2 class所在目錄
    def coverageDebugTreeNewGradle = fileTree(dir: "$project.buildDir/intermediates/javac/debug/compileDebugJavaWithJavac/classes", excludes: fileFilter)
    def mainSrc = "$project.projectDir/src/main/java"

    //設置需要檢測覆蓋率的目錄
    sourceDirectories = files([mainSrc])
    //兼容gradle版本
    classDirectories = files([coverageDebugTree, coverageDebugTreeNewGradle])
    //以下路徑也需要檢查
    executionData = fileTree(dir: project.buildDir, includes: [
            'jacoco/testCoverageDebugUnitTest.exec', 'outputs/code-coverage/debugAndroidTest/connected/coverage.ec'
    ])
}

註意以上註釋的位置，每一個配置務必仔細檢查路徑是否正確且存在！

3、 app/*module的build.gradle

在你需要統計的 app或者某 module 對應的 build.gradle 中進行 jacoco 任務配置：

引入 上面新建的 jacoco-report.gradle；
添加 coverageDebug BuildType。
代碼如下：

apply plugin: 'com.android.library'
apply from: '../jacoco-report.gradle'

android {
   、、、

    defaultConfig {
        、、、

        testInstrumentationRunner 'androidx.test.runner.AndroidJUnitRunner'
    }
    lintOptions {
        、、、
        abortOnError false
    }

    buildTypes {
        、、、
        coverageDebug {
            minifyEnabled false
            testCoverageEnabled true
        }
    }
    testOptions {
        unitTests.all {
            jvmArgs '-noverify'
        }
        unitTests {
            includeAndroidResources = true
        }

        unitTests.returnDefaultValues = true
    }
  、、、
}

dependencies {
    、、、
    testImplementation 'junit:junit:4.12'

    //單元測試
    androidTestImplementation 'androidx.test.espresso:espresso-core:3.3.0'
    testImplementation 'org.robolectric:robolectric:4.3.1'
    testImplementation "org.robolectric:shadows-multidex:4.3"
    testImplementation 'org.hamcrest:hamcrest-all:1.3'

    // power mockito
    testImplementation 'org.mockito:mockito-core:2.8.9'
    testImplementation "org.powermock:powermock-api-mockito2:1.7.4"
    testImplementation "org.powermock:powermock-module-junit4:1.7.4"
    testImplementation "org.powermock:powermock-module-junit4-rule:1.7.4"
    testImplementation "org.powermock:powermock-classloading-xstream:1.7.4"
}

4、 測試用例

在需要測試的對應 module 的 src/test/ 目錄下編寫對應的代碼測試用例，建議使用 Squaretest插件生成，使用方式請自行搜索，基本沒什麼坑，這裡不再贅述。

5、 運行 task jacocoTestReport

task路徑

在 Android Studio 的 Gradle 任務窗格中，找到 project/module/Tasks/reporting/jacocoTestReport 這個任務，雙擊運行，即可生成代碼行覆蓋率報告。

5、 查看報告

打開 project/module/build/reports/jacoco/index.html文件，即可查看各個代碼文件的行覆蓋率。

報告路徑

覆蓋率報告用瀏覽器打開後一般如下：

覆蓋率報告

6、 小花招：快速提升代碼覆蓋率

根據覆蓋率報告將覆蓋率低的類忽略，具體可查看步驟2代碼的第一個註釋處

、、、
//忽略類文件配置
def fileFilter = ['**/R.class', '**/R$*.class', '**/BuildConfig.*', '**/Manifest*.*', '**/*$ViewInjector*.*'
//繼續添加想要被忽略的低覆蓋率的類
'**/ClassA.class','**/ClassB.class'、、、
]
、、、

到此這篇關於Android使用acoco統計代碼行覆蓋率介紹的文章就介紹到這瞭,更多相關Android acoco統計代碼行覆蓋率內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：