Skip to content

Conversation

MichaelRFairhurst
Copy link
Collaborator

@MichaelRFairhurst MichaelRFairhurst commented Aug 20, 2025

Description

Implement Classes2 package, except for RULE-15-0-1 (which has tricky information missing from the database) and RULE-15-1-4 (which I haven't started yet but will take many hours).

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-13-1-1
    • RULE-13-3-1
    • RULE-14-1-1
    • RULE-15-0-2
    • RULE-15-1-3
    • RULE-16-5-1
    • RULE-16-6-1
  • 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!)

@Copilot Copilot AI review requested due to automatic review settings August 20, 2025 20:09
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.

Pull Request Overview

This PR implements most of the Classes2 rule package by adding 6 new C++ MISRA rule queries, while moving 2 harder rules (RULE-15-0-1 and RULE-15-1-4) to Classes3 package. The implementation includes comprehensive test coverage and proper integration with the exclusion framework.

  • Adds 6 new MISRA C++ 2023 rule implementations covering virtual inheritance, member specifiers, data member access levels, special member functions, conversion operators, and operator overloading
  • Moves 2 complex rules to Classes3 package for future implementation
  • Creates comprehensive test suites with both compliant and non-compliant examples for each rule

Reviewed Changes

Copilot reviewed 32 out of 32 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
rules.csv Updates rule assignments, moving RULE-15-0-1 and RULE-15-1-4 to Classes3 package
rule_packages/cpp/Classes2.json Defines metadata for 6 implemented MISRA rules in Classes2 package
cpp/misra/test/rules/RULE-*/test.cpp Test files providing comprehensive coverage for each rule implementation
cpp/misra/test/rules/RULE-/.qlref Reference files linking to query implementations
cpp/misra/test/rules/RULE-/.expected Expected test results for validation
cpp/misra/src/rules/RULE-/.ql Query implementations for each MISRA rule
cpp/common/src/codingstandards/cpp/exclusions/cpp/RuleMetadata.qll Integration with exclusion framework
cpp/common/src/codingstandards/cpp/exclusions/cpp/Classes2.qll Auto-generated exclusion definitions for Classes2 package
Comments suppressed due to low confidence (1)

cpp/misra/src/rules/RULE-14-1-1/PrivateAndPublicDataMembersMixed.ql:1

  • Spelling error: 'maintanability' should be 'maintainability'.
/**

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

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.

1 participant