Mock same-named headers by directory

[mkarlesky]

A test can name two same-named headers by directory, but it could not mock both. CMock and Unity's runner named a mock by filename alone, so the two mocks shared an include guard and lifecycle symbols. That affected traditional mocks and MOCK_PARTIAL_PUBLIC_MODULE_AT Partials alike.

ThrowTheSwitch/Unity#854 and ThrowTheSwitch/CMock#540 add :mock_name_include_folder to both tools. next_version already pins their merge commits (2eece702), so this PR changes no submodule. It enables the option and hands CMock the folder each mock's #include names. It also carries #1325's pending example, which now passes.

Behavior

The new :cmock ↳ :mock_name_include_folder setting defaults to true in Ceedling and is mirrored into :test_runner, like :mock_prefix and :mock_suffix. A mock included as drivers/uart/mock_config.h gets the guard and lifecycle functions drivers_uart_mock_config, and the runner calls those same names. A bare #include "mock_config.h", or one with a leading ./ only, keeps its current name.

The folder is the #include as written, not the mock's mirrored location, because the runner sees only the #include.

• Placement unchanged: when the folder ends the mirrored location. That holds for every Partial and for any #include that spells part of the real header's path.
• Placement moved: an #include spelling more path than the mirror holds places its mock below the per-test mock root at the written path, which the root search path still reaches.
• Option off: CMock receives no folder and names by filename alone.

The CMock configuration, with the new option, is part of each mock's cache meta, so toggling it regenerates mocks.

Changes

• MockDetails: gains include_path, the #include as the test wrote it (test_invoker_types.rb, test_build_planner.rb).
• TestBuildExecutor#mock_folder_and_path: derives CMock's folder and the mock's directory. stage_generate_mocks passes both to generate_mock.
• Generator#generate_mock(folder:): roots CMock above the folder and passes the folder to setup_mocks. Plugin hooks still receive the mock's own directory as :output_path.
• Default and mirroring: defaults.rb, and RUNNER_CMOCK_OPTIONS in configurator.rb.
• Module Generator: a comment for NAMING, after 99a87b94 removed the bumpy/camel swap that Unity#855 made unnecessary.
• PIPELINE.md: describes the naming and placement.

Tests

• Unit:
  • the folder rule: a bare #include, a folder that ends the mirror, a leading ./, a deeper written path, and the option off;
  • generate_mock roots CMock above the folder, passes the folder, and reports the mock's own directory to plugins;
  • mirroring into :test_runner;
  • MockDetails#include_path.
• System: the traditional same-named mock example (from Cover mocking two same-named headers in one test #1325) and the Partial one in partials_module_disambiguation_spec.rb now pass.
• Runs:
  • units (4724) and integration (480) pass on Apple Clang 15, and integration passes on GCC 14 in Docker;
  • system specs pass in Docker (GCC 14): same_named_modules, partials_module_disambiguation, header_include_path_validation, conditional_mock_includes, delta_builds, plugin_delta_builds, mocks_partials_configuration_validation.
• RuboCop: rake lint is clean across 503 files. The backlog is unchanged at 835 and lists no new file.

Changelog, Known Issues, Breaking Changes and mkdocs edits will follow as uncommitted diffs after CI.

🤖 Generated with Claude Code