Introduce JUnitClassModifiers check
#214
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| package tech.picnic.errorprone.bugpatterns; | ||
|
|
||
| import static com.google.errorprone.BugPattern.LinkType.CUSTOM; | ||
| import static com.google.errorprone.BugPattern.SeverityLevel.SUGGESTION; | ||
| import static com.google.errorprone.BugPattern.StandardTags.STYLE; | ||
| import static com.google.errorprone.matchers.ChildMultiMatcher.MatchType.AT_LEAST_ONE; | ||
| import static com.google.errorprone.matchers.Matchers.allOf; | ||
| import static com.google.errorprone.matchers.Matchers.annotations; | ||
| import static com.google.errorprone.matchers.Matchers.anyOf; | ||
| import static com.google.errorprone.matchers.Matchers.hasMethod; | ||
| import static com.google.errorprone.matchers.Matchers.hasModifier; | ||
| import static com.google.errorprone.matchers.Matchers.isType; | ||
| import static com.google.errorprone.matchers.Matchers.not; | ||
| import static tech.picnic.errorprone.bugpatterns.util.Documentation.BUG_PATTERNS_BASE_URL; | ||
| import static tech.picnic.errorprone.bugpatterns.util.MoreJUnitMatchers.TEST_METHOD; | ||
| import static tech.picnic.errorprone.bugpatterns.util.MoreMatchers.hasMetaAnnotation; | ||
|
|
||
| import com.google.auto.service.AutoService; | ||
| import com.google.common.collect.ImmutableSet; | ||
| import com.google.errorprone.BugPattern; | ||
| import com.google.errorprone.VisitorState; | ||
| import com.google.errorprone.bugpatterns.BugChecker; | ||
| import com.google.errorprone.bugpatterns.BugChecker.ClassTreeMatcher; | ||
| import com.google.errorprone.fixes.SuggestedFix; | ||
| import com.google.errorprone.fixes.SuggestedFixes; | ||
| import com.google.errorprone.matchers.Description; | ||
| import com.google.errorprone.matchers.Matcher; | ||
| import com.sun.source.tree.ClassTree; | ||
| import javax.lang.model.element.Modifier; | ||
|
|
||
| /** | ||
| * A {@link BugChecker} that flags non-final and non package-private JUnit test class declarations, | ||
| * unless abstract. | ||
| */ | ||
| @AutoService(BugChecker.class) | ||
| @BugPattern( | ||
| summary = "Non-abstract JUnit test classes should be declared package-private and final", | ||
| linkType = CUSTOM, | ||
| link = BUG_PATTERNS_BASE_URL + "JUnitClassModifiers", | ||
| severity = SUGGESTION, | ||
| tags = STYLE) | ||
| public final class JUnitClassModifiers extends BugChecker implements ClassTreeMatcher { | ||
| private static final long serialVersionUID = 1L; | ||
| private static final Matcher<ClassTree> HAS_SPRING_CONFIGURATION_ANNOTATION = | ||
| annotations( | ||
| AT_LEAST_ONE, | ||
| anyOf( | ||
| isType("org.springframework.context.annotation.Configuration"), | ||
| hasMetaAnnotation("org.springframework.context.annotation.Configuration"))); | ||
| private static final Matcher<ClassTree> TEST_CLASS_WITH_INCORRECT_MODIFIERS = | ||
| allOf( | ||
| hasMethod(TEST_METHOD), | ||
| not(hasModifier(Modifier.ABSTRACT)), | ||
| anyOf( | ||
| hasModifier(Modifier.PRIVATE), | ||
| hasModifier(Modifier.PROTECTED), | ||
| hasModifier(Modifier.PUBLIC), | ||
| allOf(not(hasModifier(Modifier.FINAL)), not(HAS_SPRING_CONFIGURATION_ANNOTATION)))); | ||
|
|
||
| /** Instantiates a new {@link JUnitClassModifiers} instance. */ | ||
| public JUnitClassModifiers() {} | ||
|
|
||
| @Override | ||
| public Description matchClass(ClassTree tree, VisitorState state) { | ||
| if (!TEST_CLASS_WITH_INCORRECT_MODIFIERS.matches(tree, state)) { | ||
| return Description.NO_MATCH; | ||
| } | ||
|
|
||
| SuggestedFix.Builder fixBuilder = SuggestedFix.builder(); | ||
| SuggestedFixes.removeModifiers( | ||
| tree.getModifiers(), | ||
| state, | ||
| ImmutableSet.of(Modifier.PRIVATE, Modifier.PROTECTED, Modifier.PUBLIC)) | ||
| .ifPresent(fixBuilder::merge); | ||
|
|
||
| if (!HAS_SPRING_CONFIGURATION_ANNOTATION.matches(tree, state)) { | ||
| SuggestedFixes.addModifiers(tree, state, Modifier.FINAL).ifPresent(fixBuilder::merge); | ||
| } | ||
|
|
||
| return describeMatch(tree, fixBuilder.build()); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,129 @@ | ||
| package tech.picnic.errorprone.bugpatterns; | ||
|
|
||
| import com.google.errorprone.BugCheckerRefactoringTestHelper; | ||
| import com.google.errorprone.BugCheckerRefactoringTestHelper.TestMode; | ||
| import com.google.errorprone.CompilationTestHelper; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| final class JUnitClassModifiersTest { | ||
| private final CompilationTestHelper compilationTestHelper = | ||
| CompilationTestHelper.newInstance(JUnitClassModifiers.class, getClass()); | ||
| private final BugCheckerRefactoringTestHelper refactoringTestHelper = | ||
| BugCheckerRefactoringTestHelper.newInstance(JUnitClassModifiers.class, getClass()); | ||
|
|
||
| @Test | ||
| void identification() { | ||
| compilationTestHelper | ||
| .addSourceLines( | ||
| "Container.java", | ||
| "import org.junit.jupiter.api.Test;", | ||
| "import org.junit.jupiter.params.ParameterizedTest;", | ||
| "import org.springframework.boot.test.context.TestConfiguration;", | ||
| "import org.springframework.context.annotation.Configuration;", | ||
| "", | ||
| "class Container {", | ||
| " final class FinalAndPackagePrivate {", | ||
| " @Test", | ||
| " void foo() {}", | ||
| " }", | ||
| "", | ||
| " public abstract class Abstract {", | ||
| " @Test", | ||
| " void foo() {}", | ||
| " }", | ||
| "", | ||
| " @Configuration", | ||
| " class WithConfigurationAnnotation {", | ||
| " @Test", | ||
| " void foo() {}", | ||
| " }", | ||
| "", | ||
| " @TestConfiguration", | ||
| " class WithConfigurationMetaAnnotation {", | ||
| " @Test", | ||
| " void foo() {}", | ||
| " }", | ||
| "", | ||
| " // BUG: Diagnostic contains:", | ||
| " private final class Private {", | ||
| " @Test", | ||
| " void foo() {}", | ||
| " }", | ||
| "", | ||
| " // BUG: Diagnostic contains:", | ||
| " protected final class Protected {", | ||
| " @Test", | ||
| " void foo() {}", | ||
| " }", | ||
| "", | ||
| " // BUG: Diagnostic contains:", | ||
| " public final class Public {", | ||
| " @Test", | ||
| " void foo() {}", | ||
| " }", | ||
| "", | ||
| " // BUG: Diagnostic contains:", | ||
| " class NonFinal {", | ||
| " @Test", | ||
| " void foo() {}", | ||
| " }", | ||
| "", | ||
| " // BUG: Diagnostic contains:", | ||
| " class NonFinalWithCustomTestMethod {", | ||
| " @ParameterizedTest", | ||
| " void foo() {}", | ||
| " }", | ||
|
Comment on lines
+70
to
+80
There was a problem hiding this comment. I feel like these two cases are misleading: IIUC, the latter doesn't fail due to the "custom test method" but solely because it's non-final. Did I get this right? Shouldn't we add a positive test case for test methods annotated with There was a problem hiding this comment.
Yes :)
Can do :) |
||
| "", | ||
| " @Configuration", | ||
| " // BUG: Diagnostic contains:", | ||
| " public class PublicWithConfigurationAnnotation {", | ||
| " @Test", | ||
| " void foo() {}", | ||
| " }", | ||
| "", | ||
| " @TestConfiguration", | ||
| " // BUG: Diagnostic contains:", | ||
| " protected class ProtectedWithConfigurationMetaAnnotation {", | ||
| " @Test", | ||
| " void foo() {}", | ||
| " }", | ||
| "}") | ||
| .doTest(); | ||
| } | ||
|
|
||
| @Test | ||
| void replacement() { | ||
| refactoringTestHelper | ||
| .addInputLines( | ||
| "A.java", | ||
| "import org.junit.jupiter.api.Test;", | ||
| "import org.springframework.context.annotation.Configuration;", | ||
| "", | ||
| "public class A {", | ||
| " @Test", | ||
| " void foo() {}", | ||
| "", | ||
| " @Configuration", | ||
| " private static class B {", | ||
| " @Test", | ||
| " void bar() {}", | ||
| " }", | ||
| "}") | ||
| .addOutputLines( | ||
| "A.java", | ||
| "import org.junit.jupiter.api.Test;", | ||
| "import org.springframework.context.annotation.Configuration;", | ||
| "", | ||
| "final class A {", | ||
| " @Test", | ||
| " void foo() {}", | ||
| "", | ||
| " @Configuration", | ||
| " static class B {", | ||
| " @Test", | ||
| " void bar() {}", | ||
| " }", | ||
| "}") | ||
| .doTest(TestMode.TEXT_MATCH); | ||
| } | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's move this case down so that the modifier ordering here matches the resolution order below.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
^ I'll shuffle the test code accordingly.