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
@@ -0,0 +1,82 @@
1
+ # =========================================================================
2
+ # Ceedling - Test-Centered Build System for C
3
+ # ThrowTheSwitch.org
4
+ # Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
5
+ # SPDX-License-Identifier: MIT
6
+ # =========================================================================
7
+
8
+ require 'spec_system_helper'
9
+
10
+ ##
11
+ ## Launcher Hand-off
12
+ ## =================
13
+ ##
14
+ ## GH #1365: a launcher selecting another installation ran that installation's
15
+ ## application inside its own process. The gem's launcher now hands a `--local`
16
+ ## project's build to the vendored copy's own launcher, in its own process.
17
+ ##
18
+ ## spec/integration/launcher_handoff_spec.rb covers every command short of a build.
19
+ ## These run a real build through a hand-off, on every platform, where Windows
20
+ ## emulates the process replacement and must still carry the build's exit status.
21
+ ##
22
+
23
+ ceedling_system_tests do
24
+ before :all do
25
+ @c = SystemContext.new
26
+ @c.deploy_gem
27
+ end
28
+
29
+ after :all do
30
+ @c.done!
31
+ end
32
+
33
+ before { @proj_name = unique_proj_name("handoff") }
34
+
35
+ # A vendored copy reporting its own version, a test file with one failing test, and
36
+ # the Windows executable extension the build expects
37
+ def prepare_vendored_project
38
+ version_rb = File.join( 'vendor', 'ceedling', 'lib', 'version.rb' )
39
+ File.write( version_rb, File.read( version_rb ).sub( /BASE = '[^']+'/, "BASE = '9.9.9'" ) )
40
+
41
+ FileUtils.cp test_asset_path("example_file.h"), 'src/'
42
+ FileUtils.cp test_asset_path("example_file.c"), 'src/'
43
+ FileUtils.cp test_asset_path("test_example_file.c"), 'test/'
44
+
45
+ @c.remove_project_yml_option_for_test( :extension, :executable ) if /mingw|win32/.match?( RUBY_PLATFORM.downcase )
46
+ end
47
+
48
+ def expect_build_in_vendored_copy(output)
49
+ expect(@c.last_exit_status).to eq(1), output
50
+ expect(output).to match(/is handing off to Ceedling 9\.9\.9\S* at /)
51
+ expect(output).to match(/Ceedling 9\.9\.9\S* at .+ is now running, launched from Ceedling /)
52
+ expect(output).to match(/TESTED:\s+2/)
53
+ expect(output).to match(/PASSED:\s+1/)
54
+ expect(output).to match(/FAILED:\s+1/)
55
+ end
56
+
57
+ describe "A `--local` project run by the gem" do
58
+ before { @c.with_context { @c.ceedling_appcmd_exec("new --local #{@proj_name}") } }
59
+
60
+ it "builds in the vendored copy its :which_ceedling selects and exits with the build's status" do
61
+ @c.with_context do
62
+ Dir.chdir @proj_name do
63
+ prepare_vendored_project()
64
+
65
+ expect_build_in_vendored_copy( @c.ceedling_build_exec("test:all") )
66
+ end
67
+ end
68
+ end
69
+
70
+ it "builds in the vendored copy WHICH_CEEDLING selects over the project's own setting" do
71
+ @c.with_context do
72
+ Dir.chdir @proj_name do
73
+ prepare_vendored_project()
74
+ @c.merge_project_yml_for_test( {:project => {:which_ceedling => 'gem'}} )
75
+ ENV['WHICH_CEEDLING'] = 'vendor/ceedling'
76
+
77
+ expect_build_in_vendored_copy( @c.ceedling_build_exec("test:all") )
78
+ end
79
+ end
80
+ end
81
+ end
82
+ end
@@ -0,0 +1,212 @@
1
+ # =========================================================================
2
+ # Ceedling - Test-Centered Build System for C
3
+ # ThrowTheSwitch.org
4
+ # Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
5
+ # SPDX-License-Identifier: MIT
6
+ # =========================================================================
7
+
8
+ require 'spec_system_helper'
9
+
10
+ ##
11
+ ## Mocks Named by the Folders Their #includes Spell
12
+ ## ================================================
13
+ ##
14
+ ## CMock names a mock by the folder its #include names, and the compiler reaches the mock
15
+ ## through that #include as written. Mock generation, stand-ins, compiled sources and search
16
+ ## paths must all agree on where each mock lives (the path handling audit around GH #1370).
17
+ ##
18
+
19
+ MOCK_FOLDER_PREAMBLE = "#include \"unity.h\"\nvoid setUp(void) {}\nvoid tearDown(void) {}\n"
20
+
21
+ ceedling_system_tests do
22
+ include_context "a fresh ceedling gem project", "mock_folders"
23
+
24
+ def write(path, content)
25
+ FileUtils.mkdir_p( File.dirname( path ) )
26
+ File.write( path, content )
27
+ end
28
+
29
+ def build(include_paths, preprocessor: :none)
30
+ @c.merge_project_yml_for_test( { :project => { :use_test_preprocessor => preprocessor }, :paths => { :include => include_paths } } )
31
+ output = @c.ceedling_build_exec( "test:all" )
32
+
33
+ expect(@c.last_exit_status).to eq(0), output
34
+ expect(output).to match(/PASSED:\s+1/)
35
+ end
36
+
37
+ it "builds two same-named mocks whose #include folders alone tell them apart" do
38
+ in_project do
39
+ write( 'inc/a/foo.h', "int a_read(void);\n" )
40
+ write( 'inc/b/foo.h', "int b_read(void);\n" )
41
+ write( 'test/test_c.c', MOCK_FOLDER_PREAMBLE + "#include \"a/mock_foo.h\"\n#include \"b/mock_foo.h\"\n" \
42
+ "void test_reads(void) { a_read_ExpectAndReturn(5); b_read_ExpectAndReturn(6); TEST_ASSERT_EQUAL_INT(11, a_read() + b_read()); }\n" )
43
+
44
+ build( ['inc', 'inc/a', 'inc/b'] )
45
+ end
46
+ end
47
+
48
+ it "builds two same-named mocks through a search path that lists only their parent" do
49
+ in_project do
50
+ write( 'inc/a/foo.h', "int a_read(void);\n" )
51
+ write( 'inc/b/foo.h', "int b_read(void);\n" )
52
+ write( 'test/test_c.c', MOCK_FOLDER_PREAMBLE + "#include \"a/mock_foo.h\"\n#include \"b/mock_foo.h\"\n" \
53
+ "void test_reads(void) { a_read_ExpectAndReturn(5); b_read_ExpectAndReturn(6); TEST_ASSERT_EQUAL_INT(11, a_read() + b_read()); }\n" )
54
+
55
+ build( ['inc'] )
56
+ end
57
+ end
58
+
59
+ # The mocks root carries the test's name, which the #include's folder happens to share
60
+ it "builds a mock whose #include folder shares the test's own name" do
61
+ in_project do
62
+ write( 'inc/test_c/foo.h', "int foo_read(void);\n" )
63
+ write( 'test/test_c.c', MOCK_FOLDER_PREAMBLE + "#include \"test_c/mock_foo.h\"\nvoid test_reads(void) { foo_read_ExpectAndReturn(5); TEST_ASSERT_EQUAL_INT(5, foo_read()); }\n" )
64
+
65
+ build( ['inc', 'inc/test_c'] )
66
+ end
67
+ end
68
+
69
+ it "builds a mock whose #include spells more path than its header's mirror without naming it by folder" do
70
+ in_project do
71
+ @c.merge_project_yml_for_test( { :cmock => { :mock_name_include_folder => false } } )
72
+ write( 'inc/a/foo.h', "int foo_read(void);\n" )
73
+ write( 'test/test_c.c', MOCK_FOLDER_PREAMBLE + "#include \"inc/a/mock_foo.h\"\nvoid test_reads(void) { foo_read_ExpectAndReturn(5); TEST_ASSERT_EQUAL_INT(5, foo_read()); }\n" )
74
+
75
+ build( ['inc/**'] )
76
+ end
77
+ end
78
+
79
+ # Each stand-in opens as its real mock will, through its own folder, so a macro one header
80
+ # defines selects a mock only where that header is the one included
81
+ it "reconciles #includes through the header each same-named mock's folder names" do
82
+ in_project do
83
+ write( 'inc/a/foo.h', "int a_read(void);\n" )
84
+ write( 'inc/b/foo.h', "#define USE_B_EXTRA 1\nint b_read(void);\n" )
85
+ write( 'inc/extra.h', "int extra(void);\n" )
86
+ write( 'test/test_c.c', MOCK_FOLDER_PREAMBLE + "#include \"a/mock_foo.h\"\n#include \"b/mock_foo.h\"\n#if USE_B_EXTRA\n#include \"mock_extra.h\"\n#endif\n" \
87
+ "void test_reads(void) { a_read_ExpectAndReturn(5); b_read_ExpectAndReturn(6); extra_ExpectAndReturn(1); TEST_ASSERT_EQUAL_INT(12, a_read() + b_read() + extra()); }\n" )
88
+
89
+ build( ['inc/**'], preprocessor: :all )
90
+ end
91
+ end
92
+
93
+ it "leaves a mock #include in a branch that is off out of a preprocessed build" do
94
+ in_project do
95
+ write( 'inc/x/foo.h', "int foo_read(void);\n" )
96
+ write( 'test/test_c.c', MOCK_FOLDER_PREAMBLE + "#include \"x/mock_foo.h\"\n#if 0\n#include \"../legacy/mock_old.h\"\n#endif\n" \
97
+ "void test_reads(void) { foo_read_ExpectAndReturn(5); TEST_ASSERT_EQUAL_INT(5, foo_read()); }\n" )
98
+
99
+ build( ['inc/**'], preprocessor: :all )
100
+ end
101
+ end
102
+
103
+ # Test preprocessing finds each mock at its place below its mirror root, which can carry
104
+ # folders the test's #include never wrote. A mock keeps the name its #include gives it, so a
105
+ # test calling a mock's own functions calls them by that name in every preprocessing mode.
106
+ context "named by its #include in every preprocessing mode" do
107
+ [:mocks, :tests, :all].product( [false, true] ).each do |preprocessor, fallback|
108
+ mode = fallback ? ' with fallback preprocessing' : ''
109
+
110
+ it "names a mock of a header below its glob root by its #include under :use_test_preprocessor #{preprocessor}#{mode}" do
111
+ in_project do
112
+ @c.merge_project_yml_for_test( { :test_build => { :preprocess_force_fallback => true } } ) if fallback
113
+ write( 'rtos/include/task.h', "int task_run(int x);\n" )
114
+ write( 'test/test_c.c', MOCK_FOLDER_PREAMBLE + "#include \"mock_task.h\"\n" \
115
+ "void test_run(void) { task_run_ExpectAndReturn(1, 2); TEST_ASSERT_EQUAL_INT(2, task_run(1)); mock_task_Verify(); }\n" )
116
+
117
+ build( ['rtos/**'], preprocessor: preprocessor )
118
+ end
119
+ end
120
+ end
121
+
122
+ # A pathless mock and one naming a folder can mock two headers of one name, and two
123
+ # #includes of one header's mock give it one mock, named by the one with more path
124
+ [:none, :mocks, :tests, :all].each do |preprocessor|
125
+ it "keeps a pathless mock beside a same-named mock its folder names under :use_test_preprocessor #{preprocessor}" do
126
+ in_project do
127
+ write( 'rtos/include/task.h', "int task_run(int x);\n" )
128
+ write( 'rtos/other/task.h', "int other_run(int x);\n" )
129
+ write( 'test/test_c.c', MOCK_FOLDER_PREAMBLE + "#include \"mock_task.h\"\n#include \"other/mock_task.h\"\n" \
130
+ "void test_run(void) { task_run_ExpectAndReturn(1, 2); other_run_ExpectAndReturn(3, 4); " \
131
+ "TEST_ASSERT_EQUAL_INT(6, task_run(1) + other_run(3)); mock_task_Verify(); other_mock_task_Verify(); }\n" )
132
+
133
+ build( ['rtos/**'], preprocessor: preprocessor )
134
+ end
135
+ end
136
+
137
+ # The pathless mock's source sits in the test's mock root, which the other's name ends too
138
+ it "keeps a pathless mock of a header at a search path's root beside a same-named mock under :use_test_preprocessor #{preprocessor}" do
139
+ in_project do
140
+ write( 'inc/task.h', "int r_run(int x);\n" )
141
+ write( 'inc/b/task.h', "int b_run(int x);\n" )
142
+ write( 'test/test_c.c', MOCK_FOLDER_PREAMBLE + "#include \"mock_task.h\"\n#include \"b/mock_task.h\"\n" \
143
+ "void test_run(void) { r_run_ExpectAndReturn(0, 1); b_run_ExpectAndReturn(3, 4); TEST_ASSERT_EQUAL_INT(5, r_run(0) + b_run(3)); }\n" )
144
+
145
+ build( ['inc/**'], preprocessor: preprocessor )
146
+ end
147
+ end
148
+
149
+ it "gives one header one mock when two #includes name it under :use_test_preprocessor #{preprocessor}" do
150
+ in_project do
151
+ write( 'rtos/include/task.h', "int task_run(int x);\n" )
152
+ write( 'test/test_c.c', MOCK_FOLDER_PREAMBLE + "#include \"mock_task.h\"\n#include \"include/mock_task.h\"\n" \
153
+ "void test_run(void) { task_run_ExpectAndReturn(1, 2); TEST_ASSERT_EQUAL_INT(2, task_run(1)); include_mock_task_Verify(); }\n" )
154
+
155
+ build( ['rtos/**'], preprocessor: preprocessor )
156
+ end
157
+ end
158
+ end
159
+
160
+ # Neither folder reaches the other's mock, so each spelling keeps a file to reach
161
+ [:tests, :all].each do |preprocessor|
162
+ it "builds a test that names one header's mock by two folders under :use_test_preprocessor #{preprocessor}" do
163
+ in_project do
164
+ write( 'src/drivers/task.h', "int task_run(int x);\n" )
165
+ write( 'test/test_c.c', MOCK_FOLDER_PREAMBLE + "#include \"drivers/mock_task.h\"\n#include \"src/drivers/mock_task.h\"\n" \
166
+ "void test_run(void) { task_run_ExpectAndReturn(1, 2); TEST_ASSERT_EQUAL_INT(2, task_run(1)); }\n" )
167
+
168
+ build( ['src/**'], preprocessor: preprocessor )
169
+ end
170
+ end
171
+ end
172
+
173
+ it "names two same-named mocks by the folders their #includes write under :use_test_preprocessor all" do
174
+ in_project do
175
+ write( 'inc/x/a/foo.h', "int a_read(void);\n" )
176
+ write( 'inc/y/b/foo.h', "int b_read(void);\n" )
177
+ write( 'test/test_c.c', MOCK_FOLDER_PREAMBLE + "#include \"a/mock_foo.h\"\n#include \"b/mock_foo.h\"\n" \
178
+ "void test_reads(void) { a_read_ExpectAndReturn(5); b_read_ExpectAndReturn(6); " \
179
+ "TEST_ASSERT_EQUAL_INT(11, a_read() + b_read()); a_mock_foo_Verify(); b_mock_foo_Verify(); }\n" )
180
+
181
+ build( ['inc/**'], preprocessor: :all )
182
+ end
183
+ end
184
+
185
+ # The mock stays in its header's mirrored directory either way, so only its names change
186
+ [:none, :all].each do |preprocessor|
187
+ it "regenerates a mock whose #include drops its folder under :use_test_preprocessor #{preprocessor}" do
188
+ in_project do
189
+ write( 'rtos/include/task.h', "int task_run(int x);\n" )
190
+ body = "void test_run(void) { task_run_ExpectAndReturn(1, 2); TEST_ASSERT_EQUAL_INT(2, task_run(1)); }\n"
191
+ write( 'test/test_c.c', MOCK_FOLDER_PREAMBLE + "#include \"include/mock_task.h\"\n" + body )
192
+ build( ['rtos/**'], preprocessor: preprocessor )
193
+
194
+ write( 'test/test_c.c', MOCK_FOLDER_PREAMBLE + "#include \"mock_task.h\"\n" + body )
195
+ output = @c.ceedling_build_exec( "test:all" )
196
+ expect(@c.last_exit_status).to eq(0), output
197
+ expect(output).to match(/PASSED:\s+1/)
198
+ end
199
+ end
200
+ end
201
+
202
+ it "names a mock a macro in the test file names by that #include under :use_test_preprocessor all" do
203
+ in_project do
204
+ write( 'rtos/include/task.h', "int task_run(int x);\n" )
205
+ write( 'test/test_c.c', MOCK_FOLDER_PREAMBLE + "#define TASK_MOCK \"mock_task.h\"\n#include TASK_MOCK\n" \
206
+ "void test_run(void) { task_run_ExpectAndReturn(1, 2); TEST_ASSERT_EQUAL_INT(2, task_run(1)); mock_task_Verify(); }\n" )
207
+
208
+ build( ['rtos/**'], preprocessor: :all )
209
+ end
210
+ end
211
+ end
212
+ end
@@ -0,0 +1,184 @@
1
+ # =========================================================================
2
+ # Ceedling - Test-Centered Build System for C
3
+ # ThrowTheSwitch.org
4
+ # Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
5
+ # SPDX-License-Identifier: MIT
6
+ # =========================================================================
7
+
8
+ require 'spec_system_helper'
9
+
10
+ ##
11
+ ## Mockable Header Reassembly Through Real Builds
12
+ ## ==============================================
13
+ ##
14
+ ## With :cmock ↳ :treat_inlines: :include, Ceedling reassembles a mocked header from its
15
+ ## preprocessed copies before CMock reads it. A vendor header such as a CMSIS stub opens with
16
+ ## a license comment longer than the include guard scan window, includes <stdint.h> through
17
+ ## the compiler's wrapper header, and defines an empty macro just ahead of its declarations.
18
+ ## The reassembled header keeps the header's own guard, writes each include once, and leaves
19
+ ## every declaration on a line of its own for CMock to mock.
20
+ ##
21
+
22
+ MOCKABLE_REASSEMBLY_LICENSE =
23
+ "/*\n" +
24
+ (" * Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use\n" * 30) +
25
+ " */\n"
26
+
27
+ MOCKABLE_REASSEMBLY_STUB = MOCKABLE_REASSEMBLY_LICENSE + <<~C
28
+ #ifndef __CMSIS_GCC_H
29
+ #define __CMSIS_GCC_H
30
+
31
+ #include <stdint.h>
32
+
33
+ // avoid warnings about deprecated APIs during unit testing
34
+ #ifndef CMSIS_DEPRECATED
35
+ #define CMSIS_DEPRECATED
36
+ #endif
37
+
38
+ void __enable_irq(void);
39
+ void __disable_irq(void);
40
+ uint32_t __get_PRIMASK(void);
41
+ void __DSB(void);
42
+
43
+ #endif
44
+ C
45
+
46
+ MOCKABLE_REASSEMBLY_TEST = <<~C
47
+ #include "unity.h"
48
+ #include "mock_cmsis_gcc.h"
49
+
50
+ void setUp(void) {}
51
+ void tearDown(void) {}
52
+
53
+ void test_enable_irq_is_mocked(void)
54
+ {
55
+ __enable_irq_Expect();
56
+ __enable_irq();
57
+ }
58
+
59
+ void test_get_primask_is_mocked(void)
60
+ {
61
+ __get_PRIMASK_ExpectAndReturn(1);
62
+ TEST_ASSERT_EQUAL_UINT32(1, __get_PRIMASK());
63
+ }
64
+ C
65
+
66
+ ceedling_system_tests do
67
+ include_context "a fresh ceedling gem project", "mockable_reassembly"
68
+
69
+ before do
70
+ in_project do
71
+ FileUtils.mkdir_p( 'test/stubs' )
72
+ File.write( 'test/stubs/cmsis_gcc.h', MOCKABLE_REASSEMBLY_STUB )
73
+ File.write( 'test/test_sysint.c', MOCKABLE_REASSEMBLY_TEST )
74
+
75
+ @c.merge_project_yml_for_test( {
76
+ :project => { :use_mocks => true, :use_test_preprocessor => :all },
77
+ :paths => { :include => ['src/**', 'test/stubs'] },
78
+ :cmock => { :treat_inlines => :include }
79
+ } )
80
+ end
81
+ end
82
+
83
+ # The reassembled header CMock read, not the preprocessor's own intermediate copies
84
+ def reassembled_header
85
+ found = Dir.glob( 'build/test/preprocess/files/**/cmsis_gcc.h' ).reject do |path|
86
+ path.include?( '/directives_only/' ) or path.include?( '/full_expansion/' )
87
+ end
88
+ expect(found.size).to eq(1), found.inspect
89
+
90
+ return File.read( found.first )
91
+ end
92
+
93
+ it "mocks every declaration of a vendor header behind a long license and an empty macro" do
94
+ in_project do
95
+ # Longer than the include guard scan window
96
+ expect( MOCKABLE_REASSEMBLY_LICENSE.bytesize ).to be > 2048
97
+
98
+ output = @c.ceedling_build_exec( "test:all" )
99
+ expect(@c.last_exit_status).to eq(0), output
100
+ expect(output).to match(/PASSED:\s+2/)
101
+
102
+ header = reassembled_header()
103
+ expect(header).to start_with( "#ifndef __CMSIS_GCC_H\n#define __CMSIS_GCC_H\n" )
104
+ expect(header.scan(/^\s*#define __CMSIS_GCC_H\b/).size).to eq(1), header
105
+ expect(header.scan(/^#include <stdint\.h>$/).size).to eq(1), header
106
+ expect(header).to match(/^\s*#define CMSIS_DEPRECATED\s*$/)
107
+ expect(header).to match(/^void __enable_irq\(void\);$/)
108
+ end
109
+ end
110
+
111
+ # A pathless #include and one naming a folder reach two headers of one name. The header
112
+ # prepared for CMock keeps both, in either order.
113
+ [:mocks, :all].product( [%w[config.h app/config.h], %w[app/config.h config.h]] ).each do |preprocessor, order|
114
+ it "keeps both same-named #includes of a mocked header, #{order.join(' then ')}, under :use_test_preprocessor #{preprocessor}" do
115
+ in_project do
116
+ FileUtils.mkdir_p( ['src/hw', 'lib/app'] )
117
+ File.write( 'src/hw/config.h', "#ifndef HW_CONFIG_H\n#define HW_CONFIG_H\ntypedef int hw_t;\n#endif\n" )
118
+ File.write( 'lib/app/config.h', "#ifndef APP_CONFIG_H\n#define APP_CONFIG_H\ntypedef int app_t;\n#endif\n" )
119
+ File.write( 'lib/motor.h', "#ifndef MOTOR_H\n#define MOTOR_H\n" + order.map { |text| "#include \"#{text}\"\n" }.join +
120
+ "static inline int motor_peek(void) { return 0; }\nhw_t motor_run(app_t a);\n#endif\n" )
121
+ File.write( 'test/test_motor.c', "#include \"unity.h\"\n#include \"mock_motor.h\"\nvoid setUp(void) {}\nvoid tearDown(void) {}\n" \
122
+ "void test_run(void) { motor_run_ExpectAndReturn(1, 9); TEST_ASSERT_EQUAL_INT(9, motor_run(1)); }\n" )
123
+ @c.remove_project_yml_option_for_test( :paths, :include )
124
+ @c.merge_project_yml_for_test( { :project => { :use_test_preprocessor => preprocessor }, :paths => { :include => ['src/hw/', 'lib/', 'test/stubs'] } } )
125
+
126
+ output = @c.ceedling_build_exec( "test:all" )
127
+ expect(@c.last_exit_status).to eq(0), output
128
+ expect(output).to match(/PASSED:\s+3/)
129
+ end
130
+ end
131
+ end
132
+
133
+ # An #include names a header beside its includer, which an earlier search path shadows with a
134
+ # header of the same name. No search path reaches the one beside it, so the copy writes it by
135
+ # its absolute path.
136
+ [:mocks, :all].each do |preprocessor|
137
+ it "mocks a header whose #include names a header beside it that an earlier search path shadows, under :use_test_preprocessor #{preprocessor}" do
138
+ in_project do
139
+ FileUtils.mkdir_p( ['src/hw', 'lib'] )
140
+ File.write( 'src/hw/config.h', "#ifndef HW_CONFIG_H\n#define HW_CONFIG_H\ntypedef int hw_t;\n#endif\n" )
141
+ File.write( 'lib/config.h', "#ifndef LIB_CONFIG_H\n#define LIB_CONFIG_H\n#define LIB_K 1\n#endif\n" )
142
+ File.write( 'lib/util.h', "#ifndef UTIL_H\n#define UTIL_H\n#include \"config.h\"\nint util_k(void);\n#endif\n" )
143
+ File.write( 'lib/motor.h', "#ifndef MOTOR_H\n#define MOTOR_H\n#include \"config.h\"\n#include \"hw/config.h\"\n#include \"util.h\"\n" \
144
+ "static inline int motor_peek(void) { return 0; }\nhw_t motor_run(int a);\n#endif\n" )
145
+ File.write( 'test/test_motor.c', "#include \"unity.h\"\n#include \"mock_motor.h\"\nvoid setUp(void) {}\nvoid tearDown(void) {}\n" \
146
+ "void test_run(void) { motor_run_ExpectAndReturn(1, 9); TEST_ASSERT_EQUAL_INT(9, motor_run(1)); }\n" )
147
+ @c.remove_project_yml_option_for_test( :paths, :include )
148
+ @c.merge_project_yml_for_test( { :project => { :use_test_preprocessor => preprocessor }, :paths => { :include => ['src/hw/', 'src/', 'lib/', 'test/stubs'] },
149
+ :cmock => { :treat_inlines => :include } } )
150
+
151
+ output = @c.ceedling_build_exec( "test:all" )
152
+ expect(@c.last_exit_status).to eq(0), output
153
+ expect(output).to match(/PASSED:\s+3/)
154
+ end
155
+ end
156
+ end
157
+
158
+ # Under fallback the copy's #includes are read as written, not resolved by the compiler. The one
159
+ # beside its includer is still written by its absolute path, never the shadowing header's name.
160
+ [:mocks, :all].each do |preprocessor|
161
+ it "writes the copy's #include of a header beside it that an earlier search path shadows by its absolute path under fallback, under :use_test_preprocessor #{preprocessor}" do
162
+ in_project do
163
+ FileUtils.mkdir_p( ['src/hw', 'lib'] )
164
+ File.write( 'src/hw/config.h', "#ifndef HW_CONFIG_H\n#define HW_CONFIG_H\ntypedef int hw_t;\n#endif\n" )
165
+ File.write( 'lib/config.h', "#ifndef LIB_CONFIG_H\n#define LIB_CONFIG_H\n#define LIB_K 1\n#endif\n" )
166
+ File.write( 'lib/motor.h', "#ifndef MOTOR_H\n#define MOTOR_H\n#include \"config.h\"\n" \
167
+ "static inline int motor_peek(void) { return 0; }\nint motor_run(int a);\n#endif\n" )
168
+ File.write( 'test/test_motor.c', "#include \"unity.h\"\n#include \"mock_motor.h\"\nvoid setUp(void) {}\nvoid tearDown(void) {}\n" \
169
+ "void test_run(void) { motor_run_ExpectAndReturn(1, 9); TEST_ASSERT_EQUAL_INT(9, motor_run(1)); }\n" )
170
+ @c.remove_project_yml_option_for_test( :paths, :include )
171
+ @c.merge_project_yml_for_test( { :project => { :use_test_preprocessor => preprocessor }, :paths => { :include => ['src/hw/', 'lib/', 'test/stubs'] },
172
+ :cmock => { :treat_inlines => :include }, :test_build => { :preprocess_force_fallback => true } } )
173
+
174
+ output = @c.ceedling_build_exec( "test:all" )
175
+ expect(@c.last_exit_status).to eq(0), output
176
+ expect(output).to match(/PASSED:\s+3/)
177
+
178
+ copies = Dir.glob( 'build/test/preprocess/files/**/motor.h' ).reject { |path| path.include?( '/directives_only/' ) or path.include?( '/full_expansion/' ) }
179
+ expect(copies.size).to eq(1), copies.inspect
180
+ expect(File.readlines( copies.first ).grep( /config\.h/ )).to eq( ["#include \"#{File.join( File.realpath( '.' ), 'lib/config.h' )}\"\n"] )
181
+ end
182
+ end
183
+ end
184
+ end
@@ -98,12 +98,14 @@ ceedling_system_tests do
98
98
 
99
99
  before { copy_dotdot_include_assets }
100
100
 
101
- it "fails clearly, naming .. as unsupported rather than a generic file-not-found" do
101
+ # GH #1370 audit (G9): a task name is relative to the working directory, as every
102
+ # collected path is, so `..` names a place outside the project, where no test exists here
103
+ it "looks for the test outside the project, and names it when none is there" do
102
104
  in_project do
103
105
  output = @c.ceedling_build_exec("test:../unit/test_dotdot_include")
104
106
  expect(@c.last_exit_status).to_not eq(0)
105
- expect(output).to match(/\.\./)
106
- expect(output).to match(/context/i)
107
+ expect(output).to include("../unit/test_dotdot_include")
108
+ expect(output).to_not match(/no file context/i)
107
109
  end
108
110
  end
109
111