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
@@ -0,0 +1,845 @@
1
+ # =========================================================================
2
+ # Ceedling - Test-Centered Build System for C
3
+ # ThrowTheSwitch.org
4
+ # Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
5
+ # SPDX-License-Identifier: MIT
6
+ # =========================================================================
7
+
8
+ require 'spec_helper'
9
+ require 'ceedling/filesystem/build_roots'
10
+ require 'tmpdir'
11
+ require 'ceedling/filesystem/file_finder'
12
+ require 'ceedling/filesystem/file_finder_helper'
13
+ require 'ceedling/filesystem/test_build_layout'
14
+ require 'ceedling/includes/header_search'
15
+ require 'ceedling/filename_extension'
16
+ require 'ceedling/exceptions'
17
+ require 'ceedling/constants'
18
+
19
+ describe FileFinder do
20
+ before(:each) do
21
+ @configurator = double( "Configurator" )
22
+ @file_path_utils = double( "FilePathUtils" )
23
+ @file_wrapper = double( "FileWrapper" )
24
+ @yaml_wrapper = double( "YamlWrapper" )
25
+ @loginator = double( "Loginator" )
26
+ allow(@loginator).to receive(:log)
27
+ # No configured root is long enough to shorten unless an example says so
28
+ allow(@file_path_utils).to receive(:build_roots).and_return( BuildRoots.table( [] ) )
29
+
30
+ # A real FileFinderHelper (already unit-tested on its own) so these specs exercise the
31
+ # whole query -> FileFinder -> FileFinderHelper -> PathMatcher chain, not a mocked stub of it.
32
+ @file_finder_helper = FileFinderHelper.new( { loginator: @loginator } )
33
+
34
+ # A real TestBuildLayout, so a lookup finds each test's generated files where its build
35
+ # puts them
36
+ allow(@file_wrapper).to receive(:check_path_length)
37
+ allow(@configurator).to receive(:project_build_root).and_return('build')
38
+ allow(@configurator).to receive(:project_use_mocks).and_return( true )
39
+ allow(@configurator).to receive(:project_use_partials).and_return( true )
40
+ allow(@configurator).to receive(:cmock_mock_path).and_return('build/test/mocks')
41
+ allow(@configurator).to receive(:project_test_partials_path).and_return('build/test/partials')
42
+ allow(@configurator).to receive(:project_test_preprocess_includes_path).and_return('build/test/preprocess/includes')
43
+ allow(@configurator).to receive(:project_test_preprocess_files_path).and_return('build/test/preprocess/files')
44
+ allow(@configurator).to receive(:project_test_preprocess_build_directives_path).and_return('build/test/preprocess/build_directives')
45
+ @test_build_layout = TestBuildLayout.new( { configurator: @configurator, file_wrapper: @file_wrapper } )
46
+
47
+ @file_finder = described_class.new({
48
+ configurator: @configurator,
49
+ file_finder_helper: @file_finder_helper,
50
+ file_path_utils: @file_path_utils,
51
+ file_wrapper: @file_wrapper,
52
+ yaml_wrapper: @yaml_wrapper,
53
+ test_build_layout: @test_build_layout
54
+ })
55
+ end
56
+
57
+ describe '#find_header_file' do
58
+ before(:each) do
59
+ allow(@configurator).to receive(:extension_header).and_return( FilenameExtension.new('.h') )
60
+ allow(@configurator).to receive(:collection_all_headers).and_return(
61
+ ['unit/bar.h', 'integration/bar.h', 'baz.h']
62
+ )
63
+ end
64
+
65
+ it 'resolves a bare basename when it is unique' do
66
+ expect(@file_finder.find_header_file('baz.h')).to eq('baz.h')
67
+ expect(@file_finder.find_header_file('baz')).to eq('baz.h')
68
+ end
69
+
70
+ it 'never raises on a bare, ambiguous basename -- resolves to the first candidate in collection order' do
71
+ expect(@file_finder.find_header_file('bar.h')).to eq('unit/bar.h')
72
+ end
73
+
74
+ it 'logs an ℹ️ NOTICE naming the passed-over candidate when a bare basename is ambiguous' do
75
+ expect(@loginator).to receive(:log) do |msg, verbosity, label|
76
+ expect(msg).to include('unit/bar.h')
77
+ expect(msg).to include('integration/bar.h')
78
+ expect(verbosity).to eq(Verbosity::COMPLAIN)
79
+ expect(label).to eq(LogLabels::NOTICE)
80
+ end
81
+
82
+ @file_finder.find_header_file('bar.h')
83
+ end
84
+
85
+ it 'resolves an ambiguous basename when the query supplies enough path to disambiguate' do
86
+ expect(@file_finder.find_header_file('unit/bar.h')).to eq('unit/bar.h')
87
+ expect(@file_finder.find_header_file('integration/bar.h')).to eq('integration/bar.h')
88
+ end
89
+
90
+ it 'searches a caller-supplied collection instead of collection_all_headers when one is given' do
91
+ expect(@file_finder.find_header_file('baz.h', :error, collection: ['other/baz.h'])).to eq('other/baz.h')
92
+ end
93
+
94
+ it 'finds a header through a HeaderSearch, joining a search path with the path the #include names' do
95
+ search = HeaderSearch.new( ['src'], ->(dir) { dir == 'src/drivers' ? ['src/drivers/foo.h'] : [] } )
96
+
97
+ expect(@file_finder.find_header_file('drivers/foo.h', :error, collection: search)).to eq('src/drivers/foo.h')
98
+ end
99
+
100
+ it 'tries each configured header extension through a HeaderSearch' do
101
+ allow(@configurator).to receive(:extension_header).and_return( FilenameExtension.new(['.h', '.hpp']) )
102
+ search = HeaderSearch.new( ['src'], ->(dir) { dir == 'src/drivers' ? ['src/drivers/foo.hpp'] : [] } )
103
+
104
+ expect(@file_finder.find_header_file('drivers/foo', :error, collection: search)).to eq('src/drivers/foo.hpp')
105
+ end
106
+ end
107
+
108
+ describe '#find_header_input_for_mock' do
109
+ before(:each) do
110
+ allow(@configurator).to receive(:cmock_mock_prefix).and_return( 'Mock' )
111
+ allow(@configurator).to receive(:collection_all_headers).and_return(
112
+ ['unit/bar.h', 'integration/bar.h', 'baz.h']
113
+ )
114
+ end
115
+
116
+ it 'resolves a bare mock name when its header is unique' do
117
+ expect(@file_finder.find_header_input_for_mock('Mockbaz.h')).to eq('baz.h')
118
+ end
119
+
120
+ it 'never raises on a bare, ambiguous mock name -- resolves to the first candidate in collection order' do
121
+ expect(@file_finder.find_header_input_for_mock('Mockbar.h')).to eq('unit/bar.h')
122
+ end
123
+
124
+ it 'logs an ℹ️ NOTICE naming the passed-over candidate when a bare mock name is ambiguous' do
125
+ expect(@loginator).to receive(:log) do |msg, verbosity, label|
126
+ expect(msg).to include('unit/bar.h')
127
+ expect(msg).to include('integration/bar.h')
128
+ expect(verbosity).to eq(Verbosity::COMPLAIN)
129
+ expect(label).to eq(LogLabels::NOTICE)
130
+ end
131
+
132
+ @file_finder.find_header_input_for_mock('Mockbar.h')
133
+ end
134
+
135
+ it 'resolves an ambiguous mock name when the query supplies enough path to disambiguate' do
136
+ expect(@file_finder.find_header_input_for_mock('unit/Mockbar.h')).to eq('unit/bar.h')
137
+ expect(@file_finder.find_header_input_for_mock('integration/Mockbar.h')).to eq('integration/bar.h')
138
+ end
139
+
140
+ it 'still raises rather than silently matching just the basename when the given path is bogus (not-found, not ambiguity)' do
141
+ expect {
142
+ @file_finder.find_header_input_for_mock('nonexistent/dir/Mockbaz.h')
143
+ }.to raise_error(CeedlingException)
144
+ end
145
+
146
+ it 'searches a caller-supplied collection instead of collection_all_headers when one is given' do
147
+ expect(@file_finder.find_header_input_for_mock('Mockbaz.h', collection: ['other/baz.h'])).to eq('other/baz.h')
148
+ end
149
+
150
+ it "asks a HeaderSearch for the header a mock's #include names, its path kept" do
151
+ search = HeaderSearch.new( ['src'], ->(dir) { dir == 'src/drivers' ? ['src/drivers/foo.h'] : [] } )
152
+
153
+ expect(@file_finder.find_header_input_for_mock('drivers/Mockfoo.h', collection: search)).to eq('src/drivers/foo.h')
154
+ end
155
+ end
156
+
157
+ describe '#resolve_mock' do
158
+ before(:each) do
159
+ allow(@configurator).to receive(:cmock_mock_prefix).and_return( 'Mock' )
160
+ allow(@configurator).to receive(:collection_all_headers).and_return(
161
+ ['src/drivers/foo.h', 'src/baz.h']
162
+ )
163
+ allow(@configurator).to receive(:paths_test).and_return( [] )
164
+ allow(@configurator).to receive(:paths_support).and_return( [] )
165
+ allow(@configurator).to receive(:paths_include).and_return( ['src'] )
166
+ allow(@configurator).to receive(:collection_mirror_roots_headers).and_return( ['src'] )
167
+ end
168
+
169
+ it 'resolves a mock header and its own mirrored subdirectory below the configured root that contains it' do
170
+ source, subdir = @file_finder.resolve_mock('Mockfoo.h')
171
+ expect(source).to eq('src/drivers/foo.h')
172
+ expect(subdir).to eq('drivers')
173
+ end
174
+
175
+ it 'returns an empty subdirectory for a mock header directly in a configured root' do
176
+ source, subdir = @file_finder.resolve_mock('Mockbaz.h')
177
+ expect(source).to eq('src/baz.h')
178
+ expect(subdir).to eq('')
179
+ end
180
+
181
+ it 'resolves identically regardless of how much disambiguating path the query itself carries' do
182
+ bare, bare_subdir = @file_finder.resolve_mock('Mockfoo.h')
183
+ pathed, pathed_subdir = @file_finder.resolve_mock('drivers/Mockfoo.h')
184
+ expect(bare).to eq(pathed)
185
+ expect(bare_subdir).to eq(pathed_subdir)
186
+ end
187
+
188
+ # GH #1370: a `..` root "contained" a header far above it, so its mock left the build directory
189
+ it 'places a mock of a header far above a `..` root flat, below the root that truly holds it' do
190
+ allow(@configurator).to receive(:collection_all_headers).and_return( ['../../../opt/sdk/inc/sdk.h'] )
191
+ allow(@configurator).to receive(:paths_include).and_return( ['../**', File.expand_path( '../../../opt/sdk/inc' )] )
192
+ allow(@configurator).to receive(:collection_mirror_roots_headers).and_return( ['..', '../../../opt/sdk/inc'] )
193
+
194
+ _source, subdir = @file_finder.resolve_mock('Mocksdk.h')
195
+ expect(subdir).to eq('')
196
+ end
197
+
198
+ # GH #1370 audit (G4): a glob in the middle of a root names one root per directory
199
+ it 'places a mock below the directory a glob-middle root names, not below the glob\'s base' do
200
+ allow(@configurator).to receive(:collection_all_headers).and_return( ['components/foo/include/foo.h'] )
201
+ allow(@configurator).to receive(:paths_include).and_return( ['components/*/include'] )
202
+ allow(@configurator).to receive(:collection_mirror_roots_headers).and_return( ['components/foo/include'] )
203
+
204
+ _source, subdir = @file_finder.resolve_mock('Mockfoo.h')
205
+ expect(subdir).to eq('')
206
+ end
207
+
208
+ it 'still raises on a bogus (not-found) mock reference, exactly as find_header_input_for_mock does' do
209
+ expect { @file_finder.resolve_mock('nonexistent/dir/Mockfoo.h') }.to raise_error(CeedlingException)
210
+ end
211
+
212
+ it 'finds nothing for a mock without a header, rather than raising, when told to ignore a missing header' do
213
+ expect(@file_finder.resolve_mock('Mocknope.h', complain: :ignore)).to eq( [nil, nil] )
214
+ end
215
+
216
+ it 'finds nothing for a mock whose header differs only in letter case when told to be silent' do
217
+ expect(@file_finder.resolve_mock('MockFOO.h', complain: :silent)).to eq( [nil, nil] )
218
+ end
219
+
220
+ it 'never raises on an ambiguous mock reference -- resolves to the first candidate in collection order' do
221
+ allow(@configurator).to receive(:collection_all_headers).and_return(
222
+ ['src/drivers/dup.h', 'src/other/dup.h']
223
+ )
224
+ source, subdir = @file_finder.resolve_mock('Mockdup.h')
225
+ expect(source).to eq('src/drivers/dup.h')
226
+ expect(subdir).to eq('drivers')
227
+ end
228
+
229
+ it 'searches a caller-supplied collection instead of collection_all_headers when one is given' do
230
+ source, subdir = @file_finder.resolve_mock('Mockfoo.h', collection: ['src/other/foo.h'])
231
+ expect(source).to eq('src/other/foo.h')
232
+ expect(subdir).to eq('other')
233
+ end
234
+ end
235
+
236
+ describe '#find_source_file' do
237
+ before(:each) do
238
+ allow(@configurator).to receive(:extension_source).and_return( FilenameExtension.new('.c') )
239
+ allow(@configurator).to receive(:collection_all_source).and_return(
240
+ ['drivers/foo/bar.c', 'drivers/baz/bar.c']
241
+ )
242
+ end
243
+
244
+ it 'resolves a path-qualified query among same-named files' do
245
+ expect(@file_finder.find_source_file('drivers/foo/bar.c')).to eq('drivers/foo/bar.c')
246
+ expect(@file_finder.find_source_file('foo/bar.c')).to eq('drivers/foo/bar.c')
247
+ end
248
+
249
+ it 'never raises on a bare, ambiguous query -- resolves to the first candidate in collection order' do
250
+ expect(@file_finder.find_source_file('bar.c')).to eq('drivers/foo/bar.c')
251
+ end
252
+
253
+ it 'logs an ℹ️ NOTICE naming the passed-over candidate when a bare query is ambiguous' do
254
+ expect(@loginator).to receive(:log) do |msg, verbosity, label|
255
+ expect(msg).to include('drivers/foo/bar.c')
256
+ expect(msg).to include('drivers/baz/bar.c')
257
+ expect(verbosity).to eq(Verbosity::COMPLAIN)
258
+ expect(label).to eq(LogLabels::NOTICE)
259
+ end
260
+
261
+ @file_finder.find_source_file('bar.c')
262
+ end
263
+ end
264
+
265
+ describe '#find_assembly_file' do
266
+ it 'tries every configured extension in turn, still resolving a unique match' do
267
+ allow(@configurator).to receive(:extension_assembly).and_return( FilenameExtension.new(['.s', '.S']) )
268
+ allow(@configurator).to receive(:collection_all_assembly).and_return( ['src/foo.S'] )
269
+
270
+ expect(@file_finder.find_assembly_file('foo')).to eq('src/foo.S')
271
+ end
272
+
273
+ it 'never raises on an ambiguous match -- resolves to the first candidate in collection order' do
274
+ allow(@configurator).to receive(:extension_assembly).and_return( FilenameExtension.new('.s') )
275
+ allow(@configurator).to receive(:collection_all_assembly).and_return( ['drivers/foo/bar.s', 'drivers/baz/bar.s'] )
276
+
277
+ expect(@file_finder.find_assembly_file('bar')).to eq('drivers/foo/bar.s')
278
+ end
279
+ end
280
+
281
+ describe '#find_test_file_from_name' do
282
+ before(:each) do
283
+ allow(@configurator).to receive(:extension_source).and_return( FilenameExtension.new('.c') )
284
+ allow(@configurator).to receive(:collection_all_tests).and_return(
285
+ ['unit/test_foo.c', 'integration/test_foo.c']
286
+ )
287
+ end
288
+
289
+ it 'raises a CeedlingException when a bare test name is ambiguous' do
290
+ expect { @file_finder.find_test_file_from_name('test_foo') }.to raise_error(CeedlingException)
291
+ end
292
+
293
+ it 'resolves when the name carries enough path to disambiguate' do
294
+ expect(@file_finder.find_test_file_from_name('unit/test_foo')).to eq('unit/test_foo.c')
295
+ end
296
+
297
+ # GH #1370 audit (G9): a task name is relative to the working directory, as every
298
+ # collected path is, so a leading `..` names a test outside the project
299
+ it 'resolves a name climbing out of the project, against the working directory' do
300
+ allow(@configurator).to receive(:collection_all_tests).and_return( ['../tests/test_x.c', 'unit/test_foo.c'] )
301
+
302
+ expect(@file_finder.find_test_file_from_name('../tests/test_x')).to eq('../tests/test_x.c')
303
+ end
304
+
305
+ it 'resolves a name written with `./`' do
306
+ expect(@file_finder.find_test_file_from_name('./unit/test_foo')).to eq('unit/test_foo.c')
307
+ end
308
+ end
309
+
310
+ describe '#find_file_from_list' do
311
+ it 'delegates to the underlying collection, raising on ambiguity the same as any other lookup' do
312
+ list = ['a/dup.c', 'b/dup.c']
313
+ expect { @file_finder.find_file_from_list('dup.c', list, :ignore) }.to raise_error(CeedlingException)
314
+ expect(@file_finder.find_file_from_list('a/dup.c', list, :ignore)).to eq('a/dup.c')
315
+ end
316
+ end
317
+
318
+ describe '#find_build_input_file' do
319
+ before(:each) do
320
+ allow(@configurator).to receive(:project_test_file_prefix).and_return('test_')
321
+ allow(@configurator).to receive(:test_runner_file_suffix).and_return('_runner')
322
+ allow(@configurator).to receive(:cmock_mock_prefix).and_return('Mock')
323
+ allow(@configurator).to receive(:collection_vendor_framework_sources).and_return([])
324
+ allow(@configurator).to receive(:release_build_use_assembly).and_return(false)
325
+ allow(@configurator).to receive(:test_build_use_assembly).and_return(false)
326
+ allow(@configurator).to receive(:extension_source).and_return( FilenameExtension.new('.c') )
327
+ allow(@configurator).to receive(:extension_assembly).and_return( FilenameExtension.new('.s') )
328
+ allow(@configurator).to receive(:project_test_build_output_path).and_return('build/test/out')
329
+ allow(@configurator).to receive(:project_release_build_output_path).and_return('build/release/out')
330
+ allow(@configurator).to receive(:project_build_root).and_return('build')
331
+ # No configured include root contains these queries, so each keeps its own path.
332
+ allow(@configurator).to receive(:paths_include).and_return( ['include'] )
333
+ allow(@configurator).to receive(:collection_mirror_roots_include).and_return( ['include'] )
334
+
335
+ # A test is named by its path without its extension. Examples that look tests up by
336
+ # name give their own test collection.
337
+ allow(@configurator).to receive(:collection_all_tests).and_return( [] )
338
+ allow(@file_path_utils).to receive(:form_test_name) { |test| test.to_s.ext( '' ) }
339
+ allow(@file_path_utils).to receive(:form_test_runners_path) do |name, **|
340
+ File.dirname( name ) == '.' ? 'build/test/runners' : File.join( 'build/test/runners', File.dirname( name ) )
341
+ end
342
+ end
343
+
344
+ it 'never raises, rather than silently missing a build, when two release sources share a basename -- resolves to the first by project path order' do
345
+ allow(@configurator).to receive(:collection_release_build_input).and_return(
346
+ ['drivers/foo/bar.c', 'drivers/baz/bar.c']
347
+ )
348
+
349
+ found = @file_finder.find_build_input_file( filepath: 'build/release/out/bar.o', complain: :error, context: RELEASE_SYM )
350
+ expect(found).to eq('drivers/foo/bar.c')
351
+ end
352
+
353
+ it 'logs an ℹ️ NOTICE naming the passed-over release source when ambiguous' do
354
+ allow(@configurator).to receive(:collection_release_build_input).and_return(
355
+ ['drivers/foo/bar.c', 'drivers/baz/bar.c']
356
+ )
357
+
358
+ expect(@loginator).to receive(:log) do |msg, verbosity, label|
359
+ expect(msg).to include('drivers/foo/bar.c')
360
+ expect(msg).to include('drivers/baz/bar.c')
361
+ expect(verbosity).to eq(Verbosity::COMPLAIN)
362
+ expect(label).to eq(LogLabels::NOTICE)
363
+ end
364
+
365
+ @file_finder.find_build_input_file( filepath: 'build/release/out/bar.o', complain: :error, context: RELEASE_SYM )
366
+ end
367
+
368
+ it 'still resolves a genuinely unique release source by basename' do
369
+ allow(@configurator).to receive(:collection_release_build_input).and_return( ['drivers/foo/bar.c'] )
370
+
371
+ found = @file_finder.find_build_input_file( filepath: 'build/release/out/bar.o', complain: :error, context: RELEASE_SYM )
372
+ expect(found).to eq('drivers/foo/bar.c')
373
+ end
374
+
375
+ it 'resolves a test\'s own source file via its build directory identity, even when another same-named test exists elsewhere' do
376
+ allow(@configurator).to receive(:collection_all_tests).and_return(
377
+ ['test/unit/test_foo.c', 'test/integration/test_foo.c']
378
+ )
379
+
380
+ found = @file_finder.find_build_input_file(
381
+ filepath: 'build/test/out/test/unit/test_foo/_t_/test_foo.o', complain: :error, context: TEST_SYM
382
+ )
383
+ expect(found).to eq('test/unit/test_foo.c')
384
+
385
+ found = @file_finder.find_build_input_file(
386
+ filepath: 'build/test/out/test/integration/test_foo/_t_/test_foo.o', complain: :error, context: TEST_SYM
387
+ )
388
+ expect(found).to eq('test/integration/test_foo.c')
389
+ end
390
+
391
+ # GH #1364: a test's own source resolves exactly, though its name ends another's path
392
+ {
393
+ 'flat and nested under one root' => ['test/test_calc.c', 'test/unit/test_calc.c'],
394
+ 'the same subdirectory under two roots' => ['test/unit/test_calc.c', 'extra/unit/test_calc.c'],
395
+ 'the same layout under two roots' => ['test/foo/test_x.c', 'extra/foo/test_x.c']
396
+ }.each do |layout, tests|
397
+ it "resolves each test's own source exactly with #{layout}" do
398
+ allow(@configurator).to receive(:collection_all_tests).and_return( tests )
399
+
400
+ tests.each do |test|
401
+ name = test.ext( '' )
402
+ object = File.join( 'build/test/out', name, '_t_', File.basename( name ) + '.o' )
403
+
404
+ expect(@file_finder.find_build_input_file( filepath: object, complain: :error, context: TEST_SYM, test: name )).to eq( test )
405
+ expect(@file_finder.find_build_input_file( filepath: object, complain: :error, context: TEST_SYM )).to eq( test )
406
+ end
407
+ end
408
+ end
409
+
410
+ it 'resolves the source of a test outside the project, whose name matches no path' do
411
+ allow(@file_path_utils).to receive(:form_test_name) { |test| test.to_s.ext( '' ).gsub( '..', '_up_' ) }
412
+ allow(@configurator).to receive(:collection_all_tests).and_return( ['../shared/test/unit/test_s.c'] )
413
+
414
+ found = @file_finder.find_build_input_file(
415
+ filepath: 'build/test/out/_up_/shared/test/unit/test_s/_t_/test_s.o', complain: :error, context: TEST_SYM
416
+ )
417
+ expect(found).to eq('../shared/test/unit/test_s.c')
418
+ end
419
+
420
+ it 'resolves a test whose name ends another test\'s path' do
421
+ allow(@configurator).to receive(:collection_all_tests).and_return( ['test/unit/test_calc.c', 'other/test/unit/test_calc.c'] )
422
+
423
+ found = @file_finder.find_build_input_file(
424
+ filepath: 'build/test/out/test/unit/test_calc/_t_/test_calc.o', complain: :error, context: TEST_SYM
425
+ )
426
+ expect(found).to eq('test/unit/test_calc.c')
427
+ end
428
+
429
+ it 'resolves a header named like its test to the test itself' do
430
+ allow(@configurator).to receive(:collection_all_tests).and_return( ['test/test_calc.c', 'test/unit/test_calc.c'] )
431
+
432
+ found = @file_finder.find_build_input_file( filepath: 'test_calc.h', complain: :error, context: TEST_SYM, test: 'test/unit/test_calc' )
433
+ expect(found).to eq('test/unit/test_calc.c')
434
+ end
435
+
436
+ it 'names every test once, however many lookups follow' do
437
+ expect(@configurator).to receive(:collection_all_tests).once.and_return( ['test/test_calc.c', 'test/unit/test_calc.c'] )
438
+
439
+ 2.times do
440
+ @file_finder.find_build_input_file( filepath: 'build/test/out/test/test_calc/_t_/test_calc.o', complain: :error, context: TEST_SYM )
441
+ end
442
+ end
443
+
444
+ it 'resolves a test\'s own runner by its own runner subdirectory, without treating another same-named test\'s runner as ambiguous' do
445
+ allow(@configurator).to receive(:project_test_runners_path).and_return('build/test/runners')
446
+ allow(@configurator).to receive(:collection_all_tests).and_return( ['unit/test_foo.c', 'integration/test_foo.c'] )
447
+
448
+ all_runners = {
449
+ 'build/test/runners/unit' => ['build/test/runners/unit/test_foo_runner.c'],
450
+ 'build/test/runners/integration' => ['build/test/runners/integration/test_foo_runner.c']
451
+ }
452
+ allow(@file_wrapper).to receive(:directory_listing) do |glob|
453
+ dir = all_runners.keys.find { |d| glob.start_with?(d) }
454
+ dir.nil? ? [] : all_runners[dir]
455
+ end
456
+
457
+ found = @file_finder.find_build_input_file(
458
+ filepath: 'build/test/out/unit/test_foo/_t_/test_foo_runner.o', complain: :error, context: TEST_SYM
459
+ )
460
+ expect(found).to eq('build/test/runners/unit/test_foo_runner.c')
461
+
462
+ found = @file_finder.find_build_input_file(
463
+ filepath: 'build/test/out/integration/test_foo/_t_/test_foo_runner.o', complain: :error, context: TEST_SYM
464
+ )
465
+ expect(found).to eq('build/test/runners/integration/test_foo_runner.c')
466
+ end
467
+
468
+ it 'resolves a mock generated once per test, by the current test\'s own build directory, without treating that expected repetition as ambiguous' do
469
+ allow(@configurator).to receive(:collection_all_tests).and_return( ['TestAdcModel.c', 'TestModel.c'] )
470
+
471
+ all_mocks = {
472
+ 'build/test/mocks/TestAdcModel/_t_' => ['build/test/mocks/TestAdcModel/_t_/MockTemperatureFilter.c'],
473
+ 'build/test/mocks/TestModel/_t_' => ['build/test/mocks/TestModel/_t_/MockTemperatureFilter.c']
474
+ }
475
+ # The real FileWrapper only lists files under the specific glob it's given; a test's own
476
+ # mock subtree is queried in isolation, which is exactly what keeps two tests' identically-
477
+ # named mocks from ever appearing in the same collection at once.
478
+ allow(@file_wrapper).to receive(:directory_listing) do |glob|
479
+ test_dir = all_mocks.keys.find { |dir| glob.start_with?(dir) }
480
+ test_dir.nil? ? [] : all_mocks[test_dir]
481
+ end
482
+
483
+ found = @file_finder.find_build_input_file(
484
+ filepath: 'build/test/out/TestAdcModel/_t_/MockTemperatureFilter.o', complain: :error, context: TEST_SYM
485
+ )
486
+ expect(found).to eq('build/test/mocks/TestAdcModel/_t_/MockTemperatureFilter.c')
487
+
488
+ found = @file_finder.find_build_input_file(
489
+ filepath: 'build/test/out/TestModel/_t_/MockTemperatureFilter.o', complain: :error, context: TEST_SYM
490
+ )
491
+ expect(found).to eq('build/test/mocks/TestModel/_t_/MockTemperatureFilter.c')
492
+ end
493
+
494
+ # A listing below a root, as the real FileWrapper gives, from files that each test's
495
+ # build put below its own root
496
+ def list_below(files)
497
+ allow(@file_wrapper).to receive(:directory_listing) do |glob|
498
+ root = glob.delete_suffix( '/**/*.c' )
499
+ files.select { |file| file.start_with?( root + '/' ) }
500
+ end
501
+ end
502
+
503
+ # One test's name continues another's, beside that test's own subdirectory of the same name
504
+ it 'keeps a test whose name continues another test\'s from sharing that test\'s mocks' do
505
+ allow(@configurator).to receive(:collection_all_tests).and_return( ['test/test_foo.c', 'test/test_foo/test_bar.c'] )
506
+ list_below( ['build/test/mocks/test/test_foo/_t_/Mockwidget.c', 'build/test/mocks/test/test_foo/test_bar/_t_/Mockwidget.c'] )
507
+
508
+ found = @file_finder.find_build_input_file( filepath: 'build/test/out/test/test_foo/_t_/Mockwidget.o', complain: :error, context: TEST_SYM )
509
+ expect(found).to eq('build/test/mocks/test/test_foo/_t_/Mockwidget.c')
510
+
511
+ found = @file_finder.find_build_input_file( filepath: 'build/test/out/test/test_foo/test_bar/_t_/Mockwidget.o', complain: :error, context: TEST_SYM )
512
+ expect(found).to eq('build/test/mocks/test/test_foo/test_bar/_t_/Mockwidget.c')
513
+ end
514
+
515
+ it 'keeps a test whose name continues another test\'s from sharing that test\'s Partials' do
516
+ allow(@configurator).to receive(:collection_all_tests).and_return( ['test/test_foo.c', 'test/test_foo/test_bar.c'] )
517
+ list_below( ['build/test/partials/test/test_foo/_t_/ceedling_partial_widget_impl.c', 'build/test/partials/test/test_foo/test_bar/_t_/ceedling_partial_widget_impl.c'] )
518
+
519
+ found = @file_finder.find_build_input_file( filepath: 'build/test/out/test/test_foo/_t_/ceedling_partial_widget_impl.o', complain: :error, context: TEST_SYM )
520
+ expect(found).to eq('build/test/partials/test/test_foo/_t_/ceedling_partial_widget_impl.c')
521
+ end
522
+
523
+ # A test's mock lies in a folder named like a test nested below it, which exists
524
+ it 'finds a test\'s mock in a folder named like a nested test' do
525
+ allow(@configurator).to receive(:collection_all_tests).and_return( ['test/test_c.c', 'test/test_c/test_x.c'] )
526
+ list_below( ['build/test/mocks/test/test_c/_t_/test_x/mock_qux.c'] )
527
+ allow(@configurator).to receive(:cmock_mock_prefix).and_return('mock_')
528
+
529
+ found = @file_finder.find_build_input_file( filepath: 'build/test/out/test/test_c/_t_/test_x/mock_qux.o', complain: :error, context: TEST_SYM, test: 'test/test_c' )
530
+ expect(found).to eq('build/test/mocks/test/test_c/_t_/test_x/mock_qux.c')
531
+
532
+ found = @file_finder.find_build_input_file( filepath: 'test_x/mock_qux.h', complain: :error, context: TEST_SYM, test: 'test/test_c' )
533
+ expect(found).to eq('build/test/mocks/test/test_c/_t_/test_x/mock_qux.c')
534
+ end
535
+
536
+ it 'finds a test\'s Partial in a folder named like a nested test' do
537
+ allow(@configurator).to receive(:collection_all_tests).and_return( ['test/test_c.c', 'test/test_c/test_x.c'] )
538
+ list_below( ['build/test/partials/test/test_c/_t_/test_x/ceedling_partial_qux_impl.c'] )
539
+
540
+ found = @file_finder.find_build_input_file( filepath: 'test_x/ceedling_partial_qux_impl', complain: :ignore, context: TEST_SYM, test: 'test/test_c' )
541
+ expect(found).to eq('build/test/partials/test/test_c/_t_/test_x/ceedling_partial_qux_impl.c')
542
+ end
543
+
544
+ # TEST_SOURCE_FILE() names a source by its path, with no test to scope a search by
545
+ it 'searches no test\'s mocks or Partials when no test is known' do
546
+ allow(@configurator).to receive(:collection_existing_test_build_input).and_return( ['src/Mockwidget.c', 'src/ceedling_partial_widget_impl.c'] )
547
+ list_below( ['build/test/mocks/test/test_other/_t_/Mockwidget.c', 'build/test/partials/test/test_other/_t_/ceedling_partial_widget_impl.c'] )
548
+
549
+ expect( @file_finder.find_build_input_file( filepath: 'Mockwidget.c', complain: :ignore, context: TEST_SYM ) ).to eq('src/Mockwidget.c')
550
+ expect( @file_finder.find_build_input_file( filepath: 'ceedling_partial_widget_impl.c', complain: :ignore, context: TEST_SYM ) )
551
+ .to eq('src/ceedling_partial_widget_impl.c')
552
+ expect(@file_wrapper).to_not have_received(:directory_listing)
553
+ end
554
+
555
+ it 'searches no mocks or Partials of a disabled feature' do
556
+ allow(@configurator).to receive(:project_use_mocks).and_return( false )
557
+ allow(@configurator).to receive(:project_use_partials).and_return( false )
558
+ allow(@configurator).to receive(:collection_existing_test_build_input).and_return( ['src/Mockwidget.c'] )
559
+ list_below( ['build/test/mocks/test/test_c/_t_/Mockwidget.c'] )
560
+
561
+ expect( @file_finder.find_build_input_file( filepath: 'Mockwidget.c', complain: :ignore, context: TEST_SYM, test: 'test/test_c' ) )
562
+ .to eq('src/Mockwidget.c')
563
+ expect(@file_wrapper).to_not have_received(:directory_listing)
564
+ end
565
+
566
+ # A hand-written fake may take a mock's name, and a test links it through TEST_SOURCE_FILE()
567
+ it 'finds a hand-written source named with the mock prefix that its test\'s mocks don\'t hold' do
568
+ allow(@configurator).to receive(:collection_all_tests).and_return( ['test/test_b.c'] )
569
+ allow(@configurator).to receive(:collection_existing_test_build_input).and_return( ['test/support/Mockspi.c'] )
570
+ list_below( ['build/test/mocks/test/test_a/_t_/Mockspi.c'] )
571
+
572
+ found = @file_finder.find_build_input_file(
573
+ filepath: 'build/test/out/test/test_b/_t_/test/support/Mockspi.o', complain: :error, context: TEST_SYM, test: 'test/test_b'
574
+ )
575
+ expect(found).to eq('test/support/Mockspi.c')
576
+ end
577
+
578
+ it 'finds a hand-written source named with the Partial prefix that its test\'s Partials don\'t hold' do
579
+ allow(@configurator).to receive(:collection_all_tests).and_return( ['test/test_b.c'] )
580
+ allow(@configurator).to receive(:collection_existing_test_build_input).and_return( ['test/support/ceedling_partial_spi.c'] )
581
+ list_below( [] )
582
+
583
+ found = @file_finder.find_build_input_file(
584
+ filepath: 'build/test/out/test/test_b/_t_/test/support/ceedling_partial_spi.o', complain: :error, context: TEST_SYM, test: 'test/test_b'
585
+ )
586
+ expect(found).to eq('test/support/ceedling_partial_spi.c')
587
+ end
588
+
589
+ it 'finds a test\'s own mock ahead of a hand-written source of the same name' do
590
+ allow(@configurator).to receive(:collection_all_tests).and_return( ['test/test_b.c'] )
591
+ allow(@configurator).to receive(:collection_existing_test_build_input).and_return( ['Mockspi.c'] )
592
+ list_below( ['build/test/mocks/test/test_b/_t_/Mockspi.c'] )
593
+
594
+ found = @file_finder.find_build_input_file( filepath: 'build/test/out/test/test_b/_t_/Mockspi.o', complain: :error, context: TEST_SYM )
595
+ expect(found).to eq('build/test/mocks/test/test_b/_t_/Mockspi.c')
596
+ end
597
+
598
+ it 'names the mock it sought when neither its test\'s mocks nor the build input hold it' do
599
+ allow(@configurator).to receive(:collection_all_tests).and_return( ['test/test_b.c'] )
600
+ allow(@configurator).to receive(:collection_existing_test_build_input).and_return( ['src/other.c'] )
601
+ list_below( [] )
602
+
603
+ expect {
604
+ @file_finder.find_build_input_file( filepath: 'build/test/out/test/test_b/_t_/drv/Mockspi.o', complain: :error, context: TEST_SYM )
605
+ }.to raise_error( CeedlingException, 'Found no file `drv/Mockspi.c` in search paths.' )
606
+ end
607
+
608
+ it 'warns once of a mock that neither its test\'s mocks nor the build input hold' do
609
+ allow(@configurator).to receive(:collection_all_tests).and_return( ['test/test_b.c'] )
610
+ allow(@configurator).to receive(:collection_existing_test_build_input).and_return( ['src/other.c'] )
611
+ list_below( [] )
612
+
613
+ found = @file_finder.find_build_input_file( filepath: 'build/test/out/test/test_b/_t_/drv/Mockspi.o', complain: :warn, context: TEST_SYM )
614
+
615
+ expect(found).to be_nil
616
+ expect(@loginator).to have_received(:log).once
617
+ expect(@loginator).to have_received(:log).with( 'Found no file `drv/Mockspi.c` in search paths.', Verbosity::COMPLAIN )
618
+ end
619
+
620
+ it 'lists a test\'s mocks with any bracket in its path escaped, so the listing is not a glob class' do
621
+ allow(@configurator).to receive(:collection_all_tests).and_return( ['test[1]/test_foo.c'] )
622
+
623
+ expect(@file_wrapper).to receive(:directory_listing).with( 'build/test/mocks/test\[1\]/test_foo/_t_/**/*.c' )
624
+ .and_return( ['build/test/mocks/test[1]/test_foo/_t_/Mockwidget.c'] )
625
+
626
+ found = @file_finder.find_build_input_file( filepath: 'build/test/out/test[1]/test_foo/_t_/Mockwidget.o', complain: :error, context: TEST_SYM )
627
+ expect(found).to eq('build/test/mocks/test[1]/test_foo/_t_/Mockwidget.c')
628
+ end
629
+
630
+ # A mock of a header at a search path's root sits in the test's mock root, and a same-named
631
+ # mock below it ends with the same name
632
+ it 'resolves a mock in the test\'s mock root beside a same-named mock below it' do
633
+ allow(@configurator).to receive(:collection_all_tests).and_return( ['test/test_t.c'] )
634
+ allow(@file_wrapper).to receive(:directory_listing).and_return(
635
+ ['build/test/mocks/test/test_t/_t_/b/Mocktask.c', 'build/test/mocks/test/test_t/_t_/Mocktask.c']
636
+ )
637
+
638
+
639
+ # The planner asks by each mock's #include
640
+ found = @file_finder.find_build_input_file( filepath: 'Mocktask.h', complain: :error, context: TEST_SYM, test: 'test/test_t' )
641
+ expect(found).to eq('build/test/mocks/test/test_t/_t_/Mocktask.c')
642
+
643
+ found = @file_finder.find_build_input_file( filepath: 'b/Mocktask.h', complain: :error, context: TEST_SYM, test: 'test/test_t' )
644
+ expect(found).to eq('build/test/mocks/test/test_t/_t_/b/Mocktask.c')
645
+ end
646
+
647
+ # A mock an earlier build placed deeper ends with the same folder and name
648
+ it 'resolves a mock in a subdirectory of the test\'s mock root beside a same-named mock below another' do
649
+ allow(@configurator).to receive(:collection_all_tests).and_return( ['test/test_t.c'] )
650
+ allow(@file_wrapper).to receive(:directory_listing).and_return(
651
+ ['build/test/mocks/test/test_t/_t_/src/drivers/Mocktask.c', 'build/test/mocks/test/test_t/_t_/drivers/Mocktask.c']
652
+ )
653
+
654
+ found = @file_finder.find_build_input_file( filepath: 'drivers/Mocktask.h', complain: :error, context: TEST_SYM, test: 'test/test_t' )
655
+ expect(found).to eq('build/test/mocks/test/test_t/_t_/drivers/Mocktask.c')
656
+ end
657
+
658
+ it 'still raises when the very same test mocks two different same-named headers from different directories' do
659
+ allow(@file_wrapper).to receive(:directory_listing).and_return(
660
+ ['build/test/mocks/TestAdcModel/_t_/foo/MockBar.c', 'build/test/mocks/TestAdcModel/_t_/baz/MockBar.c']
661
+ )
662
+
663
+ expect {
664
+ @file_finder.find_build_input_file(
665
+ filepath: 'build/test/out/TestAdcModel/_t_/MockBar.o', complain: :error, context: TEST_SYM
666
+ )
667
+ }.to raise_error(CeedlingException)
668
+ end
669
+
670
+ it 'resolves a mock scoped to its own test via an explicitly-given test identity, even when the object path itself is flat (e.g. a GCOV or Bullseye build with no per-test mirroring of its own)' do
671
+ # This build mirrors nothing per test, so the object sits below neither the mock
672
+ # root nor the test's own out root and the mock resolves by name alone.
673
+
674
+ all_mocks = {
675
+ 'build/test/mocks/TestAdcModel/_t_' => ['build/test/mocks/TestAdcModel/_t_/MockTemperatureFilter.c'],
676
+ 'build/test/mocks/TestModel/_t_' => ['build/test/mocks/TestModel/_t_/MockTemperatureFilter.c']
677
+ }
678
+ allow(@file_wrapper).to receive(:directory_listing) do |glob|
679
+ test_dir = all_mocks.keys.find { |dir| glob.start_with?(dir) }
680
+ test_dir.nil? ? [] : all_mocks[test_dir]
681
+ end
682
+
683
+ # A flat, project-wide object path (no per-test subdirectory of its own, as GCOV/Bullseye
684
+ # form their own objects) carries no test identity for test_context_of to recover -- only
685
+ # the explicitly-given `test:` lets this resolve to the right one of two same-named mocks.
686
+ found = @file_finder.find_build_input_file(
687
+ filepath: 'build/gcov/out/MockTemperatureFilter.o', complain: :error, context: :gcov, test: 'TestAdcModel'
688
+ )
689
+ expect(found).to eq('build/test/mocks/TestAdcModel/_t_/MockTemperatureFilter.c')
690
+
691
+ found = @file_finder.find_build_input_file(
692
+ filepath: 'build/gcov/out/MockTemperatureFilter.o', complain: :error, context: :gcov, test: 'TestModel'
693
+ )
694
+ expect(found).to eq('build/test/mocks/TestModel/_t_/MockTemperatureFilter.c')
695
+ end
696
+
697
+ it 'resolves a release object to the source at its own path, even when another same-named source exists elsewhere' do
698
+ allow(@configurator).to receive(:collection_release_build_input).and_return(
699
+ ['drivers/foo/bar.c', 'drivers/baz/bar.c']
700
+ )
701
+
702
+ found = @file_finder.find_build_input_file(
703
+ filepath: 'build/release/out/drivers/foo/bar.o', complain: :error, context: RELEASE_SYM
704
+ )
705
+ expect(found).to eq('drivers/foo/bar.c')
706
+
707
+ found = @file_finder.find_build_input_file(
708
+ filepath: 'build/release/out/drivers/baz/bar.o', complain: :error, context: RELEASE_SYM
709
+ )
710
+ expect(found).to eq('drivers/baz/bar.c')
711
+ end
712
+
713
+ # A release build has no per-test directories, so it places a directory named `_t_` as is
714
+ it 'resolves a release object of a source in a directory named like `_t_` to exactly that source' do
715
+ allow(@configurator).to receive(:collection_release_build_input).and_return( ['src/_t_/foo.c', 'src/__t_/foo.c'] )
716
+
717
+ found = @file_finder.find_build_input_file( filepath: 'build/release/out/src/_t_/foo.o', complain: :error, context: RELEASE_SYM )
718
+ expect(found).to eq('src/_t_/foo.c')
719
+
720
+ found = @file_finder.find_build_input_file( filepath: 'build/release/out/src/__t_/foo.o', complain: :error, context: RELEASE_SYM )
721
+ expect(found).to eq('src/__t_/foo.c')
722
+ end
723
+
724
+ it 'resolves a module-under-test object to the source at its own path, even when another same-named module exists elsewhere' do
725
+ allow(@configurator).to receive(:collection_existing_test_build_input).and_return(
726
+ ['drivers/foo/bar.c', 'drivers/baz/bar.c']
727
+ )
728
+
729
+ found = @file_finder.find_build_input_file(
730
+ filepath: 'build/test/out/TestFoo/_t_/drivers/foo/bar.o', complain: :error, context: TEST_SYM, test: 'TestFoo'
731
+ )
732
+ expect(found).to eq('drivers/foo/bar.c')
733
+
734
+ found = @file_finder.find_build_input_file(
735
+ filepath: 'build/test/out/TestFoo/_t_/drivers/baz/bar.o', complain: :error, context: TEST_SYM, test: 'TestFoo'
736
+ )
737
+ expect(found).to eq('drivers/baz/bar.c')
738
+ end
739
+
740
+ # A tail match of `src/util` takes whichever of these comes first
741
+ it 'resolves an object to exactly its own source, never one whose path merely ends the same way' do
742
+ allow(@configurator).to receive(:collection_release_build_input).and_return( ['lib/src/util.c', 'src/util.c'] )
743
+
744
+ found = @file_finder.find_build_input_file( filepath: 'build/release/out/src/util.o', complain: :error, context: RELEASE_SYM )
745
+ expect(found).to eq('src/util.c')
746
+ end
747
+
748
+ it 'resolves an object of a source above the project root' do
749
+ allow(@configurator).to receive(:collection_release_build_input).and_return( ['src/crc.c', '../shared/src/crc.c'] )
750
+
751
+ found = @file_finder.find_build_input_file( filepath: 'build/release/out/_up_/shared/src/crc.o', complain: :error, context: RELEASE_SYM )
752
+ expect(found).to eq('../shared/src/crc.c')
753
+ end
754
+
755
+ # GH #1387: a source below a shortened root builds below the root's marker
756
+ it 'resolves an object below a shortened root to exactly its own source' do
757
+ root = '../vendor/acme/sdk/v3/src'
758
+ table = BuildRoots.table( [root] )
759
+ allow(@file_path_utils).to receive(:build_roots).and_return( table )
760
+ allow(@configurator).to receive(:collection_release_build_input).and_return( ['os/crc.c', "#{root}/os/crc.c"] )
761
+
762
+ found = @file_finder.find_build_input_file( filepath: "build/release/out/#{table.marker_for( root )}/os/crc.o", complain: :error, context: RELEASE_SYM )
763
+ expect(found).to eq( "#{root}/os/crc.c" )
764
+ end
765
+
766
+ # Left from a build whose configuration had another root
767
+ it 'resolves an object below a marker no root holds by its name' do
768
+ allow(@configurator).to receive(:collection_release_build_input).and_return( ['src/crc.c'] )
769
+
770
+ found = @file_finder.find_build_input_file( filepath: 'build/release/out/_src_ABCDEF12/crc.o', complain: :error, context: RELEASE_SYM )
771
+ expect(found).to eq('src/crc.c')
772
+ end
773
+
774
+ it 'resolves an object of a file in the running Ceedling installation, placed below `_ceedling_`' do
775
+ helper = File.join( BuildSubpath::INSTALLATION_ROOT, 'plugins/fff/src/fff_unity_helper.c' )
776
+ allow(@configurator).to receive(:collection_existing_test_build_input).and_return( ['src/fff_unity_helper.c', helper] )
777
+
778
+ Dir.mktmpdir do |project|
779
+ Dir.chdir( project ) do
780
+ found = @file_finder.find_build_input_file(
781
+ filepath: 'build/test/out/test/test_x/_t_/_ceedling_/plugins/fff/src/fff_unity_helper.o', complain: :error, context: TEST_SYM, test: 'test/test_x'
782
+ )
783
+ expect(found).to eq( helper )
784
+ end
785
+ end
786
+ end
787
+
788
+ it 'recovers a nested test\'s identity from its object\'s path, rather than its parent test\'s' do
789
+ allow(@configurator).to receive(:collection_all_tests).and_return( ['test/test_foo.c', 'test/test_foo/test_bar.c'] )
790
+ allow(@configurator).to receive(:collection_existing_test_build_input).and_return( ['src/util.c'] )
791
+
792
+ expect(@file_finder.find_build_input_file( filepath: 'build/test/out/test/test_foo/test_bar/_t_/test/test_foo/test_bar.o', complain: :error, context: TEST_SYM ))
793
+ .to eq('test/test_foo/test_bar.c')
794
+ expect(@file_finder.find_build_input_file( filepath: 'build/test/out/test/test_foo/_t_/test/test_foo.o', complain: :error, context: TEST_SYM ))
795
+ .to eq('test/test_foo.c')
796
+ end
797
+
798
+ it 'still resolves a flat module-under-test object by basename when no test identity is given' do
799
+ allow(@configurator).to receive(:collection_existing_test_build_input).and_return( ['drivers/bar.c'] )
800
+
801
+ found = @file_finder.find_build_input_file(
802
+ filepath: 'build/test/out/TestFoo/bar.o', complain: :error, context: TEST_SYM
803
+ )
804
+ expect(found).to eq('drivers/bar.c')
805
+ end
806
+
807
+ it 'never raises on a bare, ambiguous TEST_SOURCE_FILE()-style query -- resolves to the first candidate by project path order' do
808
+ allow(@configurator).to receive(:collection_existing_test_build_input).and_return(
809
+ ['drivers/foo/bar.c', 'drivers/baz/bar.c']
810
+ )
811
+
812
+ found = @file_finder.find_build_input_file( filepath: 'bar.c', complain: :ignore, context: TEST_SYM )
813
+ expect(found).to eq('drivers/foo/bar.c')
814
+ end
815
+
816
+ it 'preserves a source-tree-relative query\'s own path, rather than collapsing it to a bare basename' do
817
+ allow(@configurator).to receive(:collection_existing_test_build_input).and_return(
818
+ ['drivers/foo/bar.c', 'drivers/baz/bar.c']
819
+ )
820
+
821
+ found = @file_finder.find_build_input_file(
822
+ filepath: 'drivers/foo/bar.c', complain: :error, context: TEST_SYM
823
+ )
824
+ expect(found).to eq('drivers/foo/bar.c')
825
+ end
826
+
827
+ it 'still resolves a plugin\'s own build-context object by basename, an unrecognized build root having no mirroring rule of its own' do
828
+ allow(@configurator).to receive(:collection_existing_test_build_input).and_return( ['drivers/bar.c'] )
829
+
830
+ found = @file_finder.find_build_input_file(
831
+ filepath: 'build/valgrind/out/TestFoo/bar.o', complain: :error, context: :valgrind
832
+ )
833
+ expect(found).to eq('drivers/bar.c')
834
+ end
835
+
836
+ it 'does not mistake an unrelated resolved path\'s own directory name for a test identity, when that directory happens to share the file\'s own basename' do
837
+ allow(@configurator).to receive(:collection_existing_test_build_input).and_return( ['build/vendor/ceedling/ceedling.c'] )
838
+
839
+ found = @file_finder.find_build_input_file(
840
+ filepath: 'build/vendor/ceedling/ceedling.h', complain: :ignore, context: TEST_SYM
841
+ )
842
+ expect(found).to eq('build/vendor/ceedling/ceedling.c')
843
+ end
844
+ end
845
+ end