Skip to content

Detect and prohibit new Guava classes #3869

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 3 commits into from
Apr 3, 2025
Merged

Detect and prohibit new Guava classes #3869

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5f9b01d
Detect and prohibit new Guava classes
dondonz Mar 29, 2025
8507df1
Fix bug should be fully qualified name
dondonz Mar 29, 2025
6fb0db2
Add full list of Guava exemptions
dondonz Mar 29, 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: 2 additions & 0 deletions build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,8 @@ dependencies {
testAnnotationProcessor 'org.openjdk.jmh:jmh-generator-annprocess:1.37'
jmh 'org.openjdk.jmh:jmh-core:1.37'
jmh 'org.openjdk.jmh:jmh-generator-annprocess:1.37'

testImplementation "com.tngtech.archunit:archunit-junit5:1.2.0"
}

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

import com.tngtech.archunit.core.domain.JavaClasses
import com.tngtech.archunit.core.importer.ClassFileImporter
import com.tngtech.archunit.core.importer.ImportOption
import spock.lang.Specification

/*
* We selectively shade in a few classes of Guava, however we want to minimise dependencies so we want to keep this list small.
* This check ensures no new Guava classes are added
*/
class GuavaLimitCheck extends Specification {

static final String GUAVA_PACKAGE_PREFIX = "com.google.common"

static final Set<String> ALLOWED_GUAVA_CLASSES = [
"com.google.common.base.Strings",
"com.google.common.collect.BiMap",
"com.google.common.collect.HashBasedTable",
"com.google.common.collect.HashBiMap",
"com.google.common.collect.HashMultimap",
"com.google.common.collect.HashMultiset",
"com.google.common.collect.ImmutableBiMap",
"com.google.common.collect.ImmutableCollection",
"com.google.common.collect.ImmutableList",
"com.google.common.collect.ImmutableList\$Builder",
"com.google.common.collect.ImmutableListMultimap",
"com.google.common.collect.ImmutableListMultimap\$Builder",
"com.google.common.collect.ImmutableMap",
"com.google.common.collect.ImmutableMap\$Builder",
"com.google.common.collect.ImmutableSet",
"com.google.common.collect.ImmutableSet\$Builder",
"com.google.common.collect.Interner",
"com.google.common.collect.Interners",
"com.google.common.collect.Iterables",
"com.google.common.collect.LinkedHashMultimap",
"com.google.common.collect.Maps",
"com.google.common.collect.Multimap",
"com.google.common.collect.Multimaps",
"com.google.common.collect.Multiset",
"com.google.common.collect.Multisets",
"com.google.common.collect.Sets",
"com.google.common.collect.Sets\$SetView",
"com.google.common.collect.Table"
]

def "should identify which classes use prohibited Guava dependencies"() {
given:
JavaClasses importedClasses = new ClassFileImporter()
.withImportOption(ImportOption.Predefined.DO_NOT_INCLUDE_TESTS)
.importPackages("graphql")

when:
Map<String, Set<String>> violationsByClass = [:]

importedClasses.each { javaClass ->
def className = javaClass.name
def guavaUsages = javaClass.getAccessesFromSelf()
.collect { it.targetOwner }
.findAll { it.packageName.startsWith(GUAVA_PACKAGE_PREFIX) && !ALLOWED_GUAVA_CLASSES.contains(it.fullName) }
.toSet()

if (!guavaUsages.isEmpty()) {
violationsByClass[className] = guavaUsages
}
}

then:
violationsByClass.isEmpty()

cleanup: "if the test fails, provide detailed information about which classes have violations"
if (!violationsByClass.isEmpty()) {
def errorMessage = new StringBuilder("Prohibited Guava class usage found:\n")

violationsByClass.each { className, guavaClasses ->
errorMessage.append("\nClass: ${className} uses these prohibited Guava classes:\n")
guavaClasses.each { guavaClass ->
errorMessage.append(" - ${guavaClass}\n")
}
}

errorMessage.append("\nEither:\n")
errorMessage.append("1. Preferred option: Replace them with alternatives that don't depend on Guava\n")
errorMessage.append("2. If absolutely necessary: Add these Guava classes to the shade configuration in the build.gradle file\n")

println errorMessage.toString()
}
}
}
Loading