Ql4ql: Quality query tagging. #19931
Ql4Ql: Add a check for quality tag consistency.
- Loading branch information
commit e00b5351a42dfe4b3d60e32796b86f53a1b2a3bf
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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-quality-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 | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
May as well use
strictcount.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Uh wait, we can't - the predicate won't hold in the case there is no top level tag (if the count is
0).There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well ok, I can invert the logic 😄