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,179 @@
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 'ceedling/constants'
9
+ require 'ceedling/filesystem/file_path_utils' # for glob handling class methods
10
+ require 'ceedling/filesystem/project_paths'
11
+ require 'ceedling/config/build_root_policy'
12
+
13
+ # Checks the paths a project file names against the filesystem: each :paths and :files
14
+ # entry, and paths named singly
15
+ class ConfiguratorPathsValidator
16
+
17
+ constructor :config_walkinator, :file_wrapper, :loginator, :reportinator
18
+
19
+ # Walk into config hash. verify existence of path(s) at given key depth.
20
+ # Paths are either full simple paths or a simple portion of a path up to a glob.
21
+ def validate_path_list(config, *keys)
22
+ list, depth = @config_walkinator.fetch_value( *keys, hash:config )
23
+ return false if list.nil?
24
+
25
+ # Trimming add/subtract notation and glob specifiers leaves nothing of a path that
26
+ # begins with a glob, so there is nothing to check
27
+ missing = checked_bases( list ).reject { |path| path.empty? or @file_wrapper.exist?( path ) }
28
+
29
+ walk = @reportinator.generate_config_walk( keys, depth )
30
+ missing.each { |path| log_error( "Config path #{walk} => '#{path}' does not exist in the filesystem." ) }
31
+
32
+ return missing.empty?
33
+ end
34
+
35
+
36
+ # Validate :paths entries, exercising each entry as Ceedling directory glob (variation of Ruby glob)
37
+ def validate_paths_entries(config, key)
38
+ return validate_entries( config, :paths, key ) { |entry, walk, build_root| valid_paths_entry?( entry, walk, build_root ) }
39
+ end
40
+
41
+
42
+ # Validate :files entries, exercising each entry as FileList glob
43
+ def validate_files_entries(config, key)
44
+ return validate_entries( config, :files, key ) { |entry, walk, build_root| valid_files_entry?( entry, walk, build_root ) }
45
+ end
46
+
47
+
48
+ # A build root of its own, warning of each :paths and :files entry within it (BuildRootPolicy)
49
+ def validate_build_root(config)
50
+ root = config[:project][:build_root].to_s
51
+ problem = BuildRootPolicy.problem( root )
52
+ log_error( BuildRootPolicy.message( root, problem ) ) unless problem.nil?
53
+ return false unless problem.nil?
54
+
55
+ BuildRootPolicy.warnings( root, config ) { |keys| @reportinator.generate_config_walk( keys ) }.each { |warning| log_complaint( warning ) }
56
+ return true
57
+ end
58
+
59
+
60
+ # Simple path verification
61
+ def validate_filepath_simple(path, *keys)
62
+ return true if @file_wrapper.exist?( path )
63
+
64
+ walk = @reportinator.generate_config_walk( keys, keys.size )
65
+ log_error( "Config path '#{path}' associated with #{walk} does not exist in the filesystem." )
66
+ return false
67
+ end
68
+
69
+ ### Private ###
70
+
71
+ private
72
+
73
+ # Each entry of one :paths or :files list, usable and passing `check`
74
+ def validate_entries(config, section, key)
75
+ list, _ = @config_walkinator.fetch_value( section, key, hash:config )
76
+ return false if list.nil?
77
+
78
+ walk = @reportinator.generate_config_walk( [section, key] )
79
+ build_root = config.dig( :project, :build_root )
80
+ return list.map { |entry| usable_entry?( entry, walk ) && yield( entry, walk, build_root ) }.all?
81
+ end
82
+
83
+ # Each additive entry's path up to its first glob. An entry YAML read as something other
84
+ # than a string, and a `-:` entry, which may name nothing, are left to the entries validation.
85
+ def checked_bases(list)
86
+ return list.grep( String ).select { |path| FilePathUtils.add_path?( path ) }.map { |path| FilePathUtils::no_decorators( path ) }
87
+ end
88
+
89
+ # A :paths or :files entry that names no path, or wraps its path in quotes, usually
90
+ # quotes only the path after its decoration. YAML keeps those quote marks as part of
91
+ # the value, so the hint points at quoting the whole entry. YAML also reads an unquoted
92
+ # decoration with nothing after it (`- -:`) as a one-key mapping rather than a string.
93
+ ENTRY_QUOTING_HINT = 'Quote the whole entry, decoration included (e.g. "-:path/to/file.c"), ' +
94
+ 'not only the path after its +: or -: decoration.'
95
+
96
+ def usable_entry?(entry, walk)
97
+ path = entry.is_a?( String ) ? FilePathUtils::no_aggregation_decorators( entry ) : ''
98
+
99
+ problem =
100
+ if !entry.nil? and !entry.is_a?( String ) then "is not a path (YAML read it as a #{entry.class})"
101
+ elsif path.empty? then 'names no path'
102
+ elsif path.start_with?( '"', "'" ) then 'wraps its path in quotes'
103
+ end
104
+ return true if problem.nil?
105
+
106
+ log_error( "#{walk} => '#{entry}' #{problem}" )
107
+ log_error( ENTRY_QUOTING_HINT )
108
+ return false
109
+ end
110
+
111
+ # A path naming a file is ignored with a warning. Any other entry must yield directories,
112
+ # except a subdirectories glob of a directory that has none, and a `-:` entry.
113
+ def valid_paths_entry?(entry, walk, build_root)
114
+ path = FilePathUtils::no_aggregation_decorators( entry )
115
+
116
+ if @file_wrapper.exist?( path ) and !@file_wrapper.directory?( path )
117
+ log_complaint( "#{walk} => '#{path}' is a filepath and will be ignored (FYI :paths is directory-oriented while :files is file-oriented)" )
118
+ return true
119
+ end
120
+
121
+ return valid_subtraction?( entry, path, walk, build_root ) unless FilePathUtils.add_path?( entry )
122
+ return true if globbed_directories?( path ) or path =~ /\/\*{1,2}$/
123
+
124
+ log_error( "#{walk} => '#{path}' yielded no directories -- matching glob is malformed or directories do not exist" )
125
+ return false
126
+ end
127
+
128
+ # A `-:` entry leaves out what it names, or warns of naming nothing. A subdirectories glob
129
+ # names its directory too.
130
+ def valid_subtraction?(entry, path, walk, build_root)
131
+ named = path.match?( %r{/\*{1,2}\z} ) ? @file_wrapper.exist?( FilePathUtils.no_decorators( entry ) ) : @file_wrapper.exist?( path )
132
+ return true if named or globbed_directories?( path )
133
+
134
+ return subtracts_nothing( entry, walk, build_root, 'directory' )
135
+ end
136
+
137
+ # A `-:` entry names what a build leaves out, so naming nothing is no error. Below the build
138
+ # root, where nothing exists before a first build, it passes without a word.
139
+ def subtracts_nothing(entry, walk, build_root, kind)
140
+ unless build_root and ProjectPaths.contains?( build_root, FilePathUtils.no_decorators( entry ) )
141
+ log_complaint( "#{walk} => '#{entry.strip}' leaves out nothing; no #{kind} matches it" )
142
+ end
143
+
144
+ return true
145
+ end
146
+
147
+ # #104 -- FilePathUtils.subdirectory_glob escapes literal brackets in the path, so they
148
+ # are matched rather than read as a glob character class
149
+ def globbed_directories?(path)
150
+ return @file_wrapper.directory_listing( FilePathUtils.subdirectory_glob( path ) ).any? { |entry| @file_wrapper.directory?( entry ) }
151
+ end
152
+
153
+ # A path naming a directory is ignored with a warning. Any other entry must yield files,
154
+ # except a `-:` entry.
155
+ def valid_files_entry?(entry, walk, build_root)
156
+ path = FilePathUtils::no_aggregation_decorators( entry )
157
+
158
+ if @file_wrapper.exist?( path ) and @file_wrapper.directory?( path )
159
+ log_complaint( "#{walk} => '#{path}' is a directory path and will be ignored (FYI :files is file-oriented while :paths is directory-oriented)" )
160
+ return true
161
+ end
162
+
163
+ # #104 -- literal brackets are escaped so they are matched rather than read as a glob
164
+ return true unless @file_wrapper.instantiate_file_list( FilePathUtils.escape_glob_brackets( path ) ).size.zero?
165
+ return subtracts_nothing( entry, walk, build_root, 'file' ) unless FilePathUtils.add_path?( entry )
166
+
167
+ log_error( "#{walk} => '#{path}' yielded no files -- matching glob is malformed or files do not exist" )
168
+ return false
169
+ end
170
+
171
+ def log_error(message)
172
+ @loginator.log( message, Verbosity::ERRORS )
173
+ end
174
+
175
+ def log_complaint(message)
176
+ @loginator.log( message, Verbosity::COMPLAIN )
177
+ end
178
+
179
+ end
@@ -6,7 +6,7 @@
6
6
  # =========================================================================
7
7
 
8
8
  require 'ceedling/constants'
9
- require 'ceedling/file_path_utils'
9
+ require 'ceedling/filesystem/file_path_utils'
10
10
 
11
11
  class ConfiguratorPlugins
12
12
 
@@ -12,12 +12,14 @@ require 'ceedling/config/line_marker_suppressors'
12
12
 
13
13
  class ConfiguratorSetup
14
14
 
15
- constructor :configurator_builder, :configurator_validator, :loginator, :reportinator, :file_wrapper,
15
+ constructor :configurator_builder, :configurator_validator, :configurator_paths_validator, :loginator, :reportinator, :file_wrapper,
16
16
  :system_wrapper, :tool_executor
17
17
 
18
18
  # Path collections, in order, since each builds on those before it
19
19
  PATH_COLLECTIONS = [
20
20
  :expand_all_path_globs,
21
+ :collect_mirror_roots,
22
+ :collect_build_roots,
21
23
  :collect_vendor_paths,
22
24
  :collect_source_and_include_paths,
23
25
  :collect_source_include_vendor_paths,
@@ -72,17 +74,6 @@ class ConfiguratorSetup
72
74
  end
73
75
  end
74
76
 
75
- # A vendor destination must be a directory, and the marker file inside it (unity.c,
76
- # cmock.c, CException.c) a plain file. An interrupted run, or a second Ceedling run racing
77
- # this one, can leave either as the wrong type, and the copy would then fail on every
78
- # later build. The whole destination is cleared, so the copy recreates it.
79
- def heal_vendor_path(path, marker_file)
80
- return unless corrupted_vendor_path?( path, marker_file )
81
-
82
- @loginator.log( "Removing corrupted vendor path (unexpected file/directory type): #{path}", Verbosity::COMPLAIN, LogLabels::NOTICE )
83
- @file_wrapper.rm_rf( path )
84
- end
85
-
86
77
  # Brings build/vendor up to date with the frameworks and support files a build needs. Only
87
78
  # a build does this, so a command that only reads the project leaves a concurrent build's
88
79
  # files alone. A file that already matches its source is not written, and one that differs,
@@ -90,8 +81,7 @@ class ConfiguratorSetup
90
81
  #
91
82
  # A release build needs only CException, and that only when exceptions are enabled.
92
83
  def vendor_frameworks_and_support_files(ceedling_lib_path, flattened_config, test_build:, release_build:)
93
- frameworks_for_build( flattened_config, test_build: test_build, release_build: release_build ).each do |source, destination, marker_file|
94
- heal_vendor_path( destination, marker_file )
84
+ frameworks_for_build( flattened_config, test_build: test_build, release_build: release_build ).each do |source, destination|
95
85
  @file_wrapper.sync_tree( source, destination )
96
86
  end
97
87
 
@@ -130,6 +120,11 @@ class ConfiguratorSetup
130
120
  end
131
121
 
132
122
 
123
+ def validate_build_root(config)
124
+ return @configurator_paths_validator.validate_build_root( config )
125
+ end
126
+
127
+
133
128
  # Every check runs, so every problem is reported
134
129
  def validate_paths(config)
135
130
  valid = validate_simple_paths( config[:cmock][:unity_helper_path], :cmock, :unity_helper_path )
@@ -275,6 +270,12 @@ class ConfiguratorSetup
275
270
  return validate_option( config, :use_backtrace, [:none, :simple, :gdb] )
276
271
  end
277
272
 
273
+ # Windows has two path limits, so the setting names one or asks for a probe. Validated on
274
+ # every OS, so a project file shared across hosts is checked everywhere.
275
+ def validate_win_path_limit(config)
276
+ return validate_option( config, :win_path_limit, [:classic, :long_paths, :auto] )
277
+ end
278
+
278
279
  def validate_threads(config)
279
280
  return [:compile_threads, :test_threads].map { |key| validate_thread_count( config, key ) }.all?
280
281
  end
@@ -282,13 +283,24 @@ class ConfiguratorSetup
282
283
  # `:max_extraction_length` multiplies 1000 characters, so `5000` reads more clearly than
283
284
  # `5000000`. The minimum keeps that ceiling well above any ordinary C declaration or
284
285
  # signature, and catches `1000` written to mean 1000 characters.
286
+ #
287
+ # `:suppress_redundant_decls` decides whether generated code carries GCC pragmas, so a
288
+ # misspelled value is caught here rather than read as truthy. `:extern_variables` must name
289
+ # one of its two behaviors.
285
290
  def validate_partials(config)
286
291
  max_extraction_length = config[:partials][:max_extraction_length]
287
292
  walk = @reportinator.generate_config_walk( [:partials, :max_extraction_length] )
288
293
 
289
294
  return log_invalid( "#{walk} is not an integer" ) unless max_extraction_length.is_a?( Integer )
290
295
  return log_invalid( "#{walk} must be at least 10 (10,000 characters)" ) if max_extraction_length < 10
291
- return true
296
+
297
+ suppress = config[:partials][:suppress_redundant_decls]
298
+ unless [true, false].include?( suppress )
299
+ walk = @reportinator.generate_config_walk( [:partials, :suppress_redundant_decls] )
300
+ return log_invalid( "#{walk} is '#{suppress}' but must be TRUE or FALSE" )
301
+ end
302
+
303
+ return validate_option( config, :extern_variables, [:weak, :test], section: :partials )
292
304
  end
293
305
 
294
306
  # Discovery records a path beneath :plugins for each enabled plugin it found, whatever
@@ -308,23 +320,16 @@ class ConfiguratorSetup
308
320
 
309
321
  private
310
322
 
311
- def corrupted_vendor_path?(path, marker_file)
312
- marker = File.join( path, marker_file )
313
-
314
- return ( @file_wrapper.exist?( path ) && !@file_wrapper.directory?( path ) ) ||
315
- ( @file_wrapper.exist?( marker ) && @file_wrapper.directory?( marker ) )
316
- end
317
-
318
- # Each framework a build uses, as [vendored source, build destination, marker file]
323
+ # Each framework a build uses, as [vendored source, build destination]
319
324
  def vendored_frameworks(config)
320
- frameworks = [ [File.join( config[:unity_vendor_path], UNITY_LIB_PATH ), config[:project_build_vendor_unity_path], UNITY_C_FILE] ]
325
+ frameworks = [ [File.join( config[:unity_vendor_path], UNITY_LIB_PATH ), config[:project_build_vendor_unity_path]] ]
321
326
 
322
327
  if config[:project_use_mocks]
323
- frameworks << [File.join( config[:cmock_vendor_path], CMOCK_LIB_PATH ), config[:project_build_vendor_cmock_path], CMOCK_C_FILE]
328
+ frameworks << [File.join( config[:cmock_vendor_path], CMOCK_LIB_PATH ), config[:project_build_vendor_cmock_path]]
324
329
  end
325
330
 
326
331
  if config[:project_use_exceptions]
327
- frameworks << [File.join( config[:cexception_vendor_path], CEXCEPTION_LIB_PATH ), config[:project_build_vendor_cexception_path], CEXCEPTION_C_FILE]
332
+ frameworks << [File.join( config[:cexception_vendor_path], CEXCEPTION_LIB_PATH ), config[:project_build_vendor_cexception_path]]
328
333
  end
329
334
 
330
335
  return frameworks
@@ -332,7 +337,7 @@ class ConfiguratorSetup
332
337
 
333
338
  def frameworks_for_build(config, test_build:, release_build:)
334
339
  return vendored_frameworks( config ) if test_build
335
- return vendored_frameworks( config ).select { |_, _, marker_file| marker_file == CEXCEPTION_C_FILE } if release_build
340
+ return vendored_frameworks( config ).select { |_, destination| destination == config[:project_build_vendor_cexception_path] } if release_build
336
341
 
337
342
  return []
338
343
  end
@@ -353,13 +358,13 @@ class ConfiguratorSetup
353
358
  end
354
359
 
355
360
  def validate_simple_paths(paths, *keys)
356
- return paths.map { |path| @configurator_validator.validate_filepath_simple( path, *keys ) }.all?
361
+ return paths.map { |path| @configurator_paths_validator.validate_filepath_simple( path, *keys ) }.all?
357
362
  end
358
363
 
359
364
  # Each entry of :paths or :files must exist and yield what its section expects
360
365
  def validate_path_section(config, section, entries_validation)
361
366
  return config[section].keys.sort.map do |key|
362
- @configurator_validator.validate_path_list( config, section, key ) & @configurator_validator.public_send( entries_validation, config, key )
367
+ @configurator_paths_validator.validate_path_list( config, section, key ) & @configurator_paths_validator.public_send( entries_validation, config, key )
363
368
  end.all?
364
369
  end
365
370
 
@@ -470,12 +475,18 @@ class ConfiguratorSetup
470
475
  @loginator.log( "Preprocessing configured at #{walk} is only supported in the :test context", Verbosity::ERRORS, LogLabels::WARNING )
471
476
  end
472
477
 
473
- def validate_option(config, key, options)
474
- value = config[:project][key]
478
+ def validate_option(config, key, options, section: :project)
479
+ value = config[section][key]
475
480
  return true if options.include?( value )
476
481
 
477
- walk = @reportinator.generate_config_walk( [:project, key] )
478
- return log_invalid( "#{walk} is ':#{value}' but must be one of {#{options.map { |option| ":#{option}" }.join( ', ' )}}" )
482
+ walk = @reportinator.generate_config_walk( [section, key] )
483
+ return log_invalid( "#{walk} is #{option_value( value )} but must be one of {#{options.map { |option| ":#{option}" }.join( ', ' )}}" )
484
+ end
485
+
486
+ # A Symbol reads as YAML writes it. Anything else reads as itself, so a string missing its
487
+ # leading colon can't pass for the symbol it resembles.
488
+ def option_value(value)
489
+ return value.is_a?( Symbol ) ? "':#{value}'" : value.inspect
479
490
  end
480
491
 
481
492
  def validate_thread_count(config, key)
@@ -6,13 +6,12 @@
6
6
  # =========================================================================
7
7
 
8
8
  require 'ceedling/constants'
9
- require 'ceedling/file_path_utils' # for glob handling class methods
10
9
  require 'ceedling/config/config_matchinator'
11
10
 
12
11
 
13
12
  class ConfiguratorValidator
14
13
 
15
- constructor :config_walkinator, :file_wrapper, :loginator, :reportinator, :tool_validator
14
+ constructor :config_walkinator, :loginator, :reportinator, :tool_validator
16
15
 
17
16
  # Walk into config hash verify existence of data at key depth
18
17
  def exists?(config, *keys)
@@ -23,54 +22,6 @@ class ConfiguratorValidator
23
22
  return false
24
23
  end
25
24
 
26
- # Walk into config hash. verify existence of path(s) at given key depth.
27
- # Paths are either full simple paths or a simple portion of a path up to a glob.
28
- def validate_path_list(config, *keys)
29
- list, depth = @config_walkinator.fetch_value( *keys, hash:config )
30
- return false if list.nil?
31
-
32
- # Trimming add/subtract notation and glob specifiers leaves nothing of a path that
33
- # begins with a glob, so there is nothing to check. An entry YAML read as something
34
- # other than a string is left to the entries validation, which reports it.
35
- paths = list.grep( String ).map { |path| FilePathUtils::no_decorators( path ) }
36
- missing = paths.reject { |path| path.empty? or @file_wrapper.exist?( path ) }
37
-
38
- walk = @reportinator.generate_config_walk( keys, depth )
39
- missing.each { |path| log_error( "Config path #{walk} => '#{path}' does not exist in the filesystem." ) }
40
-
41
- return missing.empty?
42
- end
43
-
44
-
45
- # Validate :paths entries, exercising each entry as Ceedling directory glob (variation of Ruby glob)
46
- def validate_paths_entries(config, key)
47
- list, _ = @config_walkinator.fetch_value( :paths, key, hash:config )
48
- return false if list.nil?
49
-
50
- walk = @reportinator.generate_config_walk( [:paths, key] )
51
- return list.map { |path| usable_entry?( path, walk ) && valid_paths_entry?( FilePathUtils::no_aggregation_decorators( path ), walk ) }.all?
52
- end
53
-
54
-
55
- # Validate :files entries, exercising each entry as FileList glob
56
- def validate_files_entries(config, key)
57
- list, _ = @config_walkinator.fetch_value( :files, key, hash:config )
58
- return false if list.nil?
59
-
60
- walk = @reportinator.generate_config_walk( [:files, key] )
61
- return list.map { |path| usable_entry?( path, walk ) && valid_files_entry?( FilePathUtils::no_aggregation_decorators( path ), walk ) }.all?
62
- end
63
-
64
-
65
- # Simple path verification
66
- def validate_filepath_simple(path, *keys)
67
- return true if @file_wrapper.exist?( path )
68
-
69
- walk = @reportinator.generate_config_walk( keys, keys.size )
70
- log_error( "Config path '#{path}' associated with #{walk} does not exist in the filesystem." )
71
- return false
72
- end
73
-
74
25
  def validate_tool(config:, key:, respect_optional:true)
75
26
  # Get tool
76
27
  walk = [:tools, key]
@@ -102,62 +53,6 @@ class ConfiguratorValidator
102
53
 
103
54
  private
104
55
 
105
- # A :paths or :files entry that names no path, or wraps its path in quotes, usually
106
- # quotes only the path after its decoration. YAML keeps those quote marks as part of
107
- # the value, so the hint points at quoting the whole entry. YAML also reads an unquoted
108
- # decoration with nothing after it (`- -:`) as a one-key mapping rather than a string.
109
- ENTRY_QUOTING_HINT = 'Quote the whole entry, decoration included (e.g. "-:path/to/file.c"), ' +
110
- 'not only the path after its +: or -: decoration.'
111
-
112
- def usable_entry?(entry, walk)
113
- path = entry.is_a?( String ) ? FilePathUtils::no_aggregation_decorators( entry ) : ''
114
-
115
- problem =
116
- if !entry.nil? and !entry.is_a?( String ) then "is not a path (YAML read it as a #{entry.class})"
117
- elsif path.empty? then 'names no path'
118
- elsif path.start_with?( '"', "'" ) then 'wraps its path in quotes'
119
- end
120
- return true if problem.nil?
121
-
122
- log_error( "#{walk} => '#{entry}' #{problem}" )
123
- log_error( ENTRY_QUOTING_HINT )
124
- return false
125
- end
126
-
127
- # A path naming a file is ignored with a warning. Any other entry must yield directories,
128
- # except a subdirectories glob of a directory that has none.
129
- def valid_paths_entry?(path, walk)
130
- if @file_wrapper.exist?( path ) and !@file_wrapper.directory?( path )
131
- log_complaint( "#{walk} => '#{path}' is a filepath and will be ignored (FYI :paths is directory-oriented while :files is file-oriented)" )
132
- return true
133
- end
134
-
135
- return true if globbed_directories?( path ) or path =~ /\/\*{1,2}$/
136
-
137
- log_error( "#{walk} => '#{path}' yielded no directories -- matching glob is malformed or directories do not exist" )
138
- return false
139
- end
140
-
141
- # #104 -- FilePathUtils.subdirectory_glob escapes literal brackets in the path, so they
142
- # are matched rather than read as a glob character class
143
- def globbed_directories?(path)
144
- return @file_wrapper.directory_listing( FilePathUtils.subdirectory_glob( path ) ).any? { |entry| @file_wrapper.directory?( entry ) }
145
- end
146
-
147
- # A path naming a directory is ignored with a warning. Any other entry must yield files.
148
- def valid_files_entry?(path, walk)
149
- if @file_wrapper.exist?( path ) and @file_wrapper.directory?( path )
150
- log_complaint( "#{walk} => '#{path}' is a directory path and will be ignored (FYI :files is file-oriented while :paths is directory-oriented)" )
151
- return true
152
- end
153
-
154
- # #104 -- literal brackets are escaped so they are matched rather than read as a glob
155
- return true unless @file_wrapper.instantiate_file_list( FilePathUtils.escape_glob_brackets( path ) ).size.zero?
156
-
157
- log_error( "#{walk} => '#{path}' yielded no files -- matching glob is malformed or files do not exist" )
158
- return false
159
- end
160
-
161
56
  def validate_regex_matcher(matcher)
162
57
  Regexp.compile( matcher[1..-2] )
163
58
  rescue RegexpError => ex
@@ -168,8 +63,4 @@ class ConfiguratorValidator
168
63
  @loginator.log( message, Verbosity::ERRORS )
169
64
  end
170
65
 
171
- def log_complaint(message)
172
- @loginator.log( message, Verbosity::COMPLAIN )
173
- end
174
-
175
66
  end
@@ -90,10 +90,12 @@ PARTIAL_FILENAME_PREFIX = 'ceedling_partial_'
90
90
  PARTIAL_SUFFIX_INTERFACE = '_interface'
91
91
  PARTIAL_SUFFIX_TYPES = '_types'
92
92
  PARTIAL_SUFFIX_IMPL = '_impl'
93
+ PARTIAL_SUFFIX_EXTRAS = '_extras'
93
94
  PARTIAL_FILENAME_SUFFIXES = [
94
95
  PARTIAL_SUFFIX_INTERFACE,
95
96
  PARTIAL_SUFFIX_TYPES,
96
- PARTIAL_SUFFIX_IMPL
97
+ PARTIAL_SUFFIX_IMPL,
98
+ PARTIAL_SUFFIX_EXTRAS
97
99
  ].freeze
98
100
 
99
101
  class PATTERNS
@@ -186,6 +188,7 @@ BACKTRACE_GDB_SCRIPT_FILE = 'backtrace.gdb'
186
188
 
187
189
  INPUT_CONFIGURATION_CACHE_FILE = 'input.yml' unless defined?(INPUT_CONFIGURATION_CACHE_FILE) # input configuration file dump
188
190
  DEFINES_DEPENDENCY_CACHE_FILE = 'defines_dependency.yml' unless defined?(DEFINES_DEPENDENCY_CACHE_FILE) # preprocessor definitions for files
191
+ BUILD_ROOTS_MAP_FILE = "build_roots#{EXTENSION_CORE_YAML}" unless defined?(BUILD_ROOTS_MAP_FILE) # shortened build roots and their markers
189
192
 
190
193
  TEST_ROOT_NAME = 'test' unless defined?(TEST_ROOT_NAME)
191
194
  TEST_TASK_ROOT = TEST_ROOT_NAME + ':' unless defined?(TEST_TASK_ROOT)
@@ -213,6 +216,7 @@ OPERATION_LINK_SYM = :link unless defined?(OPERATION_LINK_SYM)
213
216
 
214
217
  PREPROCESS_STANDINS_DIR = 'standins'
215
218
  PREPROCESS_FULL_EXPANSION_DIR = 'full_expansion'
219
+ PREPROCESS_EXPANDED_CODE_DIR = 'expanded_code'
216
220
  PREPROCESS_DIRECTIVES_ONLY_DIR = 'directives_only'
217
221
  PREPROCESS_RAW_DIRECTIVES_ONLY_DIR = 'directives_only/raw'
218
222
  PREPROCESS_FALLBACK_EXPANSION_DIR = 'fallback_expansion'
@@ -7,7 +7,7 @@
7
7
 
8
8
  require 'ceedling/constants'
9
9
  require 'ceedling/system_wrapper'
10
- require 'ceedling/file_path_utils'
10
+ require 'ceedling/filesystem/file_path_utils'
11
11
 
12
12
  # Assign a default value for system testing where CEEDLING_APPCFG may not be present
13
13
  # TODO: Create code config & test structure that does not internalize a test path like this
@@ -58,14 +58,14 @@ DEFAULT_TEST_LINKER_TOOL = {
58
58
  }
59
59
 
60
60
  DEFAULT_TEST_FIXTURE_TOOL = {
61
- :executable => '${1}'.freeze, # Unity test runner executable
61
+ :executable => '"${1}"'.freeze, # Unity test runner executable, quoted as a path
62
62
  :name => 'default_test_fixture'.freeze,
63
63
  :optional => false.freeze,
64
64
  :arguments => [].freeze
65
65
  }
66
66
 
67
67
  DEFAULT_TEST_FIXTURE_SIMPLE_BACKTRACE_TOOL = {
68
- :executable => '${1}'.freeze, # Unity test runner executable
68
+ :executable => '"${1}"'.freeze, # Unity test runner executable, quoted as a path
69
69
  :name => 'default_test_fixture_simple_backtrace'.freeze,
70
70
  :optional => false.freeze,
71
71
  :arguments => [
@@ -204,7 +204,7 @@ DEFAULT_TEST_BACKTRACE_GDB_TOOL = {
204
204
  '--eval-command run'.freeze,
205
205
  "--command \"${1}\"".freeze, # Debug script file to run
206
206
  '--args'.freeze,
207
- '${2}'.freeze, # Test executable
207
+ '"${2}"'.freeze, # Test executable, quoted as a path
208
208
  # Test case matching flag and (quoted) value, fully composed by the caller as
209
209
  # either `-n "<exact name>"` or `-f "<base name>"` -- see
210
210
  # GeneratorTestResultsBacktrace#unity_filter_arg.
@@ -212,6 +212,20 @@ DEFAULT_TEST_BACKTRACE_GDB_TOOL = {
212
212
  ].freeze
213
213
  }
214
214
 
215
+ # Reads one registry value, for the Windows long path probe (see WinPathProber). Optional:
216
+ # the probe reads the registry only to explain a failure, so a missing reg.exe must not
217
+ # stop a build.
218
+ DEFAULT_WINDOWS_REGISTRY_QUERY_TOOL = {
219
+ :executable => FilePathUtils.os_executable_ext('reg').freeze,
220
+ :name => 'default_windows_registry_query'.freeze,
221
+ :optional => true.freeze,
222
+ :arguments => [
223
+ 'query'.freeze,
224
+ '"${1}"'.freeze, # Registry key, quoted
225
+ '/v ${2}'.freeze # Value name
226
+ ].freeze
227
+ }
228
+
215
229
  DEFAULT_TOOLS_TEST = {
216
230
  :tools => {
217
231
  :test_compiler => DEFAULT_TEST_COMPILER_TOOL,
@@ -263,6 +277,12 @@ DEFAULT_TOOLS_RELEASE_DEPENDENCIES = {
263
277
  }
264
278
  }
265
279
 
280
+ DEFAULT_TOOLS_WINDOWS_REGISTRY_QUERY = {
281
+ :tools => {
282
+ :windows_registry_query => DEFAULT_WINDOWS_REGISTRY_QUERY_TOOL,
283
+ }
284
+ }
285
+
266
286
 
267
287
  DEFAULT_RELEASE_TARGET_NAME = 'project'
268
288
 
@@ -278,7 +298,9 @@ DEFAULT_CEEDLING_PROJECT_CONFIG = {
278
298
  :test_threads => 1,
279
299
  :test_file_prefix => 'test_',
280
300
  :release_build => false,
281
- :use_backtrace => :simple
301
+ :use_backtrace => :simple,
302
+ # Windows' classic 260-character limit, the long path limit, or a probe for which applies
303
+ :win_path_limit => :classic
282
304
  },
283
305
 
284
306
  :release_build => {
@@ -301,6 +323,14 @@ DEFAULT_CEEDLING_PROJECT_CONFIG = {
301
323
  # outright rather than silently dropping an oversized construct and everything after
302
324
  # it in the file. Value is a multiplier of 1000 characters -- 5000 means 5,000,000.
303
325
  :max_extraction_length => 5000,
326
+ # A Partial's implementation source carries prototypes the module's code relies on, and some
327
+ # repeat a declaration a header already made. GCC diagnostic pragmas around them keep
328
+ # -Wredundant-decls quiet for those lines, so a build treating warnings as errors still passes.
329
+ :suppress_redundant_decls => true,
330
+ # A variable a module declares `extern` but never defines. `:weak` writes a weak definition
331
+ # that a real one overrides, so the link works whether or not the defining module is linked.
332
+ # `:test` writes none, leaving the definition to the test or a linked module.
333
+ :extern_variables => :weak,
304
334
  },
305
335
 
306
336
  # Unlike other top-level entries, :environment is an array (of hashes) to preserve order