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
|
@@ -20,7 +20,8 @@ class PreprocessinatorFileAssembler
|
|
|
20
20
|
:file_wrapper,
|
|
21
21
|
:parsing_parcels,
|
|
22
22
|
:loginator,
|
|
23
|
-
:reportinator
|
|
23
|
+
:reportinator,
|
|
24
|
+
:build_step_doctor
|
|
24
25
|
)
|
|
25
26
|
|
|
26
27
|
def collect_mockable_header_file_contents(
|
|
@@ -33,35 +34,18 @@ class PreprocessinatorFileAssembler
|
|
|
33
34
|
include_paths:,
|
|
34
35
|
extras:
|
|
35
36
|
)
|
|
36
|
-
contents = []
|
|
37
|
-
|
|
38
37
|
preprocessed_filepath = @file_path_utils.form_preprocessed_file_full_expansion_filepath( filepath, test )
|
|
39
38
|
|
|
40
39
|
@file_wrapper.mkdir( File.dirname( preprocessed_filepath ) )
|
|
41
40
|
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
# Additional arguments
|
|
46
|
-
flags,
|
|
47
|
-
# Argument replacement
|
|
48
|
-
filepath,
|
|
49
|
-
preprocessed_filepath,
|
|
50
|
-
defines,
|
|
51
|
-
include_paths
|
|
52
|
-
)
|
|
53
|
-
@tool_executor.exec( command )
|
|
54
|
-
|
|
55
|
-
# `preprocessed_filepath` is this same build's own gcc output -- open_with_retry
|
|
56
|
-
# rides out the file briefly not yet being visible right after the shell-out exits.
|
|
57
|
-
@file_wrapper.open_with_retry( preprocessed_filepath, 'r' ) do |file|
|
|
58
|
-
contents = @preprocessinator_reconstructor.extract_file_as_array_from_expansion( file, filepath )
|
|
59
|
-
end
|
|
41
|
+
expand_fully( filepath: filepath, preprocessed_filepath: preprocessed_filepath, flags: flags, defines: defines, include_paths: include_paths )
|
|
42
|
+
|
|
43
|
+
contents = collect_own_lines( source_filepath: filepath, preprocessed_filepath: preprocessed_filepath )
|
|
60
44
|
|
|
61
45
|
# Bail out if no extras are required
|
|
62
46
|
return contents, [], nil if !extras
|
|
63
47
|
|
|
64
|
-
# Try to find an #include guard
|
|
48
|
+
# Try to find an #include guard near the top of the file's code. This name is used two ways:
|
|
65
49
|
# 1. To exclude the guard's own #define from the macro definitions preserved as "extras" below
|
|
66
50
|
# (it would be redundant -- assemble_preprocessed_header_file writes its own guard).
|
|
67
51
|
# 2. Returned to the caller so the reconstructed header can reuse this exact guard name (see
|
|
@@ -73,12 +57,7 @@ class PreprocessinatorFileAssembler
|
|
|
73
57
|
# If no guard is found (e.g. the header uses `#pragma once` or has none), `nil` flows through and
|
|
74
58
|
# assemble_preprocessed_header_file falls back to a synthetic guard, matching prior behavior.
|
|
75
59
|
include_guard =
|
|
76
|
-
@preprocessinator_reconstructor.extract_include_guard(
|
|
77
|
-
@file_wrapper.read(
|
|
78
|
-
filepath,
|
|
79
|
-
2048
|
|
80
|
-
).clean_encoding
|
|
81
|
-
)
|
|
60
|
+
@preprocessinator_reconstructor.extract_include_guard( @file_wrapper.read( filepath ).clean_encoding )
|
|
82
61
|
|
|
83
62
|
if fallback
|
|
84
63
|
msg = @reportinator.generate_module_progress(
|
|
@@ -104,18 +83,17 @@ class PreprocessinatorFileAssembler
|
|
|
104
83
|
end
|
|
105
84
|
|
|
106
85
|
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
86
|
+
# The lines a preprocessor run kept from `source_filepath`, one per element. A full
|
|
87
|
+
# expansion can wrap one source line across several, which `rejoin` joins back.
|
|
88
|
+
# Directives-only output never wraps, so its readers pass `rejoin: false`. Rejoining
|
|
89
|
+
# there would only merge distinct lines a marker puts at the same count.
|
|
90
|
+
#
|
|
91
|
+
# `preprocessed_filepath` is this same build's own preprocessor output. open_with_retry
|
|
92
|
+
# rides out the file briefly not yet being visible right after the shell-out exits.
|
|
93
|
+
def collect_own_lines(source_filepath:, preprocessed_filepath:, rejoin: true)
|
|
114
94
|
@file_wrapper.open_with_retry( preprocessed_filepath, 'r' ) do |file|
|
|
115
|
-
|
|
95
|
+
return @preprocessinator_reconstructor.extract_file_as_array_from_expansion( file, source_filepath, rejoin: rejoin )
|
|
116
96
|
end
|
|
117
|
-
|
|
118
|
-
return contents
|
|
119
97
|
end
|
|
120
98
|
|
|
121
99
|
# Extract macro definitions and pragmas from a file using text scanning (fallback mode).
|
|
@@ -124,7 +102,7 @@ class PreprocessinatorFileAssembler
|
|
|
124
102
|
# Mirrors the fallback branch of collect_mockable_header_file_contents.
|
|
125
103
|
def collect_macros_and_pragmas_fallback(source_filepath:, defines: [])
|
|
126
104
|
include_guard = @preprocessinator_reconstructor.extract_include_guard(
|
|
127
|
-
@file_wrapper.read( source_filepath
|
|
105
|
+
@file_wrapper.read( source_filepath ).clean_encoding
|
|
128
106
|
)
|
|
129
107
|
|
|
130
108
|
_contents = _active_content_for( fallback: true, filepath: source_filepath, defines: defines )
|
|
@@ -176,21 +154,6 @@ class PreprocessinatorFileAssembler
|
|
|
176
154
|
end
|
|
177
155
|
|
|
178
156
|
|
|
179
|
-
def collect_file_contents_from_full_expansion(source_filepath:, test:)
|
|
180
|
-
contents = []
|
|
181
|
-
|
|
182
|
-
full_expansion_filepath = @file_path_utils.form_preprocessed_file_full_expansion_filepath( source_filepath, test )
|
|
183
|
-
|
|
184
|
-
# `full_expansion_filepath` is this same build's own gcc output -- open_with_retry
|
|
185
|
-
# rides out the file briefly not yet being visible right after the shell-out exits.
|
|
186
|
-
@file_wrapper.open_with_retry( full_expansion_filepath, 'r' ) do |file|
|
|
187
|
-
contents = @preprocessinator_reconstructor.extract_file_as_array_from_expansion( file, source_filepath )
|
|
188
|
-
end
|
|
189
|
-
|
|
190
|
-
return contents
|
|
191
|
-
end
|
|
192
|
-
|
|
193
|
-
|
|
194
157
|
# `filepath` is the header's own path below its configured root, and its only use is the
|
|
195
158
|
# synthetic guard below. A bare basename there would give two headers sharing one name
|
|
196
159
|
# the same guard.
|
|
@@ -252,30 +215,13 @@ class PreprocessinatorFileAssembler
|
|
|
252
215
|
defines:,
|
|
253
216
|
include_paths:
|
|
254
217
|
)
|
|
255
|
-
contents = []
|
|
256
|
-
|
|
257
218
|
preprocessed_filepath = @file_path_utils.form_preprocessed_file_full_expansion_filepath( filepath, test )
|
|
258
219
|
|
|
259
220
|
@file_wrapper.mkdir( File.dirname( preprocessed_filepath ) )
|
|
260
221
|
|
|
261
|
-
|
|
262
|
-
command = @tool_executor.build_command_line(
|
|
263
|
-
@configurator.tools_test_file_full_preprocessor,
|
|
264
|
-
# Additional arguments
|
|
265
|
-
flags,
|
|
266
|
-
# Argument replacement
|
|
267
|
-
filepath,
|
|
268
|
-
preprocessed_filepath,
|
|
269
|
-
defines,
|
|
270
|
-
include_paths
|
|
271
|
-
)
|
|
272
|
-
@tool_executor.exec( command )
|
|
222
|
+
expand_fully( filepath: filepath, preprocessed_filepath: preprocessed_filepath, flags: flags, defines: defines, include_paths: include_paths )
|
|
273
223
|
|
|
274
|
-
|
|
275
|
-
# rides out the file briefly not yet being visible right after the shell-out exits.
|
|
276
|
-
@file_wrapper.open_with_retry( preprocessed_filepath, 'r' ) do |file|
|
|
277
|
-
contents = @preprocessinator_reconstructor.extract_file_as_array_from_expansion( file, filepath )
|
|
278
|
-
end
|
|
224
|
+
contents = collect_own_lines( source_filepath: filepath, preprocessed_filepath: preprocessed_filepath )
|
|
279
225
|
|
|
280
226
|
if fallback
|
|
281
227
|
msg = @reportinator.generate_module_progress(
|
|
@@ -318,6 +264,16 @@ class PreprocessinatorFileAssembler
|
|
|
318
264
|
|
|
319
265
|
private
|
|
320
266
|
|
|
267
|
+
# Runs GCC with full preprocessor expansion. This run has no fallback, so a failure goes
|
|
268
|
+
# to the build step doctor before it is raised.
|
|
269
|
+
def expand_fully(filepath:, preprocessed_filepath:, flags:, defines:, include_paths:)
|
|
270
|
+
tool = @configurator.tools_test_file_full_preprocessor
|
|
271
|
+
command = @tool_executor.build_command_line( tool, flags, filepath, preprocessed_filepath, defines, include_paths )
|
|
272
|
+
inputs = { tool: tool, source: filepath, search_paths: include_paths, flags: flags, defines: defines }
|
|
273
|
+
|
|
274
|
+
@build_step_doctor.attend( step: :preprocess, inputs: inputs ) { @tool_executor.exec( command ) }
|
|
275
|
+
end
|
|
276
|
+
|
|
321
277
|
# Returns the content string used to extract pragmas, macro definitions, and
|
|
322
278
|
# test directives -- either by binary-mode-reading and conditional-filtering
|
|
323
279
|
# the original file (fallback mode) or by reading the already directives-only
|
|
@@ -342,7 +298,7 @@ class PreprocessinatorFileAssembler
|
|
|
342
298
|
# rides out the file briefly not yet being visible right after the shell-out exits.
|
|
343
299
|
@file_wrapper.open_with_retry( directives_only_filepath, 'r' ) do |file|
|
|
344
300
|
# TODO: Modify to process line-at-a-time for memory savings & performance boost
|
|
345
|
-
@preprocessinator_reconstructor.extract_file_as_string_from_expansion( file, filepath )
|
|
301
|
+
@preprocessinator_reconstructor.extract_file_as_string_from_expansion( file, filepath, rejoin: false )
|
|
346
302
|
end
|
|
347
303
|
end
|
|
348
304
|
end
|
|
@@ -364,7 +320,7 @@ class PreprocessinatorFileAssembler
|
|
|
364
320
|
|
|
365
321
|
public
|
|
366
322
|
|
|
367
|
-
def assemble_preprocessed_code_file(
|
|
323
|
+
def assemble_preprocessed_code_file(preprocessed_filepath:, contents:, extras:, includes:)
|
|
368
324
|
# Write contents of final preprocessed file a line at a time
|
|
369
325
|
# ----------------------------------------------------------
|
|
370
326
|
# Binary mode: `contents` lines below come from an upstream preprocessed
|
|
@@ -12,6 +12,11 @@ require 'ceedling/exceptions'
|
|
|
12
12
|
|
|
13
13
|
class PreprocessinatorReconstructor
|
|
14
14
|
|
|
15
|
+
# How much of a header's code, comments and blank lines left out, is searched for its include
|
|
16
|
+
# guard. The guard pair opens a header by construction. A limit keeps a `#ifndef X` / `#define X`
|
|
17
|
+
# default deep in a `#pragma once` header from passing for one.
|
|
18
|
+
INCLUDE_GUARD_SCAN_BYTES = 2048
|
|
19
|
+
|
|
15
20
|
constructor :parsing_parcels, :file_wrapper
|
|
16
21
|
|
|
17
22
|
##
|
|
@@ -26,8 +31,11 @@ class PreprocessinatorReconstructor
|
|
|
26
31
|
## ignoring text based on preprocessor statements referencing the file we're
|
|
27
32
|
## seeking to reassemble.
|
|
28
33
|
##
|
|
29
|
-
## Note that the same text handling approach applies to full preprocessor
|
|
30
|
-
## expansion as directives only expansion.
|
|
34
|
+
## Note that the same text handling approach applies to full preprocessor
|
|
35
|
+
## expansion as directives only expansion, with one difference. Full expansion
|
|
36
|
+
## can wrap one source line's expansion across several physical lines, which
|
|
37
|
+
## `rejoin` puts back together. Directives-only output expands no macros and
|
|
38
|
+
## never wraps a line, so its readers pass `rejoin: false`.
|
|
31
39
|
##
|
|
32
40
|
## Example preprocessed expansion output
|
|
33
41
|
## --------------------------------------
|
|
@@ -80,31 +88,31 @@ class PreprocessinatorReconstructor
|
|
|
80
88
|
## }
|
|
81
89
|
|
|
82
90
|
# `input` must have the interface of IO -- StringIO for testing or File in typical use
|
|
83
|
-
def extract_file_as_array_from_expansion(input, filepath)
|
|
91
|
+
def extract_file_as_array_from_expansion(input, filepath, rejoin: true)
|
|
84
92
|
lines = []
|
|
85
|
-
_scan_expansion_for_file(input, filepath) { |line| lines << line }
|
|
93
|
+
_scan_expansion_for_file(input, filepath, rejoin: rejoin) { |line| lines << line }
|
|
86
94
|
return lines
|
|
87
95
|
end
|
|
88
96
|
|
|
89
97
|
|
|
90
98
|
# Simple variation of preceding that returns file contents as single string
|
|
91
|
-
def extract_file_as_string_from_expansion(input, filepath)
|
|
92
|
-
return extract_file_as_array_from_expansion(input, filepath).join( "\n" )
|
|
99
|
+
def extract_file_as_string_from_expansion(input, filepath, rejoin: true)
|
|
100
|
+
return extract_file_as_array_from_expansion(input, filepath, rejoin: rejoin).join( "\n" )
|
|
93
101
|
end
|
|
94
102
|
|
|
95
103
|
|
|
96
104
|
# Writes only C code from `input` preprocessor expansion belonging to `filepath`
|
|
97
105
|
# to `output` IO object incrementally (one logical line at a time) without building
|
|
98
106
|
# an intermediate array. `output` must respond to `puts` (e.g. File or StringIO).
|
|
99
|
-
def compact_from_expansion(input:, filepath:, output:)
|
|
100
|
-
_scan_expansion_for_file(input, filepath) { |line| output.puts(line) }
|
|
107
|
+
def compact_from_expansion(input:, filepath:, output:, rejoin: true)
|
|
108
|
+
_scan_expansion_for_file(input, filepath, rejoin: rejoin) { |line| output.puts(line) }
|
|
101
109
|
end
|
|
102
110
|
|
|
103
111
|
|
|
104
112
|
# File-based convenience wrapper around `compact_from_expansion`.
|
|
105
113
|
# Opens `input_filepath` for reading and `output_filepath` for writing,
|
|
106
114
|
# then delegates to `compact_from_expansion` with the resulting IO objects.
|
|
107
|
-
def compact_file_from_expansion(input_filepath:, source_filepath:, output_filepath:)
|
|
115
|
+
def compact_file_from_expansion(input_filepath:, source_filepath:, output_filepath:, rejoin: true)
|
|
108
116
|
# Binary mode on both ends: GCC output under non-C locale contains non-ASCII
|
|
109
117
|
# bytes (localized markers; the whole-buffer clean_encoding in
|
|
110
118
|
# _scan_expansion_for_file handles content), and the compacted output is
|
|
@@ -120,7 +128,7 @@ class PreprocessinatorReconstructor
|
|
|
120
128
|
begin
|
|
121
129
|
@file_wrapper.open_with_retry( input_filepath, 'rb' ) do |input|
|
|
122
130
|
@file_wrapper.open( output_filepath, 'wb' ) do |output|
|
|
123
|
-
compact_from_expansion( input: input, filepath: source_filepath, output: output )
|
|
131
|
+
compact_from_expansion( input: input, filepath: source_filepath, output: output, rejoin: rejoin )
|
|
124
132
|
end
|
|
125
133
|
end
|
|
126
134
|
rescue => e
|
|
@@ -224,11 +232,18 @@ class PreprocessinatorReconstructor
|
|
|
224
232
|
end
|
|
225
233
|
|
|
226
234
|
|
|
227
|
-
#
|
|
235
|
+
# Whether a header guards itself with `#pragma once`, looked for in the same leading code as
|
|
236
|
+
# an include guard
|
|
237
|
+
def pragma_once?(file_contents)
|
|
238
|
+
return leading_code( file_contents, INCLUDE_GUARD_SCAN_BYTES ).match?( /^\s*#\s*pragma\s+once\b/ )
|
|
239
|
+
end
|
|
240
|
+
|
|
241
|
+
# Find include guard in a whole file's contents as string. Only code counts toward the scan
|
|
242
|
+
# window, so a long license comment ahead of the guard doesn't hide it.
|
|
228
243
|
def extract_include_guard(file_contents)
|
|
229
244
|
# Look for first occurrence of #ifndef <sring> followed by #define <string>
|
|
230
245
|
regex = /#\s*ifndef\s+(\w+)(?:\s*\n)+\s*#\s*define\s+(\w+)/
|
|
231
|
-
matches = file_contents.match( regex )
|
|
246
|
+
matches = leading_code( file_contents, INCLUDE_GUARD_SCAN_BYTES ).match( regex )
|
|
232
247
|
|
|
233
248
|
# Return if no match results
|
|
234
249
|
return nil if matches.nil?
|
|
@@ -286,8 +301,14 @@ class PreprocessinatorReconstructor
|
|
|
286
301
|
## Yields one complete logical line at a time to the given block.
|
|
287
302
|
## A single `pending_line` buffer is held to allow aggregation of preprocessor-wrapped
|
|
288
303
|
## expansions (multiple physical lines at the same logical line number) before yielding.
|
|
304
|
+
## `rejoin: false` turns that aggregation off.
|
|
289
305
|
##
|
|
290
|
-
|
|
306
|
+
## A directive is never joined to a neighbor. The preprocessor writes each directive it
|
|
307
|
+
## keeps on a line of its own, such as a mid-line _Pragma() between two markers for the
|
|
308
|
+
## same source line. A marker that names a line already counted would otherwise glue a
|
|
309
|
+
## declaration onto an empty #define before it.
|
|
310
|
+
##
|
|
311
|
+
def _scan_expansion_for_file(input, filepath, rejoin: true, &block)
|
|
291
312
|
# Expand filepath under inspection to ensure proper match
|
|
292
313
|
extraction_filepath = File.expand_path( filepath )
|
|
293
314
|
# Preprocessor directive blocks generally take the form of '# <digits> <text> [optional digits]'.
|
|
@@ -300,6 +321,8 @@ class PreprocessinatorReconstructor
|
|
|
300
321
|
directive = /^\s*# \d+ \"/
|
|
301
322
|
# Line markers have the specific form of '# <digits> "path/filename.ext" [optional digits]' (see above)
|
|
302
323
|
line_marker = /^\s*#\s(\d+)\s\"(.+)\"/
|
|
324
|
+
# Any other directive the preprocessor kept, such as #define or #pragma
|
|
325
|
+
kept_directive = /\A\s*#/
|
|
303
326
|
# Boolean to ping pong between line-by-line extract/ignore
|
|
304
327
|
extract = false
|
|
305
328
|
|
|
@@ -356,7 +379,8 @@ class PreprocessinatorReconstructor
|
|
|
356
379
|
end
|
|
357
380
|
|
|
358
381
|
# If the linemarker line number hasn't advanced, aggregate the expanded line into pending
|
|
359
|
-
if (last_line_num == line_num) and !pending_line.nil?
|
|
382
|
+
if rejoin and (last_line_num == line_num) and !pending_line.nil? and
|
|
383
|
+
!pending_line.match?( kept_directive ) and !_line.match?( kept_directive )
|
|
360
384
|
# Append the stripped line to the pending line
|
|
361
385
|
# Include a space in the concatenation unless it's a semicolon or pending_line is blank
|
|
362
386
|
pending_line = (_line == ';' or pending_line.empty?) ? (pending_line + _line) : (pending_line + ' ' + _line)
|
|
@@ -388,6 +412,19 @@ class PreprocessinatorReconstructor
|
|
|
388
412
|
end
|
|
389
413
|
|
|
390
414
|
|
|
415
|
+
# The first `bytes` of a file's code, comments and blank lines left out
|
|
416
|
+
def leading_code(file_contents, bytes)
|
|
417
|
+
code = +''
|
|
418
|
+
@parsing_parcels.code_lines( file_contents ) do |line|
|
|
419
|
+
next if line.strip.empty?
|
|
420
|
+
code << line.rstrip << "\n"
|
|
421
|
+
break if code.bytesize >= bytes
|
|
422
|
+
end
|
|
423
|
+
|
|
424
|
+
return code.byteslice( 0, bytes ).scrub
|
|
425
|
+
end
|
|
426
|
+
|
|
427
|
+
|
|
391
428
|
def extract_multiline_directives(file_contents, directive)
|
|
392
429
|
results = []
|
|
393
430
|
|
data/lib/ceedling/setupinator.rb
CHANGED
|
@@ -28,7 +28,7 @@ class Setupinator
|
|
|
28
28
|
|
|
29
29
|
# The application objects setup uses, taken from the object hash rather than a DIY
|
|
30
30
|
# constructor, which validates aspects of setup
|
|
31
|
-
COLLABORATORS = %i[configurator loginator reportinator plugin_manager plugin_reportinator test_runner_manager].freeze
|
|
31
|
+
COLLABORATORS = %i[configurator loginator reportinator plugin_manager plugin_reportinator test_runner_manager file_wrapper win_path_prober file_path_utils].freeze
|
|
32
32
|
|
|
33
33
|
attr_reader :config_hash
|
|
34
34
|
|
|
@@ -66,8 +66,7 @@ class Setupinator
|
|
|
66
66
|
complete_configuration( app_cfg ) # 5.
|
|
67
67
|
validate_final_configuration() # 6.
|
|
68
68
|
|
|
69
|
-
# 7.
|
|
70
|
-
@configurator.build( app_cfg[:ceedling_lib_path], app_cfg[:logging_path], config_hash, :environment )
|
|
69
|
+
build_configuration( app_cfg ) # 7.
|
|
71
70
|
|
|
72
71
|
load_plugins() # 8.
|
|
73
72
|
end
|
|
@@ -192,6 +191,20 @@ private
|
|
|
192
191
|
@configurator.validate_final( config_hash )
|
|
193
192
|
end
|
|
194
193
|
|
|
194
|
+
##
|
|
195
|
+
## 7. Build configuration
|
|
196
|
+
##
|
|
197
|
+
|
|
198
|
+
# Partially flatten config + build Configurator accessors and globals. FileWrapper
|
|
199
|
+
# reports path lengths from the first file a command touches, before any configuration
|
|
200
|
+
# exists, so it learns the Windows path limit, and the prober that decides it, here. The
|
|
201
|
+
# long configured roots build paths shorten are written to the build root and logged.
|
|
202
|
+
def build_configuration(app_cfg)
|
|
203
|
+
@configurator.build( app_cfg[:ceedling_lib_path], app_cfg[:logging_path], config_hash, :environment )
|
|
204
|
+
@file_wrapper.configure_win_path_limit( mode: @configurator.project_win_path_limit, prober: @win_path_prober )
|
|
205
|
+
@file_path_utils.publish_build_roots.each { |root, marker| @loginator.log( "#{marker} ➡️ #{root}", Verbosity::DEBUG ) }
|
|
206
|
+
end
|
|
207
|
+
|
|
195
208
|
##
|
|
196
209
|
## 8. Final plugins handling
|
|
197
210
|
##
|
|
@@ -1,22 +1,31 @@
|
|
|
1
1
|
# Sibling-Header Isolation and Reactive Collision Guidance
|
|
2
2
|
|
|
3
|
-
A mock or a Partial exists to substitute one header's content for another. That substitution only ever sees what a test file's own `#include` directives name directly -- it has no visibility into a module's full, transitive `#include` closure. A module reaching the *same real header* a second way, through some other, unrelated `#include` chain, can slip right past the substitution: the mock or Partial still gets generated and still gets `#include`d, but the real header's own content ends up in the compile too, unmocked.
|
|
3
|
+
A mock or a Partial exists to substitute one header's content for another. That substitution only ever sees what a test file's own `#include` directives name directly -- it has no visibility into a module's full, transitive `#include` closure. A module reaching the *same real header* a second way, through some other, unrelated `#include` chain, can slip right past the substitution: the mock or Partial still gets generated and still gets `#include`d, but the real header's own content ends up in the compile too, unmocked. `TestBuildExecutor` prevents this gap where it can, and the build step doctor explains a collision that prevention can't resolve.
|
|
4
4
|
|
|
5
5
|
## Why it happens: quote-include's same-directory rule
|
|
6
6
|
|
|
7
|
-
C's `#include "..."` form checks the *including file's own directory* before it ever consults a search path (`-I`). A mock or Partial substitutes a header by relying on search-path order -- the mocks/Partials directory is listed ahead of the real header
|
|
7
|
+
C's `#include "..."` form checks the *including file's own directory* before it ever consults a search path (`-I`). A mock or Partial substitutes a header by relying on search-path order -- the mocks/Partials directory is listed ahead of the search path that reaches the real header, so an ordinary `#include "the_header.h"` finds the substitute first. That ordering means nothing, though, to a *different* file that happens to live in the same directory as the real header and does its own `#include "the_header.h"`: that file's own directory is checked first, finds the real header sitting right beside it, and never consults `-I` at all. Nothing about this is a Ceedling bug in the ordinary sense -- it's C's own quote-include resolution rule, doing exactly what it's specified to do, in a situation Ceedling's substitution scheme didn't account for.
|
|
8
8
|
|
|
9
9
|
Every remedy below works the same way: a file is copied alone into a fresh directory, where its quoted `#include` has no neighbor to find. `QuoteIncludeIsolator` (`lib/ceedling/quote_include_isolator.rb`) owns that staging, its release, and mapping a copy's path back to its original.
|
|
10
10
|
|
|
11
|
+
A copy is a tool for compiling, never a dependency. Its directory takes a new name every time and is removed afterward, so dependency tracking records the original wherever a copy was used. An unchanged rebuild then compiles nothing, and an edit to an original rebuilds what reached it through a copy.
|
|
12
|
+
|
|
11
13
|
## Prevention: `isolate_sibling_headers`
|
|
12
14
|
|
|
13
15
|
Right after a test file's own compile, its freshly-written `.d` dependency file already reveals every real header reachable from it -- including a header whose content only got *reached*, not necessarily *used* (gcc's dependency output is guard-blind: a header still counts as a dependency even when its content was fully skipped by an already-satisfied include guard). For prevention, that's enough: knowing two files merely *could* collide is all a fix needs, since it doesn't have to resolve which copy would actually win.
|
|
14
16
|
|
|
15
|
-
|
|
17
|
+
Isolation can redirect a quoted `#include` only to a file of the same name earlier on the search path. CMock writes one for each header it mocks under `:cmock` ↳ `:treat_inlines: :include`: an inline-stripped copy in the mocks directory. Nothing else does, so isolation considers only those headers (`TestSubstitutions#shadowed_headers`). With other mocks and with Partials, a sibling's quoted `#include` would find the real header through the search paths anyway.
|
|
18
|
+
|
|
19
|
+
`isolate_sibling_headers` (in `TestBuildExecutor`) parses that `.d` file and checks, for each of those headers, whether the same directory also holds some other header the test's compile reached and that quote-includes it by name. Any it finds get staged, together, into one new directory of their own via `QuoteIncludeIsolator#isolate` -- copied there alone, with nothing else beside them, so their own `#include` of the real header can no longer take the same-directory shortcut and gets forced through search paths instead, where CMock's copy is listed first. Each copy opens with `#line 1 "<original path>"`, so diagnostics, `__FILE__`, debug info and coverage data name the original header. The test's own object then recompiles with that isolation directory prepended to its search paths.
|
|
20
|
+
|
|
21
|
+
Isolation acts only one level deep, and only around a header CMock copies. A directory elsewhere in the same dependency list can hold several headers the test reaches, none of them mocked or Partialized. It is shaped the same way, but nothing designates which occupant should win, so isolation leaves it alone and logs nothing. If the compilation then fails with a collision there, the doctor's shared-directory diagnosis explains it (see below).
|
|
16
22
|
|
|
17
|
-
|
|
23
|
+
The isolated directory this produces is a *throwaway*: it's always freshly, fully derived from files already tracked by the dependency tracker, so it can never itself go stale independently and needs no tracking of its own. The test's own retry compile writes to a separate dependencies path that's never registered -- only the original attempt's own `.d` file (real headers, real paths) is what the dependency tracker keeps, unchanged. The directory itself is scoped to this one test's whole build, not to a single object: every other object in the same test needs to see the same corrected search paths, which is why `stage_build_objects` compiles a test's own file in a batch fully completed before any other object in that test starts (a real barrier, since `Batchinator#exec` blocks until every item in a batch finishes -- without it, another object could finish compiling with the original, uncorrected paths before the fix landed). The testable keeps the whole isolation, its directory and its copies, in `header_isolation`. The directory is removed once, after both batches of the whole build finish or when a compile fails.
|
|
18
24
|
|
|
19
|
-
|
|
25
|
+
Every later object compiled with the isolation directory keeps it out of its dependencies two ways:
|
|
26
|
+
|
|
27
|
+
- Its staleness meta records its search paths without the directory, plus the isolated originals under `isolated:`. A change to which files are isolated rebuilds the object, while the directory's own name never counts.
|
|
28
|
+
- `QuoteIncludeIsolator#restore_dependencies` rewrites its `.d` file to name each original in place of its copy before it is registered. An edit to an original then rebuilds every object that reached it through the copy.
|
|
20
29
|
|
|
21
30
|
`extract_bare_includes` (`preprocess/preprocessinator_includes_handler.rb`) stages an isolated copy for an unrelated reason -- limiting a preprocessor scan to a file's own top-level `#include`s -- using the same `QuoteIncludeIsolator` this mechanism does; see its own comment there for that story.
|
|
22
31
|
|
|
@@ -36,6 +45,11 @@ A source under test can sit beside a header its test mocks and quote-include it
|
|
|
36
45
|
|
|
37
46
|
## What isolation can't fix: Partials, and the reactive fallback
|
|
38
47
|
|
|
39
|
-
CMock's own mock generation, when `:treat_inlines: :include` is configured, produces a same-basename shadow of the real header -- a safe replacement sharing the real header's own filename and include guard, which is exactly what gives an isolated sibling's own `#include` something to fall through to on `-I`. Partials generates *distinctly-named* files instead; there's never a same-basename replacement waiting on a search path for an isolated sibling to find. When a Partial's own generated content and its module's real, un-Partialized header both reach one compile, isolation has structurally nothing to redirect -- the collision is a straightforward `redeclaration`/`conflicting types`/`previous definition` compile error, and it stays one no matter how the search paths are arranged.
|
|
48
|
+
CMock's own mock generation, when `:treat_inlines: :include` is configured, produces a same-basename shadow of the real header -- a safe replacement sharing the real header's own filename and include guard, which is exactly what gives an isolated sibling's own `#include` something to fall through to on `-I`. Partials generates *distinctly-named* files instead; there's never a same-basename replacement waiting on a search path for an isolated sibling to find, so isolation never runs for a Partialized header. When a Partial's own generated content and its module's real, un-Partialized header both reach one compile, isolation has structurally nothing to redirect -- the collision is a straightforward `redeclaration`/`conflicting types`/`previous definition` compile error, and it stays one no matter how the search paths are arranged.
|
|
49
|
+
|
|
50
|
+
`HeaderCollisionSpecialist` (`lib/ceedling/diagnostics/`) is the deliberate fallback, for this case and for any other collision isolation doesn't resolve. When a test's compilation fails, `TestBuildExecutor` hands its output and inputs to the build step doctor (see `diagnostics/DOCTOR.md`). The specialist matches the redeclaration and conflicting-types wordings of many toolchains, then examines the case two ways. Each logs a notice at `ERRORS` verbosity before the compiler's error is raised:
|
|
51
|
+
|
|
52
|
+
- **A substituted header colliding with its real content.** The output names a real header this test mocks or Partializes. The notice explains how the real content can arrive through a second `#include` chain, and how to break it.
|
|
53
|
+
- **A collision in a shared directory.** The output names a header whose directory holds other headers this test reaches, none of them substituted and none of them Ceedling's own. The first compilation attempt's `.d` file decides what the test reaches. A toolchain that writes no `.d` file leaves the directory's listing instead. One notice is logged per such directory, naming only the headers the compiler named. It explains the quote-include rule, isolation's limits, and how to make each declaration arrive once.
|
|
40
54
|
|
|
41
|
-
|
|
55
|
+
Both read the same failure, so one compilation can draw both notices.
|