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,163 @@
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/c_extractor/c_extractor_types'
10
+
11
+ describe CExtractorTypes::CModule do
12
+ let(:definition) { CExtractorTypes::CFunctionDefinition.new( name: 'clamp' ) }
13
+ let(:declaration) { CExtractorTypes::CFunctionDeclaration.new( name: 'tick' ) }
14
+ let(:variable) { CExtractorTypes::CVariableDeclaration.new( name: 'count' ) }
15
+ let(:statement) { CExtractorTypes::CStatement.new( text: '#define LIMIT 9' ) }
16
+
17
+ def module_of(*items)
18
+ CExtractorTypes::CModule.new(
19
+ function_definitions: items.grep( CExtractorTypes::CFunctionDefinition ),
20
+ function_declarations: items.grep( CExtractorTypes::CFunctionDeclaration ),
21
+ variable_declarations: items.grep( CExtractorTypes::CVariableDeclaration ),
22
+ macro_definitions: items.grep( CExtractorTypes::CStatement ),
23
+ element_sequence: items
24
+ )
25
+ end
26
+
27
+ context "#stamp_origin!" do
28
+ it "stamps every function with the given origin" do
29
+ module_of( definition, declaration, variable ).stamp_origin!( :header )
30
+
31
+ expect( [definition, declaration].map( &:origin ) ).to all( eq( :header ) )
32
+ end
33
+
34
+ # element_sequence references the same objects, so the generator sees the stamp in order
35
+ it "is visible through element_sequence" do
36
+ c_module = module_of( declaration, definition ).stamp_origin!( :source )
37
+
38
+ expect( c_module.element_sequence.map( &:origin ) ).to eq( [:source, :source] )
39
+ end
40
+
41
+ it "returns the module so a merge can follow it" do
42
+ c_module = module_of( definition )
43
+
44
+ expect( c_module.stamp_origin!( :header ) ).to equal( c_module )
45
+ end
46
+
47
+ # A generated header places the source's later includes where the header's items end
48
+ it "stamps variables and statements too" do
49
+ module_of( variable, statement ).stamp_origin!( :header )
50
+
51
+ expect( [variable, statement].map( &:origin ) ).to all( eq( :header ) )
52
+ end
53
+
54
+ it "stamps a statement that only element_sequence holds" do
55
+ c_module = CExtractorTypes::CModule.new( type_definitions: [statement], element_sequence: [statement] )
56
+
57
+ c_module.stamp_origin!( :source )
58
+
59
+ expect( statement.origin ).to eq( :source )
60
+ end
61
+ end
62
+
63
+ context "#+" do
64
+ it "keeps the first module's items ahead of the second's" do
65
+ header = module_of( declaration ).stamp_origin!( :header )
66
+ source = module_of( definition ).stamp_origin!( :source )
67
+
68
+ expect( (header + source).element_sequence.map( &:origin ) ).to eq( [:header, :source] )
69
+ end
70
+ end
71
+
72
+ context "#remove!" do
73
+ it "takes items out of their lists and out of element_sequence" do
74
+ c_module = module_of( statement, definition, variable )
75
+
76
+ c_module.remove!( [statement, variable] )
77
+
78
+ expect( c_module.macro_definitions ).to be_empty
79
+ expect( c_module.variable_declarations ).to be_empty
80
+ expect( c_module.element_sequence ).to eq( [definition] )
81
+ end
82
+
83
+ # Two equal statements can sit in different places, and only the one given goes
84
+ it "matches items by identity, not by equality" do
85
+ twin = CExtractorTypes::CStatement.new( text: '#define LIMIT 9' )
86
+ c_module = module_of( statement, twin )
87
+
88
+ c_module.remove!( [twin] )
89
+
90
+ expect( c_module.element_sequence ).to contain_exactly( be( statement ) )
91
+ expect( c_module.macro_definitions ).to contain_exactly( be( statement ) )
92
+ end
93
+
94
+ it "removes every one of several equal items it is given" do
95
+ twin = CExtractorTypes::CStatement.new( text: '#define LIMIT 9' )
96
+ c_module = module_of( statement, twin )
97
+
98
+ c_module.remove!( [statement, twin] )
99
+
100
+ expect( c_module.element_sequence ).to be_empty
101
+ expect( c_module.macro_definitions ).to be_empty
102
+ end
103
+ end
104
+
105
+ context "#insert_before!" do
106
+ it "adds items to the lists their kinds name and places them just ahead of the anchor" do
107
+ type = CExtractorTypes::CStatement.new( text: 'struct last { int n; };', kind: :aggregate )
108
+ c_module = module_of( statement, definition )
109
+
110
+ c_module.insert_before!( definition, [type, variable] )
111
+
112
+ expect( c_module.aggregate_definitions ).to eq( [type] )
113
+ expect( c_module.variable_declarations ).to eq( [variable] )
114
+ expect( c_module.element_sequence ).to eq( [statement, type, variable, definition] )
115
+ end
116
+
117
+ it "places a statement in the list its kind names" do
118
+ typedef = CExtractorTypes::CStatement.new( text: 'typedef int count_t;', kind: :typedef )
119
+ c_module = module_of( definition )
120
+
121
+ c_module.insert_before!( definition, [typedef] )
122
+
123
+ expect( c_module.type_definitions ).to eq( [typedef] )
124
+ expect( c_module.aggregate_definitions ).to be_empty
125
+ end
126
+
127
+ it "refuses a statement whose kind names no list" do
128
+ loose = CExtractorTypes::CStatement.new( text: 'struct s;' )
129
+
130
+ expect { module_of.insert_before!( definition, [loose] ) }.to raise_error( ArgumentError, /CStatement of kind nil/ )
131
+ end
132
+
133
+ it "places items at the end when the anchor isn't in the module" do
134
+ c_module = module_of( statement )
135
+
136
+ c_module.insert_before!( definition, [variable] )
137
+
138
+ expect( c_module.element_sequence ).to eq( [statement, variable] )
139
+ end
140
+ end
141
+ end
142
+
143
+ describe 'C extractor item origins' do
144
+ it "defaults every origin to nil" do
145
+ expect( CExtractorTypes::CFunctionDefinition.new.origin ).to be_nil
146
+ expect( CExtractorTypes::CFunctionDeclaration.new.origin ).to be_nil
147
+ expect( CExtractorTypes::CVariableDeclaration.new.origin ).to be_nil
148
+ expect( CExtractorTypes::CStatement.new.origin ).to be_nil
149
+ end
150
+
151
+ it "tells a variable declared extern from one defined here" do
152
+ expect( CExtractorTypes::CVariableDeclaration.new( decorators: ['extern', 'const'] ).extern? ).to be( true )
153
+ expect( CExtractorTypes::CVariableDeclaration.new( decorators: ['static'] ).extern? ).to be( false )
154
+ end
155
+
156
+ it "gives a declaration a source filepath field" do
157
+ expect( CExtractorTypes::CFunctionDeclaration.new( source_filepath: 'src/a.c' ).source_filepath ).to eq( 'src/a.c' )
158
+ end
159
+
160
+ it "gives a definition an expanded body field" do
161
+ expect( CExtractorTypes::CFunctionDefinition.new( expanded_body: '{ }' ).expanded_body ).to eq( '{ }' )
162
+ end
163
+ end
@@ -0,0 +1,35 @@
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/c_identifier'
10
+
11
+ describe CIdentifier do
12
+ describe '.fold' do
13
+ it 'leaves a name that is already an identifier unchanged' do
14
+ expect( CIdentifier.fold( 'sensor_2' ) ).to eq( 'sensor_2' )
15
+ end
16
+
17
+ it 'replaces each character an identifier cannot hold with an underscore' do
18
+ expect( CIdentifier.fold( 'my-sensor.v2' ) ).to eq( 'my_sensor_v2' )
19
+ end
20
+
21
+ # One for one, so a test author can predict the folded name without knowing a rule
22
+ # for runs
23
+ it 'keeps a run of replaced characters as a run of underscores' do
24
+ expect( CIdentifier.fold( 'a--b' ) ).to eq( 'a__b' )
25
+ end
26
+
27
+ it 'folds a path separator like any other character' do
28
+ expect( CIdentifier.fold( 'drivers/uart\\config' ) ).to eq( 'drivers_uart_config' )
29
+ end
30
+
31
+ it 'folds a character outside ASCII to a single underscore' do
32
+ expect( CIdentifier.fold( 'café' ) ).to eq( 'caf_' )
33
+ end
34
+ end
35
+ end
@@ -0,0 +1,61 @@
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/config/build_root_policy'
12
+
13
+ # The path handling audit around GH #1370: clobber empties the build root's test and release
14
+ # trees, so a build root holding the project's own files is refused however it is spelled
15
+ describe BuildRootPolicy do
16
+ around(:each) do |example|
17
+ Dir.mktmpdir do |dir|
18
+ @ws = File.realpath( dir )
19
+ FileUtils.mkdir_p( File.join( @ws, 'proj', 'src' ) )
20
+ Dir.chdir( File.join( @ws, 'proj' ) ) { example.run }
21
+ end
22
+ end
23
+
24
+ it 'accepts a build root of its own' do
25
+ expect(BuildRootPolicy.problem( 'build' )).to be_nil
26
+ end
27
+
28
+ # macOS spells /tmp/proj as /private/tmp/proj, and a project reached through any symlink
29
+ # has two spellings
30
+ it 'refuses the project directory or a directory above it, but no directory below it, spelled through a symlink', unless: Gem.win_platform? do
31
+ File.symlink( File.join( @ws, 'proj' ), File.join( @ws, 'link' ) )
32
+
33
+ expect(BuildRootPolicy.problem( File.join( @ws, 'link' ) )).to eq( 'is the project directory or holds it' )
34
+ expect(BuildRootPolicy.problem( File.join( @ws, 'link', 'src' ) )).to be_nil
35
+ end
36
+
37
+ it 'names each :paths and :files entry that adds to a build from within the build root' do
38
+ config = { paths: { source: ['src/**', 'build/gen/**', '-:build/old'] }, files: { include: ['+:build/gen/table.h'] } }
39
+
40
+ expect(BuildRootPolicy.entries_within( 'build', config )).to eq( [[:paths, :source, 'build/gen/**'], [:files, :include, '+:build/gen/table.h']] )
41
+ expect(BuildRootPolicy.entries_within( 'out', config )).to be_empty
42
+ end
43
+
44
+ it 'names the directories Ceedling and its enabled plugins create' do
45
+ config = {
46
+ project_build_root: 'build', project_build_artifacts_root: 'build/artifacts', project_build_tests_root: 'build/test',
47
+ project_build_release_root: 'build/release', project_build_vendor_root: 'build/vendor',
48
+ project_build_dependencies_cache_path: 'build/cache', project_log_path: 'build/logs', cmock_mock_path: 'mocks',
49
+ plugins_enabled: ['gcov', 'report_tests_pretty_stdout']
50
+ }
51
+
52
+ expect(BuildRootPolicy.reserved( config )).to contain_exactly(
53
+ 'build/artifacts', 'build/test', 'build/release', 'build/vendor', 'build/cache', 'build/logs', 'mocks', 'build/gcov', 'build/report_tests_pretty_stdout'
54
+ )
55
+ end
56
+
57
+ # An empty path would name the project directory itself
58
+ it 'names no directory for a setting with no path' do
59
+ expect(BuildRootPolicy.reserved( { project_log_path: '', plugins_enabled: ['gcov'] } )).to be_empty
60
+ end
61
+ end
@@ -11,9 +11,33 @@ require 'ceedling/filename_extension'
11
11
  require 'ceedling/system_utils' # Object#deep_clone
12
12
  require 'ceedling/system_wrapper'
13
13
  require 'ceedling/constants'
14
+ require 'ceedling/exceptions'
15
+ require 'ceedling/filesystem/build_roots'
14
16
 
15
17
  describe ConfiguratorBuilder do
16
18
 
19
+ # GH #1387: the roots a long configured location can be shortened to a marker in build paths
20
+ describe '#collect_build_roots' do
21
+ let(:fpcu) { double('file_path_collection_utils') }
22
+ let(:builder) { ConfiguratorBuilder.new(file_path_collection_utils: fpcu, loginator: nil, file_wrapper: nil, system_wrapper: nil) }
23
+ let(:config) do
24
+ { paths_source: ['src/**'], paths_include: ['../sdk/include'], paths_test: ['test/**'], paths_support: ['test/support'] }
25
+ end
26
+
27
+ it 'takes roots from the source, include, test, and support paths, as mirror roots are taken' do
28
+ expect(fpcu).to receive(:collect_mirror_roots).with( ['src/**', '../sdk/include', 'test/**', 'test/support'] ).and_return( ['src', '../sdk/include', 'test', 'test/support'] )
29
+
30
+ expect( builder.collect_build_roots( config ) ).to eq( { collection_build_roots: ['src', '../sdk/include', 'test', 'test/support'] } )
31
+ end
32
+
33
+ it 'stops configuration when two roots would share a marker, naming both' do
34
+ allow(fpcu).to receive(:collect_mirror_roots).and_return( ['../a/x/include', '../b/y/include'] )
35
+ allow(BuildRoots).to receive(:collisions).and_return( [['../a/x/include', '../b/y/include']] )
36
+
37
+ expect { builder.collect_build_roots( config ) }.to raise_error( CeedlingException, %r{'\.\./a/x/include' and '\.\./b/y/include'} )
38
+ end
39
+ end
40
+
17
41
  describe '#populate_with_defaults' do
18
42
  let(:builder) { ConfiguratorBuilder.new(file_path_collection_utils: nil, loginator: nil, file_wrapper: nil, system_wrapper: nil) }
19
43
 
@@ -80,16 +104,14 @@ describe ConfiguratorBuilder do
80
104
  class RecordingFileList
81
105
  include Enumerable
82
106
 
83
- attr_reader :patterns, :excluded
107
+ attr_reader :patterns
84
108
 
85
109
  def initialize(found = [])
86
110
  @found = found
87
111
  @patterns = []
88
- @excluded = []
89
112
  end
90
113
 
91
114
  def include(*patterns) = @patterns.concat( patterns )
92
- def exclude(*files) = @excluded.concat( files )
93
115
  def resolve() = self
94
116
  def include?(file) = @found.include?( file )
95
117
  def each(&block) = @found.each( &block )
@@ -202,6 +224,17 @@ describe ConfiguratorBuilder do
202
224
  project_release_build_target: 'build/release/app.elf', project_release_build_map: 'build/release/app.map'
203
225
  )
204
226
  end
227
+
228
+ # The path handling audit around GH #1370: an absolute output names the release itself
229
+ it 'places a target named by an absolute or `~` path where it names, with its map beside it' do
230
+ output = File.expand_path( '/elsewhere/out/app.elf' )
231
+ expect(@builder.set_release_target( in_hash.merge( release_build_output: output ) )).to eq(
232
+ project_release_build_target: output, project_release_build_map: output.ext( '.map' )
233
+ )
234
+
235
+ expect(@builder.set_release_target( in_hash.merge( release_build_output: '~/out/app.elf' ) )[:project_release_build_target])
236
+ .to eq( File.join( Dir.home, 'out/app.elf' ) )
237
+ end
205
238
  end
206
239
 
207
240
  describe '#set_build_thread_counts' do
@@ -329,16 +362,38 @@ describe ConfiguratorBuilder do
329
362
  expect(revisions).to eq( ['+:a.s'] )
330
363
  end
331
364
 
332
- it 'collects sources, filtering out tests that overlapping paths also matched' do
333
- result, = collect( ['src/a.c', 'src/test_a.c'] ) { @builder.collect_source( in_hash, ['src/test_a.c'] ) }
365
+ it 'collects sources from source paths and revises them by :files ↳ :source' do
366
+ result, = collect { @builder.collect_source( in_hash, [] ) }
334
367
  file_list, revisions = result[:collection_all_source]
335
368
 
336
369
  expect(file_list.patterns).to eq( ['src/*.c'] )
337
- expect(file_list.excluded).to eq( ['src/test_a.c'] )
338
370
  expect(revisions).to eq( ['-:src/skip.c'] )
371
+ expect(@loginator).to_not have_received(:log)
372
+ end
373
+
374
+ # A test reaches the sources through overlapping paths, or a :files revision
375
+ it 'filters out of the revised sources any test, warning of the overlap' do
376
+ allow(@file_wrapper).to receive(:instantiate_file_list_literal) { |files| RecordingFileList.new( files ) }
377
+ result, = collect do
378
+ allow(@collection_utils).to receive(:revise_filelist).and_return( ['src/a.c', 'src/test_a.c'] )
379
+ @builder.collect_source( in_hash, ['src/test_a.c'] )
380
+ end
381
+
382
+ expect(result[:collection_all_source].to_a).to eq( ['src/a.c'] )
339
383
  expect(@loginator).to have_received(:log).with(/overlap/, Verbosity::COMPLAIN)
340
384
  end
341
385
 
386
+ it 'filters any test out of the release input, without warning again' do
387
+ allow(@file_wrapper).to receive(:instantiate_file_list_literal) { |files| RecordingFileList.new( files ) }
388
+ result, = collect do
389
+ allow(@collection_utils).to receive(:revise_filelist).and_return( ['src/a.c', 'test/test_a.c'] )
390
+ @builder.collect_release_build_input( in_hash.merge( collection_all_tests: ['test/test_a.c'] ) )
391
+ end
392
+
393
+ expect(result[:collection_release_build_input].to_a).to eq( ['src/a.c'] )
394
+ expect(@loginator).to_not have_received(:log)
395
+ end
396
+
342
397
  it 'collects headers from test, support, and include paths' do
343
398
  result, = collect { @builder.collect_headers( in_hash ) }
344
399
 
@@ -0,0 +1,292 @@
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 'config_yaml_helper'
10
+ require 'ceedling/config/configurator_paths_validator'
11
+ require 'ceedling/config/config_walkinator'
12
+ require 'ceedling/reportinator'
13
+
14
+ # Unit coverage for ConfiguratorPathsValidator through a doubled file layer. What these
15
+ # validations make of a real project tree is proven in
16
+ # spec/integration/configurator_validation_spec.rb.
17
+ describe ConfiguratorPathsValidator do
18
+ include ConfigYamlHelper
19
+
20
+ before(:each) do
21
+ @file_wrapper = double('file_wrapper')
22
+ @loginator = double('loginator', log: nil)
23
+
24
+ @validator = described_class.new(
25
+ {
26
+ config_walkinator: ConfigWalkinator.new,
27
+ file_wrapper: @file_wrapper,
28
+ loginator: @loginator,
29
+ reportinator: Reportinator.new
30
+ }
31
+ )
32
+ end
33
+
34
+ def existing(*paths)
35
+ allow(@file_wrapper).to receive(:exist?) { |path| paths.include?( path ) }
36
+ end
37
+
38
+ def directories(*paths)
39
+ allow(@file_wrapper).to receive(:directory?) { |path| paths.include?( path ) }
40
+ end
41
+
42
+ describe '#validate_path_list' do
43
+ let(:config) { config_from_yaml( ":paths:\n :test:\n - +:test/**\n - -:test/ignore\n - '**/generated'\n" ) }
44
+
45
+ it 'checks each path stripped of its aggregation decorator and glob' do
46
+ existing('test', 'test/ignore')
47
+ expect(@validator.validate_path_list( config, :paths, :test )).to be true
48
+ end
49
+
50
+ it 'skips a path that begins with a glob' do
51
+ existing('test', 'test/ignore')
52
+ @validator.validate_path_list( config, :paths, :test )
53
+ expect(@file_wrapper).to_not have_received(:exist?).with('')
54
+ end
55
+
56
+ it 'logs each path that does not exist' do
57
+ existing()
58
+ expect(@validator.validate_path_list( config, :paths, :test )).to be false
59
+ expect(@loginator).to have_received(:log).with("Config path :paths ↳ :test => 'test' does not exist in the filesystem.", Verbosity::ERRORS)
60
+ end
61
+
62
+ # The path handling audit around GH #1370: a `-:` entry may name nothing to leave out
63
+ it 'leaves a `-:` path to the entries validation' do
64
+ existing('test')
65
+ expect(@validator.validate_path_list( config, :paths, :test )).to be true
66
+ end
67
+
68
+ it 'fails a missing entry' do
69
+ expect(@validator.validate_path_list( config, :paths, :source )).to be false
70
+ end
71
+ end
72
+
73
+ # An entry naming no path, or wrapping its path in quotes, is rejected before any
74
+ # filesystem check. Both usually come from quoting only the path after a +: or -:
75
+ # decoration, so each rejection carries a hint about quoting.
76
+ shared_examples 'an entry that names no usable path' do |walk|
77
+ {
78
+ 'a bare subtractive decoration' => " - '-:'\n",
79
+ 'a bare additive decoration' => " - '+:'\n",
80
+ 'an empty string' => " - ''\n",
81
+ 'whitespace alone' => " - ' '\n",
82
+ 'a YAML null' => " -\n",
83
+ }.each_pair do |label, yaml|
84
+ it "rejects #{label} as naming no path, with a quoting hint" do
85
+ expect(validate( yaml )).to be false
86
+ expect(@loginator).to have_received(:log).with(/#{Regexp.escape(walk)} => '.*' names no path/, Verbosity::ERRORS)
87
+ expect(@loginator).to have_received(:log).with(/Quote the whole entry/, Verbosity::ERRORS)
88
+ end
89
+ end
90
+
91
+ # YAML reads an unquoted decoration with nothing after it as a one-key mapping
92
+ it 'rejects an entry YAML read as something other than a path, with a quoting hint' do
93
+ expect(validate( " - -:\n" )).to be false
94
+ expect(@loginator).to have_received(:log).with(/#{Regexp.escape(walk)} => '.*' is not a path \(YAML read it as a Hash\)/, Verbosity::ERRORS)
95
+ expect(@loginator).to have_received(:log).with(/Quote the whole entry/, Verbosity::ERRORS)
96
+ end
97
+
98
+ it 'rejects a path wrapped in quotes after its decoration, with a quoting hint' do
99
+ expect(validate( " - '-:\"src/a.c\"'\n" )).to be false
100
+ expect(@loginator).to have_received(:log).with(/#{Regexp.escape(walk)} => '-:"src\/a.c"' wraps its path in quotes/, Verbosity::ERRORS)
101
+ expect(@loginator).to have_received(:log).with(/Quote the whole entry/, Verbosity::ERRORS)
102
+ end
103
+ end
104
+
105
+ describe '#validate_paths_entries' do
106
+ def validate(yaml_list)
107
+ @validator.validate_paths_entries( config_from_yaml( ":paths:\n :source:\n#{yaml_list}" ), :source )
108
+ end
109
+
110
+ it 'accepts a glob that yields directories' do
111
+ existing; directories('src', 'src/a')
112
+ allow(@file_wrapper).to receive(:directory_listing).with('src/**/**').and_return(['src', 'src/a', 'src/a/x.c'])
113
+
114
+ expect(validate( " - src/**\n" )).to be true
115
+ end
116
+
117
+ it 'warns about and skips a path naming a file' do
118
+ existing('src/main.c'); directories
119
+
120
+ expect(validate( " - src/main.c\n" )).to be true
121
+ expect(@loginator).to have_received(:log).with(/'src\/main.c' is a filepath and will be ignored/, Verbosity::COMPLAIN)
122
+ end
123
+
124
+ it 'accepts a subdirectory glob of a directory that has no subdirectories' do
125
+ existing; directories
126
+ allow(@file_wrapper).to receive(:directory_listing).and_return([])
127
+
128
+ expect(validate( " - src/*\n" )).to be true
129
+ end
130
+
131
+ it 'logs a path that yields no directories' do
132
+ existing; directories
133
+ allow(@file_wrapper).to receive(:directory_listing).and_return([])
134
+
135
+ expect(validate( " - +:src/missing\n" )).to be false
136
+ expect(@loginator).to have_received(:log).with(/'src\/missing' yielded no directories/, Verbosity::ERRORS)
137
+ end
138
+
139
+ # The path handling audit around GH #1370: a `-:` entry names what a build leaves out
140
+ it 'accepts a `-:` path that names nothing, warning of it' do
141
+ existing; directories
142
+ allow(@file_wrapper).to receive(:directory_listing).and_return([])
143
+
144
+ expect(validate( " - -:src/missing\n" )).to be true
145
+ expect(@loginator).to have_received(:log).with(/'-:src\/missing' leaves out nothing; no directory matches it/, Verbosity::COMPLAIN)
146
+ end
147
+
148
+ it 'warns of a `-:` subdirectories glob whose directory does not exist' do
149
+ existing; directories
150
+ allow(@file_wrapper).to receive(:directory_listing).and_return([])
151
+
152
+ expect(validate( " - -:src/typo/**\n" )).to be true
153
+ expect(@loginator).to have_received(:log).with(/'-:src\/typo\/\*\*' leaves out nothing; no directory matches it/, Verbosity::COMPLAIN)
154
+ end
155
+
156
+ it 'warns of a `-:` glob that matches nothing below a directory that exists' do
157
+ existing( 'src' ); directories( 'src' )
158
+ allow(@file_wrapper).to receive(:directory_listing).and_return([])
159
+
160
+ expect(validate( " - -:src/nomatch*\n" )).to be true
161
+ expect(@loginator).to have_received(:log).with(/'-:src\/nomatch\*' leaves out nothing/, Verbosity::COMPLAIN)
162
+ end
163
+
164
+ it 'accepts a `-:` subdirectories glob of an existing directory without a word' do
165
+ existing( 'src/legacy' ); directories( 'src/legacy' )
166
+ allow(@file_wrapper).to receive(:directory_listing).and_return([])
167
+
168
+ expect(validate( " - -:src/legacy/**\n" )).to be true
169
+ expect(@loginator).to_not have_received(:log)
170
+ end
171
+
172
+ it 'accepts a `-:` path below the build root that names nothing, without a word' do
173
+ existing; directories
174
+ allow(@file_wrapper).to receive(:directory_listing).and_return([])
175
+
176
+ config = config_from_yaml( ":project:\n :build_root: build\n:paths:\n :source:\n - -:build/gen\n" )
177
+ expect(@validator.validate_paths_entries( config, :source )).to be true
178
+ expect(@loginator).to_not have_received(:log)
179
+ end
180
+
181
+ it 'escapes literal brackets before globbing' do
182
+ existing; directories('src/[legacy]')
183
+ allow(@file_wrapper).to receive(:directory_listing).with('src/\[legacy\]').and_return(['src/[legacy]'])
184
+
185
+ expect(validate( " - 'src/[legacy]'\n" )).to be true
186
+ end
187
+
188
+ it 'fails a missing entry' do
189
+ expect(@validator.validate_paths_entries( { paths: {} }, :source )).to be false
190
+ end
191
+
192
+ it_behaves_like 'an entry that names no usable path', ':paths ↳ :source'
193
+ end
194
+
195
+ describe '#validate_files_entries' do
196
+ def validate(yaml_list)
197
+ @validator.validate_files_entries( config_from_yaml( ":files:\n :source:\n#{yaml_list}" ), :source )
198
+ end
199
+
200
+ it 'accepts a glob that yields files' do
201
+ existing; directories
202
+ allow(@file_wrapper).to receive(:instantiate_file_list).with('src/*.c').and_return(['src/a.c'])
203
+
204
+ expect(validate( " - +:src/*.c\n" )).to be true
205
+ end
206
+
207
+ it 'warns about and skips a path naming a directory' do
208
+ existing('src'); directories('src')
209
+
210
+ expect(validate( " - src\n" )).to be true
211
+ expect(@loginator).to have_received(:log).with(/'src' is a directory path and will be ignored/, Verbosity::COMPLAIN)
212
+ end
213
+
214
+ it 'logs a glob that yields no files' do
215
+ existing; directories
216
+ allow(@file_wrapper).to receive(:instantiate_file_list).and_return([])
217
+
218
+ expect(validate( " - src/*.x\n" )).to be false
219
+ expect(@loginator).to have_received(:log).with(/'src\/\*.x' yielded no files/, Verbosity::ERRORS)
220
+ end
221
+
222
+ it 'accepts a `-:` glob that names no files, warning of it' do
223
+ existing; directories
224
+ allow(@file_wrapper).to receive(:instantiate_file_list).and_return([])
225
+
226
+ expect(validate( " - -:src/*.x\n" )).to be true
227
+ expect(@loginator).to have_received(:log).with(/'-:src\/\*.x' leaves out nothing; no file matches it/, Verbosity::COMPLAIN)
228
+ end
229
+
230
+ it 'escapes literal brackets before globbing' do
231
+ existing; directories
232
+ allow(@file_wrapper).to receive(:instantiate_file_list).with('src/\[legacy\]/*.c').and_return(['src/[legacy]/a.c'])
233
+
234
+ expect(validate( " - 'src/[legacy]/*.c'\n" )).to be true
235
+ end
236
+
237
+ it 'fails a missing entry' do
238
+ expect(@validator.validate_files_entries( { files: {} }, :source )).to be false
239
+ end
240
+
241
+ it_behaves_like 'an entry that names no usable path', ':files ↳ :source'
242
+ end
243
+
244
+ # The path handling audit around GH #1370: clobber empties the build root's test and
245
+ # release trees
246
+ describe '#validate_build_root' do
247
+ def validate(build_root, paths: " :source:\n - src/**\n", files: '')
248
+ yaml = ":project:\n :build_root: '#{build_root}'\n:paths:\n#{paths}"
249
+ yaml += ":files:\n#{files}" unless files.empty?
250
+ @validator.validate_build_root( config_from_yaml( yaml ) )
251
+ end
252
+
253
+ it 'accepts a build root of its own' do
254
+ expect(validate( 'build' )).to be true
255
+ end
256
+
257
+ {
258
+ '' => 'names no directory',
259
+ '.' => 'is the project directory or holds it',
260
+ '..' => 'is the project directory or holds it',
261
+ '/' => 'is the project directory or holds it'
262
+ }.each do |root, problem|
263
+ it "refuses a build root of '#{root}', which #{problem}" do
264
+ expect(validate( root )).to be false
265
+ expect(@loginator).to have_received(:log).with( ":project ↳ :build_root => '#{root}' #{problem}. Give the build its own directory, such as 'build'.", Verbosity::ERRORS )
266
+ end
267
+ end
268
+
269
+ it 'accepts a build root holding :paths and :files entries that add to a build, warning of each' do
270
+ expect(validate( 'gen', paths: " :source:\n - src/**\n - gen/**\n", files: " :source:\n - gen/out/a.c\n" )).to be true
271
+ expect(@loginator).to have_received(:log).with( ":paths ↳ :source => 'gen/**' lies in the build root 'gen'. Ceedling leaves out the directories it creates there.", Verbosity::COMPLAIN )
272
+ expect(@loginator).to have_received(:log).with( ":files ↳ :source => 'gen/out/a.c' lies in the build root 'gen'. Ceedling leaves out the directories it creates there.", Verbosity::COMPLAIN )
273
+ end
274
+
275
+ it 'accepts a build root holding only what `-:` entries name' do
276
+ expect(validate( 'build', paths: " :source:\n - src/**\n - -:build/gen\n" )).to be true
277
+ end
278
+ end
279
+
280
+ describe '#validate_filepath_simple' do
281
+ it 'accepts an existing path' do
282
+ existing('helper.h')
283
+ expect(@validator.validate_filepath_simple( 'helper.h', :cmock, :unity_helper_path )).to be true
284
+ end
285
+
286
+ it 'logs a missing path with the configuration walk it came from' do
287
+ existing
288
+ expect(@validator.validate_filepath_simple( 'helper.h', :cmock, :unity_helper_path )).to be false
289
+ expect(@loginator).to have_received(:log).with("Config path 'helper.h' associated with :cmock ↳ :unity_helper_path does not exist in the filesystem.", Verbosity::ERRORS)
290
+ end
291
+ end
292
+ end