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
@@ -0,0 +1,259 @@
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/constants'
10
+ require 'ceedling/filename_extension'
11
+ require 'ceedling/includes/includes'
12
+ require 'ceedling/includes/include_pathinator'
13
+ require 'ceedling/filesystem/file_finder'
14
+ require 'ceedling/test_invoker/test_invoker_types'
15
+ require 'ceedling/test_invoker/test_derived_search_paths'
16
+
17
+ describe TestDerivedSearchPaths do
18
+ before(:each) do
19
+ @configurator = double( "Configurator", cmock_mock_prefix: 'mock_', cmock_mock_name_include_folder: true, project_build_root: 'build' )
20
+ allow(@configurator).to receive(:extension_header).and_return( FilenameExtension.new( '.h' ) )
21
+ @extractor = double( "TestContextExtractor" )
22
+ @file_wrapper = double( "FileWrapper" )
23
+ @loginator = double( "Loginator" )
24
+ @search_paths = double( "TestSearchPaths" )
25
+ allow(@loginator).to receive(:log)
26
+
27
+ # The project's headers on disk, listed a directory at a time
28
+ @tree = []
29
+ allow(@file_wrapper).to receive(:directory_listing) do |patterns|
30
+ dir = File.dirname( patterns.first ).delete_prefix( './' )
31
+ @tree.select { |header| File.dirname( header ) == dir }.sort
32
+ end
33
+ allow(@file_wrapper).to receive(:exist?) { |path| @tree.include?( path ) }
34
+
35
+ @collection = []
36
+ allow(@configurator).to receive(:collection_all_headers) { @collection }
37
+
38
+ pathinator = IncludePathinator.new( configurator: @configurator, test_context_extractor: @extractor, loginator: @loginator, file_wrapper: @file_wrapper )
39
+ pathinator.setup
40
+ finder = FileFinder.new( configurator: @configurator, file_finder_helper: nil, file_path_utils: nil, file_wrapper: @file_wrapper, yaml_wrapper: nil, test_build_layout: nil )
41
+
42
+ @derived = described_class.new(
43
+ configurator: @configurator, include_pathinator: pathinator, test_search_paths: @search_paths,
44
+ test_context_extractor: @extractor, file_finder: finder, file_wrapper: @file_wrapper, loginator: @loginator
45
+ )
46
+ @derived.setup
47
+
48
+ @testable = TestInvokerTypes::Testable.new( name: 'test_it', filepath: 'test/test_it.c' )
49
+ end
50
+
51
+ # `paths` are the test's search paths, `headers` the headers on disk, `files` the
52
+ # project's header collection, and `includes` the test's #includes. Gives the derived
53
+ # directories and keeps the refusals in @refusals.
54
+ def derive(paths:, includes:, headers: ['src/path/to/sensor.h'], files: headers)
55
+ @tree = headers
56
+ @collection = files
57
+ allow(@search_paths).to receive(:header_paths).with( @testable ).and_return( paths )
58
+ allow(@extractor).to receive(:lookup_all_header_includes_list).with( 'test/test_it.c' ).and_return( includes )
59
+
60
+ roots, @refusals = @derived.collect( @testable )
61
+ return roots
62
+ end
63
+
64
+ def mock(path)
65
+ return MockInclude.new( path )
66
+ end
67
+
68
+ describe "#collect" do
69
+ it "adds a bare mock's header's own directory" do
70
+ expect(derive( paths: ['.'], includes: [mock( 'mock_sensor.h' )] )).to eq( ['src/path/to'] )
71
+ end
72
+
73
+ it "says which search path it added, for which test, and why" do
74
+ expect(@loginator).to receive(:log).with(
75
+ "Added search path 'src/path/to' for test/test_it.c after every configured search path, so \"sensor.h\" reaches src/path/to/sensor.h.",
76
+ Verbosity::COMPLAIN, LogLabels::NOTICE
77
+ )
78
+
79
+ derive( paths: ['.'], includes: [mock( 'mock_sensor.h' )] )
80
+ end
81
+
82
+ it "names each directory once a build, however many tests need it" do
83
+ expect(@loginator).to receive(:log).with( /Added search path 'src\/path\/to'/, Verbosity::COMPLAIN, LogLabels::NOTICE ).twice
84
+
85
+ 2.times { derive( paths: ['.'], includes: [mock( 'mock_sensor.h' )] ) }
86
+ @derived.forget_notices
87
+ derive( paths: ['.'], includes: [mock( 'mock_sensor.h' )] )
88
+ end
89
+
90
+ it "adds nothing for a mock whose #include a search path already joins to its header" do
91
+ expect(@loginator).to_not receive(:log)
92
+
93
+ expect(derive( paths: ['.'], includes: [mock( 'src/path/to/mock_sensor.h' )] )).to eq( [] )
94
+ end
95
+
96
+ it "adds the directory a mock's folder is measured from" do
97
+ expect(derive( paths: ['inc'], includes: [mock( 'path/to/mock_sensor.h' )] )).to eq( ['src'] )
98
+ end
99
+
100
+ it "adds the project root for a mock's folder that spells the header's whole path" do
101
+ expect(derive( paths: ['inc'], includes: [mock( 'src/path/to/mock_sensor.h' )] )).to eq( ['.'] )
102
+ end
103
+
104
+ # The compiler can't join `src` with "src/path/to/sensor.h", though the header lies below it
105
+ it "adds the directory a mock's folder is measured from when that folder starts at a search path" do
106
+ expect(derive( paths: ['src'], includes: [mock( 'src/path/to/mock_sensor.h' )] )).to eq( ['.'] )
107
+ end
108
+
109
+ # The mock includes its header by the text the listed directory reaches it by. A directory
110
+ # added for its folder could hold a header named like a system one, such as string.h.
111
+ it "adds nothing for a mock through a folder where a search path lists the header's own directory" do
112
+ expect(derive( paths: ['src/path/to'], includes: [mock( 'path/to/mock_sensor.h' )] )).to eq( [] )
113
+ end
114
+
115
+ it "adds nothing for a plain #include through a folder where a search path lists the header's own directory" do
116
+ expect(derive( paths: ['src/path/to'], includes: [UserInclude.new( 'path/to/sensor.h' )] )).to eq( [] )
117
+ end
118
+
119
+ it "adds the header's own directory for a mock named without its folder" do
120
+ allow(@configurator).to receive(:cmock_mock_name_include_folder).and_return( false )
121
+
122
+ expect(derive( paths: ['inc'], includes: [mock( 'path/to/mock_sensor.h' )] )).to eq( ['src/path/to'] )
123
+ end
124
+
125
+ it "adds the directory a plain #include implies" do
126
+ expect(derive( paths: ['.'], includes: [UserInclude.new( 'sensor.h' )] )).to eq( ['src/path/to'] )
127
+ end
128
+
129
+ # A quoted #include looks in its own file's directory first
130
+ it "adds nothing for a plain #include the test file's own directory reaches" do
131
+ expect(derive( paths: ['.'], includes: [UserInclude.new( 'local.h' )], headers: ['test/local.h'], files: [] )).to eq( [] )
132
+ end
133
+
134
+ it "adds nothing for a header no collection holds" do
135
+ expect(derive( paths: ['.'], includes: [mock( 'mock_sensor.h' )], files: [] )).to eq( [] )
136
+ end
137
+
138
+ # The compiler rejects such an #include, and so does Ceedling
139
+ it "adds nothing for a header whose own directory is a search path" do
140
+ expect(derive( paths: ['src'], includes: [UserInclude.new( 'src/x.h' )], headers: ['src/x.h'] )).to eq( [] )
141
+ end
142
+
143
+ it "adds a directory once, which later #includes reach headers through" do
144
+ headers = ['src/path/to/sensor.h', 'src/path/to/sensor_types.h']
145
+
146
+ expect(derive( paths: ['.'], includes: [mock( 'mock_sensor.h' ), UserInclude.new( 'sensor_types.h' )], headers: headers )).to eq( ['src/path/to'] )
147
+ end
148
+
149
+ it "finds a header through a TEST_INCLUDE_PATH() directory before the collection" do
150
+ headers = ['tip/sensor.h', 'src/path/to/sensor.h']
151
+
152
+ expect(derive( paths: ['tip', '.'], includes: [mock( 'mock_sensor.h' )], headers: headers )).to eq( [] )
153
+ end
154
+
155
+ it "adds nothing for a header below the build root" do
156
+ expect(derive( paths: ['.'], includes: [UserInclude.new( 'gen.h' )], headers: ['build/gen/gen.h'] )).to eq( [] )
157
+ end
158
+
159
+ it "skips system, Unity, Ceedling and Partial #includes, Partial mocks, and paths that climb or are absolute" do
160
+ includes = [
161
+ SystemInclude.new( 'sensor.h' ), UserInclude.new( 'unity.h' ), UserInclude.new( 'ceedling.h' ),
162
+ UserInclude.new( 'ceedling_partial_sensor.h' ), mock( 'mock_ceedling_partial_sensor.h' ),
163
+ UserInclude.new( '../src/path/to/sensor.h' ).anchored( 'test' ), UserInclude.new( '/abs/sensor.h' )
164
+ ]
165
+ headers = ['src/path/to/sensor.h', 'src/path/to/unity.h', 'src/path/to/ceedling.h', 'src/path/to/ceedling_partial_sensor.h', '/abs/sensor.h']
166
+
167
+ expect(derive( paths: ['inc'], includes: includes, headers: headers )).to eq( [] )
168
+ end
169
+
170
+ it "refuses nothing for a bare name's header inside the working directory" do
171
+ expect(derive( paths: ['.'], includes: [mock( 'mock_sensor.h' )] )).to eq( ['src/path/to'] )
172
+ expect(@refusals).to eq( {} )
173
+ end
174
+
175
+ context "for a header outside the working directory" do
176
+ let(:socket) { '/usr/include/x86_64-linux-gnu/sys/socket.h' }
177
+ # A refusal spells the search path absolutely, so Windows gives it the current drive
178
+ let(:socket_dir) { ProjectPaths.absolute( File.dirname( socket ) ) }
179
+
180
+ it "adds the directory a mock's folder is measured from" do
181
+ expect(derive( paths: ['inc'], includes: [mock( 'sys/mock_socket.h' )], headers: [socket] )).to eq( ['/usr/include/x86_64-linux-gnu'] )
182
+ end
183
+
184
+ it "explains a mock named without its folder by the option it needs, logging nothing" do
185
+ allow(@configurator).to receive(:cmock_mock_name_include_folder).and_return( false )
186
+ expect(@loginator).to_not receive(:log)
187
+
188
+ expect(derive( paths: ['inc'], includes: [mock( 'sys/mock_socket.h' )], headers: [socket] )).to eq( [] )
189
+ expect(@refusals).to eq(
190
+ 'sys/socket.h' =>
191
+ "`#include \"sys/mock_socket.h\"` in test/test_it.c needs search path '#{socket_dir}', " \
192
+ "since its mock writes `#include \"socket.h\"` with :cmock ↳ :mock_name_include_folder disabled. " \
193
+ "Because this search path is outside the working directory and could cause shadowing of other headers, " \
194
+ "Ceedling won't add the full search path. Instead, enable :cmock ↳ :mock_name_include_folder and reference " \
195
+ "the parent folder, as in `#include \"sys/mock_socket.h\"`."
196
+ )
197
+ end
198
+
199
+ it "adds nothing for a bare name, explaining the #include that would reach it and logging nothing" do
200
+ expect(@loginator).to_not receive(:log)
201
+
202
+ expect(derive( paths: ['inc'], includes: [mock( 'mock_socket.h' )], headers: [socket] )).to eq( [] )
203
+ expect(@refusals).to eq(
204
+ 'socket.h' =>
205
+ "`#include \"mock_socket.h\"` in test/test_it.c needs search path '#{socket_dir}'. " \
206
+ "Because this search path is outside the working directory and could cause shadowing of other headers, " \
207
+ "Ceedling won't add the full search path. Instead, reference the parent folder, as in `#include \"sys/mock_socket.h\"`."
208
+ )
209
+ end
210
+
211
+ it "explains a plain #include by its own path" do
212
+ derive( paths: ['inc'], includes: [UserInclude.new( 'socket.h' )], headers: [socket] )
213
+
214
+ expect(@refusals.keys).to eq( ['socket.h'] )
215
+ expect(@refusals['socket.h']).to start_with( "`#include \"socket.h\"` in test/test_it.c needs search path" )
216
+ expect(@refusals['socket.h']).to end_with( "as in `#include \"sys/socket.h\"`." )
217
+ end
218
+
219
+ # The lookup tries each header extension in turn and names the last when none is found
220
+ it "files a plain #include's refusal under each header extension its lookup tries" do
221
+ allow(@configurator).to receive(:extension_header).and_return( FilenameExtension.new( ['.h', '.hpp'] ) )
222
+ derive( paths: ['inc'], includes: [UserInclude.new( 'socket.h' )], headers: [socket] )
223
+
224
+ expect(@refusals.keys).to eq( ['socket.h', 'socket.hpp'] )
225
+ expect(@refusals.values.uniq.length).to eq( 1 )
226
+ end
227
+
228
+ it "files a mock's refusal under its query alone, which its lookup asks for" do
229
+ allow(@configurator).to receive(:extension_header).and_return( FilenameExtension.new( ['.h', '.hpp'] ) )
230
+ derive( paths: ['inc'], includes: [mock( 'mock_socket.h' )], headers: [socket] )
231
+
232
+ expect(@refusals.keys).to eq( ['socket.h'] )
233
+ end
234
+
235
+ # Every stage looks a test's mocks up before its other #includes
236
+ [[:plain_first, ->(m, p) { [p, m] }], [:mock_first, ->(m, p) { [m, p] }]].each do |order, arrange|
237
+ it "explains a header a mock and a plain #include share by the mock's refusal (#{order})" do
238
+ derive( paths: ['inc'], includes: arrange.call( mock( 'mock_socket.h' ), UserInclude.new( 'socket.h' ) ), headers: [socket] )
239
+
240
+ expect(@refusals['socket.h']).to start_with( "`#include \"mock_socket.h\"` in test/test_it.c" )
241
+ end
242
+ end
243
+
244
+ it "files a refusal under the spelling the header search looks it up by" do
245
+ allow(@configurator).to receive(:cmock_mock_name_include_folder).and_return( false )
246
+ derive( paths: ['inc'], includes: [mock( './sys//mock_socket.h' )], headers: [socket] )
247
+
248
+ expect(@refusals.keys).to eq( ['sys/socket.h'] )
249
+ end
250
+
251
+ it "spells a header's search path absolutely, whatever spelling the collection holds" do
252
+ relative = ProjectPaths.relative( socket )
253
+ derive( paths: ['inc'], includes: [mock( 'mock_socket.h' )], headers: [relative] )
254
+
255
+ expect(@refusals['socket.h']).to include( "needs search path '#{socket_dir}'." )
256
+ end
257
+ end
258
+ end
259
+ end
@@ -12,6 +12,7 @@ require 'ceedling/test_invoker/test_includes_preprocessinator'
12
12
  require 'ceedling/test_invoker/test_includes_reconcilinator'
13
13
  require 'ceedling/test_invoker/test_invoker_types'
14
14
  require 'ceedling/test_invoker/test_search_paths'
15
+ require 'ceedling/includes/header_search'
15
16
  require 'ceedling/test_invoker/mock_locator'
16
17
  require 'ceedling/test_invoker/standin_headerinator'
17
18
 
@@ -87,9 +88,10 @@ describe TestIncludesExtractinator do
87
88
  allow(@test_context_extractor).to receive(:lookup_source_includes_list).and_return( [] )
88
89
  allow(@test_context_extractor).to receive(:ingest_includes)
89
90
 
90
- # Harmless default -- individual examples needing a specific ordered header
91
- # collection stub this again with a narrower `.with(...)` match.
92
- allow(@include_pathinator).to receive(:ordered_header_files).and_return( [] )
91
+ # Harmless default -- individual examples needing a specific header search stub this
92
+ # again with a narrower `.with(...)` match.
93
+ @header_search = HeaderSearch.new( [], ->(_dir) { [] } )
94
+ allow(@include_pathinator).to receive(:header_search).and_return( @header_search )
93
95
 
94
96
  # Search path defaults, so tests of a reconciling first pass, which rebuilds a test's
95
97
  # search paths, need not know every source those paths draw on
@@ -101,15 +103,15 @@ describe TestIncludesExtractinator do
101
103
  allow(@configurator).to receive(:collection_paths_vendor).and_return( [] )
102
104
  allow(@configurator).to receive(:collection_paths_test_toolchain_include).and_return( [] )
103
105
 
104
- @mock_locator = MockLocator.new(
105
- configurator: @configurator, include_pathinator: @include_pathinator, file_finder: @file_finder, file_path_utils: @file_path_utils
106
- )
107
-
108
106
  # The stage's passes and collaborators are real, over the same doubles, so these
109
107
  # examples cover the whole stage and read as paths and files
110
108
  search_paths = TestSearchPaths.new(
111
109
  configurator: @configurator, include_pathinator: @include_pathinator, test_context_extractor: @test_context_extractor
112
110
  )
111
+ @mock_locator = MockLocator.new(
112
+ configurator: @configurator, include_pathinator: @include_pathinator, test_search_paths: search_paths,
113
+ file_finder: @file_finder, file_path_utils: @file_path_utils
114
+ )
113
115
  standins = StandinHeaderinator.new(
114
116
  configurator: @configurator, loginator: @loginator, reportinator: @reportinator,
115
117
  file_wrapper: @file_wrapper, file_path_utils: @file_path_utils, mock_locator: @mock_locator
@@ -118,7 +120,8 @@ describe TestIncludesExtractinator do
118
120
 
119
121
  @extractinator = described_class.new(
120
122
  test_bare_includes_extractinator: TestBareIncludesExtractinator.new(
121
- **common, file_path_utils: @file_path_utils, dependinator: @dependinator, test_search_paths: search_paths, standin_headerinator: standins
123
+ **common, file_path_utils: @file_path_utils, dependinator: @dependinator, test_search_paths: search_paths, standin_headerinator: standins,
124
+ mock_locator: @mock_locator
122
125
  ),
123
126
  test_includes_preprocessinator: TestIncludesPreprocessinator.new(
124
127
  **common, file_path_utils: @file_path_utils, file_wrapper: @file_wrapper, dependinator: @dependinator
@@ -420,6 +423,51 @@ describe TestIncludesExtractinator do
420
423
 
421
424
  @extractinator.stage_collect_preprocessor_context( @state )
422
425
  end
426
+
427
+ # GCC lists an #include as written. The text scan anchors a climbing one to the test
428
+ # file's directory, and stages 5 and 10 find and place its mock by that text.
429
+ it "places a climbing mock's stand-in by its #include anchored to the test file's directory, keeping the list as written" do
430
+ allow(@dependinator).to receive(:stale?).and_return( true )
431
+ allow(@preprocessinator).to receive(:preprocess_bare_includes).and_return( [ Include.new('../x/MockFoo.h') ] )
432
+
433
+ expect(@file_finder).to receive(:resolve_mock).with( 'x/MockFoo.h', collection: anything, complain: anything ).and_return( ['inc/x/foo.h', 'x'] )
434
+ expect(@file_wrapper).to receive(:write).with( 'build/test/mocks/a_test/x/MockFoo.h', anything )
435
+
436
+ @extractinator.stage_collect_preprocessor_context( @state )
437
+
438
+ expect(@testable.preprocess[:includes].map(&:filepath)).to eq( ['../x/MockFoo.h'] )
439
+ end
440
+
441
+ # One header's mock named two ways would become two mocks that can't both link. The
442
+ # #include with the most path stays, as stage 2 keeps it, and the cache keeps GCC's list.
443
+ it "keeps one mock per real header on the bare list and its candidates" do
444
+ allow(@dependinator).to receive(:stale?).and_return( true )
445
+ allow(@preprocessinator).to receive(:preprocess_bare_includes).and_return( [ Include.new('MockFoo.h'), Include.new('drivers/MockFoo.h') ] )
446
+ allow(@file_finder).to receive(:resolve_mock).and_return( ['src/drivers/foo.h', 'drivers'] )
447
+
448
+ expect(@preprocessinator).to receive(:store_includes_list)
449
+ .with( hash_including( includes: satisfy { |list| list.map(&:filepath) == ['MockFoo.h', 'drivers/MockFoo.h'] } ) )
450
+ expect(@file_wrapper).to receive(:write).with( 'build/test/mocks/a_test/drivers/MockFoo.h', anything ).at_least( :once )
451
+
452
+ @extractinator.stage_collect_preprocessor_context( @state )
453
+
454
+ expect(@testable.preprocess[:includes].map(&:filepath)).to eq( ['drivers/MockFoo.h'] )
455
+ expect(@testable.preprocess[:candidates].map(&:filepath)).to eq( ['drivers/MockFoo.h'] )
456
+ end
457
+
458
+ # The test file still names the mock both ways, and pass 2 must reach a file for each
459
+ it "places a stand-in for every spelling of one header's mock, keeping one on the lists" do
460
+ allow(@dependinator).to receive(:stale?).and_return( true )
461
+ allow(@preprocessinator).to receive(:preprocess_bare_includes).and_return( [ Include.new('drivers/MockFoo.h'), Include.new('src/drivers/MockFoo.h') ] )
462
+ allow(@file_finder).to receive(:resolve_mock).and_return( ['src/drivers/foo.h', 'drivers'] )
463
+
464
+ expect(@file_wrapper).to receive(:write).with( 'build/test/mocks/a_test/drivers/MockFoo.h', anything )
465
+ expect(@file_wrapper).to receive(:write).with( 'build/test/mocks/a_test/src/drivers/MockFoo.h', anything )
466
+
467
+ @extractinator.stage_collect_preprocessor_context( @state )
468
+
469
+ expect(@testable.preprocess[:includes].map(&:filepath)).to eq( ['src/drivers/MockFoo.h'] )
470
+ end
423
471
  end
424
472
  end
425
473
 
@@ -17,12 +17,29 @@ describe 'Test pipeline object wiring' do
17
17
 
18
18
  %w[
19
19
  test_invoker test_pipeline_manager test_build_setup test_includes_extractinator test_bare_includes_extractinator
20
- test_includes_preprocessinator test_includes_reconcilinator test_build_planner partials_manager
20
+ test_includes_preprocessinator test_includes_reconcilinator test_build_planner partial_files_preprocessinator partials_manager
21
21
  test_build_executor test_file_preprocessinator test_runner_generatinator test_search_paths mock_locator
22
- standin_headerinator test_source_file_directive_resolver
22
+ standin_headerinator test_source_file_directive_resolver test_substitutions
23
23
  ].map { |name| [name, "ceedling/test_invoker/#{name}"] }.concat( [
24
24
  ['build_log_writer', 'ceedling/build_log_writer'],
25
- ['generator_test_results_backtrace', 'ceedling/generators/generator_test_results_backtrace']
25
+ ['generator_test_results_backtrace', 'ceedling/generators/generator_test_results_backtrace'],
26
+ ['build_step_doctor', 'ceedling/diagnostics/build_step_doctor'],
27
+ ['header_collision_specialist', 'ceedling/diagnostics/header_collision_specialist'],
28
+ ['missing_symbol_specialist', 'ceedling/diagnostics/missing_symbol_specialist'],
29
+ ['duplicate_symbol_specialist', 'ceedling/diagnostics/duplicate_symbol_specialist'],
30
+ ['partial_name_specialist', 'ceedling/diagnostics/partial_name_specialist'],
31
+ ['include_depth_specialist', 'ceedling/diagnostics/include_depth_specialist'],
32
+ ['preprocessinator_file_assembler', 'ceedling/preprocess/preprocessinator_file_assembler'],
33
+ ['partializer', 'ceedling/partials/partializer'],
34
+ ['partializer_helper', 'ceedling/partials/partializer_helper'],
35
+ ['partializer_reconciler', 'ceedling/partials/partializer_reconciler'],
36
+ ['partializer_utils', 'ceedling/partials/partializer_utils'],
37
+ ['generator_partials', 'ceedling/generators/generator_partials'],
38
+ ['test_build_layout', 'ceedling/filesystem/test_build_layout'],
39
+ ['dependinator', 'ceedling/dependencies/dependinator'],
40
+ ['file_path_utils', 'ceedling/filesystem/file_path_utils'],
41
+ ['file_finder', 'ceedling/filesystem/file_finder'],
42
+ ['include_factory', 'ceedling/includes/include_factory']
26
43
  ] ).each do |name, path|
27
44
  it "composes exactly what #{name}'s constructor takes" do
28
45
  require path
@@ -0,0 +1,264 @@
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/test_invoker/partial_files_preprocessinator'
10
+ require 'ceedling/test_invoker/test_invoker_types'
11
+ require 'ceedling/partials/partials'
12
+
13
+ describe PartialFilesPreprocessinator do
14
+ let(:target) { 'build/preprocess/files/a_test/src/Foo.h' }
15
+ let(:raw_directives) { 'build/preprocess/files/a_test/directives_only/raw/src/Foo.h' }
16
+ let(:raw_expansion) { 'build/preprocess/files/a_test/full_expansion/src/Foo.h' }
17
+ let(:expanded_code) { 'build/preprocess/files/a_test/expanded_code/src/Foo.h' }
18
+ let(:includes_list) { 'build/preprocess/includes/a_test/src/Foo.h.yml' }
19
+
20
+ before(:each) do
21
+ @configurator = double( 'Configurator' )
22
+ @loginator = double( 'Loginator' )
23
+ @reportinator = double( 'Reportinator' )
24
+ @batchinator = double( 'Batchinator' )
25
+ @preprocessinator = double( 'Preprocessinator' )
26
+ @file_path_utils = double( 'FilePathUtils' )
27
+ @file_wrapper = double( 'FileWrapper' )
28
+ @dependinator = double( 'Dependinator' )
29
+
30
+ @tools = { directives_only: { name: 'directives-only' }, bare: { name: 'bare' }, full: { name: 'full' } }
31
+ allow(@configurator).to receive(:tools_test_file_directives_only_preprocessor).and_return( @tools[:directives_only] )
32
+ allow(@configurator).to receive(:tools_test_bare_includes_preprocessor).and_return( @tools[:bare] )
33
+ allow(@configurator).to receive(:tools_test_file_full_preprocessor).and_return( @tools[:full] )
34
+ allow(@configurator).to receive(:test_build_preprocess_force_fallback).and_return( false )
35
+ allow(@configurator).to receive(:get_partials_config).and_return( { max_extraction_length: 5000 } )
36
+ allow(@configurator).to receive(:project_build_vendor_ceedling_path).and_return( 'build/vendor/ceedling' )
37
+ allow(@configurator).to receive(:project_build_root).and_return( 'build' )
38
+ allow(@configurator).to receive(:test_build_preprocess_directives_only_available).and_return( true )
39
+
40
+ allow(@reportinator).to receive(:generate_module_progress) { |operation:, module_name:, filename:| "#{operation} #{module_name}::#{filename}" }
41
+ allow(@reportinator).to receive(:generate_skip_summary).and_return( nil )
42
+ allow(@loginator).to receive(:log)
43
+
44
+ allow(@batchinator).to receive(:exec) { |things:, **, &block| things.each { |thing| block.call( thing ) } }
45
+
46
+ allow(@file_path_utils).to receive(:form_preprocessed_file_filepath).and_return( target )
47
+ allow(@file_path_utils).to receive(:form_preprocessed_file_raw_directives_only_filepath).and_return( raw_directives )
48
+ allow(@file_path_utils).to receive(:form_preprocessed_file_full_expansion_filepath).and_return( raw_expansion )
49
+ allow(@file_path_utils).to receive(:form_preprocessed_file_expanded_code_filepath).and_return( expanded_code )
50
+ allow(@file_path_utils).to receive(:form_preprocessed_includes_list_filepath).and_return( includes_list )
51
+
52
+ # Files on disk, by path. An example adds what an earlier run would have left.
53
+ @on_disk = []
54
+ allow(@file_wrapper).to receive(:exist?) { |path| @on_disk.include?( path ) }
55
+ allow(@file_wrapper).to receive(:rm_f)
56
+
57
+ allow(@dependinator).to receive(:register)
58
+ allow(@dependinator).to receive(:stale?).and_return( true )
59
+ allow(@dependinator).to receive(:mark_fresh)
60
+
61
+ @includes = [double( 'Include' )]
62
+ allow(@preprocessinator).to receive(:generate_directives_only_output).and_return( raw_directives )
63
+ allow(@preprocessinator).to receive(:preprocess_partial_file).and_return( [target, @includes] )
64
+ allow(@preprocessinator).to receive(:generate_partial_expansion).and_return( expanded_code )
65
+ allow(@preprocessinator).to receive(:load_includes_list).and_return( @includes )
66
+ allow(@preprocessinator).to receive(:preprocessed_dependencies).and_return( ['src/Foo.h', 'src/config.h', 'build/standins/a.h'] )
67
+
68
+ @testable = TestInvokerTypes::Testable.new(
69
+ name: 'a_test', preprocess_flags: ['-Wall'], preprocess_defines: ['TEST'], search_paths: ['src']
70
+ )
71
+ @config = Partials::ConfigFileInfo.new( filepath: 'src/Foo.h' )
72
+ @state = TestInvokerTypes::PipelineState.new(
73
+ testables: { a_test: @testable }, partials_headers: [TestInvokerTypes::PartialWork.new( config: @config, testable: @testable )],
74
+ partials_sources: [], context: :test, options: [], lock: Mutex.new
75
+ )
76
+
77
+ @preprocessinator_object = described_class.new(
78
+ configurator: @configurator, loginator: @loginator, reportinator: @reportinator, batchinator: @batchinator,
79
+ preprocessinator: @preprocessinator, file_path_utils: @file_path_utils, file_wrapper: @file_wrapper,
80
+ dependinator: @dependinator
81
+ )
82
+ end
83
+
84
+ def preprocess_headers
85
+ @preprocessinator_object.preprocess_headers( @state )
86
+ end
87
+
88
+ it 'registers the assembled copy as the target, with the file and every setting that shapes the runs' do
89
+ expect(@dependinator).to receive(:register).with(
90
+ target,
91
+ files: ['src/Foo.h'],
92
+ meta: {
93
+ flags: ['-Wall'], defines: ['TEST'], search_paths: ['src'],
94
+ tools: [@tools[:directives_only], @tools[:bare], @tools[:full]], preprocess_force_fallback: false,
95
+ partials: { max_extraction_length: 5000 }
96
+ }
97
+ )
98
+
99
+ preprocess_headers()
100
+ end
101
+
102
+ # The previous run's expansion names every header it entered. Files below the build root
103
+ # derive from project files and would only ever look changed.
104
+ it 'depends, before checking staleness, on the project headers the previous expansion entered' do
105
+ @on_disk << raw_expansion
106
+
107
+ expect(@preprocessinator).to receive(:preprocessed_dependencies).with( preprocessed_filepath: raw_expansion ).ordered.and_return( ['src/Foo.h', 'src/config.h', 'build/standins/a.h'] )
108
+ expect(@dependinator).to receive(:register).with( target, files: ['src/Foo.h', 'src/config.h'] ).ordered
109
+ expect(@dependinator).to receive(:stale?).with( target ).ordered.and_return( false )
110
+ @on_disk << expanded_code
111
+
112
+ preprocess_headers()
113
+ end
114
+
115
+ it 'reads no dependencies before the first run, when no expansion exists' do
116
+ expect(@preprocessinator).to receive(:preprocessed_dependencies).once
117
+
118
+ preprocess_headers()
119
+ end
120
+
121
+ context 'when stale' do
122
+ it 'runs directives-only, then assembly with the raw output, then the full expansion, and marks the target fresh last' do
123
+ expect(@preprocessinator).to receive(:generate_directives_only_output).with(
124
+ filepath: 'src/Foo.h', test: 'a_test', flags: ['-Wall'], include_paths: ['src'], vendor_paths: ['build/vendor/ceedling'], defines: ['TEST']
125
+ ).ordered
126
+ expect(@preprocessinator).to receive(:preprocess_partial_file).with(
127
+ kind: :header, directives_only_filepath: raw_directives, fallback: false, filepath: 'src/Foo.h', test: 'a_test',
128
+ flags: ['-Wall'], include_paths: ['src'], vendor_paths: ['build/vendor/ceedling'], defines: ['TEST']
129
+ ).ordered
130
+ expect(@preprocessinator).to receive(:generate_partial_expansion).ordered
131
+ expect(@dependinator).to receive(:mark_fresh).with( target ).ordered
132
+
133
+ preprocess_headers()
134
+ end
135
+
136
+ it 'fills in the record with every file the run wrote' do
137
+ preprocess_headers()
138
+
139
+ expect(@config).to have_attributes(
140
+ raw_directives_only_filepath: raw_directives, fallback: false, assembled_filepath: target, includes: @includes,
141
+ raw_expansion_filepath: raw_expansion, expansion_filepath: expanded_code
142
+ )
143
+ end
144
+
145
+ # A missing or edited output then makes the next run stale
146
+ it 'registers every file a later build trusts as an output, and the expansion\'s headers as dependencies, before marking fresh' do
147
+ expect(@dependinator).to receive(:register).with( target, outputs: [includes_list, raw_directives, raw_expansion, expanded_code] ).ordered
148
+ expect(@dependinator).to receive(:register).with( target, files: ['src/Foo.h', 'src/config.h'] ).ordered
149
+ expect(@dependinator).to receive(:mark_fresh).with( target ).ordered
150
+
151
+ preprocess_headers()
152
+ end
153
+
154
+ it 'assembles from the file\'s own text, without a directives-only run, when the toolchain lacks -fdirectives-only' do
155
+ allow(@configurator).to receive(:test_build_preprocess_directives_only_available).and_return( false )
156
+
157
+ expect(@preprocessinator).to_not receive(:generate_directives_only_output)
158
+ expect(@preprocessinator).to receive(:preprocess_partial_file).with( hash_including( directives_only_filepath: nil, fallback: true ) )
159
+ expect(@dependinator).to receive(:register).with( target, outputs: [includes_list, raw_expansion, expanded_code] )
160
+
161
+ preprocess_headers()
162
+
163
+ expect(@config).to have_attributes( raw_directives_only_filepath: nil, fallback: true )
164
+ end
165
+
166
+ # A raw copy on disk then always means the file was preprocessed accurately
167
+ it 'falls back for this file alone, and removes an earlier raw copy, when its directives-only run fails' do
168
+ allow(@preprocessinator).to receive(:generate_directives_only_output).and_return( nil )
169
+
170
+ expect(@file_wrapper).to receive(:rm_f).with( raw_directives )
171
+ expect(@preprocessinator).to receive(:preprocess_partial_file).with( hash_including( directives_only_filepath: nil, fallback: true ) )
172
+
173
+ preprocess_headers()
174
+
175
+ expect(@config).to have_attributes( raw_directives_only_filepath: nil, fallback: true )
176
+ end
177
+
178
+ # A fresh record would vouch for a run that failed
179
+ it 'leaves the target stale, so the next run tries again, when the full expansion fails' do
180
+ allow(@preprocessinator).to receive(:generate_partial_expansion).and_return( nil )
181
+
182
+ expect(@dependinator).to_not receive(:mark_fresh)
183
+
184
+ preprocess_headers()
185
+
186
+ expect(@config).to have_attributes( expansion_filepath: nil, raw_expansion_filepath: nil )
187
+ end
188
+
189
+ it 'logs the file it preprocesses at normal verbosity' do
190
+ expect(@loginator).to receive(:log).with( 'Preprocessing partial header for a_test::Foo.h', Verbosity::NORMAL )
191
+
192
+ preprocess_headers()
193
+ end
194
+ end
195
+
196
+ context 'when fresh' do
197
+ before(:each) do
198
+ allow(@dependinator).to receive(:stale?).and_return( false )
199
+ @on_disk.push( raw_directives, raw_expansion, expanded_code )
200
+ end
201
+
202
+ it 'runs nothing and rebuilds the record from the files the last run left' do
203
+ expect(@preprocessinator).to_not receive(:generate_directives_only_output)
204
+ expect(@preprocessinator).to_not receive(:preprocess_partial_file)
205
+ expect(@preprocessinator).to_not receive(:generate_partial_expansion)
206
+ expect(@dependinator).to_not receive(:mark_fresh)
207
+
208
+ preprocess_headers()
209
+
210
+ expect(@preprocessinator).to have_received(:load_includes_list).with( test: 'a_test', filepath: 'src/Foo.h' )
211
+ expect(@config).to have_attributes(
212
+ raw_directives_only_filepath: raw_directives, fallback: false, assembled_filepath: target, includes: @includes,
213
+ raw_expansion_filepath: raw_expansion, expansion_filepath: expanded_code
214
+ )
215
+ end
216
+
217
+ it 'recalls a file the last run preprocessed in fallback, which left no raw copy' do
218
+ @on_disk.delete( raw_directives )
219
+
220
+ preprocess_headers()
221
+
222
+ expect(@config).to have_attributes( raw_directives_only_filepath: nil, fallback: true )
223
+ end
224
+
225
+ # The record describes what the last run made, not what this run's toolchain could make
226
+ it 'recalls a file the last run preprocessed accurately when this run lacks -fdirectives-only' do
227
+ allow(@configurator).to receive(:test_build_preprocess_directives_only_available).and_return( false )
228
+
229
+ preprocess_headers()
230
+
231
+ expect(@config).to have_attributes( raw_directives_only_filepath: raw_directives, fallback: false )
232
+ end
233
+
234
+ # Reconciliation needs the expanded code, and the target's record can predate it
235
+ it 'reruns a target whose expanded code is missing' do
236
+ @on_disk.delete( expanded_code )
237
+
238
+ expect(@preprocessinator).to receive(:generate_partial_expansion)
239
+ expect(@dependinator).to receive(:mark_fresh).with( target )
240
+
241
+ preprocess_headers()
242
+ end
243
+
244
+ it 'logs the skip at obnoxious verbosity and counts it in the summary' do
245
+ expect(@loginator).to receive(:log).with( 'Skipping partial header preprocessing for a_test::Foo.h', Verbosity::OBNOXIOUS )
246
+ expect(@reportinator).to receive(:generate_skip_summary).with(
247
+ task: 'partial header preprocessing', count: 1, noun: 'headers', reason: 'nothing changed'
248
+ )
249
+
250
+ preprocess_headers()
251
+ end
252
+ end
253
+
254
+ it 'preprocesses stage 7\'s sources as sources' do
255
+ source = Partials::ConfigFileInfo.new( filepath: 'src/Foo.c' )
256
+ @state.partials_headers = []
257
+ @state.partials_sources = [TestInvokerTypes::PartialWork.new( config: source, testable: @testable )]
258
+
259
+ expect(@preprocessinator).to receive(:preprocess_partial_file).with( hash_including( kind: :source, filepath: 'src/Foo.c' ) )
260
+ expect(@reportinator).to receive(:generate_skip_summary).with( hash_including( task: 'partial source preprocessing', noun: 'sources' ) )
261
+
262
+ @preprocessinator_object.preprocess_sources( @state )
263
+ end
264
+ end