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 Language4 package, banning obsolete language features. #730

Merged

Conversation

MichaelRFairhurst
Copy link
Contributor

Description

Implement Language4 package, banning obsolete language features.

Many of the cases outlined in the amendment are covered by other rules. Add support for new cases where possible (was not possible for ID 3, storage class specifiers not at beginning of declaration, or ID 2, which is a feature of the implementation not determinable by static analysis), and reference existing rules in one comprehensive test for maximal clarity that those parts of rule 1-5 are indeed supported by our existing queries.

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-1-5
  • Queries have been modified for the following rules:
    • rule number here

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

Many of the cases outlined in the amendment are covered by other rules. Add
support for new cases where possible (was not possible for ID 3, storage class
specifiers not at beginning of declaration, or ID 2, which is a feature of the
implementation not determinable by static analysis), and reference existing
rules in one comprehensive test for maximal clarity that those parts of rule
1-5 are indeed supported by our existing queries.
@MichaelRFairhurst MichaelRFairhurst force-pushed the michaelrfairhurst/implement-lanugage4-package-rule-1-5 branch from a5dda8d to d077885 Compare October 4, 2024 18:51
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.

Thanks! I've provided some feedback on Rule 1.5. There's also the open question of whether we should include (via shared rules) the existing rules into Rule 1.5 directly itself.

c/misra/src/rules/RULE-1-5/CallToReallocWithSizeZero.ql Outdated Show resolved Hide resolved
…dundant.

Redundant reports should not be a common user issue; these features are
obsolescent and likely rarely used and less often to be excepted.

Implement ungetc() on a zero-offset stream and specific banning of gets(), as
the redundant rules for those obsolescent features report a far wider set of
issues than banned by RULE-1-5.

Implementation of banning ungetc() on a zero-offset stream is not thorough or
comprehensive. This should be fine. False positives should not create any user
issues because the call of the function overall is banned. And false negatives
should not be an issue, for the same reason.
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.

Looks good, thanks!

@lcartey lcartey added this pull request to the merge queue Oct 31, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Nov 1, 2024
@MichaelRFairhurst MichaelRFairhurst added this pull request to the merge queue Nov 15, 2024
Merged via the queue into main with commit 373b793 Nov 15, 2024
25 checks passed
@MichaelRFairhurst MichaelRFairhurst deleted the michaelrfairhurst/implement-lanugage4-package-rule-1-5 branch November 15, 2024 07:23
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