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
@@ -121,6 +121,35 @@ ceedling_system_tests do
121
121
 
122
122
  end
123
123
 
124
+ # =========================================================================
125
+ describe "A project where one of several tests misspells a TEST_SOURCE_FILE() entry" do
126
+ # =========================================================================
127
+
128
+ # A misspelled entry stops the build naming its own test, with test preprocessing on or off
129
+ before do
130
+ copy_duplicate_calc_sources
131
+ in_project do
132
+ copy_fixture("test_source_file_duplicate_basenames/test_calc_alpha.c", 'test')
133
+ copy_fixture("test_source_file_duplicate_basenames/test_calc_beta.c", 'test')
134
+ copy_fixture("test_source_file_duplicate_basenames/test_calc_typo.c", 'test')
135
+ end
136
+ end
137
+
138
+ [:none, :tests].each do |preprocessing|
139
+ it "names the test with the misspelled entry, with test preprocessing #{preprocessing}" do
140
+ in_project do
141
+ @c.merge_project_yml_for_test({ :project => { :use_test_preprocessor => preprocessing } })
142
+
143
+ output = @c.ceedling_build_exec("test:all")
144
+ expect(@c.last_exit_status).not_to eq(0)
145
+ expect(output).to match(%r{'alpha/clac\.c' specified with TEST_SOURCE_FILE\(\) in test/test_calc_typo cannot be found})
146
+ expect(output).not_to match(/Undefined symbols|undefined reference/)
147
+ end
148
+ end
149
+ end
150
+
151
+ end
152
+
124
153
  # =========================================================================
125
154
  describe "A project with two same-named, header-less sources, each identified by a disambiguating TEST_SOURCE_FILE() path" do
126
155
  # =========================================================================
@@ -165,8 +194,8 @@ ceedling_system_tests do
165
194
  # is untouched by the override), so its own NOTICE still fires -- but the
166
195
  # correctly-linked pass above already proves only beta/dup.c was ever compiled,
167
196
  # not both. A duplicate-symbol link error would have failed the build otherwise.
168
- expect(File.exist?('build/test/out/test_dup_override/beta/dup.o')).to be true
169
- expect(File.exist?('build/test/out/test_dup_override/alpha/dup.o')).to be false
197
+ expect(File.exist?('build/test/out/test/test_dup_override/_t_/src/beta/dup.o')).to be true
198
+ expect(File.exist?('build/test/out/test/test_dup_override/_t_/src/alpha/dup.o')).to be false
170
199
 
171
200
  # A second, distinct NOTICE -- from extract_sources's own override, not the
172
201
  # header-ambiguity NOTICE above -- names the winning TEST_SOURCE_FILE() entry
@@ -195,8 +224,8 @@ ceedling_system_tests do
195
224
  expect(output).to match(/TESTED:\s+1/)
196
225
  expect(output).to match(/PASSED:\s+1/)
197
226
 
198
- expect(File.exist?('build/test/out/test_dup_subtractive/alpha/dup.o')).to be false
199
- expect(File.exist?('build/test/out/test_dup_subtractive/gamma/dup_gamma.o')).to be true
227
+ expect(File.exist?('build/test/out/test/test_dup_subtractive/_t_/src/alpha/dup.o')).to be false
228
+ expect(File.exist?('build/test/out/test/test_dup_subtractive/_t_/src/gamma/dup_gamma.o')).to be true
200
229
 
201
230
  expect(output).to match(/TEST_SOURCE_FILE\(.*-:alpha[\/\\]dup\.c.*\)/)
202
231
  expect(output).to match(/removed/)
@@ -222,7 +251,7 @@ ceedling_system_tests do
222
251
  expect(output).to match(/TESTED:\s+1/)
223
252
  expect(output).to match(/PASSED:\s+1/)
224
253
 
225
- expect(File.exist?('build/test/out/test_dup_subtractive_noop/alpha/dup.o')).to be true
254
+ expect(File.exist?('build/test/out/test/test_dup_subtractive_noop/_t_/src/alpha/dup.o')).to be true
226
255
 
227
256
  expect(output).to_not match(/TEST_SOURCE_FILE\(.*removed/)
228
257
  end
@@ -230,6 +259,36 @@ ceedling_system_tests do
230
259
 
231
260
  end
232
261
 
262
+ # =========================================================================
263
+ describe "A hand-written source named with the mock prefix, beside a test that mocks its header" do
264
+ # =========================================================================
265
+
266
+ # test_a mocks spi.h, and test_b links a hand-written fake of the mock's name instead. A
267
+ # :support source would be linked into every test, test_a's too, so the fake is a source.
268
+ before do
269
+ in_project do
270
+ preamble = "#include \"unity.h\"\nvoid setUp(void) {}\nvoid tearDown(void) {}\n"
271
+ FileUtils.mkdir_p( 'src/fakes' )
272
+ File.write( 'src/spi.h', "#ifndef SPI_H\n#define SPI_H\nint spi_read(void);\n#endif\n" )
273
+ File.write( 'src/fakes/mock_spi.c', "int spi_read(void) { return 42; }\n" )
274
+ File.write( 'test/test_a.c', preamble + "#include \"mock_spi.h\"\n" \
275
+ "void test_a(void) { spi_read_ExpectAndReturn( 5 ); TEST_ASSERT_EQUAL_INT( 5, spi_read() ); }\n" )
276
+ File.write( 'test/test_b.c', preamble + "#include \"spi.h\"\nTEST_SOURCE_FILE(\"mock_spi.c\")\n" \
277
+ "void test_b(void) { TEST_ASSERT_EQUAL_INT( 42, spi_read() ); }\n" )
278
+ end
279
+ end
280
+
281
+ it "builds the hand-written source into the test that names it" do
282
+ in_project do
283
+ output = @c.ceedling_build_exec("test:all")
284
+ expect(@c.last_exit_status).to eq(0), output
285
+ expect(output).to match(/TESTED:\s+2/)
286
+ expect(output).to match(/PASSED:\s+2/)
287
+ end
288
+ end
289
+
290
+ end
291
+
233
292
  end
234
293
 
235
294
  end
@@ -213,11 +213,10 @@ describe Actionator do
213
213
  allow(@file_wrapper).to receive(:dirname) { |path| File.dirname( path ) }
214
214
  allow(@file_wrapper).to receive(:mkdir)
215
215
  allow(@file_wrapper).to receive(:write)
216
- allow(@file_wrapper).to receive(:directory?).and_return( false )
217
216
  end
218
217
 
219
218
  it 'copies files and omits junk files' do
220
- allow(@file_wrapper).to receive(:directory_listing).and_return([
219
+ allow(@file_wrapper).to receive(:tree_files).and_return([
221
220
  src_path('tree', 'keep.txt'),
222
221
  src_path('tree', 'thumbs.db'),
223
222
  src_path('tree', '.DS_Store'),
@@ -231,25 +230,25 @@ describe Actionator do
231
230
  end
232
231
 
233
232
  it 'rebases nested sources onto the destination' do
234
- allow(@file_wrapper).to receive(:directory_listing).and_return([ src_path('tree', 'a', 'b', 'c.txt') ])
233
+ allow(@file_wrapper).to receive(:tree_files).and_return([ src_path('tree', 'a', 'b', 'c.txt') ])
235
234
 
236
235
  expect(@file_wrapper).to receive(:write).with( dest_path('out', 'a', 'b', 'c.txt'), 'contents', 'wb' )
237
236
 
238
237
  @actionator.copy_directory( 'tree', 'out', force: true )
239
238
  end
240
239
 
241
- it 'skips directory entries in the listing' do
242
- allow(@file_wrapper).to receive(:directory_listing).and_return([ src_path('tree', 'sub') ])
243
- allow(@file_wrapper).to receive(:directory?).with( src_path('tree', 'sub') ).and_return( true )
244
-
245
- expect(@file_wrapper).to_not receive(:write).with( /sub/, anything, anything )
240
+ it 'lists the source without entries named with a leading dot' do
241
+ skip_rule = nil
242
+ allow(@file_wrapper).to receive(:tree_files) { |_dir, skip:| skip_rule = skip; [] }
246
243
 
247
244
  @actionator.copy_directory( 'tree', 'out', force: true )
245
+
246
+ expect( ['.rspec', '.hidden', 'keep.c'].reject { |name| skip_rule.call( name ) } ).to eq( ['keep.c'] )
248
247
  end
249
248
 
250
249
  # Thor reported the destination directory itself before any of its contents.
251
250
  it 'reports the destination directory before its files' do
252
- allow(@file_wrapper).to receive(:directory_listing).and_return([ src_path('tree', 'keep.txt') ])
251
+ allow(@file_wrapper).to receive(:tree_files).and_return([ src_path('tree', 'keep.txt') ])
253
252
 
254
253
  reported = []
255
254
  allow(@loginator).to receive(:console) { |message, _label| reported << message }
@@ -262,24 +261,22 @@ describe Actionator do
262
261
  ])
263
262
  end
264
263
 
265
- # Issue #104: a Ceedling install path can contain literal glob metacharacters.
266
- # FileWrapper#directory_listing does not escape, so Actionator has to.
267
- it 'escapes glob metacharacters in the source path' do
264
+ # Issue #104: a Ceedling install path can contain literal glob metacharacters. The
265
+ # tree is listed by walking it, so the path passes through as written.
266
+ it 'lists a source path holding glob metacharacters as written' do
268
267
  bracketed_root = File.expand_path( '/src/[legacy]' )
269
268
  @actionator.source_root = bracketed_root
270
- allow(@file_wrapper).to receive(:directory_listing).and_return([])
271
269
 
272
- escaped = bracketed_root.gsub( /[*?{}\[\]]/ ) { |char| '\\' + char }
273
- expect(@file_wrapper).to receive(:directory_listing).with( File.join( escaped, 'tree', '**', '*' ) )
270
+ expect(@file_wrapper).to receive(:tree_files).with( File.join( bracketed_root, 'tree' ), skip: Actionator::HIDDEN ).and_return([])
274
271
 
275
272
  @actionator.copy_directory( 'tree', 'out', force: true )
276
273
  end
277
274
 
278
275
  # cli_helper.rb passes component paths with a trailing separator.
279
276
  it 'tolerates a trailing separator on the source' do
280
- allow(@file_wrapper).to receive(:directory_listing).and_return([ src_path('tree', 'keep.txt') ])
277
+ allow(@file_wrapper).to receive(:tree_files).and_return([ src_path('tree', 'keep.txt') ])
281
278
 
282
- expect(@file_wrapper).to receive(:directory_listing).with( File.join( src_path('tree'), '**', '*' ) )
279
+ expect(@file_wrapper).to receive(:tree_files).with( src_path('tree'), skip: Actionator::HIDDEN )
283
280
  expect(@file_wrapper).to receive(:write).with( dest_path('out', 'keep.txt'), 'contents', 'wb' )
284
281
 
285
282
  @actionator.copy_directory( 'tree/', 'out', force: true )
@@ -44,6 +44,43 @@ describe CeedlingAppConfig do
44
44
  end
45
45
  end
46
46
 
47
+ describe ':launcher_root_path' do
48
+ it 'starts as the root of the installation this code runs from' do
49
+ expect(@app_cfg[:launcher_root_path]).to eq( @app_cfg[:ceedling_root_path] )
50
+ end
51
+
52
+ # GH #1365: `version` needs the launcher after which-Ceedling resolution moves the paths
53
+ it 'keeps the launcher root when #set_paths moves the application paths' do
54
+ launcher = @app_cfg[:ceedling_root_path]
55
+
56
+ @app_cfg.set_paths( '/tmp/some/root' )
57
+
58
+ expect(@app_cfg[:launcher_root_path]).to eq( launcher )
59
+ end
60
+ end
61
+
62
+ describe 'launch context' do
63
+ it 'keeps a frozen copy of the command line it was given' do
64
+ argv = ['test:all', '--verbosity=obnoxious']
65
+ app_cfg = described_class.new( argv: argv )
66
+ argv << 'mutated'
67
+
68
+ expect(app_cfg[:argv]).to eq( ['test:all', '--verbosity=obnoxious'] )
69
+ expect(app_cfg[:argv]).to be_frozen
70
+ end
71
+
72
+ it 'defaults to an empty command line and no hand-off' do
73
+ expect(@app_cfg[:argv]).to eq( [] )
74
+ expect(@app_cfg[:handoff]).to be_nil
75
+ end
76
+
77
+ it '#set_handoff keeps the markers a launcher handed this process' do
78
+ @app_cfg.set_handoff( {launcher: '/gem', target: '/app'} )
79
+
80
+ expect(@app_cfg[:handoff]).to eq( {launcher: '/gem', target: '/app'} )
81
+ end
82
+ end
83
+
47
84
  describe 'simple setters' do
48
85
  it '#set_project_config updates :project_config' do
49
86
  @app_cfg.set_project_config( {:project => {}} )
@@ -20,6 +20,7 @@ $: << File.join(here, '../../../lib')
20
20
  # real bin/ceedling bootstrap always loads ceedling/constants first, so this load
21
21
  # order only ever bites a spec harness requiring cli_handler.rb directly.
22
22
  require 'ceedling/constants'
23
+ require 'version' # The launcher's own version, which #version reports for this repository
23
24
  require 'cli_handler'
24
25
  require 'app_cfg'
25
26
  require 'path_validator'
@@ -40,16 +41,22 @@ require 'ceedling/rake_app/rake_task_registry'
40
41
  # exercising the real filtering/standardizing behavior it coordinates).
41
42
  describe CliHandler do
42
43
  before(:each) do
43
- @loginator = double('loginator').as_null_object
44
- @helper = double('cli_helper').as_null_object
44
+ @loginator = double('loginator').as_null_object
45
+ @helper = double('cli_helper').as_null_object
46
+ @composinator = double('composinator').as_null_object
47
+ @projectinator = double('projectinator').as_null_object
48
+ @path_validator = double('path_validator').as_null_object
49
+ @actionator = double('actionator').as_null_object
50
+ @launchinator = double('launchinator').as_null_object
45
51
 
46
52
  @cli_handler = described_class.new({
47
- :composinator => double('composinator').as_null_object,
48
- :projectinator => double('projectinator').as_null_object,
53
+ :composinator => @composinator,
54
+ :projectinator => @projectinator,
49
55
  :cli_helper => @helper,
50
- :path_validator => double('path_validator').as_null_object,
56
+ :path_validator => @path_validator,
51
57
  :rake_task_registry => double('rake_task_registry').as_null_object,
52
- :actionator => double('actionator').as_null_object,
58
+ :actionator => @actionator,
59
+ :launchinator => @launchinator,
53
60
  :loginator => @loginator,
54
61
  })
55
62
  end
@@ -77,6 +84,9 @@ describe CliHandler do
77
84
  describe '#version' do
78
85
  before(:each) do
79
86
  @app_cfg = CeedlingAppConfig.new
87
+ # No project file unless an example says otherwise
88
+ allow(@projectinator).to receive(:config_available?).and_return( false )
89
+ allow(@path_validator).to receive(:standardize_paths) { |*paths| paths }
80
90
  end
81
91
 
82
92
  def fake_application_version(install_path)
@@ -116,6 +126,271 @@ describe CliHandler do
116
126
 
117
127
  @cli_handler.version( {}, @app_cfg )
118
128
  end
129
+
130
+ # GH #1365: `version` reported the launcher for a project selecting another installation
131
+ context 'with a project' do
132
+ before(:each) do
133
+ allow(@helper).to receive(:manufacture_app_version).and_return( fake_application_version( '/elsewhere' ) )
134
+ allow(@helper).to receive(:process_mixin_filepaths) { |mixins| mixins }
135
+ end
136
+
137
+ it 'resolves which Ceedling from an explicit --project and its mixins, loading silently' do
138
+ config = {:project => {:which_ceedling => '/elsewhere'}}
139
+ expect(@composinator).to receive(:loadinate).with(
140
+ hash_including( filepath: 'other/project.yml', mixins: ['ci.yml'], silent: true )
141
+ ).and_return( ['other/project.yml', config] )
142
+ expect(@launchinator).to receive(:resolve).with( env: {}, app_cfg: @app_cfg, config: config )
143
+
144
+ @cli_handler.version( {}, @app_cfg, {:project => 'other/project.yml', :mixin => ['ci.yml']} )
145
+ end
146
+
147
+ it 'raises when an explicit --project cannot be loaded' do
148
+ allow(@composinator).to receive(:loadinate).and_raise( 'Could not find project filepath' )
149
+
150
+ expect {
151
+ @cli_handler.version( {}, @app_cfg, {:project => 'missing.yml', :mixin => []} )
152
+ }.to raise_error( /Could not find project filepath/ )
153
+ end
154
+
155
+ it 'raises when an explicit --mixin cannot be loaded with the default project file' do
156
+ allow(@composinator).to receive(:loadinate).and_raise( 'Command line failed validation' )
157
+
158
+ expect {
159
+ @cli_handler.version( {}, @app_cfg, {:project => nil, :mixin => ['missing.yml']} )
160
+ }.to raise_error( /Command line failed validation/ )
161
+ end
162
+
163
+ it 'reads the default project file when one is available' do
164
+ config = {:project => {:which_ceedling => 'vendor/ceedling'}}
165
+ allow(@projectinator).to receive(:config_available?).and_return( true )
166
+ allow(@composinator).to receive(:loadinate).and_return( ['project.yml', config] )
167
+ expect(@launchinator).to receive(:resolve).with( env: {}, app_cfg: @app_cfg, config: config )
168
+
169
+ @cli_handler.version( {}, @app_cfg )
170
+ end
171
+
172
+ it 'falls back to resolving without a project when the default project file cannot be loaded' do
173
+ allow(@projectinator).to receive(:config_available?).and_return( true )
174
+ allow(@composinator).to receive(:loadinate).and_raise( 'Project configuration file section :mixins failed validation' )
175
+ expect(@launchinator).to receive(:resolve).with( env: {}, app_cfg: @app_cfg, config: {} )
176
+
177
+ expect { @cli_handler.version( {}, @app_cfg ) }.to_not raise_error
178
+ end
179
+
180
+ it 'resolves without a project when no project file is available' do
181
+ expect(@composinator).to_not receive(:loadinate)
182
+ expect(@launchinator).to receive(:resolve).with( env: {}, app_cfg: @app_cfg, config: {} )
183
+
184
+ @cli_handler.version( {}, @app_cfg )
185
+ end
186
+
187
+ it 'never hands off, since it reports on both installations' do
188
+ @cli_handler.version( {}, @app_cfg )
189
+
190
+ expect(@launchinator).to_not have_received(:launch)
191
+ end
192
+
193
+ it 'reports the launcher from where it runs, even after resolution moves the application paths' do
194
+ allow(@launchinator).to receive(:resolve) { |app_cfg:, **| app_cfg.set_paths( '/elsewhere' ) }
195
+
196
+ expect(@loginator).to receive(:console) do |message, _label|
197
+ expect(message).to include( "Ceedling Launcher => #{Ceedling::Version::GEM}" )
198
+ expect(message).to include( "#{@app_cfg[:launcher_root_path]}/" )
199
+ end
200
+
201
+ @cli_handler.version( {}, @app_cfg )
202
+ end
203
+ end
204
+ end
205
+
206
+ # GH #1365: every command but `version` runs in the installation it selects. An exec
207
+ # never returns, so a raise stands in for it: nothing after the hand-off may run.
208
+ describe 'hand-off' do
209
+ HandedOff = Class.new( StandardError )
210
+
211
+ before(:each) do
212
+ @app_cfg = CeedlingAppConfig.new
213
+ @config = {:project => {:which_ceedling => 'vendor/ceedling'}}
214
+ allow(@path_validator).to receive(:standardize_paths) { |*paths| paths }
215
+ allow(@helper).to receive(:process_mixin_filepaths) { |mixins| mixins }
216
+ allow(@composinator).to receive(:loadinate).and_return( ['project.yml', @config] )
217
+ end
218
+
219
+ def expect_no_work_done
220
+ [:log_project_name, :console_project_name, :load_ceedling, :run_rake_tasks, :dump_yaml,
221
+ :project_exists?, :vendor_tools, :copy_docs, :lookup_example_projects, :help_footer].each do |work|
222
+ expect(@helper).to_not have_received( work )
223
+ end
224
+ expect(@actionator).to_not have_received(:make_directory)
225
+ expect(@actionator).to_not have_received(:remove_directory)
226
+ expect(@loginator).to_not have_received(:console)
227
+ end
228
+
229
+ {
230
+ 'build' => ->(h, cfg) { h.build( env: {}, app_cfg: cfg, options: {:project => nil, :mixin => []}, tasks: ['test:all'] ) },
231
+ 'check' => ->(h, cfg) { h.check( {}, cfg, {:project => nil, :mixin => []} ) },
232
+ 'environment' => ->(h, cfg) { h.environment( {}, cfg, {:project => nil, :mixin => []} ) },
233
+ 'dumpconfig' => ->(h, cfg) { h.dumpconfig( {}, cfg, {:project => nil, :mixin => [], :app => true}, 'out.yml', [] ) },
234
+ 'dumpconfig --no-app' => ->(h, cfg) { h.dumpconfig( {}, cfg, {:project => nil, :mixin => [], :app => false}, 'out.yml', [] ) },
235
+ '-T' => ->(h, cfg) { h.rake_help( env: {}, app_cfg: cfg ) },
236
+ }.each do |name, command|
237
+ it "#{name} hands off with the project's configuration before doing anything else" do
238
+ expect(@launchinator).to receive(:launch).with( env: {}, app_cfg: @app_cfg, config: @config ).and_raise( HandedOff )
239
+
240
+ expect { command.call( @cli_handler, @app_cfg ) }.to raise_error( HandedOff )
241
+ expect_no_work_done()
242
+ end
243
+ end
244
+
245
+ it 'help hands off with the project\'s configuration before printing any help' do
246
+ allow(@projectinator).to receive(:config_available?).and_return( true )
247
+ expect(@launchinator).to receive(:launch).with( env: {}, app_cfg: @app_cfg, config: @config ).and_raise( HandedOff )
248
+ printed = false
249
+
250
+ expect { @cli_handler.app_help( {}, @app_cfg, {:project => nil, :mixin => []}, nil ) { printed = true } }.to raise_error( HandedOff )
251
+ expect(printed).to be( false )
252
+ expect_no_work_done()
253
+ end
254
+
255
+ it 'help for one command hands off without the project when the project fails to load' do
256
+ allow(@projectinator).to receive(:config_available?).and_return( true )
257
+ allow(@composinator).to receive(:loadinate).and_raise( 'Project configuration file section :mixins failed validation' )
258
+ expect(@launchinator).to receive(:launch).with( env: {}, app_cfg: @app_cfg, config: {} ).and_raise( HandedOff )
259
+
260
+ expect { @cli_handler.app_help( {}, @app_cfg, {:project => nil, :mixin => []}, 'build' ) { } }.to raise_error( HandedOff )
261
+ end
262
+
263
+ it 'help for every command still fails when the project fails to load' do
264
+ allow(@projectinator).to receive(:config_available?).and_return( true )
265
+ allow(@composinator).to receive(:loadinate).and_raise( 'Project configuration file section :mixins failed validation' )
266
+
267
+ expect {
268
+ @cli_handler.app_help( {}, @app_cfg, {:project => nil, :mixin => []}, nil ) { }
269
+ }.to raise_error( /failed validation/ )
270
+ expect(@launchinator).to_not have_received(:launch)
271
+ end
272
+
273
+ it 'help without a project hands off by environment and vendor detection alone' do
274
+ allow(@projectinator).to receive(:config_available?).and_return( false )
275
+ expect(@launchinator).to receive(:launch).with( env: {}, app_cfg: @app_cfg, config: {} ).and_raise( HandedOff )
276
+
277
+ expect { @cli_handler.app_help( {}, @app_cfg, {:project => nil, :mixin => []}, 'build' ) { } }.to raise_error( HandedOff )
278
+ expect(@composinator).to_not have_received(:loadinate)
279
+ end
280
+
281
+ {
282
+ 'new' => ->(h, cfg) { h.new_project( {}, cfg, '1.2.2', {:local => true, :configs => true}, 'proj' ) },
283
+ 'examples' => ->(h, cfg) { h.list_examples( {}, cfg, {} ) },
284
+ 'example' => ->(h, cfg) { h.create_example( {}, cfg, {:local => true}, 'temp_sensor', nil ) },
285
+ }.each do |name, command|
286
+ it "#{name} hands off by environment and vendor detection before doing anything else" do
287
+ expect(@launchinator).to receive(:launch).with( env: {}, app_cfg: @app_cfg ).and_raise( HandedOff )
288
+
289
+ expect { command.call( @cli_handler, @app_cfg ) }.to raise_error( HandedOff )
290
+ expect_no_work_done()
291
+ end
292
+ end
293
+
294
+ # GH #1365: a `--local` copy carries no documentation bundle, so it would export only licenses
295
+ describe 'docs' do
296
+ before(:each) do
297
+ @launcher = Installation.new( @app_cfg[:launcher_root_path] )
298
+ @copy = Installation.new( 'vendor/ceedling' )
299
+ allow(@launchinator).to receive(:resolve) { |app_cfg:, **| app_cfg.set_paths( @copy.root ); @copy }
300
+ end
301
+
302
+ it 'hands off to the selected installation when it holds a documentation bundle' do
303
+ allow(@helper).to receive(:docs_bundle?).with( @copy.root ).and_return( true )
304
+ expect(@launchinator).to receive(:proceed).with( target: @copy, app_cfg: @app_cfg ).and_raise( HandedOff )
305
+
306
+ expect { @cli_handler.docs( {}, @app_cfg, 'out' ) }.to raise_error( HandedOff )
307
+ expect_no_work_done()
308
+ end
309
+
310
+ it 'exports the launcher\'s documentation, saying so, when the selected installation has none' do
311
+ allow(@helper).to receive(:docs_bundle?).with( @copy.root ).and_return( false )
312
+
313
+ expect(@loginator).to receive(:console).with(
314
+ "#{@copy.describe} holds no documentation bundle to export. " +
315
+ "Exporting the documentation of #{@launcher.describe( 'Ceedling launcher' )} instead.",
316
+ LogLabels::NOTICE
317
+ ).ordered
318
+ expect(@helper).to receive(:copy_docs).with( @launcher.root, 'out' ).ordered
319
+
320
+ @cli_handler.docs( {}, @app_cfg, 'out' )
321
+
322
+ expect(@launchinator).to_not have_received(:proceed)
323
+ expect(@app_cfg[:ceedling_root_path]).to eq( @launcher.root )
324
+ end
325
+
326
+ it 'exports the launcher\'s own documentation with no notice when it is selected' do
327
+ allow(@launchinator).to receive(:resolve).and_return( @launcher )
328
+
329
+ expect(@helper).to receive(:copy_docs).with( @launcher.root, 'out' )
330
+
331
+ @cli_handler.docs( {}, @app_cfg, 'out' )
332
+
333
+ expect(@loginator).to_not have_received(:console)
334
+ end
335
+ end
336
+
337
+ it 'upgrade hands off by environment alone, never to a vendor/ceedling it detects' do
338
+ source = Installation.new( 'elsewhere/ceedling' )
339
+ expect(@launchinator).to receive(:resolve).with( env: {}, app_cfg: @app_cfg, detect_vendor: false ).and_return( source )
340
+ expect(@launchinator).to receive(:proceed).with( target: source, app_cfg: @app_cfg ).and_raise( HandedOff )
341
+
342
+ expect { @cli_handler.upgrade_project( {}, @app_cfg, {:project => 'project.yml'}, 'proj' ) }.to raise_error( HandedOff )
343
+ expect_no_work_done()
344
+ end
345
+
346
+ # GH #1365: WHICH_CEEDLING naming the project's own copy would hand off to it, and a copy
347
+ # before 1.2.2 deletes itself as its own source
348
+ it 'upgrade refuses to re-vendor a project from its own vendored copy, before handing off to it' do
349
+ allow(@launchinator).to receive(:resolve) { |app_cfg:, **| app_cfg.set_paths( 'proj/vendor/ceedling' ); Installation.new( 'proj/vendor/ceedling' ) }
350
+
351
+ expect {
352
+ @cli_handler.upgrade_project( {'WHICH_CEEDLING' => 'proj/vendor/ceedling'}, @app_cfg, {:project => 'project.yml'}, 'proj' )
353
+ }.to raise_error( CeedlingException, /Cannot upgrade #{Regexp.escape( File.expand_path( 'proj/vendor/ceedling' ) )}\/ from itself/ )
354
+ expect(@launchinator).to_not have_received(:proceed)
355
+ expect_no_work_done()
356
+ end
357
+ end
358
+
359
+ # GH #1371: exported documentation was never refreshed, and refreshing it removed all of docs/
360
+ describe '#upgrade_project documentation' do
361
+ before(:each) do
362
+ @app_cfg = CeedlingAppConfig.new
363
+ @source = Installation.new( 'elsewhere/ceedling' )
364
+ @docs = File.join( 'proj', 'docs' )
365
+ allow(@path_validator).to receive(:standardize_paths) { |*paths| paths }
366
+ allow(@launchinator).to receive(:resolve) { |app_cfg:, **| app_cfg.set_paths( @source.root ); @source }
367
+ allow(@helper).to receive(:project_exists?).and_return( true )
368
+ end
369
+
370
+ def upgrade
371
+ @cli_handler.upgrade_project( {}, @app_cfg, {:project => 'project.yml'}, 'proj' )
372
+ end
373
+
374
+ it 'replaces what an export wrote, keeping the bundle when the source has none, then exports again' do
375
+ allow(@helper).to receive(:exported_docs?).with( @docs ).and_return( true )
376
+ allow(@helper).to receive(:docs_bundle?).with( @source.root ).and_return( false )
377
+
378
+ expect(@helper).to receive(:remove_exported_docs).with( @docs, keep_bundle: true ).ordered
379
+ expect(@helper).to receive(:copy_docs).with( @source.root, @docs ).ordered
380
+
381
+ upgrade()
382
+
383
+ expect(@actionator).to_not have_received(:remove_directory).with( @docs )
384
+ end
385
+
386
+ it 'leaves docs/ alone when it holds no export' do
387
+ allow(@helper).to receive(:exported_docs?).with( @docs ).and_return( false )
388
+
389
+ upgrade()
390
+
391
+ expect(@helper).to_not have_received(:remove_exported_docs)
392
+ expect(@helper).to_not have_received(:copy_docs)
393
+ end
119
394
  end
120
395
 
121
396
  describe '#list_examples' do
@@ -168,6 +443,7 @@ describe CliHandler do
168
443
  :path_validator => real_path_validator,
169
444
  :rake_task_registry => double('rake_task_registry').as_null_object,
170
445
  :actionator => double('actionator').as_null_object,
446
+ :launchinator => double('launchinator').as_null_object,
171
447
  :loginator => double('loginator').as_null_object,
172
448
  })
173
449
  end