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,267 @@
1
+ # =========================================================================
2
+ # Ceedling - Test-Centered Build System for C
3
+ # ThrowTheSwitch.org
4
+ # Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
5
+ # SPDX-License-Identifier: MIT
6
+ # =========================================================================
7
+
8
+ require 'spec_helper'
9
+ require 'ceedling/constants'
10
+ require 'ceedling/test_invoker/test_invoker_types'
11
+ require 'ceedling/dependencies/gcc_dependency_parser'
12
+ require 'ceedling/diagnostics/build_step_doctor'
13
+ require 'ceedling/diagnostics/header_collision_specialist'
14
+
15
+ describe HeaderCollisionSpecialist do
16
+ before(:each) do
17
+ @testable = TestInvokerTypes::Testable.new( name: 'a_test', paths: {} )
18
+
19
+ @test_substitutions = double( 'test_substitutions' )
20
+ allow( @test_substitutions ).to receive( :real_headers ).with( @testable ).and_return( { 'gpio.h' => '/project/library/gpio.h' } )
21
+ allow( @test_substitutions ).to receive( :partialized? ).and_return( false )
22
+ allow( @test_substitutions ).to receive( :generated_dirs ).with( @testable ).and_return( ['build/test/mocks/a_test', 'build/vendor/unity'] )
23
+
24
+ # No .d file unless an example writes one
25
+ @file_wrapper = double( 'file_wrapper' )
26
+ allow( @file_wrapper ).to receive( :exist? ).and_return( false )
27
+ allow( @file_wrapper ).to receive( :directory? ).and_return( false )
28
+
29
+ @loginator = double( 'loginator' )
30
+ allow( @loginator ).to receive( :log )
31
+
32
+ @configurator = double( 'configurator' )
33
+ allow( @configurator ).to receive( :project_use_mocks ).and_return( true )
34
+ allow( @configurator ).to receive( :project_use_partials ).and_return( true )
35
+
36
+ specialist = described_class.new(
37
+ configurator: @configurator, test_substitutions: @test_substitutions, gcc_dependency_parser: GccDependencyParser.new, file_wrapper: @file_wrapper
38
+ )
39
+ nobody = double( 'specialist', diagnoses: [] )
40
+
41
+ @doctor = BuildStepDoctor.new(
42
+ loginator: @loginator, header_collision_specialist: specialist,
43
+ missing_symbol_specialist: nobody, duplicate_symbol_specialist: nobody, partial_name_specialist: nobody,
44
+ include_depth_specialist: nobody
45
+ ).tap( &:setup )
46
+ end
47
+
48
+ def prescriptions(output, step: :compile)
49
+ @doctor.diagnose( step: step, output: output, inputs: { testable: @testable, dependencies: 'build/deps' } )
50
+ end
51
+
52
+ # The first compilation attempt's .d file, listing what the test file reached
53
+ def reached(*files)
54
+ allow( @file_wrapper ).to receive( :exist? ).with( 'build/deps' ).and_return( true )
55
+ allow( @file_wrapper ).to receive( :read ).with( 'build/deps' ).and_return( "build/a_test.o: test/a_test.c #{files.join( ' ' )}\n" )
56
+ end
57
+
58
+ describe 'a substituted header colliding with its real content' do
59
+ it 'prescribes nothing for output with no redeclaration-family error' do
60
+ expect( prescriptions( "/project/library/gpio.h:12:8: error: some unrelated compiler error\n" ) ).to eq( [] )
61
+ end
62
+
63
+ it 'prescribes nothing when the error names no header this test mocks or Partializes' do
64
+ expect( prescriptions( "/project/library/other.h:10:5: error: redeclaration of 'struct other'\n" ) ).to eq( [] )
65
+ end
66
+
67
+ it 'names the substituted header and its real path when a redeclaration error mentions it' do
68
+ notices = prescriptions( "/project/library/gpio.h:12:8: error: redeclaration of 'struct gpio'\n" )
69
+
70
+ expect( notices.size ).to eq( 1 )
71
+ expect( notices.first ).to start_with(
72
+ "The compiler output appears to report a redeclaration or conflicting types in 'gpio.h'. If so, this test's " \
73
+ "mock of 'gpio.h' may be colliding with its real content ('/project/library/gpio.h'), which can reach " \
74
+ "this compilation through a second #include chain that bypasses the mock.\n\nHOW THIS HAPPENS:\n• A mock replaces"
75
+ )
76
+ expect( notices.first ).to include(
77
+ "• Ceedling isolates the real header's direct neighbors, one level deep.",
78
+ "\n\nOPTIONS:\n1. Trace the #include chain that brings in the real header.\n",
79
+ "3. Change the source's #include so it reaches the header the way the test does.\n"
80
+ )
81
+ expect( notices.first.lines.grep( /\A\s/ ) ).to eq( ["\n", "\n"] )
82
+ end
83
+
84
+ it 'speaks of a Partial when the test Partializes the header' do
85
+ allow( @test_substitutions ).to receive( :partialized? ).with( @testable, '/project/library/gpio.h' ).and_return( true )
86
+
87
+ notice = prescriptions( "/project/library/gpio.h:12:8: error: redeclaration of 'struct gpio'\n" ).first
88
+
89
+ expect( notice ).to include( "this test's Partial of 'gpio.h'", 'bypasses the Partial.', '• A Partial replaces a header' )
90
+ end
91
+
92
+ it 'names the setting a substitution remedy needs when that feature is off' do
93
+ allow( @configurator ).to receive( :project_use_partials ).and_return( false )
94
+
95
+ notice = prescriptions( "/project/library/gpio.h:12:8: error: redeclaration of 'struct gpio'\n" ).first
96
+
97
+ expect( notice ).to include(
98
+ "2. Mock or Partialize the intermediate header that #includes it, without necessarily using it, to break the chain. " \
99
+ "Partializing requires :project ↳ :use_partials.\n"
100
+ )
101
+ expect( notice ).not_to include( 'Mocking requires' )
102
+ end
103
+
104
+ it 'finds the substituted header in an include chain line' do
105
+ output = "In file included from /project/library/gpio.h:3,\n from test/a_test.c:1:\n" \
106
+ "/project/library/pins.h:2:5: error: redefinition of 'pin'\n"
107
+
108
+ expect( prescriptions( output ).first ).to include( "'/project/library/gpio.h'" )
109
+ end
110
+
111
+ {
112
+ 'GCC conflicting types' => "/project/library/gpio.h:12:8: error: conflicting types for 'gpio_init'\n",
113
+ 'GCC previous definition' => "/project/library/gpio.h:12:8: note: previous definition of 'gpio_init' was here\n",
114
+ 'Clang redefinition' => "/project/library/gpio.h:8:5: error: redefinition of enumerator 'GPIO_DIR_MODE_IN'\n",
115
+ 'Clang previous definition' => "/project/library/gpio.h:8:5: note: previous definition is here\n",
116
+ 'conflicting types with a reason' => "/project/library/gpio.h:8:5: error: conflicting types for 'gpio_init', different types\n",
117
+ 'GCC previous declaration' => "/project/library/gpio.h:8:5: note: previous declaration of 'gpio_t' with type 'int'\n",
118
+ 'GCC different kind of symbol' => "/project/library/gpio.h:8:5: error: 'gpio' redeclared as different kind of symbol\n",
119
+ 'Clang typedef redefinition' => "/project/library/gpio.h:8:5: error: typedef redefinition with different types\n",
120
+ 'IAR' => "\"/project/library/gpio.h\",8 Error[Pe101]: \"GPIO_A\" has already been declared in the current scope\n",
121
+ 'IAR incompatible declaration' => "\"/project/library/gpio.h\",8 Error[Pe147]: declaration is incompatible with \"int g(void)\"\n",
122
+ 'Arm armcc' => "\"/project/library/gpio.h\", line 8: Error: #101: \"GPIO_A\" has already been declared in the current scope\n",
123
+ 'TI' => "\"/project/library/gpio.h\", line 8: error #256: invalid redeclaration of type name \"gpio_t\"\n",
124
+ 'MSVC' => "/project/library/gpio.h(8): error C2011: 'gpio': 'struct' type redefinition\n",
125
+ 'MSVC different basic types' => "/project/library/gpio.h(8): error C2371: 'gpio_t': redefinition; different basic types\n",
126
+ 'other compilers, generically' => "E 249: [\"/project/library/gpio.h\" 8] duplicate declaration of \"gpio_t\"\n"
127
+ }.each do |wording, output|
128
+ it "recognizes #{wording}" do
129
+ expect( prescriptions( output ).size ).to eq( 1 )
130
+ end
131
+ end
132
+
133
+ it 'does not match a header of the same basename at a different real path' do
134
+ expect( prescriptions( "/some/other/place/gpio.h:12:8: error: redeclaration of 'struct gpio'\n" ) ).to eq( [] )
135
+ end
136
+
137
+ it 'covers only compilation' do
138
+ expect( prescriptions( "/project/library/gpio.h:12:8: error: redeclaration of 'struct gpio'\n", step: :link ) ).to eq( [] )
139
+ end
140
+ end
141
+
142
+ describe 'a header colliding in a directory it shares with unsubstituted headers' do
143
+ let(:collision) do
144
+ "In file included from test/a_test.c:3:\n" \
145
+ "/project/include/ifx_core.h:20:16: error: conflicting types for 'ifx_t'\n" \
146
+ "/project/include/tle9974.h:11:16: note: previous declaration of 'ifx_t' with type 'int'\n"
147
+ end
148
+
149
+ it 'prescribes once for the directory, naming only the headers the output names' do
150
+ reached( '/project/include/ifx_core.h', '/project/include/tle9974.h', '/project/include/ifx_mem.h' )
151
+
152
+ notices = prescriptions( collision )
153
+
154
+ expect( notices.size ).to eq( 1 )
155
+ expect( notices.first ).to start_with(
156
+ "The compiler output appears to report a redeclaration or conflicting types involving 'ifx_core.h' and 'tle9974.h'. " \
157
+ "If so, the cause may lie in how headers reach this compilation. Each of these headers shares the directory " \
158
+ "'/project/include' with other headers this test's compilation reaches.\n\n"
159
+ )
160
+ expect( notices.first ).not_to include( 'ifx_mem.h' )
161
+ end
162
+
163
+ it 'gives every block of guidance, left-justified' do
164
+ reached( '/project/include/ifx_core.h', '/project/include/tle9974.h' )
165
+
166
+ notice = prescriptions( collision ).first
167
+
168
+ expect( notice ).to include(
169
+ "\n\nHOW THIS HAPPENS:\n" \
170
+ "• One translation unit may define a type, a tag, or an enum value only once, and every declaration of a name must agree.\n",
171
+ "• Isolation reaches only one level: a neighbor that #includes a substituted header directly. " \
172
+ "A chain that passes through further headers or directories is beyond this isolation.\n",
173
+ "\n\nOPTIONS:\n1. Trace the #include chains into this directory",
174
+ "2. Mock or Partialize the header whose content should be substituted so that Ceedling isolates its neighbors.\n",
175
+ "4. Add or fix the include guard of a header that arrives twice.\n"
176
+ )
177
+ expect( notice.lines.grep( /\A\s/ ) ).to eq( ["\n", "\n"] )
178
+ end
179
+
180
+ it 'names both settings when the project neither mocks nor Partializes' do
181
+ allow( @configurator ).to receive( :project_use_mocks ).and_return( false )
182
+ allow( @configurator ).to receive( :project_use_partials ).and_return( false )
183
+ reached( '/project/include/ifx_core.h', '/project/include/tle9974.h' )
184
+
185
+ expect( prescriptions( collision ).first ).to include(
186
+ "neighbors. Mocking requires :project ↳ :use_mocks. Partializing requires :project ↳ :use_partials.\n"
187
+ )
188
+ end
189
+
190
+ it 'prescribes once for each directory that holds a named header' do
191
+ reached( '/project/include/a.h', '/project/include/b.h', '/project/ip/c.h', '/project/ip/d.h' )
192
+
193
+ notices = prescriptions( "/project/include/a.h:1:1: error: redefinition of 'x'\n/project/ip/c.h:2:2: note: previous definition is here\n" )
194
+
195
+ expect( notices.size ).to eq( 2 )
196
+ expect( notices[0] ).to include( "involving 'a.h'.", "This header shares the directory '/project/include'" )
197
+ expect( notices[1] ).to include( "involving 'c.h'.", "'/project/ip'" )
198
+ end
199
+
200
+ it 'prescribes nothing when the named header has no neighbor this test reaches' do
201
+ reached( '/project/include/ifx_core.h', '/project/other/x.h' )
202
+
203
+ expect( prescriptions( "/project/include/ifx_core.h:20:16: error: conflicting types for 'ifx_t'\n" ) ).to eq( [] )
204
+ end
205
+
206
+ it 'counts only headers among a directory\'s reached files' do
207
+ reached( '/project/test/support/helper.c', '/project/test/support/helper.h' )
208
+
209
+ expect( prescriptions( "/project/test/support/helper.h:3:3: error: redefinition of 'h'\n" ) ).to eq( [] )
210
+ end
211
+
212
+ it 'leaves a substituted header\'s directory to the substituted-header diagnosis and to isolation' do
213
+ reached( '/project/library/gpio.h', '/project/library/driverlib.h' )
214
+
215
+ expect( prescriptions( "/project/library/driverlib.h:4:4: error: redefinition of 'pin'\n" ) ).to eq( [] )
216
+ end
217
+
218
+ it 'leaves out Ceedling\'s generated directories' do
219
+ reached(
220
+ 'build/test/mocks/a_test/mock_a.h', 'build/test/mocks/a_test/mock_b.h',
221
+ 'build/vendor/unity/src/unity.h', 'build/vendor/unity/src/unity_internals.h'
222
+ )
223
+
224
+ output = "build/test/mocks/a_test/mock_a.h:1:1: error: redefinition of 'x'\n" \
225
+ "build/vendor/unity/src/unity.h:2:2: error: redefinition of 'y'\n"
226
+
227
+ expect( prescriptions( output ) ).to eq( [] )
228
+ end
229
+
230
+ it 'prescribes nothing for output with no collision wording' do
231
+ reached( '/project/include/ifx_core.h', '/project/include/tle9974.h' )
232
+
233
+ expect( prescriptions( "/project/include/ifx_core.h:20:16: error: unknown type name 'ifx_t'\n" ) ).to eq( [] )
234
+ end
235
+
236
+ context 'without a .d file' do
237
+ before(:each) do
238
+ allow( @file_wrapper ).to receive( :directory? ).with( File.expand_path( '/project/include' ) ).and_return( true )
239
+ end
240
+
241
+ it 'falls back to the named header\'s own directory listing' do
242
+ allow( @file_wrapper ).to receive( :directory_entries ).with( File.expand_path( '/project/include' ) ).and_return( ['ifx_core.h', 'notes.txt', 'tle9974.h'] )
243
+
244
+ notices = prescriptions( "/project/include/ifx_core.h:20:16: error: redefinition of 'ifx_t'\n" )
245
+
246
+ expect( notices.size ).to eq( 1 )
247
+ expect( notices.first ).to include( "This header shares the directory '/project/include' with other headers.\n" )
248
+ end
249
+
250
+ it 'prescribes nothing when the listing holds no other header' do
251
+ allow( @file_wrapper ).to receive( :directory_entries ).with( File.expand_path( '/project/include' ) ).and_return( ['ifx_core.h', 'ifx_core.c'] )
252
+
253
+ expect( prescriptions( "/project/include/ifx_core.h:20:16: error: redefinition of 'ifx_t'\n" ) ).to eq( [] )
254
+ end
255
+ end
256
+
257
+ it 'prescribes beside the substituted-header diagnosis when one failure shows both' do
258
+ reached( '/project/library/gpio.h', '/project/include/a.h', '/project/include/b.h' )
259
+
260
+ notices = prescriptions( "/project/library/gpio.h:1:1: error: redefinition of 'g'\n/project/include/a.h:2:2: note: previous definition is here\n" )
261
+
262
+ expect( notices.size ).to eq( 2 )
263
+ expect( notices[0] ).to include( "'/project/library/gpio.h'" )
264
+ expect( notices[1] ).to include( "'/project/include'" )
265
+ end
266
+ end
267
+ end
@@ -0,0 +1,137 @@
1
+ # =========================================================================
2
+ # Ceedling - Test-Centered Build System for C
3
+ # ThrowTheSwitch.org
4
+ # Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
5
+ # SPDX-License-Identifier: MIT
6
+ # =========================================================================
7
+
8
+ require 'spec_helper'
9
+ require 'ceedling/constants'
10
+ require 'ceedling/diagnostics/build_step_doctor'
11
+ require 'ceedling/diagnostics/include_depth_specialist'
12
+
13
+ describe IncludeDepthSpecialist do
14
+ FORWARDING = 'vendor/esp32/include/freertos/timers.h'
15
+ KERNEL = 'vendor/kernel/include/timers.h'
16
+
17
+ before(:each) do
18
+ # Files by path, each with its text
19
+ @files = { FORWARDING => "#include <timers.h>\n", KERNEL => "int xTimerStart(int t);\n" }
20
+
21
+ @file_wrapper = double( 'file_wrapper' )
22
+ allow( @file_wrapper ).to receive( :exist? ) { |path| @files.key?( path ) }
23
+ allow( @file_wrapper ).to receive( :read ) { |path| @files.fetch( path ) }
24
+
25
+ @loginator = double( 'loginator' )
26
+ allow( @loginator ).to receive( :log )
27
+
28
+ nobody = double( 'specialist', diagnoses: [] )
29
+
30
+ @doctor = BuildStepDoctor.new(
31
+ loginator: @loginator, header_collision_specialist: nobody, missing_symbol_specialist: nobody,
32
+ duplicate_symbol_specialist: nobody, partial_name_specialist: nobody,
33
+ include_depth_specialist: described_class.new( file_wrapper: @file_wrapper )
34
+ ).tap( &:setup )
35
+ end
36
+
37
+ def prescriptions(output, search_paths: ['vendor/esp32/include/freertos', 'vendor/kernel/include'], step: :compile)
38
+ @doctor.diagnose( step: step, output: output, inputs: { search_paths: search_paths } )
39
+ end
40
+
41
+ GCC_NESTING = "In file included from #{FORWARDING}:1,\n from src/halGpio.h:3,\n" \
42
+ "#{FORWARDING}:1:20: error: #include nested depth 200 exceeds maximum of 200 " \
43
+ "(use -fmax-include-depth=DEPTH to increase the maximum)\n"
44
+ CLANG_NESTING = "In file included from src/halGpio.c:1:\nIn file included from #{FORWARDING}:1:\n" \
45
+ "#{FORWARDING}:1:10: error: #include nested too deeply\n"
46
+
47
+ {
48
+ 'GCC 10 and later' => GCC_NESTING,
49
+ 'GCC quoting the directive' => "#{FORWARDING}:1:20: error: '#include' nested depth 200 exceeds maximum of 200\n",
50
+ 'GCC quoting in UTF-8' => "#{FORWARDING}:1:20: error: ‘#include’ nested depth 200 exceeds maximum of 200\n",
51
+ 'Clang and older GCC' => CLANG_NESTING,
52
+ 'MSVC' => "#{FORWARDING}(1): fatal error C1014: too many include files : depth = 1024\n",
53
+ 'EDG front ends' => "\"#{FORWARDING}\", line 1: catastrophic error: #include file \"#{FORWARDING}\" includes itself\n",
54
+ 'other compilers, generically' => "#{FORWARDING}:1: error: include depth limit reached\n"
55
+ }.each do |family, output|
56
+ it "recognizes #{family} and names the header that includes itself" do
57
+ notice = prescriptions( output ).first
58
+
59
+ expect( notice ).to start_with( 'The compiler output appears to report #include directives nested too deeply' )
60
+ expect( notice ).to include( "'#{FORWARDING}' includes <timers.h>, and the search paths find that name in the header's own directory first " \
61
+ "('vendor/esp32/include/freertos'), so it includes itself. '#{KERNEL}' is later in the search paths." )
62
+ end
63
+ end
64
+
65
+ it 'prescribes nothing for an unrelated error, even one naming a directory called nested' do
66
+ expect( prescriptions( "In file included from vendor/nested/a.h:1:\nsrc/a.c:2:3: error: expected ';'\n" ) ).to be_empty
67
+ end
68
+
69
+ it 'diagnoses preprocessing as well as compilation, and nothing at linking' do
70
+ expect( prescriptions( GCC_NESTING, step: :preprocess ).size ).to eq( 1 )
71
+ expect( prescriptions( GCC_NESTING, step: :link ) ).to be_empty
72
+ end
73
+
74
+ it 'leaves out the intended header when no later search path holds one' do
75
+ notice = prescriptions( GCC_NESTING, search_paths: ['vendor/esp32/include/freertos'] ).first
76
+
77
+ expect( notice ).to include( "so it includes itself.\n\nHOW THIS HAPPENS:" )
78
+ end
79
+
80
+ it 'explains that a quoted self-include loops whatever the search path order' do
81
+ @files[FORWARDING] = "#include \"timers.h\"\n"
82
+ notice = prescriptions( GCC_NESTING, search_paths: ['vendor/kernel/include', 'vendor/esp32/include/freertos'] ).first
83
+
84
+ expect( notice ).to include(
85
+ "'#{FORWARDING}' includes \"timers.h\". A quoted #include searches the header's own directory before any search path, " \
86
+ "so it includes itself whatever their order. '#{KERNEL}' is in the search paths, and #include <timers.h> would let their order reach it."
87
+ )
88
+ expect( notice ).not_to include( 'is later in the search paths' )
89
+ end
90
+
91
+ it 'names the header by its search path, not by the spelling the compiler output uses' do
92
+ spelled = 'vendor/esp32/include/./freertos/timers.h'
93
+ @files[spelled] = @files[FORWARDING]
94
+ notice = prescriptions( "#{spelled}:1:10: error: #include nested too deeply\n" ).first
95
+
96
+ expect( notice ).to include( "'#{FORWARDING}' includes <timers.h>" )
97
+ end
98
+
99
+ it 'reads a header holding bytes invalid in its encoding' do
100
+ @files[FORWARDING] = (+"/* \xFF */\n#include <timers.h>\n").force_encoding( Encoding::UTF_8 )
101
+
102
+ expect( prescriptions( GCC_NESTING ).first ).to include( "'#{FORWARDING}' includes <timers.h>" )
103
+ end
104
+
105
+ it 'gives the general guidance alone when the search paths reach the intended header first' do
106
+ notice = prescriptions( GCC_NESTING, search_paths: ['vendor/kernel/include', 'vendor/esp32/include/freertos'] ).first
107
+
108
+ expect( notice ).to include( "which usually means a header includes itself.\n\nHOW THIS HAPPENS:" )
109
+ end
110
+
111
+ it 'gives the general guidance alone for headers that include each other' do
112
+ @files['inc/a.h'] = "#include \"b.h\"\n"
113
+ @files['inc/b.h'] = "#include \"a.h\"\n"
114
+ notice = prescriptions( "inc/b.h:1:10: error: #include nested too deeply\n", search_paths: ['inc'] ).first
115
+
116
+ expect( notice ).to include( "which usually means a header includes itself.\n\nHOW THIS HAPPENS:", '3. Give headers that include each other include guards' )
117
+ end
118
+
119
+ it 'gives the general guidance alone when the header named cannot be read' do
120
+ @files.delete( FORWARDING )
121
+
122
+ expect( prescriptions( GCC_NESTING ).first ).to include( "includes itself.\n\nHOW THIS HAPPENS:" )
123
+ end
124
+
125
+ it 'reads the header the error line names after its wording, not one the line before names' do
126
+ @files['inc/other.h'] = "#include <timers.h>\n"
127
+ output = "In file included from inc/other.h:4,\ntoo many include files, giving up in #{FORWARDING}\n"
128
+
129
+ expect( prescriptions( output, search_paths: ['inc', 'vendor/esp32/include/freertos', 'vendor/kernel/include'] ).first ).to include( "'#{FORWARDING}' includes <timers.h>" )
130
+ end
131
+
132
+ it 'reads the header the error line names, not one the include chain names first' do
133
+ output = "In file included from inc/other.h:4,\n#{FORWARDING}:1:20: error: #include nested depth 200 exceeds maximum of 200\n"
134
+
135
+ expect( prescriptions( output ).first ).to include( "'#{FORWARDING}' includes <timers.h>" )
136
+ end
137
+ end
@@ -0,0 +1,154 @@
1
+ # =========================================================================
2
+ # Ceedling - Test-Centered Build System for C
3
+ # ThrowTheSwitch.org
4
+ # Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
5
+ # SPDX-License-Identifier: MIT
6
+ # =========================================================================
7
+
8
+ require 'spec_helper'
9
+ require 'ceedling/constants'
10
+ require 'ceedling/diagnostics/build_step_doctor'
11
+ require 'ceedling/diagnostics/missing_symbol_specialist'
12
+
13
+ describe MissingSymbolSpecialist do
14
+ before(:each) do
15
+ @configurator = double( 'configurator' )
16
+ allow( @configurator ).to receive( :project_use_mocks ).and_return( false )
17
+ allow( @configurator ).to receive( :project_use_partials ).and_return( false )
18
+ allow( @configurator ).to receive( :project_use_test_preprocessor_tests ).and_return( false )
19
+
20
+ @loginator = double( 'loginator' )
21
+ allow( @loginator ).to receive( :log )
22
+
23
+ nobody = double( 'specialist', diagnoses: [] )
24
+
25
+ @doctor = BuildStepDoctor.new(
26
+ loginator: @loginator, header_collision_specialist: nobody,
27
+ missing_symbol_specialist: described_class.new( configurator: @configurator ), duplicate_symbol_specialist: nobody,
28
+ partial_name_specialist: nobody,
29
+ include_depth_specialist: nobody
30
+ ).tap( &:setup )
31
+ end
32
+
33
+ def prescriptions(output, step: :link)
34
+ @doctor.diagnose( step: step, output: output, inputs: {} )
35
+ end
36
+
37
+ it 'prescribes missing-symbols guidance for an undefined reference' do
38
+ notices = prescriptions( "undefined reference to `foo'" )
39
+
40
+ expect( notices.size ).to eq( 1 )
41
+ expect( notices.first ).to match( /missing symbols/i )
42
+ end
43
+
44
+ it 'prescribes nothing for an unrelated linker failure' do
45
+ expect( prescriptions( 'some unrelated linker failure' ) ).to eq( [] )
46
+ end
47
+
48
+ {
49
+ 'GNU ld and Microchip XC16/XC32' => "/usr/bin/ld: build/a_test.o: in function `test_f':\na_test.c:(.text+0x9): undefined reference to `gpio_init'\n",
50
+ 'LLD' => "ld.lld: error: undefined symbol: gpio_init\n>>> referenced by a_test.c\n",
51
+ 'Apple ld' => "Undefined symbols for architecture arm64:\n \"_gpio_init\", referenced from:\nld: symbol(s) not found for architecture arm64\n",
52
+ 'MSVC' => "a_test.obj : error LNK2019: unresolved external symbol gpio_init referenced in function test_f\n",
53
+ 'MSVC, unreferenced by function' => "a_test.obj : error LNK2001: unresolved external symbol gpio_state\n",
54
+ 'IAR ILINK' => "Error[Li005]: no definition for \"gpio_init\" [referenced from a_test.o]\n",
55
+ 'Arm armlink' => "Error: L6218E: Undefined symbol gpio_init (referred from a_test.o).\n",
56
+ 'TI' => " undefined first referenced\n symbol in file\n gpio_init a_test.obj\nerror #10234-D: unresolved symbols remain\n",
57
+ 'other linkers, generically' => "?ASlink-Warning-Undefined Global '_gpio_init' referenced by module 'a_test'\n"
58
+ }.each do |family, output|
59
+ it "recognizes #{family}" do
60
+ expect( prescriptions( output ).size ).to eq( 1 )
61
+ end
62
+ end
63
+
64
+ {
65
+ 'GNU ld' => "a.o: in function `f': multiple definition of `f'; b.o:(.text+0x0): first defined here\n",
66
+ 'Apple ld' => "duplicate symbol '_f' in:\n a.o\n b.o\nld: 1 duplicate symbol for architecture arm64\n",
67
+ 'Arm armlink' => "Error: L6200E: Symbol f multiply defined (by a.o and b.o).\n"
68
+ }.each do |family, output|
69
+ it "leaves duplicate symbols reported by #{family} to their own diagnosis" do
70
+ expect( prescriptions( output ) ).to eq( [] )
71
+ end
72
+ end
73
+
74
+ it 'covers only linking' do
75
+ expect( prescriptions( "undefined reference to `foo'", step: :compile ) ).to eq( [] )
76
+ end
77
+
78
+ it 'includes mock-specific guidance only when the project uses mocks' do
79
+ expect( prescriptions( "undefined reference to `foo'" ).first ).not_to match( /needed mocks/i )
80
+
81
+ allow( @configurator ).to receive( :project_use_mocks ).and_return( true )
82
+
83
+ expect( prescriptions( "undefined reference to `foo'" ).first ).to match( /needed mocks/i )
84
+ end
85
+
86
+ it 'logs at ERRORS as a notice' do
87
+ prescriptions( "undefined reference to `foo'" )
88
+
89
+ expect( @loginator ).to have_received( :log ).with( a_string_matching( /missing symbols/i ), Verbosity::ERRORS, LogLabels::NOTICE )
90
+ end
91
+
92
+ def notice
93
+ prescriptions( "undefined reference to `foo'" ).first
94
+ end
95
+
96
+ it 'opens tentatively, then gives causes, education, and options in left-justified blocks' do
97
+ allow( @configurator ).to receive( :project_use_mocks ).and_return( true )
98
+
99
+ expect( notice ).to start_with(
100
+ "The linker output appears to report missing symbols. If so, the following may be to blame:\n" \
101
+ "1. This test lacks #include statements corresponding to needed source files (see note below).\n"
102
+ )
103
+ expect( notice ).to include(
104
+ "4. This test does not #include needed mocks (that triggers their generation).\n\n" \
105
+ "NOTE: A test file directs the build of a test executable with #include statements:\n" \
106
+ "• By convention, Ceedling assumes header filenames correspond to source filenames.\n",
107
+ "\n\nOPTIONS:\n1. Doublecheck this test's #include statements.\n",
108
+ "4. 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.\n",
109
+ "5. Mock the header that declares a missing function, so the mock supplies it.\n"
110
+ )
111
+ expect( notice.lines.grep( /\A\s/ ) ).to all( eq( "\n" ) )
112
+ end
113
+
114
+ it 'no longer blames mixed C and C++ file extensions' do
115
+ expect( notice ).not_to include( 'C++' )
116
+ end
117
+
118
+ context 'without test preprocessing' do
119
+ it 'blames macros obscuring #include statements read as text, and offers to enable preprocessing' do
120
+ expect( notice ).to include(
121
+ "3. Complex macros, #ifdefs, etc. have obscured correct #include statements in this test.\n",
122
+ "3. Enable test preprocessing with :project ↳ :use_test_preprocessor, so macros and #ifdefs decide which #include statements count.\n"
123
+ )
124
+ end
125
+ end
126
+
127
+ context 'with test preprocessing' do
128
+ before(:each) { allow( @configurator ).to receive( :project_use_test_preprocessor_tests ).and_return( true ) }
129
+
130
+ it 'blames macros as the preprocessor evaluates them, and offers no preprocessing option' do
131
+ expect( notice ).to include( "3. Macros or #ifdefs, evaluated with this test's defines, leave out an #include statement the test needs.\n" )
132
+ expect( notice ).not_to include( 'Enable test preprocessing' )
133
+ end
134
+ end
135
+
136
+ it 'offers a mock as a remedy, naming the setting when mocks are off' do
137
+ expect( notice ).to include( "Mock the header that declares a missing function, so the mock supplies it. Mocking requires :project ↳ :use_mocks.\n" )
138
+ end
139
+
140
+ context 'with Partials enabled' do
141
+ before(:each) { allow( @configurator ).to receive( :project_use_partials ).and_return( true ) }
142
+
143
+ it 'blames a function a Partial left out, and offers to select it' do
144
+ expect( notice ).to include(
145
+ "4. A Partial in this test leaves out a function the test or the Partial's code calls. A Partial carries only the functions its directive selects.\n",
146
+ "6. Select a function a Partial left out with +name in its directive, or select the whole module with TEST_PARTIAL_ALL_MODULE.\n"
147
+ )
148
+ end
149
+ end
150
+
151
+ it 'says nothing of Partials when they are off' do
152
+ expect( notice ).not_to include( 'Partial' )
153
+ end
154
+ end