chore: S24.02 adopt CALLED_* test macros + standardise *CallCount naming

[DavidCozens]

Purpose

S24.02 (#321) under E24 Code Hygiene (#254). Closes #321.

The test base mixed several call-count assertion shapes —
LONGS_EQUAL(N, fooCallCount), LONGS_EQUAL(N, FakeFoo_BarCount()),
CHECK_TRUE(barCalled) — with inconsistent variable naming
(SenderFake_SendCount, StoreFake_WriteCount, g_sleepCallCount,
storeFullCallbackCount, etc.). Two partial implementations
(bespoke CHECK_HANDLER_INVOKED_ONCE macros in SolidSyslogErrorTest.cpp
and an expression-form CALLED_FUNCTION(f, n) already in TestUtils.h)
hinted at the shape of the answer but didn't enforce naming. This PR
generalises both into a single design across every test executable.

Change Description

Tests/Support/TestUtils.h now defines three token-paste macros backed
by the existing CososoTesting::NEVER/ONCE/TWICE/THRICE enum:

CALLED_FUNCTION(name, count)            // local static int counter
CALLED_FAKE(getter, count)              // global-state fake getter
CALLED_FAKE_ON(getter, instance, count) // instance-parameter getter

Token paste enforces the <functionName>CallCount naming rule at
compile time, so future drift is caught by the build rather than in
review.

Other notable changes:

• Tests/TestUtils.h moved to Tests/Support/TestUtils.h so
  non-Tests/-root executables (Example, FreeRtos) can reach it via
  the established Support include path.
• Counter renames to follow the <funcName>CallCount rule:
  SenderFake_SendCount → SendCallCount, StoreFake_WriteCount →
  WriteCallCount, g_sleepCallCount → NoOpSleepCallCount,
  getPort/HostCallCount → SpyGetPort/HostCallCount,
  sleepCallCount → SleepFakeCallCount, storeFullCallbackCount →
  CountStoreFullInvocationsCallCount, thresholdCallbackCount →
  CountThresholdCrossingsCallCount.
• Bool flags converted to int counters:
  storeFullCallbackInvoked / computeIntegrityCalled /
  verifyIntegrityCalled. Tests now also catch unexpected
  double-fires of these callbacks/spies.
• Bespoke CHECK_HANDLER_INVOKED_ONCE / CHECK_HANDLER_NOT_INVOKED
  macros in SolidSyslogErrorTest.cpp removed in favour of the
  generic CALLED_FUNCTION(handler, ...).
• Existing CALLED_FUNCTION(expr, n) callers in
  SolidSyslogSwitchingSenderTest.cpp migrated to CALLED_FAKE_ON
  (every site there was structurally an instance-getter call).
• Tests/FreeRtos/CMakeLists.txt picks up Tests/Support on the
  include path of all four FreeRtos host test executables.

E24 itself was renamed from "Hardening" to "Code Hygiene" earlier in
the session — the body was already written for cross-cutting
non-functional sweeps; only the title was wrong. Robustness work
continues to live in E12 / E25 / E26.

Test Evidence

Pure refactor of existing test assertions; no new tests, no
production code touched. Verification:

• cmake --build --preset debug --target junit — 1088 tests pass.
• cmake --build --preset clang-debug --target junit — 1088 tests pass.
• cmake --build --preset sanitize --target junit — 1088 tests pass.
• cmake --build --preset coverage --target coverage — 100% lines,
  100% functions (no change from baseline).
• cmake --build --preset tidy — clean.
• cmake --build --preset cppcheck — clean.
• clang-format --dry-run --Werror over Core/Tests/Example — clean.
• FreeRtos host build verified separately:
  SolidSyslogFreeRtosDatagramTest (21 tests),
  CmsdkUartTest (15), SolidSyslogFreeRtosSysUpTimeTest (4),
  SolidSyslogFreeRtosStaticResolverTest (10) — all green.
• Winsock-build variants (*Winsock*Test.cpp) converted via the same
  mechanical sweep but exercised by CI only.

Areas Affected

• Tests/Support/TestUtils.h — new home for the three call-count
  macros. The existing MinSize helper and the CososoTesting
  namespace stay.
• 23 test files swept across Tests/, Tests/Example/, and
  Tests/FreeRtos/. No production code touched (Tier 1/2 boundary
  preserved).
• Tests/FreeRtos/CMakeLists.txt — three FreeRtos test
  executables now include Tests/Support on their include path.
• No impact on derived projects: this PR only touches Tests/ and
  the test build's CMake. Core/Interface, Core/Source,
  Platform/, and the public API surface are unchanged.

Summary by CodeRabbit

Release Notes

• Tests

  • Standardized test assertions across all test suites using unified call-count verification macros
  • Replaced manual fake call-count checks with consistent assertion patterns for improved test clarity
  • Enhanced test infrastructure with new utilities to better detect and prevent unexpected function invocations

• Chores

  • Updated test build configuration to include new testing support utilities
  • Renamed test helper functions for naming consistency and clarity

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: f6dbb192-1de1-45ac-9d44-c16119bbbee3

📥 Commits

Reviewing files that changed from the base of the PR and between ae6a21c and 28363e0.

📒 Files selected for processing (34)

• DEVLOG.md
• Tests/DatagramFakeTest.cpp
• Tests/Example/ExampleServiceThreadTest.cpp
• Tests/Example/SolidSyslogExampleTest.cpp
• Tests/FreeRtos/CMakeLists.txt
• Tests/FreeRtos/CmsdkUartTest.cpp
• Tests/FreeRtos/SolidSyslogFreeRtosDatagramTest.cpp
• Tests/OpenSslFakeTest.cpp
• Tests/SenderFake.c
• Tests/SenderFake.h
• Tests/SenderFakeTest.cpp
• Tests/SocketFakeTest.cpp
• Tests/SolidSyslogBlockStoreTest.cpp
• Tests/SolidSyslogErrorTest.cpp
• Tests/SolidSyslogGetAddrInfoResolverTest.cpp
• Tests/SolidSyslogNullBufferTest.cpp
• Tests/SolidSyslogPosixDatagramTest.cpp
• Tests/SolidSyslogPosixMessageQueueBufferTest.cpp
• Tests/SolidSyslogPosixTcpStreamTest.cpp
• Tests/SolidSyslogStreamSenderTest.cpp
• Tests/SolidSyslogSwitchingSenderTest.cpp
• Tests/SolidSyslogTest.cpp
• Tests/SolidSyslogTlsStreamTest.cpp
• Tests/SolidSyslogUdpSenderTest.cpp
• Tests/SolidSyslogWinsockDatagramTest.cpp
• Tests/SolidSyslogWinsockResolverTest.cpp
• Tests/SolidSyslogWinsockTcpStreamTest.cpp
• Tests/StoreFake.c
• Tests/StoreFake.h
• Tests/StoreFakeTest.cpp
• Tests/StreamFakeTest.cpp
• Tests/Support/TestUtils.h
• Tests/TestUtils.h
• Tests/WinsockFakeTest.cpp

💤 Files with no reviewable changes (1)

• Tests/TestUtils.h

---

📝 Walkthrough

Walkthrough

This PR standardizes test call-count assertions across 30+ test files by introducing three token-paste macros in a new Tests/Support/TestUtils.h header and renaming fake accessors to conform to the *CallCount convention. The refactor replaces ad-hoc LONGS_EQUAL and CHECK_TRUE patterns with intent-named CALLED_FUNCTION, CALLED_FAKE, and CALLED_FAKE_ON macros, centralizing the naming contract and making test bodies more readable.

Changes

Test Macro Standardization

Layer / File(s)	Summary
Macro & Enum Definitions Tests/Support/TestUtils.h	New header defines CALLED_FUNCTION(name, count), CALLED_FAKE(getter, count), and CALLED_FAKE_ON(getter, instance, count) macros alongside CososoTesting enum constants (NEVER=0, ONCE=1, TWICE=2, THRICE=3). Includes MinSize utility.
Old Header Removal Tests/TestUtils.h	Delete original header after migrating utilities to Tests/Support/TestUtils.h.
Fake API Renames Tests/SenderFake.h, Tests/SenderFake.c, Tests/StoreFake.h, Tests/StoreFake.c	Rename accessor functions to enforce *CallCount naming: SenderFake_SendCount() → SenderFake_SendCallCount(), SenderFake_DisconnectCount() → SenderFake_DisconnectCallCount(), StoreFake_WriteCount() → StoreFake_WriteCallCount().
CMake Include Paths Tests/FreeRtos/CMakeLists.txt	Add ${CMAKE_SOURCE_DIR}/Tests/Support to target_include_directories for SolidSyslogFreeRtosDatagramTest, SolidSyslogFreeRtosStaticResolverTest, and CmsdkUartTest.
Test Header Includes & Namespace Tests/*/*.cpp, Tests/*FakeTest.cpp	Add #include "TestUtils.h" and using namespace CososoTesting; to 30+ test files to bring macros and enum constants into scope.
Counter Variable Renames Tests/Example/ExampleServiceThreadTest.cpp, Tests/SolidSyslogBlockStoreTest.cpp, Tests/SolidSyslogTlsStreamTest.cpp, Tests/SolidSyslogStreamSenderTest.cpp, Tests/SolidSyslogUdpSenderTest.cpp	Rename boolean flags and counters to conform to *CallCount rule: sleepCallCount → SleepFakeCallCount, g_sleepCallCount → NoOpSleepCallCount, storeFullCallbackInvoked → StoreFullCallbackCallCount, getPortCallCount → SpyGetPortCallCount, computeIntegrityCalled/verifyIntegrityCalled → SpyComputeIntegrityCallCount/SpyVerifyIntegrityCallCount.
Assertion Macro Migration Tests/*FakeTest.cpp, Tests/Posix*.cpp, Tests/Winsock*.cpp, Tests/SolidSyslog*.cpp, Tests/Example/*.cpp, Tests/FreeRtos/*.cpp	Replace 200+ LONGS_EQUAL(*CallCount()) and CHECK_TRUE/FALSE(called) assertions with CALLED_FUNCTION, CALLED_FAKE, or CALLED_FAKE_ON across all test suites. Update helper macros (e.g., CHECK_SOCKET_CLOSED_ONCE()) to use new macro style.
Change Log DEVLOG.md	Add entry for 2026-05-10 — S24.02: documents test-hygiene macro sweep, counter naming standardization, E24 epic rename, adoption details, and deferred items.

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly Related PRs

• DavidCozens/solid-syslog#300: Adds FreeRTOS datagram and task fakes that this PR's test assertions now reference via new macros.
• DavidCozens/solid-syslog#283: Introduces StoreFake and test suite updates that this PR refactors to use standardized call-count naming and macros.
• DavidCozens/solid-syslog#84: Earlier StoreFake modifications that this PR's renaming supersedes with *CallCount convention.

Poem

🐰 Hop, hop, test assertions now align,
CALLED_FAKE, CALLED_FUNCTION—macros so divine!
No more LONGS_EQUAL sprawl,
One naming rule to rule them all,
CallCounts crystal-clear and fine! ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 9.35% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The PR title accurately describes the main changes: adoption of CALLED_* test macros and standardization of *CallCount naming across the test base.
Description check	✅ Passed	The PR description comprehensively covers Purpose, Change Description, Test Evidence, and Areas Affected sections, matching the template requirements with detailed explanations of the refactoring scope and verification.
Linked Issues check	✅ Passed	The PR implements all requirements from issue #321: moves TestUtils.h to Tests/Support, defines three token-paste macros (CALLED_FUNCTION, CALLED_FAKE, CALLED_FAKE_ON) with *CallCount naming enforcement, renames all non-conforming counters, converts boolean flags to int counters, removes bespoke macros, and sweeps 23 test files across all test executables to use the new macros consistently.
Out of Scope Changes check	✅ Passed	All changes remain within scope: test-only refactoring across Tests/, Tests/Example/, Tests/FreeRtos/ and CMake configuration; no production code (Tier 1/2) touched; explicitly preserved exceptions (lastCount, spy.callCount) noted; move of TestUtils.h to Support directory is intentional to broaden test reachability.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch chore/s24-02-called-function-macro

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[github-actions]

☀️   Quality Summary

   🚦   build-linux-gcc: 100% successful (✔️ 1109 passed, 🙈 3 skipped)
   🚦   build-linux-clang: 100% successful (✔️ 1046 passed, 🙈 3 skipped)
   🚦   sanitize-linux-gcc: 100% successful (✔️ 1046 passed, 🙈 3 skipped)
   🚦   integration-linux-openssl: 100% successful (✔️ 9 passed)
   🚦   integration-windows-openssl: 100% successful (✔️ 9 passed)
   🚦   bdd-linux-syslog-ng: 94% successful (✔️ 46 passed, 🙈 3 skipped)
   🚦   bdd-windows-otel: 90% successful (✔️ 44 passed, 🙈 5 skipped)
   🚦   bdd-freertos-qemu: 49% successful (✔️ 24 passed, 🙈 25 skipped)
   🚦   build-windows-msvc: 100% successful (✔️ 958 passed, 🙈 1 skipped)
   ⚠️   Clang-Tidy: No warnings
   ⚠️   CPPCheck: No warnings

---

Created by Quality Monitor v1.14.0 (#f3859fd). More details are shown in the GitHub Checks Result.