improve wiring of data file inputs for report tasks

should help prevent ConcurrentModificationException from sometimes occurring

Author: wakingrufus

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

@@ -3,11 +3,10 @@
 import com.tngtech.archunit.thirdparty.org.objectweb.asm.ClassReader;
 import org.gradle.api.DefaultTask;
 import org.gradle.api.file.ConfigurableFileCollection;
-import org.gradle.api.provider.Property;
+import org.gradle.api.file.RegularFileProperty;
 import org.gradle.api.tasks.*;
-import org.jspecify.annotations.NonNull;
+import org.jspecify.annotations.NullMarked;
 
-import java.io.File;
 import java.io.IOException;
 import java.nio.file.Files;
 import java.nio.file.StandardOpenOption;
@@ -16,6 +15,7 @@
  * Generates a file in META-INF/services to allow Rule classes to be discovered by the Runner
  */
 @CacheableTask
+@NullMarked
 abstract public class GenerateServicesRegistryTask extends DefaultTask {
     /**
      * The classes declared in the archRules source set
@@ -28,7 +28,7 @@ abstract public class GenerateServicesRegistryTask extends DefaultTask {
      * The file in META-INF/services to output to. It should be named com.netflix.nebula.archrules.core.ArchRulesService.
      */
     @OutputFile
-    abstract public Property<@NonNull File> getArchRuleServicesFile();
+    abstract public RegularFileProperty getArchRuleServicesFile();
 
     @TaskAction
     public void generate() throws IOException {
@@ -47,11 +47,11 @@ public void generate() throws IOException {
                         getLogger().warn("Failed to read class file {}", classFile.getAbsolutePath(), e);
                     }
                 });
-        if (getArchRuleServicesFile().get().exists()) {
-            getArchRuleServicesFile().get().delete();
+        if (getArchRuleServicesFile().getAsFile().get().exists()) {
+            getArchRuleServicesFile().getAsFile().get().delete();
         }
-        getArchRuleServicesFile().get().createNewFile();
+        getArchRuleServicesFile().getAsFile().get().createNewFile();
         String fileContent = String.join("\n", visitor.getArchRuleServiceClasses());
-        Files.writeString(getArchRuleServicesFile().get().toPath(), fileContent, StandardOpenOption.WRITE);
+        Files.writeString(getArchRuleServicesFile().getAsFile().get().toPath(), fileContent, StandardOpenOption.WRITE);
     }
 }

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

@@ -25,7 +25,7 @@ abstract public class PrintJsonReportTask extends DefaultTask {
      */
     @InputFiles
     @PathSensitive(PathSensitivity.RELATIVE)
-    abstract public ListProperty<File> getDataFiles();
+    abstract public ConfigurableFileCollection getDataFiles();
 
     /**
      * File to output JSON to

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

@@ -1,8 +1,10 @@
 package com.netflix.nebula.archrules.gradle;
 
 import com.tngtech.archunit.lang.Priority;
+import org.jspecify.annotations.NullMarked;
 
 import java.io.Serializable;
 
+@NullMarked
 public record Rule(String ruleClass, String ruleName, String description, Priority priority) implements Serializable {
 }

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

@@ -1,7 +1,10 @@
 package com.netflix.nebula.archrules.gradle;
 
+import org.jspecify.annotations.NullMarked;
+
 import java.io.Serializable;
 
+@NullMarked
 public record RuleResult(
         Rule rule,
         String message,

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

@@ -1,5 +1,8 @@
 package com.netflix.nebula.archrules.gradle;
 
+import org.jspecify.annotations.NullMarked;
+
+@NullMarked
 public enum RuleResultStatus {
     PASS, FAIL, NO_MATCH
 }

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

@@ -1,9 +1,15 @@
 package com.netflix.nebula.archrules.gradle;
 
 import com.tngtech.archunit.lang.Priority;
+import org.jspecify.annotations.NullMarked;
 
 import java.io.Serializable;
 
+/**
+ * @deprecated Unused class
+ */
+@Deprecated(forRemoval = true)
+@NullMarked
 public record RuleSummary(
         String ruleClass,
         String ruleName,

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

@@ -55,7 +55,7 @@ class ArchrulesLibraryPlugin : Plugin<Project> {
                     archRuleServicesFile.set(
                         project.layout.buildDirectory.file(
                             "resources/archRules/META-INF/services/com.netflix.nebula.archrules.core.ArchRulesService"
-                        ).map { it.asFile }
+                        )
                     )
                     ruleSourceClasses.setFrom(archRulesSourceSet.output)
                     dependsOn(archRulesSourceSet.classesTaskName)

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

@@ -54,7 +54,6 @@ class ArchrulesRunnerPlugin : Plugin<Project> {
                 .configureEach {
                     project.configureCheckTaskForSourceSet(this, archRulesExt)
                 }
-            val checkTasks = project.tasks.withType<CheckRulesTask>()
 
             val jsonReportDependencies = project.configurations.dependencyScope("archRulesJsonReporting"){
                 project.dependencies.add(this.name, ARCHRULES_DEPENDENCY)
@@ -64,22 +63,16 @@ class ArchrulesRunnerPlugin : Plugin<Project> {
                 extendsFrom(jsonReportDependencies.get())
             }
             val jsonReportTask = project.tasks.register<PrintJsonReportTask>("archRulesJsonReport") {
-                getDataFiles().set(
-                    project.provider { (project.tasks.withType<CheckRulesTask>().flatMap { it.outputs.files }) }
-                )
+                dataFiles.from(project.tasks.withType<CheckRulesTask>())
                 getJsonReportFile().set(archRulesReportDir.map { it.file("report.json").asFile })
                 reportingClasspath.setFrom(jsonReportClasspath)
-                dependsOn(checkTasks)
                 onlyIf { archRulesExt.jsonReportEnabled.get() }
             }
 
             val consoleReportTask = project.tasks.register<PrintConsoleReportTask>("archRulesConsoleReport") {
-                dataFiles.from(
-                    project.provider { (project.tasks.withType<CheckRulesTask>().flatMap { it.outputs.files }) }
-                )
+                dataFiles.from(project.tasks.withType<CheckRulesTask>())
                 summaryForPassingDisabled.set(archRulesExt.skipPassingSummaries)
                 detailsThreshold.set(archRulesExt.consoleDetailsThreshold)
-                dependsOn(checkTasks)
                 onlyIf { archRulesExt.consoleReportEnabled.get() }
             }
 
@@ -98,16 +91,12 @@ class ArchrulesRunnerPlugin : Plugin<Project> {
             }
 
             val enforceTask = project.tasks.register<EnforceArchRulesTask>("enforceArchRules") {
-                dependsOn(checkTasks)
-                dataFiles.set(
-                    project.provider { (project.tasks.withType<CheckRulesTask>().flatMap { it.outputs.files }) }
-                )
+                dataFiles.from(project.tasks.withType<CheckRulesTask>())
                 failureThreshold.set(archRulesExt.failureThreshold)
                 onlyIf { failureThreshold.isPresent }
             }
 
             project.tasks.named("check") {
-                dependsOn(checkTasks)
                 dependsOn(enforceTask)
                 finalizedBy(jsonReportTask, consoleReportTask)
             }

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

@@ -2,10 +2,9 @@ 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.file.ConfigurableFileCollection
 import org.gradle.api.provider.Property
 import org.gradle.api.tasks.*
-import java.io.File
 
 @CacheableTask
 abstract class EnforceArchRulesTask : DefaultTask() {
@@ -16,7 +15,7 @@ abstract class EnforceArchRulesTask : DefaultTask() {
      */
     @get:InputFiles
     @get:PathSensitive(PathSensitivity.RELATIVE)
-    abstract val dataFiles: ListProperty<File>
+    abstract val dataFiles: ConfigurableFileCollection
 
     /**
      * The data files to read in. These files should container binary data representing [RuleResult]s
@@ -28,7 +27,7 @@ abstract class EnforceArchRulesTask : DefaultTask() {
 
     @TaskAction
     fun enforce() {
-        val criticalFailures = dataFiles.get()
+        val criticalFailures = dataFiles.files
             .filter { it.exists() }
             .flatMap { ViolationsUtil.readDetails(it) }
             .filter { it.status == RuleResultStatus.FAIL }
@@ -52,4 +51,4 @@ abstract class EnforceArchRulesTask : DefaultTask() {
             null -> false
         }
     }
-}
+}

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

@@ -99,7 +99,7 @@ class ArchrulesRunnerPluginTest {
             .`as`("console report inputs are correct")
             .hasSize(2)
         val jsonReport = project.tasks.named<PrintJsonReportTask>("archRulesJsonReport")
-        assertThat(jsonReport.get().dataFiles.get())
+        assertThat(jsonReport.get().dataFiles.files)
             .`as`("json report inputs are correct")
             .hasSize(2)
     }