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
@@ -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 -- which mirrors the
44
- # test's path below its configured :paths -> :test root, so it can be more than one
45
- # segment deep (e.g. `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
 
@@ -7,10 +7,20 @@
7
7
 
8
8
  require 'pathname'
9
9
  require 'ceedling/exceptions'
10
- require 'ceedling/file_path_utils'
10
+ require 'ceedling/filesystem/file_path_utils'
11
+ require 'ceedling/filesystem/project_paths'
12
+ require 'ceedling/includes/header_search'
13
+ require 'ceedling/filesystem/path_matcher'
11
14
 
12
15
  class IncludePathinator
13
16
 
17
+ NO_HEADERS_MESSAGE = "No header files found in project.\n" +
18
+ "Add search paths to :paths ↳ :include in your project file and/or use TEST_INCLUDE_PATH() in your test files.\n" +
19
+ "Verify header files with `ceedling paths:include` and\\or `ceedling files:include`."
20
+
21
+ # What `header_listing` remembers for a directory under the build root
22
+ LISTED_FRESH = :listed_fresh
23
+
14
24
  constructor :configurator, :test_context_extractor, :loginator, :file_wrapper
15
25
 
16
26
  def setup
@@ -20,6 +30,13 @@ class IncludePathinator
20
30
 
21
31
  # Alias for brevity
22
32
  @extractor = @test_context_extractor
33
+
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
23
40
  end
24
41
 
25
42
  def validate_test_build_directive_paths
@@ -52,50 +69,65 @@ class IncludePathinator
52
69
 
53
70
  headers.uniq!
54
71
 
55
- if headers.length == 0
56
- error = "No header files found in project.\n" +
57
- "Add search paths to :paths ↳ :include in your project file and/or use TEST_INCLUDE_PATH() in your test files.\n" +
58
- "Verify header files with `ceedling paths:include` and\\or `ceedling files:include`."
59
- @loginator.log( error, Verbosity::COMPLAIN )
60
- end
72
+ @loginator.log( NO_HEADERS_MESSAGE, Verbosity::COMPLAIN ) if headers.empty?
61
73
 
62
74
  return headers
63
75
  end
64
76
 
65
- # Header files reachable from an already-ordered directory priority list (e.g. a
66
- # test's own search_paths), in that same order and deduplicated by first occurrence.
67
- # This is the candidate list a compiler's own -I search would consult for a single
68
- # test's #include resolution -- distinct from collection_all_headers, which is one
69
- # global, project-wide list blind to any one test's own TEST_INCLUDE_PATH() priority.
70
- def ordered_header_files(search_paths)
71
- headers = []
72
- search_paths.each do |path|
73
- headers += @file_wrapper.directory_listing( @configurator.extension_header.glob_patterns(path) )
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
+ end
84
+
85
+ # Starts a test build with every search path listed afresh
86
+ def forget_header_listings
87
+ @listings_lock.synchronize do
88
+ @listings.clear
89
+ @test_include_paths = nil
74
90
  end
75
- return headers.uniq
76
91
  end
77
92
 
78
93
  # The project's whole header collection, reordered so headers beneath this test's
79
94
  # own earlier search paths come first.
80
95
  #
81
- # Distinct from ordered_header_files above, which lists each search path's immediate
82
- # contents the way a compiler's own non-recursive -I search does. A reference naming
83
- # a header by path needs the whole collection instead, since the file it names can
84
- # sit at any depth below a search path, and it needs this test's own priority so a
85
- # 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.
86
100
  #
87
- # Ordering within one priority rank is the collection's own, which is what keeps a
88
- # 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.
89
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)
90
119
  roots = search_paths.map { |path| FilePathUtils.no_decorators( path ) }.reject(&:empty?)
120
+ ranks = root_ranks( roots )
91
121
 
92
- @configurator.collection_all_headers.to_a.each_with_index.sort_by do |header, index|
93
- rank = roots.index { |root| header == root || header.start_with?( root + '/' ) } || roots.length
94
- [rank, index]
122
+ return headers.each_with_index.sort_by do |header, index|
123
+ [header_rank( header, ranks, roots.length ), index]
95
124
  end.map(&:first)
96
125
  end
97
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
98
129
  def augment_environment_header_files(headers)
130
+ @listings_lock.synchronize { @configured_headers ||= @configurator.collection_all_headers.to_a.freeze }
99
131
  @configurator.redefine_element(:collection_all_headers, headers)
100
132
  end
101
133
 
@@ -105,15 +137,62 @@ class IncludePathinator
105
137
  return @extractor.lookup_include_paths_list(filepath)
106
138
  end
107
139
 
108
- # 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.
109
142
  def collect_test_include_paths
110
- paths = []
111
- @configurator.collection_paths_test.each do |path|
112
- headers = @file_wrapper.directory_listing( @configurator.extension_header.glob_patterns(path) )
113
- 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?
114
148
  end
115
149
 
116
- return paths
150
+ return @listings_lock.synchronize { @test_include_paths ||= paths.freeze }
151
+ end
152
+
153
+ private
154
+
155
+ # One search path's headers. A directory outside the build root keeps its listing for the
156
+ # test build, since a build never writes there, and a test's search paths are listed
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.
159
+ def header_listing(path)
160
+ key = [ProjectPaths.working_dir, path]
161
+ remembered = @listings_lock.synchronize { @listings[key] }
162
+ return remembered if remembered.is_a?( Array )
163
+
164
+ listing = @file_wrapper.directory_listing( @configurator.extension_header.glob_patterns( path ) ).freeze
165
+ return listing if remembered == LISTED_FRESH
166
+
167
+ kept = ProjectPaths.contains?( @configurator.project_build_root, path ) ? LISTED_FRESH : listing
168
+ @listings_lock.synchronize { @listings[key] ||= kept }
169
+ return listing
170
+ end
171
+
172
+ # Each root's place in the search order by its absolute path, the first one kept, so a
173
+ # header's rank comes from walking up its own directories rather than trying every root
174
+ def root_ranks(roots)
175
+ return roots.each_with_index.with_object( {} ) { |(root, index), ranks| ranks[rank_key( ProjectPaths.absolute( root ) )] ||= index }
176
+ end
177
+
178
+ # The earliest-searched root a header lies below, or `none` for no root
179
+ def header_rank(header, ranks, none)
180
+ rank = none
181
+ path = ProjectPaths.absolute( header )
182
+ loop do
183
+ parent = File.dirname( path )
184
+ break if parent == path
185
+
186
+ path = parent
187
+ rank = [rank, ranks.fetch( rank_key( path ), none )].min
188
+ end
189
+
190
+ return rank
191
+ end
192
+
193
+ # Windows compares paths without regard to case
194
+ def rank_key(path)
195
+ return ProjectPaths::WINDOWS ? path.downcase : path
117
196
  end
118
197
 
119
198
  end
@@ -7,7 +7,8 @@
7
7
 
8
8
  require 'set'
9
9
  require 'ceedling/exceptions'
10
- require 'ceedling/path_matcher'
10
+ require 'ceedling/filesystem/path_matcher'
11
+ require 'ceedling/filesystem/project_paths'
11
12
 
12
13
  class Includes
13
14
  # Class method to convert mixed list of Include objects into an order-preserving list of hashes
@@ -141,8 +142,6 @@ class Includes
141
142
  # same entry and collapsed down to one.
142
143
  includes.uniq!( &:filepath )
143
144
 
144
- self.drop_shadowed!( includes )
145
-
146
145
  # Apply custom rejection with access to full list if block provided
147
146
  if block_given?
148
147
  includes.reject! { |include| yield(include, includes) }
@@ -155,7 +154,9 @@ class Includes
155
154
  end
156
155
 
157
156
  # Drops any include that carries no path of its own while another entry resolves to a
158
- # real file of the same basename.
157
+ # real file of the same basename. Only a list that mixes unresolved text with resolved
158
+ # headers needs it, as a Partial's does under fallback. In a bare or scanned list every
159
+ # entry is an #include as written, and a pathless one can name a different header.
159
160
  #
160
161
  # An unresolved include holds only the text as written, so its filepath has no
161
162
  # directory. Beside a resolved sibling of the same basename it can only reach a file by
@@ -177,7 +178,6 @@ class Includes
177
178
 
178
179
  return includes
179
180
  end
180
- private_class_method :drop_shadowed!
181
181
 
182
182
  # Class method to reconcile bare, user, and system includes returning a list of
183
183
  # reconciled user and system includes.
@@ -200,14 +200,13 @@ class Includes
200
200
  # entry's literal #include text can carry more path than its candidate (a fallback text
201
201
  # scan sees only what's literally written) or less (a candidate directives-only
202
202
  # preprocessing resolved to a fuller real location than an unqualified bare #include
203
- # ever names). A bare entry matching more than one user/mock candidate (typically a
204
- # pathless bare entry corresponding to two same-named project files in different
205
- # directories) resolves to the first candidate in `user`'s own order -- itself already
206
- # real preprocessor-derived resolution order, so this mirrors the same first-by-known-
207
- # priority policy applied everywhere else a query is matched against a collection of real
208
- # files. `on_ambiguous`, when given, is called with the bare filepath, the chosen
209
- # candidate, and every candidate passed over, so a caller with somewhere to log that
210
- # (reconcile itself carries no logger) can surface it.
203
+ # ever names). Each bare entry pairs with one candidate, the entry with the fewest
204
+ # candidates first (`pair_candidates`), so a pathless entry never takes the header a
205
+ # same-named entry with a folder names. An entry takes the candidate its whole path names
206
+ # if there is one, else the first unclaimed one in `user`'s own order, which is already
207
+ # real preprocessor-derived resolution order. `on_ambiguous`, when given, is called with
208
+ # the bare filepath, the chosen candidate, and every candidate no entry took, so a caller
209
+ # with somewhere to log that (reconcile itself carries no logger) can surface it.
211
210
  #
212
211
  # System includes are still matched by filename alone: a system header commonly reaches
213
212
  # the same basename through more than one real file (a compiler-provided header
@@ -224,17 +223,13 @@ class Includes
224
223
  # collapsing to `<stat.h>`.
225
224
  #
226
225
  # A matched user include renders filename-only whenever its basename is unique
227
- # among this reconciliation's own results -- deliberately not the literal,
228
- # as-written subdirectory spelling, even when one was available. Ceedling adds
229
- # every real source/test/include directory as its OWN individual search path
230
- # (nothing project-root-relative), so a header's basename alone already finds the
231
- # right file precisely when nothing else in this same file's own includes shares
232
- # it; preserving more path than that would achieve nothing (see the class comment
233
- # on `best_bare_match` for the analogous reasoning already applied to a resolved
234
- # `gcc -M` bare entry) and can actively break the build the moment it reaches
235
- # further than a single configured search directory ever will (there is no
236
- # project-root search path for a fuller, project-relative spelling to resolve
237
- # against once rendered into a generated file living somewhere else entirely).
226
+ # among this reconciliation's own results, not with the path its candidate resolved
227
+ # to. That path is project-relative, as `src/Types.h` is. From a generated file living
228
+ # somewhere else entirely, it reaches the header only when the project root is a search
229
+ # path. The reconciled list records which headers a file includes. Each file Ceedling
230
+ # generates from it spells them for itself, as the test's search paths reach each
231
+ # header (see Include#spelled_by), so a header reached only through a folder below
232
+ # a search path is written with that folder.
238
233
  #
239
234
  # When two or more matched user includes DO share a basename -- the genuinely
240
235
  # destructive case, since a plain basename-only render for either one would then
@@ -275,21 +270,22 @@ class Includes
275
270
 
276
271
  bare_filenames = Set.new(bare.map(&:filename))
277
272
 
273
+ # One entry per #include line written. A compiler's wrapper header, such as GCC's
274
+ # <stdint.h> doing #include_next <stdint.h>, is entered at two paths that render alike.
275
+ # The first is the one the file named.
278
276
  system_includes = system.select do |include|
279
277
  bare_filenames.include?(include.filename)
280
278
  end.map do |include|
281
279
  original = best_bare_match(bare, include.filepath)
282
280
  SystemInclude.new(include.filepath, include_path: original.filepath)
283
- end
281
+ end.uniq( &:to_s )
284
282
 
285
- user_filepaths = user.map(&:filepath)
283
+ # One file a preprocessor names two ways, as `drivers/./foo.h`, is one candidate
284
+ user_filepaths = user.map(&:filepath).uniq { |filepath| ProjectPaths.segments(filepath) }
286
285
  user_by_filepath = {}
287
286
  user.each { |include| user_by_filepath[include.filepath] ||= include }
288
287
 
289
- user_includes = []
290
- seen = Set.new
291
-
292
- bare.each do |bare_include|
288
+ entries = bare.map do |bare_include|
293
289
  # A directory-relative #include's own literal text is anchored to the one file
294
290
  # a bare scan could have found it in -- the test file itself, never a header,
295
291
  # since bare extraction never recurses into one. Resolving here, once, means
@@ -303,17 +299,24 @@ class Includes
303
299
  # candidate directives-only preprocessing resolved to a fuller real location) --
304
300
  # either side may be the more specific one, so whichever is shorter sets how many
305
301
  # of the longer one's trailing segments must match.
302
+ # The candidate the entry's whole path names comes first
306
303
  matched = user_filepaths.select { |filepath| paths_correspond?(bare_filepath, filepath) }
304
+ matched = matched.partition { |filepath| ProjectPaths.segments(filepath) == ProjectPaths.segments(bare_filepath) }.flatten
307
305
 
308
- next if matched.empty?
306
+ [bare_include, bare_filepath, matched]
307
+ end
309
308
 
310
- filepath = matched.first
311
- next if seen.include?(filepath)
312
- seen << filepath
309
+ chosen = pair_candidates(entries)
313
310
 
314
- on_ambiguous&.call(bare_include.filepath, filepath, matched[1..]) if matched.length > 1
311
+ user_includes = []
312
+ entries.each_with_index do |(bare_include, bare_filepath, matched), index|
313
+ filepath = chosen[index]
314
+ next if filepath.nil?
315
+
316
+ passed_over = matched - chosen.values
317
+ on_ambiguous&.call(bare_include.filepath, filepath, passed_over) unless passed_over.empty?
315
318
 
316
- user_includes << user_by_filepath[filepath]
319
+ user_includes << as_written(user_by_filepath[filepath], bare_include, bare_filepath)
317
320
  end
318
321
 
319
322
  # Disambiguate same-basename results -- see the class comment above. A group of
@@ -332,6 +335,58 @@ class Includes
332
335
  return reconciled
333
336
  end
334
337
 
338
+ # Pairs bare entries with candidates, as { entry index => candidate filepath }. The most
339
+ # constrained entry claims first, so a pathless #include never takes the header an
340
+ # #include naming its folder needs. Ties go in bare order, which puts GCC's text ahead of
341
+ # the text scan's. A computed #include's line-marker path, longer than its candidates,
342
+ # claims after every written text. A repeat of an earlier entry's path claims nothing, as
343
+ # GCC's `drivers/foo.h` and the text scan's `./drivers/foo.h` name one #include.
344
+ def self.pair_candidates(entries)
345
+ chosen = {}
346
+ claimants(entries).sort_by { |index| claim_order( entries[index], index ) }.each do |index|
347
+ filepath = entries[index][2].find { |candidate| !chosen.value?(candidate) }
348
+ chosen[index] = filepath if filepath
349
+ end
350
+
351
+ return chosen
352
+ end
353
+ private_class_method :pair_candidates
354
+
355
+ # The entries with a candidate, less any repeat of an earlier entry's path
356
+ def self.claimants(entries)
357
+ firsts = {}
358
+ entries.each_with_index { |(_, bare_filepath, _), index| firsts[ProjectPaths.segments(bare_filepath)] ||= index }
359
+
360
+ return entries.each_index.select do |index|
361
+ _, bare_filepath, matched = entries[index]
362
+ !matched.empty? and firsts[ProjectPaths.segments(bare_filepath)] == index
363
+ end
364
+ end
365
+ private_class_method :claimants
366
+
367
+ def self.claim_order(entry, index)
368
+ _, bare_filepath, matched = entry
369
+ length = ProjectPaths.segments(bare_filepath).length
370
+ computed = matched.all? { |candidate| length > ProjectPaths.segments(candidate).length }
371
+ return [computed ? 1 : 0, matched.length, index]
372
+ end
373
+ private_class_method :claim_order
374
+
375
+ # A mock's #include names it for CMock and the runner, so a mock keeps its bare entry's
376
+ # text, anchored as `bare_filepath` is. GCC's entry names it first, with the #include as
377
+ # written less a leading `./`, or a macro's expansion. Its candidate is the mock's place
378
+ # below its mirror root, which can carry folders the #include never wrote. A bare entry
379
+ # carrying more path than its candidate is the line-marker path of a computed #include,
380
+ # which wrote no text, so the candidate stays. Any other #include keeps its candidate, the
381
+ # header's real path.
382
+ def self.as_written(candidate, bare_include, bare_filepath)
383
+ return candidate unless candidate.is_a?(MockInclude)
384
+ return candidate if ProjectPaths.segments(bare_filepath).length > ProjectPaths.segments(candidate.filepath).length
385
+
386
+ return MockInclude.new(bare_filepath, directory_relative: bare_filepath != bare_include.filepath)
387
+ end
388
+ private_class_method :as_written
389
+
335
390
  # Two filepaths correspond if the shorter one's path segments equal the longer one's
336
391
  # own trailing segments, exactly, in order -- checked without regard for which side is
337
392
  # shorter, since either a bare entry or its candidate may be the one carrying less path.
@@ -419,6 +474,12 @@ class Include
419
474
  attr_reader :path
420
475
  attr_reader :include_path
421
476
 
477
+ # Whether a scan rewrote this include's `..` against its file's own directory, so its
478
+ # path is no longer the one written
479
+ def directory_relative?
480
+ return @directory_relative
481
+ end
482
+
422
483
  # Initialize an Include object from a C include statement or simple filepath.
423
484
  #
424
485
  # @param statement [String] A C include statement. Examples:
@@ -433,8 +494,9 @@ class Include
433
494
  # resolved location (needed elsewhere for identity -- see `Includes.sanitize!`)
434
495
  # rather than the original, as-written directive text a reconciled render needs.
435
496
  # @raise [ArgumentError] If the statement is empty or becomes empty after cleaning
436
- def initialize(statement, include_path: nil)
497
+ def initialize(statement, include_path: nil, directory_relative: false)
437
498
  @filepath = clean(statement)
499
+ @directory_relative = directory_relative
438
500
 
439
501
  raise ArgumentError, "Empty include statement" if @filepath.empty?
440
502
 
@@ -452,7 +514,26 @@ class Include
452
514
  def anchored(anchor)
453
515
  resolved = PathMatcher.resolve_relative( @filepath, anchor: anchor )
454
516
  return self if resolved == @filepath
455
- return self.class.new( resolved, include_path: @include_path )
517
+ return self.class.new( resolved, include_path: @include_path, directory_relative: true )
518
+ end
519
+
520
+ # This #include by a spelling through which `search`, a HeaderSearch, reaches its header
521
+ # (see HeaderSearch on spellings). Its own text stays wherever it already reaches the header.
522
+ # Its path becomes the header, so a caller weighing which header it names reads the header
523
+ # itself.
524
+ #
525
+ # A `resolved` #include holds the path the compiler found its header by. One as written names
526
+ # the header beside its includer, in directory `from`, ahead of any a search path finds, as the
527
+ # compiler's quote rule does. A header found either way that no search path reaches by any
528
+ # spelling is written by its absolute path, which reaches it from wherever the generated file
529
+ # lives. A header in the build root keeps its text, which the compiler's own search paths reach.
530
+ # The compiler finds a search path's header from there, so an #include as written with no
531
+ # header beside its includer is spelled by the one the search paths find. One whose header isn't
532
+ # found comes back as it is.
533
+ def spelled_by(search, from: nil, resolved: false)
534
+ header, named = header_in( search, from, resolved )
535
+ spelling = header && spelling_of( search, header, resolved || named )
536
+ return spelling ? self.class.new( header, include_path: spelling, directory_relative: @directory_relative ) : self
456
537
  end
457
538
 
458
539
  # Method specialized by subclasses
@@ -517,6 +598,27 @@ class Include
517
598
 
518
599
  private
519
600
 
601
+ # The header this #include names in `search` (see spelled_by), and whether it is the one the
602
+ # #include names where written, rather than one the search paths find. A resolved path with no
603
+ # header at it, in another letter case or never resolved at all, is searched for as written.
604
+ def header_in(search, from, resolved)
605
+ written = resolved ? search.at( @filepath ) : header_beside( search, from )
606
+ return written ? [written, true] : [search.header_candidates( @filepath ).first, false]
607
+ end
608
+
609
+ # A spelling of `header` for this #include. Where no search path reaches it, one the #include
610
+ # names where written takes the header's absolute path, and any other stays as it is. So does
611
+ # one in the build root, which the compiler's own search paths reach.
612
+ def spelling_of(search, header, absolute)
613
+ return search.spelling( header, preferring: include ) || (absolute && !search.generated?( header ) ? ProjectPaths.absolute( header ) : nil)
614
+ end
615
+
616
+ # The header an #include as written names beside its includer, or at its anchored path
617
+ def header_beside(search, from)
618
+ path = @directory_relative ? @filepath : (from && File.join( from, @filepath ))
619
+ return path && search.at( path )
620
+ end
621
+
520
622
  def clean(line)
521
623
  # Remove any initial `#include` statement
522
624
  _line = line.gsub(/#\s*include/, '')
@@ -546,6 +648,11 @@ class MockInclude < UserInclude
546
648
  def to_s()
547
649
  "#include \"#{filepath}\""
548
650
  end
651
+
652
+ # A mock's #include names its generated header, which no header search holds
653
+ def spelled_by(_search, **)
654
+ return self
655
+ end
549
656
  end
550
657
 
551
658
 
@@ -554,4 +661,9 @@ class SystemInclude < Include
554
661
  def to_s()
555
662
  "#include <#{include}>"
556
663
  end
664
+
665
+ # The compiler finds a system header through its own directories, which no header search holds
666
+ def spelled_by(_search, **)
667
+ return self
668
+ end
557
669
  end
@@ -0,0 +1,92 @@
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 'rbconfig'
9
+
10
+ # One Ceedling installation, identified by its root directory. Its version is read
11
+ # from its own files, never from the constants of whichever installation loaded first.
12
+ #
13
+ # An application loaded by an older launcher reaches this file through require_relative
14
+ # with someone else's code already loaded, so it depends on nothing else in lib/.
15
+ class Installation
16
+
17
+ VERSION_FILE = File.join( 'lib', 'version.rb' )
18
+ BUILTIN_MIXINS_DIR = File.join( 'vendor', 'unity', 'test', 'targets' )
19
+
20
+ attr_reader :root
21
+
22
+ def self.windows?
23
+ return (RbConfig::CONFIG['host_os'] =~ /mswin|mingw|msys|ucrt/i) ? true : false
24
+ end
25
+
26
+ def initialize(root)
27
+ @root = File.expand_path( root )
28
+ end
29
+
30
+ def bin_path
31
+ return File.join( @root, 'bin', 'ceedling' )
32
+ end
33
+
34
+ def rakefile_path
35
+ return File.join( @root, 'lib', 'ceedling', 'rakefile.rb' )
36
+ end
37
+
38
+ # The version tag, or nil when this installation's lib/version.rb is missing or unreadable
39
+ def version
40
+ @version = read_version() unless defined?( @version )
41
+ return @version
42
+ end
43
+
44
+ # True when this installation's launcher validates a built-in mixin directory the
45
+ # installation does not hold. `--local` vendoring left it out from 1.1.0 through 1.2.1,
46
+ # so such a copy fails on its own and only ever ran inside another launcher's process.
47
+ def missing_builtin_mixins?
48
+ mixins_filepath = File.join( @root, 'bin', 'mixins.rb' )
49
+ return false if !File.exist?( mixins_filepath )
50
+ return false if !File.read( mixins_filepath ).include?( 'BUILTIN_MIXIN_LOAD_PATHS' )
51
+
52
+ return !File.directory?( File.join( @root, BUILTIN_MIXINS_DIR ) )
53
+ end
54
+
55
+ # Symlinks resolve, and Windows paths compare without case
56
+ def ==(other)
57
+ return false unless other.is_a?( Installation )
58
+ return Installation.windows? ? identity.casecmp?( other.identity ) : (identity == other.identity)
59
+ end
60
+
61
+ # "Ceedling 1.2.0", or without the version when it cannot be read
62
+ def name(noun='Ceedling')
63
+ return [noun, version()].compact.join( ' ' )
64
+ end
65
+
66
+ # "Ceedling 1.2.0 at /path/", or without the version when it cannot be read
67
+ def describe(noun='Ceedling')
68
+ return "#{name( noun )} at #{@root}/"
69
+ end
70
+
71
+ protected
72
+
73
+ def identity
74
+ return File.realpath( @root )
75
+ rescue SystemCallError
76
+ return @root
77
+ end
78
+
79
+ private
80
+
81
+ # lib/version.rb defines Ceedling::Version. Evaluated within an anonymous module, its
82
+ # constants land beneath that module instead of reopening the loaded ::Ceedling.
83
+ def read_version
84
+ filepath = File.join( @root, VERSION_FILE )
85
+ sandbox = Module.new
86
+ sandbox.module_eval( File.read( filepath ), filepath )
87
+ return sandbox.const_get( :Ceedling, false ).const_get( :Version, false ).const_get( :TAG, false )
88
+ rescue StandardError, ScriptError
89
+ return nil
90
+ end
91
+
92
+ end