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
@@ -6,6 +6,7 @@
6
6
  # =========================================================================
7
7
 
8
8
  require 'ceedling/constants'
9
+ require 'ceedling/filesystem/project_paths'
9
10
  require 'ceedling/test_invoker/test_invoker_types'
10
11
  require 'ceedling/test_invoker/test_pipeline_helpers'
11
12
  require 'ceedling/test_invoker/test_build_validations'
@@ -48,6 +49,10 @@ class TestBuildPlanner
48
49
  mocks = {}
49
50
  _mocks = @context_extractor.lookup_mock_header_includes_list( filepath )
50
51
 
52
+ # Shared by every mock and the #include validation, since nothing here changes this
53
+ # test's search paths
54
+ collection = test_header_search( testable )
55
+
51
56
  _mocks.each do |include|
52
57
  name = File.basename( include.filename ).ext()
53
58
  source = nil
@@ -60,7 +65,7 @@ class TestBuildPlanner
60
65
  input = source
61
66
  subdir = partial_mock_subdir( include )
62
67
  else
63
- source, subdir = @mock_locator.locate( include, collection: ordered_mock_header_collection( testable ) )
68
+ source, subdir = @mock_locator.locate( include, collection: collection )
64
69
  preprocessed_input = @file_path_utils.form_preprocessed_file_filepath( source, test )
65
70
  input = (@configurator.project_use_test_preprocessor_mocks ? preprocessed_input : source)
66
71
  end
@@ -72,22 +77,23 @@ class TestBuildPlanner
72
77
  # the mock stays findable by the compiler regardless
73
78
  # of how much path the #include itself happened to spell out.
74
79
  #
75
- # Keyed by that directory alongside the name. Two modules sharing a basename are
76
- # two modules, each needing its own mock, and a key of the name alone lets the
77
- # second displace the first. `name` stays bare: it is the filename the mock is
78
- # written under, joined with `path` at generation.
79
- mocks[mock_key( name, subdir )] = MockDetails.new(
80
+ # Keyed by the directory the mock is written to alongside the name. Two modules
81
+ # sharing a basename are two modules, each needing its own mock, and a key of the
82
+ # name alone lets the second displace the first. `name` stays bare: it is the
83
+ # filename the mock is written under, at generation.
84
+ mocks[mock_key( name, partial ? subdir : placed_subdir( testable, subdir, include ) )] = MockDetails.new(
80
85
  name: name,
81
86
  filepath: source,
82
87
  path: subdir,
83
88
  source: source,
84
89
  input: input,
85
90
  partial: partial,
86
- include_path: include.filepath
91
+ include_path: include.filepath,
92
+ header_include: @mock_locator.header_respelling( include, source, collection )
87
93
  )
88
94
  end
89
95
 
90
- validate_header_includes( test_filepath: filepath, testable: testable )
96
+ validate_header_includes( test_filepath: filepath, testable: testable, search: collection )
91
97
 
92
98
  partials_configs = {}
93
99
  if @configurator.project_use_partials
@@ -114,17 +120,8 @@ class TestBuildPlanner
114
120
  def stage_flatten_partials_lists(state)
115
121
  state.testables.each do |_, testable|
116
122
  testable.partials.configs.each do |_, config|
117
- state.partials_headers << PartialWork.new(
118
- config: config.header,
119
- testable: testable,
120
- directives_only_filepath: nil
121
- ) if config.header.filepath
122
-
123
- state.partials_sources << PartialWork.new(
124
- config: config.source,
125
- testable: testable,
126
- directives_only_filepath: nil
127
- ) if config.source.filepath
123
+ state.partials_headers << PartialWork.new( config: config.header, testable: testable ) if config.header.filepath
124
+ state.partials_sources << PartialWork.new( config: config.source, testable: testable ) if config.source.filepath
128
125
  end
129
126
  end
130
127
  end
@@ -185,7 +182,7 @@ class TestBuildPlanner
185
182
  test_no_link_objects =
186
183
  @file_path_utils.form_test_build_objects_filelist(
187
184
  testable.paths[:build],
188
- fetch_shallow_source_includes( filepath ),
185
+ fetch_shallow_source_includes( filepath, state.context, testable.name ),
189
186
  extra_roots: generated_roots
190
187
  )
191
188
 
@@ -237,10 +234,11 @@ class TestBuildPlanner
237
234
  sources << File.join( PROJECT_BUILD_VENDOR_CEXCEPTION_PATH, CEXCEPTION_C_FILE ) if @configurator.project_use_exceptions
238
235
 
239
236
  if @configurator.project_use_mocks
237
+ # :unity_helper_path names a helper's header, or its path without an extension. The
238
+ # source beside it is what compiles.
240
239
  @configurator.cmock_unity_helper_path.each do |helper|
241
- if @file_wrapper.exist?( helper.ext( EXTENSION_SOURCE.primary ) )
242
- sources << helper
243
- end
240
+ source = helper.ext( EXTENSION_SOURCE.primary )
241
+ sources << source if @file_wrapper.exist?( source )
244
242
  end
245
243
  end
246
244
 
@@ -313,14 +311,28 @@ class TestBuildPlanner
313
311
  )
314
312
  end
315
313
 
316
- def fetch_shallow_source_includes(test_filepath)
317
- return @test_context_extractor.lookup_source_includes_list( test_filepath )
314
+ # The sources a test #includes, which it must not link a second time. Each is the file its
315
+ # #include names, since that file's object sits at its own path, not the #include's.
316
+ def fetch_shallow_source_includes(test_filepath, context, test_name)
317
+ return @test_context_extractor.lookup_source_includes_list( test_filepath ).map do |include|
318
+ @file_finder.find_build_input_file( filepath: include.filepath, complain: :ignore, context: context, test: test_name ) || include.filepath
319
+ end
318
320
  end
319
321
 
320
322
  # Every stage resolving a mock's real header must agree on the same winner, or a
321
323
  # stand-in, a mock search path, and the real mock would land in different directories
322
- def ordered_mock_header_collection(testable)
323
- @mock_locator.header_collection( testable.search_paths, testable.mock_search_paths )
324
+ def test_header_search(testable)
325
+ @mock_locator.header_search( testable )
326
+ end
327
+
328
+ # The mock's directory below its test's mock root, where generation writes it. Two
329
+ # same-named headers may mirror alike and differ only by the folders their #includes name.
330
+ def placed_subdir(testable, subdir, include)
331
+ root = testable.paths[:mocks]
332
+ return subdir if root.nil?
333
+
334
+ placement = @mock_locator.placement( mocks_root: root, subdir: subdir, include_path: include.filepath )
335
+ return ProjectPaths.subdir_below( root, placement.directory ) || subdir
324
336
  end
325
337
 
326
338
  # One mock's identity within its test. A mock directly in the mock root keeps the bare
@@ -331,8 +343,8 @@ class TestBuildPlanner
331
343
  return File.join( subdir, name ).to_sym
332
344
  end
333
345
 
334
- # Each mock's own generated source, below this test's mock root in the subdirectory
335
- # mirroring whatever it mocks -- the same place mock generation writes it.
346
+ # Each mock's own generated source, below this test's mock root where mock generation
347
+ # writes it (MockLocator#placement)
336
348
  #
337
349
  # Named by its own path rather than its basename so two same-named mocks in one test
338
350
  # stay distinct, and so each one's object mirrors that subdirectory too.
@@ -342,10 +354,8 @@ class TestBuildPlanner
342
354
  return [] if root.nil?
343
355
 
344
356
  testable.mocks.each_value.map do |details|
345
- File.join(
346
- @file_path_utils.form_mock_output_path( root, details.path ),
347
- details.name + EXTENSION_CORE_SOURCE
348
- )
357
+ placement = @mock_locator.placement( mocks_root: root, subdir: details.path, include_path: details.include_path )
358
+ File.join( placement.directory, details.name + EXTENSION_CORE_SOURCE )
349
359
  end
350
360
  end
351
361
 
@@ -371,6 +381,9 @@ class TestBuildPlanner
371
381
  return dir == '.' ? '' : dir
372
382
  end
373
383
 
384
+ # A source leaves the link when a mock of its .h header stands in for it. A mock of a header
385
+ # with another extension, such as foox.hpp, leaves foox.c in place, since a .h header of the
386
+ # same stem may be the one that source implements.
374
387
  def remove_mock_original_headers(filelist, mocklist)
375
388
  filelist.delete_if do |filepath|
376
389
  mocklist.include?( @configurator.cmock_mock_prefix + File.basename( filepath ).ext( EXTENSION_CORE_HEADER ) )
@@ -13,7 +13,6 @@ require 'ceedling/partials/partials'
13
13
  require 'ceedling/test_invoker/test_invoker_types'
14
14
  require 'ceedling/test_invoker/test_pipeline_helpers'
15
15
  require 'ceedling/test_invoker/test_build_validations'
16
- require 'ceedling/path_mirror'
17
16
 
18
17
  class TestBuildSetup
19
18
 
@@ -36,7 +35,9 @@ class TestBuildSetup
36
35
  :test_runner_manager,
37
36
  :dependinator,
38
37
  :test_search_paths,
39
- :mock_locator
38
+ :mock_locator,
39
+ :test_derived_search_paths,
40
+ :test_source_file_directive_resolver
40
41
  )
41
42
 
42
43
  def setup()
@@ -44,14 +45,15 @@ class TestBuildSetup
44
45
  end
45
46
 
46
47
  # Stage 1: Create per-test build/results/mock/partial directory structure
47
- # and populate the testables hash with initial entries.
48
+ # and populate the testables hash with initial entries. Stops first if two
49
+ # tests in the build share a name.
48
50
  def stage_prepare_build_paths(state)
49
- clean_test_roots = PathMirror.clean_roots( @configurator.paths_test )
51
+ validate_unique_test_names!( tests: state.tests )
50
52
 
51
53
  @batchinator.exec(workload: :compile, things: state.tests) do |filepath|
52
54
  filepath = filepath.to_s
53
- key = testable_symbolize( filepath, clean_test_roots )
54
- name = key.to_s
55
+ name = @file_path_utils.form_test_name( filepath )
56
+ key = name.to_sym
55
57
 
56
58
  state.lock.synchronize do
57
59
  state.testables[key] = Testable.new(
@@ -109,13 +111,16 @@ class TestBuildSetup
109
111
  # cache instead of being scanned again when nothing about the file itself has changed.
110
112
  def stage_collect_test_context(state)
111
113
  skipped = 0
114
+ @test_derived_search_paths.forget_notices
112
115
 
113
116
  @batchinator.exec(workload: :compile, things: state.testables) do |_, testable|
114
117
  filepath = testable.filepath
115
118
  filename = File.basename( filepath )
116
119
 
120
+ # Only a scan without test preprocessing finds TEST_SOURCE_FILE() entries, so a cache
121
+ # from the other mode is stale
117
122
  cache_target = @file_path_utils.form_test_build_directives_cache_filepath( filepath, testable.name )
118
- @dependinator.register( cache_target, files: [filepath] )
123
+ @dependinator.register( cache_target, files: [filepath], meta: { source_files_scanned: !@configurator.project_use_test_preprocessor_tests } )
119
124
  directives_stale = @dependinator.stale?( cache_target )
120
125
 
121
126
  contexts = [TestContextExtractor::Context::INCLUDES]
@@ -167,6 +172,8 @@ class TestBuildSetup
167
172
  state.lock.synchronize { skipped += 1 }
168
173
  end
169
174
 
175
+ validate_source_file_directives( testable, state.context )
176
+
170
177
  validate_mocks_in_use(
171
178
  filename: filename,
172
179
  mocks: @context_extractor.lookup_mock_header_includes_list( filepath )
@@ -178,6 +185,14 @@ class TestBuildSetup
178
185
  includes: @context_extractor.lookup_all_header_includes_list( filepath )
179
186
  )
180
187
 
188
+ # Mock search paths are found through the derived ones
189
+ derived, refusals = @test_derived_search_paths.collect( testable )
190
+ state.lock.synchronize do
191
+ testable.derived_search_paths = derived
192
+ testable.search_path_refusals = refusals
193
+ end
194
+
195
+ one_mock_per_header( testable )
181
196
  testable.mock_search_paths = collect_mock_search_paths( testable )
182
197
  end
183
198
 
@@ -194,7 +209,7 @@ class TestBuildSetup
194
209
  @batchinator.exec(workload: :compile, things: state.testables) do |_, testable|
195
210
  filepath = testable.filepath
196
211
 
197
- srch_paths = @test_search_paths.compose( filepath, testable.paths, testable.mock_search_paths )
212
+ srch_paths = @test_search_paths.compose( testable )
198
213
  cmp_flags = flags( context: state.context, operation: OPERATION_COMPILE_SYM, filepath: filepath )
199
214
  pre_flags = preprocess_flags( context: state.context, compile_flags: cmp_flags, filepath: filepath )
200
215
  asm_flags = flags( context: state.context, operation: OPERATION_ASSEMBLE_SYM, filepath: filepath )
@@ -231,6 +246,20 @@ class TestBuildSetup
231
246
  @include_pathinator.augment_environment_header_files( headers )
232
247
  end
233
248
 
249
+ # A test that names one header's mock two ways keeps one of them, which the planner, the
250
+ # runner and the rebuilt test file all read (MockLocator#one_per_header). The lookup
251
+ # needs the test's derived search paths, so it follows them.
252
+ def one_mock_per_header(testable)
253
+ return unless testable.paths[:mocks]
254
+
255
+ filepath = testable.filepath
256
+ headers = @context_extractor.lookup_all_header_includes_list( filepath )
257
+ distinct = @mock_locator.one_per_header( headers, collection: @mock_locator.header_search( testable ) )
258
+ return if distinct.length == headers.length
259
+
260
+ @context_extractor.ingest_includes( filepath, distinct + @context_extractor.lookup_source_includes_list( filepath ) )
261
+ end
262
+
234
263
  # Every mocked header's own mirrored directory below this test's mock root -- a mock is
235
264
  # only ever findable by the compiler via a search path pointing directly at wherever it
236
265
  # actually lives, since C's own #include resolution has no notion of a recursive search
@@ -247,13 +276,9 @@ class TestBuildSetup
247
276
 
248
277
  complain = @configurator.project_use_test_preprocessor_tests ? :silent : :error
249
278
 
250
- # This test's search paths don't exist until stage 3, so they are composed here
251
- # without mock directories, the same collection later stages resolve against
252
- collection = @mock_locator.header_collection( @test_search_paths.compose( testable.filepath, testable.paths ) )
253
-
254
279
  return @mock_locator.directories(
255
280
  @context_extractor.lookup_mock_header_includes_list( testable.filepath ),
256
- mocks_root: testable.paths[:mocks], collection: collection, complain: complain
281
+ mocks_root: testable.paths[:mocks], collection: @mock_locator.header_search( testable ), complain: complain
257
282
  )
258
283
  end
259
284
 
@@ -321,12 +346,12 @@ class TestBuildSetup
321
346
 
322
347
  private
323
348
 
324
- def testable_symbolize(filepath, clean_roots)
325
- basename = File.basename( filepath ).ext( '' )
326
- subdir = PathMirror.relative_subdir_from_clean_roots( filepath, clean_roots )
327
- name = subdir.empty? ? basename : File.join( subdir, basename )
349
+ # Without test preprocessing, stage 11 never runs, and only stage 2's scan finds a test's
350
+ # TEST_SOURCE_FILE() entries
351
+ def validate_source_file_directives(testable, context)
352
+ return if @configurator.project_use_test_preprocessor_tests
328
353
 
329
- return name.to_sym
354
+ @test_source_file_directive_resolver.validate!( test: testable.name, test_filepath: testable.filepath, context: context )
330
355
  end
331
356
 
332
357
  end
@@ -5,15 +5,29 @@
5
5
  # SPDX-License-Identifier: MIT
6
6
  # =========================================================================
7
7
 
8
+ require 'ceedling/filesystem/destination_collision'
9
+
8
10
  # Test-build configuration validators shared by more than one test pipeline stage
9
11
  # class -- each raises CeedlingException on a real, user-facing mistake it's
10
- # positioned to catch (a project using mocking, Partials, or a build-directive
11
- # source without configuring for it, or a header that doesn't actually resolve).
12
+ # positioned to catch (a project using mocking or Partials without configuring for
13
+ # it, a header that doesn't actually resolve, or two tests sharing one name).
12
14
  # Relies on whichever including class's own constructor DI already provides the
13
15
  # collaborators a given validator needs, the same way TestPipelineHelpers is
14
16
  # mixed in without any DI wiring of its own.
15
17
  module TestBuildValidations
16
18
 
19
+ # A name is its test's path without its extension, so two tests share one only when they
20
+ # differ in extension alone (`test_a.c` and `test_a.cpp`). Sharing would silently drop one
21
+ # test, so a build with them in it stops. A build without them is unaffected.
22
+ def validate_unique_test_names!(tests:)
23
+ shared = DestinationCollision.find( @configurator.collection_all_tests.map( &:to_s ) ) { |test| @file_path_utils.form_test_name( test ) }
24
+
25
+ tests.each do |test|
26
+ name = @file_path_utils.form_test_name( test )
27
+ DestinationCollision.raise_for( name, shared[name], 'share the build name' ) if shared.key?( name )
28
+ end
29
+ end
30
+
17
31
  def validate_mocks_in_use(filename:, mocks:)
18
32
  if !@configurator.project_use_mocks and !mocks.empty?
19
33
  _mocks = mocks.map { |include| include.filename }
@@ -43,59 +57,33 @@ module TestBuildValidations
43
57
  end
44
58
  end
45
59
 
46
- # Every #include naming a real project header -- other than a mock (validated separately,
47
- # as part of resolving it via FileFinder#resolve_mock), a system header, Unity's or
48
- # Ceedling's own header, or a Partial (Ceedling's own generated content, not a project file
49
- # to validate) -- must resolve to exactly one file, existence-wise, among this test's own
50
- # search_paths (the same directory priority the compiler itself consults): ambiguity among
51
- # same-named candidates resolves quietly to the first by that order, exactly as the real
52
- # compile would find it; only a genuinely unresolvable name still halts the build here. A
53
- # bogus or merely-unmatched path is otherwise never actually checked against real project
54
- # headers -- only its potential corresponding source file is, tolerantly, elsewhere. Unity's
55
- # and Ceedling's own headers live in the build's vendor directories, outside every configured
56
- # :test/:source/:support/:include root a test's search_paths is built from, so neither could
57
- # ever resolve there.
58
- def validate_header_includes(test_filepath:, testable:)
60
+ # Every #include of a project header must resolve through this test's search paths, as
61
+ # the compiler resolves it. Same-named candidates resolve to the first in search order,
62
+ # and only an unresolvable name halts the build here. Mocks are checked as they resolve
63
+ # (FileFinder#resolve_mock). System headers, Unity's and Ceedling's own headers, and
64
+ # Partials are Ceedling's or the toolchain's, so none is checked.
65
+ #
66
+ # `search` is the test's HeaderSearch when the caller already holds one.
67
+ def validate_header_includes(test_filepath:, testable:, search: nil)
59
68
  includes = @context_extractor.lookup_nonmock_header_includes_list( test_filepath )
60
69
 
61
- collection = @include_pathinator.ordered_header_files( testable.search_paths )
62
-
63
- includes.each do |include|
64
- next if include.is_a?( SystemInclude )
65
- next if include.filename == UNITY_H_FILE
66
- next if include.filename == CEEDLING_HEADER_FILENAME
67
- next if include.filename.start_with?( PARTIAL_FILENAME_PREFIX )
70
+ collection = search || @mock_locator.header_search( testable )
68
71
 
72
+ header_includes_to_check( includes ).each do |include|
69
73
  @file_finder.find_header_file( include.filepath, :error, collection: collection )
70
74
  end
71
75
  end
72
76
 
73
- # A TEST_SOURCE_FILE() entry must name a real, recognized file whether it
74
- # adds or removes -- a typo or a nonexistent path is worth failing loudly
75
- # on either side of the +:/-: convention, the same way a missing file has
76
- # always been treated for a plain, additive entry.
77
- def validate!(test:, filepath:)
78
- sources = @test_context_extractor.lookup_build_directive_sources_list( filepath )
79
-
80
- ext_message = @configurator.extension_source.to_s
81
- ext_message += " or #{@configurator.extension_assembly}" if @configurator.test_build_use_assembly
82
-
83
- sources.each do |raw_source|
84
- source = FilePathUtils.no_aggregation_decorators( raw_source )
85
- valid_extension =
86
- if @configurator.test_build_use_assembly
87
- @configurator.extension_assembly.match?( source ) || @configurator.extension_source.match?( source )
88
- else
89
- @configurator.extension_source.match?( source )
90
- end
91
-
92
- unless valid_extension
93
- raise CeedlingException.new( "File '#{source}' specified with TEST_SOURCE_FILE() in #{test} is not a #{ext_message} source file" )
94
- end
77
+ private
95
78
 
96
- if @file_finder.find_build_input_file( filepath: source, complain: :ignore, context: TEST_SYM ).nil?
97
- raise CeedlingException.new( "File '#{source}' specified with TEST_SOURCE_FILE() in #{test} cannot be found in the source file collection" )
98
- end
79
+ # The #includes naming a project header: no system header, Unity's or Ceedling's own
80
+ # header, or a Partial
81
+ def header_includes_to_check(includes)
82
+ return includes.reject do |include|
83
+ include.is_a?( SystemInclude ) or
84
+ include.filename == UNITY_H_FILE or
85
+ include.filename == CEEDLING_HEADER_FILENAME or
86
+ include.filename.start_with?( PARTIAL_FILENAME_PREFIX )
99
87
  end
100
88
  end
101
89
 
@@ -0,0 +1,189 @@
1
+ # =========================================================================
2
+ # Ceedling - Test-Centered Build System for C
3
+ # ThrowTheSwitch.org
4
+ # Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
5
+ # SPDX-License-Identifier: MIT
6
+ # =========================================================================
7
+
8
+ require 'ceedling/constants'
9
+ require 'ceedling/includes/includes'
10
+ require 'ceedling/includes/header_search'
11
+ require 'ceedling/filesystem/path_matcher'
12
+ require 'ceedling/filesystem/project_paths'
13
+ require 'ceedling/test_invoker/test_pipeline_helpers'
14
+ require 'ceedling/test_invoker/derived_search_path_notices'
15
+
16
+ # The search paths a test's #includes imply for headers whose own directories no search
17
+ # path lists.
18
+ #
19
+ # A header that only :files ↳ :include supplies usually sits in no search path's
20
+ # directory, so the compiler can't reach it through the #include as written. The directory that #include
21
+ # implies is the header's path with the #include's own path taken off its end. Joined with
22
+ # that directory, the #include names the header, so a test whose #include reaches nothing
23
+ # else gets the directory as a search path, after every configured path. Nothing
24
+ # configured is shadowed.
25
+ #
26
+ # A bare name gives the header's own directory. Outside the working directory that can be
27
+ # a system directory of forwarding headers, such as glibc's sys/, where one header includes
28
+ # another by a name the directory itself holds. No directory is added for a bare name
29
+ # there. The refusal explains the error the header's failed lookup raises.
30
+ class TestDerivedSearchPaths
31
+
32
+ include TestPipelineHelpers
33
+
34
+ # The option that names a mock's header by its folder
35
+ FOLDER_OPTION = ':cmock ↳ :mock_name_include_folder'
36
+
37
+ constructor :configurator, :include_pathinator, :test_search_paths, :test_context_extractor, :file_finder, :file_wrapper, :loginator
38
+
39
+ def setup
40
+ @notices = DerivedSearchPathNotices.new( loginator: @loginator )
41
+ end
42
+
43
+ # Starts a test build, whose NOTICEs name each directory once
44
+ def forget_notices
45
+ @notices.forget
46
+ end
47
+
48
+ # The directories `testable`'s #includes imply, in the order its #includes need them, and
49
+ # the refusals for headers outside the working directory, by the query each #include asks
50
+ # for. One search serves every #include until a directory joins it.
51
+ def collect(testable)
52
+ configured = @test_search_paths.header_paths( testable )
53
+ search = @include_pathinator.header_search( configured )
54
+
55
+ return candidate_includes( testable ).each_with_object( [[], {}] ) do |include, (roots, refusals)|
56
+ root = derived_root( testable, include, search, refusals )
57
+ next if root.nil?
58
+
59
+ roots << root
60
+ search = @include_pathinator.header_search( configured + roots )
61
+ end
62
+ end
63
+
64
+ private
65
+
66
+ # The test's quoted #includes of project headers it could name by a path below a search
67
+ # path
68
+ def candidate_includes(testable)
69
+ return @test_context_extractor.lookup_all_header_includes_list( testable.filepath ).reject do |include|
70
+ include.is_a?( SystemInclude ) or generated?( include ) or placed?( include )
71
+ end
72
+ end
73
+
74
+ # Unity's, Ceedling's or a Partial's header, or a Partial mock
75
+ def generated?(include)
76
+ return true if [UNITY_H_FILE, CEEDLING_HEADER_FILENAME].include?( include.filename )
77
+
78
+ return (include.filename.start_with?( PARTIAL_FILENAME_PREFIX ) or mock_partial?( include ))
79
+ end
80
+
81
+ # A path the compiler resolves without a search path: one that climbs or is absolute
82
+ def placed?(include)
83
+ return true if include.directory_relative? or PathMatcher.absolute?( include.filepath )
84
+
85
+ return ProjectPaths.segments( include.filepath ).include?( '..' )
86
+ end
87
+
88
+ # The directory `include` implies for its header, or nil when it needs none or is refused
89
+ # one. A refusal joins `refusals`.
90
+ def derived_root(testable, include, search, refusals)
91
+ query, text = query_and_text( include )
92
+ return nil if reaches?( testable, include, text, search )
93
+
94
+ header = unlisted_header( query, search )
95
+ return nil if header.nil?
96
+ return refuse( refusals, include, query, refusal( testable, include, text, header ) ) if bare_outside_project?( text, header )
97
+
98
+ root = PathMatcher.strip_tail( header, text )
99
+ @notices.added( testable, root, text, header ) unless root.nil?
100
+ return root
101
+ end
102
+
103
+ # Records why the header `query` names gets no directory, which adds none, under every
104
+ # name its failed lookup can report. Every stage looks a test's mocks up before its other
105
+ # #includes, so a mock's refusal explains a name they share.
106
+ def refuse(refusals, include, query, why)
107
+ mock = include.is_a?( MockInclude )
108
+
109
+ lookup_names( include, query ).each do |name|
110
+ refusals[name] = why if mock or !refusals.key?( name )
111
+ end
112
+
113
+ return nil
114
+ end
115
+
116
+ # The names a lookup of `query` reports, as the header search spells them. A mock's header
117
+ # is looked up by its query. Another #include's is looked up by each header extension in
118
+ # turn, and the last names the failure.
119
+ def lookup_names(include, query)
120
+ names = include.is_a?( MockInclude ) ? [query] : [query] + @configurator.extension_header.candidates( query )
121
+ return names.map { |name| HeaderSearch.normalized( name ) }.uniq
122
+ end
123
+
124
+ # Why a bare name's header outside the working directory gets no search path, and the
125
+ # #include that reaches it instead. Without :mock_name_include_folder a mock includes its
126
+ # header by `text` alone, whatever folder its own #include writes.
127
+ def refusal(testable, include, text, header)
128
+ written = include.filepath
129
+ suggested = "`#include \"#{File.join( File.basename( File.dirname( header ) ), File.basename( written ) )}\"`"
130
+ needs = "`#include \"#{written}\"` in #{testable.filepath} needs search path '#{ProjectPaths.absolute( File.dirname( header ) )}'"
131
+ reason = 'Because this search path is outside the working directory and could cause shadowing of other headers, ' \
132
+ "Ceedling won't add the full search path."
133
+
134
+ unless include.is_a?( MockInclude ) and !@configurator.cmock_mock_name_include_folder
135
+ return "#{needs}. #{reason} Instead, reference the parent folder, as in #{suggested}."
136
+ end
137
+
138
+ return "#{needs}, since its mock writes `#include \"#{text}\"` with #{FOLDER_OPTION} disabled. #{reason} " \
139
+ "Instead, enable #{FOLDER_OPTION} and reference the parent folder, as in #{suggested}."
140
+ end
141
+
142
+ # The header `query` names, when no search path lists its directory and Ceedling didn't
143
+ # generate it
144
+ def unlisted_header(query, search)
145
+ header = search.header_candidates( query ).first || @include_pathinator.collection_candidates( query, search.paths ).first
146
+ return nil if header.nil? or listed?( header, search ) or below_build_root?( header )
147
+
148
+ return header
149
+ end
150
+
151
+ # A bare name's header outside the working directory may sit among forwarding headers
152
+ def bare_outside_project?(text, header)
153
+ return (File.dirname( text ) == '.' and !ProjectPaths.contains?( ProjectPaths.working_dir, header ))
154
+ end
155
+
156
+ # The header a mock's #include asks for, and the text the compiled #include names. A
157
+ # mock names its header by the folder its #include writes, or by filename alone without
158
+ # :mock_name_include_folder.
159
+ def query_and_text(include)
160
+ return [include.filepath, include.filepath] unless include.is_a?( MockInclude )
161
+
162
+ query = @file_finder.mock_header_query( include.filepath )
163
+ text = @configurator.cmock_mock_name_include_folder ? query : File.basename( query )
164
+ return [query, text]
165
+ end
166
+
167
+ # Whether the compiled #include already finds a header: joined with a search path as the
168
+ # compiler joins it, or for the test's own #include, through the test file's directory,
169
+ # as a quoted #include does
170
+ def reaches?(testable, include, text, search)
171
+ return true if search.joins?( text )
172
+ return false if include.is_a?( MockInclude )
173
+
174
+ return @file_wrapper.exist?( File.join( File.dirname( testable.filepath ), text ) )
175
+ end
176
+
177
+ # Whether a search path lists the header's own directory, so the #include as written is
178
+ # one the compiler rejects, and no directory is added for it
179
+ def listed?(header, search)
180
+ dir = File.dirname( header )
181
+ return search.paths.any? { |path| ProjectPaths.subdir_below( path, dir ) == '' }
182
+ end
183
+
184
+ # Ceedling's own vendor and generated headers
185
+ def below_build_root?(header)
186
+ return ProjectPaths.contains?( @configurator.project_build_root, header )
187
+ end
188
+
189
+ end
@@ -50,7 +50,7 @@ class TestFilePreprocessinator
50
50
  state.lock.synchronize { skipped += 1 } unless stale
51
51
 
52
52
  stale ? scan_source_directives( testable ) : recall_source_directives( testable )
53
- state.testables.each_value { |each| @test_source_file_directive_resolver.validate!( test: testable.name, filepath: each.filepath ) }
53
+ @test_source_file_directive_resolver.validate!( test: testable.name, test_filepath: testable.filepath, context: state.context )
54
54
  end
55
55
 
56
56
  log_skip_summary( task: "test file preprocessing", count: skipped, noun: "test files" )
@@ -88,8 +88,7 @@ class TestFilePreprocessinator
88
88
  return @preprocessinator.preprocess_test_file(
89
89
  test: testable.name, filepath: testable.filepath, directives_only_filepath: directives_only_filepath( testable ),
90
90
  fallback: fallback?( testable ), includes: @context_extractor.lookup_all_header_includes_list( testable.filepath ),
91
- flags: testable.preprocess_flags, include_paths: testable.search_paths, vendor_paths: vendor_search_paths(),
92
- defines: testable.preprocess_defines
91
+ flags: testable.preprocess_flags, include_paths: testable.search_paths, defines: testable.preprocess_defines
93
92
  )
94
93
  end
95
94
 
@@ -140,7 +140,7 @@ class TestIncludesReconcilinator
140
140
  mock_dirs = @mock_locator.directories(
141
141
  @context_extractor.lookup_mock_header_includes_list( testable.filepath ),
142
142
  mocks_root: testable.paths[:mocks],
143
- collection: @mock_locator.header_collection( testable.search_paths, testable.mock_search_paths ),
143
+ collection: @mock_locator.header_search( testable ),
144
144
  complain: :silent
145
145
  )
146
146
  @test_search_paths.assign_mock_search_paths( testable, mock_dirs, state.lock )
@@ -22,7 +22,8 @@ class TestInvoker
22
22
  :dependinator,
23
23
  :loginator,
24
24
  :verbosinator,
25
- :test_pipeline_manager
25
+ :test_pipeline_manager,
26
+ :include_pathinator
26
27
  )
27
28
 
28
29
  def setup
@@ -40,6 +41,10 @@ class TestInvoker
40
41
  timestamp_s = SystemWrapper.time_stopwatch_s()
41
42
  @plugin_manager.pre_test_build( context, timestamp_s )
42
43
 
44
+ # After the hook, so a header it writes is listed, and once per run, so a later run in
45
+ # the same process lists every search path afresh
46
+ @include_pathinator.forget_header_listings
47
+
43
48
  # `identifier: context` isolates this run's own cache file (see Dependinator#open) --
44
49
  # a plugin building its own variant of the test pipeline under a distinct context
45
50
  # (:gcov, :valgrind, ...) gets its own cache automatically, never sharing one with