Implement package SideEffects6 with rule 28.3.1, predicate should not have side effects

[MichaelRFairhurst]

Description

New library to handle template parameters and find their substitutions.

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-28-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]

Pull request overview

This pull request implements MISRA C++ 2023 rule RULE-28-3-1 ("Predicates shall not have persistent side effects") as part of the new SideEffects6 package. The implementation introduces two complementary queries that detect different aspects of predicate misuse in C++ standard library algorithms.

Changes:

• Adds new template substitution tracking library (Templates.qll) to model how template parameters are instantiated with concrete types
• Adds new predicate detection library (Predicate.qll) to identify predicate function objects and function pointers passed to standard library algorithms
• Implements two queries: one detecting persistent side effects (global/static modifications) in predicates, and one detecting non-const operator() in predicate function objects

Reviewed changes

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

Show a summary per file

File	Description
rules.csv	Updates RULE-28-3-1 entry to reference SideEffects6 package
rule_packages/cpp/SideEffects6.json	Defines package metadata and query configurations for two queries targeting RULE-28-3-1
cpp/common/src/codingstandards/cpp/types/Templates.qll	New library modeling template parameter substitutions (ClassTemplateInstantiation, FunctionTemplateInstantiation, VariableTemplateInstantiation)
cpp/common/src/codingstandards/cpp/types/Predicate.qll	New library for detecting predicate types, function objects, and function pointer uses in standard library algorithms
cpp/common/src/codingstandards/cpp/exclusions/cpp/SideEffects6.qll	Auto-generated exclusion module for the two queries
cpp/common/src/codingstandards/cpp/exclusions/cpp/RuleMetadata.qll	Integrates SideEffects6 package into the exclusion metadata system
cpp/misra/src/rules/RULE-28-3-1/PredicateWithPersistentSideEffects.ql	Query detecting predicates with persistent side effects (global/static modifications)
cpp/misra/src/rules/RULE-28-3-1/NonConstPredicateFunctionObject.ql	Query detecting function objects with non-const operator() used as predicates
cpp/misra/test/rules/RULE-28-3-1/test.cpp	Comprehensive test cases covering both compliant and non-compliant scenarios
cpp/misra/test/rules/RULE-28-3-1/*.qlref	Test reference files pointing to the query implementations
cpp/misra/test/rules/RULE-28-3-1/*.expected	Expected test results for both queries

---

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

[Copilot]

Pull request overview

Copilot reviewed 23 out of 23 changed files in this pull request and generated 4 comments.

---

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

[mbaluda]

LGTM!
Missing a full stop at the end of error message