add setting for console report details threshold

Author: wakingrufus

README.md

@@ -156,6 +156,14 @@ archRules {
 }
 ```
 
+You can set the threshold for filtering details in the console report. For example, to only see details for HIGH priority failures:
+```kotlin
+archRules {
+    consoleDetailsThreshold("HIGH")
+}
+```
+The default threshold is MEDIUM.
+
 #### Configuring which code is tested
 
 You can skip running rules on a specific source set:

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

@@ -17,6 +17,7 @@ abstract class ArchrulesExtension {
     abstract val sourceSetsToSkip: ListProperty<String>
 
     abstract val failureThreshold: Property<Priority>
+    abstract val consoleDetailsThreshold: Property<Priority>
 
     /**
      * Add a source set to the list of sourcesets to skip
@@ -32,4 +33,12 @@ abstract class ArchrulesExtension {
     fun failureThreshold(priority: String) {
         failureThreshold.set(Priority.valueOf(priority))
     }
+
+    fun consoleDetailsThreshold(priority: Priority) {
+        consoleDetailsThreshold.set(priority)
+    }
+
+    fun consoleDetailsThreshold(priority: String) {
+        consoleDetailsThreshold.set(Priority.valueOf(priority))
+    }
 }

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

@@ -1,6 +1,7 @@
 package com.netflix.nebula.archrules.gradle
 
 import com.netflix.nebula.archrules.gradle.ArchRuleAttribute.ARCH_RULES
+import com.tngtech.archunit.lang.Priority
 import org.gradle.api.Plugin
 import org.gradle.api.Project
 import org.gradle.api.attributes.Bundling
@@ -32,6 +33,7 @@ class ArchrulesRunnerPlugin : Plugin<Project> {
             archRulesExt.consoleReportEnabled.convention(true)
             archRulesExt.skipPassingSummaries.convention(false)
             archRulesExt.sourceSetsToSkip.add("archRulesTest")
+            archRulesExt.consoleDetailsThreshold.convention(Priority.MEDIUM)
             project.extensions.getByType<JavaPluginExtension>().sourceSets
                 .configureEach {
                     project.configureCheckTaskForSourceSet(this, archRulesExt)
@@ -46,10 +48,11 @@ class ArchrulesRunnerPlugin : Plugin<Project> {
             }
 
             val consoleReportTask = project.tasks.register<PrintConsoleReportTask>("archRulesConsoleReport") {
-                getDataFiles().set(
+                dataFiles.set(
                     project.provider { (project.tasks.withType<CheckRulesTask>().flatMap { it.outputs.files }) }
                 )
                 summaryForPassingDisabled.set(archRulesExt.skipPassingSummaries)
+                detailsThreshold.set(archRulesExt.consoleDetailsThreshold)
                 dependsOn(checkTasks)
                 onlyIf { archRulesExt.consoleReportEnabled.get() }
             }

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

@@ -0,0 +1,61 @@
+package com.netflix.nebula.archrules.gradle
+
+import com.tngtech.archunit.lang.Priority
+import org.gradle.api.DefaultTask
+import org.gradle.api.provider.ListProperty
+import org.gradle.api.provider.Property
+import org.gradle.api.tasks.*
+import org.gradle.internal.logging.text.StyledTextOutput
+import org.gradle.internal.logging.text.StyledTextOutputFactory
+import org.gradle.kotlin.dsl.support.get
+import java.io.File
+
+/**
+ * Prints summary and detail information about {@link RuleResult}s to the console
+ */
+@UntrackedTask(because = "Provides console feedback to the user")
+abstract class PrintConsoleReportTask : DefaultTask() {
+
+    /**
+     * The data files to read in. These files should container binary data representing {@link RuleResult}s
+     * @return all data files to process
+     */
+    @get:InputFiles
+    @get:PathSensitive(PathSensitivity.RELATIVE)
+    abstract val dataFiles: ListProperty<File>
+
+    /**
+     * if summary lines for passing rules should print
+     */
+    @get:Input
+    abstract val summaryForPassingDisabled: Property<Boolean>
+
+    /**
+     * the priority threshold for printing failure details
+     */
+    @get:Input
+    @get:Optional
+    abstract val detailsThreshold: Property<Priority>
+
+    @TaskAction
+    fun printReport() {
+        val consoleOutput = services.get<StyledTextOutputFactory>().create("archrules")
+        val list = dataFiles.get()
+            .filter(File::exists)
+            .flatMap { ViolationsUtil.readDetails(it) }
+            .toList()
+        val byRule = ViolationsUtil.consolidatedFailures(list)
+        ViolationsUtil.printSummary(byRule, consoleOutput, summaryForPassingDisabled.get())
+        if (list.any {
+                it.status() == RuleResultStatus.FAIL
+                        && !it.rule().priority().meetsThreshold(detailsThreshold.orNull)
+                        && !logger.isInfoEnabled
+            }) {
+            consoleOutput.style(StyledTextOutput.Style.Header)
+                .text("Note: ")
+                .style(StyledTextOutput.Style.Normal)
+                .println("In order to see details of ${detailsThreshold.orElse(Priority.LOW)} and lower priority rules, run build with --info")
+        }
+        ViolationsUtil.printReport(byRule, consoleOutput, detailsThreshold.orNull, logger.isInfoEnabled)
+    }
+}

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

@@ -0,0 +1,12 @@
+package com.netflix.nebula.archrules.gradle
+
+import com.tngtech.archunit.lang.Priority
+
+fun Priority.meetsThreshold(threshold: Priority?): Boolean {
+    return when (threshold) {
+        null -> true
+        Priority.LOW -> true
+        Priority.MEDIUM -> this != Priority.LOW
+        Priority.HIGH -> this == Priority.HIGH
+    }
+}

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

@@ -31,10 +31,13 @@ class ViolationsUtil {
         }
 
         @JvmStatic
-        fun printReport(violations: Map<Rule, List<RuleResult>>, output: StyledTextOutput, infoLogging: Boolean) {
+        fun printReport(violations: Map<Rule, List<RuleResult>>,
+                        output: StyledTextOutput,
+                        priorityThreshold: Priority?,
+                        infoLogging: Boolean) {
             output.style(StyledTextOutput.Style.Header).println("ArchRule Violation Details:")
             violations
-                .mapValues { it.value.filter { it.rule().priority() != Priority.LOW || infoLogging } }
+                .mapValues { it.value.filter { it.rule().priority().meetsThreshold(priorityThreshold) || infoLogging } }
                 .filter { it.value.isNotEmpty() }
                 .forEach { (rule, ruleViolations) ->
                     val style = when (rule.priority()) {