Add common infrastructure for Rule-Based Testing

[thomas-bc]

Related Issue(s)
Has Unit Tests (y/n)
Documentation Included (y/n)
Generative AI was used in this contribution (y/n)

---

Change Description

Preface to #3134

The goal here is to provide a “standard" pattern for doing Rule-Based Testing. This does not mean restricting to only that pattern, but I will next document how to work with this specific pattern, and provide tooling to work with it.

• adds a TestUtils MACRO for defining Rule-Based Test rules. This enables the framework's ASSERT_EVENTS_* etc. macros to be usable within the rule body by... simply making the body of the rule delegate to a member function of the tester. this is all declared / handled by the macro, and users need simply to implement each body.
• refactors Svc.Ccsds.ApidManager to use said common infrastructure

Future Work

• Write How-To Guide
• Identify potential tooling support. My plan for now:
  • fprime-util new --rule-based-testing --> bootstraps the RBT structure (TestState folder and class definition, Rules/*.cpp file)
  • I don't see much value in having a fprime-util new --rule for each rule, as we need to insert the MACROs inside the ComponentTester.hpp which would be very brittle and not much added value. Instruct users to copy-paste is fine imo.
  • Potentially fprime-util new --rule-group that creates the RuleGroup.cpp file and a TODO rule ?

AI Usage (see policy)

Help think through the architecture and refactor the ApidManager test code to the new architecture

[Copilot]

Pull request overview

This PR adds shared infrastructure to simplify Rule-Based Testing (RBT) rules in F Prime unit tests, then refactors the Svc::Ccsds::ApidManager unit tests to use the new approach (shadow state + grouped rules implemented as tester methods).

Changes:

• Introduces FW_RBT_DEFINE_RULE in TestUtils to generate rule structs that delegate to tester member functions (enabling existing ASSERT_* macros inside rule bodies).
• Refactors ApidManager UTs into a TestState shadow-model and per-group rule implementation .cpp files.
• Updates the ApidManager UT CMake registration to compile the new rule/state sources.

Reviewed changes

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

Show a summary per file

File	Description
TestUtils/RuleBasedTesting.hpp	Adds a macro-based pattern for defining STest::Rule types that delegate to tester methods.
Svc/Ccsds/ApidManager/test/ut/TestState/TestState.hpp	Introduces an ApidManager shadow-state model API for rule preconditions/actions.
Svc/Ccsds/ApidManager/test/ut/TestState/TestState.cpp	Implements shadow-state helpers (sequence count tracking + random APID selection).
Svc/Ccsds/ApidManager/test/ut/Rules/GetSeqCount.cpp	Adds rule implementations for exercising getApidSeqCountIn.
Svc/Ccsds/ApidManager/test/ut/Rules/ValidateSeqCount.cpp	Adds rule implementations for exercising validateApidSeqCountIn.
Svc/Ccsds/ApidManager/test/ut/ApidManagerTestMain.cpp	Updates tests to instantiate/apply the new nested rule types and run randomized scenarios.
Svc/Ccsds/ApidManager/test/ut/ApidManagerTester.hpp	Refactors the tester to use FW_RBT_DEFINE_RULE and the new ApidManagerTestState.
Svc/Ccsds/ApidManager/test/ut/ApidManagerTester.cpp	Removes legacy embedded rule/helper implementations from the tester .cpp.
Svc/Ccsds/ApidManager/CMakeLists.txt	Adds new UT source files (shadow state + rule groups) to the unit test target.

[bocchino]

Looks great! I like the simplification into one macro. I just had one suggested revision to the naming in the macro.

[bocchino]

Looks good!