Merge pull request #10557 from erik-krogh/csharp-followMsg

C#: Update the alert messages to better follow the style guide

Author: erik-krogh

csharp/ql/campaigns/Solorigate/src/ModifiedFnvFunctionDetection.ql

@@ -27,6 +27,5 @@ where
       xor2.getAnOperand() = v.getAnAccess()
     )
   )
-select l,
-  "The variable $@ seems to be used as part of a FNV-like hash calculation, that is modified by an additional $@ expression using literal $@.",
-  v, v.toString(), additional_xor, "xor", l, l.toString()
+select l, "This literal is used in an $@ after an FNV-like hash calculation with variable $@.",
+  additional_xor, "additional xor", v, v.toString()

csharp/ql/campaigns/Solorigate/src/NumberOfKnownCommandsAboveThreshold.ql

@@ -34,5 +34,5 @@ where
   total = countSolorigateCommandInEnum(e) and
   total > 10
 select e,
-  "The enum $@ may be related to Solorigate. It matches " + total +
-    " of the values used for commands in the enum.", e, e.getName()
+  "This enum may be related to Solorigate. It matches " + total +
+    " of the values used for commands in the enum."

csharp/ql/campaigns/Solorigate/src/NumberOfKnownHashesAboveThreshold.ql

@@ -29,5 +29,5 @@ where
   isSolorigateHash(l) and
   total > threshold
 select l,
-  "The Hash literal $@ may be related to the Solorigate campaign. Total count = " + total +
-    " is above the threshold " + threshold + ".", l, l.getValue()
+  "This Hash literal may be related to the Solorigate campaign. Total count = " + total +
+    " is above the threshold " + threshold + "."

csharp/ql/campaigns/Solorigate/src/NumberOfKnownLiteralsAboveThreshold.ql

@@ -29,5 +29,5 @@ where
   isSolorigateLiteral(l) and
   total > threshold
 select l,
-  "The literal $@ may be related to the Solorigate campaign. Total count = " + total +
-    " is above the threshold " + threshold + ".", l, l.getValue()
+  "This literal may be related to the Solorigate campaign. Total count = " + total +
+    " is above the threshold " + threshold + "."

csharp/ql/campaigns/Solorigate/src/NumberOfKnownMethodNamesAboveThreshold.ql

@@ -28,5 +28,5 @@ where
   isSolorigateSuspiciousMethodName(m) and
   total > threshold
 select m,
-  "The method $@ may be related to Solorigate. Total count = " + total + " is above the threshold " +
-    threshold + ".", m, m.getName()
+  "This method may be related to Solorigate. Total count = " + total + " is above the threshold " +
+    threshold + "."

csharp/ql/campaigns/Solorigate/test/Solorigate/ModifiedFnvFunctionDetection.expected

@@ -1 +1 @@
-| test.cs:39:16:39:36 | 6605813339339102567 | The variable $@ seems to be used as part of a FNV-like hash calculation, that is modified by an additional $@ expression using literal $@. | test.cs:25:9:25:11 | num | num | test.cs:39:10:39:36 | ... ^ ... | xor | test.cs:39:16:39:36 | 6605813339339102567 | 6605813339339102567 |
+| test.cs:39:16:39:36 | 6605813339339102567 | This literal is used in an $@ after a FNV-like hash calculation with variable $@. | test.cs:39:10:39:36 | ... ^ ... | additional xor | test.cs:25:9:25:11 | num | num |

csharp/ql/src/API Abuse/ClassDoesNotImplementEquals.ql

@@ -23,9 +23,9 @@ where
     exists(MethodCall callToEquals |
       callToEquals.getTarget() instanceof EqualsMethod and
       callToEquals.getQualifier().getType() = c and
-      message = "but it is called $@" and
+      message = "but $@" and
       item = callToEquals and
-      itemText = "here"
+      itemText = "'Equals' is called on an instance of this class"
     )
     or
     item = c.getAnOperator().(EQOperator) and

csharp/ql/src/API Abuse/NoDisposeCallOnLocalIDisposable.ql

@@ -106,4 +106,4 @@ predicate mayNotBeDisposed(LocalScopeDisposableCreation disposable) {
 
 from LocalScopeDisposableCreation disposable
 where mayNotBeDisposed(disposable)
-select disposable, "Disposable '" + disposable.getType() + "' is created here but is not disposed."
+select disposable, "Disposable '" + disposable.getType() + "' is created but not disposed."

csharp/ql/src/CSI/NullAlways.ql

@@ -16,4 +16,4 @@ import semmle.code.csharp.dataflow.Nullness
 
 from Dereference d, Ssa::SourceVariable v
 where d.isFirstAlwaysNull(v)
-select d, "Variable $@ is always null here.", v, v.toString()
+select d, "Variable $@ is always null at this dereference.", v, v.toString()

csharp/ql/src/CSI/NullMaybe.ql

@@ -19,4 +19,5 @@ import PathGraph
 from
   Dereference d, PathNode source, PathNode sink, Ssa::SourceVariable v, string msg, Element reason
 where d.isFirstMaybeNull(v.getAnSsaDefinition(), source, sink, msg, reason)
-select d, source, sink, "Variable $@ may be null here " + msg + ".", v, v.toString(), reason, "this"
+select d, source, sink, "Variable $@ may be null at this access " + msg + ".", v, v.toString(),
+  reason, "this"