Rule 5.13.4: Remove false positives in macro expansions by castler · Pull Request #1209 · github/codeql-coding-standards · GitHub
Skip to content

Rule 5.13.4: Remove false positives in macro expansions - #1209

Open
castler wants to merge 2 commits into
github:mainfrom
castler:fix-rule-5-13-4-unkown-suffix-in-macro-expension
Open

castler wants to merge 2 commits into
github:mainfrom
castler:fix-rule-5-13-4-unkown-suffix-in-macro-expension

Conversation

@castler

@castler castler commented Oct 21, 2026

Copy link
Copy Markdown
Contributor

Description

The CodeQL extractor does not preserve the source spelling of literals expanded from a macro: getValueText() either drops the suffix (e.g. 0U becomes 0) or returns the text of the whole macro invocation. As a result, correctly suffixed literals such as TEST_MACRO(1U == 0U) were reported as missing a U suffix.

Exclude literals generated by macro expansions, consistent with the fix for RULE-7-2 (#705). Unsuffixed literals in macro expansions are now a known false negative, documented in the test.

This also applies to M2-13-3, which shares the query.

Change request type

  • Release or process automation (GitHub workflows, internal scripts)
  • Internal documentation
  • External documentation
  • Query files (.ql, .qll, .qls or unit tests)
  • External scripts (analysis report or other code shipped as part of a release)

Rules with added or modified queries

  • No rules added
  • Queries have been added for the following rules:
    • rule number here
  • Queries have been modified for the following rules:
    • 5-13-4
    • M2-13-3

Release change checklist

A change note (development_handbook.md#change-notes) is required for any pull request which modifies:

  • The structure or layout of the release artifacts.
  • The evaluation performance (memory, execution time) of an existing query.
  • The results of an existing query in any circumstance.

If you are only adding new rule queries, a change note is not required.

Author: Is a change note required?

  • Yes
  • No

🚨🚨🚨
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.

  • Confirmed

Reviewer: Confirm that either a change note is not required or the change note is required and has been added.

  • Confirmed

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

  • Have all the relevant rule package description files been checked in?
  • Have you verified that the metadata properties of each new query is set appropriately?
  • Do all the unit tests contain both "COMPLIANT" and "NON_COMPLIANT" cases?
  • Are the alert messages properly formatted and consistent with the style guide?
  • Have you run the queries on OpenPilot and verified that the performance and results are acceptable?
    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.
  • Does the query have an appropriate level of in-query comments/documentation?
  • Have you considered/identified possible edge cases?
  • Does the query not reinvent features in the standard library?
  • Can the query be simplified further (not golfed!)

Reviewer

  • Have all the relevant rule package description files been checked in?
  • Have you verified that the metadata properties of each new query is set appropriately?
  • Do all the unit tests contain both "COMPLIANT" and "NON_COMPLIANT" cases?
  • Are the alert messages properly formatted and consistent with the style guide?
  • Have you run the queries on OpenPilot and verified that the performance and results are acceptable?
    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.
  • Does the query have an appropriate level of in-query comments/documentation?
  • Have you considered/identified possible edge cases?
  • Does the query not reinvent features in the standard library?
  • Can the query be simplified further (not golfed!)

@castler
castler marked this pull request as ready for review October 21, 2026 11:01
castler and others added 2 commits October 21, 2026 13:57
The CodeQL extractor does not preserve the source spelling of literals
expanded from a macro: getValueText() either drops the suffix (e.g. `0U`
becomes `0`) or returns the text of the whole macro invocation. As a
result, correctly suffixed literals such as `TEST_MACRO(1U == 0U)` were
reported as missing a `U` suffix.

Exclude literals generated by macro expansions, consistent with the fix
for RULE-7-2 (github#705). Unsuffixed literals in
macro expansions are now a known false negative, documented in the test.

This also applies to M2-13-3, which shares the query.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants