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.

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

Fix UseSLF4JLoggerRule #1

Merged
merged 1 commit into from
Mar 1, 2024
Merged

Fix UseSLF4JLoggerRule #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 13 additions & 17 deletions custom-checks/pmd/src/main/java/org/openhab/tools/analysis/pmd/UseSLF4JLoggerRule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,11 @@
import java.util.HashSet;
import java.util.Set;

import net.sourceforge.pmd.lang.ast.Node;
import net.sourceforge.pmd.lang.java.ast.ASTClassOrInterfaceType;
import net.sourceforge.pmd.lang.java.ast.ASTImportDeclaration;
import net.sourceforge.pmd.lang.java.ast.ASTReferenceType;
import net.sourceforge.pmd.lang.java.ast.ASTType;
import net.sourceforge.pmd.lang.java.ast.ASTVariableDeclarator;
import net.sourceforge.pmd.lang.java.rule.AbstractJavaRule;
import net.sourceforge.pmd.lang.java.symbols.JTypeDeclSymbol;

/**
* Checks if a logger other than the one provided by slf4j is used
Expand All @@ -41,6 +39,11 @@ public UseSLF4JLoggerRule() {
forbiddenLoggers.add("org.apache.commons.logging.Log");
}

@Override
public String getMessage() {
return "The org.slf4j Logger should be used";
}

@Override
public Object visit(ASTImportDeclaration node, Object data) {
String fullImportName = node.getImportedName();
Expand All @@ -56,19 +59,12 @@ public Object visit(ASTImportDeclaration node, Object data) {
@Override
public Object visit(ASTVariableDeclarator node, Object data) {
ASTType typeNode = node.getParent().firstChild(ASTType.class);
if (typeNode != null) {
// getChild(0) returns out of bounds if no child exists, getFirstChild returns null
Node reftypeNode = typeNode.getFirstChild();
if (reftypeNode instanceof ASTReferenceType) {
ASTClassOrInterfaceType classOrInterfaceType = reftypeNode.firstChild(ASTClassOrInterfaceType.class);
if (classOrInterfaceType != null) {
// getImage will now return null, not sure if getSimpleName is the correct replacement
String className = classOrInterfaceType.getSimpleName();

if (isClassNameForbidden(className)) {
asCtx(data).addViolation(typeNode);
}
}
if (typeNode != null && typeNode.getTypeMirror().isClassOrInterface()) {
JTypeDeclSymbol symbol = typeNode.getTypeMirror().getSymbol();
String className = symbol.getPackageName().equals(symbol.getSimpleName()) ? symbol.getSimpleName()
: symbol.getPackageName() + "." + symbol.getSimpleName();
if (isClassNameForbidden(className)) {
asCtx(data).addViolation(typeNode);
}
}
return super.visit(node, data);
Expand All @@ -79,7 +75,7 @@ private boolean isClassNameForbidden(String className) {
return true;
}
// If the className is Logger but org.slf4j is not in the imports,
// that means the current Logger literal is not a sfl4j.Logger
// that means the current Logger literal is not an org.slf4j.Logger
return LOGGER_LITERAL.equals(className) && !isSlf4jPackageImported;
}
}
3 changes: 1 addition & 2 deletions sat-plugin/src/main/resources/rulesets/pmd/customrules.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.net/ruleset_2_0_0.xsd">
<description>Rule set that contains custom rules created for checking all bundles</description>
<rule class="org.openhab.tools.analysis.pmd.UseSLF4JLoggerRule" name="UseSLF4J" language="java"
message="The org.slf4j Logger should be used">
<rule class="org.openhab.tools.analysis.pmd.UseSLF4JLoggerRule" name="UseSLF4J" language="java">
<priority>3</priority>
</rule>
</ruleset>