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
@@ -9,13 +9,15 @@ require 'rake' # For ext()
9
9
  require 'ceedling/constants'
10
10
  require 'ceedling/filename_extension'
11
11
  require 'ceedling/exceptions'
12
+ require 'ceedling/tools/tool_quoting'
12
13
 
13
14
  # Confirms a tool's configuration can run before a build depends on it.
14
15
  #
15
- # A tool is valid when its executable can be found and its stderr redirect is a known
16
- # option. The executable is an explicit path or a bare name searched on PATH, and either
17
- # may omit the extension its file carries on disk. An executable built at run time, from
18
- # an argument or a Ruby expansion, is left for the shell to resolve.
16
+ # A tool is valid when its executable and each argument close the quotes they open, its
17
+ # executable can be found and its stderr redirect is a known option. The executable is an
18
+ # explicit path or a bare name searched on PATH, and either may omit the extension its file
19
+ # carries on disk. An executable built at run time, from an argument or a Ruby expansion,
20
+ # is left for the shell to resolve.
19
21
  class ToolValidator
20
22
 
21
23
  constructor :file_wrapper, :loginator, :system_wrapper, :ruby_expandinator
@@ -63,9 +65,11 @@ class ToolValidator
63
65
  name = tool[:name] if name.nil? or name.empty?
64
66
  extension ||= default_extension()
65
67
 
66
- valid = validate_executable( tool:tool, name:name, extension:extension, respect_optional:respect_optional, boom:boom )
67
-
68
- # Both checks run, so a tool with two problems reports both
68
+ # Every check runs, so a tool with several problems reports each. An executable whose
69
+ # quote is unclosed can't be found, and saying so would only repeat the quoting error.
70
+ findings = ToolQuoting.findings( tool, name:name, windows:@system_wrapper.windows? )
71
+ valid = validate_quoting( findings, boom )
72
+ valid &= validate_executable( tool:tool, name:name, extension:extension, respect_optional:respect_optional, boom:boom ) unless findings.any?( &:unclosed_executable? )
69
73
  return valid & validate_stderr_redirect( tool:tool, name:name, boom:boom )
70
74
  end
71
75
 
@@ -73,6 +77,13 @@ class ToolValidator
73
77
 
74
78
  private
75
79
 
80
+ # An unclosed quote fails validation, and a typographic quote only warns
81
+ def validate_quoting(findings, boom)
82
+ findings.reject( &:error ).each { |finding| @loginator.log( finding.message, Verbosity::COMPLAIN ) }
83
+
84
+ return findings.select( &:error ).map { |finding| fail_validation( finding.message, boom ) }.all?
85
+ end
86
+
76
87
  def validate_executable(tool:, name:, extension:, respect_optional:, boom:)
77
88
  command = tool[:executable]
78
89
  executable = ToolValidator.executable_from( command )
@@ -82,8 +82,9 @@ class YamlWrapper
82
82
  # already picks the right calling convention for the installed Psych, so this should be
83
83
  # unreachable in practice; it exists as a last-resort safety net for an unanticipated
84
84
  # Psych version/interface mismatch, reported distinctly so it isn't mistaken for a user
85
- # YAML-authoring error.
86
- rescue ArgumentError => e
85
+ # YAML-authoring error. `::ArgumentError` names Ruby's own class, which the constructor
86
+ # gem's same-named class would otherwise shadow here.
87
+ rescue ::ArgumentError => e
87
88
  raise YamlLoadException.new(
88
89
  reason: :incompatible, source: source_label, original_error: e,
89
90
  message: "Installed Psych YAML library (#{Psych::VERSION}) does not support a safe-loading feature Ceedling requires ⏩️ #{e.message}"
data/lib/version.rb CHANGED
@@ -21,7 +21,7 @@ module Ceedling
21
21
  # Target version for the current release cycle. Maintained by hand, one edit
22
22
  # per minor or major cycle. Never edited to match a release tag. The release
23
23
  # pipeline rewrites this line from the tag that triggered it.
24
- BASE = '1.2.1'
24
+ BASE = '1.2.3'
25
25
 
26
26
  # Marker for a build the release pipeline did not produce. That pipeline
27
27
  # empties this line, so a published gem reports a bare version while a local
@@ -131,9 +131,7 @@ namespace BULLSEYE_REPORT_NAMESPACE_SYM do
131
131
 
132
132
  desc "Generate coverage reports (Note: a #{BULLSEYE_SYM}: task must be executed first)"
133
133
  task BULLSEYE_SYM do
134
- @ceedling[:bullseye].generate_html_report()
135
- # Does nothing unless :xml_report names a format
136
- @ceedling[:bullseye].generate_xml_report()
134
+ @ceedling[:bullseye].generate_coverage_reports()
137
135
  end
138
136
 
139
137
  end
@@ -51,7 +51,7 @@ DEFAULT_BULLSEYE_LINKER_TOOL = {
51
51
  }
52
52
 
53
53
  DEFAULT_BULLSEYE_FIXTURE_TOOL = {
54
- :executable => '${1}'.freeze,
54
+ :executable => '"${1}"'.freeze, # Test executable, quoted as a path
55
55
  :name => 'default_bullseye_fixture'.freeze,
56
56
  :optional => false.freeze,
57
57
  :arguments => [].freeze
@@ -220,7 +220,7 @@ class Bullseye < Plugin
220
220
  end
221
221
 
222
222
  header = "Untested source files not in the coverage report (:untested_sources is :list):"
223
- @loginator.log_list( untested_sources.sort, header, Verbosity::COMPLAIN, LogLabels::WARNING )
223
+ @loginator.log_list( untested_sources.sort, header, Verbosity::COMPLAIN )
224
224
 
225
225
  when BULLSEYE_UNTESTED_SOURCES_COMPILE
226
226
  untested_sources = collect_untested_sources( sources )
@@ -236,7 +236,7 @@ class Bullseye < Plugin
236
236
  untested_sources.each do |filepath|
237
237
  filename = File.basename(filepath)
238
238
  object = @ceedling[:file_path_utils].form_test_object_filepath( filepath, context: BULLSEYE_SYM )
239
- dependencies = @ceedling[:file_path_utils].form_test_dependencies_filepath( filepath, context: BULLSEYE_SYM )
239
+ dependencies = @ceedling[:file_path_utils].form_test_dependencies_filepath( object, context: BULLSEYE_SYM )
240
240
  search_paths = @configurator.collection_paths_include
241
241
  # Defines and flags resolve as a tested source's do, against this source's filepath
242
242
  flags = @ceedling[:test_build_setup].flags( context: BULLSEYE_SYM, operation: OPERATION_COMPILE_SYM, filepath: filepath )
@@ -263,6 +263,9 @@ class Bullseye < Plugin
263
263
  next
264
264
  end
265
265
 
266
+ @file_wrapper.mkdir( File.dirname( object ) )
267
+ @file_wrapper.mkdir( File.dirname( dependencies ) )
268
+
266
269
  begin
267
270
  @ceedling[:generator].generate_object_file_c(
268
271
  tool: TOOLS_BULLSEYE_COMPILER,
@@ -308,8 +311,21 @@ class Bullseye < Plugin
308
311
  end
309
312
  end
310
313
 
314
+ # Generates the HTML and XML reports from the coverage file on disk.
315
+ # Called externally by plugin Rakefile (report:bullseye).
316
+ #
317
+ # Rake runs a report task on the command line before post_build, so this applies the
318
+ # report exclusions itself. A fresh coverage file has none yet.
319
+ def generate_coverage_reports()
320
+ return if (verify_coverage_file() == false)
321
+
322
+ apply_report_exclusions()
323
+ generate_html_report()
324
+ generate_xml_report()
325
+ end
326
+
311
327
  # Generates a full interactive HTML coverage report to the artifacts directory.
312
- # Called within class and also externally by plugin Rakefile (report:bullseye / post_build).
328
+ # Called by post_build and generate_coverage_reports.
313
329
  def generate_html_report()
314
330
  begin
315
331
  @ceedling[:tool_validator].validate( tool: TOOLS_BULLSEYE_REPORT_COVHTML, boom: true )
@@ -326,7 +342,7 @@ class Bullseye < Plugin
326
342
  end
327
343
 
328
344
  # Generates a machine-readable coverage report for CI tooling.
329
- # Called within class and also externally by plugin Rakefile (report:bullseye / post_build).
345
+ # Called by post_build and generate_coverage_reports.
330
346
  # Does nothing unless :xml_report names a format.
331
347
  def generate_xml_report()
332
348
  format = @project_config[:bullseye_xml_report]
@@ -559,11 +575,10 @@ class Bullseye < Plugin
559
575
  coverage_sources = []
560
576
  @test_invoker.each_test_with_sources { |_, srcs| coverage_sources.concat( srcs ) }
561
577
  coverage_sources.uniq!
562
- # Every configured source extension is a valid ending for a mock/ignored-source name,
563
- # so the two are joined into one regex alternation rather than matching just one.
564
- source_extensions = EXTENSION_SOURCE.to_a.map { |ext| Regexp.escape(ext) }.join('|')
565
- coverage_sources.delete_if {|item| item =~ /#{@configurator.cmock_mock_prefix}.+(?:#{source_extensions})$/}
566
- coverage_sources.delete_if {|item| item =~ /(?:#{BULLSEYE_IGNORE_SOURCES.join('|')})(?:#{source_extensions})$/}
578
+ # Every configured source extension is a valid ending for a mock/ignored-source name
579
+ source_extensions = EXTENSION_SOURCE.pattern
580
+ coverage_sources.delete_if {|item| item =~ /#{@configurator.cmock_mock_prefix}.+#{source_extensions}$/}
581
+ coverage_sources.delete_if {|item| item =~ /(?:#{BULLSEYE_IGNORE_SOURCES.join('|')})#{source_extensions}$/}
567
582
 
568
583
  coverage_sources.each do |source|
569
584
  command = @ceedling[:tool_executor].build_command_line(TOOLS_BULLSEYE_REPORT_COVFN, [], source)
@@ -8,7 +8,7 @@
8
8
  require 'ceedling/constants'
9
9
  require 'ceedling/exceptions'
10
10
  require 'ceedling/plugins/plugin'
11
- require 'ceedling/tool_executor'
11
+ require 'ceedling/tools/tool_executor'
12
12
 
13
13
  COMMAND_HOOKS_ROOT_NAME = 'command_hooks'.freeze
14
14
  COMMAND_HOOKS_SYM = COMMAND_HOOKS_ROOT_NAME.to_sym
@@ -16,7 +16,7 @@ DEFAULT_CPPCHECK_TOOL = {
16
16
  :optional => true.freeze,
17
17
  :arguments => [
18
18
  '-I"${1}"'.freeze,
19
- '${2}'.freeze
19
+ '"${2}"'.freeze
20
20
  ].freeze
21
21
  }
22
22
 
@@ -26,9 +26,9 @@
26
26
  :name: 'Dependencies archiver'
27
27
  :optional: true # Checked when :build_lib archives, not by every Ceedling command
28
28
  :arguments:
29
- - rcs
30
- - ${2}
31
- - ${1}
29
+ - rcs
30
+ - '"${2}"' # Library
31
+ - '"${1}"' # Objects
32
32
 
33
33
  :deps_zip:
34
34
  :executable: unzip
@@ -36,7 +36,7 @@
36
36
  :optional: true
37
37
  :arguments:
38
38
  - -o
39
- - ${1} # Filepath
39
+ - '"${1}"' # Filepath
40
40
 
41
41
  :deps_targzip:
42
42
  :executable: tar
@@ -57,7 +57,7 @@
57
57
  - clone
58
58
  - ${1} # Optional branch with `-b` flag
59
59
  - ${2} # Optional depth with `--depth` flag
60
- - ${3} # Repository source
60
+ - '"${3}"' # Repository source
61
61
  - .
62
62
 
63
63
  :deps_git_checkout:
@@ -75,7 +75,7 @@
75
75
  :arguments:
76
76
  - checkout
77
77
  - ${1} # Optional branch with `--revision` flag
78
- - ${2} # Repository source
78
+ - '"${2}"' # Repository source
79
79
  - .
80
80
 
81
81
  ...
@@ -89,12 +89,15 @@
89
89
  task :prepare => all_deps
90
90
  end
91
91
 
92
- # Dependency libraries join the library names and paths test and release builds link with
92
+ # Dependency libraries join the library names and paths test and release builds link with,
93
+ # and their files join those the links depend on
93
94
  link_libraries = @ceedling[DEPENDENCIES_SYM].link_libraries
94
95
  PATHS_LIBRARIES ||= []
95
96
  PATHS_LIBRARIES.concat( link_libraries[:paths] ).uniq!
96
97
  LIBRARIES_SYSTEM ||= []
97
98
  LIBRARIES_SYSTEM.concat( link_libraries[:names] ).uniq!
99
+ LIBRARIES_LINK_FILES ||= []
100
+ LIBRARIES_LINK_FILES.concat( link_libraries[:files] ).uniq!
98
101
 
99
102
  # Add any artifact:include or :source folders to our release & test includes paths so linking and mocking work.
100
103
  @ceedling[DEPENDENCIES_SYM].add_headers_and_sources()
@@ -8,6 +8,8 @@
8
8
  require 'ceedling/plugins/plugin'
9
9
  require 'ceedling/constants'
10
10
  require 'ceedling/exceptions'
11
+ require 'ceedling/filesystem/project_paths'
12
+ require 'ceedling/filesystem/working_dir'
11
13
  require 'dependency_spec'
12
14
  require 'dependency_commands'
13
15
  require 'dependency_environment'
@@ -121,13 +123,15 @@ class Dependencies < Plugin
121
123
  end
122
124
  end
123
125
 
124
- # Library names and their directories, for test and release linking
126
+ # Library names and their directories, for test and release linking, and the library files
127
+ # themselves, which those links depend on
125
128
  def link_libraries
126
129
  libraries = @specs.flat_map { |spec| spec.static_libraries + spec.dynamic_libraries }
127
130
 
128
131
  return {
129
132
  names: libraries.map { |library| File.basename( library, '.*' ).delete_prefix( 'lib' ) }.reject( &:empty? ).uniq,
130
- paths: libraries.map { |library| File.dirname( library ) }.reject( &:empty? ).uniq
133
+ paths: libraries.map { |library| File.dirname( library ) }.reject( &:empty? ).uniq,
134
+ files: libraries.uniq
131
135
  }
132
136
  end
133
137
 
@@ -173,7 +177,7 @@ class Dependencies < Plugin
173
177
 
174
178
  # The one place this plugin changes directory, around a dependency's own commands
175
179
  def in_directory(path, &block)
176
- Dir.chdir( path, &block )
180
+ WorkingDir.chdir( path, &block )
177
181
  end
178
182
 
179
183
  # A fetch path that already holds files is taken as fetched, so fetching again, or
@@ -273,7 +277,7 @@ class Dependencies < Plugin
273
277
  end
274
278
 
275
279
  def compile(spec, source, search_paths)
276
- object = object_for( spec, source )
280
+ object = prepared_object( spec, source )
277
281
  @ceedling[:generator].generate_object_file_c(
278
282
  tool: TOOLS_DEPS_COMPILER,
279
283
  module_name: File.basename( source ).ext,
@@ -283,13 +287,13 @@ class Dependencies < Plugin
283
287
  search_paths: search_paths,
284
288
  flags: spec.flags,
285
289
  defines: spec.defines,
286
- list: @ceedling[:file_path_utils].form_release_build_list_filepath( File.basename( source ).ext )
290
+ list: @ceedling[:file_path_utils].form_release_build_list_filepath( object )
287
291
  )
288
292
  return object
289
293
  end
290
294
 
291
295
  def assemble(spec, source)
292
- object = object_for( spec, source )
296
+ object = prepared_object( spec, source )
293
297
  @ceedling[:generator].generate_object_file_asm(
294
298
  tool: TOOLS_DEPS_ASSEMBLER, module_name: File.basename( source ).ext, context: DEPENDENCIES_SYM,
295
299
  source: source, object: object
@@ -297,8 +301,14 @@ class Dependencies < Plugin
297
301
  return object
298
302
  end
299
303
 
300
- def object_for(spec, source)
301
- return File.join( spec.build_path, File.basename( source ).ext( EXTENSION_OBJECT.primary ) )
304
+ # A source's object sits at the source's own path below the dependency's source path, so
305
+ # same-named sources in different directories keep apart. Its directory is made here.
306
+ def prepared_object(spec, source)
307
+ subdir = ProjectPaths.subdir_below( spec.source_path, File.dirname( source ) ) || ''
308
+ object = File.join( spec.build_path, subdir, File.basename( source ).ext( EXTENSION_OBJECT.primary ) )
309
+
310
+ @ceedling[:file_wrapper].mkdir( File.dirname( object ) )
311
+ return object
302
312
  end
303
313
 
304
314
  def copy_library(built, destination)
@@ -6,14 +6,15 @@
6
6
  # =========================================================================
7
7
 
8
8
  require 'ceedling/exceptions'
9
+ require 'ceedling/filesystem/project_paths'
9
10
 
10
11
  # One configured dependency, validated and normalized.
11
12
  #
12
13
  # Each dependency names its paths under :paths, and each path falls back to another when
13
14
  # left out: :source and :fetch to each other, :build to :source then :fetch, :artifact to
14
15
  # :build. With none configured, every path is `dependencies/<task name>`. Artifacts
15
- # (libraries, executables, includes, sources) live under the artifact path. An optional
16
- # :deploy path receives deployed copies.
16
+ # (libraries, executables, includes, sources) live under the artifact path, unless named by
17
+ # an absolute path. An optional :deploy path receives deployed copies.
17
18
  #
18
19
  # The task name is the configured name's word characters, which `dependencies:*` tasks
19
20
  # use, so it must be non-empty and unique among dependencies.
@@ -47,7 +48,7 @@ class DependencySpec
47
48
  @name = dep[:name] or raise CeedlingException.new( 'Each dependency must have a :name.' )
48
49
  @task_name = task_name_for( @name )
49
50
  @fetch = dep[:fetch] || {}
50
- @paths = dep[:paths] || {}
51
+ @paths = standardized( dep[:paths] || {} )
51
52
  @artifacts = dep[:artifacts] || {}
52
53
 
53
54
  problem = fetch_problem
@@ -106,7 +107,7 @@ class DependencySpec
106
107
  # glob expands through `collector` against the disk, and anything else is a directory.
107
108
  def include_directories(collector)
108
109
  return Array( @artifacts[:includes] ).flat_map do |include|
109
- path = File.join( artifact_path, include )
110
+ path = artifact_at( include )
110
111
  if include.end_with?( '.h' ) then [File.dirname( path )]
111
112
  elsif include.match?( INCLUDE_GLOB ) then collector.call( path )
112
113
  else [path]
@@ -128,7 +129,18 @@ class DependencySpec
128
129
  end
129
130
 
130
131
  def artifacts(kind)
131
- return Array( @artifacts[kind] ).map { |path| File.join( artifact_path, path ) }
132
+ return Array( @artifacts[kind] ).map { |path| artifact_at( path ) }
133
+ end
134
+
135
+ # Configured paths, read as every configured path is read
136
+ def standardized(paths)
137
+ return paths.transform_values { |path| path.is_a?( String ) ? ProjectPaths.standardize( path ) : path }
138
+ end
139
+
140
+ # An artifact below the artifact path, or one named by an absolute path as written
141
+ def artifact_at(path)
142
+ path = ProjectPaths.standardize( path )
143
+ return ProjectPaths.absolute?( path ) ? path : File.join( artifact_path, path )
132
144
  end
133
145
 
134
146
  # What is wrong with the fetch configuration, or nil
@@ -10,6 +10,7 @@
10
10
  # ⏩️ https://github.com/ElectronVector/fake_function_framework
11
11
  # =========================================================================
12
12
 
13
+ require 'fileutils'
13
14
  require 'ceedling/plugins/plugin'
14
15
  require 'fff_mock_generator'
15
16
 
@@ -36,16 +37,17 @@ end # class Fff
36
37
 
37
38
  class FffCMockWrapper
38
39
 
39
- def initialize(options=nil)
40
+ def initialize(options=nil)
40
41
  @cm_config = CMockConfig.new(options)
41
42
  @cm_parser = CMockHeaderParser.new(@cm_config)
42
- @silent = (@cm_config.verbosity < 2)
43
-
44
- # These are the additional files to include in the mock files.
45
- @includes_h_pre_orig_header = (@cm_config.includes || @cm_config.includes_h_pre_orig_header || []).map{|h| h.match?(/</) ? h : "\"#{h}\""}
46
- @includes_h_post_orig_header = (@cm_config.includes_h_post_orig_header || []).map{|h| h.match?(/</) ? h : "\"#{h}\""}
47
- @includes_c_pre_header = (@cm_config.includes_c_pre_header || []).map{|h| h.match?(/</) ? h : "\"#{h}\""}
48
- @includes_c_post_header = (@cm_config.includes_c_post_header || []).map{|h| h.match?(/</) ? h : "\"#{h}\""}
43
+ # CMock's levels: 0 errors only, 1 warnings, 2 normal, 3 verbose
44
+ @verbosity = @cm_config.verbosity
45
+
46
+ # The additional files to include in the fake files, gathered as CMock gathers them
47
+ @includes_h_pre_orig_header = quoted( @cm_config.includes, @cm_config.includes_h_pre_orig_header )
48
+ @includes_h_post_orig_header = quoted( @cm_config.includes_h_post_orig_header )
49
+ @includes_c_pre_header = quoted( @cm_config.includes_c_pre_header )
50
+ @includes_c_post_header = quoted( @cm_config.includes_c_post_header )
49
51
  end
50
52
 
51
53
  # Matches CMock's own entry point, which Ceedling calls with the folder a mock's
@@ -57,52 +59,83 @@ class FffCMockWrapper
57
59
  end
58
60
 
59
61
  def generate_mock(header_file_to_mock, folder=nil)
60
- module_name = File.basename(header_file_to_mock, '.h')
61
- puts( "Creating fake functions for #{module_name}..." ) unless @silent
62
- mock_name = @cm_config.mock_prefix + module_name + @cm_config.mock_suffix
63
- mock_path = folder.nil? ? @cm_config.mock_path : File.join(@cm_config.mock_path, folder)
64
- if @cm_config.subdir
65
- # If a subdirectory has been configured, append it to the mock path.
66
- mock_path = "#{mock_path}/#{@cm_config.subdir}"
67
- end
68
- full_path_for_mock = "#{mock_path}/#{mock_name}"
69
- c_name = c_name_for(mock_name, folder)
70
-
71
- # Parse the header file so we know what to mock.
72
- parsed_header = @cm_parser.parse(module_name, File.read(header_file_to_mock))
73
-
74
- # Create the directory if it doesn't exist.
75
- mkdir_p full_path_for_mock.pathmap("%d")
76
-
77
- # Generate the fake function header file.
78
- puts( "Creating fake functions: #{full_path_for_mock}.h" )
79
-
80
- # Create the mock header.
81
- File.open("#{full_path_for_mock}.h", 'w') do |f|
82
- f.write(FffMockGenerator.create_mock_header(module_name, mock_name, parsed_header,
83
- @includes_h_pre_orig_header, @includes_h_post_orig_header, c_name: c_name))
84
- end
85
-
86
- # Create the mock source file.
87
- File.open("#{full_path_for_mock}.c", 'w') do |f|
88
- f.write(FffMockGenerator.create_mock_source(mock_name, parsed_header,
89
- @includes_c_pre_orig_header, @includes_c_post_orig_header, c_name: c_name))
90
- end
62
+ module_name = File.basename(header_file_to_mock, '.*')
63
+ puts( "Creating fake functions for #{module_name}..." ) unless @verbosity < 2
64
+ mock_name = @cm_config.mock_prefix + module_name + @cm_config.mock_suffix
65
+
66
+ # Parse the header file so we know what to mock.
67
+ parsed_header = @cm_parser.parse(module_name, File.read(header_file_to_mock))
68
+
69
+ path = "#{mock_path_for( folder )}/#{mock_name}"
70
+ write_fake( path, header_file_to_mock, mock_name, parsed_header, folder )
71
+ write_header_copy( File.join( File.dirname( path ), File.basename( header_file_to_mock ) ), parsed_header )
91
72
  end
92
73
 
93
- # The name for a fake's guard and control functions, as CMock forms it. With
94
- # :mock_name_include_folder, the folder below the mock root comes first, so two
95
- # same-named fakes stay distinct and match the runner's calls. A leading ./ is
96
- # dropped, and characters a C identifier can't hold become `_`, as Unity's
97
- # TypeSanitizer does.
74
+ # The name for a fake's guard and control functions, as CMock forms it. Every name has the
75
+ # characters a C identifier can't hold turned to `_`, as Unity's TypeSanitizer does. That is
76
+ # Unity's rule, not CIdentifier's, since the runner Unity generates must call the very names
77
+ # this forms. With :mock_name_include_folder, the folder below the mock root comes first, so
78
+ # two same-named fakes stay distinct and match the runner's calls. A leading ./ is dropped.
98
79
  def c_name_for(mock_name, folder)
99
80
  mock_folder = [@cm_config.subdir, folder].compact
100
- return mock_name unless @cm_config.mock_name_include_folder && !mock_folder.empty?
81
+ identity = mock_name
82
+ if @cm_config.mock_name_include_folder && !mock_folder.empty?
83
+ identity = File.join( *mock_folder, '' ).sub( %r{\A(?:\.[/\\])+}, '' ) + mock_name
84
+ end
101
85
 
102
- identity = File.join( *mock_folder, '' ).sub( %r{\A(?:\.[/\\])+}, '' ) + mock_name
103
86
  return identity.gsub( %r{[-/\\.,\s]}, '_' )
104
87
  end
105
88
 
89
+ private
90
+
91
+ # The directory a fake is written to: the mock root, the folder its #include names,
92
+ # then any configured :subdir
93
+ def mock_path_for(folder)
94
+ mock_path = folder.nil? ? @cm_config.mock_path : File.join( @cm_config.mock_path, folder )
95
+ return @cm_config.subdir ? "#{mock_path}/#{@cm_config.subdir}" : mock_path
96
+ end
97
+
98
+ # Writes the fake's header and source at `path`, which ends in the mock's name. The header
99
+ # takes the original header's extension, as CMock's mock does. `folder` is the one its
100
+ # #include names, which names the fake's C identifiers and through which the fake includes
101
+ # the original header.
102
+ def write_fake(path, header_file, mock_name, parsed_header, folder)
103
+ module_name = File.basename( header_file, '.*' )
104
+ module_ext = File.extname( header_file )
105
+ c_name = c_name_for( mock_name, folder )
106
+ FileUtils.mkdir_p( File.dirname( path ) )
107
+
108
+ puts( "Creating fake functions: #{path}#{module_ext} and #{path}.c" ) unless @verbosity < 3
109
+ File.write( "#{path}#{module_ext}", FffMockGenerator.create_mock_header( module_name, mock_name, parsed_header,
110
+ @includes_h_pre_orig_header, @includes_h_post_orig_header, c_name: c_name, header_include: header_include( module_name, module_ext, folder ) ) )
111
+
112
+ File.write( "#{path}.c", FffMockGenerator.create_mock_source( mock_name, parsed_header,
113
+ @includes_c_pre_header, @includes_c_post_header, c_name: c_name, mock_header: "#{mock_name}#{module_ext}" ) )
114
+ end
115
+
116
+ # Under :treat_inlines :include, the header's text without its inline bodies, written beside
117
+ # the fake as CMock writes it beside a mock. The fake's #include reaches this copy, so the
118
+ # header's inline definitions never meet the fake's.
119
+ def write_header_copy(path, parsed_header)
120
+ return unless @cm_config.treat_inlines == :include
121
+
122
+ File.write( path, parsed_header[:normalized_source] )
123
+ end
124
+
125
+ # The text a fake includes the original header by: the folder its #include names and the
126
+ # header's filename, as CMock writes it, or Ceedling's respelling where the test's search
127
+ # paths reach the header only by another spelling (:orig_header_include)
128
+ def header_include(module_name, module_ext, folder)
129
+ respelled = @cm_config.respond_to?( :orig_header_include ) ? @cm_config.orig_header_include : nil
130
+ return respelled || File.join( *[folder].compact, "#{module_name}#{module_ext}" )
131
+ end
132
+
133
+ # Joins include lists, each named once, as #include operands. A name holding `<` is
134
+ # kept as written, and any other is quoted, as CMock does.
135
+ def quoted(*lists)
136
+ return lists.compact.flatten.uniq.map { |name| name.match?( /</ ) ? name : "\"#{name}\"" }
137
+ end
138
+
106
139
  end
107
140
 
108
141
  # Switch out the CMock with FFF Mock Generator
@@ -23,14 +23,15 @@ class FffMockGenerator
23
23
  class << self
24
24
 
25
25
  # `c_name` names the include guard and control functions. It differs from the file's
26
- # `mock_name` when the mock is named by the folder its #include names.
26
+ # `mock_name` when the mock is named by the folder its #include names. `header_include` is
27
+ # the text the original header is included by.
27
28
  def create_mock_header(module_name, mock_name, parsed_header, pre_includes=nil,
28
- post_includes=nil, c_name: mock_name)
29
+ post_includes=nil, c_name: mock_name, header_include: "#{module_name}.h")
29
30
  output = StringIO.new
30
31
  write_opening_include_guard(c_name, output)
31
32
  output.puts
32
33
  write_extra_includes(pre_includes, output)
33
- write_header_includes(module_name, output)
34
+ write_header_includes(header_include, output)
34
35
  write_extra_includes(post_includes, output)
35
36
  output.puts
36
37
  write_typedefs(parsed_header, output)
@@ -43,11 +44,13 @@ class FffMockGenerator
43
44
  output.string
44
45
  end
45
46
 
47
+ # `mock_header` is the fake's header by the name the source includes it, which carries the
48
+ # original header's extension.
46
49
  def create_mock_source (mock_name, parsed_header, pre_includes=nil,
47
- post_includes=nil, c_name: mock_name)
50
+ post_includes=nil, c_name: mock_name, mock_header: "#{mock_name}.h")
48
51
  output = StringIO.new
49
52
  write_extra_includes(pre_includes, output)
50
- write_source_includes(mock_name, output)
53
+ write_source_includes(mock_header, output)
51
54
  write_extra_includes(post_includes, output)
52
55
  output.puts
53
56
  write_function_definitions(parsed_header, output)
@@ -65,10 +68,10 @@ class FffMockGenerator
65
68
  output.puts "#define #{mock_name}_H"
66
69
  end
67
70
 
68
- def write_header_includes(module_name, output)
71
+ def write_header_includes(header_include, output)
69
72
  output.puts %{#include "fff.h"}
70
73
  output.puts %{#include "fff_unity_helper.h"}
71
- output.puts %{#include "#{module_name}.h"}
74
+ output.puts %{#include "#{header_include}"}
72
75
  end
73
76
 
74
77
  def write_typedefs(parsed_header, output)
@@ -95,10 +98,10 @@ class FffMockGenerator
95
98
 
96
99
  # Source file generation functions.
97
100
 
98
- def write_source_includes (mock_name, output)
101
+ def write_source_includes (mock_header, output)
99
102
  output.puts "#include <string.h>"
100
103
  output.puts %{#include "fff.h"}
101
- output.puts %{#include "#{mock_name}.h"}
104
+ output.puts %{#include "#{mock_header}"}
102
105
  end
103
106
 
104
107
  def write_function_definitions(parsed_header, output)