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
@@ -45,6 +45,17 @@ ceedling_system_tests do
45
45
  end
46
46
  end
47
47
 
48
+ it "builds two same-named mocks through a search path that lists only their parent" do
49
+ in_project do
50
+ write( 'inc/a/foo.h', "int a_read(void);\n" )
51
+ write( 'inc/b/foo.h', "int b_read(void);\n" )
52
+ write( 'test/test_c.c', MOCK_FOLDER_PREAMBLE + "#include \"a/mock_foo.h\"\n#include \"b/mock_foo.h\"\n" \
53
+ "void test_reads(void) { a_read_ExpectAndReturn(5); b_read_ExpectAndReturn(6); TEST_ASSERT_EQUAL_INT(11, a_read() + b_read()); }\n" )
54
+
55
+ build( ['inc'] )
56
+ end
57
+ end
58
+
48
59
  # The mocks root carries the test's name, which the #include's folder happens to share
49
60
  it "builds a mock whose #include folder shares the test's own name" do
50
61
  in_project do
@@ -88,4 +99,114 @@ ceedling_system_tests do
88
99
  build( ['inc/**'], preprocessor: :all )
89
100
  end
90
101
  end
102
+
103
+ # Test preprocessing finds each mock at its place below its mirror root, which can carry
104
+ # folders the test's #include never wrote. A mock keeps the name its #include gives it, so a
105
+ # test calling a mock's own functions calls them by that name in every preprocessing mode.
106
+ context "named by its #include in every preprocessing mode" do
107
+ [:mocks, :tests, :all].product( [false, true] ).each do |preprocessor, fallback|
108
+ mode = fallback ? ' with fallback preprocessing' : ''
109
+
110
+ it "names a mock of a header below its glob root by its #include under :use_test_preprocessor #{preprocessor}#{mode}" do
111
+ in_project do
112
+ @c.merge_project_yml_for_test( { :test_build => { :preprocess_force_fallback => true } } ) if fallback
113
+ write( 'rtos/include/task.h', "int task_run(int x);\n" )
114
+ write( 'test/test_c.c', MOCK_FOLDER_PREAMBLE + "#include \"mock_task.h\"\n" \
115
+ "void test_run(void) { task_run_ExpectAndReturn(1, 2); TEST_ASSERT_EQUAL_INT(2, task_run(1)); mock_task_Verify(); }\n" )
116
+
117
+ build( ['rtos/**'], preprocessor: preprocessor )
118
+ end
119
+ end
120
+ end
121
+
122
+ # A pathless mock and one naming a folder can mock two headers of one name, and two
123
+ # #includes of one header's mock give it one mock, named by the one with more path
124
+ [:none, :mocks, :tests, :all].each do |preprocessor|
125
+ it "keeps a pathless mock beside a same-named mock its folder names under :use_test_preprocessor #{preprocessor}" do
126
+ in_project do
127
+ write( 'rtos/include/task.h', "int task_run(int x);\n" )
128
+ write( 'rtos/other/task.h', "int other_run(int x);\n" )
129
+ write( 'test/test_c.c', MOCK_FOLDER_PREAMBLE + "#include \"mock_task.h\"\n#include \"other/mock_task.h\"\n" \
130
+ "void test_run(void) { task_run_ExpectAndReturn(1, 2); other_run_ExpectAndReturn(3, 4); " \
131
+ "TEST_ASSERT_EQUAL_INT(6, task_run(1) + other_run(3)); mock_task_Verify(); other_mock_task_Verify(); }\n" )
132
+
133
+ build( ['rtos/**'], preprocessor: preprocessor )
134
+ end
135
+ end
136
+
137
+ # The pathless mock's source sits in the test's mock root, which the other's name ends too
138
+ it "keeps a pathless mock of a header at a search path's root beside a same-named mock under :use_test_preprocessor #{preprocessor}" do
139
+ in_project do
140
+ write( 'inc/task.h', "int r_run(int x);\n" )
141
+ write( 'inc/b/task.h', "int b_run(int x);\n" )
142
+ write( 'test/test_c.c', MOCK_FOLDER_PREAMBLE + "#include \"mock_task.h\"\n#include \"b/mock_task.h\"\n" \
143
+ "void test_run(void) { r_run_ExpectAndReturn(0, 1); b_run_ExpectAndReturn(3, 4); TEST_ASSERT_EQUAL_INT(5, r_run(0) + b_run(3)); }\n" )
144
+
145
+ build( ['inc/**'], preprocessor: preprocessor )
146
+ end
147
+ end
148
+
149
+ it "gives one header one mock when two #includes name it under :use_test_preprocessor #{preprocessor}" do
150
+ in_project do
151
+ write( 'rtos/include/task.h', "int task_run(int x);\n" )
152
+ write( 'test/test_c.c', MOCK_FOLDER_PREAMBLE + "#include \"mock_task.h\"\n#include \"include/mock_task.h\"\n" \
153
+ "void test_run(void) { task_run_ExpectAndReturn(1, 2); TEST_ASSERT_EQUAL_INT(2, task_run(1)); include_mock_task_Verify(); }\n" )
154
+
155
+ build( ['rtos/**'], preprocessor: preprocessor )
156
+ end
157
+ end
158
+ end
159
+
160
+ # Neither folder reaches the other's mock, so each spelling keeps a file to reach
161
+ [:tests, :all].each do |preprocessor|
162
+ it "builds a test that names one header's mock by two folders under :use_test_preprocessor #{preprocessor}" do
163
+ in_project do
164
+ write( 'src/drivers/task.h', "int task_run(int x);\n" )
165
+ write( 'test/test_c.c', MOCK_FOLDER_PREAMBLE + "#include \"drivers/mock_task.h\"\n#include \"src/drivers/mock_task.h\"\n" \
166
+ "void test_run(void) { task_run_ExpectAndReturn(1, 2); TEST_ASSERT_EQUAL_INT(2, task_run(1)); }\n" )
167
+
168
+ build( ['src/**'], preprocessor: preprocessor )
169
+ end
170
+ end
171
+ end
172
+
173
+ it "names two same-named mocks by the folders their #includes write under :use_test_preprocessor all" do
174
+ in_project do
175
+ write( 'inc/x/a/foo.h', "int a_read(void);\n" )
176
+ write( 'inc/y/b/foo.h', "int b_read(void);\n" )
177
+ write( 'test/test_c.c', MOCK_FOLDER_PREAMBLE + "#include \"a/mock_foo.h\"\n#include \"b/mock_foo.h\"\n" \
178
+ "void test_reads(void) { a_read_ExpectAndReturn(5); b_read_ExpectAndReturn(6); " \
179
+ "TEST_ASSERT_EQUAL_INT(11, a_read() + b_read()); a_mock_foo_Verify(); b_mock_foo_Verify(); }\n" )
180
+
181
+ build( ['inc/**'], preprocessor: :all )
182
+ end
183
+ end
184
+
185
+ # The mock stays in its header's mirrored directory either way, so only its names change
186
+ [:none, :all].each do |preprocessor|
187
+ it "regenerates a mock whose #include drops its folder under :use_test_preprocessor #{preprocessor}" do
188
+ in_project do
189
+ write( 'rtos/include/task.h', "int task_run(int x);\n" )
190
+ body = "void test_run(void) { task_run_ExpectAndReturn(1, 2); TEST_ASSERT_EQUAL_INT(2, task_run(1)); }\n"
191
+ write( 'test/test_c.c', MOCK_FOLDER_PREAMBLE + "#include \"include/mock_task.h\"\n" + body )
192
+ build( ['rtos/**'], preprocessor: preprocessor )
193
+
194
+ write( 'test/test_c.c', MOCK_FOLDER_PREAMBLE + "#include \"mock_task.h\"\n" + body )
195
+ output = @c.ceedling_build_exec( "test:all" )
196
+ expect(@c.last_exit_status).to eq(0), output
197
+ expect(output).to match(/PASSED:\s+1/)
198
+ end
199
+ end
200
+ end
201
+
202
+ it "names a mock a macro in the test file names by that #include under :use_test_preprocessor all" do
203
+ in_project do
204
+ write( 'rtos/include/task.h', "int task_run(int x);\n" )
205
+ write( 'test/test_c.c', MOCK_FOLDER_PREAMBLE + "#define TASK_MOCK \"mock_task.h\"\n#include TASK_MOCK\n" \
206
+ "void test_run(void) { task_run_ExpectAndReturn(1, 2); TEST_ASSERT_EQUAL_INT(2, task_run(1)); mock_task_Verify(); }\n" )
207
+
208
+ build( ['rtos/**'], preprocessor: :all )
209
+ end
210
+ end
211
+ end
91
212
  end
@@ -0,0 +1,184 @@
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_system_helper'
9
+
10
+ ##
11
+ ## Mockable Header Reassembly Through Real Builds
12
+ ## ==============================================
13
+ ##
14
+ ## With :cmock ↳ :treat_inlines: :include, Ceedling reassembles a mocked header from its
15
+ ## preprocessed copies before CMock reads it. A vendor header such as a CMSIS stub opens with
16
+ ## a license comment longer than the include guard scan window, includes <stdint.h> through
17
+ ## the compiler's wrapper header, and defines an empty macro just ahead of its declarations.
18
+ ## The reassembled header keeps the header's own guard, writes each include once, and leaves
19
+ ## every declaration on a line of its own for CMock to mock.
20
+ ##
21
+
22
+ MOCKABLE_REASSEMBLY_LICENSE =
23
+ "/*\n" +
24
+ (" * Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use\n" * 30) +
25
+ " */\n"
26
+
27
+ MOCKABLE_REASSEMBLY_STUB = MOCKABLE_REASSEMBLY_LICENSE + <<~C
28
+ #ifndef __CMSIS_GCC_H
29
+ #define __CMSIS_GCC_H
30
+
31
+ #include <stdint.h>
32
+
33
+ // avoid warnings about deprecated APIs during unit testing
34
+ #ifndef CMSIS_DEPRECATED
35
+ #define CMSIS_DEPRECATED
36
+ #endif
37
+
38
+ void __enable_irq(void);
39
+ void __disable_irq(void);
40
+ uint32_t __get_PRIMASK(void);
41
+ void __DSB(void);
42
+
43
+ #endif
44
+ C
45
+
46
+ MOCKABLE_REASSEMBLY_TEST = <<~C
47
+ #include "unity.h"
48
+ #include "mock_cmsis_gcc.h"
49
+
50
+ void setUp(void) {}
51
+ void tearDown(void) {}
52
+
53
+ void test_enable_irq_is_mocked(void)
54
+ {
55
+ __enable_irq_Expect();
56
+ __enable_irq();
57
+ }
58
+
59
+ void test_get_primask_is_mocked(void)
60
+ {
61
+ __get_PRIMASK_ExpectAndReturn(1);
62
+ TEST_ASSERT_EQUAL_UINT32(1, __get_PRIMASK());
63
+ }
64
+ C
65
+
66
+ ceedling_system_tests do
67
+ include_context "a fresh ceedling gem project", "mockable_reassembly"
68
+
69
+ before do
70
+ in_project do
71
+ FileUtils.mkdir_p( 'test/stubs' )
72
+ File.write( 'test/stubs/cmsis_gcc.h', MOCKABLE_REASSEMBLY_STUB )
73
+ File.write( 'test/test_sysint.c', MOCKABLE_REASSEMBLY_TEST )
74
+
75
+ @c.merge_project_yml_for_test( {
76
+ :project => { :use_mocks => true, :use_test_preprocessor => :all },
77
+ :paths => { :include => ['src/**', 'test/stubs'] },
78
+ :cmock => { :treat_inlines => :include }
79
+ } )
80
+ end
81
+ end
82
+
83
+ # The reassembled header CMock read, not the preprocessor's own intermediate copies
84
+ def reassembled_header
85
+ found = Dir.glob( 'build/test/preprocess/files/**/cmsis_gcc.h' ).reject do |path|
86
+ path.include?( '/directives_only/' ) or path.include?( '/full_expansion/' )
87
+ end
88
+ expect(found.size).to eq(1), found.inspect
89
+
90
+ return File.read( found.first )
91
+ end
92
+
93
+ it "mocks every declaration of a vendor header behind a long license and an empty macro" do
94
+ in_project do
95
+ # Longer than the include guard scan window
96
+ expect( MOCKABLE_REASSEMBLY_LICENSE.bytesize ).to be > 2048
97
+
98
+ output = @c.ceedling_build_exec( "test:all" )
99
+ expect(@c.last_exit_status).to eq(0), output
100
+ expect(output).to match(/PASSED:\s+2/)
101
+
102
+ header = reassembled_header()
103
+ expect(header).to start_with( "#ifndef __CMSIS_GCC_H\n#define __CMSIS_GCC_H\n" )
104
+ expect(header.scan(/^\s*#define __CMSIS_GCC_H\b/).size).to eq(1), header
105
+ expect(header.scan(/^#include <stdint\.h>$/).size).to eq(1), header
106
+ expect(header).to match(/^\s*#define CMSIS_DEPRECATED\s*$/)
107
+ expect(header).to match(/^void __enable_irq\(void\);$/)
108
+ end
109
+ end
110
+
111
+ # A pathless #include and one naming a folder reach two headers of one name. The header
112
+ # prepared for CMock keeps both, in either order.
113
+ [:mocks, :all].product( [%w[config.h app/config.h], %w[app/config.h config.h]] ).each do |preprocessor, order|
114
+ it "keeps both same-named #includes of a mocked header, #{order.join(' then ')}, under :use_test_preprocessor #{preprocessor}" do
115
+ in_project do
116
+ FileUtils.mkdir_p( ['src/hw', 'lib/app'] )
117
+ File.write( 'src/hw/config.h', "#ifndef HW_CONFIG_H\n#define HW_CONFIG_H\ntypedef int hw_t;\n#endif\n" )
118
+ File.write( 'lib/app/config.h', "#ifndef APP_CONFIG_H\n#define APP_CONFIG_H\ntypedef int app_t;\n#endif\n" )
119
+ File.write( 'lib/motor.h', "#ifndef MOTOR_H\n#define MOTOR_H\n" + order.map { |text| "#include \"#{text}\"\n" }.join +
120
+ "static inline int motor_peek(void) { return 0; }\nhw_t motor_run(app_t a);\n#endif\n" )
121
+ File.write( 'test/test_motor.c', "#include \"unity.h\"\n#include \"mock_motor.h\"\nvoid setUp(void) {}\nvoid tearDown(void) {}\n" \
122
+ "void test_run(void) { motor_run_ExpectAndReturn(1, 9); TEST_ASSERT_EQUAL_INT(9, motor_run(1)); }\n" )
123
+ @c.remove_project_yml_option_for_test( :paths, :include )
124
+ @c.merge_project_yml_for_test( { :project => { :use_test_preprocessor => preprocessor }, :paths => { :include => ['src/hw/', 'lib/', 'test/stubs'] } } )
125
+
126
+ output = @c.ceedling_build_exec( "test:all" )
127
+ expect(@c.last_exit_status).to eq(0), output
128
+ expect(output).to match(/PASSED:\s+3/)
129
+ end
130
+ end
131
+ end
132
+
133
+ # An #include names a header beside its includer, which an earlier search path shadows with a
134
+ # header of the same name. No search path reaches the one beside it, so the copy writes it by
135
+ # its absolute path.
136
+ [:mocks, :all].each do |preprocessor|
137
+ it "mocks a header whose #include names a header beside it that an earlier search path shadows, under :use_test_preprocessor #{preprocessor}" do
138
+ in_project do
139
+ FileUtils.mkdir_p( ['src/hw', 'lib'] )
140
+ File.write( 'src/hw/config.h', "#ifndef HW_CONFIG_H\n#define HW_CONFIG_H\ntypedef int hw_t;\n#endif\n" )
141
+ File.write( 'lib/config.h', "#ifndef LIB_CONFIG_H\n#define LIB_CONFIG_H\n#define LIB_K 1\n#endif\n" )
142
+ File.write( 'lib/util.h', "#ifndef UTIL_H\n#define UTIL_H\n#include \"config.h\"\nint util_k(void);\n#endif\n" )
143
+ File.write( 'lib/motor.h', "#ifndef MOTOR_H\n#define MOTOR_H\n#include \"config.h\"\n#include \"hw/config.h\"\n#include \"util.h\"\n" \
144
+ "static inline int motor_peek(void) { return 0; }\nhw_t motor_run(int a);\n#endif\n" )
145
+ File.write( 'test/test_motor.c', "#include \"unity.h\"\n#include \"mock_motor.h\"\nvoid setUp(void) {}\nvoid tearDown(void) {}\n" \
146
+ "void test_run(void) { motor_run_ExpectAndReturn(1, 9); TEST_ASSERT_EQUAL_INT(9, motor_run(1)); }\n" )
147
+ @c.remove_project_yml_option_for_test( :paths, :include )
148
+ @c.merge_project_yml_for_test( { :project => { :use_test_preprocessor => preprocessor }, :paths => { :include => ['src/hw/', 'src/', 'lib/', 'test/stubs'] },
149
+ :cmock => { :treat_inlines => :include } } )
150
+
151
+ output = @c.ceedling_build_exec( "test:all" )
152
+ expect(@c.last_exit_status).to eq(0), output
153
+ expect(output).to match(/PASSED:\s+3/)
154
+ end
155
+ end
156
+ end
157
+
158
+ # Under fallback the copy's #includes are read as written, not resolved by the compiler. The one
159
+ # beside its includer is still written by its absolute path, never the shadowing header's name.
160
+ [:mocks, :all].each do |preprocessor|
161
+ it "writes the copy's #include of a header beside it that an earlier search path shadows by its absolute path under fallback, under :use_test_preprocessor #{preprocessor}" do
162
+ in_project do
163
+ FileUtils.mkdir_p( ['src/hw', 'lib'] )
164
+ File.write( 'src/hw/config.h', "#ifndef HW_CONFIG_H\n#define HW_CONFIG_H\ntypedef int hw_t;\n#endif\n" )
165
+ File.write( 'lib/config.h', "#ifndef LIB_CONFIG_H\n#define LIB_CONFIG_H\n#define LIB_K 1\n#endif\n" )
166
+ File.write( 'lib/motor.h', "#ifndef MOTOR_H\n#define MOTOR_H\n#include \"config.h\"\n" \
167
+ "static inline int motor_peek(void) { return 0; }\nint motor_run(int a);\n#endif\n" )
168
+ File.write( 'test/test_motor.c', "#include \"unity.h\"\n#include \"mock_motor.h\"\nvoid setUp(void) {}\nvoid tearDown(void) {}\n" \
169
+ "void test_run(void) { motor_run_ExpectAndReturn(1, 9); TEST_ASSERT_EQUAL_INT(9, motor_run(1)); }\n" )
170
+ @c.remove_project_yml_option_for_test( :paths, :include )
171
+ @c.merge_project_yml_for_test( { :project => { :use_test_preprocessor => preprocessor }, :paths => { :include => ['src/hw/', 'lib/', 'test/stubs'] },
172
+ :cmock => { :treat_inlines => :include }, :test_build => { :preprocess_force_fallback => true } } )
173
+
174
+ output = @c.ceedling_build_exec( "test:all" )
175
+ expect(@c.last_exit_status).to eq(0), output
176
+ expect(output).to match(/PASSED:\s+3/)
177
+
178
+ copies = Dir.glob( 'build/test/preprocess/files/**/motor.h' ).reject { |path| path.include?( '/directives_only/' ) or path.include?( '/full_expansion/' ) }
179
+ expect(copies.size).to eq(1), copies.inspect
180
+ expect(File.readlines( copies.first ).grep( /config\.h/ )).to eq( ["#include \"#{File.join( File.realpath( '.' ), 'lib/config.h' )}\"\n"] )
181
+ end
182
+ end
183
+ end
184
+ end