Skip to content

Implement Preconditions2, appropriate types sent via ellipsis.#1123

Open
MichaelRFairhurst wants to merge 3 commits intomainfrom
michaelrfairhurst/preconditions-rule-8-2-11-types-passed-by-ellipsis
Open

Implement Preconditions2, appropriate types sent via ellipsis.#1123
MichaelRFairhurst wants to merge 3 commits intomainfrom
michaelrfairhurst/preconditions-rule-8-2-11-types-passed-by-ellipsis

Conversation

@MichaelRFairhurst
Copy link
Copy Markdown
Collaborator

Description

please enter the description of your change here

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-8-2-11
  • 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!)

@MichaelRFairhurst MichaelRFairhurst marked this pull request as ready for review April 30, 2026 00:07
Copilot AI review requested due to automatic review settings April 30, 2026 00:07
…conditions-rule-8-2-11-types-passed-by-ellipsis
Copy link
Copy Markdown
Contributor

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.

Pull request overview

Adds the MISRA C++:2023 RULE-8-2-11 query implementation to the “Preconditions2” package, including rule-package metadata and unit tests for detecting class types that should not be passed via an ellipsis (...) parameter.

Changes:

  • Added new query cpp/misra/inappropriate-argument-type-passed-via-ellipsis (RULE-8-2-11) to flag inappropriate class types passed via ....
  • Added unit tests (test.cpp), .qlref, and .expected outputs for RULE-8-2-11.
  • Integrated the new Preconditions2 package into the exclusions/metadata plumbing (RuleMetadata.qll, new Preconditions2.qll, new rule package JSON).
Show a summary per file
File Description
rule_packages/cpp/Preconditions2.json Registers RULE-8-2-11 query metadata in the Preconditions2 rule package.
cpp/misra/src/rules/RULE-8-2-11/InappropriateArgumentTypePassedViaEllipsis.ql Implements the new RULE-8-2-11 CodeQL query and alert message.
cpp/misra/test/rules/RULE-8-2-11/test.cpp Adds test cases covering compliant and non-compliant ellipsis arguments.
cpp/misra/test/rules/RULE-8-2-11/InappropriateArgumentTypePassedViaEllipsis.qlref Links the test to the production query file.
cpp/misra/test/rules/RULE-8-2-11/InappropriateArgumentTypePassedViaEllipsis.expected Defines expected results for the unit test run.
cpp/common/src/codingstandards/cpp/exclusions/cpp/RuleMetadata.qll Wires Preconditions2 into the global exclusions/metadata registry.
cpp/common/src/codingstandards/cpp/exclusions/cpp/Preconditions2.qll Adds the autogenerated Preconditions2 query metadata module.

Copilot's findings

Comments suppressed due to low confidence (1)

cpp/misra/test/rules/RULE-8-2-11/test.cpp:43

  • This move-assignment operator returns a reference but does not return on all paths. Falling off the end of a non-void function is undefined behavior and may break extraction/compilation depending on warnings-as-errors settings. Please return *this (or otherwise return a valid reference).
  int m1;
  NonTrivialMoveAssignClass &operator=(NonTrivialMoveAssignClass &&other) {}
};
  • Files reviewed: 7/7 changed files
  • Comments generated: 2

Comment thread cpp/misra/test/rules/RULE-8-2-11/test.cpp Outdated
Comment thread cpp/misra/test/rules/RULE-8-2-11/test.cpp
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