Merge pull request #10528 from erik-krogh/java-followMsg

Java: Update the alert messages to better follow the style guide

Author: erik-krogh

java/ql/src/Frameworks/Spring/Architecture/Refactoring Opportunities/MissingParentBean.ql

@@ -34,6 +34,6 @@ where
   bean1.getBeanIdentifier() < bean2.getBeanIdentifier() and
   bean1 != bean2
 select bean1,
-  "Bean $@ has " + similarProps.toString() +
+  "This bean has " + similarProps.toString() +
     " properties similar to $@. Consider introducing a common parent bean for these two beans.",
-  bean1, bean1.getBeanIdentifier(), bean2, bean2.getBeanIdentifier()
+  bean2, bean2.getBeanIdentifier()

java/ql/src/Frameworks/Spring/Violations of Best Practice/ParentShouldNotUseAbstractClass.ql

@@ -26,5 +26,4 @@ class ParentBean extends SpringBean {
 
 from ParentBean parent
 where parent.getDeclaredClass().isAbstract()
-select parent, "Parent bean $@ should not have an abstract class.", parent,
-  parent.getBeanIdentifier()
+select parent, "This parent bean should not have an abstract class."

java/ql/src/Language Abuse/UselessNullCheck.ql

@@ -21,10 +21,11 @@ where
   e = clearlyNotNullExpr(reason) and
   (
     if reason instanceof Guard
-    then msg = "This check is useless, $@ cannot be null here, since it is guarded by $@."
+    then msg = "This check is useless. $@ cannot be null at this check, since it is guarded by $@."
     else
       if reason != e
-      then msg = "This check is useless, $@ cannot be null here, since $@ always is non-null."
+      then
+        msg = "This check is useless. $@ cannot be null at this check, since $@ always is non-null."
       else msg = "This check is useless, since $@ always is non-null."
   )
 select guard, msg, e, e.toString(), reason, reason.toString()

java/ql/src/Likely Bugs/Collections/IteratorRemoveMayFail.ql

@@ -72,5 +72,5 @@ where
   remove.getCallee().hasName("remove") and
   iterOfSpecialCollection(remove.getQualifier(), scc)
 select remove,
-  "This call may fail when iterating over the collection created $@, since it does not support element removal.",
-  scc, "here"
+  "This call may fail when iterating over $@, since it does not support element removal.", scc,
+  "the collection"

java/ql/src/Likely Bugs/Comparison/MissingInstanceofInEquals.ql

@@ -77,4 +77,4 @@ where
   // Exclude `equals` methods that implement reference-equality.
   not m instanceof ReferenceEquals and
   not m instanceof UnimplementedEquals
-select m, "equals() method does not check argument type."
+select m, "This 'equals()' method does not check argument type."

java/ql/src/Likely Bugs/Comparison/WrongNanComparison.ql

@@ -21,4 +21,4 @@ where
   eq.getAnOperand() = f.getAnAccess() and nanField(f) and f.getDeclaringType().hasName(classname)
 select eq,
   "This comparison will always yield the same result since 'NaN != NaN'. Consider using " +
-    classname + ".isNaN instead"
+    classname + ".isNaN instead."

java/ql/src/Likely Bugs/Concurrency/SleepWithLock.ql

@@ -23,4 +23,4 @@ where
     ma.getEnclosingStmt().getEnclosingStmt*() instanceof SynchronizedStmt or
     ma.getEnclosingCallable().isSynchronized()
   )
-select ma, "sleep() with lock held."
+select ma, "This calls 'Thread.sleep()' with a lock held."

java/ql/src/Likely Bugs/Concurrency/WaitWithTwoLocks.ql

@@ -27,4 +27,4 @@ where
   ma.getMethod().getDeclaringType().hasQualifiedName("java.lang", "Object") and
   ma.getEnclosingStmt().getEnclosingStmt*() = synch and
   synch.getEnclosingStmt+() instanceof Synched
-select ma, "wait() with two locks held."
+select ma, "This calls 'Object.wait()' with two locks held."

java/ql/src/Likely Bugs/Likely Typos/ContradictoryTypeChecks.ql

@@ -46,5 +46,5 @@ predicate contradictoryTypeCheck(Expr e, Variable v, RefType t, RefType sup, Exp
 
 from Expr e, Variable v, RefType t, RefType sup, Expr cond
 where contradictoryTypeCheck(e, v, t, sup, cond)
-select e, "Variable $@ cannot be of type $@ here, since $@ ensures that it is not of type $@.", v,
+select e, "This access of $@ cannot be of type $@, since $@ ensures that it is not of type $@.", v,
   v.getName(), t, t.getName(), cond, "this expression", sup, sup.getName()

java/ql/src/Likely Bugs/Likely Typos/SelfAssignment.ql

@@ -45,5 +45,4 @@ predicate sameVariable(VarAccess left, VarAccess right) {
 from AssignExpr assign
 where sameVariable(assign.getDest(), assign.getSource())
 select assign,
-  "This assigns the variable " + assign.getDest().(VarAccess).getVariable().getName() +
-    " to itself and has no effect."
+  "This expression assigns " + assign.getDest().(VarAccess).getVariable().getName() + " to itself."