Skip to content

Add ArchUnit rule to ban javax & JetBrains nullability annotations #3985

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dondonz merged 2 commits into from
May 27, 2025
Merged

Add ArchUnit rule to ban javax & JetBrains nullability annotations #3985

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
65e2c84
Add ArchUnit rule to ban javax nullability annotations
dondonz May 23, 2025
08c8bd3
Rename to nullability annotation
dondonz May 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ shadowJar {
bnd('''
-exportcontents: graphql.*
-removeheaders: Private-Package
Import-Package: !android.os.*,!com.google.*,!org.checkerframework.*,!javax.annotation.*,!graphql.com.google.*,!org.antlr.*,!graphql.org.antlr.*,!sun.misc.*,org.jspecify.annotations;resolution:=optional,*
Import-Package: !android.os.*,!com.google.*,!org.checkerframework.*,!graphql.com.google.*,!org.antlr.*,!graphql.org.antlr.*,!sun.misc.*,org.jspecify.annotations;resolution:=optional,*
Copy link
Member Author

@dondonz dondonz May 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While I'm here, we can clean up our config to remove javax.annotation

''')
}

Expand Down
40 changes: 40 additions & 0 deletions src/test/groovy/graphql/NullabilityAnnotationUsageTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
package graphql

import com.tngtech.archunit.core.domain.JavaClasses
import com.tngtech.archunit.core.importer.ClassFileImporter
import com.tngtech.archunit.core.importer.ImportOption
import com.tngtech.archunit.lang.ArchRule
import com.tngtech.archunit.lang.EvaluationResult
import com.tngtech.archunit.lang.syntax.ArchRuleDefinition
import spock.lang.Specification

class NullabilityAnnotationUsageTest extends Specification {

private static final JavaClasses importedClasses = new ClassFileImporter()
.withImportOption(ImportOption.Predefined.DO_NOT_INCLUDE_TESTS)
.importPackages("graphql")

def "should only use JSpecify nullability annotations"() {
given:
ArchRule dependencyRule = ArchRuleDefinition.noClasses()
.should()
.dependOnClassesThat()
.resideInAnyPackage(
"javax.annotation",
"org.jetbrains.annotations"
)
.because("We are using JSpecify nullability annotations only. Please change to use JSpecify.")

when:
EvaluationResult result = dependencyRule.evaluate(importedClasses)

then:
if (result.hasViolation()) {
println "We are using JSpecify nullability annotations only. Please change the following to use JSpecify instead:"
result.getFailureReport().getDetails().each { violation ->
println "- ${violation}"
}
}
!result.hasViolation()
}
}