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,129 @@
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
+ # Each toolchain family's wording, the gating and the prescription's shape. Real compilers'
9
+ # output is in spec/integration/build_step_doctor_spec.rb.
10
+
11
+ require 'spec_helper'
12
+ require 'ceedling/diagnostics/build_step_doctor'
13
+ require 'ceedling/diagnostics/partial_name_specialist'
14
+ require 'ceedling/test_invoker/test_invoker_types'
15
+
16
+ describe PartialNameSpecialist do
17
+ before(:each) do
18
+ @configurator = double( 'configurator', project_use_partials: true )
19
+ @file_wrapper = double( 'file_wrapper', directory_listing: [] )
20
+ @loginator = double( 'loginator' )
21
+ allow( @loginator ).to receive( :log )
22
+
23
+ nobody = double( 'specialist', diagnoses: [] )
24
+
25
+ @doctor = BuildStepDoctor.new(
26
+ loginator: @loginator, header_collision_specialist: nobody, missing_symbol_specialist: nobody, duplicate_symbol_specialist: nobody,
27
+ partial_name_specialist: described_class.new( configurator: @configurator, file_wrapper: @file_wrapper ),
28
+ include_depth_specialist: nobody
29
+ ).tap( &:setup )
30
+
31
+ @testable = TestInvokerTypes::Testable.new( name: 'test_ticker', filepath: 'test/test_ticker.c', paths: { partials: 'build/test/partials/test_ticker' } )
32
+ end
33
+
34
+ def prescriptions(output, source: 'test/test_ticker.c', step: :compile)
35
+ @doctor.diagnose( step: step, output: output, inputs: { testable: @testable, source: source } )
36
+ end
37
+
38
+ GCC_LOCAL = "test/test_ticker.c:9:5: error: 'partial_tick_cnt' undeclared (first use in this function)\n"
39
+ GCC_TYPE = "test/test_ticker.c:9:5: error: unknown type name 'ceedling_partial_ticker_ctx_t'\n"
40
+
41
+ {
42
+ 'GCC' => GCC_LOCAL,
43
+ 'Clang' => "test/test_ticker.c:9:5: error: use of undeclared identifier 'partial_tick_cnt'\n",
44
+ 'MSVC' => "test\\test_ticker.c(9): error C2065: 'partial_tick_cnt': undeclared identifier\n",
45
+ 'EDG (IAR)' => "Error[Pe020]: identifier \"partial_tick_cnt\" is undefined\n",
46
+ 'EDG (TI, Arm, Green Hills)' => "\"test/test_ticker.c\", line 9: error #20: identifier \"partial_tick_cnt\" is undefined\n",
47
+ 'SDCC' => "test/test_ticker.c:9: error 20: Undefined identifier 'partial_tick_cnt'\n",
48
+ 'other compilers, generically' => "test_ticker.c 9: partial_tick_cnt not declared\n"
49
+ }.each do |family, output|
50
+ it "recognizes #{family} reporting a promoted variable's name" do
51
+ expect( prescriptions( output ).size ).to eq( 1 )
52
+ end
53
+ end
54
+
55
+ {
56
+ 'GCC and Clang' => GCC_TYPE,
57
+ 'MSVC' => "test\\test_ticker.c(9): error C2061: syntax error: identifier 'ceedling_partial_ticker_ctx_t'\n",
58
+ 'EDG' => "Error[Pe020]: identifier \"ceedling_partial_ticker_ctx_t\" is undefined\n"
59
+ }.each do |family, output|
60
+ it "recognizes #{family} reporting a Partial type's name" do
61
+ expect( prescriptions( output ).first ).to include( 'PARTIAL_TYPE()' )
62
+ end
63
+ end
64
+
65
+ # A compiler reports the name the macro built, and often the macro on a note of its own
66
+ it 'recognizes the macro a note names when the name itself reads otherwise' do
67
+ output = "test/test_ticker.c:9:5: error: use of undeclared identifier 'partial_tick_cnt'\n" \
68
+ "test/test_ticker.c:3:30: note: expanded from macro 'PARTIAL_LOCAL_VAR'\n"
69
+
70
+ expect( prescriptions( output ).size ).to eq( 1 )
71
+ end
72
+
73
+ it 'prescribes nothing for a name no Partials macro builds' do
74
+ expect( prescriptions( "test/test_ticker.c:9:5: error: 'count' undeclared (first use in this function)\n" ) ).to eq( [] )
75
+ end
76
+
77
+ it 'prescribes nothing for a file other than the test file' do
78
+ expect( prescriptions( GCC_LOCAL, source: 'build/test/partials/test_ticker/ceedling_partial_ticker_impl.c' ) ).to eq( [] )
79
+ end
80
+
81
+ it 'prescribes nothing without Partials' do
82
+ allow( @configurator ).to receive( :project_use_partials ).and_return( false )
83
+
84
+ expect( prescriptions( GCC_LOCAL ) ).to eq( [] )
85
+ end
86
+
87
+ it 'covers only compiling' do
88
+ expect( prescriptions( GCC_LOCAL, step: :link ) ).to eq( [] )
89
+ end
90
+
91
+ it 'opens tentatively and explains the macro, the C rules and the corrections, left-justified' do
92
+ notice = prescriptions( GCC_LOCAL ).first
93
+
94
+ expect( notice ).to start_with( "The compiler output appears to report a name that PARTIAL_LOCAL_VAR() builds and nothing declares. If so," )
95
+ expect( notice ).to include(
96
+ "\n\nHOW THIS HAPPENS:\n• PARTIAL_LOCAL_VAR(function, variable) pastes its arguments into one name, partial_<function>_<variable>, as the test compiles.\n",
97
+ "\n\nOPTIONS:\n1. Check each argument against the function and its static variable in the module's source.\n"
98
+ )
99
+ expect( notice.lines.grep( /\A\s/ ) ).to eq( ["\n", "\n"] )
100
+ end
101
+
102
+ it 'explains how a type name is built from a module named with characters C cannot hold' do
103
+ expect( prescriptions( GCC_TYPE ).first ).to include( 'as in my_sensor for my-sensor' )
104
+ end
105
+
106
+ # Generation wrote the test's real names into its generated headers. The prescription lists
107
+ # them, whatever file holds them, and names no file.
108
+ context "with this test's Partials generated" do
109
+ before(:each) do
110
+ headers = ['build/test/partials/test_ticker/ceedling_partial_ticker_impl.h', 'build/test/partials/test_ticker/ceedling_partial_ticker_types.h']
111
+ allow( @file_wrapper ).to receive( :directory_listing ).with( 'build/test/partials/test_ticker/**/*.h' ).and_return( headers )
112
+ allow( @file_wrapper ).to receive( :read ).with( headers[0] ).and_return(
113
+ "#include \"ceedling_partial_ticker_types.h\"\nextern int partial_tick_count;\nextern ceedling_partial_ticker_tick_st_t partial_tick_st;\n"
114
+ )
115
+ allow( @file_wrapper ).to receive( :read ).with( headers[1] ).and_return( "typedef struct { int n; } ceedling_partial_ticker_tick_st_t;\n" )
116
+ end
117
+
118
+ it 'lists the promoted variables the test can name' do
119
+ notice = prescriptions( GCC_LOCAL ).first
120
+
121
+ expect( notice ).to include( "4. Promoted variables this test's Partials provide: partial_tick_count, partial_tick_st\n" )
122
+ expect( notice ).not_to include( '_impl.h', '_types.h' )
123
+ end
124
+
125
+ it 'lists the type names the test can name' do
126
+ expect( prescriptions( GCC_TYPE ).first ).to include( "4. Type names this test's Partials provide: ceedling_partial_ticker_tick_st_t\n" )
127
+ end
128
+ end
129
+ end
@@ -0,0 +1,86 @@
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/diagnostics/toolchain_output'
10
+
11
+ describe ToolchainOutput do
12
+ describe '.headers' do
13
+ {
14
+ 'GCC and Clang' => "src/a.h:12:3: error: redefinition of 'struct s'",
15
+ 'GCC include chains' => "In file included from src/a.h:2,\n from test.c:1:",
16
+ 'IAR' => "\"src/a.h\",12 Error[Pe101]: \"s\" has already been declared",
17
+ 'Arm armcc, TI, Green Hills' => "\"src/a.h\", line 12: error #101: \"s\" has already been declared",
18
+ 'MSVC' => "src/a.h(12): error C2011: 's': 'struct' type redefinition",
19
+ 'EDG declared-at notes' => "declaration is incompatible (declared at line 5 of \"src/a.h\")",
20
+ 'quoted in prose' => "previous definition of 'x' in 'src/a.h' was here",
21
+ 'backquoted' => "`src/a.h' line 3"
22
+ }.each do |family, output|
23
+ it "reads a header path in #{family} output" do
24
+ expect( described_class.headers( output ) ).to eq( ['src/a.h'] )
25
+ end
26
+ end
27
+
28
+ it 'reads C++ header extensions' do
29
+ expect( described_class.headers( 'a.hh:1:1 b.hpp:1:1 c.hxx(1)' ) ).to eq( ['a.hh', 'b.hpp', 'c.hxx'] )
30
+ end
31
+
32
+ it 'reads Windows paths, drive letter and backslashes included' do
33
+ expect( described_class.headers( "C:\\proj\\inc\\a.h(12): error C2011" ) ).to eq( ["C:\\proj\\inc\\a.h"] )
34
+ expect( described_class.headers( "\"C:\\proj\\inc\\a.h\",12 Error[Pe101]" ) ).to eq( ["C:\\proj\\inc\\a.h"] )
35
+ end
36
+
37
+ it 'reads paths with spaces only when quoted' do
38
+ expect( described_class.headers( '"my dir/a.h", line 3: error' ) ).to eq( ['my dir/a.h'] )
39
+ end
40
+
41
+ it 'lists each header once, in order of first mention' do
42
+ expect( described_class.headers( "b.h:1:1 a.h:2:2\nb.h:3:3" ) ).to eq( ['b.h', 'a.h'] )
43
+ end
44
+
45
+ it 'ignores a source file and a word that only starts like a header' do
46
+ expect( described_class.headers( 'test.c:1:1: in a.html and x.hint' ) ).to eq( [] )
47
+ end
48
+
49
+ it 'reads nothing from missing output' do
50
+ expect( described_class.headers( nil ) ).to eq( [] )
51
+ end
52
+
53
+ it 'reads a megabyte-long token in linear time' do
54
+ started = Process.clock_gettime( Process::CLOCK_MONOTONIC )
55
+ expect( described_class.headers( 'a' * 1_000_000 ) ).to eq( [] )
56
+ expect( Process.clock_gettime( Process::CLOCK_MONOTONIC ) - started ).to be < 1.0
57
+ end
58
+ end
59
+
60
+ describe '.objects' do
61
+ it 'reads object paths with the given extension in every location format' do
62
+ output = "/usr/bin/ld: build/out/gpio.o: in function `f':\n" \
63
+ "multiple definition of `f'; build/out/mock_gpio.o:(.text+0x0): first defined here\n" \
64
+ "\"build/out/x.o\" and build\\out\\y.o"
65
+
66
+ expect( described_class.objects( output, extension: '.o' ) ).to eq(
67
+ ['build/out/gpio.o', 'build/out/mock_gpio.o', 'build/out/x.o', "build\\out\\y.o"]
68
+ )
69
+ end
70
+
71
+ it 'reads an Arm armlink object list' do
72
+ output = 'Error: L6200E: Symbol f multiply defined (by mock_gpio.o and gpio.o).'
73
+
74
+ expect( described_class.objects( output, extension: '.o' ) ).to eq( ['mock_gpio.o', 'gpio.o'] )
75
+ end
76
+
77
+ it 'honors another object extension' do
78
+ expect( described_class.objects( 'LNK2005: f already defined in gpio.obj', extension: '.obj' ) ).to eq( ['gpio.obj'] )
79
+ expect( described_class.objects( 'gpio.o and gpio.obj', extension: '.obj' ) ).to eq( ['gpio.obj'] )
80
+ end
81
+
82
+ it 'reads nothing from missing output' do
83
+ expect( described_class.objects( nil, extension: '.o' ) ).to eq( [] )
84
+ end
85
+ end
86
+ end
@@ -21,10 +21,9 @@ describe 'String#clean_encoding' do
21
21
 
22
22
  # A "half" Unicode character: a multi-byte lead byte with missing or
23
23
  # insufficient continuation bytes, as if a real multi-byte character had
24
- # been clipped by a fixed-size chunk read (see
25
- # PreprocessinatorFileAssembler's 2048-byte guard-detection reads) or a
26
- # truncated copy/paste. clean_encoding's job is to never raise on this --
27
- # only ever to produce clean, valid ASCII/UTF-8 output.
24
+ # been clipped by a fixed-size chunk read or a truncated copy/paste.
25
+ # clean_encoding's job is to never raise on this -- only ever to produce
26
+ # clean, valid ASCII/UTF-8 output.
28
27
  describe 'incomplete multi-byte sequences ("half" Unicode characters)' do
29
28
  it 'replaces a lead byte missing its only continuation byte (1 of 2 bytes present)' do
30
29
  # 'Ü' (U+00DC) is 2 bytes in UTF-8: C3 9C. Only the lead byte survives.
@@ -51,6 +51,17 @@ describe FilenameExtension do
51
51
  end
52
52
  end
53
53
 
54
+ describe '#pattern' do
55
+ it 'matches any one of its extensions, escaped, as a group' do
56
+ pattern = FilenameExtension.new( ['.c', '.c++'] ).pattern
57
+
58
+ expect('a.c++').to match( /#{pattern}\z/ )
59
+ expect('a.c').to match( /#{pattern}\z/ )
60
+ expect('a.cxx').to_not match( /#{pattern}\z/ )
61
+ expect('a_c').to_not match( /#{pattern}\z/ )
62
+ end
63
+ end
64
+
54
65
  describe '#candidates' do
55
66
  it 'produces one candidate filename per configured extension' do
56
67
  extension = FilenameExtension.new(['.s', '.S'])
@@ -0,0 +1,131 @@
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 'digest/sha2'
10
+ require 'ceedling/filesystem/build_roots'
11
+ require 'ceedling/filesystem/build_subpath'
12
+
13
+ # GH #1387: a long configured root's location is replaced by a short marker in build paths.
14
+ # Roots are spelled relative to the working directory, so nothing here reads the disk.
15
+ describe BuildRoots do
16
+ let(:keil_include) { "#{'../' * 7}Keil_v5/ARM/PACK/ARM/CMSIS/5.9.0/CMSIS/RTOS2/Include" }
17
+
18
+ # The marker the module documents: the root's name, then 8 hex digits of its encoded spelling,
19
+ # case-folded on Windows as the module folds it by default
20
+ def expected_marker(root, name, windows: ProjectPaths::WINDOWS)
21
+ key = BuildSubpath.encode( root )
22
+ key = key.downcase if windows
23
+ return "_#{name}_#{Digest::SHA256.hexdigest( key )[0, 8].upcase}"
24
+ end
25
+
26
+ describe '.table' do
27
+ it 'shortens a root outside the project, whose climb and location no build step reads' do
28
+ table = described_class.table( [keil_include] )
29
+
30
+ expect(table.marker_for( keil_include )).to eq( expected_marker( keil_include, 'Include' ) )
31
+ expect(table.root_for( table.marker_for( keil_include ) )).to eq( keil_include )
32
+ end
33
+
34
+ it 'shortens a deep root inside the project' do
35
+ root = 'vendor/acme/sdk/v3/drivers/hal'
36
+ expect(described_class.table( [root] ).marker_for( root )).to eq( expected_marker( root, 'hal' ) )
37
+ end
38
+
39
+ it 'leaves a root alone when its marker would be no shorter than its own spelling' do
40
+ table = described_class.table( ['src', 'src2/a', '.', '..'] )
41
+
42
+ expect(table.entries).to be_empty
43
+ end
44
+
45
+ it 'shortens a root once its marker is shorter, however slightly' do
46
+ root = 'foo/bar/baz/abc' # 15 characters, and its marker 13
47
+
48
+ expect(described_class.table( [root] ).marker_for( root ).length).to eq( 13 )
49
+ end
50
+
51
+ it 'drops leading underscores from the name, so a marker begins with exactly one' do
52
+ private_root = 'vendor/acme/sdk/v3/drivers/_private'
53
+ blank_root = 'vendor/acme/sdk/v3/drivers/___'
54
+ table = described_class.table( [private_root, blank_root] )
55
+
56
+ expect(table.marker_for( private_root )).to eq( expected_marker( private_root, 'private' ) )
57
+ expect(table.marker_for( blank_root )).to eq( expected_marker( blank_root, 'root' ) )
58
+ end
59
+
60
+ # Test and release builds share one table, and only a test build escapes a directory named `_t_`
61
+ it "keys a root's hash on the spelling a release build gives it" do
62
+ root = 'lib/vendor/_t_/acme/sdk/hal'
63
+ key = ProjectPaths::WINDOWS ? root.downcase : root
64
+
65
+ expect(described_class.table( [root] ).marker_for( root )).to eq( "_hal_#{Digest::SHA256.hexdigest( key )[0, 8].upcase}" )
66
+ end
67
+
68
+ it 'gives a marker the shape decoding recognizes' do
69
+ expect(described_class.table( [keil_include] ).marker_for( keil_include )).to match( BuildRoots::MARKER )
70
+ end
71
+
72
+ it 'gives two same-named roots different markers' do
73
+ other = "#{'../' * 7}Keil_v5/ARM/PACK/ARM/CMSIS/5.9.0/CMSIS/Core/Include"
74
+ table = described_class.table( [keil_include, other] )
75
+
76
+ expect(table.marker_for( keil_include )).to_not eq( table.marker_for( other ) )
77
+ end
78
+
79
+ it 'gives a root the same marker every time' do
80
+ expect(described_class.table( [keil_include] ).marker_for( keil_include )).to eq( described_class.table( [keil_include] ).marker_for( keil_include ) )
81
+ end
82
+
83
+ # A whole tree shares one marker and keeps its own structure below it
84
+ it 'considers only the outermost of nested roots' do
85
+ outer = 'vendor/acme/sdk/v3'
86
+ inner = 'vendor/acme/sdk/v3/drivers/hal/include'
87
+ table = described_class.table( [inner, outer] )
88
+
89
+ expect(table.entries.map(&:first)).to eq( [outer] )
90
+ end
91
+
92
+ it 'shortens nothing below a shallow outermost root, even a deep root inside it' do
93
+ expect(described_class.table( ['src', 'src/a/b/c/d/e/f'] ).entries).to be_empty
94
+ end
95
+
96
+ it 'finds the shortened root holding a directory, if any' do
97
+ table = described_class.table( [keil_include, 'src'] )
98
+
99
+ expect(table.containing( ProjectPaths.absolute( "#{keil_include}/os" ) )).to eq( keil_include )
100
+ expect(table.containing( ProjectPaths.absolute( keil_include ) )).to eq( keil_include )
101
+ expect(table.containing( ProjectPaths.absolute( 'src/drv' ) )).to be_nil
102
+ end
103
+
104
+ # macOS and Windows file systems fold case, and Windows spellings of one place may differ in it
105
+ it 'keys its hash on a case-folded spelling on Windows, so two spellings of one root get one marker' do
106
+ lower = keil_include.downcase
107
+ upper = described_class.table( [keil_include], windows: true ).marker_for( keil_include )
108
+
109
+ expect(upper).to eq( expected_marker( keil_include, 'Include', windows: true ) )
110
+ expect(described_class.table( [lower], windows: true ).marker_for( lower ).delete_prefix( '_include' )).to eq( upper.delete_prefix( '_Include' ) )
111
+ end
112
+
113
+ it 'holds a digest that tells two tables apart' do
114
+ expect(described_class.table( [keil_include] ).digest).to_not eq( described_class.table( [] ).digest )
115
+ expect(described_class.table( [keil_include] ).digest).to eq( described_class.table( [keil_include] ).digest )
116
+ end
117
+ end
118
+
119
+ describe '.collisions' do
120
+ it 'reports two roots that would share a marker' do
121
+ other = "#{'../' * 7}Keil_v5/Other/Include"
122
+ allow(Digest::SHA256).to receive(:hexdigest).and_return( 'ab' * 32 )
123
+
124
+ expect(described_class.collisions( [keil_include, other] )).to eq( [[keil_include, other]] )
125
+ end
126
+
127
+ it 'reports nothing for roots with distinct markers' do
128
+ expect(described_class.collisions( [keil_include, 'vendor/acme/sdk/v3/drivers/hal'] )).to be_empty
129
+ end
130
+ end
131
+ end
@@ -0,0 +1,235 @@
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/build_subpath'
12
+ require 'ceedling/filesystem/build_roots'
13
+
14
+ # GH #1370 and the path handling audit around it: a build file placed by text could land
15
+ # outside the build directory
16
+ describe BuildSubpath do
17
+ WINDOWS_ONLY_BUILD = { if: 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
+ # Every other example reads INSTALLATION_ROOT itself, so only this one shows it names the
28
+ # running installation
29
+ it 'names the running installation, which holds what Ceedling ships' do
30
+ expect(File.file?( File.join( BuildSubpath::INSTALLATION_ROOT, 'lib', 'ceedling', 'filesystem', 'build_subpath.rb' ) )).to be( true )
31
+ BuildSubpath::INSTALLED_DIRS.each { |dir| expect(File.directory?( dir )).to be( true ), dir }
32
+ end
33
+
34
+ describe '.encode and .decode' do
35
+ {
36
+ 'a file in the project' => ['src/drv/uart', 'src/drv/uart'],
37
+ 'a sibling of the project' => ['../shared/src', '_up_/shared/src'],
38
+ 'the working directory' => ['.', '']
39
+ }.each do |label, (path, encoded)|
40
+ it "places #{label} by its path from the project root, and reads it back" do
41
+ expect(BuildSubpath.encode( path )).to eq( encoded )
42
+ expect(BuildSubpath.decode( encoded )).to eq( path == '.' ? '' : path )
43
+ end
44
+ end
45
+
46
+ # A project's own directory may carry a marker's name, which must read back as itself
47
+ it 'places a directory named like a marker apart from the marker, and reads it back' do
48
+ ['_up_/x', 'src/a/_up_', '_ceedling_/src', '_abs_/C/x', '_unc_/srv', 'src/__up_/x'].each do |path|
49
+ encoded = BuildSubpath.encode( path )
50
+
51
+ expect(BuildSubpath.decode( encoded )).to eq( path ), "#{path} => #{encoded}"
52
+ end
53
+ expect(BuildSubpath.encode( '_up_/x' )).to_not eq( BuildSubpath.encode( '../x' ) )
54
+ # macOS and Windows file systems fold case
55
+ expect(BuildSubpath.encode( '_UP_/x' ).downcase).to_not eq( BuildSubpath.encode( '../x' ).downcase )
56
+ expect(BuildSubpath.decode( BuildSubpath.encode( '_UP_/x' ) )).to eq( '_UP_/x' )
57
+ end
58
+
59
+ # A test's own build directories close its name with `_t_` (TestBuildLayout)
60
+ it 'places a directory named like the segment closing a test name apart from it, and reads it back' do
61
+ ['src/_t_', '_t_/x', 'src/__t_/x', 'src/_T_/x'].each do |path|
62
+ encoded = BuildSubpath.encode( path )
63
+
64
+ expect(ProjectPaths.segments( encoded ).map( &:downcase )).to_not include( BuildSubpath::OWN_SEGMENT ), "#{path} => #{encoded}"
65
+ expect(BuildSubpath.decode( encoded )).to eq( path ), "#{path} => #{encoded}"
66
+ end
67
+ expect(BuildSubpath.encode( 'src/_t_' )).to eq( 'src/__t_' )
68
+ end
69
+
70
+ it 'names a test whose path holds a directory named like `_t_` without that segment, and reads it back' do
71
+ name = BuildSubpath.encode( 'test/_t_/test_c' )
72
+
73
+ expect(name).to eq( 'test/__t_/test_c' )
74
+ expect(BuildSubpath.decode( name )).to eq( 'test/_t_/test_c' )
75
+ end
76
+
77
+ # A release build has no per-test directories, so it places such a directory as it always has
78
+ it 'keeps a directory named like `_t_` as it is in a release build, and reads it back' do
79
+ ['src/_t_', '_t_/x', 'src/__t_/x', 'src/_T_/x'].each do |path|
80
+ encoded = BuildSubpath.encode( path, release: true )
81
+
82
+ expect(encoded).to eq( path )
83
+ expect(BuildSubpath.decode( encoded, release: true )).to eq( path ), "#{path} => #{encoded}"
84
+ end
85
+ end
86
+
87
+ it 'still places a directory named like another marker apart from it in a release build' do
88
+ expect(BuildSubpath.encode( 'src/_up_/_t_', release: true )).to eq( 'src/__up_/_t_' )
89
+ expect(BuildSubpath.decode( 'src/__up_/_t_', release: true )).to eq( 'src/_up_/_t_' )
90
+ expect(BuildSubpath.encode( '../_t_/x', release: true )).to eq( '_up_/_t_/x' )
91
+ end
92
+
93
+ # Windows has no relative path from one drive to another
94
+ it 'places a file of the running Ceedling on another drive below `_ceedling_` too' do
95
+ file = File.join( BuildSubpath::INSTALLATION_ROOT, 'plugins/fff/src' )
96
+ allow(ProjectPaths).to receive(:relative).and_call_original
97
+ allow(ProjectPaths).to receive(:relative).with( file ).and_return( file )
98
+
99
+ expect(BuildSubpath.encode( file )).to eq( '_ceedling_/plugins/fff/src' )
100
+ end
101
+
102
+ it 'places an absolute path below the project as a relative one' do
103
+ expect(BuildSubpath.encode( File.join( @ws, 'app/src/x' ) )).to eq( 'src/x' )
104
+ end
105
+
106
+ it 'places a file of the running Ceedling outside the project below `_ceedling_`, and reads it back' do
107
+ file = File.join( BuildSubpath::INSTALLATION_ROOT, 'plugins/fff/src' )
108
+
109
+ expect(BuildSubpath.encode( file )).to eq( '_ceedling_/plugins/fff/src' )
110
+ expect(File.expand_path( BuildSubpath.decode( '_ceedling_/plugins/fff/src' ) )).to eq( file )
111
+ end
112
+
113
+ # A project may itself sit inside a Ceedling checkout, as the system specs' projects do.
114
+ # Only what Ceedling ships places below `_ceedling_`.
115
+ it 'places a directory beside a project inside the installation by its path from the project root' do
116
+ root = BuildSubpath::INSTALLATION_ROOT
117
+ allow(ProjectPaths).to receive(:working_dir).and_return( File.join( root, 'specout/proj/app' ) )
118
+
119
+ expect(BuildSubpath.encode( File.join( root, 'specout/proj/shared/src' ) )).to eq( '_up_/shared/src' )
120
+ expect(BuildSubpath.encode( File.join( root, 'plugins/fff/src' ) )).to eq( '_ceedling_/plugins/fff/src' )
121
+ end
122
+
123
+ it 'places a file of the running Ceedling inside the project by its path from the project root' do
124
+ Dir.chdir( BuildSubpath::INSTALLATION_ROOT ) do
125
+ expect(BuildSubpath.encode( 'plugins/fff/src' )).to eq( 'plugins/fff/src' )
126
+ end
127
+ end
128
+
129
+ it 'places a path on another drive below `_abs_`, and reads it back', **WINDOWS_ONLY_BUILD do
130
+ other = Dir.pwd.start_with?( 'C' ) ? 'D' : 'C'
131
+
132
+ expect(BuildSubpath.encode( "#{other}:/x/inc" )).to eq( "_abs_/#{other}/x/inc" )
133
+ expect(BuildSubpath.decode( "_abs_/#{other}/x/inc" )).to eq( "#{other}:/x/inc" )
134
+ end
135
+
136
+ it 'places a UNC path below `_unc_`, and reads it back', **WINDOWS_ONLY_BUILD do
137
+ expect(BuildSubpath.encode( '//server/share/inc' )).to eq( '_unc_/server/share/inc' )
138
+ expect(BuildSubpath.decode( '_unc_/server/share/inc' )).to eq( '//server/share/inc' )
139
+ end
140
+
141
+ it 'never places a file outside the build subpath it names' do
142
+ ['../../far/x', '/opt/x', '../shared', File.join( @ws, 'app/../../x' )].each do |path|
143
+ encoded = BuildSubpath.encode( path )
144
+
145
+ expect(encoded.split( '/' )).to_not include( '..' ), "#{path}: #{encoded}"
146
+ expect(encoded).to_not start_with( '/' ), "#{path}: #{encoded}"
147
+ end
148
+ end
149
+ end
150
+
151
+ # GH #1387: a long configured root's location gives way to its marker, and everything below
152
+ # the root keeps its path
153
+ describe 'with shortened roots' do
154
+ let(:external_root) { '../vendor/acme/sdk/v3/include' }
155
+ let(:deep_root) { 'lib/vendor/acme/hal' }
156
+ let(:table) { BuildRoots.table( [external_root, deep_root, 'src'] ) }
157
+ let(:external) { table.marker_for( external_root ) }
158
+ let(:deep) { table.marker_for( deep_root ) }
159
+
160
+ it 'places a root\'s own directory at its marker alone, and reads it back' do
161
+ expect(BuildSubpath.encode( external_root, roots: table )).to eq( external )
162
+ expect(BuildSubpath.decode( external, roots: table )).to eq( external_root )
163
+ end
164
+
165
+ it 'keeps the path below a root, after its marker, and reads it back' do
166
+ expect(BuildSubpath.encode( "#{external_root}/os/v2", roots: table )).to eq( "#{external}/os/v2" )
167
+ expect(BuildSubpath.decode( "#{external}/os/v2", roots: table )).to eq( "#{external_root}/os/v2" )
168
+ expect(BuildSubpath.encode( "#{deep_root}/src", roots: table )).to eq( "#{deep}/src" )
169
+ expect(BuildSubpath.decode( "#{deep}/src", roots: table )).to eq( "#{deep_root}/src" )
170
+ end
171
+
172
+ it 'keeps a directory named like `_t_` below a root as it is only in a release build' do
173
+ expect(BuildSubpath.encode( "#{external_root}/_t_/os", roots: table )).to eq( "#{external}/__t_/os" )
174
+ expect(BuildSubpath.encode( "#{external_root}/_t_/os", roots: table, release: true )).to eq( "#{external}/_t_/os" )
175
+ expect(BuildSubpath.decode( "#{external}/_t_/os", roots: table, release: true )).to eq( "#{external_root}/_t_/os" )
176
+ end
177
+
178
+ it 'places a file below a root that is not shortened as it always has' do
179
+ expect(BuildSubpath.encode( 'src/drv', roots: table )).to eq( 'src/drv' )
180
+ expect(BuildSubpath.encode( '../shared/src', roots: table )).to eq( '_up_/shared/src' )
181
+ end
182
+
183
+ it 'still places a file of the running Ceedling below `_ceedling_`' do
184
+ plugins = File.join( BuildSubpath::INSTALLATION_ROOT, 'plugins' )
185
+ file = File.join( plugins, 'fff/src' )
186
+
187
+ expect(BuildSubpath.encode( file, roots: BuildRoots.table( [plugins] ) )).to eq( '_ceedling_/plugins/fff/src' )
188
+ end
189
+
190
+ # A project's own directory may look like a marker, and must never read back as one
191
+ it 'places a directory shaped like a marker apart from any marker, and reads it back' do
192
+ ['_x_ABCDEF12/y', 'src/_v_20240101', '__x_abcdef12/z', "#{external_root}/_v_20240101/x"].each do |path|
193
+ encoded = BuildSubpath.encode( path, roots: table )
194
+
195
+ expect(encoded.split( '/' ).first).to_not match( BuildRoots::MARKER ), "#{path} => #{encoded}" unless path.start_with?( external_root )
196
+ expect(BuildSubpath.decode( encoded, roots: table )).to eq( path ), "#{path} => #{encoded}"
197
+ expect(BuildSubpath.decode( BuildSubpath.encode( path ) )).to eq( path ), path
198
+ end
199
+ end
200
+
201
+ it 'reads nothing back from a marker its table does not hold' do
202
+ expect(BuildSubpath.decode( '_include_ABCDEF12/os', roots: table )).to be_nil
203
+ expect(BuildSubpath.decode( '_include_ABCDEF12/os' )).to be_nil
204
+ end
205
+
206
+ it 'never places a file outside the build subpath it names' do
207
+ encoded = BuildSubpath.encode( "#{external_root}/os", roots: table )
208
+
209
+ expect(encoded.split( '/' )).to_not include( '..' )
210
+ expect(encoded).to_not start_with( '/' )
211
+ end
212
+ end
213
+
214
+ describe '.of_directory' do
215
+ it 'is the encoding of a directory, with the working directory as empty' do
216
+ expect(BuildSubpath.of_directory( 'src/drv' )).to eq( 'src/drv' )
217
+ expect(BuildSubpath.of_directory( '.' )).to eq( '' )
218
+ end
219
+
220
+ it 'remembers each table\'s encoding apart' do
221
+ root = '../vendor/acme/sdk/v3/include'
222
+ table = BuildRoots.table( [root] )
223
+
224
+ expect(BuildSubpath.of_directory( root, roots: table )).to eq( table.marker_for( root ) )
225
+ expect(BuildSubpath.of_directory( root )).to eq( '_up_/vendor/acme/sdk/v3/include' )
226
+ expect(BuildSubpath.of_directory( root, roots: BuildRoots.table( [] ) )).to eq( '_up_/vendor/acme/sdk/v3/include' )
227
+ end
228
+
229
+ it "remembers a release build's encoding apart from a test build's" do
230
+ expect(BuildSubpath.of_directory( 'src/_t_/drv' )).to eq( 'src/__t_/drv' )
231
+ expect(BuildSubpath.of_directory( 'src/_t_/drv', release: true )).to eq( 'src/_t_/drv' )
232
+ expect(BuildSubpath.of_directory( 'src/_t_/drv' )).to eq( 'src/__t_/drv' )
233
+ end
234
+ end
235
+ end
@@ -0,0 +1,30 @@
1
+ # =========================================================================
2
+ # Ceedling - Test-Centered Build System for C
3
+ # ThrowTheSwitch.org
4
+ # Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
5
+ # SPDX-License-Identifier: MIT
6
+ # =========================================================================
7
+
8
+ require 'spec_helper'
9
+ require 'ceedling/filesystem/destination_collision'
10
+
11
+ describe DestinationCollision do
12
+ describe '.find' do
13
+ it 'gives each output more than one input maps to, with those inputs' do
14
+ shared = DestinationCollision.find( ['a/x.c', 'b/x.c', 'c/y.c', 'a/x.c'] ) { |input| File.basename( input ) }
15
+
16
+ expect(shared).to eq( 'x.c' => ['a/x.c', 'b/x.c'] )
17
+ end
18
+
19
+ it 'gives nothing when every input has an output of its own' do
20
+ expect(DestinationCollision.find( ['a.c', 'b.c'] ) { |input| input }).to be_empty
21
+ end
22
+ end
23
+
24
+ describe '.raise_for' do
25
+ it 'names every input and the output they share, with a fix' do
26
+ expect { DestinationCollision.raise_for( 'out/x.o', ['a/x.c', 'b/x.c'], 'would build to the same file' ) }
27
+ .to raise_error( CeedlingException, '`a/x.c` and `b/x.c` would build to the same file `out/x.o`. Rename one, or move it to its own directory.' )
28
+ end
29
+ end
30
+ end