Powermock Jacoco Gradle 0% Покрытие для проекта Android

Question

У нас есть проект Android, и мы используем Powermock для некоторых наших тестов и Jacoco для отчета о покрытии. Мы заметили, что некоторые наши классы возвращаются как 0% покрытие, хотя они действительно покрыты. Мы также наблюдали сообщение ниже для затронутых классов.

"Classes ... do no match with execution data."

Несколько поисковых запросов в Интернете показывают, что Powermock и Jacoco плохо играют и что Offline Instrumentation - возможный обходной путь.

Кто-нибудь ранее использовал скрипт gradle Offline Instrumentation для проектов Android?

Answer 1

Оглядываясь назад, я думаю, что это можно решить с помощью достаточного опыта Android и онлайн-просмотра. Тем не менее, я был (и до сих пор) относительно новичок в Android, Gradle и Groovy, когда это упало мне на колени, поэтому я пишу это для следующего меня: -D

Что происходит в ореховой скорлупе ( выдержка из форума jacoco )

• Исходный файл скомпилирован в неинструментированный файл класса
• Неинструментированный файл класса инструментирован (либо предварительно инструментирован в автономном режиме, либо автоматически во время выполнения агентом Java)
• Выполнение инструментированных классов, собранных в исполняемый файл
• отчет украшает исходные файлы информацией, полученной из анализа exec-файла, и исходных неинструментированных файлов классов
• Сообщение "Classes ... do no match with execution data." во время генерации отчета означает, что файлы классов, используемые для генерации отчета, не совпадают с классами до инструментария.

РЕШЕНИЕ

На странице Jacoco Offline Instrumentation представлены основные шаги, которые должны произойти для автономного инструментария в этом отрывке:

Для таких сценариев файлы классов могут быть предварительно оснащены JaCoCo, например, с помощью инструмента Ant. Во время выполнения предварительно инструментированные классы должны быть на пути к классам вместо оригинальные занятия. Кроме того, jacocoagent.jar необходимо поместить на CLASSPATH.

Сценарий ниже делает именно это:

    apply plugin: 'jacoco'

configurations {
    jacocoAnt
    jacocoRuntime
}

jacoco {
    toolVersion = "0.8.1"
}

def offline_instrumented_outputDir = "$buildDir.path/intermediates/classes-instrumented/debug"

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

def coverageSourceDirs = [
        'src/main/java'
]

task jacocoTestReport(type: JacocoReport, dependsOn: "test") {
    group = "Reporting"

    description = "Generate Jacoco coverage reports"

    classDirectories = fileTree(
            dir: 'build/intermediates/classes/debug',
            excludes: ['**/R.class',
                       '**/R$*.class',
                       '**/BuildConfig.*',
                       '**/MainActivity.*']
    )

    sourceDirectories = files(coverageSourceDirs)
    executionData = files('build/jacoco/testDebugUnitTest.exec')
}

jacocoTestReport {
    reports {
        xml.enabled  true
        html.enabled  true
        html.destination file("build/test-results/jacocoHtml")
    }
}

/* This task is used to create offline instrumentation of classes for on-the-fly instrumentation coverage tool like Jacoco. See jacoco classId
     * and Offline Instrumentation from the jacoco site for more info.
     *
     * In this case, some classes mocked using PowerMock were reported as 0% coverage on jacoco & Sonarqube. The issue between PowerMock and jacoco
     * is well documented, and a possible solution is offline Instrumentation (not so well documented for gradle).
     *
     * In a nutshell, this task:
     *  - Pre-instruments the original *.class files
     *  - Puts the instrumented classes path at the beginning of the task's classpath (for report purposes)
     *  - Runs test & generates a new exec file based on the pre-instrumented classes -- as opposed to on-the-fly instrumented class files generated by jacoco.
     *
     * It is currently not implemented to run prior to any other existing tasks (like test, jacocoTestReport, etc...), therefore, it should be called
     * explicitly if Offline Instrumentation report is needed.
     *
     *  Usage: gradle clean & gradle createOfflineInstrTestCoverageReport & gradle jacocoTestReport
     *   - gradle clean //To prevent influence from any previous task execution
     *   - gradle createOfflineInstrTestCoverageReport //To generate *.exec file from offline instrumented class
     *   - gradle jacocoTestReport //To generate html report from newly created *.exec task
     */
task createOfflineTestCoverageReport(dependsOn: ['instrument', 'testDebugUnitTest']) {
    doLast {
        ant.taskdef(name: 'report',
                classname: 'org.jacoco.ant.ReportTask',
                classpath: configurations.jacocoAnt.asPath)
        ant.report() {
            executiondata {
                ant.file(file: "$buildDir.path/jacoco/testDebugUnitTest.exec")
            }
            structure(name: 'Example') {
                classfiles {
                    fileset(dir: "$project.buildDir/intermediates/classes/debug")
                }
                sourcefiles {
                    fileset(dir: 'src/main/java')
                }
            }
            //Uncomment if we want the task to generate jacoco html reports. However, the current script does not exclude files.
            //An alternative is to used jacocoTestReport after this task finishes
            //html(destdir: "$buildDir.path/reports/jacocoHtml")
        }
    }
}

/*
 * Part of the Offline Instrumentation process is to add the jacoco runtime to the class path along with the path of the instrumented files.
 */
gradle.taskGraph.whenReady { graph ->
    if (graph.hasTask(instrument)) {
        tasks.withType(Test) {
            doFirst {
                systemProperty 'jacoco-agent.destfile', buildDir.path + '/jacoco/testDebugUnitTest.exec'
                classpath = files(offline_instrumented_outputDir) + classpath + configurations.jacocoRuntime
            }
        }
    }
}

/*
 *  Instruments the classes per se
 */
task instrument(dependsOn:'compileDebugUnitTestSources') {
    doLast {
        println 'Instrumenting classes'

        ant.taskdef(name: 'instrument',
                classname: 'org.jacoco.ant.InstrumentTask',
                classpath: configurations.jacocoAnt.asPath)

        ant.instrument(destdir: offline_instrumented_outputDir) {
            fileset(dir: "$buildDir.path/intermediates/classes/debug")
        }
    }
}

Использование

• Сценарий можно скопировать в отдельный файл. Например: jacoco.gradle

• Ссылка на файл jacoco в вашем build.gradle. Например: apply from: jacoco.gradle

• Обеспечить правильные зависимости: jacocoAnt 'org.jacoco:org.jacoco.ant:0.8.1:nodeps'

• В командной строке запустите: gradle clean & gradle createOfflineTestCoverageReport & gradle jacocoTestReport

  gradle clean уничтожит все предыдущие артефакты выполнения gradle

  gradle createOfflineTestCoverageReport создаст автономный инструментарий, изменит порядок пути к классам, сгенерирует файл .exec

  gradle jacocoTestReport запустит тест и сгенерирует отчет jacoco на основе ранее созданного файла .exec

Чувствуешь себя потерянным?

Я собрал проект github Jacoco Powermock Android с примерами сценариев для воспроизведения и устранения проблемы. Он также содержит дополнительную информацию о решении.

ССЫЛКА

https://github.com/powermock/powermock/wiki/Code-coverage-with-JaCoCo
https://www.jacoco.org/jacoco/trunk/doc/classids.html
https://www.jacoco.org/jacoco/trunk/doc/offline.html
https://github.com/powermock/powermock-examples-maven/tree/master/jacoco-offline
https://automated-testing.info/t/jacoco-offline-instrumentations-for-android-gradle/20121
https://stackoverflow.com/questions/41370815/jacoco-offline-instrumentation-gradle-script/42238982#42238982
https://groups.google.com/forum/#!msg/jacoco/5IqM4AibmT8/-x5w4kU9BAAJ