ceedling 1.2.2 → 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 (390) hide show
  1. checksums.yaml +4 -4
  2. data/GIT_COMMIT_SHA +1 -1
  3. data/README.md +1 -1
  4. data/assets/fixtures/tests_with_partials_coverage/src/private_macro.c +7 -0
  5. data/assets/fixtures/tests_with_partials_coverage/src/private_macro.h +5 -0
  6. data/assets/fixtures/tests_with_partials_coverage/src/tally.c +13 -0
  7. data/assets/fixtures/tests_with_partials_coverage/src/tally.h +4 -0
  8. data/assets/fixtures/tests_with_partials_coverage/test/test_private_macro.c +10 -0
  9. data/assets/fixtures/tests_with_partials_coverage/test/test_tally.c +9 -0
  10. data/docs/BreakingChanges.md +16 -0
  11. data/docs/Changelog.md +71 -0
  12. data/docs/KnownIssues.md +91 -4
  13. data/examples/wondrous_forest/README.md +29 -1
  14. data/examples/wondrous_forest/src/ForestUnits.h +23 -0
  15. data/examples/wondrous_forest/src/RainGauge.c +59 -0
  16. data/examples/wondrous_forest/src/RainGauge.h +39 -0
  17. data/examples/wondrous_forest/src/RainTipIsr.c +17 -0
  18. data/examples/wondrous_forest/src/RainTipIsr.h +14 -0
  19. data/examples/wondrous_forest/test/TestRainGauge.c +126 -0
  20. data/lib/ceedling/c_extractor/README.md +15 -7
  21. data/lib/ceedling/c_extractor/c_extractor.rb +25 -14
  22. data/lib/ceedling/c_extractor/c_extractor_code_text.rb +84 -54
  23. data/lib/ceedling/c_extractor/c_extractor_constants.rb +18 -7
  24. data/lib/ceedling/c_extractor/c_extractor_declarations.rb +319 -283
  25. data/lib/ceedling/c_extractor/c_extractor_declarator.rb +285 -0
  26. data/lib/ceedling/c_extractor/c_extractor_defined_type.rb +111 -0
  27. data/lib/ceedling/c_extractor/c_extractor_definitions.rb +174 -121
  28. data/lib/ceedling/c_extractor/c_extractor_functions.rb +191 -162
  29. data/lib/ceedling/c_extractor/c_extractor_preprocessing.rb +46 -55
  30. data/lib/ceedling/c_extractor/c_extractor_statement.rb +30 -0
  31. data/lib/ceedling/c_extractor/c_extractor_types.rb +63 -41
  32. data/lib/ceedling/c_extractor/c_module_edits.rb +48 -0
  33. data/lib/ceedling/c_identifier.rb +21 -0
  34. data/lib/ceedling/ceedling.h +8 -0
  35. data/lib/ceedling/config/configurator.rb +4 -3
  36. data/lib/ceedling/config/configurator_builder.rb +17 -0
  37. data/lib/ceedling/config/configurator_setup.rb +29 -5
  38. data/lib/ceedling/constants.rb +5 -1
  39. data/lib/ceedling/defaults.rb +31 -1
  40. data/lib/ceedling/dependencies/CACHE_SCHEMA.md +118 -0
  41. data/lib/ceedling/dependencies/README.md +1 -1
  42. data/lib/ceedling/dependencies/dependency_cache_store.rb +30 -25
  43. data/lib/ceedling/dependencies/dependency_tracker.rb +9 -3
  44. data/lib/ceedling/dependencies/dependinator.rb +13 -1
  45. data/lib/ceedling/diagnostics/DOCTOR.md +142 -0
  46. data/lib/ceedling/diagnostics/README.md +5 -0
  47. data/lib/ceedling/diagnostics/build_step_doctor.rb +110 -0
  48. data/lib/ceedling/diagnostics/duplicate_symbol_specialist.rb +108 -0
  49. data/lib/ceedling/diagnostics/guidance_phrases.rb +30 -0
  50. data/lib/ceedling/diagnostics/header_collision_guidance.rb +56 -0
  51. data/lib/ceedling/diagnostics/header_collision_specialist.rb +152 -0
  52. data/lib/ceedling/diagnostics/include_depth_specialist.rb +132 -0
  53. data/lib/ceedling/diagnostics/missing_symbol_specialist.rb +111 -0
  54. data/lib/ceedling/diagnostics/partial_name_specialist.rb +134 -0
  55. data/lib/ceedling/diagnostics/toolchain_output.rb +44 -0
  56. data/lib/ceedling/filesystem/PATH_HANDLING.md +83 -27
  57. data/lib/ceedling/filesystem/README.md +6 -1
  58. data/lib/ceedling/filesystem/build_roots.rb +105 -0
  59. data/lib/ceedling/filesystem/build_subpath.rb +110 -25
  60. data/lib/ceedling/filesystem/file_finder.rb +76 -110
  61. data/lib/ceedling/filesystem/file_finder_helper.rb +33 -11
  62. data/lib/ceedling/filesystem/file_path_utils.rb +113 -91
  63. data/lib/ceedling/filesystem/file_wrapper.rb +105 -28
  64. data/lib/ceedling/filesystem/path_matcher.rb +21 -0
  65. data/lib/ceedling/filesystem/test_build_layout.rb +114 -0
  66. data/lib/ceedling/filesystem/win_long_paths.rb +153 -0
  67. data/lib/ceedling/filesystem/win_path_limit.rb +83 -0
  68. data/lib/ceedling/filesystem/win_path_prober.rb +52 -0
  69. data/lib/ceedling/generators/generator.rb +27 -64
  70. data/lib/ceedling/generators/generator_helper.rb +0 -44
  71. data/lib/ceedling/generators/generator_mocks.rb +5 -0
  72. data/lib/ceedling/generators/generator_partials.rb +305 -243
  73. data/lib/ceedling/generators/generator_test_runner.rb +5 -8
  74. data/lib/ceedling/generators/partial_header_writer.rb +95 -0
  75. data/lib/ceedling/generators/partial_source_writer.rb +137 -0
  76. data/lib/ceedling/includes/header_search.rb +225 -0
  77. data/lib/ceedling/includes/include_factory.rb +9 -12
  78. data/lib/ceedling/includes/include_pathinator.rb +53 -31
  79. data/lib/ceedling/includes/includes.rb +149 -37
  80. data/lib/ceedling/objects.yml +89 -4
  81. data/lib/ceedling/partials/README.md +110 -16
  82. data/lib/ceedling/partials/carry_plan.rb +71 -0
  83. data/lib/ceedling/partials/definition_head.rb +74 -0
  84. data/lib/ceedling/partials/include_groups.rb +37 -0
  85. data/lib/ceedling/partials/interface_extras.rb +25 -0
  86. data/lib/ceedling/partials/partializer.rb +599 -120
  87. data/lib/ceedling/partials/partializer_config.rb +5 -0
  88. data/lib/ceedling/partials/partializer_helper.rb +851 -145
  89. data/lib/ceedling/partials/partializer_reconciler.rb +174 -0
  90. data/lib/ceedling/partials/partializer_utils.rb +89 -109
  91. data/lib/ceedling/partials/partials.rb +153 -10
  92. data/lib/ceedling/partials/type_macros.rb +126 -0
  93. data/lib/ceedling/preprocess/README.md +43 -33
  94. data/lib/ceedling/preprocess/preprocessinator.rb +100 -186
  95. data/lib/ceedling/preprocess/preprocessinator_code_finder.rb +65 -72
  96. data/lib/ceedling/preprocess/preprocessinator_file_assembler.rb +31 -75
  97. data/lib/ceedling/preprocess/preprocessinator_reconstructor.rb +51 -14
  98. data/lib/ceedling/setupinator.rb +16 -3
  99. data/lib/ceedling/test_invoker/HEADER_COLLISIONS.md +21 -7
  100. data/lib/ceedling/test_invoker/PIPELINE.md +57 -16
  101. data/lib/ceedling/test_invoker/README.md +1 -1
  102. data/lib/ceedling/test_invoker/derived_search_path_notices.rb +45 -0
  103. data/lib/ceedling/test_invoker/mock_locator.rb +116 -9
  104. data/lib/ceedling/test_invoker/partial_files_preprocessinator.rb +181 -0
  105. data/lib/ceedling/test_invoker/partials_manager.rb +265 -308
  106. data/lib/ceedling/test_invoker/standin_headerinator.rb +8 -15
  107. data/lib/ceedling/test_invoker/test_bare_includes_extractinator.rb +26 -3
  108. data/lib/ceedling/test_invoker/test_build_executor.rb +338 -198
  109. data/lib/ceedling/test_invoker/test_build_planner.rb +13 -19
  110. data/lib/ceedling/test_invoker/test_build_setup.rb +26 -6
  111. data/lib/ceedling/test_invoker/test_build_validations.rb +23 -20
  112. data/lib/ceedling/test_invoker/test_derived_search_paths.rb +189 -0
  113. data/lib/ceedling/test_invoker/test_file_preprocessinator.rb +1 -2
  114. data/lib/ceedling/test_invoker/test_includes_reconcilinator.rb +1 -1
  115. data/lib/ceedling/test_invoker/test_invoker_types.rb +28 -20
  116. data/lib/ceedling/test_invoker/test_pipeline_helpers.rb +5 -3
  117. data/lib/ceedling/test_invoker/test_pipeline_manager.rb +25 -8
  118. data/lib/ceedling/test_invoker/test_runner_generatinator.rb +31 -3
  119. data/lib/ceedling/test_invoker/test_search_paths.rb +30 -8
  120. data/lib/ceedling/test_invoker/test_substitutions.rb +72 -0
  121. data/lib/ceedling/tools/shell_quoting.rb +45 -0
  122. data/lib/ceedling/tools/tool_quoting.rb +79 -0
  123. data/lib/ceedling/{tool_validator.rb → tools/tool_validator.rb} +18 -7
  124. data/lib/version.rb +1 -1
  125. data/plugins/bullseye/bullseye.rake +1 -3
  126. data/plugins/bullseye/lib/bullseye.rb +15 -2
  127. data/plugins/command_hooks/lib/command_hooks.rb +1 -1
  128. data/plugins/fff/lib/fff.rb +42 -15
  129. data/plugins/fff/lib/fff_mock_generator.rb +12 -9
  130. data/plugins/fff/spec/fff_cmock_wrapper_spec.rb +134 -0
  131. data/plugins/fff/spec/fff_mock_header_generator_spec.rb +9 -0
  132. data/plugins/fff/spec/fff_mock_source_generator_spec.rb +20 -0
  133. data/plugins/gcov/lib/console_reportinator.rb +25 -19
  134. data/plugins/gcov/lib/reportgenerator_reportinator.rb +2 -1
  135. data/site-local/404.html +2 -2
  136. data/site-local/assets/javascripts/{bundle.c21346df.min.js → bundle.a5f9d56c.min.js} +1 -1
  137. data/site-local/assets/javascripts/{bundle.c21346df.min.js.map → bundle.a5f9d56c.min.js.map} +2 -2
  138. data/site-local/configuration/environment-vars.html +2 -2
  139. data/site-local/configuration/global-collections.html +3 -3
  140. data/site-local/configuration/index.html +2 -2
  141. data/site-local/configuration/loading.html +2 -2
  142. data/site-local/configuration/mixins.html +2 -2
  143. data/site-local/configuration/parallel-builds.html +2 -2
  144. data/site-local/configuration/project-file.html +2 -2
  145. data/site-local/configuration/reference/cexception.html +2 -2
  146. data/site-local/configuration/reference/cmock.html +5 -2
  147. data/site-local/configuration/reference/defines.html +2 -2
  148. data/site-local/configuration/reference/environment.html +2 -2
  149. data/site-local/configuration/reference/extension.html +2 -2
  150. data/site-local/configuration/reference/files.html +56 -9
  151. data/site-local/configuration/reference/flags.html +2 -2
  152. data/site-local/configuration/reference/index.html +2 -2
  153. data/site-local/configuration/reference/libraries.html +2 -2
  154. data/site-local/configuration/reference/mixins.html +2 -2
  155. data/site-local/configuration/reference/partials.html +84 -2
  156. data/site-local/configuration/reference/paths.html +7 -2
  157. data/site-local/configuration/reference/plugins.html +2 -2
  158. data/site-local/configuration/reference/project.html +247 -5
  159. data/site-local/configuration/reference/release-build.html +2 -2
  160. data/site-local/configuration/reference/test-build.html +2 -2
  161. data/site-local/configuration/reference/test-runner.html +2 -2
  162. data/site-local/configuration/reference/tools.html +49 -4
  163. data/site-local/configuration/reference/unity.html +2 -2
  164. data/site-local/configuration/which-ceedling.html +2 -2
  165. data/site-local/development/index.html +2 -2
  166. data/site-local/development/plugins/configuration.html +2 -2
  167. data/site-local/development/plugins/index.html +2 -2
  168. data/site-local/development/plugins/plugin-subclass.html +5 -4
  169. data/site-local/development/plugins/rake-tasks.html +2 -2
  170. data/site-local/development/releases.html +2 -2
  171. data/site-local/development/workflow.html +2 -2
  172. data/site-local/getting-started/builds.html +2 -2
  173. data/site-local/getting-started/command-line.html +2 -2
  174. data/site-local/getting-started/example-projects/cipher-quest.html +2 -2
  175. data/site-local/getting-started/example-projects/index.html +2 -2
  176. data/site-local/getting-started/example-projects/temp-sensor.html +2 -2
  177. data/site-local/getting-started/example-projects/wondrous-forest.html +10 -2
  178. data/site-local/getting-started/index.html +2 -2
  179. data/site-local/getting-started/installation.html +2 -2
  180. data/site-local/getting-started/quick-start.html +2 -2
  181. data/site-local/help.html +2 -2
  182. data/site-local/index.html +2 -2
  183. data/site-local/overview/build-system.html +2 -2
  184. data/site-local/overview/index.html +2 -2
  185. data/site-local/overview/test-environments.html +2 -2
  186. data/site-local/overview/tools-and-frameworks.html +2 -2
  187. data/site-local/plugins/beep.html +2 -2
  188. data/site-local/plugins/bullseye/index.html +45 -38
  189. data/site-local/plugins/bullseye/licensing.html +2 -2
  190. data/site-local/plugins/command-hooks.html +4 -4
  191. data/site-local/plugins/compile-commands-json-db.html +2 -2
  192. data/site-local/plugins/cppcheck.html +2 -2
  193. data/site-local/plugins/dependencies.html +2 -2
  194. data/site-local/plugins/fff.html +16 -2
  195. data/site-local/plugins/gcov/examples.html +2 -2
  196. data/site-local/plugins/gcov/gcovr.html +8 -2
  197. data/site-local/plugins/gcov/index.html +2 -2
  198. data/site-local/plugins/gcov/overview.html +2 -2
  199. data/site-local/plugins/gcov/reportgenerator.html +18 -14
  200. data/site-local/plugins/gcov/reporting.html +2 -2
  201. data/site-local/plugins/gcov/setup.html +2 -2
  202. data/site-local/plugins/gcov/tool-versions.html +2 -2
  203. data/site-local/plugins/gcov/troubleshooting.html +2 -2
  204. data/site-local/plugins/index.html +2 -2
  205. data/site-local/plugins/module-generator.html +2 -2
  206. data/site-local/plugins/report-build-warnings-log.html +2 -2
  207. data/site-local/plugins/report-tests-gtestlike-stdout.html +2 -2
  208. data/site-local/plugins/report-tests-ide-stdout.html +2 -2
  209. data/site-local/plugins/report-tests-log-factory.html +2 -2
  210. data/site-local/plugins/report-tests-pretty-stdout.html +2 -2
  211. data/site-local/plugins/report-tests-raw-output-log.html +2 -2
  212. data/site-local/plugins/report-tests-teamcity-stdout.html +2 -2
  213. data/site-local/plugins/sanitize.html +2 -2
  214. data/site-local/plugins/valgrind.html +2 -2
  215. data/site-local/project/index.html +2 -2
  216. data/site-local/project/release-history.html +2 -2
  217. data/site-local/project/sbom.html +2 -2
  218. data/site-local/project/upgrade.html +2 -2
  219. data/site-local/reference/build-directives.html +2 -2
  220. data/site-local/reference/command-line.html +2 -2
  221. data/site-local/reference/environment-vars.html +2 -2
  222. data/site-local/reference/gcov-plugin.html +2 -2
  223. data/site-local/reference/global-collections.html +12 -12
  224. data/site-local/reference/index.html +2 -2
  225. data/site-local/reference/partials-macros.html +47 -2
  226. data/site-local/reference/project-configuration.html +2 -2
  227. data/site-local/sitemap.xml.gz +0 -0
  228. data/site-local/snapshot/examples/cipher_quest/index.html +2 -2
  229. data/site-local/snapshot/examples/temp_sensor/index.html +2 -2
  230. data/site-local/snapshot/examples/wondrous_forest/index.html +72 -15
  231. data/site-local/testing-guide/build-directives.html +2 -2
  232. data/site-local/testing-guide/conventions.html +67 -22
  233. data/site-local/testing-guide/frameworks.html +2 -2
  234. data/site-local/testing-guide/index.html +2 -2
  235. data/site-local/testing-guide/partials/configuration.html +31 -4
  236. data/site-local/testing-guide/partials/conventions.html +509 -8
  237. data/site-local/testing-guide/partials/directives.html +4 -3
  238. data/site-local/testing-guide/partials/example.html +2 -2
  239. data/site-local/testing-guide/partials/index.html +2 -2
  240. data/site-local/testing-guide/partials/overview.html +30 -12
  241. data/site-local/testing-guide/partials/variables.html +169 -4
  242. data/site-local/testing-guide/test-cases.html +2 -2
  243. data/site-local/testing-guide/test-sample.html +2 -2
  244. data/site-local/testing-guide/test-suite-anatomy.html +2 -2
  245. data/spec/integration/build_step_doctor_spec.rb +270 -0
  246. data/spec/integration/c_extractor_composition_spec.rb +254 -4
  247. data/spec/integration/includes_extraction_spec.rb +27 -14
  248. data/spec/integration/nested_test_artifacts_spec.rb +1 -1
  249. data/spec/integration/partial_files_preprocessing_spec.rb +128 -0
  250. data/spec/integration/partials_carry_spec.rb +520 -0
  251. data/spec/integration/partials_declarations_spec.rb +655 -0
  252. data/spec/integration/partials_fallback_preprocessing_spec.rb +65 -0
  253. data/spec/integration/partials_function_pointers_spec.rb +277 -0
  254. data/spec/integration/partials_header_composition_spec.rb +268 -35
  255. data/spec/integration/partials_macro_decorators_spec.rb +267 -0
  256. data/spec/integration/partials_module_resolution_spec.rb +26 -19
  257. data/spec/integration/partials_symbol_linkage_spec.rb +13 -0
  258. data/spec/integration/path_length_reporting_spec.rb +64 -0
  259. data/spec/integration/path_scenarios_spec.rb +80 -3
  260. data/spec/integration/quote_include_isolator_spec.rb +56 -0
  261. data/spec/integration/test_build_parallel_barrier_spec.rb +1 -1
  262. data/spec/integration/test_includes_extractinator_spec.rb +70 -5
  263. data/spec/integration/test_naming_spec.rb +6 -3
  264. data/spec/integration/test_source_file_checks_spec.rb +5 -3
  265. data/spec/integration/tool_executor_spec.rb +1 -1
  266. data/spec/integration/tool_validator_spec.rb +2 -2
  267. data/spec/integration/win_long_paths_probe_spec.rb +46 -0
  268. data/spec/integration/win_path_limit_spec.rb +53 -0
  269. data/spec/integration/windows_registry_query_tool_spec.rb +41 -0
  270. data/spec/support/integration/configurator_integration_helper.rb +8 -3
  271. data/spec/support/integration/partial_files_harness.rb +181 -0
  272. data/spec/support/integration/partials_generation_integration_helper.rb +237 -141
  273. data/spec/support/integration/path_scenario_harness.rb +4 -2
  274. data/spec/support/integration/spec_integration_helper.rb +8 -3
  275. data/spec/support/integration/test_includes_harness.rb +56 -35
  276. data/spec/support/integration/tool_executor_integration_helper.rb +14 -2
  277. data/spec/system/bullseye_deployment_spec.rb +2 -0
  278. data/spec/system/delta_builds_spec.rb +26 -12
  279. data/spec/system/encoding_stress_spec.rb +4 -4
  280. data/spec/system/example_wondrous_forest_spec.rb +2 -2
  281. data/spec/system/gcov_deployment_spec.rb +2 -0
  282. data/spec/system/header_include_path_validation_spec.rb +4 -4
  283. data/spec/system/header_search_paths_spec.rb +1083 -0
  284. data/spec/system/mock_include_folders_spec.rb +121 -0
  285. data/spec/system/mockable_header_reassembly_spec.rb +184 -0
  286. data/spec/system/partials_carry_spec.rb +581 -0
  287. data/spec/system/partials_delta_builds_spec.rb +280 -0
  288. data/spec/system/partials_function_pointers_spec.rb +106 -0
  289. data/spec/system/partials_macro_decorators_spec.rb +127 -0
  290. data/spec/system/partials_module_disambiguation_spec.rb +125 -0
  291. data/spec/system/path_handling_probes_spec.rb +16 -12
  292. data/spec/system/pinned_thread_count_spec.rb +4 -4
  293. data/spec/system/preprocessing_fallback_conditionals_spec.rb +1 -1
  294. data/spec/system/short_build_paths_spec.rb +87 -0
  295. data/spec/system/sibling_header_collision_spec.rb +30 -6
  296. data/spec/system/support/bullseye_common_test_cases.rb +42 -0
  297. data/spec/system/support/common_test_cases.rb +2 -2
  298. data/spec/system/support/gcov_partials_test_cases.rb +48 -0
  299. data/spec/system/test_build_layout_spec.rb +209 -0
  300. data/spec/system/test_source_file_directive_spec.rb +35 -5
  301. data/spec/units/c_extractor/c_extractor_code_text_spec.rb +67 -10
  302. data/spec/units/c_extractor/c_extractor_declarations_spec.rb +501 -4
  303. data/spec/units/c_extractor/c_extractor_declarator_spec.rb +245 -0
  304. data/spec/units/c_extractor/c_extractor_defined_type_spec.rb +45 -0
  305. data/spec/units/c_extractor/c_extractor_definitions_spec.rb +163 -3
  306. data/spec/units/c_extractor/c_extractor_functions_spec.rb +462 -21
  307. data/spec/units/c_extractor/c_extractor_preprocessing_spec.rb +39 -0
  308. data/spec/units/c_extractor/c_extractor_spec.rb +4 -4
  309. data/spec/units/c_extractor/c_extractor_types_spec.rb +163 -0
  310. data/spec/units/c_identifier_spec.rb +35 -0
  311. data/spec/units/config/configurator_builder_spec.rb +24 -0
  312. data/spec/units/config/configurator_setup_spec.rb +72 -4
  313. data/spec/units/config/configurator_spec.rb +27 -1
  314. data/spec/units/dependencies/dependency_cache_store_spec.rb +68 -3
  315. data/spec/units/dependencies/dependency_tracker_spec.rb +25 -0
  316. data/spec/units/dependencies/dependinator_spec.rb +17 -2
  317. data/spec/units/diagnostics/build_step_doctor_spec.rb +170 -0
  318. data/spec/units/diagnostics/duplicate_symbol_specialist_spec.rb +117 -0
  319. data/spec/units/diagnostics/header_collision_specialist_spec.rb +267 -0
  320. data/spec/units/diagnostics/include_depth_specialist_spec.rb +137 -0
  321. data/spec/units/diagnostics/missing_symbol_specialist_spec.rb +154 -0
  322. data/spec/units/diagnostics/partial_name_specialist_spec.rb +129 -0
  323. data/spec/units/diagnostics/toolchain_output_spec.rb +86 -0
  324. data/spec/units/encodinator_spec.rb +3 -4
  325. data/spec/units/filesystem/build_roots_spec.rb +131 -0
  326. data/spec/units/filesystem/build_subpath_spec.rb +113 -0
  327. data/spec/units/filesystem/file_finder_helper_spec.rb +80 -0
  328. data/spec/units/filesystem/file_finder_spec.rb +242 -58
  329. data/spec/units/filesystem/file_path_utils_spec.rb +251 -118
  330. data/spec/units/filesystem/file_wrapper_spec.rb +191 -6
  331. data/spec/units/filesystem/path_matcher_spec.rb +36 -0
  332. data/spec/units/filesystem/test_build_layout_spec.rb +216 -0
  333. data/spec/units/filesystem/win_long_paths_spec.rb +204 -0
  334. data/spec/units/filesystem/win_path_prober_spec.rb +158 -0
  335. data/spec/units/generators/generator_helper_spec.rb +0 -60
  336. data/spec/units/generators/generator_mocks_spec.rb +13 -0
  337. data/spec/units/generators/generator_partials_spec.rb +656 -55
  338. data/spec/units/generators/generator_spec.rb +26 -0
  339. data/spec/units/generators/generator_test_runner_spec.rb +9 -5
  340. data/spec/units/generators/partial_source_writer_spec.rb +129 -0
  341. data/spec/units/includes/header_search_spec.rb +406 -0
  342. data/spec/units/includes/include_factory_spec.rb +22 -5
  343. data/spec/units/includes/include_pathinator_spec.rb +77 -13
  344. data/spec/units/includes/include_spec.rb +14 -0
  345. data/spec/units/includes/includes_spec.rb +176 -19
  346. data/spec/units/loginator_spec.rb +31 -0
  347. data/spec/units/mock_locator_spec.rb +199 -5
  348. data/spec/units/partials/include_groups_spec.rb +42 -0
  349. data/spec/units/partials/partializer_config_spec.rb +25 -0
  350. data/spec/units/partials/partializer_helper_carry_spec.rb +661 -0
  351. data/spec/units/partials/partializer_helper_interface_extras_spec.rb +396 -0
  352. data/spec/units/partials/partializer_helper_spec.rb +529 -277
  353. data/spec/units/partials/partializer_reconciler_spec.rb +661 -0
  354. data/spec/units/partials/partializer_spec.rb +1578 -270
  355. data/spec/units/partials/partializer_utils_spec.rb +269 -232
  356. data/spec/units/partials/partials_rename_spec.rb +160 -0
  357. data/spec/units/partials_manager_spec.rb +554 -261
  358. data/spec/units/plugins/bullseye_spec.rb +34 -0
  359. data/spec/units/plugins/console_reportinator_spec.rb +58 -9
  360. data/spec/units/plugins/report_tests_teamcity_stdout_spec.rb +1 -1
  361. data/spec/units/plugins/reportgenerator_reportinator_spec.rb +51 -3
  362. data/spec/units/preprocess/preprocessinator_code_finder_spec.rb +73 -10
  363. data/spec/units/preprocess/preprocessinator_file_assembler_spec.rb +125 -37
  364. data/spec/units/preprocess/preprocessinator_includes_handler_spec.rb +15 -0
  365. data/spec/units/preprocess/preprocessinator_reconstructor_spec.rb +197 -0
  366. data/spec/units/preprocess/preprocessinator_spec.rb +153 -95
  367. data/spec/units/setupinator_spec.rb +51 -0
  368. data/spec/units/standin_headerinator_spec.rb +27 -11
  369. data/spec/units/test_build_executor_spec.rb +780 -166
  370. data/spec/units/test_build_planner_spec.rb +116 -28
  371. data/spec/units/test_build_setup_spec.rb +83 -18
  372. data/spec/units/test_context_extractor_spec.rb +11 -2
  373. data/spec/units/test_derived_search_paths_spec.rb +259 -0
  374. data/spec/units/test_includes_extractinator_spec.rb +56 -8
  375. data/spec/units/test_invoker/objects_wiring_spec.rb +20 -3
  376. data/spec/units/test_invoker/partial_files_preprocessinator_spec.rb +264 -0
  377. data/spec/units/test_invoker/test_substitutions_spec.rb +122 -0
  378. data/spec/units/test_invoker_types_spec.rb +8 -7
  379. data/spec/units/test_pipeline_manager_spec.rb +54 -13
  380. data/spec/units/test_runner_generatinator_spec.rb +93 -1
  381. data/spec/units/test_search_paths_spec.rb +73 -5
  382. data/spec/units/{default_tools_quoting_spec.rb → tools/default_tools_quoting_spec.rb} +39 -5
  383. data/spec/units/tools/shell_quoting_spec.rb +76 -0
  384. data/spec/units/{tool_executor_helper_spec.rb → tools/tool_executor_helper_spec.rb} +1 -1
  385. data/spec/units/{tool_executor_spec.rb → tools/tool_executor_spec.rb} +1 -1
  386. data/spec/units/{tool_validator_spec.rb → tools/tool_validator_spec.rb} +110 -1
  387. data/spec/units/windows_registry_query_tool_spec.rb +53 -0
  388. metadata +161 -16
  389. /data/lib/ceedling/{tool_executor.rb → tools/tool_executor.rb} +0 -0
  390. /data/lib/ceedling/{tool_executor_helper.rb → tools/tool_executor_helper.rb} +0 -0
@@ -0,0 +1,270 @@
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
+ # Integration coverage for the build step doctor against a real compiler's output.
9
+ #
10
+ # A diagnosis rests on two facts no double can supply: the words a real toolchain uses
11
+ # for an error, and the paths its output and its .d file name. Each case here compiles
12
+ # real C in a temporary directory, then hands the real output and .d file to the real
13
+ # doctor and specialists. The unit specs under spec/units/diagnostics/ own everything
14
+ # observable from fixed strings.
15
+
16
+ require 'spec_helper'
17
+ require 'spec_integration_helper'
18
+ require 'fileutils'
19
+ require 'tmpdir'
20
+ require 'open3'
21
+ require 'ceedling/constants'
22
+ require 'ceedling/filename_extension'
23
+ require 'ceedling/filesystem/file_wrapper'
24
+ require 'ceedling/dependencies/gcc_dependency_parser'
25
+ require 'ceedling/test_invoker/test_invoker_types'
26
+ require 'ceedling/test_invoker/test_substitutions'
27
+ require 'ceedling/diagnostics/build_step_doctor'
28
+ require 'ceedling/diagnostics/header_collision_specialist'
29
+ require 'ceedling/diagnostics/missing_symbol_specialist'
30
+ require 'ceedling/diagnostics/duplicate_symbol_specialist'
31
+ require 'ceedling/diagnostics/partial_name_specialist'
32
+ require 'ceedling/diagnostics/include_depth_specialist'
33
+
34
+ PROJECT_BUILD_VENDOR_UNITY_PATH = 'build/vendor/unity' unless defined?( PROJECT_BUILD_VENDOR_UNITY_PATH )
35
+ PROJECT_BUILD_VENDOR_CMOCK_PATH = 'build/vendor/cmock' unless defined?( PROJECT_BUILD_VENDOR_CMOCK_PATH )
36
+ PROJECT_BUILD_VENDOR_CEXCEPTION_PATH = 'build/vendor/cexception' unless defined?( PROJECT_BUILD_VENDOR_CEXCEPTION_PATH )
37
+
38
+ describe 'BuildStepDoctor (integration)' do
39
+ def self.compiler_available?(compiler)
40
+ Open3.capture2e( compiler, '--version' )[1].success?
41
+ rescue StandardError
42
+ false
43
+ end
44
+
45
+ before(:each) do
46
+ @root = Dir.mktmpdir
47
+
48
+ loginator = @loginator = double( 'loginator' )
49
+ verbosinator = double( 'verbosinator', should_output?: false )
50
+ allow( loginator ).to receive( :log )
51
+ @logged = []
52
+ allow( loginator ).to receive( :log ).with( anything, Verbosity::ERRORS, LogLabels::NOTICE ) { |msg, *_| @logged << msg }
53
+
54
+ configurator = double(
55
+ 'configurator',
56
+ project_build_vendor_ceedling_path: 'build/vendor/ceedling', project_use_mocks: true,
57
+ project_use_partials: false, project_use_test_preprocessor_tests: true,
58
+ cmock_mock_prefix: 'mock_', extension_object: FilenameExtension.new( '.o' )
59
+ )
60
+
61
+ file_wrapper = FileWrapper.new( loginator: loginator, verbosinator: verbosinator )
62
+ substitutions = TestSubstitutions.new( configurator: configurator )
63
+
64
+ @doctor = BuildStepDoctor.new(
65
+ loginator: loginator,
66
+ header_collision_specialist: HeaderCollisionSpecialist.new(
67
+ configurator: configurator, test_substitutions: substitutions, gcc_dependency_parser: GccDependencyParser.new, file_wrapper: file_wrapper
68
+ ),
69
+ missing_symbol_specialist: MissingSymbolSpecialist.new( configurator: configurator ),
70
+ duplicate_symbol_specialist: DuplicateSymbolSpecialist.new( configurator: configurator ),
71
+ partial_name_specialist: PartialNameSpecialist.new( configurator: configurator, file_wrapper: file_wrapper ),
72
+ include_depth_specialist: IncludeDepthSpecialist.new( file_wrapper: file_wrapper )
73
+ ).tap( &:setup )
74
+
75
+ @testable = TestInvokerTypes::Testable.new( name: 'a_test', paths: { build: File.join( @root, 'build' ) } )
76
+ end
77
+
78
+ after(:each) do
79
+ FileUtils.rm_rf( @root )
80
+ end
81
+
82
+ def write(relative, text)
83
+ path = File.join( @root, relative )
84
+ FileUtils.mkdir_p( File.dirname( path ) )
85
+ File.write( path, text )
86
+ path
87
+ end
88
+
89
+ # Compiles `source` with `-MMD`, as Ceedling's default test compiler does, and returns
90
+ # the output of a compilation that must fail
91
+ def compile_failing(compiler, source, includes:)
92
+ deps = File.join( @root, 'a_test.d' )
93
+ args = includes.map { |dir| "-I#{File.join( @root, dir )}" }
94
+ output, status = Open3.capture2e( compiler, *args, '-MMD', '-MF', deps, '-c', source, '-o', File.join( @root, 'a_test.o' ) )
95
+
96
+ expect( status.success? ).to be( false ), "expected #{compiler} to fail on #{source}, but it compiled:\n#{output}"
97
+ [output, deps]
98
+ end
99
+
100
+ # Compiles each source to an object, then links them, returning the output of a link
101
+ # that must fail and the objects it linked
102
+ def link_failing(compiler, *sources)
103
+ objects = sources.map do |source|
104
+ object = source.sub( /\.c\z/, '.o' )
105
+ output, status = Open3.capture2e( compiler, '-c', source, '-o', object )
106
+ expect( status.success? ).to be( true ), "#{compiler} failed to compile #{source}:\n#{output}"
107
+ object
108
+ end
109
+
110
+ output, status = Open3.capture2e( compiler, *objects, '-o', File.join( @root, 'a_test.out' ) )
111
+ expect( status.success? ).to be( false ), "expected #{compiler} to fail linking, but it linked:\n#{output}"
112
+ [output, objects]
113
+ end
114
+
115
+ def diagnose_link(output, objects)
116
+ @doctor.diagnose( step: :link, output: output, inputs: { testable: @testable, objects: objects } )
117
+ end
118
+
119
+ def diagnose_compile(output, deps)
120
+ @doctor.diagnose( step: :compile, output: output, inputs: { testable: @testable, dependencies: deps } )
121
+ end
122
+
123
+ %w[gcc clang].each do |compiler|
124
+ context "compiling with #{compiler}" do
125
+ before(:each) do
126
+ skip "#{compiler} is not installed or not in PATH" unless self.class.compiler_available?( compiler )
127
+ end
128
+
129
+ it 'explains two neighboring headers that define one struct' do
130
+ write( 'include/a.h', "struct shared { int a; };\n" )
131
+ write( 'include/b.h', "struct shared { int b; };\n" )
132
+ write( 'include/c.h', "int unrelated;\n" )
133
+ source = write( 'test/a_test.c', "#include \"a.h\"\n#include \"b.h\"\n#include \"c.h\"\n" )
134
+
135
+ diagnose_compile( *compile_failing( compiler, source, includes: ['include'] ) )
136
+
137
+ expect( @logged.size ).to eq( 1 )
138
+ expect( @logged.first ).to include( "involving 'b.h' and 'a.h'.", "the directory '#{File.join( @root, 'include' )}'" )
139
+ expect( @logged.first ).not_to include( 'c.h' )
140
+ end
141
+
142
+ it 'explains a mocked header whose real content also reaches the compilation' do
143
+ gpio = write( 'library/gpio.h', "struct gpio { int pin; };\n" )
144
+ # The definitions differ, since C23 lets an identical struct be redefined
145
+ write( 'mocks/mock_gpio.h', "struct gpio { int line; };\n" )
146
+ write( 'library/driverlib.h', "#include \"gpio.h\"\n" )
147
+ source = write( 'test/a_test.c', "#include \"mock_gpio.h\"\n#include \"driverlib.h\"\n" )
148
+
149
+ @testable.mocks = { gpio: TestInvokerTypes::MockDetails.new( name: 'gpio', source: gpio, partial: false ) }
150
+
151
+ diagnose_compile( *compile_failing( compiler, source, includes: ['mocks', 'library'] ) )
152
+
153
+ expect( @logged ).to include( a_string_including( "'gpio.h'", "'#{gpio}'" ) )
154
+ expect( @logged ).not_to include( a_string_including( 'shares the directory' ) )
155
+ end
156
+
157
+ it 'explains a forwarding header whose own directory comes first in the search paths' do
158
+ forwarding = write( 'esp32/freertos/timers.h', "#include <timers.h>\n" )
159
+ kernel = write( 'kernel/timers.h', "int xTimerStart(int t);\n" )
160
+ source = write( 'test/a_test.c', "#include \"timers.h\"\n" )
161
+ includes = ['esp32/freertos', 'kernel']
162
+
163
+ output, = compile_failing( compiler, source, includes: includes )
164
+ search_paths = includes.map { |dir| File.join( @root, dir ) }
165
+ @doctor.diagnose( step: :compile, output: output, inputs: { testable: @testable, search_paths: search_paths } )
166
+
167
+ expect( @logged.size ).to eq( 1 ), "expected one prescription from #{compiler}'s output:\n#{output}"
168
+ expect( @logged.first ).to include( "'#{forwarding}' includes <timers.h>", "'#{kernel}' is later in the search paths." )
169
+ end
170
+
171
+ it 'explains a symbol no linked object defines' do
172
+ test = write( 'build/a_test.c', "int gpio_init(void);\nint main(void) { return gpio_init(); }\n" )
173
+
174
+ diagnose_link( *link_failing( compiler, test ) )
175
+
176
+ expect( @logged.size ).to eq( 1 )
177
+ expect( @logged.first ).to start_with( 'The linker output appears to report missing symbols.' )
178
+ end
179
+
180
+ it 'gives no missing-symbols guidance for a symbol defined twice' do
181
+ test = write( 'build/a_test.c', "int gpio_init(void) { return 0; }\nint main(void) { return gpio_init(); }\n" )
182
+ other = write( 'build/gpio.c', "int gpio_init(void) { return 1; }\n" )
183
+
184
+ diagnose_link( *link_failing( compiler, test, other ) )
185
+
186
+ expect( @logged ).not_to include( a_string_including( 'missing symbols' ) )
187
+ expect( @logged.size ).to eq( 1 )
188
+ expect( @logged.first ).to start_with( 'The linker output appears to report a symbol defined more than once.' )
189
+ expect( @logged.first ).not_to include( 'links both' )
190
+ end
191
+
192
+ it 'names a mock linked beside the source it stands in for' do
193
+ test = write( 'build/a_test.c', "int gpio_init(void);\nint main(void) { return gpio_init(); }\n" )
194
+ mock = write( 'build/mock_gpio.c', "int gpio_init(void) { return 0; }\n" )
195
+ source = write( 'build/gpio.c', "int gpio_init(void) { return 1; }\n" )
196
+
197
+ diagnose_link( *link_failing( compiler, test, mock, source ) )
198
+
199
+ expect( @logged.size ).to eq( 1 )
200
+ expect( @logged.first ).to include( "This test links both 'mock_gpio.o' and 'gpio.o'" )
201
+ end
202
+
203
+ it 'prescribes nothing for an error that is no collision' do
204
+ write( 'include/a.h', "int a;\n" )
205
+ write( 'include/b.h', "int b;\n" )
206
+ source = write( 'test/a_test.c', "#include \"a.h\"\n#include \"b.h\"\nint f(void) { return undeclared; }\n" )
207
+
208
+ diagnose_compile( *compile_failing( compiler, source, includes: ['include'] ) )
209
+
210
+ expect( @logged ).to eq( [] )
211
+ end
212
+ end
213
+ end
214
+
215
+ # A test file whose Partials macro builds a name nothing declares, compiled against the real
216
+ # ceedling.h. The compiler reports the built name, which the specialist recognizes.
217
+ context "a Partials macro naming nothing, with Partials enabled" do
218
+ before(:each) do
219
+ configurator = double( 'configurator', project_use_partials: true )
220
+ nobody = double( 'specialist', diagnoses: [] )
221
+ file_wrapper = FileWrapper.new( loginator: double( 'loginator' ).as_null_object, verbosinator: double( 'verbosinator', should_output?: false ) )
222
+
223
+ @doctor = BuildStepDoctor.new(
224
+ loginator: @loginator, header_collision_specialist: nobody, missing_symbol_specialist: nobody,
225
+ duplicate_symbol_specialist: nobody, partial_name_specialist: PartialNameSpecialist.new( configurator: configurator, file_wrapper: file_wrapper ),
226
+ include_depth_specialist: nobody
227
+ ).tap( &:setup )
228
+ end
229
+
230
+ def compile_test(compiler, body)
231
+ source = write( 'test/a_test.c', "#include \"ceedling.h\"\n#{body}" )
232
+ output, status = Open3.capture2e(
233
+ compiler, "-I#{File.expand_path( '../../lib/ceedling', __dir__ )}", '-DCEEDLING_PARTIALS_PREFIX=ceedling_partial_', '-c', source, '-o', File.join( @root, 'a_test.o' )
234
+ )
235
+ expect( status.success? ).to be( false ), "expected #{compiler} to fail on #{source}, but it compiled:\n#{output}"
236
+
237
+ @doctor.diagnose( step: :compile, output: output, inputs: { testable: @testable, source: source } )
238
+ end
239
+
240
+ before(:each) { @testable = TestInvokerTypes::Testable.new( name: 'a_test', filepath: File.join( @root, 'test', 'a_test.c' ), paths: {} ) }
241
+
242
+ %w[gcc clang].each do |compiler|
243
+ context "compiling with #{compiler}" do
244
+ before(:each) do
245
+ skip "#{compiler} is not installed or not in PATH" unless self.class.compiler_available?( compiler )
246
+ end
247
+
248
+ it 'explains a promoted variable PARTIAL_LOCAL_VAR() misspells' do
249
+ compile_test( compiler, "int f(void) { return PARTIAL_LOCAL_VAR(tick, cnt); }\n" )
250
+
251
+ expect( @logged.size ).to eq( 1 )
252
+ expect( @logged.first ).to include( 'PARTIAL_LOCAL_VAR() builds' )
253
+ end
254
+
255
+ it 'explains a type PARTIAL_TYPE() misspells' do
256
+ compile_test( compiler, "int f(void) { PARTIAL_TYPE(ticker, ctx) copy; return sizeof( copy ); }\n" )
257
+
258
+ expect( @logged.size ).to eq( 1 )
259
+ expect( @logged.first ).to include( 'PARTIAL_TYPE() or PARTIAL_LOCAL_TYPE() names' )
260
+ end
261
+
262
+ it 'prescribes nothing for an ordinary undeclared name' do
263
+ compile_test( compiler, "int f(void) { return undeclared; }\n" )
264
+
265
+ expect( @logged ).to eq( [] )
266
+ end
267
+ end
268
+ end
269
+ end
270
+ end
@@ -56,6 +56,11 @@ describe CExtractor do
56
56
  ->(content) { extractor.from_string(content: content) }
57
57
  end
58
58
 
59
+ # Each element in order, as its kind and its text or signature
60
+ def sequence_of(content, chunk_size: CExtractorConstants::DEFAULT_CHUNK_SIZE)
61
+ extractor.from_string( content: content, chunk_size: chunk_size ).element_sequence.map { |element| [element.class.name.split( '::' ).last, element.respond_to?( :text ) ? element.text : element.signature] }
62
+ end
63
+
59
64
  it "should extract nothing from blank input" do
60
65
  contents = extract_from.call('')
61
66
  expect( contents.function_definitions.length ).to eq 0
@@ -171,7 +176,8 @@ describe CExtractor do
171
176
 
172
177
  expect( contents.variable_declarations[2].name ).to eq 'instance'
173
178
  expect( contents.variable_declarations[2].decorators ).to eq []
174
- expect( contents.variable_declarations[2].text ).to eq 'struct foo { int x; } instance;'
179
+ expect( contents.variable_declarations[2].text ).to eq 'instance;'
180
+ expect( contents.variable_declarations[2].defined_type.text ).to eq 'struct foo { int x; };'
175
181
 
176
182
  expect( contents.variable_declarations[3].name ).to eq 'array'
177
183
  expect( contents.variable_declarations[3].type ).to eq 'int'
@@ -772,7 +778,7 @@ describe CExtractor do
772
778
  float f;
773
779
  };
774
780
 
775
- /* struct with declarator — stays in variable_declarations, not aggregate_definitions */
781
+ /* struct with declarator — the type joins aggregate_definitions, the variable variable_declarations */
776
782
  struct Foo { int val; } foo_instance;
777
783
 
778
784
  typedef struct { int a; int b; } Pair;
@@ -786,7 +792,7 @@ describe CExtractor do
786
792
 
787
793
  contents = extract_from.call(file_contents)
788
794
 
789
- expect( contents.aggregate_definitions.length ).to eq 3
795
+ expect( contents.aggregate_definitions.length ).to eq 4
790
796
  expect( contents.aggregate_definitions[0].text ).to start_with('struct Point')
791
797
  expect( contents.aggregate_definitions[0].text ).to include('int x;')
792
798
  expect( contents.aggregate_definitions[0].line_num ).to eq 3
@@ -795,9 +801,12 @@ describe CExtractor do
795
801
  expect( contents.aggregate_definitions[2].text ).to start_with('union Number')
796
802
  expect( contents.aggregate_definitions[2].line_num ).to eq 10
797
803
 
798
- # struct Foo { int val; } foo_instance; stays in variable_declarations
804
+ # struct Foo { int val; } foo_instance; defines the type its variable names
805
+ expect( contents.aggregate_definitions[3].text ).to eq 'struct Foo { int val; };'
806
+ expect( contents.aggregate_definitions[3].line_num ).to eq 16
799
807
  expect( contents.variable_declarations.length ).to eq 2
800
808
  expect( contents.variable_declarations[0].name ).to eq 'foo_instance'
809
+ expect( contents.variable_declarations[0].defined_type ).to equal( contents.aggregate_definitions[3] )
801
810
  expect( contents.variable_declarations[1].name ).to eq 'some_global'
802
811
 
803
812
  expect( contents.type_definitions.length ).to eq 1
@@ -1204,6 +1213,247 @@ describe CExtractor do
1204
1213
  end
1205
1214
  end
1206
1215
 
1216
+ # A function pointer's name sits inside parentheses, which a bare macro invocation's shape
1217
+ # also starts with. Each declaration must arrive whole, as one element.
1218
+ context "with function-pointer declarators" do
1219
+ it "extracts a function-pointer variable as one variable" do
1220
+ expect( sequence_of( "int (*g_hook)(int);\n" ) ).to eq [['CVariableDeclaration', 'int (*g_hook)(int);']]
1221
+ end
1222
+
1223
+ it "extracts an initialized function-pointer variable as one variable" do
1224
+ expect( sequence_of( "int (*g_hook)(int) = 0;\n" ) ).to eq [['CVariableDeclaration', 'int (*g_hook)(int) = 0;']]
1225
+ end
1226
+
1227
+ it "extracts a function-pointer variable whose base type is a typedef as one variable" do
1228
+ expect( sequence_of( "result_t (*on_done)(int);\n" ) ).to eq [['CVariableDeclaration', 'result_t (*on_done)(int);']]
1229
+ end
1230
+
1231
+ it "extracts a constant function-pointer variable as one variable" do
1232
+ expect( sequence_of( "int (*const k_hook)(int) = bump;\n" ) ).to eq [['CVariableDeclaration', 'int (*const k_hook)(int) = bump;']]
1233
+ end
1234
+
1235
+ it "extracts an initialized pointer to an array as one variable" do
1236
+ expect( sequence_of( "int (*g_row)[4] = 0;\n" ) ).to eq [['CVariableDeclaration', 'int (*g_row)[4] = 0;']]
1237
+ end
1238
+
1239
+ it "extracts a declaration of a function returning a function pointer as one declaration" do
1240
+ expect( sequence_of( "int (*ticker_get(void))(int);\n" ) ).to eq [['CFunctionDeclaration', 'int (*ticker_get(void))(int);']]
1241
+ end
1242
+
1243
+ it "extracts a definition of a function returning a function pointer as one definition" do
1244
+ expect( sequence_of( "int (*ticker_get(void))(int) { return bump; }\n" ) ).to eq [['CFunctionDefinition', 'int (*ticker_get(void))(int)']]
1245
+ end
1246
+ end
1247
+
1248
+ # A struct, union or enum keyword can lead a variable or a function as well as a type. Each
1249
+ # statement must arrive as what it declares.
1250
+ context "with a struct, union or enum keyword leading the statement" do
1251
+ it "extracts an initialized struct variable as a variable" do
1252
+ expect( sequence_of( "struct ops g_ops = { 1 };\n" ) ).to eq [['CVariableDeclaration', 'struct ops g_ops = { 1 };']]
1253
+ end
1254
+
1255
+ it "extracts an initialized union variable as a variable" do
1256
+ expect( sequence_of( "union u g_u = { 0 };\n" ) ).to eq [['CVariableDeclaration', 'union u g_u = { 0 };']]
1257
+ end
1258
+
1259
+ it "extracts an initialized array of struct pointers as a variable" do
1260
+ expect( sequence_of( "struct ops *tbl[] = { &a1, &b1 };\n" ) ).to eq [['CVariableDeclaration', 'struct ops *tbl[] = { &a1, &b1 };']]
1261
+ end
1262
+
1263
+ it "extracts a table of designated function pointers as a variable" do
1264
+ expect( sequence_of( "struct drv_ops g_drv = { .init = drv_init, .read = drv_read };\n" ) ).to eq [['CVariableDeclaration', 'struct drv_ops g_drv = { .init = drv_init, .read = drv_read };']]
1265
+ end
1266
+
1267
+ it "extracts an initialized array of structs as a variable" do
1268
+ expect( sequence_of( "struct ops g_arr[2] = { {1}, {2} };\n" ) ).to eq [['CVariableDeclaration', 'struct ops g_arr[2] = { {1}, {2} };']]
1269
+ end
1270
+
1271
+ it "extracts a function returning a struct pointer, with a stray ';' after its body, as a function" do
1272
+ expect( sequence_of( "struct ops *make_ops(void) { return &k; };\nint after;\n" ) ).to eq [['CFunctionDefinition', 'struct ops *make_ops(void)'], ['CVariableDeclaration', 'int after;']]
1273
+ end
1274
+
1275
+ it "extracts a function returning a struct, with a stray ';' after its body, as a function" do
1276
+ expect( sequence_of( "struct ops make_v(void) { struct ops o = { 1 }; return o; };\n" ) ).to eq [['CFunctionDefinition', 'struct ops make_v(void)']]
1277
+ end
1278
+
1279
+ # A feature can end at the buffer's last byte, before the stray ';' after it is read
1280
+ (1..8).each do |chunk_size|
1281
+ it "reads past a stray ';' after a function body with #{chunk_size}-byte chunks" do
1282
+ expect( sequence_of( "struct ops *make_ops(void) { return 0; };\nint after;\n", chunk_size: chunk_size ) ).to eq [['CFunctionDefinition', 'struct ops *make_ops(void)'], ['CVariableDeclaration', 'int after;']]
1283
+ expect( sequence_of( "int f(void) { return 0; };\nint after;\n", chunk_size: chunk_size ) ).to eq [['CFunctionDefinition', 'int f(void)'], ['CVariableDeclaration', 'int after;']]
1284
+ end
1285
+ end
1286
+
1287
+ it "extracts a type with an attribute after its body as a type" do
1288
+ expect( sequence_of( "struct pk { char c; int i; } __attribute__((packed));\nint after;\n" ) ).to eq [['CStatement', 'struct pk { char c; int i; } __attribute__((packed));'], ['CVariableDeclaration', 'int after;']]
1289
+ end
1290
+ end
1291
+
1292
+ # A type specifier that takes parentheses has a macro invocation's shape. Each declaration
1293
+ # must still arrive whole, as one element.
1294
+ context "with type specifiers that take parentheses" do
1295
+ [
1296
+ ['typeof(int) g_t;', 'CVariableDeclaration', 'typeof(int) g_t;'],
1297
+ ['_Atomic(int) g_a;', 'CVariableDeclaration', '_Atomic(int) g_a;'],
1298
+ ['_Alignas(8) int g_al;', 'CVariableDeclaration', '_Alignas(8) int g_al;'],
1299
+ ['typeof(*g_pp) g_q;', 'CVariableDeclaration', 'typeof(*g_pp) g_q;'],
1300
+ ['typeof(int) tf(void);', 'CFunctionDeclaration', 'typeof(int) tf(void);']
1301
+ ].each do |content, kind, text|
1302
+ it "extracts `#{content}` as one element" do
1303
+ expect( sequence_of( "#{content}\n" ) ).to eq [[kind, text]]
1304
+ end
1305
+ end
1306
+ end
1307
+
1308
+ # An asm label's ')' ends a declaration as a parameter list does. A variable with one must
1309
+ # still arrive as a variable, and a function with one as a function.
1310
+ context "with C23 attributes" do
1311
+ it "reads each feature a C23 attribute leads and every feature after it" do
1312
+ content = <<~CONTENTS
1313
+ [[nodiscard]] static int f(void) { return 0; }
1314
+ [[nodiscard]] int g(void);
1315
+ [[maybe_unused]] static int count;
1316
+ int h(void) { return 1; }
1317
+ CONTENTS
1318
+
1319
+ expect( sequence_of( content ) ).to eq [
1320
+ ['CFunctionDefinition', '[[nodiscard]] static int f(void)'],
1321
+ ['CFunctionDeclaration', '[[nodiscard]] int g(void);'],
1322
+ ['CVariableDeclaration', '[[maybe_unused]] int count;'],
1323
+ ['CFunctionDefinition', 'int h(void)']
1324
+ ]
1325
+ end
1326
+ end
1327
+
1328
+ context "with asm labels" do
1329
+ it "extracts each declaration as the element it declares" do
1330
+ content = "int g_s asm(\"g_sym\");\nint f(void) __asm(\"f_sym\");\nint f2(void) MY_API asm(\"f2_sym\");\n" \
1331
+ "asm(\".globl top_sym\");\nint after_fn(void) { return 7; }\n"
1332
+
1333
+ expect( sequence_of( content ) ).to eq [
1334
+ ['CVariableDeclaration', 'int g_s asm("g_sym");'],
1335
+ ['CFunctionDeclaration', 'int f(void) __asm("f_sym");'],
1336
+ ['CFunctionDeclaration', 'int f2(void) MY_API asm("f2_sym");'],
1337
+ ['CVariableDeclaration', 'asm(".globl top_sym");'],
1338
+ ['CFunctionDefinition', 'int after_fn(void)']
1339
+ ]
1340
+ end
1341
+ end
1342
+
1343
+ # A chunk may end at a lone '/', which may open a comment the next chunk holds
1344
+ context "with a comment after a macro invocation's arguments" do
1345
+ (1..24).each do |chunk_size|
1346
+ it "reads the same elements with #{chunk_size}-byte chunks" do
1347
+ content = "FOO(x) /* c */;\nint after;\n"
1348
+ expect( sequence_of( content, chunk_size: chunk_size ) ).to eq sequence_of( content )
1349
+ end
1350
+ end
1351
+ end
1352
+
1353
+ # Fallback preprocessing leaves comments in place, inside declarations too
1354
+ context "with comments inside declarations" do
1355
+ it "reads on past a declaration that ends in a comment" do
1356
+ expect( sequence_of( "int g_m /* count */;\nint after_fn(void) { return 7; }\n" ) ).to eq [['CVariableDeclaration', 'int g_m ;'], ['CFunctionDefinition', 'int after_fn(void)']]
1357
+ end
1358
+
1359
+ it "reads a declaration whose initializer follows a line comment" do
1360
+ expect( sequence_of( "int g_n // count\n = 3;\nint after;\n" ) ).to eq [['CVariableDeclaration', 'int g_n = 3;'], ['CVariableDeclaration', 'int after;']]
1361
+ end
1362
+
1363
+ # A comment after a feature can run past the buffer's end, so it must be read again whole
1364
+ (1..24).each do |chunk_size|
1365
+ it "reads past a comment after a declaration with #{chunk_size}-byte chunks" do
1366
+ expect( sequence_of( "int g_last; // trailing; comment\nint after;\n", chunk_size: chunk_size ) ).to eq [['CVariableDeclaration', 'int g_last;'], ['CVariableDeclaration', 'int after;']]
1367
+ expect( sequence_of( "int g_last; /* trailing; comment */\nint after;\n", chunk_size: chunk_size ) ).to eq [['CVariableDeclaration', 'int g_last;'], ['CVariableDeclaration', 'int after;']]
1368
+ end
1369
+ end
1370
+ end
1371
+
1372
+ # A declaration that defines its type holds two things. The type is defined once, ahead of its
1373
+ # variables in element_sequence, and every variable of the statement names that one record.
1374
+ context "a declaration that defines its type" do
1375
+ it "records the type as an aggregate ahead of the variables that share it" do
1376
+ contents = extract_from.call( "int before;\nstatic struct pair { int a[2]; } g_p1, *g_p2 = &g_p1;\n" )
1377
+ type = contents.aggregate_definitions.first
1378
+
1379
+ expect( type ).to have_attributes( text: 'struct pair { int a[2]; };', kind: :aggregate, tag: 'pair', line_num: 2 )
1380
+ expect( contents.element_sequence.map( &:class ) ).to eq [
1381
+ CExtractorTypes::CVariableDeclaration, CExtractorTypes::CStatement,
1382
+ CExtractorTypes::CVariableDeclaration, CExtractorTypes::CVariableDeclaration
1383
+ ]
1384
+ expect( contents.variable_declarations.drop( 1 ).map( &:defined_type ) ).to all( equal( type ) )
1385
+ end
1386
+
1387
+ # The type held a member's array size, which no longer reads as the variable's own
1388
+ it "reads each variable of the statement without the type's body" do
1389
+ vars = extract_from.call( "static struct pair { int a[2]; } g_p1, *g_p2 = &g_p1;\n" ).variable_declarations
1390
+
1391
+ expect( vars.map { |v| [v.name, v.type, v.text, v.array_suffix, v.decorators] } ).to eq [
1392
+ ['g_p1', '', 'g_p1;', '', ['static']],
1393
+ ['g_p2', '*', '*g_p2 = &g_p1;', '', ['static']]
1394
+ ]
1395
+ end
1396
+
1397
+ it "reads an anonymous struct, union or enum with no tag" do
1398
+ contents = extract_from.call( "static struct { int n; } s;\nunion { int i; float f; } u;\nstatic enum { IDLE, RUN } e;\n" )
1399
+
1400
+ expect( contents.aggregate_definitions.map { |t| [t.text, t.tag] } ).to eq [
1401
+ ['struct { int n; };', nil], ['union { int i; float f; };', nil], ['enum { IDLE, RUN };', nil]
1402
+ ]
1403
+ expect( contents.variable_declarations.map( &:name ) ).to eq ['s', 'u', 'e']
1404
+ end
1405
+
1406
+ # An extension after the body belongs to the type, and one after the name to the variable
1407
+ it "keeps each extension with what it follows" do
1408
+ vars = extract_from.call( "struct { char c; int i; } __attribute__((packed)) s_pk __attribute__((unused));\n" ).variable_declarations
1409
+
1410
+ expect( vars.first.defined_type.text ).to eq 'struct { char c; int i; } __attribute__((packed));'
1411
+ expect( vars.first.text ).to eq 's_pk __attribute__((unused));'
1412
+ end
1413
+
1414
+ it "keeps an initializer, an asm label and a qualifier with the variable" do
1415
+ var = extract_from.call( "static const struct ops { int a; } g_ops asm(\"sym\") = { 1 };\n" ).variable_declarations.first
1416
+
1417
+ expect( var ).to have_attributes( name: 'g_ops', decorators: ['static', 'const'], asm_label: 'asm("sym")', text: 'g_ops asm("sym") = { 1 };' )
1418
+ end
1419
+
1420
+ it "reads a struct whose members are function pointers" do
1421
+ var = extract_from.call( "static struct drv { int (*read)(void); void (*write)(int); } s_drv;\n" ).variable_declarations.first
1422
+
1423
+ expect( var ).to have_attributes( name: 's_drv', declarator: nil )
1424
+ expect( var.defined_type.tag ).to eq 'drv'
1425
+ end
1426
+
1427
+ it "reads an enum with an underlying type" do
1428
+ type = extract_from.call( "enum mode : unsigned char { OFF, ON } g_mode;\n" ).aggregate_definitions.first
1429
+
1430
+ expect( type ).to have_attributes( text: 'enum mode : unsigned char { OFF, ON };', tag: 'mode' )
1431
+ end
1432
+ end
1433
+
1434
+ context "a statement that names a type" do
1435
+ it "reads a forward declaration as a type statement, never a variable" do
1436
+ contents = extract_from.call( "struct node;\nunion word;\n" )
1437
+
1438
+ expect( contents.aggregate_definitions.map { |t| [t.text, t.tag] } ).to eq [['struct node;', 'node'], ['union word;', 'word']]
1439
+ expect( contents.variable_declarations ).to be_empty
1440
+ end
1441
+
1442
+ it "records the tag and the name a typedef gives a struct" do
1443
+ contents = extract_from.call( "typedef struct node node_t;\ntypedef struct item { int v; } item_t;\ntypedef int count_t;\n" )
1444
+
1445
+ expect( contents.type_definitions.map { |t| [t.kind, t.tag, t.type_name] } ).to eq [
1446
+ [:typedef, 'node', 'node_t'], [:typedef, 'item', 'item_t'], [:typedef, nil, nil]
1447
+ ]
1448
+ end
1449
+
1450
+ it "records each statement's kind" do
1451
+ contents = extract_from.call( "#define N 1\ntypedef int n_t;\nstruct s { int a; };\nint n;\n" )
1452
+
1453
+ expect( contents.element_sequence.grep( CExtractorTypes::CStatement ).map( &:kind ) ).to eq [:macro, :typedef, :aggregate]
1454
+ end
1455
+ end
1456
+
1207
1457
  end
1208
1458
 
1209
1459
  end
@@ -93,17 +93,14 @@ describe 'Includes extraction (integration)' do
93
93
  expect(extracted(tree, 'gadget.c')).to eq(['#include "gadget_hw.h"'])
94
94
  end
95
95
 
96
- it 'currently emits a standard-library header once per file in its resolution wrapper chain' do
97
- # Characterization, not endorsement: <stdint.h> resolves through a compiler wrapper
98
- # header of the same basename, so the SYSTEM line-marker pass reports it at two
99
- # distinct paths and reconcile keeps both. The Include value model (out of scope for
100
- # this work) is where any dedup-by-basename would live.
96
+ it 'emits a standard-library header once though its resolution wrapper chain enters it twice' do
97
+ # GCC's own <stdint.h> is a wrapper that does #include_next <stdint.h>, so the SYSTEM
98
+ # line-marker pass reports the name at two distinct paths. Both would be written as
99
+ # the same #include line.
101
100
  tree = {
102
101
  'clock.c' => %(#include <stdint.h>\nuint8_t c(void){return 0;}\n)
103
102
  }
104
- result = extracted(tree, 'clock.c')
105
- expect(result.uniq).to eq(['#include <stdint.h>'])
106
- expect(result.count('#include <stdint.h>')).to be >= 1
103
+ expect(extracted(tree, 'clock.c')).to eq(['#include <stdint.h>'])
107
104
  end
108
105
 
109
106
  it 'returns nothing for a file with no includes' do
@@ -280,12 +277,11 @@ describe 'Includes extraction (integration)' do
280
277
  # --- Path / search-path shapes -----------------------------------------
281
278
 
282
279
  it 'renders a subdir-qualified quoted include by basename alone when nothing else in the file collides with it' do
283
- # Ceedling adds every real directory as its own individual search path, so a
284
- # unique basename already finds the right file -- preserving more of the
285
- # directive's own written path here would add nothing findable a plain
286
- # basename doesn't already provide, and (see the collision cases below) can
287
- # actively break the build the moment it reaches further than any one
288
- # configured search directory covers.
280
+ # The reconciled list records which header a file includes, not how to reach
281
+ # it. A file generated from it spells each header for itself as the test's
282
+ # search paths reach it (Include#spelled_by), so the basename here loses
283
+ # nothing. A collision below keeps more path, since a basename alone would
284
+ # name only one of the colliding headers.
289
285
  tree = {
290
286
  'app.c' => %(#include "drivers/uart.h"\nint a(void){return UART_BAUD;}\n),
291
287
  'drivers/uart.h' => %(#ifndef DRIVERS_UART_H\n#define DRIVERS_UART_H\n#define UART_BAUD 115200\n#endif\n)
@@ -312,6 +308,23 @@ describe 'Includes extraction (integration)' do
312
308
  )
313
309
  end
314
310
 
311
+ # A pathless #include and one naming a folder reach two headers of one name, in either
312
+ # order (#1426). Fallback keeps each as written.
313
+ [false, true].each do |fallback|
314
+ [%w[config.h app/config.h], %w[app/config.h config.h]].each do |order|
315
+ it "keeps a pathless #include beside a same-named one with a folder, #{order.join(' then ')}#{fallback ? ', in fallback' : ''}" do
316
+ tree = {
317
+ 'lib/motor.h' => %(#ifndef MOTOR_H\n#define MOTOR_H\n) + order.map { |text| %(#include "#{text}"\n) }.join + %(int motor_run(void);\n#endif\n),
318
+ 'src/hw/config.h' => %(#ifndef HW_CONFIG_H\n#define HW_CONFIG_H\ntypedef int hw_t;\n#endif\n),
319
+ 'lib/app/config.h' => %(#ifndef APP_CONFIG_H\n#define APP_CONFIG_H\ntypedef int app_t;\n#endif\n)
320
+ }
321
+
322
+ expected = (fallback or !@accurate) ? ['#include "config.h"', '#include "app/config.h"'] : ['#include "hw/config.h"', '#include "app/config.h"']
323
+ expect(extracted(tree, 'lib/motor.h', fallback: fallback, search_subdirs: ['src/hw', 'lib'])).to contain_exactly( *expected )
324
+ end
325
+ end
326
+ end
327
+
315
328
  it 'grows the disambiguating suffix past one directory level when two colliding paths still share it' do
316
329
  tree = {
317
330
  'app.c' => %(#include "sensors/adc/config.h"\n#include "drivers/adc/config.h"\nint a(void){return S_CFG + D_CFG;}\n),
@@ -82,7 +82,7 @@ describe 'Per-test logs of nested tests (integration)' do
82
82
 
83
83
  it 'keeps the gdb logs of same-named tests apart, each holding only the latest build' do
84
84
  in_project do
85
- paths = FilePathUtils.new( configurator: double( 'configurator', project_log_path: 'build/logs' ), file_wrapper: file_wrapper )
85
+ paths = FilePathUtils.new( configurator: double( 'configurator', project_log_path: 'build/logs' ), file_wrapper: file_wrapper, test_build_layout: nil )
86
86
  logs = ['test/a/test_crash', 'test/b/test_crash'].map { |name| paths.form_test_gdb_log( name, context: :test, name: 'test_boom' ) }
87
87
 
88
88
  2.times do |build|