Move M5-14-1 implementation into shared query with Rule 8.14.1, increase test coverage. by MichaelRFairhurst · Pull Request #1050 · github/codeql-coding-standards

MichaelRFairhurst · 2026-02-22T04:59:46Z

Description

Though test coverage didn't quite indicate it so, these two rules are implemented 100% compatibly.

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-14-1
Queries have been modified for the following rules:
- M5-14-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!)

…ase test coverage.

Copilot

Pull request overview

This PR consolidates the implementations of AUTOSAR M5-14-1 and MISRA C++:2023 RULE-8-14-1 into a single shared query, and adjusts tests/package metadata accordingly.

Changes:

Introduces a shared implementation ShortCircuitedPersistentSideEffectShared and rewires M5-14-1 and RULE-8-14-1 to use it.
Adds a new rule package/exclusions wiring for RULE-8-14-1 (SideEffects5) and updates RuleMetadata.
Replaces per-rule tests with shared-library-backed tests and expands shared test coverage.

Reviewed changes

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

Show a summary per file

File	Description
rule_packages/cpp/SideEffects5.json	Adds new package metadata for MISRA C++ RULE-8-14-1.
rule_packages/cpp/SideEffects1.json	Points M5-14-1 to the new shared implementation.
cpp/misra/test/rules/RULE-8-14-1/ShortCircuitedPersistentSideEffect.testref	Hooks RULE-8-14-1 tests to the shared test query.
cpp/misra/src/rules/RULE-8-14-1/ShortCircuitedPersistentSideEffect.ql	Adds new MISRA query importing the shared implementation.
cpp/common/test/rules/shortcircuitedpersistentsideeffectshared/test.cpp	Adds expanded test cases for the shared implementation.
cpp/common/test/rules/shortcircuitedpersistentsideeffectshared/ShortCircuitedPersistentSideEffectShared.ql	Shared-implementation test query wrapper (generated).
cpp/common/test/rules/shortcircuitedpersistentsideeffectshared/ShortCircuitedPersistentSideEffectShared.expected	Expected results for the shared-implementation tests.
cpp/common/src/codingstandards/cpp/rules/shortcircuitedpersistentsideeffectshared/ShortCircuitedPersistentSideEffectShared.qll	New shared query implementation module.
cpp/common/src/codingstandards/cpp/exclusions/cpp/SideEffects5.qll	Adds exclusions metadata package module for SideEffects5.
cpp/common/src/codingstandards/cpp/exclusions/cpp/RuleMetadata.qll	Registers SideEffects5 in exclusions metadata wiring.
cpp/autosar/test/rules/M5-14-1/test.cpp	Removes local test file in favor of shared tests.
cpp/autosar/test/rules/M5-14-1/RightHandOperandOfALogicalAndOperatorsContainSideEffects.qlref	Removes direct qlref test hook in favor of shared tests.
cpp/autosar/test/rules/M5-14-1/RightHandOperandOfALogicalAndOperatorsContainSideEffects.expected	Removes local expected output in favor of shared expected output.
cpp/autosar/test/rules/M5-14-1/RightHandOperandOfALogicalAndOperators.testref	Adds shared-test hook for M5-14-1.
cpp/autosar/src/rules/M5-14-1/RightHandOperandOfALogicalAndOperatorsContainSideEffects.ql	Replaces inline logic with shared implementation import/config.
change_notes/2026-02-21-share-implementation-of-m5-14-1.md	Adds change note for the refactor to shared implementation.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-22T05:04:19Z

rule_packages/cpp/SideEffects5.json

+{
+  "MISRA-C++-2023": {
+    "RULE-8-14-1": {
+      "properties": {
+        "enforcement": "undecidable",


RULE-8-14-1 is mapped to package SideEffects3 in rules.csv (line 901), but this PR introduces a new package file SideEffects5.json for the rule. This mismatch will likely break package generation / rule metadata resolution. Align the package name by updating rules.csv to SideEffects5 (or, if SideEffects3 is intended, rename/regenerate the new rule package/exclusion modules accordingly).

Copilot · 2026-02-22T05:04:20Z

cpp/autosar/test/rules/M5-14-1/RightHandOperandOfALogicalAndOperators.testref

@@ -0,0 +1 @@
+cpp/common/test/rules/shortcircuitedpersistentsideeffectshared/ShortCircuitedPersistentSideEffectShared.ql


The .testref filename is expected to be <query short_name>.testref (see scripts/generate_rules/generate_package_files.py), but this file is named RightHandOperandOfALogicalAndOperators.testref while the query short name for M5-14-1 is RightHandOperandOfALogicalAndOperatorsContainSideEffects. Rename the file to match the query short name so the test runner/generator can discover it correctly.

Copilot · 2026-02-22T05:04:20Z

cpp/misra/src/rules/RULE-8-14-1/ShortCircuitedPersistentSideEffect.ql

@@ -0,0 +1,27 @@
+/**
+ * @id cpp/misra/short-circuited-persistent-side-effect
+ * @name RULE-8-14-1: The right-hand operand of a logical && or operator should not contain persistent side effects


The query metadata @name says "logical && or operator" but the rule/package title and the @description mention both && and ||. Please update @name to include || as well so metadata is consistent across the rule definition.

Suggested change

* @name RULE-8-14-1: The right-hand operand of a logical && or operator should not contain persistent side effects

* @name RULE-8-14-1: The right-hand operand of a logical && or || operator should not contain persistent side effects

Copilot · 2026-02-22T05:04:20Z

change_notes/2026-02-21-share-implementation-of-m5-14-1.md

@@ -0,0 +1,2 @@
+ - `M5-14-1` - `RightHandOperandOfALogicalAndOperatorsContainSideEffects.ql`:
+   - Implementation has been refactor to share logic with Rule 8.14.1. No observable changes to results expected.


Typo/grammar: "has been refactor" should be "has been refactored".

Suggested change

- Implementation has been refactor to share logic with Rule 8.14.1. No observable changes to results expected.

- Implementation has been refactored to share logic with Rule 8.14.1. No observable changes to results expected.

Copilot · 2026-02-22T05:04:21Z

cpp/common/test/rules/shortcircuitedpersistentsideeffectshared/test.cpp

+  } // COMPLIANT  - noexcept operands not evaluated
+
+  if (1 || (typeid(f6()) == typeid(f5()))) {
+  } // NON_COMPLIANT  - typeid operands not evaluated, but the ==operator is


This comment is incomplete (ends at "but the ==operator is"). Either finish the sentence or remove it to avoid confusion when reading the test case.

Suggested change

} // NON_COMPLIANT - typeid operands not evaluated, but the ==operator is

} // NON_COMPLIANT - typeid operands are not evaluated, but the == operator is, so its operands are evaluated

Move M5-14-1 implementation into shared query with Rule 8.14.1, incre…

4b0b74e

…ase test coverage.

Copilot AI review requested due to automatic review settings February 22, 2026 04:59

Copilot started reviewing on behalf of MichaelRFairhurst February 22, 2026 05:00 View session

Format cpp tests

df1a5f2

Copilot AI reviewed Feb 22, 2026

View reviewed changes

MichaelRFairhurst added 3 commits February 21, 2026 21:12

Commit rules.csv changes

c3af72c

Fix locally different clang-format output compared to CI/CD

0822b06

Fix metadata inconsistency

2f1e920

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Comments

Move M5-14-1 implementation into shared query with Rule 8.14.1, increase test coverage.#1050

Move M5-14-1 implementation into shared query with Rule 8.14.1, increase test coverage.#1050
MichaelRFairhurst wants to merge 5 commits intomainfrom
michaelrfairhurst/side-effects-5-rule-8-14-1-rhs-of-and-and-should-have-no-side-effects

MichaelRFairhurst commented Feb 22, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Feb 22, 2026

Uh oh!

Copilot AI Feb 22, 2026

Uh oh!

Copilot AI Feb 22, 2026

Uh oh!

Copilot AI Feb 22, 2026

Uh oh!

Copilot AI Feb 22, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

		@@ -0,0 +1 @@
		cpp/common/test/rules/shortcircuitedpersistentsideeffectshared/ShortCircuitedPersistentSideEffectShared.ql No newline at end of file

	* @name RULE-8-14-1: The right-hand operand of a logical && or operator should not contain persistent side effects
	* @name RULE-8-14-1: The right-hand operand of a logical && or \|\| operator should not contain persistent side effects

		@@ -0,0 +1,2 @@
		- `M5-14-1` - `RightHandOperandOfALogicalAndOperatorsContainSideEffects.ql`:
		- Implementation has been refactor to share logic with Rule 8.14.1. No observable changes to results expected. No newline at end of file

	- Implementation has been refactor to share logic with Rule 8.14.1. No observable changes to results expected.
	- Implementation has been refactored to share logic with Rule 8.14.1. No observable changes to results expected.

	} // NON_COMPLIANT - typeid operands not evaluated, but the ==operator is
	} // NON_COMPLIANT - typeid operands are not evaluated, but the == operator is, so its operands are evaluated

Comments

Conversation

MichaelRFairhurst commented Feb 22, 2026

Description

Change request type

Rules with added or modified queries

Release change checklist

Query development review checklist

Author

Reviewer

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 22, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 22, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 22, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 22, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 22, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant