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,170 @@
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
+
12
+ describe BuildStepDoctor do
13
+
14
+ def specialist(*diagnoses)
15
+ double( 'specialist', diagnoses: diagnoses )
16
+ end
17
+
18
+ def doctor_with(*diagnoses, others: [])
19
+ @loginator = double( 'loginator' )
20
+ allow( @loginator ).to receive( :log )
21
+
22
+ described_class.new(
23
+ loginator: @loginator,
24
+ header_collision_specialist: specialist( *diagnoses ),
25
+ missing_symbol_specialist: specialist( *others ),
26
+ duplicate_symbol_specialist: specialist,
27
+ partial_name_specialist: specialist,
28
+ include_depth_specialist: specialist
29
+ )
30
+ end
31
+
32
+ def diagnosis(name, steps: [:compile], outcomes: [:failure], symptoms: /boom/, &examination)
33
+ BuildStepDoctor::Diagnosis.new(
34
+ name: name, steps: steps, outcomes: outcomes, symptoms: symptoms,
35
+ examination: examination || ->(_case) { "#{name} prescription" }
36
+ )
37
+ end
38
+
39
+ it 'logs a matching diagnosis\'s prescription at ERRORS as a notice and returns it' do
40
+ doctor = doctor_with( diagnosis( :first ) )
41
+
42
+ expect( doctor.diagnose( step: :compile, output: 'a boom here', inputs: {} ) ).to eq( ['first prescription'] )
43
+ expect( @loginator ).to have_received( :log ).with( 'first prescription', Verbosity::ERRORS, LogLabels::NOTICE )
44
+ end
45
+
46
+ it 'examines nothing when the symptoms are absent' do
47
+ examined = false
48
+ doctor = doctor_with( diagnosis( :quiet ) { |_case| examined = true; 'x' } )
49
+
50
+ expect( doctor.diagnose( step: :compile, output: 'all fine', inputs: {} ) ).to eq( [] )
51
+ expect( examined ).to be false
52
+ expect( @loginator ).not_to have_received( :log )
53
+ end
54
+
55
+ it 'examines only diagnoses for the case\'s step' do
56
+ doctor = doctor_with( diagnosis( :compiling ), diagnosis( :linking, steps: [:link] ) )
57
+
58
+ expect( doctor.diagnose( step: :link, output: 'boom', inputs: {} ) ).to eq( ['linking prescription'] )
59
+ end
60
+
61
+ it 'examines only diagnoses for the case\'s outcome' do
62
+ doctor = doctor_with( diagnosis( :failing ), diagnosis( :warning, outcomes: [:warning] ) )
63
+
64
+ expect( doctor.diagnose( step: :compile, outcome: :warning, output: 'boom', inputs: {} ) ).to eq( ['warning prescription'] )
65
+ end
66
+
67
+ it 'prescribes for every matching diagnosis, across specialists, in registration order' do
68
+ doctor = doctor_with( diagnosis( :one ), diagnosis( :two ), others: [diagnosis( :three )] )
69
+
70
+ expect( doctor.diagnose( step: :compile, output: 'boom', inputs: {} ) ).to eq(
71
+ ['one prescription', 'two prescription', 'three prescription']
72
+ )
73
+ end
74
+
75
+ it 'matches when any of several symptoms appears' do
76
+ doctor = doctor_with( diagnosis( :either, symptoms: [/gcc wording/, /iar wording/] ) )
77
+
78
+ expect( doctor.diagnose( step: :compile, output: 'Error[Pe101]: iar wording', inputs: {} ) ).to eq( ['either prescription'] )
79
+ end
80
+
81
+ it 'hands the examination a case holding the step, outcome, output, symptom match, and inputs' do
82
+ seen = nil
83
+ doctor = doctor_with( diagnosis( :curious, symptoms: /b(o+)m/ ) { |kase| seen = kase; nil } )
84
+
85
+ doctor.diagnose( step: :compile, output: 'a boom', inputs: { source: 'a.c' } )
86
+
87
+ expect( seen.step ).to eq( :compile )
88
+ expect( seen.outcome ).to eq( :failure )
89
+ expect( seen.output ).to eq( 'a boom' )
90
+ expect( seen.symptoms[1] ).to eq( 'oo' )
91
+ expect( seen.inputs ).to eq( { source: 'a.c' } )
92
+ end
93
+
94
+ it 'accepts an examination that prescribes nothing, one prescription, or several' do
95
+ doctor = doctor_with(
96
+ diagnosis( :none ) { |_case| nil },
97
+ diagnosis( :one ) { |_case| 'single' },
98
+ diagnosis( :many ) { |_case| ['first', 'second'] }
99
+ )
100
+
101
+ expect( doctor.diagnose( step: :compile, output: 'boom', inputs: {} ) ).to eq( ['single', 'first', 'second'] )
102
+ expect( @loginator ).to have_received( :log ).with( anything, Verbosity::ERRORS, LogLabels::NOTICE ).exactly( 3 ).times
103
+ end
104
+
105
+ it 'goes on to the other diagnoses when an examination raises, logging the error at DEBUG' do
106
+ doctor = doctor_with( diagnosis( :broken ) { |_case| raise 'examination bug' }, diagnosis( :sound ) )
107
+
108
+ expect( doctor.diagnose( step: :compile, output: 'boom', inputs: {} ) ).to eq( ['sound prescription'] )
109
+ expect( @loginator ).to have_received( :log ).with( a_string_including( 'broken', 'examination bug' ), Verbosity::DEBUG )
110
+ end
111
+
112
+ it 'refuses a diagnosis for an unknown step' do
113
+ expect { doctor_with( diagnosis( :typo, steps: [:compiel] ) ) }.to raise_error( ::ArgumentError, /compiel/ )
114
+ end
115
+
116
+ it 'refuses a diagnosis for an unknown outcome' do
117
+ expect { doctor_with( diagnosis( :typo, outcomes: [:fail] ) ) }.to raise_error( ::ArgumentError, /fail/ )
118
+ end
119
+
120
+ it 'refuses to diagnose an unknown step or outcome' do
121
+ doctor = doctor_with( diagnosis( :fine ) )
122
+
123
+ expect { doctor.diagnose( step: :linking, output: 'boom', inputs: {} ) }.to raise_error( ::ArgumentError, /linking/ )
124
+ expect { doctor.diagnose( step: :link, outcome: :error, output: 'boom', inputs: {} ) }.to raise_error( ::ArgumentError, /error/ )
125
+ end
126
+
127
+ it 'treats missing output as no symptoms' do
128
+ doctor = doctor_with( diagnosis( :any ) )
129
+
130
+ expect( doctor.diagnose( step: :compile, output: nil, inputs: {} ) ).to eq( [] )
131
+ end
132
+
133
+ describe '#attend' do
134
+ def tool_failure(output)
135
+ ShellException.new( shell_result: { exit_code: 1, output: output }, name: 'gcc' )
136
+ end
137
+
138
+ it 'returns what the step returns and diagnoses nothing when it succeeds' do
139
+ doctor = doctor_with( diagnosis( :any ) )
140
+
141
+ expect( doctor.attend( step: :compile, inputs: {} ) { :built } ).to eq( :built )
142
+ expect( @loginator ).not_to have_received( :log )
143
+ end
144
+
145
+ it 'diagnoses a tool failure with its output and the step and inputs given, then raises the same failure' do
146
+ seen = nil
147
+ doctor = doctor_with( diagnosis( :curious, steps: [:preprocess] ) { |kase| seen = kase; 'guidance' } )
148
+ failure = tool_failure( 'a boom' )
149
+
150
+ expect { doctor.attend( step: :preprocess, inputs: { source: 'a.c' } ) { raise failure } }.to raise_error( failure )
151
+ expect( [seen.step, seen.output, seen.inputs] ).to eq( [:preprocess, 'a boom', { source: 'a.c' }] )
152
+ expect( @loginator ).to have_received( :log ).with( 'guidance', Verbosity::ERRORS, LogLabels::NOTICE )
153
+ end
154
+
155
+ it 'refuses an unknown step before running the step' do
156
+ doctor = doctor_with( diagnosis( :any ) )
157
+ ran = false
158
+
159
+ expect { doctor.attend( step: :preprocces, inputs: {} ) { ran = true } }.to raise_error( ::ArgumentError, /preprocces/ )
160
+ expect( ran ).to be false
161
+ end
162
+
163
+ it 'leaves any other error undiagnosed' do
164
+ doctor = doctor_with( diagnosis( :any ) )
165
+
166
+ expect { doctor.attend( step: :compile, inputs: {} ) { raise 'boom' } }.to raise_error( RuntimeError, 'boom' )
167
+ expect( @loginator ).not_to have_received( :log )
168
+ end
169
+ end
170
+ end
@@ -0,0 +1,117 @@
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/filename_extension'
11
+ require 'ceedling/diagnostics/build_step_doctor'
12
+ require 'ceedling/diagnostics/duplicate_symbol_specialist'
13
+
14
+ describe DuplicateSymbolSpecialist do
15
+ before(:each) do
16
+ @configurator = double( 'configurator', cmock_mock_prefix: 'mock_', extension_object: FilenameExtension.new( '.o' ) )
17
+ allow( @configurator ).to receive( :project_use_mocks ).and_return( true )
18
+
19
+ @loginator = double( 'loginator' )
20
+ allow( @loginator ).to receive( :log )
21
+
22
+ nobody = double( 'specialist', diagnoses: [] )
23
+
24
+ @doctor = BuildStepDoctor.new(
25
+ loginator: @loginator, header_collision_specialist: nobody, missing_symbol_specialist: nobody,
26
+ duplicate_symbol_specialist: described_class.new( configurator: @configurator ), partial_name_specialist: nobody,
27
+ include_depth_specialist: nobody
28
+ ).tap( &:setup )
29
+ end
30
+
31
+ def prescriptions(output, objects: ['build/out/a_test.o', 'build/out/gpio.o'], step: :link)
32
+ @doctor.diagnose( step: step, output: output, inputs: { objects: objects } )
33
+ end
34
+
35
+ GNU_DUPLICATE = "/usr/bin/ld: build/out/gpio.o: in function `gpio_init':\n" \
36
+ "gpio.c:(.text+0x0): multiple definition of `gpio_init'; build/out/a_test.o:a_test.c:(.text+0x0): first defined here\n"
37
+
38
+ {
39
+ 'GNU ld' => GNU_DUPLICATE,
40
+ 'LLD' => "ld.lld: error: duplicate symbol: gpio_init\n>>> defined at gpio.c\n",
41
+ 'Apple ld' => "duplicate symbol '_gpio_init' in:\n build/out/a_test.o\n build/out/gpio.o\n",
42
+ 'MSVC' => "gpio.obj : error LNK2005: gpio_init already defined in a_test.obj\n",
43
+ 'MSVC, summarized' => "a_test.exe : fatal error LNK1169: one or more multiply defined symbols found\n",
44
+ 'IAR ILINK' => "Error[Li006]: duplicate definitions for \"gpio_init\"; in \"gpio.o\", and \"a_test.o\"\n",
45
+ 'Arm armlink' => "Error: L6200E: Symbol gpio_init multiply defined (by gpio.o and a_test.o).\n",
46
+ 'TI' => "error #10056: symbol \"gpio_init\" redefined: first defined in \"a_test.obj\"; redefined in \"gpio.obj\"\n",
47
+ 'other linkers, generically' => "?ASlink-Error-Multiple definition of _gpio_init\n"
48
+ }.each do |family, output|
49
+ it "recognizes #{family}" do
50
+ expect( prescriptions( output ).size ).to eq( 1 )
51
+ end
52
+ end
53
+
54
+ context 'without mocks' do
55
+ before(:each) { allow( @configurator ).to receive( :project_use_mocks ).and_return( false ) }
56
+
57
+ it 'leaves out the mock cause and option, and names the setting a mock remedy needs' do
58
+ notice = prescriptions( GNU_DUPLICATE ).first
59
+
60
+ expect( notice ).not_to include( '• A mock defines', "4. Don't #include both" )
61
+ expect( notice ).to include( "or mock the source's header instead. Mocking requires :project ↳ :use_mocks.\n" )
62
+ end
63
+ end
64
+
65
+ it 'prescribes nothing for a missing symbol' do
66
+ expect( prescriptions( "undefined reference to `gpio_init'\n" ) ).to eq( [] )
67
+ end
68
+
69
+ it 'covers only linking' do
70
+ expect( prescriptions( GNU_DUPLICATE, step: :compile ) ).to eq( [] )
71
+ end
72
+
73
+ it 'opens tentatively and gives the general causes, education, and options, left-justified' do
74
+ notice = prescriptions( GNU_DUPLICATE ).first
75
+
76
+ expect( notice ).to start_with( "The linker output appears to report a symbol defined more than once.\n\nHOW THIS HAPPENS:\n" )
77
+ expect( notice ).to include(
78
+ "• A program may define each function and each global variable only once across all its object files.\n",
79
+ "• A definition in a header, a function body or a variable without extern, is repeated in every source that #includes the header.\n",
80
+ "\n\nOPTIONS:\n1. Declare header variables extern, and define each one in a single source file.\n",
81
+ "4. Don't #include both a mock and its real header in one test and don't name a mocked module's source in TEST_SOURCE_FILE().\n"
82
+ )
83
+ expect( notice.lines.grep( /\A\s/ ) ).to eq( ["\n", "\n"] )
84
+ end
85
+
86
+ context 'with a mock and the source it stands in for both linked' do
87
+ let(:objects) { ['build/out/a_test.o', 'build/out/mock_gpio.o', 'build/out/gpio.o'] }
88
+
89
+ it 'names the pair as the likely cause' do
90
+ output = "/usr/bin/ld: build/out/gpio.o: in function `gpio_init':\n" \
91
+ "multiple definition of `gpio_init'; build/out/mock_gpio.o:(.text+0x0): first defined here\n"
92
+
93
+ expect( prescriptions( output, objects: objects ).first ).to start_with(
94
+ "The linker output appears to report a symbol defined more than once. " \
95
+ "This test links both 'mock_gpio.o' and 'gpio.o', which may define the same functions.\n\n"
96
+ )
97
+ end
98
+
99
+ it 'names the pair from the linked objects when the output names no object' do
100
+ output = "ld.lld: error: duplicate symbol: gpio_init\n"
101
+
102
+ expect( prescriptions( output, objects: objects ).first ).to include( "links both 'mock_gpio.o' and 'gpio.o'" )
103
+ end
104
+
105
+ it 'leaves the pair out when the project does not use mocks' do
106
+ allow( @configurator ).to receive( :project_use_mocks ).and_return( false )
107
+
108
+ expect( prescriptions( "ld.lld: error: duplicate symbol: gpio_init\n", objects: objects ).first ).not_to include( 'links both' )
109
+ end
110
+
111
+ it 'leaves the pair out when the output names other objects' do
112
+ output = "multiple definition of `helper'; build/out/a_test.o:(.text+0x0): first defined here; build/out/util.o\n"
113
+
114
+ expect( prescriptions( output, objects: objects + ['build/out/util.o'] ).first ).not_to include( 'links both' )
115
+ end
116
+ end
117
+ end
@@ -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