ceedling 1.2.2 → 1.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (390) hide show
  1. checksums.yaml +4 -4
  2. data/GIT_COMMIT_SHA +1 -1
  3. data/README.md +1 -1
  4. data/assets/fixtures/tests_with_partials_coverage/src/private_macro.c +7 -0
  5. data/assets/fixtures/tests_with_partials_coverage/src/private_macro.h +5 -0
  6. data/assets/fixtures/tests_with_partials_coverage/src/tally.c +13 -0
  7. data/assets/fixtures/tests_with_partials_coverage/src/tally.h +4 -0
  8. data/assets/fixtures/tests_with_partials_coverage/test/test_private_macro.c +10 -0
  9. data/assets/fixtures/tests_with_partials_coverage/test/test_tally.c +9 -0
  10. data/docs/BreakingChanges.md +16 -0
  11. data/docs/Changelog.md +71 -0
  12. data/docs/KnownIssues.md +91 -4
  13. data/examples/wondrous_forest/README.md +29 -1
  14. data/examples/wondrous_forest/src/ForestUnits.h +23 -0
  15. data/examples/wondrous_forest/src/RainGauge.c +59 -0
  16. data/examples/wondrous_forest/src/RainGauge.h +39 -0
  17. data/examples/wondrous_forest/src/RainTipIsr.c +17 -0
  18. data/examples/wondrous_forest/src/RainTipIsr.h +14 -0
  19. data/examples/wondrous_forest/test/TestRainGauge.c +126 -0
  20. data/lib/ceedling/c_extractor/README.md +15 -7
  21. data/lib/ceedling/c_extractor/c_extractor.rb +25 -14
  22. data/lib/ceedling/c_extractor/c_extractor_code_text.rb +84 -54
  23. data/lib/ceedling/c_extractor/c_extractor_constants.rb +18 -7
  24. data/lib/ceedling/c_extractor/c_extractor_declarations.rb +319 -283
  25. data/lib/ceedling/c_extractor/c_extractor_declarator.rb +285 -0
  26. data/lib/ceedling/c_extractor/c_extractor_defined_type.rb +111 -0
  27. data/lib/ceedling/c_extractor/c_extractor_definitions.rb +174 -121
  28. data/lib/ceedling/c_extractor/c_extractor_functions.rb +191 -162
  29. data/lib/ceedling/c_extractor/c_extractor_preprocessing.rb +46 -55
  30. data/lib/ceedling/c_extractor/c_extractor_statement.rb +30 -0
  31. data/lib/ceedling/c_extractor/c_extractor_types.rb +63 -41
  32. data/lib/ceedling/c_extractor/c_module_edits.rb +48 -0
  33. data/lib/ceedling/c_identifier.rb +21 -0
  34. data/lib/ceedling/ceedling.h +8 -0
  35. data/lib/ceedling/config/configurator.rb +4 -3
  36. data/lib/ceedling/config/configurator_builder.rb +17 -0
  37. data/lib/ceedling/config/configurator_setup.rb +29 -5
  38. data/lib/ceedling/constants.rb +5 -1
  39. data/lib/ceedling/defaults.rb +31 -1
  40. data/lib/ceedling/dependencies/CACHE_SCHEMA.md +118 -0
  41. data/lib/ceedling/dependencies/README.md +1 -1
  42. data/lib/ceedling/dependencies/dependency_cache_store.rb +30 -25
  43. data/lib/ceedling/dependencies/dependency_tracker.rb +9 -3
  44. data/lib/ceedling/dependencies/dependinator.rb +13 -1
  45. data/lib/ceedling/diagnostics/DOCTOR.md +142 -0
  46. data/lib/ceedling/diagnostics/README.md +5 -0
  47. data/lib/ceedling/diagnostics/build_step_doctor.rb +110 -0
  48. data/lib/ceedling/diagnostics/duplicate_symbol_specialist.rb +108 -0
  49. data/lib/ceedling/diagnostics/guidance_phrases.rb +30 -0
  50. data/lib/ceedling/diagnostics/header_collision_guidance.rb +56 -0
  51. data/lib/ceedling/diagnostics/header_collision_specialist.rb +152 -0
  52. data/lib/ceedling/diagnostics/include_depth_specialist.rb +132 -0
  53. data/lib/ceedling/diagnostics/missing_symbol_specialist.rb +111 -0
  54. data/lib/ceedling/diagnostics/partial_name_specialist.rb +134 -0
  55. data/lib/ceedling/diagnostics/toolchain_output.rb +44 -0
  56. data/lib/ceedling/filesystem/PATH_HANDLING.md +83 -27
  57. data/lib/ceedling/filesystem/README.md +6 -1
  58. data/lib/ceedling/filesystem/build_roots.rb +105 -0
  59. data/lib/ceedling/filesystem/build_subpath.rb +110 -25
  60. data/lib/ceedling/filesystem/file_finder.rb +76 -110
  61. data/lib/ceedling/filesystem/file_finder_helper.rb +33 -11
  62. data/lib/ceedling/filesystem/file_path_utils.rb +113 -91
  63. data/lib/ceedling/filesystem/file_wrapper.rb +105 -28
  64. data/lib/ceedling/filesystem/path_matcher.rb +21 -0
  65. data/lib/ceedling/filesystem/test_build_layout.rb +114 -0
  66. data/lib/ceedling/filesystem/win_long_paths.rb +153 -0
  67. data/lib/ceedling/filesystem/win_path_limit.rb +83 -0
  68. data/lib/ceedling/filesystem/win_path_prober.rb +52 -0
  69. data/lib/ceedling/generators/generator.rb +27 -64
  70. data/lib/ceedling/generators/generator_helper.rb +0 -44
  71. data/lib/ceedling/generators/generator_mocks.rb +5 -0
  72. data/lib/ceedling/generators/generator_partials.rb +305 -243
  73. data/lib/ceedling/generators/generator_test_runner.rb +5 -8
  74. data/lib/ceedling/generators/partial_header_writer.rb +95 -0
  75. data/lib/ceedling/generators/partial_source_writer.rb +137 -0
  76. data/lib/ceedling/includes/header_search.rb +225 -0
  77. data/lib/ceedling/includes/include_factory.rb +9 -12
  78. data/lib/ceedling/includes/include_pathinator.rb +53 -31
  79. data/lib/ceedling/includes/includes.rb +149 -37
  80. data/lib/ceedling/objects.yml +89 -4
  81. data/lib/ceedling/partials/README.md +110 -16
  82. data/lib/ceedling/partials/carry_plan.rb +71 -0
  83. data/lib/ceedling/partials/definition_head.rb +74 -0
  84. data/lib/ceedling/partials/include_groups.rb +37 -0
  85. data/lib/ceedling/partials/interface_extras.rb +25 -0
  86. data/lib/ceedling/partials/partializer.rb +599 -120
  87. data/lib/ceedling/partials/partializer_config.rb +5 -0
  88. data/lib/ceedling/partials/partializer_helper.rb +851 -145
  89. data/lib/ceedling/partials/partializer_reconciler.rb +174 -0
  90. data/lib/ceedling/partials/partializer_utils.rb +89 -109
  91. data/lib/ceedling/partials/partials.rb +153 -10
  92. data/lib/ceedling/partials/type_macros.rb +126 -0
  93. data/lib/ceedling/preprocess/README.md +43 -33
  94. data/lib/ceedling/preprocess/preprocessinator.rb +100 -186
  95. data/lib/ceedling/preprocess/preprocessinator_code_finder.rb +65 -72
  96. data/lib/ceedling/preprocess/preprocessinator_file_assembler.rb +31 -75
  97. data/lib/ceedling/preprocess/preprocessinator_reconstructor.rb +51 -14
  98. data/lib/ceedling/setupinator.rb +16 -3
  99. data/lib/ceedling/test_invoker/HEADER_COLLISIONS.md +21 -7
  100. data/lib/ceedling/test_invoker/PIPELINE.md +57 -16
  101. data/lib/ceedling/test_invoker/README.md +1 -1
  102. data/lib/ceedling/test_invoker/derived_search_path_notices.rb +45 -0
  103. data/lib/ceedling/test_invoker/mock_locator.rb +116 -9
  104. data/lib/ceedling/test_invoker/partial_files_preprocessinator.rb +181 -0
  105. data/lib/ceedling/test_invoker/partials_manager.rb +265 -308
  106. data/lib/ceedling/test_invoker/standin_headerinator.rb +8 -15
  107. data/lib/ceedling/test_invoker/test_bare_includes_extractinator.rb +26 -3
  108. data/lib/ceedling/test_invoker/test_build_executor.rb +338 -198
  109. data/lib/ceedling/test_invoker/test_build_planner.rb +13 -19
  110. data/lib/ceedling/test_invoker/test_build_setup.rb +26 -6
  111. data/lib/ceedling/test_invoker/test_build_validations.rb +23 -20
  112. data/lib/ceedling/test_invoker/test_derived_search_paths.rb +189 -0
  113. data/lib/ceedling/test_invoker/test_file_preprocessinator.rb +1 -2
  114. data/lib/ceedling/test_invoker/test_includes_reconcilinator.rb +1 -1
  115. data/lib/ceedling/test_invoker/test_invoker_types.rb +28 -20
  116. data/lib/ceedling/test_invoker/test_pipeline_helpers.rb +5 -3
  117. data/lib/ceedling/test_invoker/test_pipeline_manager.rb +25 -8
  118. data/lib/ceedling/test_invoker/test_runner_generatinator.rb +31 -3
  119. data/lib/ceedling/test_invoker/test_search_paths.rb +30 -8
  120. data/lib/ceedling/test_invoker/test_substitutions.rb +72 -0
  121. data/lib/ceedling/tools/shell_quoting.rb +45 -0
  122. data/lib/ceedling/tools/tool_quoting.rb +79 -0
  123. data/lib/ceedling/{tool_validator.rb → tools/tool_validator.rb} +18 -7
  124. data/lib/version.rb +1 -1
  125. data/plugins/bullseye/bullseye.rake +1 -3
  126. data/plugins/bullseye/lib/bullseye.rb +15 -2
  127. data/plugins/command_hooks/lib/command_hooks.rb +1 -1
  128. data/plugins/fff/lib/fff.rb +42 -15
  129. data/plugins/fff/lib/fff_mock_generator.rb +12 -9
  130. data/plugins/fff/spec/fff_cmock_wrapper_spec.rb +134 -0
  131. data/plugins/fff/spec/fff_mock_header_generator_spec.rb +9 -0
  132. data/plugins/fff/spec/fff_mock_source_generator_spec.rb +20 -0
  133. data/plugins/gcov/lib/console_reportinator.rb +25 -19
  134. data/plugins/gcov/lib/reportgenerator_reportinator.rb +2 -1
  135. data/site-local/404.html +2 -2
  136. data/site-local/assets/javascripts/{bundle.c21346df.min.js → bundle.a5f9d56c.min.js} +1 -1
  137. data/site-local/assets/javascripts/{bundle.c21346df.min.js.map → bundle.a5f9d56c.min.js.map} +2 -2
  138. data/site-local/configuration/environment-vars.html +2 -2
  139. data/site-local/configuration/global-collections.html +3 -3
  140. data/site-local/configuration/index.html +2 -2
  141. data/site-local/configuration/loading.html +2 -2
  142. data/site-local/configuration/mixins.html +2 -2
  143. data/site-local/configuration/parallel-builds.html +2 -2
  144. data/site-local/configuration/project-file.html +2 -2
  145. data/site-local/configuration/reference/cexception.html +2 -2
  146. data/site-local/configuration/reference/cmock.html +5 -2
  147. data/site-local/configuration/reference/defines.html +2 -2
  148. data/site-local/configuration/reference/environment.html +2 -2
  149. data/site-local/configuration/reference/extension.html +2 -2
  150. data/site-local/configuration/reference/files.html +56 -9
  151. data/site-local/configuration/reference/flags.html +2 -2
  152. data/site-local/configuration/reference/index.html +2 -2
  153. data/site-local/configuration/reference/libraries.html +2 -2
  154. data/site-local/configuration/reference/mixins.html +2 -2
  155. data/site-local/configuration/reference/partials.html +84 -2
  156. data/site-local/configuration/reference/paths.html +7 -2
  157. data/site-local/configuration/reference/plugins.html +2 -2
  158. data/site-local/configuration/reference/project.html +247 -5
  159. data/site-local/configuration/reference/release-build.html +2 -2
  160. data/site-local/configuration/reference/test-build.html +2 -2
  161. data/site-local/configuration/reference/test-runner.html +2 -2
  162. data/site-local/configuration/reference/tools.html +49 -4
  163. data/site-local/configuration/reference/unity.html +2 -2
  164. data/site-local/configuration/which-ceedling.html +2 -2
  165. data/site-local/development/index.html +2 -2
  166. data/site-local/development/plugins/configuration.html +2 -2
  167. data/site-local/development/plugins/index.html +2 -2
  168. data/site-local/development/plugins/plugin-subclass.html +5 -4
  169. data/site-local/development/plugins/rake-tasks.html +2 -2
  170. data/site-local/development/releases.html +2 -2
  171. data/site-local/development/workflow.html +2 -2
  172. data/site-local/getting-started/builds.html +2 -2
  173. data/site-local/getting-started/command-line.html +2 -2
  174. data/site-local/getting-started/example-projects/cipher-quest.html +2 -2
  175. data/site-local/getting-started/example-projects/index.html +2 -2
  176. data/site-local/getting-started/example-projects/temp-sensor.html +2 -2
  177. data/site-local/getting-started/example-projects/wondrous-forest.html +10 -2
  178. data/site-local/getting-started/index.html +2 -2
  179. data/site-local/getting-started/installation.html +2 -2
  180. data/site-local/getting-started/quick-start.html +2 -2
  181. data/site-local/help.html +2 -2
  182. data/site-local/index.html +2 -2
  183. data/site-local/overview/build-system.html +2 -2
  184. data/site-local/overview/index.html +2 -2
  185. data/site-local/overview/test-environments.html +2 -2
  186. data/site-local/overview/tools-and-frameworks.html +2 -2
  187. data/site-local/plugins/beep.html +2 -2
  188. data/site-local/plugins/bullseye/index.html +45 -38
  189. data/site-local/plugins/bullseye/licensing.html +2 -2
  190. data/site-local/plugins/command-hooks.html +4 -4
  191. data/site-local/plugins/compile-commands-json-db.html +2 -2
  192. data/site-local/plugins/cppcheck.html +2 -2
  193. data/site-local/plugins/dependencies.html +2 -2
  194. data/site-local/plugins/fff.html +16 -2
  195. data/site-local/plugins/gcov/examples.html +2 -2
  196. data/site-local/plugins/gcov/gcovr.html +8 -2
  197. data/site-local/plugins/gcov/index.html +2 -2
  198. data/site-local/plugins/gcov/overview.html +2 -2
  199. data/site-local/plugins/gcov/reportgenerator.html +18 -14
  200. data/site-local/plugins/gcov/reporting.html +2 -2
  201. data/site-local/plugins/gcov/setup.html +2 -2
  202. data/site-local/plugins/gcov/tool-versions.html +2 -2
  203. data/site-local/plugins/gcov/troubleshooting.html +2 -2
  204. data/site-local/plugins/index.html +2 -2
  205. data/site-local/plugins/module-generator.html +2 -2
  206. data/site-local/plugins/report-build-warnings-log.html +2 -2
  207. data/site-local/plugins/report-tests-gtestlike-stdout.html +2 -2
  208. data/site-local/plugins/report-tests-ide-stdout.html +2 -2
  209. data/site-local/plugins/report-tests-log-factory.html +2 -2
  210. data/site-local/plugins/report-tests-pretty-stdout.html +2 -2
  211. data/site-local/plugins/report-tests-raw-output-log.html +2 -2
  212. data/site-local/plugins/report-tests-teamcity-stdout.html +2 -2
  213. data/site-local/plugins/sanitize.html +2 -2
  214. data/site-local/plugins/valgrind.html +2 -2
  215. data/site-local/project/index.html +2 -2
  216. data/site-local/project/release-history.html +2 -2
  217. data/site-local/project/sbom.html +2 -2
  218. data/site-local/project/upgrade.html +2 -2
  219. data/site-local/reference/build-directives.html +2 -2
  220. data/site-local/reference/command-line.html +2 -2
  221. data/site-local/reference/environment-vars.html +2 -2
  222. data/site-local/reference/gcov-plugin.html +2 -2
  223. data/site-local/reference/global-collections.html +12 -12
  224. data/site-local/reference/index.html +2 -2
  225. data/site-local/reference/partials-macros.html +47 -2
  226. data/site-local/reference/project-configuration.html +2 -2
  227. data/site-local/sitemap.xml.gz +0 -0
  228. data/site-local/snapshot/examples/cipher_quest/index.html +2 -2
  229. data/site-local/snapshot/examples/temp_sensor/index.html +2 -2
  230. data/site-local/snapshot/examples/wondrous_forest/index.html +72 -15
  231. data/site-local/testing-guide/build-directives.html +2 -2
  232. data/site-local/testing-guide/conventions.html +67 -22
  233. data/site-local/testing-guide/frameworks.html +2 -2
  234. data/site-local/testing-guide/index.html +2 -2
  235. data/site-local/testing-guide/partials/configuration.html +31 -4
  236. data/site-local/testing-guide/partials/conventions.html +509 -8
  237. data/site-local/testing-guide/partials/directives.html +4 -3
  238. data/site-local/testing-guide/partials/example.html +2 -2
  239. data/site-local/testing-guide/partials/index.html +2 -2
  240. data/site-local/testing-guide/partials/overview.html +30 -12
  241. data/site-local/testing-guide/partials/variables.html +169 -4
  242. data/site-local/testing-guide/test-cases.html +2 -2
  243. data/site-local/testing-guide/test-sample.html +2 -2
  244. data/site-local/testing-guide/test-suite-anatomy.html +2 -2
  245. data/spec/integration/build_step_doctor_spec.rb +270 -0
  246. data/spec/integration/c_extractor_composition_spec.rb +254 -4
  247. data/spec/integration/includes_extraction_spec.rb +27 -14
  248. data/spec/integration/nested_test_artifacts_spec.rb +1 -1
  249. data/spec/integration/partial_files_preprocessing_spec.rb +128 -0
  250. data/spec/integration/partials_carry_spec.rb +520 -0
  251. data/spec/integration/partials_declarations_spec.rb +655 -0
  252. data/spec/integration/partials_fallback_preprocessing_spec.rb +65 -0
  253. data/spec/integration/partials_function_pointers_spec.rb +277 -0
  254. data/spec/integration/partials_header_composition_spec.rb +268 -35
  255. data/spec/integration/partials_macro_decorators_spec.rb +267 -0
  256. data/spec/integration/partials_module_resolution_spec.rb +26 -19
  257. data/spec/integration/partials_symbol_linkage_spec.rb +13 -0
  258. data/spec/integration/path_length_reporting_spec.rb +64 -0
  259. data/spec/integration/path_scenarios_spec.rb +80 -3
  260. data/spec/integration/quote_include_isolator_spec.rb +56 -0
  261. data/spec/integration/test_build_parallel_barrier_spec.rb +1 -1
  262. data/spec/integration/test_includes_extractinator_spec.rb +70 -5
  263. data/spec/integration/test_naming_spec.rb +6 -3
  264. data/spec/integration/test_source_file_checks_spec.rb +5 -3
  265. data/spec/integration/tool_executor_spec.rb +1 -1
  266. data/spec/integration/tool_validator_spec.rb +2 -2
  267. data/spec/integration/win_long_paths_probe_spec.rb +46 -0
  268. data/spec/integration/win_path_limit_spec.rb +53 -0
  269. data/spec/integration/windows_registry_query_tool_spec.rb +41 -0
  270. data/spec/support/integration/configurator_integration_helper.rb +8 -3
  271. data/spec/support/integration/partial_files_harness.rb +181 -0
  272. data/spec/support/integration/partials_generation_integration_helper.rb +237 -141
  273. data/spec/support/integration/path_scenario_harness.rb +4 -2
  274. data/spec/support/integration/spec_integration_helper.rb +8 -3
  275. data/spec/support/integration/test_includes_harness.rb +56 -35
  276. data/spec/support/integration/tool_executor_integration_helper.rb +14 -2
  277. data/spec/system/bullseye_deployment_spec.rb +2 -0
  278. data/spec/system/delta_builds_spec.rb +26 -12
  279. data/spec/system/encoding_stress_spec.rb +4 -4
  280. data/spec/system/example_wondrous_forest_spec.rb +2 -2
  281. data/spec/system/gcov_deployment_spec.rb +2 -0
  282. data/spec/system/header_include_path_validation_spec.rb +4 -4
  283. data/spec/system/header_search_paths_spec.rb +1083 -0
  284. data/spec/system/mock_include_folders_spec.rb +121 -0
  285. data/spec/system/mockable_header_reassembly_spec.rb +184 -0
  286. data/spec/system/partials_carry_spec.rb +581 -0
  287. data/spec/system/partials_delta_builds_spec.rb +280 -0
  288. data/spec/system/partials_function_pointers_spec.rb +106 -0
  289. data/spec/system/partials_macro_decorators_spec.rb +127 -0
  290. data/spec/system/partials_module_disambiguation_spec.rb +125 -0
  291. data/spec/system/path_handling_probes_spec.rb +16 -12
  292. data/spec/system/pinned_thread_count_spec.rb +4 -4
  293. data/spec/system/preprocessing_fallback_conditionals_spec.rb +1 -1
  294. data/spec/system/short_build_paths_spec.rb +87 -0
  295. data/spec/system/sibling_header_collision_spec.rb +30 -6
  296. data/spec/system/support/bullseye_common_test_cases.rb +42 -0
  297. data/spec/system/support/common_test_cases.rb +2 -2
  298. data/spec/system/support/gcov_partials_test_cases.rb +48 -0
  299. data/spec/system/test_build_layout_spec.rb +209 -0
  300. data/spec/system/test_source_file_directive_spec.rb +35 -5
  301. data/spec/units/c_extractor/c_extractor_code_text_spec.rb +67 -10
  302. data/spec/units/c_extractor/c_extractor_declarations_spec.rb +501 -4
  303. data/spec/units/c_extractor/c_extractor_declarator_spec.rb +245 -0
  304. data/spec/units/c_extractor/c_extractor_defined_type_spec.rb +45 -0
  305. data/spec/units/c_extractor/c_extractor_definitions_spec.rb +163 -3
  306. data/spec/units/c_extractor/c_extractor_functions_spec.rb +462 -21
  307. data/spec/units/c_extractor/c_extractor_preprocessing_spec.rb +39 -0
  308. data/spec/units/c_extractor/c_extractor_spec.rb +4 -4
  309. data/spec/units/c_extractor/c_extractor_types_spec.rb +163 -0
  310. data/spec/units/c_identifier_spec.rb +35 -0
  311. data/spec/units/config/configurator_builder_spec.rb +24 -0
  312. data/spec/units/config/configurator_setup_spec.rb +72 -4
  313. data/spec/units/config/configurator_spec.rb +27 -1
  314. data/spec/units/dependencies/dependency_cache_store_spec.rb +68 -3
  315. data/spec/units/dependencies/dependency_tracker_spec.rb +25 -0
  316. data/spec/units/dependencies/dependinator_spec.rb +17 -2
  317. data/spec/units/diagnostics/build_step_doctor_spec.rb +170 -0
  318. data/spec/units/diagnostics/duplicate_symbol_specialist_spec.rb +117 -0
  319. data/spec/units/diagnostics/header_collision_specialist_spec.rb +267 -0
  320. data/spec/units/diagnostics/include_depth_specialist_spec.rb +137 -0
  321. data/spec/units/diagnostics/missing_symbol_specialist_spec.rb +154 -0
  322. data/spec/units/diagnostics/partial_name_specialist_spec.rb +129 -0
  323. data/spec/units/diagnostics/toolchain_output_spec.rb +86 -0
  324. data/spec/units/encodinator_spec.rb +3 -4
  325. data/spec/units/filesystem/build_roots_spec.rb +131 -0
  326. data/spec/units/filesystem/build_subpath_spec.rb +113 -0
  327. data/spec/units/filesystem/file_finder_helper_spec.rb +80 -0
  328. data/spec/units/filesystem/file_finder_spec.rb +242 -58
  329. data/spec/units/filesystem/file_path_utils_spec.rb +251 -118
  330. data/spec/units/filesystem/file_wrapper_spec.rb +191 -6
  331. data/spec/units/filesystem/path_matcher_spec.rb +36 -0
  332. data/spec/units/filesystem/test_build_layout_spec.rb +216 -0
  333. data/spec/units/filesystem/win_long_paths_spec.rb +204 -0
  334. data/spec/units/filesystem/win_path_prober_spec.rb +158 -0
  335. data/spec/units/generators/generator_helper_spec.rb +0 -60
  336. data/spec/units/generators/generator_mocks_spec.rb +13 -0
  337. data/spec/units/generators/generator_partials_spec.rb +656 -55
  338. data/spec/units/generators/generator_spec.rb +26 -0
  339. data/spec/units/generators/generator_test_runner_spec.rb +9 -5
  340. data/spec/units/generators/partial_source_writer_spec.rb +129 -0
  341. data/spec/units/includes/header_search_spec.rb +406 -0
  342. data/spec/units/includes/include_factory_spec.rb +22 -5
  343. data/spec/units/includes/include_pathinator_spec.rb +77 -13
  344. data/spec/units/includes/include_spec.rb +14 -0
  345. data/spec/units/includes/includes_spec.rb +176 -19
  346. data/spec/units/loginator_spec.rb +31 -0
  347. data/spec/units/mock_locator_spec.rb +199 -5
  348. data/spec/units/partials/include_groups_spec.rb +42 -0
  349. data/spec/units/partials/partializer_config_spec.rb +25 -0
  350. data/spec/units/partials/partializer_helper_carry_spec.rb +661 -0
  351. data/spec/units/partials/partializer_helper_interface_extras_spec.rb +396 -0
  352. data/spec/units/partials/partializer_helper_spec.rb +529 -277
  353. data/spec/units/partials/partializer_reconciler_spec.rb +661 -0
  354. data/spec/units/partials/partializer_spec.rb +1578 -270
  355. data/spec/units/partials/partializer_utils_spec.rb +269 -232
  356. data/spec/units/partials/partials_rename_spec.rb +160 -0
  357. data/spec/units/partials_manager_spec.rb +554 -261
  358. data/spec/units/plugins/bullseye_spec.rb +34 -0
  359. data/spec/units/plugins/console_reportinator_spec.rb +58 -9
  360. data/spec/units/plugins/report_tests_teamcity_stdout_spec.rb +1 -1
  361. data/spec/units/plugins/reportgenerator_reportinator_spec.rb +51 -3
  362. data/spec/units/preprocess/preprocessinator_code_finder_spec.rb +73 -10
  363. data/spec/units/preprocess/preprocessinator_file_assembler_spec.rb +125 -37
  364. data/spec/units/preprocess/preprocessinator_includes_handler_spec.rb +15 -0
  365. data/spec/units/preprocess/preprocessinator_reconstructor_spec.rb +197 -0
  366. data/spec/units/preprocess/preprocessinator_spec.rb +153 -95
  367. data/spec/units/setupinator_spec.rb +51 -0
  368. data/spec/units/standin_headerinator_spec.rb +27 -11
  369. data/spec/units/test_build_executor_spec.rb +780 -166
  370. data/spec/units/test_build_planner_spec.rb +116 -28
  371. data/spec/units/test_build_setup_spec.rb +83 -18
  372. data/spec/units/test_context_extractor_spec.rb +11 -2
  373. data/spec/units/test_derived_search_paths_spec.rb +259 -0
  374. data/spec/units/test_includes_extractinator_spec.rb +56 -8
  375. data/spec/units/test_invoker/objects_wiring_spec.rb +20 -3
  376. data/spec/units/test_invoker/partial_files_preprocessinator_spec.rb +264 -0
  377. data/spec/units/test_invoker/test_substitutions_spec.rb +122 -0
  378. data/spec/units/test_invoker_types_spec.rb +8 -7
  379. data/spec/units/test_pipeline_manager_spec.rb +54 -13
  380. data/spec/units/test_runner_generatinator_spec.rb +93 -1
  381. data/spec/units/test_search_paths_spec.rb +73 -5
  382. data/spec/units/{default_tools_quoting_spec.rb → tools/default_tools_quoting_spec.rb} +39 -5
  383. data/spec/units/tools/shell_quoting_spec.rb +76 -0
  384. data/spec/units/{tool_executor_helper_spec.rb → tools/tool_executor_helper_spec.rb} +1 -1
  385. data/spec/units/{tool_executor_spec.rb → tools/tool_executor_spec.rb} +1 -1
  386. data/spec/units/{tool_validator_spec.rb → tools/tool_validator_spec.rb} +110 -1
  387. data/spec/units/windows_registry_query_tool_spec.rb +53 -0
  388. metadata +161 -16
  389. /data/lib/ceedling/{tool_executor.rb → tools/tool_executor.rb} +0 -0
  390. /data/lib/ceedling/{tool_executor_helper.rb → tools/tool_executor_helper.rb} +0 -0
@@ -0,0 +1,122 @@
1
+ # =========================================================================
2
+ # Ceedling - Test-Centered Build System for C
3
+ # ThrowTheSwitch.org
4
+ # Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
5
+ # SPDX-License-Identifier: MIT
6
+ # =========================================================================
7
+
8
+ require 'spec_helper'
9
+ require 'ceedling/constants'
10
+ require 'ceedling/test_invoker/test_invoker_types'
11
+ require 'ceedling/test_invoker/test_substitutions'
12
+
13
+ # Defined from project configuration at runtime
14
+ PROJECT_BUILD_VENDOR_UNITY_PATH = 'build/vendor/unity' unless defined?( PROJECT_BUILD_VENDOR_UNITY_PATH )
15
+ PROJECT_BUILD_VENDOR_CMOCK_PATH = 'build/vendor/cmock' unless defined?( PROJECT_BUILD_VENDOR_CMOCK_PATH )
16
+ PROJECT_BUILD_VENDOR_CEXCEPTION_PATH = 'build/vendor/cexception' unless defined?( PROJECT_BUILD_VENDOR_CEXCEPTION_PATH )
17
+
18
+ describe TestSubstitutions do
19
+ before(:each) do
20
+ @configurator = double( 'configurator', project_build_vendor_ceedling_path: 'build/vendor/ceedling' )
21
+ @substitutions = described_class.new( configurator: @configurator )
22
+ @testable = TestInvokerTypes::Testable.new( name: 'a_test', paths: { mocks: 'build/test/mocks/a_test', partials: 'build/test/partials/a_test' } )
23
+ end
24
+
25
+ def mock(source, partial: false)
26
+ TestInvokerTypes::MockDetails.new( name: File.basename( source, '.h' ), source: source, partial: partial )
27
+ end
28
+
29
+ def partial_config(header_filepath)
30
+ double( 'PartialConfig', header: double( 'HeaderFile', filepath: header_filepath ) )
31
+ end
32
+
33
+ describe '#real_headers' do
34
+ it 'maps each mocked header\'s basename to its real path' do
35
+ @testable.mocks = { gpio: mock( '/project/library/gpio.h' ), uart: mock( '/project/drivers/uart.h' ) }
36
+
37
+ expect( @substitutions.real_headers( @testable ) ).to eq(
38
+ 'gpio.h' => '/project/library/gpio.h', 'uart.h' => '/project/drivers/uart.h'
39
+ )
40
+ end
41
+
42
+ it 'maps each Partialized module\'s real header' do
43
+ @testable.partials.configs = { moduleA: partial_config( '/project/src/moduleA.h' ) }
44
+
45
+ expect( @substitutions.real_headers( @testable ) ).to eq( 'moduleA.h' => '/project/src/moduleA.h' )
46
+ end
47
+
48
+ it 'leaves out a mock Partial, whose source is a generated interface header' do
49
+ @testable.mocks = { partial_mock: mock( 'build/test/partials/a_test/moduleA_interface.h', partial: true ) }
50
+
51
+ expect( @substitutions.real_headers( @testable ) ).to eq( {} )
52
+ end
53
+
54
+ it 'leaves out a mock without a resolved source, and a Partial without a header' do
55
+ @testable.mocks = { unresolved: TestInvokerTypes::MockDetails.new( name: 'x', partial: false ) }
56
+ @testable.partials.configs = { moduleB: partial_config( nil ) }
57
+
58
+ expect( @substitutions.real_headers( @testable ) ).to eq( {} )
59
+ end
60
+
61
+ it 'is empty for a testable with no mocks or Partials' do
62
+ expect( @substitutions.real_headers( @testable ) ).to eq( {} )
63
+ end
64
+ end
65
+
66
+ describe '#shadowed_headers' do
67
+ before(:each) do
68
+ allow( @configurator ).to receive( :project_use_mocks ).and_return( true )
69
+ allow( @configurator ).to receive( :cmock_treat_inlines ).and_return( :include )
70
+ @testable.mocks = { gpio: mock( '/project/library/gpio.h' ) }
71
+ end
72
+
73
+ it 'maps each mocked header CMock copies by name under inline handling' do
74
+ expect( @substitutions.shadowed_headers( @testable ) ).to eq( 'gpio.h' => '/project/library/gpio.h' )
75
+ end
76
+
77
+ it 'leaves out a Partialized header and a mock Partial' do
78
+ @testable.mocks[:partial_mock] = mock( 'build/test/partials/a_test/moduleA_interface.h', partial: true )
79
+ @testable.partials.configs = { moduleA: partial_config( '/project/src/moduleA.h' ) }
80
+
81
+ expect( @substitutions.shadowed_headers( @testable ) ).to eq( 'gpio.h' => '/project/library/gpio.h' )
82
+ end
83
+
84
+ it 'is empty when inline handling excludes inline functions' do
85
+ allow( @configurator ).to receive( :cmock_treat_inlines ).and_return( :exclude )
86
+
87
+ expect( @substitutions.shadowed_headers( @testable ) ).to eq( {} )
88
+ end
89
+
90
+ it 'is empty when mocks are disabled' do
91
+ allow( @configurator ).to receive( :project_use_mocks ).and_return( false )
92
+
93
+ expect( @substitutions.shadowed_headers( @testable ) ).to eq( {} )
94
+ end
95
+ end
96
+
97
+ describe '#partialized?' do
98
+ it 'tells a Partialized header from a mocked one' do
99
+ @testable.mocks = { gpio: mock( '/project/library/gpio.h' ) }
100
+ @testable.partials.configs = { moduleA: partial_config( '/project/src/moduleA.h' ) }
101
+
102
+ expect( @substitutions.partialized?( @testable, '/project/src/moduleA.h' ) ).to be true
103
+ expect( @substitutions.partialized?( @testable, '/project/library/gpio.h' ) ).to be false
104
+ end
105
+ end
106
+
107
+ describe '#generated_dirs' do
108
+ it 'lists the test\'s mocks and Partials directories and the vendor framework directories' do
109
+ expect( @substitutions.generated_dirs( @testable ) ).to eq( [
110
+ 'build/test/mocks/a_test', 'build/test/partials/a_test',
111
+ PROJECT_BUILD_VENDOR_UNITY_PATH, PROJECT_BUILD_VENDOR_CMOCK_PATH, PROJECT_BUILD_VENDOR_CEXCEPTION_PATH,
112
+ 'build/vendor/ceedling'
113
+ ] )
114
+ end
115
+
116
+ it 'leaves out a directory the project does not have' do
117
+ @testable.paths = {}
118
+
119
+ expect( @substitutions.generated_dirs( @testable ) ).not_to include( nil )
120
+ end
121
+ end
122
+ end
@@ -33,6 +33,12 @@ describe "TestInvokerTypes" do
33
33
  expect(testable.mock_search_paths).to eq( [] )
34
34
  end
35
35
 
36
+ it "defaults search_path_refusals to an empty hash" do
37
+ testable = TestInvokerTypes::Testable.new
38
+
39
+ expect(testable.search_path_refusals).to eq( {} )
40
+ end
41
+
36
42
  it "accepts an explicit partials value instead of defaulting" do
37
43
  partials = TestInvokerTypes::TestablePartials.new( configs: { 'Foo' => double("Config") }, tests: ['Foo'], mocks: [] )
38
44
  testable = TestInvokerTypes::Testable.new( :partials => partials )
@@ -81,18 +87,13 @@ describe "TestInvokerTypes" do
81
87
  end
82
88
 
83
89
  describe TestInvokerTypes::PartialWork do
84
- it "carries a partial file's config and owning testable, with staleness fields settable after construction" do
90
+ it "carries a partial file's config and owning testable" do
85
91
  config = double("Config")
86
92
  testable = TestInvokerTypes::Testable.new( name: 'a_test' )
87
- work = TestInvokerTypes::PartialWork.new( config: config, testable: testable, directives_only_filepath: nil )
88
-
89
- work.preprocessed_target = 'build/preprocess/Foo.h'
90
- work.stale = true
93
+ work = TestInvokerTypes::PartialWork.new( config: config, testable: testable )
91
94
 
92
95
  expect(work.config).to equal( config )
93
96
  expect(work.testable).to equal( testable )
94
- expect(work.preprocessed_target).to eq( 'build/preprocess/Foo.h' )
95
- expect(work.stale).to be true
96
97
  end
97
98
  end
98
99
 
@@ -17,6 +17,7 @@ describe TestPipelineManager do
17
17
  @test_file_preprocessinator = double( "TestFilePreprocessinator" )
18
18
  @test_runner_generatinator = double( "TestRunnerGeneratinator" )
19
19
  @test_build_planner = double( "TestBuildPlanner" )
20
+ @partial_files_preprocessinator = double( "PartialFilesPreprocessinator" )
20
21
  @partials_manager = double( "PartialsManager" )
21
22
  @test_build_executor = double( "TestBuildExecutor" )
22
23
  @configurator = double( "Configurator" )
@@ -45,10 +46,12 @@ describe TestPipelineManager do
45
46
  allow(@test_build_planner).to receive(:stage_determine_artifacts)
46
47
  allow(@test_build_planner).to receive(:stage_flatten_objects_list)
47
48
 
48
- allow(@partials_manager).to receive(:stage_preprocess_partial_headers)
49
- allow(@partials_manager).to receive(:stage_preprocess_partial_sources)
49
+ allow(@partial_files_preprocessinator).to receive(:preprocess_headers)
50
+ allow(@partial_files_preprocessinator).to receive(:preprocess_sources)
50
51
  allow(@partials_manager).to receive(:stage_generate_partials)
51
52
  allow(@test_build_executor).to receive(:stage_preprocess_mocks)
53
+ allow(@test_build_executor).to receive(:stage_prune_header_copies)
54
+ allow(@test_build_executor).to receive(:stage_hold_header_copies)
52
55
  allow(@test_build_executor).to receive(:stage_generate_mocks)
53
56
  allow(@test_file_preprocessinator).to receive(:preprocess)
54
57
  allow(@test_runner_generatinator).to receive(:collect_details)
@@ -62,6 +65,7 @@ describe TestPipelineManager do
62
65
  :test_build_setup => @test_build_setup,
63
66
  :test_includes_extractinator => @test_includes_extractinator,
64
67
  :test_build_planner => @test_build_planner,
68
+ :partial_files_preprocessinator => @partial_files_preprocessinator,
65
69
  :partials_manager => @partials_manager,
66
70
  :test_build_executor => @test_build_executor,
67
71
  :test_file_preprocessinator => @test_file_preprocessinator,
@@ -74,12 +78,17 @@ describe TestPipelineManager do
74
78
  )
75
79
  end
76
80
 
81
+ # A flattened mock, a Partial's or a plain header's
82
+ def mock_work(partial: false)
83
+ TestInvokerTypes::MockWork.new( :details => TestInvokerTypes::MockDetails.new( :partial => partial ) )
84
+ end
85
+
77
86
  # Defaults every flattened list to non-empty, real-shaped-enough content, so every
78
87
  # existing test below exercises the "has work to do" path without having to know or
79
88
  # care about T1/T2's output -- exactly as it would if a project had at least one
80
89
  # Partial and one mock. Tests specifically about the "enabled but nothing to do this
81
90
  # run" case (below) override one or more of these to `[]`.
82
- def state(options: [], partials_headers: [double("PartialWork")], partials_sources: [double("PartialWork")], mocks_list: [double("MockWork")])
91
+ def state(options: [], partials_headers: [double("PartialWork")], partials_sources: [double("PartialWork")], mocks_list: [mock_work])
83
92
  TestInvokerTypes::PipelineState.new(
84
93
  :testables => {}, :context => :test, :options => options,
85
94
  :partials_headers => partials_headers, :partials_sources => partials_sources, :mocks_list => mocks_list,
@@ -118,8 +127,8 @@ describe TestPipelineManager do
118
127
  expect(@test_includes_extractinator).to receive(:stage_collect_preprocessor_context)
119
128
  expect(@test_build_planner).to receive(:stage_determine_files)
120
129
  expect(@test_build_planner).to receive(:stage_flatten_partials_lists)
121
- expect(@partials_manager).to receive(:stage_preprocess_partial_headers)
122
- expect(@partials_manager).to receive(:stage_preprocess_partial_sources)
130
+ expect(@partial_files_preprocessinator).to receive(:preprocess_headers)
131
+ expect(@partial_files_preprocessinator).to receive(:preprocess_sources)
123
132
  expect(@partials_manager).to receive(:stage_generate_partials)
124
133
  expect(@test_build_planner).to receive(:stage_flatten_mocks_list)
125
134
  expect(@test_build_executor).to receive(:stage_preprocess_mocks)
@@ -281,17 +290,19 @@ describe TestPipelineManager do
281
290
  end
282
291
 
283
292
  it "runs every stage and transform, start to finish" do
293
+ expect(@test_build_executor).to receive(:stage_hold_header_copies)
284
294
  expect(@test_build_setup).to receive(:stage_prepare_build_paths)
285
295
  expect(@test_build_setup).to receive(:stage_collect_test_context)
286
296
  expect(@test_build_setup).to receive(:stage_ingest_configurations)
287
297
  expect(@test_includes_extractinator).to receive(:stage_collect_preprocessor_context)
288
298
  expect(@test_build_planner).to receive(:stage_determine_files)
289
299
  expect(@test_build_planner).to receive(:stage_flatten_partials_lists)
290
- expect(@partials_manager).to receive(:stage_preprocess_partial_headers)
291
- expect(@partials_manager).to receive(:stage_preprocess_partial_sources)
300
+ expect(@partial_files_preprocessinator).to receive(:preprocess_headers)
301
+ expect(@partial_files_preprocessinator).to receive(:preprocess_sources)
292
302
  expect(@partials_manager).to receive(:stage_generate_partials)
293
303
  expect(@test_build_planner).to receive(:stage_flatten_mocks_list)
294
304
  expect(@test_build_executor).to receive(:stage_preprocess_mocks)
305
+ expect(@test_build_executor).to receive(:stage_prune_header_copies)
295
306
  expect(@test_build_executor).to receive(:stage_generate_mocks)
296
307
  expect(@test_file_preprocessinator).to receive(:preprocess)
297
308
  expect(@test_runner_generatinator).to receive(:collect_details)
@@ -324,6 +335,7 @@ describe TestPipelineManager do
324
335
  it "skips test-file preprocessing and its two dependent stages, independent of any stop-point option" do
325
336
  allow(@configurator).to receive(:project_use_test_preprocessor_tests).and_return( false )
326
337
 
338
+ expect(@test_build_executor).to_not receive(:stage_hold_header_copies)
327
339
  expect(@test_includes_extractinator).to_not receive(:stage_collect_preprocessor_context)
328
340
  expect(@test_file_preprocessinator).to_not receive(:preprocess)
329
341
  expect(@test_runner_generatinator).to_not receive(:collect_details)
@@ -338,8 +350,8 @@ describe TestPipelineManager do
338
350
  allow(@configurator).to receive(:project_use_partials).and_return( false )
339
351
 
340
352
  expect(@test_build_planner).to_not receive(:stage_flatten_partials_lists)
341
- expect(@partials_manager).to_not receive(:stage_preprocess_partial_headers)
342
- expect(@partials_manager).to_not receive(:stage_preprocess_partial_sources)
353
+ expect(@partial_files_preprocessinator).to_not receive(:preprocess_headers)
354
+ expect(@partial_files_preprocessinator).to_not receive(:preprocess_sources)
343
355
  expect(@partials_manager).to_not receive(:stage_generate_partials)
344
356
  expect(@test_build_planner).to receive(:stage_determine_files)
345
357
  expect(@loginator).to_not receive(:log)
@@ -354,6 +366,8 @@ describe TestPipelineManager do
354
366
 
355
367
  expect(@test_build_planner).to_not receive(:stage_flatten_mocks_list)
356
368
  expect(@test_build_executor).to_not receive(:stage_preprocess_mocks)
369
+ expect(@test_build_executor).to_not receive(:stage_prune_header_copies)
370
+ expect(@test_build_executor).to_not receive(:stage_hold_header_copies)
357
371
  expect(@test_build_executor).to_not receive(:stage_generate_mocks)
358
372
  expect(@test_runner_generatinator).to receive(:generate)
359
373
  expect(@loginator).to_not receive(:log)
@@ -367,8 +381,8 @@ describe TestPipelineManager do
367
381
  allow(@configurator).to receive(:project_use_partials).and_return( true )
368
382
 
369
383
  expect(@test_build_planner).to receive(:stage_flatten_partials_lists)
370
- expect(@partials_manager).to_not receive(:stage_preprocess_partial_headers)
371
- expect(@partials_manager).to_not receive(:stage_preprocess_partial_sources)
384
+ expect(@partial_files_preprocessinator).to_not receive(:preprocess_headers)
385
+ expect(@partial_files_preprocessinator).to_not receive(:preprocess_sources)
372
386
  expect(@partials_manager).to_not receive(:stage_generate_partials)
373
387
 
374
388
  expect(@loginator).to receive(:log)
@@ -383,16 +397,18 @@ describe TestPipelineManager do
383
397
  end
384
398
 
385
399
  context "when mocking is enabled but this run has no mocks" do
386
- it "skips both mocking stages and logs an OBNOXIOUS notice for each, instead of running them" do
400
+ # A test's mock root stays on its search path with no mocks in it
401
+ it "skips both mocking stages and logs an OBNOXIOUS notice for each, instead of running them, and still prunes header copies" do
387
402
  allow(@configurator).to receive(:project_use_mocks).and_return( true )
388
403
  allow(@configurator).to receive(:project_use_test_preprocessor_mocks).and_return( true )
389
404
 
390
405
  expect(@test_build_planner).to receive(:stage_flatten_mocks_list)
406
+ expect(@test_build_executor).to receive(:stage_prune_header_copies)
391
407
  expect(@test_build_executor).to_not receive(:stage_preprocess_mocks)
392
408
  expect(@test_build_executor).to_not receive(:stage_generate_mocks)
393
409
 
394
410
  expect(@loginator).to receive(:log)
395
- .with( "Preprocessing for Mocks: no mocks to process", Verbosity::OBNOXIOUS )
411
+ .with( "Preprocessing for Mocks: no mocks need preprocessing", Verbosity::OBNOXIOUS )
396
412
  expect(@loginator).to receive(:log)
397
413
  .with( "Mocking: no mocks to generate", Verbosity::OBNOXIOUS )
398
414
 
@@ -400,6 +416,31 @@ describe TestPipelineManager do
400
416
  end
401
417
  end
402
418
 
419
+ # CMock reads a Partial mock's generated header itself, so stage 9 has nothing to do for one
420
+ context "when mocking is enabled and every mock is a Partial's" do
421
+ it "skips mock preprocessing with its notice but still generates the mocks" do
422
+ allow(@configurator).to receive(:project_use_mocks).and_return( true )
423
+ allow(@configurator).to receive(:project_use_test_preprocessor_mocks).and_return( true )
424
+
425
+ expect(@test_build_executor).to_not receive(:stage_preprocess_mocks)
426
+ expect(@test_build_executor).to receive(:stage_generate_mocks)
427
+
428
+ expect(@loginator).to receive(:log)
429
+ .with( "Preprocessing for Mocks: no mocks need preprocessing", Verbosity::OBNOXIOUS )
430
+
431
+ @manager.run( state(options: [], mocks_list: [mock_work(partial: true)]) )
432
+ end
433
+
434
+ it "runs mock preprocessing when a plain mock sits beside a Partial's" do
435
+ allow(@configurator).to receive(:project_use_mocks).and_return( true )
436
+ allow(@configurator).to receive(:project_use_test_preprocessor_mocks).and_return( true )
437
+
438
+ expect(@test_build_executor).to receive(:stage_preprocess_mocks)
439
+
440
+ @manager.run( state(options: [], mocks_list: [mock_work(partial: true), mock_work]) )
441
+ end
442
+ end
443
+
403
444
  context "when mocking is enabled but mock preprocessing is disabled" do
404
445
  it "still generates mocks but skips preprocessing headers to be mocked" do
405
446
  allow(@configurator).to receive(:project_use_mocks).and_return( true )
@@ -9,6 +9,7 @@ require 'spec_helper'
9
9
  require 'ceedling/test_invoker/test_runner_generatinator'
10
10
  require 'ceedling/test_invoker/test_invoker_types'
11
11
  require 'ceedling/includes/includes'
12
+ require 'ceedling/includes/header_search'
12
13
 
13
14
  describe TestRunnerGeneratinator do
14
15
  before(:each) do
@@ -32,10 +33,12 @@ describe TestRunnerGeneratinator do
32
33
  allow(@dependinator).to receive(:stale?).and_return( true )
33
34
  allow(@dependinator).to receive(:mark_fresh)
34
35
  @generator = double( "Generator" )
36
+ @mock_locator = double( "MockLocator" )
37
+ allow(@mock_locator).to receive(:header_search).and_return( HeaderSearch.new( [], ->(_dir) { [] } ) )
35
38
 
36
39
  @runners = described_class.new(
37
40
  configurator: @configurator, loginator: @loginator, reportinator: @reportinator, batchinator: @batchinator,
38
- generator: @generator, test_context_extractor: @test_context_extractor, dependinator: @dependinator
41
+ generator: @generator, test_context_extractor: @test_context_extractor, dependinator: @dependinator, mock_locator: @mock_locator
39
42
  )
40
43
  end
41
44
 
@@ -212,4 +215,93 @@ describe TestRunnerGeneratinator do
212
215
  @runners.generate( @state )
213
216
  end
214
217
  end
218
+
219
+ # The runner compiles with the test's search paths, so it includes each of the test's
220
+ # headers by the text those paths find it through
221
+ context "runner #includes" do
222
+ before(:each) do
223
+ allow(@configurator).to receive(:get_runner_config).and_return( {} )
224
+ allow(@configurator).to receive(:get_unity_config).and_return( {} )
225
+ allow(@configurator).to receive(:project_use_test_preprocessor_tests).and_return( true )
226
+ allow(@test_context_extractor).to receive(:lookup_mock_header_includes_list).and_return( [] )
227
+
228
+ tree = ['src/top.h', 'src/drivers/foo.h']
229
+ allow(@mock_locator).to receive(:header_search).and_return(
230
+ HeaderSearch.new( ['src'], ->(dir) { tree.select { |header| File.dirname( header ) == dir } } )
231
+ )
232
+
233
+ @testable = TestInvokerTypes::Testable.new(
234
+ :name => 'a_test', :filepath => 'test/TestFoo.c',
235
+ :runner => TestInvokerTypes::RunnerInfo.new( :output_filepath => 'build/test/runners/TestFoo_runner.c', :input_filepath => 'test/TestFoo.c' )
236
+ )
237
+ @state = TestInvokerTypes::PipelineState.new( :testables => { :a_test => @testable }, :lock => Mutex.new, :context => :test, :options => [] )
238
+ end
239
+
240
+ # Without test preprocessing a test's #includes are as written. With it, each holds the path
241
+ # the compiler found its header by.
242
+ def generated_includes(includes, preprocessed: false)
243
+ allow(@configurator).to receive(:project_use_test_preprocessor_tests).and_return( preprocessed )
244
+ allow(@test_context_extractor).to receive(:lookup_nonmock_header_includes_list).and_return( includes )
245
+ rendered = nil
246
+ expect(@generator).to receive(:generate_test_runner) { |includes:, **| rendered = includes.map { |include| include.include_path || include.filename } }
247
+
248
+ @runners.generate( @state )
249
+ return rendered
250
+ end
251
+
252
+ it "includes a header by its filename when the search paths find it by that" do
253
+ expect(generated_includes( [UserInclude.new( 'top.h' )] )).to eq( ['top.h'] )
254
+ end
255
+
256
+ it "includes a header below a search path by its path below that search path" do
257
+ expect(generated_includes( [UserInclude.new( 'drivers/foo.h' )] )).to eq( ['drivers/foo.h'] )
258
+ end
259
+
260
+ # With test preprocessing, an #include carries the path GCC found the header by
261
+ it "includes a header named by its resolved path by the text the search paths find it through" do
262
+ expect(generated_includes( [UserInclude.new( 'src/drivers/foo.h' )], preprocessed: true )).to eq( ['drivers/foo.h'] )
263
+ end
264
+
265
+ it "includes the header a resolved path names, never one a later search path joins that path to" do
266
+ tree = ['include/config.h', 'third_party/mylib/include/config.h']
267
+ allow(@mock_locator).to receive(:header_search).and_return(
268
+ HeaderSearch.new( ['include', 'third_party/mylib'], ->(dir) { tree.select { |header| File.dirname( header ) == dir } } )
269
+ )
270
+
271
+ expect(generated_includes( [UserInclude.new( 'include/config.h' )], preprocessed: true )).to eq( ['config.h'] )
272
+ end
273
+
274
+ # A quoted #include as written looks beside the test file before any search path
275
+ it "includes the header beside the test file that an #include as written names" do
276
+ tree = ['src/drivers/foo.h', 'test/drivers/foo.h']
277
+ allow(@mock_locator).to receive(:header_search).and_return(
278
+ HeaderSearch.new( ['src', '.'], ->(dir) { tree.select { |header| File.dirname( header ) == dir.delete_prefix( './' ) } } )
279
+ )
280
+
281
+ expect(generated_includes( [UserInclude.new( 'drivers/foo.h' )] )).to eq( ['test/drivers/foo.h'] )
282
+ end
283
+
284
+ it "keeps the filename of a header no search path reaches" do
285
+ expect(generated_includes( [UserInclude.new( 'gone/missing.h' )] )).to eq( ['missing.h'] )
286
+ end
287
+
288
+ it "spells a test's #includes once for both stages and the runner" do
289
+ allow(@test_context_extractor).to receive(:lookup_nonmock_header_includes_list).and_return( [UserInclude.new( 'top.h' )] )
290
+ allow(@test_context_extractor).to receive(:collect_test_runner_details)
291
+ allow(@generator).to receive(:generate_test_runner)
292
+ expect(@mock_locator).to receive(:header_search).once.and_return( HeaderSearch.new( ['src'], ->(_dir) { ['src/top.h'] } ) )
293
+
294
+ @runners.collect_details( @state )
295
+ @runners.generate( @state )
296
+ end
297
+
298
+ it "carries the spelled #includes in its meta" do
299
+ allow(@test_context_extractor).to receive(:lookup_nonmock_header_includes_list).and_return( [UserInclude.new( 'drivers/foo.h' )] )
300
+ allow(@generator).to receive(:generate_test_runner)
301
+
302
+ expect(@dependinator).to receive(:register).with( anything, files: anything, meta: hash_including( includes: ['drivers/foo.h'] ) )
303
+
304
+ @runners.generate( @state )
305
+ end
306
+ end
215
307
  end
@@ -27,15 +27,21 @@ describe TestSearchPaths do
27
27
  )
28
28
  end
29
29
 
30
+ def testable(paths, mock_search_paths = [], derived_search_paths = [])
31
+ return TestInvokerTypes::Testable.new(
32
+ filepath: 'test/TestFoo.c', paths: paths, mock_search_paths: mock_search_paths, derived_search_paths: derived_search_paths
33
+ )
34
+ end
35
+
30
36
  describe "#compose" do
31
37
  it "includes a mocked header's own mirrored directory alongside the flat mock root" do
32
- result = @search_paths.compose( 'test/TestFoo.c', { mocks: 'build/test/mocks/a_test' }, ['build/test/mocks/a_test/drivers'] )
38
+ result = @search_paths.compose( testable( { mocks: 'build/test/mocks/a_test' }, ['build/test/mocks/a_test/drivers'] ) )
33
39
 
34
40
  expect(result).to eq( ['build/test/mocks/a_test', 'build/test/mocks/a_test/drivers'] )
35
41
  end
36
42
 
37
43
  it "carries only the flat mock root when no mock needs a mirrored directory of its own" do
38
- expect(@search_paths.compose( 'test/TestFoo.c', { mocks: 'build/test/mocks/a_test' } )).to eq( ['build/test/mocks/a_test'] )
44
+ expect(@search_paths.compose( testable( { mocks: 'build/test/mocks/a_test' } ) )).to eq( ['build/test/mocks/a_test'] )
39
45
  end
40
46
 
41
47
  # The compiler searches in this order, so a generated mock or Partial shadows the real
@@ -49,23 +55,75 @@ describe TestSearchPaths do
49
55
  end
50
56
  paths = { mocks: 'mocks', partials: 'partials' }
51
57
 
52
- expect(@search_paths.compose( 'test/TestFoo.c', paths, ['mocks/drivers'] )).to eq( %w[
58
+ expect(@search_paths.compose( testable( paths, ['mocks/drivers'] ) )).to eq( %w[
53
59
  mocks mocks/drivers partials partials/drivers directive test_include
54
60
  support include libraries vendor test_toolchain_include
55
61
  ] )
56
62
  end
57
63
 
64
+ it "puts the directories a test's #includes imply after every configured path" do
65
+ allow(@configurator).to receive(:collection_paths_test_toolchain_include).and_return( ['toolchain'] )
66
+ allow(@configurator).to receive(:collection_paths_include).and_return( ['src'] )
67
+
68
+ expect(@search_paths.compose( testable( { mocks: 'mocks' }, [], ['src/path/to'] ) )).to eq( ['mocks', 'src', 'toolchain', 'src/path/to'] )
69
+ end
70
+
58
71
  it "adds no Partial directory for a module named without one" do
59
72
  allow(@test_context_extractor).to receive(:lookup_partials_config).and_return( { 'uart' => {} } )
60
73
 
61
- expect(@search_paths.compose( 'test/TestFoo.c', { partials: 'partials' } )).to eq( ['partials'] )
74
+ expect(@search_paths.compose( testable( { partials: 'partials' } ) )).to eq( ['partials'] )
62
75
  end
63
76
 
64
77
  it "lists each path once" do
65
78
  allow(@configurator).to receive(:collection_paths_include).and_return( ['src', 'src'] )
66
79
  allow(@configurator).to receive(:collection_paths_support).and_return( ['src'] )
67
80
 
68
- expect(@search_paths.compose( 'test/TestFoo.c', {} )).to eq( ['src'] )
81
+ expect(@search_paths.compose( testable( {} ) )).to eq( ['src'] )
82
+ end
83
+ end
84
+
85
+ # A test's real headers are never in the directories its mocks and Partials are generated in
86
+ describe "#header_paths" do
87
+ it "gives TEST_INCLUDE_PATH() and the configured paths, without the generated directories" do
88
+ allow(@include_pathinator).to receive(:lookup_test_directive_include_paths).with( 'test/TestFoo.c' ).and_return( ['directive'] )
89
+ allow(@include_pathinator).to receive(:collect_test_include_paths).and_return( ['test_include'] )
90
+ allow(@test_context_extractor).to receive(:lookup_partials_config).and_return( { 'drivers/uart' => {} } )
91
+ %i[support include libraries vendor test_toolchain_include].each do |kind|
92
+ allow(@configurator).to receive(:"collection_paths_#{kind}").and_return( [kind.to_s] )
93
+ end
94
+
95
+ expect(@search_paths.header_paths( testable( { mocks: 'mocks', partials: 'partials' }, ['mocks/drivers'], ['derived'] ) )).to eq( %w[
96
+ directive test_include support include libraries vendor test_toolchain_include derived
97
+ ] )
98
+ end
99
+ end
100
+
101
+ # Partials are generated before mocks are preprocessed, so they are current then. The mock
102
+ # directories hold copies a later stage brings up to date.
103
+ describe "#mock_preprocess_paths" do
104
+ it "gives the Partial directories ahead of TEST_INCLUDE_PATH() and the configured paths, without the mock directories" do
105
+ allow(@include_pathinator).to receive(:lookup_test_directive_include_paths).with( 'test/TestFoo.c' ).and_return( ['directive'] )
106
+ allow(@include_pathinator).to receive(:collect_test_include_paths).and_return( ['test_include'] )
107
+ allow(@test_context_extractor).to receive(:lookup_partials_config).and_return( { 'drivers/uart' => {} } )
108
+ %i[support include libraries vendor test_toolchain_include].each do |kind|
109
+ allow(@configurator).to receive(:"collection_paths_#{kind}").and_return( [kind.to_s] )
110
+ end
111
+
112
+ expect(@search_paths.mock_preprocess_paths( testable( { mocks: 'mocks', partials: 'partials' }, ['mocks/drivers'], ['derived'] ) )).to eq( %w[
113
+ partials partials/drivers directive test_include support include libraries vendor test_toolchain_include derived
114
+ ] )
115
+ end
116
+
117
+ it "gives the header paths when the test has no Partials" do
118
+ allow(@configurator).to receive(:collection_paths_include).and_return( ['src'] )
119
+
120
+ expect(@search_paths.mock_preprocess_paths( testable( { mocks: 'mocks' }, ['mocks/drivers'], ['derived'] ) )).to eq( ['src', 'derived'] )
121
+ end
122
+
123
+ it "lists each path once" do
124
+ allow(@configurator).to receive(:collection_paths_include).and_return( ['src', 'partials'] )
125
+
126
+ expect(@search_paths.mock_preprocess_paths( testable( { partials: 'partials' } ) )).to eq( ['partials', 'src'] )
69
127
  end
70
128
  end
71
129
 
@@ -80,5 +138,15 @@ describe TestSearchPaths do
80
138
  expect(testable.mock_search_paths).to eq( ['mocks/drivers'] )
81
139
  expect(testable.search_paths).to eq( ['mocks', 'mocks/drivers'] )
82
140
  end
141
+
142
+ it "keeps the directories the test's #includes imply" do
143
+ testable = TestInvokerTypes::Testable.new(
144
+ filepath: 'test/TestFoo.c', paths: { mocks: 'mocks' }, mock_search_paths: [], derived_search_paths: ['src/path/to']
145
+ )
146
+
147
+ @search_paths.assign_mock_search_paths( testable, ['mocks/drivers'], Mutex.new )
148
+
149
+ expect(testable.search_paths).to eq( ['mocks', 'mocks/drivers', 'src/path/to'] )
150
+ end
83
151
  end
84
152
  end
@@ -9,12 +9,13 @@ require 'spec_helper'
9
9
  require 'shellwords'
10
10
  require 'yaml'
11
11
  require 'ceedling/defaults'
12
- require 'ceedling/tool_executor'
12
+ require 'ceedling/tools/tool_executor'
13
13
  require 'ceedling/ruby_expandinator'
14
14
 
15
- load File.expand_path( '../../plugins/gcov/config/defaults_gcov.rb', __dir__ )
16
- load File.expand_path( '../../plugins/bullseye/config/defaults_bullseye.rb', __dir__ )
17
- load File.expand_path( '../../plugins/cppcheck/config/defaults_cppcheck.rb', __dir__ )
15
+ require 'ceedling/tools/tool_validator'
16
+ require 'ceedling/filename_extension'
17
+
18
+ Dir[File.expand_path( '../../../plugins/*/config/defaults_*.rb', __dir__ )].each { |defaults| load defaults }
18
19
 
19
20
  # GH #1373: the default tools that run a test executable named it unquoted, so a path holding
20
21
  # an apostrophe or a space broke the shell command. Each command here is split as a POSIX
@@ -24,7 +25,7 @@ describe 'Default tools' do
24
25
  OTHER_PATH = "src/my dir/o'neil.c"
25
26
 
26
27
  DEPENDENCIES_TOOLS = YAML.load_file(
27
- File.expand_path( '../../plugins/dependencies/config/defaults.yml', __dir__ ), symbolize_names: true
28
+ File.expand_path( '../../../plugins/dependencies/config/defaults.yml', __dir__ ), symbolize_names: true
28
29
  )[:tools]
29
30
 
30
31
  before(:each) do
@@ -81,3 +82,36 @@ describe 'Default tools' do
81
82
  expect( words( DEPENDENCIES_TOOLS[:deps_zip], 'vendor/my dir/x.zip' ) ).to eq( ['unzip', '-o', 'vendor/my dir/x.zip'] )
82
83
  end
83
84
  end
85
+
86
+ # Tool validation checks every tool's quoting on every build, Ceedling's own tools included,
87
+ # so none of them may draw an error or a warning on any platform
88
+ describe 'Default tools quoting validation' do
89
+ # Every tool Ceedling and its plugins define: each constant holding one, and each tool in
90
+ # a plugin's YAML defaults
91
+ BUILT_IN_TOOLS = (
92
+ Object.constants.grep( /\ADEFAULT_\w+_TOOL\z/ ).map { |name| [name.to_s, Object.const_get( name )] } +
93
+ Dir[File.expand_path( '../../../plugins/*/config/*.yml', __dir__ )].flat_map do |filepath|
94
+ tools = YAML.load_file( filepath, symbolize_names: true )&.dig( :tools ) || {}
95
+ tools.map { |key, tool| ["#{File.basename( File.dirname( File.dirname( filepath ) ) )} :#{key}", tool] }
96
+ end
97
+ ).freeze
98
+
99
+ [false, true].each do |windows|
100
+ it "finds every built-in tool's quoting closed and straight #{windows ? 'on' : 'off'} Windows" do
101
+ loginator = double( 'loginator' )
102
+ system_wrapper = double( 'system_wrapper', windows?: windows, search_paths: ['/bin'] )
103
+ file_wrapper = double( 'file_wrapper', exist?: true )
104
+ validator = ToolValidator.new( file_wrapper: file_wrapper, loginator: loginator, system_wrapper: system_wrapper, ruby_expandinator: RubyExpandinator.new )
105
+
106
+ complaints = []
107
+ allow( loginator ).to receive( :log ) { |message, *| complaints << message }
108
+
109
+ # 50 core and plugin tools, so a narrowed collection fails here, not silently
110
+ expect( BUILT_IN_TOOLS.size ).to be >= 50
111
+ BUILT_IN_TOOLS.each do |name, tool|
112
+ expect( validator.validate( tool: Marshal.load( Marshal.dump( tool ) ), name: name, extension: FilenameExtension.new( '' ) ) ).to be( true ), name
113
+ end
114
+ expect( complaints ).to eq( [] )
115
+ end
116
+ end
117
+ end