Attach check task to lifecycle tasks depending on configuration

Author: rubensousa

build.gradle.kts

@@ -1,5 +1,5 @@
 plugins {
-    alias(libs.plugins.jetbrains.kotlin.jvm) apply false
+    alias(libs.plugins.kotlin.jvm) apply false
     alias(libs.plugins.kover) apply false
     alias(libs.plugins.maven.publish) apply false
 }

gradle.properties

@@ -1,25 +1,6 @@
-# Project-wide Gradle settings.
-# IDE (e.g. Android Studio) users:
-# Gradle settings configured through the IDE *will override*
-# any settings specified in this file.
-# For more details on how to configure your build environment visit
-# http://www.gradle.org/docs/current/userguide/build_environment.html
-# Specifies the JVM arguments used for the daemon process.
-# The setting is particularly useful for tweaking memory settings.
-org.gradle.jvmargs=-Xmx2048m -Dfile.encoding=UTF-8
-# When configured, Gradle will run in incubating parallel mode.
-# This option should only be used with decoupled projects. For more details, visit
-# https://developer.android.com/r/tools/gradle-multi-project-decoupled-projects
-# org.gradle.parallel=true
-# AndroidX package structure to make it clearer which packages are bundled with the
-# Android operating system, and which are packaged with your app's APK
-# https://developer.android.com/topic/libraries/support-library/androidx-rn
+org.gradle.jvmargs=-Xmx4096m -Dfile.encoding=UTF-8 -XX:MetaspaceSize=1g
 android.useAndroidX=true
-# Kotlin code style for this project: "official" or "obsolete":
 kotlin.code.style=official
-# Enables namespacing of each library's R class so that its R class includes only the
-# resources declared in the library itself and none from the library's dependencies,
-# thereby reducing the size of the R class for that library
 android.nonTransitiveRClass=true
 
 POM_NAME=ProjectGuard Plugin

gradle/libs.versions.toml

@@ -21,11 +21,12 @@ kotlin-stdlib = { group = "org.jetbrains.kotlin", name = "kotlin-stdlib", versio
 runner = { group = "androidx.test", name = "runner", version.ref = "runner" }
 core = { group = "androidx.test", name = "core", version.ref = "core" }
 ext-junit = { group = "androidx.test.ext", name = "junit", version.ref = "junitVersion" }
+gradle-android = { group = "com.android.tools.build", name = "gradle", version.ref = "agp" }
 
 [plugins]
 android-application = { id = "com.android.application", version.ref = "agp" }
 kotlin-android = { id = "org.jetbrains.kotlin.android", version.ref = "kotlin" }
-jetbrains-kotlin-jvm = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlin" }
+kotlin-jvm = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlin" }
 maven-publish = { id = "com.vanniktech.maven.publish", version = "0.36.0" }
 projectguard = { id = "com.rubensousa.projectguard", version = "unspecified" }
 kotlin-serialization = { id = "org.jetbrains.kotlin.plugin.serialization", version.ref = "kotlin" }

projectguard/build.gradle.kts

@@ -42,6 +42,7 @@ dependencies {
     implementation(libs.kotlin.serialization.json)
     implementation(libs.jackson.yaml)
     implementation(libs.jackson.kotlin)
+    implementation(libs.gradle.android)
     testImplementation(gradleTestKit())
     testImplementation(libs.kotlin.test)
     testImplementation(libs.truth)

projectguard/src/main/kotlin/com/rubensousa/projectguard/plugin/ProjectGuardPlugin.kt

@@ -16,6 +16,7 @@
 
 package com.rubensousa.projectguard.plugin
 
+import com.android.build.api.variant.AndroidComponentsExtension
 import com.rubensousa.projectguard.plugin.internal.DependencyGraphBuilder
 import com.rubensousa.projectguard.plugin.internal.task.TaskAggregateDependencyDump
 import com.rubensousa.projectguard.plugin.internal.task.TaskAggregateRestrictionDump
@@ -53,6 +54,13 @@ class ProjectGuardPlugin : Plugin<Project> {
     private val dependenciesFilePath = "reports/$pluginId/dependencies.json"
     private val jsonReportFilePath = "reports/$pluginId/report.json"
     private val graphBuilder = DependencyGraphBuilder()
+    private val androidPluginIds = listOf(
+        "com.android.test",
+        "com.android.application",
+        "com.android.library",
+        "com.android.dynamic-feature",
+        "com.android.kotlin.multiplatform.library"
+    )
 
     override fun apply(target: Project) {
         val rootProject = target.rootProject
@@ -71,6 +79,8 @@ class ProjectGuardPlugin : Plugin<Project> {
             individualModuleTasks.add(moduleTasks)
             setupModuleTasks(
                 aggregationTasks = aggregationTasks,
+                project = targetProject,
+                extension = extension,
                 moduleTasks = moduleTasks
             )
         }
@@ -93,6 +103,8 @@ class ProjectGuardPlugin : Plugin<Project> {
     }
 
     private fun setupModuleTasks(
+        project: Project,
+        extension: ProjectGuardExtension,
         aggregationTasks: AggregationTasks,
         moduleTasks: ModuleTasks,
     ) {
@@ -109,6 +121,43 @@ class ProjectGuardPlugin : Plugin<Project> {
             outputDir.set(project.layout.buildDirectory.dir(htmlAggregateReportFilePath))
             reportFilePath.set(getProjectReportFilePath(project))
         }
+
+        project.afterEvaluate {
+            val options = extension.getSpec().options
+            options.lifecycleTask?.let { lifecycleTask ->
+                if (lifecycleTask == LifecycleTask.ASSEMBLE) {
+                    attachToAndroidAssembleTasks(project, moduleTasks.check)
+                    project.tasks.findByName("assemble")?.dependsOn(moduleTasks.check)
+                } else {
+                    project.tasks.findByName("check")?.dependsOn(moduleTasks.check)
+                }
+            }
+        }
+    }
+
+    private fun attachToAndroidAssembleTasks(
+        project: Project,
+        checkTask: TaskProvider<TaskCheck>,
+    ) {
+        androidPluginIds.forEach { pluginId ->
+            if (project.plugins.hasPlugin(pluginId)) {
+                val androidComponents = project.extensions.getByType(AndroidComponentsExtension::class.java)
+                val variantTasks = mutableListOf<String>()
+                androidComponents.onVariants { variant ->
+                    val variantName = capitalizeVariantName(variant.name)
+                    variantTasks.add("assemble$variantName")
+                }
+                project.afterEvaluate {
+                    variantTasks.forEach { variantTask ->
+                        project.tasks.findByName(variantTask)?.dependsOn(checkTask)
+                    }
+                }
+            }
+        }
+    }
+
+    private fun capitalizeVariantName(name: String): String {
+        return name.substring(0, 1).uppercase() + name.substring(1, name.length)
     }
 
     private fun setupAggregationTasks(

projectguard/src/test/kotlin/com/rubensousa/projectguard/plugin/GroovyIntegrationTest.kt

@@ -71,7 +71,7 @@ class GroovyIntegrationTest {
         pluginRunner.addDependency(from = module, to = dependency)
 
         // then
-        pluginRunner.assertCheckFails(module)
+        pluginRunner.assertProjectGuardCheckFails(module)
         pluginRunner.assertTaskOutputContains(reason)
     }
 
@@ -96,7 +96,7 @@ class GroovyIntegrationTest {
         pluginRunner.addDependency(from = module, to = dependency)
 
         // then
-        pluginRunner.assertCheckSucceeds(module)
+        pluginRunner.assertProjectGuardCheckSucceeds(module)
         pluginRunner.assertTaskOutputContains("No fatal matches found")
     }
 

projectguard/src/test/kotlin/com/rubensousa/projectguard/plugin/PluginIntegrationTest.kt

@@ -35,6 +35,7 @@ class PluginIntegrationTest {
         rootBuildFile = temporaryFolder.newFile("build.gradle.kts")
         rootBuildFile.writeText(
             """
+            import com.rubensousa.projectguard.plugin.LifecycleTask
             plugins {
                 id("com.rubensousa.projectguard") apply true
             }
@@ -69,7 +70,7 @@ class PluginIntegrationTest {
         pluginRunner.addDependency(from = "libraryA", to = "libraryB")
 
         // then
-        pluginRunner.assertCheckFails("consumer")
+        pluginRunner.assertProjectGuardCheckFails("consumer")
     }
 
     @Test
@@ -90,7 +91,7 @@ class PluginIntegrationTest {
         pluginRunner.addDependency(from = "consumer", to = "library")
 
         // then
-        pluginRunner.assertCheckFails("consumer")
+        pluginRunner.assertProjectGuardCheckFails("consumer")
     }
 
     @Test
@@ -111,7 +112,53 @@ class PluginIntegrationTest {
         pluginRunner.addDependency(from = "consumer", to = "library")
 
         // then
-        pluginRunner.assertCheckSucceeds("consumer")
+        pluginRunner.assertProjectGuardCheckSucceeds("consumer")
+    }
+
+    @Test
+    fun `assemble fails if there are restrictions and plugin is configured to attach to lifecycle task`() {
+        pluginRunner.createModule("consumer")
+        pluginRunner.createModule("library")
+
+        rootBuildFile.appendText(
+            """
+            projectGuard {
+                options {
+                    lifecycleTask = LifecycleTask.ASSEMBLE
+                }
+                restrictDependency(":library")
+            }
+            """.trimIndent()
+        )
+
+        // when
+        pluginRunner.addDependency(from = "consumer", to = "library")
+
+        // then
+        pluginRunner.assertAssembleTaskFails("consumer")
+    }
+
+    @Test
+    fun `check fails if there are restrictions and plugin is configured to attach to lifecycle task`() {
+        pluginRunner.createModule("consumer")
+        pluginRunner.createModule("library")
+
+        rootBuildFile.appendText(
+            """
+            projectGuard {
+                options {
+                    lifecycleTask = LifecycleTask.CHECK
+                }
+                restrictDependency(":library")
+            }
+            """.trimIndent()
+        )
+
+        // when
+        pluginRunner.addDependency(from = "consumer", to = "library")
+
+        // then
+        pluginRunner.assertCheckTaskFails("consumer")
     }
 
 }

projectguard/src/test/kotlin/com/rubensousa/projectguard/plugin/PluginRunner.kt

@@ -41,20 +41,32 @@ class PluginRunner(
         settingsFile.appendText("\ninclude(\":$name\")")
     }
 
-    fun assertCheckFails(module: String) {
-        val task = createCheckTask(module)
+    fun assertProjectGuardCheckFails(module: String) {
+        val task = getProjectGuardCheckTask(module)
         val result = gradleRunner.withArguments(task).buildAndFail()
         assertThat(result.task(task)!!.outcome).isEqualTo(TaskOutcome.FAILED)
         lastResult = result
     }
 
-    fun assertCheckSucceeds(module: String) {
-        val task = createCheckTask(module)
+    fun assertProjectGuardCheckSucceeds(module: String) {
+        val task = getProjectGuardCheckTask(module)
         val result = gradleRunner.withArguments(task).build()
         assertThat(result.task(task)!!.outcome).isEqualTo(TaskOutcome.SUCCESS)
         lastResult = result
     }
 
+    fun assertAssembleTaskFails(module: String) {
+        val result = gradleRunner.withArguments(":$module:assemble").buildAndFail()
+        assertThat(result.task(getProjectGuardCheckTask(module))!!.outcome).isEqualTo(TaskOutcome.FAILED)
+        lastResult = result
+    }
+
+    fun assertCheckTaskFails(module: String) {
+        val result = gradleRunner.withArguments(":$module:check").buildAndFail()
+        assertThat(result.task(getProjectGuardCheckTask(module))!!.outcome).isEqualTo(TaskOutcome.FAILED)
+        lastResult = result
+    }
+
     fun assertTaskOutputContains(message: String) {
         assertThat(lastResult!!.output).contains(message)
     }
@@ -75,7 +87,7 @@ class PluginRunner(
         )
     }
 
-    private fun createCheckTask(module: String): String {
+    private fun getProjectGuardCheckTask(module: String): String {
         return ":$module:projectGuardCheck"
     }
 

sample/build.gradle.kts

@@ -1,8 +1,10 @@
+import com.rubensousa.projectguard.plugin.LifecycleTask
+
 // Top-level build file where you can add configuration options common to all sub-projects/modules.
 plugins {
     alias(libs.plugins.android.application) apply false
     alias(libs.plugins.kotlin.android) apply false
-    alias(libs.plugins.jetbrains.kotlin.jvm) apply false
+    alias(libs.plugins.kotlin.jvm) apply false
     alias(libs.plugins.maven.publish) apply false
     alias(libs.plugins.android.library) apply false
     alias(libs.plugins.projectguard) apply true
@@ -12,6 +14,13 @@ plugins {
 }
 
 projectGuard {
+    /**
+     * Fail the project build without running the dedicated `projectGuardCheck`
+     */
+    options {
+        lifecycleTask = LifecycleTask.ASSEMBLE
+    }
+
     report {
         showLibrariesInGraph = true
     }