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
@@ -7,16 +7,57 @@
7
7
 
8
8
  require 'spec_helper'
9
9
  require 'digest'
10
- require 'ceedling/file_wrapper'
10
+ require 'ceedling/filesystem/file_wrapper'
11
11
  require 'ceedling/dependencies/dependency_hasher'
12
12
 
13
13
  describe DependencyHasher do
14
14
 
15
15
  before(:each) do
16
16
  @file_wrapper = instance_double('FileWrapper')
17
+ # No file status by default, so every read below hashes afresh
18
+ allow( @file_wrapper ).to receive(:stat).and_return( nil )
17
19
  @hasher = described_class.new( { :file_wrapper => @file_wrapper } )
18
20
  end
19
21
 
22
+ # GH #1368: every test link hashes the libraries it links, so a large library was read
23
+ # once per test executable on every build
24
+ describe '#hash_of_file memo' do
25
+ def status(size, mtime)
26
+ return double( %q(File::Stat), size: size, mtime: mtime )
27
+ end
28
+
29
+ before(:each) do
30
+ allow( @file_wrapper ).to receive(:read_binary).with('libx.a').and_return('library')
31
+ end
32
+
33
+ it 'hashes a file left unchanged since before the build began only once' do
34
+ allow( @file_wrapper ).to receive(:stat).with('libx.a').and_return( status( 7, Time.now - 60 ) )
35
+
36
+ 2.times { expect( @hasher.hash_of_file('libx.a') ).to eq( Digest::SHA256.hexdigest('library') ) }
37
+
38
+ expect( @file_wrapper ).to have_received(:read_binary).once
39
+ end
40
+
41
+ it 'hashes again a file whose size or modification time changed' do
42
+ allow( @file_wrapper ).to receive(:stat).with('libx.a').and_return(
43
+ status( 7, Time.now - 60 ), status( 8, Time.now - 60 ), status( 8, Time.now - 50 )
44
+ )
45
+
46
+ 3.times { @hasher.hash_of_file('libx.a') }
47
+
48
+ expect( @file_wrapper ).to have_received(:read_binary).exactly(3).times
49
+ end
50
+
51
+ # A file the build writes can change within one timestamp tick, unseen by its status
52
+ it 'hashes afresh, every time, a file modified as the build began or since' do
53
+ allow( @file_wrapper ).to receive(:stat).with('libx.a').and_return( status( 7, Time.now ) )
54
+
55
+ 2.times { @hasher.hash_of_file('libx.a') }
56
+
57
+ expect( @file_wrapper ).to have_received(:read_binary).twice
58
+ end
59
+ end
60
+
20
61
  describe '#hash_of_file' do
21
62
  it 'returns the SHA-256 hex digest of the file content read via FileWrapper' do
22
63
  allow( @file_wrapper ).to receive(:read_binary).with('foo.c').and_return('int main(void) {}')
@@ -6,7 +6,7 @@
6
6
  # =========================================================================
7
7
 
8
8
  require 'spec_helper'
9
- require 'ceedling/file_wrapper'
9
+ require 'ceedling/filesystem/file_wrapper'
10
10
  require 'ceedling/dependencies/dependency_path_normalizer'
11
11
 
12
12
  describe DependencyPathNormalizer do
@@ -7,7 +7,7 @@
7
7
 
8
8
  require 'spec_helper'
9
9
  require 'ceedling/exceptions'
10
- require 'ceedling/file_wrapper'
10
+ require 'ceedling/filesystem/file_wrapper'
11
11
  require 'ceedling/system_wrapper'
12
12
  require 'ceedling/loginator'
13
13
  require 'ceedling/yaml_wrapper'
@@ -52,6 +52,8 @@ describe DependencyTracker do
52
52
  allow( @file_wrapper ).to receive(:mkdir)
53
53
  allow( @file_wrapper ).to receive(:write)
54
54
  allow( @file_wrapper ).to receive(:mv)
55
+ # No file status, so every hash reads its file afresh
56
+ allow( @file_wrapper ).to receive(:stat).and_return(nil)
55
57
  allow( @system_wrapper ).to receive(:env_get).with('CEEDLING_DEP_DEBUG').and_return(nil)
56
58
 
57
59
  hasher = DependencyHasher.new( { :file_wrapper => @file_wrapper } )
@@ -125,6 +127,31 @@ describe DependencyTracker do
125
127
 
126
128
  expect( @tracker.stale?('foo.o') ).to be(true)
127
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
+
128
155
  end
129
156
 
130
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
@@ -0,0 +1,170 @@
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/diagnostics/build_step_doctor'
11
+
12
+ describe BuildStepDoctor do
13
+
14
+ def specialist(*diagnoses)
15
+ double( 'specialist', diagnoses: diagnoses )
16
+ end
17
+
18
+ def doctor_with(*diagnoses, others: [])
19
+ @loginator = double( 'loginator' )
20
+ allow( @loginator ).to receive( :log )
21
+
22
+ described_class.new(
23
+ loginator: @loginator,
24
+ header_collision_specialist: specialist( *diagnoses ),
25
+ missing_symbol_specialist: specialist( *others ),
26
+ duplicate_symbol_specialist: specialist,
27
+ partial_name_specialist: specialist,
28
+ include_depth_specialist: specialist
29
+ )
30
+ end
31
+
32
+ def diagnosis(name, steps: [:compile], outcomes: [:failure], symptoms: /boom/, &examination)
33
+ BuildStepDoctor::Diagnosis.new(
34
+ name: name, steps: steps, outcomes: outcomes, symptoms: symptoms,
35
+ examination: examination || ->(_case) { "#{name} prescription" }
36
+ )
37
+ end
38
+
39
+ it 'logs a matching diagnosis\'s prescription at ERRORS as a notice and returns it' do
40
+ doctor = doctor_with( diagnosis( :first ) )
41
+
42
+ expect( doctor.diagnose( step: :compile, output: 'a boom here', inputs: {} ) ).to eq( ['first prescription'] )
43
+ expect( @loginator ).to have_received( :log ).with( 'first prescription', Verbosity::ERRORS, LogLabels::NOTICE )
44
+ end
45
+
46
+ it 'examines nothing when the symptoms are absent' do
47
+ examined = false
48
+ doctor = doctor_with( diagnosis( :quiet ) { |_case| examined = true; 'x' } )
49
+
50
+ expect( doctor.diagnose( step: :compile, output: 'all fine', inputs: {} ) ).to eq( [] )
51
+ expect( examined ).to be false
52
+ expect( @loginator ).not_to have_received( :log )
53
+ end
54
+
55
+ it 'examines only diagnoses for the case\'s step' do
56
+ doctor = doctor_with( diagnosis( :compiling ), diagnosis( :linking, steps: [:link] ) )
57
+
58
+ expect( doctor.diagnose( step: :link, output: 'boom', inputs: {} ) ).to eq( ['linking prescription'] )
59
+ end
60
+
61
+ it 'examines only diagnoses for the case\'s outcome' do
62
+ doctor = doctor_with( diagnosis( :failing ), diagnosis( :warning, outcomes: [:warning] ) )
63
+
64
+ expect( doctor.diagnose( step: :compile, outcome: :warning, output: 'boom', inputs: {} ) ).to eq( ['warning prescription'] )
65
+ end
66
+
67
+ it 'prescribes for every matching diagnosis, across specialists, in registration order' do
68
+ doctor = doctor_with( diagnosis( :one ), diagnosis( :two ), others: [diagnosis( :three )] )
69
+
70
+ expect( doctor.diagnose( step: :compile, output: 'boom', inputs: {} ) ).to eq(
71
+ ['one prescription', 'two prescription', 'three prescription']
72
+ )
73
+ end
74
+
75
+ it 'matches when any of several symptoms appears' do
76
+ doctor = doctor_with( diagnosis( :either, symptoms: [/gcc wording/, /iar wording/] ) )
77
+
78
+ expect( doctor.diagnose( step: :compile, output: 'Error[Pe101]: iar wording', inputs: {} ) ).to eq( ['either prescription'] )
79
+ end
80
+
81
+ it 'hands the examination a case holding the step, outcome, output, symptom match, and inputs' do
82
+ seen = nil
83
+ doctor = doctor_with( diagnosis( :curious, symptoms: /b(o+)m/ ) { |kase| seen = kase; nil } )
84
+
85
+ doctor.diagnose( step: :compile, output: 'a boom', inputs: { source: 'a.c' } )
86
+
87
+ expect( seen.step ).to eq( :compile )
88
+ expect( seen.outcome ).to eq( :failure )
89
+ expect( seen.output ).to eq( 'a boom' )
90
+ expect( seen.symptoms[1] ).to eq( 'oo' )
91
+ expect( seen.inputs ).to eq( { source: 'a.c' } )
92
+ end
93
+
94
+ it 'accepts an examination that prescribes nothing, one prescription, or several' do
95
+ doctor = doctor_with(
96
+ diagnosis( :none ) { |_case| nil },
97
+ diagnosis( :one ) { |_case| 'single' },
98
+ diagnosis( :many ) { |_case| ['first', 'second'] }
99
+ )
100
+
101
+ expect( doctor.diagnose( step: :compile, output: 'boom', inputs: {} ) ).to eq( ['single', 'first', 'second'] )
102
+ expect( @loginator ).to have_received( :log ).with( anything, Verbosity::ERRORS, LogLabels::NOTICE ).exactly( 3 ).times
103
+ end
104
+
105
+ it 'goes on to the other diagnoses when an examination raises, logging the error at DEBUG' do
106
+ doctor = doctor_with( diagnosis( :broken ) { |_case| raise 'examination bug' }, diagnosis( :sound ) )
107
+
108
+ expect( doctor.diagnose( step: :compile, output: 'boom', inputs: {} ) ).to eq( ['sound prescription'] )
109
+ expect( @loginator ).to have_received( :log ).with( a_string_including( 'broken', 'examination bug' ), Verbosity::DEBUG )
110
+ end
111
+
112
+ it 'refuses a diagnosis for an unknown step' do
113
+ expect { doctor_with( diagnosis( :typo, steps: [:compiel] ) ) }.to raise_error( ::ArgumentError, /compiel/ )
114
+ end
115
+
116
+ it 'refuses a diagnosis for an unknown outcome' do
117
+ expect { doctor_with( diagnosis( :typo, outcomes: [:fail] ) ) }.to raise_error( ::ArgumentError, /fail/ )
118
+ end
119
+
120
+ it 'refuses to diagnose an unknown step or outcome' do
121
+ doctor = doctor_with( diagnosis( :fine ) )
122
+
123
+ expect { doctor.diagnose( step: :linking, output: 'boom', inputs: {} ) }.to raise_error( ::ArgumentError, /linking/ )
124
+ expect { doctor.diagnose( step: :link, outcome: :error, output: 'boom', inputs: {} ) }.to raise_error( ::ArgumentError, /error/ )
125
+ end
126
+
127
+ it 'treats missing output as no symptoms' do
128
+ doctor = doctor_with( diagnosis( :any ) )
129
+
130
+ expect( doctor.diagnose( step: :compile, output: nil, inputs: {} ) ).to eq( [] )
131
+ end
132
+
133
+ describe '#attend' do
134
+ def tool_failure(output)
135
+ ShellException.new( shell_result: { exit_code: 1, output: output }, name: 'gcc' )
136
+ end
137
+
138
+ it 'returns what the step returns and diagnoses nothing when it succeeds' do
139
+ doctor = doctor_with( diagnosis( :any ) )
140
+
141
+ expect( doctor.attend( step: :compile, inputs: {} ) { :built } ).to eq( :built )
142
+ expect( @loginator ).not_to have_received( :log )
143
+ end
144
+
145
+ it 'diagnoses a tool failure with its output and the step and inputs given, then raises the same failure' do
146
+ seen = nil
147
+ doctor = doctor_with( diagnosis( :curious, steps: [:preprocess] ) { |kase| seen = kase; 'guidance' } )
148
+ failure = tool_failure( 'a boom' )
149
+
150
+ expect { doctor.attend( step: :preprocess, inputs: { source: 'a.c' } ) { raise failure } }.to raise_error( failure )
151
+ expect( [seen.step, seen.output, seen.inputs] ).to eq( [:preprocess, 'a boom', { source: 'a.c' }] )
152
+ expect( @loginator ).to have_received( :log ).with( 'guidance', Verbosity::ERRORS, LogLabels::NOTICE )
153
+ end
154
+
155
+ it 'refuses an unknown step before running the step' do
156
+ doctor = doctor_with( diagnosis( :any ) )
157
+ ran = false
158
+
159
+ expect { doctor.attend( step: :preprocces, inputs: {} ) { ran = true } }.to raise_error( ::ArgumentError, /preprocces/ )
160
+ expect( ran ).to be false
161
+ end
162
+
163
+ it 'leaves any other error undiagnosed' do
164
+ doctor = doctor_with( diagnosis( :any ) )
165
+
166
+ expect { doctor.attend( step: :compile, inputs: {} ) { raise 'boom' } }.to raise_error( RuntimeError, 'boom' )
167
+ expect( @loginator ).not_to have_received( :log )
168
+ end
169
+ end
170
+ end
@@ -0,0 +1,117 @@
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/diagnostics/build_step_doctor'
12
+ require 'ceedling/diagnostics/duplicate_symbol_specialist'
13
+
14
+ describe DuplicateSymbolSpecialist do
15
+ before(:each) do
16
+ @configurator = double( 'configurator', cmock_mock_prefix: 'mock_', extension_object: FilenameExtension.new( '.o' ) )
17
+ allow( @configurator ).to receive( :project_use_mocks ).and_return( true )
18
+
19
+ @loginator = double( 'loginator' )
20
+ allow( @loginator ).to receive( :log )
21
+
22
+ nobody = double( 'specialist', diagnoses: [] )
23
+
24
+ @doctor = BuildStepDoctor.new(
25
+ loginator: @loginator, header_collision_specialist: nobody, missing_symbol_specialist: nobody,
26
+ duplicate_symbol_specialist: described_class.new( configurator: @configurator ), partial_name_specialist: nobody,
27
+ include_depth_specialist: nobody
28
+ ).tap( &:setup )
29
+ end
30
+
31
+ def prescriptions(output, objects: ['build/out/a_test.o', 'build/out/gpio.o'], step: :link)
32
+ @doctor.diagnose( step: step, output: output, inputs: { objects: objects } )
33
+ end
34
+
35
+ GNU_DUPLICATE = "/usr/bin/ld: build/out/gpio.o: in function `gpio_init':\n" \
36
+ "gpio.c:(.text+0x0): multiple definition of `gpio_init'; build/out/a_test.o:a_test.c:(.text+0x0): first defined here\n"
37
+
38
+ {
39
+ 'GNU ld' => GNU_DUPLICATE,
40
+ 'LLD' => "ld.lld: error: duplicate symbol: gpio_init\n>>> defined at gpio.c\n",
41
+ 'Apple ld' => "duplicate symbol '_gpio_init' in:\n build/out/a_test.o\n build/out/gpio.o\n",
42
+ 'MSVC' => "gpio.obj : error LNK2005: gpio_init already defined in a_test.obj\n",
43
+ 'MSVC, summarized' => "a_test.exe : fatal error LNK1169: one or more multiply defined symbols found\n",
44
+ 'IAR ILINK' => "Error[Li006]: duplicate definitions for \"gpio_init\"; in \"gpio.o\", and \"a_test.o\"\n",
45
+ 'Arm armlink' => "Error: L6200E: Symbol gpio_init multiply defined (by gpio.o and a_test.o).\n",
46
+ 'TI' => "error #10056: symbol \"gpio_init\" redefined: first defined in \"a_test.obj\"; redefined in \"gpio.obj\"\n",
47
+ 'other linkers, generically' => "?ASlink-Error-Multiple definition of _gpio_init\n"
48
+ }.each do |family, output|
49
+ it "recognizes #{family}" do
50
+ expect( prescriptions( output ).size ).to eq( 1 )
51
+ end
52
+ end
53
+
54
+ context 'without mocks' do
55
+ before(:each) { allow( @configurator ).to receive( :project_use_mocks ).and_return( false ) }
56
+
57
+ it 'leaves out the mock cause and option, and names the setting a mock remedy needs' do
58
+ notice = prescriptions( GNU_DUPLICATE ).first
59
+
60
+ expect( notice ).not_to include( '• A mock defines', "4. Don't #include both" )
61
+ expect( notice ).to include( "or mock the source's header instead. Mocking requires :project ↳ :use_mocks.\n" )
62
+ end
63
+ end
64
+
65
+ it 'prescribes nothing for a missing symbol' do
66
+ expect( prescriptions( "undefined reference to `gpio_init'\n" ) ).to eq( [] )
67
+ end
68
+
69
+ it 'covers only linking' do
70
+ expect( prescriptions( GNU_DUPLICATE, step: :compile ) ).to eq( [] )
71
+ end
72
+
73
+ it 'opens tentatively and gives the general causes, education, and options, left-justified' do
74
+ notice = prescriptions( GNU_DUPLICATE ).first
75
+
76
+ expect( notice ).to start_with( "The linker output appears to report a symbol defined more than once.\n\nHOW THIS HAPPENS:\n" )
77
+ expect( notice ).to include(
78
+ "• A program may define each function and each global variable only once across all its object files.\n",
79
+ "• A definition in a header, a function body or a variable without extern, is repeated in every source that #includes the header.\n",
80
+ "\n\nOPTIONS:\n1. Declare header variables extern, and define each one in a single source file.\n",
81
+ "4. Don't #include both a mock and its real header in one test and don't name a mocked module's source in TEST_SOURCE_FILE().\n"
82
+ )
83
+ expect( notice.lines.grep( /\A\s/ ) ).to eq( ["\n", "\n"] )
84
+ end
85
+
86
+ context 'with a mock and the source it stands in for both linked' do
87
+ let(:objects) { ['build/out/a_test.o', 'build/out/mock_gpio.o', 'build/out/gpio.o'] }
88
+
89
+ it 'names the pair as the likely cause' do
90
+ output = "/usr/bin/ld: build/out/gpio.o: in function `gpio_init':\n" \
91
+ "multiple definition of `gpio_init'; build/out/mock_gpio.o:(.text+0x0): first defined here\n"
92
+
93
+ expect( prescriptions( output, objects: objects ).first ).to start_with(
94
+ "The linker output appears to report a symbol defined more than once. " \
95
+ "This test links both 'mock_gpio.o' and 'gpio.o', which may define the same functions.\n\n"
96
+ )
97
+ end
98
+
99
+ it 'names the pair from the linked objects when the output names no object' do
100
+ output = "ld.lld: error: duplicate symbol: gpio_init\n"
101
+
102
+ expect( prescriptions( output, objects: objects ).first ).to include( "links both 'mock_gpio.o' and 'gpio.o'" )
103
+ end
104
+
105
+ it 'leaves the pair out when the project does not use mocks' do
106
+ allow( @configurator ).to receive( :project_use_mocks ).and_return( false )
107
+
108
+ expect( prescriptions( "ld.lld: error: duplicate symbol: gpio_init\n", objects: objects ).first ).not_to include( 'links both' )
109
+ end
110
+
111
+ it 'leaves the pair out when the output names other objects' do
112
+ output = "multiple definition of `helper'; build/out/a_test.o:(.text+0x0): first defined here; build/out/util.o\n"
113
+
114
+ expect( prescriptions( output, objects: objects + ['build/out/util.o'] ).first ).not_to include( 'links both' )
115
+ end
116
+ end
117
+ end