Skip to content

Import INT50-CPP into 4-1-3#1088

Open
MichaelRFairhurst wants to merge 1 commit intomichaelrfairhurst/package-undefined-behaviorfrom
michaelrfairhurst/package-undefined-behavior-cast-enum-out-of-range
Open

Import INT50-CPP into 4-1-3#1088
MichaelRFairhurst wants to merge 1 commit intomichaelrfairhurst/package-undefined-behaviorfrom
michaelrfairhurst/package-undefined-behavior-cast-enum-out-of-range

Conversation

@MichaelRFairhurst
Copy link
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-4-1-3
  • 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 AI review requested due to automatic review settings March 17, 2026 07:18
Copy link
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

This PR refactors the CERT INT50-CPP “out-of-range enum cast” rule into a reusable shared CodeQL library and reuses it to introduce a new MISRA C++ RULE-4-1-3 query for critical unspecified behavior.

Changes:

  • Extracted INT50-CPP query logic into a new shared module DoNotCastToAnOutOfRangeEnumerationValueShared.qll and updated the CERT query to use it.
  • Added a new MISRA wrapper query OutOfRangeEnumCastCriticalUnspecifiedBehavior.ql and registered it in the Undefined package metadata/exclusions.
  • Added shared tests in cpp/common/test/... and hooked both CERT and MISRA tests to them via .testref.

Reviewed changes

Copilot reviewed 11 out of 13 changed files in this pull request and generated no comments.

Show a summary per file
File Description
rule_packages/cpp/Undefined.json Registers the new MISRA RULE-4-1-3 query in the Undefined package metadata.
rule_packages/cpp/TypeRanges.json Adds shared_implementation_short_name for INT50-CPP to reflect the shared implementation.
cpp/misra/test/rules/RULE-4-1-3/OutOfRangeEnumCastCriticalUnspecifiedBehavior.testref Points MISRA tests to the shared common test query.
cpp/misra/src/rules/RULE-4-1-3/OutOfRangeEnumCastCriticalUnspecifiedBehavior.ql New MISRA query wrapper using the shared implementation.
cpp/common/test/rules/donotcasttoanoutofrangeenumerationvalueshared/test.cpp New shared test cases (COMPLIANT/NON_COMPLIANT coverage).
cpp/common/test/rules/donotcasttoanoutofrangeenumerationvalueshared/DoNotCastToAnOutOfRangeEnumerationValueShared.ql Test query instantiating the shared module for the common test harness.
cpp/common/test/rules/donotcasttoanoutofrangeenumerationvalueshared/DoNotCastToAnOutOfRangeEnumerationValueShared.expected Expected results for the shared test query.
cpp/common/src/codingstandards/cpp/rules/donotcasttoanoutofrangeenumerationvalueshared/DoNotCastToAnOutOfRangeEnumerationValueShared.qll New shared library module implementing the out-of-range enum cast detection.
cpp/common/src/codingstandards/cpp/exclusions/cpp/Undefined.qll Registers the new query in Undefined query metadata/types.
cpp/cert/test/rules/INT50-CPP/DoNotCastToAnOutOfRangeEnumerationValue.testref Points CERT tests to the shared common test query.
cpp/cert/src/rules/INT50-CPP/DoNotCastToAnOutOfRangeEnumerationValue.ql Refactored to import/instantiate the shared module.
change_notes/2026-03-17-share-out-of-range-enum-cast-query.md Change note documenting the refactor/reuse.

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