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,241 @@
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 'fileutils'
9
+ require 'ceedling/constants'
10
+ require 'ceedling/exceptions'
11
+
12
+ # Walks and copies trees of regular files without `lstat`. On some filesystems `lstat`
13
+ # reports a regular file as a directory, and any copy that classifies by it puts a directory
14
+ # where the file belongs. FileTree lists a directory with `Dir.children`, which reads names
15
+ # without glob syntax, and classifies each entry with `File.stat`, which follows links.
16
+ #
17
+ # Links in a source tree are followed, and a copy holds only regular files and directories.
18
+ # A link loop or a dangling link raises rather than copying part of a tree.
19
+ #
20
+ # This is best effort. It removes the dependence on `lstat`, and trusts `stat` in its place.
21
+ module FileTree
22
+
23
+ # Errors that clear on their own, such as a scanner or a sync client holding a file open.
24
+ # Any other error fails a copy at once.
25
+ TRANSIENT_ERRORS = %i[EACCES EBUSY EPERM EINTR].filter_map { |name| Errno.const_get( name ) if Errno.const_defined?( name ) }.freeze
26
+
27
+ Result = Struct.new( :copied, :unchanged, :healed, keyword_init: true )
28
+
29
+ # Yields each regular file below `root` as its path relative to `root` and its full path,
30
+ # sorted within each directory. Returns an Enumerator without a block. An entry whose name
31
+ # `skip` accepts is neither yielded nor entered.
32
+ def self.each_file(root, skip: nil)
33
+ return enum_for( :each_file, root, skip: skip ) unless block_given?
34
+
35
+ each_entry( root, skip: skip ) { |relative, path, directory| yield( relative, path ) unless directory }
36
+ end
37
+
38
+ # Yields each directory and regular file below `root`, a directory ahead of its contents,
39
+ # as its relative path, its full path, and whether it is a directory
40
+ def self.each_entry(root, skip: nil, &block)
41
+ raise CeedlingException, "'#{root}' is not a directory" unless File.directory?( root )
42
+
43
+ walk( root, nil, [real_path( root )], skip, &block )
44
+ end
45
+
46
+ # Brings every file below `source` up to date below `destination` and returns a Result. A
47
+ # file that matches its source is left alone. One that differs or is missing is written by
48
+ # `publish`, a callable given the source and destination paths. A directory where a file
49
+ # belongs, or a file where a directory belongs, is removed first. Files `destination` has
50
+ # beyond `source` are left alone.
51
+ #
52
+ # `publish` is retried after each of `retry_delays` on an error in TRANSIENT_ERRORS.
53
+ # `log`, when given, receives a message, a Verbosity, and a LogLabels value.
54
+ def self.sync(source, destination, publish:, retry_delays: [], sleep: Kernel.method( :sleep ), log: nil)
55
+ return Sync.new( publish: publish, retry_delays: retry_delays, sleep: sleep, log: log ).tree( source, destination )
56
+ end
57
+
58
+ # As .sync, for one regular file copied into `destination_dir`
59
+ def self.sync_file(source, destination_dir, publish:, retry_delays: [], sleep: Kernel.method( :sleep ), log: nil)
60
+ return Sync.new( publish: publish, retry_delays: retry_delays, sleep: sleep, log: log ).file( source, destination_dir )
61
+ end
62
+
63
+ def self.walk(dir, relative, ancestors, skip, &block)
64
+ names_in( dir ).each do |name|
65
+ next if skip&.call( name )
66
+
67
+ path = File.join( dir, name )
68
+ entry = relative ? File.join( relative, name ) : name
69
+ next yield( entry, path, false ) unless directory_entry?( path )
70
+
71
+ yield( entry, path, true )
72
+ walk( path, entry, ancestors + [real_directory( path, ancestors )], skip, &block )
73
+ end
74
+ end
75
+
76
+ def self.names_in(dir)
77
+ return Dir.children( dir ).sort
78
+ rescue SystemCallError => e
79
+ raise CeedlingException, "'#{dir}' could not be listed ⏩️ #{e.message}"
80
+ end
81
+
82
+ # Whether a listed entry is a directory. Anything but a directory or a regular file raises.
83
+ def self.directory_entry?(path)
84
+ status = stat_of( path )
85
+ return true if status.directory?
86
+ return false if status.file?
87
+
88
+ raise CeedlingException, "'#{path}' is a #{status.ftype}, not a file or directory"
89
+ end
90
+
91
+ def self.stat_of(path)
92
+ return File.stat( path )
93
+ rescue Errno::ENOENT, Errno::ELOOP
94
+ raise CeedlingException, "'#{path}' is a dangling or unresolvable link"
95
+ rescue SystemCallError => e
96
+ raise CeedlingException, "'#{path}' could not be read ⏩️ #{e.message}"
97
+ end
98
+
99
+ def self.real_directory(path, ancestors)
100
+ real = real_path( path )
101
+ raise CeedlingException, "Link loop: '#{path}' resolves to its own ancestor '#{real}'" if ancestors.include?( real )
102
+
103
+ return real
104
+ end
105
+
106
+ # A directory's real path, for finding loops. A path that cannot be resolved stands for
107
+ # itself, so the walk goes on without that safeguard rather than stopping.
108
+ def self.real_path(path)
109
+ return File.realpath( path )
110
+ rescue SystemCallError
111
+ return File.expand_path( path )
112
+ end
113
+
114
+ private_class_method :walk, :names_in, :directory_entry?, :stat_of, :real_directory, :real_path
115
+
116
+ # One copy's settings and tallies
117
+ class Sync
118
+ def initialize(publish:, retry_delays:, sleep:, log:)
119
+ @publish = publish
120
+ @retry_delays = retry_delays
121
+ @sleep = sleep
122
+ @log = log
123
+ @result = Result.new( copied: 0, unchanged: 0, healed: 0 )
124
+ end
125
+
126
+ def tree(source, destination)
127
+ raise CeedlingException, "'#{source}' is not a directory" unless File.directory?( source )
128
+
129
+ directory( destination )
130
+ FileTree.each_entry( source ) do |relative, path, is_directory|
131
+ target = File.join( destination, relative )
132
+ is_directory ? directory( target ) : publish_file( path, target )
133
+ end
134
+ return @result
135
+ end
136
+
137
+ def file(source, destination_dir)
138
+ raise CeedlingException, "'#{source}' is not a regular file" unless File.file?( source )
139
+
140
+ directory( destination_dir )
141
+ publish_file( source, File.join( destination_dir, File.basename( source ) ) )
142
+ return @result
143
+ end
144
+
145
+ private
146
+
147
+ # Destination checks follow links, as `stat` does, so they share the source side's view.
148
+ # A dangling link counts as a file.
149
+ def directory(path)
150
+ return if File.directory?( path )
151
+
152
+ with_retries( path ) do
153
+ heal( "Replaced a file where the directory '#{path}' belongs" ) { remove_file( path ) } if File.exist?( path ) || File.symlink?( path )
154
+ FileUtils.mkdir_p( path )
155
+ end
156
+ end
157
+
158
+ # Every step is retried, since a scanner or sync client can hold the destination too
159
+ def publish_file(source, destination)
160
+ with_retries( destination ) do
161
+ if File.directory?( destination )
162
+ heal( "Replaced a directory where the file '#{destination}' belongs" ) { remove_directory( destination ) }
163
+ elsif identical?( source, destination )
164
+ next @result.unchanged += 1
165
+ end
166
+
167
+ @publish.call( source, destination )
168
+ @result.copied += 1
169
+ end
170
+ end
171
+
172
+ # Counts and logs a heal the block reports it made
173
+ def heal(message)
174
+ return unless yield
175
+
176
+ @result.healed += 1
177
+ log( message, Verbosity::COMPLAIN, LogLabels::NOTICE )
178
+ end
179
+
180
+ # Whether this removed the file or link. An error removing it reaches the retries.
181
+ def remove_file(path)
182
+ File.unlink( path )
183
+ return true
184
+ rescue Errno::ENOENT
185
+ return false
186
+ end
187
+
188
+ # Whether this removed the directory, or the link to one. Another run healing the same
189
+ # entry may have removed it already, or published a file in its place, which this run
190
+ # then publishes over. An error removing it reaches the retries.
191
+ def remove_directory(path)
192
+ return remove_file( path ) if File.symlink?( path )
193
+
194
+ Dir.rmdir( path )
195
+ return true
196
+ rescue Errno::ENOENT, Errno::ENOTDIR
197
+ return false
198
+ rescue Errno::ENOTEMPTY, Errno::EEXIST
199
+ return remove_tree( path )
200
+ end
201
+
202
+ # FileUtils.rm_r classifies by `lstat`, so it is reached only for a directory with
203
+ # contents. It works on the destination, and never follows a link out of it.
204
+ def remove_tree(path)
205
+ FileUtils.rm_r( path )
206
+ return true
207
+ rescue Errno::ENOENT
208
+ return false
209
+ end
210
+
211
+ def identical?(source, destination)
212
+ return File.file?( destination ) && File.size( source ) == File.size( destination ) && FileUtils.compare_file( source, destination )
213
+ end
214
+
215
+ def with_retries(destination)
216
+ delays = @retry_delays.dup
217
+ begin
218
+ yield
219
+ rescue *TRANSIENT_ERRORS => e
220
+ raise_exhausted( destination, e ) if delays.empty?
221
+
222
+ log( "Retrying copy to '#{destination}' after a transient error: #{e.message}", Verbosity::DEBUG, LogLabels::AUTO )
223
+ @sleep.call( delays.shift )
224
+ retry
225
+ end
226
+ end
227
+
228
+ def raise_exhausted(destination, error)
229
+ message = "Failed to copy to '#{destination}' after #{@retry_delays.size} retries ⏩️ #{error.message}\n" \
230
+ "Try deleting this project's build/ directory and rebuilding -- or, if the error names a " \
231
+ "path under your Ruby gem install, reinstall the ceedling gem."
232
+ log( message, Verbosity::ERRORS, LogLabels::AUTO )
233
+ raise CeedlingException, message
234
+ end
235
+
236
+ def log(message, verbosity, label)
237
+ @log&.call( message, verbosity, label )
238
+ end
239
+ end
240
+
241
+ end
@@ -14,15 +14,43 @@ require 'tmpdir'
14
14
  # once and single-threaded, settles the class before any thread first reaches for it,
15
15
  # which Digest's lazy autoload does not survive under contention.
16
16
  require 'digest/sha2'
17
+ require 'set'
18
+ require 'ceedling/c_identifier'
17
19
  require 'ceedling/constants'
18
20
  require 'ceedling/system_wrapper'
19
21
  require 'ceedling/exceptions'
22
+ require 'ceedling/filesystem/file_tree'
23
+ require 'ceedling/filesystem/project_paths'
24
+ require 'ceedling/filesystem/win_long_paths'
25
+ require 'ceedling/filesystem/win_path_limit'
20
26
 
21
27
 
22
28
  class FileWrapper
23
29
 
24
30
  constructor :loginator, :verbosinator
25
31
 
32
+ # The paths already reported by check_path_length. Only a path in the warning band or past
33
+ # the limit is ever recorded, so the record holds the few long paths a build makes, not
34
+ # every path it checks.
35
+ #
36
+ # The Windows path limit starts as the classic one. Setup configures it once the
37
+ # project's configuration exists (see #configure_win_path_limit). Whether long paths are
38
+ # in effect stays unknown until a path first nears the classic limit and the prober answers.
39
+ def setup
40
+ @path_reports = Set.new
41
+ @path_lock = Mutex.new
42
+ @win_path_limit = :classic
43
+ @prober = nil
44
+ @long_paths = nil
45
+ end
46
+
47
+ # :project ↳ :win_path_limit, and the WinPathProber that decides whether long paths are in
48
+ # effect for it
49
+ def configure_win_path_limit(mode:, prober:)
50
+ @win_path_limit = mode
51
+ @prober = prober
52
+ end
53
+
26
54
  # Platform practical filepath length ceilings, used only as a diagnostic heuristic --
27
55
  # neither Ruby nor the host OS exposes a portable, runtime-queryable API for this.
28
56
  # POSIX pathconf(2) is the real mechanism (PATH_MAX can vary by filesystem/mount
@@ -34,7 +62,7 @@ class FileWrapper
34
62
  # headers (a project can opt into longer paths on some platforms, but that's not
35
63
  # safely assumable here, so these stay conservative).
36
64
  PATH_LENGTH_LIMITS = {
37
- windows: 260,
65
+ windows: WinLongPaths::LIMITS[:classic],
38
66
  macos: 1024,
39
67
  linux: 4096,
40
68
  }.freeze unless const_defined?(:PATH_LENGTH_LIMITS, false)
@@ -72,7 +100,7 @@ class FileWrapper
72
100
  # at both ends (GENERATED_INCLUDE_GUARD_PATTERN).
73
101
  def self.generate_include_guard(name)
74
102
  base = name.sub(/\.[^.\/\\]*\z/, '') # Remove any extension, keeping any path
75
- base = base.gsub(/\W/, '_').squeeze('_').delete_prefix('_').delete_suffix('_')
103
+ base = CIdentifier.fold( base ).squeeze('_').delete_prefix('_').delete_suffix('_')
76
104
 
77
105
  head = GENERATED_INCLUDE_GUARD_PREFIX + include_guard_hash( name )
78
106
 
@@ -88,6 +116,13 @@ class FileWrapper
88
116
  return File.basename(path)
89
117
  end
90
118
 
119
+ # A file's status (size, modification time, ...), or nil when it can't be read
120
+ def stat(filepath)
121
+ return File.stat( filepath )
122
+ rescue SystemCallError
123
+ return nil
124
+ end
125
+
91
126
  def exist?(filepath)
92
127
  return true if (filepath == NULL_FILE_PATH)
93
128
  return File.exist?(filepath)
@@ -118,6 +153,13 @@ class FileWrapper
118
153
  return Dir.glob(glob, File::FNM_PATHNAME).sort()
119
154
  end
120
155
 
156
+ # Every regular file below dir as a full path, sorted. Unlike a glob, the walk classifies
157
+ # entries by `stat`, follows links, and reads names without pattern syntax (see FileTree).
158
+ # An entry whose name `skip` accepts is neither listed nor entered.
159
+ def tree_files(dir, skip: nil)
160
+ return FileTree.each_file( dir, skip: skip ).map { |_relative, path| path }.sort
161
+ end
162
+
121
163
  # Entry names within a single directory, `.` and `..` excluded.
122
164
  #
123
165
  # Complements `directory_listing()` for the case a glob cannot serve: matching a
@@ -207,11 +249,7 @@ class FileWrapper
207
249
  # which is how a previous attempt at "fixing" this cop was caught.
208
250
  open(filepath, flags) { |file| yield(file) } # rubocop:disable Security/Open
209
251
  rescue SystemCallError => e
210
- if attempts_remaining.empty?
211
- msg = "Failed to open '#{filepath}' after #{TRANSIENT_IO_RETRY_DELAYS.size} retries ⏩️ #{e.message}"
212
- @loginator.log(msg, Verbosity::ERRORS)
213
- raise CeedlingException, msg
214
- end
252
+ retries_exhausted!(filepath, e) if attempts_remaining.empty?
215
253
  delay = attempts_remaining.shift
216
254
  @loginator.log("Retrying read of '#{filepath}' after a transient error: #{e.message}", Verbosity::DEBUG)
217
255
  sleep(delay)
@@ -238,34 +276,32 @@ class FileWrapper
238
276
  false
239
277
  end
240
278
 
241
- # Brings every file beneath source_dir up to date beneath destination_dir. A file that
242
- # already matches its source is not written, so a reader elsewhere never sees it change. One
243
- # that differs or is missing is replaced whole (see #replace_file). Files the destination
244
- # has beyond the source are left alone.
279
+ # Brings every file beneath source_dir up to date beneath destination_dir (see FileTree.sync).
280
+ # A file that already matches its source is not written, so a reader elsewhere never sees it
281
+ # change. One that differs or is missing is replaced whole (see #replace_file). An entry of
282
+ # the wrong type is replaced. Files the destination has beyond the source are left alone.
245
283
  #
246
- # A transient OS-level error retries the whole pass: a path briefly reporting the wrong type
247
- # mid-copy, or on Windows a file another process holds open. A failure that never clears
248
- # surfaces as a CeedlingException naming the destination, not a bare Errno.
284
+ # A write is retried on an error that clears on its own, such as another process holding a
285
+ # file open on Windows. One that never clears surfaces as a CeedlingException naming the file.
249
286
  def sync_tree(source_dir, destination_dir)
250
- with_copy_retry( destination_dir ) do
251
- Dir.glob( '**/*', File::FNM_DOTMATCH, base: source_dir ).each do |relative|
252
- source = File.join( source_dir, relative )
253
- sync_one( source, File.join( destination_dir, relative ) ) if File.file?( source )
254
- end
255
- end
287
+ FileTree.sync( source_dir, destination_dir, **sync_options )
256
288
  end
257
289
 
258
290
  # As #sync_tree, for a single file copied into destination_dir
259
291
  def sync_file(source, destination_dir)
260
- with_copy_retry( destination_dir ) { sync_one( source, File.join( destination_dir, File.basename( source ) ) ) }
292
+ FileTree.sync_file( source, destination_dir, **sync_options )
261
293
  end
262
294
 
263
295
  # Copies source to a temporary name beside destination, then renames it over destination.
264
- # A concurrent reader sees the old file or the new one, never a partial one.
296
+ # A concurrent reader sees the old file or the new one, never a partial one. The copy is
297
+ # owner-writable, and so is a destination file it replaces, since Windows refuses to rename
298
+ # over a read-only file. A destination link is replaced, and the file it names left alone.
265
299
  def replace_file(source, destination)
266
300
  temp = File.join( File.dirname( destination ), ".#{File.basename( destination )}.#{Process.pid}.#{Thread.current.object_id}.tmp" )
267
301
  check_path_length( temp, origin: 'FileWrapper#replace_file' )
268
302
  FileUtils.cp( source, temp )
303
+ owner_writable( temp )
304
+ owner_writable( destination ) if File.file?( destination ) && !File.symlink?( destination )
269
305
  File.rename( temp, destination )
270
306
  ensure
271
307
  FileUtils.rm_f( temp ) if temp
@@ -329,16 +365,23 @@ class FileWrapper
329
365
  end
330
366
 
331
367
  def mkdir(folder)
332
- check_path_length(folder, origin: 'FileWrapper#mkdir')
368
+ check_path_length(folder, origin: 'FileWrapper#mkdir', directory: true)
333
369
  return FileUtils.mkdir_p(folder)
334
370
  end
335
371
 
372
+ # Makes the directory a file is about to be written in and returns the filepath. Safe
373
+ # when build threads make the same directory at once.
374
+ def mkdir_for(filepath)
375
+ mkdir( File.dirname( filepath ) )
376
+ return filepath
377
+ end
378
+
336
379
  # Creates a uniquely-named, empty directory nested inside `parent` and returns its path.
337
380
  # `parent` must already exist. Collision-free even across concurrent callers targeting
338
381
  # the same `parent` -- Dir.mktmpdir retries internally on name clash.
339
382
  def mkdir_tmp(prefix, parent)
340
383
  path = Dir.mktmpdir(prefix, parent)
341
- check_path_length(path, origin: 'FileWrapper#mkdir_tmp')
384
+ check_path_length(path, origin: 'FileWrapper#mkdir_tmp', directory: true)
342
385
  return path
343
386
  end
344
387
 
@@ -353,58 +396,99 @@ class FileWrapper
353
396
  # rejects the path. The calling context (`origin:`) is only included at DEBUG
354
397
  # verbosity -- otherwise the message stays plain, since the path itself is normally
355
398
  # enough and repeated origin labels add noise at everyday verbosity levels.
356
- def check_path_length(path, origin:)
357
- limit = path_length_limit
358
- length = File.expand_path(path).length
359
-
360
- prefix = @verbosinator.should_output?(Verbosity::DEBUG) ? "#{origin} ⏩️ " : ''
361
-
362
- if length >= limit
363
- @loginator.log(
364
- "#{prefix}Path length (#{length}) reaches or exceeds this platform's practical limit (#{limit}): #{path}",
365
- Verbosity::ERRORS
366
- )
367
- elsif length >= (limit - WARNING_MARGIN)
368
- @loginator.log(
369
- "#{prefix}Path length (#{length}) is approaching this platform's practical limit (#{limit}): #{path}",
370
- Verbosity::COMPLAIN
371
- )
372
- end
399
+ #
400
+ # A path is measured expanded against the remembered working directory, which costs no
401
+ # system call and remembers nothing. A path below the warning band, nearly every path,
402
+ # returns there, before any lock. One in the band is reported once per process, however
403
+ # many operations check it, keyed by its `ProjectPaths.absolute` spelling so two
404
+ # spellings of one place count once. Only those reported paths are remembered.
405
+ #
406
+ # On Windows, a directory (`directory: true`) stops at 248 characters under the classic
407
+ # limits. The first path to near the classic limit asks the prober whether long paths are
408
+ # in effect, if the project asked for them, and the limit is read again from its answer.
409
+ def check_path_length(path, origin:, directory: false)
410
+ length = File.expand_path( path.to_s, ProjectPaths.working_dir ).length
411
+ limit = path_length_limit( directory )
412
+
413
+ return if length < (limit - WARNING_MARGIN)
414
+
415
+ limit = probed_limit( directory ) if probe_wanted?
416
+ return if length < (limit - WARNING_MARGIN)
417
+
418
+ absolute = ProjectPaths.absolute( path.to_s )
419
+ return unless @path_lock.synchronize { @path_reports.add?( absolute ) }
420
+
421
+ log_path_length( path, length, limit, origin )
373
422
  end
374
423
 
375
424
  private
376
425
 
377
- def sync_one(source, destination)
378
- return if File.file?( destination ) && File.size( source ) == File.size( destination ) && FileUtils.compare_file( source, destination )
426
+ def sync_options
427
+ return {
428
+ publish: method( :replace_file ),
429
+ retry_delays: TRANSIENT_IO_RETRY_DELAYS,
430
+ sleep: ->( delay ) { sleep( delay ) },
431
+ log: ->( message, verbosity, label ) { @loginator.log( message, verbosity, label ) }
432
+ }
433
+ end
379
434
 
380
- FileUtils.mkdir_p( File.dirname( destination ) )
381
- replace_file( source, destination )
435
+ # #open_with_retry's last attempt failed too
436
+ def retries_exhausted!(filepath, error)
437
+ msg = "Failed to open '#{filepath}' after #{TRANSIENT_IO_RETRY_DELAYS.size} retries ⏩️ #{error.message}"
438
+ @loginator.log(msg, Verbosity::ERRORS)
439
+ raise CeedlingException, msg
382
440
  end
383
441
 
384
- def with_copy_retry(destination)
385
- attempts_remaining = TRANSIENT_IO_RETRY_DELAYS.dup
386
- begin
387
- yield
388
- rescue SystemCallError => e
389
- if attempts_remaining.empty?
390
- msg = "Failed to copy into '#{destination}' after #{TRANSIENT_IO_RETRY_DELAYS.size} retries ⏩️ #{e.message}\n" \
391
- "This path may be corrupted (a file exists where Ceedling expects a directory, or vice versa). " \
392
- "Try deleting this project's build/ directory and rebuilding -- or, if the error names a path " \
393
- "under your Ruby gem install, reinstall the ceedling gem."
394
- @loginator.log(msg, Verbosity::ERRORS)
395
- raise CeedlingException, msg
396
- end
397
- delay = attempts_remaining.shift
398
- @loginator.log("Retrying copy into '#{destination}' after a transient error: #{e.message}", Verbosity::DEBUG)
399
- sleep(delay)
400
- retry
401
- end
442
+ def owner_writable(path)
443
+ mode = File.stat( path ).mode & 0o7777
444
+ File.chmod( mode | 0o200, path ) if (mode & 0o200).zero?
402
445
  end
403
446
 
404
- def path_length_limit
405
- return PATH_LENGTH_LIMITS[:windows] if SystemWrapper.windows?
447
+ def path_length_limit(directory = false)
448
+ return windows_path_limit( directory ) if SystemWrapper.windows?
406
449
  return PATH_LENGTH_LIMITS[:macos] if SystemWrapper.macos?
407
450
  return PATH_LENGTH_LIMITS[:linux]
408
451
  end
409
452
 
453
+ def windows_path_limit(directory)
454
+ return WinLongPaths::LIMITS[:long_paths] if @long_paths
455
+ return WinLongPaths::LIMITS[directory ? :classic_directory : :classic]
456
+ end
457
+
458
+ # Only a configured FileWrapper has a prober; the launcher's keeps the classic limits
459
+ def probe_wanted?
460
+ return SystemWrapper.windows? && (@win_path_limit != :classic) && @long_paths.nil? && !@prober.nil?
461
+ end
462
+
463
+ # The limit once the prober has answered. Threads that ask together get one answer, since
464
+ # the prober probes once.
465
+ def probed_limit(directory)
466
+ @long_paths = @prober.long_paths?( @win_path_limit )
467
+ return path_length_limit( directory )
468
+ end
469
+
470
+ def log_path_length(path, length, limit, origin)
471
+ prefix = @verbosinator.should_output?(Verbosity::DEBUG) ? "#{origin} ⏩️ " : ''
472
+ subject, bound = length_terms( limit )
473
+
474
+ return @loginator.log( "#{prefix}#{subject} (#{length}) is approaching #{bound}: #{path}", Verbosity::COMPLAIN ) if length < limit
475
+
476
+ message = "#{prefix}#{subject} (#{length}) reaches or exceeds #{bound}: #{path}"
477
+ message += "\nIf this host has long paths enabled, see :project ↳ :win_path_limit." if pointer_wanted?( limit )
478
+ @loginator.log( message, Verbosity::ERRORS )
479
+ end
480
+
481
+ # What a length message calls the path, and the limit it nears or passes
482
+ def length_terms(limit)
483
+ return ['Path length', "this platform's practical limit (#{limit})"] unless SystemWrapper.windows?
484
+
485
+ subject = (limit == WinLongPaths::LIMITS[:classic_directory]) ? 'Directory path length' : 'Path length'
486
+ return [subject, WinPathLimit.limit_name( limit )]
487
+ end
488
+
489
+ # The setting can help only a project still on the classic limits by its own choice
490
+ def pointer_wanted?(limit)
491
+ return SystemWrapper.windows? && (@win_path_limit == :classic) && (limit != WinLongPaths::LIMITS[:long_paths])
492
+ end
493
+
410
494
  end
@@ -0,0 +1,30 @@
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 'set'
9
+ require 'ceedling/filesystem/path_spellings'
10
+
11
+ # What collection leaves out, each a set of spellings: `-:` entries' places, outweighed by
12
+ # an entry based nearer; excluded places, outweighed by an entry based no farther away; and
13
+ # reserved places, never collected
14
+ PathExclusions = Struct.new( :minus, :excluded, :reserved ) do
15
+ def self.of(minus, excluded, reserved)
16
+ return new( *[minus, excluded, reserved].map { |paths| PathSpellings.of( paths ) } )
17
+ end
18
+
19
+ def none?
20
+ return [minus, excluded, reserved].all?( &:empty? )
21
+ end
22
+
23
+ # Whether a place, by `spellings` of it and `distance` below the base of the entry naming
24
+ # it, is collected
25
+ def keeps?(spellings, distance)
26
+ return distance < PathSpellings.nearer( spellings, minus ) &&
27
+ distance <= PathSpellings.nearer( spellings, excluded ) &&
28
+ PathSpellings.nearer( spellings, reserved ) == Float::INFINITY
29
+ end
30
+ end