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

Implement rule amendments from Technical Corrigenda 2 #841

Merged
merged 13 commits into from
Mar 18, 2025

Conversation

MichaelRFairhurst
Copy link
Contributor

@MichaelRFairhurst MichaelRFairhurst commented Jan 16, 2025

Description

Implement MISRA-C 2012 rule amendments from Technical Corrigenda 2.

Note, one of these queries RULE-18-1 has some issues I didn't address here but I filed and these should be addressed. This solution to work around use-use flow will break during that refactor/improvement.

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:
    • RULE-8-3, RULE-10-2, RULE-18-1, M5-0-16, RULE-21-10, RULE-25-5-3, ENV34-C

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

@Copilot Copilot bot review requested due to automatic review settings January 16, 2025 05:04
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot reviewed 1 out of 19 changed files in this pull request and generated 2 comments.

Files not reviewed (18)
  • amendments.csv: Language not supported
  • c/misra/src/codingstandards/c/misra/EssentialTypes.qll: Language not supported
  • c/misra/src/rules/RULE-10-2/AdditionSubtractionOnEssentiallyCharType.ql: Language not supported
  • c/misra/test/rules/RULE-10-2/AdditionSubtractionOnEssentiallyCharType.expected: Language not supported
  • c/misra/test/rules/RULE-10-2/test.c: Language not supported
  • c/misra/test/rules/RULE-14-3/ControllingExprInvariant.expected: Language not supported
  • c/misra/test/rules/RULE-14-3/test.c: Language not supported
  • c/misra/test/rules/RULE-7-4/StringLiteralAssignedToNonConstChar.expected: Language not supported
  • c/misra/test/rules/RULE-7-4/test.c: Language not supported
  • c/misra/test/rules/RULE-8-3/function1.c: Language not supported
  • c/misra/test/rules/RULE-8-3/function2.c: Language not supported
  • cpp/common/src/codingstandards/cpp/Compatible.qll: Language not supported
  • cpp/common/src/codingstandards/cpp/rules/donotusepointerarithmetictoaddressdifferentarrays/DoNotUsePointerArithmeticToAddressDifferentArrays.qll: Language not supported
  • cpp/common/src/codingstandards/cpp/rules/invalidatedenvstringpointers/InvalidatedEnvStringPointers.qll: Language not supported
  • cpp/common/test/rules/donotusepointerarithmetictoaddressdifferentarrays/DoNotUsePointerArithmeticToAddressDifferentArrays.expected: Language not supported
  • cpp/common/test/rules/donotusepointerarithmetictoaddressdifferentarrays/test.cpp: Language not supported
  • cpp/common/test/rules/invalidatedenvstringpointers/InvalidatedEnvStringPointers.expected: Language not supported
  • cpp/common/test/rules/invalidatedenvstringpointers/test.cpp: Language not supported

Tip: Leave feedback on Copilot's review comments with the 👎 and 👍 buttons to help improve review quality. Learn more

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.

A few initial comments.

@lcartey lcartey added this pull request to the merge queue Mar 18, 2025
Merged via the queue into main with commit 6d7395a Mar 18, 2025
25 checks passed
@lcartey lcartey deleted the michaelrfairhurst/implement-rule-amendments-tc2 branch March 18, 2025 12:44
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