ceedling 1.2.2 → 1.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (390) hide show
  1. checksums.yaml +4 -4
  2. data/GIT_COMMIT_SHA +1 -1
  3. data/README.md +1 -1
  4. data/assets/fixtures/tests_with_partials_coverage/src/private_macro.c +7 -0
  5. data/assets/fixtures/tests_with_partials_coverage/src/private_macro.h +5 -0
  6. data/assets/fixtures/tests_with_partials_coverage/src/tally.c +13 -0
  7. data/assets/fixtures/tests_with_partials_coverage/src/tally.h +4 -0
  8. data/assets/fixtures/tests_with_partials_coverage/test/test_private_macro.c +10 -0
  9. data/assets/fixtures/tests_with_partials_coverage/test/test_tally.c +9 -0
  10. data/docs/BreakingChanges.md +16 -0
  11. data/docs/Changelog.md +71 -0
  12. data/docs/KnownIssues.md +91 -4
  13. data/examples/wondrous_forest/README.md +29 -1
  14. data/examples/wondrous_forest/src/ForestUnits.h +23 -0
  15. data/examples/wondrous_forest/src/RainGauge.c +59 -0
  16. data/examples/wondrous_forest/src/RainGauge.h +39 -0
  17. data/examples/wondrous_forest/src/RainTipIsr.c +17 -0
  18. data/examples/wondrous_forest/src/RainTipIsr.h +14 -0
  19. data/examples/wondrous_forest/test/TestRainGauge.c +126 -0
  20. data/lib/ceedling/c_extractor/README.md +15 -7
  21. data/lib/ceedling/c_extractor/c_extractor.rb +25 -14
  22. data/lib/ceedling/c_extractor/c_extractor_code_text.rb +84 -54
  23. data/lib/ceedling/c_extractor/c_extractor_constants.rb +18 -7
  24. data/lib/ceedling/c_extractor/c_extractor_declarations.rb +319 -283
  25. data/lib/ceedling/c_extractor/c_extractor_declarator.rb +285 -0
  26. data/lib/ceedling/c_extractor/c_extractor_defined_type.rb +111 -0
  27. data/lib/ceedling/c_extractor/c_extractor_definitions.rb +174 -121
  28. data/lib/ceedling/c_extractor/c_extractor_functions.rb +191 -162
  29. data/lib/ceedling/c_extractor/c_extractor_preprocessing.rb +46 -55
  30. data/lib/ceedling/c_extractor/c_extractor_statement.rb +30 -0
  31. data/lib/ceedling/c_extractor/c_extractor_types.rb +63 -41
  32. data/lib/ceedling/c_extractor/c_module_edits.rb +48 -0
  33. data/lib/ceedling/c_identifier.rb +21 -0
  34. data/lib/ceedling/ceedling.h +8 -0
  35. data/lib/ceedling/config/configurator.rb +4 -3
  36. data/lib/ceedling/config/configurator_builder.rb +17 -0
  37. data/lib/ceedling/config/configurator_setup.rb +29 -5
  38. data/lib/ceedling/constants.rb +5 -1
  39. data/lib/ceedling/defaults.rb +31 -1
  40. data/lib/ceedling/dependencies/CACHE_SCHEMA.md +118 -0
  41. data/lib/ceedling/dependencies/README.md +1 -1
  42. data/lib/ceedling/dependencies/dependency_cache_store.rb +30 -25
  43. data/lib/ceedling/dependencies/dependency_tracker.rb +9 -3
  44. data/lib/ceedling/dependencies/dependinator.rb +13 -1
  45. data/lib/ceedling/diagnostics/DOCTOR.md +142 -0
  46. data/lib/ceedling/diagnostics/README.md +5 -0
  47. data/lib/ceedling/diagnostics/build_step_doctor.rb +110 -0
  48. data/lib/ceedling/diagnostics/duplicate_symbol_specialist.rb +108 -0
  49. data/lib/ceedling/diagnostics/guidance_phrases.rb +30 -0
  50. data/lib/ceedling/diagnostics/header_collision_guidance.rb +56 -0
  51. data/lib/ceedling/diagnostics/header_collision_specialist.rb +152 -0
  52. data/lib/ceedling/diagnostics/include_depth_specialist.rb +132 -0
  53. data/lib/ceedling/diagnostics/missing_symbol_specialist.rb +111 -0
  54. data/lib/ceedling/diagnostics/partial_name_specialist.rb +134 -0
  55. data/lib/ceedling/diagnostics/toolchain_output.rb +44 -0
  56. data/lib/ceedling/filesystem/PATH_HANDLING.md +83 -27
  57. data/lib/ceedling/filesystem/README.md +6 -1
  58. data/lib/ceedling/filesystem/build_roots.rb +105 -0
  59. data/lib/ceedling/filesystem/build_subpath.rb +110 -25
  60. data/lib/ceedling/filesystem/file_finder.rb +76 -110
  61. data/lib/ceedling/filesystem/file_finder_helper.rb +33 -11
  62. data/lib/ceedling/filesystem/file_path_utils.rb +113 -91
  63. data/lib/ceedling/filesystem/file_wrapper.rb +105 -28
  64. data/lib/ceedling/filesystem/path_matcher.rb +21 -0
  65. data/lib/ceedling/filesystem/test_build_layout.rb +114 -0
  66. data/lib/ceedling/filesystem/win_long_paths.rb +153 -0
  67. data/lib/ceedling/filesystem/win_path_limit.rb +83 -0
  68. data/lib/ceedling/filesystem/win_path_prober.rb +52 -0
  69. data/lib/ceedling/generators/generator.rb +27 -64
  70. data/lib/ceedling/generators/generator_helper.rb +0 -44
  71. data/lib/ceedling/generators/generator_mocks.rb +5 -0
  72. data/lib/ceedling/generators/generator_partials.rb +305 -243
  73. data/lib/ceedling/generators/generator_test_runner.rb +5 -8
  74. data/lib/ceedling/generators/partial_header_writer.rb +95 -0
  75. data/lib/ceedling/generators/partial_source_writer.rb +137 -0
  76. data/lib/ceedling/includes/header_search.rb +225 -0
  77. data/lib/ceedling/includes/include_factory.rb +9 -12
  78. data/lib/ceedling/includes/include_pathinator.rb +53 -31
  79. data/lib/ceedling/includes/includes.rb +149 -37
  80. data/lib/ceedling/objects.yml +89 -4
  81. data/lib/ceedling/partials/README.md +110 -16
  82. data/lib/ceedling/partials/carry_plan.rb +71 -0
  83. data/lib/ceedling/partials/definition_head.rb +74 -0
  84. data/lib/ceedling/partials/include_groups.rb +37 -0
  85. data/lib/ceedling/partials/interface_extras.rb +25 -0
  86. data/lib/ceedling/partials/partializer.rb +599 -120
  87. data/lib/ceedling/partials/partializer_config.rb +5 -0
  88. data/lib/ceedling/partials/partializer_helper.rb +851 -145
  89. data/lib/ceedling/partials/partializer_reconciler.rb +174 -0
  90. data/lib/ceedling/partials/partializer_utils.rb +89 -109
  91. data/lib/ceedling/partials/partials.rb +153 -10
  92. data/lib/ceedling/partials/type_macros.rb +126 -0
  93. data/lib/ceedling/preprocess/README.md +43 -33
  94. data/lib/ceedling/preprocess/preprocessinator.rb +100 -186
  95. data/lib/ceedling/preprocess/preprocessinator_code_finder.rb +65 -72
  96. data/lib/ceedling/preprocess/preprocessinator_file_assembler.rb +31 -75
  97. data/lib/ceedling/preprocess/preprocessinator_reconstructor.rb +51 -14
  98. data/lib/ceedling/setupinator.rb +16 -3
  99. data/lib/ceedling/test_invoker/HEADER_COLLISIONS.md +21 -7
  100. data/lib/ceedling/test_invoker/PIPELINE.md +57 -16
  101. data/lib/ceedling/test_invoker/README.md +1 -1
  102. data/lib/ceedling/test_invoker/derived_search_path_notices.rb +45 -0
  103. data/lib/ceedling/test_invoker/mock_locator.rb +116 -9
  104. data/lib/ceedling/test_invoker/partial_files_preprocessinator.rb +181 -0
  105. data/lib/ceedling/test_invoker/partials_manager.rb +265 -308
  106. data/lib/ceedling/test_invoker/standin_headerinator.rb +8 -15
  107. data/lib/ceedling/test_invoker/test_bare_includes_extractinator.rb +26 -3
  108. data/lib/ceedling/test_invoker/test_build_executor.rb +338 -198
  109. data/lib/ceedling/test_invoker/test_build_planner.rb +13 -19
  110. data/lib/ceedling/test_invoker/test_build_setup.rb +26 -6
  111. data/lib/ceedling/test_invoker/test_build_validations.rb +23 -20
  112. data/lib/ceedling/test_invoker/test_derived_search_paths.rb +189 -0
  113. data/lib/ceedling/test_invoker/test_file_preprocessinator.rb +1 -2
  114. data/lib/ceedling/test_invoker/test_includes_reconcilinator.rb +1 -1
  115. data/lib/ceedling/test_invoker/test_invoker_types.rb +28 -20
  116. data/lib/ceedling/test_invoker/test_pipeline_helpers.rb +5 -3
  117. data/lib/ceedling/test_invoker/test_pipeline_manager.rb +25 -8
  118. data/lib/ceedling/test_invoker/test_runner_generatinator.rb +31 -3
  119. data/lib/ceedling/test_invoker/test_search_paths.rb +30 -8
  120. data/lib/ceedling/test_invoker/test_substitutions.rb +72 -0
  121. data/lib/ceedling/tools/shell_quoting.rb +45 -0
  122. data/lib/ceedling/tools/tool_quoting.rb +79 -0
  123. data/lib/ceedling/{tool_validator.rb → tools/tool_validator.rb} +18 -7
  124. data/lib/version.rb +1 -1
  125. data/plugins/bullseye/bullseye.rake +1 -3
  126. data/plugins/bullseye/lib/bullseye.rb +15 -2
  127. data/plugins/command_hooks/lib/command_hooks.rb +1 -1
  128. data/plugins/fff/lib/fff.rb +42 -15
  129. data/plugins/fff/lib/fff_mock_generator.rb +12 -9
  130. data/plugins/fff/spec/fff_cmock_wrapper_spec.rb +134 -0
  131. data/plugins/fff/spec/fff_mock_header_generator_spec.rb +9 -0
  132. data/plugins/fff/spec/fff_mock_source_generator_spec.rb +20 -0
  133. data/plugins/gcov/lib/console_reportinator.rb +25 -19
  134. data/plugins/gcov/lib/reportgenerator_reportinator.rb +2 -1
  135. data/site-local/404.html +2 -2
  136. data/site-local/assets/javascripts/{bundle.c21346df.min.js → bundle.a5f9d56c.min.js} +1 -1
  137. data/site-local/assets/javascripts/{bundle.c21346df.min.js.map → bundle.a5f9d56c.min.js.map} +2 -2
  138. data/site-local/configuration/environment-vars.html +2 -2
  139. data/site-local/configuration/global-collections.html +3 -3
  140. data/site-local/configuration/index.html +2 -2
  141. data/site-local/configuration/loading.html +2 -2
  142. data/site-local/configuration/mixins.html +2 -2
  143. data/site-local/configuration/parallel-builds.html +2 -2
  144. data/site-local/configuration/project-file.html +2 -2
  145. data/site-local/configuration/reference/cexception.html +2 -2
  146. data/site-local/configuration/reference/cmock.html +5 -2
  147. data/site-local/configuration/reference/defines.html +2 -2
  148. data/site-local/configuration/reference/environment.html +2 -2
  149. data/site-local/configuration/reference/extension.html +2 -2
  150. data/site-local/configuration/reference/files.html +56 -9
  151. data/site-local/configuration/reference/flags.html +2 -2
  152. data/site-local/configuration/reference/index.html +2 -2
  153. data/site-local/configuration/reference/libraries.html +2 -2
  154. data/site-local/configuration/reference/mixins.html +2 -2
  155. data/site-local/configuration/reference/partials.html +84 -2
  156. data/site-local/configuration/reference/paths.html +7 -2
  157. data/site-local/configuration/reference/plugins.html +2 -2
  158. data/site-local/configuration/reference/project.html +247 -5
  159. data/site-local/configuration/reference/release-build.html +2 -2
  160. data/site-local/configuration/reference/test-build.html +2 -2
  161. data/site-local/configuration/reference/test-runner.html +2 -2
  162. data/site-local/configuration/reference/tools.html +49 -4
  163. data/site-local/configuration/reference/unity.html +2 -2
  164. data/site-local/configuration/which-ceedling.html +2 -2
  165. data/site-local/development/index.html +2 -2
  166. data/site-local/development/plugins/configuration.html +2 -2
  167. data/site-local/development/plugins/index.html +2 -2
  168. data/site-local/development/plugins/plugin-subclass.html +5 -4
  169. data/site-local/development/plugins/rake-tasks.html +2 -2
  170. data/site-local/development/releases.html +2 -2
  171. data/site-local/development/workflow.html +2 -2
  172. data/site-local/getting-started/builds.html +2 -2
  173. data/site-local/getting-started/command-line.html +2 -2
  174. data/site-local/getting-started/example-projects/cipher-quest.html +2 -2
  175. data/site-local/getting-started/example-projects/index.html +2 -2
  176. data/site-local/getting-started/example-projects/temp-sensor.html +2 -2
  177. data/site-local/getting-started/example-projects/wondrous-forest.html +10 -2
  178. data/site-local/getting-started/index.html +2 -2
  179. data/site-local/getting-started/installation.html +2 -2
  180. data/site-local/getting-started/quick-start.html +2 -2
  181. data/site-local/help.html +2 -2
  182. data/site-local/index.html +2 -2
  183. data/site-local/overview/build-system.html +2 -2
  184. data/site-local/overview/index.html +2 -2
  185. data/site-local/overview/test-environments.html +2 -2
  186. data/site-local/overview/tools-and-frameworks.html +2 -2
  187. data/site-local/plugins/beep.html +2 -2
  188. data/site-local/plugins/bullseye/index.html +45 -38
  189. data/site-local/plugins/bullseye/licensing.html +2 -2
  190. data/site-local/plugins/command-hooks.html +4 -4
  191. data/site-local/plugins/compile-commands-json-db.html +2 -2
  192. data/site-local/plugins/cppcheck.html +2 -2
  193. data/site-local/plugins/dependencies.html +2 -2
  194. data/site-local/plugins/fff.html +16 -2
  195. data/site-local/plugins/gcov/examples.html +2 -2
  196. data/site-local/plugins/gcov/gcovr.html +8 -2
  197. data/site-local/plugins/gcov/index.html +2 -2
  198. data/site-local/plugins/gcov/overview.html +2 -2
  199. data/site-local/plugins/gcov/reportgenerator.html +18 -14
  200. data/site-local/plugins/gcov/reporting.html +2 -2
  201. data/site-local/plugins/gcov/setup.html +2 -2
  202. data/site-local/plugins/gcov/tool-versions.html +2 -2
  203. data/site-local/plugins/gcov/troubleshooting.html +2 -2
  204. data/site-local/plugins/index.html +2 -2
  205. data/site-local/plugins/module-generator.html +2 -2
  206. data/site-local/plugins/report-build-warnings-log.html +2 -2
  207. data/site-local/plugins/report-tests-gtestlike-stdout.html +2 -2
  208. data/site-local/plugins/report-tests-ide-stdout.html +2 -2
  209. data/site-local/plugins/report-tests-log-factory.html +2 -2
  210. data/site-local/plugins/report-tests-pretty-stdout.html +2 -2
  211. data/site-local/plugins/report-tests-raw-output-log.html +2 -2
  212. data/site-local/plugins/report-tests-teamcity-stdout.html +2 -2
  213. data/site-local/plugins/sanitize.html +2 -2
  214. data/site-local/plugins/valgrind.html +2 -2
  215. data/site-local/project/index.html +2 -2
  216. data/site-local/project/release-history.html +2 -2
  217. data/site-local/project/sbom.html +2 -2
  218. data/site-local/project/upgrade.html +2 -2
  219. data/site-local/reference/build-directives.html +2 -2
  220. data/site-local/reference/command-line.html +2 -2
  221. data/site-local/reference/environment-vars.html +2 -2
  222. data/site-local/reference/gcov-plugin.html +2 -2
  223. data/site-local/reference/global-collections.html +12 -12
  224. data/site-local/reference/index.html +2 -2
  225. data/site-local/reference/partials-macros.html +47 -2
  226. data/site-local/reference/project-configuration.html +2 -2
  227. data/site-local/sitemap.xml.gz +0 -0
  228. data/site-local/snapshot/examples/cipher_quest/index.html +2 -2
  229. data/site-local/snapshot/examples/temp_sensor/index.html +2 -2
  230. data/site-local/snapshot/examples/wondrous_forest/index.html +72 -15
  231. data/site-local/testing-guide/build-directives.html +2 -2
  232. data/site-local/testing-guide/conventions.html +67 -22
  233. data/site-local/testing-guide/frameworks.html +2 -2
  234. data/site-local/testing-guide/index.html +2 -2
  235. data/site-local/testing-guide/partials/configuration.html +31 -4
  236. data/site-local/testing-guide/partials/conventions.html +509 -8
  237. data/site-local/testing-guide/partials/directives.html +4 -3
  238. data/site-local/testing-guide/partials/example.html +2 -2
  239. data/site-local/testing-guide/partials/index.html +2 -2
  240. data/site-local/testing-guide/partials/overview.html +30 -12
  241. data/site-local/testing-guide/partials/variables.html +169 -4
  242. data/site-local/testing-guide/test-cases.html +2 -2
  243. data/site-local/testing-guide/test-sample.html +2 -2
  244. data/site-local/testing-guide/test-suite-anatomy.html +2 -2
  245. data/spec/integration/build_step_doctor_spec.rb +270 -0
  246. data/spec/integration/c_extractor_composition_spec.rb +254 -4
  247. data/spec/integration/includes_extraction_spec.rb +27 -14
  248. data/spec/integration/nested_test_artifacts_spec.rb +1 -1
  249. data/spec/integration/partial_files_preprocessing_spec.rb +128 -0
  250. data/spec/integration/partials_carry_spec.rb +520 -0
  251. data/spec/integration/partials_declarations_spec.rb +655 -0
  252. data/spec/integration/partials_fallback_preprocessing_spec.rb +65 -0
  253. data/spec/integration/partials_function_pointers_spec.rb +277 -0
  254. data/spec/integration/partials_header_composition_spec.rb +268 -35
  255. data/spec/integration/partials_macro_decorators_spec.rb +267 -0
  256. data/spec/integration/partials_module_resolution_spec.rb +26 -19
  257. data/spec/integration/partials_symbol_linkage_spec.rb +13 -0
  258. data/spec/integration/path_length_reporting_spec.rb +64 -0
  259. data/spec/integration/path_scenarios_spec.rb +80 -3
  260. data/spec/integration/quote_include_isolator_spec.rb +56 -0
  261. data/spec/integration/test_build_parallel_barrier_spec.rb +1 -1
  262. data/spec/integration/test_includes_extractinator_spec.rb +70 -5
  263. data/spec/integration/test_naming_spec.rb +6 -3
  264. data/spec/integration/test_source_file_checks_spec.rb +5 -3
  265. data/spec/integration/tool_executor_spec.rb +1 -1
  266. data/spec/integration/tool_validator_spec.rb +2 -2
  267. data/spec/integration/win_long_paths_probe_spec.rb +46 -0
  268. data/spec/integration/win_path_limit_spec.rb +53 -0
  269. data/spec/integration/windows_registry_query_tool_spec.rb +41 -0
  270. data/spec/support/integration/configurator_integration_helper.rb +8 -3
  271. data/spec/support/integration/partial_files_harness.rb +181 -0
  272. data/spec/support/integration/partials_generation_integration_helper.rb +237 -141
  273. data/spec/support/integration/path_scenario_harness.rb +4 -2
  274. data/spec/support/integration/spec_integration_helper.rb +8 -3
  275. data/spec/support/integration/test_includes_harness.rb +56 -35
  276. data/spec/support/integration/tool_executor_integration_helper.rb +14 -2
  277. data/spec/system/bullseye_deployment_spec.rb +2 -0
  278. data/spec/system/delta_builds_spec.rb +26 -12
  279. data/spec/system/encoding_stress_spec.rb +4 -4
  280. data/spec/system/example_wondrous_forest_spec.rb +2 -2
  281. data/spec/system/gcov_deployment_spec.rb +2 -0
  282. data/spec/system/header_include_path_validation_spec.rb +4 -4
  283. data/spec/system/header_search_paths_spec.rb +1083 -0
  284. data/spec/system/mock_include_folders_spec.rb +121 -0
  285. data/spec/system/mockable_header_reassembly_spec.rb +184 -0
  286. data/spec/system/partials_carry_spec.rb +581 -0
  287. data/spec/system/partials_delta_builds_spec.rb +280 -0
  288. data/spec/system/partials_function_pointers_spec.rb +106 -0
  289. data/spec/system/partials_macro_decorators_spec.rb +127 -0
  290. data/spec/system/partials_module_disambiguation_spec.rb +125 -0
  291. data/spec/system/path_handling_probes_spec.rb +16 -12
  292. data/spec/system/pinned_thread_count_spec.rb +4 -4
  293. data/spec/system/preprocessing_fallback_conditionals_spec.rb +1 -1
  294. data/spec/system/short_build_paths_spec.rb +87 -0
  295. data/spec/system/sibling_header_collision_spec.rb +30 -6
  296. data/spec/system/support/bullseye_common_test_cases.rb +42 -0
  297. data/spec/system/support/common_test_cases.rb +2 -2
  298. data/spec/system/support/gcov_partials_test_cases.rb +48 -0
  299. data/spec/system/test_build_layout_spec.rb +209 -0
  300. data/spec/system/test_source_file_directive_spec.rb +35 -5
  301. data/spec/units/c_extractor/c_extractor_code_text_spec.rb +67 -10
  302. data/spec/units/c_extractor/c_extractor_declarations_spec.rb +501 -4
  303. data/spec/units/c_extractor/c_extractor_declarator_spec.rb +245 -0
  304. data/spec/units/c_extractor/c_extractor_defined_type_spec.rb +45 -0
  305. data/spec/units/c_extractor/c_extractor_definitions_spec.rb +163 -3
  306. data/spec/units/c_extractor/c_extractor_functions_spec.rb +462 -21
  307. data/spec/units/c_extractor/c_extractor_preprocessing_spec.rb +39 -0
  308. data/spec/units/c_extractor/c_extractor_spec.rb +4 -4
  309. data/spec/units/c_extractor/c_extractor_types_spec.rb +163 -0
  310. data/spec/units/c_identifier_spec.rb +35 -0
  311. data/spec/units/config/configurator_builder_spec.rb +24 -0
  312. data/spec/units/config/configurator_setup_spec.rb +72 -4
  313. data/spec/units/config/configurator_spec.rb +27 -1
  314. data/spec/units/dependencies/dependency_cache_store_spec.rb +68 -3
  315. data/spec/units/dependencies/dependency_tracker_spec.rb +25 -0
  316. data/spec/units/dependencies/dependinator_spec.rb +17 -2
  317. data/spec/units/diagnostics/build_step_doctor_spec.rb +170 -0
  318. data/spec/units/diagnostics/duplicate_symbol_specialist_spec.rb +117 -0
  319. data/spec/units/diagnostics/header_collision_specialist_spec.rb +267 -0
  320. data/spec/units/diagnostics/include_depth_specialist_spec.rb +137 -0
  321. data/spec/units/diagnostics/missing_symbol_specialist_spec.rb +154 -0
  322. data/spec/units/diagnostics/partial_name_specialist_spec.rb +129 -0
  323. data/spec/units/diagnostics/toolchain_output_spec.rb +86 -0
  324. data/spec/units/encodinator_spec.rb +3 -4
  325. data/spec/units/filesystem/build_roots_spec.rb +131 -0
  326. data/spec/units/filesystem/build_subpath_spec.rb +113 -0
  327. data/spec/units/filesystem/file_finder_helper_spec.rb +80 -0
  328. data/spec/units/filesystem/file_finder_spec.rb +242 -58
  329. data/spec/units/filesystem/file_path_utils_spec.rb +251 -118
  330. data/spec/units/filesystem/file_wrapper_spec.rb +191 -6
  331. data/spec/units/filesystem/path_matcher_spec.rb +36 -0
  332. data/spec/units/filesystem/test_build_layout_spec.rb +216 -0
  333. data/spec/units/filesystem/win_long_paths_spec.rb +204 -0
  334. data/spec/units/filesystem/win_path_prober_spec.rb +158 -0
  335. data/spec/units/generators/generator_helper_spec.rb +0 -60
  336. data/spec/units/generators/generator_mocks_spec.rb +13 -0
  337. data/spec/units/generators/generator_partials_spec.rb +656 -55
  338. data/spec/units/generators/generator_spec.rb +26 -0
  339. data/spec/units/generators/generator_test_runner_spec.rb +9 -5
  340. data/spec/units/generators/partial_source_writer_spec.rb +129 -0
  341. data/spec/units/includes/header_search_spec.rb +406 -0
  342. data/spec/units/includes/include_factory_spec.rb +22 -5
  343. data/spec/units/includes/include_pathinator_spec.rb +77 -13
  344. data/spec/units/includes/include_spec.rb +14 -0
  345. data/spec/units/includes/includes_spec.rb +176 -19
  346. data/spec/units/loginator_spec.rb +31 -0
  347. data/spec/units/mock_locator_spec.rb +199 -5
  348. data/spec/units/partials/include_groups_spec.rb +42 -0
  349. data/spec/units/partials/partializer_config_spec.rb +25 -0
  350. data/spec/units/partials/partializer_helper_carry_spec.rb +661 -0
  351. data/spec/units/partials/partializer_helper_interface_extras_spec.rb +396 -0
  352. data/spec/units/partials/partializer_helper_spec.rb +529 -277
  353. data/spec/units/partials/partializer_reconciler_spec.rb +661 -0
  354. data/spec/units/partials/partializer_spec.rb +1578 -270
  355. data/spec/units/partials/partializer_utils_spec.rb +269 -232
  356. data/spec/units/partials/partials_rename_spec.rb +160 -0
  357. data/spec/units/partials_manager_spec.rb +554 -261
  358. data/spec/units/plugins/bullseye_spec.rb +34 -0
  359. data/spec/units/plugins/console_reportinator_spec.rb +58 -9
  360. data/spec/units/plugins/report_tests_teamcity_stdout_spec.rb +1 -1
  361. data/spec/units/plugins/reportgenerator_reportinator_spec.rb +51 -3
  362. data/spec/units/preprocess/preprocessinator_code_finder_spec.rb +73 -10
  363. data/spec/units/preprocess/preprocessinator_file_assembler_spec.rb +125 -37
  364. data/spec/units/preprocess/preprocessinator_includes_handler_spec.rb +15 -0
  365. data/spec/units/preprocess/preprocessinator_reconstructor_spec.rb +197 -0
  366. data/spec/units/preprocess/preprocessinator_spec.rb +153 -95
  367. data/spec/units/setupinator_spec.rb +51 -0
  368. data/spec/units/standin_headerinator_spec.rb +27 -11
  369. data/spec/units/test_build_executor_spec.rb +780 -166
  370. data/spec/units/test_build_planner_spec.rb +116 -28
  371. data/spec/units/test_build_setup_spec.rb +83 -18
  372. data/spec/units/test_context_extractor_spec.rb +11 -2
  373. data/spec/units/test_derived_search_paths_spec.rb +259 -0
  374. data/spec/units/test_includes_extractinator_spec.rb +56 -8
  375. data/spec/units/test_invoker/objects_wiring_spec.rb +20 -3
  376. data/spec/units/test_invoker/partial_files_preprocessinator_spec.rb +264 -0
  377. data/spec/units/test_invoker/test_substitutions_spec.rb +122 -0
  378. data/spec/units/test_invoker_types_spec.rb +8 -7
  379. data/spec/units/test_pipeline_manager_spec.rb +54 -13
  380. data/spec/units/test_runner_generatinator_spec.rb +93 -1
  381. data/spec/units/test_search_paths_spec.rb +73 -5
  382. data/spec/units/{default_tools_quoting_spec.rb → tools/default_tools_quoting_spec.rb} +39 -5
  383. data/spec/units/tools/shell_quoting_spec.rb +76 -0
  384. data/spec/units/{tool_executor_helper_spec.rb → tools/tool_executor_helper_spec.rb} +1 -1
  385. data/spec/units/{tool_executor_spec.rb → tools/tool_executor_spec.rb} +1 -1
  386. data/spec/units/{tool_validator_spec.rb → tools/tool_validator_spec.rb} +110 -1
  387. data/spec/units/windows_registry_query_tool_spec.rb +53 -0
  388. metadata +161 -16
  389. /data/lib/ceedling/{tool_executor.rb → tools/tool_executor.rb} +0 -0
  390. /data/lib/ceedling/{tool_executor_helper.rb → tools/tool_executor_helper.rb} +0 -0
@@ -49,9 +49,9 @@ class TestBuildPlanner
49
49
  mocks = {}
50
50
  _mocks = @context_extractor.lookup_mock_header_includes_list( filepath )
51
51
 
52
- # Built at the first real mock and shared by the rest, since nothing here changes
53
- # this test's search paths
54
- collection = nil
52
+ # Shared by every mock and the #include validation, since nothing here changes this
53
+ # test's search paths
54
+ collection = test_header_search( testable )
55
55
 
56
56
  _mocks.each do |include|
57
57
  name = File.basename( include.filename ).ext()
@@ -65,7 +65,6 @@ class TestBuildPlanner
65
65
  input = source
66
66
  subdir = partial_mock_subdir( include )
67
67
  else
68
- collection ||= ordered_mock_header_collection( testable )
69
68
  source, subdir = @mock_locator.locate( include, collection: collection )
70
69
  preprocessed_input = @file_path_utils.form_preprocessed_file_filepath( source, test )
71
70
  input = (@configurator.project_use_test_preprocessor_mocks ? preprocessed_input : source)
@@ -89,11 +88,12 @@ class TestBuildPlanner
89
88
  source: source,
90
89
  input: input,
91
90
  partial: partial,
92
- include_path: include.filepath
91
+ include_path: include.filepath,
92
+ header_include: @mock_locator.header_respelling( include, source, collection )
93
93
  )
94
94
  end
95
95
 
96
- validate_header_includes( test_filepath: filepath, testable: testable )
96
+ validate_header_includes( test_filepath: filepath, testable: testable, search: collection )
97
97
 
98
98
  partials_configs = {}
99
99
  if @configurator.project_use_partials
@@ -120,17 +120,8 @@ class TestBuildPlanner
120
120
  def stage_flatten_partials_lists(state)
121
121
  state.testables.each do |_, testable|
122
122
  testable.partials.configs.each do |_, config|
123
- state.partials_headers << PartialWork.new(
124
- config: config.header,
125
- testable: testable,
126
- directives_only_filepath: nil
127
- ) if config.header.filepath
128
-
129
- state.partials_sources << PartialWork.new(
130
- config: config.source,
131
- testable: testable,
132
- directives_only_filepath: nil
133
- ) if config.source.filepath
123
+ state.partials_headers << PartialWork.new( config: config.header, testable: testable ) if config.header.filepath
124
+ state.partials_sources << PartialWork.new( config: config.source, testable: testable ) if config.source.filepath
134
125
  end
135
126
  end
136
127
  end
@@ -330,8 +321,8 @@ class TestBuildPlanner
330
321
 
331
322
  # Every stage resolving a mock's real header must agree on the same winner, or a
332
323
  # stand-in, a mock search path, and the real mock would land in different directories
333
- def ordered_mock_header_collection(testable)
334
- @mock_locator.header_collection( testable.search_paths, testable.mock_search_paths )
324
+ def test_header_search(testable)
325
+ @mock_locator.header_search( testable )
335
326
  end
336
327
 
337
328
  # The mock's directory below its test's mock root, where generation writes it. Two
@@ -390,6 +381,9 @@ class TestBuildPlanner
390
381
  return dir == '.' ? '' : dir
391
382
  end
392
383
 
384
+ # A source leaves the link when a mock of its .h header stands in for it. A mock of a header
385
+ # with another extension, such as foox.hpp, leaves foox.c in place, since a .h header of the
386
+ # same stem may be the one that source implements.
393
387
  def remove_mock_original_headers(filelist, mocklist)
394
388
  filelist.delete_if do |filepath|
395
389
  mocklist.include?( @configurator.cmock_mock_prefix + File.basename( filepath ).ext( EXTENSION_CORE_HEADER ) )
@@ -36,6 +36,7 @@ class TestBuildSetup
36
36
  :dependinator,
37
37
  :test_search_paths,
38
38
  :mock_locator,
39
+ :test_derived_search_paths,
39
40
  :test_source_file_directive_resolver
40
41
  )
41
42
 
@@ -110,6 +111,7 @@ class TestBuildSetup
110
111
  # cache instead of being scanned again when nothing about the file itself has changed.
111
112
  def stage_collect_test_context(state)
112
113
  skipped = 0
114
+ @test_derived_search_paths.forget_notices
113
115
 
114
116
  @batchinator.exec(workload: :compile, things: state.testables) do |_, testable|
115
117
  filepath = testable.filepath
@@ -183,6 +185,14 @@ class TestBuildSetup
183
185
  includes: @context_extractor.lookup_all_header_includes_list( filepath )
184
186
  )
185
187
 
188
+ # Mock search paths are found through the derived ones
189
+ derived, refusals = @test_derived_search_paths.collect( testable )
190
+ state.lock.synchronize do
191
+ testable.derived_search_paths = derived
192
+ testable.search_path_refusals = refusals
193
+ end
194
+
195
+ one_mock_per_header( testable )
186
196
  testable.mock_search_paths = collect_mock_search_paths( testable )
187
197
  end
188
198
 
@@ -199,7 +209,7 @@ class TestBuildSetup
199
209
  @batchinator.exec(workload: :compile, things: state.testables) do |_, testable|
200
210
  filepath = testable.filepath
201
211
 
202
- srch_paths = @test_search_paths.compose( filepath, testable.paths, testable.mock_search_paths )
212
+ srch_paths = @test_search_paths.compose( testable )
203
213
  cmp_flags = flags( context: state.context, operation: OPERATION_COMPILE_SYM, filepath: filepath )
204
214
  pre_flags = preprocess_flags( context: state.context, compile_flags: cmp_flags, filepath: filepath )
205
215
  asm_flags = flags( context: state.context, operation: OPERATION_ASSEMBLE_SYM, filepath: filepath )
@@ -236,6 +246,20 @@ class TestBuildSetup
236
246
  @include_pathinator.augment_environment_header_files( headers )
237
247
  end
238
248
 
249
+ # A test that names one header's mock two ways keeps one of them, which the planner, the
250
+ # runner and the rebuilt test file all read (MockLocator#one_per_header). The lookup
251
+ # needs the test's derived search paths, so it follows them.
252
+ def one_mock_per_header(testable)
253
+ return unless testable.paths[:mocks]
254
+
255
+ filepath = testable.filepath
256
+ headers = @context_extractor.lookup_all_header_includes_list( filepath )
257
+ distinct = @mock_locator.one_per_header( headers, collection: @mock_locator.header_search( testable ) )
258
+ return if distinct.length == headers.length
259
+
260
+ @context_extractor.ingest_includes( filepath, distinct + @context_extractor.lookup_source_includes_list( filepath ) )
261
+ end
262
+
239
263
  # Every mocked header's own mirrored directory below this test's mock root -- a mock is
240
264
  # only ever findable by the compiler via a search path pointing directly at wherever it
241
265
  # actually lives, since C's own #include resolution has no notion of a recursive search
@@ -252,13 +276,9 @@ class TestBuildSetup
252
276
 
253
277
  complain = @configurator.project_use_test_preprocessor_tests ? :silent : :error
254
278
 
255
- # This test's search paths don't exist until stage 3, so they are composed here
256
- # without mock directories, the same collection later stages resolve against
257
- collection = @mock_locator.header_collection( @test_search_paths.compose( testable.filepath, testable.paths ) )
258
-
259
279
  return @mock_locator.directories(
260
280
  @context_extractor.lookup_mock_header_includes_list( testable.filepath ),
261
- mocks_root: testable.paths[:mocks], collection: collection, complain: complain
281
+ mocks_root: testable.paths[:mocks], collection: @mock_locator.header_search( testable ), complain: complain
262
282
  )
263
283
  end
264
284
 
@@ -57,31 +57,34 @@ module TestBuildValidations
57
57
  end
58
58
  end
59
59
 
60
- # Every #include naming a real project header -- other than a mock (validated separately,
61
- # as part of resolving it via FileFinder#resolve_mock), a system header, Unity's or
62
- # Ceedling's own header, or a Partial (Ceedling's own generated content, not a project file
63
- # to validate) -- must resolve to exactly one file, existence-wise, among this test's own
64
- # search_paths (the same directory priority the compiler itself consults): ambiguity among
65
- # same-named candidates resolves quietly to the first by that order, exactly as the real
66
- # compile would find it; only a genuinely unresolvable name still halts the build here. A
67
- # bogus or merely-unmatched path is otherwise never actually checked against real project
68
- # headers -- only its potential corresponding source file is, tolerantly, elsewhere. Unity's
69
- # and Ceedling's own headers live in the build's vendor directories, outside every configured
70
- # :test/:source/:support/:include root a test's search_paths is built from, so neither could
71
- # ever resolve there.
72
- def validate_header_includes(test_filepath:, testable:)
60
+ # Every #include of a project header must resolve through this test's search paths, as
61
+ # the compiler resolves it. Same-named candidates resolve to the first in search order,
62
+ # and only an unresolvable name halts the build here. Mocks are checked as they resolve
63
+ # (FileFinder#resolve_mock). System headers, Unity's and Ceedling's own headers, and
64
+ # Partials are Ceedling's or the toolchain's, so none is checked.
65
+ #
66
+ # `search` is the test's HeaderSearch when the caller already holds one.
67
+ def validate_header_includes(test_filepath:, testable:, search: nil)
73
68
  includes = @context_extractor.lookup_nonmock_header_includes_list( test_filepath )
74
69
 
75
- collection = @include_pathinator.ordered_header_files( testable.search_paths )
76
-
77
- includes.each do |include|
78
- next if include.is_a?( SystemInclude )
79
- next if include.filename == UNITY_H_FILE
80
- next if include.filename == CEEDLING_HEADER_FILENAME
81
- next if include.filename.start_with?( PARTIAL_FILENAME_PREFIX )
70
+ collection = search || @mock_locator.header_search( testable )
82
71
 
72
+ header_includes_to_check( includes ).each do |include|
83
73
  @file_finder.find_header_file( include.filepath, :error, collection: collection )
84
74
  end
85
75
  end
86
76
 
77
+ private
78
+
79
+ # The #includes naming a project header: no system header, Unity's or Ceedling's own
80
+ # header, or a Partial
81
+ def header_includes_to_check(includes)
82
+ return includes.reject do |include|
83
+ include.is_a?( SystemInclude ) or
84
+ include.filename == UNITY_H_FILE or
85
+ include.filename == CEEDLING_HEADER_FILENAME or
86
+ include.filename.start_with?( PARTIAL_FILENAME_PREFIX )
87
+ end
88
+ end
89
+
87
90
  end
@@ -0,0 +1,189 @@
1
+ # =========================================================================
2
+ # Ceedling - Test-Centered Build System for C
3
+ # ThrowTheSwitch.org
4
+ # Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
5
+ # SPDX-License-Identifier: MIT
6
+ # =========================================================================
7
+
8
+ require 'ceedling/constants'
9
+ require 'ceedling/includes/includes'
10
+ require 'ceedling/includes/header_search'
11
+ require 'ceedling/filesystem/path_matcher'
12
+ require 'ceedling/filesystem/project_paths'
13
+ require 'ceedling/test_invoker/test_pipeline_helpers'
14
+ require 'ceedling/test_invoker/derived_search_path_notices'
15
+
16
+ # The search paths a test's #includes imply for headers whose own directories no search
17
+ # path lists.
18
+ #
19
+ # A header that only :files ↳ :include supplies usually sits in no search path's
20
+ # directory, so the compiler can't reach it through the #include as written. The directory that #include
21
+ # implies is the header's path with the #include's own path taken off its end. Joined with
22
+ # that directory, the #include names the header, so a test whose #include reaches nothing
23
+ # else gets the directory as a search path, after every configured path. Nothing
24
+ # configured is shadowed.
25
+ #
26
+ # A bare name gives the header's own directory. Outside the working directory that can be
27
+ # a system directory of forwarding headers, such as glibc's sys/, where one header includes
28
+ # another by a name the directory itself holds. No directory is added for a bare name
29
+ # there. The refusal explains the error the header's failed lookup raises.
30
+ class TestDerivedSearchPaths
31
+
32
+ include TestPipelineHelpers
33
+
34
+ # The option that names a mock's header by its folder
35
+ FOLDER_OPTION = ':cmock ↳ :mock_name_include_folder'
36
+
37
+ constructor :configurator, :include_pathinator, :test_search_paths, :test_context_extractor, :file_finder, :file_wrapper, :loginator
38
+
39
+ def setup
40
+ @notices = DerivedSearchPathNotices.new( loginator: @loginator )
41
+ end
42
+
43
+ # Starts a test build, whose NOTICEs name each directory once
44
+ def forget_notices
45
+ @notices.forget
46
+ end
47
+
48
+ # The directories `testable`'s #includes imply, in the order its #includes need them, and
49
+ # the refusals for headers outside the working directory, by the query each #include asks
50
+ # for. One search serves every #include until a directory joins it.
51
+ def collect(testable)
52
+ configured = @test_search_paths.header_paths( testable )
53
+ search = @include_pathinator.header_search( configured )
54
+
55
+ return candidate_includes( testable ).each_with_object( [[], {}] ) do |include, (roots, refusals)|
56
+ root = derived_root( testable, include, search, refusals )
57
+ next if root.nil?
58
+
59
+ roots << root
60
+ search = @include_pathinator.header_search( configured + roots )
61
+ end
62
+ end
63
+
64
+ private
65
+
66
+ # The test's quoted #includes of project headers it could name by a path below a search
67
+ # path
68
+ def candidate_includes(testable)
69
+ return @test_context_extractor.lookup_all_header_includes_list( testable.filepath ).reject do |include|
70
+ include.is_a?( SystemInclude ) or generated?( include ) or placed?( include )
71
+ end
72
+ end
73
+
74
+ # Unity's, Ceedling's or a Partial's header, or a Partial mock
75
+ def generated?(include)
76
+ return true if [UNITY_H_FILE, CEEDLING_HEADER_FILENAME].include?( include.filename )
77
+
78
+ return (include.filename.start_with?( PARTIAL_FILENAME_PREFIX ) or mock_partial?( include ))
79
+ end
80
+
81
+ # A path the compiler resolves without a search path: one that climbs or is absolute
82
+ def placed?(include)
83
+ return true if include.directory_relative? or PathMatcher.absolute?( include.filepath )
84
+
85
+ return ProjectPaths.segments( include.filepath ).include?( '..' )
86
+ end
87
+
88
+ # The directory `include` implies for its header, or nil when it needs none or is refused
89
+ # one. A refusal joins `refusals`.
90
+ def derived_root(testable, include, search, refusals)
91
+ query, text = query_and_text( include )
92
+ return nil if reaches?( testable, include, text, search )
93
+
94
+ header = unlisted_header( query, search )
95
+ return nil if header.nil?
96
+ return refuse( refusals, include, query, refusal( testable, include, text, header ) ) if bare_outside_project?( text, header )
97
+
98
+ root = PathMatcher.strip_tail( header, text )
99
+ @notices.added( testable, root, text, header ) unless root.nil?
100
+ return root
101
+ end
102
+
103
+ # Records why the header `query` names gets no directory, which adds none, under every
104
+ # name its failed lookup can report. Every stage looks a test's mocks up before its other
105
+ # #includes, so a mock's refusal explains a name they share.
106
+ def refuse(refusals, include, query, why)
107
+ mock = include.is_a?( MockInclude )
108
+
109
+ lookup_names( include, query ).each do |name|
110
+ refusals[name] = why if mock or !refusals.key?( name )
111
+ end
112
+
113
+ return nil
114
+ end
115
+
116
+ # The names a lookup of `query` reports, as the header search spells them. A mock's header
117
+ # is looked up by its query. Another #include's is looked up by each header extension in
118
+ # turn, and the last names the failure.
119
+ def lookup_names(include, query)
120
+ names = include.is_a?( MockInclude ) ? [query] : [query] + @configurator.extension_header.candidates( query )
121
+ return names.map { |name| HeaderSearch.normalized( name ) }.uniq
122
+ end
123
+
124
+ # Why a bare name's header outside the working directory gets no search path, and the
125
+ # #include that reaches it instead. Without :mock_name_include_folder a mock includes its
126
+ # header by `text` alone, whatever folder its own #include writes.
127
+ def refusal(testable, include, text, header)
128
+ written = include.filepath
129
+ suggested = "`#include \"#{File.join( File.basename( File.dirname( header ) ), File.basename( written ) )}\"`"
130
+ needs = "`#include \"#{written}\"` in #{testable.filepath} needs search path '#{ProjectPaths.absolute( File.dirname( header ) )}'"
131
+ reason = 'Because this search path is outside the working directory and could cause shadowing of other headers, ' \
132
+ "Ceedling won't add the full search path."
133
+
134
+ unless include.is_a?( MockInclude ) and !@configurator.cmock_mock_name_include_folder
135
+ return "#{needs}. #{reason} Instead, reference the parent folder, as in #{suggested}."
136
+ end
137
+
138
+ return "#{needs}, since its mock writes `#include \"#{text}\"` with #{FOLDER_OPTION} disabled. #{reason} " \
139
+ "Instead, enable #{FOLDER_OPTION} and reference the parent folder, as in #{suggested}."
140
+ end
141
+
142
+ # The header `query` names, when no search path lists its directory and Ceedling didn't
143
+ # generate it
144
+ def unlisted_header(query, search)
145
+ header = search.header_candidates( query ).first || @include_pathinator.collection_candidates( query, search.paths ).first
146
+ return nil if header.nil? or listed?( header, search ) or below_build_root?( header )
147
+
148
+ return header
149
+ end
150
+
151
+ # A bare name's header outside the working directory may sit among forwarding headers
152
+ def bare_outside_project?(text, header)
153
+ return (File.dirname( text ) == '.' and !ProjectPaths.contains?( ProjectPaths.working_dir, header ))
154
+ end
155
+
156
+ # The header a mock's #include asks for, and the text the compiled #include names. A
157
+ # mock names its header by the folder its #include writes, or by filename alone without
158
+ # :mock_name_include_folder.
159
+ def query_and_text(include)
160
+ return [include.filepath, include.filepath] unless include.is_a?( MockInclude )
161
+
162
+ query = @file_finder.mock_header_query( include.filepath )
163
+ text = @configurator.cmock_mock_name_include_folder ? query : File.basename( query )
164
+ return [query, text]
165
+ end
166
+
167
+ # Whether the compiled #include already finds a header: joined with a search path as the
168
+ # compiler joins it, or for the test's own #include, through the test file's directory,
169
+ # as a quoted #include does
170
+ def reaches?(testable, include, text, search)
171
+ return true if search.joins?( text )
172
+ return false if include.is_a?( MockInclude )
173
+
174
+ return @file_wrapper.exist?( File.join( File.dirname( testable.filepath ), text ) )
175
+ end
176
+
177
+ # Whether a search path lists the header's own directory, so the #include as written is
178
+ # one the compiler rejects, and no directory is added for it
179
+ def listed?(header, search)
180
+ dir = File.dirname( header )
181
+ return search.paths.any? { |path| ProjectPaths.subdir_below( path, dir ) == '' }
182
+ end
183
+
184
+ # Ceedling's own vendor and generated headers
185
+ def below_build_root?(header)
186
+ return ProjectPaths.contains?( @configurator.project_build_root, header )
187
+ end
188
+
189
+ end
@@ -88,8 +88,7 @@ class TestFilePreprocessinator
88
88
  return @preprocessinator.preprocess_test_file(
89
89
  test: testable.name, filepath: testable.filepath, directives_only_filepath: directives_only_filepath( testable ),
90
90
  fallback: fallback?( testable ), includes: @context_extractor.lookup_all_header_includes_list( testable.filepath ),
91
- flags: testable.preprocess_flags, include_paths: testable.search_paths, vendor_paths: vendor_search_paths(),
92
- defines: testable.preprocess_defines
91
+ flags: testable.preprocess_flags, include_paths: testable.search_paths, defines: testable.preprocess_defines
93
92
  )
94
93
  end
95
94
 
@@ -140,7 +140,7 @@ class TestIncludesReconcilinator
140
140
  mock_dirs = @mock_locator.directories(
141
141
  @context_extractor.lookup_mock_header_includes_list( testable.filepath ),
142
142
  mocks_root: testable.paths[:mocks],
143
- collection: @mock_locator.header_collection( testable.search_paths, testable.mock_search_paths ),
143
+ collection: @mock_locator.header_search( testable ),
144
144
  complain: :silent
145
145
  )
146
146
  @test_search_paths.assign_mock_search_paths( testable, mock_dirs, state.lock )
@@ -16,8 +16,8 @@ module TestInvokerTypes
16
16
  :testables, # Hash<Symbol, Testable> — accumulated across all stages
17
17
  :context,
18
18
  :options, # Array<Symbol> — pipeline-control flags (see TestPipelineManager)
19
- :partials_headers, # Array<PartialWork> — produced by T1; consumed by stages 6 & 7
20
- :partials_sources, # Array<PartialWork> — produced by T1; consumed by stages 6 & 7
19
+ :partials_headers, # Array<PartialWork> — produced by T1; consumed by stage 6
20
+ :partials_sources, # Array<PartialWork> — produced by T1; consumed by stage 7
21
21
  :mocks_list, # Array<MockWork> — produced by T2; consumed by stages 9 & 10
22
22
  :objects_list, # Array<ObjectWork> — produced by T3; consumed by stage 15
23
23
  :lock, # Mutex for thread-safe testable writes
@@ -36,20 +36,21 @@ module TestInvokerTypes
36
36
  # depending on whether mock preprocessing is enabled), and whether this
37
37
  # mock is Ceedling's own generated Partial content rather than a mock of a
38
38
  # real header (`partial`). `include_path` is the #include as the test wrote
39
- # it. It names the mock for CMock and the runner alike.
40
- MockDetails = Struct.new(:name, :filepath, :path, :source, :input, :partial, :include_path, keyword_init: true) unless const_defined?(:MockDetails, false)
39
+ # it. It names the mock for CMock and the runner alike. `header_include` is the
40
+ # respelling of CMock's text for the mock's real header
41
+ # (MockLocator#header_respelling), or nil where CMock's text stays. An FFF fake
42
+ # includes the header by it, and CMock does where its format takes it.
43
+ MockDetails = Struct.new(:name, :filepath, :path, :source, :input, :partial, :include_path, :header_include, keyword_init: true) unless const_defined?(:MockDetails, false)
41
44
 
42
45
  # A test's generated Unity runner: the C file to be compiled (`output_filepath`)
43
46
  # and the (possibly preprocessed) test file it was generated from (`input_filepath`).
44
- RunnerInfo = Struct.new(:output_filepath, :input_filepath, keyword_init: true) unless const_defined?(:RunnerInfo, false)
47
+ # `includes` are the runner's #includes, spelled the first time stage 12 or 13 asks
48
+ RunnerInfo = Struct.new(:output_filepath, :input_filepath, :includes, keyword_init: true) unless const_defined?(:RunnerInfo, false)
45
49
 
46
- # One partial header or source file's own preprocessing work, flattened out of its
47
- # owning testable for parallel processing (T1). `preprocessed_target` and `stale` are
48
- # unset until the corresponding stage settles this target's staleness.
49
- PartialWork = Struct.new(
50
- :config, :testable, :directives_only_filepath, :preprocessed_target, :stale,
51
- keyword_init: true
52
- ) unless const_defined?(:PartialWork, false)
50
+ # One Partial header or source file to preprocess, flattened out of its owning testable
51
+ # for parallel processing (T1). `config` is the file's Partials::ConfigFileInfo, which
52
+ # preprocessing fills in for stage 8.
53
+ PartialWork = Struct.new( :config, :testable, keyword_init: true ) unless const_defined?(:PartialWork, false)
53
54
 
54
55
  # One mock's own preprocessing/generation work, flattened out of its owning testable
55
56
  # for parallel processing (T2). `details` is this mock's own MockDetails; `preprocessed_target`
@@ -74,6 +75,10 @@ module TestInvokerTypes
74
75
  # into search_paths so a mock is still findable
75
76
  # by however little path its own #include wrote
76
77
  :search_paths,
78
+ :derived_search_paths, # Array — directories the #includes of headers no
79
+ # search path lists imply, after every configured path
80
+ :search_path_refusals, # Hash — header query → why its #include gets no
81
+ # derived directory, for the error its failed lookup raises
77
82
  :compile_flags, :preprocess_flags, :assembler_flags, :link_flags,
78
83
  :compile_defines, :preprocess_defines,
79
84
  :runner, # RunnerInfo
@@ -86,19 +91,22 @@ module TestInvokerTypes
86
91
  # then the executable has already been marked fresh (if it
87
92
  # was rebuilt), so a fresh staleness query would always
88
93
  # answer false regardless of what actually happened.
89
- :isolated_headers_path, # String — set by stage 15's own sibling-header isolation
90
- # (TestBuildExecutor#isolate_sibling_headers) the first time
91
- # this test's own file compile finds a real header sharing a
92
- # directory with a mocked/Partialized header. Scoped to this
93
- # one test's whole build rather than any single object, so
94
- # every object compiled afterward sees the same corrected
95
- # search paths; nil until (if ever) that happens, and read
96
- # once more at the very end of stage 15 to know what to clean up.
94
+ :header_isolation, # QuoteIncludeIsolator::Isolation — set by stage 15's own
95
+ # sibling-header isolation (TestBuildExecutor#isolate_sibling_headers)
96
+ # when this test's own file compile finds a real header sharing a
97
+ # directory with one CMock copies by name. Scoped to this one
98
+ # test's whole build rather than any single object, so every
99
+ # object compiled afterward sees the same corrected search paths
100
+ # and maps its copies back to their originals; nil until (if ever)
101
+ # that happens, and read once more at the end of stage 15 to know
102
+ # what to clean up.
97
103
  keyword_init: true
98
104
  ) do
99
105
  def initialize(**kwargs)
100
106
  kwargs[:partials] ||= TestablePartials.new(configs: {}, tests: [], mocks: [])
101
107
  kwargs[:mock_search_paths] ||= []
108
+ kwargs[:derived_search_paths] ||= []
109
+ kwargs[:search_path_refusals] ||= {}
102
110
  super(**kwargs)
103
111
  end
104
112
  end unless const_defined?(:Testable, false)
@@ -56,11 +56,13 @@ module TestPipelineHelpers
56
56
  # between runs, with nothing else changed, should still invalidate whatever a
57
57
  # preprocessing pass produced.
58
58
  #
59
- # `partials:` is left out of the returned hash entirely when not given, so a
60
- # caller with nothing to do with Partials never carries a meaningless `nil`.
61
- def dependency_meta(flags:, defines:, search_paths:, tools: [], preprocess_force_fallback: @configurator.test_build_preprocess_force_fallback, partials: nil)
59
+ # `partials:` and `isolated:` are left out of the returned hash entirely when not given,
60
+ # so a caller with nothing to do with Partials or header isolation never carries a
61
+ # meaningless `nil`.
62
+ def dependency_meta(flags:, defines:, search_paths:, tools: [], preprocess_force_fallback: @configurator.test_build_preprocess_force_fallback, partials: nil, isolated: nil)
62
63
  meta = { flags: flags, defines: defines, search_paths: search_paths, tools: tools, preprocess_force_fallback: preprocess_force_fallback }
63
64
  meta[:partials] = partials unless partials.nil?
65
+ meta[:isolated] = isolated unless isolated.nil?
64
66
  meta
65
67
  end
66
68
 
@@ -21,6 +21,7 @@ class TestPipelineManager
21
21
  :test_build_setup,
22
22
  :test_includes_extractinator,
23
23
  :test_build_planner,
24
+ :partial_files_preprocessinator,
24
25
  :partials_manager,
25
26
  :test_build_executor,
26
27
  :test_file_preprocessinator,
@@ -166,6 +167,13 @@ class TestPipelineManager
166
167
  body: ->(s) { @test_build_setup.stage_ingest_configurations(s) }
167
168
  ),
168
169
 
170
+ # Transform 1: Set header copies aside while stage 4 preprocesses each test through its
171
+ # mock root. Transform 4 puts back those a current mock writes.
172
+ stage(transform: true,
173
+ condition: ->(s) { use_preprocessing.call(s) && use_mocks.call(s) },
174
+ body: ->(s) { @test_build_executor.stage_hold_header_copies(s) }
175
+ ),
176
+
169
177
  # Stage 4
170
178
  stage("Collecting More Test Context",
171
179
  condition: use_preprocessing,
@@ -178,7 +186,7 @@ class TestPipelineManager
178
186
  body: ->(s) { @test_build_planner.stage_determine_files(s) }
179
187
  ),
180
188
 
181
- # Transform 1: Prepare partials parallel processing
189
+ # Transform 2: Prepare partials parallel processing
182
190
  stage(transform: true,
183
191
  condition: use_partials,
184
192
  body: ->(s) { @test_build_planner.stage_flatten_partials_lists(s) }
@@ -189,7 +197,7 @@ class TestPipelineManager
189
197
  condition: use_partials,
190
198
  empty_condition: ->(s) { s.partials_headers.empty? },
191
199
  empty_notice: "no Partials to process",
192
- body: ->(s) { @partials_manager.stage_preprocess_partial_headers(s) }
200
+ body: ->(s) { @partial_files_preprocessinator.preprocess_headers(s) }
193
201
  ),
194
202
 
195
203
  # Stage 7
@@ -197,7 +205,7 @@ class TestPipelineManager
197
205
  condition: use_partials,
198
206
  empty_condition: ->(s) { s.partials_sources.empty? },
199
207
  empty_notice: "no Partials to process",
200
- body: ->(s) { @partials_manager.stage_preprocess_partial_sources(s) }
208
+ body: ->(s) { @partial_files_preprocessinator.preprocess_sources(s) }
201
209
  ),
202
210
 
203
211
  # Stage 8
@@ -208,17 +216,26 @@ class TestPipelineManager
208
216
  body: ->(s) { @partials_manager.stage_generate_partials(s) }
209
217
  ),
210
218
 
211
- # Transform 2: Prepare mocks for parallel processing
219
+ # Transform 3: Prepare mocks for parallel processing
212
220
  stage(transform: true,
213
221
  condition: use_mocks,
214
222
  body: ->(s) { @test_build_planner.stage_flatten_mocks_list(s) }
215
223
  ),
216
224
 
217
- # Stage 9
225
+ # Transform 4: Put back the header copies a current mock writes and prune the rest, before
226
+ # stage 10 regenerates mocks beside them. The test's own compile searches the mock root, so
227
+ # a stale copy would shadow its header. Runs when this run has no mocks too, since a test's
228
+ # mock root stays on its search path.
229
+ stage(transform: true,
230
+ condition: use_mocks,
231
+ body: ->(s) { @test_build_executor.stage_prune_header_copies(s) }
232
+ ),
233
+
234
+ # Stage 9 — a Partial mock needs no preprocessing, so Partial mocks alone leave it empty.
218
235
  stage("Preprocessing for Mocks",
219
236
  condition: use_mocks_preproc,
220
- empty_condition: ->(s) { s.mocks_list.empty? },
221
- empty_notice: "no mocks to process",
237
+ empty_condition: ->(s) { s.mocks_list.all? { |mock| mock.details.partial } },
238
+ empty_notice: "no mocks need preprocessing",
222
239
  body: ->(s) { @test_build_executor.stage_preprocess_mocks(s) }
223
240
  ),
224
241
 
@@ -256,7 +273,7 @@ class TestPipelineManager
256
273
  body: ->(s) { @test_build_planner.stage_determine_artifacts(s) }
257
274
  ),
258
275
 
259
- # Transform 3: Prepare objects for parallel processing — skipped under
276
+ # Transform 5: Prepare objects for parallel processing — skipped under
260
277
  # :mocking or :test_runner.
261
278
  stage(transform: true,
262
279
  condition: ->(s) { not_mocking.call(s) && not_test_runner.call(s) },