Skip to content
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.

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

Support @SuppressWarnings("all") #4076

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,8 @@ public SuppressedState suppressedState(
return SuppressedState.SUPPRESSED;
}
if (suppressible.supportsSuppressWarnings()
&& !Collections.disjoint(suppressible.allNames(), suppressWarningsStrings)) {
&& (suppressWarningsStrings.contains("all")
|| !Collections.disjoint(suppressible.allNames(), suppressWarningsStrings))) {
return SuppressedState.SUPPRESSED;
}
if (suppressible.suppressedByAnyOf(customSuppressions, state)) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@
import java.lang.annotation.Annotation;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Set;
import java.util.function.BiPredicate;
Expand Down Expand Up @@ -269,8 +270,12 @@ public boolean isSuppressed(Symbol symbol) {
}

private boolean isSuppressed(SuppressWarnings suppression) {
return suppression != null
&& !Collections.disjoint(Arrays.asList(suppression.value()), allNames());
if (suppression == null || !supportsSuppressWarnings()) {
return false;
}

List<String> suppressions = Arrays.asList(suppression.value());
return suppressions.contains("all") || !Collections.disjoint(suppressions, allNames());
}
Comment on lines 272 to 279
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This method is effectively deprecated, since it's only called by deprecated code; the first test below covers it.


/**
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,182 @@
/*
* 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();
}
Comment on lines +35 to +63
Copy link
Contributor Author

Choose a reason for hiding this comment

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

The final test case here shows why the code under test is deprecated: the suppressionAnnotations = Deprecated.class directive isn't respected.


@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);
}
}
}
Loading