Java: account for multiple strings in java/alert-suppression-annotations

yh-semmle · yh-semmle · commit 62521dca3235 · 2019-10-17T22:09:04.000-04:00
diff --git a/java/ql/src/AlertSuppressionAnnotations.ql b/java/ql/src/AlertSuppressionAnnotations.ql
@@ -9,26 +9,28 @@
 import java
 import Metrics.Internal.Extents
 
+/** Gets the LGTM suppression annotation text in the string `s`, if any. */
+bindingset[s]
+string getAnnotationText(string s) {
+  // match `lgtm[...]` anywhere in the comment
+  result = s.regexpFind("(?i)\\blgtm\\s*\\[[^\\]]*\\]", _, _)
+}
+
 /**
  * An alert suppression annotation.
  */
 class SuppressionAnnotation extends SuppressWarningsAnnotation {
-  string annotation;
+  string text;
 
   SuppressionAnnotation() {
-    exists(string text | text = this.getASuppressedWarningLiteral().getValue() |
-      // match `lgtm[...]` anywhere in the comment
-      annotation = text.regexpFind("(?i)\\blgtm\\s*\\[[^\\]]*\\]", _, _)
-    )
+    text = this.getASuppressedWarningLiteral().getValue() and
+    exists(getAnnotationText(text))
   }
 
   /**
    * Gets the text of this suppression annotation.
    */
-  string getText() { result = getASuppressedWarningLiteral().getValue() }
-
-  /** Gets the LGTM suppression annotation in this Java annotation. */
-  string getAnnotationText() { result = annotation }
+  string getText() { result = text }
 
   private Annotation getASiblingAnnotation() {
     result = getAnnotatedElement().(Annotatable).getAnAnnotation() and
@@ -95,8 +97,11 @@ class SuppressionScope extends @annotation {
   string toString() { result = "suppression range" }
 }
 
-from SuppressionAnnotation c
-select c, // suppression comment
-  c.getText(), // text of suppression comment (excluding delimiters)
-  c.getAnnotationText(), // text of suppression annotation
+from SuppressionAnnotation c, string text, string annotationText
+where
+  text = c.getText() and
+  annotationText = getAnnotationText(text)
+select c, // suppression entity
+  text, // full text of suppression string
+  annotationText, // LGTM suppression annotation text
   c.getScope() // scope of suppression
diff --git a/java/ql/test/query-tests/AlertSuppression/AlertSuppressionAnnotations.expected b/java/ql/test/query-tests/AlertSuppression/AlertSuppressionAnnotations.expected
@@ -1,3 +1,4 @@
 | TestSuppressWarnings.java:2:1:2:49 | SuppressWarnings | lgtm[java/non-sync-override] | lgtm[java/non-sync-override] | TestSuppressWarnings.java:2:1:17:5 | suppression range |
 | TestSuppressWarnings.java:5:5:5:31 | SuppressWarnings | lgtm[] | lgtm[] | TestSuppressWarnings.java:5:5:8:5 | suppression range |
-| TestSuppressWarnings.java:10:5:10:57 | SuppressWarnings | lgtm[java/confusing-method-name] | lgtm[java/confusing-method-name] | TestSuppressWarnings.java:9:5:13:5 | suppression range |
+| TestSuppressWarnings.java:10:5:10:104 | SuppressWarnings | lgtm[java/confusing-method-name] not confusing | lgtm[java/confusing-method-name] | TestSuppressWarnings.java:9:5:13:5 | suppression range |
+| TestSuppressWarnings.java:10:5:10:104 | SuppressWarnings | lgtm[java/non-sync-override] | lgtm[java/non-sync-override] | TestSuppressWarnings.java:9:5:13:5 | suppression range |
diff --git a/java/ql/test/query-tests/AlertSuppression/TestSuppressWarnings.java b/java/ql/test/query-tests/AlertSuppression/TestSuppressWarnings.java
@@ -7,7 +7,7 @@ public void test() {
         
     }
     @Deprecated
-    @SuppressWarnings("lgtm[java/confusing-method-name]")
+    @SuppressWarnings({"lgtm[java/confusing-method-name] not confusing","lgtm[java/non-sync-override]"})
     public void test2() {
         
     }

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ public void test() {`
`7`	`7`
`8`	`8`	`}`
`9`	`9`	`@Deprecated`
`10`		`- @SuppressWarnings("lgtm[java/confusing-method-name]")`
	`10`	`+ @SuppressWarnings({"lgtm[java/confusing-method-name] not confusing","lgtm[java/non-sync-override]"})`
`11`	`11`	`public void test2() {`
`12`	`12`
`13`	`13`	`}`