add ArchRule attribute value for "not arch rules"

wakingrufus · wakingrufus · commit 7c1349c5fe80 · 2026-01-21T14:02:22.000-06:00
add workaround for interop with the proto plugin
diff --git a/nebula-archrules-gradle-plugin/build.gradle.kts b/nebula-archrules-gradle-plugin/build.gradle.kts
@@ -6,6 +6,7 @@ description = "Plugins for authoring and running Nebula ArchRules"
 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
@@ -4,12 +4,13 @@
 cglib:cglib-nodep:3.2.2=testRuntimeClasspath
 com.fasterxml.jackson.core:jackson-annotations:2.20=compileClasspath,implementationDependenciesMetadata,mainArchRulesRuntime,runtimeClasspath,testArchRulesRuntime,testCompileClasspath,testImplementationDependenciesMetadata,testRuntimeClasspath
 com.jayway.jsonpath:json-path:2.9.0=testArchRulesRuntime,testCompileClasspath,testImplementationDependenciesMetadata,testRuntimeClasspath
-com.netflix.nebula:archrules-deprecation:0.7.1=archRules,mainArchRulesRuntime,testArchRulesRuntime
-com.netflix.nebula:archrules-joda:0.7.1=archRules,mainArchRulesRuntime,testArchRulesRuntime
-com.netflix.nebula:archrules-nullability:0.7.1=archRules,mainArchRulesRuntime,testArchRulesRuntime
-com.netflix.nebula:archrules-security:0.7.1=archRules,mainArchRulesRuntime,testArchRulesRuntime
-com.netflix.nebula:archrules-testing-frameworks:0.7.1=archRules,mainArchRulesRuntime,testArchRulesRuntime
-com.netflix.nebula:nebula-archrules-core:0.5.5=archRules,mainArchRulesRuntime,testArchRulesRuntime
+com.netflix.nebula:archrules-common:0.8.0=archRules,mainArchRulesRuntime,testArchRulesRuntime
+com.netflix.nebula:archrules-deprecation:0.8.0=archRules,mainArchRulesRuntime,testArchRulesRuntime
+com.netflix.nebula:archrules-joda:0.8.0=archRules,mainArchRulesRuntime,testArchRulesRuntime
+com.netflix.nebula:archrules-nullability:0.8.0=archRules,mainArchRulesRuntime,testArchRulesRuntime
+com.netflix.nebula:archrules-security:0.8.0=archRules,mainArchRulesRuntime,testArchRulesRuntime
+com.netflix.nebula:archrules-testing-frameworks:0.8.0=archRules,mainArchRulesRuntime,testArchRulesRuntime
+com.netflix.nebula:nebula-archrules-core:0.7.0=archRules,mainArchRulesRuntime,testArchRulesRuntime
 com.netflix.nebula:nebula-test:11.11.3=testArchRulesRuntime,testCompileClasspath,testImplementationDependenciesMetadata,testRuntimeClasspath
 com.tngtech.archunit:archunit:1.4.1=archRules,compileClasspath,implementationDependenciesMetadata,mainArchRulesRuntime,runtimeClasspath,testArchRulesRuntime,testCompileClasspath,testImplementationDependenciesMetadata,testRuntimeClasspath
 io.github.java-diff-utils:java-diff-utils:4.12=kotlinInternalAbiValidation
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
@@ -17,7 +17,12 @@ public interface ArchRuleAttribute extends Named {
             Attribute.of("com.netflix.nebula.archrules", ArchRuleAttribute.class);
 
     /**
-     * The only recognized value of this attribute
+     * Used in archrules artifacts to allow them to be selected via the variant selection algorithm
      */
     String ARCH_RULES = "arch-rules";
+
+    /**
+     * Used in non-archrules artifacts to avoid confusing the variant selection algorithm
+     */
+    String NOT_ARCH_RULES = "not-arch-rules";
 }
diff --git a/nebula-archrules-gradle-plugin/src/main/kotlin/com/netflix/nebula/archrules/gradle/ArchrulesLibraryPlugin.kt b/nebula-archrules-gradle-plugin/src/main/kotlin/com/netflix/nebula/archrules/gradle/ArchrulesLibraryPlugin.kt
@@ -1,6 +1,8 @@
 package com.netflix.nebula.archrules.gradle
 
 import com.netflix.nebula.archrules.gradle.ArchRuleAttribute.ARCH_RULES
+import com.netflix.nebula.archrules.gradle.ArchRuleAttribute.NOT_ARCH_RULES
+import org.gradle.api.Action
 import org.gradle.api.Plugin
 import org.gradle.api.Project
 import org.gradle.api.artifacts.type.ArtifactTypeDefinition
@@ -17,23 +19,33 @@ import org.gradle.api.tasks.TaskProvider
 import org.gradle.api.tasks.bundling.Jar
 import org.gradle.api.tasks.compile.JavaCompile
 import org.gradle.jvm.component.internal.JvmSoftwareComponentInternal
-import org.gradle.kotlin.dsl.add
-import org.gradle.kotlin.dsl.dependencies
+import org.gradle.kotlin.dsl.apply
 import org.gradle.kotlin.dsl.getByType
 import org.gradle.kotlin.dsl.invoke
 import org.gradle.kotlin.dsl.named
 import org.gradle.kotlin.dsl.register
 import org.gradle.kotlin.dsl.support.serviceOf
 import org.gradle.kotlin.dsl.withType
 import org.gradle.testing.base.TestingExtension
-import kotlin.collections.mapOf
 
 class ArchrulesLibraryPlugin : Plugin<Project> {
 
     override fun apply(project: Project) {
         val version = determineVersion()
         project.pluginManager.withPlugin("java") {
             val javaExt = project.extensions.getByType<JavaPluginExtension>()
+            javaExt.sourceSets.configureEach(Action {
+                if(!setOf("archRules", "archRulesTest").contains(this.name)) {
+                    project.configurations.named(compileClasspathConfigurationName).configure {
+                        attributes {
+                            attribute(ArchRuleAttribute.ARCH_RULES_ATTRIBUTE, project.objects.named(NOT_ARCH_RULES))
+                        }
+                    }
+                }
+            })
+            project.plugins.withId("com.google.protobuf"){
+                project.pluginManager.apply(ProtoSupportPlugin::class)
+            }
             val archRulesSourceSet = javaExt.sourceSets.create("archRules")
             project.configurations.named(archRulesSourceSet.implementationConfigurationName).configure {
                 extendsFrom(project.configurations.getByName(javaExt.sourceSets.getByName("main").implementationConfigurationName))
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
@@ -1,7 +1,9 @@
 package com.netflix.nebula.archrules.gradle
 
 import com.netflix.nebula.archrules.gradle.ArchRuleAttribute.ARCH_RULES
+import com.netflix.nebula.archrules.gradle.ArchRuleAttribute.NOT_ARCH_RULES
 import com.tngtech.archunit.lang.Priority
+import org.gradle.api.Action
 import org.gradle.api.Plugin
 import org.gradle.api.Project
 import org.gradle.api.attributes.Bundling
@@ -29,6 +31,19 @@ class ArchrulesRunnerPlugin : Plugin<Project> {
             }
         }
         project.plugins.withId("java") {
+            val javaExt = project.extensions.getByType<JavaPluginExtension>()
+            javaExt.sourceSets.configureEach(Action {
+                if(!setOf("archRules", "archRulesTest").contains(this.name)) {
+                    project.configurations.named(compileClasspathConfigurationName).configure {
+                        attributes {
+                            attribute(ArchRuleAttribute.ARCH_RULES_ATTRIBUTE, project.objects.named(NOT_ARCH_RULES))
+                        }
+                    }
+                }
+            })
+            project.plugins.withId("com.google.protobuf"){
+                project.pluginManager.apply(ProtoSupportPlugin::class)
+            }
             val archRulesExt = project.extensions.create<ArchrulesExtension>("archRules")
             archRulesExt.consoleReportEnabled.convention(true)
             archRulesExt.skipPassingSummaries.convention(false)
diff --git a/nebula-archrules-gradle-plugin/src/main/kotlin/com/netflix/nebula/archrules/gradle/ProtoSupportPlugin.kt b/nebula-archrules-gradle-plugin/src/main/kotlin/com/netflix/nebula/archrules/gradle/ProtoSupportPlugin.kt
@@ -0,0 +1,33 @@
+package com.netflix.nebula.archrules.gradle
+
+import com.netflix.nebula.archrules.gradle.ArchRuleAttribute.NOT_ARCH_RULES
+import org.gradle.api.Action
+import org.gradle.api.Plugin
+import org.gradle.api.Project
+import org.gradle.api.plugins.JavaPluginExtension
+import org.gradle.api.tasks.SourceSet
+import org.gradle.kotlin.dsl.getByType
+import org.gradle.kotlin.dsl.named
+
+/**
+ * This is an internal plugin which provides interop with the protobuf plugin.
+ * It should be only applied in response to the proto plugin
+ */
+class ProtoSupportPlugin : Plugin<Project> {
+    override fun apply(project: Project) {
+        project.pluginManager.withPlugin("java") {
+            val javaExt = project.extensions.getByType<JavaPluginExtension>()
+            /**
+             * Ideally we would get the source sets from ProtobufExtension, but it is not exposed
+             */
+            javaExt.sourceSets.configureEach(Action<SourceSet> {
+                val configurationName = if (this.name == "main") "compileProtoPath" else name + "CompileProtoPath"
+                project.configurations.named(configurationName).configure {
+                    attributes {
+                        attribute(ArchRuleAttribute.ARCH_RULES_ATTRIBUTE, project.objects.named(NOT_ARCH_RULES))
+                    }
+                }
+            })
+        }
+    }
+}
diff --git a/nebula-archrules-gradle-plugin/src/main/kotlin/com/netflix/nebula/archrules/gradle/ProtoUtil.kt b/nebula-archrules-gradle-plugin/src/main/kotlin/com/netflix/nebula/archrules/gradle/ProtoUtil.kt
@@ -0,0 +1,2 @@
+package com.netflix.nebula.archrules.gradle
+
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
@@ -31,7 +31,7 @@ class ArchrulesLibraryPluginTest {
     fun `plugin produces maven publication`() {
         val runner = testProject(projectDir) {
             properties {
-                gradleCache(true)
+                buildCache(true)
             }
             settings {
                 name("library-with-rules")
@@ -123,7 +123,7 @@ class ArchrulesLibraryPluginTest {
     fun `main dependencies are included in archRules`() {
         val runner = testProject(projectDir) {
             properties {
-                gradleCache(true)
+                buildCache(true)
             }
             settings {
                 name("library-with-rules")
@@ -194,7 +194,7 @@ class ArchrulesLibraryPluginTest {
     fun `plugin produces proper outgoingVariants`() {
         val runner = testProject(projectDir) {
             properties {
-                gradleCache(true)
+                buildCache(true)
             }
             settings {
                 name("library-with-rules")
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

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@ description = "Plugins for authoring and running Nebula ArchRules"`
`6`	`6`	`dependencies {`
`7`	`7`	`implementation(project(":nebula-archrules-core"))`
`8`	`8`	`implementation("tools.jackson.core:jackson-databind:3.0.2")`
	`9`	`+`
`9`	`10`	`testImplementation("net.javacrumbs.json-unit:json-unit-assertj:5.0.0")`
`10`	`11`	`testImplementation("org.json:json:20250517")`
`11`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+package com.netflix.nebula.archrules.gradle`
	`2`	`+`