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
@@ -8,7 +8,9 @@
8
8
  require 'spec_helper'
9
9
  require 'ceedling/constants'
10
10
  require 'ceedling/includes/includes'
11
+ require 'ceedling/includes/header_search'
11
12
  require 'ceedling/test_invoker/mock_locator'
13
+ require 'ceedling/test_invoker/test_invoker_types'
12
14
 
13
15
  describe MockLocator do
14
16
  before(:each) do
@@ -16,21 +18,33 @@ describe MockLocator do
16
18
  @include_pathinator = double( "IncludePathinator" )
17
19
  @file_finder = double( "FileFinder" )
18
20
  @file_path_utils = double( "FilePathUtils" )
21
+ @test_search_paths = double( "TestSearchPaths" )
19
22
 
20
23
  allow(@file_path_utils).to receive(:form_mock_output_path) do |root, subdir|
21
24
  subdir.nil? || subdir.empty? ? root : File.join( root, subdir )
22
25
  end
23
26
 
24
27
  @locator = described_class.new(
25
- configurator: @configurator, include_pathinator: @include_pathinator, file_finder: @file_finder, file_path_utils: @file_path_utils
28
+ configurator: @configurator, include_pathinator: @include_pathinator, test_search_paths: @test_search_paths,
29
+ file_finder: @file_finder, file_path_utils: @file_path_utils
26
30
  )
27
31
  end
28
32
 
29
- describe "#header_collection" do
30
- it "orders the headers on a test's search paths without its own mock directories" do
31
- expect(@include_pathinator).to receive(:ordered_header_files).with( ['src'] ).and_return( ['src/foo.h'] )
33
+ describe "#header_search" do
34
+ it "searches a test's header paths, which leave out its generated directories" do
35
+ testable = TestInvokerTypes::Testable.new( filepath: 'test/TestFoo.c', search_paths: ['mocks', 'mocks/drivers', 'src'] )
36
+ allow(@test_search_paths).to receive(:header_paths).with( testable ).and_return( ['src'] )
37
+ expect(@include_pathinator).to receive(:header_search).with( ['src'], refusals: {} ).and_return( :search )
32
38
 
33
- expect(@locator.header_collection( ['mocks/drivers', 'src'], ['mocks/drivers'] )).to eq( ['src/foo.h'] )
39
+ expect(@locator.header_search( testable )).to eq( :search )
40
+ end
41
+
42
+ it "explains a failed lookup by the test's search path refusals" do
43
+ testable = TestInvokerTypes::Testable.new( filepath: 'test/TestFoo.c', search_path_refusals: { 'socket.h' => 'why' } )
44
+ allow(@test_search_paths).to receive(:header_paths).with( testable ).and_return( ['src'] )
45
+ expect(@include_pathinator).to receive(:header_search).with( ['src'], refusals: { 'socket.h' => 'why' } ).and_return( :search )
46
+
47
+ expect(@locator.header_search( testable )).to eq( :search )
34
48
  end
35
49
  end
36
50
 
@@ -86,6 +100,58 @@ describe MockLocator do
86
100
  expect(@locator.directories( [MockInclude.new( 'MockGone.h' )], mocks_root: 'mocks', collection: [], complain: :ignore )).to eq( [] )
87
101
  end
88
102
  end
103
+ # A test can name one header's mock two ways, as `MockTask.h` and `drivers/MockTask.h` both
104
+ # do for src/drivers/task.h. CMock and the runner would make two mocks of it, which can't
105
+ # both link.
106
+ describe "#one_per_header" do
107
+ def resolving(map)
108
+ allow(@file_finder).to receive(:resolve_mock) { |query, **| map.fetch( query, [nil, nil] ) }
109
+ end
110
+
111
+ def kept(includes, from: nil)
112
+ return @locator.one_per_header( includes, collection: [], from: from ).map(&:filepath)
113
+ end
114
+
115
+ it "keeps the mocks of two headers that share a name" do
116
+ resolving( 'MockTask.h' => ['rtos/include/task.h', 'include'], 'other/MockTask.h' => ['rtos/other/task.h', 'other'] )
117
+
118
+ expect(kept( [MockInclude.new('MockTask.h'), MockInclude.new('other/MockTask.h')] )).to eq( ['MockTask.h', 'other/MockTask.h'] )
119
+ end
120
+
121
+ # A pathless #include reaches the mock the one with more path names, but not the reverse
122
+ it "keeps the #include with the most path of two that mock one header" do
123
+ resolving( 'MockTask.h' => ['src/drivers/task.h', 'drivers'], 'drivers/MockTask.h' => ['src/drivers/task.h', 'drivers'] )
124
+
125
+ expect(kept( [UserInclude.new('unity.h'), MockInclude.new('MockTask.h'), MockInclude.new('drivers/MockTask.h')] ))
126
+ .to eq( ['unity.h', 'drivers/MockTask.h'] )
127
+ end
128
+
129
+ it "keeps the first of two #includes with as much path that mock one header" do
130
+ resolving( 'drivers/MockTask.h' => ['src/drivers/task.h', 'drivers'], './drivers/MockTask.h' => ['src/drivers/task.h', 'drivers'] )
131
+
132
+ expect(kept( [Include.new('drivers/MockTask.h'), Include.new('./drivers/MockTask.h')] )).to eq( ['drivers/MockTask.h'] )
133
+ end
134
+
135
+ it "keeps every mock whose header isn't found" do
136
+ resolving( {} )
137
+
138
+ expect(kept( [MockInclude.new('MockGone.h'), MockInclude.new('lost/MockGone.h')] )).to eq( ['MockGone.h', 'lost/MockGone.h'] )
139
+ end
140
+
141
+ it "looks a climbing #include up anchored to `from`, and keeps it as written" do
142
+ resolving( 'x/MockFoo.h' => ['inc/x/foo.h', 'x'] )
143
+
144
+ expect(kept( [Include.new('../x/MockFoo.h'), Include.new('x/MockFoo.h')], from: 'test' )).to eq( ['../x/MockFoo.h'] )
145
+ end
146
+
147
+ it "leaves Partial mocks and other headers alone" do
148
+ expect(@file_finder).to_not receive(:resolve_mock)
149
+
150
+ includes = [MockInclude.new("Mock#{PARTIAL_FILENAME_PREFIX}foo_interface.h"), UserInclude.new('task.h'), SystemInclude.new('MockSys.h')]
151
+ expect(kept( includes )).to eq( includes.map(&:filepath) )
152
+ end
153
+ end
154
+
89
155
  # CMock writes a mock below its root at the folder the #include names, and names the mock
90
156
  # by that folder. The compiler reaches the mock through the #include as written, from
91
157
  # the directory that folder leads down or climbs from (`reach`).
@@ -146,4 +212,132 @@ describe MockLocator do
146
212
  end
147
213
  end
148
214
  end
215
+
216
+ # CMock includes a mock's real header by the folder it is given and the header's filename.
217
+ # A search path listing the header's own directory joins no such folder.
218
+ describe "#header_include and #header_respelling" do
219
+ before(:each) do
220
+ allow(@configurator).to receive(:get_cmock_config).and_return( {} )
221
+ end
222
+
223
+ def search_over(paths, headers)
224
+ return HeaderSearch.new( paths, ->(dir) { headers.select { |header| File.expand_path( File.dirname( header ) ) == File.expand_path( dir ) } } )
225
+ end
226
+
227
+ it "keeps CMock's text where a search path joins the folder to the header" do
228
+ search = search_over( ['src'], ['src/drivers/foo.h'] )
229
+
230
+ expect(@locator.header_include( MockInclude.new( 'drivers/MockFoo.h' ), 'src/drivers/foo.h', search )).to eq( 'drivers/foo.h' )
231
+ expect(@locator.header_respelling( MockInclude.new( 'drivers/MockFoo.h' ), 'src/drivers/foo.h', search )).to be_nil
232
+ end
233
+
234
+ it "takes the text the search paths reach the header by where none joins CMock's" do
235
+ search = search_over( ['src/drivers'], ['src/drivers/foo.h'] )
236
+
237
+ expect(@locator.header_include( MockInclude.new( 'drivers/MockFoo.h' ), 'src/drivers/foo.h', search )).to eq( 'foo.h' )
238
+ expect(@locator.header_respelling( MockInclude.new( 'drivers/MockFoo.h' ), 'src/drivers/foo.h', search )).to eq( 'foo.h' )
239
+ end
240
+
241
+ # The compiler includes the same-named header CMock's text reaches, whichever header the
242
+ # mock was located by
243
+ it "keeps CMock's text where it reaches another same-named header" do
244
+ search = search_over( ['lib', 'src/hw/drivers'], ['lib/drivers/foo.h', 'src/hw/drivers/foo.h'] )
245
+
246
+ expect(@locator.header_respelling( MockInclude.new( 'drivers/MockFoo.h' ), 'src/hw/drivers/foo.h', search )).to be_nil
247
+ expect(@locator.header_include( MockInclude.new( 'drivers/MockFoo.h' ), 'src/hw/drivers/foo.h', search )).to eq( 'drivers/foo.h' )
248
+ end
249
+
250
+ # A respelling is judged as the whole operand of the #include. CMock and a stand-in write
251
+ # the format around their text. An FFF fake writes no format.
252
+ it "keeps CMock's text where :orig_header_include_fmt writes more around it than quotes, respelling it for a fake" do
253
+ allow(@configurator).to receive(:get_cmock_config).and_return( { orig_header_include_fmt: '#include "../%s"' } )
254
+ search = search_over( ['src/drivers'], ['src/drivers/foo.h'] )
255
+
256
+ expect(@locator.header_include( MockInclude.new( 'drivers/MockFoo.h' ), 'src/drivers/foo.h', search )).to eq( 'drivers/foo.h' )
257
+ expect(@locator.header_respelling( MockInclude.new( 'drivers/MockFoo.h' ), 'src/drivers/foo.h', search )).to eq( 'foo.h' )
258
+ end
259
+
260
+ it "respells within a bracketed :orig_header_include_fmt" do
261
+ allow(@configurator).to receive(:get_cmock_config).and_return( { orig_header_include_fmt: '#include <%s>' } )
262
+ search = search_over( ['src/drivers'], ['src/drivers/foo.h'] )
263
+
264
+ expect(@locator.header_respelling( MockInclude.new( 'drivers/MockFoo.h' ), 'src/drivers/foo.h', search )).to eq( 'foo.h' )
265
+ end
266
+
267
+ it "keeps CMock's text where nothing reaches the header" do
268
+ search = search_over( ['inc'], ['src/drivers/foo.h'] )
269
+
270
+ expect(@locator.header_include( MockInclude.new( 'drivers/MockFoo.h' ), 'src/drivers/foo.h', search )).to eq( 'drivers/foo.h' )
271
+ expect(@locator.header_respelling( MockInclude.new( 'drivers/MockFoo.h' ), 'src/drivers/foo.h', search )).to be_nil
272
+ end
273
+
274
+ it "includes the header by its filename for a bare #include" do
275
+ search = search_over( ['src/drivers'], ['src/drivers/foo.h'] )
276
+
277
+ expect(@locator.header_include( MockInclude.new( 'MockFoo.h' ), 'src/drivers/foo.h', search )).to eq( 'foo.h' )
278
+ expect(@locator.header_respelling( MockInclude.new( 'MockFoo.h' ), 'src/drivers/foo.h', search )).to be_nil
279
+ end
280
+
281
+ it "drops a leading ./ from the folder, as CMock is given it" do
282
+ search = search_over( ['src'], ['src/drivers/foo.h'] )
283
+
284
+ expect(@locator.header_include( MockInclude.new( './drivers/MockFoo.h' ), 'src/drivers/foo.h', search )).to eq( 'drivers/foo.h' )
285
+ end
286
+
287
+ it "includes by the filename CMock writes, and respells nothing, when :mock_name_include_folder is disabled" do
288
+ allow(@configurator).to receive(:cmock_mock_name_include_folder).and_return( false )
289
+ search = search_over( ['src/drivers'], ['src/drivers/foo.h'] )
290
+
291
+ expect(@locator.header_include( MockInclude.new( 'drivers/MockFoo.h' ), 'src/drivers/foo.h', search )).to eq( 'foo.h' )
292
+ expect(@locator.header_respelling( MockInclude.new( 'drivers/MockFoo.h' ), 'src/drivers/foo.h', search )).to be_nil
293
+ end
294
+
295
+ # A Partial mock's header is Ceedling's own, generated where no search path for real headers looks
296
+ it "respells nothing for a Partial mock" do
297
+ header = 'build/test/partials/t/ceedling_partial_foo_interface.h'
298
+ search = search_over( ['.'], [header] )
299
+
300
+ expect(@locator.header_respelling( MockInclude.new( "Mock#{PARTIAL_FILENAME_PREFIX}foo_interface.h" ), header, search )).to be_nil
301
+ end
302
+
303
+ # The compiler joins a climbing folder as written, which a search can't judge
304
+ it "keeps CMock's text for a folder that climbs" do
305
+ search = search_over( ['inc/x'], ['inc/x/foo.h'] )
306
+
307
+ expect(@locator.header_respelling( MockInclude.new( '../x/MockFoo.h' ), 'inc/x/foo.h', search )).to be_nil
308
+ expect(@locator.header_include( MockInclude.new( '../x/MockFoo.h' ), 'inc/x/foo.h', search )).to eq( '../x/foo.h' )
309
+ end
310
+ end
311
+
312
+ describe "#respellable_format?" do
313
+ it "takes a respelling into a format whose text is the whole operand" do
314
+ [nil, '#include "%s"', '#include <%s>', ' # include "%s" '].each do |format|
315
+ allow(@configurator).to receive(:get_cmock_config).and_return( { orig_header_include_fmt: format }.compact )
316
+
317
+ expect(@locator.respellable_format?).to be( true ), format.inspect
318
+ end
319
+ end
320
+
321
+ it "takes no respelling into a format that writes more around the text" do
322
+ ['#include "../%s"', '#include "inc/%s"', '#include "%s" /* mock */'].each do |format|
323
+ allow(@configurator).to receive(:get_cmock_config).and_return( { orig_header_include_fmt: format } )
324
+
325
+ expect(@locator.respellable_format?).to be( false ), format
326
+ end
327
+ end
328
+ end
329
+
330
+ describe "#header_include_line" do
331
+ it "puts the text in CMock's default #include" do
332
+ allow(@configurator).to receive(:get_cmock_config).and_return( {} )
333
+
334
+ expect(@locator.header_include_line( 'drivers/foo.h' )).to eq( '#include "drivers/foo.h"' )
335
+ end
336
+
337
+ it "puts the text in the project's CMock :orig_header_include_fmt" do
338
+ allow(@configurator).to receive(:get_cmock_config).and_return( { orig_header_include_fmt: '#include <%s>' } )
339
+
340
+ expect(@locator.header_include_line( 'foo.h' )).to eq( '#include <foo.h>' )
341
+ end
342
+ end
149
343
  end
@@ -0,0 +1,42 @@
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/includes'
10
+ require 'ceedling/partials/include_groups'
11
+
12
+ describe Partials::IncludeGroups do
13
+ let(:boundary) { UserInclude.new( 'boundary' ) }
14
+ let(:config) { UserInclude.new( 'config.h' ) }
15
+ let(:log) { UserInclude.new( 'log.h' ) }
16
+
17
+ context ".split" do
18
+ it "puts what precedes the boundary first and what follows it after" do
19
+ groups = described_class.split( [config, boundary, log], boundary )
20
+
21
+ expect( [groups.leading, groups.following] ).to eq( [[config], [log]] )
22
+ end
23
+
24
+ # An equal include is not the boundary, so only the very object splits the list
25
+ it "matches the boundary by identity" do
26
+ groups = described_class.split( [UserInclude.new( 'boundary' ), boundary, log], boundary )
27
+
28
+ expect( groups.leading.size ).to eq( 1 )
29
+ expect( groups.following ).to eq( [log] )
30
+ end
31
+ end
32
+
33
+ it "lists every include in order" do
34
+ expect( described_class.new( leading: [config], following: [log] ).to_a ).to eq( [config, log] )
35
+ end
36
+
37
+ it "records each group as include directives" do
38
+ expect( described_class.new( leading: [config], following: [log] ).to_record ).to eq(
39
+ { leading: ['#include "config.h"'], following: ['#include "log.h"'] }
40
+ )
41
+ end
42
+ end
@@ -658,4 +658,29 @@ describe PartializerConfig do
658
658
 
659
659
  end
660
660
 
661
+ context "Config#fallback?" do
662
+ def file(assembled:, fallback:)
663
+ Partials::ConfigFileInfo.new( filepath: "src/a.c", assembled_filepath: (assembled ? "build/a.c" : nil), fallback: fallback )
664
+ end
665
+
666
+ it "is true when either file the module is extracted from fell back" do
667
+ config = PartializerConfig::Config.new( module: "a", header: file( assembled: true, fallback: false ), source: file( assembled: true, fallback: true ) )
668
+
669
+ expect( config.fallback? ).to be( true )
670
+ end
671
+
672
+ it "is false when every file was preprocessed accurately" do
673
+ config = PartializerConfig::Config.new( module: "a", header: file( assembled: true, fallback: false ), source: file( assembled: true, fallback: false ) )
674
+
675
+ expect( config.fallback? ).to be( false )
676
+ end
677
+
678
+ # A file preprocessing never assembled, such as a mock-only Partial's absent source, isn't extracted
679
+ it "ignores a file preprocessing never assembled" do
680
+ config = PartializerConfig::Config.new( module: "a", header: file( assembled: true, fallback: false ), source: file( assembled: false, fallback: true ) )
681
+
682
+ expect( config.fallback? ).to be( false )
683
+ end
684
+ end
685
+
661
686
  end