check versions lazily, fixes #2393 (#2400)

apollographql · Jun 30, 2020 · 4657be0 · 4657be0
1 parent d140da0
commit 4657be0
Show file tree

Hide file tree

Showing 2 changed files with 54 additions and 13 deletions.
diff --git a/...lo-gradle-plugin/src/main/kotlin/com/apollographql/apollo/gradle/internal/ApolloPlugin.kt b/...lo-gradle-plugin/src/main/kotlin/com/apollographql/apollo/gradle/internal/ApolloPlugin.kt
@@ -4,6 +4,7 @@ import com.apollographql.apollo.gradle.api.ApolloExtension
 import okhttp3.HttpUrl.Companion.toHttpUrl
 import org.gradle.api.Plugin
 import org.gradle.api.Project
+import org.gradle.api.Task
 import org.gradle.api.artifacts.ConfigurationContainer
 import org.gradle.api.tasks.TaskProvider
 import org.gradle.util.GradleVersion
@@ -47,7 +48,7 @@ open class ApolloPlugin : Plugin<Project> {
       return ret
     }
 
-    private fun registerCompilationUnits(project: Project, apolloExtension: DefaultApolloExtension) {
+    private fun registerCompilationUnits(project: Project, apolloExtension: DefaultApolloExtension, checkVersionsTask: TaskProvider<Task>) {
       val androidExtension = project.extensions.findByName("android")
 
       val apolloVariants = when {
@@ -78,7 +79,7 @@ open class ApolloPlugin : Plugin<Project> {
         }
 
         compilationUnits.forEach { compilationUnit ->
-          val codegenProvider = registerCodeGenTask(project, compilationUnit)
+          val codegenProvider = registerCodeGenTask(project, compilationUnit, checkVersionsTask)
           variantProvider.configure {
             it.dependsOn(codegenProvider)
           }
@@ -109,13 +110,15 @@ open class ApolloPlugin : Plugin<Project> {
       }
     }
 
-    private fun registerCodeGenTask(project: Project, compilationUnit: DefaultCompilationUnit): TaskProvider<ApolloGenerateSourcesTask> {
+    private fun registerCodeGenTask(project: Project, compilationUnit: DefaultCompilationUnit, checkVersionsTask: TaskProvider<Task>): TaskProvider<ApolloGenerateSourcesTask> {
       val taskName = "generate${compilationUnit.name.capitalize()}ApolloSources"
 
       return project.tasks.register(taskName, ApolloGenerateSourcesTask::class.java) {
         it.group = TASK_GROUP
         it.description = "Generate Apollo models for ${compilationUnit.name.capitalize()} GraphQL queries"
 
+        it.dependsOn(checkVersionsTask)
+
         val (compilerParams, graphqlSourceDirectorySet) = compilationUnit.resolveParams(project)
 
         it.graphqlFiles.setFrom(graphqlSourceDirectorySet)
@@ -203,11 +206,10 @@ open class ApolloPlugin : Plugin<Project> {
     }
 
     private fun afterEvaluate(project: Project, apolloExtension: DefaultApolloExtension) {
-      registerCompilationUnits(project, apolloExtension)
+      val checkVersionsTask = registerCheckVersionsTask(project)
+      registerCompilationUnits(project, apolloExtension, checkVersionsTask)
 
       registerDownloadSchemaTasks(project, apolloExtension)
-
-      checkVersions(project)
     }
 
     data class Dep(val name: String, val version: String?)
@@ -223,15 +225,32 @@ open class ApolloPlugin : Plugin<Project> {
       }
     }
 
-    fun checkVersions(project: Project) {
-      val allDeps = getDeps(project.rootProject.buildscript.configurations) +
-          getDeps(project.buildscript.configurations) +
-          getDeps(project.configurations)
+    fun registerCheckVersionsTask(project: Project): TaskProvider<Task> {
+      return project.tasks.register("checkApolloVersions") {
+        val outputFile = project.layout.buildDirectory.file("apollo/versionCheck")
+
+        val allDeps = (
+            getDeps(project.rootProject.buildscript.configurations) +
+                getDeps(project.buildscript.configurations) +
+                getDeps(project.configurations)
+            )
+
+        val allVersions = allDeps.mapNotNull { it.version }.distinct().sorted()
+        it.inputs.property("allVersions", allVersions)
+        it.outputs.file(outputFile)
 
-      check(allDeps.mapNotNull { it.version }.distinct().size <= 1) {
-        val found = allDeps.map { "${it.name}:${it.version}" }.distinct().joinToString("\n")
-        "All apollo versions should be the same. Found:\n$found"
+        it.doLast {
+          check(allVersions.size <= 1) {
+            val found = allDeps.map { "${it.name}:${it.version}" }.distinct().joinToString("\n")
+            "All apollo versions should be the same. Found:\n$found"
+          }
+
+          val version = allVersions.firstOrNull()
+          outputFile.get().asFile.parentFile.mkdirs()
+          outputFile.get().asFile.writeText("All versions are consistent: $version")
+        }
       }
+
     }
   }
 

diff --git a/...-gradle-plugin/src/test/kotlin/com/apollographql/apollo/gradle/test/ConfigurationTests.kt b/...-gradle-plugin/src/test/kotlin/com/apollographql/apollo/gradle/test/ConfigurationTests.kt
@@ -433,6 +433,28 @@ class ConfigurationTests {
     }
   }
 
+  @Test
+  fun `changing a dependency checks versions again`() {
+    withSimpleProject { dir ->
+
+      TestUtils.executeTaskAndAssertSuccess(":generateApolloSources", dir)
+
+      val result = TestUtils.executeTask("checkApolloVersions", dir)
+      assert(result.task(":checkApolloVersions")?.outcome == TaskOutcome.UP_TO_DATE)
+
+      File(dir, "build.gradle").replaceInText("dep.apollo.api", "\"com.apollographql.apollo:apollo-api:1.2.0\"")
+
+      var exception: Exception? = null
+      try {
+        TestUtils.executeTask("checkApolloVersions", dir)
+      } catch (e: UnexpectedBuildFailure) {
+        exception = e
+        assertThat(e.message, containsString("All apollo versions should be the same"))
+      }
+      assertNotNull(exception)
+    }
+  }
+
   @Test
   fun `versions are enforced even in rootProject`() {
     withTestProject("mismatchedVersions") { dir ->