improve logging and console output

Author: wakingrufus

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

@@ -4,6 +4,8 @@
 import com.netflix.nebula.archrules.core.Runner;
 import com.tngtech.archunit.core.importer.ClassFileImporter;
 import org.gradle.workers.WorkAction;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import java.io.File;
 import java.io.FileOutputStream;
@@ -12,14 +14,21 @@
 import java.util.ArrayList;
 import java.util.List;
 import java.util.ServiceLoader;
+import java.util.stream.Collectors;
 
 import static com.netflix.nebula.archrules.core.NoClassesMatchedEvent.NO_MATCH_MESSAGE;
 
 public abstract class RunRulesWorkAction implements WorkAction<RunRulesParams> {
+    private static final Logger LOGGER = LoggerFactory.getLogger(RunRulesWorkAction.class);
 
     @Override
     public void execute() {
         ServiceLoader<ArchRulesService> ruleClasses = ServiceLoader.load(ArchRulesService.class);
+        if (LOGGER.isInfoEnabled()) {
+            LOGGER.info("Rule classes detected: {}", ruleClasses.stream()
+                    .map(it -> it.type().getCanonicalName())
+                    .collect(Collectors.joining(",")));
+        }
         final var classesToCheck = new ClassFileImporter()
                 .importPaths(getParameters().getClassesToCheck().getFiles().stream().map(File::toPath).toList());
         final List<RuleResult> violationList = new ArrayList<>();

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

@@ -32,6 +32,7 @@ class ViolationsUtil {
 
         @JvmStatic
         fun printReport(violations: Map<Rule, List<RuleResult>>, output: StyledTextOutput, infoLogging: Boolean) {
+            output.style(StyledTextOutput.Style.Header).println("ArchRule Violation Details:")
             violations
                 .mapValues { it.value.filter { it.rule().priority() != Priority.LOW || infoLogging } }
                 .filter { it.value.isNotEmpty() }
@@ -56,6 +57,7 @@ class ViolationsUtil {
 
         @JvmStatic
         fun printSummary(resultMap: Map<Rule, List<RuleResult>>, output: StyledTextOutput, skipPassing: Boolean) {
+            output.style(StyledTextOutput.Style.Header).println("ArchRule Summary:")
             val indent = 4
             val maxRuleNameLength = resultMap.keys.maxOfOrNull { it.ruleName().length } ?: 1
             resultMap.entries.groupBy { entry -> entry.key.ruleClass() }

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

@@ -33,7 +33,7 @@ internal class ViolationsUtilTest {
     fun `test printSummary empty results`() {
         val output = MockStyledTextOutput()
         ViolationsUtil.printSummary(mapOf(), output, false)
-        assertThat(output.getOutput()).isEmpty()
+        assertThat(output.getOutput()).isEqualTo("ArchRule Summary:\n")
     }
 }