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
@@ -55,13 +55,15 @@ describe 'Partial header composition' do
55
55
  # ---------------------------------------------------------------------------
56
56
 
57
57
  # Issue #1319, first reporter. Types live in the module header and reference types
58
- # from a header the source includes after the module's own header.
58
+ # from a header the module header includes. The source includes that header again,
59
+ # after the module's own header.
59
60
  it 'compiles when the module header is included before its dependency' do
60
61
  @result = generate_partial(
61
62
  module_name: 'lm75b',
62
63
  header: <<~C,
63
64
  #ifndef LM75B_H
64
65
  #define LM75B_H
66
+ #include "foundation.h"
65
67
  typedef struct {
66
68
  S16 os_over_temperature_deci_c;
67
69
  U8 pin_state;
@@ -70,6 +72,7 @@ describe 'Partial header composition' do
70
72
  #endif
71
73
  C
72
74
  source: "#include <string.h>\n#include \"lm75b.h\"\n#include \"foundation.h\"\n",
75
+ header_includes: ['foundation.h'],
73
76
  source_includes: ['<string.h>', 'lm75b.h', 'foundation.h'],
74
77
  extra: { 'foundation.h' => FOUNDATION_H }
75
78
  )
@@ -195,10 +198,12 @@ describe 'Partial header composition' do
195
198
  header: <<~C,
196
199
  #ifndef ALERTMANAGER_H
197
200
  #define ALERTMANAGER_H
201
+ #include "foundation.h"
198
202
  typedef struct { S16 level; } AlertEntry_t;
199
203
  #endif
200
204
  C
201
205
  source: "#include \"alertmanager.h\"\n#include \"facade.h\"\n#include \"foundation.h\"\n",
206
+ header_includes: ['foundation.h'],
202
207
  source_includes: ['alertmanager.h', 'facade.h', 'foundation.h'],
203
208
  extra: {
204
209
  'foundation.h' => FOUNDATION_H,
@@ -345,6 +350,34 @@ describe 'Partial header composition' do
345
350
  expect( @result.types_h.to_s ).to include('typedef unsigned char counter_t;')
346
351
  expect( @result.types_h.to_s ).not_to include('unsigned long')
347
352
  end
353
+
354
+ # An aggregate carrying a declarator defines its type once, in the types header. The extern
355
+ # and the definition both name it, since C treats two anonymous structs as unrelated types.
356
+ it 'keeps one type for an aggregate defined inline on a variable' do
357
+ @result = generate_partial(
358
+ module_name: 'slotted',
359
+ header: "#ifndef SLOTTED_H\n#define SLOTTED_H\n#endif\n",
360
+ source: "#include \"slotted.h\"\nstatic struct { int depth; } slot;\n",
361
+ source_includes: ['slotted.h']
362
+ )
363
+
364
+ compile = compile_partial( @result, prelude: "#include \"ceedling_partial_slotted_impl.c\"\n" )
365
+ expect( compile.ok ).to be(true), "expected a clean compile, got: #{compile.first_error}"
366
+ end
367
+
368
+ # A tag-only forward declaration is a type statement. Read as a variable, it would become
369
+ # `extern struct node;`, an empty declaration with a storage class, which is a diagnostic in
370
+ # its own right and an error under -Werror.
371
+ it 'preserves a forward declaration as a forward declaration' do
372
+ @result = generate_partial(
373
+ module_name: 'fwd',
374
+ header: "#ifndef FWD_H\n#define FWD_H\nstruct node;\ntypedef struct node* node_ref_t;\n#endif\n",
375
+ source: "#include \"fwd.h\"\nstruct node { int value; };\nstatic node_ref_t head;\n",
376
+ source_includes: ['fwd.h']
377
+ )
378
+
379
+ expect( @result.impl_h.to_s ).not_to include('extern struct node;')
380
+ end
348
381
  end
349
382
 
350
383
  # ---------------------------------------------------------------------------
@@ -405,6 +438,39 @@ describe 'Partial header composition' do
405
438
  expect( @result.type_names( :types_h ) ).to include('valve_t')
406
439
  end
407
440
 
441
+ # A header-only module has no source to place its header, so its types header has no
442
+ # position to take. It still has to come ahead of the prototypes that use its types.
443
+ it 'compiles for a header-only module whose prototypes use its own types' do
444
+ @result = generate_partial(
445
+ module_name: 'gpio', source: nil, tests_expose: nil, mocks_expose: PartializerConfig::PUBLIC,
446
+ header: <<~C,
447
+ #ifndef GPIO_H
448
+ #define GPIO_H
449
+ #include <stdint.h>
450
+ typedef enum { GPIO_IN, GPIO_OUT } gpio_dir_t;
451
+ void gpio_set(uint32_t pin, gpio_dir_t dir);
452
+ #endif
453
+ C
454
+ header_includes: ['<stdint.h>']
455
+ )
456
+
457
+ compile = compile_interface( @result )
458
+ expect( compile.ok ).to be(true), "expected a clean compile, got: #{compile.first_error}"
459
+ end
460
+
461
+ it 'compiles for a module whose source never includes its own header' do
462
+ @result = generate_partial(
463
+ module_name: 'valve', tests_expose: nil, mocks_expose: PartializerConfig::PUBLIC,
464
+ header: "#ifndef VALVE_H\n#define VALVE_H\ntypedef struct { int port; } valve_t;\nvoid valve_open(valve_t* v);\n#endif\n",
465
+ source: "#include \"base.h\"\nint valve_count(void) { return 0; }\n",
466
+ source_includes: ['base.h'],
467
+ extra: { 'base.h' => "#ifndef BASE_H\n#define BASE_H\n#endif\n" }
468
+ )
469
+
470
+ compile = compile_interface( @result )
471
+ expect( compile.ok ).to be(true), "expected a clean compile, got: #{compile.first_error}"
472
+ end
473
+
408
474
  end
409
475
 
410
476
  # ---------------------------------------------------------------------------
@@ -505,8 +571,9 @@ describe 'Partial header composition' do
505
571
  it 'compiles with a system header ahead of the module header' do
506
572
  @result = generate_partial(
507
573
  module_name: 'lm75b',
508
- header: "#ifndef LM75B_H\n#define LM75B_H\ntypedef struct { U8 pin; } lm75b_t;\n#endif\n",
574
+ header: "#ifndef LM75B_H\n#define LM75B_H\n#include \"foundation.h\"\ntypedef struct { U8 pin; } lm75b_t;\n#endif\n",
509
575
  source: "#include <string.h>\n#include \"lm75b.h\"\n#include \"foundation.h\"\n",
576
+ header_includes: ['foundation.h'],
510
577
  source_includes: ['<string.h>', 'lm75b.h', 'foundation.h'],
511
578
  extra: { 'foundation.h' => FOUNDATION_H }
512
579
  )
@@ -783,6 +850,98 @@ describe 'Partial header composition' do
783
850
  }
784
851
  end
785
852
 
853
+ # ---------------------------------------------------------------------------
854
+ context 'function return types' do
855
+ # ---------------------------------------------------------------------------
856
+
857
+ # A Partial strips each selected function's storage class so a test can call it. Only the
858
+ # storage class goes. Every word of the return type stays, and a qualifier is part of it.
859
+ RETURN_TYPES_H = <<~C
860
+ #ifndef SHAPES_H
861
+ #define SHAPES_H
862
+ struct point { int x; };
863
+ typedef unsigned char octet_t;
864
+ struct point *shapes_origin(void);
865
+ unsigned long shapes_big(void);
866
+ const char *shapes_name(void);
867
+ octet_t *shapes_buffer(void);
868
+ #endif
869
+ C
870
+
871
+ RETURN_TYPES_C = <<~C
872
+ #include "shapes.h"
873
+ static struct point origin;
874
+ static const int table[2] = { 1, 2 };
875
+ static octet_t buffer[4];
876
+ struct point *shapes_origin(void) { return &origin; }
877
+ unsigned long shapes_big(void) { return 4000000000UL; }
878
+ const char *shapes_name(void) { return "shapes"; }
879
+ octet_t *shapes_buffer(void) { return buffer; }
880
+ static const int *shapes_table(void) { return table; }
881
+ C
882
+
883
+ def generate_shapes
884
+ generate_partial(
885
+ module_name: 'shapes', header: RETURN_TYPES_H, source: RETURN_TYPES_C,
886
+ source_includes: ['shapes.h']
887
+ )
888
+ end
889
+
890
+ it 'keeps every return type whole in the implementation header' do
891
+ @result = generate_shapes
892
+
893
+ expect( @result.impl_h ).to include( 'struct point *shapes_origin(void);' )
894
+ expect( @result.impl_h ).to include( 'unsigned long shapes_big(void);' )
895
+ expect( @result.impl_h ).to include( 'const char *shapes_name(void);' )
896
+ expect( @result.impl_h ).to include( 'octet_t *shapes_buffer(void);' )
897
+ expect( @result.impl_h ).to include( 'const int *shapes_table(void);' )
898
+ end
899
+
900
+ it 'keeps every return type whole in the implementation source' do
901
+ @result = generate_shapes
902
+
903
+ expect( @result.impl_c ).to include( 'struct point *shapes_origin(void) {' )
904
+ expect( @result.impl_c ).to include( 'unsigned long shapes_big(void) {' )
905
+ expect( @result.impl_c ).to include( 'const char *shapes_name(void) {' )
906
+ expect( @result.impl_c ).to include( 'const int *shapes_table(void) {' )
907
+ expect( @result.impl_c ).not_to match( /^static const int \*shapes_table/ )
908
+ end
909
+
910
+ it 'keeps every return type whole in the mockable interface' do
911
+ @result = generate_shapes
912
+
913
+ expect( @result.interface_h ).to include( 'struct point *shapes_origin(void);' )
914
+ expect( @result.interface_h ).to include( 'const char *shapes_name(void);' )
915
+ end
916
+
917
+ # A dropped qualifier or type word still compiles in some shapes, so warnings count too
918
+ it 'compiles the implementation source without a diagnostic' do
919
+ @result = generate_shapes
920
+
921
+ compile = compile_objects( @result )
922
+ expect( compile.ok ).to be(true), "expected a clean compile, got: #{compile.first_error}"
923
+ expect( compile.stderr ).to be_empty
924
+ end
925
+ end
926
+
927
+ # ---------------------------------------------------------------------------
928
+ context 'a variable the header declares and the source defines' do
929
+ # ---------------------------------------------------------------------------
930
+
931
+ # Both files name one variable. The implementation header declares it once, so a test
932
+ # build that warns on redundant declarations stays clean.
933
+ it 'declares the variable once in the implementation header' do
934
+ @result = generate_partial(
935
+ module_name: 'moded',
936
+ header: "#ifndef MODED_H\n#define MODED_H\nextern int moded_mode;\nint moded_get(void);\n#endif\n",
937
+ source: "#include \"moded.h\"\nint moded_mode = 3;\nint moded_get(void) { return moded_mode; }\n",
938
+ source_includes: ['moded.h']
939
+ )
940
+
941
+ expect( @result.impl_h.scan( 'extern int moded_mode;' ).size ).to eq(1)
942
+ end
943
+ end
944
+
786
945
  # ---------------------------------------------------------------------------
787
946
  context 'C shapes the extraction model does not yet carry' do
788
947
  # ---------------------------------------------------------------------------
@@ -816,39 +975,6 @@ describe 'Partial header composition' do
816
975
  expect( compile.ok ).to be(true), "expected a clean compile, got: #{compile.first_error}"
817
976
  end
818
977
 
819
- # An aggregate carrying a declarator is not a standalone type definition, so it reaches
820
- # the variable extractor whole. Re-emitting it as both an extern and a definition states
821
- # an anonymous struct twice, and C treats two anonymous structs as unrelated types.
822
- it 'keeps one type for an aggregate defined inline on a variable' do
823
- pending 'an aggregate carrying a declarator is classified as a variable -- follow-on work'
824
-
825
- @result = generate_partial(
826
- module_name: 'slotted',
827
- header: "#ifndef SLOTTED_H\n#define SLOTTED_H\n#endif\n",
828
- source: "#include \"slotted.h\"\nstatic struct { int depth; } slot;\n",
829
- source_includes: ['slotted.h']
830
- )
831
-
832
- compile = compile_partial( @result, prelude: "#include \"ceedling_partial_slotted_impl.c\"\n" )
833
- expect( compile.ok ).to be(true), "expected a clean compile, got: #{compile.first_error}"
834
- end
835
-
836
- # A tag-only forward declaration has no declarator, and reaching the variable extractor
837
- # turns it into `extern struct node;`. That is an empty declaration with a storage class,
838
- # which is a diagnostic in its own right and an error under -Werror.
839
- it 'preserves a forward declaration as a forward declaration' do
840
- pending 'a tag-only forward declaration is classified as a variable -- follow-on work'
841
-
842
- @result = generate_partial(
843
- module_name: 'fwd',
844
- header: "#ifndef FWD_H\n#define FWD_H\nstruct node;\ntypedef struct node* node_ref_t;\n#endif\n",
845
- source: "#include \"fwd.h\"\nstruct node { int value; };\nstatic node_ref_t head;\n",
846
- source_includes: ['fwd.h']
847
- )
848
-
849
- expect( @result.impl_h.to_s ).not_to include('extern struct node;')
850
- end
851
-
852
978
  # Directives-only preprocessing passes both #define and #undef through, and extraction
853
979
  # keeps only #define. A macro the module deliberately scoped to a few lines therefore
854
980
  # becomes visible everywhere the generated headers reach, the test file included.
@@ -886,4 +1012,111 @@ describe 'Partial header composition' do
886
1012
  end
887
1013
  end
888
1014
 
1015
+
1016
+ # ---------------------------------------------------------------------------
1017
+ context "includes the source names after the module's header" do
1018
+ # ---------------------------------------------------------------------------
1019
+
1020
+ # A later header that includes the module's header reaches only the spoofed guard, so it
1021
+ # finds the module's types and macros only in what a generated header writes ahead of it.
1022
+ SENSOR_LOG_H = <<~C
1023
+ #ifndef SENSOR_LOG_H
1024
+ #define SENSOR_LOG_H
1025
+ #include "sensor.h"
1026
+ void sensor_log_status(sensor_status_t status);
1027
+ #endif
1028
+ C
1029
+
1030
+ # Issue #1402. The source's own type uses the header's type, so the types header holds both.
1031
+ it "compiles when a later header uses the module header's types" do
1032
+ @result = generate_partial(
1033
+ module_name: 'sensor',
1034
+ header: <<~C,
1035
+ #ifndef SENSOR_H
1036
+ #define SENSOR_H
1037
+ #include <stdint.h>
1038
+ typedef enum { SENSOR_OK, SENSOR_ERROR } sensor_status_t;
1039
+ sensor_status_t sensor_read(int32_t *value);
1040
+ #endif
1041
+ C
1042
+ source: <<~C,
1043
+ #include "sensor_config.h"
1044
+ #include "sensor.h"
1045
+ #include "sensor_log.h"
1046
+ #include <stdint.h>
1047
+ typedef struct { int32_t value; sensor_status_t status; } sensor_reading_t;
1048
+ sensor_status_t sensor_read(int32_t *value) {
1049
+ sensor_reading_t reading = { SENSOR_DEFAULT_VALUE, SENSOR_OK };
1050
+ *value = reading.value;
1051
+ sensor_log_status(reading.status);
1052
+ return reading.status;
1053
+ }
1054
+ C
1055
+ header_includes: ['<stdint.h>'],
1056
+ source_includes: ['sensor_config.h', 'sensor.h', 'sensor_log.h', '<stdint.h>'],
1057
+ extra: {
1058
+ 'sensor_config.h' => "#ifndef SENSOR_CONFIG_H\n#define SENSOR_CONFIG_H\n#define SENSOR_DEFAULT_VALUE 42\n#endif\n",
1059
+ 'sensor_log.h' => SENSOR_LOG_H
1060
+ }
1061
+ )
1062
+
1063
+ compile = compile_partial( @result )
1064
+ expect( compile.ok ).to be(true), "expected a clean compile, got: #{compile.first_error}"
1065
+
1066
+ alone = compile_types_header_alone( @result )
1067
+ expect( alone.ok ).to be(true), "expected the types header to compile alone, got: #{alone.first_error}"
1068
+ end
1069
+
1070
+ # A module with no types gets no types header, so its implementation and interface headers
1071
+ # write its macros ahead of the later includes themselves
1072
+ it "compiles when a later header uses a macro of a module with no types" do
1073
+ @result = generate_partial(
1074
+ module_name: 'sensor',
1075
+ header: <<~C,
1076
+ #ifndef SENSOR_H
1077
+ #define SENSOR_H
1078
+ #define SENSOR_COUNT 4
1079
+ void sensor_read(void);
1080
+ #endif
1081
+ C
1082
+ source: <<~C,
1083
+ #include "sensor.h"
1084
+ #include "sensor_log.h"
1085
+ void sensor_read(void) {
1086
+ int log[SENSOR_COUNT] = { 0 };
1087
+ sensor_log_all(log);
1088
+ }
1089
+ C
1090
+ source_includes: ['sensor.h', 'sensor_log.h'],
1091
+ extra: {
1092
+ 'sensor_log.h' => "#ifndef SENSOR_LOG_H\n#define SENSOR_LOG_H\n#include \"sensor.h\"\nvoid sensor_log_all(int log[SENSOR_COUNT]);\n#endif\n"
1093
+ }
1094
+ )
1095
+
1096
+ expect( @result.types_h ).to be_nil
1097
+ compile = compile_both_headers( @result )
1098
+ expect( compile.ok ).to be(true), "expected a clean compile, got: #{compile.first_error}"
1099
+ end
1100
+
1101
+ # The mocked module's interface header declares its types, so it stands where the real
1102
+ # header stood: ahead of the module's header, whose types use it
1103
+ it "keeps a mocked Partial's interface header ahead of the module's types" do
1104
+ @result = generate_partial(
1105
+ module_name: 'host',
1106
+ header: "#ifndef HOST_H\n#define HOST_H\ntypedef struct { guest_handle_t h; } host_t;\n#endif\n",
1107
+ source: "#include \"guest.h\"\n#include \"host.h\"\n#include \"later.h\"\n",
1108
+ source_includes: ['guest.h', 'host.h', 'later.h'],
1109
+ partials: other_partial( 'guest', mocked: true ),
1110
+ extra: {
1111
+ 'guest.h' => "#ifndef GUEST_H\n#define GUEST_H\ntypedef int guest_handle_t;\n#endif\n",
1112
+ 'later.h' => "#ifndef LATER_H\n#define LATER_H\n#endif\n"
1113
+ }
1114
+ )
1115
+
1116
+ body = @result.types_h.to_s
1117
+ expect( body.index( 'ceedling_partial_guest_interface.h' ) ).to be < body.index( 'host_t;' )
1118
+ expect( body.index( '"later.h"' ) ).to be > body.index( 'host_t;' )
1119
+ end
1120
+ end
1121
+
889
1122
  end
@@ -0,0 +1,267 @@
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
+ # Selected functions and file-scope variables whose storage class or inline specifier a macro
9
+ # supplies.
10
+ #
11
+ # A project can hide `static` behind a macro of its own, such as `#define PRIVATE static`. A
12
+ # Partial strips `static` from every function and variable it exposes, so each links from the
13
+ # test. The implementation header declares the expanded, stripped declaration. The
14
+ # implementation source must define the same one, or the macro, carried in with the module's
15
+ # header, makes the definition static again after a non-static declaration.
16
+ #
17
+ # Each case compiles and links real objects with warnings as errors, in accurate and fallback
18
+ # preprocessing alike, since both reconcile with the full expansion.
19
+
20
+ require 'spec_helper'
21
+ require 'spec_integration_helper'
22
+ require 'partials_generation_integration_helper'
23
+
24
+ describe 'Partial functions and variables whose decorators a macro supplies' do
25
+
26
+ include_context 'requires gcc'
27
+
28
+ after(:each) { cleanup_dir( @dir ) }
29
+
30
+ ENGINE_HEADER = <<~C
31
+ #ifndef ENGINE_H
32
+ #define ENGINE_H
33
+ #define PRIVATE static
34
+ #define STATICINLINE static inline
35
+ #define EXTERN extern
36
+ #define LEN 2
37
+ int engine_get(void);
38
+ #endif
39
+ C
40
+
41
+ def engine(source, mode:, header: ENGINE_HEADER, **options)
42
+ result = generate_partial(
43
+ module_name: 'engine', header: header, source: source, source_includes: ['engine.h'], mode: mode, **options
44
+ )
45
+ @dir = result.dir
46
+ return result
47
+ end
48
+
49
+ def link_cleanly(result, references:)
50
+ link = link_partial( result, references: references, flags: '-Wall -Werror' )
51
+ expect( link.ok ).to be( true ), "expected a clean link, got: #{link.first_diagnostic}"
52
+ end
53
+
54
+ [:accurate, :fallback].each do |mode|
55
+ context "with #{mode} preprocessing" do
56
+ before { skip 'directives-only preprocessing is unavailable' if mode == :accurate and !directives_only_supported? }
57
+
58
+ it 'links a selected function a macro makes static' do
59
+ result = engine( "#include \"engine.h\"\nPRIVATE int helper(void) { return 41; }\nint engine_get(void) { return helper() + 1; }\n", mode: mode )
60
+
61
+ expect( result.impl_c ).to include( 'int helper(void) { return 41; }' )
62
+ expect( result.impl_c ).not_to include( 'PRIVATE int helper' )
63
+ link_cleanly( result, references: ['helper', 'engine_get'] )
64
+ end
65
+
66
+ # Fallback keeps comments in the text it extracts, where a ';' or a split name could mislead
67
+ it 'links a selected function whose head holds comments' do
68
+ source = "#include \"engine.h\"\nPRIVATE int helper /* c */ (int a) /* adds; */ { return a ? helper( a - 1 ) : 41; }\n" \
69
+ "int engine_get(void) { return helper( 2 ) + 1; }\n"
70
+ result = engine( source, mode: mode )
71
+
72
+ expect( result.impl_c ).not_to include( 'PRIVATE int helper' )
73
+ link_cleanly( result, references: ['helper', 'engine_get'] )
74
+ end
75
+
76
+ # Each body line keeps its own line, so coverage and diagnostics still point at the module
77
+ it 'keeps the function name and every body line at their own lines' do
78
+ source = "#include \"engine.h\"\nPRIVATE int\nhelper(int a,\n int b)\n{\n return a + b;\n}\nint engine_get(void) { return helper( 20, 22 ); }\n"
79
+ result = engine( source, mode: mode )
80
+
81
+ expect( result.impl_c ).to match( /^#line 3 "[^"]*engine\.c"\nint helper\(int a, int b\)\n\n\{\n return a \+ b;\n\}/ )
82
+ link_cleanly( result, references: ['helper'] )
83
+ end
84
+
85
+ it 'links a selected function a macro makes static and inline' do
86
+ result = engine( "#include \"engine.h\"\nSTATICINLINE int twice(int v) { return v * 2; }\nint engine_get(void) { return twice( 21 ); }\n", mode: mode )
87
+
88
+ expect( result.impl_c ).to include( 'int twice(int v) { return v * 2; }' )
89
+ link_cleanly( result, references: ['twice', 'engine_get'] )
90
+ end
91
+ end
92
+ end
93
+
94
+ # A variable's storage class can come from a macro too. Its extern and its definition then
95
+ # take the expanded declaration, less `static`, so the two agree and the name links.
96
+ [:accurate, :fallback].each do |mode|
97
+ context "a file-scope variable, with #{mode} preprocessing" do
98
+ before { skip 'directives-only preprocessing is unavailable' if mode == :accurate and !directives_only_supported? }
99
+
100
+ it 'links a variable a macro makes static' do
101
+ result = engine( "#include \"engine.h\"\nPRIVATE int counter;\nint engine_get(void) { return counter; }\n", mode: mode )
102
+
103
+ expect( result.impl_h ).to include( 'extern int counter;' )
104
+ expect( result.impl_h ).not_to include( 'extern PRIVATE' )
105
+ link_cleanly( result, references: ['counter', 'engine_get'] )
106
+ end
107
+
108
+ it 'links a qualified array a macro makes static, with its initializer' do
109
+ result = engine( "#include \"engine.h\"\nPRIVATE const unsigned char table[LEN] = { 1, 2 };\nint engine_get(void) { return table[1]; }\n", mode: mode )
110
+
111
+ expect( result.impl_h ).to include( 'extern const unsigned char table[2];' )
112
+ expect( result.impl_c ).to include( 'const unsigned char table[2] = { 1, 2 };' )
113
+ link_cleanly( result, references: ['table', 'engine_get'] )
114
+ end
115
+
116
+ # A variable only declared extern gets a weak definition, however `extern` is spelled
117
+ it 'gives a variable a macro declares extern its weak definition' do
118
+ result = engine( "#include \"engine.h\"\nEXTERN int shared;\nint engine_get(void) { return shared; }\n", mode: mode )
119
+
120
+ expect( result.impl_h ).to include( 'extern int shared;' )
121
+ expect( result.impl_h ).not_to include( 'extern EXTERN' )
122
+ expect( result.impl_c ).to include( '__attribute__((weak)) int shared;' )
123
+ link_cleanly( result, references: ['shared', 'engine_get'] )
124
+ end
125
+
126
+ # A variable the module defines needs no weak definition, whatever its declaration says
127
+ it 'gives no weak definition to a variable a macro declares extern and the module defines' do
128
+ result = engine( "#include \"engine.h\"\nEXTERN int shared;\nint shared = 1;\nint engine_get(void) { return shared; }\n", mode: mode )
129
+
130
+ expect( result.impl_c ).not_to include( '__attribute__((weak))' )
131
+ link_cleanly( result, references: ['shared', 'engine_get'] )
132
+ end
133
+
134
+ it 'links each variable of a compound declaration a macro makes static' do
135
+ result = engine( "#include \"engine.h\"\nPRIVATE int low = 1, *high;\nint engine_get(void) { return low + (high != 0); }\n", mode: mode )
136
+
137
+ expect( result.impl_h ).to include( 'extern int low;' )
138
+ link_cleanly( result, references: ['low', 'high', 'engine_get'] )
139
+ end
140
+
141
+ # The type a macro hid ahead of it is named once and declared once
142
+ it 'links a variable a macro makes static that defines its own type' do
143
+ result = engine( "#include \"engine.h\"\nPRIVATE struct { int a; } state;\nint engine_get(void) { return state.a; }\n", mode: mode )
144
+
145
+ expect( result.types_h.scan( 'ceedling_partial_engine_state_t;' ).size ).to eq( 1 )
146
+ expect( result.impl_h ).to include( 'extern ceedling_partial_engine_state_t state;' )
147
+ link_cleanly( result, references: ['state', 'engine_get'] )
148
+ end
149
+
150
+ it 'links a variable a macro makes static that defines a tagged type' do
151
+ result = engine( "#include \"engine.h\"\nPRIVATE struct pair { int a; } first;\nint engine_get(void) { return first.a; }\n", mode: mode )
152
+
153
+ link_cleanly( result, references: ['first', 'engine_get'] )
154
+ end
155
+ end
156
+ end
157
+
158
+ # A macro after a type's closing brace, as `struct pk { … } PACKED;`, reads as a variable in
159
+ # the written text. The expansion shows the macro belongs to the type, so the type keeps it.
160
+ [:accurate, :fallback].each do |mode|
161
+ context "a type a macro ends, with #{mode} preprocessing" do
162
+ before { skip 'directives-only preprocessing is unavailable' if mode == :accurate and !directives_only_supported? }
163
+
164
+ def ended_types(declarations, mode:, extra: {}, includes: [])
165
+ header = "#ifndef ENGINE_H\n#define ENGINE_H\n#{includes.map { |name| "#include \"#{name}\"\n" }.join}" \
166
+ "#define PACKED __attribute__((packed))\n#define ALIGNED(n) __attribute__((aligned(n)))\n" \
167
+ "#{declarations}int engine_get(void);\n#endif\n"
168
+ engine( "#include \"engine.h\"\nint engine_get(void) { return 0; }\n", mode: mode, header: header, extra: extra, header_includes: includes )
169
+ end
170
+
171
+ # The link's test translation unit asserts the layout through the generated headers
172
+ def link_holding(result, assertion)
173
+ link = link_partial( result, references: ['engine_get'], stubs: "_Static_assert( #{assertion}, \"layout kept\" );\n", flags: '-Wall -Werror' )
174
+ expect( link.ok ).to be( true ), "expected a clean link, got: #{link.first_diagnostic}"
175
+ end
176
+
177
+ it 'keeps the macro with its type, so the type keeps its layout' do
178
+ result = ended_types( "struct pk { char c; int i; } PACKED;\n", mode: mode )
179
+
180
+ expect( result.types_h ).to include( 'struct pk { char c; int i; } PACKED;' )
181
+ expect( result.impl_h ).not_to match( /\bPACKED;/ )
182
+ link_holding( result, 'sizeof( struct pk ) == 5' )
183
+ end
184
+
185
+ # Variables after the macro read it as the start of their type, and the type keeps it too
186
+ {
187
+ 'one variable' => ["struct pk { char c; int i; } PACKED inst;\n", 'inst', 'sizeof( inst ) == 5'],
188
+ 'a static variable' => ["static struct pk { char c; int i; } PACKED inst;\n", 'inst', 'sizeof( inst ) == 5'],
189
+ 'two variables' => ["struct pk { char c; int i; } PACKED i1, i2;\n", 'i1', 'sizeof( i1 ) == 5 && sizeof( i2 ) == 5'],
190
+ 'an initialized const variable' => ["const struct pk { char c; int i; } PACKED inst = { 1, 2 };\n", 'inst', 'sizeof( inst ) == 5'],
191
+ 'a pointer' => ["struct pk { char c; int i; } PACKED *gp;\n", 'gp', 'sizeof( *gp ) == 5']
192
+ }.each do |shape, (declaration, variable, assertion)|
193
+ it "keeps the macro with its type ahead of #{shape}" do
194
+ result = engine( "#include \"engine.h\"\n#{declaration}int engine_get(void) { return sizeof( #{variable} ); }\n",
195
+ mode: mode, header: "#ifndef ENGINE_H\n#define ENGINE_H\n#define PACKED __attribute__((packed))\nint engine_get(void);\n#endif\n" )
196
+
197
+ expect( result.impl_h ).not_to match( /PACKED \*?#{variable}/ )
198
+ link = link_partial( result, references: [variable, 'engine_get'], stubs: "_Static_assert( #{assertion}, \"layout kept\" );\n", flags: '-Wall -Werror' )
199
+ expect( link.ok ).to be( true ), "expected a clean link, got: #{link.first_diagnostic}"
200
+ end
201
+ end
202
+
203
+ # A macro for a storage class or a qualifier after the brace belongs to the variable
204
+ it 'keeps a storage class and a qualifier a macro writes after the brace with the variable' do
205
+ header = "#ifndef ENGINE_H\n#define ENGINE_H\n#define PRIVATE static\n#define CONST const\nint engine_get(void);\n#endif\n"
206
+ source = "#include \"engine.h\"\nstruct pk { char c; int i; } PRIVATE inst;\nstruct pc { char c; } CONST ro = { 1 };\n" \
207
+ "int engine_get(void) { return inst.i + ro.c; }\n"
208
+ result = engine( source, mode: mode, header: header )
209
+
210
+ expect( result.types_h ).not_to match( /\}\s*(?:PRIVATE|CONST|static|const)\b/ )
211
+ link = link_partial( result, references: ['inst', 'ro', 'engine_get'], flags: '-Wall -Werror' )
212
+ expect( link.ok ).to be( true ), "expected a clean link, got: #{link.first_diagnostic}"
213
+ end
214
+
215
+ it 'keeps a function-like macro with its type' do
216
+ result = ended_types( "struct al { char c; } ALIGNED(8);\n", mode: mode )
217
+
218
+ expect( result.types_h ).to include( 'struct al { char c; } ALIGNED(8);' )
219
+ link_holding( result, '_Alignof( struct al ) == 8' )
220
+ end
221
+
222
+ it 'keeps the macro with a type a storage class declares alone' do
223
+ link_holding( ended_types( "static struct pk { char c; int i; } PACKED;\n", mode: mode ), 'sizeof( struct pk ) == 5' )
224
+ end
225
+
226
+ # The types header reaches the macro through the module header's own includes
227
+ it 'keeps a macro another header defines with its type' do
228
+ toolchain = "#ifndef TOOLCHAIN_H\n#define TOOLCHAIN_H\n#define TIGHT __attribute__((packed))\n#endif\n"
229
+ result = ended_types( "struct pk { char c; int i; } TIGHT;\n", mode: mode, extra: { 'toolchain.h' => toolchain }, includes: ['toolchain.h'] )
230
+
231
+ link_holding( result, 'sizeof( struct pk ) == 5' )
232
+ end
233
+
234
+ # A macro that names a real variable leaves a variable behind in the expansion too, and a
235
+ # forward declaration of its tag defines nothing that says otherwise
236
+ it 'keeps a variable a macro names after a type it defines' do
237
+ header = "#ifndef ENGINE_H\n#define ENGINE_H\n#define MY_VAR g_var\nint engine_get(void);\n#endif\n"
238
+ result = engine( "#include \"engine.h\"\nstruct pt;\nstruct pt { int a; } MY_VAR;\nint engine_get(void) { return MY_VAR.a; }\n", mode: mode, header: header )
239
+
240
+ expect( result.types_h ).not_to include( '} MY_VAR;' )
241
+ link = link_partial( result, references: ['MY_VAR', 'engine_get'], flags: '-Wall -Werror -fno-common' )
242
+ expect( link.ok ).to be( true ), "expected a clean link, got: #{link.first_diagnostic}"
243
+ end
244
+ end
245
+ end
246
+
247
+ context 'with accurate preprocessing' do
248
+ before { skip 'directives-only preprocessing is unavailable' unless directives_only_supported? }
249
+
250
+ it 'links a selected function from a source with CRLF line endings' do
251
+ source = "#include \"engine.h\"\r\nPRIVATE int helper(void)\r\n{\r\n return 41;\r\n}\r\nint engine_get(void) { return helper() + 1; }\r\n"
252
+ link_cleanly( engine( source, mode: :accurate ), references: ['helper', 'engine_get'] )
253
+ end
254
+
255
+ # The mock takes the private function's place, and the tested public one calls it
256
+ it 'compiles a public function under test that calls its private neighbor through the mock' do
257
+ result = engine(
258
+ "#include \"engine.h\"\nPRIVATE int helper(void) { return 41; }\nint engine_get(void) { return helper() + 1; }\n",
259
+ mode: :accurate, tests_expose: PartializerConfig::PUBLIC, mocks_expose: PartializerConfig::PRIVATE
260
+ )
261
+
262
+ expect( result.interface_h ).to include( 'int helper(void);' )
263
+ compile = compile_objects( result, flags: '-Wall -Werror' )
264
+ expect( compile.ok ).to be( true ), "expected a clean compile, got: #{compile.first_diagnostic}"
265
+ end
266
+ end
267
+ end