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
@@ -12,6 +12,8 @@ require 'ceedling/preprocess/preprocessinator_file_assembler'
12
12
  require 'ceedling/preprocess/preprocessinator_reconstructor'
13
13
  require 'ceedling/parsing_parcels'
14
14
  require 'ceedling/encodinator'
15
+ require 'ceedling/exceptions'
16
+ require 'ceedling/diagnostics/build_step_doctor'
15
17
 
16
18
  RSpec.describe PreprocessinatorFileAssembler do
17
19
  include IncludeGuardHelper
@@ -36,6 +38,22 @@ RSpec.describe PreprocessinatorFileAssembler do
36
38
 
37
39
  allow(@loginator).to receive(:log)
38
40
  allow(@reportinator).to receive(:generate_module_progress).and_return('')
41
+
42
+ # A real doctor whose one diagnosis records each preprocessing case it examines
43
+ @examined = []
44
+ recorder = BuildStepDoctor::Diagnosis.new(
45
+ name: :recorder, steps: [:preprocess], symptoms: /nested/, examination: ->(kase) { @examined << kase; 'guidance' }
46
+ )
47
+ specialists = %i[header_collision_specialist missing_symbol_specialist duplicate_symbol_specialist partial_name_specialist]
48
+ .to_h { |name| [name, double( name.to_s, diagnoses: [] )] }
49
+ @build_step_doctor = BuildStepDoctor.new(
50
+ loginator: @loginator, include_depth_specialist: double( 'specialist', diagnoses: [recorder] ), **specialists
51
+ ).tap( &:setup )
52
+ end
53
+
54
+ # The failure the full preprocessor raises for a self-including header
55
+ def nesting_failure()
56
+ ShellException.new( shell_result: { exit_code: 1, output: "a.h:1:20: error: #include nested too deeply\n" }, name: 'gcc' )
39
57
  end
40
58
 
41
59
  subject do
@@ -48,7 +66,8 @@ RSpec.describe PreprocessinatorFileAssembler do
48
66
  file_wrapper: @file_wrapper,
49
67
  parsing_parcels: real_parsing_parcels,
50
68
  loginator: @loginator,
51
- reportinator: @reportinator
69
+ reportinator: @reportinator,
70
+ build_step_doctor: @build_step_doctor
52
71
  }
53
72
  )
54
73
  end
@@ -304,6 +323,29 @@ RSpec.describe PreprocessinatorFileAssembler do
304
323
  )
305
324
  end
306
325
 
326
+ context 'when the full preprocessor fails' do
327
+
328
+ let(:include_paths) { ['vendor/include'] }
329
+
330
+ it 'diagnoses the failure as preprocessing and raises the same exception' do
331
+ failure = nesting_failure()
332
+ allow(@tool_executor).to receive(:exec).and_raise(failure)
333
+
334
+ expect { call_collect_mockable(fallback: true, extras: false) }.to raise_error( failure )
335
+ expect(@examined.map( &:step )).to eq( [:preprocess] )
336
+ expect(@examined.first.inputs).to eq(
337
+ { tool: :full_preprocessor, source: filepath, search_paths: include_paths, flags: flags, defines: defines }
338
+ )
339
+ expect(@loginator).to have_received(:log).with( 'guidance', Verbosity::ERRORS, LogLabels::NOTICE )
340
+ end
341
+
342
+ end
343
+
344
+ it 'diagnoses nothing when the full preprocessor succeeds' do
345
+ call_collect_mockable(fallback: true, extras: false)
346
+ expect(@examined).to be_empty
347
+ end
348
+
307
349
  context 'when extras are not requested' do
308
350
 
309
351
  it 'returns an empty extras list and a nil include guard' do
@@ -333,7 +375,7 @@ RSpec.describe PreprocessinatorFileAssembler do
333
375
  end
334
376
 
335
377
  it 'extracts the include guard from the original file in fallback mode' do
336
- allow(@file_wrapper).to receive(:read).with(filepath, 2048).and_return(header_with_guard)
378
+ allow(@file_wrapper).to receive(:read).with(filepath).and_return(header_with_guard)
337
379
  stub_file_open(filepath, header_with_guard, 'rb')
338
380
 
339
381
  _contents, _extras, include_guard = call_collect_mockable(fallback: true, extras: true)
@@ -341,16 +383,47 @@ RSpec.describe PreprocessinatorFileAssembler do
341
383
  end
342
384
 
343
385
  it 'extracts the include guard from the original file in directives-only mode' do
344
- allow(@file_wrapper).to receive(:read).with(filepath, 2048).and_return(header_with_guard)
386
+ allow(@file_wrapper).to receive(:read).with(filepath).and_return(header_with_guard)
345
387
  stub_file_open(directives_only_filepath, header_with_guard, 'r')
346
388
 
347
389
  _contents, _extras, include_guard = call_collect_mockable(fallback: false, extras: true)
348
390
  expect(include_guard).to eq('FOO_H')
349
391
  end
350
392
 
393
+ it 'extracts the include guard behind a license comment longer than the scan window' do
394
+ license = "/*\n" + (" * SPDX-License-Identifier: Apache-2.0 -- see the LICENSE file for terms.\n" * 40) + " */\n"
395
+ header = license + header_with_guard
396
+ allow(@file_wrapper).to receive(:read).with(filepath).and_return(header)
397
+ stub_file_open(directives_only_filepath, "# 1 \"#{filepath}\"\n#define FOO_H\n", 'r')
398
+
399
+ _contents, extras, include_guard = call_collect_mockable(fallback: false, extras: true)
400
+ expect(license.bytesize).to be > 2048
401
+ expect(include_guard).to eq('FOO_H')
402
+ expect(extras).to eq([])
403
+ end
404
+
405
+ # A marker naming a line already counted would otherwise glue the declaration onto the
406
+ # empty #define, and CMock would never see the function
407
+ it 'keeps an empty #define apart from the declaration after it in directives-only mode' do
408
+ allow(@file_wrapper).to receive(:read).with(filepath).and_return(header_with_guard)
409
+ directives_only = [
410
+ "# 1 \"#{filepath}\"",
411
+ '',
412
+ '',
413
+ ' #define CMSIS_DEPRECATED',
414
+ "# 2 \"#{filepath}\"",
415
+ '',
416
+ 'void __enable_irq(void);',
417
+ ].join("\n")
418
+ stub_file_open(directives_only_filepath, directives_only, 'r')
419
+
420
+ _contents, extras, _include_guard = call_collect_mockable(fallback: false, extras: true)
421
+ expect(extras).to eq(['#define CMSIS_DEPRECATED'])
422
+ end
423
+
351
424
  it 'returns a nil include guard when the original file has no #ifndef/#define guard pair' do
352
425
  header_without_guard = "#pragma once\n\nvoid foo(void);\n"
353
- allow(@file_wrapper).to receive(:read).with(filepath, 2048).and_return(header_without_guard)
426
+ allow(@file_wrapper).to receive(:read).with(filepath).and_return(header_without_guard)
354
427
  stub_file_open(filepath, header_without_guard, 'rb')
355
428
 
356
429
  _contents, _extras, include_guard = call_collect_mockable(fallback: true, extras: true)
@@ -419,7 +492,6 @@ RSpec.describe PreprocessinatorFileAssembler do
419
492
  expect(@file_wrapper).to receive(:mkdir).with('/build/files/drivers/spi')
420
493
 
421
494
  subject.assemble_preprocessed_code_file(
422
- filename: 'config.c',
423
495
  preprocessed_filepath: '/build/files/drivers/spi/config.c',
424
496
  contents: [], extras: [], includes: []
425
497
  )
@@ -568,7 +640,6 @@ RSpec.describe PreprocessinatorFileAssembler do
568
640
  output = stub_file_write(preprocessed_filepath)
569
641
 
570
642
  subject.assemble_preprocessed_code_file(
571
- filename: 'module.c',
572
643
  preprocessed_filepath: preprocessed_filepath,
573
644
  contents: ['void foo(void) {}'],
574
645
  extras: [],
@@ -583,7 +654,6 @@ RSpec.describe PreprocessinatorFileAssembler do
583
654
  stub_file_write(preprocessed_filepath)
584
655
 
585
656
  subject.assemble_preprocessed_code_file(
586
- filename: 'module.c',
587
657
  preprocessed_filepath: preprocessed_filepath,
588
658
  contents: [],
589
659
  extras: [],
@@ -598,7 +668,6 @@ RSpec.describe PreprocessinatorFileAssembler do
598
668
  content_line_with_crlf = "void foo(void) {\r\n return;\r\n}"
599
669
 
600
670
  subject.assemble_preprocessed_code_file(
601
- filename: 'module.c',
602
671
  preprocessed_filepath: preprocessed_filepath,
603
672
  contents: [content_line_with_crlf],
604
673
  extras: [],
@@ -612,7 +681,6 @@ RSpec.describe PreprocessinatorFileAssembler do
612
681
  output = stub_file_write(preprocessed_filepath)
613
682
 
614
683
  subject.assemble_preprocessed_code_file(
615
- filename: 'module.c',
616
684
  preprocessed_filepath: preprocessed_filepath,
617
685
  contents: [],
618
686
  extras: ['TEST_SOURCE_FILE("other.c")'],
@@ -626,7 +694,6 @@ RSpec.describe PreprocessinatorFileAssembler do
626
694
  output = stub_file_write(preprocessed_filepath)
627
695
 
628
696
  subject.assemble_preprocessed_code_file(
629
- filename: 'module.c',
630
697
  preprocessed_filepath: preprocessed_filepath,
631
698
  contents: [],
632
699
  extras: [ ['TEST_CASE(1, 2)', 'TEST_CASE(3, 4)'] ],
@@ -641,52 +708,58 @@ RSpec.describe PreprocessinatorFileAssembler do
641
708
 
642
709
 
643
710
  # ===========================================================================
644
- describe '#collect_file_contents_from_directives_only_preprocessing' do
711
+ describe '#collect_own_lines' do
645
712
  # ===========================================================================
646
713
 
647
- it 'extracts file content from the raw directives-only preprocessor output' do
714
+ it 'keeps only the lines a preprocessor run attributes to the file' do
648
715
  source_filepath = 'test/test_widget.c'
649
- allow(@file_path_utils).to receive(:form_preprocessed_file_raw_directives_only_filepath)
650
- .with(source_filepath, 'test_widget')
651
- .and_return('/build/directives_only/raw_test_widget.c')
652
-
653
716
  file_contents = [
654
717
  "# 1 \"#{source_filepath}\" 99999",
655
- 'void test_ShouldDoSomething(void) {}'
718
+ 'void test_ShouldDoSomething(void) {}',
719
+ "# 1 \"vendor/unity.h\" 1",
720
+ 'void UnityBegin(void);'
656
721
  ].join("\n")
657
- stub_file_open('/build/directives_only/raw_test_widget.c', file_contents, 'r')
722
+ stub_file_open('/build/directives_only/raw/test_widget.c', file_contents, 'r')
658
723
 
659
- result = subject.collect_file_contents_from_directives_only_preprocessing(
660
- source_filepath: source_filepath, test: 'test_widget'
724
+ result = subject.collect_own_lines(
725
+ source_filepath: source_filepath, preprocessed_filepath: '/build/directives_only/raw/test_widget.c', rejoin: false
661
726
  )
662
727
 
663
728
  expect(result).to eq(['void test_ShouldDoSomething(void) {}'])
664
729
  end
665
730
 
666
- end
731
+ # Directives-only output expands no macros, so it never wraps a line to rejoin
732
+ it 'keeps lines apart that a marker puts at the same count, without rejoining' do
733
+ source_filepath = 'src/widget.h'
734
+ file_contents = [
735
+ "# 1 \"#{source_filepath}\"",
736
+ 'int widget_a(void);',
737
+ "# 1 \"#{source_filepath}\"",
738
+ 'int widget_b(void);',
739
+ ].join("\n")
740
+ stub_file_open('/build/directives_only/raw/widget.h', file_contents, 'r')
667
741
 
742
+ result = subject.collect_own_lines(
743
+ source_filepath: source_filepath, preprocessed_filepath: '/build/directives_only/raw/widget.h', rejoin: false
744
+ )
668
745
 
669
- # ===========================================================================
670
- describe '#collect_file_contents_from_full_expansion' do
671
- # ===========================================================================
746
+ expect(result).to eq(['int widget_a(void);', 'int widget_b(void);'])
747
+ end
672
748
 
673
- it 'extracts file content from the full-expansion preprocessor output' do
749
+ # A full expansion re-marks one source line to continue it, so its pieces are joined
750
+ it 'rejoins a line a full expansion wrapped, by default' do
674
751
  source_filepath = 'src/module.c'
675
- allow(@file_path_utils).to receive(:form_preprocessed_file_full_expansion_filepath)
676
- .with(source_filepath, 'test_module')
677
- .and_return('/build/full_expansion/module.c')
678
-
679
752
  file_contents = [
680
- "# 1 \"#{source_filepath}\" 99999",
681
- 'void Module_Init(void) {}'
753
+ "# 1 \"#{source_filepath}\"",
754
+ 'int x',
755
+ "# 1 \"#{source_filepath}\"",
756
+ ';'
682
757
  ].join("\n")
683
758
  stub_file_open('/build/full_expansion/module.c', file_contents, 'r')
684
759
 
685
- result = subject.collect_file_contents_from_full_expansion(
686
- source_filepath: source_filepath, test: 'test_module'
687
- )
760
+ result = subject.collect_own_lines( source_filepath: source_filepath, preprocessed_filepath: '/build/full_expansion/module.c' )
688
761
 
689
- expect(result).to eq(['void Module_Init(void) {}'])
762
+ expect(result).to eq(['int x;'])
690
763
  end
691
764
 
692
765
  end
@@ -699,7 +772,7 @@ RSpec.describe PreprocessinatorFileAssembler do
699
772
  let(:source_filepath) { '/src/module.h' }
700
773
 
701
774
  it 'extracts pragmas and macro definitions, excluding the include guard\'s own #define' do
702
- allow(@file_wrapper).to receive(:read).with(source_filepath, 2048).and_return(
775
+ allow(@file_wrapper).to receive(:read).with(source_filepath).and_return(
703
776
  "#ifndef MODULE_H\n#define MODULE_H\n"
704
777
  )
705
778
  content = <<~C
@@ -720,7 +793,7 @@ RSpec.describe PreprocessinatorFileAssembler do
720
793
  end
721
794
 
722
795
  it 'filters out macros inside an inactive conditional block' do
723
- allow(@file_wrapper).to receive(:read).with(source_filepath, 2048).and_return('')
796
+ allow(@file_wrapper).to receive(:read).with(source_filepath).and_return('')
724
797
  content = <<~C
725
798
  #ifdef FEATURE_X
726
799
  #define FEATURE_MACRO 1
@@ -757,6 +830,21 @@ RSpec.describe PreprocessinatorFileAssembler do
757
830
  stub_file_open('/build/full_expansion/test_widget.c', full_expansion, 'r')
758
831
  end
759
832
 
833
+ it 'diagnoses a full preprocessor failure as preprocessing and raises the same exception' do
834
+ failure = nesting_failure()
835
+ allow(@tool_executor).to receive(:exec).and_raise(failure)
836
+
837
+ expect {
838
+ subject.collect_test_file_contents(
839
+ test: 'test_widget', filepath: filepath, directives_only_filepath: '/build/directives_only/test_widget.c',
840
+ fallback: true, flags: ['-w'], defines: ['TEST'], include_paths: ['vendor/include']
841
+ )
842
+ }.to raise_error( failure )
843
+ expect(@examined.first.inputs).to eq(
844
+ { tool: {}, source: filepath, search_paths: ['vendor/include'], flags: ['-w'], defines: ['TEST'] }
845
+ )
846
+ end
847
+
760
848
  it 'extracts contents from the full expansion and test directives via the fallback text scan when fallback: true' do
761
849
  original_content = <<~C
762
850
  TEST_SOURCE_FILE("other.c")
@@ -168,6 +168,15 @@ RSpec.describe PreprocessinatorIncludesHandler do
168
168
  expect(result.map(&:filename)).to contain_exactly('other.h')
169
169
  end
170
170
 
171
+ # Each entry is an #include as written, and a pathless one can name another header
172
+ it 'keeps a pathless #include beside a same-named one with a folder' do
173
+ allow(@tool_executor).to receive(:exec).and_return(
174
+ output: "test_other.o: #{isolated_filepath} mock_task.h other/mock_task.h\n\nmock_task.h:\n\nother/mock_task.h:\n"
175
+ )
176
+
177
+ expect(call_it().map(&:filepath)).to eq(['mock_task.h', 'other/mock_task.h'])
178
+ end
179
+
171
180
  end
172
181
 
173
182
 
@@ -420,6 +429,12 @@ RSpec.describe PreprocessinatorIncludesHandler do
420
429
  expect(result.map(&:filename)).to contain_exactly('foo.h')
421
430
  end
422
431
 
432
+ it 'keeps a pathless #include beside a same-named one with a folder' do
433
+ stub_file_open(filepath, "#include \"config.h\"\n#include \"app/config.h\"\n")
434
+ result = subject.extract_bare_includes_from_text(filepath: filepath)
435
+ expect(result.map(&:filepath)).to eq(['config.h', 'app/config.h'])
436
+ end
437
+
423
438
  end
424
439
 
425
440
 
@@ -325,6 +325,114 @@ describe PreprocessinatorReconstructor do
325
325
  expect( @extractor.extract_file_as_array_from_expansion( input, filepath ) ).to eq expected
326
326
  end
327
327
 
328
+ # A marker naming a line the scanner has already counted puts the next line at the same
329
+ # count as the line before the marker, which is how a wrapped expansion reads
330
+ [true, false].each do |rejoin|
331
+ it "never joins a declaration onto a #define behind a marker for a line already counted (rejoin: #{rejoin})" do
332
+ filepath = "stub/cmsis_gcc.h"
333
+
334
+ file_contents = [
335
+ '# 1 "stub/cmsis_gcc.h"',
336
+ '',
337
+ '',
338
+ ' #define CMSIS_DEPRECATED',
339
+ '# 2 "stub/cmsis_gcc.h"',
340
+ '',
341
+ 'void __enable_irq(void);',
342
+ 'void __disable_irq(void);',
343
+ ]
344
+
345
+ expected = [
346
+ ' #define CMSIS_DEPRECATED',
347
+ '',
348
+ 'void __enable_irq(void);',
349
+ 'void __disable_irq(void);',
350
+ ]
351
+
352
+ input = StringIO.new( file_contents.join( "\n" ) )
353
+
354
+ expect( @extractor.extract_file_as_array_from_expansion( input, filepath, rejoin: rejoin ) ).to eq expected
355
+ end
356
+ end
357
+
358
+ # GCC 14's full expansion of a CMSIS stub under -std=c99, as written on Linux. Returning from
359
+ # <stdint.h>, it pads with blank lines around the #define it keeps, then names line 19 again.
360
+ [true, false].each do |rejoin|
361
+ it "keeps a declaration apart from an empty #define in GCC's output for a CMSIS stub (rejoin: #{rejoin})" do
362
+ file_contents = [
363
+ '# 13 "stubs/cmsis_gcc.h" 2',
364
+ '', '', '',
365
+ '#define CMSIS_DEPRECATED ',
366
+ '', '', '',
367
+ '# 19 "stubs/cmsis_gcc.h"',
368
+ 'void __enable_irq(void);',
369
+ 'void __disable_irq(void);',
370
+ '',
371
+ 'uint32_t __get_PRIMASK(void);',
372
+ '',
373
+ 'void __DSB(void);'
374
+ ]
375
+
376
+ expected = [
377
+ '#define CMSIS_DEPRECATED', '', '', '',
378
+ 'void __enable_irq(void);',
379
+ 'void __disable_irq(void);',
380
+ '',
381
+ 'uint32_t __get_PRIMASK(void);',
382
+ '',
383
+ 'void __DSB(void);'
384
+ ]
385
+
386
+ input = StringIO.new( file_contents.join( "\n" ) + "\n" )
387
+
388
+ expect( @extractor.extract_file_as_array_from_expansion( input, 'stubs/cmsis_gcc.h', rejoin: rejoin ) ).to eq expected
389
+ end
390
+ end
391
+
392
+ # GCC and clang both give a mid-line _Pragma() a line of its own between two markers
393
+ # for the source line it sat on
394
+ it "keeps a #pragma on its own line between markers for the same source line" do
395
+ filepath = "path/f.c"
396
+
397
+ file_contents = [
398
+ '# 1 "path/f.c"',
399
+ 'int a;',
400
+ '# 1 "path/f.c"',
401
+ '#pragma pack(1)',
402
+ '# 1 "path/f.c"',
403
+ ' int b;',
404
+ 'int c;',
405
+ ]
406
+
407
+ expected = [
408
+ 'int a;',
409
+ '#pragma pack(1)',
410
+ ' int b;',
411
+ 'int c;',
412
+ ]
413
+
414
+ input = StringIO.new( file_contents.join( "\n" ) )
415
+
416
+ expect( @extractor.extract_file_as_array_from_expansion( input, filepath ) ).to eq expected
417
+ end
418
+
419
+ it "joins code lines a marker puts at the same count only when rejoining" do
420
+ filepath = "path/f.c"
421
+
422
+ file_contents = [
423
+ '# 1 "path/f.c"',
424
+ 'int a = WRAPPED(1,',
425
+ '# 1 "path/f.c"',
426
+ '2);',
427
+ ]
428
+
429
+ rejoined = StringIO.new( file_contents.join( "\n" ) )
430
+ apart = StringIO.new( file_contents.join( "\n" ) )
431
+
432
+ expect( @extractor.extract_file_as_array_from_expansion( rejoined, filepath ) ).to eq ['int a = WRAPPED(1, 2);']
433
+ expect( @extractor.extract_file_as_array_from_expansion( apart, filepath, rejoin: false ) ).to eq ['int a = WRAPPED(1,', '2);']
434
+ end
435
+
328
436
  it "should extract text of original file from staggered system include expansions" do
329
437
  filepath = "path/system_header_expansion.c"
330
438
 
@@ -528,6 +636,22 @@ describe PreprocessinatorReconstructor do
528
636
  # extract_file_as_string_from_expansion uses join("\n") with no trailing newline
529
637
  expect( output.string ).to eq( string_result + "\n" )
530
638
  end
639
+
640
+ it "keeps code lines a marker puts at the same count apart when not rejoining" do
641
+ file_contents = [
642
+ '# 1 "path/f.c"',
643
+ 'first();',
644
+ '# 1 "path/f.c"',
645
+ 'second();',
646
+ ]
647
+
648
+ output = StringIO.new
649
+ @extractor.compact_from_expansion(
650
+ input: StringIO.new( file_contents.join( "\n" ) ), filepath: 'path/f.c', output: output, rejoin: false
651
+ )
652
+
653
+ expect( output.string ).to eq( "first();\nsecond();\n" )
654
+ end
531
655
  end
532
656
 
533
657
  context "#extract_test_directive_macro_calls" do
@@ -754,6 +878,20 @@ describe PreprocessinatorReconstructor do
754
878
  end
755
879
  end
756
880
 
881
+ context "#pragma_once?" do
882
+ it "finds `#pragma once` in a header's leading code" do
883
+ expect( @extractor.pragma_once?( "#pragma once\nint x;\n" ) ).to be( true )
884
+ expect( @extractor.pragma_once?( "/* License */\n\n # pragma once\nint x;\n" ) ).to be( true )
885
+ end
886
+
887
+ it "finds none in a guarded header, another pragma, or a comment" do
888
+ expect( @extractor.pragma_once?( "#ifndef X_H\n#define X_H\nint x;\n#endif\n" ) ).to be( false )
889
+ expect( @extractor.pragma_once?( "#pragma pack(1)\nint x;\n" ) ).to be( false )
890
+ expect( @extractor.pragma_once?( "// #pragma once\n/* #pragma once */\nint x;\n" ) ).to be( false )
891
+ expect( @extractor.pragma_once?( "#pragma onceler\n" ) ).to be( false )
892
+ end
893
+ end
894
+
757
895
  context "#extract_include_guard" do
758
896
  it "should extract a simple include guard from among file text" do
759
897
  file_text = <<~FILE_TEXT
@@ -796,6 +934,51 @@ describe PreprocessinatorReconstructor do
796
934
 
797
935
  expect( @extractor.extract_include_guard( file_text ) ).to eq nil
798
936
  end
937
+
938
+ # A license comment longer than the scan window is ordinary in vendor headers
939
+ it "should extract an include guard behind a leading comment longer than the scan window" do
940
+ license = "/*\n" + (" * Licensed under the Apache License, Version 2.0 (the \"License\");\n" * 60) + " */\n"
941
+ file_text = license + <<~FILE_TEXT
942
+
943
+ // A line comment between the license and the guard
944
+
945
+ #ifndef __CMSIS_GCC_H
946
+ #define __CMSIS_GCC_H
947
+
948
+ #endif
949
+ FILE_TEXT
950
+
951
+ expect( license.bytesize ).to be > PreprocessinatorReconstructor::INCLUDE_GUARD_SCAN_BYTES
952
+ expect( @extractor.extract_include_guard( file_text ) ).to eq '__CMSIS_GCC_H'
953
+ end
954
+
955
+ it "should not extract an include guard from inside a comment" do
956
+ file_text = <<~FILE_TEXT
957
+ /* Usage:
958
+ #ifndef EXAMPLE_H
959
+ #define EXAMPLE_H
960
+ */
961
+ #ifndef REAL_H
962
+ #define REAL_H
963
+ #endif
964
+ FILE_TEXT
965
+
966
+ expect( @extractor.extract_include_guard( file_text ) ).to eq 'REAL_H'
967
+ end
968
+
969
+ # A header guarded by #pragma once has no guard, and a configuration default deep in it
970
+ # has the same shape as one
971
+ it "should not extract an include guard from beyond the scan window of code" do
972
+ declarations = (1..200).map { |n| "int some_function_#{n}(void);\n" }.join
973
+ file_text = "#pragma once\n" + declarations + <<~FILE_TEXT
974
+ #ifndef BUFFER_SIZE
975
+ #define BUFFER_SIZE 64
976
+ #endif
977
+ FILE_TEXT
978
+
979
+ expect( declarations.bytesize ).to be > PreprocessinatorReconstructor::INCLUDE_GUARD_SCAN_BYTES
980
+ expect( @extractor.extract_include_guard( file_text ) ).to eq nil
981
+ end
799
982
  end
800
983
 
801
984
  context "#extract_macro_defs" do
@@ -973,6 +1156,20 @@ describe PreprocessinatorReconstructor do
973
1156
 
974
1157
  expect( crlf_output.string ).to eq( lf_output.string )
975
1158
  end
1159
+
1160
+ it "keeps code lines a marker puts at the same count apart when not rejoining" do
1161
+ input_handle = StringIO.new( [ '# 1 "WANT.c"', 'first();', '# 1 "WANT.c"', 'second();' ].join( "\n" ) )
1162
+ output_handle = StringIO.new
1163
+
1164
+ allow(@file_wrapper).to receive(:open_with_retry).with( 'input.c', 'rb' ).and_yield( input_handle )
1165
+ allow(@file_wrapper).to receive(:open).with( 'output.c', 'wb' ).and_yield( output_handle )
1166
+
1167
+ @extractor.compact_file_from_expansion(
1168
+ input_filepath: 'input.c', source_filepath: 'WANT.c', output_filepath: 'output.c', rejoin: false
1169
+ )
1170
+
1171
+ expect( output_handle.string ).to eq( "first();\nsecond();\n" )
1172
+ end
976
1173
  end
977
1174
 
978
1175
  end