ceedling 1.2.1 → 1.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (545) hide show
  1. checksums.yaml +4 -4
  2. data/GIT_COMMIT_SHA +1 -1
  3. data/README.md +11 -9
  4. data/Rakefile +2 -1
  5. data/assets/features/ceedling +1 -1
  6. data/assets/fixtures/test_source_file_duplicate_basenames/test_calc_typo.c +14 -0
  7. data/assets/fixtures/tests_with_duplicate_test_names/test_foo.c +21 -0
  8. data/assets/fixtures/tests_with_partials_coverage/src/private_macro.c +7 -0
  9. data/assets/fixtures/tests_with_partials_coverage/src/private_macro.h +5 -0
  10. data/assets/fixtures/tests_with_partials_coverage/src/tally.c +13 -0
  11. data/assets/fixtures/tests_with_partials_coverage/src/tally.h +4 -0
  12. data/assets/fixtures/tests_with_partials_coverage/test/test_private_macro.c +10 -0
  13. data/assets/fixtures/tests_with_partials_coverage/test/test_tally.c +9 -0
  14. data/bin/actionator.rb +6 -12
  15. data/bin/app_cfg.rb +14 -1
  16. data/bin/ceedling +13 -3
  17. data/bin/cli.rb +25 -6
  18. data/bin/cli_handler.rb +113 -73
  19. data/bin/cli_helper.rb +51 -78
  20. data/bin/installation_selector.rb +81 -0
  21. data/bin/launchinator.rb +69 -0
  22. data/bin/mixin_resolvinator.rb +26 -36
  23. data/bin/objects.yml +13 -0
  24. data/bin/path_validator.rb +25 -29
  25. data/bin/versionator.rb +47 -48
  26. data/ceedling.gemspec +19 -15
  27. data/docs/BreakingChanges.md +86 -1
  28. data/docs/Changelog.md +145 -3
  29. data/docs/KnownIssues.md +179 -6
  30. data/docs/ReleaseNotes.md +13 -0
  31. data/examples/wondrous_forest/README.md +29 -1
  32. data/examples/wondrous_forest/src/ForestUnits.h +23 -0
  33. data/examples/wondrous_forest/src/RainGauge.c +59 -0
  34. data/examples/wondrous_forest/src/RainGauge.h +39 -0
  35. data/examples/wondrous_forest/src/RainTipIsr.c +17 -0
  36. data/examples/wondrous_forest/src/RainTipIsr.h +14 -0
  37. data/examples/wondrous_forest/test/TestRainGauge.c +126 -0
  38. data/lib/ceedling/build_log_writer.rb +33 -0
  39. data/lib/ceedling/c_extractor/README.md +15 -7
  40. data/lib/ceedling/c_extractor/c_extractor.rb +25 -14
  41. data/lib/ceedling/c_extractor/c_extractor_code_text.rb +84 -54
  42. data/lib/ceedling/c_extractor/c_extractor_constants.rb +18 -7
  43. data/lib/ceedling/c_extractor/c_extractor_declarations.rb +319 -283
  44. data/lib/ceedling/c_extractor/c_extractor_declarator.rb +285 -0
  45. data/lib/ceedling/c_extractor/c_extractor_defined_type.rb +111 -0
  46. data/lib/ceedling/c_extractor/c_extractor_definitions.rb +174 -121
  47. data/lib/ceedling/c_extractor/c_extractor_functions.rb +191 -162
  48. data/lib/ceedling/c_extractor/c_extractor_preprocessing.rb +46 -55
  49. data/lib/ceedling/c_extractor/c_extractor_statement.rb +30 -0
  50. data/lib/ceedling/c_extractor/c_extractor_types.rb +63 -41
  51. data/lib/ceedling/c_extractor/c_module_edits.rb +48 -0
  52. data/lib/ceedling/c_identifier.rb +21 -0
  53. data/lib/ceedling/ceedling.h +8 -0
  54. data/lib/ceedling/config/build_root_policy.rb +70 -0
  55. data/lib/ceedling/config/configurator.rb +18 -19
  56. data/lib/ceedling/config/configurator_builder.rb +75 -28
  57. data/lib/ceedling/config/configurator_paths_validator.rb +179 -0
  58. data/lib/ceedling/config/configurator_plugins.rb +1 -1
  59. data/lib/ceedling/config/configurator_setup.rb +44 -33
  60. data/lib/ceedling/config/configurator_validator.rb +1 -110
  61. data/lib/ceedling/constants.rb +5 -1
  62. data/lib/ceedling/defaults.rb +35 -5
  63. data/lib/ceedling/dependencies/CACHE_SCHEMA.md +118 -0
  64. data/lib/ceedling/dependencies/README.md +18 -16
  65. data/lib/ceedling/dependencies/dependency_cache_store.rb +43 -21
  66. data/lib/ceedling/dependencies/dependency_hasher.rb +35 -1
  67. data/lib/ceedling/dependencies/dependency_tracker.rb +9 -3
  68. data/lib/ceedling/dependencies/dependinator.rb +13 -1
  69. data/lib/ceedling/diagnostics/DOCTOR.md +142 -0
  70. data/lib/ceedling/diagnostics/README.md +5 -0
  71. data/lib/ceedling/diagnostics/build_step_doctor.rb +110 -0
  72. data/lib/ceedling/diagnostics/duplicate_symbol_specialist.rb +108 -0
  73. data/lib/ceedling/diagnostics/guidance_phrases.rb +30 -0
  74. data/lib/ceedling/diagnostics/header_collision_guidance.rb +56 -0
  75. data/lib/ceedling/diagnostics/header_collision_specialist.rb +152 -0
  76. data/lib/ceedling/diagnostics/include_depth_specialist.rb +132 -0
  77. data/lib/ceedling/diagnostics/missing_symbol_specialist.rb +111 -0
  78. data/lib/ceedling/diagnostics/partial_name_specialist.rb +134 -0
  79. data/lib/ceedling/diagnostics/toolchain_output.rb +44 -0
  80. data/lib/ceedling/filename_extension.rb +7 -1
  81. data/lib/ceedling/filesystem/FILE_TREE.md +253 -0
  82. data/lib/ceedling/filesystem/PATH_HANDLING.md +360 -0
  83. data/lib/ceedling/filesystem/README.md +46 -0
  84. data/lib/ceedling/filesystem/build_roots.rb +105 -0
  85. data/lib/ceedling/filesystem/build_subpath.rb +187 -0
  86. data/lib/ceedling/filesystem/destination_collision.rb +25 -0
  87. data/lib/ceedling/{file_finder.rb → filesystem/file_finder.rb} +177 -156
  88. data/lib/ceedling/filesystem/file_finder_helper.rb +154 -0
  89. data/lib/ceedling/filesystem/file_path_collection_utils.rb +183 -0
  90. data/lib/ceedling/{file_path_utils.rb → filesystem/file_path_utils.rb} +200 -167
  91. data/lib/ceedling/{file_system_wrapper.rb → filesystem/file_system_wrapper.rb} +6 -5
  92. data/lib/ceedling/filesystem/file_tree.rb +241 -0
  93. data/lib/ceedling/{file_wrapper.rb → filesystem/file_wrapper.rb} +149 -65
  94. data/lib/ceedling/filesystem/path_exclusions.rb +30 -0
  95. data/lib/ceedling/{path_matcher.rb → filesystem/path_matcher.rb} +48 -23
  96. data/lib/ceedling/{path_mirror.rb → filesystem/path_mirror.rb} +19 -18
  97. data/lib/ceedling/filesystem/path_spellings.rb +55 -0
  98. data/lib/ceedling/filesystem/project_paths.rb +184 -0
  99. data/lib/ceedling/filesystem/test_build_layout.rb +114 -0
  100. data/lib/ceedling/filesystem/win_long_paths.rb +153 -0
  101. data/lib/ceedling/filesystem/win_path_limit.rb +83 -0
  102. data/lib/ceedling/filesystem/win_path_prober.rb +52 -0
  103. data/lib/ceedling/filesystem/working_dir.rb +40 -0
  104. data/lib/ceedling/generators/generator.rb +32 -70
  105. data/lib/ceedling/generators/generator_helper.rb +0 -44
  106. data/lib/ceedling/generators/generator_mocks.rb +5 -0
  107. data/lib/ceedling/generators/generator_partials.rb +306 -244
  108. data/lib/ceedling/generators/generator_test_results_backtrace.rb +7 -7
  109. data/lib/ceedling/generators/generator_test_runner.rb +5 -8
  110. data/lib/ceedling/generators/partial_header_writer.rb +95 -0
  111. data/lib/ceedling/generators/partial_source_writer.rb +137 -0
  112. data/lib/ceedling/handoff.rb +121 -0
  113. data/lib/ceedling/includes/header_search.rb +225 -0
  114. data/lib/ceedling/includes/include_factory.rb +9 -12
  115. data/lib/ceedling/includes/include_pathinator.rb +112 -33
  116. data/lib/ceedling/includes/includes.rb +150 -38
  117. data/lib/ceedling/installation.rb +92 -0
  118. data/lib/ceedling/library_resolver.rb +99 -0
  119. data/lib/ceedling/objects.yml +112 -6
  120. data/lib/ceedling/partials/README.md +110 -16
  121. data/lib/ceedling/partials/carry_plan.rb +71 -0
  122. data/lib/ceedling/partials/definition_head.rb +74 -0
  123. data/lib/ceedling/partials/include_groups.rb +37 -0
  124. data/lib/ceedling/partials/interface_extras.rb +25 -0
  125. data/lib/ceedling/partials/partializer.rb +603 -124
  126. data/lib/ceedling/partials/partializer_config.rb +8 -1
  127. data/lib/ceedling/partials/partializer_helper.rb +851 -145
  128. data/lib/ceedling/partials/partializer_reconciler.rb +174 -0
  129. data/lib/ceedling/partials/partializer_utils.rb +89 -109
  130. data/lib/ceedling/partials/partials.rb +153 -10
  131. data/lib/ceedling/partials/type_macros.rb +126 -0
  132. data/lib/ceedling/plugins/report_log_writer_plugin.rb +3 -5
  133. data/lib/ceedling/preprocess/README.md +43 -33
  134. data/lib/ceedling/preprocess/preprocessinator.rb +100 -186
  135. data/lib/ceedling/preprocess/preprocessinator_code_finder.rb +65 -72
  136. data/lib/ceedling/preprocess/preprocessinator_file_assembler.rb +32 -76
  137. data/lib/ceedling/preprocess/preprocessinator_includes_handler.rb +1 -1
  138. data/lib/ceedling/preprocess/preprocessinator_line_marker_includes_extractor.rb +1 -1
  139. data/lib/ceedling/preprocess/preprocessinator_reconstructor.rb +51 -14
  140. data/lib/ceedling/rake_app/rakefile_component_resolver.rb +10 -17
  141. data/lib/ceedling/rakefile.rb +15 -1
  142. data/lib/ceedling/rakefiles/base/tasks_base.rake +1 -1
  143. data/lib/ceedling/rakefiles/release/rules_release.rake +4 -7
  144. data/lib/ceedling/release_invoker/release_build_executor.rb +33 -44
  145. data/lib/ceedling/release_invoker/release_build_planner.rb +14 -6
  146. data/lib/ceedling/reportinator.rb +3 -4
  147. data/lib/ceedling/setupinator.rb +104 -87
  148. data/lib/ceedling/test_context_extractor.rb +5 -1
  149. data/lib/ceedling/test_invoker/HEADER_COLLISIONS.md +21 -7
  150. data/lib/ceedling/test_invoker/PIPELINE.md +62 -19
  151. data/lib/ceedling/test_invoker/README.md +1 -1
  152. data/lib/ceedling/test_invoker/derived_search_path_notices.rb +45 -0
  153. data/lib/ceedling/test_invoker/mock_locator.rb +175 -10
  154. data/lib/ceedling/test_invoker/partial_files_preprocessinator.rb +181 -0
  155. data/lib/ceedling/test_invoker/partials_manager.rb +271 -302
  156. data/lib/ceedling/test_invoker/standin_headerinator.rb +19 -17
  157. data/lib/ceedling/test_invoker/test_bare_includes_extractinator.rb +26 -3
  158. data/lib/ceedling/test_invoker/test_build_executor.rb +358 -234
  159. data/lib/ceedling/test_invoker/test_build_planner.rb +46 -33
  160. data/lib/ceedling/test_invoker/test_build_setup.rb +43 -18
  161. data/lib/ceedling/test_invoker/test_build_validations.rb +35 -47
  162. data/lib/ceedling/test_invoker/test_derived_search_paths.rb +189 -0
  163. data/lib/ceedling/test_invoker/test_file_preprocessinator.rb +2 -3
  164. data/lib/ceedling/test_invoker/test_includes_reconcilinator.rb +1 -1
  165. data/lib/ceedling/test_invoker/test_invoker.rb +6 -1
  166. data/lib/ceedling/test_invoker/test_invoker_types.rb +28 -20
  167. data/lib/ceedling/test_invoker/test_pipeline_helpers.rb +6 -4
  168. data/lib/ceedling/test_invoker/test_pipeline_manager.rb +25 -8
  169. data/lib/ceedling/test_invoker/test_runner_generatinator.rb +31 -3
  170. data/lib/ceedling/test_invoker/test_search_paths.rb +30 -8
  171. data/lib/ceedling/test_invoker/test_source_file_directive_resolver.rb +40 -20
  172. data/lib/ceedling/test_invoker/test_substitutions.rb +72 -0
  173. data/lib/ceedling/tools/shell_quoting.rb +45 -0
  174. data/lib/ceedling/{tool_executor.rb → tools/tool_executor.rb} +9 -3
  175. data/lib/ceedling/tools/tool_quoting.rb +79 -0
  176. data/lib/ceedling/{tool_validator.rb → tools/tool_validator.rb} +18 -7
  177. data/lib/ceedling/yaml_wrapper.rb +3 -2
  178. data/lib/version.rb +1 -1
  179. data/plugins/bullseye/bullseye.rake +1 -3
  180. data/plugins/bullseye/config/defaults_bullseye.rb +1 -1
  181. data/plugins/bullseye/lib/bullseye.rb +24 -9
  182. data/plugins/command_hooks/lib/command_hooks.rb +1 -1
  183. data/plugins/cppcheck/config/defaults_cppcheck.rb +1 -1
  184. data/plugins/dependencies/config/defaults.yml +6 -6
  185. data/plugins/dependencies/dependencies.rake +4 -1
  186. data/plugins/dependencies/lib/dependencies.rb +18 -8
  187. data/plugins/dependencies/lib/dependency_spec.rb +17 -5
  188. data/plugins/fff/lib/fff.rb +79 -46
  189. data/plugins/fff/lib/fff_mock_generator.rb +12 -9
  190. data/plugins/fff/spec/fff_cmock_wrapper_spec.rb +262 -0
  191. data/plugins/fff/spec/fff_mock_header_generator_spec.rb +9 -0
  192. data/plugins/fff/spec/fff_mock_source_generator_spec.rb +20 -0
  193. data/plugins/gcov/config/defaults_gcov.rb +1 -1
  194. data/plugins/gcov/lib/console_reportinator.rb +28 -36
  195. data/plugins/gcov/lib/gcov.rb +9 -2
  196. data/plugins/gcov/lib/gcovr_reportinator.rb +8 -40
  197. data/plugins/gcov/lib/gcovr_thresholds.rb +74 -0
  198. data/plugins/gcov/lib/reportgenerator_reportinator.rb +3 -2
  199. data/plugins/module_generator/lib/module_generator.rb +3 -3
  200. data/plugins/report_tests_teamcity_stdout/lib/report_tests_teamcity_stdout.rb +53 -80
  201. data/plugins/sanitize/lib/sanitize_records.rb +3 -6
  202. data/plugins/valgrind/lib/valgrind.rb +14 -7
  203. data/site-local/404.html +2 -2
  204. data/site-local/assets/javascripts/{bundle.c21346df.min.js → bundle.a5f9d56c.min.js} +1 -1
  205. data/site-local/assets/javascripts/{bundle.c21346df.min.js.map → bundle.a5f9d56c.min.js.map} +2 -2
  206. data/site-local/configuration/environment-vars.html +2 -2
  207. data/site-local/configuration/global-collections.html +3 -3
  208. data/site-local/configuration/index.html +2 -2
  209. data/site-local/configuration/loading.html +2 -2
  210. data/site-local/configuration/mixins.html +2 -2
  211. data/site-local/configuration/parallel-builds.html +2 -2
  212. data/site-local/configuration/project-file.html +2 -2
  213. data/site-local/configuration/reference/cexception.html +2 -2
  214. data/site-local/configuration/reference/cmock.html +7 -3
  215. data/site-local/configuration/reference/defines.html +2 -2
  216. data/site-local/configuration/reference/environment.html +2 -2
  217. data/site-local/configuration/reference/extension.html +2 -2
  218. data/site-local/configuration/reference/files.html +65 -12
  219. data/site-local/configuration/reference/flags.html +2 -2
  220. data/site-local/configuration/reference/index.html +2 -2
  221. data/site-local/configuration/reference/libraries.html +23 -5
  222. data/site-local/configuration/reference/mixins.html +2 -2
  223. data/site-local/configuration/reference/partials.html +84 -2
  224. data/site-local/configuration/reference/paths.html +36 -8
  225. data/site-local/configuration/reference/plugins.html +2 -2
  226. data/site-local/configuration/reference/project.html +264 -12
  227. data/site-local/configuration/reference/release-build.html +4 -2
  228. data/site-local/configuration/reference/test-build.html +2 -2
  229. data/site-local/configuration/reference/test-runner.html +2 -2
  230. data/site-local/configuration/reference/tools.html +58 -4
  231. data/site-local/configuration/reference/unity.html +2 -2
  232. data/site-local/configuration/which-ceedling.html +379 -19
  233. data/site-local/development/index.html +2 -2
  234. data/site-local/development/plugins/configuration.html +2 -2
  235. data/site-local/development/plugins/index.html +2 -2
  236. data/site-local/development/plugins/plugin-subclass.html +5 -4
  237. data/site-local/development/plugins/rake-tasks.html +2 -2
  238. data/site-local/development/releases.html +7 -3
  239. data/site-local/development/workflow.html +50 -45
  240. data/site-local/getting-started/builds.html +4 -2
  241. data/site-local/getting-started/command-line.html +58 -6
  242. data/site-local/getting-started/example-projects/cipher-quest.html +2 -2
  243. data/site-local/getting-started/example-projects/index.html +2 -2
  244. data/site-local/getting-started/example-projects/temp-sensor.html +2 -2
  245. data/site-local/getting-started/example-projects/wondrous-forest.html +10 -2
  246. data/site-local/getting-started/index.html +2 -2
  247. data/site-local/getting-started/installation.html +2 -2
  248. data/site-local/getting-started/quick-start.html +2 -2
  249. data/site-local/help.html +2 -2
  250. data/site-local/index.html +2 -2
  251. data/site-local/overview/build-system.html +2 -2
  252. data/site-local/overview/index.html +2 -2
  253. data/site-local/overview/test-environments.html +2 -2
  254. data/site-local/overview/tools-and-frameworks.html +2 -2
  255. data/site-local/plugins/beep.html +2 -2
  256. data/site-local/plugins/bullseye/index.html +45 -38
  257. data/site-local/plugins/bullseye/licensing.html +2 -2
  258. data/site-local/plugins/command-hooks.html +4 -4
  259. data/site-local/plugins/compile-commands-json-db.html +2 -2
  260. data/site-local/plugins/cppcheck.html +2 -2
  261. data/site-local/plugins/dependencies.html +8 -5
  262. data/site-local/plugins/fff.html +58 -13
  263. data/site-local/plugins/gcov/examples.html +2 -2
  264. data/site-local/plugins/gcov/gcovr.html +23 -14
  265. data/site-local/plugins/gcov/index.html +2 -2
  266. data/site-local/plugins/gcov/overview.html +2 -2
  267. data/site-local/plugins/gcov/reportgenerator.html +18 -14
  268. data/site-local/plugins/gcov/reporting.html +2 -2
  269. data/site-local/plugins/gcov/setup.html +4 -3
  270. data/site-local/plugins/gcov/tool-versions.html +2 -2
  271. data/site-local/plugins/gcov/troubleshooting.html +2 -2
  272. data/site-local/plugins/index.html +2 -2
  273. data/site-local/plugins/module-generator.html +2 -2
  274. data/site-local/plugins/report-build-warnings-log.html +2 -2
  275. data/site-local/plugins/report-tests-gtestlike-stdout.html +2 -2
  276. data/site-local/plugins/report-tests-ide-stdout.html +2 -2
  277. data/site-local/plugins/report-tests-log-factory.html +2 -2
  278. data/site-local/plugins/report-tests-pretty-stdout.html +2 -2
  279. data/site-local/plugins/report-tests-raw-output-log.html +5 -3
  280. data/site-local/plugins/report-tests-teamcity-stdout.html +8 -5
  281. data/site-local/plugins/sanitize.html +9 -8
  282. data/site-local/plugins/valgrind.html +10 -9
  283. data/site-local/project/index.html +2 -2
  284. data/site-local/project/release-history.html +2 -2
  285. data/site-local/project/sbom.html +2 -2
  286. data/site-local/project/upgrade.html +5 -2
  287. data/site-local/reference/build-directives.html +2 -2
  288. data/site-local/reference/command-line.html +11 -4
  289. data/site-local/reference/environment-vars.html +2 -2
  290. data/site-local/reference/gcov-plugin.html +2 -2
  291. data/site-local/reference/global-collections.html +12 -12
  292. data/site-local/reference/index.html +2 -2
  293. data/site-local/reference/partials-macros.html +47 -2
  294. data/site-local/reference/project-configuration.html +2 -2
  295. data/site-local/sitemap.xml.gz +0 -0
  296. data/site-local/snapshot/examples/cipher_quest/index.html +2 -2
  297. data/site-local/snapshot/examples/temp_sensor/index.html +2 -2
  298. data/site-local/snapshot/examples/wondrous_forest/index.html +72 -15
  299. data/site-local/snapshot/plugins/bullseye/config/defaults_bullseye.rb +1 -1
  300. data/site-local/snapshot/plugins/gcov/config/defaults_gcov.rb +1 -1
  301. data/site-local/testing-guide/build-directives.html +2 -2
  302. data/site-local/testing-guide/conventions.html +113 -15
  303. data/site-local/testing-guide/frameworks.html +2 -2
  304. data/site-local/testing-guide/index.html +2 -2
  305. data/site-local/testing-guide/partials/configuration.html +31 -4
  306. data/site-local/testing-guide/partials/conventions.html +509 -8
  307. data/site-local/testing-guide/partials/directives.html +4 -3
  308. data/site-local/testing-guide/partials/example.html +2 -2
  309. data/site-local/testing-guide/partials/index.html +2 -2
  310. data/site-local/testing-guide/partials/overview.html +30 -12
  311. data/site-local/testing-guide/partials/variables.html +169 -4
  312. data/site-local/testing-guide/test-cases.html +2 -2
  313. data/site-local/testing-guide/test-sample.html +2 -2
  314. data/site-local/testing-guide/test-suite-anatomy.html +2 -2
  315. data/spec/integration/actionator_file_operations_spec.rb +91 -1
  316. data/spec/integration/build_step_doctor_spec.rb +270 -0
  317. data/spec/integration/c_extractor_composition_spec.rb +254 -4
  318. data/spec/integration/compile_commands_json_db_spec.rb +1 -1
  319. data/spec/integration/configurator_validation_spec.rb +1 -1
  320. data/spec/integration/dependencies/dependency_tracker_cache_hardening_spec.rb +26 -0
  321. data/spec/integration/dependencies/dependency_tracker_core_spec.rb +22 -0
  322. data/spec/integration/includes_extraction_spec.rb +27 -14
  323. data/spec/integration/launcher_handoff_spec.rb +297 -0
  324. data/spec/integration/mixin_loading_spec.rb +1 -1
  325. data/spec/integration/module_generator_spec.rb +3 -3
  326. data/spec/integration/nested_test_artifacts_spec.rb +99 -0
  327. data/spec/integration/partial_files_preprocessing_spec.rb +128 -0
  328. data/spec/integration/partials_carry_spec.rb +520 -0
  329. data/spec/integration/partials_declarations_spec.rb +655 -0
  330. data/spec/integration/partials_fallback_preprocessing_spec.rb +65 -0
  331. data/spec/integration/partials_function_pointers_spec.rb +277 -0
  332. data/spec/integration/partials_header_composition_spec.rb +268 -35
  333. data/spec/integration/partials_macro_decorators_spec.rb +267 -0
  334. data/spec/integration/partials_module_resolution_spec.rb +33 -23
  335. data/spec/integration/partials_symbol_linkage_spec.rb +13 -0
  336. data/spec/integration/path_intake_scenarios_spec.rb +101 -0
  337. data/spec/integration/path_length_reporting_spec.rb +64 -0
  338. data/spec/integration/path_scenarios_spec.rb +399 -0
  339. data/spec/integration/quote_include_isolator_spec.rb +57 -1
  340. data/spec/integration/report_build_warnings_log_spec.rb +1 -1
  341. data/spec/integration/report_tests_log_factory_spec.rb +1 -1
  342. data/spec/integration/test_build_parallel_barrier_spec.rb +1 -1
  343. data/spec/integration/test_executable_manifest_spec.rb +1 -1
  344. data/spec/integration/test_includes_extractinator_spec.rb +69 -3
  345. data/spec/integration/test_naming_spec.rb +201 -0
  346. data/spec/integration/test_source_file_checks_spec.rb +168 -0
  347. data/spec/integration/tool_executor_spec.rb +1 -1
  348. data/spec/integration/tool_validator_spec.rb +3 -3
  349. data/spec/integration/upgrade_docs_spec.rb +84 -0
  350. data/spec/integration/vendor_copy_transient_io_retry_spec.rb +74 -5
  351. data/spec/integration/win_long_paths_probe_spec.rb +46 -0
  352. data/spec/integration/win_path_limit_spec.rb +53 -0
  353. data/spec/integration/windows_registry_query_tool_spec.rb +41 -0
  354. data/spec/support/file_tree_helper.rb +88 -0
  355. data/spec/support/integration/configurator_integration_helper.rb +14 -9
  356. data/spec/support/integration/dependency_tracker_integration_helper.rb +1 -1
  357. data/spec/support/integration/partial_files_harness.rb +181 -0
  358. data/spec/support/integration/partials_generation_integration_helper.rb +239 -143
  359. data/spec/support/integration/path_scenario_harness.rb +175 -0
  360. data/spec/support/integration/spec_integration_helper.rb +9 -4
  361. data/spec/support/integration/test_includes_harness.rb +69 -37
  362. data/spec/support/integration/tool_executor_integration_helper.rb +14 -2
  363. data/spec/support/spec_helper.rb +2 -0
  364. data/spec/support/system/spec_system_helper.rb +7 -6
  365. data/spec/support/system/system_context.rb +21 -3
  366. data/spec/support/working_dir_tracking.rb +49 -0
  367. data/spec/system/build_output_mirroring_spec.rb +2 -2
  368. data/spec/system/bullseye_deployment_spec.rb +2 -0
  369. data/spec/system/conditional_mock_includes_spec.rb +1 -1
  370. data/spec/system/delta_builds_spec.rb +163 -23
  371. data/spec/system/encoding_stress_spec.rb +4 -4
  372. data/spec/system/example_wondrous_forest_spec.rb +2 -2
  373. data/spec/system/gcov_deployment_spec.rb +3 -0
  374. data/spec/system/header_include_path_validation_spec.rb +4 -4
  375. data/spec/system/header_search_paths_spec.rb +1083 -0
  376. data/spec/system/launcher_handoff_spec.rb +82 -0
  377. data/spec/system/mock_include_folders_spec.rb +212 -0
  378. data/spec/system/mockable_header_reassembly_spec.rb +184 -0
  379. data/spec/system/parent_directory_reference_spec.rb +5 -3
  380. data/spec/system/partials_carry_spec.rb +581 -0
  381. data/spec/system/partials_delta_builds_spec.rb +280 -0
  382. data/spec/system/partials_function_pointers_spec.rb +106 -0
  383. data/spec/system/partials_macro_decorators_spec.rb +127 -0
  384. data/spec/system/partials_module_disambiguation_spec.rb +125 -0
  385. data/spec/system/path_handling_probes_spec.rb +196 -0
  386. data/spec/system/pinned_thread_count_spec.rb +4 -4
  387. data/spec/system/preprocessing_fallback_conditionals_spec.rb +1 -1
  388. data/spec/system/preprocessing_parameterized_tests_spec.rb +1 -1
  389. data/spec/system/rake_release_task_path_disambiguation_spec.rb +6 -6
  390. data/spec/system/rake_test_task_path_disambiguation_spec.rb +85 -0
  391. data/spec/system/short_build_paths_spec.rb +87 -0
  392. data/spec/system/sibling_header_collision_spec.rb +30 -6
  393. data/spec/system/special_path_characters_spec.rb +86 -0
  394. data/spec/system/support/bullseye_common_test_cases.rb +42 -0
  395. data/spec/system/support/common_test_cases.rb +23 -21
  396. data/spec/system/support/gcov_common_test_cases.rb +37 -9
  397. data/spec/system/support/gcov_partials_test_cases.rb +48 -0
  398. data/spec/system/support/sanitize_common_test_cases.rb +2 -2
  399. data/spec/system/support/valgrind_common_test_cases.rb +12 -12
  400. data/spec/system/test_build_layout_spec.rb +209 -0
  401. data/spec/system/test_pipeline_stop_points_spec.rb +4 -4
  402. data/spec/system/test_runner_system_include_spec.rb +1 -1
  403. data/spec/system/test_source_file_directive_spec.rb +64 -5
  404. data/spec/units/bin/actionator_spec.rb +14 -17
  405. data/spec/units/bin/app_cfg_spec.rb +37 -0
  406. data/spec/units/bin/cli_handler_spec.rb +282 -6
  407. data/spec/units/bin/cli_helper_spec.rb +116 -45
  408. data/spec/units/bin/installation_selector_spec.rb +114 -0
  409. data/spec/units/bin/launchinator_spec.rb +171 -0
  410. data/spec/units/bin/path_validator_spec.rb +10 -0
  411. data/spec/units/bin/versionator_spec.rb +38 -6
  412. data/spec/units/build_log_writer_spec.rb +57 -0
  413. data/spec/units/c_extractor/c_extractor_code_text_spec.rb +67 -10
  414. data/spec/units/c_extractor/c_extractor_declarations_spec.rb +501 -4
  415. data/spec/units/c_extractor/c_extractor_declarator_spec.rb +245 -0
  416. data/spec/units/c_extractor/c_extractor_defined_type_spec.rb +45 -0
  417. data/spec/units/c_extractor/c_extractor_definitions_spec.rb +163 -3
  418. data/spec/units/c_extractor/c_extractor_functions_spec.rb +462 -21
  419. data/spec/units/c_extractor/c_extractor_preprocessing_spec.rb +39 -0
  420. data/spec/units/c_extractor/c_extractor_spec.rb +4 -4
  421. data/spec/units/c_extractor/c_extractor_types_spec.rb +163 -0
  422. data/spec/units/c_identifier_spec.rb +35 -0
  423. data/spec/units/config/build_root_policy_spec.rb +61 -0
  424. data/spec/units/config/configurator_builder_spec.rb +61 -6
  425. data/spec/units/config/configurator_paths_validator_spec.rb +292 -0
  426. data/spec/units/config/configurator_setup_spec.rb +80 -68
  427. data/spec/units/config/configurator_spec.rb +54 -6
  428. data/spec/units/config/configurator_validator_spec.rb +1 -172
  429. data/spec/units/dependencies/dependency_cache_store_spec.rb +98 -2
  430. data/spec/units/dependencies/dependency_debug_tree_spec.rb +1 -1
  431. data/spec/units/dependencies/dependency_hasher_spec.rb +42 -1
  432. data/spec/units/dependencies/dependency_path_normalizer_spec.rb +1 -1
  433. data/spec/units/dependencies/dependency_tracker_spec.rb +28 -1
  434. data/spec/units/dependencies/dependinator_spec.rb +17 -2
  435. data/spec/units/diagnostics/build_step_doctor_spec.rb +170 -0
  436. data/spec/units/diagnostics/duplicate_symbol_specialist_spec.rb +117 -0
  437. data/spec/units/diagnostics/header_collision_specialist_spec.rb +267 -0
  438. data/spec/units/diagnostics/include_depth_specialist_spec.rb +137 -0
  439. data/spec/units/diagnostics/missing_symbol_specialist_spec.rb +154 -0
  440. data/spec/units/diagnostics/partial_name_specialist_spec.rb +129 -0
  441. data/spec/units/diagnostics/toolchain_output_spec.rb +86 -0
  442. data/spec/units/encodinator_spec.rb +3 -4
  443. data/spec/units/filename_extension_spec.rb +11 -0
  444. data/spec/units/filesystem/build_roots_spec.rb +131 -0
  445. data/spec/units/filesystem/build_subpath_spec.rb +235 -0
  446. data/spec/units/filesystem/destination_collision_spec.rb +30 -0
  447. data/spec/units/{file_finder_helper_spec.rb → filesystem/file_finder_helper_spec.rb} +126 -1
  448. data/spec/units/filesystem/file_finder_spec.rb +845 -0
  449. data/spec/units/{file_path_collection_utils_spec.rb → filesystem/file_path_collection_utils_spec.rb} +181 -1
  450. data/spec/units/{file_path_utils_spec.rb → filesystem/file_path_utils_spec.rb} +435 -185
  451. data/spec/units/filesystem/file_system_wrapper_spec.rb +33 -0
  452. data/spec/units/filesystem/file_tree_spec.rb +511 -0
  453. data/spec/units/filesystem/file_tree_windows_spec.rb +78 -0
  454. data/spec/units/{file_wrapper_spec.rb → filesystem/file_wrapper_spec.rb} +286 -18
  455. data/spec/units/{path_matcher_spec.rb → filesystem/path_matcher_spec.rb} +48 -1
  456. data/spec/units/{path_mirror_spec.rb → filesystem/path_mirror_spec.rb} +32 -4
  457. data/spec/units/filesystem/project_paths_spec.rb +147 -0
  458. data/spec/units/filesystem/test_build_layout_spec.rb +216 -0
  459. data/spec/units/filesystem/win_long_paths_spec.rb +204 -0
  460. data/spec/units/filesystem/win_path_prober_spec.rb +158 -0
  461. data/spec/units/filesystem/working_dir_spec.rb +71 -0
  462. data/spec/units/generators/generator_helper_spec.rb +0 -60
  463. data/spec/units/generators/generator_mocks_spec.rb +13 -0
  464. data/spec/units/generators/generator_partials_spec.rb +656 -55
  465. data/spec/units/generators/generator_spec.rb +38 -6
  466. data/spec/units/generators/generator_test_results_backtrace_spec.rb +50 -46
  467. data/spec/units/generators/generator_test_results_spec.rb +1 -1
  468. data/spec/units/generators/generator_test_runner_spec.rb +9 -5
  469. data/spec/units/generators/partial_source_writer_spec.rb +129 -0
  470. data/spec/units/handoff_spec.rb +205 -0
  471. data/spec/units/includes/header_search_spec.rb +406 -0
  472. data/spec/units/includes/include_factory_spec.rb +23 -6
  473. data/spec/units/includes/include_pathinator_spec.rb +118 -8
  474. data/spec/units/includes/include_spec.rb +14 -0
  475. data/spec/units/includes/includes_spec.rb +176 -19
  476. data/spec/units/installation_spec.rb +228 -0
  477. data/spec/units/library_resolver_spec.rb +157 -0
  478. data/spec/units/loginator_spec.rb +31 -0
  479. data/spec/units/mock_locator_spec.rb +275 -6
  480. data/spec/units/partials/include_groups_spec.rb +42 -0
  481. data/spec/units/partials/partializer_config_spec.rb +32 -0
  482. data/spec/units/partials/partializer_helper_carry_spec.rb +661 -0
  483. data/spec/units/partials/partializer_helper_interface_extras_spec.rb +396 -0
  484. data/spec/units/partials/partializer_helper_spec.rb +529 -277
  485. data/spec/units/partials/partializer_reconciler_spec.rb +661 -0
  486. data/spec/units/partials/partializer_spec.rb +1579 -270
  487. data/spec/units/partials/partializer_utils_spec.rb +269 -232
  488. data/spec/units/partials/partials_rename_spec.rb +160 -0
  489. data/spec/units/partials_manager_spec.rb +561 -251
  490. data/spec/units/plugins/bullseye_spec.rb +49 -2
  491. data/spec/units/plugins/console_reportinator_spec.rb +73 -26
  492. data/spec/units/plugins/dependencies_spec.rb +33 -7
  493. data/spec/units/plugins/dependency_spec_spec.rb +17 -0
  494. data/spec/units/plugins/gcov_spec.rb +28 -3
  495. data/spec/units/plugins/gcovr_reportinator_spec.rb +19 -47
  496. data/spec/units/plugins/gcovr_thresholds_spec.rb +95 -0
  497. data/spec/units/plugins/module_generator_spec.rb +5 -5
  498. data/spec/units/plugins/report_build_warnings_log_spec.rb +3 -3
  499. data/spec/units/plugins/report_log_writer_plugin_spec.rb +10 -1
  500. data/spec/units/plugins/report_tests_raw_output_log_spec.rb +13 -2
  501. data/spec/units/plugins/report_tests_teamcity_stdout_spec.rb +77 -3
  502. data/spec/units/plugins/reportgenerator_reportinator_spec.rb +52 -4
  503. data/spec/units/plugins/sanitize_records_spec.rb +3 -1
  504. data/spec/units/plugins/sanitize_spec.rb +1 -1
  505. data/spec/units/plugins/valgrind_spec.rb +23 -8
  506. data/spec/units/preprocess/preprocessinator_code_finder_spec.rb +73 -10
  507. data/spec/units/preprocess/preprocessinator_comment_stripper_spec.rb +1 -1
  508. data/spec/units/preprocess/preprocessinator_file_assembler_spec.rb +125 -37
  509. data/spec/units/preprocess/preprocessinator_includes_handler_spec.rb +15 -0
  510. data/spec/units/preprocess/preprocessinator_reconstructor_spec.rb +197 -0
  511. data/spec/units/preprocess/preprocessinator_spec.rb +153 -95
  512. data/spec/units/rake_app/rakefile_component_resolver_spec.rb +21 -0
  513. data/spec/units/release_build_executor_spec.rb +53 -14
  514. data/spec/units/release_build_planner_spec.rb +15 -3
  515. data/spec/units/reportinator_spec.rb +5 -5
  516. data/spec/units/setupinator_spec.rb +51 -0
  517. data/spec/units/standin_headerinator_spec.rb +55 -9
  518. data/spec/units/test_build_executor_spec.rb +842 -166
  519. data/spec/units/test_build_planner_spec.rb +205 -15
  520. data/spec/units/test_build_setup_spec.rb +179 -30
  521. data/spec/units/test_context_extractor_spec.rb +36 -2
  522. data/spec/units/test_derived_search_paths_spec.rb +259 -0
  523. data/spec/units/test_file_preprocessinator_spec.rb +17 -1
  524. data/spec/units/test_includes_extractinator_spec.rb +61 -9
  525. data/spec/units/test_invoker/objects_wiring_spec.rb +24 -4
  526. data/spec/units/test_invoker/partial_files_preprocessinator_spec.rb +264 -0
  527. data/spec/units/test_invoker/test_substitutions_spec.rb +122 -0
  528. data/spec/units/test_invoker_spec.rb +14 -1
  529. data/spec/units/test_invoker_types_spec.rb +8 -7
  530. data/spec/units/test_pipeline_manager_spec.rb +54 -13
  531. data/spec/units/test_runner_generatinator_spec.rb +93 -1
  532. data/spec/units/test_search_paths_spec.rb +73 -5
  533. data/spec/units/test_source_file_directive_resolver_spec.rb +38 -7
  534. data/spec/units/tools/default_tools_quoting_spec.rb +117 -0
  535. data/spec/units/tools/shell_quoting_spec.rb +76 -0
  536. data/spec/units/{tool_executor_helper_spec.rb → tools/tool_executor_helper_spec.rb} +1 -1
  537. data/spec/units/{tool_executor_spec.rb → tools/tool_executor_spec.rb} +27 -1
  538. data/spec/units/{tool_validator_spec.rb → tools/tool_validator_spec.rb} +110 -1
  539. data/spec/units/windows_registry_query_tool_spec.rb +53 -0
  540. data/spec/units/yaml_wrapper_spec.rb +11 -0
  541. metadata +265 -36
  542. data/lib/ceedling/file_finder_helper.rb +0 -127
  543. data/lib/ceedling/file_path_collection_utils.rb +0 -164
  544. data/spec/units/file_finder_spec.rb +0 -495
  545. /data/lib/ceedling/{tool_executor_helper.rb → tools/tool_executor_helper.rb} +0 -0
@@ -0,0 +1,205 @@
1
+ # =========================================================================
2
+ # Ceedling - Test-Centered Build System for C
3
+ # ThrowTheSwitch.org
4
+ # Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
5
+ # SPDX-License-Identifier: MIT
6
+ # =========================================================================
7
+
8
+ require 'spec_helper'
9
+ require 'tmpdir'
10
+ require 'fileutils'
11
+ require 'rbconfig'
12
+ require 'ceedling/handoff'
13
+ require 'ceedling/constants'
14
+ require 'app_cfg'
15
+
16
+ describe Handoff do
17
+ def installation_with_version(root, version)
18
+ FileUtils.mkdir_p( File.join( root, 'lib' ) )
19
+ File.write( File.join( root, 'lib', 'version.rb' ), "module Ceedling; module Version; TAG = '#{version}'; end; end\n" )
20
+ return Installation.new( root )
21
+ end
22
+
23
+ describe '.take_markers' do
24
+ it 'removes both markers from the environment and returns them' do
25
+ env = {'CEEDLING_HANDOFF_LAUNCHER' => '/gem', 'CEEDLING_HANDOFF_TARGET' => '/app', 'OTHER' => 'x'}
26
+
27
+ expect(described_class.take_markers( env )).to eq( {launcher: '/gem', target: '/app'} )
28
+ expect(env).to eq( {'OTHER' => 'x'} )
29
+ end
30
+
31
+ it 'returns nil when this process was not handed off' do
32
+ expect(described_class.take_markers( {} )).to be_nil
33
+ end
34
+ end
35
+
36
+ describe '.received?' do
37
+ it 'is true when the markers name this installation as the target' do
38
+ Dir.mktmpdir do |root|
39
+ expect(described_class.received?( {launcher: '/gem', target: root + '/'}, own: Installation.new( root ) )).to be( true )
40
+ end
41
+ end
42
+
43
+ # GH #1365: markers an older target leaks to a nested launcher name someone else
44
+ it 'is false when the markers name another installation' do
45
+ Dir.mktmpdir do |root|
46
+ expect(described_class.received?( {launcher: '/gem', target: '/elsewhere'}, own: Installation.new( root ) )).to be( false )
47
+ end
48
+ end
49
+
50
+ it 'is false without markers' do
51
+ expect(described_class.received?( nil, own: Installation.new( '/gem' ) )).to be( false )
52
+ end
53
+ end
54
+
55
+ describe 'messages' do
56
+ it 'names both installations and their versions when handing off' do
57
+ Dir.mktmpdir do |dir|
58
+ launcher = installation_with_version( File.join( dir, 'gem' ), '1.2.2' )
59
+ target = installation_with_version( File.join( dir, 'app' ), '1.2.0' )
60
+
61
+ expect(described_class.handing_off_message( launcher: launcher, target: target )).to eq(
62
+ "Ceedling launcher 1.2.2 at #{launcher.root}/ is handing off to Ceedling 1.2.0 at #{target.root}/, which runs in its own process."
63
+ )
64
+ end
65
+ end
66
+
67
+ it 'names the launcher a handed-off process came from' do
68
+ Dir.mktmpdir do |dir|
69
+ own = installation_with_version( File.join( dir, 'app' ), '1.2.2' )
70
+ launcher = installation_with_version( File.join( dir, 'gem' ), '1.2.3' )
71
+
72
+ expect(described_class.received_message( {launcher: launcher.root, target: own.root}, own: own )).to eq(
73
+ "Ceedling 1.2.2 at #{own.root}/ is now running, launched from Ceedling 1.2.3 at #{launcher.root}/."
74
+ )
75
+ end
76
+ end
77
+ end
78
+
79
+ # GH #1365: a launcher before 1.2.2 always loads the application into its own process
80
+ describe '.complete_in_process' do
81
+ before(:each) do
82
+ # This repository's launcher stands in for an older one: its CeedlingAppConfig is
83
+ # defined beneath this repository's bin/, so any other application root is foreign
84
+ @app_cfg = CeedlingAppConfig.new
85
+ @launcher = Installation.new( @app_cfg[:launcher_root_path] )
86
+ @loginator = double('loginator').as_null_object
87
+ @system_wrapper = double('system_wrapper', get_cmdline: ['test:all', '-v', 'obnoxious'])
88
+ @handoff_objects = {loginator: @loginator, system_wrapper: @system_wrapper}
89
+ allow(described_class).to receive(:exec)
90
+ end
91
+
92
+ def complete(app_root, env: {})
93
+ described_class.complete_in_process( app_root: app_root, app_cfg: @app_cfg, handoff_objects: @handoff_objects, env: env )
94
+ end
95
+
96
+ it 'restarts a foreign launcher\'s application in its own process, with the original command line' do
97
+ Dir.mktmpdir do |root|
98
+ app = Installation.new( root )
99
+
100
+ expect(@loginator).to receive(:log).with(
101
+ "#{@launcher.describe( 'Ceedling launcher' )} loaded #{app.describe} into its own process. " +
102
+ "Restarting in #{app.name}'s own process. Upgrade Ceedling and review your installations to avoid this.",
103
+ Verbosity::COMPLAIN
104
+ ).ordered
105
+ expect(described_class).to receive(:exec).with(
106
+ target: app, launcher: @launcher, argv: ['test:all', '-v', 'obnoxious'], loginator: @loginator
107
+ ).ordered
108
+
109
+ complete( root )
110
+ end
111
+ end
112
+
113
+ it 'does nothing for the launcher\'s own application' do
114
+ complete( @launcher.root )
115
+
116
+ expect(described_class).to_not have_received(:exec)
117
+ expect(@loginator).to_not have_received(:log)
118
+ end
119
+
120
+ def expect_fallback(app)
121
+ expect(@loginator).to receive(:log).with(
122
+ "#{@launcher.describe( 'Ceedling launcher' )} loaded #{app.describe} into its own process. " +
123
+ "Continuing in the launcher's process, which can fail or misbehave. Upgrade Ceedling, or run this " +
124
+ "installation's own launcher directly with `ruby #{app.bin_path}`. A project created with `--local` has a " +
125
+ "launch script at its root that does this: run `./ceedling` from the project root (`.\\ceedling.cmd` on Windows).",
126
+ Verbosity::COMPLAIN
127
+ )
128
+ end
129
+
130
+ it 'warns and continues when the launcher kept no command line to restart with' do
131
+ Dir.mktmpdir do |root|
132
+ @handoff_objects[:system_wrapper] = double('old_system_wrapper')
133
+ expect_fallback( Installation.new( root ) )
134
+
135
+ complete( root )
136
+
137
+ expect(described_class).to_not have_received(:exec)
138
+ end
139
+ end
140
+
141
+ # A hand-off already happened in this chain; restarting again could cycle
142
+ it 'warns and continues when a launcher handed off to this process' do
143
+ Dir.mktmpdir do |root|
144
+ @app_cfg.set_handoff( {launcher: '/gem', target: @launcher.root} )
145
+ expect_fallback( Installation.new( root ) )
146
+
147
+ complete( root )
148
+
149
+ expect(described_class).to_not have_received(:exec)
150
+ end
151
+ end
152
+
153
+ it 'warns and continues when hand-off markers are still in the environment' do
154
+ Dir.mktmpdir do |root|
155
+ expect_fallback( Installation.new( root ) )
156
+
157
+ complete( root, env: {'CEEDLING_HANDOFF_TARGET' => '/somewhere'} )
158
+
159
+ expect(described_class).to_not have_received(:exec)
160
+ end
161
+ end
162
+
163
+ it 'names the launcher relative to the working directory when it lies beneath it' do
164
+ Dir.mktmpdir do |root|
165
+ Dir.chdir( root ) do
166
+ app = Installation.new( File.join( Dir.pwd, 'vendor', 'ceedling' ) )
167
+ @handoff_objects[:system_wrapper] = double('old_system_wrapper')
168
+
169
+ expect(@loginator).to receive(:log).with( /directly with `ruby vendor\/ceedling\/bin\/ceedling`/, Verbosity::COMPLAIN )
170
+
171
+ complete( app.root )
172
+ end
173
+ end
174
+ end
175
+ end
176
+
177
+ describe '.exec' do
178
+ before(:each) do
179
+ @loginator = double('loginator')
180
+ allow(@loginator).to receive(:wrapup)
181
+ allow(described_class).to receive(:replace_process)
182
+ end
183
+
184
+ it 'replaces this process with the target\'s own launcher, given the original command line and both markers' do
185
+ launcher = Installation.new( '/gem' )
186
+ target = Installation.new( '/app' )
187
+
188
+ described_class.exec( target: target, launcher: launcher, argv: ['test:all', '--mixin', '=:a: b c'], loginator: @loginator )
189
+
190
+ expect(described_class).to have_received(:replace_process).with(
191
+ {'CEEDLING_HANDOFF_LAUNCHER' => launcher.root, 'CEEDLING_HANDOFF_TARGET' => target.root},
192
+ RbConfig.ruby, target.bin_path, 'test:all', '--mixin', '=:a: b c'
193
+ )
194
+ end
195
+
196
+ it 'drains logging and flushes the standard streams before the process is replaced' do
197
+ expect(@loginator).to receive(:wrapup).ordered
198
+ expect($stdout).to receive(:flush).ordered
199
+ expect($stderr).to receive(:flush).ordered
200
+ expect(described_class).to receive(:replace_process).ordered
201
+
202
+ described_class.exec( target: Installation.new( '/app' ), launcher: Installation.new( '/gem' ), argv: [], loginator: @loginator )
203
+ end
204
+ end
205
+ end
@@ -0,0 +1,406 @@
1
+ # =========================================================================
2
+ # Ceedling - Test-Centered Build System for C
3
+ # ThrowTheSwitch.org
4
+ # Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
5
+ # SPDX-License-Identifier: MIT
6
+ # =========================================================================
7
+
8
+ require 'spec_helper'
9
+ require 'ceedling/includes/header_search'
10
+ require 'ceedling/includes/includes'
11
+
12
+ describe HeaderSearch do
13
+ # A directory tree's headers, listed as IncludePathinator lists a directory
14
+ def search(paths, tree, **options)
15
+ @listed = Hash.new( 0 )
16
+ lister = lambda do |dir|
17
+ @listed[dir] += 1
18
+ tree.select { |header| File.dirname( header ) == dir }.sort
19
+ end
20
+
21
+ return described_class.new( paths, lister, **options )
22
+ end
23
+
24
+ describe "#header_candidates" do
25
+ it "finds a bare name in the first search path holding it, the others after it" do
26
+ headers = search( ['inc', 'src'], ['src/foo.h', 'inc/foo.h', 'src/bar.h'] )
27
+
28
+ expect(headers.header_candidates( 'foo.h' )).to eq( ['inc/foo.h', 'src/foo.h'] )
29
+ end
30
+
31
+ it "finds a bare name exactly as a trailing match over every search path's listing does" do
32
+ tree = ['a/x.h', 'a/y.h', 'b/x.h', 'b/sub/x.h', 'c/z.h']
33
+ headers = search( ['b', 'a', 'c'], tree )
34
+ flat = ['b', 'a', 'c'].flat_map { |dir| tree.select { |header| File.dirname( header ) == dir }.sort }
35
+
36
+ %w[x.h y.h z.h w.h].each do |name|
37
+ expect(headers.header_candidates( name )).to eq( PathMatcher.candidates( name, flat ) )
38
+ end
39
+ end
40
+
41
+ it "joins each search path with the directory an #include names" do
42
+ headers = search( ['src'], ['src/drivers/foo.h'] )
43
+
44
+ expect(headers.header_candidates( 'drivers/foo.h' )).to eq( ['src/drivers/foo.h'] )
45
+ end
46
+
47
+ it "finds the same path below two search paths in search order" do
48
+ headers = search( ['b', 'a'], ['a/drivers/foo.h', 'b/drivers/foo.h'] )
49
+
50
+ expect(headers.header_candidates( 'drivers/foo.h' )).to eq( ['b/drivers/foo.h', 'a/drivers/foo.h'] )
51
+ end
52
+
53
+ it "prefers a join over a header whose trailing path matches" do
54
+ headers = search( ['lib/drivers', 'src'], ['lib/drivers/foo.h', 'src/drivers/foo.h'] )
55
+
56
+ expect(headers.header_candidates( 'drivers/foo.h' )).to eq( ['src/drivers/foo.h'] )
57
+ end
58
+
59
+ it "drops a leading ./ and empty segments from the #include" do
60
+ headers = search( ['src'], ['src/drivers/foo.h'] )
61
+
62
+ expect(headers.header_candidates( './drivers//foo.h' )).to eq( ['src/drivers/foo.h'] )
63
+ end
64
+
65
+ it "gives one header reached through two spellings of its directory once" do
66
+ headers = search( ['src', './src'], ['src/foo.h', './src/foo.h'] )
67
+
68
+ expect(headers.header_candidates( 'foo.h' )).to eq( ['src/foo.h'] )
69
+ end
70
+
71
+ it "keeps a filename that differs only in letter case out of the candidates" do
72
+ headers = search( ['src'], ['src/drivers/Foo.h'] )
73
+
74
+ expect(headers.header_candidates( 'drivers/foo.h' )).to eq( [] )
75
+ end
76
+
77
+ # A mock after stage 4 names its place below its mirror root, which need not be a
78
+ # search path
79
+ it "matches the trailing path of a header directly in a search path when no join reaches it" do
80
+ headers = search( ['test/support'], ['test/support/foo.h'] )
81
+
82
+ expect(headers.header_candidates( 'support/foo.h' )).to eq( ['test/support/foo.h'] )
83
+ end
84
+
85
+ # A plain #include after stage 4 carries the path GCC found it by
86
+ it "takes the #include's own path when it names a header below a search path" do
87
+ headers = search( ['src'], ['src/drivers/foo.h'] )
88
+
89
+ expect(headers.header_candidates( 'src/drivers/foo.h' )).to eq( ['src/drivers/foo.h'] )
90
+ end
91
+
92
+ it "takes an absolute path below a search path" do
93
+ headers = search( ['/opt/sdk'], ['/opt/sdk/drivers/foo.h'] )
94
+
95
+ expect(headers.header_candidates( '/opt/sdk/drivers/foo.h' )).to eq( ['/opt/sdk/drivers/foo.h'] )
96
+ end
97
+
98
+ # ProjectPaths expands both sides alike, so a drive-lettered path compares on any host
99
+ it "takes a path with a drive letter below a search path" do
100
+ headers = search( ['C:/sdk/inc'], ['C:/sdk/inc/drivers/x.h'] )
101
+
102
+ expect(headers.header_candidates( 'C:\\sdk\\inc\\drivers\\x.h' )).to eq( ['C:/sdk/inc/drivers/x.h'] )
103
+ end
104
+
105
+ it "finds no absolute path outside every search path" do
106
+ headers = search( ['src'], ['/opt/sdk/foo.h'] )
107
+
108
+ expect(headers.header_candidates( '/opt/sdk/foo.h' )).to eq( [] )
109
+ end
110
+
111
+ # The scan resolves `..` against the test file's own directory
112
+ it "never joins a search path with an #include that climbs" do
113
+ headers = search( ['src/a'], ['src/b/foo.h', 'src/a/foo.h'] )
114
+
115
+ expect(headers.header_candidates( '../b/foo.h' )).to eq( [] )
116
+ end
117
+
118
+ it "never reads a glob character in an #include's directory as a glob" do
119
+ headers = search( ['src', '.'], ['src/drivers/foo.h'] )
120
+
121
+ expect(headers.header_candidates( 'd*/foo.h' )).to eq( [] )
122
+ expect(@listed.keys).to_not include( a_string_including( '*' ) )
123
+ end
124
+
125
+ it "finds a header whose own name holds a glob character" do
126
+ expect(search( ['src'], ['src/a[1].h'] ).header_candidates( 'a[1].h' )).to eq( ['src/a[1].h'] )
127
+ end
128
+
129
+ it "finds nothing for a name no search path reaches" do
130
+ headers = search( ['src'], ['src/foo.h'] )
131
+
132
+ expect(headers.header_candidates( 'drivers/bar.h' )).to eq( [] )
133
+ end
134
+ end
135
+
136
+ describe "#refusal" do
137
+ it "explains a query by its own spelling, slashes and dot segments aside" do
138
+ headers = described_class.new( ['src'], ->(_dir) { [] }, refusals: { 'sys/socket.h' => 'why' } )
139
+
140
+ expect(headers.refusal( 'sys/socket.h' )).to eq( 'why' )
141
+ expect(headers.refusal( './sys\\socket.h' )).to eq( 'why' )
142
+ expect(headers.refusal( 'socket.h' )).to be_nil
143
+ end
144
+
145
+ it "explains nothing by default" do
146
+ expect(search( ['src'], [] ).refusal( 'socket.h' )).to be_nil
147
+ end
148
+ end
149
+
150
+ describe "#joins?" do
151
+ it "says whether a search path joined with the text names a header, as -I does" do
152
+ headers = search( ['src'], ['src/drivers/foo.h'] )
153
+
154
+ expect(headers.joins?( 'drivers/foo.h' )).to be( true )
155
+ expect(headers.joins?( 'src/drivers/foo.h' )).to be( false )
156
+ end
157
+ end
158
+
159
+ describe "#hint_files" do
160
+ it "holds every header the search looked at, so one in another letter case can be named" do
161
+ headers = search( ['inc', 'src'], ['inc/top.h', 'src/drivers/Foo.h'] )
162
+
163
+ expect(headers.hint_files( 'drivers/foo.h' )).to include( 'src/drivers/Foo.h', 'inc/top.h' )
164
+ end
165
+ end
166
+
167
+ describe "#spelling" do
168
+ it "spells a header by its filename when the search paths find it by that" do
169
+ expect(search( ['inc', 'src'], ['src/foo.h'] ).spelling( 'src/foo.h' )).to eq( 'foo.h' )
170
+ end
171
+
172
+ it "spells a header below a search path by its path below that search path" do
173
+ expect(search( ['src'], ['src/drivers/foo.h'] ).spelling( 'src/drivers/foo.h' )).to eq( 'drivers/foo.h' )
174
+ end
175
+
176
+ it "spells a header a same-named one shadows by its filename by its path below a search path" do
177
+ headers = search( ['src', 'src/drivers'], ['src/foo.h', 'src/drivers/foo.h'] )
178
+
179
+ expect(headers.spelling( 'src/drivers/foo.h' )).to eq( 'drivers/foo.h' )
180
+ end
181
+
182
+ it "gives nil for a header no search path reaches" do
183
+ expect(search( ['src'], ['other/foo.h'] ).spelling( 'other/foo.h' )).to be_nil
184
+ end
185
+
186
+ it "keeps a preferred text that finds the header first" do
187
+ headers = search( ['src', 'src/app', 'src/hw'], ['src/app/config.h', 'src/hw/config.h'] )
188
+
189
+ expect(headers.spelling( 'src/app/config.h', preferring: 'app/config.h' )).to eq( 'app/config.h' )
190
+ end
191
+
192
+ # The compiler only joins a text with each search path
193
+ it "passes over a preferred text the search paths reach only by its trailing path" do
194
+ headers = search( ['src/hw', 'lib'], ['src/hw/config.h', 'lib/app/config.h'] )
195
+
196
+ expect(headers.spelling( 'src/hw/config.h', preferring: 'hw/config.h' )).to eq( 'config.h' )
197
+ end
198
+
199
+ it "passes over a preferred text that finds another header" do
200
+ headers = search( ['src', 'src/app', 'src/hw'], ['src/app/config.h', 'src/hw/config.h'] )
201
+
202
+ expect(headers.spelling( 'src/hw/config.h', preferring: 'config.h' )).to eq( 'hw/config.h' )
203
+ end
204
+ end
205
+
206
+ describe "#at" do
207
+ it "gives the header a path names itself, whatever a search path joins that path to" do
208
+ headers = search( ['include', 'third_party/mylib'], ['include/config.h', 'third_party/mylib/include/config.h'] )
209
+
210
+ expect(headers.at( 'include/config.h' )).to eq( 'include/config.h' )
211
+ expect(headers.header_candidates( 'include/config.h' ).first).to eq( 'third_party/mylib/include/config.h' )
212
+ end
213
+
214
+ it "gives nil where no header lies at the path" do
215
+ expect(search( ['src'], ['src/foo.h'] ).at( 'src/bar.h' )).to be_nil
216
+ end
217
+ end
218
+
219
+ # A generated file writes a header's #include by the text that reaches it, and a Partial
220
+ # matches modules by the header the include names
221
+ describe "Include#spelled_by" do
222
+ it "spells a user #include as the search paths reach its header, and names that header" do
223
+ spelled = UserInclude.new( 'drivers/foo.h' ).spelled_by( search( ['src'], ['src/drivers/foo.h'] ) )
224
+
225
+ expect( [spelled.filepath, spelled.include_path, spelled.to_s] ).to eq( ['src/drivers/foo.h', 'drivers/foo.h', '#include "drivers/foo.h"'] )
226
+ end
227
+
228
+ it "keeps the filename where it reaches the same header" do
229
+ spelled = UserInclude.new( 'src/foo.h' ).spelled_by( search( ['src'], ['src/foo.h'] ) )
230
+
231
+ expect( [spelled.filepath, spelled.to_s] ).to eq( ['src/foo.h', '#include "foo.h"'] )
232
+ end
233
+
234
+ it "keeps an #include's anchoring" do
235
+ spelled = UserInclude.new( 'src/foo.h', directory_relative: true ).spelled_by( search( ['src'], ['src/foo.h'] ) )
236
+
237
+ expect( spelled.directory_relative? ).to be( true )
238
+ end
239
+
240
+ # A preprocessor's #include holds the path the compiler found its header by
241
+ it "names a resolved #include's own header, never one a later search path joins its path to" do
242
+ headers = search( ['include', 'third_party/mylib'], ['include/config.h', 'third_party/mylib/include/config.h'] )
243
+ spelled = UserInclude.new( 'include/config.h' ).spelled_by( headers, resolved: true )
244
+
245
+ expect( [spelled.filepath, spelled.to_s] ).to eq( ['include/config.h', '#include "config.h"'] )
246
+ end
247
+
248
+ # A list that was never resolved, or a path in another letter case, names no header itself
249
+ it "takes the search paths' header for a resolved #include with no header at its path" do
250
+ spelled = UserInclude.new( 'drivers/foo.h' ).spelled_by( search( ['src'], ['src/drivers/foo.h'] ), resolved: true )
251
+
252
+ expect( [spelled.filepath, spelled.to_s] ).to eq( ['src/drivers/foo.h', '#include "drivers/foo.h"'] )
253
+ end
254
+
255
+ it "leaves a resolved #include whose header no directory lists as it is" do
256
+ lost = UserInclude.new( 'gone/foo.h' )
257
+
258
+ expect( lost.spelled_by( search( ['src'], ['src/foo.h'] ), resolved: true ) ).to equal( lost )
259
+ end
260
+
261
+ # A header beside its includer, under no search path, is reached by none of its spellings
262
+ it "writes a resolved #include no spelling reaches by its header's absolute path" do
263
+ headers = search( ['src/hw', 'src'], ['src/hw/config.h', 'lib/config.h'] )
264
+ spelled = UserInclude.new( 'lib/config.h' ).spelled_by( headers, resolved: true )
265
+ absolute = "#{ProjectPaths.working_dir}/lib/config.h"
266
+
267
+ expect( [spelled.filepath, spelled.include_path, spelled.to_s] ).to eq( ['lib/config.h', absolute, "#include \"#{absolute}\""] )
268
+ end
269
+
270
+ it "keeps an #include's anchoring when it writes the header's absolute path" do
271
+ headers = search( ['src/hw'], ['src/hw/config.h', 'lib/config.h'] )
272
+ spelled = UserInclude.new( 'lib/config.h', directory_relative: true ).spelled_by( headers, resolved: true )
273
+
274
+ expect( [spelled.directory_relative?, spelled.include_path] ).to eq( [true, "#{ProjectPaths.working_dir}/lib/config.h"] )
275
+ end
276
+
277
+ it "writes a resolved #include a spelling reaches by that spelling, never by an absolute path" do
278
+ headers = search( ['src/hw', 'lib'], ['src/hw/config.h', 'lib/util.h'] )
279
+ spelled = UserInclude.new( 'lib/util.h' ).spelled_by( headers, resolved: true )
280
+
281
+ expect( [spelled.filepath, spelled.to_s] ).to eq( ['lib/util.h', '#include "util.h"'] )
282
+ end
283
+
284
+ it "writes an #include as written by its header's absolute path where the header is beside its includer and no search path finds one of that name" do
285
+ headers = search( ['src/hw'], ['src/hw/other.h', 'lib/config.h'] )
286
+ spelled = UserInclude.new( 'config.h' ).spelled_by( headers, from: 'lib' )
287
+ absolute = "#{ProjectPaths.working_dir}/lib/config.h"
288
+
289
+ expect( [spelled.filepath, spelled.include_path] ).to eq( ['lib/config.h', absolute] )
290
+ end
291
+
292
+ # A generated directory is on the compiler's search paths, though a test's header search
293
+ # leaves it out, so the compiler reaches a header there by the text it already has
294
+ it "keeps the text of a resolved #include whose header lies in the build root and no search path reaches" do
295
+ headers = search( ['src'], ['src/foo.h', 'build/test/partials/test_foo/ceedling_partial_foo_impl.h'], build_root: 'build' )
296
+ include = UserInclude.new( 'build/test/partials/test_foo/ceedling_partial_foo_impl.h' )
297
+
298
+ expect( include.spelled_by( headers, resolved: true ) ).to equal( include )
299
+ end
300
+
301
+ it "writes a resolved #include whose header lies outside the build root and no search path reaches by its absolute path" do
302
+ headers = search( ['src'], ['src/foo.h', 'builds/foo/config.h'], build_root: 'build' )
303
+ spelled = UserInclude.new( 'builds/foo/config.h' ).spelled_by( headers, resolved: true )
304
+
305
+ expect( spelled.include_path ).to eq( "#{ProjectPaths.working_dir}/builds/foo/config.h" )
306
+ end
307
+
308
+ it "spells a header in the build root by a spelling that reaches it" do
309
+ headers = search( ['build/test/mocks', 'src'], ['build/test/mocks/mock_foo.h'], build_root: 'build' )
310
+ spelled = UserInclude.new( 'build/test/mocks/mock_foo.h' ).spelled_by( headers, resolved: true )
311
+
312
+ expect( spelled.to_s ).to eq( '#include "mock_foo.h"' )
313
+ end
314
+
315
+ # Reconciliation spells two same-named headers apart, which a shorter text could undo
316
+ it "keeps the text an #include has where that text reaches its header" do
317
+ headers = search( ['src', 'src/app', 'src/hw'], ['src/app/config.h', 'src/hw/config.h'] )
318
+ spelled = UserInclude.new( 'src/app/config.h', include_path: 'app/config.h' ).spelled_by( headers, resolved: true )
319
+
320
+ expect( [spelled.filepath, spelled.to_s] ).to eq( ['src/app/config.h', '#include "app/config.h"'] )
321
+ end
322
+
323
+ # A text scan's #include holds the text as written, which the compiler looks for beside the
324
+ # file holding it before any search path
325
+ it "names the header beside its includer first for an #include as written" do
326
+ headers = search( ['src', 'src/drivers/uart'], ['src/config.h', 'src/drivers/uart/config.h'] )
327
+ spelled = UserInclude.new( 'config.h' ).spelled_by( headers, from: 'src/drivers/uart' )
328
+
329
+ expect( [spelled.filepath, spelled.to_s] ).to eq( ['src/drivers/uart/config.h', '#include "drivers/uart/config.h"'] )
330
+ end
331
+
332
+ it "takes the search paths' header for an #include as written with no header beside its includer" do
333
+ headers = search( ['src', 'src/drivers/uart'], ['src/config.h', 'src/drivers/uart/config.h'] )
334
+ spelled = UserInclude.new( 'config.h' ).spelled_by( headers, from: 'src/drivers' )
335
+
336
+ expect( [spelled.filepath, spelled.to_s] ).to eq( ['src/config.h', '#include "config.h"'] )
337
+ end
338
+
339
+ # The compiler finds a header beside the includer by the quote rule, which a generated file's
340
+ # own directory doesn't share, so a search path's header of the same name is another header
341
+ it "writes an #include as written by the absolute path of the header beside its includer where no search path reaches it" do
342
+ headers = search( ['src'], ['src/drivers/foo.h', 'test/drivers/foo.h'] )
343
+ spelled = UserInclude.new( 'drivers/foo.h' ).spelled_by( headers, from: 'test' )
344
+ absolute = "#{ProjectPaths.working_dir}/test/drivers/foo.h"
345
+
346
+ expect( [spelled.filepath, spelled.include_path, spelled.to_s] ).to eq( ['test/drivers/foo.h', absolute, "#include \"#{absolute}\""] )
347
+ end
348
+
349
+ it "keeps an anchored #include's anchoring when it writes the absolute path of the header beside its includer" do
350
+ headers = search( ['src'], ['src/drivers/foo.h', 'test/drivers/foo.h'] )
351
+ spelled = UserInclude.new( 'test/drivers/foo.h', directory_relative: true ).spelled_by( headers, from: 'test' )
352
+
353
+ expect( [spelled.directory_relative?, spelled.include_path] ).to eq( [true, "#{ProjectPaths.working_dir}/test/drivers/foo.h"] )
354
+ end
355
+
356
+ it "spells an #include as written by the search paths' header when none is beside its includer" do
357
+ headers = search( ['src'], ['src/drivers/foo.h'] )
358
+ spelled = UserInclude.new( 'drivers/foo.h' ).spelled_by( headers, from: 'test' )
359
+
360
+ expect( [spelled.filepath, spelled.to_s] ).to eq( ['src/drivers/foo.h', '#include "drivers/foo.h"'] )
361
+ end
362
+
363
+ it "spells an #include as written by the spelling that reaches the header beside its includer" do
364
+ headers = search( ['test', 'src'], ['src/drivers/foo.h', 'test/drivers/foo.h'] )
365
+ spelled = UserInclude.new( 'drivers/foo.h' ).spelled_by( headers, from: 'test' )
366
+
367
+ expect( [spelled.filepath, spelled.to_s] ).to eq( ['test/drivers/foo.h', '#include "drivers/foo.h"'] )
368
+ end
369
+
370
+ it "takes an anchored #include's own header, never one beside its includer" do
371
+ headers = search( ['src'], ['src/common/helper.h', 'src/x/common/helper.h'] )
372
+ spelled = UserInclude.new( 'src/common/helper.h', directory_relative: true ).spelled_by( headers, from: 'src/x' )
373
+
374
+ expect( spelled.filepath ).to eq( 'src/common/helper.h' )
375
+ end
376
+
377
+ it "leaves a system #include, a mock's, and one whose header it can't find as they are" do
378
+ headers = search( ['src'], ['src/foo.h'] )
379
+ system = SystemInclude.new( 'stdint.h' )
380
+ mock = MockInclude.new( 'mock_foo.h' )
381
+ lost = UserInclude.new( 'gone.h' )
382
+
383
+ expect( [system, mock, lost].map { |include| include.spelled_by( headers ) } ).to eq( [system, mock, lost] )
384
+ expect( lost.spelled_by( headers ) ).to equal( lost )
385
+ end
386
+ end
387
+
388
+ describe "#flat" do
389
+ it "lists every header directly in a search path, in search order" do
390
+ headers = search( ['src', 'inc'], ['inc/a.h', 'src/b.h', 'src/sub/c.h'] )
391
+
392
+ expect(headers.flat).to eq( ['src/b.h', 'inc/a.h'] )
393
+ end
394
+ end
395
+
396
+ it "lists each directory once however many lookups ask" do
397
+ headers = search( ['src'], ['src/drivers/foo.h', 'src/top.h'] )
398
+
399
+ 3.times do
400
+ headers.header_candidates( 'drivers/foo.h' )
401
+ headers.header_candidates( 'top.h' )
402
+ end
403
+
404
+ expect(@listed).to eq( { 'src/drivers' => 1, 'src' => 1 } )
405
+ end
406
+ end