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
@@ -7,26 +7,32 @@
7
7
 
8
8
  require 'spec_helper'
9
9
  require 'ceedling/includes/include_factory'
10
+ require 'ceedling/filesystem/test_build_layout'
10
11
 
11
12
  describe IncludeFactory do
12
13
  before(:each) do
13
14
  @configurator = double( "Configurator" )
14
15
  allow(@configurator).to receive(:cmock_mock_prefix).and_return( 'Mock' )
15
16
  allow(@configurator).to receive(:cmock_mock_path).and_return( 'build/test/mocks' )
17
+ allow(@configurator).to receive(:project_use_mocks).and_return( true )
16
18
 
17
- @factory = described_class.new( { configurator: @configurator } )
19
+ file_wrapper = double( "FileWrapper" )
20
+ allow(file_wrapper).to receive(:check_path_length)
21
+ layout = TestBuildLayout.new( { configurator: @configurator, file_wrapper: file_wrapper } )
22
+
23
+ @factory = described_class.new( { configurator: @configurator, test_build_layout: layout } )
18
24
  end
19
25
 
20
26
  describe '#user_include_from_filepath' do
21
- it 'strips a flat test\'s own mock subdirectory down to the bare mock filename' do
22
- include_obj = @factory.user_include_from_filepath( 'build/test/mocks/TestFoo/MockBar.h', test: 'TestFoo' )
27
+ it 'strips a test\'s own mock subdirectory down to the bare mock filename' do
28
+ include_obj = @factory.user_include_from_filepath( 'build/test/mocks/test/TestFoo/_t_/MockBar.h', test: 'test/TestFoo' )
23
29
  expect( include_obj.filename ).to eq( 'MockBar.h' )
24
30
  expect( include_obj.filepath ).to eq( 'MockBar.h' )
25
31
  end
26
32
 
27
33
  it 'strips a nested test\'s own multi-segment mock subdirectory down to the bare mock filename' do
28
34
  include_obj = @factory.user_include_from_filepath(
29
- 'build/test/mocks/adc/TestAdcConductor/MockAdcHardware.h', test: 'adc/TestAdcConductor'
35
+ 'build/test/mocks/test/adc/TestAdcConductor/_t_/MockAdcHardware.h', test: 'test/adc/TestAdcConductor'
30
36
  )
31
37
  expect( include_obj.filename ).to eq( 'MockAdcHardware.h' )
32
38
  expect( include_obj.filepath ).to eq( 'MockAdcHardware.h' )
@@ -34,14 +40,25 @@ describe IncludeFactory do
34
40
 
35
41
  it 'preserves a mocked header\'s own mirrored subdirectory beyond the test\'s own mock subdirectory' do
36
42
  include_obj = @factory.user_include_from_filepath(
37
- 'build/test/mocks/TestFoo/calculators/MockBar.h', test: 'TestFoo'
43
+ 'build/test/mocks/TestFoo/_t_/calculators/MockBar.h', test: 'TestFoo'
38
44
  )
39
45
  expect( include_obj.filename ).to eq( 'MockBar.h' )
40
46
  expect( include_obj.filepath ).to eq( 'calculators/MockBar.h' )
41
47
  end
42
48
 
49
+ # A test's mock lies in a folder named like a test nested below it
50
+ it 'keeps a mocked header\'s subdirectory named like a nested test' do
51
+ include_obj = @factory.user_include_from_filepath( 'build/test/mocks/test/test_c/_t_/test_x/Mockqux.h', test: 'test/test_c' )
52
+ expect( include_obj.filepath ).to eq( 'test_x/Mockqux.h' )
53
+ end
54
+
55
+ it 'leaves a mock below another test\'s mock root untouched' do
56
+ include_obj = @factory.user_include_from_filepath( 'build/test/mocks/test/test_c/test_x/_t_/Mockqux.h', test: 'test/test_c' )
57
+ expect( include_obj.filepath ).to eq( 'build/test/mocks/test/test_c/test_x/_t_/Mockqux.h' )
58
+ end
59
+
43
60
  it 'falls back to stripping through the last segment when no test identity is given' do
44
- include_obj = @factory.user_include_from_filepath( 'build/test/mocks/TestFoo/MockBar.h' )
61
+ include_obj = @factory.user_include_from_filepath( 'build/test/mocks/TestFoo/_t_/MockBar.h' )
45
62
  expect( include_obj.filepath ).to eq( 'MockBar.h' )
46
63
  end
47
64
 
@@ -20,6 +20,7 @@ describe IncludePathinator do
20
20
  @file_wrapper = double( "FileWrapper" )
21
21
 
22
22
  allow(@configurator).to receive(:extension_header).and_return( FilenameExtension.new('.h') )
23
+ allow(@configurator).to receive(:project_build_root).and_return( 'build' )
23
24
 
24
25
  @pathinator = described_class.new(
25
26
  {
@@ -31,21 +32,22 @@ describe IncludePathinator do
31
32
  )
32
33
  end
33
34
 
34
- describe '#ordered_header_files' do
35
+ # Each search builds anew, so these show the listings it draws on shared across searches
36
+ describe '#header_search' do
35
37
  it 'returns an empty list given an empty search path list' do
36
- expect(@pathinator.ordered_header_files([])).to eq([])
38
+ expect(@pathinator.header_search([]).flat).to eq([])
37
39
  end
38
40
 
39
41
  it 'lists headers from a single search path' do
40
42
  allow(@file_wrapper).to receive(:directory_listing).with(['inc/*.h']).and_return( ['inc/foo.h', 'inc/bar.h'] )
41
- expect(@pathinator.ordered_header_files(['inc'])).to eq( ['inc/foo.h', 'inc/bar.h'] )
43
+ expect(@pathinator.header_search(['inc']).flat).to eq( ['inc/foo.h', 'inc/bar.h'] )
42
44
  end
43
45
 
44
46
  it 'concatenates headers from multiple search paths in the order the paths are given' do
45
47
  allow(@file_wrapper).to receive(:directory_listing).with(['first/*.h']).and_return( ['first/foo.h'] )
46
48
  allow(@file_wrapper).to receive(:directory_listing).with(['second/*.h']).and_return( ['second/foo.h'] )
47
49
 
48
- expect(@pathinator.ordered_header_files(['first', 'second'])).to eq( ['first/foo.h', 'second/foo.h'] )
50
+ expect(@pathinator.header_search(['first', 'second']).flat).to eq( ['first/foo.h', 'second/foo.h'] )
49
51
  end
50
52
 
51
53
  it "ranks an earlier search path's same-named header ahead of a later path's, regardless of either path's own alphabetical position" do
@@ -55,18 +57,95 @@ describe IncludePathinator do
55
57
  allow(@file_wrapper).to receive(:directory_listing).with(['zzz/*.h']).and_return( ['zzz/dup.h'] )
56
58
  allow(@file_wrapper).to receive(:directory_listing).with(['aaa/*.h']).and_return( ['aaa/dup.h'] )
57
59
 
58
- expect(@pathinator.ordered_header_files(['zzz', 'aaa'])).to eq( ['zzz/dup.h', 'aaa/dup.h'] )
60
+ expect(@pathinator.header_search(['zzz', 'aaa']).flat).to eq( ['zzz/dup.h', 'aaa/dup.h'] )
59
61
  end
60
62
 
61
63
  it 'de-duplicates an identical filepath reachable more than once, keeping its first occurrence' do
62
64
  allow(@file_wrapper).to receive(:directory_listing).with(['inc/*.h']).and_return( ['inc/foo.h'] )
63
65
 
64
- expect(@pathinator.ordered_header_files(['inc', 'inc'])).to eq( ['inc/foo.h'] )
66
+ expect(@pathinator.header_search(['inc', 'inc']).flat).to eq( ['inc/foo.h'] )
67
+ end
68
+
69
+ # A test's search paths are listed several times a test, and nothing in a build writes
70
+ # into the project's own directories
71
+ it 'lists a directory outside the build root once' do
72
+ expect(@file_wrapper).to receive(:directory_listing).with(['inc/*.h']).once.and_return( ['inc/foo.h'] )
73
+
74
+ 2.times { expect(@pathinator.header_search(['inc']).flat).to eq( ['inc/foo.h'] ) }
75
+ end
76
+
77
+ it 'lists a directory under the build root on every call, so headers the build writes appear' do
78
+ expect(@file_wrapper).to receive(:directory_listing).with(['build/test/mocks/*.h']).twice.and_return(
79
+ ['build/test/mocks/a.h'],
80
+ ['build/test/mocks/a.h', 'build/test/mocks/b.h']
81
+ )
82
+ expect(ProjectPaths).to receive(:contains?).once.and_call_original
83
+
84
+ expect(@pathinator.header_search(['build/test/mocks']).flat).to eq( ['build/test/mocks/a.h'] )
85
+ expect(@pathinator.header_search(['build/test/mocks']).flat).to eq( ['build/test/mocks/a.h', 'build/test/mocks/b.h'] )
86
+ end
87
+
88
+ it 'lists every directory again after the listings are forgotten' do
89
+ expect(@file_wrapper).to receive(:directory_listing).with(['inc/*.h']).twice.and_return( ['inc/foo.h'], ['inc/foo.h', 'inc/new.h'] )
90
+
91
+ @pathinator.header_search(['inc']).flat
92
+ @pathinator.forget_header_listings
93
+
94
+ expect(@pathinator.header_search(['inc']).flat).to eq( ['inc/foo.h', 'inc/new.h'] )
95
+ end
96
+
97
+ it 'gives a search the build root, so it knows which headers Ceedling generates' do
98
+ search = @pathinator.header_search( ['src'] )
99
+
100
+ expect( [search.generated?( 'build/test/partials/foo.h' ), search.generated?( 'src/foo.h' )] ).to eq( [true, false] )
101
+ end
102
+
103
+ it 'lists the directory a search path joins with an #include once, outside the build root' do
104
+ expect(@file_wrapper).to receive(:directory_listing).with(['src/drivers/*.h']).once.and_return( ['src/drivers/foo.h'] )
105
+
106
+ 2.times { expect(@pathinator.header_search(['src']).header_candidates('drivers/foo.h')).to eq( ['src/drivers/foo.h'] ) }
65
107
  end
66
108
  end
67
109
 
68
- # Distinct from ordered_header_files: this returns the whole project collection, since a
69
- # reference naming a header by path can sit at any depth below a search path.
110
+ describe '#collect_test_include_paths' do
111
+ before(:each) do
112
+ allow(@configurator).to receive(:collection_paths_test).and_return( ['test', 'test/support'] )
113
+ allow(@file_wrapper).to receive(:directory_listing).with(['test/*.h']).and_return( [] )
114
+ allow(@file_wrapper).to receive(:directory_listing).with(['test/support/*.h']).and_return( ['test/support/helper.h'] )
115
+ end
116
+
117
+ it 'gives the test directories holding headers' do
118
+ expect(@pathinator.collect_test_include_paths).to eq( ['test/support'] )
119
+ end
120
+
121
+ # Every composition of a test's search paths asks
122
+ it 'lists the test directories once until the listings are forgotten' do
123
+ expect(@file_wrapper).to receive(:directory_listing).with(['test/*.h']).twice.and_return( [] )
124
+
125
+ 2.times { @pathinator.collect_test_include_paths }
126
+ @pathinator.forget_header_listings
127
+ @pathinator.collect_test_include_paths
128
+ end
129
+ end
130
+
131
+ describe '#collection_candidates' do
132
+ it "gives the collection's headers a query names, those below earlier search paths first" do
133
+ allow(@configurator).to receive(:collection_all_headers).and_return( ['src/a/sensor.h', 'lib/sensor.h', 'src/other.h'] )
134
+
135
+ expect(@pathinator.collection_candidates( 'sensor.h', ['lib', 'src'] )).to eq( ['lib/sensor.h', 'src/a/sensor.h'] )
136
+ end
137
+ end
138
+
139
+ describe '#prioritize' do
140
+ it 'orders any header list by the earliest search path each header lies below, keeping ties in list order' do
141
+ headers = ['src/b.h', 'inc/a.h', 'src/a.h', 'other/c.h']
142
+
143
+ expect(@pathinator.prioritize( headers, ['inc', 'src'] )).to eq( ['inc/a.h', 'src/b.h', 'src/a.h', 'other/c.h'] )
144
+ end
145
+ end
146
+
147
+ # Distinct from header_search: this returns the whole project collection, since a
148
+ # Partial module named by path can sit at any depth below a search path.
70
149
  describe '#prioritized_header_files' do
71
150
  it 'returns headers at any depth below a search path, not only its immediate contents' do
72
151
  allow(@configurator).to receive(:collection_all_headers)
@@ -220,11 +299,25 @@ describe IncludePathinator do
220
299
 
221
300
  describe '#augment_environment_header_files' do
222
301
  it 'delegates to configurator.redefine_element with :collection_all_headers and the given headers, unchanged' do
302
+ allow(@configurator).to receive(:collection_all_headers).and_return( ['inc/foo.h'] )
223
303
  headers = ['inc/foo.h', 'inc/bar.h']
224
304
  expect(@configurator).to receive(:redefine_element).with(:collection_all_headers, headers)
225
305
 
226
306
  @pathinator.augment_environment_header_files(headers)
227
307
  end
308
+
309
+ # A later build in the process would otherwise find another test's TEST_INCLUDE_PATH()
310
+ # headers among the configured ones
311
+ it 'keeps collection_candidates drawing on the collection as configured' do
312
+ collection = ['src/a/sensor.h']
313
+ allow(@configurator).to receive(:collection_all_headers) { collection }
314
+ allow(@configurator).to receive(:redefine_element) { |_name, headers| collection = headers }
315
+
316
+ @pathinator.augment_environment_header_files( ['src/a/sensor.h', 'tip/sensor.h'] )
317
+ @pathinator.augment_environment_header_files( ['src/a/sensor.h', 'tip/sensor.h'] )
318
+
319
+ expect(@pathinator.collection_candidates( 'sensor.h', [] )).to eq( ['src/a/sensor.h'] )
320
+ end
228
321
  end
229
322
 
230
323
  describe '#lookup_test_directive_include_paths' do
@@ -266,4 +359,21 @@ describe IncludePathinator do
266
359
  expect(@pathinator.collect_test_include_paths).to eq(['has_headers'])
267
360
  end
268
361
  end
362
+
363
+ # A search path spelled with `./` or absolutely names the same place (the path handling
364
+ # audit around GH #1370)
365
+ describe 'G23: #prioritized_header_files with other spellings of a search path' do
366
+ before(:each) do
367
+ allow(@configurator).to receive(:collection_all_headers)
368
+ .and_return(Rake::FileList.new(['vendor/config.h', 'local/config.h']))
369
+ end
370
+
371
+ it 'ranks a `./`-spelled search path as the plain one' do
372
+ expect( @pathinator.prioritized_header_files(['./local', 'vendor']) ).to eq(['local/config.h', 'vendor/config.h'])
373
+ end
374
+
375
+ it 'ranks an absolute search path as the relative one' do
376
+ expect( @pathinator.prioritized_header_files([File.join( Dir.pwd, 'local' ), 'vendor']) ).to eq(['local/config.h', 'vendor/config.h'])
377
+ end
378
+ end
269
379
  end
@@ -564,6 +564,20 @@ describe "Include string coercion (to_str)" do
564
564
  # to_str always returns @filename (the basename) regardless of include_path
565
565
  expect(include_obj.to_str).to eq("header.h")
566
566
  end
567
+
568
+ # Its path is then no longer the one written
569
+ it "marks an include whose `..` a scan resolved against its file's directory" do
570
+ anchored = UserInclude.new("../src/header.h").anchored("test")
571
+
572
+ expect(anchored.filepath).to eq("src/header.h")
573
+ expect(anchored.directory_relative?).to be( true )
574
+ expect(anchored).to eq( UserInclude.new("src/header.h") )
575
+ end
576
+
577
+ it "leaves an include without `..` unmarked" do
578
+ expect(UserInclude.new("src/header.h").anchored("test").directory_relative?).to be( false )
579
+ expect(UserInclude.new("src/header.h").directory_relative?).to be( false )
580
+ end
567
581
  end
568
582
 
569
583
  describe "SystemInclude" do
@@ -531,7 +531,8 @@ describe "Includes sorting" do
531
531
  end
532
532
 
533
533
  describe "Includes sanitization" do
534
- describe "sanitize!()" do
534
+ # A list that mixes an unresolved text with resolved headers, as a Partial's does
535
+ describe "drop_shadowed!()" do
535
536
  # An unresolved include carries only the text as written, so its filepath has no
536
537
  # directory of its own. Beside a resolved entry for the same basename it can only
537
538
  # ever reach a file by search-path accident, and which file that is depends on
@@ -546,7 +547,7 @@ describe "Includes sanitization" do
546
547
  UserInclude.new('include/drivers/spi/config.h', include_path: 'spi/config.h')
547
548
  ]
548
549
 
549
- result = Includes.sanitize!(includes)
550
+ result = Includes.drop_shadowed!(includes)
550
551
 
551
552
  expect( result.map(&:filepath) )
552
553
  .to eq(['include/drivers/uart/config.h', 'include/drivers/spi/config.h'])
@@ -558,7 +559,7 @@ describe "Includes sanitization" do
558
559
  UserInclude.new('include/drivers/uart/config.h', include_path: 'uart/config.h')
559
560
  ]
560
561
 
561
- result = Includes.sanitize!(includes)
562
+ result = Includes.drop_shadowed!(includes)
562
563
 
563
564
  expect( result.map(&:filepath) )
564
565
  .to eq(['include/config.h', 'include/drivers/uart/config.h'])
@@ -570,10 +571,32 @@ describe "Includes sanitization" do
570
571
  UserInclude.new('include/drivers/uart/other.h', include_path: 'uart/other.h')
571
572
  ]
572
573
 
573
- result = Includes.sanitize!(includes)
574
+ result = Includes.drop_shadowed!(includes)
574
575
 
575
576
  expect( result.map(&:filepath) ).to include('config.h')
576
577
  end
578
+ end
579
+
580
+ describe "sanitize!()" do
581
+ # Every entry of a bare or scanned list is an #include as written, and a pathless one
582
+ # can name a different header than a same-named one with a folder
583
+ it "keeps a pathless #include beside a same-named one with a folder" do
584
+ includes = [Include.new('config.h'), Include.new('app/config.h')]
585
+
586
+ expect( Includes.sanitize!(includes).map(&:filepath) ).to eq(['config.h', 'app/config.h'])
587
+ end
588
+
589
+ it "keeps a pathless mock beside a same-named mock with a folder" do
590
+ includes = [MockInclude.new('mock_task.h'), MockInclude.new('other/mock_task.h')]
591
+
592
+ expect( Includes.sanitize!(includes).map(&:filepath) ).to eq(['mock_task.h', 'other/mock_task.h'])
593
+ end
594
+
595
+ it "keeps a user #include beside a same-named system #include" do
596
+ includes = [SystemInclude.new('sys/types.h'), UserInclude.new('types.h')]
597
+
598
+ expect( Includes.sanitize!(includes).map(&:filepath) ).to eq(['sys/types.h', 'types.h'])
599
+ end
577
600
 
578
601
  it "removes duplicate includes" do
579
602
  includes = [
@@ -1273,6 +1296,89 @@ describe "Includes reconciliation" do
1273
1296
  expect(calls).to be_empty
1274
1297
  end
1275
1298
 
1299
+ # A pathless #include matches every same-named header. The #include naming a folder
1300
+ # takes its own header first, in whatever order the preprocessor entered them (#1426).
1301
+ [['src/hw/config.h', 'lib/app/config.h'], ['lib/app/config.h', 'src/hw/config.h']].each do |order|
1302
+ it "pairs a pathless #include with the same-named header a folder's #include leaves, with candidates #{order.join(', ')}" do
1303
+ bare = [Include.new("config.h"), Include.new("app/config.h")]
1304
+ user = order.map { |filepath| UserInclude.new(filepath) }
1305
+
1306
+ result = Includes.reconcile(bare: bare, user: user, system: [])
1307
+
1308
+ expect(result.map(&:filepath)).to eq(['src/hw/config.h', 'lib/app/config.h'])
1309
+ end
1310
+ end
1311
+
1312
+ [['include/mock_task.h', 'other/mock_task.h'], ['other/mock_task.h', 'include/mock_task.h']].each do |order|
1313
+ it "keeps a pathless mock beside a same-named mock its folder names, with candidates #{order.join(', ')}" do
1314
+ bare = [Include.new("mock_task.h"), Include.new("other/mock_task.h")]
1315
+ user = order.map { |filepath| MockInclude.new(filepath) }
1316
+
1317
+ result = Includes.reconcile(bare: bare, user: user, system: [])
1318
+
1319
+ expect(result.map(&:filepath)).to eq(['mock_task.h', 'other/mock_task.h'])
1320
+ end
1321
+ end
1322
+
1323
+ # GCC lists `./drivers/foo.h` as `drivers/foo.h`, and the text scan adds it as written
1324
+ it "pairs a repeat of an earlier #include's path with nothing, even beside another same-named header" do
1325
+ bare = [Include.new("config.h"), Include.new("./config.h")]
1326
+ user = [UserInclude.new("test/config.h"), UserInclude.new("src/config.h")]
1327
+
1328
+ result = Includes.reconcile(bare: bare, user: user, system: [])
1329
+
1330
+ expect(result.map(&:filepath)).to eq(['test/config.h'])
1331
+ end
1332
+
1333
+ # A mock named by its #include's own place keeps that text, not a shorter candidate's
1334
+ it "pairs an #include with the candidate its whole path names before one it only ends" do
1335
+ bare = [Include.new("drivers/mock_task.h"), Include.new("src/drivers/mock_task.h")]
1336
+ user = [MockInclude.new("drivers/mock_task.h"), MockInclude.new("src/drivers/mock_task.h")]
1337
+
1338
+ result = Includes.reconcile(bare: bare, user: user, system: [])
1339
+
1340
+ expect(result.map(&:filepath)).to eq(['drivers/mock_task.h', 'src/drivers/mock_task.h'])
1341
+ end
1342
+
1343
+ it "pairs one #include alone with the candidate its whole path names" do
1344
+ bare = [Include.new("src/drivers/mock_task.h")]
1345
+ user = [MockInclude.new("drivers/mock_task.h"), MockInclude.new("src/drivers/mock_task.h")]
1346
+
1347
+ expect(Includes.reconcile(bare: bare, user: user, system: []).map(&:filepath)).to eq(['src/drivers/mock_task.h'])
1348
+ end
1349
+
1350
+ # A preprocessor can name one file two ways, as `drivers/./mock_task.h`
1351
+ it "counts candidates naming one path once" do
1352
+ bare = [Include.new("drivers/mock_task.h")]
1353
+ user = [MockInclude.new("build/m/drivers/mock_task.h"), MockInclude.new("build/m/drivers/./mock_task.h")]
1354
+
1355
+ calls = []
1356
+ Includes.reconcile(bare: bare, user: user, system: []) { |*args| calls << args }
1357
+
1358
+ expect(calls).to be_empty
1359
+ end
1360
+
1361
+ # A header another #include took was not passed over
1362
+ it "does not call on_ambiguous for a same-named header another #include took" do
1363
+ bare = [Include.new("config.h"), Include.new("app/config.h")]
1364
+ user = [UserInclude.new("src/hw/config.h"), UserInclude.new("lib/app/config.h")]
1365
+
1366
+ calls = []
1367
+ Includes.reconcile(bare: bare, user: user, system: []) { |*args| calls << args }
1368
+
1369
+ expect(calls).to be_empty
1370
+ end
1371
+
1372
+ it "names only the candidates no #include took as passed over" do
1373
+ bare = [Include.new("config.h"), Include.new("app/config.h")]
1374
+ user = [UserInclude.new("src/hw/config.h"), UserInclude.new("lib/app/config.h"), UserInclude.new("vendor/config.h")]
1375
+
1376
+ calls = []
1377
+ Includes.reconcile(bare: bare, user: user, system: []) { |*args| calls << args }
1378
+
1379
+ expect(calls).to eq([["config.h", "src/hw/config.h", ["vendor/config.h"]]])
1380
+ end
1381
+
1276
1382
  it "preserves a system include directive's original directory components instead of collapsing to its bare filename" do
1277
1383
  bare = [Include.new("sys/stat.h")]
1278
1384
  user = []
@@ -1329,7 +1435,8 @@ describe "Includes reconciliation" do
1329
1435
  # search even under -nostdinc, so an ordinary bare entry's own text can't be
1330
1436
  # trusted as "the literal, as-written spelling" the way a system include's can.
1331
1437
  # A bare entry carrying `include_path` (see the tests below) is a different,
1332
- # known-literal case -- this one stays untagged.
1438
+ # known-literal case -- this one stays untagged. A file generated from the
1439
+ # reconciled list spells the header for itself (Include#spelled_by).
1333
1440
  bare = [Include.new("drivers/gpio.h")]
1334
1441
  user = [UserInclude.new("drivers/gpio.h")]
1335
1442
  system = []
@@ -1423,22 +1530,60 @@ describe "Includes reconciliation" do
1423
1530
  expect("#{result[0]}").to eq('#include "Types.h"')
1424
1531
  end
1425
1532
 
1426
- it "renders a matched MockInclude the same way regardless of the include_path fix, since MockInclude#to_s never consults it" do
1427
- bare = [Include.new("mock_module.h")]
1428
- user = [MockInclude.new("mocks/subdir/mock_module.h")]
1429
- system = []
1533
+ # A mock's #include names it for CMock and the runner. Its candidate holds its place below
1534
+ # its mirror root, which can carry folders the test never wrote.
1535
+ context "for a mock" do
1536
+ it "keeps the #include the test wrote, not the mock's place below its mirror root" do
1537
+ result = Includes.reconcile(bare: [Include.new("mock_task.h")], user: [MockInclude.new("include/mock_task.h")], system: [])
1430
1538
 
1431
- result = Includes.reconcile(bare: bare, user: user, system: system)
1539
+ expect(result.length).to eq(1)
1540
+ expect(result[0]).to be_a(MockInclude)
1541
+ expect("#{result[0]}").to eq('#include "mock_task.h"')
1542
+ end
1432
1543
 
1433
- expect(result.length).to eq(1)
1434
- expect(result[0]).to be_a(MockInclude)
1435
- expect("#{result[0]}").to eq('#include "mocks/subdir/mock_module.h"')
1544
+ # As the text scan records it, so the mock keeps one name in every preprocessing mode
1545
+ it "keeps a climbing #include anchored to the test file's directory" do
1546
+ result = Includes.reconcile(
1547
+ bare: [Include.new("../x/mock_foo.h")], user: [MockInclude.new("_up_/x/mock_foo.h")], system: [], test_filepath: "test/test_c.c"
1548
+ )
1549
+
1550
+ expect(result[0].filepath).to eq("x/mock_foo.h")
1551
+ expect(result[0]).to be_directory_relative
1552
+ end
1553
+
1554
+ # A computed #include's bare entry is the path its line marker names, which carries the
1555
+ # mock root ahead of the mock's place
1556
+ it "keeps the mock's place for a computed #include, whose bare entry is its line-marker path" do
1557
+ result = Includes.reconcile(
1558
+ bare: [Include.new("build/test/mocks/test_t/include/mock_task.h")], user: [MockInclude.new("include/mock_task.h")], system: []
1559
+ )
1560
+
1561
+ expect("#{result[0]}").to eq('#include "include/mock_task.h"')
1562
+ end
1563
+
1564
+ it "keeps the #include the test wrote when a computed #include's line-marker path names the same mock" do
1565
+ bare = [Include.new("mock_task.h"), Include.new("build/test/mocks/test_t/include/mock_task.h")]
1566
+ result = Includes.reconcile(bare: bare, user: [MockInclude.new("include/mock_task.h")], system: [])
1567
+
1568
+ expect(result.map(&:to_s)).to eq(['#include "mock_task.h"'])
1569
+ end
1570
+
1571
+ it "keeps two same-named mocks apart by the folders the test wrote" do
1572
+ bare = [Include.new("a/mock_foo.h"), Include.new("b/mock_foo.h")]
1573
+ user = [MockInclude.new("x/a/mock_foo.h"), MockInclude.new("y/b/mock_foo.h")]
1574
+
1575
+ result = Includes.reconcile(bare: bare, user: user, system: [])
1576
+
1577
+ expect(result.map(&:to_s)).to contain_exactly('#include "a/mock_foo.h"', '#include "b/mock_foo.h"')
1578
+ expect(result).to all( be_a(MockInclude) )
1579
+ end
1436
1580
  end
1437
1581
 
1438
- it "does not hard-error over two same-named system headers, a normal toolchain wrapper-chain pattern rather than a project-file conflict" do
1582
+ it "keeps one of two same-named system headers, a normal toolchain wrapper-chain pattern rather than a project-file conflict" do
1439
1583
  # e.g. a compiler-provided stdint.h #include_next-ing its libc counterpart --
1440
1584
  # both real, both legitimately entered, both sharing a basename, neither a
1441
- # project file whose identity is actually in question.
1585
+ # project file whose identity is actually in question. Both would be written
1586
+ # as the same #include line, so only the first, the one the file named, is kept.
1442
1587
  bare = [Include.new("stdint.h")]
1443
1588
 
1444
1589
  user = []
@@ -1452,10 +1597,22 @@ describe "Includes reconciliation" do
1452
1597
  result = Includes.reconcile(bare: bare, user: user, system: system)
1453
1598
  }.not_to raise_error
1454
1599
 
1455
- expect(result.length).to eq(2)
1456
- expect(result.map(&:filepath)).to include(
1457
- "/usr/lib/gcc/x86_64-linux-gnu/14/include/stdint.h", "/usr/include/stdint.h"
1458
- )
1600
+ expect(result.map(&:filepath)).to eq(["/usr/lib/gcc/x86_64-linux-gnu/14/include/stdint.h"])
1601
+ expect(result.map(&:to_s)).to eq(["#include <stdint.h>"])
1602
+ end
1603
+
1604
+ it "keeps same-named system headers that are written as different #include lines" do
1605
+ bare = [Include.new("stat.h"), Include.new("sys/stat.h")]
1606
+
1607
+ user = []
1608
+ system = [
1609
+ SystemInclude.new("/usr/include/sys/stat.h"),
1610
+ SystemInclude.new("/opt/compat/include/stat.h")
1611
+ ]
1612
+
1613
+ result = Includes.reconcile(bare: bare, user: user, system: system)
1614
+
1615
+ expect(result.map(&:to_s)).to contain_exactly("#include <sys/stat.h>", "#include <stat.h>")
1459
1616
  end
1460
1617
 
1461
1618
  it "resolves a .. in a bare entry's literal text against test_filepath's own directory to match a clean candidate" do