JaCoCo на инструментальных тестах Android завершается неудачно, «агент не запущен» - PullRequest
0 голосов
/ 02 ноября 2018

у нас есть многомодульный проект с некоторыми приложениями и библиотеками, и мы используем JaCoCo для освещения юнит-тестов и инструментальных тестов на Android. Поэтому мы используем стандартный плагин jacoco для Gradle вместе с плагином Android для Gradle. Используемая нами цель JaCoCo - createStandardDebugCoverageReport.

Однако мы видим поведение, которое не можем ни объяснить, ни изменить: На обоих модулях тесты выполняются и проходят, но на одном модуле отчет о покрытии создается и загружается из эмулятора. На другом модуле мы видим сообщение об ошибке после прохождения теста:

Причина: java.lang.IllegalStateException: агент JaCoCo не запущен.

на logcat и, таким образом, создается файл с нулевыми байтами.

Мы протестировали его с двумя аналогичными приложениями с классами ExampleUnitTest и ExampleInstrumentedTest.

Вся конфигурация JaCoCo выполняется в корневой ветке проекта.

Корень проекта:

import org.ajoberstar.grgit.Grgit

buildscript {
    ext {
        jacocoVersion = "0.8.1"
    }
    repositories {
        maven {
            url "our.artifactory.url"
            credentials {
                username System.getenv("ARTIFACTORY_LOCAL_USERNAME") ? System.getenv("ARTIFACTORY_LOCAL_USERNAME") : project.property("ARTIFACTORY_LOCAL_USERNAME")
                password System.getenv("ARTIFACTORY_LOCAL_PASSWORD") ? System.getenv("ARTIFACTORY_LOCAL_PASSWORD") : project.property("ARTIFACTORY_LOCAL_PASSWORD")
            }
        }
        // The used repositories need to be configured within artifactory because we use it as dependency cache.
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:3.3.0-alpha13'
        classpath 'com.google.gms:google-services:3.2.0'
        classpath 'io.fabric.tools:gradle:1.26.1'
        classpath 'org.jfrog.buildinfo:build-info-extractor-gradle:4.7.5'
        classpath 'org.ajoberstar:grgit:2.2.1'
        classpath "org.sonarsource.scanner.gradle:sonarqube-gradle-plugin:2.6.2"

        classpath "org.jacoco:org.jacoco.core:${jacocoVersion}"
        classpath "org.jacoco:org.jacoco.report:${jacocoVersion}"
        classpath "org.jacoco:org.jacoco.agent:${jacocoVersion}"

        classpath "org.codehaus.groovy:groovy-all:2.4.15"
    }
}

plugins {
    id "org.sonarqube" version "2.6.2"
}

// This block encapsulates custom properties and makes them available to all
// modules in the project.
ext {
    versionCode = 110
    versionName = "0.17.3"

    currentBranchName = System.getenv("BRANCH")

    def gitDirectory = file(file('.').parentFile.absolutePath + File.separator + '.git')
    if (currentBranchName.equals("unknown") && gitDirectory.exists()) {
        git = Grgit.open(dir: gitDirectory.parentFile)
        currentBranchName = git.branch.current.name
    }

    artifactoryUser = System.getenv("ARTIFACTORY_LOCAL_USERNAME")
    artifactoryPassword = System.getenv("ARTIFACTORY_LOCAL_PASSWORD")

    minSdkVersion = 23
    compileSdkVersion = 28
    targetSdkVersion = 28
    supportLibVersion = "28.0.0"
    playServicesVersion = "16.2.0"
    jacocoVersion = "0.8.1"
}

allprojects {
    apply plugin: "com.jfrog.artifactory"
    apply plugin: 'maven-publish'

    repositories {
        maven {
            url "our.artifactory.url"
            credentials {
                username System.getenv("ARTIFACTORY_LOCAL_USERNAME") ? System.getenv("ARTIFACTORY_LOCAL_USERNAME") : project.property("ARTIFACTORY_LOCAL_USERNAME")
                password System.getenv("ARTIFACTORY_LOCAL_PASSWORD") ? System.getenv("ARTIFACTORY_LOCAL_PASSWORD") : project.property("ARTIFACTORY_LOCAL_PASSWORD")
            }
        }
        // The used repositories need to be configured within artifactory because we use it as dependency cache.
    }

// This is the only place of any JaCoCo configuration
    apply plugin: 'jacoco'

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

Следующее приложение износа, рабочий образец:

apply plugin: 'com.android.application'

configurations {
    demoDebugCompile
    demoReleaseCompile
    standardDebugCompile
    standardReleaseCompile
}

android {
    signingConfigs {
        ourSigningConfig {
            keyAlias getEnvProperty("SIGNING_KEY_ALIAS")
            keyPassword getEnvProperty("SIGNING_KEY_PASSWORD")
            storeFile file(getEnvProperty("SIGNING_STORE_FILE"))
            storePassword getEnvProperty("SIGNING_STORE_PASSWORD")
        }
    }

    compileSdkVersion rootProject.ext.compileSdkVersion

    defaultConfig {
        applicationId "our.working.applicationid"
        minSdkVersion rootProject.ext.minSdkVersion
        targetSdkVersion rootProject.ext.targetSdkVersion
        versionCode rootProject.ext.versionCode
        versionName rootProject.ext.versionName
        multiDexEnabled true
        testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
    }

    buildTypes {
        release {
            debuggable false
            minifyEnabled true
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
            signingConfig signingConfigs.ourSigningConfig
        }

        debug {
            debuggable true
            minifyEnabled false
            applicationIdSuffix ".debug"
            versionNameSuffix " Debug"
            testCoverageEnabled true
        }
    }

    flavorDimensions "mode"

    productFlavors {
        demo {
            dimension "mode"
            applicationIdSuffix ".demo"
            versionNameSuffix " Demo"
            buildConfigField "boolean", "DEMO", "true"
        }

        standard {
            dimension "mode"
            buildConfigField "boolean", "DEMO", "false"
        }
    }

    testOptions {
        unitTests {
            includeAndroidResources = true
            returnDefaultValues = false
        }

        unitTests.all {
            jvmArgs '-noverify'
            // https://stackoverflow.com/questions/32315978/jvm-options-in-android-when-run-gradlew-test/37593189#37593189
        }
    }

    lintOptions {
        abortOnError false
    }

    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
}

dependencies {
    // External libraries
    implementation fileTree(include: ['*.jar'], dir: 'libs')

    // Support library
    implementation 'com.google.android.support:wearable:2.1.0'
    compileOnly 'com.google.android.wearable:wearable:2.1.0'

    // Google Play services
    implementation "com.google.android.gms:play-services-wearable:15.0.1" // TODO: use ${rootProject.ext.supportLibVersion}

    // Authenticator
    implementation project(':authenticator')

    // Testing
    testImplementation 'junit:junit:4.12'
    testImplementation 'org.robolectric:robolectric:4.0-beta-1'

    androidTestImplementation 'com.android.support.test:runner:1.0.2'
    androidTestImplementation 'com.android.support.test.espresso:espresso-core:3.0.2'
}

configurations.all {
    resolutionStrategy.eachDependency { DependencyResolveDetails details ->
        def requested = details.requested
        if (requested.group == 'com.android.support') {
            if (!requested.name.startsWith("multidex")) {
                details.useVersion "${rootProject.ext.supportLibVersion}"
            }
        }
    }
}

artifactoryPublish.skip = true

Ниже приводится фиктивное приложение. Этот дает нам agent not started exception. Мы сравнили файлы Gradle модуля и улучшили его с помощью зависимостей рабочего файла Gradle.

apply plugin: 'com.android.application'

configurations {
    demoDebugCompile
    demoReleaseCompile
    standardDebugCompile
    standardReleaseCompile
}

android {
    compileSdkVersion rootProject.ext.compileSdkVersion

    defaultConfig {
        applicationId "our.nonworking.applicationid"
        minSdkVersion rootProject.ext.minSdkVersion
        targetSdkVersion rootProject.ext.targetSdkVersion
        versionCode rootProject.ext.versionCode
        versionName rootProject.ext.versionName
        multiDexEnabled true
        testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
        proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
    }

    buildTypes {
        release {
            debuggable false
            minifyEnabled true
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
            consumerProguardFiles 'proguard-rules.pro'
        }
        debug {
            debuggable true
            minifyEnabled false
            applicationIdSuffix ".debug"
            versionNameSuffix " Debug"
            testCoverageEnabled true
        }
    }

    flavorDimensions "mode"
    productFlavors {
        demo {
            dimension "mode"
            applicationIdSuffix ".demo"
            versionNameSuffix " Demo"
            buildConfigField "boolean", "DEMO", "true"
        }
        standard {
            dimension "mode"
            buildConfigField "boolean", "DEMO", "false"
        }
    }

    testOptions {
        unitTests {
            includeAndroidResources = true
            returnDefaultValues = false
        }
        unitTests.all {
            jvmArgs '-noverify'
            // https://stackoverflow.com/questions/32315978/jvm-options-in-android-when-run-gradlew-test/37593189#37593189
        }
    }

    lintOptions {
        abortOnError false
    }

    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
}

dependencies {
    implementation fileTree(include: ['*.jar'], dir: 'libs')

    implementation 'com.android.support.constraint:constraint-layout:1.1.3'

    // Support library
    implementation 'com.google.android.support:wearable:2.1.0'
    compileOnly 'com.google.android.wearable:wearable:2.1.0'

    // Google Play services
    implementation "com.google.android.gms:play-services-wearable:15.0.1" // TODO: use ${rootProject.ext.supportLibVersion}

    // Authenticator
    implementation project(':authenticator')

    // Testing
    testImplementation 'junit:junit:4.12'
    testImplementation 'org.robolectric:robolectric:4.0-beta-1'

    androidTestImplementation 'com.android.support.test:runner:1.0.2'
    androidTestImplementation 'com.android.support.test.espresso:espresso-core:3.0.2'
}

configurations.all {
    resolutionStrategy.eachDependency { DependencyResolveDetails details ->
        def requested = details.requested
        if (requested.group == 'com.android.support') {
            if (!requested.name.startsWith("multidex")) {
                details.useVersion "${rootProject.ext.supportLibVersion}"
            }
        }
    }
}

artifactoryPublish.skip = true

У нас сейчас нет идей. Что может повлиять на это? Мы видим такое же поведение на некоторых библиотеках в нашем проекте. Тестируемый эмулятор Pixel XL API 28. У вас есть предложение, совет или подсказка?

Заранее спасибо.

Ответы [ 2 ]

0 голосов
/ 16 ноября 2018

Я нашел решение, которое, к сожалению, до конца не понимаю:

Я объединил конфигурацию теста, распаковав ее в дополнительный файл Gradle, чтобы не было никакой разницы между конфигурацией Gradle модулей в отношении тестов.

Это не помогло, но улучшило мою архитектуру.

Если я добавлю инструментальные тесты к модулям, которые имеют эти проблемы, он просто работает, и отчеты о покрытии создаются для всех модулей. Я не понимаю, что все эти модули имеют ExampleInstrumentedTest, что проходит. Однако два модуля имеют только ExampleInstrumentedTest, и он генерирует отчет о покрытии. Они оба приложения для Android . Однако у меня была проблема не создавать отчет о покрытии с другим (очень простым) приложением. Вот почему я не пытался добавить другие инструментальные тесты к неисправным модулям.

Итак, теперь это работает для меня. Но если кто-то может дать подсказку, почему это работает, и использование ExampleInstrumentedTest не работает, это будет очень цениться.

0 голосов
/ 07 ноября 2018

Начиная с плагина 3.0.0, теперь вы не можете сконфигурировать Jacoco с помощью блока DSL android, но вместо этого необходимо указать версию jacoco в зависимостях classpath вместе с плагином Android. Поэтому добавьте следующее:

buildscript {
  repositories {
    google()
    jcenter()
  }
  dependencies {
    // Android plugin 
    classpath 'com.android.tools.build:gradle:3.0.1'
    //Jacoco version
    classpath 'org.jacoco:org.jacoco.core:0.8.1'
  }
}

Надеюсь, это поможет

...