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.
- checksums.yaml +4 -4
- data/GIT_COMMIT_SHA +1 -1
- data/README.md +1 -1
- data/assets/fixtures/tests_with_partials_coverage/src/private_macro.c +7 -0
- data/assets/fixtures/tests_with_partials_coverage/src/private_macro.h +5 -0
- data/assets/fixtures/tests_with_partials_coverage/src/tally.c +13 -0
- data/assets/fixtures/tests_with_partials_coverage/src/tally.h +4 -0
- data/assets/fixtures/tests_with_partials_coverage/test/test_private_macro.c +10 -0
- data/assets/fixtures/tests_with_partials_coverage/test/test_tally.c +9 -0
- data/docs/BreakingChanges.md +16 -0
- data/docs/Changelog.md +71 -0
- data/docs/KnownIssues.md +91 -4
- data/examples/wondrous_forest/README.md +29 -1
- data/examples/wondrous_forest/src/ForestUnits.h +23 -0
- data/examples/wondrous_forest/src/RainGauge.c +59 -0
- data/examples/wondrous_forest/src/RainGauge.h +39 -0
- data/examples/wondrous_forest/src/RainTipIsr.c +17 -0
- data/examples/wondrous_forest/src/RainTipIsr.h +14 -0
- data/examples/wondrous_forest/test/TestRainGauge.c +126 -0
- data/lib/ceedling/c_extractor/README.md +15 -7
- data/lib/ceedling/c_extractor/c_extractor.rb +25 -14
- data/lib/ceedling/c_extractor/c_extractor_code_text.rb +84 -54
- data/lib/ceedling/c_extractor/c_extractor_constants.rb +18 -7
- data/lib/ceedling/c_extractor/c_extractor_declarations.rb +319 -283
- data/lib/ceedling/c_extractor/c_extractor_declarator.rb +285 -0
- data/lib/ceedling/c_extractor/c_extractor_defined_type.rb +111 -0
- data/lib/ceedling/c_extractor/c_extractor_definitions.rb +174 -121
- data/lib/ceedling/c_extractor/c_extractor_functions.rb +191 -162
- data/lib/ceedling/c_extractor/c_extractor_preprocessing.rb +46 -55
- data/lib/ceedling/c_extractor/c_extractor_statement.rb +30 -0
- data/lib/ceedling/c_extractor/c_extractor_types.rb +63 -41
- data/lib/ceedling/c_extractor/c_module_edits.rb +48 -0
- data/lib/ceedling/c_identifier.rb +21 -0
- data/lib/ceedling/ceedling.h +8 -0
- data/lib/ceedling/config/configurator.rb +4 -3
- data/lib/ceedling/config/configurator_builder.rb +17 -0
- data/lib/ceedling/config/configurator_setup.rb +29 -5
- data/lib/ceedling/constants.rb +5 -1
- data/lib/ceedling/defaults.rb +31 -1
- data/lib/ceedling/dependencies/CACHE_SCHEMA.md +118 -0
- data/lib/ceedling/dependencies/README.md +1 -1
- data/lib/ceedling/dependencies/dependency_cache_store.rb +30 -25
- data/lib/ceedling/dependencies/dependency_tracker.rb +9 -3
- data/lib/ceedling/dependencies/dependinator.rb +13 -1
- data/lib/ceedling/diagnostics/DOCTOR.md +142 -0
- data/lib/ceedling/diagnostics/README.md +5 -0
- data/lib/ceedling/diagnostics/build_step_doctor.rb +110 -0
- data/lib/ceedling/diagnostics/duplicate_symbol_specialist.rb +108 -0
- data/lib/ceedling/diagnostics/guidance_phrases.rb +30 -0
- data/lib/ceedling/diagnostics/header_collision_guidance.rb +56 -0
- data/lib/ceedling/diagnostics/header_collision_specialist.rb +152 -0
- data/lib/ceedling/diagnostics/include_depth_specialist.rb +132 -0
- data/lib/ceedling/diagnostics/missing_symbol_specialist.rb +111 -0
- data/lib/ceedling/diagnostics/partial_name_specialist.rb +134 -0
- data/lib/ceedling/diagnostics/toolchain_output.rb +44 -0
- data/lib/ceedling/filesystem/PATH_HANDLING.md +83 -27
- data/lib/ceedling/filesystem/README.md +6 -1
- data/lib/ceedling/filesystem/build_roots.rb +105 -0
- data/lib/ceedling/filesystem/build_subpath.rb +110 -25
- data/lib/ceedling/filesystem/file_finder.rb +76 -110
- data/lib/ceedling/filesystem/file_finder_helper.rb +33 -11
- data/lib/ceedling/filesystem/file_path_utils.rb +113 -91
- data/lib/ceedling/filesystem/file_wrapper.rb +105 -28
- data/lib/ceedling/filesystem/path_matcher.rb +21 -0
- data/lib/ceedling/filesystem/test_build_layout.rb +114 -0
- data/lib/ceedling/filesystem/win_long_paths.rb +153 -0
- data/lib/ceedling/filesystem/win_path_limit.rb +83 -0
- data/lib/ceedling/filesystem/win_path_prober.rb +52 -0
- data/lib/ceedling/generators/generator.rb +27 -64
- data/lib/ceedling/generators/generator_helper.rb +0 -44
- data/lib/ceedling/generators/generator_mocks.rb +5 -0
- data/lib/ceedling/generators/generator_partials.rb +305 -243
- data/lib/ceedling/generators/generator_test_runner.rb +5 -8
- data/lib/ceedling/generators/partial_header_writer.rb +95 -0
- data/lib/ceedling/generators/partial_source_writer.rb +137 -0
- data/lib/ceedling/includes/header_search.rb +225 -0
- data/lib/ceedling/includes/include_factory.rb +9 -12
- data/lib/ceedling/includes/include_pathinator.rb +53 -31
- data/lib/ceedling/includes/includes.rb +149 -37
- data/lib/ceedling/objects.yml +89 -4
- data/lib/ceedling/partials/README.md +110 -16
- data/lib/ceedling/partials/carry_plan.rb +71 -0
- data/lib/ceedling/partials/definition_head.rb +74 -0
- data/lib/ceedling/partials/include_groups.rb +37 -0
- data/lib/ceedling/partials/interface_extras.rb +25 -0
- data/lib/ceedling/partials/partializer.rb +599 -120
- data/lib/ceedling/partials/partializer_config.rb +5 -0
- data/lib/ceedling/partials/partializer_helper.rb +851 -145
- data/lib/ceedling/partials/partializer_reconciler.rb +174 -0
- data/lib/ceedling/partials/partializer_utils.rb +89 -109
- data/lib/ceedling/partials/partials.rb +153 -10
- data/lib/ceedling/partials/type_macros.rb +126 -0
- data/lib/ceedling/preprocess/README.md +43 -33
- data/lib/ceedling/preprocess/preprocessinator.rb +100 -186
- data/lib/ceedling/preprocess/preprocessinator_code_finder.rb +65 -72
- data/lib/ceedling/preprocess/preprocessinator_file_assembler.rb +31 -75
- data/lib/ceedling/preprocess/preprocessinator_reconstructor.rb +51 -14
- data/lib/ceedling/setupinator.rb +16 -3
- data/lib/ceedling/test_invoker/HEADER_COLLISIONS.md +21 -7
- data/lib/ceedling/test_invoker/PIPELINE.md +57 -16
- data/lib/ceedling/test_invoker/README.md +1 -1
- data/lib/ceedling/test_invoker/derived_search_path_notices.rb +45 -0
- data/lib/ceedling/test_invoker/mock_locator.rb +116 -9
- data/lib/ceedling/test_invoker/partial_files_preprocessinator.rb +181 -0
- data/lib/ceedling/test_invoker/partials_manager.rb +265 -308
- data/lib/ceedling/test_invoker/standin_headerinator.rb +8 -15
- data/lib/ceedling/test_invoker/test_bare_includes_extractinator.rb +26 -3
- data/lib/ceedling/test_invoker/test_build_executor.rb +338 -198
- data/lib/ceedling/test_invoker/test_build_planner.rb +13 -19
- data/lib/ceedling/test_invoker/test_build_setup.rb +26 -6
- data/lib/ceedling/test_invoker/test_build_validations.rb +23 -20
- data/lib/ceedling/test_invoker/test_derived_search_paths.rb +189 -0
- data/lib/ceedling/test_invoker/test_file_preprocessinator.rb +1 -2
- data/lib/ceedling/test_invoker/test_includes_reconcilinator.rb +1 -1
- data/lib/ceedling/test_invoker/test_invoker_types.rb +28 -20
- data/lib/ceedling/test_invoker/test_pipeline_helpers.rb +5 -3
- data/lib/ceedling/test_invoker/test_pipeline_manager.rb +25 -8
- data/lib/ceedling/test_invoker/test_runner_generatinator.rb +31 -3
- data/lib/ceedling/test_invoker/test_search_paths.rb +30 -8
- data/lib/ceedling/test_invoker/test_substitutions.rb +72 -0
- data/lib/ceedling/tools/shell_quoting.rb +45 -0
- data/lib/ceedling/tools/tool_quoting.rb +79 -0
- data/lib/ceedling/{tool_validator.rb → tools/tool_validator.rb} +18 -7
- data/lib/version.rb +1 -1
- data/plugins/bullseye/bullseye.rake +1 -3
- data/plugins/bullseye/lib/bullseye.rb +15 -2
- data/plugins/command_hooks/lib/command_hooks.rb +1 -1
- data/plugins/fff/lib/fff.rb +42 -15
- data/plugins/fff/lib/fff_mock_generator.rb +12 -9
- data/plugins/fff/spec/fff_cmock_wrapper_spec.rb +134 -0
- data/plugins/fff/spec/fff_mock_header_generator_spec.rb +9 -0
- data/plugins/fff/spec/fff_mock_source_generator_spec.rb +20 -0
- data/plugins/gcov/lib/console_reportinator.rb +25 -19
- data/plugins/gcov/lib/reportgenerator_reportinator.rb +2 -1
- data/site-local/404.html +2 -2
- data/site-local/assets/javascripts/{bundle.c21346df.min.js → bundle.a5f9d56c.min.js} +1 -1
- data/site-local/assets/javascripts/{bundle.c21346df.min.js.map → bundle.a5f9d56c.min.js.map} +2 -2
- data/site-local/configuration/environment-vars.html +2 -2
- data/site-local/configuration/global-collections.html +3 -3
- data/site-local/configuration/index.html +2 -2
- data/site-local/configuration/loading.html +2 -2
- data/site-local/configuration/mixins.html +2 -2
- data/site-local/configuration/parallel-builds.html +2 -2
- data/site-local/configuration/project-file.html +2 -2
- data/site-local/configuration/reference/cexception.html +2 -2
- data/site-local/configuration/reference/cmock.html +5 -2
- data/site-local/configuration/reference/defines.html +2 -2
- data/site-local/configuration/reference/environment.html +2 -2
- data/site-local/configuration/reference/extension.html +2 -2
- data/site-local/configuration/reference/files.html +56 -9
- data/site-local/configuration/reference/flags.html +2 -2
- data/site-local/configuration/reference/index.html +2 -2
- data/site-local/configuration/reference/libraries.html +2 -2
- data/site-local/configuration/reference/mixins.html +2 -2
- data/site-local/configuration/reference/partials.html +84 -2
- data/site-local/configuration/reference/paths.html +7 -2
- data/site-local/configuration/reference/plugins.html +2 -2
- data/site-local/configuration/reference/project.html +247 -5
- data/site-local/configuration/reference/release-build.html +2 -2
- data/site-local/configuration/reference/test-build.html +2 -2
- data/site-local/configuration/reference/test-runner.html +2 -2
- data/site-local/configuration/reference/tools.html +49 -4
- data/site-local/configuration/reference/unity.html +2 -2
- data/site-local/configuration/which-ceedling.html +2 -2
- data/site-local/development/index.html +2 -2
- data/site-local/development/plugins/configuration.html +2 -2
- data/site-local/development/plugins/index.html +2 -2
- data/site-local/development/plugins/plugin-subclass.html +5 -4
- data/site-local/development/plugins/rake-tasks.html +2 -2
- data/site-local/development/releases.html +2 -2
- data/site-local/development/workflow.html +2 -2
- data/site-local/getting-started/builds.html +2 -2
- data/site-local/getting-started/command-line.html +2 -2
- data/site-local/getting-started/example-projects/cipher-quest.html +2 -2
- data/site-local/getting-started/example-projects/index.html +2 -2
- data/site-local/getting-started/example-projects/temp-sensor.html +2 -2
- data/site-local/getting-started/example-projects/wondrous-forest.html +10 -2
- data/site-local/getting-started/index.html +2 -2
- data/site-local/getting-started/installation.html +2 -2
- data/site-local/getting-started/quick-start.html +2 -2
- data/site-local/help.html +2 -2
- data/site-local/index.html +2 -2
- data/site-local/overview/build-system.html +2 -2
- data/site-local/overview/index.html +2 -2
- data/site-local/overview/test-environments.html +2 -2
- data/site-local/overview/tools-and-frameworks.html +2 -2
- data/site-local/plugins/beep.html +2 -2
- data/site-local/plugins/bullseye/index.html +45 -38
- data/site-local/plugins/bullseye/licensing.html +2 -2
- data/site-local/plugins/command-hooks.html +4 -4
- data/site-local/plugins/compile-commands-json-db.html +2 -2
- data/site-local/plugins/cppcheck.html +2 -2
- data/site-local/plugins/dependencies.html +2 -2
- data/site-local/plugins/fff.html +16 -2
- data/site-local/plugins/gcov/examples.html +2 -2
- data/site-local/plugins/gcov/gcovr.html +8 -2
- data/site-local/plugins/gcov/index.html +2 -2
- data/site-local/plugins/gcov/overview.html +2 -2
- data/site-local/plugins/gcov/reportgenerator.html +18 -14
- data/site-local/plugins/gcov/reporting.html +2 -2
- data/site-local/plugins/gcov/setup.html +2 -2
- data/site-local/plugins/gcov/tool-versions.html +2 -2
- data/site-local/plugins/gcov/troubleshooting.html +2 -2
- data/site-local/plugins/index.html +2 -2
- data/site-local/plugins/module-generator.html +2 -2
- data/site-local/plugins/report-build-warnings-log.html +2 -2
- data/site-local/plugins/report-tests-gtestlike-stdout.html +2 -2
- data/site-local/plugins/report-tests-ide-stdout.html +2 -2
- data/site-local/plugins/report-tests-log-factory.html +2 -2
- data/site-local/plugins/report-tests-pretty-stdout.html +2 -2
- data/site-local/plugins/report-tests-raw-output-log.html +2 -2
- data/site-local/plugins/report-tests-teamcity-stdout.html +2 -2
- data/site-local/plugins/sanitize.html +2 -2
- data/site-local/plugins/valgrind.html +2 -2
- data/site-local/project/index.html +2 -2
- data/site-local/project/release-history.html +2 -2
- data/site-local/project/sbom.html +2 -2
- data/site-local/project/upgrade.html +2 -2
- data/site-local/reference/build-directives.html +2 -2
- data/site-local/reference/command-line.html +2 -2
- data/site-local/reference/environment-vars.html +2 -2
- data/site-local/reference/gcov-plugin.html +2 -2
- data/site-local/reference/global-collections.html +12 -12
- data/site-local/reference/index.html +2 -2
- data/site-local/reference/partials-macros.html +47 -2
- data/site-local/reference/project-configuration.html +2 -2
- data/site-local/sitemap.xml.gz +0 -0
- data/site-local/snapshot/examples/cipher_quest/index.html +2 -2
- data/site-local/snapshot/examples/temp_sensor/index.html +2 -2
- data/site-local/snapshot/examples/wondrous_forest/index.html +72 -15
- data/site-local/testing-guide/build-directives.html +2 -2
- data/site-local/testing-guide/conventions.html +67 -22
- data/site-local/testing-guide/frameworks.html +2 -2
- data/site-local/testing-guide/index.html +2 -2
- data/site-local/testing-guide/partials/configuration.html +31 -4
- data/site-local/testing-guide/partials/conventions.html +509 -8
- data/site-local/testing-guide/partials/directives.html +4 -3
- data/site-local/testing-guide/partials/example.html +2 -2
- data/site-local/testing-guide/partials/index.html +2 -2
- data/site-local/testing-guide/partials/overview.html +30 -12
- data/site-local/testing-guide/partials/variables.html +169 -4
- data/site-local/testing-guide/test-cases.html +2 -2
- data/site-local/testing-guide/test-sample.html +2 -2
- data/site-local/testing-guide/test-suite-anatomy.html +2 -2
- data/spec/integration/build_step_doctor_spec.rb +270 -0
- data/spec/integration/c_extractor_composition_spec.rb +254 -4
- data/spec/integration/includes_extraction_spec.rb +27 -14
- data/spec/integration/nested_test_artifacts_spec.rb +1 -1
- data/spec/integration/partial_files_preprocessing_spec.rb +128 -0
- data/spec/integration/partials_carry_spec.rb +520 -0
- data/spec/integration/partials_declarations_spec.rb +655 -0
- data/spec/integration/partials_fallback_preprocessing_spec.rb +65 -0
- data/spec/integration/partials_function_pointers_spec.rb +277 -0
- data/spec/integration/partials_header_composition_spec.rb +268 -35
- data/spec/integration/partials_macro_decorators_spec.rb +267 -0
- data/spec/integration/partials_module_resolution_spec.rb +26 -19
- data/spec/integration/partials_symbol_linkage_spec.rb +13 -0
- data/spec/integration/path_length_reporting_spec.rb +64 -0
- data/spec/integration/path_scenarios_spec.rb +80 -3
- data/spec/integration/quote_include_isolator_spec.rb +56 -0
- data/spec/integration/test_build_parallel_barrier_spec.rb +1 -1
- data/spec/integration/test_includes_extractinator_spec.rb +70 -5
- data/spec/integration/test_naming_spec.rb +6 -3
- data/spec/integration/test_source_file_checks_spec.rb +5 -3
- data/spec/integration/tool_executor_spec.rb +1 -1
- data/spec/integration/tool_validator_spec.rb +2 -2
- data/spec/integration/win_long_paths_probe_spec.rb +46 -0
- data/spec/integration/win_path_limit_spec.rb +53 -0
- data/spec/integration/windows_registry_query_tool_spec.rb +41 -0
- data/spec/support/integration/configurator_integration_helper.rb +8 -3
- data/spec/support/integration/partial_files_harness.rb +181 -0
- data/spec/support/integration/partials_generation_integration_helper.rb +237 -141
- data/spec/support/integration/path_scenario_harness.rb +4 -2
- data/spec/support/integration/spec_integration_helper.rb +8 -3
- data/spec/support/integration/test_includes_harness.rb +56 -35
- data/spec/support/integration/tool_executor_integration_helper.rb +14 -2
- data/spec/system/bullseye_deployment_spec.rb +2 -0
- data/spec/system/delta_builds_spec.rb +26 -12
- data/spec/system/encoding_stress_spec.rb +4 -4
- data/spec/system/example_wondrous_forest_spec.rb +2 -2
- data/spec/system/gcov_deployment_spec.rb +2 -0
- data/spec/system/header_include_path_validation_spec.rb +4 -4
- data/spec/system/header_search_paths_spec.rb +1083 -0
- data/spec/system/mock_include_folders_spec.rb +121 -0
- data/spec/system/mockable_header_reassembly_spec.rb +184 -0
- data/spec/system/partials_carry_spec.rb +581 -0
- data/spec/system/partials_delta_builds_spec.rb +280 -0
- data/spec/system/partials_function_pointers_spec.rb +106 -0
- data/spec/system/partials_macro_decorators_spec.rb +127 -0
- data/spec/system/partials_module_disambiguation_spec.rb +125 -0
- data/spec/system/path_handling_probes_spec.rb +16 -12
- data/spec/system/pinned_thread_count_spec.rb +4 -4
- data/spec/system/preprocessing_fallback_conditionals_spec.rb +1 -1
- data/spec/system/short_build_paths_spec.rb +87 -0
- data/spec/system/sibling_header_collision_spec.rb +30 -6
- data/spec/system/support/bullseye_common_test_cases.rb +42 -0
- data/spec/system/support/common_test_cases.rb +2 -2
- data/spec/system/support/gcov_partials_test_cases.rb +48 -0
- data/spec/system/test_build_layout_spec.rb +209 -0
- data/spec/system/test_source_file_directive_spec.rb +35 -5
- data/spec/units/c_extractor/c_extractor_code_text_spec.rb +67 -10
- data/spec/units/c_extractor/c_extractor_declarations_spec.rb +501 -4
- data/spec/units/c_extractor/c_extractor_declarator_spec.rb +245 -0
- data/spec/units/c_extractor/c_extractor_defined_type_spec.rb +45 -0
- data/spec/units/c_extractor/c_extractor_definitions_spec.rb +163 -3
- data/spec/units/c_extractor/c_extractor_functions_spec.rb +462 -21
- data/spec/units/c_extractor/c_extractor_preprocessing_spec.rb +39 -0
- data/spec/units/c_extractor/c_extractor_spec.rb +4 -4
- data/spec/units/c_extractor/c_extractor_types_spec.rb +163 -0
- data/spec/units/c_identifier_spec.rb +35 -0
- data/spec/units/config/configurator_builder_spec.rb +24 -0
- data/spec/units/config/configurator_setup_spec.rb +72 -4
- data/spec/units/config/configurator_spec.rb +27 -1
- data/spec/units/dependencies/dependency_cache_store_spec.rb +68 -3
- data/spec/units/dependencies/dependency_tracker_spec.rb +25 -0
- data/spec/units/dependencies/dependinator_spec.rb +17 -2
- data/spec/units/diagnostics/build_step_doctor_spec.rb +170 -0
- data/spec/units/diagnostics/duplicate_symbol_specialist_spec.rb +117 -0
- data/spec/units/diagnostics/header_collision_specialist_spec.rb +267 -0
- data/spec/units/diagnostics/include_depth_specialist_spec.rb +137 -0
- data/spec/units/diagnostics/missing_symbol_specialist_spec.rb +154 -0
- data/spec/units/diagnostics/partial_name_specialist_spec.rb +129 -0
- data/spec/units/diagnostics/toolchain_output_spec.rb +86 -0
- data/spec/units/encodinator_spec.rb +3 -4
- data/spec/units/filesystem/build_roots_spec.rb +131 -0
- data/spec/units/filesystem/build_subpath_spec.rb +113 -0
- data/spec/units/filesystem/file_finder_helper_spec.rb +80 -0
- data/spec/units/filesystem/file_finder_spec.rb +242 -58
- data/spec/units/filesystem/file_path_utils_spec.rb +251 -118
- data/spec/units/filesystem/file_wrapper_spec.rb +191 -6
- data/spec/units/filesystem/path_matcher_spec.rb +36 -0
- data/spec/units/filesystem/test_build_layout_spec.rb +216 -0
- data/spec/units/filesystem/win_long_paths_spec.rb +204 -0
- data/spec/units/filesystem/win_path_prober_spec.rb +158 -0
- data/spec/units/generators/generator_helper_spec.rb +0 -60
- data/spec/units/generators/generator_mocks_spec.rb +13 -0
- data/spec/units/generators/generator_partials_spec.rb +656 -55
- data/spec/units/generators/generator_spec.rb +26 -0
- data/spec/units/generators/generator_test_runner_spec.rb +9 -5
- data/spec/units/generators/partial_source_writer_spec.rb +129 -0
- data/spec/units/includes/header_search_spec.rb +406 -0
- data/spec/units/includes/include_factory_spec.rb +22 -5
- data/spec/units/includes/include_pathinator_spec.rb +77 -13
- data/spec/units/includes/include_spec.rb +14 -0
- data/spec/units/includes/includes_spec.rb +176 -19
- data/spec/units/loginator_spec.rb +31 -0
- data/spec/units/mock_locator_spec.rb +199 -5
- data/spec/units/partials/include_groups_spec.rb +42 -0
- data/spec/units/partials/partializer_config_spec.rb +25 -0
- data/spec/units/partials/partializer_helper_carry_spec.rb +661 -0
- data/spec/units/partials/partializer_helper_interface_extras_spec.rb +396 -0
- data/spec/units/partials/partializer_helper_spec.rb +529 -277
- data/spec/units/partials/partializer_reconciler_spec.rb +661 -0
- data/spec/units/partials/partializer_spec.rb +1578 -270
- data/spec/units/partials/partializer_utils_spec.rb +269 -232
- data/spec/units/partials/partials_rename_spec.rb +160 -0
- data/spec/units/partials_manager_spec.rb +554 -261
- data/spec/units/plugins/bullseye_spec.rb +34 -0
- data/spec/units/plugins/console_reportinator_spec.rb +58 -9
- data/spec/units/plugins/report_tests_teamcity_stdout_spec.rb +1 -1
- data/spec/units/plugins/reportgenerator_reportinator_spec.rb +51 -3
- data/spec/units/preprocess/preprocessinator_code_finder_spec.rb +73 -10
- data/spec/units/preprocess/preprocessinator_file_assembler_spec.rb +125 -37
- data/spec/units/preprocess/preprocessinator_includes_handler_spec.rb +15 -0
- data/spec/units/preprocess/preprocessinator_reconstructor_spec.rb +197 -0
- data/spec/units/preprocess/preprocessinator_spec.rb +153 -95
- data/spec/units/setupinator_spec.rb +51 -0
- data/spec/units/standin_headerinator_spec.rb +27 -11
- data/spec/units/test_build_executor_spec.rb +780 -166
- data/spec/units/test_build_planner_spec.rb +116 -28
- data/spec/units/test_build_setup_spec.rb +83 -18
- data/spec/units/test_context_extractor_spec.rb +11 -2
- data/spec/units/test_derived_search_paths_spec.rb +259 -0
- data/spec/units/test_includes_extractinator_spec.rb +56 -8
- data/spec/units/test_invoker/objects_wiring_spec.rb +20 -3
- data/spec/units/test_invoker/partial_files_preprocessinator_spec.rb +264 -0
- data/spec/units/test_invoker/test_substitutions_spec.rb +122 -0
- data/spec/units/test_invoker_types_spec.rb +8 -7
- data/spec/units/test_pipeline_manager_spec.rb +54 -13
- data/spec/units/test_runner_generatinator_spec.rb +93 -1
- data/spec/units/test_search_paths_spec.rb +73 -5
- data/spec/units/{default_tools_quoting_spec.rb → tools/default_tools_quoting_spec.rb} +39 -5
- data/spec/units/tools/shell_quoting_spec.rb +76 -0
- data/spec/units/{tool_executor_helper_spec.rb → tools/tool_executor_helper_spec.rb} +1 -1
- data/spec/units/{tool_executor_spec.rb → tools/tool_executor_spec.rb} +1 -1
- data/spec/units/{tool_validator_spec.rb → tools/tool_validator_spec.rb} +110 -1
- data/spec/units/windows_registry_query_tool_spec.rb +53 -0
- metadata +161 -16
- /data/lib/ceedling/{tool_executor.rb → tools/tool_executor.rb} +0 -0
- /data/lib/ceedling/{tool_executor_helper.rb → tools/tool_executor_helper.rb} +0 -0
|
@@ -0,0 +1,56 @@
|
|
|
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 'ceedling/diagnostics/guidance_phrases'
|
|
9
|
+
|
|
10
|
+
# The education and options that follow each HeaderCollisionSpecialist prescription's
|
|
11
|
+
# lead sentence. Each opens with how C produces the collision, then numbers the ways to
|
|
12
|
+
# resolve it, every line left-justified so a narrow terminal wraps it cleanly. A remedy
|
|
13
|
+
# that mocks or Partializes a header names the setting a disabled feature needs.
|
|
14
|
+
module HeaderCollisionGuidance
|
|
15
|
+
|
|
16
|
+
# Follows the lead of a substituted-header prescription
|
|
17
|
+
SUBSTITUTED_HEADER = <<~GUIDANCE.freeze
|
|
18
|
+
HOW THIS HAPPENS:
|
|
19
|
+
• A %{substitute} replaces a header only where an #include names it and the search paths find the substitute first.
|
|
20
|
+
• A quoted #include looks in the including file's own directory before any search path, so a neighbor of the real header reaches it directly.
|
|
21
|
+
• A substitute is usually a separate file with its own include guard; the guard does not keep the real header out.
|
|
22
|
+
• Ceedling isolates the real header's direct neighbors, one level deep. A chain that passes through further headers or directories is beyond that isolation.
|
|
23
|
+
|
|
24
|
+
OPTIONS:
|
|
25
|
+
1. Trace the #include chain that brings in the real header.
|
|
26
|
+
2. %{substitution}
|
|
27
|
+
3. Change the source's #include so it reaches the header the way the test does.
|
|
28
|
+
GUIDANCE
|
|
29
|
+
|
|
30
|
+
# Follows the lead of a shared-directory prescription
|
|
31
|
+
SHARED_DIRECTORY = <<~GUIDANCE.freeze
|
|
32
|
+
HOW THIS HAPPENS:
|
|
33
|
+
• One translation unit may define a type, a tag, or an enum value only once, and every declaration of a name must agree.
|
|
34
|
+
• An include guard keeps a header out the second time only when both arrivals are the same file. Two copies of a header, or two headers that declare one name, pass every guard.
|
|
35
|
+
• A quoted #include looks in the including file's own directory before any search path. A header there reaches its neighbor directly, whatever order the search paths set.
|
|
36
|
+
• Ceedling isolates a header's neighbors only when the header is mocked or Partialized. No header in this directory is, so no isolation applies here.
|
|
37
|
+
• Isolation reaches only one level: a neighbor that #includes a substituted header directly. A chain that passes through further headers or directories is beyond this isolation.
|
|
38
|
+
|
|
39
|
+
OPTIONS:
|
|
40
|
+
1. Trace the #include chains into this directory to the declaration that arrives twice or to the two declarations that disagree.
|
|
41
|
+
2. %{substitution}
|
|
42
|
+
3. Change the #include or the search path that brings in the second copy.
|
|
43
|
+
4. Add or fix the include guard of a header that arrives twice.
|
|
44
|
+
GUIDANCE
|
|
45
|
+
|
|
46
|
+
# `substitute` is 'mock' or 'Partial', whichever this test made of the header
|
|
47
|
+
def self.substituted_header(substitute:, mocks:, partials:)
|
|
48
|
+
remedy = 'the intermediate header that #includes it, without necessarily using it, to break the chain.'
|
|
49
|
+
return format( SUBSTITUTED_HEADER, substitute: substitute, substitution: GuidancePhrases.substitute( remedy, mocks: mocks, partials: partials ) )
|
|
50
|
+
end
|
|
51
|
+
|
|
52
|
+
def self.shared_directory(mocks:, partials:)
|
|
53
|
+
remedy = 'the header whose content should be substituted so that Ceedling isolates its neighbors.'
|
|
54
|
+
return format( SHARED_DIRECTORY, substitution: GuidancePhrases.substitute( remedy, mocks: mocks, partials: partials ) )
|
|
55
|
+
end
|
|
56
|
+
end
|
|
@@ -0,0 +1,152 @@
|
|
|
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 'ceedling/diagnostics/build_step_doctor'
|
|
9
|
+
require 'ceedling/diagnostics/toolchain_output'
|
|
10
|
+
require 'ceedling/diagnostics/header_collision_guidance'
|
|
11
|
+
|
|
12
|
+
# Explains compiler errors where one translation unit declares a name twice or two ways.
|
|
13
|
+
#
|
|
14
|
+
# A mock or Partial substitutes a header only through the #include directives a test
|
|
15
|
+
# names and the order of its search paths. A header's real content can still reach a
|
|
16
|
+
# compilation another way, and its declarations then collide with the substitute's (see
|
|
17
|
+
# HEADER_COLLISIONS.md). Headers that share a directory can collide the same way with no
|
|
18
|
+
# substitute involved, since a quoted #include finds its neighbor before any search path.
|
|
19
|
+
#
|
|
20
|
+
# Compilers word the collision differently, and no list of wordings is complete. The
|
|
21
|
+
# symptoms below cover the families DOCTOR.md lists and end in a generic net, since a
|
|
22
|
+
# missed collision costs more than guidance that turns out not to apply.
|
|
23
|
+
class HeaderCollisionSpecialist
|
|
24
|
+
|
|
25
|
+
COLLISION_SYMPTOMS = [
|
|
26
|
+
# GCC
|
|
27
|
+
/redefinition of|redeclaration of|conflicting types|previous (?:definition|declaration)|redeclared as different kind/i,
|
|
28
|
+
# Clang, armclang, and Microchip XC8 v2 and later
|
|
29
|
+
/typedef redefinition|previous definition is here/i,
|
|
30
|
+
# EDG front ends: IAR (Pe101), Arm armcc (#101), TI and Green Hills (error #101)
|
|
31
|
+
/has already been (?:declared|defined)|invalid redeclaration|declaration is incompatible|(?:\bPe|#)0*(?:101|147|256)\b/i,
|
|
32
|
+
# MSVC
|
|
33
|
+
/\bC(?:2011|2084|2370|2371)\b|redefinition; different/,
|
|
34
|
+
# TASKING, SDCC, and other compilers
|
|
35
|
+
/redefin|redeclar|already (?:been )?(?:declared|defined)|duplicate (?:definition|declaration)/i
|
|
36
|
+
].freeze
|
|
37
|
+
|
|
38
|
+
constructor :configurator, :test_substitutions, :gcc_dependency_parser, :file_wrapper
|
|
39
|
+
|
|
40
|
+
def diagnoses()
|
|
41
|
+
return [
|
|
42
|
+
diagnosis( :substituted_header_collision, method( :examine_substituted_header ) ),
|
|
43
|
+
diagnosis( :shared_directory_collision, method( :examine_shared_directory ) )
|
|
44
|
+
]
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
### Private ###
|
|
48
|
+
|
|
49
|
+
private
|
|
50
|
+
|
|
51
|
+
def diagnosis(name, examination)
|
|
52
|
+
return BuildStepDoctor::Diagnosis.new( name: name, steps: [:compile], symptoms: COLLISION_SYMPTOMS, examination: examination )
|
|
53
|
+
end
|
|
54
|
+
|
|
55
|
+
# A header the output names that is also one the test substitutes means the real
|
|
56
|
+
# header's content reached the compilation beside its substitute
|
|
57
|
+
def examine_substituted_header(kase)
|
|
58
|
+
testable = kase.inputs[:testable]
|
|
59
|
+
culprit = substituted_culprit( testable, ToolchainOutput.headers( kase.output ) )
|
|
60
|
+
return nil if culprit.nil?
|
|
61
|
+
|
|
62
|
+
substitute = @test_substitutions.partialized?( testable, culprit.last ) ? 'Partial' : 'mock'
|
|
63
|
+
return substituted_header_prescription( *culprit, substitute: substitute )
|
|
64
|
+
end
|
|
65
|
+
|
|
66
|
+
# The substituted header, as `[basename, real path]`, that a mentioned path names
|
|
67
|
+
def substituted_culprit(testable, mentioned)
|
|
68
|
+
return @test_substitutions.real_headers( testable ).find do |basename, real_path|
|
|
69
|
+
mentioned.any? { |m| File.basename( m ) == basename && File.expand_path( m ) == File.expand_path( real_path ) }
|
|
70
|
+
end
|
|
71
|
+
end
|
|
72
|
+
|
|
73
|
+
# A named header beside other headers, none of them substituted, may have reached its
|
|
74
|
+
# neighbor through a quoted #include. Isolation acts only around a substituted header,
|
|
75
|
+
# so its directory and Ceedling's own are left out. The headers the first attempt's .d
|
|
76
|
+
# file lists are what this test reaches. A toolchain that writes no .d file leaves
|
|
77
|
+
# only the directory's listing, which may overstate the risk.
|
|
78
|
+
def examine_shared_directory(kase)
|
|
79
|
+
reached = reached_headers( kase.inputs[:dependencies] )
|
|
80
|
+
excluded = excluded_dirs( kase.inputs[:testable] )
|
|
81
|
+
|
|
82
|
+
return named_by_directory( kase.output ).filter_map do |dir, headers|
|
|
83
|
+
next if within?( dir, excluded ) || !neighbors?( dir, headers, reached )
|
|
84
|
+
|
|
85
|
+
shared_directory_prescription( headers, reached: !reached.nil? )
|
|
86
|
+
end
|
|
87
|
+
end
|
|
88
|
+
|
|
89
|
+
# The headers the output names, grouped by their expanded directory
|
|
90
|
+
def named_by_directory(output)
|
|
91
|
+
return ToolchainOutput.headers( output ).group_by { |header| File.dirname( File.expand_path( header ) ) }
|
|
92
|
+
end
|
|
93
|
+
|
|
94
|
+
def within?(dir, roots)
|
|
95
|
+
return roots.any? { |root| dir == root || dir.start_with?( root + '/' ) }
|
|
96
|
+
end
|
|
97
|
+
|
|
98
|
+
# Every header the .d file lists, expanded, or nil without a .d file
|
|
99
|
+
def reached_headers(dependencies)
|
|
100
|
+
return nil if dependencies.nil? || !@file_wrapper.exist?( dependencies )
|
|
101
|
+
|
|
102
|
+
files = @gcc_dependency_parser.parse( @file_wrapper.read( dependencies ) ).values.flatten
|
|
103
|
+
return files.select { |file| header?( file ) }.map { |file| File.expand_path( file ) }.uniq
|
|
104
|
+
end
|
|
105
|
+
|
|
106
|
+
def excluded_dirs(testable)
|
|
107
|
+
substituted = @test_substitutions.real_headers( testable ).values.map { |real_path| File.dirname( File.expand_path( real_path ) ) }
|
|
108
|
+
return substituted + @test_substitutions.generated_dirs( testable ).map { |dir| File.expand_path( dir ) }
|
|
109
|
+
end
|
|
110
|
+
|
|
111
|
+
def neighbors?(dir, headers, reached)
|
|
112
|
+
beside = reached ? reached.select { |header| File.dirname( header ) == dir } : listed_headers( dir )
|
|
113
|
+
return (beside | headers.map { |header| File.expand_path( header ) }).size > 1
|
|
114
|
+
end
|
|
115
|
+
|
|
116
|
+
def listed_headers(dir)
|
|
117
|
+
return [] unless @file_wrapper.directory?( dir )
|
|
118
|
+
|
|
119
|
+
return @file_wrapper.directory_entries( dir ).select { |name| header?( name ) }.map { |name| File.join( dir, name ) }
|
|
120
|
+
end
|
|
121
|
+
|
|
122
|
+
def header?(filepath)
|
|
123
|
+
return ToolchainOutput::HEADER_EXTENSIONS.include?( File.extname( filepath ).delete_prefix( '.' ).downcase )
|
|
124
|
+
end
|
|
125
|
+
|
|
126
|
+
def substituted_header_prescription(basename, real_path, substitute:)
|
|
127
|
+
guidance = HeaderCollisionGuidance.substituted_header( substitute: substitute, **features )
|
|
128
|
+
|
|
129
|
+
return "The compiler output appears to report a redeclaration or conflicting types in '#{basename}'. " \
|
|
130
|
+
"If so, this test's #{substitute} of '#{basename}' may be colliding with its real content ('#{real_path}'), " \
|
|
131
|
+
"which can reach this compilation through a second #include chain that bypasses the #{substitute}.\n" \
|
|
132
|
+
"\n" + guidance
|
|
133
|
+
end
|
|
134
|
+
|
|
135
|
+
# The substitution features the project has on, which decide how remedies are worded
|
|
136
|
+
def features()
|
|
137
|
+
return { mocks: @configurator.project_use_mocks, partials: @configurator.project_use_partials }
|
|
138
|
+
end
|
|
139
|
+
|
|
140
|
+
# The directory is spelled as the output spelled it
|
|
141
|
+
def shared_directory_prescription(headers, reached:)
|
|
142
|
+
dir = File.dirname( headers.first )
|
|
143
|
+
names = headers.map { |header| "'#{File.basename( header )}'" }
|
|
144
|
+
listing = names.size == 1 ? names.first : "#{names[0..-2].join( ', ' )} and #{names.last}"
|
|
145
|
+
subject = names.size == 1 ? 'This header shares' : 'Each of these headers shares'
|
|
146
|
+
company = reached ? "other headers this test's compilation reaches" : 'other headers'
|
|
147
|
+
|
|
148
|
+
return "The compiler output appears to report a redeclaration or conflicting types involving #{listing}. " \
|
|
149
|
+
"If so, the cause may lie in how headers reach this compilation. #{subject} the directory '#{dir}' with #{company}.\n" \
|
|
150
|
+
"\n" + HeaderCollisionGuidance.shared_directory( **features )
|
|
151
|
+
end
|
|
152
|
+
end
|
|
@@ -0,0 +1,132 @@
|
|
|
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 'ceedling/diagnostics/build_step_doctor'
|
|
9
|
+
require 'ceedling/diagnostics/toolchain_output'
|
|
10
|
+
|
|
11
|
+
# Explains #include directives nested deeper than a compiler allows.
|
|
12
|
+
#
|
|
13
|
+
# The nesting is almost always a loop. A forwarding header that includes its own
|
|
14
|
+
# filename, meaning to reach a header of that name elsewhere, finds itself again when
|
|
15
|
+
# its own directory comes first in the search paths. Headers that include each other
|
|
16
|
+
# without include guards loop the same way. The compiler stops at a fixed depth and
|
|
17
|
+
# reports the loop only as nesting too deep.
|
|
18
|
+
#
|
|
19
|
+
# The guidance always explains both loops. When the header the error names includes
|
|
20
|
+
# its own filename and the search paths lead back to it, the guidance also names the
|
|
21
|
+
# header, the path that loops, and any header of that name later in the search paths.
|
|
22
|
+
class IncludeDepthSpecialist
|
|
23
|
+
|
|
24
|
+
# Each family's wording for nesting too deep, ending in a generic net. Newer GCC quotes
|
|
25
|
+
# the directive, with curly quotes in a UTF-8 locale, so a few non-word characters may
|
|
26
|
+
# follow it.
|
|
27
|
+
INCLUDE_DEPTH_SYMPTOMS = [
|
|
28
|
+
# GCC 10 and later
|
|
29
|
+
/#include\W{1,4}nested depth \d+ exceeds maximum/i,
|
|
30
|
+
# Clang, armclang, and GCC before 10
|
|
31
|
+
/#include\W{1,4}nested too deeply/i,
|
|
32
|
+
# MSVC
|
|
33
|
+
/\bC1014\b|too many include files/i,
|
|
34
|
+
# EDG front ends: IAR, Arm armcc, TI, and Green Hills
|
|
35
|
+
/includes itself|include file nesting/i,
|
|
36
|
+
# Other compilers
|
|
37
|
+
/\binclude\w* (?:depth|nesting)|nested (?:#?include|too deep)|too many (?:nested )?include/i
|
|
38
|
+
].freeze
|
|
39
|
+
|
|
40
|
+
INCLUDE_DIRECTIVE = /^[ \t]*#[ \t]*include[ \t]*([<"])([^>"\n]+)[>"]/
|
|
41
|
+
|
|
42
|
+
GUIDANCE = <<~GUIDANCE.freeze
|
|
43
|
+
HOW THIS HAPPENS:
|
|
44
|
+
• A compiler searches the include paths in order and uses the first file with the requested name.
|
|
45
|
+
• A forwarding header that #includes its own filename, to reach a header of that name elsewhere, finds itself again when its directory comes first.
|
|
46
|
+
• Two headers that #include each other without include guards repeat in the same way.
|
|
47
|
+
• The compiler stops at a fixed nesting limit and reports the loop as nesting too deep.
|
|
48
|
+
|
|
49
|
+
OPTIONS:
|
|
50
|
+
1. Order :paths ↳ :include (or TEST_INCLUDE_PATH()) so the directory holding the intended header comes before the forwarding header's directory.
|
|
51
|
+
2. List the forwarding header's parent directory instead, and #include it by its subdirectory, such as "freertos/timers.h".
|
|
52
|
+
3. Give headers that include each other include guards or #pragma once.
|
|
53
|
+
GUIDANCE
|
|
54
|
+
|
|
55
|
+
constructor :file_wrapper
|
|
56
|
+
|
|
57
|
+
def diagnoses()
|
|
58
|
+
return [
|
|
59
|
+
BuildStepDoctor::Diagnosis.new(
|
|
60
|
+
name: :include_nested_too_deeply,
|
|
61
|
+
steps: [:preprocess, :compile],
|
|
62
|
+
symptoms: INCLUDE_DEPTH_SYMPTOMS,
|
|
63
|
+
examination: method( :examine )
|
|
64
|
+
)
|
|
65
|
+
]
|
|
66
|
+
end
|
|
67
|
+
|
|
68
|
+
### Private ###
|
|
69
|
+
|
|
70
|
+
private
|
|
71
|
+
|
|
72
|
+
def examine(kase)
|
|
73
|
+
lead = 'The compiler output appears to report #include directives nested too deeply, which usually means a header includes itself.'
|
|
74
|
+
finding = self_inclusion( error_header( kase.symptoms ), kase.inputs[:search_paths] || [] )
|
|
75
|
+
lead += "\n#{finding}" if finding
|
|
76
|
+
|
|
77
|
+
return "#{lead}\n\n#{GUIDANCE}"
|
|
78
|
+
end
|
|
79
|
+
|
|
80
|
+
# The header on the line that reports the error, or nil
|
|
81
|
+
def error_header(match)
|
|
82
|
+
line = match.pre_match[/[^\n]*\z/] + match[0] + match.post_match[/\A[^\n]*/]
|
|
83
|
+
return ToolchainOutput.headers( line ).first
|
|
84
|
+
end
|
|
85
|
+
|
|
86
|
+
# Explains the first #include in `header` that the search reaches it through again, or nil.
|
|
87
|
+
# The explanation names the header as the search found it. The output may spell it
|
|
88
|
+
# another way, such as Clang on Windows joining a search path and a name with '\'.
|
|
89
|
+
def self_inclusion(header, search_paths)
|
|
90
|
+
return nil if header.nil? || !@file_wrapper.exist?( header )
|
|
91
|
+
|
|
92
|
+
@file_wrapper.read( header ).scrub.scan( INCLUDE_DIRECTIVE ).each do |delimiter, name|
|
|
93
|
+
found = search( header, delimiter, name, search_paths )
|
|
94
|
+
next unless same_file?( found.first, header )
|
|
95
|
+
|
|
96
|
+
return looping_explanation( found.first, delimiter, name, found )
|
|
97
|
+
end
|
|
98
|
+
|
|
99
|
+
return nil
|
|
100
|
+
end
|
|
101
|
+
|
|
102
|
+
# Every file an #include of `name` in `header` can reach, in the order the compiler searches.
|
|
103
|
+
# A quoted #include searches its own file's directory before the search paths.
|
|
104
|
+
def search(header, delimiter, name, search_paths)
|
|
105
|
+
directories = (delimiter == '"' ? [File.dirname( header )] : []) + search_paths
|
|
106
|
+
|
|
107
|
+
return directories.map { |directory| File.join( directory, name ) }.select { |path| @file_wrapper.exist?( path ) }
|
|
108
|
+
end
|
|
109
|
+
|
|
110
|
+
# A quoted #include loops whatever the search path order, so only an angled one is
|
|
111
|
+
# blamed on that order
|
|
112
|
+
def looping_explanation(header, delimiter, name, found)
|
|
113
|
+
intended = found.find { |path| !same_file?( path, header ) }
|
|
114
|
+
|
|
115
|
+
if delimiter == '"'
|
|
116
|
+
explanation = "'#{header}' includes \"#{name}\". A quoted #include searches the header's own directory before any search path, " \
|
|
117
|
+
'so it includes itself whatever their order.'
|
|
118
|
+
return intended ? "#{explanation} '#{intended}' is in the search paths, and #include <#{name}> would let their order reach it." : explanation
|
|
119
|
+
end
|
|
120
|
+
|
|
121
|
+
explanation = "'#{header}' includes <#{name}>, and the search paths find that name in the header's own directory first " \
|
|
122
|
+
"('#{File.dirname( found.first )}'), so it includes itself."
|
|
123
|
+
return intended ? "#{explanation} '#{intended}' is later in the search paths." : explanation
|
|
124
|
+
end
|
|
125
|
+
|
|
126
|
+
# A symlink or a difference in case can name one file two ways
|
|
127
|
+
def same_file?(path, other)
|
|
128
|
+
return false if path.nil?
|
|
129
|
+
|
|
130
|
+
return File.expand_path( path ) == File.expand_path( other ) || File.identical?( path, other )
|
|
131
|
+
end
|
|
132
|
+
end
|
|
@@ -0,0 +1,111 @@
|
|
|
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 'ceedling/diagnostics/build_step_doctor'
|
|
9
|
+
require 'ceedling/diagnostics/guidance_phrases'
|
|
10
|
+
|
|
11
|
+
# Explains linker errors for symbols no linked object defines.
|
|
12
|
+
#
|
|
13
|
+
# A test executable links only the sources its #include directives name by Ceedling's
|
|
14
|
+
# convention, plus any TEST_SOURCE_FILE() adds. A missing symbol most often means that
|
|
15
|
+
# convention left out a source the test needs.
|
|
16
|
+
class MissingSymbolSpecialist
|
|
17
|
+
|
|
18
|
+
# Each family's wording for a symbol no object defines, ending in a generic net. A
|
|
19
|
+
# duplicate symbol is left to DuplicateSymbolSpecialist, whose advice differs.
|
|
20
|
+
MISSING_SYMBOL_SYMPTOMS = [
|
|
21
|
+
# GNU ld, and Microchip XC16 and XC32
|
|
22
|
+
/undefined reference to/i,
|
|
23
|
+
# LLD, Apple ld, and Arm armlink (L6218E)
|
|
24
|
+
/undefined symbol|symbol\(s\) not found|\bL6218E\b/i,
|
|
25
|
+
# MSVC
|
|
26
|
+
/\bLNK20(?:19|01)\b|unresolved external symbol/i,
|
|
27
|
+
# IAR ILINK
|
|
28
|
+
/\bLi005\b|no definition for/i,
|
|
29
|
+
# TI
|
|
30
|
+
/undefined\s+first referenced|unresolved symbols remain/i,
|
|
31
|
+
# Green Hills, TASKING, SDCC, and other linkers
|
|
32
|
+
/undefined (?:global|external)|unresolved (?:external|symbol)/i
|
|
33
|
+
].freeze
|
|
34
|
+
|
|
35
|
+
constructor :configurator
|
|
36
|
+
|
|
37
|
+
def diagnoses()
|
|
38
|
+
return [
|
|
39
|
+
BuildStepDoctor::Diagnosis.new(
|
|
40
|
+
name: :missing_symbols,
|
|
41
|
+
steps: [:link],
|
|
42
|
+
symptoms: MISSING_SYMBOL_SYMPTOMS,
|
|
43
|
+
examination: ->(_case) { prescription() }
|
|
44
|
+
)
|
|
45
|
+
]
|
|
46
|
+
end
|
|
47
|
+
|
|
48
|
+
### Private ###
|
|
49
|
+
|
|
50
|
+
private
|
|
51
|
+
|
|
52
|
+
def prescription()
|
|
53
|
+
return causes() + "\n" + note() + "\n" + options()
|
|
54
|
+
end
|
|
55
|
+
|
|
56
|
+
def causes()
|
|
57
|
+
return "The linker output appears to report missing symbols. If so, the following may be to blame:\n" + numbered( [
|
|
58
|
+
'This test lacks #include statements corresponding to needed source files (see note below).',
|
|
59
|
+
'Project file paths omit source files corresponding to #include statements in this test.',
|
|
60
|
+
macro_cause(),
|
|
61
|
+
('This test does not #include needed mocks (that triggers their generation).' if mocks?),
|
|
62
|
+
("A Partial in this test leaves out a function the test or the Partial's code calls. " \
|
|
63
|
+
'A Partial carries only the functions its directive selects.' if partials?)
|
|
64
|
+
] )
|
|
65
|
+
end
|
|
66
|
+
|
|
67
|
+
# Without test preprocessing, #include statements are read as text, so a macro or
|
|
68
|
+
# #ifdef can hide or invent one. With it, the preprocessor evaluates them.
|
|
69
|
+
def macro_cause()
|
|
70
|
+
return 'Complex macros, #ifdefs, etc. have obscured correct #include statements in this test.' unless preprocessing?
|
|
71
|
+
|
|
72
|
+
return "Macros or #ifdefs, evaluated with this test's defines, leave out an #include statement the test needs."
|
|
73
|
+
end
|
|
74
|
+
|
|
75
|
+
def note()
|
|
76
|
+
notice = "NOTE: A test file directs the build of a test executable with #include statements:\n" \
|
|
77
|
+
"• By convention, Ceedling assumes header filenames correspond to source filenames.\n" \
|
|
78
|
+
"• Which code files to compile and link are determined by #include statements.\n"
|
|
79
|
+
notice += "• An #include statement convention directs the generation of mocks from header files.\n" if mocks?
|
|
80
|
+
|
|
81
|
+
return notice
|
|
82
|
+
end
|
|
83
|
+
|
|
84
|
+
def options()
|
|
85
|
+
return "OPTIONS:\n" + numbered( [
|
|
86
|
+
"Doublecheck this test's #include statements.",
|
|
87
|
+
'Simplify complex macros or fully specify symbols for this test in :project ↳ :defines.',
|
|
88
|
+
('Enable test preprocessing with :project ↳ :use_test_preprocessor, so macros and #ifdefs decide which #include statements count.' unless preprocessing?),
|
|
89
|
+
'If no header file corresponds to the needed source file, use the TEST_SOURCE_FILE() build directive macro in this test to inject a source file into the build.',
|
|
90
|
+
"Mock the header that declares a missing function, so the mock supplies it.#{GuidancePhrases.requirements( mocks: mocks? )}",
|
|
91
|
+
("Select a function a Partial left out with +name in its directive, or select the whole module with TEST_PARTIAL_ALL_MODULE." if partials?)
|
|
92
|
+
] ) + "\nSee the docs on conventions, paths, preprocessing, compilation symbols, and build directive macros.\n"
|
|
93
|
+
end
|
|
94
|
+
|
|
95
|
+
# Numbers the items present, one per line
|
|
96
|
+
def numbered(items)
|
|
97
|
+
return items.compact.each_with_index.map { |item, index| "#{index + 1}. #{item}\n" }.join
|
|
98
|
+
end
|
|
99
|
+
|
|
100
|
+
def mocks?()
|
|
101
|
+
return @configurator.project_use_mocks
|
|
102
|
+
end
|
|
103
|
+
|
|
104
|
+
def partials?()
|
|
105
|
+
return @configurator.project_use_partials
|
|
106
|
+
end
|
|
107
|
+
|
|
108
|
+
def preprocessing?()
|
|
109
|
+
return @configurator.project_use_test_preprocessor_tests
|
|
110
|
+
end
|
|
111
|
+
end
|
|
@@ -0,0 +1,134 @@
|
|
|
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 'ceedling/diagnostics/build_step_doctor'
|
|
9
|
+
|
|
10
|
+
# Explains a test file's compilation error for a name one of ceedling.h's Partials macros built.
|
|
11
|
+
#
|
|
12
|
+
# PARTIAL_LOCAL_VAR(), PARTIAL_TYPE() and PARTIAL_LOCAL_TYPE() paste their arguments into one
|
|
13
|
+
# identifier as the test compiles. An argument that doesn't match the module builds a name
|
|
14
|
+
# nothing declares, and the compiler reports only that name, not the macro's arguments.
|
|
15
|
+
class PartialNameSpecialist
|
|
16
|
+
|
|
17
|
+
# Each family's wording for a name nothing declares, as a variable or as a type, ending in a
|
|
18
|
+
# generic net. A false match costs a hedged note, and the examination asks for a name the
|
|
19
|
+
# macros build besides.
|
|
20
|
+
UNDECLARED_SYMPTOMS = [
|
|
21
|
+
# GCC and Clang, Microchip XC8, XC16 and XC32, and armclang
|
|
22
|
+
/undeclared|unknown type name/i,
|
|
23
|
+
# MSVC
|
|
24
|
+
/\bC(?:2065|2061|4430|2146)\b/,
|
|
25
|
+
# EDG front ends: IAR, armcc, TI and Green Hills
|
|
26
|
+
/\bPe0*20\b|#20(?!\d)|identifier\s+"[^"\n]*"\s+is\s+undefined/i,
|
|
27
|
+
# SDCC, TASKING and other compilers
|
|
28
|
+
/undefined identifier|not declared|unknown type|is not a type/i
|
|
29
|
+
].freeze
|
|
30
|
+
|
|
31
|
+
# An identifier, scanned whole so each token is tested once
|
|
32
|
+
IDENTIFIER = /[A-Za-z_$][\w$]*/
|
|
33
|
+
|
|
34
|
+
# The names the macros build, and the macros themselves as a note on an expansion names them
|
|
35
|
+
LOCAL_VAR = /\Apartial_[\w$]+\z/
|
|
36
|
+
TYPE = /\Aceedling_partial_[\w$]+_t\z/
|
|
37
|
+
LOCAL_VAR_MACRO = 'PARTIAL_LOCAL_VAR'
|
|
38
|
+
TYPE_MACROS = ['PARTIAL_TYPE', 'PARTIAL_LOCAL_TYPE'].freeze
|
|
39
|
+
|
|
40
|
+
# How many of a test's real names a prescription lists
|
|
41
|
+
NAMES_LISTED = 12
|
|
42
|
+
|
|
43
|
+
LOCAL_VAR_GUIDANCE = <<~GUIDANCE.freeze
|
|
44
|
+
HOW THIS HAPPENS:
|
|
45
|
+
• PARTIAL_LOCAL_VAR(function, variable) pastes its arguments into one name, partial_<function>_<variable>, as the test compiles.
|
|
46
|
+
• Each argument must match the module's source exactly, case included. A misspelling builds a name nothing declares.
|
|
47
|
+
• Only a variable declared static inside a function is promoted. A variable at file scope keeps its own name.
|
|
48
|
+
• The macro builds a name the compiler reads. It can't take a string or a runtime value.
|
|
49
|
+
• A test reaches promoted variables through a TEST_PARTIAL_*_MODULE() macro. A MOCK_PARTIAL_*_MODULE() macro provides none.
|
|
50
|
+
|
|
51
|
+
OPTIONS:
|
|
52
|
+
1. Check each argument against the function and its static variable in the module's source.
|
|
53
|
+
2. Name a variable at file scope directly, without the macro.
|
|
54
|
+
3. Include the module with a TEST_PARTIAL_*_MODULE() macro.%{names}
|
|
55
|
+
GUIDANCE
|
|
56
|
+
|
|
57
|
+
TYPE_GUIDANCE = <<~GUIDANCE.freeze
|
|
58
|
+
HOW THIS HAPPENS:
|
|
59
|
+
• A Partial names the type of a variable declared together with its type, as in `static struct { int count; } s_ctx;`.
|
|
60
|
+
• PARTIAL_TYPE(module, variable) and PARTIAL_LOCAL_TYPE(module, function, variable) paste their arguments into that name as the test compiles.
|
|
61
|
+
• The module argument is the module's name alone, without a directory. A character a C identifier can't hold is written as `_`, as in my_sensor for my-sensor.
|
|
62
|
+
• Variables declared in one statement share one type, named for the first of them.
|
|
63
|
+
• A variable whose type is named elsewhere, as in `static struct ctx s_ctx;`, uses that name, here `struct ctx`.
|
|
64
|
+
|
|
65
|
+
OPTIONS:
|
|
66
|
+
1. Check each argument against the module's name and its declaration, case included.
|
|
67
|
+
2. Use PARTIAL_LOCAL_TYPE() for a static declared inside a function, with the function's name.
|
|
68
|
+
3. Write a type named elsewhere by its own name.%{names}
|
|
69
|
+
GUIDANCE
|
|
70
|
+
|
|
71
|
+
constructor :configurator, :file_wrapper
|
|
72
|
+
|
|
73
|
+
def diagnoses()
|
|
74
|
+
return [
|
|
75
|
+
BuildStepDoctor::Diagnosis.new(
|
|
76
|
+
name: :partial_local_var, steps: [:compile], symptoms: UNDECLARED_SYMPTOMS, examination: method( :examine_local_var )
|
|
77
|
+
),
|
|
78
|
+
BuildStepDoctor::Diagnosis.new(
|
|
79
|
+
name: :partial_type, steps: [:compile], symptoms: UNDECLARED_SYMPTOMS, examination: method( :examine_type )
|
|
80
|
+
)
|
|
81
|
+
]
|
|
82
|
+
end
|
|
83
|
+
|
|
84
|
+
### Private ###
|
|
85
|
+
|
|
86
|
+
private
|
|
87
|
+
|
|
88
|
+
def examine_local_var(kase)
|
|
89
|
+
return nil unless names?( kase, LOCAL_VAR, [LOCAL_VAR_MACRO] )
|
|
90
|
+
|
|
91
|
+
lead = 'The compiler output appears to report a name that PARTIAL_LOCAL_VAR() builds and nothing declares. ' \
|
|
92
|
+
"If so, the macro's arguments may not match a static variable inside one of the module's functions."
|
|
93
|
+
return "#{lead}\n\n" + format( LOCAL_VAR_GUIDANCE, names: listed( kase, LOCAL_VAR, 'Promoted variables' ) )
|
|
94
|
+
end
|
|
95
|
+
|
|
96
|
+
def examine_type(kase)
|
|
97
|
+
return nil unless names?( kase, TYPE, TYPE_MACROS )
|
|
98
|
+
|
|
99
|
+
lead = 'The compiler output appears to report a type that PARTIAL_TYPE() or PARTIAL_LOCAL_TYPE() names and nothing declares. ' \
|
|
100
|
+
"If so, the macro's arguments may not match a variable declared together with its type."
|
|
101
|
+
return "#{lead}\n\n" + format( TYPE_GUIDANCE, names: listed( kase, TYPE, 'Type names' ) )
|
|
102
|
+
end
|
|
103
|
+
|
|
104
|
+
# Whether the failure is the test file's own, in a build with Partials, and names something a
|
|
105
|
+
# macro builds, or the macro itself
|
|
106
|
+
def names?(kase, shape, macros)
|
|
107
|
+
return false unless @configurator.project_use_partials and test_file?( kase )
|
|
108
|
+
|
|
109
|
+
return kase.output.scan( IDENTIFIER ).any? { |token| token.match?( shape ) or macros.include?( token ) }
|
|
110
|
+
end
|
|
111
|
+
|
|
112
|
+
def test_file?(kase)
|
|
113
|
+
testable = kase.inputs[:testable]
|
|
114
|
+
return (testable and kase.inputs[:source] == testable.filepath)
|
|
115
|
+
end
|
|
116
|
+
|
|
117
|
+
# The names of a shape this test's Partials provide, as one more option, or nothing when none
|
|
118
|
+
# can be read. Generation writes them into the test's own generated headers.
|
|
119
|
+
def listed(kase, shape, label)
|
|
120
|
+
names = provided( kase.inputs[:testable], shape )
|
|
121
|
+
return '' if names.empty?
|
|
122
|
+
|
|
123
|
+
more = names.size > NAMES_LISTED ? ', …' : ''
|
|
124
|
+
return "\n4. #{label} this test's Partials provide: #{names.first( NAMES_LISTED ).join( ', ' )}#{more}"
|
|
125
|
+
end
|
|
126
|
+
|
|
127
|
+
def provided(testable, shape)
|
|
128
|
+
dir = testable.paths && testable.paths[:partials]
|
|
129
|
+
return [] unless dir
|
|
130
|
+
|
|
131
|
+
headers = @file_wrapper.directory_listing( File.join( dir, '**', '*.h' ) )
|
|
132
|
+
return headers.flat_map { |header| @file_wrapper.read( header ).scan( IDENTIFIER ) }.select { |token| token.match?( shape ) }.uniq.sort
|
|
133
|
+
end
|
|
134
|
+
end
|
|
@@ -0,0 +1,44 @@
|
|
|
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
|
+
# Reads the file paths a toolchain's output mentions.
|
|
9
|
+
#
|
|
10
|
+
# Toolchains place a path in many ways: `a.h:12:3` (GCC, Clang), `"a.h",12` (IAR),
|
|
11
|
+
# `"a.h", line 12` (Arm armcc, TI, Green Hills), `a.h(12)` (MSVC), and inside prose such
|
|
12
|
+
# as `declared at line 5 of "a.h"`. Rather than parse each format, a path is any token
|
|
13
|
+
# that ends in a wanted extension. A double-quoted path may hold spaces. An unquoted one
|
|
14
|
+
# ends at whitespace or punctuation no path holds, apart from a Windows drive letter's
|
|
15
|
+
# colon. Reading too much is safe here: a caller compares each path against files it
|
|
16
|
+
# knows, so a stray match finds nothing.
|
|
17
|
+
module ToolchainOutput
|
|
18
|
+
HEADER_EXTENSIONS = %w[h hh hpp hxx].freeze
|
|
19
|
+
|
|
20
|
+
# Characters that end an unquoted path
|
|
21
|
+
PATH_STOP = %q{\s"'`(),:;<>\[\]}
|
|
22
|
+
|
|
23
|
+
# Headers the output names, each once, in order of first mention
|
|
24
|
+
def self.headers(output)
|
|
25
|
+
return paths( output, "(?:#{HEADER_EXTENSIONS.join( '|' )})" )
|
|
26
|
+
end
|
|
27
|
+
|
|
28
|
+
# Object files the output names, each once, in order of first mention
|
|
29
|
+
def self.objects(output, extension:)
|
|
30
|
+
return paths( output, Regexp.escape( extension.delete_prefix( '.' ) ) )
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
# Tokens are scanned whole, quoted strings first, and each is kept only when it ends in
|
|
34
|
+
# the extension. Testing the ending after the scan keeps the pass linear on long tokens.
|
|
35
|
+
def self.paths(output, extension)
|
|
36
|
+
return [] if output.nil?
|
|
37
|
+
|
|
38
|
+
ending = /\.#{extension}\z/i
|
|
39
|
+
tokens = output.scan( /"([^"\n]*)"|((?:[A-Za-z]:)?[^#{PATH_STOP}]+)/ ).map { |quoted, bare| quoted || bare }
|
|
40
|
+
|
|
41
|
+
return tokens.select { |token| token.match?( ending ) }.uniq
|
|
42
|
+
end
|
|
43
|
+
private_class_method :paths
|
|
44
|
+
end
|