ceedling 1.2.2 → 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 (390) hide show
  1. checksums.yaml +4 -4
  2. data/GIT_COMMIT_SHA +1 -1
  3. data/README.md +1 -1
  4. data/assets/fixtures/tests_with_partials_coverage/src/private_macro.c +7 -0
  5. data/assets/fixtures/tests_with_partials_coverage/src/private_macro.h +5 -0
  6. data/assets/fixtures/tests_with_partials_coverage/src/tally.c +13 -0
  7. data/assets/fixtures/tests_with_partials_coverage/src/tally.h +4 -0
  8. data/assets/fixtures/tests_with_partials_coverage/test/test_private_macro.c +10 -0
  9. data/assets/fixtures/tests_with_partials_coverage/test/test_tally.c +9 -0
  10. data/docs/BreakingChanges.md +16 -0
  11. data/docs/Changelog.md +71 -0
  12. data/docs/KnownIssues.md +91 -4
  13. data/examples/wondrous_forest/README.md +29 -1
  14. data/examples/wondrous_forest/src/ForestUnits.h +23 -0
  15. data/examples/wondrous_forest/src/RainGauge.c +59 -0
  16. data/examples/wondrous_forest/src/RainGauge.h +39 -0
  17. data/examples/wondrous_forest/src/RainTipIsr.c +17 -0
  18. data/examples/wondrous_forest/src/RainTipIsr.h +14 -0
  19. data/examples/wondrous_forest/test/TestRainGauge.c +126 -0
  20. data/lib/ceedling/c_extractor/README.md +15 -7
  21. data/lib/ceedling/c_extractor/c_extractor.rb +25 -14
  22. data/lib/ceedling/c_extractor/c_extractor_code_text.rb +84 -54
  23. data/lib/ceedling/c_extractor/c_extractor_constants.rb +18 -7
  24. data/lib/ceedling/c_extractor/c_extractor_declarations.rb +319 -283
  25. data/lib/ceedling/c_extractor/c_extractor_declarator.rb +285 -0
  26. data/lib/ceedling/c_extractor/c_extractor_defined_type.rb +111 -0
  27. data/lib/ceedling/c_extractor/c_extractor_definitions.rb +174 -121
  28. data/lib/ceedling/c_extractor/c_extractor_functions.rb +191 -162
  29. data/lib/ceedling/c_extractor/c_extractor_preprocessing.rb +46 -55
  30. data/lib/ceedling/c_extractor/c_extractor_statement.rb +30 -0
  31. data/lib/ceedling/c_extractor/c_extractor_types.rb +63 -41
  32. data/lib/ceedling/c_extractor/c_module_edits.rb +48 -0
  33. data/lib/ceedling/c_identifier.rb +21 -0
  34. data/lib/ceedling/ceedling.h +8 -0
  35. data/lib/ceedling/config/configurator.rb +4 -3
  36. data/lib/ceedling/config/configurator_builder.rb +17 -0
  37. data/lib/ceedling/config/configurator_setup.rb +29 -5
  38. data/lib/ceedling/constants.rb +5 -1
  39. data/lib/ceedling/defaults.rb +31 -1
  40. data/lib/ceedling/dependencies/CACHE_SCHEMA.md +118 -0
  41. data/lib/ceedling/dependencies/README.md +1 -1
  42. data/lib/ceedling/dependencies/dependency_cache_store.rb +30 -25
  43. data/lib/ceedling/dependencies/dependency_tracker.rb +9 -3
  44. data/lib/ceedling/dependencies/dependinator.rb +13 -1
  45. data/lib/ceedling/diagnostics/DOCTOR.md +142 -0
  46. data/lib/ceedling/diagnostics/README.md +5 -0
  47. data/lib/ceedling/diagnostics/build_step_doctor.rb +110 -0
  48. data/lib/ceedling/diagnostics/duplicate_symbol_specialist.rb +108 -0
  49. data/lib/ceedling/diagnostics/guidance_phrases.rb +30 -0
  50. data/lib/ceedling/diagnostics/header_collision_guidance.rb +56 -0
  51. data/lib/ceedling/diagnostics/header_collision_specialist.rb +152 -0
  52. data/lib/ceedling/diagnostics/include_depth_specialist.rb +132 -0
  53. data/lib/ceedling/diagnostics/missing_symbol_specialist.rb +111 -0
  54. data/lib/ceedling/diagnostics/partial_name_specialist.rb +134 -0
  55. data/lib/ceedling/diagnostics/toolchain_output.rb +44 -0
  56. data/lib/ceedling/filesystem/PATH_HANDLING.md +83 -27
  57. data/lib/ceedling/filesystem/README.md +6 -1
  58. data/lib/ceedling/filesystem/build_roots.rb +105 -0
  59. data/lib/ceedling/filesystem/build_subpath.rb +110 -25
  60. data/lib/ceedling/filesystem/file_finder.rb +76 -110
  61. data/lib/ceedling/filesystem/file_finder_helper.rb +33 -11
  62. data/lib/ceedling/filesystem/file_path_utils.rb +113 -91
  63. data/lib/ceedling/filesystem/file_wrapper.rb +105 -28
  64. data/lib/ceedling/filesystem/path_matcher.rb +21 -0
  65. data/lib/ceedling/filesystem/test_build_layout.rb +114 -0
  66. data/lib/ceedling/filesystem/win_long_paths.rb +153 -0
  67. data/lib/ceedling/filesystem/win_path_limit.rb +83 -0
  68. data/lib/ceedling/filesystem/win_path_prober.rb +52 -0
  69. data/lib/ceedling/generators/generator.rb +27 -64
  70. data/lib/ceedling/generators/generator_helper.rb +0 -44
  71. data/lib/ceedling/generators/generator_mocks.rb +5 -0
  72. data/lib/ceedling/generators/generator_partials.rb +305 -243
  73. data/lib/ceedling/generators/generator_test_runner.rb +5 -8
  74. data/lib/ceedling/generators/partial_header_writer.rb +95 -0
  75. data/lib/ceedling/generators/partial_source_writer.rb +137 -0
  76. data/lib/ceedling/includes/header_search.rb +225 -0
  77. data/lib/ceedling/includes/include_factory.rb +9 -12
  78. data/lib/ceedling/includes/include_pathinator.rb +53 -31
  79. data/lib/ceedling/includes/includes.rb +149 -37
  80. data/lib/ceedling/objects.yml +89 -4
  81. data/lib/ceedling/partials/README.md +110 -16
  82. data/lib/ceedling/partials/carry_plan.rb +71 -0
  83. data/lib/ceedling/partials/definition_head.rb +74 -0
  84. data/lib/ceedling/partials/include_groups.rb +37 -0
  85. data/lib/ceedling/partials/interface_extras.rb +25 -0
  86. data/lib/ceedling/partials/partializer.rb +599 -120
  87. data/lib/ceedling/partials/partializer_config.rb +5 -0
  88. data/lib/ceedling/partials/partializer_helper.rb +851 -145
  89. data/lib/ceedling/partials/partializer_reconciler.rb +174 -0
  90. data/lib/ceedling/partials/partializer_utils.rb +89 -109
  91. data/lib/ceedling/partials/partials.rb +153 -10
  92. data/lib/ceedling/partials/type_macros.rb +126 -0
  93. data/lib/ceedling/preprocess/README.md +43 -33
  94. data/lib/ceedling/preprocess/preprocessinator.rb +100 -186
  95. data/lib/ceedling/preprocess/preprocessinator_code_finder.rb +65 -72
  96. data/lib/ceedling/preprocess/preprocessinator_file_assembler.rb +31 -75
  97. data/lib/ceedling/preprocess/preprocessinator_reconstructor.rb +51 -14
  98. data/lib/ceedling/setupinator.rb +16 -3
  99. data/lib/ceedling/test_invoker/HEADER_COLLISIONS.md +21 -7
  100. data/lib/ceedling/test_invoker/PIPELINE.md +57 -16
  101. data/lib/ceedling/test_invoker/README.md +1 -1
  102. data/lib/ceedling/test_invoker/derived_search_path_notices.rb +45 -0
  103. data/lib/ceedling/test_invoker/mock_locator.rb +116 -9
  104. data/lib/ceedling/test_invoker/partial_files_preprocessinator.rb +181 -0
  105. data/lib/ceedling/test_invoker/partials_manager.rb +265 -308
  106. data/lib/ceedling/test_invoker/standin_headerinator.rb +8 -15
  107. data/lib/ceedling/test_invoker/test_bare_includes_extractinator.rb +26 -3
  108. data/lib/ceedling/test_invoker/test_build_executor.rb +338 -198
  109. data/lib/ceedling/test_invoker/test_build_planner.rb +13 -19
  110. data/lib/ceedling/test_invoker/test_build_setup.rb +26 -6
  111. data/lib/ceedling/test_invoker/test_build_validations.rb +23 -20
  112. data/lib/ceedling/test_invoker/test_derived_search_paths.rb +189 -0
  113. data/lib/ceedling/test_invoker/test_file_preprocessinator.rb +1 -2
  114. data/lib/ceedling/test_invoker/test_includes_reconcilinator.rb +1 -1
  115. data/lib/ceedling/test_invoker/test_invoker_types.rb +28 -20
  116. data/lib/ceedling/test_invoker/test_pipeline_helpers.rb +5 -3
  117. data/lib/ceedling/test_invoker/test_pipeline_manager.rb +25 -8
  118. data/lib/ceedling/test_invoker/test_runner_generatinator.rb +31 -3
  119. data/lib/ceedling/test_invoker/test_search_paths.rb +30 -8
  120. data/lib/ceedling/test_invoker/test_substitutions.rb +72 -0
  121. data/lib/ceedling/tools/shell_quoting.rb +45 -0
  122. data/lib/ceedling/tools/tool_quoting.rb +79 -0
  123. data/lib/ceedling/{tool_validator.rb → tools/tool_validator.rb} +18 -7
  124. data/lib/version.rb +1 -1
  125. data/plugins/bullseye/bullseye.rake +1 -3
  126. data/plugins/bullseye/lib/bullseye.rb +15 -2
  127. data/plugins/command_hooks/lib/command_hooks.rb +1 -1
  128. data/plugins/fff/lib/fff.rb +42 -15
  129. data/plugins/fff/lib/fff_mock_generator.rb +12 -9
  130. data/plugins/fff/spec/fff_cmock_wrapper_spec.rb +134 -0
  131. data/plugins/fff/spec/fff_mock_header_generator_spec.rb +9 -0
  132. data/plugins/fff/spec/fff_mock_source_generator_spec.rb +20 -0
  133. data/plugins/gcov/lib/console_reportinator.rb +25 -19
  134. data/plugins/gcov/lib/reportgenerator_reportinator.rb +2 -1
  135. data/site-local/404.html +2 -2
  136. data/site-local/assets/javascripts/{bundle.c21346df.min.js → bundle.a5f9d56c.min.js} +1 -1
  137. data/site-local/assets/javascripts/{bundle.c21346df.min.js.map → bundle.a5f9d56c.min.js.map} +2 -2
  138. data/site-local/configuration/environment-vars.html +2 -2
  139. data/site-local/configuration/global-collections.html +3 -3
  140. data/site-local/configuration/index.html +2 -2
  141. data/site-local/configuration/loading.html +2 -2
  142. data/site-local/configuration/mixins.html +2 -2
  143. data/site-local/configuration/parallel-builds.html +2 -2
  144. data/site-local/configuration/project-file.html +2 -2
  145. data/site-local/configuration/reference/cexception.html +2 -2
  146. data/site-local/configuration/reference/cmock.html +5 -2
  147. data/site-local/configuration/reference/defines.html +2 -2
  148. data/site-local/configuration/reference/environment.html +2 -2
  149. data/site-local/configuration/reference/extension.html +2 -2
  150. data/site-local/configuration/reference/files.html +56 -9
  151. data/site-local/configuration/reference/flags.html +2 -2
  152. data/site-local/configuration/reference/index.html +2 -2
  153. data/site-local/configuration/reference/libraries.html +2 -2
  154. data/site-local/configuration/reference/mixins.html +2 -2
  155. data/site-local/configuration/reference/partials.html +84 -2
  156. data/site-local/configuration/reference/paths.html +7 -2
  157. data/site-local/configuration/reference/plugins.html +2 -2
  158. data/site-local/configuration/reference/project.html +247 -5
  159. data/site-local/configuration/reference/release-build.html +2 -2
  160. data/site-local/configuration/reference/test-build.html +2 -2
  161. data/site-local/configuration/reference/test-runner.html +2 -2
  162. data/site-local/configuration/reference/tools.html +49 -4
  163. data/site-local/configuration/reference/unity.html +2 -2
  164. data/site-local/configuration/which-ceedling.html +2 -2
  165. data/site-local/development/index.html +2 -2
  166. data/site-local/development/plugins/configuration.html +2 -2
  167. data/site-local/development/plugins/index.html +2 -2
  168. data/site-local/development/plugins/plugin-subclass.html +5 -4
  169. data/site-local/development/plugins/rake-tasks.html +2 -2
  170. data/site-local/development/releases.html +2 -2
  171. data/site-local/development/workflow.html +2 -2
  172. data/site-local/getting-started/builds.html +2 -2
  173. data/site-local/getting-started/command-line.html +2 -2
  174. data/site-local/getting-started/example-projects/cipher-quest.html +2 -2
  175. data/site-local/getting-started/example-projects/index.html +2 -2
  176. data/site-local/getting-started/example-projects/temp-sensor.html +2 -2
  177. data/site-local/getting-started/example-projects/wondrous-forest.html +10 -2
  178. data/site-local/getting-started/index.html +2 -2
  179. data/site-local/getting-started/installation.html +2 -2
  180. data/site-local/getting-started/quick-start.html +2 -2
  181. data/site-local/help.html +2 -2
  182. data/site-local/index.html +2 -2
  183. data/site-local/overview/build-system.html +2 -2
  184. data/site-local/overview/index.html +2 -2
  185. data/site-local/overview/test-environments.html +2 -2
  186. data/site-local/overview/tools-and-frameworks.html +2 -2
  187. data/site-local/plugins/beep.html +2 -2
  188. data/site-local/plugins/bullseye/index.html +45 -38
  189. data/site-local/plugins/bullseye/licensing.html +2 -2
  190. data/site-local/plugins/command-hooks.html +4 -4
  191. data/site-local/plugins/compile-commands-json-db.html +2 -2
  192. data/site-local/plugins/cppcheck.html +2 -2
  193. data/site-local/plugins/dependencies.html +2 -2
  194. data/site-local/plugins/fff.html +16 -2
  195. data/site-local/plugins/gcov/examples.html +2 -2
  196. data/site-local/plugins/gcov/gcovr.html +8 -2
  197. data/site-local/plugins/gcov/index.html +2 -2
  198. data/site-local/plugins/gcov/overview.html +2 -2
  199. data/site-local/plugins/gcov/reportgenerator.html +18 -14
  200. data/site-local/plugins/gcov/reporting.html +2 -2
  201. data/site-local/plugins/gcov/setup.html +2 -2
  202. data/site-local/plugins/gcov/tool-versions.html +2 -2
  203. data/site-local/plugins/gcov/troubleshooting.html +2 -2
  204. data/site-local/plugins/index.html +2 -2
  205. data/site-local/plugins/module-generator.html +2 -2
  206. data/site-local/plugins/report-build-warnings-log.html +2 -2
  207. data/site-local/plugins/report-tests-gtestlike-stdout.html +2 -2
  208. data/site-local/plugins/report-tests-ide-stdout.html +2 -2
  209. data/site-local/plugins/report-tests-log-factory.html +2 -2
  210. data/site-local/plugins/report-tests-pretty-stdout.html +2 -2
  211. data/site-local/plugins/report-tests-raw-output-log.html +2 -2
  212. data/site-local/plugins/report-tests-teamcity-stdout.html +2 -2
  213. data/site-local/plugins/sanitize.html +2 -2
  214. data/site-local/plugins/valgrind.html +2 -2
  215. data/site-local/project/index.html +2 -2
  216. data/site-local/project/release-history.html +2 -2
  217. data/site-local/project/sbom.html +2 -2
  218. data/site-local/project/upgrade.html +2 -2
  219. data/site-local/reference/build-directives.html +2 -2
  220. data/site-local/reference/command-line.html +2 -2
  221. data/site-local/reference/environment-vars.html +2 -2
  222. data/site-local/reference/gcov-plugin.html +2 -2
  223. data/site-local/reference/global-collections.html +12 -12
  224. data/site-local/reference/index.html +2 -2
  225. data/site-local/reference/partials-macros.html +47 -2
  226. data/site-local/reference/project-configuration.html +2 -2
  227. data/site-local/sitemap.xml.gz +0 -0
  228. data/site-local/snapshot/examples/cipher_quest/index.html +2 -2
  229. data/site-local/snapshot/examples/temp_sensor/index.html +2 -2
  230. data/site-local/snapshot/examples/wondrous_forest/index.html +72 -15
  231. data/site-local/testing-guide/build-directives.html +2 -2
  232. data/site-local/testing-guide/conventions.html +67 -22
  233. data/site-local/testing-guide/frameworks.html +2 -2
  234. data/site-local/testing-guide/index.html +2 -2
  235. data/site-local/testing-guide/partials/configuration.html +31 -4
  236. data/site-local/testing-guide/partials/conventions.html +509 -8
  237. data/site-local/testing-guide/partials/directives.html +4 -3
  238. data/site-local/testing-guide/partials/example.html +2 -2
  239. data/site-local/testing-guide/partials/index.html +2 -2
  240. data/site-local/testing-guide/partials/overview.html +30 -12
  241. data/site-local/testing-guide/partials/variables.html +169 -4
  242. data/site-local/testing-guide/test-cases.html +2 -2
  243. data/site-local/testing-guide/test-sample.html +2 -2
  244. data/site-local/testing-guide/test-suite-anatomy.html +2 -2
  245. data/spec/integration/build_step_doctor_spec.rb +270 -0
  246. data/spec/integration/c_extractor_composition_spec.rb +254 -4
  247. data/spec/integration/includes_extraction_spec.rb +27 -14
  248. data/spec/integration/nested_test_artifacts_spec.rb +1 -1
  249. data/spec/integration/partial_files_preprocessing_spec.rb +128 -0
  250. data/spec/integration/partials_carry_spec.rb +520 -0
  251. data/spec/integration/partials_declarations_spec.rb +655 -0
  252. data/spec/integration/partials_fallback_preprocessing_spec.rb +65 -0
  253. data/spec/integration/partials_function_pointers_spec.rb +277 -0
  254. data/spec/integration/partials_header_composition_spec.rb +268 -35
  255. data/spec/integration/partials_macro_decorators_spec.rb +267 -0
  256. data/spec/integration/partials_module_resolution_spec.rb +26 -19
  257. data/spec/integration/partials_symbol_linkage_spec.rb +13 -0
  258. data/spec/integration/path_length_reporting_spec.rb +64 -0
  259. data/spec/integration/path_scenarios_spec.rb +80 -3
  260. data/spec/integration/quote_include_isolator_spec.rb +56 -0
  261. data/spec/integration/test_build_parallel_barrier_spec.rb +1 -1
  262. data/spec/integration/test_includes_extractinator_spec.rb +70 -5
  263. data/spec/integration/test_naming_spec.rb +6 -3
  264. data/spec/integration/test_source_file_checks_spec.rb +5 -3
  265. data/spec/integration/tool_executor_spec.rb +1 -1
  266. data/spec/integration/tool_validator_spec.rb +2 -2
  267. data/spec/integration/win_long_paths_probe_spec.rb +46 -0
  268. data/spec/integration/win_path_limit_spec.rb +53 -0
  269. data/spec/integration/windows_registry_query_tool_spec.rb +41 -0
  270. data/spec/support/integration/configurator_integration_helper.rb +8 -3
  271. data/spec/support/integration/partial_files_harness.rb +181 -0
  272. data/spec/support/integration/partials_generation_integration_helper.rb +237 -141
  273. data/spec/support/integration/path_scenario_harness.rb +4 -2
  274. data/spec/support/integration/spec_integration_helper.rb +8 -3
  275. data/spec/support/integration/test_includes_harness.rb +56 -35
  276. data/spec/support/integration/tool_executor_integration_helper.rb +14 -2
  277. data/spec/system/bullseye_deployment_spec.rb +2 -0
  278. data/spec/system/delta_builds_spec.rb +26 -12
  279. data/spec/system/encoding_stress_spec.rb +4 -4
  280. data/spec/system/example_wondrous_forest_spec.rb +2 -2
  281. data/spec/system/gcov_deployment_spec.rb +2 -0
  282. data/spec/system/header_include_path_validation_spec.rb +4 -4
  283. data/spec/system/header_search_paths_spec.rb +1083 -0
  284. data/spec/system/mock_include_folders_spec.rb +121 -0
  285. data/spec/system/mockable_header_reassembly_spec.rb +184 -0
  286. data/spec/system/partials_carry_spec.rb +581 -0
  287. data/spec/system/partials_delta_builds_spec.rb +280 -0
  288. data/spec/system/partials_function_pointers_spec.rb +106 -0
  289. data/spec/system/partials_macro_decorators_spec.rb +127 -0
  290. data/spec/system/partials_module_disambiguation_spec.rb +125 -0
  291. data/spec/system/path_handling_probes_spec.rb +16 -12
  292. data/spec/system/pinned_thread_count_spec.rb +4 -4
  293. data/spec/system/preprocessing_fallback_conditionals_spec.rb +1 -1
  294. data/spec/system/short_build_paths_spec.rb +87 -0
  295. data/spec/system/sibling_header_collision_spec.rb +30 -6
  296. data/spec/system/support/bullseye_common_test_cases.rb +42 -0
  297. data/spec/system/support/common_test_cases.rb +2 -2
  298. data/spec/system/support/gcov_partials_test_cases.rb +48 -0
  299. data/spec/system/test_build_layout_spec.rb +209 -0
  300. data/spec/system/test_source_file_directive_spec.rb +35 -5
  301. data/spec/units/c_extractor/c_extractor_code_text_spec.rb +67 -10
  302. data/spec/units/c_extractor/c_extractor_declarations_spec.rb +501 -4
  303. data/spec/units/c_extractor/c_extractor_declarator_spec.rb +245 -0
  304. data/spec/units/c_extractor/c_extractor_defined_type_spec.rb +45 -0
  305. data/spec/units/c_extractor/c_extractor_definitions_spec.rb +163 -3
  306. data/spec/units/c_extractor/c_extractor_functions_spec.rb +462 -21
  307. data/spec/units/c_extractor/c_extractor_preprocessing_spec.rb +39 -0
  308. data/spec/units/c_extractor/c_extractor_spec.rb +4 -4
  309. data/spec/units/c_extractor/c_extractor_types_spec.rb +163 -0
  310. data/spec/units/c_identifier_spec.rb +35 -0
  311. data/spec/units/config/configurator_builder_spec.rb +24 -0
  312. data/spec/units/config/configurator_setup_spec.rb +72 -4
  313. data/spec/units/config/configurator_spec.rb +27 -1
  314. data/spec/units/dependencies/dependency_cache_store_spec.rb +68 -3
  315. data/spec/units/dependencies/dependency_tracker_spec.rb +25 -0
  316. data/spec/units/dependencies/dependinator_spec.rb +17 -2
  317. data/spec/units/diagnostics/build_step_doctor_spec.rb +170 -0
  318. data/spec/units/diagnostics/duplicate_symbol_specialist_spec.rb +117 -0
  319. data/spec/units/diagnostics/header_collision_specialist_spec.rb +267 -0
  320. data/spec/units/diagnostics/include_depth_specialist_spec.rb +137 -0
  321. data/spec/units/diagnostics/missing_symbol_specialist_spec.rb +154 -0
  322. data/spec/units/diagnostics/partial_name_specialist_spec.rb +129 -0
  323. data/spec/units/diagnostics/toolchain_output_spec.rb +86 -0
  324. data/spec/units/encodinator_spec.rb +3 -4
  325. data/spec/units/filesystem/build_roots_spec.rb +131 -0
  326. data/spec/units/filesystem/build_subpath_spec.rb +113 -0
  327. data/spec/units/filesystem/file_finder_helper_spec.rb +80 -0
  328. data/spec/units/filesystem/file_finder_spec.rb +242 -58
  329. data/spec/units/filesystem/file_path_utils_spec.rb +251 -118
  330. data/spec/units/filesystem/file_wrapper_spec.rb +191 -6
  331. data/spec/units/filesystem/path_matcher_spec.rb +36 -0
  332. data/spec/units/filesystem/test_build_layout_spec.rb +216 -0
  333. data/spec/units/filesystem/win_long_paths_spec.rb +204 -0
  334. data/spec/units/filesystem/win_path_prober_spec.rb +158 -0
  335. data/spec/units/generators/generator_helper_spec.rb +0 -60
  336. data/spec/units/generators/generator_mocks_spec.rb +13 -0
  337. data/spec/units/generators/generator_partials_spec.rb +656 -55
  338. data/spec/units/generators/generator_spec.rb +26 -0
  339. data/spec/units/generators/generator_test_runner_spec.rb +9 -5
  340. data/spec/units/generators/partial_source_writer_spec.rb +129 -0
  341. data/spec/units/includes/header_search_spec.rb +406 -0
  342. data/spec/units/includes/include_factory_spec.rb +22 -5
  343. data/spec/units/includes/include_pathinator_spec.rb +77 -13
  344. data/spec/units/includes/include_spec.rb +14 -0
  345. data/spec/units/includes/includes_spec.rb +176 -19
  346. data/spec/units/loginator_spec.rb +31 -0
  347. data/spec/units/mock_locator_spec.rb +199 -5
  348. data/spec/units/partials/include_groups_spec.rb +42 -0
  349. data/spec/units/partials/partializer_config_spec.rb +25 -0
  350. data/spec/units/partials/partializer_helper_carry_spec.rb +661 -0
  351. data/spec/units/partials/partializer_helper_interface_extras_spec.rb +396 -0
  352. data/spec/units/partials/partializer_helper_spec.rb +529 -277
  353. data/spec/units/partials/partializer_reconciler_spec.rb +661 -0
  354. data/spec/units/partials/partializer_spec.rb +1578 -270
  355. data/spec/units/partials/partializer_utils_spec.rb +269 -232
  356. data/spec/units/partials/partials_rename_spec.rb +160 -0
  357. data/spec/units/partials_manager_spec.rb +554 -261
  358. data/spec/units/plugins/bullseye_spec.rb +34 -0
  359. data/spec/units/plugins/console_reportinator_spec.rb +58 -9
  360. data/spec/units/plugins/report_tests_teamcity_stdout_spec.rb +1 -1
  361. data/spec/units/plugins/reportgenerator_reportinator_spec.rb +51 -3
  362. data/spec/units/preprocess/preprocessinator_code_finder_spec.rb +73 -10
  363. data/spec/units/preprocess/preprocessinator_file_assembler_spec.rb +125 -37
  364. data/spec/units/preprocess/preprocessinator_includes_handler_spec.rb +15 -0
  365. data/spec/units/preprocess/preprocessinator_reconstructor_spec.rb +197 -0
  366. data/spec/units/preprocess/preprocessinator_spec.rb +153 -95
  367. data/spec/units/setupinator_spec.rb +51 -0
  368. data/spec/units/standin_headerinator_spec.rb +27 -11
  369. data/spec/units/test_build_executor_spec.rb +780 -166
  370. data/spec/units/test_build_planner_spec.rb +116 -28
  371. data/spec/units/test_build_setup_spec.rb +83 -18
  372. data/spec/units/test_context_extractor_spec.rb +11 -2
  373. data/spec/units/test_derived_search_paths_spec.rb +259 -0
  374. data/spec/units/test_includes_extractinator_spec.rb +56 -8
  375. data/spec/units/test_invoker/objects_wiring_spec.rb +20 -3
  376. data/spec/units/test_invoker/partial_files_preprocessinator_spec.rb +264 -0
  377. data/spec/units/test_invoker/test_substitutions_spec.rb +122 -0
  378. data/spec/units/test_invoker_types_spec.rb +8 -7
  379. data/spec/units/test_pipeline_manager_spec.rb +54 -13
  380. data/spec/units/test_runner_generatinator_spec.rb +93 -1
  381. data/spec/units/test_search_paths_spec.rb +73 -5
  382. data/spec/units/{default_tools_quoting_spec.rb → tools/default_tools_quoting_spec.rb} +39 -5
  383. data/spec/units/tools/shell_quoting_spec.rb +76 -0
  384. data/spec/units/{tool_executor_helper_spec.rb → tools/tool_executor_helper_spec.rb} +1 -1
  385. data/spec/units/{tool_executor_spec.rb → tools/tool_executor_spec.rb} +1 -1
  386. data/spec/units/{tool_validator_spec.rb → tools/tool_validator_spec.rb} +110 -1
  387. data/spec/units/windows_registry_query_tool_spec.rb +53 -0
  388. metadata +161 -16
  389. /data/lib/ceedling/{tool_executor.rb → tools/tool_executor.rb} +0 -0
  390. /data/lib/ceedling/{tool_executor_helper.rb → tools/tool_executor_helper.rb} +0 -0
@@ -0,0 +1,163 @@
1
+ # =========================================================================
2
+ # Ceedling - Test-Centered Build System for C
3
+ # ThrowTheSwitch.org
4
+ # Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
5
+ # SPDX-License-Identifier: MIT
6
+ # =========================================================================
7
+
8
+ require 'spec_helper'
9
+ require 'ceedling/c_extractor/c_extractor_types'
10
+
11
+ describe CExtractorTypes::CModule do
12
+ let(:definition) { CExtractorTypes::CFunctionDefinition.new( name: 'clamp' ) }
13
+ let(:declaration) { CExtractorTypes::CFunctionDeclaration.new( name: 'tick' ) }
14
+ let(:variable) { CExtractorTypes::CVariableDeclaration.new( name: 'count' ) }
15
+ let(:statement) { CExtractorTypes::CStatement.new( text: '#define LIMIT 9' ) }
16
+
17
+ def module_of(*items)
18
+ CExtractorTypes::CModule.new(
19
+ function_definitions: items.grep( CExtractorTypes::CFunctionDefinition ),
20
+ function_declarations: items.grep( CExtractorTypes::CFunctionDeclaration ),
21
+ variable_declarations: items.grep( CExtractorTypes::CVariableDeclaration ),
22
+ macro_definitions: items.grep( CExtractorTypes::CStatement ),
23
+ element_sequence: items
24
+ )
25
+ end
26
+
27
+ context "#stamp_origin!" do
28
+ it "stamps every function with the given origin" do
29
+ module_of( definition, declaration, variable ).stamp_origin!( :header )
30
+
31
+ expect( [definition, declaration].map( &:origin ) ).to all( eq( :header ) )
32
+ end
33
+
34
+ # element_sequence references the same objects, so the generator sees the stamp in order
35
+ it "is visible through element_sequence" do
36
+ c_module = module_of( declaration, definition ).stamp_origin!( :source )
37
+
38
+ expect( c_module.element_sequence.map( &:origin ) ).to eq( [:source, :source] )
39
+ end
40
+
41
+ it "returns the module so a merge can follow it" do
42
+ c_module = module_of( definition )
43
+
44
+ expect( c_module.stamp_origin!( :header ) ).to equal( c_module )
45
+ end
46
+
47
+ # A generated header places the source's later includes where the header's items end
48
+ it "stamps variables and statements too" do
49
+ module_of( variable, statement ).stamp_origin!( :header )
50
+
51
+ expect( [variable, statement].map( &:origin ) ).to all( eq( :header ) )
52
+ end
53
+
54
+ it "stamps a statement that only element_sequence holds" do
55
+ c_module = CExtractorTypes::CModule.new( type_definitions: [statement], element_sequence: [statement] )
56
+
57
+ c_module.stamp_origin!( :source )
58
+
59
+ expect( statement.origin ).to eq( :source )
60
+ end
61
+ end
62
+
63
+ context "#+" do
64
+ it "keeps the first module's items ahead of the second's" do
65
+ header = module_of( declaration ).stamp_origin!( :header )
66
+ source = module_of( definition ).stamp_origin!( :source )
67
+
68
+ expect( (header + source).element_sequence.map( &:origin ) ).to eq( [:header, :source] )
69
+ end
70
+ end
71
+
72
+ context "#remove!" do
73
+ it "takes items out of their lists and out of element_sequence" do
74
+ c_module = module_of( statement, definition, variable )
75
+
76
+ c_module.remove!( [statement, variable] )
77
+
78
+ expect( c_module.macro_definitions ).to be_empty
79
+ expect( c_module.variable_declarations ).to be_empty
80
+ expect( c_module.element_sequence ).to eq( [definition] )
81
+ end
82
+
83
+ # Two equal statements can sit in different places, and only the one given goes
84
+ it "matches items by identity, not by equality" do
85
+ twin = CExtractorTypes::CStatement.new( text: '#define LIMIT 9' )
86
+ c_module = module_of( statement, twin )
87
+
88
+ c_module.remove!( [twin] )
89
+
90
+ expect( c_module.element_sequence ).to contain_exactly( be( statement ) )
91
+ expect( c_module.macro_definitions ).to contain_exactly( be( statement ) )
92
+ end
93
+
94
+ it "removes every one of several equal items it is given" do
95
+ twin = CExtractorTypes::CStatement.new( text: '#define LIMIT 9' )
96
+ c_module = module_of( statement, twin )
97
+
98
+ c_module.remove!( [statement, twin] )
99
+
100
+ expect( c_module.element_sequence ).to be_empty
101
+ expect( c_module.macro_definitions ).to be_empty
102
+ end
103
+ end
104
+
105
+ context "#insert_before!" do
106
+ it "adds items to the lists their kinds name and places them just ahead of the anchor" do
107
+ type = CExtractorTypes::CStatement.new( text: 'struct last { int n; };', kind: :aggregate )
108
+ c_module = module_of( statement, definition )
109
+
110
+ c_module.insert_before!( definition, [type, variable] )
111
+
112
+ expect( c_module.aggregate_definitions ).to eq( [type] )
113
+ expect( c_module.variable_declarations ).to eq( [variable] )
114
+ expect( c_module.element_sequence ).to eq( [statement, type, variable, definition] )
115
+ end
116
+
117
+ it "places a statement in the list its kind names" do
118
+ typedef = CExtractorTypes::CStatement.new( text: 'typedef int count_t;', kind: :typedef )
119
+ c_module = module_of( definition )
120
+
121
+ c_module.insert_before!( definition, [typedef] )
122
+
123
+ expect( c_module.type_definitions ).to eq( [typedef] )
124
+ expect( c_module.aggregate_definitions ).to be_empty
125
+ end
126
+
127
+ it "refuses a statement whose kind names no list" do
128
+ loose = CExtractorTypes::CStatement.new( text: 'struct s;' )
129
+
130
+ expect { module_of.insert_before!( definition, [loose] ) }.to raise_error( ArgumentError, /CStatement of kind nil/ )
131
+ end
132
+
133
+ it "places items at the end when the anchor isn't in the module" do
134
+ c_module = module_of( statement )
135
+
136
+ c_module.insert_before!( definition, [variable] )
137
+
138
+ expect( c_module.element_sequence ).to eq( [statement, variable] )
139
+ end
140
+ end
141
+ end
142
+
143
+ describe 'C extractor item origins' do
144
+ it "defaults every origin to nil" do
145
+ expect( CExtractorTypes::CFunctionDefinition.new.origin ).to be_nil
146
+ expect( CExtractorTypes::CFunctionDeclaration.new.origin ).to be_nil
147
+ expect( CExtractorTypes::CVariableDeclaration.new.origin ).to be_nil
148
+ expect( CExtractorTypes::CStatement.new.origin ).to be_nil
149
+ end
150
+
151
+ it "tells a variable declared extern from one defined here" do
152
+ expect( CExtractorTypes::CVariableDeclaration.new( decorators: ['extern', 'const'] ).extern? ).to be( true )
153
+ expect( CExtractorTypes::CVariableDeclaration.new( decorators: ['static'] ).extern? ).to be( false )
154
+ end
155
+
156
+ it "gives a declaration a source filepath field" do
157
+ expect( CExtractorTypes::CFunctionDeclaration.new( source_filepath: 'src/a.c' ).source_filepath ).to eq( 'src/a.c' )
158
+ end
159
+
160
+ it "gives a definition an expanded body field" do
161
+ expect( CExtractorTypes::CFunctionDefinition.new( expanded_body: '{ }' ).expanded_body ).to eq( '{ }' )
162
+ end
163
+ end
@@ -0,0 +1,35 @@
1
+ # =========================================================================
2
+ # Ceedling - Test-Centered Build System for C
3
+ # ThrowTheSwitch.org
4
+ # Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
5
+ # SPDX-License-Identifier: MIT
6
+ # =========================================================================
7
+
8
+ require 'spec_helper'
9
+ require 'ceedling/c_identifier'
10
+
11
+ describe CIdentifier do
12
+ describe '.fold' do
13
+ it 'leaves a name that is already an identifier unchanged' do
14
+ expect( CIdentifier.fold( 'sensor_2' ) ).to eq( 'sensor_2' )
15
+ end
16
+
17
+ it 'replaces each character an identifier cannot hold with an underscore' do
18
+ expect( CIdentifier.fold( 'my-sensor.v2' ) ).to eq( 'my_sensor_v2' )
19
+ end
20
+
21
+ # One for one, so a test author can predict the folded name without knowing a rule
22
+ # for runs
23
+ it 'keeps a run of replaced characters as a run of underscores' do
24
+ expect( CIdentifier.fold( 'a--b' ) ).to eq( 'a__b' )
25
+ end
26
+
27
+ it 'folds a path separator like any other character' do
28
+ expect( CIdentifier.fold( 'drivers/uart\\config' ) ).to eq( 'drivers_uart_config' )
29
+ end
30
+
31
+ it 'folds a character outside ASCII to a single underscore' do
32
+ expect( CIdentifier.fold( 'café' ) ).to eq( 'caf_' )
33
+ end
34
+ end
35
+ end
@@ -11,9 +11,33 @@ require 'ceedling/filename_extension'
11
11
  require 'ceedling/system_utils' # Object#deep_clone
12
12
  require 'ceedling/system_wrapper'
13
13
  require 'ceedling/constants'
14
+ require 'ceedling/exceptions'
15
+ require 'ceedling/filesystem/build_roots'
14
16
 
15
17
  describe ConfiguratorBuilder do
16
18
 
19
+ # GH #1387: the roots a long configured location can be shortened to a marker in build paths
20
+ describe '#collect_build_roots' do
21
+ let(:fpcu) { double('file_path_collection_utils') }
22
+ let(:builder) { ConfiguratorBuilder.new(file_path_collection_utils: fpcu, loginator: nil, file_wrapper: nil, system_wrapper: nil) }
23
+ let(:config) do
24
+ { paths_source: ['src/**'], paths_include: ['../sdk/include'], paths_test: ['test/**'], paths_support: ['test/support'] }
25
+ end
26
+
27
+ it 'takes roots from the source, include, test, and support paths, as mirror roots are taken' do
28
+ expect(fpcu).to receive(:collect_mirror_roots).with( ['src/**', '../sdk/include', 'test/**', 'test/support'] ).and_return( ['src', '../sdk/include', 'test', 'test/support'] )
29
+
30
+ expect( builder.collect_build_roots( config ) ).to eq( { collection_build_roots: ['src', '../sdk/include', 'test', 'test/support'] } )
31
+ end
32
+
33
+ it 'stops configuration when two roots would share a marker, naming both' do
34
+ allow(fpcu).to receive(:collect_mirror_roots).and_return( ['../a/x/include', '../b/y/include'] )
35
+ allow(BuildRoots).to receive(:collisions).and_return( [['../a/x/include', '../b/y/include']] )
36
+
37
+ expect { builder.collect_build_roots( config ) }.to raise_error( CeedlingException, %r{'\.\./a/x/include' and '\.\./b/y/include'} )
38
+ end
39
+ end
40
+
17
41
  describe '#populate_with_defaults' do
18
42
  let(:builder) { ConfiguratorBuilder.new(file_path_collection_utils: nil, loginator: nil, file_wrapper: nil, system_wrapper: nil) }
19
43
 
@@ -9,6 +9,8 @@ require 'spec_helper'
9
9
  require 'ceedling/config/configurator_setup'
10
10
  require 'ceedling/reportinator'
11
11
  require 'ceedling/config/configurator_validator'
12
+ require 'ceedling/config/configurator'
13
+ require 'ceedling/defaults'
12
14
  require 'config_yaml_helper'
13
15
 
14
16
  # Unit coverage for ConfiguratorSetup's validations and build steps through doubled
@@ -83,15 +85,50 @@ describe ConfiguratorSetup do
83
85
 
84
86
  context "#validate_partials" do
85
87
  it "accepts an integer at the minimum" do
86
- config = { partials: { max_extraction_length: 10 } }
88
+ config = { partials: { max_extraction_length: 10, suppress_redundant_decls: true, extern_variables: :weak } }
87
89
  expect(@setup.validate_partials(config)).to be true
88
90
  end
89
91
 
90
92
  it "accepts an integer above the minimum" do
91
- config = { partials: { max_extraction_length: 5000 } }
93
+ config = { partials: { max_extraction_length: 5000, suppress_redundant_decls: true, extern_variables: :weak } }
92
94
  expect(@setup.validate_partials(config)).to be true
93
95
  end
94
96
 
97
+ it "accepts either boolean for :suppress_redundant_decls" do
98
+ [true, false].each do |value|
99
+ config = { partials: { max_extraction_length: 5000, suppress_redundant_decls: value, extern_variables: :weak } }
100
+ expect(@setup.validate_partials(config)).to be true
101
+ end
102
+ end
103
+
104
+ it "accepts either value for :extern_variables" do
105
+ [:weak, :test].each do |value|
106
+ config = { partials: { max_extraction_length: 5000, suppress_redundant_decls: true, extern_variables: value } }
107
+ expect(@setup.validate_partials(config)).to be true
108
+ end
109
+ end
110
+
111
+ it "shows a string :extern_variables as a string" do
112
+ config = { partials: { max_extraction_length: 5000, suppress_redundant_decls: true, extern_variables: 'weak' } }
113
+ expect(@loginator).to receive(:log)
114
+ .with(/:partials ↳ :extern_variables is "weak" but must be one of \{:weak, :test\}/, Verbosity::ERRORS)
115
+ expect(@setup.validate_partials(config)).to be false
116
+ end
117
+
118
+ it "rejects any other :extern_variables" do
119
+ config = { partials: { max_extraction_length: 5000, suppress_redundant_decls: true, extern_variables: :strong } }
120
+ expect(@loginator).to receive(:log)
121
+ .with(/:partials ↳ :extern_variables is ':strong' but must be one of \{:weak, :test\}/, Verbosity::ERRORS)
122
+ expect(@setup.validate_partials(config)).to be false
123
+ end
124
+
125
+ it "rejects a non-boolean :suppress_redundant_decls" do
126
+ config = { partials: { max_extraction_length: 5000, suppress_redundant_decls: 'yes' } }
127
+ expect(@loginator).to receive(:log)
128
+ .with(/:partials ↳ :suppress_redundant_decls is 'yes' but must be TRUE or FALSE/, Verbosity::ERRORS)
129
+ expect(@setup.validate_partials(config)).to be false
130
+ end
131
+
95
132
  it "rejects a non-integer value" do
96
133
  config = { partials: { max_extraction_length: '5000' } }
97
134
  expect(@loginator).to receive(:log)
@@ -572,7 +609,38 @@ describe ConfiguratorSetup do
572
609
 
573
610
  it "names the backtrace options when rejecting another value" do
574
611
  expect(@setup.validate_backtrace( { project: { use_backtrace: true } } )).to be false
575
- logged(/:project ↳ :use_backtrace is ':true' but must be one of \{:none, :simple, :gdb\}/)
612
+ logged(/:project ↳ :use_backtrace is true but must be one of \{:none, :simple, :gdb\}/)
613
+ end
614
+ end
615
+
616
+ # Windows has two path limits, so the setting names one of them, or asks for a probe.
617
+ # It is validated on every OS, so a shared project file is checked everywhere.
618
+ context "#validate_win_path_limit" do
619
+ it "accepts each Windows path limit option" do
620
+ [:classic, :long_paths, :auto].each do |option|
621
+ expect(@setup.validate_win_path_limit( { project: { win_path_limit: option } } )).to be true
622
+ end
623
+ end
624
+
625
+ { 260 => '260', true => 'true', :long => "':long'" }.each do |value, shown|
626
+ it "names the options when rejecting #{value.inspect}" do
627
+ expect(@setup.validate_win_path_limit( { project: { win_path_limit: value } } )).to be false
628
+ logged(/:project ↳ :win_path_limit is #{Regexp.escape( shown )} but must be one of \{:classic, :long_paths, :auto\}/)
629
+ end
630
+ end
631
+
632
+ # A string written without its colon would otherwise print as the symbol it resembles
633
+ it "shows a string value as a string" do
634
+ expect(@setup.validate_win_path_limit( { project: { win_path_limit: 'auto' } } )).to be false
635
+ logged(/:project ↳ :win_path_limit is "auto" but must be one of/)
636
+ end
637
+
638
+ it "runs among the final validations" do
639
+ expect(Configurator::FINAL_VALIDATIONS).to include( :validate_win_path_limit )
640
+ end
641
+
642
+ it "defaults to the classic limit" do
643
+ expect(DEFAULT_CEEDLING_PROJECT_CONFIG[:project][:win_path_limit]).to eq( :classic )
576
644
  end
577
645
  end
578
646
 
@@ -695,7 +763,7 @@ describe ConfiguratorSetup do
695
763
  context "#build_project_collections" do
696
764
  it "merges every path and file collection" do
697
765
  collections = [
698
- :expand_all_path_globs, :collect_mirror_roots, :collect_vendor_paths, :collect_source_and_include_paths, :collect_source_include_vendor_paths,
766
+ :expand_all_path_globs, :collect_mirror_roots, :collect_build_roots, :collect_vendor_paths, :collect_source_and_include_paths, :collect_source_include_vendor_paths,
699
767
  :collect_test_support_source_include_paths, :collect_test_support_source_include_vendor_paths, :collect_assembly,
700
768
  :collect_headers, :collect_release_build_input, :collect_existing_test_build_input,
701
769
  :collect_release_artifact_extra_link_objects, :collect_test_fixture_extra_link_objects, :collect_vendor_framework_sources
@@ -10,7 +10,7 @@ require 'ceedling/config/configurator'
10
10
  require 'ceedling/ruby_expandinator'
11
11
  require 'ceedling/exceptions'
12
12
  require 'ceedling/constants'
13
- require 'ceedling/tool_executor'
13
+ require 'ceedling/tools/tool_executor'
14
14
  require 'ceedling/config/config_walkinator'
15
15
  require 'ceedling/config/configurator_builder'
16
16
  require 'ceedling/system_utils'
@@ -493,6 +493,32 @@ describe Configurator do
493
493
  expect( tools ).to include( :test_assembler, :test_backtrace_gdb, :release_compiler, :release_linker, :release_assembler )
494
494
  end
495
495
 
496
+ # Only the long path probe reads the registry, and only on Windows when a project asks for long paths
497
+ context "with the Windows registry query" do
498
+ def tools_with_limit(windows:, limit:)
499
+ allow( @system_wrapper ).to receive( :windows? ).and_return( windows )
500
+ return tools_for( limit.nil? ? ":project: {}\n" : ":project:\n :win_path_limit: #{limit.inspect}\n" )
501
+ end
502
+
503
+ [:auto, :long_paths].each do |limit|
504
+ it "adds it on Windows when :win_path_limit is #{limit.inspect}" do
505
+ expect( tools_with_limit( windows: true, limit: limit ) ).to include( :windows_registry_query )
506
+ end
507
+ end
508
+
509
+ it "leaves it out on Windows when :win_path_limit is :classic" do
510
+ expect( tools_with_limit( windows: true, limit: :classic ) ).to_not include( :windows_registry_query )
511
+ end
512
+
513
+ it "leaves it out on Windows when :win_path_limit is not set" do
514
+ expect( tools_with_limit( windows: true, limit: nil ) ).to_not include( :windows_registry_query )
515
+ end
516
+
517
+ it "leaves it out off Windows, whatever :win_path_limit is" do
518
+ expect( tools_with_limit( windows: false, limit: :auto ) ).to_not include( :windows_registry_query )
519
+ end
520
+ end
521
+
496
522
  it "adds copies rather than the default tool definitions themselves" do
497
523
  defaults = { tools: {} }
498
524
  @configurator.merge_tools_defaults( { project: {} }, defaults )
@@ -124,9 +124,62 @@ describe DependencyCacheStore do
124
124
  expect( @store.load('cache.json')['entries'] ).to eq( {} )
125
125
  end
126
126
 
127
- # GH #1364: version 2 places per-test build output by the test's path from the project root
128
- it 'marks the 1.2.2 build layout as schema version 2' do
129
- expect( DependencyCacheStore::CACHE_SCHEMA_VERSION ).to eq( 2 )
127
+ # GH #1364: version 2 places per-test build output by the test's path from the project root.
128
+ # GH #1387: version 3 places build files below a long configured root at the root's marker.
129
+ # GH #1439: version 4 closes each test's name in its own build directories with `_t_`.
130
+ it 'marks the 1.2.3 build layout as schema version 4' do
131
+ expect( DependencyCacheStore::CACHE_SCHEMA_VERSION ).to eq( 4 )
132
+ end
133
+
134
+ # Each test's own root changed only test build paths
135
+ it 'keeps the 1.2.3 release build layout at schema version 3' do
136
+ expect( DependencyCacheStore::RELEASE_CACHE_SCHEMA_VERSION ).to eq( 3 )
137
+ end
138
+
139
+ it 'uses a cache of the schema version its pipeline gives as it is' do
140
+ payload = JSON.generate(
141
+ 'schema_version' => 3, 'hash_algorithm' => DependencyHasher::HASH_ALGORITHM, 'entries' => { 'foo.o' => valid_entry }
142
+ )
143
+ stub_file( 'build/cache/.release.dep_cache.json', payload )
144
+
145
+ result = @store.load( 'build/cache/.release.dep_cache.json', schema_version: 3 )
146
+
147
+ expect( result['entries'] ).to eq( 'foo.o' => valid_entry )
148
+ expect( result['schema_version'] ).to eq( 3 )
149
+ expect( @loginator ).not_to have_received(:log)
150
+ end
151
+
152
+ it "treats a cache newer than its pipeline's schema version as absent" do
153
+ payload = JSON.generate(
154
+ 'schema_version' => 4, 'hash_algorithm' => DependencyHasher::HASH_ALGORITHM, 'entries' => { 'foo.o' => valid_entry }
155
+ )
156
+ stub_file( 'build/cache/.release.dep_cache.json', payload )
157
+
158
+ expect(@loginator).to receive(:log).with( /has an incompatible or missing schema_version/, Verbosity::COMPLAIN )
159
+
160
+ expect( @store.load( 'build/cache/.release.dep_cache.json', schema_version: 3 )['entries'] ).to eq( {} )
161
+ end
162
+
163
+ it 'rebuilds once from a cache of shortened roots without per-test roots' do
164
+ payload = JSON.generate(
165
+ 'schema_version' => 3, 'hash_algorithm' => DependencyHasher::HASH_ALGORITHM, 'entries' => { 'foo.o' => valid_entry }
166
+ )
167
+ stub_file( 'build/cache/.test.dep_cache.json', payload )
168
+
169
+ expect(@loginator).to receive(:log).with( /comes from an earlier Ceedling build layout/, Verbosity::COMPLAIN )
170
+
171
+ expect( @store.load('build/cache/.test.dep_cache.json')['entries'] ).to eq( {} )
172
+ end
173
+
174
+ it 'rebuilds once from the 1.2.2 build layout too' do
175
+ payload = JSON.generate(
176
+ 'schema_version' => 2, 'hash_algorithm' => DependencyHasher::HASH_ALGORITHM, 'entries' => { 'foo.o' => valid_entry }
177
+ )
178
+ stub_file( 'build/cache/.test.dep_cache.json', payload )
179
+
180
+ expect(@loginator).to receive(:log).with( /comes from an earlier Ceedling build layout/, Verbosity::COMPLAIN )
181
+
182
+ expect( @store.load('build/cache/.test.dep_cache.json')['entries'] ).to eq( {} )
130
183
  end
131
184
 
132
185
  it 'rebuilds once from an older build layout, advising clobber for what that layout left' do
@@ -390,6 +443,18 @@ describe DependencyCacheStore do
390
443
 
391
444
  @store.persist( '/build/dep_cache.json', {} )
392
445
  end
446
+
447
+ it "writes the schema version its pipeline gives" do
448
+ allow( @file_wrapper ).to receive(:dirname).and_return('/build')
449
+ allow( @file_wrapper ).to receive(:mkdir)
450
+ allow( @file_wrapper ).to receive(:mv)
451
+ written = nil
452
+ allow( @file_wrapper ).to receive(:write) { |_path, content| written = content }
453
+
454
+ @store.persist( '/build/.release.dep_cache.json', {}, schema_version: DependencyCacheStore::RELEASE_CACHE_SCHEMA_VERSION )
455
+
456
+ expect( JSON.parse( written )['schema_version'] ).to eq( DependencyCacheStore::RELEASE_CACHE_SCHEMA_VERSION )
457
+ end
393
458
  end
394
459
 
395
460
  end
@@ -127,6 +127,31 @@ describe DependencyTracker do
127
127
 
128
128
  expect( @tracker.stale?('foo.o') ).to be(true)
129
129
  end
130
+
131
+ def stub_cache(version)
132
+ cache_json = JSON.generate(
133
+ 'schema_version' => version,
134
+ 'hash_algorithm' => DependencyHasher::HASH_ALGORITHM,
135
+ 'entries' => { 'kept.o' => { 'self_hash' => 'a' * 64, 'meta_hash' => nil, 'deps' => {} } }
136
+ )
137
+ allow( @file_wrapper ).to receive(:exist?).with('cache.json').and_return(true)
138
+ allow( @file_wrapper ).to receive(:exist?).with('kept.o').and_return(true)
139
+ allow( @file_wrapper ).to receive(:read).with('cache.json').and_return( cache_json )
140
+ end
141
+
142
+ # A release build's layout changes apart from a test build's
143
+ it 'reads and writes a cache of the schema version its pipeline gives' do
144
+ stub_cache( 3 )
145
+ written = nil
146
+ allow( @file_wrapper ).to receive(:write) { |_path, content| written = content }
147
+
148
+ @tracker.open( store_path: 'cache.json', schema_version: 3 )
149
+ @tracker.flush
150
+
151
+ expect( JSON.parse( written )['schema_version'] ).to eq( 3 )
152
+ expect( JSON.parse( written )['entries'] ).to have_key( 'kept.o' )
153
+ end
154
+
130
155
  end
131
156
 
132
157
  # ── #register additive semantics ────────────────────────────────────────
@@ -7,6 +7,7 @@
7
7
 
8
8
  require 'spec_helper'
9
9
  require 'ceedling/dependencies/dependency_tracker'
10
+ require 'ceedling/dependencies/dependency_cache_store'
10
11
  require 'ceedling/dependencies/dependinator'
11
12
 
12
13
  describe Dependinator do
@@ -27,16 +28,30 @@ describe Dependinator do
27
28
  end
28
29
  end
29
30
 
31
+ # A release build's layout changes apart from a test build's
32
+ describe '.cache_schema_version' do
33
+ it "gives a release build's cache the release schema version" do
34
+ expect( Dependinator.cache_schema_version( :release ) ).to eq( DependencyCacheStore::RELEASE_CACHE_SCHEMA_VERSION )
35
+ end
36
+
37
+ it "gives every test pipeline's cache the test schema version" do
38
+ [:test, :gcov, :bullseye, :valgrind].each do |identifier|
39
+ expect( Dependinator.cache_schema_version( identifier ) ).to eq( DependencyCacheStore::CACHE_SCHEMA_VERSION ), identifier.to_s
40
+ end
41
+ end
42
+ end
43
+
30
44
  describe '#open' do
31
45
  it 'opens the tracker at a cache file identified by the default :test identifier when none is given' do
32
- expect( @tracker ).to receive(:open).with( store_path: '/proj/build/cache/.test.dep_cache.json' )
46
+ expect( @tracker ).to receive(:open).with( store_path: '/proj/build/cache/.test.dep_cache.json', schema_version: DependencyCacheStore::CACHE_SCHEMA_VERSION )
33
47
  @dependinator.open
34
48
  end
35
49
 
36
50
  it 'opens the tracker at a distinct cache file for a different identifier' do
37
- expect( @tracker ).to receive(:open).with( store_path: '/proj/build/cache/.release.dep_cache.json' )
51
+ expect( @tracker ).to receive(:open).with( store_path: '/proj/build/cache/.release.dep_cache.json', schema_version: DependencyCacheStore::RELEASE_CACHE_SCHEMA_VERSION )
38
52
  @dependinator.open( identifier: :release )
39
53
  end
54
+
40
55
  end
41
56
 
42
57
  describe '#register' do