适用于Android的自定义Gradle测试任务

适用于Android的自定义Gradle测试任务

问题描述:

问题

我想创建一个自定义的gradle测试任务,使其仅运行JUNIT测试并省略Robolectric测试.我正在尝试通过创建新的测试注释并省略任何包含该新注释的测试来实现此任务.

I want to create a custom gradle test task to only run JUNIT tests and omit Robolectric tests. I am attempting to achieve this task by creating a new test annotation and omitting any tests that include that new annotation.

错误

运行gradle任务时不包含JUNIT软件包.

JUNIT packages are not included when I run the the gradle task.

error: package android.test.suitebuilder.annotation does not exist
import android.test.suitebuilder.annotation.SmallTest;

详细信息

新注释

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.TYPE})
public @interface RobolectricTest {
}

成绩文件

apply plugin: 'com.android.application'
apply plugin: 'com.google.gms.google-services'

repositories {
    mavenCentral()
    maven { url     'http://artifactory.ops.am1.qa.ext.bamgrid.com/artifactory/mobile-resources' }
    maven { url 'https://oss.sonatype.org/content/repositories/snapshots/' }
}

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        classpath 'com.google.gms:google-services:1.3.0-beta1'
    }
}

android {
    compileSdkVersion rootProject.ext.compileSDKVersion
    buildToolsVersion rootProject.ext.buildToolsVersion

    defaultConfig {
        applicationId "com.example"
        minSdkVersion 17
        targetSdkVersion rootProject.ext.targetSdkVersion
        buildConfigField "String", "BUILD_TIME", "\"" + getDateAndTime() + "\""
        buildConfigField "String", "VERSION_BUILD", "\"" +     project["VERSION_BUILD"] + "\""
        versionCode Integer.parseInt(project.VERSION_CODE)
        versionName project.VERSION_NAME
    }

    signingConfigs {
        debug {
            storeFile file(project.DEBUG_KEYSTORE)
            storePassword project.DEBUG_KEYSTORE_PASSWORD
            keyAlias project.DEBUG_KEYSTORE_ALIAS
            keyPassword project.DEBUG_KEY_PASS
        }

        release {
            storeFile file(project.RELEASE_KEYSTORE)
            storePassword project.RELEASE_KEYSTORE_PASSWORD
            keyAlias project.RELEASE_KEYSTORE_ALIAS
            keyPassword project.RELEASE_KEY_PASS
        }
    }

    sourceSets {
        main {
            res.srcDirs = ['src/main/res/',
                           'src/main/abc']
        }
    }

    buildTypes {
        release {
            minifyEnabled true
            shrinkResources true
            zipAlignEnabled true
            proguardFile getDefaultProguardFile('proguard-android-optimize.txt')
            proguardFile 'proguard-rules.pro'
            signingConfig signingConfigs.release

        }
        debug {
            testCoverageEnabled = true
            debuggable true
            signingConfig signingConfigs.debug
        }
    }
}

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

    testCompile ('junit:junit:4.12')
    testCompile ('org.apache.maven:maven-ant-tasks:2.1.3')
    testCompile ('org.robolectric:robolectric:3.0')
    testCompile ('org.robolectric:shadows-support-v4:3.0')
}

sourceSets {
    unitTest {
        java.srcDirs = ['src/test/java']
        resources.srcDirs = ['src/test/resources']
    }
}

ClassLoader getClassLoader() {
    List urls = sourceSets.test.runtimeClasspath.collect {
        it.toURI().toURL()
    }
    return URLClassLoader.newInstance( urls as URL[] )
}    

/**
 *  Filters out files that have specific annotation
 * @param map - map of things to filter
 * @return - list of acceptable files after filter
 */
List annotationFilter( Map map ) {
   map.prefix = map?.prefix ?: '' // prefix: provide convenience for passing in annotation names

    ClassLoader loader = classLoader
    List result

    // filter with annotations
    if( !map.includes ) {
        result = map?.names
    } else {
        result = []
        map?.names.each { name ->
            Class klass = loader.loadClass( name )
            map?.includes.each { annotationName ->
                String fullName = map.prefix + annotationName
                Class annotation = loader.loadClass( fullName ).asSubclass( Annotation )
                if( !klass.isAnnotationPresent( annotation ) ) {
                    result << name
                }
            }
        }
    }

    if( result?.size() == 0 ) result = [ 'no.tests.to.run' ]
    return result
}

/**
 * Gradle task to run only robolectric tests.
 */
task unitTest( type: Test, description: 'Run all junit tests' ) {

    android.sourceSets.main.java.srcDirs.each { dir ->
        def buildDir = dir.getAbsolutePath().split('/')
        buildDir =  (buildDir[0..(buildDir.length - 4)] + ['build',     'classes', 'debug']).join('/')


        sourceSets.unitTest.compileClasspath += files(buildDir)
        sourceSets.unitTest.runtimeClasspath += files(buildDir)
    }

    testClassesDir = sourceSets.unitTest.output.classesDir
    classpath = sourceSets.unitTest.runtimeClasspath

    doLast {
        println "Doing Last"
        List names = testClassNames()
        List filtered = annotationFilter( names: names, includes:   ['testUtils.RobolectricTest'] )
        println 'Running ' + filtered.size() + ' tests:\n' +     filtered*.toString()*.replaceAll('^','\t').join('\n')

       filter {
            setIncludePatterns( filtered as String[] )
        }
    }
}

仅执行特定测试的自定义Gradle任务

在@ alphonzo79答案的基础上,我能够解决问题.

Building on @alphonzo79 answer, I was able to solve the issue.

要知道的事情

  • Android gradle omits common testing features in gradle, like exclude and custom sourceSets.
  • Retention and Target was not helpful. Only categories worked.
  • You don't need a new build type, you only need to change the test option when compiling your own tasks.
  • Don't use this - https://github.com/pkainulainen/gradle-examples/blob/master/integration-tests/build.gradle

完整的答案是创建一个自定义任务,该任务将android testOptions的标志更改为excludeCategories.

The complete answer was to create a custom task that changed a flag for the android testOptions to excludeCategories.

LINK

CODE

def integrationTests = false

...

testOptions {
    unitTests.all {
        useJUnit()
        if (integrationTests.toBoolean()) {
            println "Integration Tests Only for " + it.name
            options {
                excludeCategories 'com.example.reactivemvp.categories.UnitTest'
            }
        } else {
            println "Unit Tests Only for " + it.name
            options {
                excludeCategories 'com.example.reactivemvp.categories.IntegrationTest'
            }
        }
    }
}

...

task integrationTest(
    type: Test,
    description: 'Run integration tests only. Pass in \'-Pintegration=true\'',
    dependsOn: ['testDebugUnitTest', 'clean'] ) {

    //Here for task completion, not actually used since sub task of testDebugUnitTest
    testClassesDir = file("src/integrationTest/java/");
    classpath = files("$System.env.ANDROID_HOME/sources/android-18")

    //
    //Turn on integration testing when argument exists and is true
    //
    if (project.hasProperty('integration')) {
        println integration
        if (integration == 'true') {
            integrationTests = true
        }
    }
  }