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,137 @@
|
|
|
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
|
+
require 'ceedling/diagnostics/include_depth_specialist'
|
|
12
|
+
|
|
13
|
+
describe IncludeDepthSpecialist do
|
|
14
|
+
FORWARDING = 'vendor/esp32/include/freertos/timers.h'
|
|
15
|
+
KERNEL = 'vendor/kernel/include/timers.h'
|
|
16
|
+
|
|
17
|
+
before(:each) do
|
|
18
|
+
# Files by path, each with its text
|
|
19
|
+
@files = { FORWARDING => "#include <timers.h>\n", KERNEL => "int xTimerStart(int t);\n" }
|
|
20
|
+
|
|
21
|
+
@file_wrapper = double( 'file_wrapper' )
|
|
22
|
+
allow( @file_wrapper ).to receive( :exist? ) { |path| @files.key?( path ) }
|
|
23
|
+
allow( @file_wrapper ).to receive( :read ) { |path| @files.fetch( path ) }
|
|
24
|
+
|
|
25
|
+
@loginator = double( 'loginator' )
|
|
26
|
+
allow( @loginator ).to receive( :log )
|
|
27
|
+
|
|
28
|
+
nobody = double( 'specialist', diagnoses: [] )
|
|
29
|
+
|
|
30
|
+
@doctor = BuildStepDoctor.new(
|
|
31
|
+
loginator: @loginator, header_collision_specialist: nobody, missing_symbol_specialist: nobody,
|
|
32
|
+
duplicate_symbol_specialist: nobody, partial_name_specialist: nobody,
|
|
33
|
+
include_depth_specialist: described_class.new( file_wrapper: @file_wrapper )
|
|
34
|
+
).tap( &:setup )
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
def prescriptions(output, search_paths: ['vendor/esp32/include/freertos', 'vendor/kernel/include'], step: :compile)
|
|
38
|
+
@doctor.diagnose( step: step, output: output, inputs: { search_paths: search_paths } )
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
GCC_NESTING = "In file included from #{FORWARDING}:1,\n from src/halGpio.h:3,\n" \
|
|
42
|
+
"#{FORWARDING}:1:20: error: #include nested depth 200 exceeds maximum of 200 " \
|
|
43
|
+
"(use -fmax-include-depth=DEPTH to increase the maximum)\n"
|
|
44
|
+
CLANG_NESTING = "In file included from src/halGpio.c:1:\nIn file included from #{FORWARDING}:1:\n" \
|
|
45
|
+
"#{FORWARDING}:1:10: error: #include nested too deeply\n"
|
|
46
|
+
|
|
47
|
+
{
|
|
48
|
+
'GCC 10 and later' => GCC_NESTING,
|
|
49
|
+
'GCC quoting the directive' => "#{FORWARDING}:1:20: error: '#include' nested depth 200 exceeds maximum of 200\n",
|
|
50
|
+
'GCC quoting in UTF-8' => "#{FORWARDING}:1:20: error: ‘#include’ nested depth 200 exceeds maximum of 200\n",
|
|
51
|
+
'Clang and older GCC' => CLANG_NESTING,
|
|
52
|
+
'MSVC' => "#{FORWARDING}(1): fatal error C1014: too many include files : depth = 1024\n",
|
|
53
|
+
'EDG front ends' => "\"#{FORWARDING}\", line 1: catastrophic error: #include file \"#{FORWARDING}\" includes itself\n",
|
|
54
|
+
'other compilers, generically' => "#{FORWARDING}:1: error: include depth limit reached\n"
|
|
55
|
+
}.each do |family, output|
|
|
56
|
+
it "recognizes #{family} and names the header that includes itself" do
|
|
57
|
+
notice = prescriptions( output ).first
|
|
58
|
+
|
|
59
|
+
expect( notice ).to start_with( 'The compiler output appears to report #include directives nested too deeply' )
|
|
60
|
+
expect( notice ).to include( "'#{FORWARDING}' includes <timers.h>, and the search paths find that name in the header's own directory first " \
|
|
61
|
+
"('vendor/esp32/include/freertos'), so it includes itself. '#{KERNEL}' is later in the search paths." )
|
|
62
|
+
end
|
|
63
|
+
end
|
|
64
|
+
|
|
65
|
+
it 'prescribes nothing for an unrelated error, even one naming a directory called nested' do
|
|
66
|
+
expect( prescriptions( "In file included from vendor/nested/a.h:1:\nsrc/a.c:2:3: error: expected ';'\n" ) ).to be_empty
|
|
67
|
+
end
|
|
68
|
+
|
|
69
|
+
it 'diagnoses preprocessing as well as compilation, and nothing at linking' do
|
|
70
|
+
expect( prescriptions( GCC_NESTING, step: :preprocess ).size ).to eq( 1 )
|
|
71
|
+
expect( prescriptions( GCC_NESTING, step: :link ) ).to be_empty
|
|
72
|
+
end
|
|
73
|
+
|
|
74
|
+
it 'leaves out the intended header when no later search path holds one' do
|
|
75
|
+
notice = prescriptions( GCC_NESTING, search_paths: ['vendor/esp32/include/freertos'] ).first
|
|
76
|
+
|
|
77
|
+
expect( notice ).to include( "so it includes itself.\n\nHOW THIS HAPPENS:" )
|
|
78
|
+
end
|
|
79
|
+
|
|
80
|
+
it 'explains that a quoted self-include loops whatever the search path order' do
|
|
81
|
+
@files[FORWARDING] = "#include \"timers.h\"\n"
|
|
82
|
+
notice = prescriptions( GCC_NESTING, search_paths: ['vendor/kernel/include', 'vendor/esp32/include/freertos'] ).first
|
|
83
|
+
|
|
84
|
+
expect( notice ).to include(
|
|
85
|
+
"'#{FORWARDING}' includes \"timers.h\". A quoted #include searches the header's own directory before any search path, " \
|
|
86
|
+
"so it includes itself whatever their order. '#{KERNEL}' is in the search paths, and #include <timers.h> would let their order reach it."
|
|
87
|
+
)
|
|
88
|
+
expect( notice ).not_to include( 'is later in the search paths' )
|
|
89
|
+
end
|
|
90
|
+
|
|
91
|
+
it 'names the header by its search path, not by the spelling the compiler output uses' do
|
|
92
|
+
spelled = 'vendor/esp32/include/./freertos/timers.h'
|
|
93
|
+
@files[spelled] = @files[FORWARDING]
|
|
94
|
+
notice = prescriptions( "#{spelled}:1:10: error: #include nested too deeply\n" ).first
|
|
95
|
+
|
|
96
|
+
expect( notice ).to include( "'#{FORWARDING}' includes <timers.h>" )
|
|
97
|
+
end
|
|
98
|
+
|
|
99
|
+
it 'reads a header holding bytes invalid in its encoding' do
|
|
100
|
+
@files[FORWARDING] = (+"/* \xFF */\n#include <timers.h>\n").force_encoding( Encoding::UTF_8 )
|
|
101
|
+
|
|
102
|
+
expect( prescriptions( GCC_NESTING ).first ).to include( "'#{FORWARDING}' includes <timers.h>" )
|
|
103
|
+
end
|
|
104
|
+
|
|
105
|
+
it 'gives the general guidance alone when the search paths reach the intended header first' do
|
|
106
|
+
notice = prescriptions( GCC_NESTING, search_paths: ['vendor/kernel/include', 'vendor/esp32/include/freertos'] ).first
|
|
107
|
+
|
|
108
|
+
expect( notice ).to include( "which usually means a header includes itself.\n\nHOW THIS HAPPENS:" )
|
|
109
|
+
end
|
|
110
|
+
|
|
111
|
+
it 'gives the general guidance alone for headers that include each other' do
|
|
112
|
+
@files['inc/a.h'] = "#include \"b.h\"\n"
|
|
113
|
+
@files['inc/b.h'] = "#include \"a.h\"\n"
|
|
114
|
+
notice = prescriptions( "inc/b.h:1:10: error: #include nested too deeply\n", search_paths: ['inc'] ).first
|
|
115
|
+
|
|
116
|
+
expect( notice ).to include( "which usually means a header includes itself.\n\nHOW THIS HAPPENS:", '3. Give headers that include each other include guards' )
|
|
117
|
+
end
|
|
118
|
+
|
|
119
|
+
it 'gives the general guidance alone when the header named cannot be read' do
|
|
120
|
+
@files.delete( FORWARDING )
|
|
121
|
+
|
|
122
|
+
expect( prescriptions( GCC_NESTING ).first ).to include( "includes itself.\n\nHOW THIS HAPPENS:" )
|
|
123
|
+
end
|
|
124
|
+
|
|
125
|
+
it 'reads the header the error line names after its wording, not one the line before names' do
|
|
126
|
+
@files['inc/other.h'] = "#include <timers.h>\n"
|
|
127
|
+
output = "In file included from inc/other.h:4,\ntoo many include files, giving up in #{FORWARDING}\n"
|
|
128
|
+
|
|
129
|
+
expect( prescriptions( output, search_paths: ['inc', 'vendor/esp32/include/freertos', 'vendor/kernel/include'] ).first ).to include( "'#{FORWARDING}' includes <timers.h>" )
|
|
130
|
+
end
|
|
131
|
+
|
|
132
|
+
it 'reads the header the error line names, not one the include chain names first' do
|
|
133
|
+
output = "In file included from inc/other.h:4,\n#{FORWARDING}:1:20: error: #include nested depth 200 exceeds maximum of 200\n"
|
|
134
|
+
|
|
135
|
+
expect( prescriptions( output ).first ).to include( "'#{FORWARDING}' includes <timers.h>" )
|
|
136
|
+
end
|
|
137
|
+
end
|
|
@@ -0,0 +1,154 @@
|
|
|
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
|
+
require 'ceedling/diagnostics/missing_symbol_specialist'
|
|
12
|
+
|
|
13
|
+
describe MissingSymbolSpecialist do
|
|
14
|
+
before(:each) do
|
|
15
|
+
@configurator = double( 'configurator' )
|
|
16
|
+
allow( @configurator ).to receive( :project_use_mocks ).and_return( false )
|
|
17
|
+
allow( @configurator ).to receive( :project_use_partials ).and_return( false )
|
|
18
|
+
allow( @configurator ).to receive( :project_use_test_preprocessor_tests ).and_return( false )
|
|
19
|
+
|
|
20
|
+
@loginator = double( 'loginator' )
|
|
21
|
+
allow( @loginator ).to receive( :log )
|
|
22
|
+
|
|
23
|
+
nobody = double( 'specialist', diagnoses: [] )
|
|
24
|
+
|
|
25
|
+
@doctor = BuildStepDoctor.new(
|
|
26
|
+
loginator: @loginator, header_collision_specialist: nobody,
|
|
27
|
+
missing_symbol_specialist: described_class.new( configurator: @configurator ), duplicate_symbol_specialist: nobody,
|
|
28
|
+
partial_name_specialist: nobody,
|
|
29
|
+
include_depth_specialist: nobody
|
|
30
|
+
).tap( &:setup )
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
def prescriptions(output, step: :link)
|
|
34
|
+
@doctor.diagnose( step: step, output: output, inputs: {} )
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
it 'prescribes missing-symbols guidance for an undefined reference' do
|
|
38
|
+
notices = prescriptions( "undefined reference to `foo'" )
|
|
39
|
+
|
|
40
|
+
expect( notices.size ).to eq( 1 )
|
|
41
|
+
expect( notices.first ).to match( /missing symbols/i )
|
|
42
|
+
end
|
|
43
|
+
|
|
44
|
+
it 'prescribes nothing for an unrelated linker failure' do
|
|
45
|
+
expect( prescriptions( 'some unrelated linker failure' ) ).to eq( [] )
|
|
46
|
+
end
|
|
47
|
+
|
|
48
|
+
{
|
|
49
|
+
'GNU ld and Microchip XC16/XC32' => "/usr/bin/ld: build/a_test.o: in function `test_f':\na_test.c:(.text+0x9): undefined reference to `gpio_init'\n",
|
|
50
|
+
'LLD' => "ld.lld: error: undefined symbol: gpio_init\n>>> referenced by a_test.c\n",
|
|
51
|
+
'Apple ld' => "Undefined symbols for architecture arm64:\n \"_gpio_init\", referenced from:\nld: symbol(s) not found for architecture arm64\n",
|
|
52
|
+
'MSVC' => "a_test.obj : error LNK2019: unresolved external symbol gpio_init referenced in function test_f\n",
|
|
53
|
+
'MSVC, unreferenced by function' => "a_test.obj : error LNK2001: unresolved external symbol gpio_state\n",
|
|
54
|
+
'IAR ILINK' => "Error[Li005]: no definition for \"gpio_init\" [referenced from a_test.o]\n",
|
|
55
|
+
'Arm armlink' => "Error: L6218E: Undefined symbol gpio_init (referred from a_test.o).\n",
|
|
56
|
+
'TI' => " undefined first referenced\n symbol in file\n gpio_init a_test.obj\nerror #10234-D: unresolved symbols remain\n",
|
|
57
|
+
'other linkers, generically' => "?ASlink-Warning-Undefined Global '_gpio_init' referenced by module 'a_test'\n"
|
|
58
|
+
}.each do |family, output|
|
|
59
|
+
it "recognizes #{family}" do
|
|
60
|
+
expect( prescriptions( output ).size ).to eq( 1 )
|
|
61
|
+
end
|
|
62
|
+
end
|
|
63
|
+
|
|
64
|
+
{
|
|
65
|
+
'GNU ld' => "a.o: in function `f': multiple definition of `f'; b.o:(.text+0x0): first defined here\n",
|
|
66
|
+
'Apple ld' => "duplicate symbol '_f' in:\n a.o\n b.o\nld: 1 duplicate symbol for architecture arm64\n",
|
|
67
|
+
'Arm armlink' => "Error: L6200E: Symbol f multiply defined (by a.o and b.o).\n"
|
|
68
|
+
}.each do |family, output|
|
|
69
|
+
it "leaves duplicate symbols reported by #{family} to their own diagnosis" do
|
|
70
|
+
expect( prescriptions( output ) ).to eq( [] )
|
|
71
|
+
end
|
|
72
|
+
end
|
|
73
|
+
|
|
74
|
+
it 'covers only linking' do
|
|
75
|
+
expect( prescriptions( "undefined reference to `foo'", step: :compile ) ).to eq( [] )
|
|
76
|
+
end
|
|
77
|
+
|
|
78
|
+
it 'includes mock-specific guidance only when the project uses mocks' do
|
|
79
|
+
expect( prescriptions( "undefined reference to `foo'" ).first ).not_to match( /needed mocks/i )
|
|
80
|
+
|
|
81
|
+
allow( @configurator ).to receive( :project_use_mocks ).and_return( true )
|
|
82
|
+
|
|
83
|
+
expect( prescriptions( "undefined reference to `foo'" ).first ).to match( /needed mocks/i )
|
|
84
|
+
end
|
|
85
|
+
|
|
86
|
+
it 'logs at ERRORS as a notice' do
|
|
87
|
+
prescriptions( "undefined reference to `foo'" )
|
|
88
|
+
|
|
89
|
+
expect( @loginator ).to have_received( :log ).with( a_string_matching( /missing symbols/i ), Verbosity::ERRORS, LogLabels::NOTICE )
|
|
90
|
+
end
|
|
91
|
+
|
|
92
|
+
def notice
|
|
93
|
+
prescriptions( "undefined reference to `foo'" ).first
|
|
94
|
+
end
|
|
95
|
+
|
|
96
|
+
it 'opens tentatively, then gives causes, education, and options in left-justified blocks' do
|
|
97
|
+
allow( @configurator ).to receive( :project_use_mocks ).and_return( true )
|
|
98
|
+
|
|
99
|
+
expect( notice ).to start_with(
|
|
100
|
+
"The linker output appears to report missing symbols. If so, the following may be to blame:\n" \
|
|
101
|
+
"1. This test lacks #include statements corresponding to needed source files (see note below).\n"
|
|
102
|
+
)
|
|
103
|
+
expect( notice ).to include(
|
|
104
|
+
"4. This test does not #include needed mocks (that triggers their generation).\n\n" \
|
|
105
|
+
"NOTE: A test file directs the build of a test executable with #include statements:\n" \
|
|
106
|
+
"• By convention, Ceedling assumes header filenames correspond to source filenames.\n",
|
|
107
|
+
"\n\nOPTIONS:\n1. Doublecheck this test's #include statements.\n",
|
|
108
|
+
"4. 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.\n",
|
|
109
|
+
"5. Mock the header that declares a missing function, so the mock supplies it.\n"
|
|
110
|
+
)
|
|
111
|
+
expect( notice.lines.grep( /\A\s/ ) ).to all( eq( "\n" ) )
|
|
112
|
+
end
|
|
113
|
+
|
|
114
|
+
it 'no longer blames mixed C and C++ file extensions' do
|
|
115
|
+
expect( notice ).not_to include( 'C++' )
|
|
116
|
+
end
|
|
117
|
+
|
|
118
|
+
context 'without test preprocessing' do
|
|
119
|
+
it 'blames macros obscuring #include statements read as text, and offers to enable preprocessing' do
|
|
120
|
+
expect( notice ).to include(
|
|
121
|
+
"3. Complex macros, #ifdefs, etc. have obscured correct #include statements in this test.\n",
|
|
122
|
+
"3. Enable test preprocessing with :project ↳ :use_test_preprocessor, so macros and #ifdefs decide which #include statements count.\n"
|
|
123
|
+
)
|
|
124
|
+
end
|
|
125
|
+
end
|
|
126
|
+
|
|
127
|
+
context 'with test preprocessing' do
|
|
128
|
+
before(:each) { allow( @configurator ).to receive( :project_use_test_preprocessor_tests ).and_return( true ) }
|
|
129
|
+
|
|
130
|
+
it 'blames macros as the preprocessor evaluates them, and offers no preprocessing option' do
|
|
131
|
+
expect( notice ).to include( "3. Macros or #ifdefs, evaluated with this test's defines, leave out an #include statement the test needs.\n" )
|
|
132
|
+
expect( notice ).not_to include( 'Enable test preprocessing' )
|
|
133
|
+
end
|
|
134
|
+
end
|
|
135
|
+
|
|
136
|
+
it 'offers a mock as a remedy, naming the setting when mocks are off' do
|
|
137
|
+
expect( notice ).to include( "Mock the header that declares a missing function, so the mock supplies it. Mocking requires :project ↳ :use_mocks.\n" )
|
|
138
|
+
end
|
|
139
|
+
|
|
140
|
+
context 'with Partials enabled' do
|
|
141
|
+
before(:each) { allow( @configurator ).to receive( :project_use_partials ).and_return( true ) }
|
|
142
|
+
|
|
143
|
+
it 'blames a function a Partial left out, and offers to select it' do
|
|
144
|
+
expect( notice ).to include(
|
|
145
|
+
"4. A Partial in this test leaves out a function the test or the Partial's code calls. A Partial carries only the functions its directive selects.\n",
|
|
146
|
+
"6. Select a function a Partial left out with +name in its directive, or select the whole module with TEST_PARTIAL_ALL_MODULE.\n"
|
|
147
|
+
)
|
|
148
|
+
end
|
|
149
|
+
end
|
|
150
|
+
|
|
151
|
+
it 'says nothing of Partials when they are off' do
|
|
152
|
+
expect( notice ).not_to include( 'Partial' )
|
|
153
|
+
end
|
|
154
|
+
end
|
|
@@ -0,0 +1,129 @@
|
|
|
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
|
+
# Each toolchain family's wording, the gating and the prescription's shape. Real compilers'
|
|
9
|
+
# output is in spec/integration/build_step_doctor_spec.rb.
|
|
10
|
+
|
|
11
|
+
require 'spec_helper'
|
|
12
|
+
require 'ceedling/diagnostics/build_step_doctor'
|
|
13
|
+
require 'ceedling/diagnostics/partial_name_specialist'
|
|
14
|
+
require 'ceedling/test_invoker/test_invoker_types'
|
|
15
|
+
|
|
16
|
+
describe PartialNameSpecialist do
|
|
17
|
+
before(:each) do
|
|
18
|
+
@configurator = double( 'configurator', project_use_partials: true )
|
|
19
|
+
@file_wrapper = double( 'file_wrapper', directory_listing: [] )
|
|
20
|
+
@loginator = double( 'loginator' )
|
|
21
|
+
allow( @loginator ).to receive( :log )
|
|
22
|
+
|
|
23
|
+
nobody = double( 'specialist', diagnoses: [] )
|
|
24
|
+
|
|
25
|
+
@doctor = BuildStepDoctor.new(
|
|
26
|
+
loginator: @loginator, header_collision_specialist: nobody, missing_symbol_specialist: nobody, duplicate_symbol_specialist: nobody,
|
|
27
|
+
partial_name_specialist: described_class.new( configurator: @configurator, file_wrapper: @file_wrapper ),
|
|
28
|
+
include_depth_specialist: nobody
|
|
29
|
+
).tap( &:setup )
|
|
30
|
+
|
|
31
|
+
@testable = TestInvokerTypes::Testable.new( name: 'test_ticker', filepath: 'test/test_ticker.c', paths: { partials: 'build/test/partials/test_ticker' } )
|
|
32
|
+
end
|
|
33
|
+
|
|
34
|
+
def prescriptions(output, source: 'test/test_ticker.c', step: :compile)
|
|
35
|
+
@doctor.diagnose( step: step, output: output, inputs: { testable: @testable, source: source } )
|
|
36
|
+
end
|
|
37
|
+
|
|
38
|
+
GCC_LOCAL = "test/test_ticker.c:9:5: error: 'partial_tick_cnt' undeclared (first use in this function)\n"
|
|
39
|
+
GCC_TYPE = "test/test_ticker.c:9:5: error: unknown type name 'ceedling_partial_ticker_ctx_t'\n"
|
|
40
|
+
|
|
41
|
+
{
|
|
42
|
+
'GCC' => GCC_LOCAL,
|
|
43
|
+
'Clang' => "test/test_ticker.c:9:5: error: use of undeclared identifier 'partial_tick_cnt'\n",
|
|
44
|
+
'MSVC' => "test\\test_ticker.c(9): error C2065: 'partial_tick_cnt': undeclared identifier\n",
|
|
45
|
+
'EDG (IAR)' => "Error[Pe020]: identifier \"partial_tick_cnt\" is undefined\n",
|
|
46
|
+
'EDG (TI, Arm, Green Hills)' => "\"test/test_ticker.c\", line 9: error #20: identifier \"partial_tick_cnt\" is undefined\n",
|
|
47
|
+
'SDCC' => "test/test_ticker.c:9: error 20: Undefined identifier 'partial_tick_cnt'\n",
|
|
48
|
+
'other compilers, generically' => "test_ticker.c 9: partial_tick_cnt not declared\n"
|
|
49
|
+
}.each do |family, output|
|
|
50
|
+
it "recognizes #{family} reporting a promoted variable's name" do
|
|
51
|
+
expect( prescriptions( output ).size ).to eq( 1 )
|
|
52
|
+
end
|
|
53
|
+
end
|
|
54
|
+
|
|
55
|
+
{
|
|
56
|
+
'GCC and Clang' => GCC_TYPE,
|
|
57
|
+
'MSVC' => "test\\test_ticker.c(9): error C2061: syntax error: identifier 'ceedling_partial_ticker_ctx_t'\n",
|
|
58
|
+
'EDG' => "Error[Pe020]: identifier \"ceedling_partial_ticker_ctx_t\" is undefined\n"
|
|
59
|
+
}.each do |family, output|
|
|
60
|
+
it "recognizes #{family} reporting a Partial type's name" do
|
|
61
|
+
expect( prescriptions( output ).first ).to include( 'PARTIAL_TYPE()' )
|
|
62
|
+
end
|
|
63
|
+
end
|
|
64
|
+
|
|
65
|
+
# A compiler reports the name the macro built, and often the macro on a note of its own
|
|
66
|
+
it 'recognizes the macro a note names when the name itself reads otherwise' do
|
|
67
|
+
output = "test/test_ticker.c:9:5: error: use of undeclared identifier 'partial_tick_cnt'\n" \
|
|
68
|
+
"test/test_ticker.c:3:30: note: expanded from macro 'PARTIAL_LOCAL_VAR'\n"
|
|
69
|
+
|
|
70
|
+
expect( prescriptions( output ).size ).to eq( 1 )
|
|
71
|
+
end
|
|
72
|
+
|
|
73
|
+
it 'prescribes nothing for a name no Partials macro builds' do
|
|
74
|
+
expect( prescriptions( "test/test_ticker.c:9:5: error: 'count' undeclared (first use in this function)\n" ) ).to eq( [] )
|
|
75
|
+
end
|
|
76
|
+
|
|
77
|
+
it 'prescribes nothing for a file other than the test file' do
|
|
78
|
+
expect( prescriptions( GCC_LOCAL, source: 'build/test/partials/test_ticker/ceedling_partial_ticker_impl.c' ) ).to eq( [] )
|
|
79
|
+
end
|
|
80
|
+
|
|
81
|
+
it 'prescribes nothing without Partials' do
|
|
82
|
+
allow( @configurator ).to receive( :project_use_partials ).and_return( false )
|
|
83
|
+
|
|
84
|
+
expect( prescriptions( GCC_LOCAL ) ).to eq( [] )
|
|
85
|
+
end
|
|
86
|
+
|
|
87
|
+
it 'covers only compiling' do
|
|
88
|
+
expect( prescriptions( GCC_LOCAL, step: :link ) ).to eq( [] )
|
|
89
|
+
end
|
|
90
|
+
|
|
91
|
+
it 'opens tentatively and explains the macro, the C rules and the corrections, left-justified' do
|
|
92
|
+
notice = prescriptions( GCC_LOCAL ).first
|
|
93
|
+
|
|
94
|
+
expect( notice ).to start_with( "The compiler output appears to report a name that PARTIAL_LOCAL_VAR() builds and nothing declares. If so," )
|
|
95
|
+
expect( notice ).to include(
|
|
96
|
+
"\n\nHOW THIS HAPPENS:\n• PARTIAL_LOCAL_VAR(function, variable) pastes its arguments into one name, partial_<function>_<variable>, as the test compiles.\n",
|
|
97
|
+
"\n\nOPTIONS:\n1. Check each argument against the function and its static variable in the module's source.\n"
|
|
98
|
+
)
|
|
99
|
+
expect( notice.lines.grep( /\A\s/ ) ).to eq( ["\n", "\n"] )
|
|
100
|
+
end
|
|
101
|
+
|
|
102
|
+
it 'explains how a type name is built from a module named with characters C cannot hold' do
|
|
103
|
+
expect( prescriptions( GCC_TYPE ).first ).to include( 'as in my_sensor for my-sensor' )
|
|
104
|
+
end
|
|
105
|
+
|
|
106
|
+
# Generation wrote the test's real names into its generated headers. The prescription lists
|
|
107
|
+
# them, whatever file holds them, and names no file.
|
|
108
|
+
context "with this test's Partials generated" do
|
|
109
|
+
before(:each) do
|
|
110
|
+
headers = ['build/test/partials/test_ticker/ceedling_partial_ticker_impl.h', 'build/test/partials/test_ticker/ceedling_partial_ticker_types.h']
|
|
111
|
+
allow( @file_wrapper ).to receive( :directory_listing ).with( 'build/test/partials/test_ticker/**/*.h' ).and_return( headers )
|
|
112
|
+
allow( @file_wrapper ).to receive( :read ).with( headers[0] ).and_return(
|
|
113
|
+
"#include \"ceedling_partial_ticker_types.h\"\nextern int partial_tick_count;\nextern ceedling_partial_ticker_tick_st_t partial_tick_st;\n"
|
|
114
|
+
)
|
|
115
|
+
allow( @file_wrapper ).to receive( :read ).with( headers[1] ).and_return( "typedef struct { int n; } ceedling_partial_ticker_tick_st_t;\n" )
|
|
116
|
+
end
|
|
117
|
+
|
|
118
|
+
it 'lists the promoted variables the test can name' do
|
|
119
|
+
notice = prescriptions( GCC_LOCAL ).first
|
|
120
|
+
|
|
121
|
+
expect( notice ).to include( "4. Promoted variables this test's Partials provide: partial_tick_count, partial_tick_st\n" )
|
|
122
|
+
expect( notice ).not_to include( '_impl.h', '_types.h' )
|
|
123
|
+
end
|
|
124
|
+
|
|
125
|
+
it 'lists the type names the test can name' do
|
|
126
|
+
expect( prescriptions( GCC_TYPE ).first ).to include( "4. Type names this test's Partials provide: ceedling_partial_ticker_tick_st_t\n" )
|
|
127
|
+
end
|
|
128
|
+
end
|
|
129
|
+
end
|
|
@@ -0,0 +1,86 @@
|
|
|
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/diagnostics/toolchain_output'
|
|
10
|
+
|
|
11
|
+
describe ToolchainOutput do
|
|
12
|
+
describe '.headers' do
|
|
13
|
+
{
|
|
14
|
+
'GCC and Clang' => "src/a.h:12:3: error: redefinition of 'struct s'",
|
|
15
|
+
'GCC include chains' => "In file included from src/a.h:2,\n from test.c:1:",
|
|
16
|
+
'IAR' => "\"src/a.h\",12 Error[Pe101]: \"s\" has already been declared",
|
|
17
|
+
'Arm armcc, TI, Green Hills' => "\"src/a.h\", line 12: error #101: \"s\" has already been declared",
|
|
18
|
+
'MSVC' => "src/a.h(12): error C2011: 's': 'struct' type redefinition",
|
|
19
|
+
'EDG declared-at notes' => "declaration is incompatible (declared at line 5 of \"src/a.h\")",
|
|
20
|
+
'quoted in prose' => "previous definition of 'x' in 'src/a.h' was here",
|
|
21
|
+
'backquoted' => "`src/a.h' line 3"
|
|
22
|
+
}.each do |family, output|
|
|
23
|
+
it "reads a header path in #{family} output" do
|
|
24
|
+
expect( described_class.headers( output ) ).to eq( ['src/a.h'] )
|
|
25
|
+
end
|
|
26
|
+
end
|
|
27
|
+
|
|
28
|
+
it 'reads C++ header extensions' do
|
|
29
|
+
expect( described_class.headers( 'a.hh:1:1 b.hpp:1:1 c.hxx(1)' ) ).to eq( ['a.hh', 'b.hpp', 'c.hxx'] )
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
it 'reads Windows paths, drive letter and backslashes included' do
|
|
33
|
+
expect( described_class.headers( "C:\\proj\\inc\\a.h(12): error C2011" ) ).to eq( ["C:\\proj\\inc\\a.h"] )
|
|
34
|
+
expect( described_class.headers( "\"C:\\proj\\inc\\a.h\",12 Error[Pe101]" ) ).to eq( ["C:\\proj\\inc\\a.h"] )
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
it 'reads paths with spaces only when quoted' do
|
|
38
|
+
expect( described_class.headers( '"my dir/a.h", line 3: error' ) ).to eq( ['my dir/a.h'] )
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
it 'lists each header once, in order of first mention' do
|
|
42
|
+
expect( described_class.headers( "b.h:1:1 a.h:2:2\nb.h:3:3" ) ).to eq( ['b.h', 'a.h'] )
|
|
43
|
+
end
|
|
44
|
+
|
|
45
|
+
it 'ignores a source file and a word that only starts like a header' do
|
|
46
|
+
expect( described_class.headers( 'test.c:1:1: in a.html and x.hint' ) ).to eq( [] )
|
|
47
|
+
end
|
|
48
|
+
|
|
49
|
+
it 'reads nothing from missing output' do
|
|
50
|
+
expect( described_class.headers( nil ) ).to eq( [] )
|
|
51
|
+
end
|
|
52
|
+
|
|
53
|
+
it 'reads a megabyte-long token in linear time' do
|
|
54
|
+
started = Process.clock_gettime( Process::CLOCK_MONOTONIC )
|
|
55
|
+
expect( described_class.headers( 'a' * 1_000_000 ) ).to eq( [] )
|
|
56
|
+
expect( Process.clock_gettime( Process::CLOCK_MONOTONIC ) - started ).to be < 1.0
|
|
57
|
+
end
|
|
58
|
+
end
|
|
59
|
+
|
|
60
|
+
describe '.objects' do
|
|
61
|
+
it 'reads object paths with the given extension in every location format' do
|
|
62
|
+
output = "/usr/bin/ld: build/out/gpio.o: in function `f':\n" \
|
|
63
|
+
"multiple definition of `f'; build/out/mock_gpio.o:(.text+0x0): first defined here\n" \
|
|
64
|
+
"\"build/out/x.o\" and build\\out\\y.o"
|
|
65
|
+
|
|
66
|
+
expect( described_class.objects( output, extension: '.o' ) ).to eq(
|
|
67
|
+
['build/out/gpio.o', 'build/out/mock_gpio.o', 'build/out/x.o', "build\\out\\y.o"]
|
|
68
|
+
)
|
|
69
|
+
end
|
|
70
|
+
|
|
71
|
+
it 'reads an Arm armlink object list' do
|
|
72
|
+
output = 'Error: L6200E: Symbol f multiply defined (by mock_gpio.o and gpio.o).'
|
|
73
|
+
|
|
74
|
+
expect( described_class.objects( output, extension: '.o' ) ).to eq( ['mock_gpio.o', 'gpio.o'] )
|
|
75
|
+
end
|
|
76
|
+
|
|
77
|
+
it 'honors another object extension' do
|
|
78
|
+
expect( described_class.objects( 'LNK2005: f already defined in gpio.obj', extension: '.obj' ) ).to eq( ['gpio.obj'] )
|
|
79
|
+
expect( described_class.objects( 'gpio.o and gpio.obj', extension: '.obj' ) ).to eq( ['gpio.obj'] )
|
|
80
|
+
end
|
|
81
|
+
|
|
82
|
+
it 'reads nothing from missing output' do
|
|
83
|
+
expect( described_class.objects( nil, extension: '.o' ) ).to eq( [] )
|
|
84
|
+
end
|
|
85
|
+
end
|
|
86
|
+
end
|
|
@@ -21,10 +21,9 @@ describe 'String#clean_encoding' do
|
|
|
21
21
|
|
|
22
22
|
# A "half" Unicode character: a multi-byte lead byte with missing or
|
|
23
23
|
# insufficient continuation bytes, as if a real multi-byte character had
|
|
24
|
-
# been clipped by a fixed-size chunk read
|
|
25
|
-
#
|
|
26
|
-
#
|
|
27
|
-
# only ever to produce clean, valid ASCII/UTF-8 output.
|
|
24
|
+
# been clipped by a fixed-size chunk read or a truncated copy/paste.
|
|
25
|
+
# clean_encoding's job is to never raise on this -- only ever to produce
|
|
26
|
+
# clean, valid ASCII/UTF-8 output.
|
|
28
27
|
describe 'incomplete multi-byte sequences ("half" Unicode characters)' do
|
|
29
28
|
it 'replaces a lead byte missing its only continuation byte (1 of 2 bytes present)' do
|
|
30
29
|
# 'Ü' (U+00DC) is 2 bytes in UTF-8: C3 9C. Only the lead byte survives.
|
|
@@ -0,0 +1,131 @@
|
|
|
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 'digest/sha2'
|
|
10
|
+
require 'ceedling/filesystem/build_roots'
|
|
11
|
+
require 'ceedling/filesystem/build_subpath'
|
|
12
|
+
|
|
13
|
+
# GH #1387: a long configured root's location is replaced by a short marker in build paths.
|
|
14
|
+
# Roots are spelled relative to the working directory, so nothing here reads the disk.
|
|
15
|
+
describe BuildRoots do
|
|
16
|
+
let(:keil_include) { "#{'../' * 7}Keil_v5/ARM/PACK/ARM/CMSIS/5.9.0/CMSIS/RTOS2/Include" }
|
|
17
|
+
|
|
18
|
+
# The marker the module documents: the root's name, then 8 hex digits of its encoded spelling,
|
|
19
|
+
# case-folded on Windows as the module folds it by default
|
|
20
|
+
def expected_marker(root, name, windows: ProjectPaths::WINDOWS)
|
|
21
|
+
key = BuildSubpath.encode( root )
|
|
22
|
+
key = key.downcase if windows
|
|
23
|
+
return "_#{name}_#{Digest::SHA256.hexdigest( key )[0, 8].upcase}"
|
|
24
|
+
end
|
|
25
|
+
|
|
26
|
+
describe '.table' do
|
|
27
|
+
it 'shortens a root outside the project, whose climb and location no build step reads' do
|
|
28
|
+
table = described_class.table( [keil_include] )
|
|
29
|
+
|
|
30
|
+
expect(table.marker_for( keil_include )).to eq( expected_marker( keil_include, 'Include' ) )
|
|
31
|
+
expect(table.root_for( table.marker_for( keil_include ) )).to eq( keil_include )
|
|
32
|
+
end
|
|
33
|
+
|
|
34
|
+
it 'shortens a deep root inside the project' do
|
|
35
|
+
root = 'vendor/acme/sdk/v3/drivers/hal'
|
|
36
|
+
expect(described_class.table( [root] ).marker_for( root )).to eq( expected_marker( root, 'hal' ) )
|
|
37
|
+
end
|
|
38
|
+
|
|
39
|
+
it 'leaves a root alone when its marker would be no shorter than its own spelling' do
|
|
40
|
+
table = described_class.table( ['src', 'src2/a', '.', '..'] )
|
|
41
|
+
|
|
42
|
+
expect(table.entries).to be_empty
|
|
43
|
+
end
|
|
44
|
+
|
|
45
|
+
it 'shortens a root once its marker is shorter, however slightly' do
|
|
46
|
+
root = 'foo/bar/baz/abc' # 15 characters, and its marker 13
|
|
47
|
+
|
|
48
|
+
expect(described_class.table( [root] ).marker_for( root ).length).to eq( 13 )
|
|
49
|
+
end
|
|
50
|
+
|
|
51
|
+
it 'drops leading underscores from the name, so a marker begins with exactly one' do
|
|
52
|
+
private_root = 'vendor/acme/sdk/v3/drivers/_private'
|
|
53
|
+
blank_root = 'vendor/acme/sdk/v3/drivers/___'
|
|
54
|
+
table = described_class.table( [private_root, blank_root] )
|
|
55
|
+
|
|
56
|
+
expect(table.marker_for( private_root )).to eq( expected_marker( private_root, 'private' ) )
|
|
57
|
+
expect(table.marker_for( blank_root )).to eq( expected_marker( blank_root, 'root' ) )
|
|
58
|
+
end
|
|
59
|
+
|
|
60
|
+
# Test and release builds share one table, and only a test build escapes a directory named `_t_`
|
|
61
|
+
it "keys a root's hash on the spelling a release build gives it" do
|
|
62
|
+
root = 'lib/vendor/_t_/acme/sdk/hal'
|
|
63
|
+
key = ProjectPaths::WINDOWS ? root.downcase : root
|
|
64
|
+
|
|
65
|
+
expect(described_class.table( [root] ).marker_for( root )).to eq( "_hal_#{Digest::SHA256.hexdigest( key )[0, 8].upcase}" )
|
|
66
|
+
end
|
|
67
|
+
|
|
68
|
+
it 'gives a marker the shape decoding recognizes' do
|
|
69
|
+
expect(described_class.table( [keil_include] ).marker_for( keil_include )).to match( BuildRoots::MARKER )
|
|
70
|
+
end
|
|
71
|
+
|
|
72
|
+
it 'gives two same-named roots different markers' do
|
|
73
|
+
other = "#{'../' * 7}Keil_v5/ARM/PACK/ARM/CMSIS/5.9.0/CMSIS/Core/Include"
|
|
74
|
+
table = described_class.table( [keil_include, other] )
|
|
75
|
+
|
|
76
|
+
expect(table.marker_for( keil_include )).to_not eq( table.marker_for( other ) )
|
|
77
|
+
end
|
|
78
|
+
|
|
79
|
+
it 'gives a root the same marker every time' do
|
|
80
|
+
expect(described_class.table( [keil_include] ).marker_for( keil_include )).to eq( described_class.table( [keil_include] ).marker_for( keil_include ) )
|
|
81
|
+
end
|
|
82
|
+
|
|
83
|
+
# A whole tree shares one marker and keeps its own structure below it
|
|
84
|
+
it 'considers only the outermost of nested roots' do
|
|
85
|
+
outer = 'vendor/acme/sdk/v3'
|
|
86
|
+
inner = 'vendor/acme/sdk/v3/drivers/hal/include'
|
|
87
|
+
table = described_class.table( [inner, outer] )
|
|
88
|
+
|
|
89
|
+
expect(table.entries.map(&:first)).to eq( [outer] )
|
|
90
|
+
end
|
|
91
|
+
|
|
92
|
+
it 'shortens nothing below a shallow outermost root, even a deep root inside it' do
|
|
93
|
+
expect(described_class.table( ['src', 'src/a/b/c/d/e/f'] ).entries).to be_empty
|
|
94
|
+
end
|
|
95
|
+
|
|
96
|
+
it 'finds the shortened root holding a directory, if any' do
|
|
97
|
+
table = described_class.table( [keil_include, 'src'] )
|
|
98
|
+
|
|
99
|
+
expect(table.containing( ProjectPaths.absolute( "#{keil_include}/os" ) )).to eq( keil_include )
|
|
100
|
+
expect(table.containing( ProjectPaths.absolute( keil_include ) )).to eq( keil_include )
|
|
101
|
+
expect(table.containing( ProjectPaths.absolute( 'src/drv' ) )).to be_nil
|
|
102
|
+
end
|
|
103
|
+
|
|
104
|
+
# macOS and Windows file systems fold case, and Windows spellings of one place may differ in it
|
|
105
|
+
it 'keys its hash on a case-folded spelling on Windows, so two spellings of one root get one marker' do
|
|
106
|
+
lower = keil_include.downcase
|
|
107
|
+
upper = described_class.table( [keil_include], windows: true ).marker_for( keil_include )
|
|
108
|
+
|
|
109
|
+
expect(upper).to eq( expected_marker( keil_include, 'Include', windows: true ) )
|
|
110
|
+
expect(described_class.table( [lower], windows: true ).marker_for( lower ).delete_prefix( '_include' )).to eq( upper.delete_prefix( '_Include' ) )
|
|
111
|
+
end
|
|
112
|
+
|
|
113
|
+
it 'holds a digest that tells two tables apart' do
|
|
114
|
+
expect(described_class.table( [keil_include] ).digest).to_not eq( described_class.table( [] ).digest )
|
|
115
|
+
expect(described_class.table( [keil_include] ).digest).to eq( described_class.table( [keil_include] ).digest )
|
|
116
|
+
end
|
|
117
|
+
end
|
|
118
|
+
|
|
119
|
+
describe '.collisions' do
|
|
120
|
+
it 'reports two roots that would share a marker' do
|
|
121
|
+
other = "#{'../' * 7}Keil_v5/Other/Include"
|
|
122
|
+
allow(Digest::SHA256).to receive(:hexdigest).and_return( 'ab' * 32 )
|
|
123
|
+
|
|
124
|
+
expect(described_class.collisions( [keil_include, other] )).to eq( [[keil_include, other]] )
|
|
125
|
+
end
|
|
126
|
+
|
|
127
|
+
it 'reports nothing for roots with distinct markers' do
|
|
128
|
+
expect(described_class.collisions( [keil_include, 'vendor/acme/sdk/v3/drivers/hal'] )).to be_empty
|
|
129
|
+
end
|
|
130
|
+
end
|
|
131
|
+
end
|