Add tests for per-task configuration (#115)

Author: 9999years

.travis.yml

@@ -2,6 +2,16 @@ language: java
 
 jdk: openjdk8
 
-install: true
+install: skip
 
-script: ./gradlew clean build
+# https://guides.gradle.org/executing-gradle-builds-on-travisci/#enable_caching_of_downloaded_artifacts
+before_cache:
+  - rm -f  $HOME/.gradle/caches/modules-2/modules-2.lock
+  - rm -fr $HOME/.gradle/caches/*/plugin-resolution/
+
+cache:
+  directories:
+    - $HOME/.gradle/caches/
+    - $HOME/.gradle/wrapper/
+
+script: ./gradlew build --info --stacktrace --parallel

README.md

@@ -12,7 +12,7 @@ Add the following to your `build.gradle` file:
 ```groovy
 plugins {
     // Checker Framework pluggable type-checking
-    id 'org.checkerframework' version '0.5.6'
+    id 'org.checkerframework' version '0.5.7'
 }
 
 apply plugin: 'org.checkerframework'
@@ -80,7 +80,7 @@ the definitions of the custom qualifiers.
 
 ### Specifying a Checker Framework version
 
-Version 0.5.6 of this plugin uses Checker Framework version 3.5.0 by default.
+Version 0.5.7 of this plugin uses Checker Framework version 3.5.0 by default.
 Anytime you upgrade to a newer version of this plugin,
 it might use a different version of the Checker Framework.
 
@@ -181,7 +181,7 @@ plugin to the top-level project. For example:
 
 ```groovy
 plugins {
-  id 'org.checkerframework' version '0.5.6' apply false
+  id 'org.checkerframework' version '0.5.7' apply false
 }
 
 subprojects { subproject ->
@@ -224,7 +224,7 @@ plugins {
   id "net.ltgt.errorprone" version "1.1.1" apply false
   // To do Checker Framework pluggable type-checking (and disable Error Prone), run:
   // ./gradlew compileJava -PuseCheckerFramework=true
-  id 'org.checkerframework' version '0.5.6' apply false
+  id 'org.checkerframework' version '0.5.7' apply false
 }
 
 if (!project.hasProperty("useCheckerFramework")) {

build.gradle

@@ -32,7 +32,7 @@ dependencies {
 }
 
 group 'org.checkerframework'
-version '0.5.6'
+version '0.5.7'
 
 gradlePlugin {
     plugins {

gradle/compile.gradle

@@ -31,8 +31,10 @@ tasks.withType(Test) {
     showCauses true
     showExceptions true
     showStackTraces true
-    events 'failed', 'skipped'
+    events 'failed', 'skipped', 'started', 'passed'
   }
+
+  maxParallelForks = 32
 }
 
 tasks.withType(Groovydoc) {

settings.gradle

@@ -2,7 +2,7 @@
  * This file was generated by the Gradle 'init' task.
  *
  * The settings file is used to specify which projects to include in your build.
- * 
+ *
  * Detailed information about configuring a multi-project build in Gradle can be found
  * in the user guide at https://docs.gradle.org/5.0/userguide/multi_project_builds.html
  */

src/main/groovy/org/checkerframework/gradle/plugin/CheckerFrameworkPlugin.groovy

@@ -1,9 +1,11 @@
 package org.checkerframework.gradle.plugin
 
+import org.gradle.api.Task
 import org.gradle.api.artifacts.DependencyResolutionListener
 import org.gradle.api.artifacts.ResolvableDependencies
 import org.gradle.api.internal.artifacts.dependencies.DefaultExternalModuleDependency
 import org.gradle.api.internal.artifacts.dependencies.DefaultSelfResolvingDependency
+import org.gradle.util.GradleVersion
 
 import java.util.jar.JarFile
 
@@ -49,17 +51,40 @@ final class CheckerFrameworkPlugin implements Plugin<Project> {
    */
   private final static def manifestLocation = "/checkerframework/"
 
+  /**
+   * Configure each task in {@code project} with the given {@code taskType}.
+   * <p>
+   * We prefer to configure with {@link
+   * org.gradle.api.tasks.TaskCollection#configureEach(org.gradle.api.Action)}
+   * rather than {@link
+   * org.gradle.api.tasks.TaskCollection#all(org.gradle.api.Action)}, but {@code
+   * configureEach} is only available on Gradle 4.9 and newer, so this method
+   * dynamically picks the better candidate based on the current Gradle version.
+   * <p>
+   * See also: <a href="https://docs.gradle.org/current/userguide/task_configuration_avoidance.html">
+   * Gradle documentation: Task Configuration Avoidance</a>
+   */
+  private static <S extends Task> void configureTasks(Project project, Class<S> taskType, Action<? super S> configure) {
+    if (GradleVersion.current() < GradleVersion.version("4.9")) {
+      project.tasks.withType(taskType).all configure
+    } else {
+      project.tasks.withType(taskType).configureEach configure
+    }
+  }
+
   @Override void apply(Project project) {
     // Either get an existing CF config, or create a new one if none exists
     CheckerFrameworkExtension userConfig = project.extensions.findByType(CheckerFrameworkExtension.class)?:
             project.extensions.create("checkerFramework", CheckerFrameworkExtension)
     boolean applied = false
     (ANDROID_IDS + "java").each { id ->
       project.pluginManager.withPlugin(id) {
-        LOG.info('Found plugin {}, applying checker compiler options.', id)
-        configureProject(project, userConfig)
-        applyToProject(project, userConfig)
-        if (!applied) applied = true
+        if (!applied) {
+          LOG.info('Found plugin {}, applying checker compiler options.', id)
+          configureProject(project, userConfig)
+          applyToProject(project, userConfig)
+          applied = true
+        }
       }
     }
 
@@ -215,10 +240,20 @@ final class CheckerFrameworkPlugin implements Plugin<Project> {
       void afterResolve(ResolvableDependencies resolvableDependencies) {}
     })
 
-    project.tasks.withType(AbstractCompile).all { AbstractCompile compile ->
-      CheckerFrameworkTaskExtension checkerExtension =
-          compile.extensions.create("checkerFramework", CheckerFrameworkTaskExtension)
-    }
+    configureTasks(project, AbstractCompile, { AbstractCompile compile ->
+      def ext = compile.extensions.findByName("checkerFramework")
+      if (ext == null) {
+        LOG.info("Adding checkerFramework extension to task {}", compile.name)
+        compile.extensions.create("checkerFramework", CheckerFrameworkTaskExtension)
+      } else if (ext instanceof CheckerFrameworkTaskExtension) {
+        LOG.debug("Task {} in project {} already has checkerFramework added to it;" +
+                " make sure you're applying the org.checkerframework plugin after the Java plugin", compile.name,
+                compile.project)
+      } else {
+        throw new IllegalStateException("Task " + compile.name + " in project " + compile.project +
+            " already has a checkerFramework extension, but it's of an incorrect type " + ext.class)
+      }
+    })
   }
 
   /**
@@ -281,8 +316,7 @@ final class CheckerFrameworkPlugin implements Plugin<Project> {
         }
       } catch (Exception e) {
         versionString = LIBRARY_VERSION
-        LOG.warn("Unable to determine Checker Framework version. Assuming default is being used.")
-        LOG.debug(e)
+        LOG.warn("Unable to determine Checker Framework version. Assuming default is being used: {}", versionString, e.toString())
       }
 
       if (javaSourceVersion.java8 && jvmVersion.isJava8()) {
@@ -297,8 +331,7 @@ final class CheckerFrameworkPlugin implements Plugin<Project> {
           // errorprone javac is required
           needErrorProneJavac = true
           LOG.warn("Defaulting to ErrorProne Javac, because on a Java 8 JVM and" +
-                  " cannot determine exact Checker Framework version.")
-          LOG.debug(e)
+                  " cannot determine exact Checker Framework version.", e)
         }
       }
 
@@ -309,10 +342,17 @@ final class CheckerFrameworkPlugin implements Plugin<Project> {
         createManifestTask.checkers = userConfig.checkers
       }
 
-      project.tasks.withType(AbstractCompile).all { AbstractCompile compile ->
-        if (!compile.extensions.checkerFramework.skipCheckerFramework
-            && compile.hasProperty('options')
-            && !(userConfig.excludeTests && compile.name.toLowerCase().contains("test"))) {
+      configureTasks(project, AbstractCompile, { AbstractCompile compile ->
+        if (compile.extensions.checkerFramework.skipCheckerFramework) {
+          LOG.info("skipping the Checker Framework for task " + compile.name +
+              " because skipCheckerFramework property is set")
+          return
+        }
+        if(userConfig.excludeTests && compile.name.toLowerCase().contains("test")) {
+          LOG.info("skipping the Checker Framework for task {} because excludeTests property is set", compile.name)
+          return
+        }
+        if (compile.hasProperty('options')) {
           compile.options.annotationProcessorPath = compile.options.annotationProcessorPath == null ?
               project.configurations.checkerFramework :
               project.configurations.checkerFramework.plus(compile.options.annotationProcessorPath)
@@ -361,12 +401,12 @@ final class CheckerFrameworkPlugin implements Plugin<Project> {
 
         ANDROID_IDS.each { id ->
           project.plugins.withId(id) {
-            options.bootstrapClasspath = project.files(System.getProperty("sun.boot.class.path")) + options.bootstrapClasspath
+            compile.options.bootstrapClasspath = project.files(System.getProperty("sun.boot.class.path")) + compile.options.bootstrapClasspath
             }
           }
-        options.fork = true
+        compile.options.fork = true
         }
-      }
+      })
     }
   }
 }

src/test/groovy/org/checkerframework/gradle/plugin/CheckerFrameworkPluginSpec.groovy

@@ -2,25 +2,22 @@ package org.checkerframework.gradle.plugin
 
 import org.gradle.testkit.runner.BuildResult
 import org.gradle.testkit.runner.GradleRunner
+import org.gradle.util.GradleVersion
 import spock.lang.Unroll
 import test.BaseSpecification
 
 final class CheckerFrameworkPluginSpec extends BaseSpecification {
   static final List<String> TESTED_GRADLE_VERSIONS = [
     '3.4',
-    '3.5',
     '4.0',
-    '4.1',
-    '4.2',
-    '4.3',
-    '4.4',
-    '4.5',
-    '4.6',
-    '4.7',
     '4.8',
     '4.9',
     '4.10',
     '5.0',
+    '5.5',
+    '6.0',
+    '6.4',
+    '6.5',
   ]
 
   @Unroll def "java project running licenseReport using with gradle #gradleVersion"() {
@@ -115,7 +112,8 @@ final class CheckerFrameworkPluginSpec extends BaseSpecification {
     gradleVersion << TESTED_GRADLE_VERSIONS
   }
 
-  def 'with relevant plugin loaded subsequently, compiler settings are applied'() {
+  @Unroll
+  def 'with relevant plugin loaded subsequently, compiler settings are applied with gradle #gradleVersion'() {
     given:
     buildFile <<
       """
@@ -146,13 +144,14 @@ final class CheckerFrameworkPluginSpec extends BaseSpecification {
     gradleVersion << TESTED_GRADLE_VERSIONS
   }
 
-  def 'with resolved configuration dependencies, compilation settings are still applied'() {
+  @Unroll
+  def 'with resolved configuration dependencies, compilation settings are still applied with gradle #gradleVersion'() {
     given:
     buildFile <<
       """
         plugins {
-          id 'org.checkerframework'
           id 'java'
+          id 'org.checkerframework'
           id 'application'
         }
 
@@ -179,4 +178,82 @@ final class CheckerFrameworkPluginSpec extends BaseSpecification {
     where:
     gradleVersion << TESTED_GRADLE_VERSIONS
   }
+
+  @Unroll
+  def 'skipCheckerFramework can be used to skip checking individual tasks with gradle #gradleVersion'() {
+    given:
+    buildFile << """
+        plugins {
+          id 'java'
+          id 'org.checkerframework'
+          id 'application'
+        }
+
+        repositories {
+          maven {
+            url "${getClass().getResource("/maven/").toURI()}"
+          }
+        }
+
+        tasks.withType(JavaCompile).all {
+          configure {
+            checkerFramework {
+              skipCheckerFramework = true
+            }
+          }
+        }
+      """.stripIndent().trim()
+
+    when:
+    BuildResult result = GradleRunner.create()
+        .withGradleVersion(gradleVersion)
+        .withProjectDir(testProjectDir.root)
+        .withPluginClasspath()
+        .withArguments('--info')
+        .build()
+
+    then:
+    result.
+        output.
+        contains('skipping the Checker Framework for task compileJava because skipCheckerFramework property is set')
+
+    where:
+    gradleVersion << TESTED_GRADLE_VERSIONS
+  }
+
+  @Unroll
+  def 'plugin warns when applying org.checkerframework after java plugin with gradle #gradleVersion'() {
+    given:
+    buildFile << """
+        plugins {
+          id 'org.checkerframework'
+          id 'java'
+        }
+
+        repositories {
+          maven {
+            url "${getClass().getResource("/maven/").toURI()}"
+          }
+        }
+      """.stripIndent().trim()
+
+    when:
+    BuildResult result = GradleRunner.create()
+        .withGradleVersion(gradleVersion)
+        .withProjectDir(testProjectDir.root)
+        .withPluginClasspath()
+        .withArguments('--debug')
+        .build()
+
+    then:
+    result.
+        output.
+        contains("make sure you're applying the org.checkerframework plugin after the Java plugin")
+
+    where:
+    // This particular behavior only shows up on Gradle 6.4+
+    gradleVersion << TESTED_GRADLE_VERSIONS.stream().filter({
+      GradleVersion.version(it) >= GradleVersion.version("6.4")
+    })
+  }
 }