SONARJAVA-1437 Update subset of rules to highlight precise location

Author: mpaladin

its/ruling/src/test/resources/commons-beanutils/squid-S138.json

@@ -1,6 +1,6 @@
 {
 'commons-beanutils:commons-beanutils:src/main/java/org/apache/commons/beanutils/BeanUtilsBean.java':[
-327,
-861,
+326,
+860,
 ],
 }

java-checks/src/main/java/org/sonar/java/checks/AvoidDESCheck.java

@@ -55,19 +55,18 @@ protected List<MethodMatcher> getMethodInvocationMatchers() {
   protected void onMethodInvocationFound(MethodInvocationTree mit) {
     ExpressionTree firstArg = mit.arguments().get(0);
     ExpressionTree defaultPropertyValue = JavaPropertiesHelper.retrievedPropertyDefaultValue(firstArg);
-    if (defaultPropertyValue != null) {
-      firstArg = defaultPropertyValue;
+    if (defaultPropertyValue == null) {
+      defaultPropertyValue = firstArg;
     }
-    if (firstArg != null && firstArg.is(Tree.Kind.STRING_LITERAL)) {
-      String algo = LiteralUtils.trimQuotes(((LiteralTree) firstArg).value());
-      checkIssue(mit, algo);
+    if (defaultPropertyValue != null && defaultPropertyValue.is(Tree.Kind.STRING_LITERAL)) {
+      checkIssue(firstArg, (LiteralTree) defaultPropertyValue);
     }
   }
 
-  private void checkIssue(Tree tree, String algorithm) {
-    String[] transformationElements = algorithm.split("/");
+  private void checkIssue(ExpressionTree argumentForReport, LiteralTree argument) {
+    String[] transformationElements = LiteralUtils.trimQuotes(argument.value()).split("/");
     if (transformationElements.length > 0 && isExcludedAlgorithm(transformationElements[0])) {
-      addIssue(tree, "Use the recommended AES (Advanced Encryption Standard) instead.");
+      reportIssue(argumentForReport, "Use the recommended AES (Advanced Encryption Standard) instead.");
     }
   }
 

java-checks/src/main/java/org/sonar/java/checks/CloneMethodCallsSuperCloneCheck.java

@@ -66,7 +66,7 @@ public void visitNode(Tree tree) {
   @Override
   public void leaveNode(Tree tree) {
     if (isCloneMethod(tree) && !foundSuperClone) {
-      addIssue(tree, "Use super.clone() to create and seed the cloned instance to be returned.");
+      reportIssue(((MethodTree) tree).simpleName(), "Use super.clone() to create and seed the cloned instance to be returned.");
     }
   }
 
@@ -86,14 +86,14 @@ private static boolean isSuperCloneCall(Tree tree) {
     MethodInvocationTree mit = (MethodInvocationTree) tree;
 
     return mit.arguments().isEmpty() &&
-        mit.methodSelect().is(Kind.MEMBER_SELECT) &&
-        isSuperClone((MemberSelectExpressionTree) mit.methodSelect());
+      mit.methodSelect().is(Kind.MEMBER_SELECT) &&
+      isSuperClone((MemberSelectExpressionTree) mit.methodSelect());
   }
 
   private static boolean isSuperClone(MemberSelectExpressionTree tree) {
     return "clone".equals(tree.identifier().name()) &&
-        tree.expression().is(Kind.IDENTIFIER) &&
-        "super".equals(((IdentifierTree) tree.expression()).name());
+      tree.expression().is(Kind.IDENTIFIER) &&
+      "super".equals(((IdentifierTree) tree.expression()).name());
   }
 
 }

java-checks/src/main/java/org/sonar/java/checks/CompareToReturnValueCheck.java

@@ -87,7 +87,7 @@ private class ReturnStatementVisitor extends BaseTreeVisitor {
     @Override
     public void visitReturnStatement(ReturnStatementTree tree) {
       if (returnsIntegerMinValue(tree.expression())) {
-        addIssue(tree, "Simply return -1");
+        reportIssue(tree.expression(), "Simply return -1");
       }
     }
 

java-checks/src/main/java/org/sonar/java/checks/DefaultInitializedFieldCheck.java

@@ -71,7 +71,7 @@ private void checkVariable(VariableTree member) {
     if (initializer != null) {
       initializer = ExpressionsHelper.skipParentheses(initializer);
       if (isDefault(initializer, member.type().symbolType().isPrimitive())) {
-        addIssue(member, "Remove this initialization to \"" + ((LiteralTree) initializer).value() + "\", the compiler will do that for you.");
+        reportIssue(initializer, "Remove this initialization to \"" + ((LiteralTree) initializer).value() + "\", the compiler will do that for you.");
       }
     }
   }

java-checks/src/main/java/org/sonar/java/checks/FinalizeFieldsSetCheck.java

@@ -84,7 +84,7 @@ public void visitClass(ClassTree tree) {
     @Override
     public void visitAssignmentExpression(AssignmentExpressionTree tree) {
       if (isFieldAssignment(tree) && isNullAssignment(tree)) {
-        addIssue(tree, "Remove this nullification of \"" + getFieldName(tree) + "\".");
+        reportIssue(tree.expression(), "Remove this nullification of \"" + getFieldName(tree) + "\".");
       }
     }
 

java-checks/src/main/java/org/sonar/java/checks/GarbageCollectorCalledCheck.java

@@ -44,7 +44,6 @@
 @SqaleConstantRemediation("30min")
 public class GarbageCollectorCalledCheck extends SubscriptionBaseVisitor {
 
-
   @Override
   public List<Tree.Kind> nodesToVisit() {
     return ImmutableList.of(Tree.Kind.METHOD_INVOCATION);
@@ -56,7 +55,7 @@ public void visitNode(Tree tree) {
     if (mit.arguments().isEmpty() && mit.methodSelect().is(Tree.Kind.MEMBER_SELECT)) {
       MemberSelectExpressionTree mset = (MemberSelectExpressionTree) mit.methodSelect();
       if (isGarbageCollectorCall(mset)) {
-        addIssue(tree, "Don't try to be smarter than the JVM, remove this call to run the garbage collector.");
+        reportIssue(mset.identifier(), "Don't try to be smarter than the JVM, remove this call to run the garbage collector.");
       }
     }
   }
@@ -68,12 +67,12 @@ private static boolean isGarbageCollectorCall(MemberSelectExpressionTree mset) {
         return "System".equals(((IdentifierTree) mset.expression()).name());
       } else if (mset.expression().is(Tree.Kind.METHOD_INVOCATION)) {
         MethodInvocationTree mit = (MethodInvocationTree) mset.expression();
-        if(mit.arguments().isEmpty() && mit.methodSelect().is(Tree.Kind.MEMBER_SELECT)) {
+        if (mit.arguments().isEmpty() && mit.methodSelect().is(Tree.Kind.MEMBER_SELECT)) {
           MemberSelectExpressionTree subMset = (MemberSelectExpressionTree) mit.methodSelect();
           //detect call to Runtime.getRuntime().gc()
           return "getRuntime".equals(subMset.identifier().name())
-              && subMset.expression().is(Tree.Kind.IDENTIFIER)
-              && "Runtime".equals(((IdentifierTree) subMset.expression()).name());
+            && subMset.expression().is(Tree.Kind.IDENTIFIER)
+            && "Runtime".equals(((IdentifierTree) subMset.expression()).name());
         }
       }
     }

java-checks/src/main/java/org/sonar/java/checks/IgnoredReturnValueCheck.java

@@ -28,6 +28,7 @@
 import org.sonar.plugins.java.api.semantic.Symbol;
 import org.sonar.plugins.java.api.semantic.Type;
 import org.sonar.plugins.java.api.tree.ExpressionStatementTree;
+import org.sonar.plugins.java.api.tree.IdentifierTree;
 import org.sonar.plugins.java.api.tree.MethodInvocationTree;
 import org.sonar.plugins.java.api.tree.Tree;
 import org.sonar.squidbridge.annotations.SqaleConstantRemediation;
@@ -68,7 +69,8 @@ public void visitNode(Tree tree) {
       MethodInvocationTree mit = (MethodInvocationTree) est.expression();
       Type methodType = mit.symbolType();
       if (!returnsVoid(methodType) && isCheckedType(mit)) {
-        addIssue(tree, "The return value of \"" + methodName(mit) + "\" must be used.");
+        IdentifierTree methodName = MethodsHelper.methodName(mit);
+        reportIssue(methodName, "The return value of \"" + methodName.name() + "\" must be used.");
       }
     }
   }
@@ -87,7 +89,4 @@ private static boolean returnsVoid(Type methodType) {
     return methodType.isVoid() || methodType.isUnknown();
   }
 
-  private static String methodName(MethodInvocationTree mit) {
-    return MethodsHelper.methodName(mit).name();
-  }
 }

java-checks/src/main/java/org/sonar/java/checks/IndexOfStartPositionCheck.java

@@ -24,6 +24,7 @@
 import org.sonar.check.Priority;
 import org.sonar.check.Rule;
 import org.sonar.java.checks.helpers.ExpressionsHelper;
+import org.sonar.java.checks.helpers.MethodsHelper;
 import org.sonar.java.checks.methods.MethodMatcher;
 import org.sonar.java.model.LiteralUtils;
 import org.sonar.java.tag.Tag;
@@ -85,7 +86,7 @@ private void checkIndexOfInvocation(MethodInvocationTree mit, ExpressionTree oth
       }
       Long otherValue = LiteralUtils.longLiteralValue(other);
       if (otherValue != null && otherValue != -1 && otherValue != 0) {
-        addIssue(mit, "Use \".indexOf(" + replaceMessage + ",n) > -1\" instead.");
+        reportIssue(MethodsHelper.methodName(mit), "Use \".indexOf(" + replaceMessage + ",n) > -1\" instead.");
       }
     }
   }

java-checks/src/main/java/org/sonar/java/checks/InstanceOfAlwaysTrueCheck.java

@@ -53,7 +53,7 @@ public void visitNode(Tree tree) {
     Type expressionType = instanceOfTree.expression().symbolType();
     Type instanceOf = instanceOfTree.type().symbolType();
     if (expressionType.isSubtypeOf(instanceOf)) {
-      addIssue(tree, "Remove this useless \"instanceof\" operator; it will always return \"true\". ");
+      reportIssue(instanceOfTree.instanceofKeyword(), "Remove this useless \"instanceof\" operator; it will always return \"true\". ");
     }
   }
 }