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
@@ -8,39 +8,31 @@
8
8
  require 'rubygems'
9
9
  require 'rake' # for adding ext() method to string
10
10
  require 'ceedling/exceptions'
11
- require 'ceedling/path_matcher'
12
- require 'ceedling/path_mirror'
13
- require 'ceedling/file_path_utils'
11
+ require 'ceedling/filesystem/path_matcher'
12
+ require 'ceedling/filesystem/path_mirror'
13
+ require 'ceedling/filesystem/file_path_utils'
14
+ require 'ceedling/filesystem/project_paths'
15
+ require 'ceedling/filesystem/build_subpath'
14
16
 
15
17
  class FileFinder
16
18
 
17
- constructor :configurator, :file_finder_helper, :file_path_utils, :file_wrapper, :yaml_wrapper
19
+ constructor :configurator, :file_finder_helper, :file_path_utils, :file_wrapper, :yaml_wrapper, :test_build_layout
20
+
21
+ def setup
22
+ @test_names_lock = Mutex.new
23
+ end
18
24
 
19
25
 
20
- # `collection`, when given, is a caller's own already-ordered, per-test header list
21
- # (see IncludePathinator#ordered_header_files) reflecting that one test's real search-path
22
- # priority -- TEST_INCLUDE_PATH() ranked ahead of :support/:include, as a real compile would
23
- # see it. Absent that (a caller with no single test in view, e.g. Partializer resolving a
24
- # module generically), the project-wide collection_all_headers is the only sensible fallback.
26
+ # `collection`, when given, is a test's HeaderSearch (see IncludePathinator#header_search),
27
+ # which finds the header through that test's search paths as its compiler would, or a
28
+ # caller's own ordered header list. Absent either, the project-wide collection_all_headers
29
+ # is the fallback.
25
30
  # `complain` sets what a missing header does: :error raises, and :warn or :ignore
26
31
  # returns nil. A header matching only in letter case raises under all three; :silent
27
32
  # returns nil for that too.
28
33
  def find_header_input_for_mock(mock, collection: nil, complain: :error)
29
- # Mock name/path => <mock prefix><header filename (.h)>, optionally preceded by however
30
- # much path the #include itself carried (e.g. 'Mockfoo.h' or 'drivers/Mockfoo.h').
31
- # Note: In some rare cases, a mock name may include a dot (ex. Sensor.44) because of versioning file naming convention
32
- # Be careful about assuming the end of the name has any sort of file extension
33
- #
34
- # Stripping the mock prefix from only the basename -- not the whole query -- preserves
35
- # whatever disambiguating path the #include carried, so a query with a path is matched
36
- # exactly as specifically as it was written, not collapsed to a bare basename that would
37
- # throw away real disambiguating information.
38
- dir = File.dirname(mock)
39
- basename = File.basename(mock).delete_prefix(@configurator.cmock_mock_prefix)
40
- header = dir == '.' ? basename : File.join(dir, basename)
41
-
42
34
  found_path = @file_finder_helper.resolve_file_in_collection(
43
- header,
35
+ mock_header_query(mock),
44
36
  collection || @configurator.collection_all_headers,
45
37
  complain
46
38
  )
@@ -48,6 +40,16 @@ class FileFinder
48
40
  return found_path
49
41
  end
50
42
 
43
+ # The header a mock's #include names, as in 'Mockfoo.h' or 'drivers/Mockfoo.h'. The mock
44
+ # prefix drops from the filename alone, so the path the #include carried stays in the
45
+ # query. A mock name may hold a dot (Sensor.44) by a versioning convention, so nothing
46
+ # here assumes the name ends in an extension.
47
+ def mock_header_query(mock)
48
+ dir = File.dirname(mock)
49
+ basename = File.basename(mock).delete_prefix(@configurator.cmock_mock_prefix)
50
+ return dir == '.' ? basename : File.join(dir, basename)
51
+ end
52
+
51
53
  # A mock's real header and its own mirrored subdirectory below whichever configured
52
54
  # :test/:support/:include root contains it -- the same roots collection_all_headers is
53
55
  # built from. Combined into one call since every caller needing the mirrored subdirectory
@@ -59,7 +61,7 @@ class FileFinder
59
61
  source = find_header_input_for_mock(mock, collection: collection, complain: complain)
60
62
  return [nil, nil] if source.nil?
61
63
 
62
- subdir = PathMirror.relative_subdir(source, @configurator.paths_test + @configurator.paths_support + @configurator.paths_include)
64
+ subdir = PathMirror.relative_subdir_from_clean_roots( source, @configurator.collection_mirror_roots_headers )
63
65
  return [source, subdir]
64
66
  end
65
67
 
@@ -72,11 +74,10 @@ class FileFinder
72
74
  # compilation step downstream to catch a wrong guess the way there is for a header
73
75
  # or source file resolved during a build.
74
76
  #
75
- # A task name has no file of its own to anchor a `..` against, unlike an #include or
76
- # TEST_SOURCE_FILE() entry -- resolving with no anchor surfaces that as a specific,
77
- # named error rather than falling through to a generic file-not-found further down.
77
+ # A task name is relative to the working directory, as every collected path is, so a
78
+ # leading `..` names a test outside the project.
78
79
  def find_test_file_from_name(name)
79
- name = PathMatcher.resolve_relative(name)
80
+ name = PathMatcher.resolve_relative(name, anchor: '')
80
81
  return find_first_candidate(name, @configurator.extension_source, @configurator.collection_all_tests, :error, strict: true)
81
82
  end
82
83
 
@@ -89,14 +90,15 @@ class FileFinder
89
90
  # Extract filename without file extension
90
91
  source_file = File.basename(filepath).ext('')
91
92
 
92
- # Recovered once and reused by every branch below that needs it, rather than each
93
- # independently re-deriving the same test identity from the same filepath. Prefers the
94
- # caller's own explicitly-known test identity over inferring it from the filepath's own
95
- # structure -- inference only works when a context's own object paths are mirrored under
96
- # a per-test subdirectory (the :test context is; GCOV and Bullseye's own flat, project-wide
97
- # object paths are not), so a context lacking that structure would otherwise never recover
98
- # a test identity at all.
99
- test_context = test ? test.to_s : test_context_of(filepath)
93
+ # Recovered once and reused by every branch below that needs it. The caller's own test
94
+ # comes first. Without one, a build file's own place in the test build layout names its
95
+ # test exactly, and a source-tree query, from an #include or TEST_SOURCE_FILE(), names none.
96
+ test_context = test ? test.to_s : test_context_of(filepath, context)
97
+
98
+ # A test's generated mocks and Partials sit below its own roots, which only a known test
99
+ # has. Without one these branches search nothing, so a query never finds another test's.
100
+ mocks_root = release ? nil : @test_build_layout.root( :mocks, test_context )
101
+ partials_root = release ? nil : @test_build_layout.root( :partials, test_context )
100
102
 
101
103
  # We only collect files that already exist when we start up.
102
104
  # FileLists can produce undesired results for dynamically generated files depending on when they're accessed.
@@ -107,9 +109,13 @@ class FileFinder
107
109
  # Some legacy files can include naming conventions like <name>.##.<ext> for versioning.
108
110
  # If we use .ext() below we'll clobber the dotted portion of the filename
109
111
 
110
- # Generated test runners -- a flat test's own runner is searched for in the shared flat
111
- # runners directory; only a nested test's own mirrored subdirectory scopes the search
112
- # further, so two same-named tests' runners are never mistaken for each other
112
+ # The name and the files a mock or Partial branch below searched. A hand-written source may
113
+ # take a generated file's name, so a miss there falls through to the build's sources. A miss
114
+ # of both complains of the generated file.
115
+ generated = nil
116
+
117
+ # Generated test runners -- searched for in the runners directory of this test's name,
118
+ # so two same-named tests' runners are never mistaken for each other
113
119
  if (!release) and
114
120
  (source_file =~ /^#{Regexp.escape(@configurator.project_test_file_prefix)}.+#{Regexp.escape(@configurator.test_runner_file_suffix)}$/)
115
121
  _source_file = source_file + EXTENSION_CORE_SOURCE
@@ -123,52 +129,49 @@ class FileFinder
123
129
  @file_wrapper.directory_listing( FilePathUtils.glob(runner_scope_dir(test_context), '*') ),
124
130
  complain)
125
131
 
126
- # Generated mocks -- scoped to this test's own mock subtree so another test's
132
+ # Generated mocks -- scoped to this test's own mock root so another test's
127
133
  # identically named mock (expected, routine repetition) is never mistaken for ambiguity
128
- elsif (!release) and
134
+ elsif !mocks_root.nil? and
129
135
  (source_file.start_with?( @configurator.cmock_mock_prefix ))
130
136
  # A mock mirrors the directory of whatever it mocks, so two same-named headers
131
137
  # mocked in one test -- two modules mocked as Partials by directory, say -- are
132
138
  # told apart only by that subdirectory. Measured the same way a generated
133
139
  # Partial's is, below.
134
- mocks_root = File.join(@configurator.cmock_mock_path, test_context)
135
- subdir = generated_file_subdir( filepath, mocks_root, test: test, context: context )
140
+ subdir = generated_file_subdir( filepath, mocks_root, test: test_context, context: context )
136
141
 
137
142
  _source_file = source_file + EXTENSION_CORE_SOURCE
138
143
  _source_file = File.join( subdir, _source_file ) unless subdir.empty?
144
+ collection = own_generated_files( mocks_root )
139
145
 
140
- found_file =
141
- @file_finder_helper.find_file_in_collection(
142
- _source_file,
143
- @file_wrapper.directory_listing(
144
- File.join(mocks_root, ('**/*' + EXTENSION_CORE_SOURCE))
145
- ),
146
- complain)
146
+ # The mock at exactly this place below the root comes first, since a same-named mock
147
+ # deeper down, such as one an earlier build left, ends with the same folder and name.
148
+ # A flat object path names no subdirectory, so the name alone still finds a mock
149
+ # anywhere below the root.
150
+ exact = ProjectPaths.segments( File.join( mocks_root, _source_file ) )
151
+ found_file = collection.find { |file| ProjectPaths.segments( file ) == exact }
152
+ found_file ||= @file_finder_helper.find_file_in_collection( _source_file, collection, :ignore )
153
+ generated = [_source_file, collection]
147
154
 
148
155
  # Generated partials -- same per-test scoping rationale as mocks, above
149
- elsif (!release) and
156
+ elsif !partials_root.nil? and
150
157
  (source_file.start_with?( PARTIAL_FILENAME_PREFIX ))
151
158
  # A generated Partial sits in the subdirectory mirroring its own module, so that
152
159
  # subdirectory is what distinguishes two modules sharing a basename. Derived the
153
160
  # same way a mock's is, above.
154
- partials_root = File.join(@configurator.project_test_partials_path, test_context)
155
- subdir = generated_file_subdir( filepath, partials_root, test: test, context: context )
161
+ subdir = generated_file_subdir( filepath, partials_root, test: test_context, context: context )
156
162
 
157
163
  _source_file = source_file + EXTENSION_CORE_SOURCE
158
164
  _source_file = File.join( subdir, _source_file ) unless subdir.empty?
159
165
 
160
- collection =
161
- @file_wrapper.directory_listing(
162
- File.join(partials_root, ('**/*' + EXTENSION_CORE_SOURCE))
163
- )
166
+ collection = own_generated_files( partials_root )
164
167
 
165
168
  # Ambiguity is detected here rather than rescued from the matching below. One
166
169
  # matching implementation stays in force, and the message is composed from the
167
170
  # module names the test author wrote instead of reworded by exception.
168
171
  raise_ambiguous_partial!( _source_file, collection, partials_root )
169
172
 
170
- found_file =
171
- @file_finder_helper.find_file_in_collection( _source_file, collection, complain )
173
+ found_file = @file_finder_helper.find_file_in_collection( _source_file, collection, :ignore )
174
+ generated = [_source_file, collection]
172
175
 
173
176
  # Vendor framework sources (unity.c, cmock.c, cexception.c, etc.)
174
177
  # Note: Taking a small chance by mixing test and release frameworks without smart checks on test/release build
@@ -180,12 +183,11 @@ class FileFinder
180
183
  @configurator.collection_existing_test_build_input,
181
184
  complain)
182
185
 
183
- # The test file's own object, resolving back to its own source -- go directly by this
184
- # object's own test identity rather than searching the whole project's test collection
185
- # by bare basename, which is exactly the kind of query that's ambiguous the moment
186
- # another same-named test exists elsewhere
186
+ # The test file's own object resolves to the test it names. A name is the test's path,
187
+ # so the lookup is exact. Searching by name instead is ambiguous wherever one test's
188
+ # name ends another test's path.
187
189
  elsif (!release) and !test_context.empty? and (source_file == File.basename( test_context ))
188
- found_file = find_test_file_from_name( test_context )
190
+ found_file = test_files_by_name[test_context]
189
191
 
190
192
  end
191
193
 
@@ -194,45 +196,28 @@ class FileFinder
194
196
  end
195
197
 
196
198
  #
197
- # Above we can confidently rely on the complain parameter passed to file_finder_helper because
198
- # we know the specific type of file being searched for.
199
+ # Above, runners and vendor sources rely on the complain parameter passed to file_finder_helper,
200
+ # since the kind of file sought is certain. Mocks and Partials complain only once the lookup
201
+ # below misses too.
199
202
  #
200
203
  # Below we ignore file misses because of lgoical complexities of searching for potentially either
201
204
  # assmebly or C files, including C files that may not exist (counterparts to header files by convention).
202
205
  # We save the existence handling until the end.
203
206
  #
204
207
 
205
- # A module-under-test or release source's object mirrors that source's own subdirectory
206
- # below whichever configured root it came from -- recovering that mirrored subdirectory
207
- # here lets the query go straight to the matching source, rather than a bare basename
208
- # that's ambiguous the moment another same-named source exists elsewhere.
209
- query_file = mirrored_query(filepath, release: release, test: test, context: context)
208
+ # A module-under-test or release object sits at its source's own path below its build
209
+ # root, so that path recovers the one source, rather than a bare basename that is
210
+ # ambiguous the moment another same-named source exists elsewhere.
211
+ query_file, exact = mirrored_query(filepath, release: release, test: test, context: context)
210
212
 
211
- # Assembly files for release build
212
- if release and @configurator.release_build_use_assembly
213
- found_file = try_extensions(query_file, @configurator.extension_assembly, @configurator.collection_release_build_input)
214
-
215
- # Assembly files for test build
216
- elsif (!release) and @configurator.test_build_use_assembly
217
- found_file = try_extensions(query_file, @configurator.extension_assembly, @configurator.collection_existing_test_build_input)
218
- end
219
-
220
- if !found_file.nil?
221
- return found_file
222
- end
223
-
224
- # Release build C files
225
- if release
226
- found_file = try_extensions(query_file, @configurator.extension_source, @configurator.collection_release_build_input)
227
-
228
- # Test build C files
229
- else
230
- found_file = try_extensions(query_file, @configurator.extension_source, @configurator.collection_existing_test_build_input)
231
- end
213
+ found_file = find_compiled_input( query_file, release: release, exact: exact )
232
214
 
233
215
  if found_file.nil?
234
- # Every name actually attempted above, laid out for the reader in the same order they
235
- # were tried, so a missing-file complaint names every filename ceedling went looking for.
216
+ # A generated file's search complains as it would alone, naming the file it sought
217
+ return @file_finder_helper.find_file_in_collection( *generated, complain ) unless generated.nil?
218
+
219
+ # Every name actually attempted, in the order tried, so a missing-file complaint
220
+ # names every filename ceedling went looking for.
236
221
  tried = @configurator.extension_source.map { |ext| query_file + ext }
237
222
  tried += @configurator.extension_assembly.map { |ext| query_file + ext } if @configurator.release_build_use_assembly
238
223
  @file_finder_helper.handle_missing_file(tried.join(' or '), complain)
@@ -242,8 +227,8 @@ class FileFinder
242
227
  end
243
228
 
244
229
 
245
- # `collection`, when given, overrides collection_all_headers with a caller's own
246
- # already-ordered, per-test header list -- see find_header_input_for_mock's comment.
230
+ # `collection`, when given, overrides collection_all_headers with a test's HeaderSearch or
231
+ # a caller's own ordered header list -- see find_header_input_for_mock's comment.
247
232
  def find_header_file(filepath, complain = :error, collection: nil)
248
233
  return find_first_candidate(filepath, @configurator.extension_header, collection || @configurator.collection_all_headers, complain)
249
234
  end
@@ -265,6 +250,24 @@ class FileFinder
265
250
 
266
251
  private
267
252
 
253
+ # A C or assembly build input for `query`, assembly first where the build uses it. An
254
+ # exact query is the file's own path, matched as such before any tail match.
255
+ def find_compiled_input(query, release:, exact:)
256
+ collection = release ? @configurator.collection_release_build_input : @configurator.collection_existing_test_build_input
257
+
258
+ compiled_extensions( release ).each do |extension|
259
+ found = (exact && exact_file( query, extension, collection )) || try_extensions( query, extension, collection )
260
+ return found unless found.nil?
261
+ end
262
+
263
+ return nil
264
+ end
265
+
266
+ def compiled_extensions(release)
267
+ assembly = release ? @configurator.release_build_use_assembly : @configurator.test_build_use_assembly
268
+ return assembly ? [@configurator.extension_assembly, @configurator.extension_source] : [@configurator.extension_source]
269
+ end
270
+
268
271
  # Translates a generated-Partial ambiguity into the test author's own terms. The query
269
272
  # here is a generated filename under a build directory, neither of which the author
270
273
  # typed, so reporting them offers nothing to act on. Candidates render as extensionless
@@ -299,74 +302,92 @@ class FileFinder
299
302
  raise CeedlingException.new( message )
300
303
  end
301
304
 
302
- # A test object's build directory identity mirrors the configured test root a source
303
- # file lives under (e.g. `unit/test_foo` for `test/unit/test_foo.c`, plain `test_foo` for
304
- # a flat file). Recovering that identity from a build artifact's own path lets a lookup
305
- # go straight to the one test it belongs to, rather than searching the whole project by
306
- # bare basename -- exactly the query shape that's ambiguous when another same-named test
307
- # exists elsewhere.
305
+ # The name of the test whose own build directory holds `filepath` (TestBuildLayout#locate),
306
+ # such as `test/unit/test_foo` for an object below `build/test/out/test/unit/test_foo/_t_/`.
307
+ # It lets a lookup go straight to the one test a build file belongs to, rather than
308
+ # searching the whole project by bare basename, the query shape that's ambiguous when
309
+ # another same-named test exists elsewhere.
308
310
  #
309
- # A filepath that isn't under the test build root at all (a source-tree-relative query
310
- # from an #include or TEST_SOURCE_FILE(), rather than a build artifact's own path) has no
311
- # test identity to recover -- empty string, never a directory name that could coincidentally
312
- # match some unrelated file's own basename.
313
- def test_context_of(filepath)
314
- dir = File.dirname( filepath )
315
- root = @configurator.project_test_build_output_path
316
- return dir.start_with?( root + '/' ) ? dir[(root.length + 1)..] : ''
311
+ # A filepath below no test's own directory, such as a source-tree-relative query from an
312
+ # #include or TEST_SOURCE_FILE(), has no test to recover and gives ''.
313
+ def test_context_of(filepath, context)
314
+ return @test_build_layout.locate( filepath, context: context ) || ''
317
315
  end
318
316
 
319
- # A flat test's own runner lives in the shared flat runners directory; only a nested
320
- # test's own mirrored subdirectory (excluding its own basename) narrows the search
321
- # further -- mirroring FilePathUtils#form_test_runners_path's own directory-forming rule.
322
- # Takes the test identity already recovered by the caller rather than a raw filepath, so
323
- # it isn't independently re-deriving what the caller already has in hand.
317
+ # A test's runner lives where FilePathUtils#form_test_runners_path puts it. Takes the test
318
+ # identity the caller already recovered rather than a raw filepath.
324
319
  def runner_scope_dir(test_context)
325
- subdir = File.dirname( test_context )
326
- root = @configurator.project_test_runners_path
327
- return subdir == '.' ? root : File.join(root, subdir)
320
+ return @file_path_utils.form_test_runners_path( test_context )
321
+ end
322
+
323
+ # Every test file by its name. Names are paths, and a build stops before its first lookup
324
+ # if two tests in it share one. Built once, on first use, since build threads share this
325
+ # finder.
326
+ def test_files_by_name
327
+ @test_names_lock.synchronize do
328
+ @test_files_by_name ||= @configurator.collection_all_tests.to_h { |test| [@file_path_utils.form_test_name( test ), test.to_s] }
329
+ end
330
+ end
331
+
332
+ # A test's generated mocks or Partials, below its own root of that kind. No other test's
333
+ # root lies below it, so every file there is this test's own.
334
+ def own_generated_files(root)
335
+ return @file_wrapper.directory_listing( FilePathUtils.glob( root, '**/*' + EXTENSION_CORE_SOURCE ) )
328
336
  end
329
337
 
330
- # A release or module-under-test object's own path mirrors its source's subdirectory
331
- # below whichever configured root it came from, rooted at the release build output path
332
- # or (given the current test's identity) that test's own build path. Recovering that
333
- # mirrored subdirectory and combining it with the bare basename recreates a query that
334
- # identifies the same one source PathMirror originally mirrored it from.
338
+ # The query for the source of a release or module-under-test object, and whether it is
339
+ # exact. Such an object sits at its source's own path below the release output root, or
340
+ # below the build path of the test it belongs to, so decoding that path names the source.
335
341
  #
336
- # A filepath that isn't under the project's build root at all is a source-tree-relative
337
- # query in its own right -- straight from an #include or a TEST_SOURCE_FILE() directive,
338
- # say. Such a path keeps whatever disambiguating path it carries rather than being
339
- # collapsed to a bare basename, reduced to its own namespace below a configured include
340
- # root when one contains it (see header_root_relative_query below).
342
+ # A filepath outside the build root is a source-tree-relative query in its own right,
343
+ # from an #include or a TEST_SOURCE_FILE() directive, say. It keeps whatever path it
344
+ # carries, reduced to its namespace below a configured include root when one contains it
345
+ # (see header_root_relative_query below).
341
346
  #
342
- # A filepath that IS somewhere under the build root, but either belongs to a build
343
- # context this method doesn't specifically know how to mirror (a plugin's own object
344
- # output, e.g. build/valgrind/out/..., rather than release or test) or lacks enough to
345
- # peel back a known per-test root (test build input queried without a test identity),
346
- # falls back to the bare basename -- exactly what every caller has always seen for those
347
- # cases.
347
+ # A filepath below the build root in a context this method doesn't know (a plugin's own
348
+ # object output, e.g. build/valgrind/out/...), or test build input queried without a test
349
+ # identity, falls back to the bare basename.
348
350
  def mirrored_query(filepath, release:, test:, context:)
349
- dir = File.dirname(filepath)
350
- build_root = @configurator.project_build_root
351
+ return [source_tree_query( filepath ), false] unless ProjectPaths.contains?( @configurator.project_build_root, filepath )
351
352
 
352
- unless dir == build_root || dir.start_with?(build_root + '/')
353
- query = header_root_relative_query( filepath )
354
- return query.nil? ? filepath.ext('') : query
355
- end
353
+ root = placement_root( release, test, context )
354
+ subdir = root.nil? ? nil : ProjectPaths.subdir_below( root, File.dirname( filepath ) )
355
+ basename = File.basename( filepath ).ext('')
356
+ return [basename, false] if subdir.nil? || subdir.empty?
357
+
358
+ # A marker no shortened root holds was placed by another configuration
359
+ source_dir = BuildSubpath.decode( subdir, roots: @file_path_utils.build_roots, release: release )
360
+ return [basename, false] if source_dir.nil?
356
361
 
357
- basename = File.basename(filepath).ext('')
362
+ return [File.join( source_dir, basename ), true]
363
+ end
364
+
365
+ def source_tree_query(filepath)
366
+ query = header_root_relative_query( filepath )
367
+ return query.nil? ? filepath.ext('') : query
368
+ end
358
369
 
359
- root =
360
- if release
361
- @configurator.project_release_build_output_path
362
- elsif test
363
- @file_path_utils.form_test_build_path(test, context: context)
364
- end
370
+ # The root a release or test object is placed below, or nil where none is known
371
+ def placement_root(release, test, context)
372
+ return @configurator.project_release_build_output_path if release
365
373
 
366
- return basename if root.nil?
374
+ return @test_build_layout.root( :out, test, context: context )
375
+ end
376
+
377
+ # The file of `collection` at exactly `query` plus one of `extension`'s spellings, or nil.
378
+ # Compared by absolute path, through an index built once per collection, since build
379
+ # threads share this finder.
380
+ def exact_file(query, extension, collection)
381
+ index = @test_names_lock.synchronize do
382
+ (@exact_indexes ||= {}.compare_by_identity)[collection] ||= collection.to_h { |file| [ProjectPaths.absolute( file ), file.to_s] }
383
+ end
384
+
385
+ extension.to_a.each do |ext|
386
+ found = index[ProjectPaths.absolute( query + ext )]
387
+ return found unless found.nil?
388
+ end
367
389
 
368
- subdir = PathMirror.relative_subdir(filepath, [root])
369
- return subdir.empty? ? basename : File.join(subdir, basename)
390
+ return nil
370
391
  end
371
392
 
372
393
  # The subdirectory a generated file's query carries, mirroring the module it belongs to.
@@ -381,7 +402,7 @@ class FileFinder
381
402
  # fallback preprocessing builds a generated #include from a module name instead of
382
403
  # resolving the file. Whatever directory such a name carries is the module's own.
383
404
  def generated_file_subdir(filepath, root, test:, context:)
384
- out_root = test.nil? ? nil : @file_path_utils.form_test_build_path(test, context: context)
405
+ out_root = @test_build_layout.root( :out, test, context: context )
385
406
 
386
407
  subdir = PathMirror.relative_subdir( filepath, [root, out_root].compact )
387
408
 
@@ -399,9 +420,9 @@ class FileFinder
399
420
 
400
421
  return '' if dir == '.'
401
422
 
402
- # Matched at a path boundary. A directory merely beginning with the build root's own
403
- # name is an ordinary relative directory and still names its module.
404
- return '' if dir == root || dir.start_with?( root + '/' )
423
+ # Compared as directories. A directory merely beginning with the build root's own name
424
+ # is an ordinary relative directory and still names its module.
425
+ return '' if ProjectPaths.contains?( root, dir )
405
426
 
406
427
  return dir
407
428
  end
@@ -415,7 +436,7 @@ class FileFinder
415
436
  # Only the root is dropped. The namespace is preserved, since that is what keeps two
416
437
  # same-basename modules apart.
417
438
  def header_root_relative_query(filepath)
418
- subdir = PathMirror.relative_subdir_if_rooted( filepath, @configurator.paths_include )
439
+ subdir = PathMirror.relative_subdir_if_rooted_in_clean_roots( filepath, @configurator.collection_mirror_roots_include )
419
440
 
420
441
  return nil if subdir.nil?
421
442
 
@@ -488,7 +509,7 @@ class FileFinder
488
509
  if strict
489
510
  return PathMatcher.match(candidate, collection)
490
511
  else
491
- winner, _others = PathMatcher.resolve(candidate, collection)
512
+ winner, _others = @file_finder_helper.resolve_in_collection(candidate, collection)
492
513
  return winner
493
514
  end
494
515
  end