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,132 @@
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/diagnostics/build_step_doctor'
9
+ require 'ceedling/diagnostics/toolchain_output'
10
+
11
+ # Explains #include directives nested deeper than a compiler allows.
12
+ #
13
+ # The nesting is almost always a loop. A forwarding header that includes its own
14
+ # filename, meaning to reach a header of that name elsewhere, finds itself again when
15
+ # its own directory comes first in the search paths. Headers that include each other
16
+ # without include guards loop the same way. The compiler stops at a fixed depth and
17
+ # reports the loop only as nesting too deep.
18
+ #
19
+ # The guidance always explains both loops. When the header the error names includes
20
+ # its own filename and the search paths lead back to it, the guidance also names the
21
+ # header, the path that loops, and any header of that name later in the search paths.
22
+ class IncludeDepthSpecialist
23
+
24
+ # Each family's wording for nesting too deep, ending in a generic net. Newer GCC quotes
25
+ # the directive, with curly quotes in a UTF-8 locale, so a few non-word characters may
26
+ # follow it.
27
+ INCLUDE_DEPTH_SYMPTOMS = [
28
+ # GCC 10 and later
29
+ /#include\W{1,4}nested depth \d+ exceeds maximum/i,
30
+ # Clang, armclang, and GCC before 10
31
+ /#include\W{1,4}nested too deeply/i,
32
+ # MSVC
33
+ /\bC1014\b|too many include files/i,
34
+ # EDG front ends: IAR, Arm armcc, TI, and Green Hills
35
+ /includes itself|include file nesting/i,
36
+ # Other compilers
37
+ /\binclude\w* (?:depth|nesting)|nested (?:#?include|too deep)|too many (?:nested )?include/i
38
+ ].freeze
39
+
40
+ INCLUDE_DIRECTIVE = /^[ \t]*#[ \t]*include[ \t]*([<"])([^>"\n]+)[>"]/
41
+
42
+ GUIDANCE = <<~GUIDANCE.freeze
43
+ HOW THIS HAPPENS:
44
+ • A compiler searches the include paths in order and uses the first file with the requested name.
45
+ • A forwarding header that #includes its own filename, to reach a header of that name elsewhere, finds itself again when its directory comes first.
46
+ • Two headers that #include each other without include guards repeat in the same way.
47
+ • The compiler stops at a fixed nesting limit and reports the loop as nesting too deep.
48
+
49
+ OPTIONS:
50
+ 1. Order :paths ↳ :include (or TEST_INCLUDE_PATH()) so the directory holding the intended header comes before the forwarding header's directory.
51
+ 2. List the forwarding header's parent directory instead, and #include it by its subdirectory, such as "freertos/timers.h".
52
+ 3. Give headers that include each other include guards or #pragma once.
53
+ GUIDANCE
54
+
55
+ constructor :file_wrapper
56
+
57
+ def diagnoses()
58
+ return [
59
+ BuildStepDoctor::Diagnosis.new(
60
+ name: :include_nested_too_deeply,
61
+ steps: [:preprocess, :compile],
62
+ symptoms: INCLUDE_DEPTH_SYMPTOMS,
63
+ examination: method( :examine )
64
+ )
65
+ ]
66
+ end
67
+
68
+ ### Private ###
69
+
70
+ private
71
+
72
+ def examine(kase)
73
+ lead = 'The compiler output appears to report #include directives nested too deeply, which usually means a header includes itself.'
74
+ finding = self_inclusion( error_header( kase.symptoms ), kase.inputs[:search_paths] || [] )
75
+ lead += "\n#{finding}" if finding
76
+
77
+ return "#{lead}\n\n#{GUIDANCE}"
78
+ end
79
+
80
+ # The header on the line that reports the error, or nil
81
+ def error_header(match)
82
+ line = match.pre_match[/[^\n]*\z/] + match[0] + match.post_match[/\A[^\n]*/]
83
+ return ToolchainOutput.headers( line ).first
84
+ end
85
+
86
+ # Explains the first #include in `header` that the search reaches it through again, or nil.
87
+ # The explanation names the header as the search found it. The output may spell it
88
+ # another way, such as Clang on Windows joining a search path and a name with '\'.
89
+ def self_inclusion(header, search_paths)
90
+ return nil if header.nil? || !@file_wrapper.exist?( header )
91
+
92
+ @file_wrapper.read( header ).scrub.scan( INCLUDE_DIRECTIVE ).each do |delimiter, name|
93
+ found = search( header, delimiter, name, search_paths )
94
+ next unless same_file?( found.first, header )
95
+
96
+ return looping_explanation( found.first, delimiter, name, found )
97
+ end
98
+
99
+ return nil
100
+ end
101
+
102
+ # Every file an #include of `name` in `header` can reach, in the order the compiler searches.
103
+ # A quoted #include searches its own file's directory before the search paths.
104
+ def search(header, delimiter, name, search_paths)
105
+ directories = (delimiter == '"' ? [File.dirname( header )] : []) + search_paths
106
+
107
+ return directories.map { |directory| File.join( directory, name ) }.select { |path| @file_wrapper.exist?( path ) }
108
+ end
109
+
110
+ # A quoted #include loops whatever the search path order, so only an angled one is
111
+ # blamed on that order
112
+ def looping_explanation(header, delimiter, name, found)
113
+ intended = found.find { |path| !same_file?( path, header ) }
114
+
115
+ if delimiter == '"'
116
+ explanation = "'#{header}' includes \"#{name}\". A quoted #include searches the header's own directory before any search path, " \
117
+ 'so it includes itself whatever their order.'
118
+ return intended ? "#{explanation} '#{intended}' is in the search paths, and #include <#{name}> would let their order reach it." : explanation
119
+ end
120
+
121
+ explanation = "'#{header}' includes <#{name}>, and the search paths find that name in the header's own directory first " \
122
+ "('#{File.dirname( found.first )}'), so it includes itself."
123
+ return intended ? "#{explanation} '#{intended}' is later in the search paths." : explanation
124
+ end
125
+
126
+ # A symlink or a difference in case can name one file two ways
127
+ def same_file?(path, other)
128
+ return false if path.nil?
129
+
130
+ return File.expand_path( path ) == File.expand_path( other ) || File.identical?( path, other )
131
+ end
132
+ end
@@ -0,0 +1,111 @@
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/diagnostics/build_step_doctor'
9
+ require 'ceedling/diagnostics/guidance_phrases'
10
+
11
+ # Explains linker errors for symbols no linked object defines.
12
+ #
13
+ # A test executable links only the sources its #include directives name by Ceedling's
14
+ # convention, plus any TEST_SOURCE_FILE() adds. A missing symbol most often means that
15
+ # convention left out a source the test needs.
16
+ class MissingSymbolSpecialist
17
+
18
+ # Each family's wording for a symbol no object defines, ending in a generic net. A
19
+ # duplicate symbol is left to DuplicateSymbolSpecialist, whose advice differs.
20
+ MISSING_SYMBOL_SYMPTOMS = [
21
+ # GNU ld, and Microchip XC16 and XC32
22
+ /undefined reference to/i,
23
+ # LLD, Apple ld, and Arm armlink (L6218E)
24
+ /undefined symbol|symbol\(s\) not found|\bL6218E\b/i,
25
+ # MSVC
26
+ /\bLNK20(?:19|01)\b|unresolved external symbol/i,
27
+ # IAR ILINK
28
+ /\bLi005\b|no definition for/i,
29
+ # TI
30
+ /undefined\s+first referenced|unresolved symbols remain/i,
31
+ # Green Hills, TASKING, SDCC, and other linkers
32
+ /undefined (?:global|external)|unresolved (?:external|symbol)/i
33
+ ].freeze
34
+
35
+ constructor :configurator
36
+
37
+ def diagnoses()
38
+ return [
39
+ BuildStepDoctor::Diagnosis.new(
40
+ name: :missing_symbols,
41
+ steps: [:link],
42
+ symptoms: MISSING_SYMBOL_SYMPTOMS,
43
+ examination: ->(_case) { prescription() }
44
+ )
45
+ ]
46
+ end
47
+
48
+ ### Private ###
49
+
50
+ private
51
+
52
+ def prescription()
53
+ return causes() + "\n" + note() + "\n" + options()
54
+ end
55
+
56
+ def causes()
57
+ return "The linker output appears to report missing symbols. If so, the following may be to blame:\n" + numbered( [
58
+ 'This test lacks #include statements corresponding to needed source files (see note below).',
59
+ 'Project file paths omit source files corresponding to #include statements in this test.',
60
+ macro_cause(),
61
+ ('This test does not #include needed mocks (that triggers their generation).' if mocks?),
62
+ ("A Partial in this test leaves out a function the test or the Partial's code calls. " \
63
+ 'A Partial carries only the functions its directive selects.' if partials?)
64
+ ] )
65
+ end
66
+
67
+ # Without test preprocessing, #include statements are read as text, so a macro or
68
+ # #ifdef can hide or invent one. With it, the preprocessor evaluates them.
69
+ def macro_cause()
70
+ return 'Complex macros, #ifdefs, etc. have obscured correct #include statements in this test.' unless preprocessing?
71
+
72
+ return "Macros or #ifdefs, evaluated with this test's defines, leave out an #include statement the test needs."
73
+ end
74
+
75
+ def note()
76
+ notice = "NOTE: A test file directs the build of a test executable with #include statements:\n" \
77
+ "• By convention, Ceedling assumes header filenames correspond to source filenames.\n" \
78
+ "• Which code files to compile and link are determined by #include statements.\n"
79
+ notice += "• An #include statement convention directs the generation of mocks from header files.\n" if mocks?
80
+
81
+ return notice
82
+ end
83
+
84
+ def options()
85
+ return "OPTIONS:\n" + numbered( [
86
+ "Doublecheck this test's #include statements.",
87
+ 'Simplify complex macros or fully specify symbols for this test in :project ↳ :defines.',
88
+ ('Enable test preprocessing with :project ↳ :use_test_preprocessor, so macros and #ifdefs decide which #include statements count.' unless preprocessing?),
89
+ 'If no header file corresponds to the needed source file, use the TEST_SOURCE_FILE() build directive macro in this test to inject a source file into the build.',
90
+ "Mock the header that declares a missing function, so the mock supplies it.#{GuidancePhrases.requirements( mocks: mocks? )}",
91
+ ("Select a function a Partial left out with +name in its directive, or select the whole module with TEST_PARTIAL_ALL_MODULE." if partials?)
92
+ ] ) + "\nSee the docs on conventions, paths, preprocessing, compilation symbols, and build directive macros.\n"
93
+ end
94
+
95
+ # Numbers the items present, one per line
96
+ def numbered(items)
97
+ return items.compact.each_with_index.map { |item, index| "#{index + 1}. #{item}\n" }.join
98
+ end
99
+
100
+ def mocks?()
101
+ return @configurator.project_use_mocks
102
+ end
103
+
104
+ def partials?()
105
+ return @configurator.project_use_partials
106
+ end
107
+
108
+ def preprocessing?()
109
+ return @configurator.project_use_test_preprocessor_tests
110
+ end
111
+ end
@@ -0,0 +1,134 @@
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/diagnostics/build_step_doctor'
9
+
10
+ # Explains a test file's compilation error for a name one of ceedling.h's Partials macros built.
11
+ #
12
+ # PARTIAL_LOCAL_VAR(), PARTIAL_TYPE() and PARTIAL_LOCAL_TYPE() paste their arguments into one
13
+ # identifier as the test compiles. An argument that doesn't match the module builds a name
14
+ # nothing declares, and the compiler reports only that name, not the macro's arguments.
15
+ class PartialNameSpecialist
16
+
17
+ # Each family's wording for a name nothing declares, as a variable or as a type, ending in a
18
+ # generic net. A false match costs a hedged note, and the examination asks for a name the
19
+ # macros build besides.
20
+ UNDECLARED_SYMPTOMS = [
21
+ # GCC and Clang, Microchip XC8, XC16 and XC32, and armclang
22
+ /undeclared|unknown type name/i,
23
+ # MSVC
24
+ /\bC(?:2065|2061|4430|2146)\b/,
25
+ # EDG front ends: IAR, armcc, TI and Green Hills
26
+ /\bPe0*20\b|#20(?!\d)|identifier\s+"[^"\n]*"\s+is\s+undefined/i,
27
+ # SDCC, TASKING and other compilers
28
+ /undefined identifier|not declared|unknown type|is not a type/i
29
+ ].freeze
30
+
31
+ # An identifier, scanned whole so each token is tested once
32
+ IDENTIFIER = /[A-Za-z_$][\w$]*/
33
+
34
+ # The names the macros build, and the macros themselves as a note on an expansion names them
35
+ LOCAL_VAR = /\Apartial_[\w$]+\z/
36
+ TYPE = /\Aceedling_partial_[\w$]+_t\z/
37
+ LOCAL_VAR_MACRO = 'PARTIAL_LOCAL_VAR'
38
+ TYPE_MACROS = ['PARTIAL_TYPE', 'PARTIAL_LOCAL_TYPE'].freeze
39
+
40
+ # How many of a test's real names a prescription lists
41
+ NAMES_LISTED = 12
42
+
43
+ LOCAL_VAR_GUIDANCE = <<~GUIDANCE.freeze
44
+ HOW THIS HAPPENS:
45
+ • PARTIAL_LOCAL_VAR(function, variable) pastes its arguments into one name, partial_<function>_<variable>, as the test compiles.
46
+ • Each argument must match the module's source exactly, case included. A misspelling builds a name nothing declares.
47
+ • Only a variable declared static inside a function is promoted. A variable at file scope keeps its own name.
48
+ • The macro builds a name the compiler reads. It can't take a string or a runtime value.
49
+ • A test reaches promoted variables through a TEST_PARTIAL_*_MODULE() macro. A MOCK_PARTIAL_*_MODULE() macro provides none.
50
+
51
+ OPTIONS:
52
+ 1. Check each argument against the function and its static variable in the module's source.
53
+ 2. Name a variable at file scope directly, without the macro.
54
+ 3. Include the module with a TEST_PARTIAL_*_MODULE() macro.%{names}
55
+ GUIDANCE
56
+
57
+ TYPE_GUIDANCE = <<~GUIDANCE.freeze
58
+ HOW THIS HAPPENS:
59
+ • A Partial names the type of a variable declared together with its type, as in `static struct { int count; } s_ctx;`.
60
+ • PARTIAL_TYPE(module, variable) and PARTIAL_LOCAL_TYPE(module, function, variable) paste their arguments into that name as the test compiles.
61
+ • The module argument is the module's name alone, without a directory. A character a C identifier can't hold is written as `_`, as in my_sensor for my-sensor.
62
+ • Variables declared in one statement share one type, named for the first of them.
63
+ • A variable whose type is named elsewhere, as in `static struct ctx s_ctx;`, uses that name, here `struct ctx`.
64
+
65
+ OPTIONS:
66
+ 1. Check each argument against the module's name and its declaration, case included.
67
+ 2. Use PARTIAL_LOCAL_TYPE() for a static declared inside a function, with the function's name.
68
+ 3. Write a type named elsewhere by its own name.%{names}
69
+ GUIDANCE
70
+
71
+ constructor :configurator, :file_wrapper
72
+
73
+ def diagnoses()
74
+ return [
75
+ BuildStepDoctor::Diagnosis.new(
76
+ name: :partial_local_var, steps: [:compile], symptoms: UNDECLARED_SYMPTOMS, examination: method( :examine_local_var )
77
+ ),
78
+ BuildStepDoctor::Diagnosis.new(
79
+ name: :partial_type, steps: [:compile], symptoms: UNDECLARED_SYMPTOMS, examination: method( :examine_type )
80
+ )
81
+ ]
82
+ end
83
+
84
+ ### Private ###
85
+
86
+ private
87
+
88
+ def examine_local_var(kase)
89
+ return nil unless names?( kase, LOCAL_VAR, [LOCAL_VAR_MACRO] )
90
+
91
+ lead = 'The compiler output appears to report a name that PARTIAL_LOCAL_VAR() builds and nothing declares. ' \
92
+ "If so, the macro's arguments may not match a static variable inside one of the module's functions."
93
+ return "#{lead}\n\n" + format( LOCAL_VAR_GUIDANCE, names: listed( kase, LOCAL_VAR, 'Promoted variables' ) )
94
+ end
95
+
96
+ def examine_type(kase)
97
+ return nil unless names?( kase, TYPE, TYPE_MACROS )
98
+
99
+ lead = 'The compiler output appears to report a type that PARTIAL_TYPE() or PARTIAL_LOCAL_TYPE() names and nothing declares. ' \
100
+ "If so, the macro's arguments may not match a variable declared together with its type."
101
+ return "#{lead}\n\n" + format( TYPE_GUIDANCE, names: listed( kase, TYPE, 'Type names' ) )
102
+ end
103
+
104
+ # Whether the failure is the test file's own, in a build with Partials, and names something a
105
+ # macro builds, or the macro itself
106
+ def names?(kase, shape, macros)
107
+ return false unless @configurator.project_use_partials and test_file?( kase )
108
+
109
+ return kase.output.scan( IDENTIFIER ).any? { |token| token.match?( shape ) or macros.include?( token ) }
110
+ end
111
+
112
+ def test_file?(kase)
113
+ testable = kase.inputs[:testable]
114
+ return (testable and kase.inputs[:source] == testable.filepath)
115
+ end
116
+
117
+ # The names of a shape this test's Partials provide, as one more option, or nothing when none
118
+ # can be read. Generation writes them into the test's own generated headers.
119
+ def listed(kase, shape, label)
120
+ names = provided( kase.inputs[:testable], shape )
121
+ return '' if names.empty?
122
+
123
+ more = names.size > NAMES_LISTED ? ', …' : ''
124
+ return "\n4. #{label} this test's Partials provide: #{names.first( NAMES_LISTED ).join( ', ' )}#{more}"
125
+ end
126
+
127
+ def provided(testable, shape)
128
+ dir = testable.paths && testable.paths[:partials]
129
+ return [] unless dir
130
+
131
+ headers = @file_wrapper.directory_listing( File.join( dir, '**', '*.h' ) )
132
+ return headers.flat_map { |header| @file_wrapper.read( header ).scan( IDENTIFIER ) }.select { |token| token.match?( shape ) }.uniq.sort
133
+ end
134
+ end
@@ -0,0 +1,44 @@
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
+ # Reads the file paths a toolchain's output mentions.
9
+ #
10
+ # Toolchains place a path in many ways: `a.h:12:3` (GCC, Clang), `"a.h",12` (IAR),
11
+ # `"a.h", line 12` (Arm armcc, TI, Green Hills), `a.h(12)` (MSVC), and inside prose such
12
+ # as `declared at line 5 of "a.h"`. Rather than parse each format, a path is any token
13
+ # that ends in a wanted extension. A double-quoted path may hold spaces. An unquoted one
14
+ # ends at whitespace or punctuation no path holds, apart from a Windows drive letter's
15
+ # colon. Reading too much is safe here: a caller compares each path against files it
16
+ # knows, so a stray match finds nothing.
17
+ module ToolchainOutput
18
+ HEADER_EXTENSIONS = %w[h hh hpp hxx].freeze
19
+
20
+ # Characters that end an unquoted path
21
+ PATH_STOP = %q{\s"'`(),:;<>\[\]}
22
+
23
+ # Headers the output names, each once, in order of first mention
24
+ def self.headers(output)
25
+ return paths( output, "(?:#{HEADER_EXTENSIONS.join( '|' )})" )
26
+ end
27
+
28
+ # Object files the output names, each once, in order of first mention
29
+ def self.objects(output, extension:)
30
+ return paths( output, Regexp.escape( extension.delete_prefix( '.' ) ) )
31
+ end
32
+
33
+ # Tokens are scanned whole, quoted strings first, and each is kept only when it ends in
34
+ # the extension. Testing the ending after the scan keeps the pass linear on long tokens.
35
+ def self.paths(output, extension)
36
+ return [] if output.nil?
37
+
38
+ ending = /\.#{extension}\z/i
39
+ tokens = output.scan( /"([^"\n]*)"|((?:[A-Za-z]:)?[^#{PATH_STOP}]+)/ ).map { |quoted, bare| quoted || bare }
40
+
41
+ return tokens.select { |token| token.match?( ending ) }.uniq
42
+ end
43
+ private_class_method :paths
44
+ end
@@ -5,7 +5,7 @@
5
5
  # SPDX-License-Identifier: MIT
6
6
  # =========================================================================
7
7
 
8
- require 'ceedling/file_path_utils'
8
+ require 'ceedling/filesystem/file_path_utils'
9
9
 
10
10
  # A configured filename-extension setting for one file type (source, header,
11
11
  # assembly, and so on). A project may name a file type with a single
@@ -51,6 +51,12 @@ class FilenameExtension
51
51
  @extensions.include?(File.extname(filepath))
52
52
  end
53
53
 
54
+ # A regex source matching any one of this type's extensions, each escaped, as one
55
+ # non-capturing group, for a pattern naming a file of this type by its ending
56
+ def pattern
57
+ return "(?:#{@extensions.map { |ext| Regexp.escape( ext ) }.join( '|' )})"
58
+ end
59
+
54
60
  # Every filename `basename` could take on under this type, one per
55
61
  # configured extension. Used to search a directory for a file of this
56
62
  # type when its extension isn't known in advance -- a build input file