org.sonar.java.checks.CatchUsesExceptionWithContextCheck Maven / Gradle / Ivy
/*
* SonarQube Java
* Copyright (C) 2012-2024 SonarSource SA
* mailto:info AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the Sonar Source-Available License Version 1, as published by SonarSource SA.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the Sonar Source-Available License for more details.
*
* You should have received a copy of the Sonar Source-Available License
* along with this program; if not, see https://sonarsource.com/license/ssal/
*/
package org.sonar.java.checks;
import java.util.ArrayDeque;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Deque;
import java.util.HashSet;
import java.util.List;
import java.util.Objects;
import java.util.Set;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import javax.annotation.CheckForNull;
import javax.annotation.Nullable;
import org.apache.commons.lang3.StringUtils;
import org.sonar.check.Rule;
import org.sonar.check.RuleProperty;
import org.sonar.java.checks.helpers.ExpressionsHelper;
import org.sonar.plugins.java.api.JavaFileScanner;
import org.sonar.plugins.java.api.JavaFileScannerContext;
import org.sonar.plugins.java.api.semantic.MethodMatchers;
import org.sonar.plugins.java.api.semantic.Symbol;
import org.sonar.plugins.java.api.tree.Arguments;
import org.sonar.plugins.java.api.tree.AssignmentExpressionTree;
import org.sonar.plugins.java.api.tree.BaseTreeVisitor;
import org.sonar.plugins.java.api.tree.CatchTree;
import org.sonar.plugins.java.api.tree.ClassTree;
import org.sonar.plugins.java.api.tree.ExpressionTree;
import org.sonar.plugins.java.api.tree.IdentifierTree;
import org.sonar.plugins.java.api.tree.LambdaExpressionTree;
import org.sonar.plugins.java.api.tree.MemberSelectExpressionTree;
import org.sonar.plugins.java.api.tree.MethodInvocationTree;
import org.sonar.plugins.java.api.tree.NewClassTree;
import org.sonar.plugins.java.api.tree.ParenthesizedTree;
import org.sonar.plugins.java.api.tree.Tree;
import org.sonar.plugins.java.api.tree.Tree.Kind;
import org.sonar.plugins.java.api.tree.TryStatementTree;
import org.sonar.plugins.java.api.tree.UnionTypeTree;
import org.sonar.plugins.java.api.tree.VariableTree;
import static org.sonar.java.model.ExpressionUtils.skipParentheses;
@Rule(key = "S1166")
public class CatchUsesExceptionWithContextCheck extends BaseTreeVisitor implements JavaFileScanner {
private static final MethodMatchers GET_MESSAGE_METHODS = MethodMatchers.create()
.ofSubTypes("java.lang.Throwable")
.names("getMessage", "getLocalizedMessage")
.addWithoutParametersMatcher()
.build();
private static final String JAVA_UTIL_LOGGING_LOGGER = "java.util.logging.Logger";
private static final String SLF4J_LOGGER = "org.slf4j.Logger";
private static final MethodMatchers JAVA_UTIL_LOG_METHOD = MethodMatchers.create()
.ofTypes(JAVA_UTIL_LOGGING_LOGGER).names("log").withAnyParameters().build();
private static final MethodMatchers JAVA_UTIL_LOGP_METHOD = MethodMatchers.create()
.ofTypes(JAVA_UTIL_LOGGING_LOGGER).names("logp").withAnyParameters().build();
private static final MethodMatchers JAVA_UTIL_LOGRB_METHOD = MethodMatchers.create()
.ofTypes(JAVA_UTIL_LOGGING_LOGGER).names("logrb").withAnyParameters().build();
private static final MethodMatchers LOGGING_METHODS = MethodMatchers.or(
MethodMatchers.create().ofAnyType().name(CatchUsesExceptionWithContextCheck::containsLogIgnoreCase).withAnyParameters().build(),
MethodMatchers.create().ofType(type -> containsLogIgnoreCase(type.name())).anyName().withAnyParameters().build(),
MethodMatchers.create()
.ofTypes(JAVA_UTIL_LOGGING_LOGGER).names("config", "fine", "finer", "finest", "info", "severe", "warning").withAnyParameters().build(),
JAVA_UTIL_LOG_METHOD,
JAVA_UTIL_LOGP_METHOD,
JAVA_UTIL_LOGRB_METHOD,
MethodMatchers.create()
.ofTypes(SLF4J_LOGGER).names("debug", "error", "info", "trace", "warn").withAnyParameters().build());
private static final String EXCLUDED_EXCEPTION_TYPE = "java.lang.InterruptedException, " +
"java.lang.NumberFormatException, " +
"java.lang.NoSuchMethodException, " +
"java.text.ParseException, " +
"java.net.MalformedURLException, " +
"java.time.format.DateTimeParseException";
@RuleProperty(
key = "exceptions",
description = "List of exceptions which should not be checked. Use a simple dash ('-') character to check all exceptions.",
defaultValue = "" + EXCLUDED_EXCEPTION_TYPE)
public String exceptionsCommaSeparated = EXCLUDED_EXCEPTION_TYPE;
private JavaFileScannerContext context;
private Deque usageStatusStack;
private Set exceptions;
private Set exceptionIdentifiers;
private Set excludedCatchTrees = new HashSet<>();
@Override
public void scanFile(JavaFileScannerContext context) {
this.context = context;
usageStatusStack = new ArrayDeque<>();
if (context.getSemanticModel() != null) {
scan(context.getTree());
}
excludedCatchTrees.clear();
}
@Override
public void visitTryStatement(TryStatementTree tree) {
if (containsEnumValueOf(tree.block())) {
tree.catches().stream()
.filter(c -> c.parameter().symbol().type().is("java.lang.IllegalArgumentException"))
.findAny()
.ifPresent(excludedCatchTrees::add);
}
super.visitTryStatement(tree);
}
private static boolean containsEnumValueOf(Tree tree) {
EnumValueOfVisitor visitor = new EnumValueOfVisitor();
tree.accept(visitor);
return visitor.hasEnumValueOf;
}
private static boolean containsLogIgnoreCase(String name) {
return StringUtils.containsIgnoreCase(name, "log");
}
private static class EnumValueOfVisitor extends BaseTreeVisitor {
private static final MethodMatchers ENUM_VALUE_OF = MethodMatchers.create()
.ofSubTypes("java.lang.Enum")
.names("valueOf")
.withAnyParameters()
.build();
private boolean hasEnumValueOf = false;
@Override
public void visitMethodInvocation(MethodInvocationTree tree) {
if (ENUM_VALUE_OF.matches(tree)) {
hasEnumValueOf = true;
}
super.visitMethodInvocation(tree);
}
@Override
public void visitClass(ClassTree tree) {
// skip anonymous classes
}
@Override
public void visitLambdaExpression(LambdaExpressionTree lambdaExpressionTree) {
// skip lambdas
}
}
@Override
public void visitCatch(CatchTree tree) {
if (!isExcludedType(tree.parameter().type()) && !excludedCatchTrees.contains(tree)) {
Symbol exception = tree.parameter().symbol();
usageStatusStack.addFirst(new UsageStatus(exception.usages()));
super.visitCatch(tree);
if (usageStatusStack.pop().isInvalid()) {
context.reportIssue(this, tree.parameter(), "Either log or rethrow this exception.");
}
}
}
@Override
public void visitMethodInvocation(MethodInvocationTree mit) {
super.visitMethodInvocation(mit);
if (LOGGING_METHODS.matches(mit) || mit.methodSymbol().isUnknown()) {
usageStatusStack.forEach(usageStatus -> usageStatus.addLoggingMethodInvocation(mit));
}
}
@Override
public void visitMemberSelectExpression(MemberSelectExpressionTree tree) {
final IdentifierTree identifier;
ExpressionTree expression = tree.expression();
if (expression.is(Kind.IDENTIFIER)) {
identifier = (IdentifierTree) expression;
} else if (expression.is(Kind.PARENTHESIZED_EXPRESSION) && ((ParenthesizedTree) expression).expression().is(Kind.IDENTIFIER)) {
identifier = (IdentifierTree) ((ParenthesizedTree) expression).expression();
} else {
identifier = null;
}
if (!usageStatusStack.isEmpty() && identifier != null) {
usageStatusStack.forEach(usageStatus -> usageStatus.addInvalidUsage(identifier));
}
super.visitMemberSelectExpression(tree);
}
private boolean isExcludedType(Tree tree) {
if (tree.is(Kind.UNION_TYPE)) {
return ((UnionTypeTree) tree).typeAlternatives().stream().allMatch(this::isExcludedType);
}
return isUnqualifiedExcludedType(tree) ||
isQualifiedExcludedType(tree);
}
private boolean isUnqualifiedExcludedType(Tree tree) {
return tree.is(Kind.IDENTIFIER) &&
getExceptionIdentifiers().contains(((IdentifierTree) tree).name());
}
private boolean isQualifiedExcludedType(Tree tree) {
if (!tree.is(Kind.MEMBER_SELECT)) {
return false;
}
return getExceptions().contains(ExpressionsHelper.concatenate((MemberSelectExpressionTree) tree));
}
private Set getExceptions() {
if (exceptions == null) {
if ("-".equals(exceptionsCommaSeparated.trim())) {
// explicitly handle '-' as discarding character
exceptions = Collections.emptySet();
} else {
exceptions = Stream.of(exceptionsCommaSeparated.split(",")).map(String::trim).collect(Collectors.toSet());
}
}
return exceptions;
}
private Set getExceptionIdentifiers() {
if (exceptionIdentifiers == null) {
exceptionIdentifiers = getExceptions().stream()
.map(exception -> exception.substring(exception.lastIndexOf('.') + 1))
.collect(Collectors.toSet());
}
return exceptionIdentifiers;
}
private static class UsageStatus {
private final Collection validUsages;
private final List loggingMethodInvocations;
UsageStatus(Collection usages) {
validUsages = new ArrayList<>(usages);
loggingMethodInvocations = new ArrayList<>();
}
public void addInvalidUsage(IdentifierTree exceptionIdentifier) {
validUsages.remove(exceptionIdentifier);
}
public void addLoggingMethodInvocation(MethodInvocationTree mit) {
loggingMethodInvocations.add(mit);
}
public boolean isInvalid() {
return validUsages.isEmpty() && !isMessageLoggedWithAdditionalContext();
}
private boolean isMessageLoggedWithAdditionalContext() {
return loggingMethodInvocations.stream().anyMatch(mit -> hasGetMessageInvocation(mit) && hasDynamicExceptionMessageUsage(mit));
}
private static boolean hasGetMessageInvocation(MethodInvocationTree mit) {
return hasGetMessageMethodInvocation(mit) || isGetMessageReferencedByIdentifiers(mit);
}
private static boolean isGetMessageReferencedByIdentifiers(MethodInvocationTree mit) {
ChildrenIdentifierCollector visitor = new ChildrenIdentifierCollector();
mit.accept(visitor);
boolean invocationInInitializer = visitor.identifiersChildren.stream()
.map(UsageStatus::getVariableInitializer)
.distinct()
.anyMatch(UsageStatus::hasGetMessageMethodInvocation);
return invocationInInitializer || visitor.identifiersChildren.stream()
.map(IdentifierTree::symbol)
.map(Symbol::usages)
.flatMap(usagesList -> getAssignments(usagesList).stream())
.anyMatch(assignment -> hasGetMessageMethodInvocation(assignment.expression()));
}
private static boolean hasGetMessageMethodInvocation(@Nullable Tree tree) {
if (tree == null) {
return false;
}
GetExceptionMessageVisitor visitor = new GetExceptionMessageVisitor();
tree.accept(visitor);
return visitor.hasGetMessageCall;
}
private static boolean hasDynamicExceptionMessageUsage(MethodInvocationTree mit) {
Arguments arguments = mit.arguments();
int argumentsCount = arguments.size();
if (argumentsCount == 0) {
return true;
}
ExpressionTree firstArg = arguments.get(0);
ExpressionTree argumentToCheck;
if (mit.methodSymbol().owner().type().is(SLF4J_LOGGER)) {
if (argumentsCount == 1) {
argumentToCheck = firstArg;
} else if (argumentsCount == 2 && firstArg.symbolType().is("org.slf4j.Marker")) {
argumentToCheck = arguments.get(1);
} else {
argumentToCheck = null;
}
} else if (JAVA_UTIL_LOG_METHOD.matches(mit) && argumentsCount == 2) {
argumentToCheck = arguments.get(1);
} else if (JAVA_UTIL_LOGP_METHOD.matches(mit) && argumentsCount == 4) {
argumentToCheck = arguments.get(3);
} else if (JAVA_UTIL_LOGRB_METHOD.matches(mit) && argumentsCount == 5) {
argumentToCheck = arguments.get(4);
} else {
argumentToCheck = firstArg;
}
return argumentToCheck == null || !isSimpleExceptionMessage(argumentToCheck);
}
private static boolean isSimpleExceptionMessage(ExpressionTree expressionTree) {
ExpressionTree innerExpression = skipParentheses(expressionTree);
if (innerExpression.is(Kind.IDENTIFIER)) {
IdentifierTree variable = (IdentifierTree) innerExpression;
List assignments = getAssignments(variable.symbol().usages());
ExpressionTree initializer = getVariableInitializer(variable);
return assignments.isEmpty() && initializer != null && isSimpleExceptionMessage(initializer);
} else if (innerExpression.is(Kind.METHOD_INVOCATION)) {
return GET_MESSAGE_METHODS.matches(((MethodInvocationTree) innerExpression));
}
return false;
}
private static List getAssignments(List usages) {
return usages.stream().map(UsageStatus::getAssignmentToIdentifier).filter(Objects::nonNull).toList();
}
@CheckForNull
private static AssignmentExpressionTree getAssignmentToIdentifier(IdentifierTree usage) {
Tree parent = usage.parent();
while (parent != null) {
if (parent.is(Kind.ASSIGNMENT, Kind.PLUS_ASSIGNMENT)) {
AssignmentExpressionTree assignmentExpressionTree = (AssignmentExpressionTree) parent;
if (assignmentExpressionTree.variable().equals(usage)) {
return assignmentExpressionTree;
} else {
return null;
}
}
parent = parent.parent();
}
return null;
}
@CheckForNull
private static ExpressionTree getVariableInitializer(IdentifierTree variable) {
Tree declaration = variable.symbol().declaration();
if (declaration != null && declaration.is(Kind.VARIABLE)) {
return ((VariableTree) declaration).initializer();
}
return null;
}
}
private static class GetExceptionMessageVisitor extends BaseTreeVisitor {
boolean hasGetMessageCall = false;
@Override
public void visitMethodInvocation(MethodInvocationTree mit) {
if (!hasGetMessageCall && GET_MESSAGE_METHODS.matches(mit)) {
hasGetMessageCall = true;
}
super.visitMethodInvocation(mit);
}
@Override
public void visitNewClass(NewClassTree newClassTree) {
// skip method invocations found in a NewClassTree
}
}
private static class ChildrenIdentifierCollector extends BaseTreeVisitor {
Set identifiersChildren = new HashSet<>();
@Override
public void visitIdentifier(IdentifierTree tree) {
identifiersChildren.add(tree);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy