Skip to content

Commit

Permalink
Improve compatibility with Checkstyle 10
Browse files Browse the repository at this point in the history 
Closes gh-395
  • Loading branch information
@wilkinsona
wilkinsona committed Dec 14, 2023
1 parent e875f94 commit fd84f42
Show file tree
Hide file tree
Showing 2 changed files with 66 additions and 25 deletions.
17 changes: 10 additions & 7 deletions ...t-checkstyle/src/main/java/io/spring/javaformat/checkstyle/SpringConfigurationLoader.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,11 @@
import com.puppycrawl.tools.checkstyle.ConfigurationLoader;
import com.puppycrawl.tools.checkstyle.ConfigurationLoader.IgnoredModulesOptions;
import com.puppycrawl.tools.checkstyle.PropertyResolver;
import com.puppycrawl.tools.checkstyle.api.AutomaticBean;
import com.puppycrawl.tools.checkstyle.api.CheckstyleException;
import com.puppycrawl.tools.checkstyle.api.Configurable;
import com.puppycrawl.tools.checkstyle.api.Configuration;
import com.puppycrawl.tools.checkstyle.api.Context;
import com.puppycrawl.tools.checkstyle.api.Contextualizable;
import com.puppycrawl.tools.checkstyle.api.FileSetCheck;
import org.xml.sax.InputSource;

Expand Down Expand Up @@ -79,19 +80,21 @@ private Object createModule(Configuration configuration) {
String name = configuration.getName();
try {
Object module = this.moduleFactory.createModule(name);
if (module instanceof AutomaticBean) {
initialize(configuration, (AutomaticBean) module);
}
initialize(configuration, module);
return module;
}
catch (CheckstyleException ex) {
throw new IllegalStateException("cannot initialize module " + name + " - " + ex.getMessage(), ex);
}
}

private void initialize(Configuration configuration, AutomaticBean bean) throws CheckstyleException {
bean.contextualize(this.context);
bean.configure(configuration);
private void initialize(Configuration configuration, Object module) throws CheckstyleException {
if (module instanceof Contextualizable) {
((Contextualizable) module).contextualize(this.context);
}
if (module instanceof Configurable) {
((Configurable) module).configure(configuration);
}
}

}
74 changes: 56 additions & 18 deletions ...mat-checkstyle/src/main/java/io/spring/javaformat/checkstyle/check/SpringJUnit5Check.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,14 @@
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.stream.Collectors;
import java.util.stream.Stream;

import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FullIdent;
Expand All @@ -38,33 +40,33 @@
*/
public class SpringJUnit5Check extends AbstractSpringCheck {

private static final String JUNIT4_TEST_ANNOTATION = "org.junit.Test";
private static final String JUNIT4_TEST_ANNOTATION_NAME = "org.junit.Test";

private static final List<String> TEST_ANNOTATIONS;
private static final List<Annotation> TEST_ANNOTATIONS;
static {
Set<String> annotations = new LinkedHashSet<>();
annotations.add("RepeatedTest");
annotations.add("Test");
annotations.add("TestFactory");
annotations.add("TestTemplate");
annotations.add("ParameterizedTest");
Set<Annotation> annotations = new LinkedHashSet<>();
annotations.add(new Annotation("org.junit.jupiter.api", "RepeatedTest"));
annotations.add(new Annotation("org.junit.jupiter.api", "Test"));
annotations.add(new Annotation("org.junit.jupiter.api", "TestFactory"));
annotations.add(new Annotation("org.junit.jupiter.api", "TestTemplate"));
annotations.add(new Annotation("org.junit.jupiter.api", "ParameterizedTest"));
TEST_ANNOTATIONS = Collections.unmodifiableList(new ArrayList<>(annotations));
}

private static final List<String> LIFECYCLE_ANNOTATIONS;
private static final List<Annotation> LIFECYCLE_ANNOTATIONS;
static {
Set<String> annotations = new LinkedHashSet<>();
annotations.add("BeforeAll");
annotations.add("BeforeEach");
annotations.add("AfterAll");
annotations.add("AfterEach");
Set<Annotation> annotations = new LinkedHashSet<>();
annotations.add(new Annotation("org.junit.jupiter.api", "BeforeAll"));
annotations.add(new Annotation("org.junit.jupiter.api", "BeforeEach"));
annotations.add(new Annotation("org.junit.jupiter.api", "AfterAll"));
annotations.add(new Annotation("org.junit.jupiter.api", "AfterEach"));
LIFECYCLE_ANNOTATIONS = Collections.unmodifiableList(new ArrayList<>(annotations));
}

private static final Set<String> BANNED_IMPORTS;
static {
Set<String> bannedImports = new LinkedHashSet<>();
bannedImports.add(JUNIT4_TEST_ANNOTATION);
bannedImports.add(JUNIT4_TEST_ANNOTATION_NAME);
bannedImports.add("org.junit.After");
bannedImports.add("org.junit.AfterClass");
bannedImports.add("org.junit.Before");
Expand Down Expand Up @@ -106,14 +108,33 @@ public void visitToken(DetailAST ast) {
}

private void visitMethodDef(DetailAST ast) {
if (AnnotationUtil.containsAnnotation(ast, TEST_ANNOTATIONS)) {
if (containsAnnotation(ast, TEST_ANNOTATIONS)) {
this.testMethods.add(ast);
}
if (AnnotationUtil.containsAnnotation(ast, LIFECYCLE_ANNOTATIONS)) {
if (containsAnnotation(ast, LIFECYCLE_ANNOTATIONS)) {
this.lifecycleMethods.add(ast);
}
}

private boolean containsAnnotation(DetailAST ast, List<Annotation> annotations) {
List<String> annotationNames = annotations.stream().flatMap((annotation) ->
Stream.of(annotation.simpleName, annotation.fullyQualifiedName())).collect(Collectors.toList());
try {
return AnnotationUtil.containsAnnotation(ast, annotationNames);
}
catch (NoSuchMethodError ex) {
// Checkstyle >= 10.3 (https://github.com/checkstyle/checkstyle/issues/14134)
Set<String> annotationNamesSet = new HashSet<>(annotationNames);
try {
return (boolean) AnnotationUtil.class.getMethod("containsAnnotation", DetailAST.class, Set.class)
.invoke(null, ast, annotationNamesSet);
}
catch (Exception ex2) {
throw new RuntimeException("containsAnnotation failed", ex2);
}
}
}

private void visitImport(DetailAST ast) {
FullIdent ident = FullIdent.createFullIdentBelow(ast);
this.imports.put(ident.getText(), ident);
Expand Down Expand Up @@ -146,7 +167,7 @@ private void check() {
}
}
for (DetailAST testMethod : this.testMethods) {
if (AnnotationUtil.containsAnnotation(testMethod, JUNIT4_TEST_ANNOTATION)) {
if (AnnotationUtil.containsAnnotation(testMethod, JUNIT4_TEST_ANNOTATION_NAME)) {
log(testMethod, "junit5.bannedTestAnnotation");
}
}
Expand Down Expand Up @@ -176,4 +197,21 @@ public void setUnlessImports(String unlessImports) {
.unmodifiableList(Arrays.stream(unlessImports.split(",")).map(String::trim).collect(Collectors.toList()));
}

private static final class Annotation {

private final String packageName;

private final String simpleName;

private Annotation(String packageName, String simpleName) {
this.packageName = packageName;
this.simpleName = simpleName;
}

private String fullyQualifiedName() {
return this.packageName + "." + this.simpleName;
}

}

}

0 comments on commit fd84f42

Please sign in to comment.