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
@@ -7,6 +7,8 @@
7
7
 
8
8
  require 'spec_helper'
9
9
  require 'ceedling/generators/generator'
10
+ require 'ceedling/c_extractor/c_extractor_types'
11
+ require 'ceedling/partials/carry_plan'
10
12
  require 'ceedling/constants'
11
13
 
12
14
  # Scoped to Generator#generate_object_file_c's choice of which file the compiler receives,
@@ -47,6 +49,14 @@ describe Generator do
47
49
  )
48
50
  end
49
51
 
52
+ describe '#mock_generator_name' do
53
+ it 'names the class that writes each mock' do
54
+ allow(@generator_mocks).to receive(:generator_name).and_return( 'CMock' )
55
+
56
+ expect( @generator.mock_generator_name ).to eq( 'CMock' )
57
+ end
58
+ end
59
+
50
60
  describe '#generate_object_file_c' do
51
61
  it 'hands the compiler the source itself by default' do
52
62
  compile()
@@ -64,6 +74,22 @@ describe Generator do
64
74
  end
65
75
  end
66
76
 
77
+ describe '#generate_partial_implementation' do
78
+ it 'hands the carry plan and both Partials settings to Partial generation' do
79
+ plan = Partials::CarryPlan.new
80
+
81
+ @generator.generate_partial_implementation(
82
+ test: 'test_engine', partial: 'engine', function_definitions: [], source_includes: [],
83
+ header_includes: [], c_module: CExtractorTypes::CModule.new,
84
+ output_path: 'build/partials', carry: plan, suppress_redundant_decls: false, extern_variables: :test
85
+ )
86
+
87
+ expect(@collaborators[:generator_partials]).to have_received(:generate_implementation).with(
88
+ hash_including( carry: plan, suppress_redundant_decls: false, extern_variables: :test )
89
+ )
90
+ end
91
+ end
92
+
67
93
  describe '#generate_test_results' do
68
94
  before(:each) do
69
95
  allow(@collaborators[:generator_helper]).to receive(:test_crash?).and_return( false )
@@ -215,16 +215,20 @@ describe GeneratorTestRunner do
215
215
  expect( captured ).to eq( ['<sys/stat.h>'] )
216
216
  end
217
217
 
218
- it 'renders a user include with a directory component down to its bare filename, unchanged from prior behavior' do
219
- # Unlike a system header, a project's own directories are exposed to the
220
- # compiler as a flat list of -I search paths -- rendering a user include's
221
- # own directory component here breaks resolution rather than fixing anything,
222
- # so this behavior is intentionally unchanged by the issue #1236 fix.
218
+ it 'renders a user include with a directory component down to its bare filename when no spelling is given' do
219
+ # A user include's filepath can be its header's resolved location, which the runner's
220
+ # -I search paths don't reach, so without a spelling only its filename is rendered
223
221
  captured = build_and_capture_includes( includes: [ UserInclude.new('sub/header.h') ] )
224
222
 
225
223
  expect( captured ).to eq( ['header.h'] )
226
224
  end
227
225
 
226
+ it 'renders a user include by the spelling its caller found its header through' do
227
+ captured = build_and_capture_includes( includes: [ UserInclude.new('src/sub/header.h', include_path: 'sub/header.h') ] )
228
+
229
+ expect( captured ).to eq( ['sub/header.h'] )
230
+ end
231
+
228
232
  it 'renders a mixed list of system and user includes each in their own correct form' do
229
233
  captured = build_and_capture_includes(
230
234
  includes: [ SystemInclude.new('sys/stat.h'), UserInclude.new('sub/header.h') ]
@@ -0,0 +1,129 @@
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/generators/partial_source_writer'
10
+ require 'ceedling/partials/partials'
11
+ require 'ceedling/c_extractor/c_extractor_types'
12
+ require 'stringio'
13
+
14
+ describe PartialSourceWriter do
15
+ let(:buf) { StringIO.new }
16
+ let(:filepath) { 'build/partials/engine_impl.c' }
17
+
18
+ def writer(suppress_redundant_decls: true, path: filepath)
19
+ PartialSourceWriter.new( io: buf, filepath: path, suppress_redundant_decls: suppress_redundant_decls )
20
+ end
21
+
22
+ def decl(signature, line_num: nil, source_filepath: nil)
23
+ CExtractorTypes::CFunctionDeclaration.new(
24
+ name: signature[/(\w+)\s*\(/, 1], signature: signature, line_num: line_num, source_filepath: source_filepath
25
+ )
26
+ end
27
+
28
+ def func(code_block, line_num: nil, source_filepath: nil)
29
+ Partials.manufacture_function_definition(
30
+ name: code_block[/(\w+)\s*\(/, 1], signature: code_block[/\A[^{]*/].strip, code_block: code_block,
31
+ line_num: line_num, source_filepath: source_filepath
32
+ )
33
+ end
34
+
35
+ # The marker names the line after itself, so the line it lands on is one less
36
+ def expect_hand_back(text)
37
+ lines = buf.string.lines
38
+ index = lines.index { |l| l.include?( "\"#{filepath}\"" ) }
39
+ expect( index ).not_to be_nil
40
+ expect( lines[index] ).to eq( "#line #{index + 2} \"#{filepath}\"\n" )
41
+ expect( lines[index + 1] ).to eq( text )
42
+ end
43
+
44
+ it "writes the preamble with each include on its own line" do
45
+ writer.preamble( ['#include "a.h"', '#include "b.h"'] )
46
+
47
+ expect( buf.string ).to eq( "// Ceedling generated file\n#include \"a.h\"\n#include \"b.h\"\n\n" )
48
+ end
49
+
50
+ it "hands attribution back to this file after a located function" do
51
+ w = writer
52
+ w.preamble( [] )
53
+ w.function( func( "int get(void) { return 1; }", line_num: 9, source_filepath: 'src/engine.c' ) )
54
+ w.text( "int mode = 3;\n" )
55
+ w.finish
56
+
57
+ expect_hand_back( "int mode = 3;\n" )
58
+ end
59
+
60
+ it "hands attribution back before an unlocated function" do
61
+ w = writer
62
+ w.preamble( [] )
63
+ w.function( func( "int get(void) { return 1; }", line_num: 9, source_filepath: 'src/engine.c' ) )
64
+ w.function( func( "int put(void) { return 2; }" ) )
65
+ w.finish
66
+
67
+ expect_hand_back( "int put(void) { return 2; }\n" )
68
+ end
69
+
70
+ it "writes no hand-back without its own file path" do
71
+ w = writer( path: nil )
72
+ w.prototype( decl( 'int board_tick(void);', line_num: 5, source_filepath: 'src/engine.h' ) )
73
+ w.text( "int mode = 3;\n" )
74
+ w.finish
75
+
76
+ expect( buf.string.scan( '#line' ).size ).to eq( 1 )
77
+ end
78
+
79
+ # A backslash in a #line string starts an escape sequence
80
+ it "writes forward slashes in every line marker" do
81
+ w = writer( path: 'build\\partials\\engine_impl.c' )
82
+ w.prototype( decl( 'int board_tick(void);', line_num: 5, source_filepath: 'src\\engine.h' ) )
83
+ w.text( "int mode = 3;\n" )
84
+ w.finish
85
+
86
+ expect( buf.string ).to include( "#line 5 \"src/engine.h\"\n" )
87
+ expect( buf.string ).to include( "\"build/partials/engine_impl.c\"\n" )
88
+ expect( buf.string ).not_to include( '\\' )
89
+ end
90
+
91
+ it "writes a function once however often it is offered" do
92
+ w = writer
93
+ get = func( "int get(void) { return 1; }" )
94
+ w.function( get )
95
+ w.function( get )
96
+
97
+ expect( buf.string.scan( 'int get(void)' ).size ).to eq( 1 )
98
+ end
99
+
100
+ it "ignores a function that is not there" do
101
+ w = writer
102
+ w.function( nil )
103
+
104
+ expect( buf.string ).to eq( '' )
105
+ end
106
+
107
+ it "separates a function from the item before it with a blank line" do
108
+ w = writer
109
+ w.text( "int mode = 3;\n" )
110
+ w.function( func( "int get(void) { return 1; }" ) )
111
+
112
+ expect( buf.string ).to eq( "int mode = 3;\n\nint get(void) { return 1; }\n\n" )
113
+ end
114
+
115
+ it "writes a prototype without its surrounding whitespace" do
116
+ w = writer( suppress_redundant_decls: false )
117
+ w.prototype( decl( " int board_tick(void);\n" ) )
118
+
119
+ expect( buf.string ).to eq( "int board_tick(void);\n" )
120
+ end
121
+
122
+ it "closes the pragma run before a function" do
123
+ w = writer
124
+ w.prototype( decl( 'int board_tick(void);' ) )
125
+ w.function( func( "int get(void) { return 1; }" ) )
126
+
127
+ expect( buf.string ).to start_with( PartialSourceWriter::REDUNDANT_DECLS_PUSH + "int board_tick(void);\n" + PartialSourceWriter::REDUNDANT_DECLS_POP )
128
+ end
129
+ end
@@ -0,0 +1,406 @@
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/includes/header_search'
10
+ require 'ceedling/includes/includes'
11
+
12
+ describe HeaderSearch do
13
+ # A directory tree's headers, listed as IncludePathinator lists a directory
14
+ def search(paths, tree, **options)
15
+ @listed = Hash.new( 0 )
16
+ lister = lambda do |dir|
17
+ @listed[dir] += 1
18
+ tree.select { |header| File.dirname( header ) == dir }.sort
19
+ end
20
+
21
+ return described_class.new( paths, lister, **options )
22
+ end
23
+
24
+ describe "#header_candidates" do
25
+ it "finds a bare name in the first search path holding it, the others after it" do
26
+ headers = search( ['inc', 'src'], ['src/foo.h', 'inc/foo.h', 'src/bar.h'] )
27
+
28
+ expect(headers.header_candidates( 'foo.h' )).to eq( ['inc/foo.h', 'src/foo.h'] )
29
+ end
30
+
31
+ it "finds a bare name exactly as a trailing match over every search path's listing does" do
32
+ tree = ['a/x.h', 'a/y.h', 'b/x.h', 'b/sub/x.h', 'c/z.h']
33
+ headers = search( ['b', 'a', 'c'], tree )
34
+ flat = ['b', 'a', 'c'].flat_map { |dir| tree.select { |header| File.dirname( header ) == dir }.sort }
35
+
36
+ %w[x.h y.h z.h w.h].each do |name|
37
+ expect(headers.header_candidates( name )).to eq( PathMatcher.candidates( name, flat ) )
38
+ end
39
+ end
40
+
41
+ it "joins each search path with the directory an #include names" do
42
+ headers = search( ['src'], ['src/drivers/foo.h'] )
43
+
44
+ expect(headers.header_candidates( 'drivers/foo.h' )).to eq( ['src/drivers/foo.h'] )
45
+ end
46
+
47
+ it "finds the same path below two search paths in search order" do
48
+ headers = search( ['b', 'a'], ['a/drivers/foo.h', 'b/drivers/foo.h'] )
49
+
50
+ expect(headers.header_candidates( 'drivers/foo.h' )).to eq( ['b/drivers/foo.h', 'a/drivers/foo.h'] )
51
+ end
52
+
53
+ it "prefers a join over a header whose trailing path matches" do
54
+ headers = search( ['lib/drivers', 'src'], ['lib/drivers/foo.h', 'src/drivers/foo.h'] )
55
+
56
+ expect(headers.header_candidates( 'drivers/foo.h' )).to eq( ['src/drivers/foo.h'] )
57
+ end
58
+
59
+ it "drops a leading ./ and empty segments from the #include" do
60
+ headers = search( ['src'], ['src/drivers/foo.h'] )
61
+
62
+ expect(headers.header_candidates( './drivers//foo.h' )).to eq( ['src/drivers/foo.h'] )
63
+ end
64
+
65
+ it "gives one header reached through two spellings of its directory once" do
66
+ headers = search( ['src', './src'], ['src/foo.h', './src/foo.h'] )
67
+
68
+ expect(headers.header_candidates( 'foo.h' )).to eq( ['src/foo.h'] )
69
+ end
70
+
71
+ it "keeps a filename that differs only in letter case out of the candidates" do
72
+ headers = search( ['src'], ['src/drivers/Foo.h'] )
73
+
74
+ expect(headers.header_candidates( 'drivers/foo.h' )).to eq( [] )
75
+ end
76
+
77
+ # A mock after stage 4 names its place below its mirror root, which need not be a
78
+ # search path
79
+ it "matches the trailing path of a header directly in a search path when no join reaches it" do
80
+ headers = search( ['test/support'], ['test/support/foo.h'] )
81
+
82
+ expect(headers.header_candidates( 'support/foo.h' )).to eq( ['test/support/foo.h'] )
83
+ end
84
+
85
+ # A plain #include after stage 4 carries the path GCC found it by
86
+ it "takes the #include's own path when it names a header below a search path" do
87
+ headers = search( ['src'], ['src/drivers/foo.h'] )
88
+
89
+ expect(headers.header_candidates( 'src/drivers/foo.h' )).to eq( ['src/drivers/foo.h'] )
90
+ end
91
+
92
+ it "takes an absolute path below a search path" do
93
+ headers = search( ['/opt/sdk'], ['/opt/sdk/drivers/foo.h'] )
94
+
95
+ expect(headers.header_candidates( '/opt/sdk/drivers/foo.h' )).to eq( ['/opt/sdk/drivers/foo.h'] )
96
+ end
97
+
98
+ # ProjectPaths expands both sides alike, so a drive-lettered path compares on any host
99
+ it "takes a path with a drive letter below a search path" do
100
+ headers = search( ['C:/sdk/inc'], ['C:/sdk/inc/drivers/x.h'] )
101
+
102
+ expect(headers.header_candidates( 'C:\\sdk\\inc\\drivers\\x.h' )).to eq( ['C:/sdk/inc/drivers/x.h'] )
103
+ end
104
+
105
+ it "finds no absolute path outside every search path" do
106
+ headers = search( ['src'], ['/opt/sdk/foo.h'] )
107
+
108
+ expect(headers.header_candidates( '/opt/sdk/foo.h' )).to eq( [] )
109
+ end
110
+
111
+ # The scan resolves `..` against the test file's own directory
112
+ it "never joins a search path with an #include that climbs" do
113
+ headers = search( ['src/a'], ['src/b/foo.h', 'src/a/foo.h'] )
114
+
115
+ expect(headers.header_candidates( '../b/foo.h' )).to eq( [] )
116
+ end
117
+
118
+ it "never reads a glob character in an #include's directory as a glob" do
119
+ headers = search( ['src', '.'], ['src/drivers/foo.h'] )
120
+
121
+ expect(headers.header_candidates( 'd*/foo.h' )).to eq( [] )
122
+ expect(@listed.keys).to_not include( a_string_including( '*' ) )
123
+ end
124
+
125
+ it "finds a header whose own name holds a glob character" do
126
+ expect(search( ['src'], ['src/a[1].h'] ).header_candidates( 'a[1].h' )).to eq( ['src/a[1].h'] )
127
+ end
128
+
129
+ it "finds nothing for a name no search path reaches" do
130
+ headers = search( ['src'], ['src/foo.h'] )
131
+
132
+ expect(headers.header_candidates( 'drivers/bar.h' )).to eq( [] )
133
+ end
134
+ end
135
+
136
+ describe "#refusal" do
137
+ it "explains a query by its own spelling, slashes and dot segments aside" do
138
+ headers = described_class.new( ['src'], ->(_dir) { [] }, refusals: { 'sys/socket.h' => 'why' } )
139
+
140
+ expect(headers.refusal( 'sys/socket.h' )).to eq( 'why' )
141
+ expect(headers.refusal( './sys\\socket.h' )).to eq( 'why' )
142
+ expect(headers.refusal( 'socket.h' )).to be_nil
143
+ end
144
+
145
+ it "explains nothing by default" do
146
+ expect(search( ['src'], [] ).refusal( 'socket.h' )).to be_nil
147
+ end
148
+ end
149
+
150
+ describe "#joins?" do
151
+ it "says whether a search path joined with the text names a header, as -I does" do
152
+ headers = search( ['src'], ['src/drivers/foo.h'] )
153
+
154
+ expect(headers.joins?( 'drivers/foo.h' )).to be( true )
155
+ expect(headers.joins?( 'src/drivers/foo.h' )).to be( false )
156
+ end
157
+ end
158
+
159
+ describe "#hint_files" do
160
+ it "holds every header the search looked at, so one in another letter case can be named" do
161
+ headers = search( ['inc', 'src'], ['inc/top.h', 'src/drivers/Foo.h'] )
162
+
163
+ expect(headers.hint_files( 'drivers/foo.h' )).to include( 'src/drivers/Foo.h', 'inc/top.h' )
164
+ end
165
+ end
166
+
167
+ describe "#spelling" do
168
+ it "spells a header by its filename when the search paths find it by that" do
169
+ expect(search( ['inc', 'src'], ['src/foo.h'] ).spelling( 'src/foo.h' )).to eq( 'foo.h' )
170
+ end
171
+
172
+ it "spells a header below a search path by its path below that search path" do
173
+ expect(search( ['src'], ['src/drivers/foo.h'] ).spelling( 'src/drivers/foo.h' )).to eq( 'drivers/foo.h' )
174
+ end
175
+
176
+ it "spells a header a same-named one shadows by its filename by its path below a search path" do
177
+ headers = search( ['src', 'src/drivers'], ['src/foo.h', 'src/drivers/foo.h'] )
178
+
179
+ expect(headers.spelling( 'src/drivers/foo.h' )).to eq( 'drivers/foo.h' )
180
+ end
181
+
182
+ it "gives nil for a header no search path reaches" do
183
+ expect(search( ['src'], ['other/foo.h'] ).spelling( 'other/foo.h' )).to be_nil
184
+ end
185
+
186
+ it "keeps a preferred text that finds the header first" do
187
+ headers = search( ['src', 'src/app', 'src/hw'], ['src/app/config.h', 'src/hw/config.h'] )
188
+
189
+ expect(headers.spelling( 'src/app/config.h', preferring: 'app/config.h' )).to eq( 'app/config.h' )
190
+ end
191
+
192
+ # The compiler only joins a text with each search path
193
+ it "passes over a preferred text the search paths reach only by its trailing path" do
194
+ headers = search( ['src/hw', 'lib'], ['src/hw/config.h', 'lib/app/config.h'] )
195
+
196
+ expect(headers.spelling( 'src/hw/config.h', preferring: 'hw/config.h' )).to eq( 'config.h' )
197
+ end
198
+
199
+ it "passes over a preferred text that finds another header" do
200
+ headers = search( ['src', 'src/app', 'src/hw'], ['src/app/config.h', 'src/hw/config.h'] )
201
+
202
+ expect(headers.spelling( 'src/hw/config.h', preferring: 'config.h' )).to eq( 'hw/config.h' )
203
+ end
204
+ end
205
+
206
+ describe "#at" do
207
+ it "gives the header a path names itself, whatever a search path joins that path to" do
208
+ headers = search( ['include', 'third_party/mylib'], ['include/config.h', 'third_party/mylib/include/config.h'] )
209
+
210
+ expect(headers.at( 'include/config.h' )).to eq( 'include/config.h' )
211
+ expect(headers.header_candidates( 'include/config.h' ).first).to eq( 'third_party/mylib/include/config.h' )
212
+ end
213
+
214
+ it "gives nil where no header lies at the path" do
215
+ expect(search( ['src'], ['src/foo.h'] ).at( 'src/bar.h' )).to be_nil
216
+ end
217
+ end
218
+
219
+ # A generated file writes a header's #include by the text that reaches it, and a Partial
220
+ # matches modules by the header the include names
221
+ describe "Include#spelled_by" do
222
+ it "spells a user #include as the search paths reach its header, and names that header" do
223
+ spelled = UserInclude.new( 'drivers/foo.h' ).spelled_by( search( ['src'], ['src/drivers/foo.h'] ) )
224
+
225
+ expect( [spelled.filepath, spelled.include_path, spelled.to_s] ).to eq( ['src/drivers/foo.h', 'drivers/foo.h', '#include "drivers/foo.h"'] )
226
+ end
227
+
228
+ it "keeps the filename where it reaches the same header" do
229
+ spelled = UserInclude.new( 'src/foo.h' ).spelled_by( search( ['src'], ['src/foo.h'] ) )
230
+
231
+ expect( [spelled.filepath, spelled.to_s] ).to eq( ['src/foo.h', '#include "foo.h"'] )
232
+ end
233
+
234
+ it "keeps an #include's anchoring" do
235
+ spelled = UserInclude.new( 'src/foo.h', directory_relative: true ).spelled_by( search( ['src'], ['src/foo.h'] ) )
236
+
237
+ expect( spelled.directory_relative? ).to be( true )
238
+ end
239
+
240
+ # A preprocessor's #include holds the path the compiler found its header by
241
+ it "names a resolved #include's own header, never one a later search path joins its path to" do
242
+ headers = search( ['include', 'third_party/mylib'], ['include/config.h', 'third_party/mylib/include/config.h'] )
243
+ spelled = UserInclude.new( 'include/config.h' ).spelled_by( headers, resolved: true )
244
+
245
+ expect( [spelled.filepath, spelled.to_s] ).to eq( ['include/config.h', '#include "config.h"'] )
246
+ end
247
+
248
+ # A list that was never resolved, or a path in another letter case, names no header itself
249
+ it "takes the search paths' header for a resolved #include with no header at its path" do
250
+ spelled = UserInclude.new( 'drivers/foo.h' ).spelled_by( search( ['src'], ['src/drivers/foo.h'] ), resolved: true )
251
+
252
+ expect( [spelled.filepath, spelled.to_s] ).to eq( ['src/drivers/foo.h', '#include "drivers/foo.h"'] )
253
+ end
254
+
255
+ it "leaves a resolved #include whose header no directory lists as it is" do
256
+ lost = UserInclude.new( 'gone/foo.h' )
257
+
258
+ expect( lost.spelled_by( search( ['src'], ['src/foo.h'] ), resolved: true ) ).to equal( lost )
259
+ end
260
+
261
+ # A header beside its includer, under no search path, is reached by none of its spellings
262
+ it "writes a resolved #include no spelling reaches by its header's absolute path" do
263
+ headers = search( ['src/hw', 'src'], ['src/hw/config.h', 'lib/config.h'] )
264
+ spelled = UserInclude.new( 'lib/config.h' ).spelled_by( headers, resolved: true )
265
+ absolute = "#{ProjectPaths.working_dir}/lib/config.h"
266
+
267
+ expect( [spelled.filepath, spelled.include_path, spelled.to_s] ).to eq( ['lib/config.h', absolute, "#include \"#{absolute}\""] )
268
+ end
269
+
270
+ it "keeps an #include's anchoring when it writes the header's absolute path" do
271
+ headers = search( ['src/hw'], ['src/hw/config.h', 'lib/config.h'] )
272
+ spelled = UserInclude.new( 'lib/config.h', directory_relative: true ).spelled_by( headers, resolved: true )
273
+
274
+ expect( [spelled.directory_relative?, spelled.include_path] ).to eq( [true, "#{ProjectPaths.working_dir}/lib/config.h"] )
275
+ end
276
+
277
+ it "writes a resolved #include a spelling reaches by that spelling, never by an absolute path" do
278
+ headers = search( ['src/hw', 'lib'], ['src/hw/config.h', 'lib/util.h'] )
279
+ spelled = UserInclude.new( 'lib/util.h' ).spelled_by( headers, resolved: true )
280
+
281
+ expect( [spelled.filepath, spelled.to_s] ).to eq( ['lib/util.h', '#include "util.h"'] )
282
+ end
283
+
284
+ it "writes an #include as written by its header's absolute path where the header is beside its includer and no search path finds one of that name" do
285
+ headers = search( ['src/hw'], ['src/hw/other.h', 'lib/config.h'] )
286
+ spelled = UserInclude.new( 'config.h' ).spelled_by( headers, from: 'lib' )
287
+ absolute = "#{ProjectPaths.working_dir}/lib/config.h"
288
+
289
+ expect( [spelled.filepath, spelled.include_path] ).to eq( ['lib/config.h', absolute] )
290
+ end
291
+
292
+ # A generated directory is on the compiler's search paths, though a test's header search
293
+ # leaves it out, so the compiler reaches a header there by the text it already has
294
+ it "keeps the text of a resolved #include whose header lies in the build root and no search path reaches" do
295
+ headers = search( ['src'], ['src/foo.h', 'build/test/partials/test_foo/ceedling_partial_foo_impl.h'], build_root: 'build' )
296
+ include = UserInclude.new( 'build/test/partials/test_foo/ceedling_partial_foo_impl.h' )
297
+
298
+ expect( include.spelled_by( headers, resolved: true ) ).to equal( include )
299
+ end
300
+
301
+ it "writes a resolved #include whose header lies outside the build root and no search path reaches by its absolute path" do
302
+ headers = search( ['src'], ['src/foo.h', 'builds/foo/config.h'], build_root: 'build' )
303
+ spelled = UserInclude.new( 'builds/foo/config.h' ).spelled_by( headers, resolved: true )
304
+
305
+ expect( spelled.include_path ).to eq( "#{ProjectPaths.working_dir}/builds/foo/config.h" )
306
+ end
307
+
308
+ it "spells a header in the build root by a spelling that reaches it" do
309
+ headers = search( ['build/test/mocks', 'src'], ['build/test/mocks/mock_foo.h'], build_root: 'build' )
310
+ spelled = UserInclude.new( 'build/test/mocks/mock_foo.h' ).spelled_by( headers, resolved: true )
311
+
312
+ expect( spelled.to_s ).to eq( '#include "mock_foo.h"' )
313
+ end
314
+
315
+ # Reconciliation spells two same-named headers apart, which a shorter text could undo
316
+ it "keeps the text an #include has where that text reaches its header" do
317
+ headers = search( ['src', 'src/app', 'src/hw'], ['src/app/config.h', 'src/hw/config.h'] )
318
+ spelled = UserInclude.new( 'src/app/config.h', include_path: 'app/config.h' ).spelled_by( headers, resolved: true )
319
+
320
+ expect( [spelled.filepath, spelled.to_s] ).to eq( ['src/app/config.h', '#include "app/config.h"'] )
321
+ end
322
+
323
+ # A text scan's #include holds the text as written, which the compiler looks for beside the
324
+ # file holding it before any search path
325
+ it "names the header beside its includer first for an #include as written" do
326
+ headers = search( ['src', 'src/drivers/uart'], ['src/config.h', 'src/drivers/uart/config.h'] )
327
+ spelled = UserInclude.new( 'config.h' ).spelled_by( headers, from: 'src/drivers/uart' )
328
+
329
+ expect( [spelled.filepath, spelled.to_s] ).to eq( ['src/drivers/uart/config.h', '#include "drivers/uart/config.h"'] )
330
+ end
331
+
332
+ it "takes the search paths' header for an #include as written with no header beside its includer" do
333
+ headers = search( ['src', 'src/drivers/uart'], ['src/config.h', 'src/drivers/uart/config.h'] )
334
+ spelled = UserInclude.new( 'config.h' ).spelled_by( headers, from: 'src/drivers' )
335
+
336
+ expect( [spelled.filepath, spelled.to_s] ).to eq( ['src/config.h', '#include "config.h"'] )
337
+ end
338
+
339
+ # The compiler finds a header beside the includer by the quote rule, which a generated file's
340
+ # own directory doesn't share, so a search path's header of the same name is another header
341
+ it "writes an #include as written by the absolute path of the header beside its includer where no search path reaches it" do
342
+ headers = search( ['src'], ['src/drivers/foo.h', 'test/drivers/foo.h'] )
343
+ spelled = UserInclude.new( 'drivers/foo.h' ).spelled_by( headers, from: 'test' )
344
+ absolute = "#{ProjectPaths.working_dir}/test/drivers/foo.h"
345
+
346
+ expect( [spelled.filepath, spelled.include_path, spelled.to_s] ).to eq( ['test/drivers/foo.h', absolute, "#include \"#{absolute}\""] )
347
+ end
348
+
349
+ it "keeps an anchored #include's anchoring when it writes the absolute path of the header beside its includer" do
350
+ headers = search( ['src'], ['src/drivers/foo.h', 'test/drivers/foo.h'] )
351
+ spelled = UserInclude.new( 'test/drivers/foo.h', directory_relative: true ).spelled_by( headers, from: 'test' )
352
+
353
+ expect( [spelled.directory_relative?, spelled.include_path] ).to eq( [true, "#{ProjectPaths.working_dir}/test/drivers/foo.h"] )
354
+ end
355
+
356
+ it "spells an #include as written by the search paths' header when none is beside its includer" do
357
+ headers = search( ['src'], ['src/drivers/foo.h'] )
358
+ spelled = UserInclude.new( 'drivers/foo.h' ).spelled_by( headers, from: 'test' )
359
+
360
+ expect( [spelled.filepath, spelled.to_s] ).to eq( ['src/drivers/foo.h', '#include "drivers/foo.h"'] )
361
+ end
362
+
363
+ it "spells an #include as written by the spelling that reaches the header beside its includer" do
364
+ headers = search( ['test', 'src'], ['src/drivers/foo.h', 'test/drivers/foo.h'] )
365
+ spelled = UserInclude.new( 'drivers/foo.h' ).spelled_by( headers, from: 'test' )
366
+
367
+ expect( [spelled.filepath, spelled.to_s] ).to eq( ['test/drivers/foo.h', '#include "drivers/foo.h"'] )
368
+ end
369
+
370
+ it "takes an anchored #include's own header, never one beside its includer" do
371
+ headers = search( ['src'], ['src/common/helper.h', 'src/x/common/helper.h'] )
372
+ spelled = UserInclude.new( 'src/common/helper.h', directory_relative: true ).spelled_by( headers, from: 'src/x' )
373
+
374
+ expect( spelled.filepath ).to eq( 'src/common/helper.h' )
375
+ end
376
+
377
+ it "leaves a system #include, a mock's, and one whose header it can't find as they are" do
378
+ headers = search( ['src'], ['src/foo.h'] )
379
+ system = SystemInclude.new( 'stdint.h' )
380
+ mock = MockInclude.new( 'mock_foo.h' )
381
+ lost = UserInclude.new( 'gone.h' )
382
+
383
+ expect( [system, mock, lost].map { |include| include.spelled_by( headers ) } ).to eq( [system, mock, lost] )
384
+ expect( lost.spelled_by( headers ) ).to equal( lost )
385
+ end
386
+ end
387
+
388
+ describe "#flat" do
389
+ it "lists every header directly in a search path, in search order" do
390
+ headers = search( ['src', 'inc'], ['inc/a.h', 'src/b.h', 'src/sub/c.h'] )
391
+
392
+ expect(headers.flat).to eq( ['src/b.h', 'inc/a.h'] )
393
+ end
394
+ end
395
+
396
+ it "lists each directory once however many lookups ask" do
397
+ headers = search( ['src'], ['src/drivers/foo.h', 'src/top.h'] )
398
+
399
+ 3.times do
400
+ headers.header_candidates( 'drivers/foo.h' )
401
+ headers.header_candidates( 'top.h' )
402
+ end
403
+
404
+ expect(@listed).to eq( { 'src/drivers' => 1, 'src' => 1 } )
405
+ end
406
+ end