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,216 @@
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 'ceedling/filesystem/test_build_layout'
10
+ require 'ceedling/filesystem/build_subpath'
11
+
12
+ describe TestBuildLayout do
13
+
14
+ LAYOUT_BASES = {
15
+ mocks: 'build/test/mocks',
16
+ partials: 'build/test/partials',
17
+ preprocess_includes: 'build/test/preprocess/includes',
18
+ preprocess_files: 'build/test/preprocess/files',
19
+ build_directives: 'build/test/preprocess/build_directives',
20
+ out: 'build/test/out',
21
+ dependencies: 'build/test/dependencies'
22
+ }.freeze
23
+
24
+ before(:each) do
25
+ @configurator = double( 'configurator' )
26
+ @file_wrapper = double( 'file_wrapper' )
27
+ allow(@file_wrapper).to receive(:check_path_length)
28
+
29
+ allow(@configurator).to receive(:project_build_root).and_return( 'build' )
30
+ allow(@configurator).to receive(:project_use_mocks).and_return( true )
31
+ allow(@configurator).to receive(:project_use_partials).and_return( true )
32
+ allow(@configurator).to receive(:cmock_mock_path).and_return( LAYOUT_BASES[:mocks] )
33
+ allow(@configurator).to receive(:project_test_partials_path).and_return( LAYOUT_BASES[:partials] )
34
+ allow(@configurator).to receive(:project_test_preprocess_includes_path).and_return( LAYOUT_BASES[:preprocess_includes] )
35
+ allow(@configurator).to receive(:project_test_preprocess_files_path).and_return( LAYOUT_BASES[:preprocess_files] )
36
+ allow(@configurator).to receive(:project_test_preprocess_build_directives_path).and_return( LAYOUT_BASES[:build_directives] )
37
+
38
+ @layout = described_class.new( { :configurator => @configurator, :file_wrapper => @file_wrapper } )
39
+ end
40
+
41
+ it 'reserves the segment `_t_`' do
42
+ expect( BuildSubpath::OWN_SEGMENT ).to eq( '_t_' )
43
+ end
44
+
45
+ describe '#base' do
46
+ LAYOUT_BASES.each do |kind, base|
47
+ it "gives the shared #{kind} directory" do
48
+ expect( @layout.base( kind, context: :test ) ).to eq( base )
49
+ end
50
+ end
51
+
52
+ it 'places the output and dependencies bases below their build context' do
53
+ expect( @layout.base( :out, context: :gcov ) ).to eq( 'build/gcov/out' )
54
+ expect( @layout.base( :dependencies, context: :gcov ) ).to eq( 'build/gcov/dependencies' )
55
+ expect( @layout.base( :out ) ).to eq( 'build/out' )
56
+ end
57
+
58
+ it 'gives no base for a disabled feature' do
59
+ allow(@configurator).to receive(:project_use_mocks).and_return( false )
60
+ allow(@configurator).to receive(:project_use_partials).and_return( false )
61
+
62
+ expect( @layout.base( :mocks ) ).to be_nil
63
+ expect( @layout.base( :partials ) ).to be_nil
64
+ end
65
+ end
66
+
67
+ describe '#root' do
68
+ LAYOUT_BASES.each do |kind, base|
69
+ it "closes a test's #{kind} directory with `_t_`" do
70
+ expect( @layout.root( kind, 'test/unit/test_foo', context: :test ) ).to eq( "#{base}/test/unit/test_foo/_t_" )
71
+ end
72
+ end
73
+
74
+ it 'gives no root for a nil or empty name' do
75
+ expect( @layout.root( :mocks, nil ) ).to be_nil
76
+ expect( @layout.root( :mocks, '' ) ).to be_nil
77
+ expect( @layout.root( :out, nil, context: :test ) ).to be_nil
78
+ end
79
+
80
+ it 'gives no root for a disabled feature' do
81
+ allow(@configurator).to receive(:project_use_mocks).and_return( false )
82
+ allow(@configurator).to receive(:project_use_partials).and_return( false )
83
+
84
+ expect( @layout.root( :mocks, 'test/test_c' ) ).to be_nil
85
+ expect( @layout.root( :partials, 'test/test_c' ) ).to be_nil
86
+ end
87
+
88
+ it "places a nested test's root beside its parent's subdirectory of the same name" do
89
+ expect( @layout.root( :mocks, 'test/test_c/test_x' ) ).to eq( 'build/test/mocks/test/test_c/test_x/_t_' )
90
+ expect( @layout.file( :mocks, 'test/test_c', 'test_x/mock_qux.c' ) ).to eq( 'build/test/mocks/test/test_c/_t_/test_x/mock_qux.c' )
91
+ end
92
+
93
+ it "checks the root's length once" do
94
+ @layout.root( :out, 'test/test_c', context: :test )
95
+
96
+ expect(@file_wrapper).to have_received(:check_path_length).once
97
+ end
98
+
99
+ # Windows limits a directory's path more tightly than a file's
100
+ it "checks the root's length as a directory's" do
101
+ @layout.root( :mocks, 'test/test_c' )
102
+
103
+ expect(@file_wrapper).to have_received(:check_path_length).with( 'build/test/mocks/test/test_c/_t_', origin: 'TestBuildLayout#root', directory: true )
104
+ end
105
+ end
106
+
107
+ describe '#file' do
108
+ LAYOUT_BASES.each do |kind, base|
109
+ it "places a file below a test's #{kind} root" do
110
+ expect( @layout.file( kind, 'test/test_c', 'drv/x.h', context: :test ) ).to eq( "#{base}/test/test_c/_t_/drv/x.h" )
111
+ end
112
+ end
113
+
114
+ it 'gives the root itself for no subpath' do
115
+ expect( @layout.file( :mocks, 'test/test_c', '' ) ).to eq( 'build/test/mocks/test/test_c/_t_' )
116
+ expect( @layout.file( :mocks, 'test/test_c', nil ) ).to eq( 'build/test/mocks/test/test_c/_t_' )
117
+ end
118
+
119
+ it 'gives nothing where the test has no root' do
120
+ allow(@configurator).to receive(:project_use_partials).and_return( false )
121
+
122
+ expect( @layout.file( :mocks, nil, 'mock_x.h' ) ).to be_nil
123
+ expect( @layout.file( :partials, 'test/test_c', 'x.h' ) ).to be_nil
124
+ end
125
+ end
126
+
127
+ describe '#generated_roots' do
128
+ it "gives a test's Partials root and mock root" do
129
+ expect( @layout.generated_roots( 'test/test_c' ) ).to eq( ['build/test/partials/test/test_c/_t_', 'build/test/mocks/test/test_c/_t_'] )
130
+ end
131
+
132
+ it 'leaves out a disabled feature' do
133
+ allow(@configurator).to receive(:project_use_partials).and_return( false )
134
+
135
+ expect( @layout.generated_roots( 'test/test_c' ) ).to eq( ['build/test/mocks/test/test_c/_t_'] )
136
+ end
137
+
138
+ it 'gives none for no test' do
139
+ expect( @layout.generated_roots( nil ) ).to eq( [] )
140
+ end
141
+ end
142
+
143
+ describe '#locate' do
144
+ LAYOUT_BASES.each do |kind, base|
145
+ it "names the test of a file below its #{kind} root" do
146
+ expect( @layout.locate( "#{base}/test/test_c/_t_/test_x/mock_qux.c", context: :test ) ).to eq( 'test/test_c' )
147
+ end
148
+ end
149
+
150
+ it "tells a nested test's file from its parent's file in a folder of the nested test's name" do
151
+ expect( @layout.locate( 'build/test/mocks/test/test_c/test_x/_t_/mock_qux.c' ) ).to eq( 'test/test_c/test_x' )
152
+ expect( @layout.locate( 'build/test/mocks/test/test_c/_t_/test_x/mock_qux.c' ) ).to eq( 'test/test_c' )
153
+ end
154
+
155
+ # The first `_t_` ends the name, since no name holds one
156
+ it 'ends the name at the first `_t_`' do
157
+ expect( @layout.locate( 'build/test/mocks/test/test_c/_t_/_t_/mock_qux.c' ) ).to eq( 'test/test_c' )
158
+ end
159
+
160
+ it "names a test whose own directory is named like `_t_` by its escaped name" do
161
+ name = BuildSubpath.encode( 'test/_t_/test_c' )
162
+
163
+ expect( @layout.locate( @layout.file( :out, name, 'x.o', context: :test ), context: :test ) ).to eq( 'test/__t_/test_c' )
164
+ end
165
+
166
+ it 'names the test of its root itself' do
167
+ expect( @layout.locate( 'build/test/out/test/test_c/_t_', context: :test ) ).to eq( 'test/test_c' )
168
+ end
169
+
170
+ it "locates a file below the context's own output root" do
171
+ expect( @layout.locate( 'build/gcov/out/test/test_c/_t_/src/x.o', context: :gcov ) ).to eq( 'test/test_c' )
172
+ expect( @layout.locate( 'build/gcov/out/test/test_c/_t_/src/x.o', context: :test ) ).to be_nil
173
+ end
174
+
175
+ it 'locates nothing below no test root' do
176
+ expect( @layout.locate( 'build/test/out/test/test_c/test_c.o', context: :test ) ).to be_nil
177
+ expect( @layout.locate( 'build/test/mocks/_t_/mock_x.c' ) ).to be_nil
178
+ expect( @layout.locate( 'src/test_x/qux.c', context: :test ) ).to be_nil
179
+ expect( @layout.locate( 'build/test/runners/test/test_c_runner.c', context: :test ) ).to be_nil
180
+ end
181
+
182
+ it 'locates nothing below a disabled feature' do
183
+ allow(@configurator).to receive(:project_use_mocks).and_return( false )
184
+
185
+ expect( @layout.locate( 'build/test/mocks/test/test_c/_t_/mock_x.c' ) ).to be_nil
186
+ end
187
+
188
+ # Below the output base, the mock's test would be `mocks/test/test_c`
189
+ it 'counts the most specific base holding a path' do
190
+ allow(@configurator).to receive(:cmock_mock_path).and_return( 'build/test/out/mocks' )
191
+
192
+ expect( @layout.locate( 'build/test/out/mocks/test/test_c/_t_/mock_x.c', context: :test ) ).to eq( 'test/test_c' )
193
+ end
194
+ end
195
+
196
+ describe '#subpath' do
197
+ LAYOUT_BASES.reject { |kind, _| TestBuildLayout::CONTEXTUAL.key?( kind ) }.each do |kind, base|
198
+ it "gives a path below a test's #{kind} root" do
199
+ expect( @layout.subpath( "#{base}/test/test_c/_t_/drv/x.h", kind: kind, name: 'test/test_c' ) ).to eq( 'drv/x.h' )
200
+ end
201
+ end
202
+
203
+ it "gives nothing for a path outside the test's root" do
204
+ expect( @layout.subpath( 'build/test/mocks/test/test_c/test_x/_t_/mock_qux.h', kind: :mocks, name: 'test/test_c' ) ).to be_nil
205
+ expect( @layout.subpath( 'test_x/mock_qux.h', kind: :mocks, name: 'test/test_c' ) ).to be_nil
206
+ end
207
+
208
+ it 'gives nothing for no name or a disabled feature' do
209
+ allow(@configurator).to receive(:project_use_mocks).and_return( false )
210
+
211
+ expect( @layout.subpath( 'build/test/partials/test/test_c/_t_/x.h', kind: :partials, name: nil ) ).to be_nil
212
+ expect( @layout.subpath( 'build/test/mocks/test/test_c/_t_/x.h', kind: :mocks, name: 'test/test_c' ) ).to be_nil
213
+ end
214
+ end
215
+
216
+ end
@@ -0,0 +1,204 @@
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 'ceedling/exceptions'
10
+ require 'ceedling/filesystem/win_long_paths'
11
+
12
+ # Touches no filesystem and runs no process. The disk is an in-memory fake that records
13
+ # each call, and the registry query returns canned output. The real disk and `reg query`
14
+ # are exercised in spec/integration/win_long_paths_probe_spec.rb and
15
+ # spec/integration/windows_registry_query_tool_spec.rb.
16
+ module WinLongPathsSpec
17
+ # `reg query` output as a hosted Windows runner prints it, with long paths enabled
18
+ ENABLED_OUTPUT = "\r\nHKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Control\\FileSystem\r\n" \
19
+ " LongPathsEnabled REG_DWORD 0x1\r\n\r\n".freeze
20
+ DISABLED_OUTPUT = ENABLED_OUTPUT.sub( '0x1', '0x0' ).freeze
21
+
22
+ # Records every call. A method named in `raises` raises that error. `glob_result`
23
+ # stands in for a glob that silently leaves entries out, as Ruby 3.0's does.
24
+ class FakeDisk
25
+ attr_reader :calls
26
+
27
+ def initialize(raises: {}, glob_result: nil)
28
+ @raises = raises
29
+ @glob_result = glob_result
30
+ @files = {}
31
+ @calls = []
32
+ end
33
+
34
+ def mkdir_p(path) = record( :mkdir_p, path ) { nil }
35
+ def write(path, c) = record( :write, path ) { @files[path] = c }
36
+ def read(path) = record( :read, path ) { @files.fetch( path ) }
37
+ def delete(path) = record( :delete, path ) { @files.delete( path ) }
38
+ def rmdir(path) = record( :rmdir, path ) { nil }
39
+
40
+ def children(path)
41
+ record( :children, path ) { @files.keys.select { |f| File.dirname( f ) == path }.map { |f| File.basename( f ) } }
42
+ end
43
+
44
+ def glob(pattern)
45
+ record( :glob, pattern ) { @glob_result || @files.keys.select { |f| File.fnmatch( pattern, f ) } }
46
+ end
47
+
48
+ private
49
+
50
+ def record(name, path)
51
+ @calls << [name, path]
52
+ raise @raises[name] if @raises.key?( name )
53
+
54
+ return yield
55
+ end
56
+ end
57
+ end
58
+
59
+ describe WinLongPaths do
60
+ def query_returning(output, success: true)
61
+ return -> { [output, success] }
62
+ end
63
+
64
+ let(:root) { '/build' }
65
+
66
+ describe '.registry_enabled?' do
67
+ it 'reads 0x1 as enabled' do
68
+ expect(described_class.registry_enabled?( query: query_returning( WinLongPathsSpec::ENABLED_OUTPUT ) )).to be true
69
+ end
70
+
71
+ it 'reads 0x0 as disabled' do
72
+ expect(described_class.registry_enabled?( query: query_returning( WinLongPathsSpec::DISABLED_OUTPUT ) )).to be false
73
+ end
74
+
75
+ it 'reads a missing value as disabled' do
76
+ output = "\r\nHKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Control\\FileSystem\r\n\r\n"
77
+ expect(described_class.registry_enabled?( query: query_returning( output ) )).to be false
78
+ end
79
+
80
+ it 'reads a failed query as disabled' do
81
+ output = "ERROR: The system was unable to find the specified registry key or value.\r\n"
82
+ expect(described_class.registry_enabled?( query: query_returning( output, success: false ) )).to be false
83
+ end
84
+
85
+ # ToolExecutor raises a ShellException when the tool can't run at all
86
+ it 'reads a query that could not run as disabled' do
87
+ query = -> { raise ShellException.new( name: 'reg', message: 'reg.exe not found' ) }
88
+ expect(described_class.registry_enabled?( query: query )).to be false
89
+ end
90
+
91
+ it 'has no query of its own' do
92
+ expect { described_class.registry_enabled? }.to raise_error( ::ArgumentError, /query/ )
93
+ end
94
+ end
95
+
96
+ describe '.probe' do
97
+ def probe(disk, output = WinLongPathsSpec::ENABLED_OUTPUT, query: query_returning( output ))
98
+ return described_class.probe( root, disk: disk, query: query )
99
+ end
100
+
101
+ def directories_made(disk)
102
+ return disk.calls.select { |name, _| name == :mkdir_p }.map(&:last)
103
+ end
104
+
105
+ it 'reports full support when files and listings both work' do
106
+ expect(probe( WinLongPathsSpec::FakeDisk.new )).to eq( { support: :full } )
107
+ end
108
+
109
+ it 'reports files only when listing a long directory raises, as on Ruby 3.1 to 3.4' do
110
+ disk = WinLongPathsSpec::FakeDisk.new( raises: { children: Errno::ENAMETOOLONG.new } )
111
+ expect(probe( disk )).to eq( { support: :files_only } )
112
+ end
113
+
114
+ it 'reports files only when a glob silently leaves the file out, as on Ruby 3.0' do
115
+ disk = WinLongPathsSpec::FakeDisk.new( glob_result: [] )
116
+ expect(probe( disk )).to eq( { support: :files_only } )
117
+ end
118
+
119
+ it 'blames the registry when writing fails and long paths are disabled' do
120
+ disk = WinLongPathsSpec::FakeDisk.new( raises: { write: Errno::ENOENT.new } )
121
+ expect(probe( disk, WinLongPathsSpec::DISABLED_OUTPUT )).to eq( { support: :none, cause: :registry_disabled } )
122
+ end
123
+
124
+ it 'blames the process when writing fails although long paths are enabled' do
125
+ disk = WinLongPathsSpec::FakeDisk.new( raises: { write: Errno::ENOENT.new } )
126
+ expect(probe( disk, WinLongPathsSpec::ENABLED_OUTPUT )).to eq( { support: :none, cause: :process_not_aware } )
127
+ end
128
+
129
+ it 'reports the query failure itself when the registry cannot be read' do
130
+ disk = WinLongPathsSpec::FakeDisk.new( raises: { mkdir_p: Errno::ENOENT.new } )
131
+ result = probe( disk, query: -> { raise ShellException.new( name: 'reg', message: 'reg.exe not found' ) } )
132
+
133
+ expect(result[:support]).to eq( :none )
134
+ expect(result[:cause]).to eq( :probe_failed )
135
+ expect(result[:error]).to match( /reg\.exe not found/ )
136
+ end
137
+
138
+ it 'has no registry query of its own' do
139
+ expect { described_class.probe( root, disk: WinLongPathsSpec::FakeDisk.new ) }.to raise_error( ::ArgumentError, /query/ )
140
+ end
141
+
142
+ it 'never queries the registry when the file test passes' do
143
+ query = -> { raise 'queried' }
144
+ expect(probe( WinLongPathsSpec::FakeDisk.new, query: query )).to eq( { support: :full } )
145
+ end
146
+
147
+ # Each directory from `deep` up to `base`, deepest first. It stops at the top of the
148
+ # path too, so a wrong base fails the example instead of climbing forever.
149
+ def ancestry(deep, base)
150
+ chain = [deep]
151
+ chain << File.dirname( chain.last ) until chain.last == base || File.dirname( chain.last ) == chain.last
152
+ return chain
153
+ end
154
+
155
+ # The probe expands its root, and on Windows that adds a drive letter. Stubbing the
156
+ # expansion specifies both spellings on every OS.
157
+ { 'a root without a drive' => '/build', 'a root with a drive letter' => 'D:/build' }.each do |kind, expanded|
158
+ context "below #{kind}" do
159
+ before(:each) do
160
+ allow(File).to receive(:expand_path).and_call_original
161
+ allow(File).to receive(:expand_path).with( root ).and_return( expanded )
162
+ end
163
+
164
+ it 'builds a path past 260 characters from segments well under 255' do
165
+ disk = WinLongPathsSpec::FakeDisk.new
166
+ probe( disk )
167
+
168
+ deep = directories_made( disk ).first
169
+
170
+ expect(deep).to start_with( "#{expanded}/" )
171
+ expect(deep.length).to be > described_class::LIMITS[:classic]
172
+ expect(deep.delete_prefix( "#{expanded}/" ).split( '/' ).map(&:length).max).to be < 255
173
+ end
174
+
175
+ [
176
+ ['every test passing', {}],
177
+ ['a listing failing', { children: Errno::ENAMETOOLONG.new }],
178
+ ['a write failing midway', { write: Errno::ENOENT.new }]
179
+ ].each do |description, raises|
180
+ it "removes its file and every directory it made, deepest first, after #{description}" do
181
+ disk = WinLongPathsSpec::FakeDisk.new( raises: raises )
182
+ probe( disk )
183
+
184
+ deep = directories_made( disk ).first
185
+ base = File.join( expanded, deep.delete_prefix( "#{expanded}/" ).split( '/' ).first )
186
+ removed = disk.calls.select { |name, _| name == :rmdir }.map(&:last)
187
+
188
+ expect(disk.calls.map(&:first)).to include( :delete )
189
+ expect(removed).to eq( ancestry( deep, base ) )
190
+ end
191
+ end
192
+ end
193
+ end
194
+
195
+ it 'names its directory uniquely, so two probes never share one' do
196
+ first = WinLongPathsSpec::FakeDisk.new
197
+ second = WinLongPathsSpec::FakeDisk.new
198
+ probe( first )
199
+ probe( second )
200
+
201
+ expect(directories_made( first )).not_to eq( directories_made( second ) )
202
+ end
203
+ end
204
+ end
@@ -0,0 +1,158 @@
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 'rbconfig'
10
+ require 'ceedling/constants'
11
+ require 'ceedling/filesystem/win_path_prober'
12
+
13
+ # Touches no filesystem and runs no process: the probe is stubbed, and ToolExecutor is a
14
+ # double. The real probe and the real `reg query` run in spec/integration/.
15
+ describe WinPathProber do
16
+ let(:tool) { { name: 'default_windows_registry_query', executable: 'reg.exe', arguments: [] } }
17
+
18
+ before(:each) do
19
+ @configurator = double( 'configurator', project_build_root: 'build', tools_windows_registry_query: tool )
20
+ @tool_executor = double( 'tool_executor' )
21
+ @loginator = double( 'loginator' )
22
+ @logged = []
23
+ allow(@loginator).to receive(:log) { |message, verbosity = nil, label = nil| @logged << [message, verbosity, label] }
24
+
25
+ @prober = described_class.new( { configurator: @configurator, tool_executor: @tool_executor, loginator: @loginator } )
26
+ end
27
+
28
+ def probe_returning(support, cause: nil)
29
+ result = cause ? { support: support, cause: cause, error: 'reg missing' } : { support: support }
30
+ allow(WinLongPaths).to receive(:probe).and_return( result )
31
+ end
32
+
33
+ # Messages a user sees at normal verbosity
34
+ def shown
35
+ return @logged.reject { |_message, verbosity, _label| verbosity == Verbosity::DEBUG }
36
+ end
37
+
38
+ describe '#long_paths?' do
39
+ it 'probes below the build root with its own registry query' do
40
+ probe_returning( :full )
41
+ @prober.long_paths?( :auto )
42
+
43
+ expect(WinLongPaths).to have_received(:probe).with( 'build', query: @prober.method( :registry_query ) )
44
+ end
45
+
46
+ context 'with :long_paths' do
47
+ it 'answers yes with full support, noting it at DEBUG' do
48
+ probe_returning( :full )
49
+
50
+ expect(@prober.long_paths?( :long_paths )).to be true
51
+ expect(shown).to be_empty
52
+ expect(@logged.map(&:first)).to include( match( /Windows long paths: full support \(Ruby #{Regexp.escape( RUBY_VERSION )}\)/ ) )
53
+ end
54
+
55
+ it 'answers yes when only files work, warning that directory listing fails' do
56
+ probe_returning( :files_only )
57
+
58
+ expect(@prober.long_paths?( :long_paths )).to be true
59
+ expect(shown.length).to eq( 1 )
60
+ message, verbosity = shown.first
61
+ expect(verbosity).to eq( Verbosity::COMPLAIN )
62
+ expect(message).to include( ':project ↳ :win_path_limit is :long_paths' )
63
+ expect(message).to include( "Ruby #{RUBY_VERSION} cannot list directories past 260 characters" )
64
+ expect(message).to match( /`clean`, and `clobber`/ )
65
+ end
66
+
67
+ it 'answers no when long paths are disabled, warning with the registry value' do
68
+ probe_returning( :none, cause: :registry_disabled )
69
+
70
+ expect(@prober.long_paths?( :long_paths )).to be false
71
+ expect(shown.map { |_m, verbosity, _l| verbosity }).to eq( [Verbosity::COMPLAIN] )
72
+ expect(shown.first.first).to include( 'LongPathsEnabled' )
73
+ end
74
+
75
+ it 'names this Ruby when it is not long-path-aware' do
76
+ probe_returning( :none, cause: :process_not_aware )
77
+ @prober.long_paths?( :long_paths )
78
+
79
+ expect(shown.first.first).to include( RbConfig.ruby ).and include( 'not long-path-aware' )
80
+ end
81
+
82
+ it 'names the registry error when the probe could not read it' do
83
+ probe_returning( :none, cause: :probe_failed )
84
+ @prober.long_paths?( :long_paths )
85
+
86
+ expect(shown.first.first).to include( 'reg missing' )
87
+ end
88
+ end
89
+
90
+ context 'with :auto' do
91
+ it 'answers yes with full support, saying nothing at normal verbosity' do
92
+ probe_returning( :full )
93
+
94
+ expect(@prober.long_paths?( :auto )).to be true
95
+ expect(shown).to be_empty
96
+ end
97
+
98
+ it 'answers no when only files work, with one notice' do
99
+ probe_returning( :files_only )
100
+
101
+ expect(@prober.long_paths?( :auto )).to be false
102
+ expect(shown.map { |_m, verbosity, label| [verbosity, label] }).to eq( [[Verbosity::NORMAL, LogLabels::NOTICE]] )
103
+ expect(shown.first.first).to include( "Ruby #{RUBY_VERSION} cannot list directories past 260 characters" )
104
+ end
105
+
106
+ it 'answers no when long paths are disabled, with one notice' do
107
+ probe_returning( :none, cause: :registry_disabled )
108
+
109
+ expect(@prober.long_paths?( :auto )).to be false
110
+ expect(shown.map { |_m, verbosity, label| [verbosity, label] }).to eq( [[Verbosity::NORMAL, LogLabels::NOTICE]] )
111
+ expect(shown.first.first).to include( 'LongPathsEnabled' )
112
+ end
113
+ end
114
+
115
+ it 'probes and logs once, then keeps its answer' do
116
+ probe_returning( :files_only )
117
+ @prober.long_paths?( :auto )
118
+ @prober.long_paths?( :auto )
119
+
120
+ expect(WinLongPaths).to have_received(:probe).once
121
+ expect(@logged.length).to eq( 1 )
122
+ end
123
+
124
+ it 'probes once, however many threads ask at once' do
125
+ probe_returning( :files_only )
126
+ threads = (0...8).map { Thread.new { @prober.long_paths?( :auto ) } }
127
+
128
+ expect(threads.map(&:value)).to all( be false )
129
+ expect(WinLongPaths).to have_received(:probe).once
130
+ expect(@logged.length).to eq( 1 )
131
+ end
132
+ end
133
+
134
+ describe '#registry_query' do
135
+ def expect_command(result, failed:)
136
+ command = { options: {} }
137
+ expect(@tool_executor).to receive(:build_command_line)
138
+ .with( tool, [], WinLongPaths::REGISTRY_KEY, WinLongPaths::REGISTRY_VALUE ).and_return( command )
139
+ expect(@tool_executor).to receive(:exec).with( command ) do |executed|
140
+ expect(executed[:options][:boom]).to be false
141
+ result
142
+ end
143
+ allow(@tool_executor).to receive(:failed?).with( result ).and_return( failed )
144
+ end
145
+
146
+ it 'runs the configured tool for the long paths value, without raising on a failed exit' do
147
+ expect_command( { output: 'LongPathsEnabled REG_DWORD 0x1' }, failed: false )
148
+
149
+ expect(@prober.registry_query).to eq( ['LongPathsEnabled REG_DWORD 0x1', true] )
150
+ end
151
+
152
+ it 'reports a failed exit as an unsuccessful query, with its output' do
153
+ expect_command( { output: 'ERROR: The system was unable to find the specified registry key or value.' }, failed: true )
154
+
155
+ expect(@prober.registry_query).to eq( ['ERROR: The system was unable to find the specified registry key or value.', false] )
156
+ end
157
+ end
158
+ end
@@ -0,0 +1,71 @@
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/working_dir'
12
+ require 'ceedling/filesystem/project_paths'
13
+
14
+ describe WorkingDir do
15
+ around(:each) do |example|
16
+ Dir.mktmpdir do |dir|
17
+ @ws = File.realpath( dir )
18
+ FileUtils.mkdir_p( File.join( @ws, 'app/dep' ) )
19
+ Dir.chdir( File.join( @ws, 'app' ) ) { example.run }
20
+ end
21
+ end
22
+
23
+ describe '.path' do
24
+ it 'reads the working directory once, however often it is asked' do
25
+ WorkingDir.path
26
+ expect(Dir).not_to receive(:pwd)
27
+
28
+ 3.times { expect(WorkingDir.path).to eq( File.join( @ws, 'app' ) ) }
29
+ end
30
+
31
+ it 'keeps answering for the directory Ceedling started in across a plain Dir.chdir' do
32
+ WorkingDir.path
33
+
34
+ answer = WorkingDirTracking.untracked { Dir.chdir( 'dep' ) { WorkingDir.path } }
35
+ expect(answer).to eq( File.join( @ws, 'app' ) )
36
+ end
37
+
38
+ # The spec suite's own Dir.chdir hook, which every in-process spec relies on
39
+ it 'answers for a directory a spec changes to' do
40
+ WorkingDir.path
41
+
42
+ expect(Dir.chdir( 'dep' ) { WorkingDir.path }).to eq( File.join( @ws, 'app/dep' ) )
43
+ expect(WorkingDir.path).to eq( File.join( @ws, 'app' ) )
44
+ end
45
+ end
46
+
47
+ # Untracked, so the spec suite's Dir.chdir hook can't do WorkingDir.chdir's work for it
48
+ describe '.chdir' do
49
+ around(:each) { |example| WorkingDirTracking.untracked { example.run } }
50
+
51
+ before(:each) do
52
+ WorkingDir.path
53
+ end
54
+
55
+ it 'answers for the directory it changes to, then for the one it left' do
56
+ inside = WorkingDir.chdir( 'dep' ) { [WorkingDir.path, ProjectPaths.canonical( File.join( @ws, 'app/dep/x' ) )] }
57
+
58
+ expect(inside).to eq( [File.join( @ws, 'app/dep' ), 'x'] )
59
+ expect(WorkingDir.path).to eq( File.join( @ws, 'app' ) )
60
+ expect(ProjectPaths.canonical( File.join( @ws, 'app/dep/x' ) )).to eq( 'dep/x' )
61
+ end
62
+
63
+ it 'answers for the directory it left after a block that raises' do
64
+ inside = nil
65
+ expect { WorkingDir.chdir( 'dep' ) { inside = WorkingDir.path; raise 'failed' } }.to raise_error( 'failed' )
66
+
67
+ expect(inside).to eq( File.join( @ws, 'app/dep' ) )
68
+ expect(WorkingDir.path).to eq( File.join( @ws, 'app' ) )
69
+ end
70
+ end
71
+ end