ceedling 1.2.2 → 1.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (390) hide show
  1. checksums.yaml +4 -4
  2. data/GIT_COMMIT_SHA +1 -1
  3. data/README.md +1 -1
  4. data/assets/fixtures/tests_with_partials_coverage/src/private_macro.c +7 -0
  5. data/assets/fixtures/tests_with_partials_coverage/src/private_macro.h +5 -0
  6. data/assets/fixtures/tests_with_partials_coverage/src/tally.c +13 -0
  7. data/assets/fixtures/tests_with_partials_coverage/src/tally.h +4 -0
  8. data/assets/fixtures/tests_with_partials_coverage/test/test_private_macro.c +10 -0
  9. data/assets/fixtures/tests_with_partials_coverage/test/test_tally.c +9 -0
  10. data/docs/BreakingChanges.md +16 -0
  11. data/docs/Changelog.md +71 -0
  12. data/docs/KnownIssues.md +91 -4
  13. data/examples/wondrous_forest/README.md +29 -1
  14. data/examples/wondrous_forest/src/ForestUnits.h +23 -0
  15. data/examples/wondrous_forest/src/RainGauge.c +59 -0
  16. data/examples/wondrous_forest/src/RainGauge.h +39 -0
  17. data/examples/wondrous_forest/src/RainTipIsr.c +17 -0
  18. data/examples/wondrous_forest/src/RainTipIsr.h +14 -0
  19. data/examples/wondrous_forest/test/TestRainGauge.c +126 -0
  20. data/lib/ceedling/c_extractor/README.md +15 -7
  21. data/lib/ceedling/c_extractor/c_extractor.rb +25 -14
  22. data/lib/ceedling/c_extractor/c_extractor_code_text.rb +84 -54
  23. data/lib/ceedling/c_extractor/c_extractor_constants.rb +18 -7
  24. data/lib/ceedling/c_extractor/c_extractor_declarations.rb +319 -283
  25. data/lib/ceedling/c_extractor/c_extractor_declarator.rb +285 -0
  26. data/lib/ceedling/c_extractor/c_extractor_defined_type.rb +111 -0
  27. data/lib/ceedling/c_extractor/c_extractor_definitions.rb +174 -121
  28. data/lib/ceedling/c_extractor/c_extractor_functions.rb +191 -162
  29. data/lib/ceedling/c_extractor/c_extractor_preprocessing.rb +46 -55
  30. data/lib/ceedling/c_extractor/c_extractor_statement.rb +30 -0
  31. data/lib/ceedling/c_extractor/c_extractor_types.rb +63 -41
  32. data/lib/ceedling/c_extractor/c_module_edits.rb +48 -0
  33. data/lib/ceedling/c_identifier.rb +21 -0
  34. data/lib/ceedling/ceedling.h +8 -0
  35. data/lib/ceedling/config/configurator.rb +4 -3
  36. data/lib/ceedling/config/configurator_builder.rb +17 -0
  37. data/lib/ceedling/config/configurator_setup.rb +29 -5
  38. data/lib/ceedling/constants.rb +5 -1
  39. data/lib/ceedling/defaults.rb +31 -1
  40. data/lib/ceedling/dependencies/CACHE_SCHEMA.md +118 -0
  41. data/lib/ceedling/dependencies/README.md +1 -1
  42. data/lib/ceedling/dependencies/dependency_cache_store.rb +30 -25
  43. data/lib/ceedling/dependencies/dependency_tracker.rb +9 -3
  44. data/lib/ceedling/dependencies/dependinator.rb +13 -1
  45. data/lib/ceedling/diagnostics/DOCTOR.md +142 -0
  46. data/lib/ceedling/diagnostics/README.md +5 -0
  47. data/lib/ceedling/diagnostics/build_step_doctor.rb +110 -0
  48. data/lib/ceedling/diagnostics/duplicate_symbol_specialist.rb +108 -0
  49. data/lib/ceedling/diagnostics/guidance_phrases.rb +30 -0
  50. data/lib/ceedling/diagnostics/header_collision_guidance.rb +56 -0
  51. data/lib/ceedling/diagnostics/header_collision_specialist.rb +152 -0
  52. data/lib/ceedling/diagnostics/include_depth_specialist.rb +132 -0
  53. data/lib/ceedling/diagnostics/missing_symbol_specialist.rb +111 -0
  54. data/lib/ceedling/diagnostics/partial_name_specialist.rb +134 -0
  55. data/lib/ceedling/diagnostics/toolchain_output.rb +44 -0
  56. data/lib/ceedling/filesystem/PATH_HANDLING.md +83 -27
  57. data/lib/ceedling/filesystem/README.md +6 -1
  58. data/lib/ceedling/filesystem/build_roots.rb +105 -0
  59. data/lib/ceedling/filesystem/build_subpath.rb +110 -25
  60. data/lib/ceedling/filesystem/file_finder.rb +76 -110
  61. data/lib/ceedling/filesystem/file_finder_helper.rb +33 -11
  62. data/lib/ceedling/filesystem/file_path_utils.rb +113 -91
  63. data/lib/ceedling/filesystem/file_wrapper.rb +105 -28
  64. data/lib/ceedling/filesystem/path_matcher.rb +21 -0
  65. data/lib/ceedling/filesystem/test_build_layout.rb +114 -0
  66. data/lib/ceedling/filesystem/win_long_paths.rb +153 -0
  67. data/lib/ceedling/filesystem/win_path_limit.rb +83 -0
  68. data/lib/ceedling/filesystem/win_path_prober.rb +52 -0
  69. data/lib/ceedling/generators/generator.rb +27 -64
  70. data/lib/ceedling/generators/generator_helper.rb +0 -44
  71. data/lib/ceedling/generators/generator_mocks.rb +5 -0
  72. data/lib/ceedling/generators/generator_partials.rb +305 -243
  73. data/lib/ceedling/generators/generator_test_runner.rb +5 -8
  74. data/lib/ceedling/generators/partial_header_writer.rb +95 -0
  75. data/lib/ceedling/generators/partial_source_writer.rb +137 -0
  76. data/lib/ceedling/includes/header_search.rb +225 -0
  77. data/lib/ceedling/includes/include_factory.rb +9 -12
  78. data/lib/ceedling/includes/include_pathinator.rb +53 -31
  79. data/lib/ceedling/includes/includes.rb +149 -37
  80. data/lib/ceedling/objects.yml +89 -4
  81. data/lib/ceedling/partials/README.md +110 -16
  82. data/lib/ceedling/partials/carry_plan.rb +71 -0
  83. data/lib/ceedling/partials/definition_head.rb +74 -0
  84. data/lib/ceedling/partials/include_groups.rb +37 -0
  85. data/lib/ceedling/partials/interface_extras.rb +25 -0
  86. data/lib/ceedling/partials/partializer.rb +599 -120
  87. data/lib/ceedling/partials/partializer_config.rb +5 -0
  88. data/lib/ceedling/partials/partializer_helper.rb +851 -145
  89. data/lib/ceedling/partials/partializer_reconciler.rb +174 -0
  90. data/lib/ceedling/partials/partializer_utils.rb +89 -109
  91. data/lib/ceedling/partials/partials.rb +153 -10
  92. data/lib/ceedling/partials/type_macros.rb +126 -0
  93. data/lib/ceedling/preprocess/README.md +43 -33
  94. data/lib/ceedling/preprocess/preprocessinator.rb +100 -186
  95. data/lib/ceedling/preprocess/preprocessinator_code_finder.rb +65 -72
  96. data/lib/ceedling/preprocess/preprocessinator_file_assembler.rb +31 -75
  97. data/lib/ceedling/preprocess/preprocessinator_reconstructor.rb +51 -14
  98. data/lib/ceedling/setupinator.rb +16 -3
  99. data/lib/ceedling/test_invoker/HEADER_COLLISIONS.md +21 -7
  100. data/lib/ceedling/test_invoker/PIPELINE.md +57 -16
  101. data/lib/ceedling/test_invoker/README.md +1 -1
  102. data/lib/ceedling/test_invoker/derived_search_path_notices.rb +45 -0
  103. data/lib/ceedling/test_invoker/mock_locator.rb +116 -9
  104. data/lib/ceedling/test_invoker/partial_files_preprocessinator.rb +181 -0
  105. data/lib/ceedling/test_invoker/partials_manager.rb +265 -308
  106. data/lib/ceedling/test_invoker/standin_headerinator.rb +8 -15
  107. data/lib/ceedling/test_invoker/test_bare_includes_extractinator.rb +26 -3
  108. data/lib/ceedling/test_invoker/test_build_executor.rb +338 -198
  109. data/lib/ceedling/test_invoker/test_build_planner.rb +13 -19
  110. data/lib/ceedling/test_invoker/test_build_setup.rb +26 -6
  111. data/lib/ceedling/test_invoker/test_build_validations.rb +23 -20
  112. data/lib/ceedling/test_invoker/test_derived_search_paths.rb +189 -0
  113. data/lib/ceedling/test_invoker/test_file_preprocessinator.rb +1 -2
  114. data/lib/ceedling/test_invoker/test_includes_reconcilinator.rb +1 -1
  115. data/lib/ceedling/test_invoker/test_invoker_types.rb +28 -20
  116. data/lib/ceedling/test_invoker/test_pipeline_helpers.rb +5 -3
  117. data/lib/ceedling/test_invoker/test_pipeline_manager.rb +25 -8
  118. data/lib/ceedling/test_invoker/test_runner_generatinator.rb +31 -3
  119. data/lib/ceedling/test_invoker/test_search_paths.rb +30 -8
  120. data/lib/ceedling/test_invoker/test_substitutions.rb +72 -0
  121. data/lib/ceedling/tools/shell_quoting.rb +45 -0
  122. data/lib/ceedling/tools/tool_quoting.rb +79 -0
  123. data/lib/ceedling/{tool_validator.rb → tools/tool_validator.rb} +18 -7
  124. data/lib/version.rb +1 -1
  125. data/plugins/bullseye/bullseye.rake +1 -3
  126. data/plugins/bullseye/lib/bullseye.rb +15 -2
  127. data/plugins/command_hooks/lib/command_hooks.rb +1 -1
  128. data/plugins/fff/lib/fff.rb +42 -15
  129. data/plugins/fff/lib/fff_mock_generator.rb +12 -9
  130. data/plugins/fff/spec/fff_cmock_wrapper_spec.rb +134 -0
  131. data/plugins/fff/spec/fff_mock_header_generator_spec.rb +9 -0
  132. data/plugins/fff/spec/fff_mock_source_generator_spec.rb +20 -0
  133. data/plugins/gcov/lib/console_reportinator.rb +25 -19
  134. data/plugins/gcov/lib/reportgenerator_reportinator.rb +2 -1
  135. data/site-local/404.html +2 -2
  136. data/site-local/assets/javascripts/{bundle.c21346df.min.js → bundle.a5f9d56c.min.js} +1 -1
  137. data/site-local/assets/javascripts/{bundle.c21346df.min.js.map → bundle.a5f9d56c.min.js.map} +2 -2
  138. data/site-local/configuration/environment-vars.html +2 -2
  139. data/site-local/configuration/global-collections.html +3 -3
  140. data/site-local/configuration/index.html +2 -2
  141. data/site-local/configuration/loading.html +2 -2
  142. data/site-local/configuration/mixins.html +2 -2
  143. data/site-local/configuration/parallel-builds.html +2 -2
  144. data/site-local/configuration/project-file.html +2 -2
  145. data/site-local/configuration/reference/cexception.html +2 -2
  146. data/site-local/configuration/reference/cmock.html +5 -2
  147. data/site-local/configuration/reference/defines.html +2 -2
  148. data/site-local/configuration/reference/environment.html +2 -2
  149. data/site-local/configuration/reference/extension.html +2 -2
  150. data/site-local/configuration/reference/files.html +56 -9
  151. data/site-local/configuration/reference/flags.html +2 -2
  152. data/site-local/configuration/reference/index.html +2 -2
  153. data/site-local/configuration/reference/libraries.html +2 -2
  154. data/site-local/configuration/reference/mixins.html +2 -2
  155. data/site-local/configuration/reference/partials.html +84 -2
  156. data/site-local/configuration/reference/paths.html +7 -2
  157. data/site-local/configuration/reference/plugins.html +2 -2
  158. data/site-local/configuration/reference/project.html +247 -5
  159. data/site-local/configuration/reference/release-build.html +2 -2
  160. data/site-local/configuration/reference/test-build.html +2 -2
  161. data/site-local/configuration/reference/test-runner.html +2 -2
  162. data/site-local/configuration/reference/tools.html +49 -4
  163. data/site-local/configuration/reference/unity.html +2 -2
  164. data/site-local/configuration/which-ceedling.html +2 -2
  165. data/site-local/development/index.html +2 -2
  166. data/site-local/development/plugins/configuration.html +2 -2
  167. data/site-local/development/plugins/index.html +2 -2
  168. data/site-local/development/plugins/plugin-subclass.html +5 -4
  169. data/site-local/development/plugins/rake-tasks.html +2 -2
  170. data/site-local/development/releases.html +2 -2
  171. data/site-local/development/workflow.html +2 -2
  172. data/site-local/getting-started/builds.html +2 -2
  173. data/site-local/getting-started/command-line.html +2 -2
  174. data/site-local/getting-started/example-projects/cipher-quest.html +2 -2
  175. data/site-local/getting-started/example-projects/index.html +2 -2
  176. data/site-local/getting-started/example-projects/temp-sensor.html +2 -2
  177. data/site-local/getting-started/example-projects/wondrous-forest.html +10 -2
  178. data/site-local/getting-started/index.html +2 -2
  179. data/site-local/getting-started/installation.html +2 -2
  180. data/site-local/getting-started/quick-start.html +2 -2
  181. data/site-local/help.html +2 -2
  182. data/site-local/index.html +2 -2
  183. data/site-local/overview/build-system.html +2 -2
  184. data/site-local/overview/index.html +2 -2
  185. data/site-local/overview/test-environments.html +2 -2
  186. data/site-local/overview/tools-and-frameworks.html +2 -2
  187. data/site-local/plugins/beep.html +2 -2
  188. data/site-local/plugins/bullseye/index.html +45 -38
  189. data/site-local/plugins/bullseye/licensing.html +2 -2
  190. data/site-local/plugins/command-hooks.html +4 -4
  191. data/site-local/plugins/compile-commands-json-db.html +2 -2
  192. data/site-local/plugins/cppcheck.html +2 -2
  193. data/site-local/plugins/dependencies.html +2 -2
  194. data/site-local/plugins/fff.html +16 -2
  195. data/site-local/plugins/gcov/examples.html +2 -2
  196. data/site-local/plugins/gcov/gcovr.html +8 -2
  197. data/site-local/plugins/gcov/index.html +2 -2
  198. data/site-local/plugins/gcov/overview.html +2 -2
  199. data/site-local/plugins/gcov/reportgenerator.html +18 -14
  200. data/site-local/plugins/gcov/reporting.html +2 -2
  201. data/site-local/plugins/gcov/setup.html +2 -2
  202. data/site-local/plugins/gcov/tool-versions.html +2 -2
  203. data/site-local/plugins/gcov/troubleshooting.html +2 -2
  204. data/site-local/plugins/index.html +2 -2
  205. data/site-local/plugins/module-generator.html +2 -2
  206. data/site-local/plugins/report-build-warnings-log.html +2 -2
  207. data/site-local/plugins/report-tests-gtestlike-stdout.html +2 -2
  208. data/site-local/plugins/report-tests-ide-stdout.html +2 -2
  209. data/site-local/plugins/report-tests-log-factory.html +2 -2
  210. data/site-local/plugins/report-tests-pretty-stdout.html +2 -2
  211. data/site-local/plugins/report-tests-raw-output-log.html +2 -2
  212. data/site-local/plugins/report-tests-teamcity-stdout.html +2 -2
  213. data/site-local/plugins/sanitize.html +2 -2
  214. data/site-local/plugins/valgrind.html +2 -2
  215. data/site-local/project/index.html +2 -2
  216. data/site-local/project/release-history.html +2 -2
  217. data/site-local/project/sbom.html +2 -2
  218. data/site-local/project/upgrade.html +2 -2
  219. data/site-local/reference/build-directives.html +2 -2
  220. data/site-local/reference/command-line.html +2 -2
  221. data/site-local/reference/environment-vars.html +2 -2
  222. data/site-local/reference/gcov-plugin.html +2 -2
  223. data/site-local/reference/global-collections.html +12 -12
  224. data/site-local/reference/index.html +2 -2
  225. data/site-local/reference/partials-macros.html +47 -2
  226. data/site-local/reference/project-configuration.html +2 -2
  227. data/site-local/sitemap.xml.gz +0 -0
  228. data/site-local/snapshot/examples/cipher_quest/index.html +2 -2
  229. data/site-local/snapshot/examples/temp_sensor/index.html +2 -2
  230. data/site-local/snapshot/examples/wondrous_forest/index.html +72 -15
  231. data/site-local/testing-guide/build-directives.html +2 -2
  232. data/site-local/testing-guide/conventions.html +67 -22
  233. data/site-local/testing-guide/frameworks.html +2 -2
  234. data/site-local/testing-guide/index.html +2 -2
  235. data/site-local/testing-guide/partials/configuration.html +31 -4
  236. data/site-local/testing-guide/partials/conventions.html +509 -8
  237. data/site-local/testing-guide/partials/directives.html +4 -3
  238. data/site-local/testing-guide/partials/example.html +2 -2
  239. data/site-local/testing-guide/partials/index.html +2 -2
  240. data/site-local/testing-guide/partials/overview.html +30 -12
  241. data/site-local/testing-guide/partials/variables.html +169 -4
  242. data/site-local/testing-guide/test-cases.html +2 -2
  243. data/site-local/testing-guide/test-sample.html +2 -2
  244. data/site-local/testing-guide/test-suite-anatomy.html +2 -2
  245. data/spec/integration/build_step_doctor_spec.rb +270 -0
  246. data/spec/integration/c_extractor_composition_spec.rb +254 -4
  247. data/spec/integration/includes_extraction_spec.rb +27 -14
  248. data/spec/integration/nested_test_artifacts_spec.rb +1 -1
  249. data/spec/integration/partial_files_preprocessing_spec.rb +128 -0
  250. data/spec/integration/partials_carry_spec.rb +520 -0
  251. data/spec/integration/partials_declarations_spec.rb +655 -0
  252. data/spec/integration/partials_fallback_preprocessing_spec.rb +65 -0
  253. data/spec/integration/partials_function_pointers_spec.rb +277 -0
  254. data/spec/integration/partials_header_composition_spec.rb +268 -35
  255. data/spec/integration/partials_macro_decorators_spec.rb +267 -0
  256. data/spec/integration/partials_module_resolution_spec.rb +26 -19
  257. data/spec/integration/partials_symbol_linkage_spec.rb +13 -0
  258. data/spec/integration/path_length_reporting_spec.rb +64 -0
  259. data/spec/integration/path_scenarios_spec.rb +80 -3
  260. data/spec/integration/quote_include_isolator_spec.rb +56 -0
  261. data/spec/integration/test_build_parallel_barrier_spec.rb +1 -1
  262. data/spec/integration/test_includes_extractinator_spec.rb +70 -5
  263. data/spec/integration/test_naming_spec.rb +6 -3
  264. data/spec/integration/test_source_file_checks_spec.rb +5 -3
  265. data/spec/integration/tool_executor_spec.rb +1 -1
  266. data/spec/integration/tool_validator_spec.rb +2 -2
  267. data/spec/integration/win_long_paths_probe_spec.rb +46 -0
  268. data/spec/integration/win_path_limit_spec.rb +53 -0
  269. data/spec/integration/windows_registry_query_tool_spec.rb +41 -0
  270. data/spec/support/integration/configurator_integration_helper.rb +8 -3
  271. data/spec/support/integration/partial_files_harness.rb +181 -0
  272. data/spec/support/integration/partials_generation_integration_helper.rb +237 -141
  273. data/spec/support/integration/path_scenario_harness.rb +4 -2
  274. data/spec/support/integration/spec_integration_helper.rb +8 -3
  275. data/spec/support/integration/test_includes_harness.rb +56 -35
  276. data/spec/support/integration/tool_executor_integration_helper.rb +14 -2
  277. data/spec/system/bullseye_deployment_spec.rb +2 -0
  278. data/spec/system/delta_builds_spec.rb +26 -12
  279. data/spec/system/encoding_stress_spec.rb +4 -4
  280. data/spec/system/example_wondrous_forest_spec.rb +2 -2
  281. data/spec/system/gcov_deployment_spec.rb +2 -0
  282. data/spec/system/header_include_path_validation_spec.rb +4 -4
  283. data/spec/system/header_search_paths_spec.rb +1083 -0
  284. data/spec/system/mock_include_folders_spec.rb +121 -0
  285. data/spec/system/mockable_header_reassembly_spec.rb +184 -0
  286. data/spec/system/partials_carry_spec.rb +581 -0
  287. data/spec/system/partials_delta_builds_spec.rb +280 -0
  288. data/spec/system/partials_function_pointers_spec.rb +106 -0
  289. data/spec/system/partials_macro_decorators_spec.rb +127 -0
  290. data/spec/system/partials_module_disambiguation_spec.rb +125 -0
  291. data/spec/system/path_handling_probes_spec.rb +16 -12
  292. data/spec/system/pinned_thread_count_spec.rb +4 -4
  293. data/spec/system/preprocessing_fallback_conditionals_spec.rb +1 -1
  294. data/spec/system/short_build_paths_spec.rb +87 -0
  295. data/spec/system/sibling_header_collision_spec.rb +30 -6
  296. data/spec/system/support/bullseye_common_test_cases.rb +42 -0
  297. data/spec/system/support/common_test_cases.rb +2 -2
  298. data/spec/system/support/gcov_partials_test_cases.rb +48 -0
  299. data/spec/system/test_build_layout_spec.rb +209 -0
  300. data/spec/system/test_source_file_directive_spec.rb +35 -5
  301. data/spec/units/c_extractor/c_extractor_code_text_spec.rb +67 -10
  302. data/spec/units/c_extractor/c_extractor_declarations_spec.rb +501 -4
  303. data/spec/units/c_extractor/c_extractor_declarator_spec.rb +245 -0
  304. data/spec/units/c_extractor/c_extractor_defined_type_spec.rb +45 -0
  305. data/spec/units/c_extractor/c_extractor_definitions_spec.rb +163 -3
  306. data/spec/units/c_extractor/c_extractor_functions_spec.rb +462 -21
  307. data/spec/units/c_extractor/c_extractor_preprocessing_spec.rb +39 -0
  308. data/spec/units/c_extractor/c_extractor_spec.rb +4 -4
  309. data/spec/units/c_extractor/c_extractor_types_spec.rb +163 -0
  310. data/spec/units/c_identifier_spec.rb +35 -0
  311. data/spec/units/config/configurator_builder_spec.rb +24 -0
  312. data/spec/units/config/configurator_setup_spec.rb +72 -4
  313. data/spec/units/config/configurator_spec.rb +27 -1
  314. data/spec/units/dependencies/dependency_cache_store_spec.rb +68 -3
  315. data/spec/units/dependencies/dependency_tracker_spec.rb +25 -0
  316. data/spec/units/dependencies/dependinator_spec.rb +17 -2
  317. data/spec/units/diagnostics/build_step_doctor_spec.rb +170 -0
  318. data/spec/units/diagnostics/duplicate_symbol_specialist_spec.rb +117 -0
  319. data/spec/units/diagnostics/header_collision_specialist_spec.rb +267 -0
  320. data/spec/units/diagnostics/include_depth_specialist_spec.rb +137 -0
  321. data/spec/units/diagnostics/missing_symbol_specialist_spec.rb +154 -0
  322. data/spec/units/diagnostics/partial_name_specialist_spec.rb +129 -0
  323. data/spec/units/diagnostics/toolchain_output_spec.rb +86 -0
  324. data/spec/units/encodinator_spec.rb +3 -4
  325. data/spec/units/filesystem/build_roots_spec.rb +131 -0
  326. data/spec/units/filesystem/build_subpath_spec.rb +113 -0
  327. data/spec/units/filesystem/file_finder_helper_spec.rb +80 -0
  328. data/spec/units/filesystem/file_finder_spec.rb +242 -58
  329. data/spec/units/filesystem/file_path_utils_spec.rb +251 -118
  330. data/spec/units/filesystem/file_wrapper_spec.rb +191 -6
  331. data/spec/units/filesystem/path_matcher_spec.rb +36 -0
  332. data/spec/units/filesystem/test_build_layout_spec.rb +216 -0
  333. data/spec/units/filesystem/win_long_paths_spec.rb +204 -0
  334. data/spec/units/filesystem/win_path_prober_spec.rb +158 -0
  335. data/spec/units/generators/generator_helper_spec.rb +0 -60
  336. data/spec/units/generators/generator_mocks_spec.rb +13 -0
  337. data/spec/units/generators/generator_partials_spec.rb +656 -55
  338. data/spec/units/generators/generator_spec.rb +26 -0
  339. data/spec/units/generators/generator_test_runner_spec.rb +9 -5
  340. data/spec/units/generators/partial_source_writer_spec.rb +129 -0
  341. data/spec/units/includes/header_search_spec.rb +406 -0
  342. data/spec/units/includes/include_factory_spec.rb +22 -5
  343. data/spec/units/includes/include_pathinator_spec.rb +77 -13
  344. data/spec/units/includes/include_spec.rb +14 -0
  345. data/spec/units/includes/includes_spec.rb +176 -19
  346. data/spec/units/loginator_spec.rb +31 -0
  347. data/spec/units/mock_locator_spec.rb +199 -5
  348. data/spec/units/partials/include_groups_spec.rb +42 -0
  349. data/spec/units/partials/partializer_config_spec.rb +25 -0
  350. data/spec/units/partials/partializer_helper_carry_spec.rb +661 -0
  351. data/spec/units/partials/partializer_helper_interface_extras_spec.rb +396 -0
  352. data/spec/units/partials/partializer_helper_spec.rb +529 -277
  353. data/spec/units/partials/partializer_reconciler_spec.rb +661 -0
  354. data/spec/units/partials/partializer_spec.rb +1578 -270
  355. data/spec/units/partials/partializer_utils_spec.rb +269 -232
  356. data/spec/units/partials/partials_rename_spec.rb +160 -0
  357. data/spec/units/partials_manager_spec.rb +554 -261
  358. data/spec/units/plugins/bullseye_spec.rb +34 -0
  359. data/spec/units/plugins/console_reportinator_spec.rb +58 -9
  360. data/spec/units/plugins/report_tests_teamcity_stdout_spec.rb +1 -1
  361. data/spec/units/plugins/reportgenerator_reportinator_spec.rb +51 -3
  362. data/spec/units/preprocess/preprocessinator_code_finder_spec.rb +73 -10
  363. data/spec/units/preprocess/preprocessinator_file_assembler_spec.rb +125 -37
  364. data/spec/units/preprocess/preprocessinator_includes_handler_spec.rb +15 -0
  365. data/spec/units/preprocess/preprocessinator_reconstructor_spec.rb +197 -0
  366. data/spec/units/preprocess/preprocessinator_spec.rb +153 -95
  367. data/spec/units/setupinator_spec.rb +51 -0
  368. data/spec/units/standin_headerinator_spec.rb +27 -11
  369. data/spec/units/test_build_executor_spec.rb +780 -166
  370. data/spec/units/test_build_planner_spec.rb +116 -28
  371. data/spec/units/test_build_setup_spec.rb +83 -18
  372. data/spec/units/test_context_extractor_spec.rb +11 -2
  373. data/spec/units/test_derived_search_paths_spec.rb +259 -0
  374. data/spec/units/test_includes_extractinator_spec.rb +56 -8
  375. data/spec/units/test_invoker/objects_wiring_spec.rb +20 -3
  376. data/spec/units/test_invoker/partial_files_preprocessinator_spec.rb +264 -0
  377. data/spec/units/test_invoker/test_substitutions_spec.rb +122 -0
  378. data/spec/units/test_invoker_types_spec.rb +8 -7
  379. data/spec/units/test_pipeline_manager_spec.rb +54 -13
  380. data/spec/units/test_runner_generatinator_spec.rb +93 -1
  381. data/spec/units/test_search_paths_spec.rb +73 -5
  382. data/spec/units/{default_tools_quoting_spec.rb → tools/default_tools_quoting_spec.rb} +39 -5
  383. data/spec/units/tools/shell_quoting_spec.rb +76 -0
  384. data/spec/units/{tool_executor_helper_spec.rb → tools/tool_executor_helper_spec.rb} +1 -1
  385. data/spec/units/{tool_executor_spec.rb → tools/tool_executor_spec.rb} +1 -1
  386. data/spec/units/{tool_validator_spec.rb → tools/tool_validator_spec.rb} +110 -1
  387. data/spec/units/windows_registry_query_tool_spec.rb +53 -0
  388. metadata +161 -16
  389. /data/lib/ceedling/{tool_executor.rb → tools/tool_executor.rb} +0 -0
  390. /data/lib/ceedling/{tool_executor_helper.rb → tools/tool_executor_helper.rb} +0 -0
@@ -49,18 +49,15 @@ class GeneratorTestRunner
49
49
  # filename here drops both the directory component and the '<>' delimiters a
50
50
  # system header's own search path depends on (issue #1236).
51
51
  #
52
- # User includes: bare filename, same as always. Unlike mocks (whose subdirectory
53
- # is a real, dedicated build/test/mocks/<test>/ path -- hence their own
54
- # directory-preserving filepath usage above) or a system header (whose directory
55
- # is meaningful to the system include search path), a project's own directories
56
- # are exposed to the compiler as a flat list of -I search paths, not nested to
57
- # match whatever directory component a captured UserInclude's filepath happens to
58
- # carry -- rendering the full path here breaks resolution instead of fixing it.
52
+ # User includes: the spelling the caller found the header by through the test's
53
+ # search paths (include_path), else the bare filename. A captured UserInclude's
54
+ # filepath can be the header's resolved location, which the runner's -I search
55
+ # paths don't reach, so it is never rendered.
59
56
  includes.map do |include|
60
57
  if include.is_a?(SystemInclude)
61
58
  "<#{include.include_path || include.filepath}>"
62
59
  else
63
- include.filename
60
+ include.include_path || include.filename
64
61
  end
65
62
  end
66
63
  )
@@ -0,0 +1,95 @@
1
+ # =========================================================================
2
+ # Ceedling - Test-Centered Build System for C
3
+ # ThrowTheSwitch.org
4
+ # Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
5
+ # SPDX-License-Identifier: MIT
6
+ # =========================================================================
7
+
8
+ require 'ceedling/filesystem/file_wrapper'
9
+
10
+ # Writes one of a Partial's generated headers one item at a time.
11
+ #
12
+ # GeneratorPartials decides what each item is. The writer keeps the state that spans items: the
13
+ # blank lines around functions and the source's later includes, which go where the module
14
+ # header's items end. Every generated header opens and closes the same way, so the writer owns
15
+ # both ends.
16
+ class PartialHeaderWriter
17
+
18
+ # @param io [IO] Output file handle
19
+ # @param name [String] The header's filename, from which its own include guard comes
20
+ def initialize(io:, name:)
21
+ @io = io
22
+ @guard = FileWrapper.generate_include_guard( name )
23
+ @written = false
24
+ @last_was_function = false
25
+ end
26
+
27
+ # Everything above the header's own content: its include guard, the spoof of the real module
28
+ # header's guard, and the includes that header carries.
29
+ #
30
+ # The order of the last two is the whole point. A carried header can transitively reach the
31
+ # real module header, so the spoof has to be satisfied before any include is processed rather
32
+ # than after. And relocated content names things a generated file does not define, so without
33
+ # the includes it compiles only where something earlier in the translation unit happened to
34
+ # supply those names.
35
+ #
36
+ # @param include_guard [String, nil] The real module header's own guard, or nil when it has none
37
+ # and so supplies nothing to spoof
38
+ # @param includes [Array] The includes ahead of the header's content
39
+ # @param flag [String, nil] Defined ahead of the spoof only when the real header's guard
40
+ # isn't yet, so content the real header would supply follows only where it hasn't arrived
41
+ def preamble(include_guard, includes, flag: nil)
42
+ @io << "#ifndef #{@guard}\n"
43
+ @io << "#define #{@guard}\n\n"
44
+ @io << "#ifndef #{include_guard}\n#define #{flag}\n#endif\n" if include_guard and flag
45
+ @io << "#define #{include_guard}\n\n" if include_guard
46
+ return if includes.empty?
47
+
48
+ includes.each { |include| @io << "#{include}\n" }
49
+ @io << "\n"
50
+ end
51
+
52
+ # A line of content that is no function, such as a macro, a type or an extern
53
+ def line(text)
54
+ @io << text << "\n"
55
+ _wrote( function: false )
56
+ end
57
+
58
+ # A function's signature, set apart from what precedes it by a blank line
59
+ def function(signature)
60
+ @io << "\n" if @written and !@last_was_function
61
+ @io << signature << ";\n\n"
62
+ _wrote( function: true )
63
+ end
64
+
65
+ # The source's includes after the module header, written where the header's items end, as the
66
+ # source meets them when it compiles. The spoof keeps the real header out, so these includes
67
+ # find its types and macros only in what a generated header writes ahead of them. `macros` are
68
+ # header macros held back until the includes, which come first. Both lists are consumed, so
69
+ # only the first call with includes writes anything.
70
+ def following_includes(includes, macros: [])
71
+ return if includes.empty?
72
+
73
+ macros.each { |macro| @io << "#{macro.text}\n" }
74
+ @io << "\n" if (@written and !@last_was_function) or macros.any?
75
+ includes.each { |include| @io << "#{include}\n" }
76
+ @io << "\n"
77
+ macros.clear
78
+ includes.clear
79
+ # The includes end in a blank line, as a function does
80
+ _wrote( function: true )
81
+ end
82
+
83
+ # A blank line before the guard's close when the last item didn't already end in one
84
+ def finish
85
+ @io << "\n" if @written and !@last_was_function
86
+ @io << "#endif // #{@guard}\n\n"
87
+ end
88
+
89
+ private
90
+
91
+ def _wrote(function:)
92
+ @last_was_function = function
93
+ @written = true
94
+ end
95
+ end
@@ -0,0 +1,137 @@
1
+ # =========================================================================
2
+ # Ceedling - Test-Centered Build System for C
3
+ # ThrowTheSwitch.org
4
+ # Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
5
+ # SPDX-License-Identifier: MIT
6
+ # =========================================================================
7
+
8
+ require 'set'
9
+
10
+ # Writes a Partial's implementation source one item at a time.
11
+ #
12
+ # GeneratorPartials decides what each item is. The writer keeps the state that spans items: an
13
+ # open run of carried prototypes inside its GCC pragmas, a #line that points at another file,
14
+ # the blank lines between functions, and the functions already written.
15
+ #
16
+ # A #line ties generated code back to its original file and line, so debuggers, compiler
17
+ # messages and gcov coverage all point at the real file. After a located item, a #line hands
18
+ # attribution back to this file before the next item without a location of its own. That only
19
+ # holds if this file's line count matches what each #line promises, which is why the file is
20
+ # written in binary mode and every line written here is counted.
21
+ class PartialSourceWriter
22
+
23
+ # Carried prototypes can repeat a declaration a header already made. These pragmas keep GCC's
24
+ # -Wredundant-decls quiet for just those lines. Compilers that don't define __GNUC__ never see them.
25
+ REDUNDANT_DECLS_PUSH = "#if defined(__GNUC__)\n#pragma GCC diagnostic push\n#pragma GCC diagnostic ignored \"-Wredundant-decls\"\n#endif\n" unless const_defined?(:REDUNDANT_DECLS_PUSH, false)
26
+ REDUNDANT_DECLS_POP = "#if defined(__GNUC__)\n#pragma GCC diagnostic pop\n#endif\n" unless const_defined?(:REDUNDANT_DECLS_POP, false)
27
+
28
+ # Passes writes through and counts the lines written, so a #line can name this file's own next line
29
+ class LineCountingIO
30
+ attr_reader :lines
31
+
32
+ def initialize(io)
33
+ @io = io
34
+ @lines = 0
35
+ end
36
+
37
+ def <<(text)
38
+ text = text.to_s
39
+ @io << text
40
+ @lines += text.count( "\n" )
41
+ return self
42
+ end
43
+ end
44
+
45
+ # @param io [IO] Output file handle
46
+ # @param filepath [String, nil] This file's own path, named when attribution returns to it
47
+ # @param suppress_redundant_decls [Boolean] Whether carried prototypes sit inside GCC pragmas
48
+ def initialize(io:, filepath:, suppress_redundant_decls:)
49
+ @io = LineCountingIO.new( io )
50
+ @filepath = filepath
51
+ @suppress = suppress_redundant_decls
52
+ @wrapped = false # a run of prototypes is open inside its pragmas
53
+ @anchored = false # the last #line named another file
54
+ @last_was_function = false
55
+ @written = false
56
+ @functions = Set.new
57
+ end
58
+
59
+ def preamble(includes)
60
+ @io << "// Ceedling generated file\n"
61
+ includes.each { |include| @io << "#{include}\n" }
62
+ @io << "\n"
63
+ end
64
+
65
+ # A line of text with no location of its own, such as a variable or bare macro invocation
66
+ def text(text)
67
+ _close_run
68
+ _hand_back
69
+ @io << text
70
+ _wrote( function: false )
71
+ end
72
+
73
+ # A carried prototype, written as the user spelled it, so `extern inline` keeps making this
74
+ # file hold the external definition
75
+ def prototype(decl)
76
+ _open_run
77
+ _attribute( decl )
78
+ @io << decl.signature.strip << "\n"
79
+ _wrote( function: false )
80
+ end
81
+
82
+ # A selected function or carried helper. A name already written is skipped.
83
+ def function(func)
84
+ return if func.nil? or @functions.include?( func.name )
85
+
86
+ _close_run
87
+ # Blank line before a function when preceded by a non-function item
88
+ @io << "\n" if @written and !@last_was_function
89
+ _attribute( func )
90
+ @io << func.code_block << "\n\n"
91
+ @functions << func.name
92
+ _wrote( function: true )
93
+ end
94
+
95
+ def finish
96
+ _close_run
97
+ end
98
+
99
+ private
100
+
101
+ def _open_run
102
+ return if @wrapped or !@suppress
103
+
104
+ @io << REDUNDANT_DECLS_PUSH
105
+ @wrapped = true
106
+ end
107
+
108
+ def _close_run
109
+ @io << REDUNDANT_DECLS_POP if @wrapped
110
+ @wrapped = false
111
+ end
112
+
113
+ # A located item takes a #line naming its own file and line. Any other item belongs to this file.
114
+ def _attribute(item)
115
+ return _hand_back unless item.line_num and item.source_filepath
116
+
117
+ @io << _line_marker( item.line_num, item.source_filepath )
118
+ @anchored = true
119
+ end
120
+
121
+ # What follows a located item belongs to this file again. The directive itself takes a line,
122
+ # so the next line is two past the count so far.
123
+ def _hand_back
124
+ @io << _line_marker( @io.lines + 2, @filepath ) if @anchored and @filepath
125
+ @anchored = false
126
+ end
127
+
128
+ # Forward slashes, since a backslash in a #line string starts an escape sequence
129
+ def _line_marker(line_num, filepath)
130
+ return "#line #{line_num} \"#{filepath.tr( '\\', '/' )}\"\n"
131
+ end
132
+
133
+ def _wrote(function:)
134
+ @last_was_function = function
135
+ @written = true
136
+ end
137
+ end
@@ -0,0 +1,225 @@
1
+ # =========================================================================
2
+ # Ceedling - Test-Centered Build System for C
3
+ # ThrowTheSwitch.org
4
+ # Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
5
+ # SPDX-License-Identifier: MIT
6
+ # =========================================================================
7
+
8
+ require 'ceedling/filesystem/path_matcher'
9
+ require 'ceedling/filesystem/project_paths'
10
+
11
+ # Directory listings of headers, each indexed by filename, listed once for a search
12
+ class HeaderListings
13
+
14
+ def initialize(lister)
15
+ @lister = lister
16
+ @by_dir = {}
17
+ @lock = Mutex.new
18
+ end
19
+
20
+ # A directory's headers
21
+ def headers(dir)
22
+ return entry( dir ).first
23
+ end
24
+
25
+ # The header named `name` in `dir`, letter case and all, or nil
26
+ def named(dir, name)
27
+ return entry( dir ).last[name]
28
+ end
29
+
30
+ private
31
+
32
+ # A directory's headers and the same headers by filename, the first of a name kept
33
+ def entry(dir)
34
+ listed = @lock.synchronize { @by_dir[dir] }
35
+ return listed unless listed.nil?
36
+
37
+ headers = @lister.call( dir )
38
+ names = headers.each_with_object( {} ) { |header, by_name| by_name[File.basename( header )] ||= header }
39
+ return @lock.synchronize { @by_dir[dir] ||= [headers, names].freeze }
40
+ end
41
+
42
+ end
43
+
44
+ # A test's real headers, found the way its compiler finds them: each search path in
45
+ # order, joined with the path an #include names. A bare name joins to a search path's
46
+ # own listing, so it finds exactly the headers a flat listing of every search path holds.
47
+ #
48
+ # An #include's spelling is the text it names its header by, between its quotes. One header
49
+ # can have several. With `src` and `src/drivers` both searched, `foo.h` and `drivers/foo.h`
50
+ # both name `src/drivers/foo.h`. A spelling reaches a header when the compiler, joining it
51
+ # with each search path in order, finds that header first. A file Ceedling generates lives
52
+ # away from the file it comes from, so it includes each header by a spelling that reaches it
53
+ # (`spelling`) or, where no spelling reaches it, by its absolute path. A header generated in the
54
+ # build root keeps its text, since the compiler's own search paths reach it. A respelling
55
+ # replaces a text that reaches another header, or none.
56
+ #
57
+ # An #include after stage 4 can carry a path the test never wrote: GCC's resolved
58
+ # path for a plain #include, or a computed mock's place below its mirror root. When no
59
+ # search path joins to a query, the query matches the trailing path of a header directly
60
+ # in a search path, and then names a header itself when one lies below a search path.
61
+ #
62
+ # Each directory is listed once for the search's lifetime, so one search serves a
63
+ # test's every lookup in one stage.
64
+ class HeaderSearch
65
+
66
+ # Characters a directory listing would read as a glob
67
+ GLOB_CHARACTERS = /[*?\[\]{}]/
68
+
69
+ attr_reader :paths
70
+
71
+ # A query as every search reads it: forward slashes, with no `.` or empty segments. A
72
+ # drive letter, a root `/`, and a Windows share's `//` stay.
73
+ def self.normalized(query)
74
+ query = query.to_s.tr( '\\', '/' )
75
+ root = query[%r{\A(?:[A-Za-z]:/|/+)}].to_s
76
+ rest = query.delete_prefix( root )
77
+ root = (ProjectPaths.unc?( root ) ? '//' : '/') if root.start_with?( '/' )
78
+
79
+ return root + ProjectPaths.segments( rest ).join( '/' )
80
+ end
81
+
82
+ # The ways a query names headers, tried in turn: the compiler's join first
83
+ TIERS = [:joined, :trailing, :named].freeze
84
+
85
+ # `paths` in search order. `lister` gives a directory's headers. `refusals` explain, by
86
+ # the query a test's #include asks for, why no search path reaches its header. `build_root`
87
+ # holds the headers Ceedling generates.
88
+ def initialize(paths, lister, refusals: {}, build_root: nil)
89
+ @paths = paths
90
+ @listings = HeaderListings.new( lister )
91
+ @refusals = refusals.to_h { |query, why| [normalized( query ), why] }
92
+ @build_root = build_root
93
+ end
94
+
95
+ # The headers `query` names, the one the compiler includes first. Empty for none.
96
+ def header_candidates(query)
97
+ query = normalized( query )
98
+
99
+ # A bare name names no directory, so only a join can find it
100
+ TIERS.each do |tier|
101
+ next if tier != :joined and File.dirname( query ) == '.'
102
+
103
+ found = send( tier, query )
104
+ return distinct( found ) unless found.empty?
105
+ end
106
+
107
+ return []
108
+ end
109
+
110
+ # Whether a search path joined with `text` names a header, as the compiler's -I does
111
+ def joins?(text)
112
+ return !joined( normalized( text ) ).empty?
113
+ end
114
+
115
+ # Every header a search for `query` looked at, for a hint at one in another letter case
116
+ def hint_files(query)
117
+ query = normalized( query )
118
+ dirs = joinable?( query ) ? @paths.map { |path| joined_directory( path, query ) } : []
119
+ dirs << File.dirname( query ) if nameable?( query )
120
+
121
+ return (dirs.flat_map { |dir| listing( dir ) } + flat).uniq
122
+ end
123
+
124
+ # Why no search path reaches the header `query` names, for the error its failed lookup
125
+ # raises. Nil when Ceedling refused no search path for it.
126
+ def refusal(query)
127
+ return @refusals[normalized( query )]
128
+ end
129
+
130
+ # The header at `path` itself, as its directory lists it, or nil. A preprocessor's #include
131
+ # names its header by such a path, which a search path joined with it could name another by.
132
+ def at(path)
133
+ path = normalized( path )
134
+ return nameable?( path ) ? named_in( File.dirname( path ), File.basename( path ) ) : nil
135
+ end
136
+
137
+ # A spelling that reaches `header` through these search paths: `preferring` when it does,
138
+ # then the header's filename, otherwise its path below the earliest search path that reaches
139
+ # it. Nil for none.
140
+ def spelling(header, preferring: nil)
141
+ target = location( header )
142
+ texts = [preferring, File.basename( header )] + @paths.filter_map { |path| ProjectPaths.subdir_below( path, header ) }
143
+
144
+ return texts.compact.uniq.find do |text|
145
+ found = joined( normalized( text ) ).first
146
+ !found.nil? and location( found ) == target
147
+ end
148
+ end
149
+
150
+ # Whether `header` lies in the build root. The compiler's search paths include the directories
151
+ # Ceedling generates headers in, which these paths leave out.
152
+ def generated?(header)
153
+ return !@build_root.nil? && ProjectPaths.contains?( @build_root, header )
154
+ end
155
+
156
+ # Every header directly in a search path, in search order
157
+ def flat
158
+ return @flat ||= @paths.flat_map { |path| listing( path ) }.uniq
159
+ end
160
+
161
+ private
162
+
163
+ def normalized(query)
164
+ return HeaderSearch.normalized( query )
165
+ end
166
+
167
+ # Each search path joined with the query's path, holding the query's file
168
+ def joined(query)
169
+ return [] unless joinable?( query )
170
+
171
+ name = File.basename( query )
172
+ return @paths.filter_map { |path| named_in( joined_directory( path, query ), name ) }
173
+ end
174
+
175
+ # A header directly in a search path whose trailing path is the query
176
+ def trailing(query)
177
+ return PathMatcher.candidates( query, flat )
178
+ end
179
+
180
+ # The query itself, when it names a header at or below a search path
181
+ def named(query)
182
+ return [] unless @paths.any? { |path| ProjectPaths.contains?( path, File.dirname( query ) ) }
183
+
184
+ return [at( query )].compact
185
+ end
186
+
187
+ # A relative path the compiler would join: no `..` and no glob character in its
188
+ # directory, which a listing would expand
189
+ def joinable?(query)
190
+ return false if PathMatcher.absolute?( query ) or File.dirname( query ).match?( GLOB_CHARACTERS )
191
+
192
+ return !ProjectPaths.segments( query ).include?( '..' )
193
+ end
194
+
195
+ def nameable?(query)
196
+ dir = File.dirname( query )
197
+ return (dir != '.' and !dir.match?( GLOB_CHARACTERS ))
198
+ end
199
+
200
+ def joined_directory(path, query)
201
+ dir = File.dirname( query )
202
+ return dir == '.' ? path : File.join( path, dir )
203
+ end
204
+
205
+ # One header reached through two spellings of one directory is one candidate
206
+ def distinct(found)
207
+ return found if found.length < 2
208
+
209
+ return found.uniq { |header| location( header ) }
210
+ end
211
+
212
+ def location(header)
213
+ absolute = ProjectPaths.absolute( header )
214
+ return ProjectPaths::WINDOWS ? absolute.downcase : absolute
215
+ end
216
+
217
+ def named_in(dir, name)
218
+ return @listings.named( dir, name )
219
+ end
220
+
221
+ def listing(dir)
222
+ return @listings.headers( dir )
223
+ end
224
+
225
+ end
@@ -10,7 +10,7 @@ require 'ceedling/includes/includes'
10
10
 
11
11
  class IncludeFactory
12
12
 
13
- constructor :configurator
13
+ constructor :configurator, :test_build_layout
14
14
 
15
15
  def user_include_from_directive(directive)
16
16
  results = directive.match(PATTERNS::USER_INCLUDE_DIRECTIVE_FILENAME)
@@ -40,18 +40,15 @@ class IncludeFactory
40
40
 
41
41
  # A resolved mock include's filepath may carry a leading build directory path that
42
42
  # snuck in from discovering an empty mock stand-in or an already-generated mock file.
43
- # That leading path is the current test's own mock subdirectory -- named by the test's
44
- # path from the project root, so it can be more than one segment deep (e.g.
45
- # `test/adc/TestFoo`) -- followed by however many further segments mirror
46
- # the mocked header's own relative directory (e.g. `calculators/`). Knowing the current
47
- # test's identity lets exactly the first part be removed, leaving any header-mirroring
48
- # segments after it untouched. Without that identity, fall back to stripping everything
49
- # up through the last segment, the best a caller lacking test context can do.
43
+ # That leading path is the current test's own mock root (TestBuildLayout), followed by
44
+ # however many further segments mirror the mocked header's own relative directory (e.g.
45
+ # `calculators/`). Knowing the current test's identity lets exactly the root be removed,
46
+ # leaving any header-mirroring segments after it untouched. Without that identity, fall
47
+ # back to stripping everything up through the last segment, the best a caller lacking
48
+ # test context can do.
50
49
  def strip_mock_test_subdir(filepath, test)
51
- if test
52
- prefix = File.join( @configurator.cmock_mock_path, test.to_s ) + '/'
53
- return filepath.start_with?( prefix ) ? filepath[prefix.length..] : filepath
54
- end
50
+ return @test_build_layout.subpath( filepath, kind: :mocks, name: test ) || filepath if test
51
+
55
52
  return filepath.sub( /^#{Regexp.escape( @configurator.cmock_mock_path )}\/.+\//, '' )
56
53
  end
57
54
 
@@ -9,6 +9,8 @@ require 'pathname'
9
9
  require 'ceedling/exceptions'
10
10
  require 'ceedling/filesystem/file_path_utils'
11
11
  require 'ceedling/filesystem/project_paths'
12
+ require 'ceedling/includes/header_search'
13
+ require 'ceedling/filesystem/path_matcher'
12
14
 
13
15
  class IncludePathinator
14
16
 
@@ -29,9 +31,12 @@ class IncludePathinator
29
31
  # Alias for brevity
30
32
  @extractor = @test_context_extractor
31
33
 
32
- # Each search path's header listing for one test build (see `header_listing`)
33
- @listings = {}
34
- @listings_lock = Mutex.new
34
+ # Each search path's header listing for one test build (see `header_listing`), and the
35
+ # test directories holding headers
36
+ @listings = {}
37
+ @test_include_paths = nil
38
+ @configured_headers = nil
39
+ @listings_lock = Mutex.new
35
40
  end
36
41
 
37
42
  def validate_test_build_directive_paths
@@ -69,45 +74,60 @@ class IncludePathinator
69
74
  return headers
70
75
  end
71
76
 
72
- # Header files reachable from an already-ordered directory priority list (e.g. a
73
- # test's own search_paths), in that same order and deduplicated by first occurrence.
74
- # This is the candidate list a compiler's own -I search would consult for a single
75
- # test's #include resolution -- distinct from collection_all_headers, which is one
76
- # global, project-wide list blind to any one test's own TEST_INCLUDE_PATH() priority.
77
- def ordered_header_files(search_paths)
78
- headers = []
79
- search_paths.each do |path|
80
- headers.concat( header_listing( path ) )
81
- end
82
- return headers.uniq
77
+ # A test's headers found as its compiler finds them, through `search_paths` in order,
78
+ # each directory listed as `header_listing` lists it. Distinct from collection_all_headers,
79
+ # which is one project-wide list blind to any one test's TEST_INCLUDE_PATH() priority.
80
+ # `refusals` explain a failed lookup (see HeaderSearch#refusal).
81
+ def header_search(search_paths, refusals: {})
82
+ return HeaderSearch.new( search_paths, method( :header_listing ), refusals: refusals, build_root: @configurator.project_build_root )
83
83
  end
84
84
 
85
85
  # Starts a test build with every search path listed afresh
86
86
  def forget_header_listings
87
- @listings_lock.synchronize { @listings.clear }
87
+ @listings_lock.synchronize do
88
+ @listings.clear
89
+ @test_include_paths = nil
90
+ end
88
91
  end
89
92
 
90
93
  # The project's whole header collection, reordered so headers beneath this test's
91
94
  # own earlier search paths come first.
92
95
  #
93
- # Distinct from ordered_header_files above, which lists each search path's immediate
94
- # contents the way a compiler's own non-recursive -I search does. A reference naming
95
- # a header by path needs the whole collection instead, since the file it names can
96
- # sit at any depth below a search path, and it needs this test's own priority so a
97
- # TEST_INCLUDE_PATH() decides among same-named candidates.
96
+ # Distinct from header_search above, which finds a header as the compiler's -I search
97
+ # does. A Partial module named by path needs the whole collection instead, since its
98
+ # trailing path matches a file at any depth below a search path, and it needs this
99
+ # test's own priority so a TEST_INCLUDE_PATH() decides among same-named candidates.
98
100
  #
99
- # Ordering within one priority rank is the collection's own, which is what keeps a
100
- # reference that distinguishes nothing resolving exactly as it did before.
101
+ # Ordering within one priority rank is the collection's own, so a reference that
102
+ # distinguishes nothing resolves by collection order.
101
103
  def prioritized_header_files(search_paths)
104
+ return prioritize( @configurator.collection_all_headers.to_a, search_paths )
105
+ end
106
+
107
+ # The configured collection's headers `query` could name, those beneath earlier search
108
+ # paths first. Matches filter the collection before ranking, so a lookup costs one pass.
109
+ # Stage 2 adds every test's TEST_INCLUDE_PATH() headers to the collection, which a later
110
+ # build in the process would see, so lookups draw on the collection as configured.
111
+ def collection_candidates(query, search_paths)
112
+ headers = @listings_lock.synchronize { @configured_headers } || @configurator.collection_all_headers.to_a
113
+ return prioritize( PathMatcher.candidates( query, headers ), search_paths )
114
+ end
115
+
116
+ # `headers` reordered so those beneath earlier search paths come first, keeping their
117
+ # own order within one rank
118
+ def prioritize(headers, search_paths)
102
119
  roots = search_paths.map { |path| FilePathUtils.no_decorators( path ) }.reject(&:empty?)
103
120
  ranks = root_ranks( roots )
104
121
 
105
- @configurator.collection_all_headers.to_a.each_with_index.sort_by do |header, index|
122
+ return headers.each_with_index.sort_by do |header, index|
106
123
  [header_rank( header, ranks, roots.length ), index]
107
124
  end.map(&:first)
108
125
  end
109
126
 
127
+ # Remembers the configured collection the first time, since the collection then holds
128
+ # every test's TEST_INCLUDE_PATH() headers for each later build in the process
110
129
  def augment_environment_header_files(headers)
130
+ @listings_lock.synchronize { @configured_headers ||= @configurator.collection_all_headers.to_a.freeze }
111
131
  @configurator.redefine_element(:collection_all_headers, headers)
112
132
  end
113
133
 
@@ -117,23 +137,25 @@ class IncludePathinator
117
137
  return @extractor.lookup_include_paths_list(filepath)
118
138
  end
119
139
 
120
- # Gather together [:paths][:test] that actually contain header files
140
+ # Gather together [:paths][:test] that actually contain header files. Remembered for the
141
+ # test build, since every composition of a test's search paths asks.
121
142
  def collect_test_include_paths
122
- paths = []
123
- @configurator.collection_paths_test.each do |path|
124
- headers = @file_wrapper.directory_listing( @configurator.extension_header.glob_patterns(path) )
125
- paths << path if headers.length > 0
143
+ remembered = @listings_lock.synchronize { @test_include_paths }
144
+ return remembered unless remembered.nil?
145
+
146
+ paths = @configurator.collection_paths_test.select do |path|
147
+ !@file_wrapper.directory_listing( @configurator.extension_header.glob_patterns(path) ).empty?
126
148
  end
127
149
 
128
- return paths
150
+ return @listings_lock.synchronize { @test_include_paths ||= paths.freeze }
129
151
  end
130
152
 
131
153
  private
132
154
 
133
155
  # One search path's headers. A directory outside the build root keeps its listing for the
134
156
  # test build, since a build never writes there, and a test's search paths are listed
135
- # several times a test. One under the build root is listed every time, since the build
136
- # fills it as it runs.
157
+ # several times a test. One under the build root is listed every time, since a plugin or
158
+ # the build itself can write headers there as it runs.
137
159
  def header_listing(path)
138
160
  key = [ProjectPaths.working_dir, path]
139
161
  remembered = @listings_lock.synchronize { @listings[key] }