add extension option for skipping running rules in specific source sets

Author: wakingrufus

README.md

@@ -154,6 +154,14 @@ archRules {
 }
 ```
 
+You can skip running rules on a specific source set:
+```kotlin
+archRules {
+    skipSourceSet("test")
+}
+```
+The `archRulesTest` source set is skipped by default.
+
 ## How it works
 
 The Archrules Library plugin produces a separate Jar for the `archRules` sourceset, which is exposed as an alternate variant of the library. It also will automatically generate a `META-INF/services` file which contains a reference for each implementation of `com.netflix.nebula.archrules.core.ArchRulesService` to declare it as a service provider.

nebula-archrules-gradle-plugin/src/main/java/com/netflix/nebula/archrules/gradle/PrintConsoleReportTask.java

@@ -37,6 +37,7 @@ abstract public class PrintConsoleReportTask extends DefaultTask {
     public void printReport() {
         final var consoleOutput = getServices().get(StyledTextOutputFactory.class).create("archrules");
         List<RuleResult> list = getDataFiles().get().stream()
+                .filter(File::exists)
                 .flatMap(it -> ViolationsUtil.readDetails(it).stream())
                 .toList();
         final var byRule = ViolationsUtil.consolidatedFailures(list);

nebula-archrules-gradle-plugin/src/main/java/com/netflix/nebula/archrules/gradle/PrintJsonReportTask.java

@@ -37,6 +37,7 @@ abstract public class PrintJsonReportTask extends DefaultTask {
     @TaskAction
     public void printReport() {
         List<RuleResult> list = getDataFiles().get().stream()
+                .filter(File::exists)
                 .flatMap(it -> ViolationsUtil.readDetails(it).stream())
                 .toList();
 

nebula-archrules-gradle-plugin/src/main/kotlin/com/netflix/nebula/archrules/gradle/ArchrulesExtension.kt

@@ -1,8 +1,24 @@
 package com.netflix.nebula.archrules.gradle
 
+import org.gradle.api.provider.ListProperty
 import org.gradle.api.provider.Property
 
 abstract class ArchrulesExtension {
+    /**
+     * set to false to disable the console report
+     */
     abstract val consoleReportEnabled: Property<Boolean>
+
+    /**
+     * Skip printing lines in the console report summary for passing rules
+     */
     abstract val skipPassingSummaries: Property<Boolean>
+    abstract val sourceSetsToSkip: ListProperty<String>
+
+    /**
+     * Add a source set to the list of sourcesets to skip
+     */
+    fun skipSourceSet(name: String) {
+        sourceSetsToSkip.add(name)
+    }
 }

nebula-archrules-gradle-plugin/src/main/kotlin/com/netflix/nebula/archrules/gradle/ArchrulesRunnerPlugin.kt

@@ -31,9 +31,10 @@ class ArchrulesRunnerPlugin : Plugin<Project> {
             val archRulesExt = project.extensions.create<ArchrulesExtension>("archRules")
             archRulesExt.consoleReportEnabled.convention(true)
             archRulesExt.skipPassingSummaries.convention(false)
+            archRulesExt.sourceSetsToSkip.add("archRulesTest")
             project.extensions.getByType<JavaPluginExtension>().sourceSets
                 .configureEach {
-                    project.configureCheckTaskForSourceSet(this)
+                    project.configureCheckTaskForSourceSet(this, archRulesExt)
                 }
             val checkTasks = project.tasks.withType<CheckRulesTask>()
             val jsonReportTask = project.tasks.register<PrintJsonReportTask>("archRulesJsonReport") {
@@ -60,7 +61,7 @@ class ArchrulesRunnerPlugin : Plugin<Project> {
         }
     }
 
-    fun Project.configureCheckTaskForSourceSet(sourceSet: SourceSet) {
+    fun Project.configureCheckTaskForSourceSet(sourceSet: SourceSet, ext: ArchrulesExtension) {
         val archRulesReportDir = project.layout.buildDirectory.dir("reports/archrules")
         val sourceSetArchRulesRuntime = configurations.resolvable(sourceSet.name + "ArchRulesRuntime") {
             extendsFrom(configurations.getByName(sourceSet.runtimeClasspathConfigurationName))
@@ -79,6 +80,7 @@ class ArchrulesRunnerPlugin : Plugin<Project> {
             })
             sourcesToCheck.from(sourceSet.output.classesDirs)
             dependsOn(project.tasks.named(sourceSet.classesTaskName))
+            onlyIf { !ext.sourceSetsToSkip.get().contains(sourceSet.name) }
         }
     }
 }

nebula-archrules-gradle-plugin/src/test/kotlin/com/netflix/nebula/archrules/gradle/ArchrulesRunnerPluginTest.kt

@@ -380,6 +380,111 @@ archRules {
             .doesNotContain("deprecated  LOW")
     }
 
+    @Test
+    fun `plugin skips archrules library test sourceset by default`() {
+        val runner = testProject(projectDir) {
+            properties {
+                gradleCache(true)
+            }
+            settings {
+                name("consumer")
+            }
+            rootProject {
+                plugins {
+                    id("java")
+                    id("com.netflix.nebula.archrules.runner")
+                    id("com.netflix.nebula.archrules.library")
+                }
+                repositories {
+                    mavenCentral()
+                }
+                dependencies(
+                    """archRules("com.netflix.nebula:archrules-deprecation:0.+")"""
+                )
+                src {
+                    main {
+                        exampleLibraryClass()
+                        exampleDeprecatedUsage()
+                    }
+                    test {
+                        exampleDeprecatedUsage("FailingCodeTest")
+                    }
+                }
+            }
+        }
+
+        val result = runner.run("check", "--stacktrace", "-x", "test")
+
+        assertThat(result.task(":checkArchRulesMain"))
+            .`as`("archRules run for main source set")
+            .hasOutcome(TaskOutcome.SUCCESS, TaskOutcome.FROM_CACHE)
+
+        assertThat(result.task(":checkArchRulesTest"))
+            .`as`("archRules run for test source set")
+            .hasOutcome(TaskOutcome.SUCCESS, TaskOutcome.FROM_CACHE)
+
+        assertThat(result.task(":checkArchRulesArchRulesTest"))
+            .`as`("archRules run for test source set")
+            .hasOutcome(TaskOutcome.SKIPPED)
+
+        assertThat(result)
+            .hasNoMutableStateWarnings()
+            .hasNoDeprecationWarnings()
+    }
+
+    @Test
+    fun `plugin can skip configured source sets`() {
+        val runner = testProject(projectDir) {
+            properties {
+                gradleCache(true)
+            }
+            settings {
+                name("consumer")
+            }
+            rootProject {
+                plugins {
+                    id("java")
+                    id("com.netflix.nebula.archrules.runner")
+                }
+                repositories {
+                    mavenCentral()
+                }
+                dependencies(
+                    """archRules("com.netflix.nebula:archrules-deprecation:0.+")"""
+                )
+                src {
+                    main {
+                        exampleLibraryClass()
+                        exampleDeprecatedUsage()
+                    }
+                    test {
+                        exampleDeprecatedUsage("FailingCodeTest")
+                    }
+                }
+                rawBuildScript("""
+archRules {
+    skipSourceSet("test")
+}      
+"""
+                )
+            }
+        }
+
+        val result = runner.run("check", "--stacktrace", "-x", "test")
+
+        assertThat(result.task(":checkArchRulesMain"))
+            .`as`("archRules run for main source set")
+            .hasOutcome(TaskOutcome.SUCCESS, TaskOutcome.FROM_CACHE)
+
+        assertThat(result.task(":checkArchRulesTest"))
+            .`as`("archRules run for test source set")
+            .hasOutcome(TaskOutcome.SKIPPED)
+
+        assertThat(result)
+            .hasNoMutableStateWarnings()
+            .hasNoDeprecationWarnings()
+    }
+
     fun readDetails(dataFile: File): List<RuleResult> {
         val list: MutableList<RuleResult> = mutableListOf()
         try {