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

A0-1-1: Fix useless assignment false positive on constexpr array size #732

Merged
merged 4 commits into from
Oct 9, 2024

Conversation

fjatWbyT
Copy link
Contributor

@fjatWbyT fjatWbyT commented Oct 4, 2024

Description

Addresses false positive like the one in #690 in another AUTOSAR ule.

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

@fjatWbyT
Copy link
Contributor Author

fjatWbyT commented Oct 4, 2024

Hello @lcartey,

I looked for unit tests analogous to the one updated in #690, in this case for A0-1-1 "useless assignment", in contrast with M0-1-9 "no dead code", but couldn't find any already existing. I run locally the (153) tests in cpp/common/test/rules after applying the change and all pass. I could find tests for useless assignment in deviations, but I doubt those need updating for this change since there's no new deviation.

Does it make sense to add explicit coverage for A0-1-1?
I wonder if it would be sensible to (a) add a new directory cpp/common/uselessassignment, (b) update configuration so that the ones in cpp/common/deadcode are also run against A0-1-1, or (c) something else :)
On the one hand, I think that covering these other isUselessSsaDefinition predicate and InterestingStackVariable class (assuming they aren't already) would be an improvement. On the other hand, since they are (at least partially) used by the dead code qll, it might not be worth further updates.

@lcartey
Copy link
Collaborator

lcartey commented Oct 4, 2024

Hi @fjatWbyT! Thanks for the PR.

The test cases for A0-1-1 live here:
https://github.com/github/codeql-coding-standards/tree/main/cpp/autosar/test/rules/A0-1-1

The tests live in a common directory when one query implementation is shared by multiple rules - for example, where an AUTOSAR and CERT C++ rule cover the same issue. A0-1-1 is only required to be reported to AUTOSAR, so the tests live in the AUTOSAR test directory, under the rule ID.

@fjatWbyT
Copy link
Contributor Author

fjatWbyT commented Oct 4, 2024

Aaah, it is clear now. Thank you very much for the explanation. I will update the PR with extra coverage for this case in that file.

Copy link
Collaborator

@lcartey lcartey left a comment

Choose a reason for hiding this comment

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

Thank you!

@lcartey lcartey enabled auto-merge October 9, 2024 12:30
@lcartey lcartey added this pull request to the merge queue Oct 9, 2024
Merged via the queue into github:main with commit 7736c34 Oct 9, 2024
21 checks passed
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