Skip to content
Merged
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 @@ -21,14 +21,14 @@
import org.sonar.java.checks.helpers.NumericConversionUtils;
import org.sonar.java.checks.helpers.QuickFixHelper;
import org.sonar.java.model.ExpressionUtils;
import org.sonar.java.model.JProblem;
import org.sonar.java.model.JWarning;
import org.sonar.java.model.JavaTree;
import org.sonar.java.reporting.AnalyzerMessage;
import org.sonar.java.reporting.JavaQuickFix;
import org.sonar.java.reporting.JavaTextEdit;
import org.sonar.plugins.java.api.IssuableSubscriptionVisitor;
import org.sonar.plugins.java.api.diagnostics.ProblemKind;
import org.sonar.plugins.java.api.diagnostics.Warning;
import org.sonar.plugins.java.api.semantic.Type;
import org.sonar.plugins.java.api.tree.CompilationUnitTree;
import org.sonar.plugins.java.api.tree.ExpressionTree;
import org.sonar.plugins.java.api.tree.MemberSelectExpressionTree;
import org.sonar.plugins.java.api.tree.MethodInvocationTree;
Expand All @@ -40,7 +40,7 @@
@Rule(key = "S1905")
public class RedundantTypeCastCheck extends IssuableSubscriptionVisitor {

private List<JWarning> warnings;
private List<Warning> warnings;

@Override
public List<Tree.Kind> nodesToVisit() {
Expand All @@ -50,7 +50,7 @@ public List<Tree.Kind> nodesToVisit() {
@Override
public void visitNode(Tree tree) {
if (tree.is(Tree.Kind.COMPILATION_UNIT)) {
warnings = ((JavaTree.CompilationUnitTreeImpl) tree).warnings(JProblem.Type.REDUNDANT_CAST);
warnings = ((CompilationUnitTree) tree).warnings(ProblemKind.REDUNDANT_CAST);
return;
}

Expand Down Expand Up @@ -95,7 +95,7 @@ private boolean isUnnecessaryCast(TypeCastTree typeCastTree) {
// returns Class<? extends (receiver type)> at compile time. To prevent false-positives, we ignore this case.
return false;
}
return warnings.stream().anyMatch(warning -> matchesWarning(warning, typeCastTree));
return warnings.stream().anyMatch(warning -> typeCastTree.equals(warning.syntaxTree()));
}

private static boolean isMethodInvocationReceiverOfGetClass(TypeCastTree typeCastTree) {
Expand All @@ -106,16 +106,6 @@ private static boolean isMethodInvocationReceiverOfGetClass(TypeCastTree typeCas
methodInvocation.arguments().isEmpty();
}

private static boolean matchesWarning(JWarning warning, TypeCastTree tree) {
Tree warningTree = warning.syntaxTree();
if (warningTree.is(Tree.Kind.PARENTHESIZED_EXPRESSION)) {
// When a cast expression is nested inside one or more parenthesized expression, Eclipse raises the warning on
// the outermost parenthesized expression rather than the cast expression, so we need to take that into account
return tree.equals(skipParentheses(warningTree));
}
return tree.equals(warningTree);
}

Comment thread
rombirli marked this conversation as resolved.
Resolved
@Override
protected void clearState() {
warnings = null;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,22 +15,23 @@
* along with this program; if not, see https://sonarsource.com/license/ssal/
*/
package org.sonar.java.checks;

import java.util.Arrays;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import org.sonar.check.Rule;
import org.sonar.java.checks.helpers.QuickFixHelper;
import org.sonar.java.model.ExpressionUtils;
import org.sonar.java.model.JProblem;
import org.sonar.java.model.JWarning;
import org.sonar.java.model.JavaTree;
import org.sonar.java.model.SyntacticEquivalence;
import org.sonar.java.reporting.JavaQuickFix;
import org.sonar.java.reporting.JavaTextEdit;
import org.sonar.plugins.java.api.IssuableSubscriptionVisitor;
import org.sonar.plugins.java.api.diagnostics.ProblemKind;
import org.sonar.plugins.java.api.diagnostics.Warning;
import org.sonar.plugins.java.api.tree.AssignmentExpressionTree;
import org.sonar.plugins.java.api.tree.ClassTree;
import org.sonar.plugins.java.api.tree.CompilationUnitTree;
import org.sonar.plugins.java.api.tree.ExpressionTree;
import org.sonar.plugins.java.api.tree.IdentifierTree;
import org.sonar.plugins.java.api.tree.MemberSelectExpressionTree;
Expand All @@ -45,7 +46,7 @@
public class SelfAssignmentCheck extends IssuableSubscriptionVisitor {

private static final String ISSUE_MESSAGE = "Remove or correct this useless self-assignment.";
private final Set<JWarning> warnings = new HashSet<>();
private final Set<Warning> warnings = new HashSet<>();

@Override
public List<Tree.Kind> nodesToVisit() {
Expand All @@ -56,7 +57,7 @@ public List<Tree.Kind> nodesToVisit() {
public void visitNode(Tree tree) {
if (tree.is(Tree.Kind.COMPILATION_UNIT)) {
warnings.clear();
warnings.addAll(((JavaTree.CompilationUnitTreeImpl) tree).warnings(JProblem.Type.ASSIGNMENT_HAS_NO_EFFECT));
warnings.addAll(((CompilationUnitTree) tree).warnings(ProblemKind.ASSIGNMENT_HAS_NO_EFFECT));
return;
}
AssignmentExpressionTree node = (AssignmentExpressionTree) tree;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,14 @@
import java.util.List;
import java.util.Map;
import org.sonar.check.Rule;
import org.sonar.java.model.JProblem;
import org.sonar.java.model.JWarning;
import org.sonar.java.model.JavaTree.CompilationUnitTreeImpl;
import org.sonar.plugins.java.api.IssuableSubscriptionVisitor;
import org.sonar.plugins.java.api.JavaFileScannerContext.Location;
import org.sonar.plugins.java.api.diagnostics.ProblemKind;
import org.sonar.plugins.java.api.diagnostics.Warning;
import org.sonar.plugins.java.api.location.Position;
import org.sonar.plugins.java.api.semantic.Type;
import org.sonar.plugins.java.api.tree.CatchTree;
import org.sonar.plugins.java.api.tree.CompilationUnitTree;
import org.sonar.plugins.java.api.tree.SyntaxToken;
import org.sonar.plugins.java.api.tree.Tree;
import org.sonar.plugins.java.api.tree.TryStatementTree;
Expand All @@ -41,7 +41,7 @@
@Rule(key = "S4970")
public class UnreachableCatchCheck extends IssuableSubscriptionVisitor {

private final List<JWarning> warnings = new ArrayList<>();
private final List<Warning> warnings = new ArrayList<>();
private static final Comparator<Location> LOCATION_COMPARATOR = Comparator.comparing(loc -> Position.startOf(loc.syntaxNode));

@Override
Expand All @@ -53,7 +53,7 @@ public List<Tree.Kind> nodesToVisit() {
public void visitNode(Tree tree) {
if (tree.is(Tree.Kind.COMPILATION_UNIT)) {
warnings.clear();
warnings.addAll(((CompilationUnitTreeImpl) tree).warnings(JProblem.Type.MASKED_CATCH));
warnings.addAll(((CompilationUnitTree) tree).warnings(ProblemKind.MASKED_CATCH));
return;
}
checkWarnings((TryStatementTree) tree);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,25 +21,22 @@
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.stream.Collectors;
import org.sonar.check.Rule;
import org.sonar.java.checks.helpers.ExpressionsHelper;
import org.sonar.java.checks.helpers.QuickFixHelper;
import org.sonar.java.model.JProblem;
import org.sonar.java.model.JWarning;
import org.sonar.java.model.JavaTree.CompilationUnitTreeImpl;
import org.sonar.java.reporting.AnalyzerMessage;
import org.sonar.java.reporting.JavaQuickFix;
import org.sonar.java.reporting.JavaTextEdit;
import org.sonar.plugins.java.api.IssuableSubscriptionVisitor;
import org.sonar.plugins.java.api.diagnostics.ProblemKind;
import org.sonar.plugins.java.api.diagnostics.Warning;
import org.sonar.plugins.java.api.tree.CompilationUnitTree;
import org.sonar.plugins.java.api.tree.ExpressionTree;
import org.sonar.plugins.java.api.tree.ImportTree;
import org.sonar.plugins.java.api.tree.MemberSelectExpressionTree;
import org.sonar.plugins.java.api.tree.PackageDeclarationTree;
import org.sonar.plugins.java.api.tree.SyntaxTrivia;
import org.sonar.plugins.java.api.tree.SyntaxTrivia.CommentKind;
Expand All @@ -50,7 +47,6 @@
@Rule(key = "S1128")
public class UselessImportCheck extends IssuableSubscriptionVisitor {

private static final Pattern COMPILER_WARNING = Pattern.compile("The import ([$\\w]++(\\.[$\\w]++)*+) is never used");
private static final Pattern NON_WORDS_CHARACTERS = Pattern.compile("\\W+");
private static final Pattern JAVADOC_REFERENCE = Pattern.compile("\\{@link[^\\{\\}]++\\}|(@see|@throws)[^\r\n]++[\r\n]");
private static final Pattern MARKDOWN_REFERENCE = Pattern.compile("\\[[^\\[\\]\\r\\n]++\\]");
Expand Down Expand Up @@ -88,50 +84,40 @@ public void visitNode(Tree tree) {
@Override
public void leaveNode(Tree tree) {
if (tree.is(Tree.Kind.COMPILATION_UNIT)) {
handleWarnings(((CompilationUnitTreeImpl) tree).warnings(JProblem.Type.UNUSED_IMPORT));
handleWarnings(((CompilationUnitTree) tree).warnings(ProblemKind.UNUSED_IMPORT));
imports.clear();
}
}

private void handleWarnings(List<JWarning> warnings) {
for (JWarning warning : warnings) {
Matcher matcher = COMPILER_WARNING.matcher(warning.message());
Optional<String> fqn = matcher.find() ? Optional.of(matcher.group(1)) : Optional.empty();
fqn.ifPresent(importName -> {
if (!usedInJavaDoc.contains(importName) && !importName.startsWith("java.lang")) {
String message;
if (duplicatedImports.contains(importName)) {
message = "Remove this duplicated import.";
} else if (isImportFromSamePackage(importName, warning.syntaxTree())) {
message = "Remove this unnecessary import: same package classes are always implicitly imported.";
} else {
message = "Remove this unused import '" + importName + "'.";
}
ImportTree reportTree = (ImportTree) warning.syntaxTree();
QuickFixHelper.newIssue(context)
.forRule(this)
.onTree(reportTree.qualifiedIdentifier())
.withMessage(message)
.withQuickFix(() -> quickFix(reportTree, imports))
.report();
private void handleWarnings(List<Warning> warnings) {
for (Warning warning : warnings) {
ImportTree reportTree = (ImportTree) warning.syntaxTree();
String importName = ExpressionsHelper.concatenate((ExpressionTree) reportTree.qualifiedIdentifier());
boolean onDemand = importName.endsWith(".*");
if (onDemand) {
importName = importName.substring(0, importName.length() - 2);
}
if (!usedInJavaDoc.contains(importName) && !importName.startsWith("java.lang")) {
String message;
if (duplicatedImports.contains(importName)) {
message = "Remove this duplicated import.";
} else if (isImportFromSamePackage(importName, onDemand)) {
message = "Remove this unnecessary import: same package classes are always implicitly imported.";
} else {
message = "Remove this unused import '" + importName + "'.";
}
});
}
}

private boolean isImportFromSamePackage(String importName, Tree tree) {
// ECJ warning message does not contain the ".*" in case of star import, we have to find out if we are in this case.
// Defensive programming, the syntax tree of the warning should always be an ImportTree.
if (tree.is(Tree.Kind.IMPORT)) {
Tree qualifiedIdentifier = ((ImportTree) tree).qualifiedIdentifier();
// Defensive programming, the qualifiedIdentifier should always be a MemberSelectTree.
if (qualifiedIdentifier.is(Tree.Kind.MEMBER_SELECT) &&
"*".equals(((MemberSelectExpressionTree) qualifiedIdentifier).identifier().name())) {
return importName.equals(currentPackage);
QuickFixHelper.newIssue(context)
.forRule(this)
.onTree(reportTree.qualifiedIdentifier())
.withMessage(message)
.withQuickFix(() -> quickFix(reportTree, imports))
.report();
}
}
}

return importName.substring(0, importName.lastIndexOf(".")).equals(currentPackage);
private boolean isImportFromSamePackage(String importName, boolean onDemand) {
return onDemand ? importName.equals(currentPackage) : importName.substring(0, importName.lastIndexOf('.')).equals(currentPackage);
}

private void handleImportTree(ImportTree importTree) {
Expand Down
25 changes: 14 additions & 11 deletions java-frontend/src/main/java/org/sonar/java/SonarComponents.java
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,6 @@
import org.sonar.java.classpath.ClasspathForTest;
import org.sonar.java.exceptions.ApiMismatchException;
import org.sonar.java.model.GeneratedFile;
import org.sonar.java.model.JProblem;
import org.sonar.java.model.LineUtils;
import org.sonar.java.reporting.AnalyzerMessage;
import org.sonar.java.reporting.JavaIssue;
Expand All @@ -74,6 +73,8 @@
import org.sonar.plugins.java.api.JavaFileScanner;
import org.sonar.plugins.java.api.JspCodeVisitor;
import org.sonar.plugins.java.api.caching.SonarLintCache;
import org.sonar.plugins.java.api.diagnostics.Problem;
import org.sonar.plugins.java.api.diagnostics.ProblemKind;
import org.sonarsource.api.sonarlint.SonarLintSide;
import org.sonarsource.sonarlint.plugin.api.SonarLintRuntime;

Expand Down Expand Up @@ -120,7 +121,7 @@ public class SonarComponents extends CheckRegistrar.RegistrarContext {

private final ClasspathForMain javaClasspath;
private final ClasspathForTest javaTestClasspath;
private final Map<JProblem, List<String>> problemsToFilePaths = new HashMap<>();
private final Map<ProblemGroupKey, List<String>> problemsToFilePaths = new HashMap<>();

private final CheckFactory checkFactory;
private final ActiveRules activeRules;
Expand Down Expand Up @@ -613,9 +614,10 @@ public InputComponent project() {
return context.project();
}

public void collectUndefinedTypes(String pathToFile, Set<JProblem> undefinedTypes) {
undefinedTypes.forEach(problem -> {
List<String> filesAffectedByProblem = problemsToFilePaths.computeIfAbsent(problem, key -> new ArrayList<>());
public void collectUndefinedTypes(String pathToFile, Set<? extends Problem> semanticProblems) {
semanticProblems.forEach(problem -> {
ProblemGroupKey problemGroupKey = new ProblemGroupKey(problem.type(), problem.message());
List<String> filesAffectedByProblem = problemsToFilePaths.computeIfAbsent(problemGroupKey, key -> new ArrayList<>());
filesAffectedByProblem.add(pathToFile);
});
}
Expand All @@ -639,31 +641,30 @@ public void logUndefinedTypes() {
private void logUndefinedTypes(int maxLines) {
logParserMessages(
problemsToFilePaths.entrySet().stream()
.filter(entry -> entry.getKey().type() == JProblem.Type.UNDEFINED_TYPE),
.filter(entry -> entry.getKey().type() == ProblemKind.UNDEFINED_TYPE),
maxLines,
"Unresolved imports/types have been detected during analysis. Enable DEBUG mode to see them.",
"Unresolved imports/types:"
);
logParserMessages(
problemsToFilePaths.entrySet().stream()
.filter(entry -> entry.getKey().type() == JProblem.Type.PREVIEW_FEATURE_USED),
.filter(entry -> entry.getKey().type() == ProblemKind.PREVIEW_FEATURE_USED),
maxLines,
"Use of preview features have been detected during analysis. Enable DEBUG mode to see them.",
"Use of preview features:"
);
}

private static void logParserMessages(Stream<Map.Entry<JProblem, List<String>>> messages, int maxProblems, String warningMessage,
String debugMessage) {
private static void logParserMessages(Stream<Map.Entry<ProblemGroupKey, List<String>>> messages, int maxProblems, String warningMessage, String debugMessage) {
String problemDelimiter = System.lineSeparator() + "- ";
List<List<String>> messagesList = messages
.sorted(Comparator.comparing(entry -> entry.getKey().toString()))
.sorted(Comparator.comparing(entry -> entry.getKey().message()))
// We only consider the first `maxProblems` elements. We keep an extra one to know if we passed the threshold in later tests.
.limit(maxProblems + 1L)
.map(entry -> {
List<String> paths = entry.getValue();
List<String> problemAndPaths = new ArrayList<>(paths.size() + 1);
problemAndPaths.add(problemDelimiter + entry.getKey().toString());
problemAndPaths.add(problemDelimiter + entry.getKey().message());
paths.forEach(path -> problemAndPaths.add(" * " + path));
return problemAndPaths;
})
Expand Down Expand Up @@ -700,4 +701,6 @@ public Configuration getConfiguration() {
return context.config();
}

private record ProblemGroupKey(ProblemKind type, String message) {}

}
Original file line number Diff line number Diff line change
Expand Up @@ -39,14 +39,14 @@
import org.sonar.java.annotations.VisibleForTesting;
import org.sonar.java.model.InputFileUtils;
import org.sonar.java.model.JParserConfig;
import org.sonar.java.model.JProblem;
import org.sonar.java.model.JavaTree;
import org.sonar.java.model.VisitorsBridge;
import org.sonar.java.telemetry.NoOpTelemetry;
import org.sonar.java.telemetry.Telemetry;
import org.sonar.java.telemetry.TelemetryKey;
import org.sonar.java.telemetry.TelemetryKey.JavaAnalysisKeys;
import org.sonar.plugins.java.api.JavaVersion;
import org.sonar.plugins.java.api.diagnostics.Problem;
import org.sonar.plugins.java.api.tree.CompilationUnitTree;

import static java.lang.System.currentTimeMillis;
Expand Down Expand Up @@ -165,7 +165,7 @@ public void simpleScan(InputFile inputFile, JParserConfig.Result result, Consume
modifyCompilationUnit.accept(ast);
visitor.visitFile(ast, sonarComponents != null && sonarComponents.fileCanBeSkipped(inputFile));
String path = inputFile.toString();
Set<JProblem> undefinedTypes = ast.undefinedTypes();
Set<Problem> undefinedTypes = ast.semanticProblems();
collectUndefinedTypes(path, undefinedTypes);
cleanUp.accept(ast);
telemetryAnalysisKeys = javaAnalysisKeys.success();
Expand Down Expand Up @@ -198,7 +198,7 @@ private static void cleanUpAst(JavaTree.CompilationUnitTreeImpl ast) {
ast.getEnvironmentCleaner().run();
}

private void collectUndefinedTypes(String path, Set<JProblem> undefinedTypes) {
private void collectUndefinedTypes(String path, Set<Problem> undefinedTypes) {
if (sonarComponents != null) {
sonarComponents.collectUndefinedTypes(path, undefinedTypes);
}
Expand Down
Loading
Loading