Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

M3-2-1: Exclude non-object and template variables #65

Merged
merged 7 commits into from
Sep 30, 2022

Conversation

lcartey
Copy link
Collaborator

@lcartey lcartey commented Aug 18, 2022

Description

Fixes #34.

  • Reduces false positives by excluding non-object variables (for example, member variables).
  • Reduces false positives by excluding variable templates and template instantiations.
  • Improved the reported error message by including the conflicting type names.

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:
    • M3-2-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 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!)

Variable templates cause multiple variables to be generated, causing
false positives for M3-2-1.
TemplateVariables and variables in template instantiations are excluded
because they cause spurious results for this query.
Add the types of the two declarations to help clarify differences.
Exclude member variables and variables from templates or template
instantiations, as the rule is only applicable to objects.
@lcartey lcartey added this to the v2.9.0 milestone Aug 18, 2022
Copy link
Contributor

@mbaluda mbaluda left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@mbaluda
Copy link
Contributor

mbaluda commented Sep 22, 2022

@lcartey is it ok that the release notes are dated so much in the past? before the previous release?

@lcartey
Copy link
Collaborator Author

lcartey commented Sep 22, 2022

@mbaluda I seem to have typo'd the date of the release note in this case to change_notes/2022-09-18-m3-2-1-templates.md, which I think is fine (it was supposed to be August).

In general the date of the change note is not relevant - the date doesn't appear in the release notes, and the relevant change notes are gathered by querying git to determine which files are new (rather than using the creation date on the file).

@lcartey lcartey merged commit be6d8a7 into github:main Sep 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

M3-2-1: Do not consider variable template instantiations as a redeclaration with a different type
2 participants