Ql4Ql: Add a check for quality tag consistency.

Author: michaelnebel

ql/ql/src/queries/style/MissingQualityMetadata.ql

@@ -0,0 +1,51 @@
+/**
+ * @name Missing quality metadata
+ * @description Quality queries should have exactly one top-level category and if sub-categories are used, the appropriate top-level category should be used.
+ * @kind problem
+ * @problem.severity warning
+ * @precision very-high
+ * @id ql/missing-security-metadata
+ * @tags correctness
+ */
+
+import ql
+
+private predicate unInterestingLocation(File f) {
+  f.getRelativePath().matches("%/" + ["experimental", "examples", "test"] + "/%")
+}
+
+private predicate hasQualityTag(QueryDoc doc) { doc.getQueryTags() = "quality" }
+
+private predicate incorrectTopLevelCategorisation(QueryDoc doc) {
+  count(string s | s = doc.getQueryTags() and s = ["maintainability", "reliability"]) != 1
+}
+
+private predicate reliabilitySubCategory(QueryDoc doc) {
+  doc.getQueryTags() = ["correctness", "performance", "concurrency", "error-handling"]
+}
+
+private predicate maintainabilitySubCategory(QueryDoc doc) {
+  doc.getQueryTags() = ["readability", "useless-code", "complexity"]
+}
+
+from TopLevel t, QueryDoc doc, string msg
+where
+  doc = t.getQLDoc() and
+  not unInterestingLocation(t.getLocation().getFile()) and
+  hasQualityTag(doc) and
+  (
+    incorrectTopLevelCategorisation(doc) and
+    msg =
+      "This query file has incorrect top-level categorisation. It should have exactly one top-level category, either `@tags maintainability` or `@tags reliability`."
+    or
+    maintainabilitySubCategory(doc) and
+    not doc.getQueryTags() = "maintainability" and
+    msg =
+      "This query file has a sub-category of maintainability but is missing the `@tags maintainability` tag."
+    or
+    reliabilitySubCategory(doc) and
+    not doc.getQueryTags() = "reliability" and
+    msg =
+      "This query file has a sub-category of reliability but is missing the `@tags reliability` tag."
+  )
+select t, msg