ceedling 1.2.1 → 1.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (545) hide show
  1. checksums.yaml +4 -4
  2. data/GIT_COMMIT_SHA +1 -1
  3. data/README.md +11 -9
  4. data/Rakefile +2 -1
  5. data/assets/features/ceedling +1 -1
  6. data/assets/fixtures/test_source_file_duplicate_basenames/test_calc_typo.c +14 -0
  7. data/assets/fixtures/tests_with_duplicate_test_names/test_foo.c +21 -0
  8. data/assets/fixtures/tests_with_partials_coverage/src/private_macro.c +7 -0
  9. data/assets/fixtures/tests_with_partials_coverage/src/private_macro.h +5 -0
  10. data/assets/fixtures/tests_with_partials_coverage/src/tally.c +13 -0
  11. data/assets/fixtures/tests_with_partials_coverage/src/tally.h +4 -0
  12. data/assets/fixtures/tests_with_partials_coverage/test/test_private_macro.c +10 -0
  13. data/assets/fixtures/tests_with_partials_coverage/test/test_tally.c +9 -0
  14. data/bin/actionator.rb +6 -12
  15. data/bin/app_cfg.rb +14 -1
  16. data/bin/ceedling +13 -3
  17. data/bin/cli.rb +25 -6
  18. data/bin/cli_handler.rb +113 -73
  19. data/bin/cli_helper.rb +51 -78
  20. data/bin/installation_selector.rb +81 -0
  21. data/bin/launchinator.rb +69 -0
  22. data/bin/mixin_resolvinator.rb +26 -36
  23. data/bin/objects.yml +13 -0
  24. data/bin/path_validator.rb +25 -29
  25. data/bin/versionator.rb +47 -48
  26. data/ceedling.gemspec +19 -15
  27. data/docs/BreakingChanges.md +86 -1
  28. data/docs/Changelog.md +145 -3
  29. data/docs/KnownIssues.md +179 -6
  30. data/docs/ReleaseNotes.md +13 -0
  31. data/examples/wondrous_forest/README.md +29 -1
  32. data/examples/wondrous_forest/src/ForestUnits.h +23 -0
  33. data/examples/wondrous_forest/src/RainGauge.c +59 -0
  34. data/examples/wondrous_forest/src/RainGauge.h +39 -0
  35. data/examples/wondrous_forest/src/RainTipIsr.c +17 -0
  36. data/examples/wondrous_forest/src/RainTipIsr.h +14 -0
  37. data/examples/wondrous_forest/test/TestRainGauge.c +126 -0
  38. data/lib/ceedling/build_log_writer.rb +33 -0
  39. data/lib/ceedling/c_extractor/README.md +15 -7
  40. data/lib/ceedling/c_extractor/c_extractor.rb +25 -14
  41. data/lib/ceedling/c_extractor/c_extractor_code_text.rb +84 -54
  42. data/lib/ceedling/c_extractor/c_extractor_constants.rb +18 -7
  43. data/lib/ceedling/c_extractor/c_extractor_declarations.rb +319 -283
  44. data/lib/ceedling/c_extractor/c_extractor_declarator.rb +285 -0
  45. data/lib/ceedling/c_extractor/c_extractor_defined_type.rb +111 -0
  46. data/lib/ceedling/c_extractor/c_extractor_definitions.rb +174 -121
  47. data/lib/ceedling/c_extractor/c_extractor_functions.rb +191 -162
  48. data/lib/ceedling/c_extractor/c_extractor_preprocessing.rb +46 -55
  49. data/lib/ceedling/c_extractor/c_extractor_statement.rb +30 -0
  50. data/lib/ceedling/c_extractor/c_extractor_types.rb +63 -41
  51. data/lib/ceedling/c_extractor/c_module_edits.rb +48 -0
  52. data/lib/ceedling/c_identifier.rb +21 -0
  53. data/lib/ceedling/ceedling.h +8 -0
  54. data/lib/ceedling/config/build_root_policy.rb +70 -0
  55. data/lib/ceedling/config/configurator.rb +18 -19
  56. data/lib/ceedling/config/configurator_builder.rb +75 -28
  57. data/lib/ceedling/config/configurator_paths_validator.rb +179 -0
  58. data/lib/ceedling/config/configurator_plugins.rb +1 -1
  59. data/lib/ceedling/config/configurator_setup.rb +44 -33
  60. data/lib/ceedling/config/configurator_validator.rb +1 -110
  61. data/lib/ceedling/constants.rb +5 -1
  62. data/lib/ceedling/defaults.rb +35 -5
  63. data/lib/ceedling/dependencies/CACHE_SCHEMA.md +118 -0
  64. data/lib/ceedling/dependencies/README.md +18 -16
  65. data/lib/ceedling/dependencies/dependency_cache_store.rb +43 -21
  66. data/lib/ceedling/dependencies/dependency_hasher.rb +35 -1
  67. data/lib/ceedling/dependencies/dependency_tracker.rb +9 -3
  68. data/lib/ceedling/dependencies/dependinator.rb +13 -1
  69. data/lib/ceedling/diagnostics/DOCTOR.md +142 -0
  70. data/lib/ceedling/diagnostics/README.md +5 -0
  71. data/lib/ceedling/diagnostics/build_step_doctor.rb +110 -0
  72. data/lib/ceedling/diagnostics/duplicate_symbol_specialist.rb +108 -0
  73. data/lib/ceedling/diagnostics/guidance_phrases.rb +30 -0
  74. data/lib/ceedling/diagnostics/header_collision_guidance.rb +56 -0
  75. data/lib/ceedling/diagnostics/header_collision_specialist.rb +152 -0
  76. data/lib/ceedling/diagnostics/include_depth_specialist.rb +132 -0
  77. data/lib/ceedling/diagnostics/missing_symbol_specialist.rb +111 -0
  78. data/lib/ceedling/diagnostics/partial_name_specialist.rb +134 -0
  79. data/lib/ceedling/diagnostics/toolchain_output.rb +44 -0
  80. data/lib/ceedling/filename_extension.rb +7 -1
  81. data/lib/ceedling/filesystem/FILE_TREE.md +253 -0
  82. data/lib/ceedling/filesystem/PATH_HANDLING.md +360 -0
  83. data/lib/ceedling/filesystem/README.md +46 -0
  84. data/lib/ceedling/filesystem/build_roots.rb +105 -0
  85. data/lib/ceedling/filesystem/build_subpath.rb +187 -0
  86. data/lib/ceedling/filesystem/destination_collision.rb +25 -0
  87. data/lib/ceedling/{file_finder.rb → filesystem/file_finder.rb} +177 -156
  88. data/lib/ceedling/filesystem/file_finder_helper.rb +154 -0
  89. data/lib/ceedling/filesystem/file_path_collection_utils.rb +183 -0
  90. data/lib/ceedling/{file_path_utils.rb → filesystem/file_path_utils.rb} +200 -167
  91. data/lib/ceedling/{file_system_wrapper.rb → filesystem/file_system_wrapper.rb} +6 -5
  92. data/lib/ceedling/filesystem/file_tree.rb +241 -0
  93. data/lib/ceedling/{file_wrapper.rb → filesystem/file_wrapper.rb} +149 -65
  94. data/lib/ceedling/filesystem/path_exclusions.rb +30 -0
  95. data/lib/ceedling/{path_matcher.rb → filesystem/path_matcher.rb} +48 -23
  96. data/lib/ceedling/{path_mirror.rb → filesystem/path_mirror.rb} +19 -18
  97. data/lib/ceedling/filesystem/path_spellings.rb +55 -0
  98. data/lib/ceedling/filesystem/project_paths.rb +184 -0
  99. data/lib/ceedling/filesystem/test_build_layout.rb +114 -0
  100. data/lib/ceedling/filesystem/win_long_paths.rb +153 -0
  101. data/lib/ceedling/filesystem/win_path_limit.rb +83 -0
  102. data/lib/ceedling/filesystem/win_path_prober.rb +52 -0
  103. data/lib/ceedling/filesystem/working_dir.rb +40 -0
  104. data/lib/ceedling/generators/generator.rb +32 -70
  105. data/lib/ceedling/generators/generator_helper.rb +0 -44
  106. data/lib/ceedling/generators/generator_mocks.rb +5 -0
  107. data/lib/ceedling/generators/generator_partials.rb +306 -244
  108. data/lib/ceedling/generators/generator_test_results_backtrace.rb +7 -7
  109. data/lib/ceedling/generators/generator_test_runner.rb +5 -8
  110. data/lib/ceedling/generators/partial_header_writer.rb +95 -0
  111. data/lib/ceedling/generators/partial_source_writer.rb +137 -0
  112. data/lib/ceedling/handoff.rb +121 -0
  113. data/lib/ceedling/includes/header_search.rb +225 -0
  114. data/lib/ceedling/includes/include_factory.rb +9 -12
  115. data/lib/ceedling/includes/include_pathinator.rb +112 -33
  116. data/lib/ceedling/includes/includes.rb +150 -38
  117. data/lib/ceedling/installation.rb +92 -0
  118. data/lib/ceedling/library_resolver.rb +99 -0
  119. data/lib/ceedling/objects.yml +112 -6
  120. data/lib/ceedling/partials/README.md +110 -16
  121. data/lib/ceedling/partials/carry_plan.rb +71 -0
  122. data/lib/ceedling/partials/definition_head.rb +74 -0
  123. data/lib/ceedling/partials/include_groups.rb +37 -0
  124. data/lib/ceedling/partials/interface_extras.rb +25 -0
  125. data/lib/ceedling/partials/partializer.rb +603 -124
  126. data/lib/ceedling/partials/partializer_config.rb +8 -1
  127. data/lib/ceedling/partials/partializer_helper.rb +851 -145
  128. data/lib/ceedling/partials/partializer_reconciler.rb +174 -0
  129. data/lib/ceedling/partials/partializer_utils.rb +89 -109
  130. data/lib/ceedling/partials/partials.rb +153 -10
  131. data/lib/ceedling/partials/type_macros.rb +126 -0
  132. data/lib/ceedling/plugins/report_log_writer_plugin.rb +3 -5
  133. data/lib/ceedling/preprocess/README.md +43 -33
  134. data/lib/ceedling/preprocess/preprocessinator.rb +100 -186
  135. data/lib/ceedling/preprocess/preprocessinator_code_finder.rb +65 -72
  136. data/lib/ceedling/preprocess/preprocessinator_file_assembler.rb +32 -76
  137. data/lib/ceedling/preprocess/preprocessinator_includes_handler.rb +1 -1
  138. data/lib/ceedling/preprocess/preprocessinator_line_marker_includes_extractor.rb +1 -1
  139. data/lib/ceedling/preprocess/preprocessinator_reconstructor.rb +51 -14
  140. data/lib/ceedling/rake_app/rakefile_component_resolver.rb +10 -17
  141. data/lib/ceedling/rakefile.rb +15 -1
  142. data/lib/ceedling/rakefiles/base/tasks_base.rake +1 -1
  143. data/lib/ceedling/rakefiles/release/rules_release.rake +4 -7
  144. data/lib/ceedling/release_invoker/release_build_executor.rb +33 -44
  145. data/lib/ceedling/release_invoker/release_build_planner.rb +14 -6
  146. data/lib/ceedling/reportinator.rb +3 -4
  147. data/lib/ceedling/setupinator.rb +104 -87
  148. data/lib/ceedling/test_context_extractor.rb +5 -1
  149. data/lib/ceedling/test_invoker/HEADER_COLLISIONS.md +21 -7
  150. data/lib/ceedling/test_invoker/PIPELINE.md +62 -19
  151. data/lib/ceedling/test_invoker/README.md +1 -1
  152. data/lib/ceedling/test_invoker/derived_search_path_notices.rb +45 -0
  153. data/lib/ceedling/test_invoker/mock_locator.rb +175 -10
  154. data/lib/ceedling/test_invoker/partial_files_preprocessinator.rb +181 -0
  155. data/lib/ceedling/test_invoker/partials_manager.rb +271 -302
  156. data/lib/ceedling/test_invoker/standin_headerinator.rb +19 -17
  157. data/lib/ceedling/test_invoker/test_bare_includes_extractinator.rb +26 -3
  158. data/lib/ceedling/test_invoker/test_build_executor.rb +358 -234
  159. data/lib/ceedling/test_invoker/test_build_planner.rb +46 -33
  160. data/lib/ceedling/test_invoker/test_build_setup.rb +43 -18
  161. data/lib/ceedling/test_invoker/test_build_validations.rb +35 -47
  162. data/lib/ceedling/test_invoker/test_derived_search_paths.rb +189 -0
  163. data/lib/ceedling/test_invoker/test_file_preprocessinator.rb +2 -3
  164. data/lib/ceedling/test_invoker/test_includes_reconcilinator.rb +1 -1
  165. data/lib/ceedling/test_invoker/test_invoker.rb +6 -1
  166. data/lib/ceedling/test_invoker/test_invoker_types.rb +28 -20
  167. data/lib/ceedling/test_invoker/test_pipeline_helpers.rb +6 -4
  168. data/lib/ceedling/test_invoker/test_pipeline_manager.rb +25 -8
  169. data/lib/ceedling/test_invoker/test_runner_generatinator.rb +31 -3
  170. data/lib/ceedling/test_invoker/test_search_paths.rb +30 -8
  171. data/lib/ceedling/test_invoker/test_source_file_directive_resolver.rb +40 -20
  172. data/lib/ceedling/test_invoker/test_substitutions.rb +72 -0
  173. data/lib/ceedling/tools/shell_quoting.rb +45 -0
  174. data/lib/ceedling/{tool_executor.rb → tools/tool_executor.rb} +9 -3
  175. data/lib/ceedling/tools/tool_quoting.rb +79 -0
  176. data/lib/ceedling/{tool_validator.rb → tools/tool_validator.rb} +18 -7
  177. data/lib/ceedling/yaml_wrapper.rb +3 -2
  178. data/lib/version.rb +1 -1
  179. data/plugins/bullseye/bullseye.rake +1 -3
  180. data/plugins/bullseye/config/defaults_bullseye.rb +1 -1
  181. data/plugins/bullseye/lib/bullseye.rb +24 -9
  182. data/plugins/command_hooks/lib/command_hooks.rb +1 -1
  183. data/plugins/cppcheck/config/defaults_cppcheck.rb +1 -1
  184. data/plugins/dependencies/config/defaults.yml +6 -6
  185. data/plugins/dependencies/dependencies.rake +4 -1
  186. data/plugins/dependencies/lib/dependencies.rb +18 -8
  187. data/plugins/dependencies/lib/dependency_spec.rb +17 -5
  188. data/plugins/fff/lib/fff.rb +79 -46
  189. data/plugins/fff/lib/fff_mock_generator.rb +12 -9
  190. data/plugins/fff/spec/fff_cmock_wrapper_spec.rb +262 -0
  191. data/plugins/fff/spec/fff_mock_header_generator_spec.rb +9 -0
  192. data/plugins/fff/spec/fff_mock_source_generator_spec.rb +20 -0
  193. data/plugins/gcov/config/defaults_gcov.rb +1 -1
  194. data/plugins/gcov/lib/console_reportinator.rb +28 -36
  195. data/plugins/gcov/lib/gcov.rb +9 -2
  196. data/plugins/gcov/lib/gcovr_reportinator.rb +8 -40
  197. data/plugins/gcov/lib/gcovr_thresholds.rb +74 -0
  198. data/plugins/gcov/lib/reportgenerator_reportinator.rb +3 -2
  199. data/plugins/module_generator/lib/module_generator.rb +3 -3
  200. data/plugins/report_tests_teamcity_stdout/lib/report_tests_teamcity_stdout.rb +53 -80
  201. data/plugins/sanitize/lib/sanitize_records.rb +3 -6
  202. data/plugins/valgrind/lib/valgrind.rb +14 -7
  203. data/site-local/404.html +2 -2
  204. data/site-local/assets/javascripts/{bundle.c21346df.min.js → bundle.a5f9d56c.min.js} +1 -1
  205. data/site-local/assets/javascripts/{bundle.c21346df.min.js.map → bundle.a5f9d56c.min.js.map} +2 -2
  206. data/site-local/configuration/environment-vars.html +2 -2
  207. data/site-local/configuration/global-collections.html +3 -3
  208. data/site-local/configuration/index.html +2 -2
  209. data/site-local/configuration/loading.html +2 -2
  210. data/site-local/configuration/mixins.html +2 -2
  211. data/site-local/configuration/parallel-builds.html +2 -2
  212. data/site-local/configuration/project-file.html +2 -2
  213. data/site-local/configuration/reference/cexception.html +2 -2
  214. data/site-local/configuration/reference/cmock.html +7 -3
  215. data/site-local/configuration/reference/defines.html +2 -2
  216. data/site-local/configuration/reference/environment.html +2 -2
  217. data/site-local/configuration/reference/extension.html +2 -2
  218. data/site-local/configuration/reference/files.html +65 -12
  219. data/site-local/configuration/reference/flags.html +2 -2
  220. data/site-local/configuration/reference/index.html +2 -2
  221. data/site-local/configuration/reference/libraries.html +23 -5
  222. data/site-local/configuration/reference/mixins.html +2 -2
  223. data/site-local/configuration/reference/partials.html +84 -2
  224. data/site-local/configuration/reference/paths.html +36 -8
  225. data/site-local/configuration/reference/plugins.html +2 -2
  226. data/site-local/configuration/reference/project.html +264 -12
  227. data/site-local/configuration/reference/release-build.html +4 -2
  228. data/site-local/configuration/reference/test-build.html +2 -2
  229. data/site-local/configuration/reference/test-runner.html +2 -2
  230. data/site-local/configuration/reference/tools.html +58 -4
  231. data/site-local/configuration/reference/unity.html +2 -2
  232. data/site-local/configuration/which-ceedling.html +379 -19
  233. data/site-local/development/index.html +2 -2
  234. data/site-local/development/plugins/configuration.html +2 -2
  235. data/site-local/development/plugins/index.html +2 -2
  236. data/site-local/development/plugins/plugin-subclass.html +5 -4
  237. data/site-local/development/plugins/rake-tasks.html +2 -2
  238. data/site-local/development/releases.html +7 -3
  239. data/site-local/development/workflow.html +50 -45
  240. data/site-local/getting-started/builds.html +4 -2
  241. data/site-local/getting-started/command-line.html +58 -6
  242. data/site-local/getting-started/example-projects/cipher-quest.html +2 -2
  243. data/site-local/getting-started/example-projects/index.html +2 -2
  244. data/site-local/getting-started/example-projects/temp-sensor.html +2 -2
  245. data/site-local/getting-started/example-projects/wondrous-forest.html +10 -2
  246. data/site-local/getting-started/index.html +2 -2
  247. data/site-local/getting-started/installation.html +2 -2
  248. data/site-local/getting-started/quick-start.html +2 -2
  249. data/site-local/help.html +2 -2
  250. data/site-local/index.html +2 -2
  251. data/site-local/overview/build-system.html +2 -2
  252. data/site-local/overview/index.html +2 -2
  253. data/site-local/overview/test-environments.html +2 -2
  254. data/site-local/overview/tools-and-frameworks.html +2 -2
  255. data/site-local/plugins/beep.html +2 -2
  256. data/site-local/plugins/bullseye/index.html +45 -38
  257. data/site-local/plugins/bullseye/licensing.html +2 -2
  258. data/site-local/plugins/command-hooks.html +4 -4
  259. data/site-local/plugins/compile-commands-json-db.html +2 -2
  260. data/site-local/plugins/cppcheck.html +2 -2
  261. data/site-local/plugins/dependencies.html +8 -5
  262. data/site-local/plugins/fff.html +58 -13
  263. data/site-local/plugins/gcov/examples.html +2 -2
  264. data/site-local/plugins/gcov/gcovr.html +23 -14
  265. data/site-local/plugins/gcov/index.html +2 -2
  266. data/site-local/plugins/gcov/overview.html +2 -2
  267. data/site-local/plugins/gcov/reportgenerator.html +18 -14
  268. data/site-local/plugins/gcov/reporting.html +2 -2
  269. data/site-local/plugins/gcov/setup.html +4 -3
  270. data/site-local/plugins/gcov/tool-versions.html +2 -2
  271. data/site-local/plugins/gcov/troubleshooting.html +2 -2
  272. data/site-local/plugins/index.html +2 -2
  273. data/site-local/plugins/module-generator.html +2 -2
  274. data/site-local/plugins/report-build-warnings-log.html +2 -2
  275. data/site-local/plugins/report-tests-gtestlike-stdout.html +2 -2
  276. data/site-local/plugins/report-tests-ide-stdout.html +2 -2
  277. data/site-local/plugins/report-tests-log-factory.html +2 -2
  278. data/site-local/plugins/report-tests-pretty-stdout.html +2 -2
  279. data/site-local/plugins/report-tests-raw-output-log.html +5 -3
  280. data/site-local/plugins/report-tests-teamcity-stdout.html +8 -5
  281. data/site-local/plugins/sanitize.html +9 -8
  282. data/site-local/plugins/valgrind.html +10 -9
  283. data/site-local/project/index.html +2 -2
  284. data/site-local/project/release-history.html +2 -2
  285. data/site-local/project/sbom.html +2 -2
  286. data/site-local/project/upgrade.html +5 -2
  287. data/site-local/reference/build-directives.html +2 -2
  288. data/site-local/reference/command-line.html +11 -4
  289. data/site-local/reference/environment-vars.html +2 -2
  290. data/site-local/reference/gcov-plugin.html +2 -2
  291. data/site-local/reference/global-collections.html +12 -12
  292. data/site-local/reference/index.html +2 -2
  293. data/site-local/reference/partials-macros.html +47 -2
  294. data/site-local/reference/project-configuration.html +2 -2
  295. data/site-local/sitemap.xml.gz +0 -0
  296. data/site-local/snapshot/examples/cipher_quest/index.html +2 -2
  297. data/site-local/snapshot/examples/temp_sensor/index.html +2 -2
  298. data/site-local/snapshot/examples/wondrous_forest/index.html +72 -15
  299. data/site-local/snapshot/plugins/bullseye/config/defaults_bullseye.rb +1 -1
  300. data/site-local/snapshot/plugins/gcov/config/defaults_gcov.rb +1 -1
  301. data/site-local/testing-guide/build-directives.html +2 -2
  302. data/site-local/testing-guide/conventions.html +113 -15
  303. data/site-local/testing-guide/frameworks.html +2 -2
  304. data/site-local/testing-guide/index.html +2 -2
  305. data/site-local/testing-guide/partials/configuration.html +31 -4
  306. data/site-local/testing-guide/partials/conventions.html +509 -8
  307. data/site-local/testing-guide/partials/directives.html +4 -3
  308. data/site-local/testing-guide/partials/example.html +2 -2
  309. data/site-local/testing-guide/partials/index.html +2 -2
  310. data/site-local/testing-guide/partials/overview.html +30 -12
  311. data/site-local/testing-guide/partials/variables.html +169 -4
  312. data/site-local/testing-guide/test-cases.html +2 -2
  313. data/site-local/testing-guide/test-sample.html +2 -2
  314. data/site-local/testing-guide/test-suite-anatomy.html +2 -2
  315. data/spec/integration/actionator_file_operations_spec.rb +91 -1
  316. data/spec/integration/build_step_doctor_spec.rb +270 -0
  317. data/spec/integration/c_extractor_composition_spec.rb +254 -4
  318. data/spec/integration/compile_commands_json_db_spec.rb +1 -1
  319. data/spec/integration/configurator_validation_spec.rb +1 -1
  320. data/spec/integration/dependencies/dependency_tracker_cache_hardening_spec.rb +26 -0
  321. data/spec/integration/dependencies/dependency_tracker_core_spec.rb +22 -0
  322. data/spec/integration/includes_extraction_spec.rb +27 -14
  323. data/spec/integration/launcher_handoff_spec.rb +297 -0
  324. data/spec/integration/mixin_loading_spec.rb +1 -1
  325. data/spec/integration/module_generator_spec.rb +3 -3
  326. data/spec/integration/nested_test_artifacts_spec.rb +99 -0
  327. data/spec/integration/partial_files_preprocessing_spec.rb +128 -0
  328. data/spec/integration/partials_carry_spec.rb +520 -0
  329. data/spec/integration/partials_declarations_spec.rb +655 -0
  330. data/spec/integration/partials_fallback_preprocessing_spec.rb +65 -0
  331. data/spec/integration/partials_function_pointers_spec.rb +277 -0
  332. data/spec/integration/partials_header_composition_spec.rb +268 -35
  333. data/spec/integration/partials_macro_decorators_spec.rb +267 -0
  334. data/spec/integration/partials_module_resolution_spec.rb +33 -23
  335. data/spec/integration/partials_symbol_linkage_spec.rb +13 -0
  336. data/spec/integration/path_intake_scenarios_spec.rb +101 -0
  337. data/spec/integration/path_length_reporting_spec.rb +64 -0
  338. data/spec/integration/path_scenarios_spec.rb +399 -0
  339. data/spec/integration/quote_include_isolator_spec.rb +57 -1
  340. data/spec/integration/report_build_warnings_log_spec.rb +1 -1
  341. data/spec/integration/report_tests_log_factory_spec.rb +1 -1
  342. data/spec/integration/test_build_parallel_barrier_spec.rb +1 -1
  343. data/spec/integration/test_executable_manifest_spec.rb +1 -1
  344. data/spec/integration/test_includes_extractinator_spec.rb +69 -3
  345. data/spec/integration/test_naming_spec.rb +201 -0
  346. data/spec/integration/test_source_file_checks_spec.rb +168 -0
  347. data/spec/integration/tool_executor_spec.rb +1 -1
  348. data/spec/integration/tool_validator_spec.rb +3 -3
  349. data/spec/integration/upgrade_docs_spec.rb +84 -0
  350. data/spec/integration/vendor_copy_transient_io_retry_spec.rb +74 -5
  351. data/spec/integration/win_long_paths_probe_spec.rb +46 -0
  352. data/spec/integration/win_path_limit_spec.rb +53 -0
  353. data/spec/integration/windows_registry_query_tool_spec.rb +41 -0
  354. data/spec/support/file_tree_helper.rb +88 -0
  355. data/spec/support/integration/configurator_integration_helper.rb +14 -9
  356. data/spec/support/integration/dependency_tracker_integration_helper.rb +1 -1
  357. data/spec/support/integration/partial_files_harness.rb +181 -0
  358. data/spec/support/integration/partials_generation_integration_helper.rb +239 -143
  359. data/spec/support/integration/path_scenario_harness.rb +175 -0
  360. data/spec/support/integration/spec_integration_helper.rb +9 -4
  361. data/spec/support/integration/test_includes_harness.rb +69 -37
  362. data/spec/support/integration/tool_executor_integration_helper.rb +14 -2
  363. data/spec/support/spec_helper.rb +2 -0
  364. data/spec/support/system/spec_system_helper.rb +7 -6
  365. data/spec/support/system/system_context.rb +21 -3
  366. data/spec/support/working_dir_tracking.rb +49 -0
  367. data/spec/system/build_output_mirroring_spec.rb +2 -2
  368. data/spec/system/bullseye_deployment_spec.rb +2 -0
  369. data/spec/system/conditional_mock_includes_spec.rb +1 -1
  370. data/spec/system/delta_builds_spec.rb +163 -23
  371. data/spec/system/encoding_stress_spec.rb +4 -4
  372. data/spec/system/example_wondrous_forest_spec.rb +2 -2
  373. data/spec/system/gcov_deployment_spec.rb +3 -0
  374. data/spec/system/header_include_path_validation_spec.rb +4 -4
  375. data/spec/system/header_search_paths_spec.rb +1083 -0
  376. data/spec/system/launcher_handoff_spec.rb +82 -0
  377. data/spec/system/mock_include_folders_spec.rb +212 -0
  378. data/spec/system/mockable_header_reassembly_spec.rb +184 -0
  379. data/spec/system/parent_directory_reference_spec.rb +5 -3
  380. data/spec/system/partials_carry_spec.rb +581 -0
  381. data/spec/system/partials_delta_builds_spec.rb +280 -0
  382. data/spec/system/partials_function_pointers_spec.rb +106 -0
  383. data/spec/system/partials_macro_decorators_spec.rb +127 -0
  384. data/spec/system/partials_module_disambiguation_spec.rb +125 -0
  385. data/spec/system/path_handling_probes_spec.rb +196 -0
  386. data/spec/system/pinned_thread_count_spec.rb +4 -4
  387. data/spec/system/preprocessing_fallback_conditionals_spec.rb +1 -1
  388. data/spec/system/preprocessing_parameterized_tests_spec.rb +1 -1
  389. data/spec/system/rake_release_task_path_disambiguation_spec.rb +6 -6
  390. data/spec/system/rake_test_task_path_disambiguation_spec.rb +85 -0
  391. data/spec/system/short_build_paths_spec.rb +87 -0
  392. data/spec/system/sibling_header_collision_spec.rb +30 -6
  393. data/spec/system/special_path_characters_spec.rb +86 -0
  394. data/spec/system/support/bullseye_common_test_cases.rb +42 -0
  395. data/spec/system/support/common_test_cases.rb +23 -21
  396. data/spec/system/support/gcov_common_test_cases.rb +37 -9
  397. data/spec/system/support/gcov_partials_test_cases.rb +48 -0
  398. data/spec/system/support/sanitize_common_test_cases.rb +2 -2
  399. data/spec/system/support/valgrind_common_test_cases.rb +12 -12
  400. data/spec/system/test_build_layout_spec.rb +209 -0
  401. data/spec/system/test_pipeline_stop_points_spec.rb +4 -4
  402. data/spec/system/test_runner_system_include_spec.rb +1 -1
  403. data/spec/system/test_source_file_directive_spec.rb +64 -5
  404. data/spec/units/bin/actionator_spec.rb +14 -17
  405. data/spec/units/bin/app_cfg_spec.rb +37 -0
  406. data/spec/units/bin/cli_handler_spec.rb +282 -6
  407. data/spec/units/bin/cli_helper_spec.rb +116 -45
  408. data/spec/units/bin/installation_selector_spec.rb +114 -0
  409. data/spec/units/bin/launchinator_spec.rb +171 -0
  410. data/spec/units/bin/path_validator_spec.rb +10 -0
  411. data/spec/units/bin/versionator_spec.rb +38 -6
  412. data/spec/units/build_log_writer_spec.rb +57 -0
  413. data/spec/units/c_extractor/c_extractor_code_text_spec.rb +67 -10
  414. data/spec/units/c_extractor/c_extractor_declarations_spec.rb +501 -4
  415. data/spec/units/c_extractor/c_extractor_declarator_spec.rb +245 -0
  416. data/spec/units/c_extractor/c_extractor_defined_type_spec.rb +45 -0
  417. data/spec/units/c_extractor/c_extractor_definitions_spec.rb +163 -3
  418. data/spec/units/c_extractor/c_extractor_functions_spec.rb +462 -21
  419. data/spec/units/c_extractor/c_extractor_preprocessing_spec.rb +39 -0
  420. data/spec/units/c_extractor/c_extractor_spec.rb +4 -4
  421. data/spec/units/c_extractor/c_extractor_types_spec.rb +163 -0
  422. data/spec/units/c_identifier_spec.rb +35 -0
  423. data/spec/units/config/build_root_policy_spec.rb +61 -0
  424. data/spec/units/config/configurator_builder_spec.rb +61 -6
  425. data/spec/units/config/configurator_paths_validator_spec.rb +292 -0
  426. data/spec/units/config/configurator_setup_spec.rb +80 -68
  427. data/spec/units/config/configurator_spec.rb +54 -6
  428. data/spec/units/config/configurator_validator_spec.rb +1 -172
  429. data/spec/units/dependencies/dependency_cache_store_spec.rb +98 -2
  430. data/spec/units/dependencies/dependency_debug_tree_spec.rb +1 -1
  431. data/spec/units/dependencies/dependency_hasher_spec.rb +42 -1
  432. data/spec/units/dependencies/dependency_path_normalizer_spec.rb +1 -1
  433. data/spec/units/dependencies/dependency_tracker_spec.rb +28 -1
  434. data/spec/units/dependencies/dependinator_spec.rb +17 -2
  435. data/spec/units/diagnostics/build_step_doctor_spec.rb +170 -0
  436. data/spec/units/diagnostics/duplicate_symbol_specialist_spec.rb +117 -0
  437. data/spec/units/diagnostics/header_collision_specialist_spec.rb +267 -0
  438. data/spec/units/diagnostics/include_depth_specialist_spec.rb +137 -0
  439. data/spec/units/diagnostics/missing_symbol_specialist_spec.rb +154 -0
  440. data/spec/units/diagnostics/partial_name_specialist_spec.rb +129 -0
  441. data/spec/units/diagnostics/toolchain_output_spec.rb +86 -0
  442. data/spec/units/encodinator_spec.rb +3 -4
  443. data/spec/units/filename_extension_spec.rb +11 -0
  444. data/spec/units/filesystem/build_roots_spec.rb +131 -0
  445. data/spec/units/filesystem/build_subpath_spec.rb +235 -0
  446. data/spec/units/filesystem/destination_collision_spec.rb +30 -0
  447. data/spec/units/{file_finder_helper_spec.rb → filesystem/file_finder_helper_spec.rb} +126 -1
  448. data/spec/units/filesystem/file_finder_spec.rb +845 -0
  449. data/spec/units/{file_path_collection_utils_spec.rb → filesystem/file_path_collection_utils_spec.rb} +181 -1
  450. data/spec/units/{file_path_utils_spec.rb → filesystem/file_path_utils_spec.rb} +435 -185
  451. data/spec/units/filesystem/file_system_wrapper_spec.rb +33 -0
  452. data/spec/units/filesystem/file_tree_spec.rb +511 -0
  453. data/spec/units/filesystem/file_tree_windows_spec.rb +78 -0
  454. data/spec/units/{file_wrapper_spec.rb → filesystem/file_wrapper_spec.rb} +286 -18
  455. data/spec/units/{path_matcher_spec.rb → filesystem/path_matcher_spec.rb} +48 -1
  456. data/spec/units/{path_mirror_spec.rb → filesystem/path_mirror_spec.rb} +32 -4
  457. data/spec/units/filesystem/project_paths_spec.rb +147 -0
  458. data/spec/units/filesystem/test_build_layout_spec.rb +216 -0
  459. data/spec/units/filesystem/win_long_paths_spec.rb +204 -0
  460. data/spec/units/filesystem/win_path_prober_spec.rb +158 -0
  461. data/spec/units/filesystem/working_dir_spec.rb +71 -0
  462. data/spec/units/generators/generator_helper_spec.rb +0 -60
  463. data/spec/units/generators/generator_mocks_spec.rb +13 -0
  464. data/spec/units/generators/generator_partials_spec.rb +656 -55
  465. data/spec/units/generators/generator_spec.rb +38 -6
  466. data/spec/units/generators/generator_test_results_backtrace_spec.rb +50 -46
  467. data/spec/units/generators/generator_test_results_spec.rb +1 -1
  468. data/spec/units/generators/generator_test_runner_spec.rb +9 -5
  469. data/spec/units/generators/partial_source_writer_spec.rb +129 -0
  470. data/spec/units/handoff_spec.rb +205 -0
  471. data/spec/units/includes/header_search_spec.rb +406 -0
  472. data/spec/units/includes/include_factory_spec.rb +23 -6
  473. data/spec/units/includes/include_pathinator_spec.rb +118 -8
  474. data/spec/units/includes/include_spec.rb +14 -0
  475. data/spec/units/includes/includes_spec.rb +176 -19
  476. data/spec/units/installation_spec.rb +228 -0
  477. data/spec/units/library_resolver_spec.rb +157 -0
  478. data/spec/units/loginator_spec.rb +31 -0
  479. data/spec/units/mock_locator_spec.rb +275 -6
  480. data/spec/units/partials/include_groups_spec.rb +42 -0
  481. data/spec/units/partials/partializer_config_spec.rb +32 -0
  482. data/spec/units/partials/partializer_helper_carry_spec.rb +661 -0
  483. data/spec/units/partials/partializer_helper_interface_extras_spec.rb +396 -0
  484. data/spec/units/partials/partializer_helper_spec.rb +529 -277
  485. data/spec/units/partials/partializer_reconciler_spec.rb +661 -0
  486. data/spec/units/partials/partializer_spec.rb +1579 -270
  487. data/spec/units/partials/partializer_utils_spec.rb +269 -232
  488. data/spec/units/partials/partials_rename_spec.rb +160 -0
  489. data/spec/units/partials_manager_spec.rb +561 -251
  490. data/spec/units/plugins/bullseye_spec.rb +49 -2
  491. data/spec/units/plugins/console_reportinator_spec.rb +73 -26
  492. data/spec/units/plugins/dependencies_spec.rb +33 -7
  493. data/spec/units/plugins/dependency_spec_spec.rb +17 -0
  494. data/spec/units/plugins/gcov_spec.rb +28 -3
  495. data/spec/units/plugins/gcovr_reportinator_spec.rb +19 -47
  496. data/spec/units/plugins/gcovr_thresholds_spec.rb +95 -0
  497. data/spec/units/plugins/module_generator_spec.rb +5 -5
  498. data/spec/units/plugins/report_build_warnings_log_spec.rb +3 -3
  499. data/spec/units/plugins/report_log_writer_plugin_spec.rb +10 -1
  500. data/spec/units/plugins/report_tests_raw_output_log_spec.rb +13 -2
  501. data/spec/units/plugins/report_tests_teamcity_stdout_spec.rb +77 -3
  502. data/spec/units/plugins/reportgenerator_reportinator_spec.rb +52 -4
  503. data/spec/units/plugins/sanitize_records_spec.rb +3 -1
  504. data/spec/units/plugins/sanitize_spec.rb +1 -1
  505. data/spec/units/plugins/valgrind_spec.rb +23 -8
  506. data/spec/units/preprocess/preprocessinator_code_finder_spec.rb +73 -10
  507. data/spec/units/preprocess/preprocessinator_comment_stripper_spec.rb +1 -1
  508. data/spec/units/preprocess/preprocessinator_file_assembler_spec.rb +125 -37
  509. data/spec/units/preprocess/preprocessinator_includes_handler_spec.rb +15 -0
  510. data/spec/units/preprocess/preprocessinator_reconstructor_spec.rb +197 -0
  511. data/spec/units/preprocess/preprocessinator_spec.rb +153 -95
  512. data/spec/units/rake_app/rakefile_component_resolver_spec.rb +21 -0
  513. data/spec/units/release_build_executor_spec.rb +53 -14
  514. data/spec/units/release_build_planner_spec.rb +15 -3
  515. data/spec/units/reportinator_spec.rb +5 -5
  516. data/spec/units/setupinator_spec.rb +51 -0
  517. data/spec/units/standin_headerinator_spec.rb +55 -9
  518. data/spec/units/test_build_executor_spec.rb +842 -166
  519. data/spec/units/test_build_planner_spec.rb +205 -15
  520. data/spec/units/test_build_setup_spec.rb +179 -30
  521. data/spec/units/test_context_extractor_spec.rb +36 -2
  522. data/spec/units/test_derived_search_paths_spec.rb +259 -0
  523. data/spec/units/test_file_preprocessinator_spec.rb +17 -1
  524. data/spec/units/test_includes_extractinator_spec.rb +61 -9
  525. data/spec/units/test_invoker/objects_wiring_spec.rb +24 -4
  526. data/spec/units/test_invoker/partial_files_preprocessinator_spec.rb +264 -0
  527. data/spec/units/test_invoker/test_substitutions_spec.rb +122 -0
  528. data/spec/units/test_invoker_spec.rb +14 -1
  529. data/spec/units/test_invoker_types_spec.rb +8 -7
  530. data/spec/units/test_pipeline_manager_spec.rb +54 -13
  531. data/spec/units/test_runner_generatinator_spec.rb +93 -1
  532. data/spec/units/test_search_paths_spec.rb +73 -5
  533. data/spec/units/test_source_file_directive_resolver_spec.rb +38 -7
  534. data/spec/units/tools/default_tools_quoting_spec.rb +117 -0
  535. data/spec/units/tools/shell_quoting_spec.rb +76 -0
  536. data/spec/units/{tool_executor_helper_spec.rb → tools/tool_executor_helper_spec.rb} +1 -1
  537. data/spec/units/{tool_executor_spec.rb → tools/tool_executor_spec.rb} +27 -1
  538. data/spec/units/{tool_validator_spec.rb → tools/tool_validator_spec.rb} +110 -1
  539. data/spec/units/windows_registry_query_tool_spec.rb +53 -0
  540. data/spec/units/yaml_wrapper_spec.rb +11 -0
  541. metadata +265 -36
  542. data/lib/ceedling/file_finder_helper.rb +0 -127
  543. data/lib/ceedling/file_path_collection_utils.rb +0 -164
  544. data/spec/units/file_finder_spec.rb +0 -495
  545. /data/lib/ceedling/{tool_executor_helper.rb → tools/tool_executor_helper.rb} +0 -0
@@ -8,7 +8,7 @@
8
8
  class GeneratorTestResultsBacktrace
9
9
 
10
10
  constructor :configurator, :tool_executor, :generator_test_results, :generator_helper,
11
- :file_path_utils, :file_wrapper, :loginator
11
+ :file_path_utils, :build_log_writer, :loginator
12
12
 
13
13
  def setup()
14
14
  @RESULTS_COLLECTOR = Struct.new( :passed, :failed, :ignored, :output, keyword_init:true )
@@ -31,7 +31,10 @@ class GeneratorTestResultsBacktrace
31
31
  # Writes the full gdb transcript to a per-test-case log file and assembles a
32
32
  # terse crash label (signal + description, optional source line in backticks)
33
33
  # for each failing test case. Returns a modified shell_result with regenerated output.
34
- def do_gdb(filename, executable, shell_result, test_cases, context:)
34
+ #
35
+ # `test_name` places the logs, so same-named tests keep separate ones. Each log holds only
36
+ # this build's crash.
37
+ def do_gdb(filename, executable, shell_result, test_cases, context:, test_name:)
35
38
  gdb_script_filepath = File.join( @configurator.project_build_tests_root, BACKTRACE_GDB_SCRIPT_FILE )
36
39
 
37
40
  # Clean stats tracker
@@ -40,8 +43,6 @@ class GeneratorTestResultsBacktrace
40
43
  # Reset time
41
44
  shell_result[:time] = 0
42
45
 
43
- test_name = File.basename( filename, '.*' )
44
-
45
46
  # True once some retry group has actually shown crash evidence of its own -- an
46
47
  # unresolved member, or (below) a group whose real status contradicts a fully clean
47
48
  # set of matches. If this stays false across every group, the whole diagnostic never
@@ -120,8 +121,7 @@ class GeneratorTestResultsBacktrace
120
121
 
121
122
  # Per-test-case log file: <log_path>/<context>/<test_name>/<test_case>.gdb.log
122
123
  log_path = @file_path_utils.form_test_gdb_log( test_name, context: context, name: crashed_case[:test] )
123
- @file_wrapper.mkdir( File.dirname( log_path ) )
124
- @file_wrapper.write( log_path, "=== #{crashed_case[:test]} ===\n#{crash_result[:output]}\n", 'a' )
124
+ @build_log_writer.write( log_path, "=== #{crashed_case[:test]} ===\n#{crash_result[:output]}\n" )
125
125
 
126
126
  unresolved.each do |test_case|
127
127
  group_results[:failed] += 1
@@ -296,7 +296,7 @@ class GeneratorTestResultsBacktrace
296
296
  # such as Valgrind's, keeps the main run's report.
297
297
  #
298
298
  # `explain` names the cause of a rerun's crash, if a plugin recognizes it.
299
- def do_simple(filename, executable, shell_result, test_cases, context:, tool: nil, explain: nil)
299
+ def do_simple(filename, executable, shell_result, test_cases, tool: nil, explain: nil)
300
300
  results = @RESULTS_COLLECTOR.new( passed:0, failed:0, ignored:0, output:[] )
301
301
  shell_result[:time] = 0 # Summed over the per-group sub-process runs
302
302
  any_crashed = false
@@ -49,18 +49,15 @@ class GeneratorTestRunner
49
49
  # filename here drops both the directory component and the '<>' delimiters a
50
50
  # system header's own search path depends on (issue #1236).
51
51
  #
52
- # User includes: bare filename, same as always. Unlike mocks (whose subdirectory
53
- # is a real, dedicated build/test/mocks/<test>/ path -- hence their own
54
- # directory-preserving filepath usage above) or a system header (whose directory
55
- # is meaningful to the system include search path), a project's own directories
56
- # are exposed to the compiler as a flat list of -I search paths, not nested to
57
- # match whatever directory component a captured UserInclude's filepath happens to
58
- # carry -- rendering the full path here breaks resolution instead of fixing it.
52
+ # User includes: the spelling the caller found the header by through the test's
53
+ # search paths (include_path), else the bare filename. A captured UserInclude's
54
+ # filepath can be the header's resolved location, which the runner's -I search
55
+ # paths don't reach, so it is never rendered.
59
56
  includes.map do |include|
60
57
  if include.is_a?(SystemInclude)
61
58
  "<#{include.include_path || include.filepath}>"
62
59
  else
63
- include.filename
60
+ include.include_path || include.filename
64
61
  end
65
62
  end
66
63
  )
@@ -0,0 +1,95 @@
1
+ # =========================================================================
2
+ # Ceedling - Test-Centered Build System for C
3
+ # ThrowTheSwitch.org
4
+ # Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
5
+ # SPDX-License-Identifier: MIT
6
+ # =========================================================================
7
+
8
+ require 'ceedling/filesystem/file_wrapper'
9
+
10
+ # Writes one of a Partial's generated headers one item at a time.
11
+ #
12
+ # GeneratorPartials decides what each item is. The writer keeps the state that spans items: the
13
+ # blank lines around functions and the source's later includes, which go where the module
14
+ # header's items end. Every generated header opens and closes the same way, so the writer owns
15
+ # both ends.
16
+ class PartialHeaderWriter
17
+
18
+ # @param io [IO] Output file handle
19
+ # @param name [String] The header's filename, from which its own include guard comes
20
+ def initialize(io:, name:)
21
+ @io = io
22
+ @guard = FileWrapper.generate_include_guard( name )
23
+ @written = false
24
+ @last_was_function = false
25
+ end
26
+
27
+ # Everything above the header's own content: its include guard, the spoof of the real module
28
+ # header's guard, and the includes that header carries.
29
+ #
30
+ # The order of the last two is the whole point. A carried header can transitively reach the
31
+ # real module header, so the spoof has to be satisfied before any include is processed rather
32
+ # than after. And relocated content names things a generated file does not define, so without
33
+ # the includes it compiles only where something earlier in the translation unit happened to
34
+ # supply those names.
35
+ #
36
+ # @param include_guard [String, nil] The real module header's own guard, or nil when it has none
37
+ # and so supplies nothing to spoof
38
+ # @param includes [Array] The includes ahead of the header's content
39
+ # @param flag [String, nil] Defined ahead of the spoof only when the real header's guard
40
+ # isn't yet, so content the real header would supply follows only where it hasn't arrived
41
+ def preamble(include_guard, includes, flag: nil)
42
+ @io << "#ifndef #{@guard}\n"
43
+ @io << "#define #{@guard}\n\n"
44
+ @io << "#ifndef #{include_guard}\n#define #{flag}\n#endif\n" if include_guard and flag
45
+ @io << "#define #{include_guard}\n\n" if include_guard
46
+ return if includes.empty?
47
+
48
+ includes.each { |include| @io << "#{include}\n" }
49
+ @io << "\n"
50
+ end
51
+
52
+ # A line of content that is no function, such as a macro, a type or an extern
53
+ def line(text)
54
+ @io << text << "\n"
55
+ _wrote( function: false )
56
+ end
57
+
58
+ # A function's signature, set apart from what precedes it by a blank line
59
+ def function(signature)
60
+ @io << "\n" if @written and !@last_was_function
61
+ @io << signature << ";\n\n"
62
+ _wrote( function: true )
63
+ end
64
+
65
+ # The source's includes after the module header, written where the header's items end, as the
66
+ # source meets them when it compiles. The spoof keeps the real header out, so these includes
67
+ # find its types and macros only in what a generated header writes ahead of them. `macros` are
68
+ # header macros held back until the includes, which come first. Both lists are consumed, so
69
+ # only the first call with includes writes anything.
70
+ def following_includes(includes, macros: [])
71
+ return if includes.empty?
72
+
73
+ macros.each { |macro| @io << "#{macro.text}\n" }
74
+ @io << "\n" if (@written and !@last_was_function) or macros.any?
75
+ includes.each { |include| @io << "#{include}\n" }
76
+ @io << "\n"
77
+ macros.clear
78
+ includes.clear
79
+ # The includes end in a blank line, as a function does
80
+ _wrote( function: true )
81
+ end
82
+
83
+ # A blank line before the guard's close when the last item didn't already end in one
84
+ def finish
85
+ @io << "\n" if @written and !@last_was_function
86
+ @io << "#endif // #{@guard}\n\n"
87
+ end
88
+
89
+ private
90
+
91
+ def _wrote(function:)
92
+ @last_was_function = function
93
+ @written = true
94
+ end
95
+ end
@@ -0,0 +1,137 @@
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 'set'
9
+
10
+ # Writes a Partial's implementation source one item at a time.
11
+ #
12
+ # GeneratorPartials decides what each item is. The writer keeps the state that spans items: an
13
+ # open run of carried prototypes inside its GCC pragmas, a #line that points at another file,
14
+ # the blank lines between functions, and the functions already written.
15
+ #
16
+ # A #line ties generated code back to its original file and line, so debuggers, compiler
17
+ # messages and gcov coverage all point at the real file. After a located item, a #line hands
18
+ # attribution back to this file before the next item without a location of its own. That only
19
+ # holds if this file's line count matches what each #line promises, which is why the file is
20
+ # written in binary mode and every line written here is counted.
21
+ class PartialSourceWriter
22
+
23
+ # Carried prototypes can repeat a declaration a header already made. These pragmas keep GCC's
24
+ # -Wredundant-decls quiet for just those lines. Compilers that don't define __GNUC__ never see them.
25
+ REDUNDANT_DECLS_PUSH = "#if defined(__GNUC__)\n#pragma GCC diagnostic push\n#pragma GCC diagnostic ignored \"-Wredundant-decls\"\n#endif\n" unless const_defined?(:REDUNDANT_DECLS_PUSH, false)
26
+ REDUNDANT_DECLS_POP = "#if defined(__GNUC__)\n#pragma GCC diagnostic pop\n#endif\n" unless const_defined?(:REDUNDANT_DECLS_POP, false)
27
+
28
+ # Passes writes through and counts the lines written, so a #line can name this file's own next line
29
+ class LineCountingIO
30
+ attr_reader :lines
31
+
32
+ def initialize(io)
33
+ @io = io
34
+ @lines = 0
35
+ end
36
+
37
+ def <<(text)
38
+ text = text.to_s
39
+ @io << text
40
+ @lines += text.count( "\n" )
41
+ return self
42
+ end
43
+ end
44
+
45
+ # @param io [IO] Output file handle
46
+ # @param filepath [String, nil] This file's own path, named when attribution returns to it
47
+ # @param suppress_redundant_decls [Boolean] Whether carried prototypes sit inside GCC pragmas
48
+ def initialize(io:, filepath:, suppress_redundant_decls:)
49
+ @io = LineCountingIO.new( io )
50
+ @filepath = filepath
51
+ @suppress = suppress_redundant_decls
52
+ @wrapped = false # a run of prototypes is open inside its pragmas
53
+ @anchored = false # the last #line named another file
54
+ @last_was_function = false
55
+ @written = false
56
+ @functions = Set.new
57
+ end
58
+
59
+ def preamble(includes)
60
+ @io << "// Ceedling generated file\n"
61
+ includes.each { |include| @io << "#{include}\n" }
62
+ @io << "\n"
63
+ end
64
+
65
+ # A line of text with no location of its own, such as a variable or bare macro invocation
66
+ def text(text)
67
+ _close_run
68
+ _hand_back
69
+ @io << text
70
+ _wrote( function: false )
71
+ end
72
+
73
+ # A carried prototype, written as the user spelled it, so `extern inline` keeps making this
74
+ # file hold the external definition
75
+ def prototype(decl)
76
+ _open_run
77
+ _attribute( decl )
78
+ @io << decl.signature.strip << "\n"
79
+ _wrote( function: false )
80
+ end
81
+
82
+ # A selected function or carried helper. A name already written is skipped.
83
+ def function(func)
84
+ return if func.nil? or @functions.include?( func.name )
85
+
86
+ _close_run
87
+ # Blank line before a function when preceded by a non-function item
88
+ @io << "\n" if @written and !@last_was_function
89
+ _attribute( func )
90
+ @io << func.code_block << "\n\n"
91
+ @functions << func.name
92
+ _wrote( function: true )
93
+ end
94
+
95
+ def finish
96
+ _close_run
97
+ end
98
+
99
+ private
100
+
101
+ def _open_run
102
+ return if @wrapped or !@suppress
103
+
104
+ @io << REDUNDANT_DECLS_PUSH
105
+ @wrapped = true
106
+ end
107
+
108
+ def _close_run
109
+ @io << REDUNDANT_DECLS_POP if @wrapped
110
+ @wrapped = false
111
+ end
112
+
113
+ # A located item takes a #line naming its own file and line. Any other item belongs to this file.
114
+ def _attribute(item)
115
+ return _hand_back unless item.line_num and item.source_filepath
116
+
117
+ @io << _line_marker( item.line_num, item.source_filepath )
118
+ @anchored = true
119
+ end
120
+
121
+ # What follows a located item belongs to this file again. The directive itself takes a line,
122
+ # so the next line is two past the count so far.
123
+ def _hand_back
124
+ @io << _line_marker( @io.lines + 2, @filepath ) if @anchored and @filepath
125
+ @anchored = false
126
+ end
127
+
128
+ # Forward slashes, since a backslash in a #line string starts an escape sequence
129
+ def _line_marker(line_num, filepath)
130
+ return "#line #{line_num} \"#{filepath.tr( '\\', '/' )}\"\n"
131
+ end
132
+
133
+ def _wrote(function:)
134
+ @last_was_function = function
135
+ @written = true
136
+ end
137
+ end
@@ -0,0 +1,121 @@
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 'rbconfig'
9
+ require_relative 'installation'
10
+
11
+ # The protocol by which one Ceedling installation hands a command off to another: the
12
+ # selected installation's own launcher replaces this process, given the original command
13
+ # line. Environment markers tell that process who launched it and stop it handing off again.
14
+ #
15
+ # Like Installation, this file depends on nothing else in lib/, so an application loaded
16
+ # by an older launcher can load it with require_relative.
17
+ module Handoff
18
+
19
+ LAUNCHER_VAR = 'CEEDLING_HANDOFF_LAUNCHER'
20
+ TARGET_VAR = 'CEEDLING_HANDOFF_TARGET'
21
+
22
+ # Removes the markers from env, so no subprocess of this build inherits them, and
23
+ # returns them, or nil when no launcher handed off to this process
24
+ def self.take_markers(env)
25
+ launcher = env.delete( LAUNCHER_VAR )
26
+ target = env.delete( TARGET_VAR )
27
+ return nil if target.nil?
28
+
29
+ return {launcher: launcher, target: target}
30
+ end
31
+
32
+ # Whether the markers name own as the installation a launcher handed off to
33
+ def self.received?(markers, own:)
34
+ return false if markers.nil? or markers[:target].nil?
35
+
36
+ return Installation.new( markers[:target] ) == own
37
+ end
38
+
39
+ def self.handing_off_message(launcher:, target:)
40
+ return "#{launcher.describe( 'Ceedling launcher' )} is handing off to #{target.describe()}, which runs in its own process."
41
+ end
42
+
43
+ def self.received_message(markers, own:)
44
+ return "#{own.describe()} is now running, launched from #{Installation.new( markers[:launcher] ).describe()}."
45
+ end
46
+
47
+ # Replaces this process with target's own launcher. Nothing after this call runs, not
48
+ # even END blocks, so logging drains and the standard streams flush first.
49
+ def self.exec(target:, launcher:, argv:, loginator:)
50
+ loginator.wrapup()
51
+ $stdout.flush()
52
+ $stderr.flush()
53
+
54
+ markers = {LAUNCHER_VAR => launcher.root, TARGET_VAR => target.root}
55
+ replace_process( markers, RbConfig.ruby, target.bin_path, *argv )
56
+ end
57
+
58
+ # Finishes a hand-off that a launcher before 1.2.2 cannot make: it loads this application
59
+ # into its own process. Every such launcher kept the original command line in the
60
+ # SystemWrapper it hands over, so the application restarts as its own launcher. Without
61
+ # that command line, or inside a hand-off already, it warns and continues in-process,
62
+ # so a restart never cycles.
63
+ def self.complete_in_process(app_root:, app_cfg:, handoff_objects:, env:)
64
+ launcher = Installation.new( launcher_root_of( app_cfg ) )
65
+ app = Installation.new( app_root )
66
+ return if launcher == app
67
+
68
+ loginator = handoff_objects[:loginator]
69
+ argv = command_line( handoff_objects[:system_wrapper] )
70
+ restart = !(argv.nil? or in_handoff?( app_cfg, env ))
71
+
72
+ loginator.log( loaded_message( launcher, app, restart ), Verbosity::COMPLAIN )
73
+ exec( target:app, launcher:launcher, argv:argv, loginator:loginator ) if restart
74
+ end
75
+
76
+ # The one seam to the operating system, so specs can stand in for it
77
+ def self.replace_process(env, *command)
78
+ Kernel.exec( env, *command )
79
+ end
80
+
81
+ # The launcher's CeedlingAppConfig is defined in its own bin/
82
+ def self.launcher_root_of(app_cfg)
83
+ filepath, _ = app_cfg.class.instance_method( :initialize ).source_location
84
+ return File.expand_path( '..', File.dirname( filepath ) )
85
+ end
86
+
87
+ def self.command_line(system_wrapper)
88
+ return nil if !system_wrapper.respond_to?( :get_cmdline )
89
+
90
+ return system_wrapper.get_cmdline()
91
+ end
92
+
93
+ def self.in_handoff?(app_cfg, env)
94
+ return true if !app_cfg[:handoff].nil?
95
+
96
+ return !(env[TARGET_VAR].nil? and env[LAUNCHER_VAR].nil?)
97
+ end
98
+
99
+ def self.loaded_message(launcher, app, restart)
100
+ loaded = "#{launcher.describe( 'Ceedling launcher' )} loaded #{app.describe()} into its own process."
101
+ return "#{loaded} Restarting in #{app.name()}'s own process. Upgrade Ceedling and review your installations to avoid this." if restart
102
+
103
+ return "#{loaded} #{continuing_advice( app )}"
104
+ end
105
+
106
+ def self.continuing_advice(app)
107
+ return "Continuing in the launcher's process, which can fail or misbehave. Upgrade Ceedling, or run this " +
108
+ "installation's own launcher directly with `ruby #{display_path( app.bin_path )}`. A project created " +
109
+ "with `--local` has a launch script at its root that does this: run `./ceedling` from the project root " +
110
+ "(`.\\ceedling.cmd` on Windows)."
111
+ end
112
+
113
+ # Relative to the working directory when beneath it, as a user would type it
114
+ def self.display_path(filepath)
115
+ cwd = File.join( Dir.pwd, '' )
116
+ return filepath.start_with?( cwd ) ? filepath.delete_prefix( cwd ) : filepath
117
+ end
118
+
119
+ private_class_method :launcher_root_of, :command_line, :in_handoff?, :loaded_message, :continuing_advice, :display_path
120
+
121
+ end
@@ -0,0 +1,225 @@
1
+ # =========================================================================
2
+ # Ceedling - Test-Centered Build System for C
3
+ # ThrowTheSwitch.org
4
+ # Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
5
+ # SPDX-License-Identifier: MIT
6
+ # =========================================================================
7
+
8
+ require 'ceedling/filesystem/path_matcher'
9
+ require 'ceedling/filesystem/project_paths'
10
+
11
+ # Directory listings of headers, each indexed by filename, listed once for a search
12
+ class HeaderListings
13
+
14
+ def initialize(lister)
15
+ @lister = lister
16
+ @by_dir = {}
17
+ @lock = Mutex.new
18
+ end
19
+
20
+ # A directory's headers
21
+ def headers(dir)
22
+ return entry( dir ).first
23
+ end
24
+
25
+ # The header named `name` in `dir`, letter case and all, or nil
26
+ def named(dir, name)
27
+ return entry( dir ).last[name]
28
+ end
29
+
30
+ private
31
+
32
+ # A directory's headers and the same headers by filename, the first of a name kept
33
+ def entry(dir)
34
+ listed = @lock.synchronize { @by_dir[dir] }
35
+ return listed unless listed.nil?
36
+
37
+ headers = @lister.call( dir )
38
+ names = headers.each_with_object( {} ) { |header, by_name| by_name[File.basename( header )] ||= header }
39
+ return @lock.synchronize { @by_dir[dir] ||= [headers, names].freeze }
40
+ end
41
+
42
+ end
43
+
44
+ # A test's real headers, found the way its compiler finds them: each search path in
45
+ # order, joined with the path an #include names. A bare name joins to a search path's
46
+ # own listing, so it finds exactly the headers a flat listing of every search path holds.
47
+ #
48
+ # An #include's spelling is the text it names its header by, between its quotes. One header
49
+ # can have several. With `src` and `src/drivers` both searched, `foo.h` and `drivers/foo.h`
50
+ # both name `src/drivers/foo.h`. A spelling reaches a header when the compiler, joining it
51
+ # with each search path in order, finds that header first. A file Ceedling generates lives
52
+ # away from the file it comes from, so it includes each header by a spelling that reaches it
53
+ # (`spelling`) or, where no spelling reaches it, by its absolute path. A header generated in the
54
+ # build root keeps its text, since the compiler's own search paths reach it. A respelling
55
+ # replaces a text that reaches another header, or none.
56
+ #
57
+ # An #include after stage 4 can carry a path the test never wrote: GCC's resolved
58
+ # path for a plain #include, or a computed mock's place below its mirror root. When no
59
+ # search path joins to a query, the query matches the trailing path of a header directly
60
+ # in a search path, and then names a header itself when one lies below a search path.
61
+ #
62
+ # Each directory is listed once for the search's lifetime, so one search serves a
63
+ # test's every lookup in one stage.
64
+ class HeaderSearch
65
+
66
+ # Characters a directory listing would read as a glob
67
+ GLOB_CHARACTERS = /[*?\[\]{}]/
68
+
69
+ attr_reader :paths
70
+
71
+ # A query as every search reads it: forward slashes, with no `.` or empty segments. A
72
+ # drive letter, a root `/`, and a Windows share's `//` stay.
73
+ def self.normalized(query)
74
+ query = query.to_s.tr( '\\', '/' )
75
+ root = query[%r{\A(?:[A-Za-z]:/|/+)}].to_s
76
+ rest = query.delete_prefix( root )
77
+ root = (ProjectPaths.unc?( root ) ? '//' : '/') if root.start_with?( '/' )
78
+
79
+ return root + ProjectPaths.segments( rest ).join( '/' )
80
+ end
81
+
82
+ # The ways a query names headers, tried in turn: the compiler's join first
83
+ TIERS = [:joined, :trailing, :named].freeze
84
+
85
+ # `paths` in search order. `lister` gives a directory's headers. `refusals` explain, by
86
+ # the query a test's #include asks for, why no search path reaches its header. `build_root`
87
+ # holds the headers Ceedling generates.
88
+ def initialize(paths, lister, refusals: {}, build_root: nil)
89
+ @paths = paths
90
+ @listings = HeaderListings.new( lister )
91
+ @refusals = refusals.to_h { |query, why| [normalized( query ), why] }
92
+ @build_root = build_root
93
+ end
94
+
95
+ # The headers `query` names, the one the compiler includes first. Empty for none.
96
+ def header_candidates(query)
97
+ query = normalized( query )
98
+
99
+ # A bare name names no directory, so only a join can find it
100
+ TIERS.each do |tier|
101
+ next if tier != :joined and File.dirname( query ) == '.'
102
+
103
+ found = send( tier, query )
104
+ return distinct( found ) unless found.empty?
105
+ end
106
+
107
+ return []
108
+ end
109
+
110
+ # Whether a search path joined with `text` names a header, as the compiler's -I does
111
+ def joins?(text)
112
+ return !joined( normalized( text ) ).empty?
113
+ end
114
+
115
+ # Every header a search for `query` looked at, for a hint at one in another letter case
116
+ def hint_files(query)
117
+ query = normalized( query )
118
+ dirs = joinable?( query ) ? @paths.map { |path| joined_directory( path, query ) } : []
119
+ dirs << File.dirname( query ) if nameable?( query )
120
+
121
+ return (dirs.flat_map { |dir| listing( dir ) } + flat).uniq
122
+ end
123
+
124
+ # Why no search path reaches the header `query` names, for the error its failed lookup
125
+ # raises. Nil when Ceedling refused no search path for it.
126
+ def refusal(query)
127
+ return @refusals[normalized( query )]
128
+ end
129
+
130
+ # The header at `path` itself, as its directory lists it, or nil. A preprocessor's #include
131
+ # names its header by such a path, which a search path joined with it could name another by.
132
+ def at(path)
133
+ path = normalized( path )
134
+ return nameable?( path ) ? named_in( File.dirname( path ), File.basename( path ) ) : nil
135
+ end
136
+
137
+ # A spelling that reaches `header` through these search paths: `preferring` when it does,
138
+ # then the header's filename, otherwise its path below the earliest search path that reaches
139
+ # it. Nil for none.
140
+ def spelling(header, preferring: nil)
141
+ target = location( header )
142
+ texts = [preferring, File.basename( header )] + @paths.filter_map { |path| ProjectPaths.subdir_below( path, header ) }
143
+
144
+ return texts.compact.uniq.find do |text|
145
+ found = joined( normalized( text ) ).first
146
+ !found.nil? and location( found ) == target
147
+ end
148
+ end
149
+
150
+ # Whether `header` lies in the build root. The compiler's search paths include the directories
151
+ # Ceedling generates headers in, which these paths leave out.
152
+ def generated?(header)
153
+ return !@build_root.nil? && ProjectPaths.contains?( @build_root, header )
154
+ end
155
+
156
+ # Every header directly in a search path, in search order
157
+ def flat
158
+ return @flat ||= @paths.flat_map { |path| listing( path ) }.uniq
159
+ end
160
+
161
+ private
162
+
163
+ def normalized(query)
164
+ return HeaderSearch.normalized( query )
165
+ end
166
+
167
+ # Each search path joined with the query's path, holding the query's file
168
+ def joined(query)
169
+ return [] unless joinable?( query )
170
+
171
+ name = File.basename( query )
172
+ return @paths.filter_map { |path| named_in( joined_directory( path, query ), name ) }
173
+ end
174
+
175
+ # A header directly in a search path whose trailing path is the query
176
+ def trailing(query)
177
+ return PathMatcher.candidates( query, flat )
178
+ end
179
+
180
+ # The query itself, when it names a header at or below a search path
181
+ def named(query)
182
+ return [] unless @paths.any? { |path| ProjectPaths.contains?( path, File.dirname( query ) ) }
183
+
184
+ return [at( query )].compact
185
+ end
186
+
187
+ # A relative path the compiler would join: no `..` and no glob character in its
188
+ # directory, which a listing would expand
189
+ def joinable?(query)
190
+ return false if PathMatcher.absolute?( query ) or File.dirname( query ).match?( GLOB_CHARACTERS )
191
+
192
+ return !ProjectPaths.segments( query ).include?( '..' )
193
+ end
194
+
195
+ def nameable?(query)
196
+ dir = File.dirname( query )
197
+ return (dir != '.' and !dir.match?( GLOB_CHARACTERS ))
198
+ end
199
+
200
+ def joined_directory(path, query)
201
+ dir = File.dirname( query )
202
+ return dir == '.' ? path : File.join( path, dir )
203
+ end
204
+
205
+ # One header reached through two spellings of one directory is one candidate
206
+ def distinct(found)
207
+ return found if found.length < 2
208
+
209
+ return found.uniq { |header| location( header ) }
210
+ end
211
+
212
+ def location(header)
213
+ absolute = ProjectPaths.absolute( header )
214
+ return ProjectPaths::WINDOWS ? absolute.downcase : absolute
215
+ end
216
+
217
+ def named_in(dir, name)
218
+ return @listings.named( dir, name )
219
+ end
220
+
221
+ def listing(dir)
222
+ return @listings.headers( dir )
223
+ end
224
+
225
+ end