ceedling 1.2.1 → 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 (545) hide show
  1. checksums.yaml +4 -4
  2. data/GIT_COMMIT_SHA +1 -1
  3. data/README.md +11 -9
  4. data/Rakefile +2 -1
  5. data/assets/features/ceedling +1 -1
  6. data/assets/fixtures/test_source_file_duplicate_basenames/test_calc_typo.c +14 -0
  7. data/assets/fixtures/tests_with_duplicate_test_names/test_foo.c +21 -0
  8. data/assets/fixtures/tests_with_partials_coverage/src/private_macro.c +7 -0
  9. data/assets/fixtures/tests_with_partials_coverage/src/private_macro.h +5 -0
  10. data/assets/fixtures/tests_with_partials_coverage/src/tally.c +13 -0
  11. data/assets/fixtures/tests_with_partials_coverage/src/tally.h +4 -0
  12. data/assets/fixtures/tests_with_partials_coverage/test/test_private_macro.c +10 -0
  13. data/assets/fixtures/tests_with_partials_coverage/test/test_tally.c +9 -0
  14. data/bin/actionator.rb +6 -12
  15. data/bin/app_cfg.rb +14 -1
  16. data/bin/ceedling +13 -3
  17. data/bin/cli.rb +25 -6
  18. data/bin/cli_handler.rb +113 -73
  19. data/bin/cli_helper.rb +51 -78
  20. data/bin/installation_selector.rb +81 -0
  21. data/bin/launchinator.rb +69 -0
  22. data/bin/mixin_resolvinator.rb +26 -36
  23. data/bin/objects.yml +13 -0
  24. data/bin/path_validator.rb +25 -29
  25. data/bin/versionator.rb +47 -48
  26. data/ceedling.gemspec +19 -15
  27. data/docs/BreakingChanges.md +86 -1
  28. data/docs/Changelog.md +145 -3
  29. data/docs/KnownIssues.md +179 -6
  30. data/docs/ReleaseNotes.md +13 -0
  31. data/examples/wondrous_forest/README.md +29 -1
  32. data/examples/wondrous_forest/src/ForestUnits.h +23 -0
  33. data/examples/wondrous_forest/src/RainGauge.c +59 -0
  34. data/examples/wondrous_forest/src/RainGauge.h +39 -0
  35. data/examples/wondrous_forest/src/RainTipIsr.c +17 -0
  36. data/examples/wondrous_forest/src/RainTipIsr.h +14 -0
  37. data/examples/wondrous_forest/test/TestRainGauge.c +126 -0
  38. data/lib/ceedling/build_log_writer.rb +33 -0
  39. data/lib/ceedling/c_extractor/README.md +15 -7
  40. data/lib/ceedling/c_extractor/c_extractor.rb +25 -14
  41. data/lib/ceedling/c_extractor/c_extractor_code_text.rb +84 -54
  42. data/lib/ceedling/c_extractor/c_extractor_constants.rb +18 -7
  43. data/lib/ceedling/c_extractor/c_extractor_declarations.rb +319 -283
  44. data/lib/ceedling/c_extractor/c_extractor_declarator.rb +285 -0
  45. data/lib/ceedling/c_extractor/c_extractor_defined_type.rb +111 -0
  46. data/lib/ceedling/c_extractor/c_extractor_definitions.rb +174 -121
  47. data/lib/ceedling/c_extractor/c_extractor_functions.rb +191 -162
  48. data/lib/ceedling/c_extractor/c_extractor_preprocessing.rb +46 -55
  49. data/lib/ceedling/c_extractor/c_extractor_statement.rb +30 -0
  50. data/lib/ceedling/c_extractor/c_extractor_types.rb +63 -41
  51. data/lib/ceedling/c_extractor/c_module_edits.rb +48 -0
  52. data/lib/ceedling/c_identifier.rb +21 -0
  53. data/lib/ceedling/ceedling.h +8 -0
  54. data/lib/ceedling/config/build_root_policy.rb +70 -0
  55. data/lib/ceedling/config/configurator.rb +18 -19
  56. data/lib/ceedling/config/configurator_builder.rb +75 -28
  57. data/lib/ceedling/config/configurator_paths_validator.rb +179 -0
  58. data/lib/ceedling/config/configurator_plugins.rb +1 -1
  59. data/lib/ceedling/config/configurator_setup.rb +44 -33
  60. data/lib/ceedling/config/configurator_validator.rb +1 -110
  61. data/lib/ceedling/constants.rb +5 -1
  62. data/lib/ceedling/defaults.rb +35 -5
  63. data/lib/ceedling/dependencies/CACHE_SCHEMA.md +118 -0
  64. data/lib/ceedling/dependencies/README.md +18 -16
  65. data/lib/ceedling/dependencies/dependency_cache_store.rb +43 -21
  66. data/lib/ceedling/dependencies/dependency_hasher.rb +35 -1
  67. data/lib/ceedling/dependencies/dependency_tracker.rb +9 -3
  68. data/lib/ceedling/dependencies/dependinator.rb +13 -1
  69. data/lib/ceedling/diagnostics/DOCTOR.md +142 -0
  70. data/lib/ceedling/diagnostics/README.md +5 -0
  71. data/lib/ceedling/diagnostics/build_step_doctor.rb +110 -0
  72. data/lib/ceedling/diagnostics/duplicate_symbol_specialist.rb +108 -0
  73. data/lib/ceedling/diagnostics/guidance_phrases.rb +30 -0
  74. data/lib/ceedling/diagnostics/header_collision_guidance.rb +56 -0
  75. data/lib/ceedling/diagnostics/header_collision_specialist.rb +152 -0
  76. data/lib/ceedling/diagnostics/include_depth_specialist.rb +132 -0
  77. data/lib/ceedling/diagnostics/missing_symbol_specialist.rb +111 -0
  78. data/lib/ceedling/diagnostics/partial_name_specialist.rb +134 -0
  79. data/lib/ceedling/diagnostics/toolchain_output.rb +44 -0
  80. data/lib/ceedling/filename_extension.rb +7 -1
  81. data/lib/ceedling/filesystem/FILE_TREE.md +253 -0
  82. data/lib/ceedling/filesystem/PATH_HANDLING.md +360 -0
  83. data/lib/ceedling/filesystem/README.md +46 -0
  84. data/lib/ceedling/filesystem/build_roots.rb +105 -0
  85. data/lib/ceedling/filesystem/build_subpath.rb +187 -0
  86. data/lib/ceedling/filesystem/destination_collision.rb +25 -0
  87. data/lib/ceedling/{file_finder.rb → filesystem/file_finder.rb} +177 -156
  88. data/lib/ceedling/filesystem/file_finder_helper.rb +154 -0
  89. data/lib/ceedling/filesystem/file_path_collection_utils.rb +183 -0
  90. data/lib/ceedling/{file_path_utils.rb → filesystem/file_path_utils.rb} +200 -167
  91. data/lib/ceedling/{file_system_wrapper.rb → filesystem/file_system_wrapper.rb} +6 -5
  92. data/lib/ceedling/filesystem/file_tree.rb +241 -0
  93. data/lib/ceedling/{file_wrapper.rb → filesystem/file_wrapper.rb} +149 -65
  94. data/lib/ceedling/filesystem/path_exclusions.rb +30 -0
  95. data/lib/ceedling/{path_matcher.rb → filesystem/path_matcher.rb} +48 -23
  96. data/lib/ceedling/{path_mirror.rb → filesystem/path_mirror.rb} +19 -18
  97. data/lib/ceedling/filesystem/path_spellings.rb +55 -0
  98. data/lib/ceedling/filesystem/project_paths.rb +184 -0
  99. data/lib/ceedling/filesystem/test_build_layout.rb +114 -0
  100. data/lib/ceedling/filesystem/win_long_paths.rb +153 -0
  101. data/lib/ceedling/filesystem/win_path_limit.rb +83 -0
  102. data/lib/ceedling/filesystem/win_path_prober.rb +52 -0
  103. data/lib/ceedling/filesystem/working_dir.rb +40 -0
  104. data/lib/ceedling/generators/generator.rb +32 -70
  105. data/lib/ceedling/generators/generator_helper.rb +0 -44
  106. data/lib/ceedling/generators/generator_mocks.rb +5 -0
  107. data/lib/ceedling/generators/generator_partials.rb +306 -244
  108. data/lib/ceedling/generators/generator_test_results_backtrace.rb +7 -7
  109. data/lib/ceedling/generators/generator_test_runner.rb +5 -8
  110. data/lib/ceedling/generators/partial_header_writer.rb +95 -0
  111. data/lib/ceedling/generators/partial_source_writer.rb +137 -0
  112. data/lib/ceedling/handoff.rb +121 -0
  113. data/lib/ceedling/includes/header_search.rb +225 -0
  114. data/lib/ceedling/includes/include_factory.rb +9 -12
  115. data/lib/ceedling/includes/include_pathinator.rb +112 -33
  116. data/lib/ceedling/includes/includes.rb +150 -38
  117. data/lib/ceedling/installation.rb +92 -0
  118. data/lib/ceedling/library_resolver.rb +99 -0
  119. data/lib/ceedling/objects.yml +112 -6
  120. data/lib/ceedling/partials/README.md +110 -16
  121. data/lib/ceedling/partials/carry_plan.rb +71 -0
  122. data/lib/ceedling/partials/definition_head.rb +74 -0
  123. data/lib/ceedling/partials/include_groups.rb +37 -0
  124. data/lib/ceedling/partials/interface_extras.rb +25 -0
  125. data/lib/ceedling/partials/partializer.rb +603 -124
  126. data/lib/ceedling/partials/partializer_config.rb +8 -1
  127. data/lib/ceedling/partials/partializer_helper.rb +851 -145
  128. data/lib/ceedling/partials/partializer_reconciler.rb +174 -0
  129. data/lib/ceedling/partials/partializer_utils.rb +89 -109
  130. data/lib/ceedling/partials/partials.rb +153 -10
  131. data/lib/ceedling/partials/type_macros.rb +126 -0
  132. data/lib/ceedling/plugins/report_log_writer_plugin.rb +3 -5
  133. data/lib/ceedling/preprocess/README.md +43 -33
  134. data/lib/ceedling/preprocess/preprocessinator.rb +100 -186
  135. data/lib/ceedling/preprocess/preprocessinator_code_finder.rb +65 -72
  136. data/lib/ceedling/preprocess/preprocessinator_file_assembler.rb +32 -76
  137. data/lib/ceedling/preprocess/preprocessinator_includes_handler.rb +1 -1
  138. data/lib/ceedling/preprocess/preprocessinator_line_marker_includes_extractor.rb +1 -1
  139. data/lib/ceedling/preprocess/preprocessinator_reconstructor.rb +51 -14
  140. data/lib/ceedling/rake_app/rakefile_component_resolver.rb +10 -17
  141. data/lib/ceedling/rakefile.rb +15 -1
  142. data/lib/ceedling/rakefiles/base/tasks_base.rake +1 -1
  143. data/lib/ceedling/rakefiles/release/rules_release.rake +4 -7
  144. data/lib/ceedling/release_invoker/release_build_executor.rb +33 -44
  145. data/lib/ceedling/release_invoker/release_build_planner.rb +14 -6
  146. data/lib/ceedling/reportinator.rb +3 -4
  147. data/lib/ceedling/setupinator.rb +104 -87
  148. data/lib/ceedling/test_context_extractor.rb +5 -1
  149. data/lib/ceedling/test_invoker/HEADER_COLLISIONS.md +21 -7
  150. data/lib/ceedling/test_invoker/PIPELINE.md +62 -19
  151. data/lib/ceedling/test_invoker/README.md +1 -1
  152. data/lib/ceedling/test_invoker/derived_search_path_notices.rb +45 -0
  153. data/lib/ceedling/test_invoker/mock_locator.rb +175 -10
  154. data/lib/ceedling/test_invoker/partial_files_preprocessinator.rb +181 -0
  155. data/lib/ceedling/test_invoker/partials_manager.rb +271 -302
  156. data/lib/ceedling/test_invoker/standin_headerinator.rb +19 -17
  157. data/lib/ceedling/test_invoker/test_bare_includes_extractinator.rb +26 -3
  158. data/lib/ceedling/test_invoker/test_build_executor.rb +358 -234
  159. data/lib/ceedling/test_invoker/test_build_planner.rb +46 -33
  160. data/lib/ceedling/test_invoker/test_build_setup.rb +43 -18
  161. data/lib/ceedling/test_invoker/test_build_validations.rb +35 -47
  162. data/lib/ceedling/test_invoker/test_derived_search_paths.rb +189 -0
  163. data/lib/ceedling/test_invoker/test_file_preprocessinator.rb +2 -3
  164. data/lib/ceedling/test_invoker/test_includes_reconcilinator.rb +1 -1
  165. data/lib/ceedling/test_invoker/test_invoker.rb +6 -1
  166. data/lib/ceedling/test_invoker/test_invoker_types.rb +28 -20
  167. data/lib/ceedling/test_invoker/test_pipeline_helpers.rb +6 -4
  168. data/lib/ceedling/test_invoker/test_pipeline_manager.rb +25 -8
  169. data/lib/ceedling/test_invoker/test_runner_generatinator.rb +31 -3
  170. data/lib/ceedling/test_invoker/test_search_paths.rb +30 -8
  171. data/lib/ceedling/test_invoker/test_source_file_directive_resolver.rb +40 -20
  172. data/lib/ceedling/test_invoker/test_substitutions.rb +72 -0
  173. data/lib/ceedling/tools/shell_quoting.rb +45 -0
  174. data/lib/ceedling/{tool_executor.rb → tools/tool_executor.rb} +9 -3
  175. data/lib/ceedling/tools/tool_quoting.rb +79 -0
  176. data/lib/ceedling/{tool_validator.rb → tools/tool_validator.rb} +18 -7
  177. data/lib/ceedling/yaml_wrapper.rb +3 -2
  178. data/lib/version.rb +1 -1
  179. data/plugins/bullseye/bullseye.rake +1 -3
  180. data/plugins/bullseye/config/defaults_bullseye.rb +1 -1
  181. data/plugins/bullseye/lib/bullseye.rb +24 -9
  182. data/plugins/command_hooks/lib/command_hooks.rb +1 -1
  183. data/plugins/cppcheck/config/defaults_cppcheck.rb +1 -1
  184. data/plugins/dependencies/config/defaults.yml +6 -6
  185. data/plugins/dependencies/dependencies.rake +4 -1
  186. data/plugins/dependencies/lib/dependencies.rb +18 -8
  187. data/plugins/dependencies/lib/dependency_spec.rb +17 -5
  188. data/plugins/fff/lib/fff.rb +79 -46
  189. data/plugins/fff/lib/fff_mock_generator.rb +12 -9
  190. data/plugins/fff/spec/fff_cmock_wrapper_spec.rb +262 -0
  191. data/plugins/fff/spec/fff_mock_header_generator_spec.rb +9 -0
  192. data/plugins/fff/spec/fff_mock_source_generator_spec.rb +20 -0
  193. data/plugins/gcov/config/defaults_gcov.rb +1 -1
  194. data/plugins/gcov/lib/console_reportinator.rb +28 -36
  195. data/plugins/gcov/lib/gcov.rb +9 -2
  196. data/plugins/gcov/lib/gcovr_reportinator.rb +8 -40
  197. data/plugins/gcov/lib/gcovr_thresholds.rb +74 -0
  198. data/plugins/gcov/lib/reportgenerator_reportinator.rb +3 -2
  199. data/plugins/module_generator/lib/module_generator.rb +3 -3
  200. data/plugins/report_tests_teamcity_stdout/lib/report_tests_teamcity_stdout.rb +53 -80
  201. data/plugins/sanitize/lib/sanitize_records.rb +3 -6
  202. data/plugins/valgrind/lib/valgrind.rb +14 -7
  203. data/site-local/404.html +2 -2
  204. data/site-local/assets/javascripts/{bundle.c21346df.min.js → bundle.a5f9d56c.min.js} +1 -1
  205. data/site-local/assets/javascripts/{bundle.c21346df.min.js.map → bundle.a5f9d56c.min.js.map} +2 -2
  206. data/site-local/configuration/environment-vars.html +2 -2
  207. data/site-local/configuration/global-collections.html +3 -3
  208. data/site-local/configuration/index.html +2 -2
  209. data/site-local/configuration/loading.html +2 -2
  210. data/site-local/configuration/mixins.html +2 -2
  211. data/site-local/configuration/parallel-builds.html +2 -2
  212. data/site-local/configuration/project-file.html +2 -2
  213. data/site-local/configuration/reference/cexception.html +2 -2
  214. data/site-local/configuration/reference/cmock.html +7 -3
  215. data/site-local/configuration/reference/defines.html +2 -2
  216. data/site-local/configuration/reference/environment.html +2 -2
  217. data/site-local/configuration/reference/extension.html +2 -2
  218. data/site-local/configuration/reference/files.html +65 -12
  219. data/site-local/configuration/reference/flags.html +2 -2
  220. data/site-local/configuration/reference/index.html +2 -2
  221. data/site-local/configuration/reference/libraries.html +23 -5
  222. data/site-local/configuration/reference/mixins.html +2 -2
  223. data/site-local/configuration/reference/partials.html +84 -2
  224. data/site-local/configuration/reference/paths.html +36 -8
  225. data/site-local/configuration/reference/plugins.html +2 -2
  226. data/site-local/configuration/reference/project.html +264 -12
  227. data/site-local/configuration/reference/release-build.html +4 -2
  228. data/site-local/configuration/reference/test-build.html +2 -2
  229. data/site-local/configuration/reference/test-runner.html +2 -2
  230. data/site-local/configuration/reference/tools.html +58 -4
  231. data/site-local/configuration/reference/unity.html +2 -2
  232. data/site-local/configuration/which-ceedling.html +379 -19
  233. data/site-local/development/index.html +2 -2
  234. data/site-local/development/plugins/configuration.html +2 -2
  235. data/site-local/development/plugins/index.html +2 -2
  236. data/site-local/development/plugins/plugin-subclass.html +5 -4
  237. data/site-local/development/plugins/rake-tasks.html +2 -2
  238. data/site-local/development/releases.html +7 -3
  239. data/site-local/development/workflow.html +50 -45
  240. data/site-local/getting-started/builds.html +4 -2
  241. data/site-local/getting-started/command-line.html +58 -6
  242. data/site-local/getting-started/example-projects/cipher-quest.html +2 -2
  243. data/site-local/getting-started/example-projects/index.html +2 -2
  244. data/site-local/getting-started/example-projects/temp-sensor.html +2 -2
  245. data/site-local/getting-started/example-projects/wondrous-forest.html +10 -2
  246. data/site-local/getting-started/index.html +2 -2
  247. data/site-local/getting-started/installation.html +2 -2
  248. data/site-local/getting-started/quick-start.html +2 -2
  249. data/site-local/help.html +2 -2
  250. data/site-local/index.html +2 -2
  251. data/site-local/overview/build-system.html +2 -2
  252. data/site-local/overview/index.html +2 -2
  253. data/site-local/overview/test-environments.html +2 -2
  254. data/site-local/overview/tools-and-frameworks.html +2 -2
  255. data/site-local/plugins/beep.html +2 -2
  256. data/site-local/plugins/bullseye/index.html +45 -38
  257. data/site-local/plugins/bullseye/licensing.html +2 -2
  258. data/site-local/plugins/command-hooks.html +4 -4
  259. data/site-local/plugins/compile-commands-json-db.html +2 -2
  260. data/site-local/plugins/cppcheck.html +2 -2
  261. data/site-local/plugins/dependencies.html +8 -5
  262. data/site-local/plugins/fff.html +58 -13
  263. data/site-local/plugins/gcov/examples.html +2 -2
  264. data/site-local/plugins/gcov/gcovr.html +23 -14
  265. data/site-local/plugins/gcov/index.html +2 -2
  266. data/site-local/plugins/gcov/overview.html +2 -2
  267. data/site-local/plugins/gcov/reportgenerator.html +18 -14
  268. data/site-local/plugins/gcov/reporting.html +2 -2
  269. data/site-local/plugins/gcov/setup.html +4 -3
  270. data/site-local/plugins/gcov/tool-versions.html +2 -2
  271. data/site-local/plugins/gcov/troubleshooting.html +2 -2
  272. data/site-local/plugins/index.html +2 -2
  273. data/site-local/plugins/module-generator.html +2 -2
  274. data/site-local/plugins/report-build-warnings-log.html +2 -2
  275. data/site-local/plugins/report-tests-gtestlike-stdout.html +2 -2
  276. data/site-local/plugins/report-tests-ide-stdout.html +2 -2
  277. data/site-local/plugins/report-tests-log-factory.html +2 -2
  278. data/site-local/plugins/report-tests-pretty-stdout.html +2 -2
  279. data/site-local/plugins/report-tests-raw-output-log.html +5 -3
  280. data/site-local/plugins/report-tests-teamcity-stdout.html +8 -5
  281. data/site-local/plugins/sanitize.html +9 -8
  282. data/site-local/plugins/valgrind.html +10 -9
  283. data/site-local/project/index.html +2 -2
  284. data/site-local/project/release-history.html +2 -2
  285. data/site-local/project/sbom.html +2 -2
  286. data/site-local/project/upgrade.html +5 -2
  287. data/site-local/reference/build-directives.html +2 -2
  288. data/site-local/reference/command-line.html +11 -4
  289. data/site-local/reference/environment-vars.html +2 -2
  290. data/site-local/reference/gcov-plugin.html +2 -2
  291. data/site-local/reference/global-collections.html +12 -12
  292. data/site-local/reference/index.html +2 -2
  293. data/site-local/reference/partials-macros.html +47 -2
  294. data/site-local/reference/project-configuration.html +2 -2
  295. data/site-local/sitemap.xml.gz +0 -0
  296. data/site-local/snapshot/examples/cipher_quest/index.html +2 -2
  297. data/site-local/snapshot/examples/temp_sensor/index.html +2 -2
  298. data/site-local/snapshot/examples/wondrous_forest/index.html +72 -15
  299. data/site-local/snapshot/plugins/bullseye/config/defaults_bullseye.rb +1 -1
  300. data/site-local/snapshot/plugins/gcov/config/defaults_gcov.rb +1 -1
  301. data/site-local/testing-guide/build-directives.html +2 -2
  302. data/site-local/testing-guide/conventions.html +113 -15
  303. data/site-local/testing-guide/frameworks.html +2 -2
  304. data/site-local/testing-guide/index.html +2 -2
  305. data/site-local/testing-guide/partials/configuration.html +31 -4
  306. data/site-local/testing-guide/partials/conventions.html +509 -8
  307. data/site-local/testing-guide/partials/directives.html +4 -3
  308. data/site-local/testing-guide/partials/example.html +2 -2
  309. data/site-local/testing-guide/partials/index.html +2 -2
  310. data/site-local/testing-guide/partials/overview.html +30 -12
  311. data/site-local/testing-guide/partials/variables.html +169 -4
  312. data/site-local/testing-guide/test-cases.html +2 -2
  313. data/site-local/testing-guide/test-sample.html +2 -2
  314. data/site-local/testing-guide/test-suite-anatomy.html +2 -2
  315. data/spec/integration/actionator_file_operations_spec.rb +91 -1
  316. data/spec/integration/build_step_doctor_spec.rb +270 -0
  317. data/spec/integration/c_extractor_composition_spec.rb +254 -4
  318. data/spec/integration/compile_commands_json_db_spec.rb +1 -1
  319. data/spec/integration/configurator_validation_spec.rb +1 -1
  320. data/spec/integration/dependencies/dependency_tracker_cache_hardening_spec.rb +26 -0
  321. data/spec/integration/dependencies/dependency_tracker_core_spec.rb +22 -0
  322. data/spec/integration/includes_extraction_spec.rb +27 -14
  323. data/spec/integration/launcher_handoff_spec.rb +297 -0
  324. data/spec/integration/mixin_loading_spec.rb +1 -1
  325. data/spec/integration/module_generator_spec.rb +3 -3
  326. data/spec/integration/nested_test_artifacts_spec.rb +99 -0
  327. data/spec/integration/partial_files_preprocessing_spec.rb +128 -0
  328. data/spec/integration/partials_carry_spec.rb +520 -0
  329. data/spec/integration/partials_declarations_spec.rb +655 -0
  330. data/spec/integration/partials_fallback_preprocessing_spec.rb +65 -0
  331. data/spec/integration/partials_function_pointers_spec.rb +277 -0
  332. data/spec/integration/partials_header_composition_spec.rb +268 -35
  333. data/spec/integration/partials_macro_decorators_spec.rb +267 -0
  334. data/spec/integration/partials_module_resolution_spec.rb +33 -23
  335. data/spec/integration/partials_symbol_linkage_spec.rb +13 -0
  336. data/spec/integration/path_intake_scenarios_spec.rb +101 -0
  337. data/spec/integration/path_length_reporting_spec.rb +64 -0
  338. data/spec/integration/path_scenarios_spec.rb +399 -0
  339. data/spec/integration/quote_include_isolator_spec.rb +57 -1
  340. data/spec/integration/report_build_warnings_log_spec.rb +1 -1
  341. data/spec/integration/report_tests_log_factory_spec.rb +1 -1
  342. data/spec/integration/test_build_parallel_barrier_spec.rb +1 -1
  343. data/spec/integration/test_executable_manifest_spec.rb +1 -1
  344. data/spec/integration/test_includes_extractinator_spec.rb +69 -3
  345. data/spec/integration/test_naming_spec.rb +201 -0
  346. data/spec/integration/test_source_file_checks_spec.rb +168 -0
  347. data/spec/integration/tool_executor_spec.rb +1 -1
  348. data/spec/integration/tool_validator_spec.rb +3 -3
  349. data/spec/integration/upgrade_docs_spec.rb +84 -0
  350. data/spec/integration/vendor_copy_transient_io_retry_spec.rb +74 -5
  351. data/spec/integration/win_long_paths_probe_spec.rb +46 -0
  352. data/spec/integration/win_path_limit_spec.rb +53 -0
  353. data/spec/integration/windows_registry_query_tool_spec.rb +41 -0
  354. data/spec/support/file_tree_helper.rb +88 -0
  355. data/spec/support/integration/configurator_integration_helper.rb +14 -9
  356. data/spec/support/integration/dependency_tracker_integration_helper.rb +1 -1
  357. data/spec/support/integration/partial_files_harness.rb +181 -0
  358. data/spec/support/integration/partials_generation_integration_helper.rb +239 -143
  359. data/spec/support/integration/path_scenario_harness.rb +175 -0
  360. data/spec/support/integration/spec_integration_helper.rb +9 -4
  361. data/spec/support/integration/test_includes_harness.rb +69 -37
  362. data/spec/support/integration/tool_executor_integration_helper.rb +14 -2
  363. data/spec/support/spec_helper.rb +2 -0
  364. data/spec/support/system/spec_system_helper.rb +7 -6
  365. data/spec/support/system/system_context.rb +21 -3
  366. data/spec/support/working_dir_tracking.rb +49 -0
  367. data/spec/system/build_output_mirroring_spec.rb +2 -2
  368. data/spec/system/bullseye_deployment_spec.rb +2 -0
  369. data/spec/system/conditional_mock_includes_spec.rb +1 -1
  370. data/spec/system/delta_builds_spec.rb +163 -23
  371. data/spec/system/encoding_stress_spec.rb +4 -4
  372. data/spec/system/example_wondrous_forest_spec.rb +2 -2
  373. data/spec/system/gcov_deployment_spec.rb +3 -0
  374. data/spec/system/header_include_path_validation_spec.rb +4 -4
  375. data/spec/system/header_search_paths_spec.rb +1083 -0
  376. data/spec/system/launcher_handoff_spec.rb +82 -0
  377. data/spec/system/mock_include_folders_spec.rb +212 -0
  378. data/spec/system/mockable_header_reassembly_spec.rb +184 -0
  379. data/spec/system/parent_directory_reference_spec.rb +5 -3
  380. data/spec/system/partials_carry_spec.rb +581 -0
  381. data/spec/system/partials_delta_builds_spec.rb +280 -0
  382. data/spec/system/partials_function_pointers_spec.rb +106 -0
  383. data/spec/system/partials_macro_decorators_spec.rb +127 -0
  384. data/spec/system/partials_module_disambiguation_spec.rb +125 -0
  385. data/spec/system/path_handling_probes_spec.rb +196 -0
  386. data/spec/system/pinned_thread_count_spec.rb +4 -4
  387. data/spec/system/preprocessing_fallback_conditionals_spec.rb +1 -1
  388. data/spec/system/preprocessing_parameterized_tests_spec.rb +1 -1
  389. data/spec/system/rake_release_task_path_disambiguation_spec.rb +6 -6
  390. data/spec/system/rake_test_task_path_disambiguation_spec.rb +85 -0
  391. data/spec/system/short_build_paths_spec.rb +87 -0
  392. data/spec/system/sibling_header_collision_spec.rb +30 -6
  393. data/spec/system/special_path_characters_spec.rb +86 -0
  394. data/spec/system/support/bullseye_common_test_cases.rb +42 -0
  395. data/spec/system/support/common_test_cases.rb +23 -21
  396. data/spec/system/support/gcov_common_test_cases.rb +37 -9
  397. data/spec/system/support/gcov_partials_test_cases.rb +48 -0
  398. data/spec/system/support/sanitize_common_test_cases.rb +2 -2
  399. data/spec/system/support/valgrind_common_test_cases.rb +12 -12
  400. data/spec/system/test_build_layout_spec.rb +209 -0
  401. data/spec/system/test_pipeline_stop_points_spec.rb +4 -4
  402. data/spec/system/test_runner_system_include_spec.rb +1 -1
  403. data/spec/system/test_source_file_directive_spec.rb +64 -5
  404. data/spec/units/bin/actionator_spec.rb +14 -17
  405. data/spec/units/bin/app_cfg_spec.rb +37 -0
  406. data/spec/units/bin/cli_handler_spec.rb +282 -6
  407. data/spec/units/bin/cli_helper_spec.rb +116 -45
  408. data/spec/units/bin/installation_selector_spec.rb +114 -0
  409. data/spec/units/bin/launchinator_spec.rb +171 -0
  410. data/spec/units/bin/path_validator_spec.rb +10 -0
  411. data/spec/units/bin/versionator_spec.rb +38 -6
  412. data/spec/units/build_log_writer_spec.rb +57 -0
  413. data/spec/units/c_extractor/c_extractor_code_text_spec.rb +67 -10
  414. data/spec/units/c_extractor/c_extractor_declarations_spec.rb +501 -4
  415. data/spec/units/c_extractor/c_extractor_declarator_spec.rb +245 -0
  416. data/spec/units/c_extractor/c_extractor_defined_type_spec.rb +45 -0
  417. data/spec/units/c_extractor/c_extractor_definitions_spec.rb +163 -3
  418. data/spec/units/c_extractor/c_extractor_functions_spec.rb +462 -21
  419. data/spec/units/c_extractor/c_extractor_preprocessing_spec.rb +39 -0
  420. data/spec/units/c_extractor/c_extractor_spec.rb +4 -4
  421. data/spec/units/c_extractor/c_extractor_types_spec.rb +163 -0
  422. data/spec/units/c_identifier_spec.rb +35 -0
  423. data/spec/units/config/build_root_policy_spec.rb +61 -0
  424. data/spec/units/config/configurator_builder_spec.rb +61 -6
  425. data/spec/units/config/configurator_paths_validator_spec.rb +292 -0
  426. data/spec/units/config/configurator_setup_spec.rb +80 -68
  427. data/spec/units/config/configurator_spec.rb +54 -6
  428. data/spec/units/config/configurator_validator_spec.rb +1 -172
  429. data/spec/units/dependencies/dependency_cache_store_spec.rb +98 -2
  430. data/spec/units/dependencies/dependency_debug_tree_spec.rb +1 -1
  431. data/spec/units/dependencies/dependency_hasher_spec.rb +42 -1
  432. data/spec/units/dependencies/dependency_path_normalizer_spec.rb +1 -1
  433. data/spec/units/dependencies/dependency_tracker_spec.rb +28 -1
  434. data/spec/units/dependencies/dependinator_spec.rb +17 -2
  435. data/spec/units/diagnostics/build_step_doctor_spec.rb +170 -0
  436. data/spec/units/diagnostics/duplicate_symbol_specialist_spec.rb +117 -0
  437. data/spec/units/diagnostics/header_collision_specialist_spec.rb +267 -0
  438. data/spec/units/diagnostics/include_depth_specialist_spec.rb +137 -0
  439. data/spec/units/diagnostics/missing_symbol_specialist_spec.rb +154 -0
  440. data/spec/units/diagnostics/partial_name_specialist_spec.rb +129 -0
  441. data/spec/units/diagnostics/toolchain_output_spec.rb +86 -0
  442. data/spec/units/encodinator_spec.rb +3 -4
  443. data/spec/units/filename_extension_spec.rb +11 -0
  444. data/spec/units/filesystem/build_roots_spec.rb +131 -0
  445. data/spec/units/filesystem/build_subpath_spec.rb +235 -0
  446. data/spec/units/filesystem/destination_collision_spec.rb +30 -0
  447. data/spec/units/{file_finder_helper_spec.rb → filesystem/file_finder_helper_spec.rb} +126 -1
  448. data/spec/units/filesystem/file_finder_spec.rb +845 -0
  449. data/spec/units/{file_path_collection_utils_spec.rb → filesystem/file_path_collection_utils_spec.rb} +181 -1
  450. data/spec/units/{file_path_utils_spec.rb → filesystem/file_path_utils_spec.rb} +435 -185
  451. data/spec/units/filesystem/file_system_wrapper_spec.rb +33 -0
  452. data/spec/units/filesystem/file_tree_spec.rb +511 -0
  453. data/spec/units/filesystem/file_tree_windows_spec.rb +78 -0
  454. data/spec/units/{file_wrapper_spec.rb → filesystem/file_wrapper_spec.rb} +286 -18
  455. data/spec/units/{path_matcher_spec.rb → filesystem/path_matcher_spec.rb} +48 -1
  456. data/spec/units/{path_mirror_spec.rb → filesystem/path_mirror_spec.rb} +32 -4
  457. data/spec/units/filesystem/project_paths_spec.rb +147 -0
  458. data/spec/units/filesystem/test_build_layout_spec.rb +216 -0
  459. data/spec/units/filesystem/win_long_paths_spec.rb +204 -0
  460. data/spec/units/filesystem/win_path_prober_spec.rb +158 -0
  461. data/spec/units/filesystem/working_dir_spec.rb +71 -0
  462. data/spec/units/generators/generator_helper_spec.rb +0 -60
  463. data/spec/units/generators/generator_mocks_spec.rb +13 -0
  464. data/spec/units/generators/generator_partials_spec.rb +656 -55
  465. data/spec/units/generators/generator_spec.rb +38 -6
  466. data/spec/units/generators/generator_test_results_backtrace_spec.rb +50 -46
  467. data/spec/units/generators/generator_test_results_spec.rb +1 -1
  468. data/spec/units/generators/generator_test_runner_spec.rb +9 -5
  469. data/spec/units/generators/partial_source_writer_spec.rb +129 -0
  470. data/spec/units/handoff_spec.rb +205 -0
  471. data/spec/units/includes/header_search_spec.rb +406 -0
  472. data/spec/units/includes/include_factory_spec.rb +23 -6
  473. data/spec/units/includes/include_pathinator_spec.rb +118 -8
  474. data/spec/units/includes/include_spec.rb +14 -0
  475. data/spec/units/includes/includes_spec.rb +176 -19
  476. data/spec/units/installation_spec.rb +228 -0
  477. data/spec/units/library_resolver_spec.rb +157 -0
  478. data/spec/units/loginator_spec.rb +31 -0
  479. data/spec/units/mock_locator_spec.rb +275 -6
  480. data/spec/units/partials/include_groups_spec.rb +42 -0
  481. data/spec/units/partials/partializer_config_spec.rb +32 -0
  482. data/spec/units/partials/partializer_helper_carry_spec.rb +661 -0
  483. data/spec/units/partials/partializer_helper_interface_extras_spec.rb +396 -0
  484. data/spec/units/partials/partializer_helper_spec.rb +529 -277
  485. data/spec/units/partials/partializer_reconciler_spec.rb +661 -0
  486. data/spec/units/partials/partializer_spec.rb +1579 -270
  487. data/spec/units/partials/partializer_utils_spec.rb +269 -232
  488. data/spec/units/partials/partials_rename_spec.rb +160 -0
  489. data/spec/units/partials_manager_spec.rb +561 -251
  490. data/spec/units/plugins/bullseye_spec.rb +49 -2
  491. data/spec/units/plugins/console_reportinator_spec.rb +73 -26
  492. data/spec/units/plugins/dependencies_spec.rb +33 -7
  493. data/spec/units/plugins/dependency_spec_spec.rb +17 -0
  494. data/spec/units/plugins/gcov_spec.rb +28 -3
  495. data/spec/units/plugins/gcovr_reportinator_spec.rb +19 -47
  496. data/spec/units/plugins/gcovr_thresholds_spec.rb +95 -0
  497. data/spec/units/plugins/module_generator_spec.rb +5 -5
  498. data/spec/units/plugins/report_build_warnings_log_spec.rb +3 -3
  499. data/spec/units/plugins/report_log_writer_plugin_spec.rb +10 -1
  500. data/spec/units/plugins/report_tests_raw_output_log_spec.rb +13 -2
  501. data/spec/units/plugins/report_tests_teamcity_stdout_spec.rb +77 -3
  502. data/spec/units/plugins/reportgenerator_reportinator_spec.rb +52 -4
  503. data/spec/units/plugins/sanitize_records_spec.rb +3 -1
  504. data/spec/units/plugins/sanitize_spec.rb +1 -1
  505. data/spec/units/plugins/valgrind_spec.rb +23 -8
  506. data/spec/units/preprocess/preprocessinator_code_finder_spec.rb +73 -10
  507. data/spec/units/preprocess/preprocessinator_comment_stripper_spec.rb +1 -1
  508. data/spec/units/preprocess/preprocessinator_file_assembler_spec.rb +125 -37
  509. data/spec/units/preprocess/preprocessinator_includes_handler_spec.rb +15 -0
  510. data/spec/units/preprocess/preprocessinator_reconstructor_spec.rb +197 -0
  511. data/spec/units/preprocess/preprocessinator_spec.rb +153 -95
  512. data/spec/units/rake_app/rakefile_component_resolver_spec.rb +21 -0
  513. data/spec/units/release_build_executor_spec.rb +53 -14
  514. data/spec/units/release_build_planner_spec.rb +15 -3
  515. data/spec/units/reportinator_spec.rb +5 -5
  516. data/spec/units/setupinator_spec.rb +51 -0
  517. data/spec/units/standin_headerinator_spec.rb +55 -9
  518. data/spec/units/test_build_executor_spec.rb +842 -166
  519. data/spec/units/test_build_planner_spec.rb +205 -15
  520. data/spec/units/test_build_setup_spec.rb +179 -30
  521. data/spec/units/test_context_extractor_spec.rb +36 -2
  522. data/spec/units/test_derived_search_paths_spec.rb +259 -0
  523. data/spec/units/test_file_preprocessinator_spec.rb +17 -1
  524. data/spec/units/test_includes_extractinator_spec.rb +61 -9
  525. data/spec/units/test_invoker/objects_wiring_spec.rb +24 -4
  526. data/spec/units/test_invoker/partial_files_preprocessinator_spec.rb +264 -0
  527. data/spec/units/test_invoker/test_substitutions_spec.rb +122 -0
  528. data/spec/units/test_invoker_spec.rb +14 -1
  529. data/spec/units/test_invoker_types_spec.rb +8 -7
  530. data/spec/units/test_pipeline_manager_spec.rb +54 -13
  531. data/spec/units/test_runner_generatinator_spec.rb +93 -1
  532. data/spec/units/test_search_paths_spec.rb +73 -5
  533. data/spec/units/test_source_file_directive_resolver_spec.rb +38 -7
  534. data/spec/units/tools/default_tools_quoting_spec.rb +117 -0
  535. data/spec/units/tools/shell_quoting_spec.rb +76 -0
  536. data/spec/units/{tool_executor_helper_spec.rb → tools/tool_executor_helper_spec.rb} +1 -1
  537. data/spec/units/{tool_executor_spec.rb → tools/tool_executor_spec.rb} +27 -1
  538. data/spec/units/{tool_validator_spec.rb → tools/tool_validator_spec.rb} +110 -1
  539. data/spec/units/windows_registry_query_tool_spec.rb +53 -0
  540. data/spec/units/yaml_wrapper_spec.rb +11 -0
  541. metadata +265 -36
  542. data/lib/ceedling/file_finder_helper.rb +0 -127
  543. data/lib/ceedling/file_path_collection_utils.rb +0 -164
  544. data/spec/units/file_finder_spec.rb +0 -495
  545. /data/lib/ceedling/{tool_executor_helper.rb → tools/tool_executor_helper.rb} +0 -0
@@ -59,7 +59,7 @@ class Preprocessinator
59
59
  result = run_preprocessor( @configurator.tools_test_file_directives_only_preprocessor, filepath, raw, **tool_args )
60
60
 
61
61
  if @tool_executor.failed?( result )
62
- return log_failure( "Failed to generate directive-only preprocessor output (fallback methods will be used) for #{filepath}", Verbosity::OBNOXIOUS, LogLabels::ERROR )
62
+ return log_failure( "Failed to generate directive-only preprocessor output (fallback methods will be used) for #{filepath}", Verbosity::COMPLAIN )
63
63
  end
64
64
 
65
65
  strip_and_compact( filepath, test, raw )
@@ -75,7 +75,7 @@ class Preprocessinator
75
75
  result = run_preprocessor( @configurator.tools_test_file_full_preprocessor, filepath, output, **tool_args )
76
76
 
77
77
  if @tool_executor.failed?( result )
78
- return log_failure( "Failed to generate fallback preprocessor expansion (text-scan #includes will be used) for #{filepath}", Verbosity::OBNOXIOUS, LogLabels::ERROR )
78
+ return log_failure( "Failed to generate fallback preprocessor expansion (text-scan #includes will be used) for #{filepath}", Verbosity::COMPLAIN )
79
79
  end
80
80
 
81
81
  return output
@@ -97,18 +97,14 @@ class Preprocessinator
97
97
  fallback: fallback, defines: defines )
98
98
  end
99
99
 
100
- # Persists `includes` under a cache file keyed by `test`/`filepath` so
101
- # `load_includes_list` can recall it later. Independent callers share this
102
- # pair of methods against different `filepath`s, each already knowing its
103
- # target is stale before writing here:
104
- # - Stage 4's first pass (TestBareIncludesExtractinator), for a test file's own
105
- # bare-includes list.
106
- # - `preprocess_file_includes_common` below, for a mocked header's or a
107
- # Partial header/source file's includes -- called from stage 9 and
108
- # stages 6/7 (test_build_executor.rb) respectively, both of which
109
- # register their own DependencyTracker target and only call in once
110
- # they've determined it stale.
111
- # This method itself performs no freshness check of its own.
100
+ # Persists `includes` under a cache file keyed by `test` and `filepath`, so
101
+ # `load_includes_list` can recall it later. Two callers share the pair, each already
102
+ # knowing its target is stale:
103
+ # - Stage 4's first pass (TestBareIncludesExtractinator), for a test file's own bare
104
+ # #includes.
105
+ # - `preprocess_file_includes_common` below, for a mockable header's or a Partial
106
+ # file's #includes, from stage 9 and stages 6 and 7.
107
+ # This method performs no freshness check of its own.
112
108
  def store_includes_list(test:, filepath:, includes:)
113
109
  _filepath = ensure_output_dir(
114
110
  @file_path_utils.form_preprocessed_includes_list_filepath( filepath, test )
@@ -143,6 +139,17 @@ class Preprocessinator
143
139
  end
144
140
  end
145
141
 
142
+ # CMock copies a mockable header beside the mock under :treat_inlines :include, so each of its
143
+ # #includes is written by a spelling the test's search paths reach its header by or, where no
144
+ # spelling reaches it, by its absolute path (see HeaderSearch on spellings). Fallback's text
145
+ # scan holds each as written, which names a header beside `filepath` first. Without a search
146
+ # they stay as reconciled.
147
+ def spelled(includes, search, filepath, fallback)
148
+ return includes unless search
149
+
150
+ return includes.map { |include| include.spelled_by( search, from: File.dirname( filepath ), resolved: !fallback ) }
151
+ end
152
+
146
153
  def preprocess_mockable_header_file(
147
154
  test:,
148
155
  filepath:,
@@ -152,7 +159,8 @@ class Preprocessinator
152
159
  include_paths:,
153
160
  vendor_paths:,
154
161
  defines:,
155
- extras: false
162
+ extras: false,
163
+ include_search: nil
156
164
  )
157
165
  msg = @reportinator.generate_module_progress(
158
166
  operation: 'Preprocessing header file for follow-on mock handling',
@@ -181,7 +189,6 @@ class Preprocessinator
181
189
  directives_only_filepath: directives_only_filepath,
182
190
  fallback: fallback,
183
191
  flags: flags,
184
- include_paths: include_paths,
185
192
  vendor_paths: vendor_paths,
186
193
  defines: defines
187
194
  }
@@ -189,9 +196,10 @@ class Preprocessinator
189
196
  # Extract includes & log progress and details. stage_preprocess_mocks
190
197
  # (test_build_executor.rb) only ever calls this method once it has
191
198
  # already determined, via its own DependencyTracker target (antecedent +
192
- # flags/defines/search_paths/extras meta), that this header's
193
- # preprocessing is stale, so the extraction below always runs for real.
194
- includes = preprocess_file_includes_common( **arg_hash )
199
+ # the headers its full expansion entered + flags/defines/search_paths/extras
200
+ # meta), that this header's preprocessing is stale, so the extraction below
201
+ # always runs for real.
202
+ includes = spelled( preprocess_file_includes_common( **arg_hash ), include_search, filepath, fallback )
195
203
 
196
204
  header = "Discovered #includes for mockable header from #{filepath}:"
197
205
  @loginator.log_list( includes, header, Verbosity::OBNOXIOUS )
@@ -231,126 +239,29 @@ class Preprocessinator
231
239
  return preprocessed_filepath
232
240
  end
233
241
 
234
- def preprocess_partial_header_file_preserve_macros(
235
- test:,
236
- filepath:,
237
- directives_only_filepath:,
238
- fallback:,
239
- flags:,
240
- include_paths:,
241
- vendor_paths:,
242
- defines:
243
- )
244
- msg = @reportinator.generate_module_progress(
245
- operation: 'Preprocessing header file for follow-on Partials handling',
246
- module_name: test,
247
- filename: File.basename( filepath )
242
+ # A Partial's header or source with its macros kept, reassembled with its reconciled
243
+ # #includes for extraction to parse. `kind` is :header or :source. Gives the assembled
244
+ # copy's path and the #includes. `directives_only_filepath` is the file's raw
245
+ # -fdirectives-only output, which fallback has none of.
246
+ def preprocess_partial_file(kind:, test:, filepath:, directives_only_filepath:, fallback:, **tool_args)
247
+ noun = kind.to_s
248
+ msg = @reportinator.generate_module_progress(
249
+ operation: "Preprocessing #{noun} file for follow-on Partials handling", module_name: test, filename: File.basename( filepath )
248
250
  )
249
251
  @loginator.log( msg )
250
252
 
251
- preprocessed_filepath = @file_path_utils.form_preprocessed_file_filepath( filepath, test )
252
-
253
- arg_hash = {
254
- test: test,
255
- filepath: filepath,
256
- directives_only_filepath: directives_only_filepath,
257
- fallback: fallback,
258
- flags: flags,
259
- include_paths: include_paths,
260
- vendor_paths: vendor_paths,
261
- defines: defines
262
- }
263
-
264
- # Extract includes & log progress and details
265
- includes = preprocess_file_includes_common( **arg_hash )
266
-
267
- header = "Discovered #includes for Partial header from #{filepath}:"
268
- @loginator.log_list( includes, header, Verbosity::OBNOXIOUS )
269
-
270
- contents =
271
- if fallback
272
- @file_assembler.collect_file_contents_fallback( source_filepath: filepath, defines: defines )
273
- else
274
- @file_assembler.collect_file_contents_from_directives_only_preprocessing( source_filepath: filepath, test: test )
275
- end
276
-
277
- # In fallback mode, #define macros are stripped from contents (all '#' lines skipped).
278
- # Re-extract them so the CExtractor can see them when parsing the reconstituted file.
279
- extras = fallback ? @file_assembler.collect_macros_and_pragmas_fallback( source_filepath: filepath, defines: defines ) : []
280
-
281
- arg_hash = {
282
- filepath: @file_path_utils.preprocessed_file_subpath( filepath ),
283
- preprocessed_filepath: preprocessed_filepath,
284
- contents: contents,
285
- extras: extras,
286
- includes: includes
287
- }
288
-
289
- # Create a reconstituted header file
290
- @file_assembler.assemble_preprocessed_header_file( **arg_hash )
291
-
292
- return preprocessed_filepath, includes
293
- end
294
-
295
- def preprocess_partial_source_file_preserve_macros(
296
- test:,
297
- filepath:,
298
- directives_only_filepath:,
299
- fallback:,
300
- flags:,
301
- include_paths:,
302
- vendor_paths:,
303
- defines:
304
- )
305
- msg = @reportinator.generate_module_progress(
306
- operation: 'Preprocessing source file for follow-on Partials handling',
307
- module_name: test,
308
- filename: File.basename( filepath )
253
+ includes = preprocess_file_includes_common(
254
+ test: test, filepath: filepath, directives_only_filepath: directives_only_filepath, fallback: fallback,
255
+ **tool_args.except( :include_paths )
309
256
  )
310
- @loginator.log( msg )
257
+ @loginator.log_list( includes, "Discovered #includes for Partial #{noun} from #{filepath}:", Verbosity::OBNOXIOUS )
311
258
 
312
- preprocessed_filepath = @file_path_utils.form_preprocessed_file_filepath( filepath, test )
259
+ contents, extras = partial_file_contents( filepath, directives_only_filepath, fallback, tool_args[:defines] )
260
+ assembled = @file_path_utils.form_preprocessed_file_filepath( filepath, test )
313
261
 
314
- arg_hash = {
315
- test: test,
316
- filepath: filepath,
317
- directives_only_filepath: directives_only_filepath,
318
- fallback: fallback,
319
- flags: flags,
320
- include_paths: include_paths,
321
- vendor_paths: vendor_paths,
322
- defines: defines
323
- }
324
-
325
- # Extract includes & log progress and info
326
- includes = preprocess_file_includes_common( **arg_hash )
327
-
328
- header = "Discovered #includes for Partial source from #{filepath}:"
329
- @loginator.log_list( includes, header, Verbosity::OBNOXIOUS )
262
+ write_partial_file( kind, filepath, preprocessed_filepath: assembled, contents: contents, extras: extras, includes: includes )
330
263
 
331
- contents =
332
- if fallback
333
- @file_assembler.collect_file_contents_fallback( source_filepath: filepath, defines: defines )
334
- else
335
- @file_assembler.collect_file_contents_from_directives_only_preprocessing( source_filepath: filepath, test: test )
336
- end
337
-
338
- # In fallback mode, #define macros are stripped from contents (all '#' lines skipped).
339
- # Re-extract them so the CExtractor can see them when parsing the reconstituted file.
340
- extras = fallback ? @file_assembler.collect_macros_and_pragmas_fallback( source_filepath: filepath, defines: defines ) : []
341
-
342
- arg_hash = {
343
- filename: File.basename( filepath ),
344
- preprocessed_filepath: preprocessed_filepath,
345
- contents: contents,
346
- extras: extras,
347
- includes: includes
348
- }
349
-
350
- # Create a reconstituted source file
351
- @file_assembler.assemble_preprocessed_code_file( **arg_hash )
352
-
353
- return preprocessed_filepath, includes
264
+ return assembled, includes
354
265
  end
355
266
 
356
267
  def preprocess_test_file(
@@ -361,7 +272,6 @@ class Preprocessinator
361
272
  includes:,
362
273
  flags:,
363
274
  include_paths:,
364
- vendor_paths:,
365
275
  defines:
366
276
  )
367
277
  msg = @reportinator.generate_module_progress(
@@ -402,11 +312,10 @@ class Preprocessinator
402
312
  contents, extras = @file_assembler.collect_test_file_contents( **arg_hash )
403
313
 
404
314
  arg_hash = {
405
- filename: File.basename( filepath ),
406
315
  preprocessed_filepath: preprocessed_filepath,
407
316
  contents: contents,
408
317
  extras: extras,
409
- includes: includes
318
+ includes: includes
410
319
  }
411
320
 
412
321
  # Create a reconstituted test file from preprocessing expansion and preserving any extras
@@ -418,26 +327,30 @@ class Preprocessinator
418
327
  return preprocessed_filepath
419
328
  end
420
329
 
421
- def preprocess_partial_header_expand_macros(filepath:, test:, flags:, include_paths:, vendor_paths:, defines:)
422
- _preprocess_partial_expand_macros(
423
- filepath: filepath,
424
- test: test,
425
- flags: flags,
426
- include_paths: include_paths,
427
- vendor_paths: vendor_paths,
428
- defines: defines
429
- )
430
- end
330
+ # A Partial's header or source in full expansion, where a macro hiding a decorator or a
331
+ # call is visible. The expansion stays whole, since its line markers name every file it
332
+ # entered. The file's own lines are written beside it as plain code, which
333
+ # reconciliation parses. Gives that code's path.
334
+ #
335
+ # Nil when the preprocessor fails, so its caller reconciles nothing. A failure leaves
336
+ # neither file behind, so an earlier run's expansion never passes for this one's.
337
+ def generate_partial_expansion(filepath:, test:, **tool_args)
338
+ progress = { operation: 'Full-preprocessing for Partial reconciliation', module_name: test, filename: File.basename( filepath ) }
339
+ @loginator.log( @reportinator.generate_module_progress( **progress ) )
431
340
 
432
- def preprocess_partial_source_expand_macros(filepath:, test:, flags:, include_paths:, vendor_paths:, defines:)
433
- _preprocess_partial_expand_macros(
434
- filepath: filepath,
435
- test: test,
436
- flags: flags,
437
- include_paths: include_paths,
438
- vendor_paths: vendor_paths,
439
- defines: defines
440
- )
341
+ raw = ensure_output_dir( @file_path_utils.form_preprocessed_file_full_expansion_filepath( filepath, test ) )
342
+ code = @file_path_utils.form_preprocessed_file_expanded_code_filepath( filepath, test )
343
+ result = run_preprocessor( @configurator.tools_test_file_full_preprocessor, filepath, raw, **tool_args )
344
+
345
+ if @tool_executor.failed?( result )
346
+ [raw, code].each { |path| @file_wrapper.rm_f( path ) }
347
+ return log_failure( "Failed to generate full expansion for Partial reconciliation (macro-supplied decorators will be missed) for #{filepath}", Verbosity::COMPLAIN )
348
+ end
349
+
350
+ contents = @file_assembler.collect_own_lines( source_filepath: filepath, preprocessed_filepath: raw )
351
+ @file_assembler.assemble_preprocessed_code_file( preprocessed_filepath: code, contents: contents, extras: [], includes: [] )
352
+
353
+ return code
441
354
  end
442
355
 
443
356
  ### Private ###
@@ -446,7 +359,9 @@ class Preprocessinator
446
359
  # Runs a preprocessor `tool` over `filepath` into `output`. A file's own search paths
447
360
  # come ahead of vendor paths, so a project header wins a name clash. `boom: false` keeps
448
361
  # a failing run from raising: ToolExecutor#exec would otherwise stop the build before the
449
- # caller could fall back in its own way.
362
+ # caller could fall back in its own way. A failure here goes to no BuildStepDoctor
363
+ # diagnosis. Several of these runs are expected to fail and fall back, so their output
364
+ # yields little guidance (see diagnostics/DOCTOR.md).
450
365
  def run_preprocessor(tool, filepath, output, flags:, include_paths:, vendor_paths:, defines:)
451
366
  command = @tool_executor.build_command_line( tool, flags, filepath, output, defines, (include_paths + vendor_paths) )
452
367
  command[:options][:boom] = false
@@ -454,6 +369,28 @@ class Preprocessinator
454
369
  return @tool_executor.exec( command )
455
370
  end
456
371
 
372
+ # A Partial file's content lines and the extras written ahead of them. Fallback reads the
373
+ # original file's text. Its reader skips every `#` line, so the file's macros and
374
+ # pragmas are recovered separately as extras for extraction to see.
375
+ def partial_file_contents(filepath, directives_only_filepath, fallback, defines)
376
+ unless fallback
377
+ return @file_assembler.collect_own_lines( source_filepath: filepath, preprocessed_filepath: directives_only_filepath, rejoin: false ), []
378
+ end
379
+
380
+ return @file_assembler.collect_file_contents_fallback( source_filepath: filepath, defines: defines ),
381
+ @file_assembler.collect_macros_and_pragmas_fallback( source_filepath: filepath, defines: defines )
382
+ end
383
+
384
+ # A Partial's header is written with an include guard named for its path below its root,
385
+ # so two same-named headers differ. A source has no guard.
386
+ def write_partial_file(kind, filepath, **written)
387
+ if kind == :header
388
+ @file_assembler.assemble_preprocessed_header_file( filepath: @file_path_utils.preprocessed_file_subpath( filepath ), **written )
389
+ else
390
+ @file_assembler.assemble_preprocessed_code_file( **written )
391
+ end
392
+ end
393
+
457
394
  # Logs why a preprocessor run failed and gives the nil its caller returns
458
395
  def log_failure(msg, *log_args)
459
396
  @loginator.log( msg, *log_args )
@@ -466,7 +403,7 @@ class Preprocessinator
466
403
  compacted = ensure_output_dir( @file_path_utils.form_preprocessed_file_compacted_directives_only_filepath( filepath, test ) )
467
404
 
468
405
  @comment_stripper.strip_file( raw )
469
- @reconstructor.compact_file_from_expansion( input_filepath: raw, source_filepath: filepath, output_filepath: compacted )
406
+ @reconstructor.compact_file_from_expansion( input_filepath: raw, source_filepath: filepath, output_filepath: compacted, rejoin: false )
470
407
  end
471
408
 
472
409
  # Creates a preprocessed artifact's own directory and hands the path back, so a caller
@@ -506,42 +443,19 @@ class Preprocessinator
506
443
  includes
507
444
  end
508
445
 
509
- # A Partial's file in full expansion, reassembled in place as plain code. Nil when the
510
- # preprocessor fails, so its caller uses directives-only signatures instead.
511
- def _preprocess_partial_expand_macros(filepath:, test:, **tool_args)
512
- progress = { operation: 'Full-preprocessing for expanded Partial signature extraction', module_name: test, filename: File.basename( filepath ) }
513
- @loginator.log( @reportinator.generate_module_progress( **progress ) )
514
-
515
- output = ensure_output_dir( @file_path_utils.form_preprocessed_file_full_expansion_filepath( filepath, test ) )
516
- result = run_preprocessor( @configurator.tools_test_file_full_preprocessor, filepath, output, **tool_args )
517
-
518
- if @tool_executor.failed?( result )
519
- return log_failure( "Failed to generate full expansion for Partial signature extraction (directives-only signatures will be used) for #{filepath}", Verbosity::COMPLAIN )
520
- end
521
-
522
- assemble_full_expansion( filepath, test, output )
523
- return output
524
- end
525
-
526
- def assemble_full_expansion(filepath, test, output)
527
- contents = @file_assembler.collect_file_contents_from_full_expansion( source_filepath: filepath, test: test )
528
- @file_assembler.assemble_preprocessed_code_file(
529
- filename: File.basename( filepath ), preprocessed_filepath: output, contents: contents, extras: [], includes: []
530
- )
531
- end
532
-
533
- # Extracts, reconciles, and persists a header or source file's user/system
534
- # includes. Called only once a caller has already determined, via its own
535
- # DependencyTracker target, that this exact file/test pair is stale --
536
- # see `preprocess_mockable_header_file` above and stages 6/7 in
537
- # test_build_executor.rb -- so the extraction below always runs for real.
446
+ # Extracts, reconciles, and persists a header or source file's user/system #includes.
447
+ # Stage 9 calls it for mockable headers, and stages 6 and 7 for Partial files. Each
448
+ # calls only once its own DependencyTracker target is stale, so the extraction always
449
+ # runs for real.
450
+ #
451
+ # The file's own search paths take no part. The bare pass searches vendor paths alone,
452
+ # and the user and system lists come from output a preprocessor already wrote.
538
453
  def preprocess_file_includes_common(
539
454
  test:,
540
455
  filepath:,
541
456
  directives_only_filepath:,
542
457
  fallback:,
543
458
  flags:,
544
- include_paths:,
545
459
  vendor_paths:,
546
460
  defines:
547
461
  )
@@ -5,8 +5,6 @@
5
5
  # SPDX-License-Identifier: MIT
6
6
  # =========================================================================
7
7
 
8
- require 'stringio'
9
-
10
8
  class PreprocessinatorCodeFinder
11
9
 
12
10
  constructor :file_wrapper
@@ -16,47 +14,47 @@ class PreprocessinatorCodeFinder
16
14
  # Regex-special-character-immune string
17
15
  WHITESPACE_MARKER = '<!@_ws_!@>' unless const_defined?(:WHITESPACE_MARKER)
18
16
 
19
- # Open a GCC preprocessor output file and search it for code.
20
- # Returns the 1-indexed source line number of the match, or nil if not found.
21
- # Intended for production use where preprocessor output resides on disk.
22
- def find_in_preprocessed_file(filepath, code)
17
+ # Open a GCC preprocessor output file once and search it for each code block.
18
+ # Returns each block's 1-indexed source line number, or nil where it isn't found.
19
+ # One read serves every function a file holds. With nothing to find, no file is opened.
20
+ def find_all_in_preprocessed_file(filepath, codes)
21
+ return [] if codes.empty?
22
+
23
23
  # `filepath` is this same build's own gcc preprocessor output -- open_with_retry
24
24
  # rides out the file briefly not yet being visible right after the shell-out exits.
25
25
  @file_wrapper.open_with_retry( filepath, 'r' ) do |file|
26
- return find_in_preprocessed_content( io: file, search: code )
26
+ return find_all_in_preprocessed_content( file.read, codes )
27
27
  end
28
28
  end
29
29
 
30
-
31
- # Wrap a GCC preprocessor output string in a StringIO and search it for code.
30
+ # Search a GCC preprocessor output string for code.
32
31
  # Returns the 1-indexed source line number of the match, or nil if not found.
33
32
  # Intended for test use so that specs require no temporary files.
34
33
  def find_in_preprocessed_string(content, code)
35
- buffer = StringIO.new( content )
36
- return find_in_preprocessed_content( io: buffer, search: code )
34
+ return find_all_in_preprocessed_content( content, [code] ).first
37
35
  end
38
36
 
39
- # Open a C source file and search it for code.
40
- # Returns the 1-indexed source line number of the match, or nil if not found.
41
- # Intended for production use where C file resides on disk.
42
- def find_in_c_file(filepath, code)
37
+ # Open a C source file once and search it for each code block.
38
+ # Returns each block's 1-indexed line number, or nil where it isn't found.
39
+ # With nothing to find, no file is opened.
40
+ def find_all_in_c_file(filepath, codes)
41
+ return [] if codes.empty?
42
+
43
43
  @file_wrapper.open( filepath, 'r' ) do |file|
44
- return find_in_c_code( io: file, search: code )
44
+ return find_all_in_c_content( file.read, codes )
45
45
  end
46
46
  end
47
47
 
48
-
49
- # Wrap a C file content string in a StringIO and search it for code.
48
+ # Search a C file content string for code.
50
49
  # Returns the 1-indexed source line number of the match, or nil if not found.
51
- # Intended for test use so that specs require no temporary files.
50
+ # Partials searches file text it has already read this way.
52
51
  def find_in_c_string(content, code)
53
- buffer = StringIO.new( content )
54
- return find_in_c_code( io: buffer, search: code )
52
+ return find_all_in_c_content( content, [code] ).first
55
53
  end
56
54
 
57
55
  private
58
56
 
59
- # Search a GCC preprocessor output IO stream for an exact match of search.
57
+ # Search GCC preprocessor output for an exact match of each code block.
60
58
  #
61
59
  # GCC preprocessor output intersperses the expanded source text with line
62
60
  # markers of the form:
@@ -66,62 +64,53 @@ class PreprocessinatorCodeFinder
66
64
  # corresponds to line linenum in the named file. Subsequent non-marker lines
67
65
  # increment the source line count by one each.
68
66
  #
69
- # The method locates `search`` as a substring of the full stream content, then
70
- # walks backwards through the line markers that precede the match to find the
71
- # most recent one. The source line number is computed as:
72
- # last_marker_linenum + (newlines between marker end and match start)
67
+ # Each block is located as a substring of the whole content. Its source line is
68
+ # the nearest marker ending at or before the match, plus the newlines between:
69
+ # marker_linenum + (newlines between marker end and match start)
70
+ #
71
+ # The markers are indexed once, on the first match, so every block after it
72
+ # costs only its own search.
73
73
  #
74
- # Returns nil when search is not present in the stream or no line marker
75
- # precedes the match (which indicates malformed preprocessor output).
76
- def find_in_preprocessed_content(io:, search:)
77
- content = io.read
78
- return nil if content.nil? || content.empty?
79
-
80
- # Locate the search string within the preprocessor output
81
- match_pos = whitespace_insensitive_search( content, search )
82
- return nil if match_pos.nil?
83
-
84
- # Examine only the content before the match for GCC line markers.
85
- # Line markers have the form: # <linenum> "<filename>" [optional flags]
86
- # The linenum in each marker refers to the source line immediately following it.
87
- prefix = content[0, match_pos]
88
-
89
- last_marker_num = nil
90
- # Byte position in content after the last marker's newline
91
- last_marker_end = 0
92
-
93
- prefix.scan( LINE_MARKER_REGEX ) do |captures|
94
- last_marker_num = captures[0].to_i
95
- last_marker_end = $~.end(0)
74
+ # A block's line is nil when the block is absent. It is also nil when no line
75
+ # marker precedes the block, a sign of malformed preprocessor output.
76
+ def find_all_in_preprocessed_content(content, searches)
77
+ return Array.new( searches.size ) if content.nil? || content.empty?
78
+
79
+ markers = nil
80
+ return searches.map do |search|
81
+ match_pos = whitespace_insensitive_search( content, search )
82
+ next nil if match_pos.nil?
83
+
84
+ markers ||= line_markers( content )
85
+ preprocessed_line( content, markers, match_pos )
96
86
  end
87
+ end
97
88
 
98
- if last_marker_num.nil?
99
- # No line marker precedes the match -- something is wrong
100
- return nil
101
- end
89
+ # Each line marker's end position and the line number it names, in file order
90
+ def line_markers(content)
91
+ markers = []
92
+ content.scan( LINE_MARKER_REGEX ) { markers << [$~.end( 0 ), $~[1].to_i] }
93
+ return markers
94
+ end
95
+
96
+ # The source line of a match, from the last marker that ends at or before it
97
+ def preprocessed_line(content, markers, match_pos)
98
+ following = markers.bsearch_index { |(stop, _)| stop > match_pos } || markers.size
99
+ return nil if following.zero?
102
100
 
103
- # Each newline between the end of the last line marker line and the match start
104
- # advances the source line by one. The marker's linenum is the base.
105
- newlines_after_marker = content[last_marker_end, match_pos - last_marker_end].count("\n")
106
-
107
- # Return line number of found code (mostly for test validation)
108
- return last_marker_num + newlines_after_marker
101
+ stop, line_num = markers[following - 1]
102
+ return line_num + content[stop, match_pos - stop].count( "\n" )
109
103
  end
110
104
 
111
- # Search a C code IO stream for an exact match of search.
112
- #
113
- # The method locates `search`` as a substring of the full stream content, then
114
- # identifies the source line number. Returns nil when search is not present in
115
- # the stream.
116
- def find_in_c_code(io:, search:)
117
- content = io.read
118
- return nil if content.nil? || content.empty?
119
-
120
- # Locate the search string within the preprocessor output
121
- match_pos = whitespace_insensitive_search( content, search )
122
- return nil if match_pos.nil?
123
-
124
- return (content[0, match_pos].count("\n")) + 1
105
+ # Search C code for an exact match of each code block. Returns each block's
106
+ # 1-indexed line number, or nil where it isn't found.
107
+ def find_all_in_c_content(content, searches)
108
+ return Array.new( searches.size ) if content.nil? || content.empty?
109
+
110
+ return searches.map do |search|
111
+ match_pos = whitespace_insensitive_search( content, search )
112
+ match_pos.nil? ? nil : content[0, match_pos].count( "\n" ) + 1
113
+ end
125
114
  end
126
115
 
127
116
  def whitespace_insensitive_search(content, code)
@@ -135,6 +124,10 @@ class PreprocessinatorCodeFinder
135
124
  # Replace the whitespace token with regex whitespace-insenstive matcher
136
125
  _code.gsub!(/#{WHITESPACE_MARKER}/, '\s+')
137
126
 
127
+ # Code starting with a word can't start in the middle of one, so `int f(void);` never
128
+ # matches inside `uint f(void);`
129
+ _code = '(?<!\w)' + _code if code.match?( /\A\w/ )
130
+
138
131
  # Create the regex we'll use
139
132
  pattern = Regexp.new( _code )
140
133