A0-1-1: Ignore incomplete or compiler generated variables

[lcartey]

Description

Fixes #230 and #402.

Also addresses #372 but for A0-1-1 only.

This PR makes the following adjustments:

• Excludes assignments to variables that occur in uninstantiated templates. Uninstantiated templates provide a necessarily incomplete model of the code - with certain types, call targets and so forth only being resolved once the template is instantiated. It is therefore not possible, or necessary, to determine whether a variable is unused.
• Excludes compiler-generated variables, such as those generated for range-based for loops (e.g. (__range)). With the range-based for loops these compiler-generated variables are generally not "unused", because the compiler will also generate a use for each variable. However, if they appeared in uninstantiated templates then the model may be incomplete. I would therefore expect most range-based for loop results to be removed by the first change, but I think it's prudent to exclude all compiler-generated variables to avoid false positives.
• Enable deviations on the assignment as well as the variable itself.

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:
  • A0-1-1

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!)

[rvermeulen]

See comment on exclusion on variable.

Changes made.

[lcartey]

@rvermeulen ready for re-review.

[rvermeulen]

Looks good. Just a final check on the change note stating that a deviation can be applied to both the assignment and the variable, which I believe is no longer the case.