Util: add AlertSuppression.qll

Author: aibaars

shared/util/codeql/suppression/AlertSuppression.qll

@@ -0,0 +1,109 @@
+signature class SingleLineComment {
+  string toString();
+
+  predicate hasLocationInfo(
+    string filepath, int startline, int startcolumn, int endline, int endcolumn
+  );
+
+  string getText();
+}
+
+/**
+ * Constructs an alert suppression query.
+ */
+module Make<SingleLineComment Comment> {
+  /**
+   * An alert suppression comment.
+   */
+  abstract class SuppressionComment instanceof Comment {
+    /**
+     * Gets the text of this suppression comment.
+     */
+    string getText() { result = super.getText() }
+
+    /**
+     * Holds if this element is at the specified location.
+     * The location spans column `startcolumn` of line `startline` to
+     * column `endcolumn` of line `endline` in file `filepath`.
+     * For more information, see
+     * [Locations](https://codeql.github.com/docs/writing-codeql-queries/providing-locations-in-codeql-queries/).
+     */
+    predicate hasLocationInfo(
+      string filepath, int startline, int startcolumn, int endline, int endcolumn
+    ) {
+      super.hasLocationInfo(filepath, startline, startcolumn, endline, endcolumn)
+    }
+
+    /** Gets the suppression annotation in this comment. */
+    abstract string getAnnotation();
+
+    /**
+     * Holds if this comment applies to the range from column `startcolumn` of line `startline`
+     * to column `endcolumn` of line `endline` in file `filepath`.
+     */
+    abstract predicate covers(
+      string filepath, int startline, int startcolumn, int endline, int endcolumn
+    );
+
+    /** Gets the scope of this suppression. */
+    SuppressionScope getScope() { this = result.getSuppressionComment() }
+
+    /** Gets a textual representation of this element. */
+    string toString() { result = super.toString() }
+  }
+
+  private class LgtmSuppressionComment extends SuppressionComment {
+    private string annotation;
+
+    LgtmSuppressionComment() {
+      exists(string text | text = this.(Comment).getText() |
+        // match `lgtm[...]` anywhere in the comment
+        annotation = text.regexpFind("(?i)\\blgtm\\s*\\[[^\\]]*\\]", _, _)
+        or
+        // match `lgtm` at the start of the comment and after semicolon
+        annotation = text.regexpFind("(?i)(?<=^|;)\\s*lgtm(?!\\B|\\s*\\[)", _, _).trim()
+      )
+    }
+
+    override string getAnnotation() { result = annotation }
+
+    override predicate covers(
+      string filepath, int startline, int startcolumn, int endline, int endcolumn
+    ) {
+      this.hasLocationInfo(filepath, startline, _, endline, endcolumn) and
+      startcolumn = 1
+    }
+  }
+
+  /**
+   * The scope of an alert suppression comment.
+   */
+  private class SuppressionScope instanceof SuppressionComment {
+    /** Gets a suppression comment with this scope. */
+    SuppressionComment getSuppressionComment() { result = this }
+
+    /**
+     * Holds if this element is at the specified location.
+     * The location spans column `startcolumn` of line `startline` to
+     * column `endcolumn` of line `endline` in file `filepath`.
+     * For more information, see
+     * [Locations](https://codeql.github.com/docs/writing-codeql-queries/providing-locations-in-codeql-queries/).
+     */
+    predicate hasLocationInfo(
+      string filepath, int startline, int startcolumn, int endline, int endcolumn
+    ) {
+      this.(SuppressionComment).covers(filepath, startline, startcolumn, endline, endcolumn)
+    }
+
+    /** Gets a textual representation of this element. */
+    string toString() { result = "suppression range" }
+  }
+
+  query predicate suppressions(
+    SuppressionComment c, string text, string annotation, SuppressionScope scope
+  ) {
+    text = c.getText() and // text of suppression comment (excluding delimiters)
+    annotation = c.getAnnotation() and // text of suppression annotation
+    scope = c.getScope() // scope of suppression
+  }
+}