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
@@ -17,54 +17,29 @@ class PartialsManager
17
17
  :loginator,
18
18
  :reportinator,
19
19
  :batchinator,
20
- :preprocessinator,
21
20
  :partializer,
22
21
  :generator,
23
22
  :dependinator,
24
- :file_path_utils
23
+ :file_path_utils,
24
+ :file_wrapper,
25
+ :mock_locator
25
26
  )
26
27
 
27
- # Stage 6: Preprocess partial header files for extract-and-generate pass.
28
- def stage_preprocess_partial_headers(state)
29
- preprocess_partials(
30
- items: state.partials_headers,
31
- kind: 'header',
32
- noun: 'headers',
33
- preserve_macros_method: :preprocess_partial_header_file_preserve_macros,
34
- expand_macros_method: :preprocess_partial_header_expand_macros
35
- )
36
- end
37
-
38
- # Stage 7: Preprocess partial source files for extract-and-generate pass.
39
- def stage_preprocess_partial_sources(state)
40
- preprocess_partials(
41
- items: state.partials_sources,
42
- kind: 'source',
43
- noun: 'sources',
44
- preserve_macros_method: :preprocess_partial_source_file_preserve_macros,
45
- expand_macros_method: :preprocess_partial_source_expand_macros
46
- )
47
- end
48
-
49
28
  # Stage 8: Extract and generate partial implementation and interface files.
50
29
  #
51
- # Extraction and validation below always run in full, for every partial, every
52
- # invocation -- pure in-memory C parsing from whatever `config` already holds,
53
- # cheap regardless of whether stages 6/7 did real preprocessing work or recalled
54
- # it. `testable.partials.tests`/`.mocks` are rebuilt from that in-memory result
55
- # every run too, since stage 14 reads those lists to decide compile sources
56
- # regardless of whether anything on disk actually changed.
30
+ # A Partial whose implementation and interface are fresh is passed over without extraction.
31
+ # Its staleness record depends on nothing extraction finds, so it is checked first. Each of
32
+ # those two files vouches for the types header it includes. A Partial passed over still
33
+ # joins its test's `testable.partials.tests`/`.mocks` lists. Stage 14 reads `.tests` to decide
34
+ # compile sources.
57
35
  #
58
- # The three disk writes below -- types header, implementation, interface -- are
59
- # each independently optional (a module with no type/aggregate defs never gets
60
- # a types header at all; implementation/interface are separately gated on
61
- # extraction succeeding) and each gets its own DependencyTracker target rather
62
- # than one combined target the way stage 6's three preprocessing passes share
63
- # one: a target that's sometimes legitimately never written would never read
64
- # back as fresh.
36
+ # Any other Partial is extracted and validated in full, and each file it generates is
37
+ # written only where stale. Each of the three files is optional. A module with no types gets
38
+ # no types header, and the implementation and interface each follow one side of the
39
+ # selection. So each file has its own DependencyTracker target. One target shared by all
40
+ # three, as stage 6's preprocessing passes share one, would never read back as fresh when a
41
+ # file is legitimately never written.
65
42
  def stage_generate_partials(state)
66
- directives_only = @configurator.test_build_preprocess_directives_only_available
67
-
68
43
  partials = []
69
44
  state.testables.each do |_, testable|
70
45
  next if testable.partials.configs.empty?
@@ -73,46 +48,32 @@ class PartialsManager
73
48
  end
74
49
  end
75
50
 
76
- skipped_types = 0
77
- skipped_impl = 0
78
- skipped_interface = 0
51
+ # How many of each kind of generated file were fresh and so left alone
52
+ skipped = Hash.new( 0 )
53
+
54
+ # Each test's search, built before the batch, which shares it between that test's Partials
55
+ searches = partials.map { |partial| partial[:testable] }.uniq.to_h { |testable| [testable.name, @mock_locator.header_search( testable )] }
79
56
 
80
57
  @batchinator.exec(workload: :compile, things: partials) do |partial|
81
58
  config = partial[:config]
82
59
  testable = partial[:testable]
83
60
  name = testable.name
84
61
 
85
- module_contents = @partializer.extract_module_contents(
86
- name,
87
- config,
88
- fallback: !directives_only
89
- )
90
-
91
- @partializer.validate_config(
92
- c_module: module_contents, config: config, name: name, fallback: !directives_only
93
- )
94
-
95
- @partializer.sanitize( module_contents )
96
-
97
- # Antecedents mirror stages 6/7's own targets for this same module's header/source --
98
- # Partial generation's actual inputs (the preprocessed content those stages produce or
99
- # recall) are already fully covered by the same file+flags/defines/search_paths.
100
- # A declaration-only Partial (a prototype with no matching definition) has no source
101
- # file to find, leaving config.source.filepath legitimately nil -- compact it out
102
- # before it reaches path normalization, which expects real paths only.
103
- antecedent_files = [config.header.filepath, config.source.filepath].compact
104
-
105
- # The real header's guard is spoofed deliberately in every generated file, and the types
106
- # header carries the dependencies its extracted types name. Both are inputs to generation,
107
- # so both ride in the staleness meta below -- a changed guard or a changed include list
108
- # has to invalidate what was generated from the previous ones.
62
+ # Every input generation reads rides in the staleness record below, so a change to any of
63
+ # them regenerates what the previous ones produced:
64
+ # - The preprocessed copies stages 6/7 wrote, beside the originals. Generation reads the
65
+ # copies, so whatever rewrites them without touching the originals reaches this stage
66
+ # through them, as toggling forced fallback or changing the preprocessor does.
67
+ # - The test's selection, which decides what each generated file holds.
68
+ # - The real header's guard, spoofed deliberately in every generated file.
69
+ # - Each generated file's includes, which depend on the test's other Partial modules
70
+ # and how each is selected. The record's lists leave out the types header, since the
71
+ # module files the record holds decide whether one exists.
72
+ antecedent_files = partial_antecedent_files( config )
109
73
  module_include_guard = @partializer.extract_module_include_guard( config.header.filepath )
110
- types_header_includes = @partializer.remap_types_header_includes(
111
- name: config.module,
112
- includes: (config.source.includes + config.header.includes),
113
- partials: testable.partials.configs,
114
- test: name
115
- )
74
+ # Generation's lists are the ones logged, so the record's are computed without a test name
75
+ spelled = spell_partial_includes( config, searches[name] )
76
+ record_includes = remap_partial_includes( config, testable.partials.configs, nil, nil, spelled )
116
77
 
117
78
  antecedent_meta = {
118
79
  flags: testable.preprocess_flags,
@@ -122,43 +83,55 @@ class PartialsManager
122
83
  # so there's nothing to add here beyond the whole :partials config.
123
84
  tools: [],
124
85
  partials: @configurator.get_partials_config,
86
+ selection: { tests: config.tests.to_h, mocks: config.mocks.to_h },
125
87
  include_guard: module_include_guard,
126
- types_includes: types_header_includes.map( &:to_s )
88
+ types_includes: record_includes[:types].to_record,
89
+ impl_header_includes: record_includes[:impl_header].to_record,
90
+ impl_source_includes: record_includes[:impl_source].map( &:to_s ),
91
+ interface_includes: record_includes[:interface].to_record
127
92
  }
128
93
 
94
+ record = { files: antecedent_files, meta: antecedent_meta, name: name, partial: config.module }
95
+ paths = partial_paths( config, testable )
96
+
97
+ fresh = fresh_targets( config, paths, record )
98
+ if fresh
99
+ skip_fresh_partial( state, testable, config, fresh, skipped )
100
+ next
101
+ end
102
+
103
+ module_contents = @partializer.extract_module_contents( name, config )
104
+ @partializer.validate_config( c_module: module_contents, config: config, name: name )
105
+
106
+ @partializer.sanitize( module_contents, include_guard: module_include_guard )
107
+
129
108
  # Generated once and shared by the implementation and interface headers below (via
130
109
  # their own includes lists), so a module tested and mocked in the same test file gets
131
- # exactly one C definition of each of its typedefs and aggregate types. Nothing to
132
- # write (and therefore nothing to track) when the module has no typedefs or aggregate
133
- # definitions -- recompute the bare filename the same deterministic way
134
- # GeneratorPartials#generate_types would have, purely so the includes-remapping below
135
- # still knows what to #include.
136
- types_header = nil
137
- if !module_contents.type_definitions.empty? || !module_contents.aggregate_definitions.empty?
138
- types_header = @file_path_utils.form_partial_types_header_filename( config.module )
139
- target = File.join( testable.paths[:partials], types_header )
140
-
141
- @dependinator.register( target, files: antecedent_files, meta: antecedent_meta )
142
-
143
- if @dependinator.stale?( target )
110
+ # exactly one C definition of each of its typedefs and aggregate types. A module with no
111
+ # typedefs or aggregate definitions gets none, and one an earlier build left is removed.
112
+ # The filename is computed the same deterministic way GeneratorPartials#generate_types
113
+ # computes it, so the includes remapping below knows what to #include.
114
+ types_header = module_contents.types? ? @file_path_utils.form_partial_types_header_filename( config.module ) : nil
115
+ discard_leftover_types( paths[:types] ) if types_header.nil?
116
+
117
+ includes = remap_partial_includes( config, testable.partials.configs, types_header, name, spelled )
118
+
119
+ # The implementation and interface include the types header, so each vouches for it
120
+ types_target = types_header && paths[:types]
121
+
122
+ if types_header
123
+ unchanged = generate_when_stale( target: types_target, kind: :types, **record ) do
144
124
  @generator.generate_partial_types(
145
125
  name: name,
146
126
  partial: config.module,
147
127
  c_module: module_contents,
148
- output_path: testable.paths[:partials],
149
- includes: types_header_includes,
150
- include_guard: module_include_guard
151
- )
152
- @dependinator.mark_fresh( target )
153
- else
154
- msg = @reportinator.generate_module_progress(
155
- operation: 'Skipping Partial types generation for',
156
- module_name: name,
157
- filename: config.module
128
+ output_path: testable.paths[:partials],
129
+ includes: includes[:types].leading,
130
+ following_includes: includes[:types].following,
131
+ include_guard: module_include_guard
158
132
  )
159
- @loginator.log( msg, Verbosity::OBNOXIOUS )
160
- state.lock.synchronize { skipped_types += 1 }
161
133
  end
134
+ state.lock.synchronize { skipped[:types] += 1 } if unchanged
162
135
  end
163
136
 
164
137
  implementation = @partializer.extract_implementation_functions(
@@ -183,255 +156,239 @@ class PartialsManager
183
156
  interface: interface
184
157
  )
185
158
 
186
- arg_hash = {
187
- test: name,
188
- partial: config.module,
189
- function_definitions: implementation,
190
- c_module: module_contents,
191
- header_includes: @partializer.remap_implementation_header_includes(
192
- name: config.module,
193
- includes: (config.source.includes + config.header.includes),
194
- partials: testable.partials.configs,
195
- types_header: types_header,
196
- test: name
197
- ),
198
- source_includes: @partializer.remap_implementation_source_includes(
199
- name: config.module,
200
- includes: (config.source.includes + config.header.includes),
201
- partials: testable.partials.configs,
202
- test: name
203
- ),
204
- input_filepath: config.source.filepath,
205
- output_path: testable.paths[:partials],
206
- include_guard: module_include_guard
207
- }
208
-
209
159
  unless implementation.nil?
210
160
  # The same call writes a header alongside the source, so the source vouches for it
211
161
  # as an output. A modified or deleted header then regenerates both.
212
- target = File.join( testable.paths[:partials], @file_path_utils.form_partial_implementation_source_filename( config.module ) )
213
- header_target = File.join( testable.paths[:partials], @file_path_utils.form_partial_implementation_header_filename( config.module ) )
214
-
215
- @dependinator.register( target, files: antecedent_files, meta: antecedent_meta, outputs: [header_target] )
216
-
217
- if @dependinator.stale?( target )
218
- @generator.generate_partial_implementation( **arg_hash )
219
- @dependinator.mark_fresh( target )
220
- else
221
- msg = @reportinator.generate_module_progress(
222
- operation: 'Skipping Partial implementation generation for',
223
- module_name: name,
224
- filename: config.module
162
+ outputs = [paths[:impl_header], types_target].compact
163
+ unchanged = generate_when_stale( target: paths[:implementation], outputs: outputs, kind: :implementation, **record ) do
164
+ # What the implementation source carries beyond the selection. Planned only when the
165
+ # source regenerates, so its notices appear with that build.
166
+ carry = @partializer.plan_carry(
167
+ test: name, c_module: module_contents, impl: implementation, interface: interface,
168
+ header_guarded: !module_include_guard.nil?, config: config
169
+ )
170
+
171
+ @generator.generate_partial_implementation(
172
+ test: name,
173
+ partial: config.module,
174
+ function_definitions: implementation,
175
+ c_module: module_contents,
176
+ header_includes: includes[:impl_header].leading,
177
+ header_following_includes: includes[:impl_header].following,
178
+ source_includes: includes[:impl_source],
179
+ output_path: testable.paths[:partials],
180
+ include_guard: module_include_guard,
181
+ carry: carry,
182
+ suppress_redundant_decls: @configurator.partials_suppress_redundant_decls,
183
+ extern_variables: @configurator.partials_extern_variables
225
184
  )
226
- @loginator.log( msg, Verbosity::OBNOXIOUS )
227
- state.lock.synchronize { skipped_impl += 1 }
228
185
  end
229
186
 
230
- state.lock.synchronize { testable.partials.tests << config.module }
187
+ state.lock.synchronize do
188
+ skipped[:implementation] += 1 if unchanged
189
+ testable.partials.tests << config.module
190
+ end
231
191
  end
232
192
 
233
- arg_hash = {
234
- test: name,
235
- partial: config.module,
236
- function_declarations: interface,
237
- includes: @partializer.remap_interface_header_includes(
238
- name: config.module,
239
- includes: (config.source.includes + config.header.includes),
240
- partials: testable.partials.configs,
241
- types_header: types_header,
242
- test: name
243
- ),
244
- c_module: module_contents,
245
- input_filepath: config.header.filepath,
246
- output_path: testable.paths[:partials],
247
- include_guard: module_include_guard
248
- }
249
-
250
193
  unless interface.nil?
251
- target = File.join( testable.paths[:partials], @file_path_utils.form_partial_interface_header_filename( config.module ) )
252
-
253
- @dependinator.register( target, files: antecedent_files, meta: antecedent_meta )
254
-
255
- if @dependinator.stale?( target )
256
- @generator.generate_partial_interface( **arg_hash )
257
- @dependinator.mark_fresh( target )
258
- else
259
- msg = @reportinator.generate_module_progress(
260
- operation: 'Skipping Partial interface generation for',
261
- module_name: name,
262
- filename: config.module
194
+ extras = implementation.nil? ? plan_extras( name, config, module_contents, interface, module_include_guard ) : nil
195
+ explain_tested_mock( testable, config, module_contents, interface, module_include_guard ) unless implementation.nil?
196
+ extras_target = (extras.nil? or extras.empty?) ? nil : paths[:extras]
197
+ discard_leftover_extras( paths[:extras] ) if extras_target.nil?
198
+
199
+ outputs = [types_target, extras_target].compact
200
+ unchanged = generate_when_stale( target: paths[:interface], outputs: outputs, kind: :interface, **record ) do
201
+ @generator.generate_partial_interface(
202
+ test: name,
203
+ partial: config.module,
204
+ function_declarations: interface,
205
+ includes: includes[:interface].leading,
206
+ following_includes: includes[:interface].following,
207
+ c_module: module_contents,
208
+ output_path: testable.paths[:partials],
209
+ include_guard: module_include_guard,
210
+ extras: extras
263
211
  )
264
- @loginator.log( msg, Verbosity::OBNOXIOUS )
265
- state.lock.synchronize { skipped_interface += 1 }
266
212
  end
267
213
 
268
- state.lock.synchronize { testable.partials.mocks << config.module }
214
+ state.lock.synchronize do
215
+ skipped[:interface] += 1 if unchanged
216
+ testable.partials.mocks << config.module
217
+ end
269
218
  end
270
219
  end
271
220
 
272
221
  order_partials( partials.map { |partial| partial[:testable] }.uniq )
273
222
 
274
- log_skip_summary( task: "Partial types generation", count: skipped_types, noun: "types headers" )
275
- log_skip_summary( task: "Partial implementation generation", count: skipped_impl, noun: "implementations" )
276
- log_skip_summary( task: "Partial interface generation", count: skipped_interface, noun: "interfaces" )
223
+ log_skip_summary( task: "Partial types generation", count: skipped[:types], noun: "types headers" )
224
+ log_skip_summary( task: "Partial implementation generation", count: skipped[:implementation], noun: "implementations" )
225
+ log_skip_summary( task: "Partial interface generation", count: skipped[:interface], noun: "interfaces" )
277
226
  end
278
227
 
279
228
  private
280
229
 
281
- # Shared body for stages 6 and 7 -- a partial's header and source files go through
282
- # identical preprocessing, differing only in which of `state.partials_headers`/
283
- # `state.partials_sources` supplies the work and which Preprocessinator methods
284
- # `kind` (a header or a source) is actually preprocessed by.
285
- #
286
- # A partial file's three preprocessing passes below (directives-only generation,
287
- # preserve-macros preprocessing, full-expansion) all derive from the same
288
- # antecedent file and the same preprocess flags/defines/search paths, so they're
289
- # stale or fresh together as a single unit -- one DependencyTracker target per
290
- # file per test covers all three.
291
- #
292
- # Settling every target's staleness in its own sequential pass first (cheap, no
293
- # subprocess work) is what lets the three parallel batches below each just check
294
- # `details.stale` instead of duplicating the register/stale? call three times
295
- # over. On a stale target, all three passes run and populate `config` as they do
296
- # today. On a fresh target, the two preprocessed output filepaths are recomputed
297
- # the same deterministic way the preprocessor methods themselves compute them,
298
- # and `config.includes` is recalled from the on-disk list a prior stale run wrote
299
- # -- so `config` ends up populated identically either way, and stage 8 (which
300
- # reads only `config`) needs no knowledge of which path produced it.
301
- # Build threads finish in any order. Each test's Partial modules return to its configuration
302
- # order, which its link and mock lists follow, so an unchanged build sees unchanged lists.
303
- def order_partials(testables)
304
- testables.each do |testable|
305
- order = testable.partials.configs.values.map( &:module )
306
- testable.partials.tests.sort_by! { |_module| order.index( _module ) }
307
- testable.partials.mocks.sort_by! { |_module| order.index( _module ) }
230
+ # Generates one Partial file when its record says it's stale, and logs the skip otherwise.
231
+ # Returns true when generation was skipped, for the stage's summary.
232
+ def generate_when_stale(target:, files:, meta:, kind:, name:, partial:, outputs: [])
233
+ @dependinator.register( target, files: files, meta: meta, outputs: outputs )
234
+
235
+ if @dependinator.stale?( target )
236
+ yield
237
+ @dependinator.mark_fresh( target )
238
+ return false
308
239
  end
240
+
241
+ log_generation_skip( kind, name, partial )
242
+ return true
309
243
  end
310
244
 
311
- def preprocess_partials(items:, kind:, noun:, preserve_macros_method:, expand_macros_method:)
312
- directives_only = @configurator.test_build_preprocess_directives_only_available
313
- skipped = 0
245
+ def log_generation_skip(kind, name, partial)
246
+ msg = @reportinator.generate_module_progress(
247
+ operation: "Skipping Partial #{kind} generation for", module_name: name, filename: partial
248
+ )
249
+ @loginator.log( msg, Verbosity::OBNOXIOUS )
250
+ end
314
251
 
315
- items.each do |details|
316
- config = details.config
317
- testable = details.testable
318
- name = testable.name
252
+ # How FilePathUtils names each file a Partial generates
253
+ PARTIAL_FILENAMES = {
254
+ types: :form_partial_types_header_filename,
255
+ implementation: :form_partial_implementation_source_filename,
256
+ impl_header: :form_partial_implementation_header_filename,
257
+ interface: :form_partial_interface_header_filename,
258
+ extras: :form_partial_extras_header_filename
259
+ }.freeze unless const_defined?(:PARTIAL_FILENAMES, false)
260
+
261
+ # Where each file a Partial generates lives
262
+ def partial_paths(config, testable)
263
+ dir = testable.paths[:partials]
264
+ return PARTIAL_FILENAMES.transform_values { |form| File.join( dir, @file_path_utils.public_send( form, config.module ) ) }
265
+ end
319
266
 
320
- target = @file_path_utils.form_preprocessed_file_filepath( config.filepath, name )
321
-
322
- @dependinator.register(
323
- target,
324
- files: [config.filepath],
325
- meta: dependency_meta(
326
- flags: testable.preprocess_flags, defines: testable.preprocess_defines, search_paths: testable.search_paths,
327
- tools: [
328
- @configurator.tools_test_file_directives_only_preprocessor,
329
- @configurator.tools_test_bare_includes_preprocessor,
330
- @configurator.tools_test_file_full_preprocessor
331
- ],
332
- partials: @configurator.get_partials_config
333
- )
334
- )
267
+ # The files a fresh Partial would have generated, keyed by kind, or nil when the Partial must
268
+ # be extracted. The implementation and interface decide, each vouching for the types header it
269
+ # includes. A types header still on disk is registered too, so a full run's pruning keeps its
270
+ # record.
271
+ def fresh_targets(config, paths, record)
272
+ targets = checkable_targets( config, paths )
273
+ vouching = targets.values_at( :implementation, :interface ).compact
335
274
 
336
- details.preprocessed_target = target
337
- details.stale = @dependinator.stale?( target )
338
-
339
- if details.stale
340
- msg = @reportinator.generate_module_progress(
341
- operation: "Preprocessing partial #{kind} for",
342
- module_name: name,
343
- filename: File.basename( config.filepath )
344
- )
345
- @loginator.log( msg )
346
- else
347
- msg = @reportinator.generate_module_progress(
348
- operation: "Skipping partial #{kind} preprocessing for",
349
- module_name: name,
350
- filename: File.basename( config.filepath )
351
- )
352
- @loginator.log( msg, Verbosity::OBNOXIOUS )
353
- skipped += 1
354
-
355
- config.directives_only_filepath = target
356
- config.includes = @preprocessinator.load_includes_list( test: name, filepath: config.filepath )
357
- config.full_expansion_filepath = @file_path_utils.form_preprocessed_file_full_expansion_filepath( config.filepath, name )
358
- end
275
+ targets.each_value { |target| @dependinator.register( target, files: record[:files], meta: record[:meta] ) }
276
+ return nil if vouching.empty? or vouching.any? { |target| @dependinator.stale?( target ) }
277
+
278
+ return targets
279
+ end
280
+
281
+ # Each file a Partial generates that can be checked before extraction. The implementation and
282
+ # interface follow the test's selection. Only extraction knows whether a types header is due,
283
+ # so its file on disk stands in.
284
+ def checkable_targets(config, paths)
285
+ targets = {}
286
+ targets[:types] = paths[:types] if @file_wrapper.exist?( paths[:types] )
287
+ targets[:implementation] = paths[:implementation] unless config.tests.type.nil?
288
+ targets[:interface] = paths[:interface] unless config.mocks.type.nil?
289
+ return targets
290
+ end
291
+
292
+ # A fresh Partial needs only its bookkeeping. Each file it would have generated is logged and
293
+ # counted as skipped, and the module joins its test's lists as generation would have added it.
294
+ def skip_fresh_partial(state, testable, config, targets, skipped)
295
+ targets.each_key { |kind| log_generation_skip( kind, testable.name, config.module ) }
296
+
297
+ state.lock.synchronize do
298
+ targets.each_key { |kind| skipped[kind] += 1 }
299
+ join_partial_lists( testable.partials, config.module, targets.keys )
359
300
  end
301
+ end
360
302
 
361
- log_skip_summary( task: "partial #{kind} preprocessing", count: skipped, noun: noun )
303
+ # A module with no types gets no types header. One an earlier build left would otherwise pass
304
+ # for current whenever the Partial is next found fresh.
305
+ def discard_leftover_types(path)
306
+ return unless @file_wrapper.exist?( path )
362
307
 
363
- # Generate directive-only preprocessor output if available
364
- @batchinator.exec(workload: :compile, things: items) do |details|
365
- next unless details.stale
308
+ @file_wrapper.rm_f( path )
309
+ @dependinator.invalidate( path )
310
+ end
366
311
 
367
- config = details.config
368
- testable = details.testable
369
- name = testable.name
312
+ # A mock-only Partial's interface stands in for its real header, so the rest of that header
313
+ # comes along in an extras header. A module the test also tests carries what its own code
314
+ # uses through its implementation instead, so it plans none.
315
+ def plan_extras(name, config, module_contents, interface, include_guard)
316
+ return @partializer.plan_interface_extras(
317
+ test: name, c_module: module_contents, interface: interface, header_guarded: !include_guard.nil?, config: config
318
+ )
319
+ end
370
320
 
371
- arg_hash = {
372
- filepath: config.filepath,
373
- test: name,
374
- flags: testable.preprocess_flags,
375
- include_paths: testable.search_paths,
376
- vendor_paths: vendor_search_paths(),
377
- defines: testable.preprocess_defines
378
- }
321
+ def explain_tested_mock(testable, config, module_contents, interface, include_guard)
322
+ @partializer.explain_tested_mock(
323
+ test: testable.name, c_module: module_contents, interface: interface, header_guarded: !include_guard.nil?, config: config,
324
+ partials: testable.partials.configs
325
+ )
326
+ end
379
327
 
380
- details.directives_only_filepath = @preprocessinator.generate_directives_only_output( **arg_hash )
381
- end if directives_only
382
-
383
- # Preprocess and assemble files
384
- @batchinator.exec(workload: :compile, things: items) do |details|
385
- next unless details.stale
386
-
387
- config = details.config
388
- testable = details.testable
389
- name = testable.name
390
- directives_only_filepath = details.directives_only_filepath
391
-
392
- arg_hash = {
393
- test: name,
394
- filepath: config.filepath,
395
- directives_only_filepath: directives_only_filepath,
396
- fallback: directives_only_fallback?( directives_only, directives_only_filepath ),
397
- flags: testable.preprocess_flags,
398
- include_paths: testable.search_paths,
399
- vendor_paths: vendor_search_paths(),
400
- defines: testable.preprocess_defines
401
- }
328
+ # An interface that keeps nothing includes no extras header. One an earlier build left would
329
+ # only sit beside it.
330
+ def discard_leftover_extras(path)
331
+ @file_wrapper.rm_f( path ) if @file_wrapper.exist?( path )
332
+ end
402
333
 
403
- config.directives_only_filepath, config.includes = @preprocessinator.public_send( preserve_macros_method, **arg_hash )
404
- end
334
+ # A module joins the test's list for each side of its Partial that exists
335
+ def join_partial_lists(partials, partial_module, kinds)
336
+ partials.tests << partial_module if kinds.include?( :implementation )
337
+ partials.mocks << partial_module if kinds.include?( :interface )
338
+ end
405
339
 
406
- # Full-preprocess files for expanded signature extraction.
407
- @batchinator.exec(workload: :compile, things: items) do |details|
408
- next unless details.stale
340
+ # A Partial's original header and source, and the preprocessed copies of each that generation
341
+ # reads. Extraction parses the assembled copy and the expanded code. Inline marking and the
342
+ # incomplete-type search read the raw directives-only copy, which holds every header the file
343
+ # includes. A declaration-only Partial has no source file, and a file preprocessed in fallback
344
+ # has no raw copy. Those paths are nil and compacted out, since path normalization expects
345
+ # real paths only.
346
+ def partial_antecedent_files(config)
347
+ return [config.header, config.source].flat_map do |file|
348
+ [file.filepath, file.assembled_filepath, file.expansion_filepath, file.raw_directives_only_filepath]
349
+ end.compact.uniq
350
+ end
409
351
 
410
- config = details.config
411
- testable = details.testable
412
- name = testable.name
352
+ # The includes of each file this module's Partial can generate, keyed by file. The impl and
353
+ # interface headers carry the shared types header when the module has one. Each generated
354
+ # header gets its includes in groups (Partials::IncludeGroups), split where the source
355
+ # includes the module's header.
356
+ def remap_partial_includes(config, partials, types_header, test, spelled)
357
+ common = { name: config.module, partials: partials, test: test }
358
+ split = { **common, source_includes: spelled[:source], header_includes: spelled[:header] }
359
+
360
+ return {
361
+ types: @partializer.remap_types_header_includes( **split ),
362
+ impl_header: @partializer.remap_implementation_header_includes( **split, types_header: types_header ),
363
+ impl_source: @partializer.remap_implementation_source_includes( **common, includes: spelled[:source] + spelled[:header] ),
364
+ interface: @partializer.remap_interface_header_includes( **split, types_header: types_header )
365
+ }
366
+ end
413
367
 
414
- arg_hash = {
415
- filepath: config.filepath,
416
- test: name,
417
- flags: testable.preprocess_flags,
418
- include_paths: testable.search_paths,
419
- vendor_paths: vendor_search_paths(),
420
- defines: testable.preprocess_defines
421
- }
368
+ # A Partial's #includes, each by a spelling the test's search paths reach its header by or,
369
+ # where no spelling reaches it, by its absolute path (see HeaderSearch on spellings), so a
370
+ # generated file reaches it from the Partials directory, and modules are matched by that header
371
+ def spell_partial_includes(config, search)
372
+ return {
373
+ source: spelled_includes( config.source, search ),
374
+ header: spelled_includes( config.header, search )
375
+ }
376
+ end
422
377
 
423
- config.full_expansion_filepath = @preprocessinator.public_send( expand_macros_method, **arg_hash )
378
+ # One module file's #includes. Fallback's text scan holds each as written, which names a header
379
+ # beside the file first. The preprocessor's hold the path it found each header by.
380
+ def spelled_includes(file_info, search)
381
+ from = file_info.filepath && File.dirname( file_info.filepath )
382
+ return file_info.includes.map { |include| include.spelled_by( search, from: from, resolved: !file_info.fallback ) }
383
+ end
424
384
 
425
- # A skipped run recalls the includes list and full expansion this run wrote, so the
426
- # preprocessed target vouches for both
427
- @dependinator.register(
428
- details.preprocessed_target,
429
- outputs: [
430
- @file_path_utils.form_preprocessed_includes_list_filepath( config.filepath, name ),
431
- @file_path_utils.form_preprocessed_file_full_expansion_filepath( config.filepath, name )
432
- ]
433
- )
434
- @dependinator.mark_fresh( details.preprocessed_target )
385
+ # Build threads finish in any order. Each test's Partial modules return to its configuration
386
+ # order, which its link and mock lists follow, so an unchanged build sees unchanged lists.
387
+ def order_partials(testables)
388
+ testables.each do |testable|
389
+ order = testable.partials.configs.values.map( &:module )
390
+ testable.partials.tests.sort_by! { |_module| order.index( _module ) }
391
+ testable.partials.mocks.sort_by! { |_module| order.index( _module ) }
435
392
  end
436
393
  end
437
394