-
Notifications
You must be signed in to change notification settings - Fork 134
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
Feature: Add consistent logging errorprone rule #1644
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
62 changes: 62 additions & 0 deletions
62
...line-error-prone/src/main/java/com/palantir/baseline/errorprone/ConsistentLoggerName.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,62 @@ | ||
/* | ||
* (c) Copyright 2020 Palantir Technologies Inc. All rights reserved. | ||
* | ||
* 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.palantir.baseline.errorprone; | ||
|
||
import com.google.auto.service.AutoService; | ||
import com.google.errorprone.BugPattern; | ||
import com.google.errorprone.VisitorState; | ||
import com.google.errorprone.bugpatterns.BugChecker; | ||
import com.google.errorprone.fixes.SuggestedFixes; | ||
import com.google.errorprone.matchers.Description; | ||
import com.google.errorprone.matchers.Matcher; | ||
import com.google.errorprone.matchers.Matchers; | ||
import com.google.errorprone.matchers.method.MethodMatchers; | ||
import com.sun.source.tree.VariableTree; | ||
import javax.lang.model.element.Modifier; | ||
|
||
@AutoService(BugChecker.class) | ||
@BugPattern( | ||
name = "ConsistentLoggerName", | ||
link = "https://github.com/palantir/gradle-baseline#baseline-error-prone-checks", | ||
linkType = BugPattern.LinkType.CUSTOM, | ||
providesFix = BugPattern.ProvidesFix.REQUIRES_HUMAN_ATTENTION, | ||
severity = BugPattern.SeverityLevel.WARNING, | ||
summary = "Loggers created using getLogger(Class<?>) must be named 'log'.") | ||
public final class ConsistentLoggerName extends BugChecker implements BugChecker.VariableTreeMatcher { | ||
|
||
private static final Matcher<VariableTree> matcher = Matchers.allOf( | ||
Matchers.isField(), | ||
Matchers.isStatic(), | ||
Matchers.hasModifier(Modifier.FINAL), | ||
Matchers.hasModifier(Modifier.PRIVATE), | ||
Matchers.isSubtypeOf("org.slf4j.Logger"), | ||
Matchers.variableInitializer(MethodMatchers.staticMethod() | ||
.onClass("org.slf4j.LoggerFactory") | ||
.named("getLogger") | ||
// Only match the 'class' constructor | ||
.withParameters(Class.class.getName()))); | ||
|
||
@Override | ||
public Description matchVariable(VariableTree tree, VisitorState state) { | ||
if (matcher.matches(tree, state) && !tree.getName().contentEquals("log")) { | ||
return buildDescription(tree) | ||
.addFix(SuggestedFixes.renameVariable(tree, "log", state)) | ||
.build(); | ||
} | ||
return Description.NO_MATCH; | ||
} | ||
} |
114 changes: 114 additions & 0 deletions
114
...-error-prone/src/test/java/com/palantir/baseline/errorprone/ConsistentLoggerNameTest.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,114 @@ | ||
/* | ||
* (c) Copyright 2020 Palantir Technologies Inc. All rights reserved. | ||
* | ||
* 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.palantir.baseline.errorprone; | ||
|
||
import org.junit.jupiter.api.Test; | ||
|
||
class ConsistentLoggerNameTest { | ||
|
||
@Test | ||
void testFix() { | ||
fix().addInputLines( | ||
"Test.java", | ||
"import org.slf4j.*;", | ||
"class Test {", | ||
" private static final Logger LOG = LoggerFactory.getLogger(Test.class);", | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. how about There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Everything goes to |
||
"}") | ||
.addOutputLines( | ||
"Test.java", | ||
"import org.slf4j.*;", | ||
"class Test {", | ||
" private static final Logger log = LoggerFactory.getLogger(Test.class);", | ||
"}") | ||
.doTest(); | ||
} | ||
|
||
@Test | ||
void testFix_references() { | ||
fix().addInputLines( | ||
"Test.java", | ||
"import org.slf4j.*;", | ||
"class Test {", | ||
" private static final Logger LOG = LoggerFactory.getLogger(Test.class);", | ||
" private void foo() {", | ||
" LOG.error(\"error\");", | ||
" }", | ||
"}") | ||
.addOutputLines( | ||
"Test.java", | ||
"import org.slf4j.*;", | ||
"class Test {", | ||
" private static final Logger log = LoggerFactory.getLogger(Test.class);", | ||
" private void foo() {", | ||
" log.error(\"error\");", | ||
" }", | ||
"}") | ||
.doTest(); | ||
} | ||
|
||
@Test | ||
void ignores_local_variables() { | ||
fix().addInputLines( | ||
"Test.java", | ||
"import org.slf4j.*;", | ||
"class Test {", | ||
" private Logger LOG = LoggerFactory.getLogger(Test.class);", | ||
"}") | ||
.expectUnchanged() | ||
.doTest(); | ||
} | ||
|
||
@Test | ||
void ignores_non_final_fields() { | ||
fix().addInputLines( | ||
"Test.java", | ||
"import org.slf4j.*;", | ||
"class Test {", | ||
" private static Logger LOG = LoggerFactory.getLogger(Test.class);", | ||
"}") | ||
.expectUnchanged() | ||
.doTest(); | ||
} | ||
|
||
@Test | ||
void ignores_non_private_fields() { | ||
fix().addInputLines( | ||
"Test.java", | ||
"import org.slf4j.*;", | ||
"class Test {", | ||
" static Logger LOG = LoggerFactory.getLogger(Test.class);", | ||
"}") | ||
.expectUnchanged() | ||
.doTest(); | ||
} | ||
|
||
@Test | ||
void ignores_field_on_interface() { | ||
fix().addInputLines( | ||
"Test.java", | ||
"import org.slf4j.*;", | ||
"interface Test {", | ||
" static Logger LOG = LoggerFactory.getLogger(Test.class);", | ||
"}") | ||
.expectUnchanged() | ||
.doTest(); | ||
} | ||
|
||
private RefactoringValidator fix() { | ||
return RefactoringValidator.of(new ConsistentLoggerName(), getClass()); | ||
} | ||
} |
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,5 @@ | ||
type: feature | ||
feature: | ||
description: Add consistent logging errorprone rule | ||
links: | ||
- https://github.com/palantir/gradle-baseline/pull/1644 |
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
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.
Thoughts on filtering down to
static final
fields in this case? I think we should add other rules to require loggers to be private+static+final, but in the case of odd legacy code we should flag the most specific failure. I'm not confident we'd want instance loggers to be renamed automatically, I just don't have a good enough sense for all the places they might exist.