-
Notifications
You must be signed in to change notification settings - Fork 727
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Checks that are suppressed using `@SuppressWarnings("CheckName")` are
now also suppressed by `@SuppressWarnings("all")`, as emitted by
libraries such as Lombok and Immutables.
Checks that are unsuppressible, or can only be suppressed by a custom
annotation are _not_ suppressed by `@SuppressWarnings("all")`.
While there: improve the deprecated `BugChecker#isSuppressed(Tree)` and
`BugChecker#isSuppressed(Symbol)` methods to respect
`BugChecker#supportsSuppressWarnings()`.
Resolves #4065.
Fixes #4076
COPYBARA_INTEGRATE_REVIEW=#4076 from PicnicSupermarket:sschroevers/suppress-warnings-all 1b8f663
PiperOrigin-RevId: 565440855- Loading branch information
1 parent
5a05839
commit 47f0c72
Showing
3 changed files
with
193 additions
and
3 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
184 changes: 184 additions & 0 deletions
184
core/src/test/java/com/google/errorprone/bugpatterns/BugCheckerTest.java
This file contains 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,184 @@ | ||
| /* | ||
| * Copyright 2023 The Error Prone Authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package com.google.errorprone.bugpatterns; | ||
|
|
||
| import static com.google.common.collect.ImmutableList.toImmutableList; | ||
| import static com.google.errorprone.BugPattern.SeverityLevel.ERROR; | ||
|
|
||
| import com.google.common.collect.ImmutableList; | ||
| import com.google.errorprone.BugPattern; | ||
| import com.google.errorprone.CompilationTestHelper; | ||
| import com.google.errorprone.VisitorState; | ||
| import com.google.errorprone.bugpatterns.BugChecker.VariableTreeMatcher; | ||
| import com.google.errorprone.matchers.Description; | ||
| import com.sun.source.tree.VariableTree; | ||
| import org.junit.Test; | ||
| import org.junit.runner.RunWith; | ||
| import org.junit.runners.JUnit4; | ||
|
|
||
| @RunWith(JUnit4.class) | ||
| public class BugCheckerTest { | ||
| @Test | ||
| public void isSuppressed_withoutVisitorState() { | ||
| CompilationTestHelper.newInstance(LegacySuppressionCheck.class, getClass()) | ||
| .addSourceLines( | ||
| "A.java", | ||
| "class A {", | ||
| " void m() {", | ||
| " // BUG: Diagnostic contains: []", | ||
| " int unsuppressed;", | ||
| " // BUG: Diagnostic contains: []", | ||
| " @SuppressWarnings(\"foo\") int unrelatedSuppression;", | ||
| " // BUG: Diagnostic contains: [Suppressible]", | ||
| " @SuppressWarnings(\"Suppressible\") int suppressed;", | ||
| " // BUG: Diagnostic contains: [Suppressible]", | ||
| " @SuppressWarnings(\"Alternative\") int suppressedWithAlternativeName;", | ||
| " // BUG: Diagnostic contains: [Suppressible]", | ||
| " @SuppressWarnings(\"all\") int allSuppressed;", | ||
| " // BUG: Diagnostic contains: [Suppressible]", | ||
| " @SuppressWarnings({\"foo\", \"Suppressible\"}) int alsoSuppressed;", | ||
| " // BUG: Diagnostic contains: [Suppressible]", | ||
| " @SuppressWarnings({\"all\", \"foo\"}) int redundantlySuppressed;", | ||
| " // BUG: Diagnostic contains: [Suppressible]", | ||
| " @SuppressWarnings({\"all\", \"OnlySuppressedInsideDeprecatedCode\"}) int" | ||
| + " ineffectiveSuppression;", | ||
| " // BUG: Diagnostic contains: []", | ||
| " @Deprecated int unuspportedSuppression;", | ||
| " }", | ||
| "}") | ||
| .doTest(); | ||
| } | ||
|
|
||
| @Test | ||
| public void isSuppressed() { | ||
| CompilationTestHelper.newInstance(SuppressibleCheck.class, getClass()) | ||
| .addSourceLines( | ||
| "A.java", | ||
| "class A {", | ||
| " void m() {", | ||
| " // BUG: Diagnostic contains:", | ||
| " int unsuppressed;", | ||
| " // BUG: Diagnostic contains:", | ||
| " @SuppressWarnings(\"foo\") int unrelatedSuppression;", | ||
| " @SuppressWarnings(\"Suppressible\") int suppressed;", | ||
| " @SuppressWarnings(\"Alternative\") int suppressedWithAlternativeName;", | ||
| " @SuppressWarnings(\"all\") int allSuppressed;", | ||
| " @SuppressWarnings({\"foo\", \"Suppressible\"}) int alsoSuppressed;", | ||
| " @SuppressWarnings({\"all\", \"foo\"}) int redundantlySuppressed;", | ||
| " }", | ||
| "}") | ||
| .doTest(); | ||
| } | ||
|
|
||
| @Test | ||
| public void isSuppressed_customSuppressionAnnotation() { | ||
| CompilationTestHelper.newInstance(CustomSuppressibilityCheck.class, getClass()) | ||
| .addSourceLines( | ||
| "A.java", | ||
| "class A {", | ||
| " void m() {", | ||
| " // BUG: Diagnostic contains:", | ||
| " int unsuppressed;", | ||
| " // BUG: Diagnostic contains:", | ||
| " @SuppressWarnings({\"all\", \"OnlySuppressedInsideDeprecatedCode\"}) int" | ||
| + " ineffectiveSuppression;", | ||
| " @Deprecated int suppressed;", | ||
| " }", | ||
| "}") | ||
| .doTest(); | ||
| } | ||
|
|
||
| @Test | ||
| public void isSuppressed_disableWarningsInGeneratedCode() { | ||
| CompilationTestHelper.newInstance(CustomSuppressibilityCheck.class, getClass()) | ||
| .setArgs("-XepDisableWarningsInGeneratedCode") | ||
| .addSourceLines( | ||
| "A.java", | ||
| "import javax.annotation.processing.Generated;", | ||
| "class A {", | ||
| " void m() {", | ||
| " // BUG: Diagnostic contains:", | ||
| " @Generated(\"some-tool\") int unsuppressed;", | ||
| " }", | ||
| "}") | ||
| .doTest(); | ||
|
|
||
| // The check is suppressed if its severity is downgraded to `WARNING`. | ||
| CompilationTestHelper.newInstance(CustomSuppressibilityCheck.class, getClass()) | ||
| .setArgs( | ||
| "-XepDisableWarningsInGeneratedCode", "-Xep:OnlySuppressedInsideDeprecatedCode:WARN") | ||
| .addSourceLines( | ||
| "A.java", | ||
| "import javax.annotation.processing.Generated;", | ||
| "class A {", | ||
| " void m() {", | ||
| " @Generated(\"some-tool\") int unsuppressed;", | ||
| " }", | ||
| "}") | ||
| .doTest(); | ||
| } | ||
|
|
||
| @BugPattern( | ||
| name = "SuppressionReporter", | ||
| summary = | ||
| "Tells whether some other checks are suppressed according to the deprecated method " | ||
| + "`BugChecker#isSuppressed(Tree)`", | ||
| severity = ERROR, | ||
| suppressionAnnotations = {}) | ||
| public static final class LegacySuppressionCheck extends BugChecker | ||
| implements VariableTreeMatcher { | ||
| private final ImmutableList<BugChecker> checks = | ||
| ImmutableList.of(new SuppressibleCheck(), new CustomSuppressibilityCheck()); | ||
|
|
||
| @Override | ||
| @SuppressWarnings("deprecation") // testing deprecated method | ||
| public Description matchVariable(VariableTree tree, VisitorState state) { | ||
| ImmutableList<String> suppressions = | ||
| checks.stream() | ||
| .filter(check -> check.isSuppressed(tree)) | ||
| .map(BugChecker::canonicalName) | ||
| .collect(toImmutableList()); | ||
|
|
||
| return buildDescription(tree).setMessage("Suppressions: " + suppressions).build(); | ||
| } | ||
| } | ||
|
|
||
| @BugPattern( | ||
| name = "Suppressible", | ||
| altNames = "Alternative", | ||
| summary = "Can be suppressed", | ||
| severity = ERROR) | ||
| public static final class SuppressibleCheck extends BugChecker implements VariableTreeMatcher { | ||
| @Override | ||
| public Description matchVariable(VariableTree tree, VisitorState state) { | ||
| return describeMatch(tree); | ||
| } | ||
| } | ||
|
|
||
| @BugPattern( | ||
| name = "OnlySuppressedInsideDeprecatedCode", | ||
| summary = "Can be suppressed using `@Deprecated`, but not `@SuppressWarnings`", | ||
| severity = ERROR, | ||
| suppressionAnnotations = Deprecated.class) | ||
| public static final class CustomSuppressibilityCheck extends BugChecker | ||
| implements VariableTreeMatcher { | ||
| @Override | ||
| public Description matchVariable(VariableTree tree, VisitorState state) { | ||
| return describeMatch(tree); | ||
| } | ||
| } | ||
| } |