SONARJAVA-2588 Support java.util.Logging.log for S3457

Author: benzonico

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

@@ -23,6 +23,7 @@
 import org.apache.commons.lang.StringUtils;
 import org.sonar.java.checks.methods.AbstractMethodDetection;
 import org.sonar.java.matcher.MethodMatcher;
+import org.sonar.java.matcher.TypeCriteria;
 import org.sonar.plugins.java.api.tree.ExpressionTree;
 import org.sonar.plugins.java.api.tree.MethodInvocationTree;
 import org.sonar.plugins.java.api.tree.NewArrayTree;
@@ -43,6 +44,10 @@ public abstract class AbstractPrintfChecker extends AbstractMethodDetection {
   private static final String FORMAT_METHOD_NAME = "format";
 
   protected static final MethodMatcher MESSAGE_FORMAT = MethodMatcher.create().typeDefinition("java.text.MessageFormat").name(FORMAT_METHOD_NAME).withAnyParameters();
+  protected static final MethodMatcher JAVA_UTIL_LOGGER = MethodMatcher.create().typeDefinition("java.util.logging.Logger").name("log")
+    .addParameter("java.util.logging.Level")
+    .addParameter("java.lang.String")
+    .addParameter(TypeCriteria.anyType());
   protected static final Pattern MESSAGE_FORMAT_PATTERN = Pattern.compile("\\{(?<index>\\d+)(?<type>,\\w+)?(?<style>,[^}]*)?\\}");
 
   @Override
@@ -54,7 +59,8 @@ protected List<MethodMatcher> getMethodInvocationMatchers() {
       MethodMatcher.create().typeDefinition("java.io.PrintStream").name("printf").withAnyParameters(),
       MethodMatcher.create().typeDefinition("java.io.PrintWriter").name(FORMAT_METHOD_NAME).withAnyParameters(),
       MethodMatcher.create().typeDefinition("java.io.PrintWriter").name("printf").withAnyParameters(),
-      MESSAGE_FORMAT
+      MESSAGE_FORMAT,
+      JAVA_UTIL_LOGGER
       );
   }
 

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

@@ -19,6 +19,10 @@
  */
 package org.sonar.java.checks;
 
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.List;
+import java.util.Set;
 import org.sonar.check.Rule;
 import org.sonar.java.matcher.MethodMatcher;
 import org.sonar.java.matcher.TypeCriteria;
@@ -31,11 +35,6 @@
 import org.sonar.plugins.java.api.tree.NewArrayTree;
 import org.sonar.plugins.java.api.tree.Tree;
 
-import java.util.ArrayList;
-import java.util.Collection;
-import java.util.List;
-import java.util.Set;
-
 @Rule(key = "S3457")
 public class PrintfMisuseCheck extends AbstractPrintfChecker {
 
@@ -51,6 +50,13 @@ protected void onMethodInvocationFound(MethodInvocationTree mit) {
       // only consider the static method
       return;
     }
+    if (!isMessageFormat) {
+      isMessageFormat = JAVA_UTIL_LOGGER.matches(mit);
+      if (isMessageFormat && mit.arguments().get(2).symbolType().isSubtypeOf("java.lang.Throwable")) {
+        // ignore formatting issues when last argument is a throwable
+        return;
+      }
+    }
     // Check type of first argument:
     if (mit.arguments().get(0).symbolType().is("java.lang.String")) {
       formatStringTree = mit.arguments().get(0);

java-checks/src/test/files/checks/PrintfMisuseCheck.java

@@ -112,5 +112,24 @@ void foo(Calendar c){
     MessageFormat.format("{0,number,#.#}{1}", new Object[42]); // Compliant - Not considered
     MessageFormat.format("value=\"'{'{0}'}'{1}\"", new Object[] {"value 1", "value 2"});
     MessageFormat.format("value=\"{0}'{'{1}'}'\"", new Object[] {"value 1", "value 2"});
+
+    java.util.logging.Logger logger;
+    logger.log(java.util.logging.Level.SEVERE, "{0,number,$'#',##}", value); // Compliant
+    logger.log(java.util.logging.Level.SEVERE, "Result ''{0}''.", 14); // Compliant
+    logger.log(java.util.logging.Level.SEVERE, "Result '{0}'", 14); // Noncompliant {{String contains no format specifiers.}}
+    logger.log(java.util.logging.Level.SEVERE, "Result ' {0}", 14);
+    logger.log(java.util.logging.Level.SEVERE, "Result {{{0}}.", 14);
+    logger.log(java.util.logging.Level.SEVERE, "Result {0}!", myObject.toString()); // Noncompliant {{No need to call toString "method()" as formatting and string conversion is done by the Formatter.}}
+    logger.log(java.util.logging.Level.SEVERE, "Result {0}!", myObject.hashCode()); // Compliant
+    logger.log(java.util.logging.Level.SEVERE, "Result yeah!", 14); // Noncompliant {{String contains no format specifiers.}}
+    logger.log(java.util.logging.Level.SEVERE, "Result yeah!", new Exception()); // compliant, throwable parameter
+    logger.log(java.util.logging.Level.SEVERE, "Result {1}!", 14);
+    logger.log(java.util.logging.Level.SEVERE, "Result {0} and {1}!", 14);
+    logger.log(java.util.logging.Level.SEVERE, "{0,number,#.#}{1}", new Object[] {0.07, "$"}); // Compliant
+    logger.log(java.util.logging.Level.SEVERE, "{0,number,#.#}{1}", new Object[] {0.07});
+    logger.log(java.util.logging.Level.SEVERE, "{0,number,#.#}{1}", objs); // Compliant - skipped as the array is not initialized in the method invocation
+    logger.log(java.util.logging.Level.SEVERE, "{0,number,#.#}{1}", new Object[42]); // Compliant - Not considered
+    logger.log(java.util.logging.Level.SEVERE, "value=\"'{'{0}'}'{1}\"", new Object[] {"value 1", "value 2"});
+    logger.log(java.util.logging.Level.SEVERE, "value=\"{0}'{'{1}'}'\"", new Object[] {"value 1", "value 2"});
   }
 }