add json report task which will run by default

wakingrufus · wakingrufus · commit 69fac8bd4757 · 2025-11-13T12:42:15.000-06:00
diff --git a/nebula-archrules-gradle-plugin/build.gradle.kts b/nebula-archrules-gradle-plugin/build.gradle.kts
@@ -8,6 +8,7 @@ repositories {
 }
 dependencies {
     implementation(project(":nebula-archrules-core"))
+    implementation("tools.jackson.core:jackson-databind:3.0.2")
     testImplementation("net.javacrumbs.json-unit:json-unit-assertj:5.0.0")
     testImplementation("org.json:json:20250517")
 }
diff --git a/nebula-archrules-gradle-plugin/gradle.lockfile b/nebula-archrules-gradle-plugin/gradle.lockfile
@@ -2,6 +2,7 @@
 # Manual edits can break the build and are not advised.
 # This file is expected to be part of source control.
 cglib:cglib-nodep:3.2.2=integTestRuntimeClasspath,testRuntimeClasspath
+com.fasterxml.jackson.core:jackson-annotations:2.20=compileClasspath,integTestCompileClasspath,integTestRuntimeClasspath,runtimeClasspath,testCompileClasspath,testRuntimeClasspath
 com.jayway.jsonpath:json-path:2.9.0=integTestCompileClasspath,integTestRuntimeClasspath,testCompileClasspath,testRuntimeClasspath
 com.netflix.nebula:nebula-test:11.7.1=integTestCompileClasspath,integTestRuntimeClasspath,testCompileClasspath,testRuntimeClasspath
 com.tngtech.archunit:archunit:1.4.1=compileClasspath,integTestCompileClasspath,integTestRuntimeClasspath,runtimeClasspath,testCompileClasspath,testRuntimeClasspath
@@ -46,4 +47,6 @@ org.objenesis:objenesis:2.4=integTestRuntimeClasspath,testRuntimeClasspath
 org.opentest4j:opentest4j:1.3.0=integTestCompileClasspath,integTestRuntimeClasspath,testCompileClasspath,testRuntimeClasspath
 org.ow2.asm:asm:9.3=integTestRuntimeClasspath,testRuntimeClasspath
 org.slf4j:slf4j-api:2.0.17=compileClasspath,integTestCompileClasspath,integTestRuntimeClasspath,runtimeClasspath,testCompileClasspath,testRuntimeClasspath
+tools.jackson.core:jackson-core:3.0.2=compileClasspath,integTestCompileClasspath,integTestRuntimeClasspath,runtimeClasspath,testCompileClasspath,testRuntimeClasspath
+tools.jackson.core:jackson-databind:3.0.2=compileClasspath,integTestCompileClasspath,integTestRuntimeClasspath,runtimeClasspath,testCompileClasspath,testRuntimeClasspath
 empty=annotationProcessor,integTestAnnotationProcessor,integTestKotlinScriptDefExtensions,kotlinScriptDefExtensions,testAnnotationProcessor,testKotlinScriptDefExtensions
diff --git a/nebula-archrules-gradle-plugin/src/main/java/com/netflix/nebula/archrules/gradle/ArchRuleAttribute.java b/nebula-archrules-gradle-plugin/src/main/java/com/netflix/nebula/archrules/gradle/ArchRuleAttribute.java
@@ -4,8 +4,19 @@
 import org.gradle.api.attributes.Attribute;
 import org.jspecify.annotations.NonNull;
 
+/**
+ * Attribute used to denote an archrules library, and to resolve archrules variants
+ */
 public interface ArchRuleAttribute extends Named {
+
+    /**
+     * Attribute used to denote an archrules library, and to resolve archrules variants
+     */
     Attribute<@NonNull ArchRuleAttribute> ARCH_RULES_ATTRIBUTE =
             Attribute.of("com.netflix.nebula.archrules", ArchRuleAttribute.class);
+
+    /**
+     * The only recognized value of this attribute
+     */
     String ARCH_RULES = "arch-rules";
 }
diff --git a/nebula-archrules-gradle-plugin/src/main/java/com/netflix/nebula/archrules/gradle/PrintJsonReportTask.java b/nebula-archrules-gradle-plugin/src/main/java/com/netflix/nebula/archrules/gradle/PrintJsonReportTask.java
@@ -0,0 +1,49 @@
+package com.netflix.nebula.archrules.gradle;
+
+import org.gradle.api.DefaultTask;
+import org.gradle.api.provider.ListProperty;
+import org.gradle.api.provider.Property;
+import org.gradle.api.tasks.*;
+import org.jspecify.annotations.NonNull;
+import tools.jackson.databind.json.JsonMapper;
+
+import java.io.File;
+import java.util.List;
+
+/**
+ * Produces a JSON report of all ArchRules failures
+ */
+@CacheableTask
+abstract public class PrintJsonReportTask extends DefaultTask {
+
+    /**
+     * The data files to read in. These files should container binary data representing {@link RuleResult}s
+     * @return all data files to process
+     */
+    @InputFiles
+    @PathSensitive(PathSensitivity.RELATIVE)
+    abstract public ListProperty<@NonNull File> getDataFiles();
+
+    /**
+     * File to output JSON to
+     * @return file for output
+     */
+    @OutputFile
+    abstract public Property<@NonNull File> getJsonReportFile();
+
+    /**
+     * The action for this task
+     */
+    @TaskAction
+    public void printReport() {
+        List<RuleResult> list = getDataFiles().get().stream()
+                .flatMap(it -> ViolationsUtil.readDetails(it).stream())
+                .toList();
+
+        final var report = new JsonReportRoot(list);
+        new JsonMapper().writeValue(getJsonReportFile().get(), report);
+    }
+
+    record JsonReportRoot(List<RuleResult> violations) {
+    }
+}
diff --git a/nebula-archrules-gradle-plugin/src/main/kotlin/com/netflix/nebula/archrules/gradle/ArchrulesRunnerPlugin.kt b/nebula-archrules-gradle-plugin/src/main/kotlin/com/netflix/nebula/archrules/gradle/ArchrulesRunnerPlugin.kt
@@ -69,8 +69,20 @@ class ArchrulesRunnerPlugin : Plugin<Project> {
                         }
                     checkTask
                 }
+
+            val dataFiles = checkTasks.stream()
+                .map { it.get().dataFile.get() }
+                .toList()
+
+            val jsonReportTask = project.tasks.register<PrintJsonReportTask>("archRulesJsonReport") {
+                getDataFiles().set(dataFiles)
+                getJsonReportFile().set(archRulesReportDir.map { it.file("report.json").asFile })
+                dependsOn(checkTasks)
+            }
+
             project.tasks.named("check") {
                 dependsOn(checkTasks)
+                finalizedBy(jsonReportTask)
             }
         }
     }
diff --git a/nebula-archrules-gradle-plugin/src/main/kotlin/com/netflix/nebula/archrules/gradle/ViolationsUtil.kt b/nebula-archrules-gradle-plugin/src/main/kotlin/com/netflix/nebula/archrules/gradle/ViolationsUtil.kt
@@ -0,0 +1,28 @@
+package com.netflix.nebula.archrules.gradle
+
+import java.io.File
+import java.io.FileInputStream
+import java.io.IOException
+import java.io.ObjectInputStream
+
+class ViolationsUtil {
+    companion object {
+        @JvmStatic
+        fun readDetails(dataFile: File): List<RuleResult> {
+            val list: MutableList<RuleResult> = mutableListOf()
+            try {
+                ObjectInputStream(FileInputStream(dataFile)).use { objectInputStream ->
+                    val numObjects = objectInputStream.readInt()
+                    repeat(numObjects) {
+                        list.add(objectInputStream.readObject() as RuleResult)
+                    }
+                }
+            } catch (e: IOException) {
+                throw RuntimeException(e)
+            } catch (e: ClassNotFoundException) {
+                throw RuntimeException(e)
+            }
+            return list
+        }
+    }
+}
diff --git a/nebula-archrules-gradle-plugin/src/test/kotlin/com/netflix/nebula/archrules/gradle/ArchrulesLibraryPluginTest.kt b/nebula-archrules-gradle-plugin/src/test/kotlin/com/netflix/nebula/archrules/gradle/ArchrulesLibraryPluginTest.kt
@@ -29,6 +29,9 @@ class ArchrulesLibraryPluginTest {
     @Test
     fun `plugin produces maven publication`() {
         val runner = testProject(projectDir) {
+            properties {
+                gradleCache(true)
+            }
             settings {
                 name("library-with-rules")
             }
@@ -65,7 +68,7 @@ class ArchrulesLibraryPluginTest {
 
         assertThat(result.task(":compileArchRulesJava"))
             .`as`("compile task runs for the archRules source set")
-            .hasOutcome(TaskOutcome.SUCCESS)
+            .hasOutcome(TaskOutcome.SUCCESS, TaskOutcome.FROM_CACHE)
         assertThat(result.task(":archRulesJar"))
             .hasOutcome(TaskOutcome.SUCCESS)
         assertThat(result)
@@ -102,6 +105,9 @@ println(moduleMetadataJson)
     @Test
     fun `plugin sets up tests for rules`() {
         val runner = testProject(projectDir) {
+            properties {
+                gradleCache(true)
+            }
             settings {
                 name("library-with-rules")
             }
diff --git a/nebula-archrules-gradle-plugin/src/test/kotlin/com/netflix/nebula/archrules/gradle/ArchrulesRunnerPluginTest.kt b/nebula-archrules-gradle-plugin/src/test/kotlin/com/netflix/nebula/archrules/gradle/ArchrulesRunnerPluginTest.kt
@@ -3,8 +3,10 @@ package com.netflix.nebula.archrules.gradle
 import nebula.test.dsl.TestKitAssertions.assertThat
 import nebula.test.dsl.main
 import nebula.test.dsl.plugins
+import nebula.test.dsl.properties
 import nebula.test.dsl.repositories
 import nebula.test.dsl.rootProject
+import nebula.test.dsl.run
 import nebula.test.dsl.settings
 import nebula.test.dsl.sourceSet
 import nebula.test.dsl.src
@@ -16,6 +18,8 @@ import org.gradle.testkit.runner.TaskOutcome
 import org.junit.jupiter.api.Disabled
 import org.junit.jupiter.api.Test
 import org.junit.jupiter.api.io.TempDir
+import org.junit.jupiter.params.ParameterizedTest
+import org.junit.jupiter.params.provider.EnumSource
 import java.io.File
 import java.io.FileInputStream
 import java.io.IOException
@@ -34,9 +38,13 @@ class ArchrulesRunnerPluginTest {
         assertThat(configuration).isNotNull
     }
 
-    @Test
-    fun `plugin checks each sourceset`() {
+    @ParameterizedTest
+    @EnumSource(SupportedGradleVersion::class)
+    fun `plugin checks each sourceset`(gradleVersion: SupportedGradleVersion) {
         val runner = testProject(projectDir) {
+            properties {
+                gradleCache(true)
+            }
             settings {
                 name("consumer")
             }
@@ -63,7 +71,10 @@ class ArchrulesRunnerPluginTest {
             }
         }
 
-        val result = runner.run("check", "--stacktrace", "-x", "test")
+        val result = runner.run("check", "--stacktrace", "-x", "test"){
+            withGradleVersion(gradleVersion.version)
+            forwardOutput()
+        }
 
         assertThat(result.task(":checkArchRulesMain"))
             .`as`("archRules run for main source set")
@@ -73,6 +84,10 @@ class ArchrulesRunnerPluginTest {
             .`as`("archRules run for test source set")
             .hasOutcome(TaskOutcome.SUCCESS)
 
+        assertThat(result.task(":archRulesJsonReport"))
+            .`as`("archRules json report runs by default")
+            .hasOutcome(TaskOutcome.SUCCESS)
+
         assertThat(result)
             .hasNoMutableStateWarnings()
             .hasNoDeprecationWarnings()
@@ -90,11 +105,19 @@ class ArchrulesRunnerPluginTest {
             .exists()
         val testErrors = readDetails(testReport)
         assertThat(testErrors).hasSize(1)
+
+        val jsonReport = projectDir.resolve("build/reports/archrules/report.json")
+        assertThat(jsonReport)
+            .`as`("json report created")
+            .exists()
     }
 
     @Test
     fun `plugin checks each sourceset from its runtime`() {
         val runner = testProject(projectDir) {
+            properties {
+                gradleCache(true)
+            }
             settings {
                 name("consumer")
             }
@@ -166,5 +189,4 @@ class ArchrulesRunnerPluginTest {
         }
         return list
     }
-
-}
+}
diff --git a/nebula-archrules-gradle-plugin/src/test/kotlin/com/netflix/nebula/archrules/gradle/IntegrationTest.kt b/nebula-archrules-gradle-plugin/src/test/kotlin/com/netflix/nebula/archrules/gradle/IntegrationTest.kt
@@ -16,6 +16,9 @@ internal class IntegrationTest {
     @EnumSource(SupportedGradleVersion::class)
     fun test(gradleVersion: SupportedGradleVersion) {
         val runner = testProject(projectDir) {
+            properties {
+                gradleCache(true)
+            }
             subProject("library-with-rules") {
                 // a library that contains production code and rules to go along with it
                 plugins {

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@ repositories {`
`8`	`8`	`}`
`9`	`9`	`dependencies {`
`10`	`10`	`implementation(project(":nebula-archrules-core"))`
	`11`	`+ implementation("tools.jackson.core:jackson-databind:3.0.2")`
`11`	`12`	`testImplementation("net.javacrumbs.json-unit:json-unit-assertj:5.0.0")`
`12`	`13`	`testImplementation("org.json:json:20250517")`
`13`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -69,8 +69,20 @@ class ArchrulesRunnerPlugin : Plugin<Project> {`
`69`	`69`	`}`
`70`	`70`	`checkTask`
`71`	`71`	`}`
	`72`	`+`
	`73`	`+ val dataFiles = checkTasks.stream()`
	`74`	`+ .map { it.get().dataFile.get() }`
	`75`	`+ .toList()`
	`76`	`+`
	`77`	`+ val jsonReportTask = project.tasks.register<PrintJsonReportTask>("archRulesJsonReport") {`
	`78`	`+ getDataFiles().set(dataFiles)`
	`79`	`+ getJsonReportFile().set(archRulesReportDir.map { it.file("report.json").asFile })`
	`80`	`+ dependsOn(checkTasks)`
	`81`	`+ }`
	`82`	`+`
`72`	`83`	`project.tasks.named("check") {`
`73`	`84`	`dependsOn(checkTasks)`
	`85`	`+ finalizedBy(jsonReportTask)`
`74`	`86`	`}`
`75`	`87`	`}`
`76`	`88`	`}`