Skip to content

Conversation

@MichaelRFairhurst
Copy link
Collaborator

Description

Implements Rule 0-0-2, invariant conditions. Similar to autosar's M0-1-2 but with different exceptional cases.

I tried using modules as a new form of query behavior sharing here. At some point in the future, we may want the shared query generator to generate this template instead of the existing one that uses abstract classes and an unparameterized problems query.

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-0-0-2
  • Queries have been modified for the following rules:
    • M-0-1-2

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 December 18, 2025 01:06
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 implements RULE-0-0-2 from MISRA C++ 2023, which identifies controlling expressions that are invariant (always true or always false). The implementation refactors the existing M0-1-2 query for AUTOSAR to share common logic through a parameterized module approach, while allowing each standard to define its own exceptional cases.

  • Introduces a shared InvariantCondition.qll library that provides reusable logic for detecting invariant conditions via parameterized modules
  • Implements RULE-0-0-2 for MISRA C++ 2023 with exceptions for while(true), constexpr if, and macro-generated do {} while(false) loops
  • Refactors M0-1-2 to use the shared library while maintaining its own exception logic for breaking loops and macro-affected conditions

Reviewed changes

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

Show a summary per file
File Description
rule_packages/cpp/DeadCode4.json Adds rule package metadata for RULE-0-0-2 with appropriate properties and query configuration
cpp/misra/test/rules/RULE-0-0-2/test.cpp Provides comprehensive test cases covering compliant and non-compliant scenarios including templates, macros, and constexpr
cpp/misra/test/rules/RULE-0-0-2/InvariantCondition.qlref Reference file pointing to the MISRA query implementation
cpp/misra/test/rules/RULE-0-0-2/InvariantCondition.expected Expected test results with 15 non-compliant cases identified
cpp/misra/src/rules/RULE-0-0-2/InvariantCondition.ql Main query implementing RULE-0-0-2 with MISRA-specific exception logic
cpp/common/src/codingstandards/cpp/rules/invariantcondition/InvariantCondition.qll Shared library module providing parameterized invariant condition detection logic
cpp/common/src/codingstandards/cpp/exclusions/cpp/RuleMetadata.qll Updates rule metadata registry to include DeadCode4 package
cpp/common/src/codingstandards/cpp/exclusions/cpp/DeadCode4.qll Auto-generated query metadata for the DeadCode4 package
cpp/common/src/codingstandards/cpp/Literals.qll Adds isTrue() and isFalse() convenience predicates to BoolLiteral class
cpp/autosar/src/rules/M0-1-2/InfeasiblePath.ql Refactored to use shared library while maintaining AUTOSAR-specific exception logic
change_notes/2025-12-17-unfeasible-statement-refactor.md Documents the refactoring with no expected behavior change for M0-1-2

💡 Add Copilot custom instructions for smarter, more guided reviews. 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.

2 participants