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
@@ -7,7 +7,10 @@
7
7
 
8
8
  require 'spec_helper'
9
9
  require 'tmpdir'
10
- require 'ceedling/file_wrapper'
10
+ require 'ceedling/filesystem/file_wrapper'
11
+ require 'ceedling/filesystem/project_paths'
12
+ require 'ceedling/filesystem/win_long_paths'
13
+ require 'ceedling/constants'
11
14
  require 'ceedling/system_wrapper'
12
15
  require 'ceedling/exceptions'
13
16
 
@@ -32,15 +35,15 @@ describe FileWrapper do
32
35
  allow(SystemWrapper).to receive(:macos?).and_return(false)
33
36
  end
34
37
 
35
- # Absolute paths throughout: check_path_length measures File.expand_path(path).length,
38
+ # Absolute paths throughout: check_path_length measures the path's absolute spelling,
36
39
  # so a relative path would pick up the test-runner's own CWD and throw off the
37
40
  # precise threshold arithmetic these examples depend on. The padding is sized off
38
- # File.expand_path('/')'s own actual length rather than assumed to be 1, since Windows
39
- # expands a bare '/' by prepending a drive letter (e.g. "C:/") -- without probing that
40
- # overhead first, expanded lengths on Windows would run a couple characters longer than
41
- # intended and throw off the precise threshold boundaries these examples depend on.
41
+ # the absolute spelling of '/' rather than assumed to be 1, since Windows spells a bare
42
+ # '/' with a drive letter (e.g. "C:/") -- without probing that overhead first, lengths
43
+ # on Windows would run a couple characters longer than intended and throw off the
44
+ # precise threshold boundaries these examples depend on.
42
45
  def path_of_length(n)
43
- overhead = File.expand_path('/').length - 1
46
+ overhead = ProjectPaths.absolute('/').length - 1
44
47
  '/' + ('a' * (n - 1 - overhead))
45
48
  end
46
49
 
@@ -125,6 +128,188 @@ describe FileWrapper do
125
128
  expect(@loginator).to have_received(:log).with(any_args, Verbosity::ERRORS)
126
129
  end
127
130
  end
131
+
132
+ # A build file is created, opened, and written through separate FileWrapper calls, and
133
+ # each checks its path. One report per path keeps a real failure from being buried.
134
+ context 'one report per path' do
135
+ it 'reports a long path once, whichever operation checks it' do
136
+ path = path_of_length(5000)
137
+ ['FileWrapper#mkdir', 'FileWrapper#open', 'FileWrapper#write'].each do |origin|
138
+ @file_wrapper.check_path_length(path, origin: origin)
139
+ end
140
+
141
+ expect(@loginator).to have_received(:log).once
142
+ end
143
+
144
+ it 'reports a relative and an absolute spelling of one path once' do
145
+ relative = 'b' * 5000
146
+ @file_wrapper.check_path_length(relative, origin: 'Test')
147
+ @file_wrapper.check_path_length(File.join(ProjectPaths.working_dir, relative), origin: 'Test')
148
+
149
+ expect(@loginator).to have_received(:log).once
150
+ end
151
+
152
+ it 'reports each of two long paths' do
153
+ @file_wrapper.check_path_length(path_of_length(5000), origin: 'Test')
154
+ @file_wrapper.check_path_length(path_of_length(5001), origin: 'Test')
155
+
156
+ expect(@loginator).to have_received(:log).twice
157
+ end
158
+
159
+ it 'remembers nothing, and takes no lock, for a path below the warning band' do
160
+ expect(@file_wrapper.instance_variable_get(:@path_lock)).not_to receive(:synchronize)
161
+ expect(ProjectPaths).not_to receive(:absolute)
162
+
163
+ @file_wrapper.check_path_length('src/short/path.c', origin: 'Test')
164
+
165
+ expect(@file_wrapper.instance_variable_get(:@path_reports)).to be_empty
166
+ end
167
+
168
+ it 'measures a relative path against the remembered working directory, not the process\'s' do
169
+ expect(File).to receive(:expand_path).with('src/file.c', ProjectPaths.working_dir).and_call_original
170
+
171
+ @file_wrapper.check_path_length('src/file.c', origin: 'Test')
172
+ end
173
+ end
174
+
175
+ # :project ↳ :win_path_limit. The prober is a double; what it decides and logs is
176
+ # specified in win_path_prober_spec.rb.
177
+ context 'Windows path limit' do
178
+ before(:each) do
179
+ allow(SystemWrapper).to receive(:windows?).and_return(true)
180
+ @logged = []
181
+ allow(@loginator).to receive(:log) { |message, verbosity = nil, label = nil| @logged << [message, verbosity, label] }
182
+ @prober = double('win_path_prober')
183
+ end
184
+
185
+ def configure(mode, long_paths: nil)
186
+ allow(@prober).to receive(:long_paths?).and_return(long_paths) unless long_paths.nil?
187
+ @file_wrapper.configure_win_path_limit(mode: mode, prober: @prober)
188
+ end
189
+
190
+ def check(length, directory: false)
191
+ @file_wrapper.check_path_length(path_of_length(length), origin: 'Test', directory: directory)
192
+ end
193
+
194
+ def verbosities
195
+ return @logged.map { |_message, verbosity, _label| verbosity }
196
+ end
197
+
198
+ context ':classic' do
199
+ before(:each) { configure(:classic) }
200
+
201
+ it 'never asks the prober' do
202
+ expect(@prober).not_to receive(:long_paths?)
203
+ check(300)
204
+ end
205
+
206
+ it 'reports a path at 260 against Windows\' limit, pointing to the setting' do
207
+ check(300)
208
+
209
+ expect(@logged.length).to eq( 1 )
210
+ message, verbosity = @logged.first
211
+ expect(verbosity).to eq( Verbosity::ERRORS )
212
+ expect(message).to match( /Path length \(300\) reaches or exceeds Windows' 260-character limit/ )
213
+ expect(message).to include( ':project ↳ :win_path_limit' )
214
+ end
215
+
216
+ it 'warns of a file path in the band below 260' do
217
+ check(240)
218
+ expect(verbosities).to eq( [Verbosity::COMPLAIN] )
219
+ expect(@logged.first.first).to match( /is approaching Windows' 260-character limit/ )
220
+ end
221
+
222
+ it 'reports a directory past 248 as an error, though a file of that length only warns' do
223
+ check(252, directory: true)
224
+ check(253)
225
+
226
+ expect(verbosities).to eq( [Verbosity::ERRORS, Verbosity::COMPLAIN] )
227
+ expect(@logged.first.first).to match( /Directory path length \(252\) reaches or exceeds Windows' 248-character limit for directories/ )
228
+ end
229
+ end
230
+
231
+ [:long_paths, :auto].each do |mode|
232
+ context mode.inspect do
233
+ it 'asks the prober with this mode once a path nears the classic limit' do
234
+ configure(mode, long_paths: true)
235
+ check(300)
236
+
237
+ expect(@prober).to have_received(:long_paths?).with( mode )
238
+ end
239
+
240
+ it 'never asks the prober for a path below the warning band' do
241
+ configure(mode, long_paths: true)
242
+ check(200)
243
+
244
+ expect(@prober).not_to have_received(:long_paths?)
245
+ end
246
+
247
+ it 'asks once, then keeps the answer' do
248
+ configure(mode, long_paths: false)
249
+ check(300)
250
+ check(301)
251
+
252
+ expect(@prober).to have_received(:long_paths?).once
253
+ end
254
+
255
+ it 'reports nothing below the long limit once long paths are in effect' do
256
+ configure(mode, long_paths: true)
257
+ check(300)
258
+ check(252, directory: true)
259
+
260
+ expect(@logged).to be_empty
261
+ end
262
+
263
+ # Windows' own path functions can't expand a path past 32,767 characters, so the
264
+ # measured length is given rather than taken from File.expand_path on every OS
265
+ it 'reports a path past the long limit against it' do
266
+ configure(mode, long_paths: true)
267
+ path = path_of_length(300)
268
+ allow(File).to receive(:expand_path).and_call_original
269
+ allow(File).to receive(:expand_path).with(path, ProjectPaths.working_dir).and_return('/' + ('a' * 32_799))
270
+
271
+ @file_wrapper.check_path_length(path, origin: 'Test')
272
+
273
+ expect(@logged.first.first).to match( /reaches or exceeds Windows' 32,767-character long path limit/ )
274
+ end
275
+
276
+ it 'reports against 260, without the pointer, when long paths are not in effect' do
277
+ configure(mode, long_paths: false)
278
+ check(300)
279
+
280
+ expect(verbosities).to eq( [Verbosity::ERRORS] )
281
+ expect(@logged.first.first).to match( /260-character limit/ )
282
+ expect(@logged.first.first).not_to include( ':project ↳ :win_path_limit' )
283
+ end
284
+ end
285
+ end
286
+
287
+ it 'ignores the setting and never asks the prober on macOS and Linux' do
288
+ allow(SystemWrapper).to receive(:windows?).and_return(false)
289
+ expect(@prober).not_to receive(:long_paths?)
290
+ @file_wrapper.configure_win_path_limit(mode: :auto, prober: @prober)
291
+
292
+ check(5000)
293
+
294
+ expect(@logged.first.first).to match( /this platform's practical limit \(4096\)/ )
295
+ end
296
+ end
297
+ end
298
+
299
+ describe '#mkdir and #mkdir_tmp' do
300
+ it 'checks a directory it makes as a directory' do
301
+ allow(FileUtils).to receive(:mkdir_p)
302
+ expect(@file_wrapper).to receive(:check_path_length).with('build/dir', origin: 'FileWrapper#mkdir', directory: true)
303
+
304
+ @file_wrapper.mkdir('build/dir')
305
+ end
306
+
307
+ it 'checks a temporary directory it makes as a directory' do
308
+ allow(Dir).to receive(:mktmpdir).and_return('build/tmp123')
309
+ expect(@file_wrapper).to receive(:check_path_length).with('build/tmp123', origin: 'FileWrapper#mkdir_tmp', directory: true)
310
+
311
+ @file_wrapper.mkdir_tmp('tmp', 'build')
312
+ end
128
313
  end
129
314
 
130
315
  # #104 -- plain FileList.new(files)/#include treats every entry as a glob pattern to
@@ -211,13 +396,9 @@ describe FileWrapper do
211
396
  end
212
397
  end
213
398
 
214
- # Same transient-visibility race as #open_with_retry, here hitting FileUtils.cp_r's
215
- # own internal stat-then-open sequence instead of a bare File.open (Issue #1292:
216
- # a vendor destination briefly reporting the wrong file/directory type mid-copy).
217
- # Stub-based, matching #open_with_retry's own spec above -- no real filesystem or
218
- # timing involved.
219
- # A transient error mid-copy (a path briefly the wrong type, a file another process holds
220
- # open on Windows) is retried; one that never clears names the destination.
399
+ # A transient error mid-copy, such as a file another process holds open on Windows, is
400
+ # retried; one that never clears names the file. An error retrying cannot clear fails at
401
+ # once (GH #1376). FileTree's own specs cover the walk and the healing.
221
402
  describe '#sync_tree retries' do
222
403
  before(:each) do
223
404
  allow(@file_wrapper).to receive(:sleep)
@@ -241,12 +422,12 @@ describe FileWrapper do
241
422
  end
242
423
  end
243
424
 
244
- it 'retries past a SystemCallError and succeeds once the copy stops raising' do
425
+ it 'retries past a transient error and succeeds once the copy stops raising' do
245
426
  with_tree do |source, dest|
246
427
  calls = 0
247
428
  allow(@file_wrapper).to receive(:replace_file).and_wrap_original do |original, *args|
248
429
  calls += 1
249
- raise Errno::EISDIR, 'transient' if calls < 3
430
+ raise Errno::EACCES, 'transient' if calls < 3
250
431
  original.call( *args )
251
432
  end
252
433
 
@@ -260,15 +441,24 @@ describe FileWrapper do
260
441
 
261
442
  it 'raises a CeedlingException naming the destination once every retry is exhausted, and logs it' do
262
443
  with_tree do |source, dest|
263
- allow(@file_wrapper).to receive(:replace_file).and_raise( Errno::ENOTDIR, 'still wrong type' )
444
+ allow(@file_wrapper).to receive(:replace_file).and_raise( Errno::EACCES, 'still held open' )
264
445
 
265
446
  expect { @file_wrapper.sync_tree( source, dest ) }.to raise_error( CeedlingException, /#{Regexp.escape( dest )}/ )
266
- expect(@loginator).to have_received(:log).with( a_string_including( dest ), Verbosity::ERRORS )
447
+ expect(@loginator).to have_received(:log).with( a_string_including( dest ), Verbosity::ERRORS, LogLabels::AUTO )
267
448
  # Initial attempt plus one retry for each configured delay
268
449
  expect(@file_wrapper).to have_received(:replace_file).exactly( FileWrapper::TRANSIENT_IO_RETRY_DELAYS.size + 1 ).times
269
450
  end
270
451
  end
271
452
 
453
+ it 'fails at once on an error retrying cannot clear' do
454
+ with_tree do |source, dest|
455
+ allow(@file_wrapper).to receive(:replace_file).and_raise( Errno::ENOTDIR, 'wrong type' )
456
+
457
+ expect { @file_wrapper.sync_tree( source, dest ) }.to raise_error( Errno::ENOTDIR )
458
+ expect(@file_wrapper).not_to have_received(:sleep)
459
+ end
460
+ end
461
+
272
462
  it 'propagates an error that is not a SystemCallError without retrying' do
273
463
  with_tree do |source, dest|
274
464
  allow(@file_wrapper).to receive(:replace_file).and_raise( ArgumentError, 'not transient' )
@@ -279,6 +469,19 @@ describe FileWrapper do
279
469
  end
280
470
  end
281
471
 
472
+ describe '#tree_files' do
473
+ it 'lists every regular file below a directory as full paths in sorted path order' do
474
+ Dir.mktmpdir do |dir|
475
+ ['a/b.c', 'a.c', '.hidden', 'dir[1]/x.c'].each do |name|
476
+ FileUtils.mkdir_p( File.dirname( File.join( dir, name ) ) )
477
+ File.write( File.join( dir, name ), name )
478
+ end
479
+
480
+ expect( @file_wrapper.tree_files( dir ) ).to eq( ['.hidden', 'a.c', 'a/b.c', 'dir[1]/x.c'].map { |name| File.join( dir, name ) } )
481
+ end
482
+ end
483
+ end
484
+
282
485
  # The temporary copy beside the destination is the longest path replace_file writes
283
486
  describe '#replace_file' do
284
487
  it 'checks the length of its temporary path, then leaves only the destination' do
@@ -298,6 +501,71 @@ describe FileWrapper do
298
501
  expect( Dir.children( File.dirname( destination ) ) ).to eq( ['unity.h'] )
299
502
  end
300
503
  end
504
+
505
+ # Windows refuses to rename over a read-only file
506
+ it 'leaves the destination owner-writable, from a read-only source over a read-only destination' do
507
+ Dir.mktmpdir do |dir|
508
+ source = File.join( dir, 'unity.h' )
509
+ destination = File.join( dir, 'out', 'unity.h' )
510
+ File.write( source, "new\n" )
511
+ FileUtils.mkdir_p( File.dirname( destination ) )
512
+ File.write( destination, "old\n" )
513
+ File.chmod( 0o444, source )
514
+ File.chmod( 0o444, destination )
515
+ allow(@file_wrapper).to receive(:check_path_length)
516
+
517
+ @file_wrapper.replace_file( source, destination )
518
+
519
+ expect( File.read( destination ) ).to eq( "new\n" )
520
+ expect( File.stat( destination ).mode & 0o200 ).to eq( 0o200 )
521
+ end
522
+ end
523
+
524
+ it 'replaces a destination link without changing the mode of the file it names' do
525
+ Dir.mktmpdir do |dir|
526
+ source = File.join( dir, 'unity.h' )
527
+ outside = File.join( dir, 'outside.h' )
528
+ destination = File.join( dir, 'out', 'unity.h' )
529
+ File.write( source, "new\n" )
530
+ File.write( outside, "outside\n" )
531
+ File.chmod( 0o444, outside )
532
+ FileUtils.mkdir_p( File.dirname( destination ) )
533
+ begin
534
+ File.symlink( outside, destination )
535
+ rescue NotImplementedError, SystemCallError => e
536
+ skip "symlinks are unavailable here (#{e.class})"
537
+ end
538
+ allow(@file_wrapper).to receive(:check_path_length)
539
+
540
+ @file_wrapper.replace_file( source, destination )
541
+
542
+ expect( File.read( destination ) ).to eq( "new\n" )
543
+ expect( File.stat( outside ).mode & 0o777 ).to eq( 0o444 )
544
+ end
545
+ end
546
+ end
547
+
548
+ describe '#mkdir_for' do
549
+ it 'makes every directory above a file and returns the filepath' do
550
+ Dir.mktmpdir do |dir|
551
+ filepath = File.join( dir, 'artifacts', 'test', 'unit', 'test_foo.log' )
552
+
553
+ expect( @file_wrapper.mkdir_for( filepath ) ).to eq( filepath )
554
+ expect( File.directory?( File.dirname( filepath ) ) ).to be true
555
+ expect( File.exist?( filepath ) ).to be false
556
+ end
557
+ end
558
+
559
+ it 'tolerates threads making the same directory at once' do
560
+ Dir.mktmpdir do |dir|
561
+ filepath = File.join( dir, 'a', 'b', 'c', 'test_foo.log' )
562
+
563
+ threads = Array.new( 8 ) { Thread.new { @file_wrapper.mkdir_for( filepath ) } }
564
+
565
+ expect { threads.each( &:join ) }.to_not raise_error
566
+ expect( File.directory?( File.dirname( filepath ) ) ).to be true
567
+ end
568
+ end
301
569
  end
302
570
 
303
571
  # The removal methods are thin pass-throughs to FileUtils. These examples exist
@@ -6,7 +6,7 @@
6
6
  # =========================================================================
7
7
 
8
8
  require 'spec_helper'
9
- require 'ceedling/path_matcher'
9
+ require 'ceedling/filesystem/path_matcher'
10
10
  require 'ceedling/exceptions'
11
11
 
12
12
  describe PathMatcher do
@@ -190,4 +190,51 @@ describe PathMatcher do
190
190
  end
191
191
  end
192
192
 
193
+
194
+ # A `.` segment names nothing (the path handling audit around GH #1370)
195
+ # The directory a search path must be for `tail` joined with it to name `path`
196
+ describe '.strip_tail' do
197
+ it 'gives what lies above the tail' do
198
+ expect(described_class.strip_tail( 'src/path/to/sensor.h', 'sensor.h' )).to eq( 'src/path/to' )
199
+ expect(described_class.strip_tail( 'src/path/to/sensor.h', 'path/to/sensor.h' )).to eq( 'src' )
200
+ end
201
+
202
+ it 'gives `.` when the tail is the whole path' do
203
+ expect(described_class.strip_tail( 'src/sensor.h', 'src/sensor.h' )).to eq( '.' )
204
+ end
205
+
206
+ it 'keeps an absolute path absolute' do
207
+ expect(described_class.strip_tail( '/usr/include/x86_64-linux-gnu/sys/socket.h', 'sys/socket.h' )).to eq( '/usr/include/x86_64-linux-gnu' )
208
+ expect(described_class.strip_tail( '/sys/socket.h', 'sys/socket.h' )).to eq( '/' )
209
+ end
210
+
211
+ it 'keeps a drive letter, with forward slashes' do
212
+ expect(described_class.strip_tail( 'C:\\sdk\\inc\\sys\\socket.h', 'sys/socket.h' )).to eq( 'C:/sdk/inc' )
213
+ expect(described_class.strip_tail( 'C:/sys/socket.h', 'sys/socket.h' )).to eq( 'C:/' )
214
+ end
215
+
216
+ it 'keeps a share' do
217
+ expect(described_class.strip_tail( '//server/sdk/sys/socket.h', 'sys/socket.h' )).to eq( '//server/sdk' )
218
+ end
219
+
220
+ it 'ignores `./` and doubled separators' do
221
+ expect(described_class.strip_tail( './src//path/sensor.h', './path/sensor.h' )).to eq( 'src' )
222
+ end
223
+
224
+ it 'gives nil when the path ends otherwise' do
225
+ expect(described_class.strip_tail( 'src/path/to/sensor.h', 'other/sensor.h' )).to be_nil
226
+ expect(described_class.strip_tail( 'src/path/to/sensor.h', 'Sensor.h' )).to be_nil
227
+ expect(described_class.strip_tail( 'sensor.h', 'to/sensor.h' )).to be_nil
228
+ end
229
+ end
230
+
231
+ describe 'G9: `.` segments' do
232
+ it 'matches a query with a leading `./`' do
233
+ expect(PathMatcher.candidates( './foo.h', ['inc/foo.h'] )).to eq( ['inc/foo.h'] )
234
+ end
235
+
236
+ it 'matches a query with a `.` segment within it' do
237
+ expect(PathMatcher.candidates( 'sub/./bar.h', ['inc/sub/bar.h'] )).to eq( ['inc/sub/bar.h'] )
238
+ end
239
+ end
193
240
  end
@@ -6,7 +6,7 @@
6
6
  # =========================================================================
7
7
 
8
8
  require 'spec_helper'
9
- require 'ceedling/path_mirror'
9
+ require 'ceedling/filesystem/path_mirror'
10
10
 
11
11
  describe PathMirror do
12
12
 
@@ -20,9 +20,9 @@ describe PathMirror do
20
20
  expect(described_class.relative_subdir('src/drivers/sensors/foo.c', ['src/**'])).to eq('drivers/sensors')
21
21
  end
22
22
 
23
- it 'strips +:/-: aggregation decorators from configured roots before comparing' do
23
+ it 'strips a +: decorator, and never treats a -: exclusion as a root' do
24
24
  expect(described_class.relative_subdir('src/drivers/foo.c', ['+:src/**'])).to eq('drivers')
25
- expect(described_class.relative_subdir('src/drivers/foo.c', ['-:src/**'])).to eq('drivers')
25
+ expect(described_class.relative_subdir('src/drivers/foo.c', ['-:src/**'])).to eq('')
26
26
  end
27
27
 
28
28
  it 'picks the most specific (longest) matching root when configured roots are nested' do
@@ -49,7 +49,7 @@ describe PathMirror do
49
49
  it 'produces the same result as .relative_subdir when roots are cleaned once upfront' do
50
50
  clean = described_class.clean_roots(['+:src/**', '-:src/legacy/**'])
51
51
  expect(described_class.relative_subdir_from_clean_roots('src/drivers/foo.c', clean)).to eq('drivers')
52
- expect(described_class.relative_subdir_from_clean_roots('src/legacy/vendor/foo.c', clean)).to eq('vendor')
52
+ expect(described_class.relative_subdir_from_clean_roots('src/legacy/vendor/foo.c', clean)).to eq('legacy/vendor')
53
53
  end
54
54
 
55
55
  it 'drops decorated roots that clean to nothing' do
@@ -100,4 +100,32 @@ describe PathMirror do
100
100
  expect( PathMirror.path_segments('drivers//uart/') ).to eq(['drivers', 'uart'])
101
101
  end
102
102
  end
103
+
104
+ # Root matching across spellings of one place (GH #1370 and the path handling audit)
105
+ describe 'root containment' do
106
+ it 'G1 (#1370): never answers a subdirectory that climbs out, below a `..` root' do
107
+ subdir = PathMirror.relative_subdir( '../../../opt/vendor/inc/x.h', ['../**'] )
108
+
109
+ expect(subdir.split( '/' )).to_not include( '..' )
110
+ end
111
+
112
+ it 'G2: mirrors below a `./`-spelled root as below the plain one' do
113
+ expect(PathMirror.relative_subdir( 'src/a/x.c', ['./src/**'] )).to eq( 'a' )
114
+ end
115
+
116
+ it 'G2: mirrors below an absolute root spelling of a relative file\'s directory' do
117
+ expect(PathMirror.relative_subdir( 'src/a/x.c', [File.join( Dir.pwd, 'src/**' )] )).to eq( 'a' )
118
+ end
119
+
120
+ it 'G2: mirrors a file spelled relatively below an absolute root outside the working directory' do
121
+ file = File.join( '..', '..', 'opt', 'x', 'a', 'f.c' )
122
+ root = File.join( File.expand_path( '../..' ), 'opt', 'x', '**' )
123
+
124
+ expect(PathMirror.relative_subdir( file, [root] )).to eq( 'a' )
125
+ end
126
+
127
+ it 'G3: never treats a `-:` exclusion as a root' do
128
+ expect(PathMirror.relative_subdir( 'src/exp/sub/x.c', ['+:src/**', '-:src/exp'] )).to eq( 'exp/sub' )
129
+ end
130
+ end
103
131
  end
@@ -0,0 +1,147 @@
1
+ # =========================================================================
2
+ # Ceedling - Test-Centered Build System for C
3
+ # ThrowTheSwitch.org
4
+ # Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
5
+ # SPDX-License-Identifier: MIT
6
+ # =========================================================================
7
+
8
+ require 'spec_helper'
9
+ require 'tmpdir'
10
+ require 'fileutils'
11
+ require 'ceedling/filesystem/project_paths'
12
+
13
+ # GH #1370 and the path handling audit around it: one place spelled many ways compared
14
+ # as text, so `..` "contained" paths above it and build files escaped the build directory
15
+ describe ProjectPaths do
16
+ WINDOWS_ONLY = { if: Gem.win_platform? }.freeze
17
+ POSIX_ONLY = { unless: Gem.win_platform? }.freeze
18
+
19
+ around(:each) do |example|
20
+ Dir.mktmpdir do |dir|
21
+ @ws = File.realpath( dir )
22
+ FileUtils.mkdir_p( File.join( @ws, 'app' ) )
23
+ Dir.chdir( File.join( @ws, 'app' ) ) { example.run }
24
+ end
25
+ end
26
+
27
+ describe '.standardize' do
28
+ it 'writes a path with forward slashes and no trailing separator' do
29
+ expect(ProjectPaths.standardize( " src\\drv\\ " )).to eq( 'src/drv' )
30
+ end
31
+
32
+ it 'reads `~` as the home directory, after any decorator' do
33
+ expect(ProjectPaths.standardize( '~/inc' )).to eq( File.join( Dir.home, 'inc' ) )
34
+ expect(ProjectPaths.standardize( '-:~/inc' )).to eq( "-:#{File.join( Dir.home, 'inc' )}" )
35
+ end
36
+
37
+ it 'leaves `~user` as written' do
38
+ expect(ProjectPaths.standardize( '~someone/inc' )).to eq( '~someone/inc' )
39
+ end
40
+
41
+ it 'keeps a filesystem root' do
42
+ expect(ProjectPaths.standardize( '/' )).to eq( '/' )
43
+ end
44
+
45
+ it 'reads `~` after a decorator and a space, and drops every trailing separator' do
46
+ expect(ProjectPaths.standardize( '+: ~/inc' )).to eq( "+:#{File.join( Dir.home, 'inc' )}" )
47
+ expect(ProjectPaths.standardize( 'src//' )).to eq( 'src' )
48
+ end
49
+ end
50
+
51
+ describe '.absolute' do
52
+ # Spelled as the full computation spells it, whatever the shortcut for a clean path
53
+ it 'spells a rooted path with a trailing separator or surrounding space without either' do
54
+ expect(ProjectPaths.absolute( '/a/' )).to eq( '/a' ) unless Gem.win_platform?
55
+ expect(ProjectPaths.absolute( " #{@ws}/x " )).to eq( "#{@ws}/x" )
56
+ end
57
+
58
+ it 'reads `~user` as a directory of that name, never the user\'s home' do
59
+ expect(ProjectPaths.absolute( '~nosuchuser/inc' )).to eq( File.join( @ws, 'app', '~nosuchuser/inc' ) )
60
+ end
61
+
62
+ it 'reads a doubled leading separator as the filesystem root', **POSIX_ONLY do
63
+ expect(ProjectPaths.absolute( '//usr/include' )).to eq( '/usr/include' )
64
+ expect(ProjectPaths.contains?( '/usr', '//usr/include' )).to be true
65
+ end
66
+
67
+ it 'keeps a UNC path\'s `..` below its share', **WINDOWS_ONLY do
68
+ expect(ProjectPaths.absolute( '//srv/sh/a/../../../x' )).to eq( '//srv/sh/x' )
69
+ end
70
+ end
71
+
72
+ describe '.canonical' do
73
+ it 'spells every form of one place alike' do
74
+ FileUtils.mkdir_p( 'src/drv' )
75
+ spellings = ['src/drv', './src/drv', 'src/drv/', 'src\\drv', File.join( @ws, 'app/src/drv' ), 'src/../src/drv']
76
+
77
+ expect(spellings.map { |spelling| ProjectPaths.canonical( spelling ) }.uniq).to eq( ['src/drv'] )
78
+ end
79
+
80
+ it 'resolves a symlink along the existing part of a path', **POSIX_ONLY do
81
+ FileUtils.mkdir_p( 'src' )
82
+ File.symlink( File.join( @ws, 'app' ), File.join( @ws, 'link' ) )
83
+
84
+ expect(ProjectPaths.canonical( File.join( @ws, 'link/src/not_yet' ) )).to eq( 'src/not_yet' )
85
+ end
86
+
87
+ it 'climbs to a place outside the project' do
88
+ expect(ProjectPaths.canonical( File.join( @ws, 'shared/src' ) )).to eq( '../shared/src' )
89
+ end
90
+ end
91
+
92
+ describe '.subdir_below' do
93
+ it 'names the directories from a root down to a path below it' do
94
+ expect(ProjectPaths.subdir_below( 'src', 'src/drv/uart' )).to eq( 'drv/uart' )
95
+ expect(ProjectPaths.subdir_below( 'src', 'src' )).to eq( '' )
96
+ end
97
+
98
+ it 'finds nothing below a root that only shares a path\'s leading text' do
99
+ expect(ProjectPaths.subdir_below( 'src', 'src2/x' )).to be_nil
100
+ end
101
+
102
+ it 'finds nothing below `..` for a path climbing past it' do
103
+ expect(ProjectPaths.subdir_below( '..', '../../vendor/inc' )).to be_nil
104
+ expect(ProjectPaths.subdir_below( '..', '../vendor/inc' )).to eq( 'vendor/inc' )
105
+ end
106
+
107
+ it 'compares every spelling of a root and a path' do
108
+ expect(ProjectPaths.subdir_below( './src', File.join( @ws, 'app/src/a' ) )).to eq( 'a' )
109
+ expect(ProjectPaths.subdir_below( File.join( @ws, 'app/src' ), 'src/a' )).to eq( 'a' )
110
+ end
111
+
112
+ it 'never answers a subdirectory that climbs or is absolute' do
113
+ roots = ['..', '../..', '.', 'src', File.join( @ws, 'vendor' ), '/']
114
+ paths = ['../../far/x', '../vendor/inc', 'src/a', '/opt/x', File.join( @ws, 'vendor/inc' )]
115
+
116
+ roots.product( paths ).each do |root, path|
117
+ subdir = ProjectPaths.subdir_below( root, path )
118
+ next if subdir.nil?
119
+
120
+ expect(subdir.split( '/' )).to_not include( '..' ), "#{root} below #{path}: #{subdir}"
121
+ expect(subdir).to_not start_with( '/' ), "#{root} below #{path}: #{subdir}"
122
+ end
123
+ end
124
+
125
+ it 'compares Windows paths without regard to case', **WINDOWS_ONLY do
126
+ expect(ProjectPaths.subdir_below( 'C:/Proj/Src', 'c:/proj/src/a' )).to eq( 'a' )
127
+ end
128
+ end
129
+
130
+ # A build asks for the working directory tens of thousands of times, and asking the
131
+ # operating system costs tens of microseconds on macOS
132
+ describe '.working_dir' do
133
+ it 'reads the working directory once, however often it is asked' do
134
+ ProjectPaths.working_dir
135
+ expect(Dir).not_to receive(:pwd)
136
+
137
+ 3.times { expect(ProjectPaths.working_dir).to eq( File.join( @ws, 'app' ) ) }
138
+ end
139
+
140
+ it 'answers a remembered path without reading the working directory' do
141
+ ProjectPaths.absolute( 'src/drv' )
142
+ expect(Dir).not_to receive(:pwd)
143
+
144
+ expect(ProjectPaths.absolute( 'src/drv' )).to eq( File.join( @ws, 'app/src/drv' ) )
145
+ end
146
+ end
147
+ end