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,10 +8,18 @@
8
8
  require 'rubygems'
9
9
  require 'rake' # for ext()
10
10
  require 'fileutils'
11
+ require 'pathname'
12
+ require 'yaml'
11
13
  require 'ceedling/exceptions'
12
14
  require 'ceedling/system_wrapper'
13
15
  require 'ceedling/constants'
14
- require 'ceedling/path_mirror'
16
+ require 'ceedling/filesystem/path_mirror'
17
+ require 'ceedling/filesystem/path_matcher'
18
+ require 'ceedling/filesystem/project_paths'
19
+ require 'ceedling/filesystem/build_subpath'
20
+ require 'ceedling/filesystem/build_roots'
21
+ require 'ceedling/filesystem/destination_collision'
22
+ require 'ceedling/filesystem/test_build_layout'
15
23
 
16
24
  # global utility methods (for plugins, project files, etc.)
17
25
  def ceedling_form_filepath(destination_path, original_filepath, new_extension=nil)
@@ -22,8 +30,7 @@ end
22
30
 
23
31
  class FilePathUtils
24
32
 
25
- constructor :configurator, :file_wrapper
26
-
33
+ constructor :configurator, :file_wrapper, :test_build_layout
27
34
 
28
35
  ######### Class methods ##########
29
36
 
@@ -32,9 +39,7 @@ class FilePathUtils
32
39
  def self.standardize_in_place(path)
33
40
  if path.is_a? String
34
41
  raise CeedlingException.new("Attempted to standardize path in frozen string ⏩️ #{path.inspect}") if path.frozen?
35
- path.strip!
36
- path.tr!("\\", '/')
37
- path.chomp!('/')
42
+ path.replace( ProjectPaths.standardize( path ) )
38
43
  end
39
44
  return path
40
45
  end
@@ -149,31 +154,24 @@ class FilePathUtils
149
154
  # ['a/b', 'a/c', 'a'] => ['a']
150
155
  # ['src', 'lib/core', 'lib/utils'] => ['src', 'lib/core', 'lib/utils'] (unchanged)
151
156
  #
152
- # Comparison uses forward-slash-normalized copies; returned paths preserve the original
153
- # form supplied by the caller.
157
+ # Paths compare as the directories they name (ProjectPaths.contains?), so `..` holds
158
+ # `../sib` but not `../../far/x`. Returned paths preserve the form the caller supplied.
154
159
  def self.collapse_to_common_parents(paths)
155
160
  return paths if paths.nil? || paths.length <= 1
156
161
 
157
- # Pair each original path with a normalized form used only for ancestry comparison.
158
- # Normalize to forward slashes and strip any trailing separator.
159
- pairs = paths.map { |p| [p, p.tr('\\', '/').chomp('/')] }
160
-
161
- # Sort shallowest-first so ancestors are always encountered before their descendants.
162
- # No tiebreaker for same-depth entries needed: Ruby's sort_by doesn't guarantee a
163
- # stable order among ties, but two same-depth paths can never be each other's
164
- # ancestor, so the ancestor-exclusion check below is correct regardless of which
165
- # order same-depth ties come out in.
166
- pairs.sort_by! { |_, normalized| normalized.count('/') }
167
-
168
- kept = []
169
- pairs.each do |original, normalized|
170
- # Skip this path if any already-kept path is a proper ancestor of it.
171
- next if kept.any? { |_, k| normalized.start_with?(k + '/') }
172
- kept << [original, normalized]
173
- end
162
+ # Shortest absolute spelling first, so an ancestor is always met before what it holds
163
+ pairs = paths.map { |path| [path, ProjectPaths.absolute( path )] }.sort_by { |_, absolute| absolute.length }
164
+
165
+ return outermost( pairs ).map { |original, _| original }
166
+ end
174
167
 
175
- kept.map { |original, _| original }
168
+ # The [original, absolute] pairs no earlier pair's directory holds
169
+ def self.outermost(pairs)
170
+ return pairs.each_with_object( [] ) do |pair, kept|
171
+ kept << pair unless kept.any? { |_, held| ProjectPaths.contains?( held, pair.last ) }
172
+ end
176
173
  end
174
+ private_class_method :outermost
177
175
 
178
176
 
179
177
  ######### Instance methods ##########
@@ -191,13 +189,10 @@ class FilePathUtils
191
189
  return subdir.empty? ? File.join(root, basename) : File.join(root, subdir, basename)
192
190
  end
193
191
 
192
+ # A release build has no per-test directories, so it places each file by its release spelling
193
+ # (see BuildSubpath)
194
194
  def form_release_build_objects_filelist(files)
195
- return mirror_build_objects(
196
- files,
197
- root: @configurator.project_release_build_output_path,
198
- ext: @configurator.extension_object.primary,
199
- roots: @configurator.paths_source
200
- )
195
+ return mirror_build_objects( files, root: @configurator.project_release_build_output_path, ext: @configurator.extension_object.primary, release: true )
201
196
  end
202
197
 
203
198
  # `filepath` is an already-mirrored object path -- its own directory is exactly where its
@@ -207,32 +202,70 @@ class FilePathUtils
207
202
  end
208
203
 
209
204
  def form_release_dependencies_filelist(files)
210
- return mirror_build_objects(
211
- files,
212
- root: @configurator.project_release_dependencies_path,
213
- ext: @configurator.extension_dependencies.primary,
214
- roots: @configurator.paths_source
215
- )
205
+ return mirror_build_objects( files, root: @configurator.project_release_dependencies_path, ext: @configurator.extension_dependencies.primary, release: true )
216
206
  end
217
207
 
218
208
  ### Tests ###
219
209
 
210
+ # A test is named by its path from the project root, without its extension. The name places
211
+ # the test's build, results, runner, mock, preprocessing and log directories, and a path is
212
+ # unique, so no two tests share them. A test outside the project keeps its whole path too,
213
+ # with each `..` written as `_up_`, and a path with no relative form (another Windows drive)
214
+ # placed under `_abs_`, so no name reaches outside the build directory.
215
+ def form_test_name(filepath)
216
+ return BuildSubpath.encode( filepath.to_s.ext( '' ) )
217
+ end
218
+
219
+ # The configured roots that build paths spell by a short marker (see BuildRoots), built
220
+ # once per configured list. Build threads may build it together harmlessly, since every
221
+ # table of one list is the same.
222
+ def build_roots
223
+ roots = @configurator.collection_build_roots
224
+ cached = @build_roots
225
+ return cached.last if cached&.first.equal?( roots )
226
+
227
+ table = BuildRoots.table( roots )
228
+ @build_roots = [roots, table].freeze
229
+ return table
230
+ end
231
+
232
+ # Writes each shortened root and its marker to the build root, for tracing a marker to its
233
+ # root, or removes the map when no root is shortened, and returns them
234
+ def publish_build_roots
235
+ entries = build_roots.entries
236
+ path = File.join( @configurator.project_build_root, BUILD_ROOTS_MAP_FILE )
237
+ return entries.tap { @file_wrapper.rm_f( path ) } if entries.empty?
238
+
239
+ @file_wrapper.mkdir( @configurator.project_build_root )
240
+ @file_wrapper.write( path, YAML.dump( entries.to_h { |root, marker| [marker, root] } ) )
241
+ return entries
242
+ end
243
+
244
+ # A build path as it would be spelled without shortened roots: each marker segment becomes
245
+ # its root's encoded spelling. For matching patterns written against build paths.
246
+ def expanded_build_path(path)
247
+ table = build_roots
248
+ return path if table.empty?
249
+
250
+ return path.split( '/', -1 ).map { |segment| (root = table.root_for( segment )).nil? ? segment : BuildSubpath.encode( root ) }.join( '/' )
251
+ end
252
+
253
+ # A test's own output directory (TestBuildLayout), or the context's output root itself for
254
+ # no test, where a context's own sources outside any test build
220
255
  def form_test_build_path(name, context: nil)
221
- form_build_context_path(BUILD_OUT_DIR, name: name, context: context)
256
+ return @test_build_layout.root( :out, name, context: context ) || @test_build_layout.base( :out, context: context )
222
257
  end
223
258
 
259
+ # Where a build places the object of `filepath`: below its test's build path, or below the
260
+ # context's own output root for a source compiled outside any test
224
261
  def form_test_object_filepath(filepath, name: nil, context: nil)
225
- File.join(
226
- form_build_context_path(BUILD_OUT_DIR, name: name, context: context),
227
- File.basename(filepath).ext(@configurator.extension_object.primary)
228
- )
262
+ root = form_test_build_path( name, context: context )
263
+ return build_filepath( filepath, root: root, ext: @configurator.extension_object.primary, generated_roots: generated_roots( name ) )
229
264
  end
230
265
 
231
- # As `form_test_runners_path`: a flat test's own identity forms the shared flat results
232
- # directory, untouched -- only a genuinely nested test's own mirrored subdirectory
233
- # becomes an extra directory level here, so two same-named tests land in distinct
234
- # results directories without perturbing the overwhelmingly common flat, non-duplicate
235
- # case.
266
+ # As `form_test_runners_path`: a test's results sit beneath the directories of its name,
267
+ # so same-named tests in different directories keep apart. Only a test at the project
268
+ # root uses the results directory itself.
236
269
  def form_test_results_path(name = nil, context: nil)
237
270
  subdir = name.nil? ? '' : mirrored_test_subdir(name)
238
271
  return form_build_context_path(BUILD_RESULTS_DIR, context: context) if subdir.empty?
@@ -249,70 +282,66 @@ class FilePathUtils
249
282
  File.join( *parts )
250
283
  end
251
284
 
285
+ # As `form_test_build_path`, for dependencies files
252
286
  def form_test_dependencies_path(name, context: nil)
253
- form_build_context_path(BUILD_DEPENDENCIES_DIR, name: name, context: context)
287
+ return @test_build_layout.root( :dependencies, name, context: context ) || @test_build_layout.base( :dependencies, context: context )
254
288
  end
255
289
 
256
- # `filepath` is an already-mirrored object path -- recovering the mirrored subdirectory
257
- # beyond the test's own build root and re-rooting it under this test's dependencies path
258
- # keeps this dependencies file alongside the same-named object it accompanies, rather
259
- # than colliding with another object's dependencies file at a shared flat basename.
260
- # Without a test identity to recover that build root from, there's no mirroring to do --
261
- # the dependencies file stays exactly where its context-level directory alone places it.
290
+ # `filepath` is an object path. Its dependencies file sits at the object's own place below
291
+ # the dependencies root, so it never collides with another same-named object's. Without a
292
+ # test, that place is below the context's own output root.
262
293
  def form_test_dependencies_filepath(filepath, name: nil, context: nil)
263
- root = form_build_context_path(BUILD_DEPENDENCIES_DIR, name: name, context: context)
294
+ root = form_test_dependencies_path( name, context: context )
264
295
  basename = File.basename(filepath).ext(@configurator.extension_dependencies.primary)
265
296
 
266
- return File.join(root, basename) if name.nil?
267
-
268
- subdir = PathMirror.relative_subdir( filepath, [form_test_build_path(name, context: context)] )
297
+ subdir = ProjectPaths.subdir_below( form_test_build_path( name, context: context ), File.dirname( filepath ) ) || ''
269
298
  return subdir.empty? ? File.join(root, basename) : File.join(root, subdir, basename)
270
299
  end
271
300
 
272
- def form_test_mocks_path(name, context: nil)
273
- form_named_path(@configurator.cmock_mock_path, name)
301
+ def form_test_mocks_path(name)
302
+ return @test_build_layout.root( :mocks, name )
274
303
  end
275
304
 
276
- def form_test_partials_path(name, context: nil)
277
- form_named_path(@configurator.project_test_partials_path, name)
305
+ def form_test_partials_path(name)
306
+ return @test_build_layout.root( :partials, name )
278
307
  end
279
308
 
280
- def form_test_preprocess_includes_path(name, context: nil)
281
- form_named_path(@configurator.project_test_preprocess_includes_path, name)
309
+ def form_test_preprocess_includes_path(name)
310
+ return @test_build_layout.root( :preprocess_includes, name )
282
311
  end
283
312
 
284
- def form_test_preprocess_files_path(name, context: nil)
285
- form_named_path(@configurator.project_test_preprocess_files_path, name)
313
+ def form_test_preprocess_files_path(name)
314
+ return @test_build_layout.root( :preprocess_files, name )
286
315
  end
287
316
 
288
- def form_test_preprocess_files_full_expansion_path(name, context: nil)
289
- form_named_path(@configurator.project_test_preprocess_files_path, name, subdir: PREPROCESS_FULL_EXPANSION_DIR)
317
+ def form_test_preprocess_files_full_expansion_path(name)
318
+ return @test_build_layout.file( :preprocess_files, name, PREPROCESS_FULL_EXPANSION_DIR )
290
319
  end
291
320
 
292
- def form_test_preprocess_files_directives_only_path(name, context: nil)
293
- form_named_path(@configurator.project_test_preprocess_files_path, name, subdir: PREPROCESS_DIRECTIVES_ONLY_DIR)
321
+ def form_test_preprocess_files_directives_only_path(name)
322
+ return @test_build_layout.file( :preprocess_files, name, PREPROCESS_DIRECTIVES_ONLY_DIR )
294
323
  end
295
324
 
296
- def form_test_preprocess_files_raw_directives_only_path(name, context: nil)
297
- form_named_path(@configurator.project_test_preprocess_files_path, name, subdir: PREPROCESS_RAW_DIRECTIVES_ONLY_DIR)
325
+ def form_test_preprocess_files_raw_directives_only_path(name)
326
+ return @test_build_layout.file( :preprocess_files, name, PREPROCESS_RAW_DIRECTIVES_ONLY_DIR )
298
327
  end
299
328
 
300
- def form_test_preprocess_build_directives_path(name, context: nil)
301
- form_named_path(@configurator.project_test_preprocess_build_directives_path, name)
329
+ def form_test_preprocess_build_directives_path(name)
330
+ return @test_build_layout.root( :build_directives, name )
302
331
  end
303
332
 
304
333
  # Where a test file's own #include/build-directive scan results are cached, keyed by
305
334
  # the test file's own name so each test's cache lives alongside its other
306
335
  # preprocessing artifacts.
307
- def form_test_build_directives_cache_filepath(filepath, subdir)
308
- return File.join( @configurator.project_test_preprocess_build_directives_path, subdir, File.basename(filepath) + EXTENSION_CORE_YAML )
336
+ def form_test_build_directives_cache_filepath(filepath, name)
337
+ return @test_build_layout.file( :build_directives, name, File.basename(filepath) + EXTENSION_CORE_YAML )
309
338
  end
310
339
 
311
340
  # Where a test file's TEST_SOURCE_FILE() results are cached once its preprocessed
312
341
  # output has been generated -- kept distinct from the raw-file cache above since the
313
342
  # two are populated at different points in the pipeline from different content.
314
- def form_preprocessed_source_files_cache_filepath(filepath, subdir)
315
- return File.join( @configurator.project_test_preprocess_build_directives_path, subdir, File.basename(filepath) + '_source_files' + EXTENSION_CORE_YAML )
343
+ def form_preprocessed_source_files_cache_filepath(filepath, name)
344
+ return @test_build_layout.file( :build_directives, name, File.basename(filepath) + '_source_files' + EXTENSION_CORE_YAML )
316
345
  end
317
346
 
318
347
  def form_pass_results_filepath(build_output_path, filepath)
@@ -323,12 +352,10 @@ class FilePathUtils
323
352
  return File.join( build_output_path, File.basename(filepath).ext(@configurator.extension_testfail.primary) )
324
353
  end
325
354
 
326
- # A flat test's own identity (no mirrored subdirectory of its own) forms the shared flat
327
- # runners directory, untouched -- only a genuinely nested test's own mirrored
328
- # subdirectory (excluding its own basename) becomes an extra directory level here, so two
329
- # same-named tests in different directories land in distinct runner directories without
330
- # perturbing the overwhelmingly common flat, non-duplicate case.
331
- def form_test_runners_path(name, context: nil)
355
+ # A test's runner sits beneath the directories of its name, so same-named tests in
356
+ # different directories keep apart. Only a test at the project root uses the runners
357
+ # directory itself.
358
+ def form_test_runners_path(name)
332
359
  subdir = mirrored_test_subdir(name)
333
360
  return @configurator.project_test_runners_path if subdir.empty?
334
361
  return File.join(@configurator.project_test_runners_path, subdir)
@@ -373,13 +400,7 @@ class FilePathUtils
373
400
  # the same filepath, so all of them agree on where the artifact lands without
374
401
  # coordinating.
375
402
  def preprocessed_file_subpath(filepath, test = nil)
376
- roots = @configurator.paths_source +
377
- @configurator.paths_support +
378
- @configurator.paths_include +
379
- @configurator.paths_test +
380
- generated_roots( test )
381
-
382
- subdir = PathMirror.relative_subdir( filepath, roots )
403
+ subdir = form_build_subpath( filepath, generated_roots: generated_roots( test ) )
383
404
  basename = File.basename( filepath )
384
405
 
385
406
  return basename if subdir.empty?
@@ -387,62 +408,53 @@ class FilePathUtils
387
408
  return File.join( subdir, basename )
388
409
  end
389
410
 
390
- # The roots holding one test's own generated files. A mock or a generated Partial sits
391
- # below one of these rather than a configured source root, and two same-named modules
392
- # each produce one, so without these roots both share a single preprocessed artifact.
393
- #
394
- # Each root carries the test's own name, so what mirrors forward is the module's own
395
- # subdirectory rather than the test name a second time.
411
+ # The roots holding one test's own generated files (TestBuildLayout#generated_roots). A
412
+ # mock or a generated Partial sits below one of these rather than a configured source
413
+ # root, and two same-named modules each produce one, so without these roots both share a
414
+ # single preprocessed artifact. What mirrors forward is the module's own subdirectory.
396
415
  def generated_roots(test)
397
- return [] if test.nil?
398
-
399
- roots = []
400
- roots << File.join( @configurator.project_test_partials_path, test ) if @configurator.project_use_partials
401
- roots << File.join( @configurator.cmock_mock_path, test ) if @configurator.project_use_mocks
416
+ return @test_build_layout.generated_roots( test )
417
+ end
402
418
 
403
- return roots
419
+ # Composes a preprocessed artifact's path below the test's root of `kind`, or below the base
420
+ # every test shares for no test, as `form_test_build_path` does. Pure, like
421
+ # every other path builder here: callers that merely restate a path -- a rake target
422
+ # declaration, a staleness check -- must not leave directories behind as a side effect.
423
+ # Whoever writes the file creates its directory, the same way a mock's or a Partial's own
424
+ # writer does.
425
+ def form_preprocessed_filepath(kind, test, kind_dir, filepath, suffix: '')
426
+ root = @test_build_layout.root( kind, test ) || @test_build_layout.base( kind )
427
+ return File.join( *[root, kind_dir, preprocessed_file_subpath( filepath, test ) + suffix].compact )
404
428
  end
405
429
 
406
- # Composes a preprocessed artifact's path. Pure, like every other path builder here:
407
- # callers that merely restate a path -- a rake target declaration, a staleness check --
408
- # must not leave directories behind as a side effect. Whoever writes the file creates
409
- # its directory, the same way a mock's or a Partial's own writer does.
410
- def form_preprocessed_filepath(root, subdir, kind_dir, filepath, suffix: '')
411
- return File.join( *[root, subdir, kind_dir, preprocessed_file_subpath( filepath, subdir ) + suffix].compact )
430
+ def form_preprocessed_includes_list_filepath(filepath, test)
431
+ return form_preprocessed_filepath( :preprocess_includes, test, nil, filepath, suffix: EXTENSION_CORE_YAML )
412
432
  end
413
433
 
414
- def form_preprocessed_includes_list_filepath(filepath, subdir)
415
- return form_preprocessed_filepath(
416
- @configurator.project_test_preprocess_includes_path, subdir, nil, filepath, suffix: EXTENSION_CORE_YAML
417
- )
434
+ def form_preprocessed_file_filepath(filepath, test)
435
+ return form_preprocessed_filepath( :preprocess_files, test, nil, filepath )
418
436
  end
419
437
 
420
- def form_preprocessed_file_filepath(filepath, subdir)
421
- return form_preprocessed_filepath( @configurator.project_test_preprocess_files_path, subdir, nil, filepath )
438
+ def form_preprocessed_file_full_expansion_filepath(filepath, test)
439
+ return form_preprocessed_filepath( :preprocess_files, test, PREPROCESS_FULL_EXPANSION_DIR, filepath )
422
440
  end
423
441
 
424
- def form_preprocessed_file_full_expansion_filepath(filepath, subdir)
425
- return form_preprocessed_filepath(
426
- @configurator.project_test_preprocess_files_path, subdir, PREPROCESS_FULL_EXPANSION_DIR, filepath
427
- )
442
+ # A file's own lines from its full expansion, as plain code without line markers. The
443
+ # expansion itself stays whole beside it, since its markers name every file it entered.
444
+ def form_preprocessed_file_expanded_code_filepath(filepath, test)
445
+ return form_preprocessed_filepath( :preprocess_files, test, PREPROCESS_EXPANDED_CODE_DIR, filepath )
428
446
  end
429
447
 
430
- def form_preprocessed_file_raw_directives_only_filepath(filepath, subdir)
431
- return form_preprocessed_filepath(
432
- @configurator.project_test_preprocess_files_path, subdir, PREPROCESS_RAW_DIRECTIVES_ONLY_DIR, filepath
433
- )
448
+ def form_preprocessed_file_raw_directives_only_filepath(filepath, test)
449
+ return form_preprocessed_filepath( :preprocess_files, test, PREPROCESS_RAW_DIRECTIVES_ONLY_DIR, filepath )
434
450
  end
435
451
 
436
- def form_preprocessed_file_fallback_expansion_filepath(filepath, subdir)
437
- return form_preprocessed_filepath(
438
- @configurator.project_test_preprocess_files_path, subdir, PREPROCESS_FALLBACK_EXPANSION_DIR, filepath
439
- )
452
+ def form_preprocessed_file_fallback_expansion_filepath(filepath, test)
453
+ return form_preprocessed_filepath( :preprocess_files, test, PREPROCESS_FALLBACK_EXPANSION_DIR, filepath )
440
454
  end
441
455
 
442
- def form_preprocessed_file_compacted_directives_only_filepath(filepath, subdir)
443
- return form_preprocessed_filepath(
444
- @configurator.project_test_preprocess_files_path, subdir, PREPROCESS_DIRECTIVES_ONLY_DIR, filepath
445
- )
456
+ def form_preprocessed_file_compacted_directives_only_filepath(filepath, test)
457
+ return form_preprocessed_filepath( :preprocess_files, test, PREPROCESS_DIRECTIVES_ONLY_DIR, filepath )
446
458
  end
447
459
 
448
460
  # `extra_roots` carries roots known only to the caller. A generated Partial source sits
@@ -450,12 +462,7 @@ class FilePathUtils
450
462
  # standard roots mirrors it. Without its root here, two modules sharing a basename
451
463
  # collapse onto one object filename.
452
464
  def form_test_build_objects_filelist(path, sources, extra_roots: [])
453
- return mirror_build_objects(
454
- sources,
455
- root: path,
456
- ext: @configurator.extension_object.primary,
457
- roots: @configurator.paths_source + @configurator.paths_support + extra_roots
458
- )
465
+ return mirror_build_objects( sources, root: path, ext: @configurator.extension_object.primary, generated_roots: extra_roots )
459
466
  end
460
467
 
461
468
  # Where one mock's generated files sit: its test's mock root, plus the subdirectory
@@ -467,16 +474,16 @@ class FilePathUtils
467
474
  return File.join( root, subdir )
468
475
  end
469
476
 
470
- def form_mock_header_filepath(subdir, filename)
471
- # @configurator.cmock_mock_path accessor only exists if mocks are enabled
477
+ # A header at `filename` below a test's mock root
478
+ def form_mock_header_filepath(name, filename)
472
479
  raise CeedlingException.new('Mocks are not enabled, but an internal feature dependent on them was accessed.') unless @configurator.project_use_mocks
473
- return File.join(@configurator.cmock_mock_path, subdir, filename.ext(EXTENSION_CORE_HEADER))
480
+ return @test_build_layout.file( :mocks, name, filename.ext(EXTENSION_CORE_HEADER) )
474
481
  end
475
482
 
476
- def form_partial_header_filepath(subdir, filename)
477
- # @configurator.project_test_partials_path accessor only exists if partials are enabled
483
+ # A header at `filename` below a test's Partials root
484
+ def form_partial_header_filepath(name, filename)
478
485
  raise CeedlingException.new('Partials are not enabled, but an internal feature dependent on them was accessed.') unless @configurator.project_use_partials
479
- return File.join( @configurator.project_test_partials_path, subdir, filename.ext(EXTENSION_CORE_HEADER) )
486
+ return @test_build_layout.file( :partials, name, filename.ext(EXTENSION_CORE_HEADER) )
480
487
  end
481
488
 
482
489
  # Every generated Partial filename below is also the text a Partial directive macro
@@ -534,6 +541,12 @@ class FilePathUtils
534
541
  return form_partial_filename( _module, PARTIAL_SUFFIX_TYPES, EXTENSION_CORE_HEADER )
535
542
  end
536
543
 
544
+ # What a mock-only Partial keeps of its real header beyond the mocked functions, which its
545
+ # interface header includes and CMock never reads
546
+ def form_partial_extras_header_filename(_module)
547
+ return form_partial_filename( _module, PARTIAL_SUFFIX_EXTRAS, EXTENSION_CORE_HEADER )
548
+ end
549
+
537
550
  def form_mock_partial_interface_header_filename(_module)
538
551
  return form_partial_filename( _module, PARTIAL_SUFFIX_INTERFACE, EXTENSION_CORE_HEADER, prefix: @configurator.cmock_mock_prefix )
539
552
  end
@@ -546,13 +559,13 @@ class FilePathUtils
546
559
  return form_partial_filename( _module, PARTIAL_SUFFIX_IMPL, EXTENSION_CORE_SOURCE )
547
560
  end
548
561
 
562
+ # Each test's results file sits where `form_test_results_path` puts it, beneath its name
549
563
  def form_pass_results_filelist(path, files)
550
- return mirror_build_objects(
551
- files,
552
- root: path,
553
- ext: @configurator.extension_testpass.primary,
554
- roots: @configurator.paths_test
555
- )
564
+ results = @file_wrapper.instantiate_file_list_literal( files ).map do |file|
565
+ subdir = mirrored_test_subdir( form_test_name( file ) )
566
+ form_pass_results_filepath( subdir.empty? ? path : File.join( path, subdir ), file )
567
+ end
568
+ return @file_wrapper.instantiate_file_list_literal( results )
556
569
  end
557
570
 
558
571
  ### Private ###
@@ -570,16 +583,8 @@ class FilePathUtils
570
583
  return path
571
584
  end
572
585
 
573
- # Forms base/name[/subdir]
574
- def form_named_path(base, name, subdir: nil)
575
- path = subdir ? File.join( base, name, subdir ) : File.join( base, name )
576
- @file_wrapper.check_path_length( path, origin: 'FilePathUtils#form_named_path' )
577
- return path
578
- end
579
-
580
- # The mirrored-subdirectory portion of a test's own identity, excluding its own basename
581
- # -- '' for a flat test (e.g. 'TestFoo', no subdirectory at all), or the leading segments
582
- # for a nested one (e.g. 'unit' for 'unit/test_foo').
586
+ # The directories of a test's name, excluding its basename: 'test/unit' for
587
+ # 'test/unit/test_foo', or '' for a test at the project root.
583
588
  def mirrored_test_subdir(name)
584
589
  dir = File.dirname(name)
585
590
  return '' if dir == '.'
@@ -602,15 +607,43 @@ class FilePathUtils
602
607
  # it contains a literal `[`/`]`. FileWrapper#instantiate_file_list_literal (`<<`, not
603
608
  # `.new`/`.include`) adds every entry as-is, with no glob interpretation at all -- the
604
609
  # correct construction for a list that's already the real, final answer.
605
- def mirror_build_objects(files, root:, ext:, roots:)
606
- clean_roots = PathMirror.clean_roots( roots )
610
+ def mirror_build_objects(files, root:, ext:, generated_roots: [], release: false)
611
+ sources = @file_wrapper.instantiate_file_list_literal( files ).to_a.uniq { |file| ProjectPaths.absolute( file ) }
612
+ objects = sources.map { |file| build_filepath( file, root: root, ext: ext, generated_roots: generated_roots, release: release ) }
607
613
 
608
- objects = @file_wrapper.instantiate_file_list_literal(files).map do |file|
609
- subdir = PathMirror.relative_subdir_from_clean_roots( file, clean_roots )
610
- basename = File.basename(file).ext(ext)
611
- subdir.empty? ? File.join(root, basename) : File.join(root, subdir, basename)
612
- end
614
+ validate_distinct_build_files!( sources, objects )
613
615
  return @file_wrapper.instantiate_file_list_literal( objects )
614
616
  end
615
617
 
618
+ def build_filepath(file, root:, ext:, generated_roots:, release: false)
619
+ subdir = form_build_subpath( file, generated_roots: generated_roots, release: release )
620
+ basename = File.basename( file ).ext( ext )
621
+ path = subdir.empty? ? File.join( root, basename ) : File.join( root, subdir, basename )
622
+
623
+ # A source far from the project gains a directory for each level its path climbs.
624
+ # FileWrapper reports each path once, however often it is formed.
625
+ @file_wrapper.check_path_length( path, origin: 'FilePathUtils#build_filepath' )
626
+ return path
627
+ end
628
+
629
+ # Where below a build output root the build file of `file` lands. A file below one of the
630
+ # caller's generated roots (a test's mocks or Partials) mirrors below that root; one
631
+ # below the build root otherwise (vendored frameworks, runners) lands flat; and any other
632
+ # lands by its own path from the project root, so two sources never share one.
633
+ def form_build_subpath(file, generated_roots: [], release: false)
634
+ generated = PathMirror.relative_subdir_if_rooted_in_clean_roots( file, generated_roots )
635
+ return generated unless generated.nil?
636
+ return '' if ProjectPaths.contains?( @configurator.project_build_root, file )
637
+
638
+ return BuildSubpath.of_directory( File.dirname( file ), roots: build_roots, release: release )
639
+ end
640
+
641
+ # Two sources building to one file would leave one of them out of the build
642
+ def validate_distinct_build_files!(sources, built)
643
+ built_from = sources.zip( built ).to_h
644
+ DestinationCollision.find( sources ) { |source| built_from[source] }.each do |file, sharing|
645
+ DestinationCollision.raise_for( file, sharing, 'would build to the same file' )
646
+ end
647
+ end
648
+
616
649
  end
@@ -5,12 +5,13 @@
5
5
  # SPDX-License-Identifier: MIT
6
6
  # =========================================================================
7
7
 
8
+ require 'ceedling/filesystem/working_dir'
9
+
8
10
  class FileSystemWrapper
9
11
 
10
- def cd(path)
11
- FileUtils.cd path do
12
- yield
13
- end
12
+ # Through WorkingDir, so paths resolved inside the block resolve against `path`
13
+ def cd(path, &block)
14
+ return WorkingDir.chdir( path, &block )
14
15
  end
15
16
 
16
- end
17
+ end