add nullability rule for springframework

sullis · wakingrufus · commit 2c6480367002 · 2025-12-01T17:29:21.000-06:00
diff --git a/archrules-deprecation/gradle.lockfile b/archrules-deprecation/gradle.lockfile
@@ -7,7 +7,7 @@ com.netflix.nebula:archrules-joda:0.1.3=archRules
 com.netflix.nebula:archrules-nullability:0.1.3=archRules
 com.netflix.nebula:archrules-testing-frameworks:0.1.3=archRules
 com.netflix.nebula:nebula-archrules-core:0.1.5=archRules
-com.netflix.nebula:nebula-archrules-core:0.2.2=archRulesCompileClasspath,archRulesRuntimeClasspath,archRulesTestCompileClasspath,archRulesTestRuntimeClasspath
+com.netflix.nebula:nebula-archrules-core:0.2.3=archRulesCompileClasspath,archRulesRuntimeClasspath,archRulesTestCompileClasspath,archRulesTestRuntimeClasspath
 com.tngtech.archunit:archunit:1.4.1=archRules,archRulesCompileClasspath,archRulesRuntimeClasspath,archRulesTestCompileClasspath,archRulesTestRuntimeClasspath
 net.bytebuddy:byte-buddy:1.17.7=archRulesTestCompileClasspath,archRulesTestRuntimeClasspath
 org.apiguardian:apiguardian-api:1.1.2=archRulesTestCompileClasspath
diff --git a/archrules-joda/gradle.lockfile b/archrules-joda/gradle.lockfile
@@ -7,7 +7,7 @@ com.netflix.nebula:archrules-deprecation:0.1.3=archRules
 com.netflix.nebula:archrules-nullability:0.1.3=archRules
 com.netflix.nebula:archrules-testing-frameworks:0.1.3=archRules
 com.netflix.nebula:nebula-archrules-core:0.1.5=archRules
-com.netflix.nebula:nebula-archrules-core:0.2.2=archRulesCompileClasspath,archRulesRuntimeClasspath,archRulesTestCompileClasspath,archRulesTestRuntimeClasspath
+com.netflix.nebula:nebula-archrules-core:0.2.3=archRulesCompileClasspath,archRulesRuntimeClasspath,archRulesTestCompileClasspath,archRulesTestRuntimeClasspath
 com.tngtech.archunit:archunit:1.4.1=archRules,archRulesCompileClasspath,archRulesRuntimeClasspath,archRulesTestCompileClasspath,archRulesTestRuntimeClasspath
 joda-time:joda-time:2.14.0=archRulesTestCompileClasspath,archRulesTestRuntimeClasspath
 net.bytebuddy:byte-buddy:1.17.7=archRulesTestCompileClasspath,archRulesTestRuntimeClasspath
diff --git a/archrules-nullability/build.gradle.kts b/archrules-nullability/build.gradle.kts
@@ -15,6 +15,7 @@ dependencies {
     archRulesTestImplementation("com.google.code.findbugs:jsr305:3.0.2")
     archRulesTestImplementation("jakarta.annotation:jakarta.annotation-api:3.0.0")
     archRulesTestImplementation("org.jetbrains:annotations:26.0.2-1")
+    archRulesTestImplementation("org.springframework:spring-core:5.3.39")
 }
 java {
     toolchain {
diff --git a/archrules-nullability/gradle.lockfile b/archrules-nullability/gradle.lockfile
@@ -8,7 +8,7 @@ com.netflix.nebula:archrules-deprecation:0.1.3=archRules
 com.netflix.nebula:archrules-joda:0.1.3=archRules
 com.netflix.nebula:archrules-testing-frameworks:0.1.3=archRules
 com.netflix.nebula:nebula-archrules-core:0.1.5=archRules
-com.netflix.nebula:nebula-archrules-core:0.2.2=archRulesCompileClasspath,archRulesRuntimeClasspath,archRulesTestCompileClasspath,archRulesTestRuntimeClasspath
+com.netflix.nebula:nebula-archrules-core:0.2.3=archRulesCompileClasspath,archRulesRuntimeClasspath,archRulesTestCompileClasspath,archRulesTestRuntimeClasspath
 com.tngtech.archunit:archunit:1.4.1=archRules,archRulesCompileClasspath,archRulesRuntimeClasspath,archRulesTestCompileClasspath,archRulesTestRuntimeClasspath
 jakarta.annotation:jakarta.annotation-api:3.0.0=archRulesTestCompileClasspath,archRulesTestRuntimeClasspath
 net.bytebuddy:byte-buddy:1.17.7=archRulesTestCompileClasspath,archRulesTestRuntimeClasspath
@@ -26,4 +26,6 @@ org.junit.platform:junit-platform-launcher:1.12.2=archRulesTestRuntimeClasspath
 org.junit:junit-bom:5.12.2=archRulesTestCompileClasspath,archRulesTestRuntimeClasspath
 org.opentest4j:opentest4j:1.3.0=archRulesTestCompileClasspath,archRulesTestRuntimeClasspath
 org.slf4j:slf4j-api:2.0.17=archRules,archRulesCompileClasspath,archRulesRuntimeClasspath,archRulesTestCompileClasspath,archRulesTestRuntimeClasspath
+org.springframework:spring-core:5.3.39=archRulesTestCompileClasspath,archRulesTestRuntimeClasspath
+org.springframework:spring-jcl:5.3.39=archRulesTestCompileClasspath,archRulesTestRuntimeClasspath
 empty=annotationProcessor,archRulesAnnotationProcessor,archRulesTestAnnotationProcessor,compileClasspath,runtimeClasspath,testAnnotationProcessor,testCompileClasspath,testRuntimeClasspath
diff --git a/archrules-nullability/src/archRules/java/com/netflix/nebula/archrules/nullability/NebulaNullabilityArchRules.java b/archrules-nullability/src/archRules/java/com/netflix/nebula/archrules/nullability/NebulaNullabilityArchRules.java
@@ -31,6 +31,14 @@ public class NebulaNullabilityArchRules implements ArchRulesService {
             .orShould().dependOnClassesThat(fullyQualifiedName("org.jetbrains.annotations.NotNull"))
             .allowEmptyShould(true)
             .because("Only JSpecify annotations should be used on @NullMarked classes");
+    static final ArchRule UPGRADE_LEGACY_SPRING_FRAMEWORK = ArchRuleDefinition.priority(Priority.MEDIUM)
+            .noClasses()
+            .that().areAnnotatedWith("org.jspecify.annotations.NullMarked")
+            .should()
+            .dependOnClassesThat(fullyQualifiedName("org.springframework.lang.Nullable"))
+            .orShould().dependOnClassesThat(fullyQualifiedName("org.springframework.lang.NonNull"))
+            .allowEmptyShould(true)
+            .because("Only JSpecify annotations should be used on @NullMarked classes");
     static final ArchRule UPGRADE_LEGACY_JAVAX = ArchRuleDefinition.priority(Priority.MEDIUM)
             .noClasses()
             .that().areAnnotatedWith("org.jspecify.annotations.NullMarked")
@@ -53,6 +61,7 @@ public Map<String, ArchRule> getRules() {
         Map<String, ArchRule> rules = new HashMap<>();
         rules.put("public classes should be @NullMarked", PUBLIC_CLASSES_SHOULD_BE_NULL_MARKED);
         rules.put("upgrade legacy jetbrains annotations", UPGRADE_LEGACY_JETBRAINS);
+        rules.put("upgrade legacy spring annotations", UPGRADE_LEGACY_SPRING_FRAMEWORK);
         rules.put("upgrade legacy javax annotations", UPGRADE_LEGACY_JAVAX);
         rules.put("upgrade legacy jakarta annotations", UPGRADE_LEGACY_JAKARTA);
         return rules;
diff --git a/archrules-nullability/src/archRulesTest/java/com/netflix/nebula/archrules/nullability/NebulaNullabilityArchRulesTest.java b/archrules-nullability/src/archRulesTest/java/com/netflix/nebula/archrules/nullability/NebulaNullabilityArchRulesTest.java
@@ -78,6 +78,17 @@ public void test_jetbrains() {
                 .hasSize(2);
     }
 
+    @Test
+    public void test_spring_framework() {
+      EvaluationResult result = Runner.check(
+          NebulaNullabilityArchRules.UPGRADE_LEGACY_SPRING_FRAMEWORK,
+          SpringFrameworkFailingClass.class);
+      assertThat(result.hasViolation())
+          .isTrue();
+      assertThat(result.getFailureReport().getDetails())
+          .hasSize(2);
+  }
+
     static class InnerClass {
     }
 }
diff --git a/archrules-nullability/src/archRulesTest/java/com/netflix/nebula/archrules/nullability/SpringFrameworkFailingClass.java b/archrules-nullability/src/archRulesTest/java/com/netflix/nebula/archrules/nullability/SpringFrameworkFailingClass.java
@@ -0,0 +1,13 @@
+package com.netflix.nebula.archrules.nullability;
+
+import org.jspecify.annotations.NullMarked;
+
+
+@NullMarked
+public class SpringFrameworkFailingClass {
+    @org.springframework.lang.Nullable
+    String nullable;
+
+    @org.springframework.lang.NonNull
+    String nonNullable = "";
+}
diff --git a/archrules-testing-frameworks/gradle.lockfile b/archrules-testing-frameworks/gradle.lockfile
@@ -7,7 +7,7 @@ com.netflix.nebula:archrules-deprecation:0.1.3=archRules
 com.netflix.nebula:archrules-joda:0.1.3=archRules
 com.netflix.nebula:archrules-nullability:0.1.3=archRules
 com.netflix.nebula:nebula-archrules-core:0.1.5=archRules
-com.netflix.nebula:nebula-archrules-core:0.2.2=archRulesCompileClasspath,archRulesRuntimeClasspath,archRulesTestCompileClasspath,archRulesTestRuntimeClasspath
+com.netflix.nebula:nebula-archrules-core:0.2.3=archRulesCompileClasspath,archRulesRuntimeClasspath,archRulesTestCompileClasspath,archRulesTestRuntimeClasspath
 com.tngtech.archunit:archunit:1.4.1=archRules,archRulesCompileClasspath,archRulesRuntimeClasspath,archRulesTestCompileClasspath,archRulesTestRuntimeClasspath
 junit:junit:4.12=archRulesTestCompileClasspath,archRulesTestRuntimeClasspath
 net.bytebuddy:byte-buddy:1.17.7=archRulesTestCompileClasspath,archRulesTestRuntimeClasspath

Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@ dependencies {`
`15`	`15`	`archRulesTestImplementation("com.google.code.findbugs:jsr305:3.0.2")`
`16`	`16`	`archRulesTestImplementation("jakarta.annotation:jakarta.annotation-api:3.0.0")`
`17`	`17`	`archRulesTestImplementation("org.jetbrains:annotations:26.0.2-1")`
	`18`	`+ archRulesTestImplementation("org.springframework:spring-core:5.3.39")`
`18`	`19`	`}`
`19`	`20`	`java {`
`20`	`21`	`toolchain {`
Original file line number	Diff line number	Diff line change
`@@ -78,6 +78,17 @@ public void test_jetbrains() {`
`78`	`78`	`.hasSize(2);`
`79`	`79`	`}`
`80`	`80`
	`81`	`+ @Test`
	`82`	`+ public void test_spring_framework() {`
	`83`	`+ EvaluationResult result = Runner.check(`
	`84`	`+ NebulaNullabilityArchRules.UPGRADE_LEGACY_SPRING_FRAMEWORK,`
	`85`	`+ SpringFrameworkFailingClass.class);`
	`86`	`+ assertThat(result.hasViolation())`
	`87`	`+ .isTrue();`
	`88`	`+ assertThat(result.getFailureReport().getDetails())`
	`89`	`+ .hasSize(2);`
	`90`	`+ }`
	`91`	`+`
`81`	`92`	`static class InnerClass {`
`82`	`93`	`}`
`83`	`94`	`}`