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,581 @@
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
+ ## What a Partial Carries Through Real Builds
12
+ ## ==========================================
13
+ ##
14
+ ## A Partial's implementation source carries what the module's code relies on beyond the
15
+ ## selected functions. That is prototypes of functions defined elsewhere, prototypes of
16
+ ## functions the test left out, and the header helpers kept code uses. These builds run
17
+ ## unoptimized, where an inline function's call needs a real external definition to link
18
+ ## against. A call to an undeclared function fails on every compiler, GCC before 14 included,
19
+ ## so a prototype left behind can't pass as a warning.
20
+ ##
21
+
22
+ PARTIALS_CARRY_PREAMBLE = "#include \"unity.h\"\n#include \"ceedling.h\"\n"
23
+
24
+ # An inline function lives in a header that isn't the module's. The module's source declares it
25
+ # `extern inline`, which makes that source's object hold the external definition.
26
+ PARTIALS_CARRY_API_HEADER = <<~C
27
+ #ifndef ENGINE_API_H
28
+ #define ENGINE_API_H
29
+ int engine_get(void);
30
+ inline int engine_get_twice(void)
31
+ {
32
+ return 2 * engine_get();
33
+ }
34
+ #endif
35
+ C
36
+
37
+ PARTIALS_CARRY_PORT_HEADER = <<~C
38
+ #ifndef PORT_H
39
+ #define PORT_H
40
+ static int port_read(void);
41
+ #endif
42
+ C
43
+
44
+ PARTIALS_CARRY_INLINE_SOURCE = <<~C
45
+ #include "engine_api.h"
46
+ #include "port.h"
47
+
48
+ extern inline int engine_get_twice(void);
49
+
50
+ int engine_get(void)
51
+ {
52
+ return port_read() + 1;
53
+ }
54
+ C
55
+
56
+ PARTIALS_CARRY_INLINE_TEST = PARTIALS_CARRY_PREAMBLE + <<~C
57
+ #include TEST_PARTIAL_PUBLIC_MODULE(engine)
58
+ #include MOCK_PARTIAL_PRIVATE_MODULE(port)
59
+ #include "engine_api.h"
60
+
61
+ void setUp(void) {}
62
+ void tearDown(void) {}
63
+
64
+ void test_engine_get_adds_one(void)
65
+ {
66
+ port_read_ExpectAndReturn(41);
67
+ TEST_ASSERT_EQUAL_INT(42, engine_get());
68
+ }
69
+
70
+ void test_engine_get_twice_doubles(void)
71
+ {
72
+ port_read_ExpectAndReturn(20);
73
+ TEST_ASSERT_EQUAL_INT(42, engine_get_twice());
74
+ }
75
+ C
76
+
77
+ # A header helper, a prototype defined elsewhere, a subtracted function the test stubs, and an
78
+ # extern variable the test defines
79
+ PARTIALS_CARRY_HELPER_HEADER = <<~C
80
+ #ifndef BOARD_ENGINE_H
81
+ #define BOARD_ENGINE_H
82
+ extern int board_count;
83
+ int board_tick(void);
84
+ static inline int clamp(int v) { return v > 9 ? 9 : v; }
85
+ int board_engine_get(void);
86
+ int board_engine_poll(void);
87
+ int board_engine_report(void);
88
+ int board_engine_count(void);
89
+ #endif
90
+ C
91
+
92
+ PARTIALS_CARRY_HELPER_SOURCE = <<~C
93
+ #include "board_engine.h"
94
+ int board_engine_get(void) { return clamp(board_tick()); }
95
+ int board_engine_poll(void) { return board_engine_get(); }
96
+ int board_engine_report(void) { return board_engine_poll() + 1; }
97
+ int board_engine_count(void) { return board_count + 1; }
98
+ C
99
+
100
+ PARTIALS_CARRY_HELPER_TEST = PARTIALS_CARRY_PREAMBLE + <<~C
101
+ #include TEST_PARTIAL_PUBLIC_MODULE(board_engine)
102
+ TEST_PARTIAL_CONFIG(board_engine, -board_engine_poll)
103
+
104
+ int board_count = 41;
105
+ int board_tick(void) { return 12; }
106
+ int board_engine_poll(void) { return 7; }
107
+
108
+ void setUp(void) {}
109
+ void tearDown(void) {}
110
+
111
+ void test_get_clamps_the_tick(void) { TEST_ASSERT_EQUAL_INT(9, board_engine_get()); }
112
+ void test_report_uses_the_stubbed_poll(void) { TEST_ASSERT_EQUAL_INT(8, board_engine_report()); }
113
+ void test_count_reads_the_extern_variable(void) { TEST_ASSERT_EQUAL_INT(42, board_engine_count()); }
114
+ C
115
+
116
+ # A guardless module header that another header pulls in again, helpers and all
117
+ PARTIALS_CARRY_ONCE_HEADER = <<~C
118
+ #pragma once
119
+ static inline int clamp(int v) { return v > 9 ? 9 : v; }
120
+ int once_get(int v);
121
+ C
122
+
123
+ PARTIALS_CARRY_ONCE_CONFIG = <<~C
124
+ #ifndef ONCE_CFG_H
125
+ #define ONCE_CFG_H
126
+ #include "once.h"
127
+ #define ONCE_BIAS 0
128
+ #endif
129
+ C
130
+
131
+ PARTIALS_CARRY_ONCE_SOURCE = <<~C
132
+ #include "once.h"
133
+ #include "once_cfg.h"
134
+ int once_get(int v) { return clamp(v) + ONCE_BIAS; }
135
+ C
136
+
137
+ PARTIALS_CARRY_ONCE_TEST = PARTIALS_CARRY_PREAMBLE + <<~C
138
+ #include TEST_PARTIAL_PUBLIC_MODULE(once)
139
+ void setUp(void) {}
140
+ void tearDown(void) {}
141
+ void test_get(void) { TEST_ASSERT_EQUAL_INT(9, once_get(42)); }
142
+ C
143
+
144
+ # A header-only module whose prototype uses the header's own type, and the module that calls it
145
+ PARTIALS_CARRY_GPIO_HEADER = <<~C
146
+ #ifndef GPIO_H
147
+ #define GPIO_H
148
+ #include <stdint.h>
149
+ typedef enum { GPIO_IN, GPIO_OUT } gpio_dir_t;
150
+ void gpio_set(uint32_t pin, gpio_dir_t dir);
151
+ #endif
152
+ C
153
+
154
+ PARTIALS_CARRY_BLINK_SOURCE = <<~C
155
+ #include "blink.h"
156
+ #include "gpio.h"
157
+ int blink_on(void) { gpio_set(13, GPIO_OUT); return 1; }
158
+ C
159
+
160
+ PARTIALS_CARRY_BLINK_TEST = PARTIALS_CARRY_PREAMBLE + <<~C
161
+ #include TEST_PARTIAL_PUBLIC_MODULE(blink)
162
+ #include MOCK_PARTIAL_PUBLIC_MODULE(gpio)
163
+ void setUp(void) {}
164
+ void tearDown(void) {}
165
+ void test_on_sets_the_pin_out(void)
166
+ {
167
+ gpio_set_Expect(13, GPIO_OUT);
168
+ TEST_ASSERT_EQUAL_INT(1, blink_on());
169
+ }
170
+ C
171
+
172
+ # A dependency named by its directory, whose real inline body fails any test it runs in
173
+ PARTIALS_CARRY_HW_PORT_HEADER = <<~C
174
+ #ifndef PORT_H
175
+ #define PORT_H
176
+ static inline int port_read(void) { return -1000; }
177
+ #endif
178
+ C
179
+
180
+ PARTIALS_CARRY_HW_ENGINE_SOURCE = <<~C
181
+ #include "engine.h"
182
+ #include "port.h"
183
+ int engine_get(void) { return port_read() + 1; }
184
+ C
185
+
186
+ PARTIALS_CARRY_HW_ENGINE_TEST = PARTIALS_CARRY_PREAMBLE + <<~C
187
+ #include TEST_PARTIAL_PUBLIC_MODULE(engine)
188
+ #include MOCK_PARTIAL_PRIVATE_MODULE_AT(hw, port)
189
+ void setUp(void) {}
190
+ void tearDown(void) {}
191
+ void test_get_adds_one(void)
192
+ {
193
+ port_read_ExpectAndReturn(41);
194
+ TEST_ASSERT_EQUAL_INT(42, engine_get());
195
+ }
196
+ C
197
+
198
+ # A module tested and mocked in one test whose source never includes its own header
199
+ PARTIALS_CARRY_VALVE_SOURCE = <<~C
200
+ static int valve_base(void) { return -1000; }
201
+ int valve_open(void) { return valve_base() + 1; }
202
+ C
203
+
204
+ PARTIALS_CARRY_VALVE_TEST = PARTIALS_CARRY_PREAMBLE + <<~C
205
+ #include TEST_PARTIAL_PUBLIC_MODULE(valve)
206
+ #include MOCK_PARTIAL_PRIVATE_MODULE(valve)
207
+ void setUp(void) {}
208
+ void tearDown(void) {}
209
+ void test_open_adds_one(void)
210
+ {
211
+ valve_base_ExpectAndReturn(41);
212
+ TEST_ASSERT_EQUAL_INT(42, valve_open());
213
+ }
214
+ C
215
+
216
+ # A header-only module whose functions its user's port defines, as #1417's project does. The
217
+ # helper stays real, and the port's function is mocked.
218
+ PARTIALS_CARRY_SENSOR_INTERFACE_HEADER = <<~C
219
+ #ifndef SENSOR_INTERFACE_H
220
+ #define SENSOR_INTERFACE_H
221
+ #define SENSOR_SCALE 2
222
+ typedef struct { int raw; } sensor_reading_t;
223
+ static const int sensor_table[] = { 1, 2 };
224
+ static inline int sensor_twice(int x) { return SENSOR_SCALE * x; }
225
+ static sensor_reading_t sensor_inf_read(void);
226
+ #endif
227
+ C
228
+
229
+ PARTIALS_CARRY_SENSOR_MANAGER_SOURCE = <<~C
230
+ #include "sensor_manager.h"
231
+ #include "sensor_interface.h"
232
+ #include SENSOR_INCLUDE_PORT
233
+ int sensor_get(void)
234
+ {
235
+ sensor_reading_t reading = sensor_inf_read();
236
+ return sensor_twice(reading.raw) * sensor_table[1];
237
+ }
238
+ C
239
+
240
+ PARTIALS_CARRY_SENSOR_TEST = PARTIALS_CARRY_PREAMBLE + <<~C
241
+ #include TEST_PARTIAL_PUBLIC_MODULE(sensor_manager)
242
+ #include MOCK_PARTIAL_PRIVATE_MODULE(sensor_interface)
243
+ MOCK_PARTIAL_CONFIG(sensor_interface, -sensor_twice)
244
+ void setUp(void) {}
245
+ void tearDown(void) {}
246
+ void test_get_scales_the_reading(void)
247
+ {
248
+ sensor_reading_t reading = { 21 };
249
+ sensor_inf_read_ExpectAndReturn(reading);
250
+ TEST_ASSERT_EQUAL_INT(84, sensor_get());
251
+ }
252
+ C
253
+
254
+ # A mocked module's private helper, which the public mock leaves to its user
255
+ PARTIALS_CARRY_PINS_HEADER = <<~C
256
+ #ifndef PINS_H
257
+ #define PINS_H
258
+ #include <stdint.h>
259
+ static inline uint32_t pins_mask(uint32_t pin) { return 1u << pin; }
260
+ void pins_write(uint32_t mask);
261
+ #endif
262
+ C
263
+
264
+ PARTIALS_CARRY_LED_TEST = PARTIALS_CARRY_PREAMBLE + <<~C
265
+ #include TEST_PARTIAL_PUBLIC_MODULE(led)
266
+ #include MOCK_PARTIAL_PUBLIC_MODULE(pins)
267
+ void setUp(void) {}
268
+ void tearDown(void) {}
269
+ void test_on_writes_the_pin_mask(void)
270
+ {
271
+ pins_write_Expect(8);
272
+ led_on();
273
+ }
274
+ C
275
+
276
+ # A mocked module whose header uses #pragma once, which is not an include guard
277
+ PARTIALS_CARRY_ONCE_PORT_HEADER = <<~C
278
+ #pragma once
279
+ static inline int oport_twice(int x) { return 2 * x; }
280
+ int oport_read(void);
281
+ C
282
+
283
+ PARTIALS_CARRY_ONCE_PORT_TEST = PARTIALS_CARRY_PREAMBLE + <<~C
284
+ #include TEST_PARTIAL_PUBLIC_MODULE(oengine)
285
+ #include MOCK_PARTIAL_PUBLIC_MODULE(oport)
286
+ void setUp(void) {}
287
+ void tearDown(void) {}
288
+ void test_get_reads_the_port(void) { oport_read_ExpectAndReturn(41); TEST_ASSERT_EQUAL_INT(42, oengine_get()); }
289
+ C
290
+
291
+ PARTIALS_CARRY_PORT_TWICE_HEADER = "#ifndef PORT_H\n#define PORT_H\nstatic inline int port_twice(int x) { return 2 * x; }\nint port_read(void);\n#endif\n"
292
+ PARTIALS_CARRY_PORT_READ_SOURCE = "#include \"port.h\"\nint port_read(void) { return 0; }\n"
293
+
294
+ ceedling_system_tests do
295
+ include_context "a fresh ceedling gem project", "partials_carry"
296
+
297
+ before do
298
+ in_project do
299
+ @c.merge_project_yml_for_test( {
300
+ :project => { :use_partials => true },
301
+ :flags => { :test => { :compile => { '*' => ['-Werror=implicit-function-declaration'] } } }
302
+ } )
303
+ end
304
+ end
305
+
306
+ def build_passing(tests)
307
+ output = @c.ceedling_build_exec( "test:all" )
308
+ expect(@c.last_exit_status).to eq(0), output
309
+ expect(output).to match(/PASSED:\s+#{tests}/)
310
+
311
+ return output
312
+ end
313
+
314
+ it "links a test calling an inline function the module defines externally" do
315
+ in_project do
316
+ File.write( 'src/engine_api.h', PARTIALS_CARRY_API_HEADER )
317
+ File.write( 'src/port.h', PARTIALS_CARRY_PORT_HEADER )
318
+ File.write( 'src/engine.c', PARTIALS_CARRY_INLINE_SOURCE )
319
+ File.write( 'test/test_engine.c', PARTIALS_CARRY_INLINE_TEST )
320
+
321
+ build_passing( 2 )
322
+ end
323
+ end
324
+
325
+ it "builds a module whose code relies on a helper, external prototypes and a test stub" do
326
+ in_project do
327
+ File.write( 'src/board_engine.h', PARTIALS_CARRY_HELPER_HEADER )
328
+ File.write( 'src/board_engine.c', PARTIALS_CARRY_HELPER_SOURCE )
329
+ File.write( 'test/test_board_engine.c', PARTIALS_CARRY_HELPER_TEST )
330
+
331
+ build_passing( 3 )
332
+ end
333
+ end
334
+
335
+ it "writes no weak definition and no pragmas when the project file turns both off" do
336
+ in_project do
337
+ @c.merge_project_yml_for_test( { :partials => { :extern_variables => :test, :suppress_redundant_decls => false } } )
338
+ File.write( 'src/board_engine.h', PARTIALS_CARRY_HELPER_HEADER )
339
+ File.write( 'src/board_engine.c', PARTIALS_CARRY_HELPER_SOURCE )
340
+ File.write( 'test/test_board_engine.c', PARTIALS_CARRY_HELPER_TEST )
341
+
342
+ build_passing( 3 )
343
+
344
+ impl = File.read( Dir.glob( 'build/test/partials/**/ceedling_partial_board_engine_impl.c' ).first )
345
+ expect( impl ).to include( 'int board_tick(void);' )
346
+ expect( impl ).not_to include( 'int board_count;' )
347
+ expect( impl ).not_to include( '#pragma GCC diagnostic' )
348
+ end
349
+ end
350
+
351
+ [false, true].each do |fallback|
352
+ it "mocks a header-only module whose prototype uses its own type#{' under fallback preprocessing' if fallback}" do
353
+ in_project do
354
+ @c.merge_project_yml_for_test( { :test_build => { :preprocess_force_fallback => fallback } } )
355
+ File.write( 'src/gpio.h', PARTIALS_CARRY_GPIO_HEADER )
356
+ File.write( 'src/blink.h', "#ifndef BLINK_H\n#define BLINK_H\nint blink_on(void);\n#endif\n" )
357
+ File.write( 'src/blink.c', PARTIALS_CARRY_BLINK_SOURCE )
358
+ File.write( 'test/test_blink.c', PARTIALS_CARRY_BLINK_TEST )
359
+
360
+ build_passing( 1 )
361
+ end
362
+ end
363
+ end
364
+
365
+ it "mocks a dependency named by its directory in place of its real header" do
366
+ in_project do
367
+ FileUtils.mkdir_p( 'src/hw' )
368
+ File.write( 'src/hw/port.h', PARTIALS_CARRY_HW_PORT_HEADER )
369
+ File.write( 'src/engine.h', "#ifndef ENGINE_H\n#define ENGINE_H\nint engine_get(void);\n#endif\n" )
370
+ File.write( 'src/engine.c', PARTIALS_CARRY_HW_ENGINE_SOURCE )
371
+ File.write( 'test/test_engine.c', PARTIALS_CARRY_HW_ENGINE_TEST )
372
+
373
+ build_passing( 1 )
374
+ end
375
+ end
376
+
377
+ it "builds a module tested and mocked in one test whose source never includes its own header" do
378
+ in_project do
379
+ File.write( 'src/valve.h', "#ifndef VALVE_H\n#define VALVE_H\nint valve_open(void);\n#endif\n" )
380
+ File.write( 'src/valve.c', PARTIALS_CARRY_VALVE_SOURCE )
381
+ File.write( 'test/test_valve.c', PARTIALS_CARRY_VALVE_TEST )
382
+
383
+ build_passing( 1 )
384
+ end
385
+ end
386
+
387
+ # A mock-only Partial's interface stands in for its real header, so the rest of that header
388
+ # comes along. CMock reads only the interface, so it mocks exactly what the test selected.
389
+ it "mocks a header-only module's port function and keeps its helper, table and types" do
390
+ in_project do
391
+ @c.merge_project_yml_for_test( { :defines => { :test => ['SENSOR_INCLUDE_PORT=<sensor_port_mocked.inc>'] } } )
392
+ FileUtils.mkdir_p( 'test/support' )
393
+ File.write( 'test/support/sensor_port_mocked.inc', '' )
394
+ File.write( 'src/sensor_interface.h', PARTIALS_CARRY_SENSOR_INTERFACE_HEADER )
395
+ File.write( 'src/sensor_manager.h', "#ifndef SENSOR_MANAGER_H\n#define SENSOR_MANAGER_H\nint sensor_get(void);\n#endif\n" )
396
+ File.write( 'src/sensor_manager.c', PARTIALS_CARRY_SENSOR_MANAGER_SOURCE )
397
+ File.write( 'test/test_sensor_manager.c', PARTIALS_CARRY_SENSOR_TEST )
398
+ @c.merge_project_yml_for_test( { :paths => { :support => ['test/support'] } } )
399
+
400
+ build_passing( 1 )
401
+
402
+ mock = File.read( Dir.glob( 'build/test/mocks/**/mock_ceedling_partial_sensor_interface_interface.h' ).first )
403
+ expect( mock ).to include( 'sensor_inf_read_ExpectAndReturn' )
404
+ expect( mock ).not_to include( 'sensor_twice' )
405
+ end
406
+ end
407
+
408
+ it "keeps a mocked module's private helper for the module that uses it" do
409
+ in_project do
410
+ File.write( 'src/pins.h', PARTIALS_CARRY_PINS_HEADER )
411
+ File.write( 'src/led.h', "#ifndef LED_H\n#define LED_H\nvoid led_on(void);\n#endif\n" )
412
+ File.write( 'src/led.c', "#include \"led.h\"\n#include \"pins.h\"\nvoid led_on(void) { pins_write(pins_mask(3)); }\n" )
413
+ File.write( 'test/test_led.c', PARTIALS_CARRY_LED_TEST )
414
+
415
+ build_passing( 1 )
416
+ end
417
+ end
418
+
419
+ it "leaves a mocked #pragma once header's helpers behind with a notice, and still builds" do
420
+ in_project do
421
+ File.write( 'src/oport.h', PARTIALS_CARRY_ONCE_PORT_HEADER )
422
+ File.write( 'src/oengine.h', "#ifndef OENGINE_H\n#define OENGINE_H\nint oengine_get(void);\n#endif\n" )
423
+ File.write( 'src/oengine.c', "#include \"oengine.h\"\n#include \"oport.h\"\nint oengine_get(void) { return oport_read() + 1; }\n" )
424
+ File.write( 'test/test_oengine.c', PARTIALS_CARRY_ONCE_PORT_TEST )
425
+
426
+ output = build_passing( 1 )
427
+ expect( output ).to include( 'Its mock leaves helper `oport_twice()` from src/oport.h behind.' )
428
+ expect( output ).to include( 'src/oport.h uses `#pragma once`, which is not an include guard.' )
429
+ end
430
+ end
431
+
432
+ # The extras stand in for the rest of the real header in every file of the test that
433
+ # includes a mock-only Partial's interface. These are the shapes where they must step aside.
434
+ describe "a mocked header's extras" do
435
+ def port_project(port_h:, port_c:, engine_c:, test:, extra: {})
436
+ File.write( 'src/port.h', port_h )
437
+ File.write( 'src/port.c', port_c )
438
+ File.write( 'src/engine.h', "#ifndef ENGINE_H\n#define ENGINE_H\nint engine_get(void);\n#endif\n" )
439
+ File.write( 'src/engine.c', engine_c )
440
+ extra.each { |path, text| File.write( path, text ) }
441
+ File.write( 'test/test_engine.c', PARTIALS_CARRY_PREAMBLE + test + "void setUp(void) {}\nvoid tearDown(void) {}\n" )
442
+ end
443
+
444
+ # A mock of public functions alone reads only the header, which declares what it subtracts.
445
+ # The test defines its own, through the prototype the extras keep.
446
+ it "subtracts a declared function from a public mock" do
447
+ in_project do
448
+ port_project(
449
+ port_h: "#ifndef PORT_H\n#define PORT_H\nint port_read(void);\nint port_write(int v);\n#endif\n",
450
+ port_c: "#include \"port.h\"\nint port_read(void) { return 0; }\nint port_write(int v) { return v; }\n",
451
+ engine_c: "#include \"engine.h\"\n#include \"port.h\"\nint engine_get(void) { return port_write( port_read() ) + 1; }\n",
452
+ test: "#include TEST_PARTIAL_PUBLIC_MODULE(engine)\n#include MOCK_PARTIAL_PUBLIC_MODULE(port)\nMOCK_PARTIAL_CONFIG(port, -port_write)\n" \
453
+ "int port_write(int v) { return 2 * v; }\n" \
454
+ "void test_get(void) { port_read_ExpectAndReturn(20); TEST_ASSERT_EQUAL_INT(41, engine_get()); }\n"
455
+ )
456
+
457
+ build_passing( 1 )
458
+ end
459
+ end
460
+
461
+ it "steps aside where another header brought in the real one first" do
462
+ in_project do
463
+ port_project(
464
+ port_h: PARTIALS_CARRY_PORT_TWICE_HEADER, port_c: PARTIALS_CARRY_PORT_READ_SOURCE,
465
+ extra: { 'src/board.h' => "#ifndef BOARD_H\n#define BOARD_H\n#include \"port.h\"\n#define BOARD_ID 1\n#endif\n" },
466
+ engine_c: "#include \"engine.h\"\n#include \"board.h\"\n#include \"port.h\"\nint engine_get(void) { return port_twice(port_read()) + BOARD_ID; }\n",
467
+ test: "#include TEST_PARTIAL_PUBLIC_MODULE(engine)\n#include MOCK_PARTIAL_PUBLIC_MODULE(port)\n" \
468
+ "void test_get(void) { port_read_ExpectAndReturn(20); TEST_ASSERT_EQUAL_INT(41, engine_get()); }\n"
469
+ )
470
+
471
+ build_passing( 1 )
472
+ end
473
+ end
474
+
475
+ it "steps aside where the test file includes the real header first" do
476
+ in_project do
477
+ port_project(
478
+ port_h: PARTIALS_CARRY_PORT_TWICE_HEADER, port_c: PARTIALS_CARRY_PORT_READ_SOURCE,
479
+ engine_c: "#include \"engine.h\"\n#include \"port.h\"\nint engine_get(void) { return port_read() + 1; }\n",
480
+ test: "#include \"port.h\"\n#include TEST_PARTIAL_PUBLIC_MODULE(engine)\n#include MOCK_PARTIAL_PUBLIC_MODULE(port)\n" \
481
+ "void test_get(void) { port_read_ExpectAndReturn(41); TEST_ASSERT_EQUAL_INT(42, engine_get()); }\n"
482
+ )
483
+
484
+ build_passing( 1 )
485
+ end
486
+ end
487
+
488
+ it "keeps neither copy of a static fallback preprocessing found twice" do
489
+ in_project do
490
+ @c.merge_project_yml_for_test( { :test_build => { :preprocess_force_fallback => true } } )
491
+ port_project(
492
+ port_h: "#ifndef PORT_H\n#define PORT_H\n#include \"rev.h\"\n#if PORT_REV > 2\nstatic const int port_gain = 1;\n#endif\n" \
493
+ "#if PORT_REV <= 2\nstatic const int port_gain = 2;\n#endif\nint port_read(void);\n#endif\n",
494
+ port_c: PARTIALS_CARRY_PORT_READ_SOURCE, extra: { 'src/rev.h' => "#ifndef REV_H\n#define REV_H\n#define PORT_REV 3\n#endif\n" },
495
+ engine_c: "#include \"engine.h\"\n#include \"port.h\"\nint engine_get(void) { return port_read() + 1; }\n",
496
+ test: "#include TEST_PARTIAL_PUBLIC_MODULE(engine)\n#include MOCK_PARTIAL_PUBLIC_MODULE(port)\n" \
497
+ "void test_get(void) { port_read_ExpectAndReturn(41); TEST_ASSERT_EQUAL_INT(42, engine_get()); }\n"
498
+ )
499
+
500
+ build_passing( 1 )
501
+ end
502
+ end
503
+
504
+ it "leaves behind a table naming a function the mock leaves undefined" do
505
+ in_project do
506
+ port_project(
507
+ port_h: "#ifndef PORT_H\n#define PORT_H\ntypedef int (*port_fn_t)(void);\nint port_a(void);\n" \
508
+ "static inline int port_raw(void) { return 0; }\nstatic const port_fn_t port_handlers[] = { port_a };\n#endif\n",
509
+ port_c: "#include \"port.h\"\nint port_a(void) { return 5; }\n",
510
+ engine_c: "#include \"engine.h\"\n#include \"port.h\"\nint engine_get(void) { return port_raw() + 1; }\n",
511
+ test: "#include TEST_PARTIAL_PUBLIC_MODULE(engine)\n#include MOCK_PARTIAL_PRIVATE_MODULE(port)\n" \
512
+ "void test_get(void) { port_raw_ExpectAndReturn(41); TEST_ASSERT_EQUAL_INT(42, engine_get()); }\n"
513
+ )
514
+
515
+ build_passing( 1 )
516
+ end
517
+ end
518
+
519
+ it "declares an extern the way the header does, not the way the source sizes it" do
520
+ in_project do
521
+ port_project(
522
+ port_h: "#ifndef PORT_H\n#define PORT_H\nextern int port_buf[];\nint port_read(void);\n#endif\n",
523
+ port_c: "#include \"port.h\"\n#define PORT_BUF_LEN 4\nint port_buf[PORT_BUF_LEN];\nint port_read(void) { return port_buf[0]; }\n",
524
+ engine_c: "#include \"engine.h\"\n#include \"port.h\"\nint engine_get(void) { return port_read() + 1; }\n",
525
+ test: "#include TEST_PARTIAL_PUBLIC_MODULE(engine)\n#include MOCK_PARTIAL_ALL_MODULE(port)\n" \
526
+ "void test_get(void) { port_read_ExpectAndReturn(41); TEST_ASSERT_EQUAL_INT(42, engine_get()); }\n"
527
+ )
528
+
529
+ build_passing( 1 )
530
+ end
531
+ end
532
+
533
+ it "leaves behind a prototype a function-like macro of its name rewrites" do
534
+ in_project do
535
+ port_project(
536
+ port_h: "#ifndef PORT_H\n#define PORT_H\nvoid *port_alloc(unsigned n);\n#define port_alloc(n) port_alloc_dbg((n), __LINE__)\n" \
537
+ "void *port_alloc_dbg(unsigned n, int line);\nstatic inline int port_raw(void) { return 0; }\n#endif\n",
538
+ port_c: "#include \"port.h\"\n#undef port_alloc\nvoid *port_alloc(unsigned n) { (void)n; return 0; }\n" \
539
+ "void *port_alloc_dbg(unsigned n, int line) { (void)n; (void)line; return 0; }\n",
540
+ engine_c: "#include \"engine.h\"\n#include \"port.h\"\nint engine_get(void) { return port_raw() + 1; }\n",
541
+ test: "#include TEST_PARTIAL_PUBLIC_MODULE(engine)\n#include MOCK_PARTIAL_PRIVATE_MODULE(port)\n" \
542
+ "void test_get(void) { port_raw_ExpectAndReturn(41); TEST_ASSERT_EQUAL_INT(42, engine_get()); }\n"
543
+ )
544
+
545
+ build_passing( 1 )
546
+ end
547
+ end
548
+
549
+ # A module tested and mocked in one test keeps its header's content in its own implementation
550
+ it "explains what another Partial goes without from a module the test both tests and mocks" do
551
+ in_project do
552
+ port_project(
553
+ port_h: "#ifndef PORT_H\n#define PORT_H\nstatic inline int port_twice(int x) { return 2 * x; }\nstatic const int port_k = 1;\n" \
554
+ "int port_read(void);\nint port_scaled(void);\n#endif\n",
555
+ port_c: "#include \"port.h\"\nint port_read(void) { return 0; }\nint port_scaled(void) { return port_twice(port_read()); }\n",
556
+ engine_c: "#include \"engine.h\"\n#include \"port.h\"\nint engine_get(void) { return port_twice(port_read()) + port_k; }\n",
557
+ test: "#include TEST_PARTIAL_PUBLIC_MODULE(engine)\n#include TEST_PARTIAL_MODULE(port)\nTEST_PARTIAL_CONFIG(port, port_scaled)\n" \
558
+ "#include MOCK_PARTIAL_MODULE(port)\nMOCK_PARTIAL_CONFIG(port, port_read)\n" \
559
+ "void test_get(void) { port_read_ExpectAndReturn(20); TEST_ASSERT_EQUAL_INT(41, engine_get()); }\n"
560
+ )
561
+
562
+ output = @c.ceedling_build_exec( "test:all" )
563
+ # It names only what engine uses
564
+ expect( output ).to include( "Other Partials in this test include src/port.h's mock, which leaves helper `port_twice()` and variable `port_k` out." )
565
+ end
566
+ end
567
+ end
568
+
569
+ it "leaves a #pragma once header's helpers behind with a notice, and still builds" do
570
+ in_project do
571
+ File.write( 'src/once.h', PARTIALS_CARRY_ONCE_HEADER )
572
+ File.write( 'src/once_cfg.h', PARTIALS_CARRY_ONCE_CONFIG )
573
+ File.write( 'src/once.c', PARTIALS_CARRY_ONCE_SOURCE )
574
+ File.write( 'test/test_once.c', PARTIALS_CARRY_ONCE_TEST )
575
+
576
+ output = build_passing( 1 )
577
+ expect(output).to include( 'Not carrying helper `clamp()` from src/once.h.' )
578
+ expect(output).to include( 'src/once.h uses `#pragma once`, which is not an include guard.' )
579
+ end
580
+ end
581
+ end