Skip to content

Ignore non-literal arg names in LogsafeArgName #1465

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
merged 4 commits into from
Aug 3, 2020
Merged

Ignore non-literal arg names in LogsafeArgName #1465

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c559e8f
Ignore non-literal arg names in LogsafeArgName
pkoenig10 Aug 3, 2020
82bfb28
Add generated changelog entries
pkoenig10 Aug 3, 2020
e0aa047
Combine
pkoenig10 Aug 3, 2020
24ee906
Clean up
pkoenig10 Aug 3, 2020
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
5 changes: 1 addition & 4 deletions baseline-error-prone/src/main/java/com/palantir/baseline/errorprone/LogsafeArgName.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
import com.google.errorprone.bugpatterns.BugChecker.MethodInvocationTreeMatcher;
import com.google.errorprone.fixes.SuggestedFix;
import com.google.errorprone.fixes.SuggestedFixes;
import com.google.errorprone.matchers.CompileTimeConstantExpressionMatcher;
import com.google.errorprone.matchers.Description;
import com.google.errorprone.matchers.Matcher;
import com.google.errorprone.matchers.Matchers;
Expand All @@ -49,8 +48,6 @@ public final class LogsafeArgName extends BugChecker implements MethodInvocation

private static final Matcher<ExpressionTree> SAFE_ARG_OF =
Matchers.staticMethod().onClass("com.palantir.logsafe.SafeArg").named("of");
private final Matcher<ExpressionTree> compileTimeConstExpressionMatcher =
new CompileTimeConstantExpressionMatcher();

private final Set<String> unsafeParamNames;

Expand All @@ -72,7 +69,7 @@ public Description matchMethodInvocation(MethodInvocationTree tree, VisitorState

List<? extends ExpressionTree> args = tree.getArguments();
ExpressionTree argNameExpression = args.get(0);
if (compileTimeConstExpressionMatcher.matches(argNameExpression, state)) {
if (argNameExpression instanceof JCTree.JCLiteral) {
String argName = (String) ((JCTree.JCLiteral) argNameExpression).getValue();
if (unsafeParamNames.stream().anyMatch(unsafeArgName -> unsafeArgName.equalsIgnoreCase(argName))) {
SuggestedFix.Builder builder = SuggestedFix.builder();
Expand Down
17 changes: 17 additions & 0 deletions baseline-error-prone/src/test/java/com/palantir/baseline/errorprone/LogsafeArgNameTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,23 @@ public void ignores_safe_arg_names() {
.doTest();
}

@Test
public void ignores_identifier_arg_names() {
getCompilationHelper()
.addSourceLines(
"Test.java",
"import com.palantir.logsafe.SafeArg;",
"import java.lang.String;",
"class Test {",
" static final String NAME = \"name\";",
" void f() {",
" SafeArg.of(NAME, 1);",
" }",
"",
"}")
.doTest();
}

private static RefactoringValidator getRefactoringHelper() {
return RefactoringValidator.of(
new LogsafeArgName(ErrorProneFlags.builder()
Expand Down
5 changes: 5 additions & 0 deletions changelog/@unreleased/pr-1465.v2.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
type: fix
fix:
description: The `LogsafeArgName` now ignores arg names that are not literals.
links:
- https://github.com/palantir/gradle-baseline/pull/1465