Restore deleted deviations suppression query #876
Conversation
There was a problem hiding this comment.
Pull Request Overview
This pull request restores the previously deleted DeviationsSuppression.ql query by adding a corresponding change note.
- Restores the DeviationsSuppression.ql query used for generating the Guideline Compliance Summary
- Adds a change note to document the restoration
Files not reviewed (4)
- cpp/common/src/codingstandards/cpp/deviations/DeviationsSuppression.qhelp: Language not supported
- cpp/common/src/codingstandards/cpp/deviations/DeviationsSuppression.ql: Language not supported
- cpp/common/test/deviations/deviations_report_deviated/DeviationsSuppression.expected: Language not supported
- cpp/common/test/deviations/deviations_report_deviated/DeviationsSuppression.qlref: Language not supported
Tip: If you use Visual Studio Code, you can request a review from Copilot before you push from the "Source Control" tab. Learn more
This is required for our reporting scripts. Changes implemented to support reporting of locations and messages for new deviation formats.
| else | ||
| // Find the last column for a location on the next line | ||
| endcolumn = | ||
| max(Location l | |
There was a problem hiding this comment.
Perhaps the logic here, and the predicates getLastLineNumber, getLastColumnNumber from DeviationsSuppression.ql, should perhaps be a library in cpp/common
| @@ -336,26 +341,60 @@ class CodeIdentifierDeviation extends TCodeIndentifierDeviation { | |||
| ) | |||
| } | |||
|
|
|||
| predicate hasLocationInfo( | |||
There was a problem hiding this comment.
May want to a comment that this is the location of the suppressed range rather than the location of the comment itself.
| or | ||
| this = TMultiLineDeviation(_, _, _, filepath, suppressedLine, endline) and | ||
| suppressedColumn = 1 and | ||
| endcolumn = 1 |
There was a problem hiding this comment.
Some potential inconsistencies. Firstly, the suppressed area includes the text of the first comment, but ends before the text of the second comment.
Additionally, it looks like:
// codeql::misra_deviation_begin(foo)
non_compliant_code // codeql::misra_deviation_end(foo)
neither deviates the non_compliant_code nor triggers an invalid deviation warning. The deviated location matched here would not include non_compliant_code either.
Do you think either of these are an issue worth filing or fixing?
Description
I incorrectly deleted the
DeviationsSuppression.qlquery in #807. This query is still used as part of generating our Guideline Compliance Summary, and is useful for customers wanting to generate a SARIF file including suppression information.Change request type
.ql,.qll,.qlsor unit tests)Rules with added or modified queries
Release change checklist
A change note (development_handbook.md#change-notes) is required for any pull request which modifies:
If you are only adding new rule queries, a change note is not required.
Author: Is a change note required?
🚨🚨🚨
Reviewer: Confirm that format of shared queries (not the .qll file, the
.ql file that imports it) is valid by running them within VS Code.
Reviewer: Confirm that either a change note is not required or the change note is required and has been added.
Query development review checklist
For PRs that add new queries or modify existing queries, the following checklist should be completed by both the author and reviewer:
Author
As a rule of thumb, predicates specific to the query should take no more than 1 minute, and for simple queries be under 10 seconds. If this is not the case, this should be highlighted and agreed in the code review process.
Reviewer
As a rule of thumb, predicates specific to the query should take no more than 1 minute, and for simple queries be under 10 seconds. If this is not the case, this should be highlighted and agreed in the code review process.