Ql4ql: Quality query tagging. #19931
Open
+250
−46
Conversation
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
| @@ -0,0 +1 @@ | |||
| queries/style/MissingQualityMetadata.ql | |||
Check warning
Code scanning / CodeQL
Query test without inline test expectations Warning test
70d3b6a to
eb14420
Compare
eb14420 to
ce5f119
Compare
hvitved
reviewed
Jul 2, 2025
| private predicate hasQualityTag(QueryDoc doc) { doc.getQueryTags() = "quality" } | ||
|
|
||
| private predicate incorrectTopLevelCategorisation(QueryDoc doc) { | ||
| count(string s | s = doc.getQueryTags() and s = ["maintainability", "reliability"]) != 1 |
There was a problem hiding this comment.
May as well use strictcount.
There was a problem hiding this comment.
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.
Well ok, I can invert the logic 😄
ql/ql/src/codeql_ql/ast/Ast.qll
Outdated
| } | ||
|
|
||
| /** Gets the individual @tags for the query. */ | ||
| string getQueryTags() { |
There was a problem hiding this comment.
getAQueryTag would be a better name.
ce5f119 to
179793e
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
In this PR we introduce a Ql4Ql check for correct use of quality query tags as documented here.
According to the documentation
quality) should have at least a top level categorisation.Furthermore, we also fix the existing violations.
The failing java integration tests are unrelated.