Skip to content

Import A5-6-1 division/mod by zero#1087

Open
MichaelRFairhurst wants to merge 1 commit intomichaelrfairhurst/package-undefined-behaviorfrom
michaelrfairhurst/package-undefined-behavior-divide-or-modulo-by-zero
Open

Import A5-6-1 division/mod by zero#1087
MichaelRFairhurst wants to merge 1 commit intomichaelrfairhurst/package-undefined-behaviorfrom
michaelrfairhurst/package-undefined-behavior-divide-or-modulo-by-zero

Conversation

@MichaelRFairhurst
Copy link
Collaborator

Description

Division or mod 0 is undefined behavior.

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:
    • A5-6-1

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 05:01
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

Adds a MISRA C++ 2023 RULE-4-1-3 query for division/modulo by zero by reusing the existing AUTOSAR A5-6-1 implementation via a new shared CodeQL library, consolidating rule logic and tests.

Changes:

  • Introduce shared implementation DivisorEqualToZeroShared and refactor AUTOSAR A5-6-1 to use it.
  • Add new MISRA RULE-4-1-3 query (DivisionByZeroUndefinedBehavior) that instantiates the shared implementation.
  • Update rule package metadata, exclusions metadata wiring, shared tests, and add a change note.

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 Adds new RULE-4-1-3 query entry and links it to the shared implementation.
rule_packages/cpp/Expressions.json Points A5-6-1 query metadata at the new shared implementation.
cpp/misra/test/rules/RULE-4-1-3/DivisionByZeroUndefinedBehavior.testref Reuses the shared test implementation for the new MISRA query.
cpp/misra/src/rules/RULE-4-1-3/DivisionByZeroUndefinedBehavior.ql New MISRA query instantiating the shared divisor-zero logic.
cpp/common/test/rules/divisorequaltozeroshared/test.cpp Minor test file formatting/line-number alignment.
cpp/common/test/rules/divisorequaltozeroshared/DivisorEqualToZeroShared.ql Generated shared-query test harness instantiation.
cpp/common/test/rules/divisorequaltozeroshared/DivisorEqualToZeroShared.expected Updates expected file line numbering to match test source.
cpp/common/src/codingstandards/cpp/rules/divisorequaltozeroshared/DivisorEqualToZeroShared.qll New reusable shared implementation (configurable via exclusions Query).
cpp/common/src/codingstandards/cpp/exclusions/cpp/Undefined.qll Wires new MISRA query into the Undefined package query metadata/accessors.
cpp/autosar/test/rules/A5-6-1/DivisorEqualToZero.testref Switches AUTOSAR A5-6-1 test to reuse the shared test implementation.
cpp/autosar/test/rules/A5-6-1/DivisorEqualToZero.qlref Removes the old direct .qlref-based test linkage.
cpp/autosar/src/rules/A5-6-1/DivisorEqualToZero.ql Refactors AUTOSAR query to instantiate the shared implementation.
change_notes/2026-03-16-share-divisor-equal-to-zero-query.md Adds required change note for the refactor and 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