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
@@ -9,6 +9,7 @@ require 'spec_helper'
9
9
  require 'tmpdir'
10
10
  require 'fileutils'
11
11
  require 'ceedling/filesystem/build_subpath'
12
+ require 'ceedling/filesystem/build_roots'
12
13
 
13
14
  # GH #1370 and the path handling audit around it: a build file placed by text could land
14
15
  # outside the build directory
@@ -55,6 +56,40 @@ describe BuildSubpath do
55
56
  expect(BuildSubpath.decode( BuildSubpath.encode( '_UP_/x' ) )).to eq( '_UP_/x' )
56
57
  end
57
58
 
59
+ # A test's own build directories close its name with `_t_` (TestBuildLayout)
60
+ it 'places a directory named like the segment closing a test name apart from it, and reads it back' do
61
+ ['src/_t_', '_t_/x', 'src/__t_/x', 'src/_T_/x'].each do |path|
62
+ encoded = BuildSubpath.encode( path )
63
+
64
+ expect(ProjectPaths.segments( encoded ).map( &:downcase )).to_not include( BuildSubpath::OWN_SEGMENT ), "#{path} => #{encoded}"
65
+ expect(BuildSubpath.decode( encoded )).to eq( path ), "#{path} => #{encoded}"
66
+ end
67
+ expect(BuildSubpath.encode( 'src/_t_' )).to eq( 'src/__t_' )
68
+ end
69
+
70
+ it 'names a test whose path holds a directory named like `_t_` without that segment, and reads it back' do
71
+ name = BuildSubpath.encode( 'test/_t_/test_c' )
72
+
73
+ expect(name).to eq( 'test/__t_/test_c' )
74
+ expect(BuildSubpath.decode( name )).to eq( 'test/_t_/test_c' )
75
+ end
76
+
77
+ # A release build has no per-test directories, so it places such a directory as it always has
78
+ it 'keeps a directory named like `_t_` as it is in a release build, and reads it back' do
79
+ ['src/_t_', '_t_/x', 'src/__t_/x', 'src/_T_/x'].each do |path|
80
+ encoded = BuildSubpath.encode( path, release: true )
81
+
82
+ expect(encoded).to eq( path )
83
+ expect(BuildSubpath.decode( encoded, release: true )).to eq( path ), "#{path} => #{encoded}"
84
+ end
85
+ end
86
+
87
+ it 'still places a directory named like another marker apart from it in a release build' do
88
+ expect(BuildSubpath.encode( 'src/_up_/_t_', release: true )).to eq( 'src/__up_/_t_' )
89
+ expect(BuildSubpath.decode( 'src/__up_/_t_', release: true )).to eq( 'src/_up_/_t_' )
90
+ expect(BuildSubpath.encode( '../_t_/x', release: true )).to eq( '_up_/_t_/x' )
91
+ end
92
+
58
93
  # Windows has no relative path from one drive to another
59
94
  it 'places a file of the running Ceedling on another drive below `_ceedling_` too' do
60
95
  file = File.join( BuildSubpath::INSTALLATION_ROOT, 'plugins/fff/src' )
@@ -113,10 +148,88 @@ describe BuildSubpath do
113
148
  end
114
149
  end
115
150
 
151
+ # GH #1387: a long configured root's location gives way to its marker, and everything below
152
+ # the root keeps its path
153
+ describe 'with shortened roots' do
154
+ let(:external_root) { '../vendor/acme/sdk/v3/include' }
155
+ let(:deep_root) { 'lib/vendor/acme/hal' }
156
+ let(:table) { BuildRoots.table( [external_root, deep_root, 'src'] ) }
157
+ let(:external) { table.marker_for( external_root ) }
158
+ let(:deep) { table.marker_for( deep_root ) }
159
+
160
+ it 'places a root\'s own directory at its marker alone, and reads it back' do
161
+ expect(BuildSubpath.encode( external_root, roots: table )).to eq( external )
162
+ expect(BuildSubpath.decode( external, roots: table )).to eq( external_root )
163
+ end
164
+
165
+ it 'keeps the path below a root, after its marker, and reads it back' do
166
+ expect(BuildSubpath.encode( "#{external_root}/os/v2", roots: table )).to eq( "#{external}/os/v2" )
167
+ expect(BuildSubpath.decode( "#{external}/os/v2", roots: table )).to eq( "#{external_root}/os/v2" )
168
+ expect(BuildSubpath.encode( "#{deep_root}/src", roots: table )).to eq( "#{deep}/src" )
169
+ expect(BuildSubpath.decode( "#{deep}/src", roots: table )).to eq( "#{deep_root}/src" )
170
+ end
171
+
172
+ it 'keeps a directory named like `_t_` below a root as it is only in a release build' do
173
+ expect(BuildSubpath.encode( "#{external_root}/_t_/os", roots: table )).to eq( "#{external}/__t_/os" )
174
+ expect(BuildSubpath.encode( "#{external_root}/_t_/os", roots: table, release: true )).to eq( "#{external}/_t_/os" )
175
+ expect(BuildSubpath.decode( "#{external}/_t_/os", roots: table, release: true )).to eq( "#{external_root}/_t_/os" )
176
+ end
177
+
178
+ it 'places a file below a root that is not shortened as it always has' do
179
+ expect(BuildSubpath.encode( 'src/drv', roots: table )).to eq( 'src/drv' )
180
+ expect(BuildSubpath.encode( '../shared/src', roots: table )).to eq( '_up_/shared/src' )
181
+ end
182
+
183
+ it 'still places a file of the running Ceedling below `_ceedling_`' do
184
+ plugins = File.join( BuildSubpath::INSTALLATION_ROOT, 'plugins' )
185
+ file = File.join( plugins, 'fff/src' )
186
+
187
+ expect(BuildSubpath.encode( file, roots: BuildRoots.table( [plugins] ) )).to eq( '_ceedling_/plugins/fff/src' )
188
+ end
189
+
190
+ # A project's own directory may look like a marker, and must never read back as one
191
+ it 'places a directory shaped like a marker apart from any marker, and reads it back' do
192
+ ['_x_ABCDEF12/y', 'src/_v_20240101', '__x_abcdef12/z', "#{external_root}/_v_20240101/x"].each do |path|
193
+ encoded = BuildSubpath.encode( path, roots: table )
194
+
195
+ expect(encoded.split( '/' ).first).to_not match( BuildRoots::MARKER ), "#{path} => #{encoded}" unless path.start_with?( external_root )
196
+ expect(BuildSubpath.decode( encoded, roots: table )).to eq( path ), "#{path} => #{encoded}"
197
+ expect(BuildSubpath.decode( BuildSubpath.encode( path ) )).to eq( path ), path
198
+ end
199
+ end
200
+
201
+ it 'reads nothing back from a marker its table does not hold' do
202
+ expect(BuildSubpath.decode( '_include_ABCDEF12/os', roots: table )).to be_nil
203
+ expect(BuildSubpath.decode( '_include_ABCDEF12/os' )).to be_nil
204
+ end
205
+
206
+ it 'never places a file outside the build subpath it names' do
207
+ encoded = BuildSubpath.encode( "#{external_root}/os", roots: table )
208
+
209
+ expect(encoded.split( '/' )).to_not include( '..' )
210
+ expect(encoded).to_not start_with( '/' )
211
+ end
212
+ end
213
+
116
214
  describe '.of_directory' do
117
215
  it 'is the encoding of a directory, with the working directory as empty' do
118
216
  expect(BuildSubpath.of_directory( 'src/drv' )).to eq( 'src/drv' )
119
217
  expect(BuildSubpath.of_directory( '.' )).to eq( '' )
120
218
  end
219
+
220
+ it 'remembers each table\'s encoding apart' do
221
+ root = '../vendor/acme/sdk/v3/include'
222
+ table = BuildRoots.table( [root] )
223
+
224
+ expect(BuildSubpath.of_directory( root, roots: table )).to eq( table.marker_for( root ) )
225
+ expect(BuildSubpath.of_directory( root )).to eq( '_up_/vendor/acme/sdk/v3/include' )
226
+ expect(BuildSubpath.of_directory( root, roots: BuildRoots.table( [] ) )).to eq( '_up_/vendor/acme/sdk/v3/include' )
227
+ end
228
+
229
+ it "remembers a release build's encoding apart from a test build's" do
230
+ expect(BuildSubpath.of_directory( 'src/_t_/drv' )).to eq( 'src/__t_/drv' )
231
+ expect(BuildSubpath.of_directory( 'src/_t_/drv', release: true )).to eq( 'src/_t_/drv' )
232
+ expect(BuildSubpath.of_directory( 'src/_t_/drv' )).to eq( 'src/__t_/drv' )
233
+ end
121
234
  end
122
235
  end
@@ -7,6 +7,7 @@
7
7
 
8
8
  require 'spec_helper'
9
9
  require 'ceedling/filesystem/file_finder_helper'
10
+ require 'ceedling/includes/header_search'
10
11
  require 'ceedling/constants'
11
12
  require 'ceedling/loginator'
12
13
 
@@ -170,6 +171,85 @@ describe FileFinderHelper do
170
171
  end
171
172
  end
172
173
  end
174
+ # A HeaderSearch finds a header as the compiler does
175
+ describe '#resolve_file_in_collection with a HeaderSearch' do
176
+ def search(paths, tree, refusals: {})
177
+ return HeaderSearch.new( paths, ->(dir) { tree.select { |header| File.dirname( header ) == dir } }, refusals: refusals )
178
+ end
179
+
180
+ it 'resolves to the first search path joining to the header' do
181
+ headers = search( ['src'], ['src/drivers/foo.h'] )
182
+
183
+ expect(@ff_helper.resolve_file_in_collection('drivers/foo.h', headers, :error)).to eq('src/drivers/foo.h')
184
+ end
185
+
186
+ it 'logs the NOTICE once, naming the header the compiler finds later' do
187
+ headers = search( ['a', 'b'], ['a/drivers/foo.h', 'b/drivers/foo.h'] )
188
+ expect(@loginator).to receive(:log).once.with(
189
+ "Multiple files matched 'drivers/foo.h' but chose 'a/drivers/foo.h' by search-path priority. " \
190
+ "Other candidates: b/drivers/foo.h. Add more path to 'drivers/foo.h' at its point of reference to select a different file.",
191
+ Verbosity::COMPLAIN, LogLabels::NOTICE
192
+ )
193
+
194
+ 2.times { @ff_helper.resolve_file_in_collection('drivers/foo.h', headers, :error) }
195
+ end
196
+
197
+ it 'raises the same message for a header no search path reaches' do
198
+ headers = search( ['src'], ['src/foo.h'] )
199
+
200
+ expect { @ff_helper.resolve_file_in_collection('drivers/foo.h', headers, :error) }
201
+ .to raise_error(CeedlingException, 'Found no file `drivers/foo.h` in search paths.')
202
+ end
203
+
204
+ it 'names a header in another letter case among those the search looked at' do
205
+ headers = search( ['src'], ['src/drivers/Foo.h'] )
206
+
207
+ expect { @ff_helper.resolve_file_in_collection('drivers/foo.h', headers, :error) }
208
+ .to raise_error(CeedlingException, /different capitalization was found: 'src\/drivers\/Foo.h'/)
209
+ end
210
+
211
+ it 'gives nil without a word when told to be silent' do
212
+ expect(@loginator).to_not receive(:log)
213
+
214
+ expect(@ff_helper.resolve_file_in_collection('drivers/foo.h', search( ['src'], [] ), :silent)).to be_nil
215
+ end
216
+
217
+ # The search looks at the header the query names as a path, which no search path reaches
218
+ it 'gives no letter case hint for a header spelled in the very same case' do
219
+ headers = search( ['src'], ['other/foo.h'] )
220
+
221
+ expect { @ff_helper.resolve_file_in_collection('other/foo.h', headers, :error) }
222
+ .to raise_error(CeedlingException, 'Found no file `other/foo.h` in search paths.')
223
+ expect(@ff_helper.resolve_file_in_collection('other/foo.h', headers, :ignore)).to be_nil
224
+ end
225
+
226
+ context 'for a header stage 2 refused a search path' do
227
+ let(:headers) { search( ['inc'], ['inc/Socket.h'], refusals: { 'socket.h' => 'Reference the parent folder.' } ) }
228
+
229
+ it 'raises with the refusal, which explains more than a letter case hint' do
230
+ expect { @ff_helper.resolve_file_in_collection('socket.h', headers, :error) }
231
+ .to raise_error(CeedlingException, 'Found no file `socket.h` in search paths. Reference the parent folder.')
232
+ end
233
+
234
+ it 'warns with the refusal when told to warn' do
235
+ expect(@loginator).to receive(:log).with( 'Found no file `socket.h` in search paths. Reference the parent folder.', Verbosity::COMPLAIN )
236
+
237
+ expect(@ff_helper.resolve_file_in_collection('socket.h', headers, :warn)).to be_nil
238
+ end
239
+
240
+ it 'gives nil without a word when told to be silent' do
241
+ expect(@loginator).to_not receive(:log)
242
+
243
+ expect(@ff_helper.resolve_file_in_collection('socket.h', headers, :silent)).to be_nil
244
+ end
245
+
246
+ it 'raises without it for another header' do
247
+ expect { @ff_helper.resolve_file_in_collection('other.h', headers, :error) }
248
+ .to raise_error(CeedlingException, 'Found no file `other.h` in search paths.')
249
+ end
250
+ end
251
+ end
252
+
173
253
  # A module generator path hint is matched to the configured path it resembles most
174
254
  describe '#find_best_path_in_collection' do
175
255
  PATHS = ['src', 'src/lab', 'src/lab/x', 'test/lab'].freeze