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,259 @@
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/constants'
10
+ require 'ceedling/filename_extension'
11
+ require 'ceedling/includes/includes'
12
+ require 'ceedling/includes/include_pathinator'
13
+ require 'ceedling/filesystem/file_finder'
14
+ require 'ceedling/test_invoker/test_invoker_types'
15
+ require 'ceedling/test_invoker/test_derived_search_paths'
16
+
17
+ describe TestDerivedSearchPaths do
18
+ before(:each) do
19
+ @configurator = double( "Configurator", cmock_mock_prefix: 'mock_', cmock_mock_name_include_folder: true, project_build_root: 'build' )
20
+ allow(@configurator).to receive(:extension_header).and_return( FilenameExtension.new( '.h' ) )
21
+ @extractor = double( "TestContextExtractor" )
22
+ @file_wrapper = double( "FileWrapper" )
23
+ @loginator = double( "Loginator" )
24
+ @search_paths = double( "TestSearchPaths" )
25
+ allow(@loginator).to receive(:log)
26
+
27
+ # The project's headers on disk, listed a directory at a time
28
+ @tree = []
29
+ allow(@file_wrapper).to receive(:directory_listing) do |patterns|
30
+ dir = File.dirname( patterns.first ).delete_prefix( './' )
31
+ @tree.select { |header| File.dirname( header ) == dir }.sort
32
+ end
33
+ allow(@file_wrapper).to receive(:exist?) { |path| @tree.include?( path ) }
34
+
35
+ @collection = []
36
+ allow(@configurator).to receive(:collection_all_headers) { @collection }
37
+
38
+ pathinator = IncludePathinator.new( configurator: @configurator, test_context_extractor: @extractor, loginator: @loginator, file_wrapper: @file_wrapper )
39
+ pathinator.setup
40
+ finder = FileFinder.new( configurator: @configurator, file_finder_helper: nil, file_path_utils: nil, file_wrapper: @file_wrapper, yaml_wrapper: nil, test_build_layout: nil )
41
+
42
+ @derived = described_class.new(
43
+ configurator: @configurator, include_pathinator: pathinator, test_search_paths: @search_paths,
44
+ test_context_extractor: @extractor, file_finder: finder, file_wrapper: @file_wrapper, loginator: @loginator
45
+ )
46
+ @derived.setup
47
+
48
+ @testable = TestInvokerTypes::Testable.new( name: 'test_it', filepath: 'test/test_it.c' )
49
+ end
50
+
51
+ # `paths` are the test's search paths, `headers` the headers on disk, `files` the
52
+ # project's header collection, and `includes` the test's #includes. Gives the derived
53
+ # directories and keeps the refusals in @refusals.
54
+ def derive(paths:, includes:, headers: ['src/path/to/sensor.h'], files: headers)
55
+ @tree = headers
56
+ @collection = files
57
+ allow(@search_paths).to receive(:header_paths).with( @testable ).and_return( paths )
58
+ allow(@extractor).to receive(:lookup_all_header_includes_list).with( 'test/test_it.c' ).and_return( includes )
59
+
60
+ roots, @refusals = @derived.collect( @testable )
61
+ return roots
62
+ end
63
+
64
+ def mock(path)
65
+ return MockInclude.new( path )
66
+ end
67
+
68
+ describe "#collect" do
69
+ it "adds a bare mock's header's own directory" do
70
+ expect(derive( paths: ['.'], includes: [mock( 'mock_sensor.h' )] )).to eq( ['src/path/to'] )
71
+ end
72
+
73
+ it "says which search path it added, for which test, and why" do
74
+ expect(@loginator).to receive(:log).with(
75
+ "Added search path 'src/path/to' for test/test_it.c after every configured search path, so \"sensor.h\" reaches src/path/to/sensor.h.",
76
+ Verbosity::COMPLAIN, LogLabels::NOTICE
77
+ )
78
+
79
+ derive( paths: ['.'], includes: [mock( 'mock_sensor.h' )] )
80
+ end
81
+
82
+ it "names each directory once a build, however many tests need it" do
83
+ expect(@loginator).to receive(:log).with( /Added search path 'src\/path\/to'/, Verbosity::COMPLAIN, LogLabels::NOTICE ).twice
84
+
85
+ 2.times { derive( paths: ['.'], includes: [mock( 'mock_sensor.h' )] ) }
86
+ @derived.forget_notices
87
+ derive( paths: ['.'], includes: [mock( 'mock_sensor.h' )] )
88
+ end
89
+
90
+ it "adds nothing for a mock whose #include a search path already joins to its header" do
91
+ expect(@loginator).to_not receive(:log)
92
+
93
+ expect(derive( paths: ['.'], includes: [mock( 'src/path/to/mock_sensor.h' )] )).to eq( [] )
94
+ end
95
+
96
+ it "adds the directory a mock's folder is measured from" do
97
+ expect(derive( paths: ['inc'], includes: [mock( 'path/to/mock_sensor.h' )] )).to eq( ['src'] )
98
+ end
99
+
100
+ it "adds the project root for a mock's folder that spells the header's whole path" do
101
+ expect(derive( paths: ['inc'], includes: [mock( 'src/path/to/mock_sensor.h' )] )).to eq( ['.'] )
102
+ end
103
+
104
+ # The compiler can't join `src` with "src/path/to/sensor.h", though the header lies below it
105
+ it "adds the directory a mock's folder is measured from when that folder starts at a search path" do
106
+ expect(derive( paths: ['src'], includes: [mock( 'src/path/to/mock_sensor.h' )] )).to eq( ['.'] )
107
+ end
108
+
109
+ # The mock includes its header by the text the listed directory reaches it by. A directory
110
+ # added for its folder could hold a header named like a system one, such as string.h.
111
+ it "adds nothing for a mock through a folder where a search path lists the header's own directory" do
112
+ expect(derive( paths: ['src/path/to'], includes: [mock( 'path/to/mock_sensor.h' )] )).to eq( [] )
113
+ end
114
+
115
+ it "adds nothing for a plain #include through a folder where a search path lists the header's own directory" do
116
+ expect(derive( paths: ['src/path/to'], includes: [UserInclude.new( 'path/to/sensor.h' )] )).to eq( [] )
117
+ end
118
+
119
+ it "adds the header's own directory for a mock named without its folder" do
120
+ allow(@configurator).to receive(:cmock_mock_name_include_folder).and_return( false )
121
+
122
+ expect(derive( paths: ['inc'], includes: [mock( 'path/to/mock_sensor.h' )] )).to eq( ['src/path/to'] )
123
+ end
124
+
125
+ it "adds the directory a plain #include implies" do
126
+ expect(derive( paths: ['.'], includes: [UserInclude.new( 'sensor.h' )] )).to eq( ['src/path/to'] )
127
+ end
128
+
129
+ # A quoted #include looks in its own file's directory first
130
+ it "adds nothing for a plain #include the test file's own directory reaches" do
131
+ expect(derive( paths: ['.'], includes: [UserInclude.new( 'local.h' )], headers: ['test/local.h'], files: [] )).to eq( [] )
132
+ end
133
+
134
+ it "adds nothing for a header no collection holds" do
135
+ expect(derive( paths: ['.'], includes: [mock( 'mock_sensor.h' )], files: [] )).to eq( [] )
136
+ end
137
+
138
+ # The compiler rejects such an #include, and so does Ceedling
139
+ it "adds nothing for a header whose own directory is a search path" do
140
+ expect(derive( paths: ['src'], includes: [UserInclude.new( 'src/x.h' )], headers: ['src/x.h'] )).to eq( [] )
141
+ end
142
+
143
+ it "adds a directory once, which later #includes reach headers through" do
144
+ headers = ['src/path/to/sensor.h', 'src/path/to/sensor_types.h']
145
+
146
+ expect(derive( paths: ['.'], includes: [mock( 'mock_sensor.h' ), UserInclude.new( 'sensor_types.h' )], headers: headers )).to eq( ['src/path/to'] )
147
+ end
148
+
149
+ it "finds a header through a TEST_INCLUDE_PATH() directory before the collection" do
150
+ headers = ['tip/sensor.h', 'src/path/to/sensor.h']
151
+
152
+ expect(derive( paths: ['tip', '.'], includes: [mock( 'mock_sensor.h' )], headers: headers )).to eq( [] )
153
+ end
154
+
155
+ it "adds nothing for a header below the build root" do
156
+ expect(derive( paths: ['.'], includes: [UserInclude.new( 'gen.h' )], headers: ['build/gen/gen.h'] )).to eq( [] )
157
+ end
158
+
159
+ it "skips system, Unity, Ceedling and Partial #includes, Partial mocks, and paths that climb or are absolute" do
160
+ includes = [
161
+ SystemInclude.new( 'sensor.h' ), UserInclude.new( 'unity.h' ), UserInclude.new( 'ceedling.h' ),
162
+ UserInclude.new( 'ceedling_partial_sensor.h' ), mock( 'mock_ceedling_partial_sensor.h' ),
163
+ UserInclude.new( '../src/path/to/sensor.h' ).anchored( 'test' ), UserInclude.new( '/abs/sensor.h' )
164
+ ]
165
+ headers = ['src/path/to/sensor.h', 'src/path/to/unity.h', 'src/path/to/ceedling.h', 'src/path/to/ceedling_partial_sensor.h', '/abs/sensor.h']
166
+
167
+ expect(derive( paths: ['inc'], includes: includes, headers: headers )).to eq( [] )
168
+ end
169
+
170
+ it "refuses nothing for a bare name's header inside the working directory" do
171
+ expect(derive( paths: ['.'], includes: [mock( 'mock_sensor.h' )] )).to eq( ['src/path/to'] )
172
+ expect(@refusals).to eq( {} )
173
+ end
174
+
175
+ context "for a header outside the working directory" do
176
+ let(:socket) { '/usr/include/x86_64-linux-gnu/sys/socket.h' }
177
+ # A refusal spells the search path absolutely, so Windows gives it the current drive
178
+ let(:socket_dir) { ProjectPaths.absolute( File.dirname( socket ) ) }
179
+
180
+ it "adds the directory a mock's folder is measured from" do
181
+ expect(derive( paths: ['inc'], includes: [mock( 'sys/mock_socket.h' )], headers: [socket] )).to eq( ['/usr/include/x86_64-linux-gnu'] )
182
+ end
183
+
184
+ it "explains a mock named without its folder by the option it needs, logging nothing" do
185
+ allow(@configurator).to receive(:cmock_mock_name_include_folder).and_return( false )
186
+ expect(@loginator).to_not receive(:log)
187
+
188
+ expect(derive( paths: ['inc'], includes: [mock( 'sys/mock_socket.h' )], headers: [socket] )).to eq( [] )
189
+ expect(@refusals).to eq(
190
+ 'sys/socket.h' =>
191
+ "`#include \"sys/mock_socket.h\"` in test/test_it.c needs search path '#{socket_dir}', " \
192
+ "since its mock writes `#include \"socket.h\"` with :cmock ↳ :mock_name_include_folder disabled. " \
193
+ "Because this search path is outside the working directory and could cause shadowing of other headers, " \
194
+ "Ceedling won't add the full search path. Instead, enable :cmock ↳ :mock_name_include_folder and reference " \
195
+ "the parent folder, as in `#include \"sys/mock_socket.h\"`."
196
+ )
197
+ end
198
+
199
+ it "adds nothing for a bare name, explaining the #include that would reach it and logging nothing" do
200
+ expect(@loginator).to_not receive(:log)
201
+
202
+ expect(derive( paths: ['inc'], includes: [mock( 'mock_socket.h' )], headers: [socket] )).to eq( [] )
203
+ expect(@refusals).to eq(
204
+ 'socket.h' =>
205
+ "`#include \"mock_socket.h\"` in test/test_it.c needs search path '#{socket_dir}'. " \
206
+ "Because this search path is outside the working directory and could cause shadowing of other headers, " \
207
+ "Ceedling won't add the full search path. Instead, reference the parent folder, as in `#include \"sys/mock_socket.h\"`."
208
+ )
209
+ end
210
+
211
+ it "explains a plain #include by its own path" do
212
+ derive( paths: ['inc'], includes: [UserInclude.new( 'socket.h' )], headers: [socket] )
213
+
214
+ expect(@refusals.keys).to eq( ['socket.h'] )
215
+ expect(@refusals['socket.h']).to start_with( "`#include \"socket.h\"` in test/test_it.c needs search path" )
216
+ expect(@refusals['socket.h']).to end_with( "as in `#include \"sys/socket.h\"`." )
217
+ end
218
+
219
+ # The lookup tries each header extension in turn and names the last when none is found
220
+ it "files a plain #include's refusal under each header extension its lookup tries" do
221
+ allow(@configurator).to receive(:extension_header).and_return( FilenameExtension.new( ['.h', '.hpp'] ) )
222
+ derive( paths: ['inc'], includes: [UserInclude.new( 'socket.h' )], headers: [socket] )
223
+
224
+ expect(@refusals.keys).to eq( ['socket.h', 'socket.hpp'] )
225
+ expect(@refusals.values.uniq.length).to eq( 1 )
226
+ end
227
+
228
+ it "files a mock's refusal under its query alone, which its lookup asks for" do
229
+ allow(@configurator).to receive(:extension_header).and_return( FilenameExtension.new( ['.h', '.hpp'] ) )
230
+ derive( paths: ['inc'], includes: [mock( 'mock_socket.h' )], headers: [socket] )
231
+
232
+ expect(@refusals.keys).to eq( ['socket.h'] )
233
+ end
234
+
235
+ # Every stage looks a test's mocks up before its other #includes
236
+ [[:plain_first, ->(m, p) { [p, m] }], [:mock_first, ->(m, p) { [m, p] }]].each do |order, arrange|
237
+ it "explains a header a mock and a plain #include share by the mock's refusal (#{order})" do
238
+ derive( paths: ['inc'], includes: arrange.call( mock( 'mock_socket.h' ), UserInclude.new( 'socket.h' ) ), headers: [socket] )
239
+
240
+ expect(@refusals['socket.h']).to start_with( "`#include \"mock_socket.h\"` in test/test_it.c" )
241
+ end
242
+ end
243
+
244
+ it "files a refusal under the spelling the header search looks it up by" do
245
+ allow(@configurator).to receive(:cmock_mock_name_include_folder).and_return( false )
246
+ derive( paths: ['inc'], includes: [mock( './sys//mock_socket.h' )], headers: [socket] )
247
+
248
+ expect(@refusals.keys).to eq( ['sys/socket.h'] )
249
+ end
250
+
251
+ it "spells a header's search path absolutely, whatever spelling the collection holds" do
252
+ relative = ProjectPaths.relative( socket )
253
+ derive( paths: ['inc'], includes: [mock( 'mock_socket.h' )], headers: [relative] )
254
+
255
+ expect(@refusals['socket.h']).to include( "needs search path '#{socket_dir}'." )
256
+ end
257
+ end
258
+ end
259
+ end
@@ -156,10 +156,26 @@ describe TestFilePreprocessinator do
156
156
  it "validates a test's TEST_SOURCE_FILE() entries through the resolver, regardless of staleness" do
157
157
  allow(@dependinator).to receive(:stale?).and_return( false )
158
158
 
159
- expect(@test_source_file_directive_resolver).to receive(:validate!).with( test: 'a_test', filepath: 'test/TestFoo.c' )
159
+ expect(@test_source_file_directive_resolver).to receive(:validate!).with( test: 'a_test', test_filepath: 'test/TestFoo.c', context: :test )
160
160
 
161
161
  @preprocessinator_stage.preprocess( @state )
162
162
  end
163
+
164
+ # Each test checks its own entries, not every test's
165
+ it "validates each test's entries once, under that test's own name" do
166
+ allow(@dependinator).to receive(:stale?).and_return( false )
167
+ others = %w[b_test c_test].to_h do |name|
168
+ [name.to_sym, @testable.dup.tap { |testable| testable.name = name; testable.filepath = "test/#{name}.c" }]
169
+ end
170
+ @state.testables.merge!( others )
171
+
172
+ checked = []
173
+ allow(@test_source_file_directive_resolver).to receive(:validate!) { |test:, test_filepath:, context:| checked << [test, test_filepath, context] }
174
+
175
+ @preprocessinator_stage.preprocess( @state )
176
+
177
+ expect(checked).to contain_exactly( ['a_test', 'test/TestFoo.c', :test], ['b_test', 'test/b_test.c', :test], ['c_test', 'test/c_test.c', :test] )
178
+ end
163
179
  end
164
180
 
165
181
  # The full expansion reads every header the test reaches, so a change to one of them
@@ -12,12 +12,15 @@ require 'ceedling/test_invoker/test_includes_preprocessinator'
12
12
  require 'ceedling/test_invoker/test_includes_reconcilinator'
13
13
  require 'ceedling/test_invoker/test_invoker_types'
14
14
  require 'ceedling/test_invoker/test_search_paths'
15
+ require 'ceedling/includes/header_search'
15
16
  require 'ceedling/test_invoker/mock_locator'
16
17
  require 'ceedling/test_invoker/standin_headerinator'
17
18
 
18
19
  describe TestIncludesExtractinator do
19
20
  before(:each) do
20
21
  @configurator = double( "Configurator" )
22
+ # Ceedling always defaults it, and the mock locator reads it
23
+ allow(@configurator).to receive(:cmock_mock_name_include_folder).and_return( true )
21
24
  @loginator = double( "Loginator" )
22
25
  @reportinator = double( "Reportinator" )
23
26
  @batchinator = double( "Batchinator" )
@@ -85,9 +88,10 @@ describe TestIncludesExtractinator do
85
88
  allow(@test_context_extractor).to receive(:lookup_source_includes_list).and_return( [] )
86
89
  allow(@test_context_extractor).to receive(:ingest_includes)
87
90
 
88
- # Harmless default -- individual examples needing a specific ordered header
89
- # collection stub this again with a narrower `.with(...)` match.
90
- allow(@include_pathinator).to receive(:ordered_header_files).and_return( [] )
91
+ # Harmless default -- individual examples needing a specific header search stub this
92
+ # again with a narrower `.with(...)` match.
93
+ @header_search = HeaderSearch.new( [], ->(_dir) { [] } )
94
+ allow(@include_pathinator).to receive(:header_search).and_return( @header_search )
91
95
 
92
96
  # Search path defaults, so tests of a reconciling first pass, which rebuilds a test's
93
97
  # search paths, need not know every source those paths draw on
@@ -99,15 +103,15 @@ describe TestIncludesExtractinator do
99
103
  allow(@configurator).to receive(:collection_paths_vendor).and_return( [] )
100
104
  allow(@configurator).to receive(:collection_paths_test_toolchain_include).and_return( [] )
101
105
 
102
- @mock_locator = MockLocator.new(
103
- configurator: @configurator, include_pathinator: @include_pathinator, file_finder: @file_finder, file_path_utils: @file_path_utils
104
- )
105
-
106
106
  # The stage's passes and collaborators are real, over the same doubles, so these
107
107
  # examples cover the whole stage and read as paths and files
108
108
  search_paths = TestSearchPaths.new(
109
109
  configurator: @configurator, include_pathinator: @include_pathinator, test_context_extractor: @test_context_extractor
110
110
  )
111
+ @mock_locator = MockLocator.new(
112
+ configurator: @configurator, include_pathinator: @include_pathinator, test_search_paths: search_paths,
113
+ file_finder: @file_finder, file_path_utils: @file_path_utils
114
+ )
111
115
  standins = StandinHeaderinator.new(
112
116
  configurator: @configurator, loginator: @loginator, reportinator: @reportinator,
113
117
  file_wrapper: @file_wrapper, file_path_utils: @file_path_utils, mock_locator: @mock_locator
@@ -116,7 +120,8 @@ describe TestIncludesExtractinator do
116
120
 
117
121
  @extractinator = described_class.new(
118
122
  test_bare_includes_extractinator: TestBareIncludesExtractinator.new(
119
- **common, file_path_utils: @file_path_utils, dependinator: @dependinator, test_search_paths: search_paths, standin_headerinator: standins
123
+ **common, file_path_utils: @file_path_utils, dependinator: @dependinator, test_search_paths: search_paths, standin_headerinator: standins,
124
+ mock_locator: @mock_locator
120
125
  ),
121
126
  test_includes_preprocessinator: TestIncludesPreprocessinator.new(
122
127
  **common, file_path_utils: @file_path_utils, file_wrapper: @file_wrapper, dependinator: @dependinator
@@ -393,8 +398,10 @@ describe TestIncludesExtractinator do
393
398
  allow(@file_wrapper).to receive(:exist?).and_return( false )
394
399
  allow(@file_wrapper).to receive(:mkdir)
395
400
  allow(@file_wrapper).to receive(:write)
396
- allow(@file_path_utils).to receive(:form_mock_header_filepath).and_return( 'build/test/mocks/a_test/MockFoo.h' )
397
401
  allow(@file_finder).to receive(:resolve_mock).and_return( ['src/Foo.h', ''] )
402
+ allow(@file_path_utils).to receive(:form_mock_output_path) { |root, subdir| subdir.to_s.empty? ? root : File.join( root, subdir ) }
403
+ # A test mocks only when its build mocks, which gives it a mock root
404
+ @testable.paths = { mocks: 'build/test/mocks/a_test' }
398
405
  end
399
406
 
400
407
  it "places a stand-in for each mock on a freshly extracted bare-includes list" do
@@ -416,6 +423,51 @@ describe TestIncludesExtractinator do
416
423
 
417
424
  @extractinator.stage_collect_preprocessor_context( @state )
418
425
  end
426
+
427
+ # GCC lists an #include as written. The text scan anchors a climbing one to the test
428
+ # file's directory, and stages 5 and 10 find and place its mock by that text.
429
+ it "places a climbing mock's stand-in by its #include anchored to the test file's directory, keeping the list as written" do
430
+ allow(@dependinator).to receive(:stale?).and_return( true )
431
+ allow(@preprocessinator).to receive(:preprocess_bare_includes).and_return( [ Include.new('../x/MockFoo.h') ] )
432
+
433
+ expect(@file_finder).to receive(:resolve_mock).with( 'x/MockFoo.h', collection: anything, complain: anything ).and_return( ['inc/x/foo.h', 'x'] )
434
+ expect(@file_wrapper).to receive(:write).with( 'build/test/mocks/a_test/x/MockFoo.h', anything )
435
+
436
+ @extractinator.stage_collect_preprocessor_context( @state )
437
+
438
+ expect(@testable.preprocess[:includes].map(&:filepath)).to eq( ['../x/MockFoo.h'] )
439
+ end
440
+
441
+ # One header's mock named two ways would become two mocks that can't both link. The
442
+ # #include with the most path stays, as stage 2 keeps it, and the cache keeps GCC's list.
443
+ it "keeps one mock per real header on the bare list and its candidates" do
444
+ allow(@dependinator).to receive(:stale?).and_return( true )
445
+ allow(@preprocessinator).to receive(:preprocess_bare_includes).and_return( [ Include.new('MockFoo.h'), Include.new('drivers/MockFoo.h') ] )
446
+ allow(@file_finder).to receive(:resolve_mock).and_return( ['src/drivers/foo.h', 'drivers'] )
447
+
448
+ expect(@preprocessinator).to receive(:store_includes_list)
449
+ .with( hash_including( includes: satisfy { |list| list.map(&:filepath) == ['MockFoo.h', 'drivers/MockFoo.h'] } ) )
450
+ expect(@file_wrapper).to receive(:write).with( 'build/test/mocks/a_test/drivers/MockFoo.h', anything ).at_least( :once )
451
+
452
+ @extractinator.stage_collect_preprocessor_context( @state )
453
+
454
+ expect(@testable.preprocess[:includes].map(&:filepath)).to eq( ['drivers/MockFoo.h'] )
455
+ expect(@testable.preprocess[:candidates].map(&:filepath)).to eq( ['drivers/MockFoo.h'] )
456
+ end
457
+
458
+ # The test file still names the mock both ways, and pass 2 must reach a file for each
459
+ it "places a stand-in for every spelling of one header's mock, keeping one on the lists" do
460
+ allow(@dependinator).to receive(:stale?).and_return( true )
461
+ allow(@preprocessinator).to receive(:preprocess_bare_includes).and_return( [ Include.new('drivers/MockFoo.h'), Include.new('src/drivers/MockFoo.h') ] )
462
+ allow(@file_finder).to receive(:resolve_mock).and_return( ['src/drivers/foo.h', 'drivers'] )
463
+
464
+ expect(@file_wrapper).to receive(:write).with( 'build/test/mocks/a_test/drivers/MockFoo.h', anything )
465
+ expect(@file_wrapper).to receive(:write).with( 'build/test/mocks/a_test/src/drivers/MockFoo.h', anything )
466
+
467
+ @extractinator.stage_collect_preprocessor_context( @state )
468
+
469
+ expect(@testable.preprocess[:includes].map(&:filepath)).to eq( ['src/drivers/MockFoo.h'] )
470
+ end
419
471
  end
420
472
  end
421
473
 
@@ -17,12 +17,32 @@ describe 'Test pipeline object wiring' do
17
17
 
18
18
  %w[
19
19
  test_invoker test_pipeline_manager test_build_setup test_includes_extractinator test_bare_includes_extractinator
20
- test_includes_preprocessinator test_includes_reconcilinator test_build_planner partials_manager
20
+ test_includes_preprocessinator test_includes_reconcilinator test_build_planner partial_files_preprocessinator partials_manager
21
21
  test_build_executor test_file_preprocessinator test_runner_generatinator test_search_paths mock_locator
22
- standin_headerinator
23
- ].each do |name|
22
+ standin_headerinator test_source_file_directive_resolver test_substitutions
23
+ ].map { |name| [name, "ceedling/test_invoker/#{name}"] }.concat( [
24
+ ['build_log_writer', 'ceedling/build_log_writer'],
25
+ ['generator_test_results_backtrace', 'ceedling/generators/generator_test_results_backtrace'],
26
+ ['build_step_doctor', 'ceedling/diagnostics/build_step_doctor'],
27
+ ['header_collision_specialist', 'ceedling/diagnostics/header_collision_specialist'],
28
+ ['missing_symbol_specialist', 'ceedling/diagnostics/missing_symbol_specialist'],
29
+ ['duplicate_symbol_specialist', 'ceedling/diagnostics/duplicate_symbol_specialist'],
30
+ ['partial_name_specialist', 'ceedling/diagnostics/partial_name_specialist'],
31
+ ['include_depth_specialist', 'ceedling/diagnostics/include_depth_specialist'],
32
+ ['preprocessinator_file_assembler', 'ceedling/preprocess/preprocessinator_file_assembler'],
33
+ ['partializer', 'ceedling/partials/partializer'],
34
+ ['partializer_helper', 'ceedling/partials/partializer_helper'],
35
+ ['partializer_reconciler', 'ceedling/partials/partializer_reconciler'],
36
+ ['partializer_utils', 'ceedling/partials/partializer_utils'],
37
+ ['generator_partials', 'ceedling/generators/generator_partials'],
38
+ ['test_build_layout', 'ceedling/filesystem/test_build_layout'],
39
+ ['dependinator', 'ceedling/dependencies/dependinator'],
40
+ ['file_path_utils', 'ceedling/filesystem/file_path_utils'],
41
+ ['file_finder', 'ceedling/filesystem/file_finder'],
42
+ ['include_factory', 'ceedling/includes/include_factory']
43
+ ] ).each do |name, path|
24
44
  it "composes exactly what #{name}'s constructor takes" do
25
- require "ceedling/test_invoker/#{name}"
45
+ require path
26
46
  klass = Object.const_get( name.split( '_' ).map( &:capitalize ).join )
27
47
 
28
48
  expect(OBJECTS_WIRING.dig( name, 'compose' )).to match_array( klass.constructor_keys.map( &:to_s ) )