ceedling 1.2.1 → 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 (545) hide show
  1. checksums.yaml +4 -4
  2. data/GIT_COMMIT_SHA +1 -1
  3. data/README.md +11 -9
  4. data/Rakefile +2 -1
  5. data/assets/features/ceedling +1 -1
  6. data/assets/fixtures/test_source_file_duplicate_basenames/test_calc_typo.c +14 -0
  7. data/assets/fixtures/tests_with_duplicate_test_names/test_foo.c +21 -0
  8. data/assets/fixtures/tests_with_partials_coverage/src/private_macro.c +7 -0
  9. data/assets/fixtures/tests_with_partials_coverage/src/private_macro.h +5 -0
  10. data/assets/fixtures/tests_with_partials_coverage/src/tally.c +13 -0
  11. data/assets/fixtures/tests_with_partials_coverage/src/tally.h +4 -0
  12. data/assets/fixtures/tests_with_partials_coverage/test/test_private_macro.c +10 -0
  13. data/assets/fixtures/tests_with_partials_coverage/test/test_tally.c +9 -0
  14. data/bin/actionator.rb +6 -12
  15. data/bin/app_cfg.rb +14 -1
  16. data/bin/ceedling +13 -3
  17. data/bin/cli.rb +25 -6
  18. data/bin/cli_handler.rb +113 -73
  19. data/bin/cli_helper.rb +51 -78
  20. data/bin/installation_selector.rb +81 -0
  21. data/bin/launchinator.rb +69 -0
  22. data/bin/mixin_resolvinator.rb +26 -36
  23. data/bin/objects.yml +13 -0
  24. data/bin/path_validator.rb +25 -29
  25. data/bin/versionator.rb +47 -48
  26. data/ceedling.gemspec +19 -15
  27. data/docs/BreakingChanges.md +86 -1
  28. data/docs/Changelog.md +145 -3
  29. data/docs/KnownIssues.md +179 -6
  30. data/docs/ReleaseNotes.md +13 -0
  31. data/examples/wondrous_forest/README.md +29 -1
  32. data/examples/wondrous_forest/src/ForestUnits.h +23 -0
  33. data/examples/wondrous_forest/src/RainGauge.c +59 -0
  34. data/examples/wondrous_forest/src/RainGauge.h +39 -0
  35. data/examples/wondrous_forest/src/RainTipIsr.c +17 -0
  36. data/examples/wondrous_forest/src/RainTipIsr.h +14 -0
  37. data/examples/wondrous_forest/test/TestRainGauge.c +126 -0
  38. data/lib/ceedling/build_log_writer.rb +33 -0
  39. data/lib/ceedling/c_extractor/README.md +15 -7
  40. data/lib/ceedling/c_extractor/c_extractor.rb +25 -14
  41. data/lib/ceedling/c_extractor/c_extractor_code_text.rb +84 -54
  42. data/lib/ceedling/c_extractor/c_extractor_constants.rb +18 -7
  43. data/lib/ceedling/c_extractor/c_extractor_declarations.rb +319 -283
  44. data/lib/ceedling/c_extractor/c_extractor_declarator.rb +285 -0
  45. data/lib/ceedling/c_extractor/c_extractor_defined_type.rb +111 -0
  46. data/lib/ceedling/c_extractor/c_extractor_definitions.rb +174 -121
  47. data/lib/ceedling/c_extractor/c_extractor_functions.rb +191 -162
  48. data/lib/ceedling/c_extractor/c_extractor_preprocessing.rb +46 -55
  49. data/lib/ceedling/c_extractor/c_extractor_statement.rb +30 -0
  50. data/lib/ceedling/c_extractor/c_extractor_types.rb +63 -41
  51. data/lib/ceedling/c_extractor/c_module_edits.rb +48 -0
  52. data/lib/ceedling/c_identifier.rb +21 -0
  53. data/lib/ceedling/ceedling.h +8 -0
  54. data/lib/ceedling/config/build_root_policy.rb +70 -0
  55. data/lib/ceedling/config/configurator.rb +18 -19
  56. data/lib/ceedling/config/configurator_builder.rb +75 -28
  57. data/lib/ceedling/config/configurator_paths_validator.rb +179 -0
  58. data/lib/ceedling/config/configurator_plugins.rb +1 -1
  59. data/lib/ceedling/config/configurator_setup.rb +44 -33
  60. data/lib/ceedling/config/configurator_validator.rb +1 -110
  61. data/lib/ceedling/constants.rb +5 -1
  62. data/lib/ceedling/defaults.rb +35 -5
  63. data/lib/ceedling/dependencies/CACHE_SCHEMA.md +118 -0
  64. data/lib/ceedling/dependencies/README.md +18 -16
  65. data/lib/ceedling/dependencies/dependency_cache_store.rb +43 -21
  66. data/lib/ceedling/dependencies/dependency_hasher.rb +35 -1
  67. data/lib/ceedling/dependencies/dependency_tracker.rb +9 -3
  68. data/lib/ceedling/dependencies/dependinator.rb +13 -1
  69. data/lib/ceedling/diagnostics/DOCTOR.md +142 -0
  70. data/lib/ceedling/diagnostics/README.md +5 -0
  71. data/lib/ceedling/diagnostics/build_step_doctor.rb +110 -0
  72. data/lib/ceedling/diagnostics/duplicate_symbol_specialist.rb +108 -0
  73. data/lib/ceedling/diagnostics/guidance_phrases.rb +30 -0
  74. data/lib/ceedling/diagnostics/header_collision_guidance.rb +56 -0
  75. data/lib/ceedling/diagnostics/header_collision_specialist.rb +152 -0
  76. data/lib/ceedling/diagnostics/include_depth_specialist.rb +132 -0
  77. data/lib/ceedling/diagnostics/missing_symbol_specialist.rb +111 -0
  78. data/lib/ceedling/diagnostics/partial_name_specialist.rb +134 -0
  79. data/lib/ceedling/diagnostics/toolchain_output.rb +44 -0
  80. data/lib/ceedling/filename_extension.rb +7 -1
  81. data/lib/ceedling/filesystem/FILE_TREE.md +253 -0
  82. data/lib/ceedling/filesystem/PATH_HANDLING.md +360 -0
  83. data/lib/ceedling/filesystem/README.md +46 -0
  84. data/lib/ceedling/filesystem/build_roots.rb +105 -0
  85. data/lib/ceedling/filesystem/build_subpath.rb +187 -0
  86. data/lib/ceedling/filesystem/destination_collision.rb +25 -0
  87. data/lib/ceedling/{file_finder.rb → filesystem/file_finder.rb} +177 -156
  88. data/lib/ceedling/filesystem/file_finder_helper.rb +154 -0
  89. data/lib/ceedling/filesystem/file_path_collection_utils.rb +183 -0
  90. data/lib/ceedling/{file_path_utils.rb → filesystem/file_path_utils.rb} +200 -167
  91. data/lib/ceedling/{file_system_wrapper.rb → filesystem/file_system_wrapper.rb} +6 -5
  92. data/lib/ceedling/filesystem/file_tree.rb +241 -0
  93. data/lib/ceedling/{file_wrapper.rb → filesystem/file_wrapper.rb} +149 -65
  94. data/lib/ceedling/filesystem/path_exclusions.rb +30 -0
  95. data/lib/ceedling/{path_matcher.rb → filesystem/path_matcher.rb} +48 -23
  96. data/lib/ceedling/{path_mirror.rb → filesystem/path_mirror.rb} +19 -18
  97. data/lib/ceedling/filesystem/path_spellings.rb +55 -0
  98. data/lib/ceedling/filesystem/project_paths.rb +184 -0
  99. data/lib/ceedling/filesystem/test_build_layout.rb +114 -0
  100. data/lib/ceedling/filesystem/win_long_paths.rb +153 -0
  101. data/lib/ceedling/filesystem/win_path_limit.rb +83 -0
  102. data/lib/ceedling/filesystem/win_path_prober.rb +52 -0
  103. data/lib/ceedling/filesystem/working_dir.rb +40 -0
  104. data/lib/ceedling/generators/generator.rb +32 -70
  105. data/lib/ceedling/generators/generator_helper.rb +0 -44
  106. data/lib/ceedling/generators/generator_mocks.rb +5 -0
  107. data/lib/ceedling/generators/generator_partials.rb +306 -244
  108. data/lib/ceedling/generators/generator_test_results_backtrace.rb +7 -7
  109. data/lib/ceedling/generators/generator_test_runner.rb +5 -8
  110. data/lib/ceedling/generators/partial_header_writer.rb +95 -0
  111. data/lib/ceedling/generators/partial_source_writer.rb +137 -0
  112. data/lib/ceedling/handoff.rb +121 -0
  113. data/lib/ceedling/includes/header_search.rb +225 -0
  114. data/lib/ceedling/includes/include_factory.rb +9 -12
  115. data/lib/ceedling/includes/include_pathinator.rb +112 -33
  116. data/lib/ceedling/includes/includes.rb +150 -38
  117. data/lib/ceedling/installation.rb +92 -0
  118. data/lib/ceedling/library_resolver.rb +99 -0
  119. data/lib/ceedling/objects.yml +112 -6
  120. data/lib/ceedling/partials/README.md +110 -16
  121. data/lib/ceedling/partials/carry_plan.rb +71 -0
  122. data/lib/ceedling/partials/definition_head.rb +74 -0
  123. data/lib/ceedling/partials/include_groups.rb +37 -0
  124. data/lib/ceedling/partials/interface_extras.rb +25 -0
  125. data/lib/ceedling/partials/partializer.rb +603 -124
  126. data/lib/ceedling/partials/partializer_config.rb +8 -1
  127. data/lib/ceedling/partials/partializer_helper.rb +851 -145
  128. data/lib/ceedling/partials/partializer_reconciler.rb +174 -0
  129. data/lib/ceedling/partials/partializer_utils.rb +89 -109
  130. data/lib/ceedling/partials/partials.rb +153 -10
  131. data/lib/ceedling/partials/type_macros.rb +126 -0
  132. data/lib/ceedling/plugins/report_log_writer_plugin.rb +3 -5
  133. data/lib/ceedling/preprocess/README.md +43 -33
  134. data/lib/ceedling/preprocess/preprocessinator.rb +100 -186
  135. data/lib/ceedling/preprocess/preprocessinator_code_finder.rb +65 -72
  136. data/lib/ceedling/preprocess/preprocessinator_file_assembler.rb +32 -76
  137. data/lib/ceedling/preprocess/preprocessinator_includes_handler.rb +1 -1
  138. data/lib/ceedling/preprocess/preprocessinator_line_marker_includes_extractor.rb +1 -1
  139. data/lib/ceedling/preprocess/preprocessinator_reconstructor.rb +51 -14
  140. data/lib/ceedling/rake_app/rakefile_component_resolver.rb +10 -17
  141. data/lib/ceedling/rakefile.rb +15 -1
  142. data/lib/ceedling/rakefiles/base/tasks_base.rake +1 -1
  143. data/lib/ceedling/rakefiles/release/rules_release.rake +4 -7
  144. data/lib/ceedling/release_invoker/release_build_executor.rb +33 -44
  145. data/lib/ceedling/release_invoker/release_build_planner.rb +14 -6
  146. data/lib/ceedling/reportinator.rb +3 -4
  147. data/lib/ceedling/setupinator.rb +104 -87
  148. data/lib/ceedling/test_context_extractor.rb +5 -1
  149. data/lib/ceedling/test_invoker/HEADER_COLLISIONS.md +21 -7
  150. data/lib/ceedling/test_invoker/PIPELINE.md +62 -19
  151. data/lib/ceedling/test_invoker/README.md +1 -1
  152. data/lib/ceedling/test_invoker/derived_search_path_notices.rb +45 -0
  153. data/lib/ceedling/test_invoker/mock_locator.rb +175 -10
  154. data/lib/ceedling/test_invoker/partial_files_preprocessinator.rb +181 -0
  155. data/lib/ceedling/test_invoker/partials_manager.rb +271 -302
  156. data/lib/ceedling/test_invoker/standin_headerinator.rb +19 -17
  157. data/lib/ceedling/test_invoker/test_bare_includes_extractinator.rb +26 -3
  158. data/lib/ceedling/test_invoker/test_build_executor.rb +358 -234
  159. data/lib/ceedling/test_invoker/test_build_planner.rb +46 -33
  160. data/lib/ceedling/test_invoker/test_build_setup.rb +43 -18
  161. data/lib/ceedling/test_invoker/test_build_validations.rb +35 -47
  162. data/lib/ceedling/test_invoker/test_derived_search_paths.rb +189 -0
  163. data/lib/ceedling/test_invoker/test_file_preprocessinator.rb +2 -3
  164. data/lib/ceedling/test_invoker/test_includes_reconcilinator.rb +1 -1
  165. data/lib/ceedling/test_invoker/test_invoker.rb +6 -1
  166. data/lib/ceedling/test_invoker/test_invoker_types.rb +28 -20
  167. data/lib/ceedling/test_invoker/test_pipeline_helpers.rb +6 -4
  168. data/lib/ceedling/test_invoker/test_pipeline_manager.rb +25 -8
  169. data/lib/ceedling/test_invoker/test_runner_generatinator.rb +31 -3
  170. data/lib/ceedling/test_invoker/test_search_paths.rb +30 -8
  171. data/lib/ceedling/test_invoker/test_source_file_directive_resolver.rb +40 -20
  172. data/lib/ceedling/test_invoker/test_substitutions.rb +72 -0
  173. data/lib/ceedling/tools/shell_quoting.rb +45 -0
  174. data/lib/ceedling/{tool_executor.rb → tools/tool_executor.rb} +9 -3
  175. data/lib/ceedling/tools/tool_quoting.rb +79 -0
  176. data/lib/ceedling/{tool_validator.rb → tools/tool_validator.rb} +18 -7
  177. data/lib/ceedling/yaml_wrapper.rb +3 -2
  178. data/lib/version.rb +1 -1
  179. data/plugins/bullseye/bullseye.rake +1 -3
  180. data/plugins/bullseye/config/defaults_bullseye.rb +1 -1
  181. data/plugins/bullseye/lib/bullseye.rb +24 -9
  182. data/plugins/command_hooks/lib/command_hooks.rb +1 -1
  183. data/plugins/cppcheck/config/defaults_cppcheck.rb +1 -1
  184. data/plugins/dependencies/config/defaults.yml +6 -6
  185. data/plugins/dependencies/dependencies.rake +4 -1
  186. data/plugins/dependencies/lib/dependencies.rb +18 -8
  187. data/plugins/dependencies/lib/dependency_spec.rb +17 -5
  188. data/plugins/fff/lib/fff.rb +79 -46
  189. data/plugins/fff/lib/fff_mock_generator.rb +12 -9
  190. data/plugins/fff/spec/fff_cmock_wrapper_spec.rb +262 -0
  191. data/plugins/fff/spec/fff_mock_header_generator_spec.rb +9 -0
  192. data/plugins/fff/spec/fff_mock_source_generator_spec.rb +20 -0
  193. data/plugins/gcov/config/defaults_gcov.rb +1 -1
  194. data/plugins/gcov/lib/console_reportinator.rb +28 -36
  195. data/plugins/gcov/lib/gcov.rb +9 -2
  196. data/plugins/gcov/lib/gcovr_reportinator.rb +8 -40
  197. data/plugins/gcov/lib/gcovr_thresholds.rb +74 -0
  198. data/plugins/gcov/lib/reportgenerator_reportinator.rb +3 -2
  199. data/plugins/module_generator/lib/module_generator.rb +3 -3
  200. data/plugins/report_tests_teamcity_stdout/lib/report_tests_teamcity_stdout.rb +53 -80
  201. data/plugins/sanitize/lib/sanitize_records.rb +3 -6
  202. data/plugins/valgrind/lib/valgrind.rb +14 -7
  203. data/site-local/404.html +2 -2
  204. data/site-local/assets/javascripts/{bundle.c21346df.min.js → bundle.a5f9d56c.min.js} +1 -1
  205. data/site-local/assets/javascripts/{bundle.c21346df.min.js.map → bundle.a5f9d56c.min.js.map} +2 -2
  206. data/site-local/configuration/environment-vars.html +2 -2
  207. data/site-local/configuration/global-collections.html +3 -3
  208. data/site-local/configuration/index.html +2 -2
  209. data/site-local/configuration/loading.html +2 -2
  210. data/site-local/configuration/mixins.html +2 -2
  211. data/site-local/configuration/parallel-builds.html +2 -2
  212. data/site-local/configuration/project-file.html +2 -2
  213. data/site-local/configuration/reference/cexception.html +2 -2
  214. data/site-local/configuration/reference/cmock.html +7 -3
  215. data/site-local/configuration/reference/defines.html +2 -2
  216. data/site-local/configuration/reference/environment.html +2 -2
  217. data/site-local/configuration/reference/extension.html +2 -2
  218. data/site-local/configuration/reference/files.html +65 -12
  219. data/site-local/configuration/reference/flags.html +2 -2
  220. data/site-local/configuration/reference/index.html +2 -2
  221. data/site-local/configuration/reference/libraries.html +23 -5
  222. data/site-local/configuration/reference/mixins.html +2 -2
  223. data/site-local/configuration/reference/partials.html +84 -2
  224. data/site-local/configuration/reference/paths.html +36 -8
  225. data/site-local/configuration/reference/plugins.html +2 -2
  226. data/site-local/configuration/reference/project.html +264 -12
  227. data/site-local/configuration/reference/release-build.html +4 -2
  228. data/site-local/configuration/reference/test-build.html +2 -2
  229. data/site-local/configuration/reference/test-runner.html +2 -2
  230. data/site-local/configuration/reference/tools.html +58 -4
  231. data/site-local/configuration/reference/unity.html +2 -2
  232. data/site-local/configuration/which-ceedling.html +379 -19
  233. data/site-local/development/index.html +2 -2
  234. data/site-local/development/plugins/configuration.html +2 -2
  235. data/site-local/development/plugins/index.html +2 -2
  236. data/site-local/development/plugins/plugin-subclass.html +5 -4
  237. data/site-local/development/plugins/rake-tasks.html +2 -2
  238. data/site-local/development/releases.html +7 -3
  239. data/site-local/development/workflow.html +50 -45
  240. data/site-local/getting-started/builds.html +4 -2
  241. data/site-local/getting-started/command-line.html +58 -6
  242. data/site-local/getting-started/example-projects/cipher-quest.html +2 -2
  243. data/site-local/getting-started/example-projects/index.html +2 -2
  244. data/site-local/getting-started/example-projects/temp-sensor.html +2 -2
  245. data/site-local/getting-started/example-projects/wondrous-forest.html +10 -2
  246. data/site-local/getting-started/index.html +2 -2
  247. data/site-local/getting-started/installation.html +2 -2
  248. data/site-local/getting-started/quick-start.html +2 -2
  249. data/site-local/help.html +2 -2
  250. data/site-local/index.html +2 -2
  251. data/site-local/overview/build-system.html +2 -2
  252. data/site-local/overview/index.html +2 -2
  253. data/site-local/overview/test-environments.html +2 -2
  254. data/site-local/overview/tools-and-frameworks.html +2 -2
  255. data/site-local/plugins/beep.html +2 -2
  256. data/site-local/plugins/bullseye/index.html +45 -38
  257. data/site-local/plugins/bullseye/licensing.html +2 -2
  258. data/site-local/plugins/command-hooks.html +4 -4
  259. data/site-local/plugins/compile-commands-json-db.html +2 -2
  260. data/site-local/plugins/cppcheck.html +2 -2
  261. data/site-local/plugins/dependencies.html +8 -5
  262. data/site-local/plugins/fff.html +58 -13
  263. data/site-local/plugins/gcov/examples.html +2 -2
  264. data/site-local/plugins/gcov/gcovr.html +23 -14
  265. data/site-local/plugins/gcov/index.html +2 -2
  266. data/site-local/plugins/gcov/overview.html +2 -2
  267. data/site-local/plugins/gcov/reportgenerator.html +18 -14
  268. data/site-local/plugins/gcov/reporting.html +2 -2
  269. data/site-local/plugins/gcov/setup.html +4 -3
  270. data/site-local/plugins/gcov/tool-versions.html +2 -2
  271. data/site-local/plugins/gcov/troubleshooting.html +2 -2
  272. data/site-local/plugins/index.html +2 -2
  273. data/site-local/plugins/module-generator.html +2 -2
  274. data/site-local/plugins/report-build-warnings-log.html +2 -2
  275. data/site-local/plugins/report-tests-gtestlike-stdout.html +2 -2
  276. data/site-local/plugins/report-tests-ide-stdout.html +2 -2
  277. data/site-local/plugins/report-tests-log-factory.html +2 -2
  278. data/site-local/plugins/report-tests-pretty-stdout.html +2 -2
  279. data/site-local/plugins/report-tests-raw-output-log.html +5 -3
  280. data/site-local/plugins/report-tests-teamcity-stdout.html +8 -5
  281. data/site-local/plugins/sanitize.html +9 -8
  282. data/site-local/plugins/valgrind.html +10 -9
  283. data/site-local/project/index.html +2 -2
  284. data/site-local/project/release-history.html +2 -2
  285. data/site-local/project/sbom.html +2 -2
  286. data/site-local/project/upgrade.html +5 -2
  287. data/site-local/reference/build-directives.html +2 -2
  288. data/site-local/reference/command-line.html +11 -4
  289. data/site-local/reference/environment-vars.html +2 -2
  290. data/site-local/reference/gcov-plugin.html +2 -2
  291. data/site-local/reference/global-collections.html +12 -12
  292. data/site-local/reference/index.html +2 -2
  293. data/site-local/reference/partials-macros.html +47 -2
  294. data/site-local/reference/project-configuration.html +2 -2
  295. data/site-local/sitemap.xml.gz +0 -0
  296. data/site-local/snapshot/examples/cipher_quest/index.html +2 -2
  297. data/site-local/snapshot/examples/temp_sensor/index.html +2 -2
  298. data/site-local/snapshot/examples/wondrous_forest/index.html +72 -15
  299. data/site-local/snapshot/plugins/bullseye/config/defaults_bullseye.rb +1 -1
  300. data/site-local/snapshot/plugins/gcov/config/defaults_gcov.rb +1 -1
  301. data/site-local/testing-guide/build-directives.html +2 -2
  302. data/site-local/testing-guide/conventions.html +113 -15
  303. data/site-local/testing-guide/frameworks.html +2 -2
  304. data/site-local/testing-guide/index.html +2 -2
  305. data/site-local/testing-guide/partials/configuration.html +31 -4
  306. data/site-local/testing-guide/partials/conventions.html +509 -8
  307. data/site-local/testing-guide/partials/directives.html +4 -3
  308. data/site-local/testing-guide/partials/example.html +2 -2
  309. data/site-local/testing-guide/partials/index.html +2 -2
  310. data/site-local/testing-guide/partials/overview.html +30 -12
  311. data/site-local/testing-guide/partials/variables.html +169 -4
  312. data/site-local/testing-guide/test-cases.html +2 -2
  313. data/site-local/testing-guide/test-sample.html +2 -2
  314. data/site-local/testing-guide/test-suite-anatomy.html +2 -2
  315. data/spec/integration/actionator_file_operations_spec.rb +91 -1
  316. data/spec/integration/build_step_doctor_spec.rb +270 -0
  317. data/spec/integration/c_extractor_composition_spec.rb +254 -4
  318. data/spec/integration/compile_commands_json_db_spec.rb +1 -1
  319. data/spec/integration/configurator_validation_spec.rb +1 -1
  320. data/spec/integration/dependencies/dependency_tracker_cache_hardening_spec.rb +26 -0
  321. data/spec/integration/dependencies/dependency_tracker_core_spec.rb +22 -0
  322. data/spec/integration/includes_extraction_spec.rb +27 -14
  323. data/spec/integration/launcher_handoff_spec.rb +297 -0
  324. data/spec/integration/mixin_loading_spec.rb +1 -1
  325. data/spec/integration/module_generator_spec.rb +3 -3
  326. data/spec/integration/nested_test_artifacts_spec.rb +99 -0
  327. data/spec/integration/partial_files_preprocessing_spec.rb +128 -0
  328. data/spec/integration/partials_carry_spec.rb +520 -0
  329. data/spec/integration/partials_declarations_spec.rb +655 -0
  330. data/spec/integration/partials_fallback_preprocessing_spec.rb +65 -0
  331. data/spec/integration/partials_function_pointers_spec.rb +277 -0
  332. data/spec/integration/partials_header_composition_spec.rb +268 -35
  333. data/spec/integration/partials_macro_decorators_spec.rb +267 -0
  334. data/spec/integration/partials_module_resolution_spec.rb +33 -23
  335. data/spec/integration/partials_symbol_linkage_spec.rb +13 -0
  336. data/spec/integration/path_intake_scenarios_spec.rb +101 -0
  337. data/spec/integration/path_length_reporting_spec.rb +64 -0
  338. data/spec/integration/path_scenarios_spec.rb +399 -0
  339. data/spec/integration/quote_include_isolator_spec.rb +57 -1
  340. data/spec/integration/report_build_warnings_log_spec.rb +1 -1
  341. data/spec/integration/report_tests_log_factory_spec.rb +1 -1
  342. data/spec/integration/test_build_parallel_barrier_spec.rb +1 -1
  343. data/spec/integration/test_executable_manifest_spec.rb +1 -1
  344. data/spec/integration/test_includes_extractinator_spec.rb +69 -3
  345. data/spec/integration/test_naming_spec.rb +201 -0
  346. data/spec/integration/test_source_file_checks_spec.rb +168 -0
  347. data/spec/integration/tool_executor_spec.rb +1 -1
  348. data/spec/integration/tool_validator_spec.rb +3 -3
  349. data/spec/integration/upgrade_docs_spec.rb +84 -0
  350. data/spec/integration/vendor_copy_transient_io_retry_spec.rb +74 -5
  351. data/spec/integration/win_long_paths_probe_spec.rb +46 -0
  352. data/spec/integration/win_path_limit_spec.rb +53 -0
  353. data/spec/integration/windows_registry_query_tool_spec.rb +41 -0
  354. data/spec/support/file_tree_helper.rb +88 -0
  355. data/spec/support/integration/configurator_integration_helper.rb +14 -9
  356. data/spec/support/integration/dependency_tracker_integration_helper.rb +1 -1
  357. data/spec/support/integration/partial_files_harness.rb +181 -0
  358. data/spec/support/integration/partials_generation_integration_helper.rb +239 -143
  359. data/spec/support/integration/path_scenario_harness.rb +175 -0
  360. data/spec/support/integration/spec_integration_helper.rb +9 -4
  361. data/spec/support/integration/test_includes_harness.rb +69 -37
  362. data/spec/support/integration/tool_executor_integration_helper.rb +14 -2
  363. data/spec/support/spec_helper.rb +2 -0
  364. data/spec/support/system/spec_system_helper.rb +7 -6
  365. data/spec/support/system/system_context.rb +21 -3
  366. data/spec/support/working_dir_tracking.rb +49 -0
  367. data/spec/system/build_output_mirroring_spec.rb +2 -2
  368. data/spec/system/bullseye_deployment_spec.rb +2 -0
  369. data/spec/system/conditional_mock_includes_spec.rb +1 -1
  370. data/spec/system/delta_builds_spec.rb +163 -23
  371. data/spec/system/encoding_stress_spec.rb +4 -4
  372. data/spec/system/example_wondrous_forest_spec.rb +2 -2
  373. data/spec/system/gcov_deployment_spec.rb +3 -0
  374. data/spec/system/header_include_path_validation_spec.rb +4 -4
  375. data/spec/system/header_search_paths_spec.rb +1083 -0
  376. data/spec/system/launcher_handoff_spec.rb +82 -0
  377. data/spec/system/mock_include_folders_spec.rb +212 -0
  378. data/spec/system/mockable_header_reassembly_spec.rb +184 -0
  379. data/spec/system/parent_directory_reference_spec.rb +5 -3
  380. data/spec/system/partials_carry_spec.rb +581 -0
  381. data/spec/system/partials_delta_builds_spec.rb +280 -0
  382. data/spec/system/partials_function_pointers_spec.rb +106 -0
  383. data/spec/system/partials_macro_decorators_spec.rb +127 -0
  384. data/spec/system/partials_module_disambiguation_spec.rb +125 -0
  385. data/spec/system/path_handling_probes_spec.rb +196 -0
  386. data/spec/system/pinned_thread_count_spec.rb +4 -4
  387. data/spec/system/preprocessing_fallback_conditionals_spec.rb +1 -1
  388. data/spec/system/preprocessing_parameterized_tests_spec.rb +1 -1
  389. data/spec/system/rake_release_task_path_disambiguation_spec.rb +6 -6
  390. data/spec/system/rake_test_task_path_disambiguation_spec.rb +85 -0
  391. data/spec/system/short_build_paths_spec.rb +87 -0
  392. data/spec/system/sibling_header_collision_spec.rb +30 -6
  393. data/spec/system/special_path_characters_spec.rb +86 -0
  394. data/spec/system/support/bullseye_common_test_cases.rb +42 -0
  395. data/spec/system/support/common_test_cases.rb +23 -21
  396. data/spec/system/support/gcov_common_test_cases.rb +37 -9
  397. data/spec/system/support/gcov_partials_test_cases.rb +48 -0
  398. data/spec/system/support/sanitize_common_test_cases.rb +2 -2
  399. data/spec/system/support/valgrind_common_test_cases.rb +12 -12
  400. data/spec/system/test_build_layout_spec.rb +209 -0
  401. data/spec/system/test_pipeline_stop_points_spec.rb +4 -4
  402. data/spec/system/test_runner_system_include_spec.rb +1 -1
  403. data/spec/system/test_source_file_directive_spec.rb +64 -5
  404. data/spec/units/bin/actionator_spec.rb +14 -17
  405. data/spec/units/bin/app_cfg_spec.rb +37 -0
  406. data/spec/units/bin/cli_handler_spec.rb +282 -6
  407. data/spec/units/bin/cli_helper_spec.rb +116 -45
  408. data/spec/units/bin/installation_selector_spec.rb +114 -0
  409. data/spec/units/bin/launchinator_spec.rb +171 -0
  410. data/spec/units/bin/path_validator_spec.rb +10 -0
  411. data/spec/units/bin/versionator_spec.rb +38 -6
  412. data/spec/units/build_log_writer_spec.rb +57 -0
  413. data/spec/units/c_extractor/c_extractor_code_text_spec.rb +67 -10
  414. data/spec/units/c_extractor/c_extractor_declarations_spec.rb +501 -4
  415. data/spec/units/c_extractor/c_extractor_declarator_spec.rb +245 -0
  416. data/spec/units/c_extractor/c_extractor_defined_type_spec.rb +45 -0
  417. data/spec/units/c_extractor/c_extractor_definitions_spec.rb +163 -3
  418. data/spec/units/c_extractor/c_extractor_functions_spec.rb +462 -21
  419. data/spec/units/c_extractor/c_extractor_preprocessing_spec.rb +39 -0
  420. data/spec/units/c_extractor/c_extractor_spec.rb +4 -4
  421. data/spec/units/c_extractor/c_extractor_types_spec.rb +163 -0
  422. data/spec/units/c_identifier_spec.rb +35 -0
  423. data/spec/units/config/build_root_policy_spec.rb +61 -0
  424. data/spec/units/config/configurator_builder_spec.rb +61 -6
  425. data/spec/units/config/configurator_paths_validator_spec.rb +292 -0
  426. data/spec/units/config/configurator_setup_spec.rb +80 -68
  427. data/spec/units/config/configurator_spec.rb +54 -6
  428. data/spec/units/config/configurator_validator_spec.rb +1 -172
  429. data/spec/units/dependencies/dependency_cache_store_spec.rb +98 -2
  430. data/spec/units/dependencies/dependency_debug_tree_spec.rb +1 -1
  431. data/spec/units/dependencies/dependency_hasher_spec.rb +42 -1
  432. data/spec/units/dependencies/dependency_path_normalizer_spec.rb +1 -1
  433. data/spec/units/dependencies/dependency_tracker_spec.rb +28 -1
  434. data/spec/units/dependencies/dependinator_spec.rb +17 -2
  435. data/spec/units/diagnostics/build_step_doctor_spec.rb +170 -0
  436. data/spec/units/diagnostics/duplicate_symbol_specialist_spec.rb +117 -0
  437. data/spec/units/diagnostics/header_collision_specialist_spec.rb +267 -0
  438. data/spec/units/diagnostics/include_depth_specialist_spec.rb +137 -0
  439. data/spec/units/diagnostics/missing_symbol_specialist_spec.rb +154 -0
  440. data/spec/units/diagnostics/partial_name_specialist_spec.rb +129 -0
  441. data/spec/units/diagnostics/toolchain_output_spec.rb +86 -0
  442. data/spec/units/encodinator_spec.rb +3 -4
  443. data/spec/units/filename_extension_spec.rb +11 -0
  444. data/spec/units/filesystem/build_roots_spec.rb +131 -0
  445. data/spec/units/filesystem/build_subpath_spec.rb +235 -0
  446. data/spec/units/filesystem/destination_collision_spec.rb +30 -0
  447. data/spec/units/{file_finder_helper_spec.rb → filesystem/file_finder_helper_spec.rb} +126 -1
  448. data/spec/units/filesystem/file_finder_spec.rb +845 -0
  449. data/spec/units/{file_path_collection_utils_spec.rb → filesystem/file_path_collection_utils_spec.rb} +181 -1
  450. data/spec/units/{file_path_utils_spec.rb → filesystem/file_path_utils_spec.rb} +435 -185
  451. data/spec/units/filesystem/file_system_wrapper_spec.rb +33 -0
  452. data/spec/units/filesystem/file_tree_spec.rb +511 -0
  453. data/spec/units/filesystem/file_tree_windows_spec.rb +78 -0
  454. data/spec/units/{file_wrapper_spec.rb → filesystem/file_wrapper_spec.rb} +286 -18
  455. data/spec/units/{path_matcher_spec.rb → filesystem/path_matcher_spec.rb} +48 -1
  456. data/spec/units/{path_mirror_spec.rb → filesystem/path_mirror_spec.rb} +32 -4
  457. data/spec/units/filesystem/project_paths_spec.rb +147 -0
  458. data/spec/units/filesystem/test_build_layout_spec.rb +216 -0
  459. data/spec/units/filesystem/win_long_paths_spec.rb +204 -0
  460. data/spec/units/filesystem/win_path_prober_spec.rb +158 -0
  461. data/spec/units/filesystem/working_dir_spec.rb +71 -0
  462. data/spec/units/generators/generator_helper_spec.rb +0 -60
  463. data/spec/units/generators/generator_mocks_spec.rb +13 -0
  464. data/spec/units/generators/generator_partials_spec.rb +656 -55
  465. data/spec/units/generators/generator_spec.rb +38 -6
  466. data/spec/units/generators/generator_test_results_backtrace_spec.rb +50 -46
  467. data/spec/units/generators/generator_test_results_spec.rb +1 -1
  468. data/spec/units/generators/generator_test_runner_spec.rb +9 -5
  469. data/spec/units/generators/partial_source_writer_spec.rb +129 -0
  470. data/spec/units/handoff_spec.rb +205 -0
  471. data/spec/units/includes/header_search_spec.rb +406 -0
  472. data/spec/units/includes/include_factory_spec.rb +23 -6
  473. data/spec/units/includes/include_pathinator_spec.rb +118 -8
  474. data/spec/units/includes/include_spec.rb +14 -0
  475. data/spec/units/includes/includes_spec.rb +176 -19
  476. data/spec/units/installation_spec.rb +228 -0
  477. data/spec/units/library_resolver_spec.rb +157 -0
  478. data/spec/units/loginator_spec.rb +31 -0
  479. data/spec/units/mock_locator_spec.rb +275 -6
  480. data/spec/units/partials/include_groups_spec.rb +42 -0
  481. data/spec/units/partials/partializer_config_spec.rb +32 -0
  482. data/spec/units/partials/partializer_helper_carry_spec.rb +661 -0
  483. data/spec/units/partials/partializer_helper_interface_extras_spec.rb +396 -0
  484. data/spec/units/partials/partializer_helper_spec.rb +529 -277
  485. data/spec/units/partials/partializer_reconciler_spec.rb +661 -0
  486. data/spec/units/partials/partializer_spec.rb +1579 -270
  487. data/spec/units/partials/partializer_utils_spec.rb +269 -232
  488. data/spec/units/partials/partials_rename_spec.rb +160 -0
  489. data/spec/units/partials_manager_spec.rb +561 -251
  490. data/spec/units/plugins/bullseye_spec.rb +49 -2
  491. data/spec/units/plugins/console_reportinator_spec.rb +73 -26
  492. data/spec/units/plugins/dependencies_spec.rb +33 -7
  493. data/spec/units/plugins/dependency_spec_spec.rb +17 -0
  494. data/spec/units/plugins/gcov_spec.rb +28 -3
  495. data/spec/units/plugins/gcovr_reportinator_spec.rb +19 -47
  496. data/spec/units/plugins/gcovr_thresholds_spec.rb +95 -0
  497. data/spec/units/plugins/module_generator_spec.rb +5 -5
  498. data/spec/units/plugins/report_build_warnings_log_spec.rb +3 -3
  499. data/spec/units/plugins/report_log_writer_plugin_spec.rb +10 -1
  500. data/spec/units/plugins/report_tests_raw_output_log_spec.rb +13 -2
  501. data/spec/units/plugins/report_tests_teamcity_stdout_spec.rb +77 -3
  502. data/spec/units/plugins/reportgenerator_reportinator_spec.rb +52 -4
  503. data/spec/units/plugins/sanitize_records_spec.rb +3 -1
  504. data/spec/units/plugins/sanitize_spec.rb +1 -1
  505. data/spec/units/plugins/valgrind_spec.rb +23 -8
  506. data/spec/units/preprocess/preprocessinator_code_finder_spec.rb +73 -10
  507. data/spec/units/preprocess/preprocessinator_comment_stripper_spec.rb +1 -1
  508. data/spec/units/preprocess/preprocessinator_file_assembler_spec.rb +125 -37
  509. data/spec/units/preprocess/preprocessinator_includes_handler_spec.rb +15 -0
  510. data/spec/units/preprocess/preprocessinator_reconstructor_spec.rb +197 -0
  511. data/spec/units/preprocess/preprocessinator_spec.rb +153 -95
  512. data/spec/units/rake_app/rakefile_component_resolver_spec.rb +21 -0
  513. data/spec/units/release_build_executor_spec.rb +53 -14
  514. data/spec/units/release_build_planner_spec.rb +15 -3
  515. data/spec/units/reportinator_spec.rb +5 -5
  516. data/spec/units/setupinator_spec.rb +51 -0
  517. data/spec/units/standin_headerinator_spec.rb +55 -9
  518. data/spec/units/test_build_executor_spec.rb +842 -166
  519. data/spec/units/test_build_planner_spec.rb +205 -15
  520. data/spec/units/test_build_setup_spec.rb +179 -30
  521. data/spec/units/test_context_extractor_spec.rb +36 -2
  522. data/spec/units/test_derived_search_paths_spec.rb +259 -0
  523. data/spec/units/test_file_preprocessinator_spec.rb +17 -1
  524. data/spec/units/test_includes_extractinator_spec.rb +61 -9
  525. data/spec/units/test_invoker/objects_wiring_spec.rb +24 -4
  526. data/spec/units/test_invoker/partial_files_preprocessinator_spec.rb +264 -0
  527. data/spec/units/test_invoker/test_substitutions_spec.rb +122 -0
  528. data/spec/units/test_invoker_spec.rb +14 -1
  529. data/spec/units/test_invoker_types_spec.rb +8 -7
  530. data/spec/units/test_pipeline_manager_spec.rb +54 -13
  531. data/spec/units/test_runner_generatinator_spec.rb +93 -1
  532. data/spec/units/test_search_paths_spec.rb +73 -5
  533. data/spec/units/test_source_file_directive_resolver_spec.rb +38 -7
  534. data/spec/units/tools/default_tools_quoting_spec.rb +117 -0
  535. data/spec/units/tools/shell_quoting_spec.rb +76 -0
  536. data/spec/units/{tool_executor_helper_spec.rb → tools/tool_executor_helper_spec.rb} +1 -1
  537. data/spec/units/{tool_executor_spec.rb → tools/tool_executor_spec.rb} +27 -1
  538. data/spec/units/{tool_validator_spec.rb → tools/tool_validator_spec.rb} +110 -1
  539. data/spec/units/windows_registry_query_tool_spec.rb +53 -0
  540. data/spec/units/yaml_wrapper_spec.rb +11 -0
  541. metadata +265 -36
  542. data/lib/ceedling/file_finder_helper.rb +0 -127
  543. data/lib/ceedling/file_path_collection_utils.rb +0 -164
  544. data/spec/units/file_finder_spec.rb +0 -495
  545. /data/lib/ceedling/{tool_executor_helper.rb → tools/tool_executor_helper.rb} +0 -0
@@ -21,7 +21,7 @@
21
21
 
22
22
 
23
23
  <link rel="icon" href="../../assets/images/favicon.png">
24
- <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.0">
24
+ <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.2">
25
25
 
26
26
 
27
27
 
@@ -1519,6 +1519,161 @@
1519
1519
  </ul>
1520
1520
  </nav>
1521
1521
 
1522
+ </li>
1523
+
1524
+ <li class="md-nav__item">
1525
+ <a href="#what-a-partial-carries-from-your-module" class="md-nav__link">
1526
+ <span class="md-ellipsis">
1527
+
1528
+ What a Partial Carries From Your Module
1529
+
1530
+ </span>
1531
+ </a>
1532
+
1533
+ <nav class="md-nav" aria-label="What a Partial Carries From Your Module">
1534
+ <ul class="md-nav__list">
1535
+
1536
+ <li class="md-nav__item">
1537
+ <a href="#what-is-carried" class="md-nav__link">
1538
+ <span class="md-ellipsis">
1539
+
1540
+ What is carried
1541
+
1542
+ </span>
1543
+ </a>
1544
+
1545
+ </li>
1546
+
1547
+ <li class="md-nav__item">
1548
+ <a href="#what-is-not-carried" class="md-nav__link">
1549
+ <span class="md-ellipsis">
1550
+
1551
+ What is not carried
1552
+
1553
+ </span>
1554
+ </a>
1555
+
1556
+ </li>
1557
+
1558
+ <li class="md-nav__item">
1559
+ <a href="#inline-functions-with-an-external-definition" class="md-nav__link">
1560
+ <span class="md-ellipsis">
1561
+
1562
+ Inline functions with an external definition
1563
+
1564
+ </span>
1565
+ </a>
1566
+
1567
+ </li>
1568
+
1569
+ <li class="md-nav__item">
1570
+ <a href="#a-module-header-without-an-include-guard" class="md-nav__link">
1571
+ <span class="md-ellipsis">
1572
+
1573
+ A module header without an include guard
1574
+
1575
+ </span>
1576
+ </a>
1577
+
1578
+ </li>
1579
+
1580
+ <li class="md-nav__item">
1581
+ <a href="#repeated-declarations" class="md-nav__link">
1582
+ <span class="md-ellipsis">
1583
+
1584
+ Repeated declarations
1585
+
1586
+ </span>
1587
+ </a>
1588
+
1589
+ </li>
1590
+
1591
+ <li class="md-nav__item">
1592
+ <a href="#fallback-preprocessing" class="md-nav__link">
1593
+ <span class="md-ellipsis">
1594
+
1595
+ Fallback preprocessing
1596
+
1597
+ </span>
1598
+ </a>
1599
+
1600
+ </li>
1601
+
1602
+ </ul>
1603
+ </nav>
1604
+
1605
+ </li>
1606
+
1607
+ <li class="md-nav__item">
1608
+ <a href="#what-a-mock-partial-keeps-from-your-header" class="md-nav__link">
1609
+ <span class="md-ellipsis">
1610
+
1611
+ What a Mock Partial Keeps From Your Header
1612
+
1613
+ </span>
1614
+ </a>
1615
+
1616
+ <nav class="md-nav" aria-label="What a Mock Partial Keeps From Your Header">
1617
+ <ul class="md-nav__list">
1618
+
1619
+ <li class="md-nav__item">
1620
+ <a href="#what-is-kept" class="md-nav__link">
1621
+ <span class="md-ellipsis">
1622
+
1623
+ What is kept
1624
+
1625
+ </span>
1626
+ </a>
1627
+
1628
+ </li>
1629
+
1630
+ <li class="md-nav__item">
1631
+ <a href="#what-is-left-out" class="md-nav__link">
1632
+ <span class="md-ellipsis">
1633
+
1634
+ What is left out
1635
+
1636
+ </span>
1637
+ </a>
1638
+
1639
+ </li>
1640
+
1641
+ <li class="md-nav__item">
1642
+ <a href="#a-mocked-header-without-an-include-guard" class="md-nav__link">
1643
+ <span class="md-ellipsis">
1644
+
1645
+ A mocked header without an include guard
1646
+
1647
+ </span>
1648
+ </a>
1649
+
1650
+ </li>
1651
+
1652
+ <li class="md-nav__item">
1653
+ <a href="#a-module-both-tested-and-mocked" class="md-nav__link">
1654
+ <span class="md-ellipsis">
1655
+
1656
+ A module both tested and mocked
1657
+
1658
+ </span>
1659
+ </a>
1660
+
1661
+ </li>
1662
+
1663
+ </ul>
1664
+ </nav>
1665
+
1666
+ </li>
1667
+
1668
+ <li class="md-nav__item">
1669
+ <a href="#function-pointers" class="md-nav__link">
1670
+ <span class="md-ellipsis">
1671
+
1672
+ Function Pointers
1673
+
1674
+ </span>
1675
+ </a>
1676
+
1522
1677
  </li>
1523
1678
 
1524
1679
  </ul>
@@ -4375,6 +4530,161 @@
4375
4530
  </ul>
4376
4531
  </nav>
4377
4532
 
4533
+ </li>
4534
+
4535
+ <li class="md-nav__item">
4536
+ <a href="#what-a-partial-carries-from-your-module" class="md-nav__link">
4537
+ <span class="md-ellipsis">
4538
+
4539
+ What a Partial Carries From Your Module
4540
+
4541
+ </span>
4542
+ </a>
4543
+
4544
+ <nav class="md-nav" aria-label="What a Partial Carries From Your Module">
4545
+ <ul class="md-nav__list">
4546
+
4547
+ <li class="md-nav__item">
4548
+ <a href="#what-is-carried" class="md-nav__link">
4549
+ <span class="md-ellipsis">
4550
+
4551
+ What is carried
4552
+
4553
+ </span>
4554
+ </a>
4555
+
4556
+ </li>
4557
+
4558
+ <li class="md-nav__item">
4559
+ <a href="#what-is-not-carried" class="md-nav__link">
4560
+ <span class="md-ellipsis">
4561
+
4562
+ What is not carried
4563
+
4564
+ </span>
4565
+ </a>
4566
+
4567
+ </li>
4568
+
4569
+ <li class="md-nav__item">
4570
+ <a href="#inline-functions-with-an-external-definition" class="md-nav__link">
4571
+ <span class="md-ellipsis">
4572
+
4573
+ Inline functions with an external definition
4574
+
4575
+ </span>
4576
+ </a>
4577
+
4578
+ </li>
4579
+
4580
+ <li class="md-nav__item">
4581
+ <a href="#a-module-header-without-an-include-guard" class="md-nav__link">
4582
+ <span class="md-ellipsis">
4583
+
4584
+ A module header without an include guard
4585
+
4586
+ </span>
4587
+ </a>
4588
+
4589
+ </li>
4590
+
4591
+ <li class="md-nav__item">
4592
+ <a href="#repeated-declarations" class="md-nav__link">
4593
+ <span class="md-ellipsis">
4594
+
4595
+ Repeated declarations
4596
+
4597
+ </span>
4598
+ </a>
4599
+
4600
+ </li>
4601
+
4602
+ <li class="md-nav__item">
4603
+ <a href="#fallback-preprocessing" class="md-nav__link">
4604
+ <span class="md-ellipsis">
4605
+
4606
+ Fallback preprocessing
4607
+
4608
+ </span>
4609
+ </a>
4610
+
4611
+ </li>
4612
+
4613
+ </ul>
4614
+ </nav>
4615
+
4616
+ </li>
4617
+
4618
+ <li class="md-nav__item">
4619
+ <a href="#what-a-mock-partial-keeps-from-your-header" class="md-nav__link">
4620
+ <span class="md-ellipsis">
4621
+
4622
+ What a Mock Partial Keeps From Your Header
4623
+
4624
+ </span>
4625
+ </a>
4626
+
4627
+ <nav class="md-nav" aria-label="What a Mock Partial Keeps From Your Header">
4628
+ <ul class="md-nav__list">
4629
+
4630
+ <li class="md-nav__item">
4631
+ <a href="#what-is-kept" class="md-nav__link">
4632
+ <span class="md-ellipsis">
4633
+
4634
+ What is kept
4635
+
4636
+ </span>
4637
+ </a>
4638
+
4639
+ </li>
4640
+
4641
+ <li class="md-nav__item">
4642
+ <a href="#what-is-left-out" class="md-nav__link">
4643
+ <span class="md-ellipsis">
4644
+
4645
+ What is left out
4646
+
4647
+ </span>
4648
+ </a>
4649
+
4650
+ </li>
4651
+
4652
+ <li class="md-nav__item">
4653
+ <a href="#a-mocked-header-without-an-include-guard" class="md-nav__link">
4654
+ <span class="md-ellipsis">
4655
+
4656
+ A mocked header without an include guard
4657
+
4658
+ </span>
4659
+ </a>
4660
+
4661
+ </li>
4662
+
4663
+ <li class="md-nav__item">
4664
+ <a href="#a-module-both-tested-and-mocked" class="md-nav__link">
4665
+ <span class="md-ellipsis">
4666
+
4667
+ A module both tested and mocked
4668
+
4669
+ </span>
4670
+ </a>
4671
+
4672
+ </li>
4673
+
4674
+ </ul>
4675
+ </nav>
4676
+
4677
+ </li>
4678
+
4679
+ <li class="md-nav__item">
4680
+ <a href="#function-pointers" class="md-nav__link">
4681
+ <span class="md-ellipsis">
4682
+
4683
+ Function Pointers
4684
+
4685
+ </span>
4686
+ </a>
4687
+
4378
4688
  </li>
4379
4689
 
4380
4690
  </ul>
@@ -4549,13 +4859,16 @@ their declaration or definition:</p>
4549
4859
  outside its containing translation unit, and therefore cannot be called or
4550
4860
  mocked from a test build without special handling. <code>inline</code> functions may be
4551
4861
  folded away by the compiler entirely. Partials use decorators to organize
4552
- lists of functions for testing and mocking, but the decorators are stripped
4553
- in the resulting generated code.</p>
4862
+ lists of functions for testing and mocking, and the decorators are stripped
4863
+ from the functions you select. What a Partial carries keeps its decorators, as
4864
+ <a href="#what-a-partial-carries-from-your-module">described below</a>.</p>
4554
4865
  <div class="admonition note">
4555
- <p class="admonition-title">Because of preproccesing only the “private” keywords are recognized</p>
4556
- <p>The preprocesing steps that are part of generating Partials expand any
4557
- macros (e.g. <code>INLINE</code> or <code>STATICINLINE</code>) to the actual keywords decorating
4558
- function signatures. As such, only the keywords above must be handled.</p>
4866
+ <p class="admonition-title">Decorators a macro supplies are recognized too</p>
4867
+ <p>Generating a Partial expands your module's macros to see the keywords
4868
+ behind them, so a macro such as <code>PRIVATE</code> or <code>STATICINLINE</code> works as the
4869
+ keyword it stands for. A function a macro makes <code>static</code> is written from
4870
+ its expanded signature, and every line of its body keeps its place. A
4871
+ variable a macro makes <code>static</code> loses <code>static</code> the same way.</p>
4559
4872
  </div>
4560
4873
  <h3 id="public-functions">Public functions</h3>
4561
4874
  <p>“Public” functions are everything else — functions with no visibility-
@@ -4564,6 +4877,194 @@ restricting decorator and ordinary external linkage.</p>
4564
4877
  of functions each <code>_MODULE</code> macro selects. The filtering and collection is
4565
4878
  documented in detail in the
4566
4879
  <a href="directives.html#partials-function-selection-by-macro">Partials function-selection by macro</a> section.</p>
4880
+ <h2 id="what-a-partial-carries-from-your-module">What a Partial Carries From Your Module</h2>
4881
+ <p>A Partial brings along what your selected functions rely on. Your module's
4882
+ code calls functions it only declares, and its header may define small
4883
+ <code>static</code> or <code>inline</code> helpers. A Partial holding only the selected functions
4884
+ would fail to compile or link without them. Ceedling copies them into the
4885
+ Partial's generated implementation source, written as your module writes them.
4886
+ A mock keeps its own share of your header, as
4887
+ <a href="#what-a-mock-partial-keeps-from-your-header">described below</a>.</p>
4888
+ <h3 id="what-is-carried">What is carried</h3>
4889
+ <p>A Partial carries three kinds of content beyond the functions you select.
4890
+ Each comes along only when the code the Partial keeps uses it. The one
4891
+ exception is a prototype of an inline function another header defines.</p>
4892
+ <ul>
4893
+ <li><strong>Prototypes of functions defined elsewhere.</strong> Your module declares a
4894
+ function that another file defines. The prototype comes along when the
4895
+ Partial's code uses the function. A prototype that gives an inline function
4896
+ its external definition, described below, always comes along.</li>
4897
+ <li><strong>Prototypes of functions your test leaves out.</strong> A test can subtract a
4898
+ function, such as <code>-engine_poll</code>, and define a stub of its own. The
4899
+ prototype comes along so a selected function calling it links to your stub.</li>
4900
+ <li><strong>Helpers your module header defines.</strong> A <code>static</code> or <code>inline</code> function
4901
+ defined in the module header comes along when the Partial's code uses it.
4902
+ A use through a macro counts. So does a use by another helper that came
4903
+ along.</li>
4904
+ </ul>
4905
+ <p>A function counts as used wherever the code names it. A call counts, and so
4906
+ does taking its address, passing it as a callback, or listing it in a table of
4907
+ handlers. A struct member, a parameter or a local variable that merely shares
4908
+ a function's name does not count, and neither does a mention in a comment.</p>
4909
+ <p>Each carried item keeps its original spelling and decorators. A carried helper
4910
+ has any function-scope <code>static</code> promoted, as every function in a Partial does.
4911
+ A line marker (<code>#line</code>) ahead of each item Ceedling can locate points back to
4912
+ its original file and line, so compiler messages and coverage reports name your
4913
+ own files.</p>
4914
+ <div class="admonition tip">
4915
+ <p class="admonition-title">See what a Partial carries</p>
4916
+ <p>Run a test build with <code>--verbosity=debug</code> that generates the Partial, such
4917
+ as the first build after <code>ceedling clobber</code>. Each Partial lists what it
4918
+ carried and why.</p>
4919
+ </div>
4920
+ <h3 id="what-is-not-carried">What is not carried</h3>
4921
+ <p>Some content stays behind, because carrying it could break a build that works.</p>
4922
+ <ul>
4923
+ <li>A helper the Partial's code never uses stays behind. Its own code never has
4924
+ to compile in the Partial.</li>
4925
+ <li>A prototype the Partial's code never uses stays behind. A header included
4926
+ later may define a macro of the same name, and the macro would mangle a
4927
+ prototype nothing needed.</li>
4928
+ <li>A function your module's source defines and your test does not select stays
4929
+ behind. That is what selecting a Partial means. A selected function that
4930
+ calls a <code>static</code> function in the source needs that function selected too.
4931
+ Add it with <code>+name</code>, or select the whole module with
4932
+ <code>TEST_PARTIAL_ALL_MODULE</code>.</li>
4933
+ <li>A <code>static</code> prototype stays behind unless its helper comes along.</li>
4934
+ <li>Nothing is added to a Partial's headers, so your test file sees only what
4935
+ the selection gives it. A test that calls a helper directly selects it with
4936
+ <code>+name</code>.</li>
4937
+ </ul>
4938
+ <h3 id="inline-functions-with-an-external-definition">Inline functions with an external definition</h3>
4939
+ <p>C99 gives an inline function its external definition through a declaration.
4940
+ A header defines the function <code>inline</code>. One source file declares it
4941
+ <code>extern inline</code>, <code>extern</code>, or with no <code>inline</code> at all. That source file's
4942
+ object then holds the definition that an unoptimized call links to. A Partial
4943
+ carries the declaration, so a test calling the function links.</p>
4944
+ <p>Ceedling finds the inline body in the headers your source file includes. Under
4945
+ <a href="#fallback-preprocessing">fallback preprocessing</a> it cannot look there. Only a
4946
+ declaration that says <code>inline</code> itself is then carried this way.</p>
4947
+ <p>A Partial never mocks a function your module only declares when another header
4948
+ defines it inline. The body lives in that header, which a mock cannot replace.
4949
+ The Partial's implementation source carries the declaration instead.</p>
4950
+ <p>A test that also mocks the module holding the inline body, as a Partial,
4951
+ removes that body. Some compilers then warn that the inline function is not
4952
+ defined. The mock supplies the definition, so the build still links.</p>
4953
+ <h3 id="a-module-header-without-an-include-guard">A module header without an include guard</h3>
4954
+ <p>A Partial stands in for your module header by defining that header's include
4955
+ guard. A header guarded only by <code>#pragma once</code> has no guard to define. Another
4956
+ header your module includes may pull the real header in again, helpers and
4957
+ all. A carried copy of a helper would then collide with the real one.</p>
4958
+ <p>A Partial therefore carries no helpers from a header without an include guard.
4959
+ When it generates the Partial, it logs a notice naming the helpers the
4960
+ Partial's code uses. Give the
4961
+ header an include guard to have its helpers carried. Selecting a helper with
4962
+ <code>+name</code> also works when no other header pulls the real header in.</p>
4963
+ <h3 id="repeated-declarations">Repeated declarations</h3>
4964
+ <p>A carried prototype may repeat a declaration that one of your headers already
4965
+ makes. That is valid C. Some builds warn about it with <code>-Wredundant-decls</code> and
4966
+ fail on the warning with <code>-Werror</code>. Ceedling wraps carried prototypes in GCC
4967
+ diagnostic pragmas that quiet that one warning for those lines alone. The
4968
+ <a href="../../configuration/reference/partials.html#suppress_redundant_decls"><code>:partials</code> ↳ <code>:suppress_redundant_decls</code></a>
4969
+ setting turns the wrapping off.</p>
4970
+ <h3 id="fallback-preprocessing">Fallback preprocessing</h3>
4971
+ <p><a href="../conventions.html#fallback-test-build-preprocessing">Fallback preprocessing</a>
4972
+ is best effort and only partially capable. It can keep two different copies of
4973
+ one function, such as both sides of a conditional it cannot evaluate. A Partial
4974
+ carries neither copy. When it generates the Partial, it logs a notice naming the
4975
+ function. For a helper, the notice suggests selecting it with <code>+name</code>, which
4976
+ selects the first copy.</p>
4977
+ <h2 id="what-a-mock-partial-keeps-from-your-header">What a Mock Partial Keeps From Your Header</h2>
4978
+ <p>A Mock Partial keeps the rest of your module header for the code that includes
4979
+ it. Its interface header stands in for your real header wherever your test
4980
+ build includes it, and CMock mocks only the functions you select. Code that
4981
+ includes your header may still use the rest of it, such as a <code>static inline</code>
4982
+ helper, a <code>static const</code> table, an <code>extern</code> variable, or a function you leave
4983
+ unmocked. A module your test mocks but doesn't test keeps that content in a
4984
+ header of its own, <code>ceedling_partial_&lt;module&gt;_extras.h</code>.</p>
4985
+ <p>The interface header includes the extras header where your header's own
4986
+ declarations end, so a kept helper can call a mocked function your header
4987
+ declares. CMock never reads the extras header, so nothing in it becomes a
4988
+ mock. Your test file sees what it keeps too, through the mock.</p>
4989
+ <div class="admonition tip">
4990
+ <p class="admonition-title">See what a mock keeps</p>
4991
+ <p>Run a test build with <code>--verbosity=debug</code> that generates the Partial, such
4992
+ as the first build after <code>ceedling clobber</code>. Each mock lists what it kept.</p>
4993
+ </div>
4994
+ <h3 id="what-is-kept">What is kept</h3>
4995
+ <ul>
4996
+ <li><strong>Helpers your header defines.</strong> Each <code>static</code> or <code>inline</code> function in your
4997
+ header that your test doesn't mock is kept as your header writes it. A
4998
+ function-scope <code>static</code> in it is promoted, as in every Partial.</li>
4999
+ <li><strong><code>static</code> variables your header defines.</strong></li>
5000
+ <li><strong><code>extern</code> declarations</strong> of variables, as your header writes them.</li>
5001
+ <li><strong>Prototypes of functions your test doesn't mock.</strong></li>
5002
+ </ul>
5003
+ <h3 id="what-is-left-out">What is left out</h3>
5004
+ <p>Some content stays behind, because keeping it could break a build that works.</p>
5005
+ <ul>
5006
+ <li>Anything your module's source defines. A mock stands in for your header
5007
+ alone.</li>
5008
+ <li>A variable your header defines without <code>static</code>. Every file that includes
5009
+ the header would define it again.</li>
5010
+ <li>A <code>static</code> or <code>inline</code> prototype whose helper isn't kept.</li>
5011
+ <li>A prototype that a function-like macro of the same name rewrites, since
5012
+ calls use the macro.</li>
5013
+ <li>A <code>static</code> variable, or a <code>static</code> helper that isn't <code>inline</code>, that names a
5014
+ function your module declares and your test doesn't mock. Your test build may
5015
+ hold no definition of that function. A compiler can emit such an item even
5016
+ where nothing uses it, and the test would fail to link. An item that names
5017
+ anything left out this way stays behind too.</li>
5018
+ <li>Under <a href="#fallback-preprocessing">fallback preprocessing</a>, an item with two
5019
+ different copies, such as both sides of a conditional. Identical copies are
5020
+ kept once. An item that names a function with two different prototypes stays
5021
+ behind too, <code>inline</code> helpers included.</li>
5022
+ </ul>
5023
+ <h3 id="a-mocked-header-without-an-include-guard">A mocked header without an include guard</h3>
5024
+ <p>A header without an include guard can still arrive through another include,
5025
+ helpers and all, as it can for a
5026
+ <a href="#a-module-header-without-an-include-guard">Test Partial</a>. A kept copy of a
5027
+ helper or a <code>static</code> variable would then collide with the real one. A mock of
5028
+ such a header keeps only its <code>extern</code> declarations and prototypes. When it
5029
+ generates the Partial, Ceedling logs a notice naming the helpers and variables
5030
+ the mock leaves behind. Give the header an include guard to have them kept.
5031
+ <code>#pragma once</code> is not an include guard. Ceedling relies on include guards to
5032
+ stand a mock in for a header, so a <code>#pragma once</code> header is treated as one
5033
+ without a guard.</p>
5034
+ <h3 id="a-module-both-tested-and-mocked">A module both tested and mocked</h3>
5035
+ <p>A module that one test both tests and mocks gets no extras header. Its
5036
+ implementation source carries what its own code uses, as
5037
+ <a href="#what-a-partial-carries-from-your-module">described above</a>. Another Partial in
5038
+ that test that includes the module's header gets the mock's interface in its
5039
+ place, which declares only the mocked functions. Code in that Partial that uses
5040
+ the header's helpers or <code>static</code> variables fails to compile or link.</p>
5041
+ <p>When it generates the Partial, Ceedling logs a notice naming what the other
5042
+ Partials use. Two changes work around it:</p>
5043
+ <ol>
5044
+ <li>Test the module in a test file of its own, and only mock it in this one.</li>
5045
+ <li>Move what the other Partials use into a header your module header includes.
5046
+ The mock keeps that header's <code>#include</code>.</li>
5047
+ </ol>
5048
+ <h2 id="function-pointers">Function Pointers</h2>
5049
+ <p>A Partial reads function pointers in each common spelling, with or without a
5050
+ typedef for their type. A function may take or return one. A module may hold
5051
+ one, an array of them, or a pointer to an array. A Partial declares each such
5052
+ variable with its whole type, so a test can assign it and call through it.</p>
5053
+ <div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="kt">void</span><span class="w"> </span><span class="nf">ticker_register</span><span class="p">(</span><span class="kt">int</span><span class="w"> </span><span class="p">(</span><span class="o">*</span><span class="n">cb</span><span class="p">)(</span><span class="kt">int</span><span class="p">));</span><span class="w"> </span><span class="c1">// a function taking a function pointer</span>
5054
+ <a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a><span class="kt">int</span><span class="w"> </span><span class="p">(</span><span class="o">*</span><span class="n">ticker_get</span><span class="p">(</span><span class="kt">void</span><span class="p">))(</span><span class="kt">int</span><span class="p">);</span><span class="w"> </span><span class="c1">// a function returning one</span>
5055
+ <a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a><span class="k">static</span><span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="p">(</span><span class="o">*</span><span class="n">s_hook</span><span class="p">)(</span><span class="kt">int</span><span class="p">);</span><span class="w"> </span><span class="c1">// a variable holding one</span>
5056
+ <a id="__codelineno-2-4" name="__codelineno-2-4" href="#__codelineno-2-4"></a><span class="k">static</span><span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="p">(</span><span class="o">*</span><span class="n">s_table</span><span class="p">[</span><span class="mi">2</span><span class="p">])(</span><span class="kt">int</span><span class="p">);</span><span class="w"> </span><span class="c1">// an array of them</span>
5057
+ </code></pre></div>
5058
+ <p>A table whose entries name <code>static</code> functions in your module's source needs
5059
+ those functions selected too. Add them with <code>+name</code>, as for a selected function
5060
+ that calls them.</p>
5061
+ <p>A Partial reads each declaration as written, before macros expand. A macro that
5062
+ spells part of a declarator can hide what the declaration names, as <code>WINAPI</code>
5063
+ does in <code>void (WINAPI *fp)(int);</code>. For a function pointer, give its type a name
5064
+ with a typedef and use the name in the declaration. For a function a macro
5065
+ declares, declare the function directly. When a Partial finds no name at all
5066
+ for a function your module defines, it stops the build with a message naming
5067
+ the definition.</p>
4567
5068
  <p><br/><br/></p>
4568
5069
 
4569
5070
 
@@ -4635,7 +5136,7 @@ documented in detail in the
4635
5136
  <script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.a7633da7.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
4636
5137
 
4637
5138
 
4638
- <script src="../../assets/javascripts/bundle.c21346df.min.js"></script>
5139
+ <script src="../../assets/javascripts/bundle.a5f9d56c.min.js"></script>
4639
5140
 
4640
5141
 
4641
5142
  </body>
@@ -21,7 +21,7 @@
21
21
 
22
22
 
23
23
  <link rel="icon" href="../../assets/images/favicon.png">
24
- <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.0">
24
+ <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.2">
25
25
 
26
26
 
27
27
 
@@ -4693,7 +4693,8 @@ section.</p>
4693
4693
  <p>Add <code>--verbosity obnoxious</code> (or <code>-v 4</code>) to your <code>test:</code> command line invocation
4694
4694
  for detailed logging of the C extraction and Partials generations for your test
4695
4695
  build. The logged lists of functions and variables can help you fine tune or
4696
- troubleshoot your Partials configuration.</p>
4696
+ troubleshoot your Partials configuration. Extraction runs only for a Partial
4697
+ the build generates, such as on the first build after <code>ceedling clobber</code>.</p>
4697
4698
  </div>
4698
4699
  <h2 id="include-conventions"><code>#include</code> conventions</h2>
4699
4700
  <p>The <code>_MODULE</code> macros each expand to a <strong>string literal</strong> that names a
@@ -5097,7 +5098,7 @@ error.</p>
5097
5098
  <script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.a7633da7.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
5098
5099
 
5099
5100
 
5100
- <script src="../../assets/javascripts/bundle.c21346df.min.js"></script>
5101
+ <script src="../../assets/javascripts/bundle.a5f9d56c.min.js"></script>
5101
5102
 
5102
5103
 
5103
5104
  </body>
@@ -21,7 +21,7 @@
21
21
 
22
22
 
23
23
  <link rel="icon" href="../../assets/images/favicon.png">
24
- <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.0">
24
+ <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.2">
25
25
 
26
26
 
27
27
 
@@ -4691,7 +4691,7 @@ usage scenarios.</p>
4691
4691
  <script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.a7633da7.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
4692
4692
 
4693
4693
 
4694
- <script src="../../assets/javascripts/bundle.c21346df.min.js"></script>
4694
+ <script src="../../assets/javascripts/bundle.a5f9d56c.min.js"></script>
4695
4695
 
4696
4696
 
4697
4697
  </body>
@@ -21,7 +21,7 @@
21
21
 
22
22
 
23
23
  <link rel="icon" href="../../assets/images/favicon.png">
24
- <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.0">
24
+ <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.2">
25
25
 
26
26
 
27
27
 
@@ -4426,7 +4426,7 @@ be complexities that Partials are simply unable to resolve.</p>
4426
4426
  <script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.a7633da7.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
4427
4427
 
4428
4428
 
4429
- <script src="../../assets/javascripts/bundle.c21346df.min.js"></script>
4429
+ <script src="../../assets/javascripts/bundle.a5f9d56c.min.js"></script>
4430
4430
 
4431
4431
 
4432
4432
  </body>