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
@@ -8,7 +8,8 @@
8
8
  require 'spec_helper'
9
9
  require 'ceedling/preprocess/preprocessinator'
10
10
  require 'ceedling/includes/includes'
11
- require 'ceedling/tool_executor'
11
+ require 'ceedling/includes/header_search'
12
+ require 'ceedling/tools/tool_executor'
12
13
 
13
14
  RSpec.describe Preprocessinator do
14
15
 
@@ -72,7 +73,6 @@ RSpec.describe Preprocessinator do
72
73
  directives_only_filepath: '/build/directives_only/module.c',
73
74
  fallback: false,
74
75
  flags: [],
75
- include_paths: [],
76
76
  vendor_paths: [],
77
77
  defines: defines
78
78
  )
@@ -218,41 +218,34 @@ RSpec.describe Preprocessinator do
218
218
  end
219
219
 
220
220
  # ===========================================================================
221
- describe '#preprocess_partial_header_expand_macros / #preprocess_partial_source_expand_macros' do
221
+ describe '#generate_partial_expansion' do
222
222
  # ===========================================================================
223
- # Both public methods funnel through the same private _preprocess_partial_expand_macros.
224
223
 
225
224
  let(:filepath) { '/src/module.c' }
225
+ let(:raw) { '/build/full_expansion/module.c' }
226
+ let(:code) { '/build/expanded_code/module.c' }
226
227
 
227
- def call_it(method: :preprocess_partial_header_expand_macros)
228
- subject.send(
229
- method,
230
- filepath: filepath,
231
- test: 'test',
232
- flags: [],
233
- include_paths: [],
234
- vendor_paths: [],
235
- defines: []
228
+ def call_it(**overrides)
229
+ subject.generate_partial_expansion(
230
+ filepath: filepath, test: 'test', flags: [], include_paths: [], vendor_paths: [], defines: [], **overrides
236
231
  )
237
232
  end
238
233
 
239
234
  before do
240
- allow(@file_path_utils).to receive(:form_preprocessed_file_full_expansion_filepath).and_return('/build/full_expansion/module.c')
235
+ allow(@file_path_utils).to receive(:form_preprocessed_file_full_expansion_filepath).with(filepath, 'test').and_return(raw)
236
+ allow(@file_path_utils).to receive(:form_preprocessed_file_expanded_code_filepath).with(filepath, 'test').and_return(code)
241
237
  allow(@configurator).to receive(:tools_test_file_full_preprocessor).and_return({})
242
238
  allow(@tool_executor).to receive(:build_command_line).and_return({ options: {} })
239
+ allow(@file_assembler).to receive(:collect_own_lines).and_return([])
240
+ allow(@file_assembler).to receive(:assemble_preprocessed_code_file)
241
+ allow(@file_wrapper).to receive(:rm_f)
243
242
  end
244
243
 
245
- # Without boom: false, the real ToolExecutor#exec (not this double) raises
246
- # ShellException on a nonzero exit code before the fallback below it ever runs,
247
- # crashing the build instead of gracefully degrading as documented.
248
- it "sets boom: false on the command before invoking the full preprocessor" do
244
+ # Without boom: false, the real ToolExecutor#exec raises ShellException on a failed run
245
+ # before the caller can reconcile without the expansion
246
+ it 'sets boom: false on the command before invoking the full preprocessor' do
249
247
  captured_command = nil
250
- allow(@tool_executor).to receive(:exec) do |command|
251
- captured_command = command
252
- { exit_code: 0 }
253
- end
254
- allow(@file_assembler).to receive(:collect_file_contents_from_full_expansion).and_return([])
255
- allow(@file_assembler).to receive(:assemble_preprocessed_code_file)
248
+ allow(@tool_executor).to receive(:exec) { |command| captured_command = command; { exit_code: 0 } }
256
249
 
257
250
  call_it()
258
251
 
@@ -260,58 +253,60 @@ RSpec.describe Preprocessinator do
260
253
  end
261
254
 
262
255
  # Vendor paths follow the file's own search paths, so a project header wins a name clash
263
- it "runs the full preprocessor tool on the file, its output, defines, and search paths ahead of vendor paths" do
256
+ it 'runs the full preprocessor tool into the raw expansion, with search paths ahead of vendor paths' do
264
257
  allow(@configurator).to receive(:tools_test_file_full_preprocessor).and_return( { name: 'full' } )
265
258
  allow(@tool_executor).to receive(:exec).and_return( failed_run )
266
259
 
267
- subject.send( :preprocess_partial_header_expand_macros,
268
- filepath: filepath, test: 'test', flags: ['-std=c99'], include_paths: ['inc'], vendor_paths: ['vendor'], defines: ['FOO']
269
- )
260
+ call_it( flags: ['-std=c99'], include_paths: ['inc'], vendor_paths: ['vendor'], defines: ['FOO'] )
270
261
 
271
262
  expect(@tool_executor).to have_received(:build_command_line).with(
272
- { name: 'full' }, ['-std=c99'], filepath, '/build/full_expansion/module.c', ['FOO'], ['inc', 'vendor']
263
+ { name: 'full' }, ['-std=c99'], filepath, raw, ['FOO'], ['inc', 'vendor']
273
264
  )
274
265
  end
275
266
 
276
- it "returns nil without raising when the full preprocessor invocation fails" do
277
- allow(@tool_executor).to receive(:exec).and_return( failed_run )
267
+ it 'keeps the raw expansion whole and writes the file\'s own lines beside it as plain code' do
268
+ allow(@tool_executor).to receive(:exec).and_return({ exit_code: 0 })
269
+ allow(@file_assembler).to receive(:collect_own_lines).with(source_filepath: filepath, preprocessed_filepath: raw).and_return(['expanded line'])
278
270
 
279
- result = nil
280
- expect { result = call_it() }.to_not raise_error
281
- expect(result).to be_nil
271
+ expect( call_it() ).to eq(code)
272
+ expect(@file_assembler).to have_received(:assemble_preprocessed_code_file).with(
273
+ preprocessed_filepath: code, contents: ['expanded line'], extras: [], includes: []
274
+ )
275
+ expect(@file_wrapper).to_not have_received(:rm_f)
282
276
  end
283
277
 
284
- it "returns nil without raising via preprocess_partial_source_expand_macros too" do
278
+ # An earlier run's files would otherwise pass for this run's expansion
279
+ it 'returns nil without raising, and removes both files, when the preprocessor fails' do
285
280
  allow(@tool_executor).to receive(:exec).and_return( failed_run )
286
281
 
287
- result = nil
288
- expect { result = call_it(method: :preprocess_partial_source_expand_macros) }.to_not raise_error
282
+ result = :unset
283
+ expect { result = call_it() }.to_not raise_error
284
+
289
285
  expect(result).to be_nil
286
+ expect(@file_wrapper).to have_received(:rm_f).with(raw)
287
+ expect(@file_wrapper).to have_received(:rm_f).with(code)
288
+ expect(@file_assembler).to_not have_received(:assemble_preprocessed_code_file)
290
289
  end
291
290
 
292
- it "returns the full expansion filepath and assembles the code file on success" do
291
+ it 'names reconciliation in its progress line' do
293
292
  allow(@tool_executor).to receive(:exec).and_return({ exit_code: 0 })
294
- allow(@file_assembler).to receive(:collect_file_contents_from_full_expansion).and_return(['expanded line'])
295
293
 
296
- captured = nil
297
- allow(@file_assembler).to receive(:assemble_preprocessed_code_file) { |**kwargs| captured = kwargs }
298
-
299
- result = call_it()
294
+ call_it()
300
295
 
301
- expect(result).to eq('/build/full_expansion/module.c')
302
- expect(captured[:contents]).to eq(['expanded line'])
303
- expect(captured[:includes]).to eq([])
304
- expect(captured[:extras]).to eq([])
296
+ expect(@reportinator).to have_received(:generate_module_progress).with(
297
+ operation: 'Full-preprocessing for Partial reconciliation', module_name: 'test', filename: 'module.c'
298
+ )
305
299
  end
306
300
 
307
- it "reaches the same success behavior via preprocess_partial_source_expand_macros too" do
308
- allow(@tool_executor).to receive(:exec).and_return({ exit_code: 0 })
309
- allow(@file_assembler).to receive(:collect_file_contents_from_full_expansion).and_return(['expanded line'])
310
- allow(@file_assembler).to receive(:assemble_preprocessed_code_file)
301
+ it 'warns that macro-supplied decorators will be missed when the preprocessor fails' do
302
+ allow(@tool_executor).to receive(:exec).and_return( failed_run )
311
303
 
312
- result = call_it(method: :preprocess_partial_source_expand_macros)
304
+ call_it()
313
305
 
314
- expect(result).to eq('/build/full_expansion/module.c')
306
+ expect(@loginator).to have_received(:log).with(
307
+ 'Failed to generate full expansion for Partial reconciliation (macro-supplied decorators will be missed) for /src/module.c',
308
+ Verbosity::COMPLAIN
309
+ )
315
310
  end
316
311
 
317
312
  end
@@ -378,12 +373,15 @@ RSpec.describe Preprocessinator do
378
373
  )
379
374
  end
380
375
 
381
- it "logs that the file falls back when the preprocessor fails" do
376
+ # Every stage that runs the pass reports a failure through this one warning
377
+ it "warns that the file falls back when the preprocessor fails" do
382
378
  allow(@tool_executor).to receive(:exec).and_return( failed_run )
383
379
 
384
380
  call_it()
385
381
 
386
- expect(@loginator).to have_received(:log).with( /Failed to generate directive-only preprocessor output .* for \/src\/module\.c/, Verbosity::OBNOXIOUS, LogLabels::ERROR )
382
+ expect(@loginator).to have_received(:log).with(
383
+ 'Failed to generate directive-only preprocessor output (fallback methods will be used) for /src/module.c', Verbosity::COMPLAIN
384
+ )
387
385
  end
388
386
 
389
387
  it "on success, strips comments, compacts the expansion, and returns the raw filepath" do
@@ -395,7 +393,8 @@ RSpec.describe Preprocessinator do
395
393
  expect(@reconstructor).to have_received(:compact_file_from_expansion).with(
396
394
  input_filepath: '/build/directives_only/module.c',
397
395
  source_filepath: filepath,
398
- output_filepath: '/build/directives_only/module_compacted.c'
396
+ output_filepath: '/build/directives_only/module_compacted.c',
397
+ rejoin: false
399
398
  )
400
399
  expect(result).to eq('/build/directives_only/module.c')
401
400
  end
@@ -464,7 +463,7 @@ RSpec.describe Preprocessinator do
464
463
  expect(@reconstructor).to_not have_received(:compact_file_from_expansion)
465
464
  end
466
465
 
467
- it 'returns nil without raising, and logs that text-scan #includes will be used, when the preprocessor fails' do
466
+ it 'returns nil without raising, and warns that text-scan #includes will be used, when the preprocessor fails' do
468
467
  allow(@tool_executor).to receive(:exec).and_return( failed_run )
469
468
 
470
469
  result = nil
@@ -472,7 +471,7 @@ RSpec.describe Preprocessinator do
472
471
 
473
472
  expect(result).to be_nil
474
473
  expect(@loginator).to have_received(:log).with(
475
- 'Failed to generate fallback preprocessor expansion (text-scan #includes will be used) for /src/test_module.c', Verbosity::OBNOXIOUS, LogLabels::ERROR
474
+ 'Failed to generate fallback preprocessor expansion (text-scan #includes will be used) for /src/test_module.c', Verbosity::COMPLAIN
476
475
  )
477
476
  end
478
477
 
@@ -630,6 +629,49 @@ RSpec.describe Preprocessinator do
630
629
  expect(call_it()).to eq('/build/preprocessed/module.h')
631
630
  end
632
631
 
632
+ # A real search over `tree`, a list of header paths, as IncludePathinator lists a directory
633
+ def header_search_over(paths, tree)
634
+ return HeaderSearch.new( paths, ->(dir) { tree.select { |header| File.dirname( header ) == dir }.sort } )
635
+ end
636
+
637
+ # The #includes the assembled header writes, from a header preprocessed with `fallback`
638
+ def assembled_includes(includes, search, fallback: false, header: filepath)
639
+ allow(subject).to receive(:preprocess_file_includes_common).and_return( includes )
640
+ written = nil
641
+ allow(@file_assembler).to receive(:assemble_preprocessed_header_file) { |includes:, **| written = includes.map( &:to_s ) }
642
+
643
+ subject.preprocess_mockable_header_file(
644
+ test: 'test', filepath: header, directives_only_filepath: nil, fallback: fallback, flags: [], include_paths: [],
645
+ vendor_paths: [], defines: [], include_search: search
646
+ )
647
+ return written
648
+ end
649
+
650
+ # CMock copies the header beside the mock under :treat_inlines :include, so its #includes
651
+ # are written as the test's search paths reach each header
652
+ it "spells the header's #includes through the test's search before assembling" do
653
+ search = header_search_over( ['/src'], ['/src/drivers/foo.h'] )
654
+
655
+ expect( assembled_includes( [UserInclude.new( '/src/drivers/foo.h' ), SystemInclude.new( 'stdint.h' )], search ) )
656
+ .to eq( ['#include "drivers/foo.h"', '#include <stdint.h>'] )
657
+ end
658
+
659
+ # A preprocessor's #include holds the path the compiler found its header by
660
+ it "spells a preprocessed #include by the header the compiler found" do
661
+ search = header_search_over( ['include', 'lib'], ['include/config.h', 'lib/include/config.h'] )
662
+
663
+ expect( assembled_includes( [UserInclude.new( 'include/config.h' )], search ) ).to eq( ['#include "config.h"'] )
664
+ end
665
+
666
+ # Fallback's text scan holds an #include as written, which the compiler looks for beside the
667
+ # header holding it before any search path
668
+ it "spells a fallback #include by the header beside the mockable header" do
669
+ search = header_search_over( ['/src', '/src/drivers'], ['/src/config.h', '/src/drivers/config.h'] )
670
+ includes = assembled_includes( [UserInclude.new( 'config.h' )], search, fallback: true, header: '/src/drivers/module.h' )
671
+
672
+ expect( includes ).to eq( ['#include "drivers/config.h"'] )
673
+ end
674
+
633
675
  it "fires pre_mock_preprocess before assembling and post_mock_preprocess after" do
634
676
  order = []
635
677
  allow(@plugin_manager).to receive(:pre_mock_preprocess) { order << :pre }
@@ -668,27 +710,27 @@ RSpec.describe Preprocessinator do
668
710
  end
669
711
 
670
712
  # ===========================================================================
671
- describe '#preprocess_partial_header_file_preserve_macros / #preprocess_partial_source_file_preserve_macros' do
713
+ describe '#preprocess_partial_file' do
672
714
  # ===========================================================================
673
715
 
674
- let(:filepath) { '/src/module.h' }
716
+ let(:raw) { '/build/directives_only/raw/module.h' }
675
717
 
676
- def call_it(method:, fallback:)
677
- subject.send(
678
- method,
718
+ def call_it(kind:, fallback:, filepath: '/src/module.h')
719
+ subject.preprocess_partial_file(
720
+ kind: kind,
679
721
  test: 'test',
680
722
  filepath: filepath,
681
- directives_only_filepath: '/build/directives_only/module.h',
723
+ directives_only_filepath: raw,
682
724
  fallback: fallback,
683
725
  flags: [],
684
726
  include_paths: [],
685
727
  vendor_paths: [],
686
- defines: []
728
+ defines: ['FOO']
687
729
  )
688
730
  end
689
731
 
690
732
  before do
691
- allow(@file_path_utils).to receive(:preprocessed_file_subpath) { |path| File.basename(path) }
733
+ allow(@file_path_utils).to receive(:preprocessed_file_subpath) { |path| "sub/#{File.basename(path)}" }
692
734
  allow(@file_path_utils).to receive(:form_preprocessed_file_filepath).and_return('/build/preprocessed/module.h')
693
735
  allow(@file_path_utils).to receive(:form_preprocessed_includes_list_filepath).and_return('/build/includes/module.h.yml')
694
736
  allow(@includes_handler).to receive(:extract_bare_includes).and_return([])
@@ -700,50 +742,68 @@ RSpec.describe Preprocessinator do
700
742
  allow(@includes_handler).to receive(:extract_system_includes_from_text).and_return([])
701
743
  allow(@includes_handler).to receive(:write_includes_list)
702
744
  allow(@file_assembler).to receive(:collect_file_contents_fallback).and_return(['fallback content'])
703
- allow(@file_assembler).to receive(:collect_file_contents_from_directives_only_preprocessing).and_return(['directives content'])
745
+ allow(@file_assembler).to receive(:collect_own_lines).and_return(['directives content'])
704
746
  allow(@file_assembler).to receive(:collect_macros_and_pragmas_fallback).and_return(['macro'])
705
747
  allow(@file_assembler).to receive(:assemble_preprocessed_header_file)
706
748
  allow(@file_assembler).to receive(:assemble_preprocessed_code_file)
707
749
  end
708
750
 
709
- it "uses the fallback content-source and re-extracts macros/pragmas when fallback: true (header)" do
710
- captured = nil
711
- allow(@file_assembler).to receive(:assemble_preprocessed_header_file) { |**kwargs| captured = kwargs }
712
-
713
- call_it(method: :preprocess_partial_header_file_preserve_macros, fallback: true)
751
+ # Fallback drops every `#` line from the content, so macros and pragmas come back as extras
752
+ it 'reads the original file\'s text and recovers its macros in fallback' do
753
+ call_it( kind: :header, fallback: true )
714
754
 
715
- expect(@file_assembler).to have_received(:collect_file_contents_fallback)
716
- expect(@file_assembler).to_not have_received(:collect_file_contents_from_directives_only_preprocessing)
717
- expect(captured[:contents]).to eq(['fallback content'])
718
- expect(captured[:extras]).to eq(['macro'])
755
+ expect(@file_assembler).to have_received(:collect_file_contents_fallback).with(source_filepath: '/src/module.h', defines: ['FOO'])
756
+ expect(@file_assembler).to_not have_received(:collect_own_lines)
757
+ expect(@file_assembler).to have_received(:assemble_preprocessed_header_file).with(
758
+ hash_including( contents: ['fallback content'], extras: ['macro'] )
759
+ )
719
760
  end
720
761
 
721
- it "uses directives-only content and empty extras when fallback: false (header)" do
722
- captured = nil
723
- allow(@file_assembler).to receive(:assemble_preprocessed_header_file) { |**kwargs| captured = kwargs }
724
-
725
- call_it(method: :preprocess_partial_header_file_preserve_macros, fallback: false)
762
+ # Directives-only output expands no macros, so nothing in it is rejoined
763
+ it 'reads the file\'s own lines from its raw directives-only output, unjoined, when accurate' do
764
+ call_it( kind: :header, fallback: false )
726
765
 
727
- expect(@file_assembler).to have_received(:collect_file_contents_from_directives_only_preprocessing)
766
+ expect(@file_assembler).to have_received(:collect_own_lines).with(source_filepath: '/src/module.h', preprocessed_filepath: raw, rejoin: false)
728
767
  expect(@file_assembler).to_not have_received(:collect_file_contents_fallback)
729
- expect(captured[:contents]).to eq(['directives content'])
730
- expect(captured[:extras]).to eq([])
768
+ expect(@file_assembler).to have_received(:assemble_preprocessed_header_file).with(
769
+ hash_including( contents: ['directives content'], extras: [] )
770
+ )
731
771
  end
732
772
 
733
- it "uses the fallback content-source for the source-file variant too" do
734
- captured = nil
735
- allow(@file_assembler).to receive(:assemble_preprocessed_code_file) { |**kwargs| captured = kwargs }
773
+ # The guard is derived from the header's path below its root, so two same-named headers differ
774
+ it 'writes a header with a guard named for its path below its root' do
775
+ call_it( kind: :header, fallback: false )
776
+
777
+ expect(@file_assembler).to have_received(:assemble_preprocessed_header_file).with(
778
+ hash_including( filepath: 'sub/module.h', preprocessed_filepath: '/build/preprocessed/module.h' )
779
+ )
780
+ expect(@file_assembler).to_not have_received(:assemble_preprocessed_code_file)
781
+ end
782
+
783
+ it 'writes a source without a guard' do
784
+ allow(@file_path_utils).to receive(:form_preprocessed_file_filepath).with('/src/module.c', 'test').and_return('/build/preprocessed/module.c')
785
+
786
+ call_it( kind: :source, fallback: true, filepath: '/src/module.c' )
787
+
788
+ expect(@file_assembler).to have_received(:assemble_preprocessed_code_file).with(
789
+ hash_including( preprocessed_filepath: '/build/preprocessed/module.c', contents: ['fallback content'], extras: ['macro'] )
790
+ )
791
+ expect(@file_assembler).to_not have_received(:assemble_preprocessed_header_file)
792
+ end
736
793
 
737
- call_it(method: :preprocess_partial_source_file_preserve_macros, fallback: true)
794
+ it 'names the file\'s kind in its progress and #includes logs' do
795
+ call_it( kind: :source, fallback: false, filepath: '/src/module.c' )
738
796
 
739
- expect(captured[:contents]).to eq(['fallback content'])
740
- expect(captured[:extras]).to eq(['macro'])
797
+ expect(@reportinator).to have_received(:generate_module_progress).with(
798
+ operation: 'Preprocessing source file for follow-on Partials handling', module_name: 'test', filename: 'module.c'
799
+ )
800
+ expect(@loginator).to have_received(:log_list).with( [], 'Discovered #includes for Partial source from /src/module.c:', Verbosity::OBNOXIOUS )
741
801
  end
742
802
 
743
- it "returns the preprocessed filepath and the discovered includes" do
744
- preprocessed_filepath, includes = call_it(method: :preprocess_partial_header_file_preserve_macros, fallback: false)
803
+ it 'returns the assembled copy\'s path and the discovered #includes' do
804
+ assembled, includes = call_it( kind: :header, fallback: false )
745
805
 
746
- expect(preprocessed_filepath).to eq('/build/preprocessed/module.h')
806
+ expect(assembled).to eq('/build/preprocessed/module.h')
747
807
  expect(includes).to eq([])
748
808
  end
749
809
 
@@ -764,7 +824,6 @@ RSpec.describe Preprocessinator do
764
824
  includes: [],
765
825
  flags: [],
766
826
  include_paths: [],
767
- vendor_paths: [],
768
827
  defines: []
769
828
  )
770
829
  end
@@ -812,7 +871,6 @@ RSpec.describe Preprocessinator do
812
871
  includes: given_includes,
813
872
  flags: [],
814
873
  include_paths: [],
815
- vendor_paths: [],
816
874
  defines: []
817
875
  )
818
876
 
@@ -0,0 +1,51 @@
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 'spec_helper'
9
+ require 'ceedling/setupinator'
10
+ require 'ceedling/constants'
11
+
12
+ describe Setupinator do
13
+ # FileWrapper is built before any configuration exists, so setup hands it the Windows
14
+ # path limit, and the prober that decides it, once the configuration is built
15
+ describe 'Windows path limit' do
16
+ it 'gives FileWrapper the configured mode and the prober once the configuration is built' do
17
+ configurator = double( 'configurator', project_win_path_limit: :auto, build: nil )
18
+ file_wrapper = double( 'file_wrapper' )
19
+ objects = Setupinator::COLLABORATORS.to_h { |name| [name, double( name.to_s )] }
20
+ objects = objects.merge( configurator: configurator, file_wrapper: file_wrapper,
21
+ file_path_utils: double( 'file_path_utils', publish_build_roots: [] ) )
22
+
23
+ setupinator = described_class.new
24
+ setupinator.ceedling = objects
25
+
26
+ expect(configurator).to receive(:build).ordered
27
+ expect(file_wrapper).to receive(:configure_win_path_limit).with( mode: :auto, prober: objects[:win_path_prober] ).ordered
28
+
29
+ setupinator.send( :build_configuration, { ceedling_lib_path: 'lib', logging_path: 'logs' } )
30
+ end
31
+ end
32
+
33
+ # GH #1387: a build path below a long configured root carries the root's marker instead
34
+ describe 'shortened roots' do
35
+ it 'publishes the roots table once the configuration is built, and logs each marker at DEBUG' do
36
+ configurator = double( 'configurator', project_win_path_limit: :classic, build: nil )
37
+ file_path_utils = double( 'file_path_utils' )
38
+ loginator = double( 'loginator' )
39
+ objects = Setupinator::COLLABORATORS.to_h { |name| [name, double( name.to_s ).as_null_object] }
40
+
41
+ setupinator = described_class.new
42
+ setupinator.ceedling = objects.merge( configurator: configurator, file_path_utils: file_path_utils, loginator: loginator )
43
+
44
+ expect(configurator).to receive(:build).ordered
45
+ expect(file_path_utils).to receive(:publish_build_roots).ordered.and_return( [['../sdk/include', '_include_3F2A91C0']] )
46
+ expect(loginator).to receive(:log).with( '_include_3F2A91C0 ➡️ ../sdk/include', Verbosity::DEBUG )
47
+
48
+ setupinator.send( :build_configuration, { ceedling_lib_path: 'lib', logging_path: 'logs' } )
49
+ end
50
+ end
51
+ end
@@ -32,13 +32,15 @@ describe StandinHeaderinator do
32
32
  allow(@file_path_utils).to receive(:form_mock_output_path) do |root, subdir|
33
33
  subdir.nil? || subdir.empty? ? root : File.join( root, subdir )
34
34
  end
35
- allow(@mock_locator).to receive(:header_collection).and_return( ['src/drivers/foo.h'] )
35
+ allow(@mock_locator).to receive(:header_search).and_return( :search )
36
36
  allow(@mock_locator).to receive(:locate).and_return( ['src/drivers/foo.h', 'drivers'] )
37
37
  allow(@mock_locator).to receive(:placement) do |mocks_root:, subdir:, **|
38
38
  dir = subdir.empty? ? mocks_root : File.join( mocks_root, subdir )
39
39
  MockLocator::MockPlacement.new( folder: nil, directory: dir, root: dir, reach: dir )
40
40
  end
41
41
  allow(@mock_locator).to receive(:search_directories) { |placement| [placement.directory] }
42
+ allow(@mock_locator).to receive(:header_include) { |_include, header, _search| File.basename( header ) }
43
+ allow(@mock_locator).to receive(:header_include_line) { |text| "#include \"#{text}\"" }
42
44
 
43
45
  @standins = described_class.new(
44
46
  configurator: @configurator, loginator: @loginator, reportinator: @reportinator,
@@ -63,8 +65,22 @@ describe StandinHeaderinator do
63
65
  @standins.place( @testable, [Include.new( 'MockFoo.h' )] )
64
66
  end
65
67
 
66
- it "includes the header in the project's CMock :orig_header_include_fmt" do
67
- allow(@configurator).to receive(:get_cmock_config).and_return( { orig_header_include_fmt: '#include <%s>' } )
68
+ # CMock names a mock's header with the header's own extension, which the test's #include repeats
69
+ it "writes a stand-in with the extension its mock's #include names" do
70
+ expect(@file_wrapper).to receive(:write).with( 'build/test/mocks/a_test/drivers/MockFoo.hpp', anything )
71
+ expect(@file_wrapper).to_not receive(:write).with( 'build/test/mocks/a_test/drivers/MockFoo.h', anything )
72
+
73
+ @standins.place( @testable, [Include.new( 'MockFoo.hpp' )] )
74
+ end
75
+
76
+ it "keeps the dots of a mock's name in its stand-in's path" do
77
+ expect(@file_wrapper).to receive(:write).with( 'build/test/mocks/a_test/drivers/MockSensor.44.hpp', anything )
78
+
79
+ @standins.place( @testable, [Include.new( 'MockSensor.44.hpp' )] )
80
+ end
81
+
82
+ it "includes the header by the line the real mock opens with" do
83
+ allow(@mock_locator).to receive(:header_include_line).with( 'foo.h' ).and_return( '#include <foo.h>' )
68
84
 
69
85
  expect(@file_wrapper).to receive(:write).with( anything, "#{StandinHeaderinator::MARKER}\n#include <foo.h>\n" )
70
86
 
@@ -100,11 +116,9 @@ describe StandinHeaderinator do
100
116
  @standins.place( @testable, [Include.new( 'MockFoo.h' )] )
101
117
  end
102
118
 
103
- it "resolves a mock's header against the test's search paths without its mock directories" do
104
- expect(@mock_locator).to receive(:header_collection)
105
- .with( ['build/test/mocks/a_test', 'build/test/mocks/a_test/hw', 'src'], ['build/test/mocks/a_test/hw'] )
106
- .and_return( ['src/drivers/foo.h'] )
107
- expect(@mock_locator).to receive(:locate).with( Include.new( 'MockFoo.h' ), collection: ['src/drivers/foo.h'], complain: :error )
119
+ it "resolves a mock's header through the test's header search" do
120
+ expect(@mock_locator).to receive(:header_search).with( @testable ).and_return( :search )
121
+ expect(@mock_locator).to receive(:locate).with( Include.new( 'MockFoo.h' ), collection: :search, complain: :error )
108
122
  .and_return( ['src/drivers/foo.h', 'drivers'] )
109
123
 
110
124
  @standins.place( @testable, [Include.new( 'MockFoo.h' )] )
@@ -129,12 +143,14 @@ describe StandinHeaderinator do
129
143
  .to eq( ['build/test/mocks/a_test/_up_/x', 'build/test/mocks/a_test/_up_/_up_'] )
130
144
  end
131
145
 
132
- # The real mock opens with the header as CMock names it, by the folder CMock is given
133
- it "includes the header by the folder its mock is named by" do
146
+ # The real mock opens with the header by the text the test's search paths reach it by,
147
+ # which a search path listing the header's own directory gives without the folder
148
+ it "includes the header by the text its mock includes it by" do
134
149
  named = MockLocator::MockPlacement.new( folder: 'drivers', directory: 'build/test/mocks/a_test/drivers', root: 'build/test/mocks/a_test', reach: 'build/test/mocks/a_test' )
135
150
  allow(@mock_locator).to receive(:placement).and_return( named )
151
+ allow(@mock_locator).to receive(:header_include).with( Include.new( 'drivers/MockFoo.h' ), 'src/drivers/foo.h', :search ).and_return( 'foo.h' )
136
152
 
137
- expect(@file_wrapper).to receive(:write).with( 'build/test/mocks/a_test/drivers/MockFoo.h', "#{StandinHeaderinator::MARKER}\n#include \"drivers/foo.h\"\n" )
153
+ expect(@file_wrapper).to receive(:write).with( 'build/test/mocks/a_test/drivers/MockFoo.h', "#{StandinHeaderinator::MARKER}\n#include \"foo.h\"\n" )
138
154
 
139
155
  @standins.place( @testable, [Include.new( 'drivers/MockFoo.h' )] )
140
156
  end