Merge pull request github#11719 from aibaars/alert-suppression-shared

Shared AlertSuppression library

Author: aibaars

cpp/ql/src/AlertSuppression.ql

@@ -5,78 +5,35 @@
  * @id cpp/alert-suppression
  */
 
-import cpp
-
-/**
- * An alert suppression comment.
- */
-class SuppressionComment extends Comment {
-  string annotation;
-  string text;
-
-  SuppressionComment() {
-    (
-      this instanceof CppStyleComment and
-      // strip the beginning slashes
-      text = this.getContents().suffix(2)
-      or
-      this instanceof CStyleComment and
-      // strip both the beginning /* and the end */ the comment
-      exists(string text0 |
-        text0 = this.getContents().suffix(2) and
-        text = text0.prefix(text0.length() - 2)
-      ) and
-      // The /* */ comment must be a single-line comment
-      not text.matches("%\n%")
+private import codeql.suppression.AlertSuppression as AS
+private import semmle.code.cpp.Element
+
+class SingleLineComment extends Comment {
+  private string text;
+
+  SingleLineComment() {
+    this instanceof CppStyleComment and
+    // strip the beginning slashes
+    text = this.getContents().suffix(2)
+    or
+    this instanceof CStyleComment and
+    // strip both the beginning /* and the end */ the comment
+    exists(string text0 |
+      text0 = this.getContents().suffix(2) and
+      text = text0.prefix(text0.length() - 2)
     ) and
-    (
-      // 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()
-    )
+    // The /* */ comment must be a single-line comment
+    not text.matches("%\n%")
   }
 
-  /** Gets the text in this comment, excluding the leading //. */
-  string getText() { result = text }
-
-  /** Gets the suppression annotation in this comment. */
-  string getAnnotation() { result = annotation }
-
-  /**
-   * Holds if this comment applies to the range from column `startcolumn` of line `startline`
-   * to column `endcolumn` of line `endline` in file `filepath`.
-   */
-  predicate covers(string filepath, int startline, int startcolumn, int endline, int endcolumn) {
-    this.getLocation().hasLocationInfo(filepath, startline, _, endline, endcolumn) and
-    startcolumn = 1
-  }
-
-  /** Gets the scope of this suppression. */
-  SuppressionScope getScope() { result = this }
-}
-
-/**
- * The scope of an alert suppression comment.
- */
-class SuppressionScope extends ElementBase instanceof SuppressionComment {
-  /**
-   * 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.covers(filepath, startline, startcolumn, endline, endcolumn)
+    this.getLocation().hasLocationInfo(filepath, startline, startcolumn, endline, endcolumn)
   }
+
+  /** Gets the text in this comment, excluding the leading //. */
+  string getText() { result = text }
 }
 
-from SuppressionComment c
-select c, // suppression comment
-  c.getText(), // text of suppression comment (excluding delimiters)
-  c.getAnnotation(), // text of suppression annotation
-  c.getScope() // scope of suppression
+import AS::Make<SingleLineComment>

cpp/ql/src/qlpack.yml

@@ -6,6 +6,7 @@ groups:
 dependencies:
     codeql/cpp-all: ${workspace}
     codeql/suite-helpers: ${workspace}
+    codeql/util: ${workspace}
 suites: codeql-suites
 extractor: cpp
 defaultSuiteFile: codeql-suites/cpp-code-scanning.qls

cpp/ql/test/query-tests/AlertSuppression/AlertSuppression.expected

@@ -5,68 +5,20 @@
  * @id cs/alert-suppression
  */
 
-import csharp
+private import codeql.suppression.AlertSuppression as AS
+private import semmle.code.csharp.Comments
 
-/**
- * An alert suppression comment.
- */
-class SuppressionComment extends CommentLine {
-  string annotation;
-
-  SuppressionComment() {
+class SingleLineComment extends CommentLine {
+  SingleLineComment() {
     // Must be either `// ...` or `/* ... */` on a single line.
-    this.getRawText().regexpMatch("//.*|/\\*.*\\*/") and
-    exists(string text | text = this.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()
-    )
-  }
-
-  /** Gets the suppression annotation in this comment. */
-  string getAnnotation() { result = annotation }
-
-  /**
-   * Holds if this comment applies to the range from column `startcolumn` of line `startline`
-   * to column `endcolumn` of line `endline` in file `filepath`.
-   */
-  predicate covers(string filepath, int startline, int startcolumn, int endline, int endcolumn) {
-    this.getLocation().hasLocationInfo(filepath, startline, _, endline, endcolumn) and
-    startcolumn = 1
+    this.getRawText().regexpMatch("//.*|/\\*.*\\*/")
   }
 
-  /** Gets the scope of this suppression. */
-  SuppressionScope getScope() { this = result.getSuppressionComment() }
-}
-
-/**
- * The scope of an alert suppression comment.
- */
-class SuppressionScope extends @commentline 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
   ) {
-    super.covers(filepath, startline, startcolumn, endline, endcolumn)
+    this.getLocation().hasLocationInfo(filepath, startline, startcolumn, endline, endcolumn)
   }
-
-  /** Gets a textual representation of this element. */
-  string toString() { result = "suppression range" }
 }
 
-from SuppressionComment c
-select c, // suppression comment
-  c.getText(), // text of suppression comment (excluding delimiters)
-  c.getAnnotation(), // text of suppression annotation
-  c.getScope() // scope of suppression
+import AS::Make<SingleLineComment>

csharp/ql/src/AlertSuppression.ql

@@ -9,3 +9,4 @@ defaultSuiteFile: codeql-suites/csharp-code-scanning.qls
 dependencies:
   codeql/csharp-all: ${workspace}
   codeql/suite-helpers: ${workspace}
+  codeql/util: ${workspace}

csharp/ql/src/qlpack.yml

@@ -0,0 +1 @@
+AlertSuppressionWindows.cs eol=crlf

csharp/ql/test/query-tests/AlertSuppression/.gitattributes

@@ -5,73 +5,14 @@
  * @id go/alert-suppression
  */
 
-import go
+private import codeql.suppression.AlertSuppression as AS
+private import semmle.go.Comments as G
 
-/**
- * An alert suppression comment.
- */
-class SuppressionComment extends Locatable {
-  string text;
-  string annotation;
-
-  SuppressionComment() {
-    text = this.(Comment).getText() and
+class SingleLineComment extends G::Comment {
+  SingleLineComment() {
     // suppression comments must be single-line
-    not text.matches("%\n%") and
-    (
-      // 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()
-    )
-  }
-
-  /** Gets the text of this suppression comment, not including delimiters. */
-  string getText() { result = text }
-
-  /** Gets the suppression annotation in this comment. */
-  string getAnnotation() { result = annotation }
-
-  /**
-   * Holds if this comment applies to the range from column `startcolumn` of line `startline`
-   * to column `endcolumn` of line `endline` in file `filepath`.
-   */
-  predicate covers(string filepath, int startline, int startcolumn, int endline, int endcolumn) {
-    this.getLocation().hasLocationInfo(filepath, startline, _, endline, endcolumn) and
-    startcolumn = 1
+    not this.getText().matches("%\n%")
   }
-
-  /** Gets the scope of this suppression. */
-  SuppressionScope getScope() { this = result.getSuppressionComment() }
-}
-
-/**
- * The scope of an alert suppression comment.
- */
-class SuppressionScope extends @locatable 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
-  ) {
-    super.covers(filepath, startline, startcolumn, endline, endcolumn)
-  }
-
-  /** Gets a textual representation of this element. */
-  string toString() { result = "suppression range" }
 }
 
-from SuppressionComment c
-select c, // suppression comment
-  c.getText(), // text of suppression comment (excluding delimiters)
-  c.getAnnotation(), // text of suppression annotation
-  c.getScope() // scope of suppression
+import AS::Make<SingleLineComment>

go/ql/src/AlertSuppression.ql

@@ -9,3 +9,4 @@ defaultSuiteFile: codeql-suites/go-code-scanning.qls
 dependencies:
   codeql/go-all: ${workspace}
   codeql/suite-helpers: ${workspace}
+  codeql/util: ${workspace}

go/ql/src/qlpack.yml

@@ -0,0 +1 @@
+tstWindows.go eol=crlf

go/ql/test/query-tests/AlertSuppression/.gitattributes

@@ -5,77 +5,17 @@
  * @id java/alert-suppression
  */
 
-import java
-
-/**
- * An alert suppression comment.
- */
-class SuppressionComment extends Javadoc {
-  string annotation;
-
-  SuppressionComment() {
-    // suppression comments must be single-line
-    (
-      isEolComment(this)
-      or
-      isNormalComment(this) and exists(int line | this.hasLocationInfo(_, line, _, line, _))
-    ) and
-    exists(string text | text = this.getChild(0).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()
-    )
+private import codeql.suppression.AlertSuppression as AS
+private import semmle.code.java.Javadoc
+
+class SingleLineComment extends Javadoc {
+  SingleLineComment() {
+    isEolComment(this)
+    or
+    isNormalComment(this) and exists(int line | this.hasLocationInfo(_, line, _, line, _))
   }
 
-  /**
-   * Gets the text of this suppression comment.
-   */
   string getText() { result = this.getChild(0).getText() }
-
-  /** Gets the suppression annotation in this comment. */
-  string getAnnotation() { result = annotation }
-
-  /**
-   * Holds if this comment applies to the range from column `startcolumn` of line `startline`
-   * to column `endcolumn` of line `endline` in file `filepath`.
-   */
-  predicate covers(string filepath, int startline, int startcolumn, int endline, int endcolumn) {
-    this.getLocation().hasLocationInfo(filepath, startline, _, endline, endcolumn) and
-    startcolumn = 1
-  }
-
-  /** Gets the scope of this suppression. */
-  SuppressionScope getScope() { this = result.getSuppressionComment() }
-}
-
-/**
- * The scope of an alert suppression comment.
- */
-class SuppressionScope extends @javadoc 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
-  ) {
-    super.covers(filepath, startline, startcolumn, endline, endcolumn)
-  }
-
-  /** Gets a textual representation of this element. */
-  string toString() { result = "suppression range" }
 }
 
-from SuppressionComment c
-select c, // suppression comment
-  c.getText(), // text of suppression comment (excluding delimiters)
-  c.getAnnotation(), // text of suppression annotation
-  c.getScope() // scope of suppression
+import AS::Make<SingleLineComment>