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,114 @@
|
|
|
1
|
+
# =========================================================================
|
|
2
|
+
# Ceedling - Test-Centered Build System for C
|
|
3
|
+
# ThrowTheSwitch.org
|
|
4
|
+
# Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
|
|
5
|
+
# SPDX-License-Identifier: MIT
|
|
6
|
+
# =========================================================================
|
|
7
|
+
|
|
8
|
+
require 'ceedling/constants'
|
|
9
|
+
require 'ceedling/filesystem/build_subpath'
|
|
10
|
+
require 'ceedling/filesystem/project_paths'
|
|
11
|
+
|
|
12
|
+
# Where each test's own build files go. Each kind of file has a base directory every test
|
|
13
|
+
# shares, and a test's root of that kind is the base, the test's name, and the reserved
|
|
14
|
+
# segment `_t_` (BuildSubpath::OWN_SEGMENT). A name is a path, so a test's root sits beside
|
|
15
|
+
# the directories of other tests' names rather than among them. No name holds the segment,
|
|
16
|
+
# since BuildSubpath escapes a directory named like it, so no test's root lies inside
|
|
17
|
+
# another's. Below a base, the first such segment therefore ends a test's name exactly.
|
|
18
|
+
#
|
|
19
|
+
# Runners, results, logs and artifacts are files named by a test's basename below the
|
|
20
|
+
# directories of its name. Those can't collide, so they stay outside this layout.
|
|
21
|
+
class TestBuildLayout
|
|
22
|
+
|
|
23
|
+
# Each kind with a configured base, and the setting that enables it, if any
|
|
24
|
+
CONFIGURED = {
|
|
25
|
+
mocks: [:cmock_mock_path, :project_use_mocks],
|
|
26
|
+
partials: [:project_test_partials_path, :project_use_partials],
|
|
27
|
+
preprocess_includes: [:project_test_preprocess_includes_path, nil],
|
|
28
|
+
preprocess_files: [:project_test_preprocess_files_path, nil],
|
|
29
|
+
build_directives: [:project_test_preprocess_build_directives_path, nil]
|
|
30
|
+
}.freeze
|
|
31
|
+
|
|
32
|
+
# Each kind whose base belongs to a build context, and its directory there
|
|
33
|
+
CONTEXTUAL = { out: BUILD_OUT_DIR, dependencies: BUILD_DEPENDENCIES_DIR }.freeze
|
|
34
|
+
|
|
35
|
+
KINDS = (CONFIGURED.keys + CONTEXTUAL.keys).freeze
|
|
36
|
+
|
|
37
|
+
constructor :configurator, :file_wrapper
|
|
38
|
+
|
|
39
|
+
# The directory every test's files of `kind` share, or nil for a disabled feature. The
|
|
40
|
+
# output and dependencies bases sit below a build context, such as `build/gcov/out`.
|
|
41
|
+
def base(kind, context: nil)
|
|
42
|
+
dir = CONTEXTUAL[kind]
|
|
43
|
+
return File.join( *[@configurator.project_build_root, context&.to_s, dir].compact ) unless dir.nil?
|
|
44
|
+
|
|
45
|
+
setting, feature = CONFIGURED.fetch( kind )
|
|
46
|
+
return nil unless feature.nil? or @configurator.public_send( feature )
|
|
47
|
+
|
|
48
|
+
return @configurator.public_send( setting )
|
|
49
|
+
end
|
|
50
|
+
|
|
51
|
+
# A test's own directory of `kind`, or nil for an empty name or a disabled feature. The
|
|
52
|
+
# root's length is checked here, as a directory's, since every file of the test's own lies
|
|
53
|
+
# below it.
|
|
54
|
+
def root(kind, name, context: nil)
|
|
55
|
+
return nil if name.to_s.empty?
|
|
56
|
+
|
|
57
|
+
base = base( kind, context: context )
|
|
58
|
+
return nil if base.nil?
|
|
59
|
+
|
|
60
|
+
path = File.join( base, name.to_s, BuildSubpath::OWN_SEGMENT )
|
|
61
|
+
@file_wrapper.check_path_length( path, origin: 'TestBuildLayout#root', directory: true )
|
|
62
|
+
return path
|
|
63
|
+
end
|
|
64
|
+
|
|
65
|
+
# A file at `subpath` below a test's root of `kind`, or nil where the test has no root
|
|
66
|
+
def file(kind, name, subpath, context: nil)
|
|
67
|
+
root = root( kind, name, context: context )
|
|
68
|
+
return root if root.nil? or subpath.to_s.empty?
|
|
69
|
+
|
|
70
|
+
return File.join( root, subpath )
|
|
71
|
+
end
|
|
72
|
+
|
|
73
|
+
# The roots of a test's generated Partials and mocks, as far as each feature is enabled.
|
|
74
|
+
# A mock or a Partial mirrors its own subdirectory below one of these.
|
|
75
|
+
def generated_roots(name)
|
|
76
|
+
return [root( :partials, name ), root( :mocks, name )].compact
|
|
77
|
+
end
|
|
78
|
+
|
|
79
|
+
# The name of the test whose root holds `path`, or nil for a path below no test's root. The
|
|
80
|
+
# most specific base holding the path counts, should one base be configured inside another.
|
|
81
|
+
def locate(path, context: nil)
|
|
82
|
+
held( path, context ).each do |segments|
|
|
83
|
+
index = segments.index( BuildSubpath::OWN_SEGMENT )
|
|
84
|
+
next if index.nil? or index.zero?
|
|
85
|
+
|
|
86
|
+
return segments.take( index ).join( '/' )
|
|
87
|
+
end
|
|
88
|
+
|
|
89
|
+
return nil
|
|
90
|
+
end
|
|
91
|
+
|
|
92
|
+
# The path below a test's root of `kind`, a kind with no build context, that `path` lies at,
|
|
93
|
+
# '' for the root itself, or nil for a path outside it
|
|
94
|
+
def subpath(path, kind:, name:)
|
|
95
|
+
root = root( kind, name )
|
|
96
|
+
return nil if root.nil?
|
|
97
|
+
|
|
98
|
+
return ProjectPaths.subdir_below( root, path )
|
|
99
|
+
end
|
|
100
|
+
|
|
101
|
+
private
|
|
102
|
+
|
|
103
|
+
# The segments of `path` below each base that holds it, the most specific base first
|
|
104
|
+
def held(path, context)
|
|
105
|
+
found = KINDS.filter_map do |kind|
|
|
106
|
+
base = base( kind, context: context )
|
|
107
|
+
rest = base.nil? ? nil : ProjectPaths.subdir_below( base, path )
|
|
108
|
+
rest&.split( '/' )
|
|
109
|
+
end
|
|
110
|
+
|
|
111
|
+
return found.sort_by( &:length )
|
|
112
|
+
end
|
|
113
|
+
|
|
114
|
+
end
|
|
@@ -0,0 +1,153 @@
|
|
|
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 'fileutils'
|
|
9
|
+
require 'securerandom'
|
|
10
|
+
require 'ceedling/exceptions'
|
|
11
|
+
|
|
12
|
+
# Windows' path length limits, and a probe of how far past the classic 260 characters
|
|
13
|
+
# this Ruby process can actually work.
|
|
14
|
+
#
|
|
15
|
+
# Windows lifts the 260-character limit for a program only when the host has long paths
|
|
16
|
+
# enabled (`LongPathsEnabled` = 1) and the program's manifest declares itself
|
|
17
|
+
# long-path-aware. Every RubyInstaller Ruby declares it, yet Ruby before 4.0 still cannot
|
|
18
|
+
# list a directory past 260 characters: globs, `Dir.children`, and recursive copies and
|
|
19
|
+
# removals fail there, or silently leave entries out, while single files work. The probe
|
|
20
|
+
# tests that behavior directly instead of reading version numbers.
|
|
21
|
+
#
|
|
22
|
+
# The registry is read only to explain a failure, through `query:`: a callable returning
|
|
23
|
+
# `reg query` output and whether the query succeeded. WinPathProber runs it as a Ceedling
|
|
24
|
+
# tool. `win32/registry` needs Fiddle, which stops being a default gem after Ruby 3.4.
|
|
25
|
+
#
|
|
26
|
+
# Every filesystem touch goes through `disk:` and every registry read through `query:`,
|
|
27
|
+
# so the logic can be specified with no disk at all.
|
|
28
|
+
module WinLongPaths
|
|
29
|
+
|
|
30
|
+
LIMITS = {
|
|
31
|
+
classic: 260, # MAX_PATH, the terminating NUL included
|
|
32
|
+
classic_directory: 248, # CreateDirectory leaves room for an 8.3 file name
|
|
33
|
+
long_paths: 32_767 # The longest path a UNICODE_STRING holds
|
|
34
|
+
}.freeze
|
|
35
|
+
|
|
36
|
+
REGISTRY_KEY = 'HKLM\\SYSTEM\\CurrentControlSet\\Control\\FileSystem'.freeze
|
|
37
|
+
REGISTRY_VALUE = 'LongPathsEnabled'.freeze
|
|
38
|
+
ENABLED = /LongPathsEnabled\s+REG_DWORD\s+0x1\b/
|
|
39
|
+
|
|
40
|
+
# Each probe directory name is this long, so the deep path stays far below Windows'
|
|
41
|
+
# 255-character limit on a single path component
|
|
42
|
+
SEGMENT = 40
|
|
43
|
+
PROBE_FILE = 'probe.txt'.freeze
|
|
44
|
+
CONTENT = 'Ceedling long path probe'.freeze
|
|
45
|
+
|
|
46
|
+
# The probe's only contact with the filesystem
|
|
47
|
+
module Disk
|
|
48
|
+
def self.mkdir_p(path) = FileUtils.mkdir_p( path )
|
|
49
|
+
def self.write(path, text) = File.write( path, text )
|
|
50
|
+
def self.read(path) = File.read( path )
|
|
51
|
+
def self.delete(path) = File.delete( path )
|
|
52
|
+
def self.rmdir(path) = Dir.rmdir( path )
|
|
53
|
+
def self.children(path) = Dir.children( path )
|
|
54
|
+
def self.glob(pattern) = Dir.glob( pattern )
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
# Whether the host has long paths enabled. A missing value, a failed query, or a query
|
|
58
|
+
# that could not run at all reads as disabled.
|
|
59
|
+
def self.registry_enabled?(query:)
|
|
60
|
+
return registry_state( query )[:state] == :enabled
|
|
61
|
+
end
|
|
62
|
+
|
|
63
|
+
# Writes, reads, and lists a file in a directory below `root` nested past 260
|
|
64
|
+
# characters, then removes it all. Returns one of:
|
|
65
|
+
# - `{ support: :full }`: files and directory listings both work
|
|
66
|
+
# - `{ support: :files_only }`: files work, but listing a directory that deep fails
|
|
67
|
+
# - `{ support: :none, cause: }`: files fail. The cause comes from the registry, since
|
|
68
|
+
# Windows reports only "No such file or directory" whatever the reason:
|
|
69
|
+
# `:registry_disabled`, `:process_not_aware`, or `:probe_failed` (with `error:`) when
|
|
70
|
+
# the registry can't be read.
|
|
71
|
+
def self.probe(root, query:, disk: Disk)
|
|
72
|
+
directories = probe_directories( File.expand_path( root ) )
|
|
73
|
+
deep = directories.last
|
|
74
|
+
file = File.join( deep, PROBE_FILE )
|
|
75
|
+
|
|
76
|
+
begin
|
|
77
|
+
return no_support( query ) unless files_work?( disk, deep, file )
|
|
78
|
+
return { support: listings_work?( disk, deep ) ? :full : :files_only }
|
|
79
|
+
ensure
|
|
80
|
+
clean_up( disk, directories, file )
|
|
81
|
+
end
|
|
82
|
+
end
|
|
83
|
+
|
|
84
|
+
# A uniquely named directory below `root`, then nested directories until the deepest
|
|
85
|
+
# passes 260 characters by a full segment. Outermost first.
|
|
86
|
+
def self.probe_directories(root)
|
|
87
|
+
directories = [File.join( root, "long_path_probe_#{Process.pid}_#{SecureRandom.hex( 4 )}" )]
|
|
88
|
+
|
|
89
|
+
while directories.last.length <= (LIMITS[:classic] + SEGMENT)
|
|
90
|
+
name = format( '%02d', directories.length ).ljust( SEGMENT, 'x' )
|
|
91
|
+
directories << File.join( directories.last, name )
|
|
92
|
+
end
|
|
93
|
+
|
|
94
|
+
return directories
|
|
95
|
+
end
|
|
96
|
+
|
|
97
|
+
def self.files_work?(disk, deep, file)
|
|
98
|
+
disk.mkdir_p( deep )
|
|
99
|
+
disk.write( file, CONTENT )
|
|
100
|
+
return disk.read( file ) == CONTENT
|
|
101
|
+
rescue SystemCallError
|
|
102
|
+
return false
|
|
103
|
+
end
|
|
104
|
+
|
|
105
|
+
# Checks what the listings return, not only that they return. Ruby 3.0's glob leaves a
|
|
106
|
+
# deep entry out without raising.
|
|
107
|
+
def self.listings_work?(disk, deep)
|
|
108
|
+
return false unless disk.children( deep ).include?( PROBE_FILE )
|
|
109
|
+
|
|
110
|
+
return disk.glob( File.join( deep, '*' ) ).any? { |path| File.basename( path ) == PROBE_FILE }
|
|
111
|
+
rescue SystemCallError
|
|
112
|
+
return false
|
|
113
|
+
end
|
|
114
|
+
|
|
115
|
+
def self.no_support(query)
|
|
116
|
+
registry = registry_state( query )
|
|
117
|
+
|
|
118
|
+
case registry[:state]
|
|
119
|
+
when :enabled then return { support: :none, cause: :process_not_aware }
|
|
120
|
+
when :disabled then return { support: :none, cause: :registry_disabled }
|
|
121
|
+
else return { support: :none, cause: :probe_failed, error: registry[:error] }
|
|
122
|
+
end
|
|
123
|
+
end
|
|
124
|
+
|
|
125
|
+
# A query that could not run raises a CeedlingException, such as ToolExecutor's
|
|
126
|
+
# ShellException for a missing executable. Its message, on one line, names the reason.
|
|
127
|
+
def self.registry_state(query)
|
|
128
|
+
output, success = query.call
|
|
129
|
+
return { state: (success && output.match?( ENABLED )) ? :enabled : :disabled }
|
|
130
|
+
rescue CeedlingException => e
|
|
131
|
+
return { state: :unknown, error: e.message.split.join( ' ' ) }
|
|
132
|
+
end
|
|
133
|
+
|
|
134
|
+
# Ruby before 4.0 can't remove a tree this deep recursively, and it can't list one
|
|
135
|
+
# either, so the probe removes exactly what it made: its file, then each directory,
|
|
136
|
+
# deepest first. Anything already gone, or never made, is skipped.
|
|
137
|
+
def self.clean_up(disk, directories, file)
|
|
138
|
+
begin
|
|
139
|
+
disk.delete( file )
|
|
140
|
+
rescue SystemCallError
|
|
141
|
+
nil
|
|
142
|
+
end
|
|
143
|
+
|
|
144
|
+
directories.reverse_each do |directory|
|
|
145
|
+
disk.rmdir( directory )
|
|
146
|
+
rescue SystemCallError
|
|
147
|
+
next
|
|
148
|
+
end
|
|
149
|
+
end
|
|
150
|
+
|
|
151
|
+
private_class_method :probe_directories, :files_work?, :listings_work?, :no_support, :registry_state, :clean_up
|
|
152
|
+
|
|
153
|
+
end
|
|
@@ -0,0 +1,83 @@
|
|
|
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 'rbconfig'
|
|
9
|
+
require 'ceedling/constants'
|
|
10
|
+
require 'ceedling/filesystem/win_long_paths'
|
|
11
|
+
|
|
12
|
+
# What :project ↳ :win_path_limit means once the long path probe has answered: which
|
|
13
|
+
# Windows limit applies, and the one message that says why. Also how each limit reads
|
|
14
|
+
# in a path length message.
|
|
15
|
+
module WinPathLimit
|
|
16
|
+
|
|
17
|
+
# What a probe result means for a `:win_path_limit` mode: whether long paths are in
|
|
18
|
+
# effect, and the one message to log about it, as arguments to `Loginator#log`.
|
|
19
|
+
# - `:long_paths` keeps the long limit when files work, warning if listings don't.
|
|
20
|
+
# - `:auto` takes the long limit only with full support, noting why when it doesn't.
|
|
21
|
+
# - Without file support, either mode keeps the classic limit and names the cause.
|
|
22
|
+
def self.decision(result, mode)
|
|
23
|
+
case result[:support]
|
|
24
|
+
when :full
|
|
25
|
+
return { long_paths: true, log: ["Windows long paths: full support (Ruby #{RUBY_VERSION})", Verbosity::DEBUG] }
|
|
26
|
+
when :files_only
|
|
27
|
+
return files_only_decision( mode )
|
|
28
|
+
else
|
|
29
|
+
return no_support_decision( result, mode )
|
|
30
|
+
end
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
# How a Windows path limit reads in a message
|
|
34
|
+
def self.limit_name(limit)
|
|
35
|
+
return "Windows' #{WinLongPaths::LIMITS[:classic_directory]}-character limit for directories" if limit == WinLongPaths::LIMITS[:classic_directory]
|
|
36
|
+
return "Windows' #{limit.to_s.reverse.scan( /\d{1,3}/ ).join( ',' ).reverse}-character long path limit" if limit == WinLongPaths::LIMITS[:long_paths]
|
|
37
|
+
|
|
38
|
+
return "Windows' #{limit}-character limit"
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
def self.files_only_decision(mode)
|
|
42
|
+
listing = "Ruby #{RUBY_VERSION} cannot list directories past #{WinLongPaths::LIMITS[:classic]} characters"
|
|
43
|
+
|
|
44
|
+
if mode == :long_paths
|
|
45
|
+
message = ":project ↳ :win_path_limit is :long_paths, but #{listing}. Builds can write long paths, but Ceedling's " \
|
|
46
|
+
'directory scans, `clean`, and `clobber` can fail or leave files behind in them. Ruby 4.0 or later lists them.'
|
|
47
|
+
return { long_paths: true, log: [message, Verbosity::COMPLAIN] }
|
|
48
|
+
end
|
|
49
|
+
|
|
50
|
+
message = "Windows long paths are enabled, but #{listing}. Ceedling keeps reporting paths against the " \
|
|
51
|
+
"#{WinLongPaths::LIMITS[:classic]}-character limit. Ruby 4.0 or later lists them."
|
|
52
|
+
return { long_paths: false, log: [message, Verbosity::NORMAL, LogLabels::NOTICE] }
|
|
53
|
+
end
|
|
54
|
+
|
|
55
|
+
def self.no_support_decision(result, mode)
|
|
56
|
+
cause, remedy = cause_text( result )
|
|
57
|
+
limit = "the #{WinLongPaths::LIMITS[:classic]}-character limit"
|
|
58
|
+
|
|
59
|
+
if mode == :long_paths
|
|
60
|
+
message = ":project ↳ :win_path_limit is :long_paths, but #{cause}. Ceedling reports paths against #{limit}.#{remedy}"
|
|
61
|
+
return { long_paths: false, log: [message, Verbosity::COMPLAIN] }
|
|
62
|
+
end
|
|
63
|
+
|
|
64
|
+
message = "Windows long paths are unavailable: #{cause}. Ceedling keeps reporting paths against #{limit}.#{remedy}"
|
|
65
|
+
return { long_paths: false, log: [message, Verbosity::NORMAL, LogLabels::NOTICE] }
|
|
66
|
+
end
|
|
67
|
+
|
|
68
|
+
def self.cause_text(result)
|
|
69
|
+
case result[:cause]
|
|
70
|
+
when :registry_disabled
|
|
71
|
+
return ["long paths are not enabled on this host (#{WinLongPaths::REGISTRY_KEY} ↳ #{WinLongPaths::REGISTRY_VALUE} is not 1)",
|
|
72
|
+
' Enable "Win32 long paths" and run Ceedling again.']
|
|
73
|
+
when :process_not_aware
|
|
74
|
+
return ["long paths are enabled on this host, but this Ruby (#{RbConfig.ruby}) could not use them in the build " \
|
|
75
|
+
"directory. Either it is not long-path-aware, or that directory's drive does not support long paths", '']
|
|
76
|
+
else
|
|
77
|
+
return ["the Windows registry could not be read to check for long path support (#{result[:error]})", '']
|
|
78
|
+
end
|
|
79
|
+
end
|
|
80
|
+
|
|
81
|
+
private_class_method :files_only_decision, :no_support_decision, :cause_text
|
|
82
|
+
|
|
83
|
+
end
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# =========================================================================
|
|
2
|
+
# Ceedling - Test-Centered Build System for C
|
|
3
|
+
# ThrowTheSwitch.org
|
|
4
|
+
# Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
|
|
5
|
+
# SPDX-License-Identifier: MIT
|
|
6
|
+
# =========================================================================
|
|
7
|
+
|
|
8
|
+
require 'ceedling/filesystem/win_long_paths'
|
|
9
|
+
require 'ceedling/filesystem/win_path_limit'
|
|
10
|
+
|
|
11
|
+
# Decides once per process whether Windows long paths are in effect for a
|
|
12
|
+
# `:project` ↳ `:win_path_limit` mode, and says why in one message.
|
|
13
|
+
#
|
|
14
|
+
# FileWrapper asks only on Windows, with `:auto` or `:long_paths`, once a path first nears
|
|
15
|
+
# the classic limit. The probe works below the build root, and reads the registry through
|
|
16
|
+
# the `:tools` ↳ `:windows_registry_query` tool, which configuration adds in exactly that
|
|
17
|
+
# case. Compile and test threads can ask at once, so the probe runs under a lock.
|
|
18
|
+
class WinPathProber
|
|
19
|
+
|
|
20
|
+
constructor :configurator, :tool_executor, :loginator
|
|
21
|
+
|
|
22
|
+
def setup
|
|
23
|
+
@lock = Mutex.new
|
|
24
|
+
@long_paths = nil
|
|
25
|
+
end
|
|
26
|
+
|
|
27
|
+
# Whether long paths are in effect. The first call probes and logs the decision; later
|
|
28
|
+
# calls return the same answer.
|
|
29
|
+
def long_paths?(mode)
|
|
30
|
+
@lock.synchronize do
|
|
31
|
+
next @long_paths unless @long_paths.nil?
|
|
32
|
+
|
|
33
|
+
result = WinLongPaths.probe( @configurator.project_build_root, query: method( :registry_query ) )
|
|
34
|
+
decision = WinPathLimit.decision( result, mode )
|
|
35
|
+
@loginator.log( *decision[:log] )
|
|
36
|
+
@long_paths = decision[:long_paths]
|
|
37
|
+
end
|
|
38
|
+
end
|
|
39
|
+
|
|
40
|
+
# `reg query` output for the long paths value, and whether the query succeeded. A failed
|
|
41
|
+
# exit is an answer, not an error, so the tool runs without raising on one.
|
|
42
|
+
def registry_query
|
|
43
|
+
command = @tool_executor.build_command_line(
|
|
44
|
+
@configurator.tools_windows_registry_query, [], WinLongPaths::REGISTRY_KEY, WinLongPaths::REGISTRY_VALUE
|
|
45
|
+
)
|
|
46
|
+
command[:options][:boom] = false
|
|
47
|
+
result = @tool_executor.exec( command )
|
|
48
|
+
|
|
49
|
+
return [result[:output], !@tool_executor.failed?( result )]
|
|
50
|
+
end
|
|
51
|
+
|
|
52
|
+
end
|
|
@@ -46,78 +46,36 @@ class Generator
|
|
|
46
46
|
# rather than duplicated by generate_partial_implementation and generate_partial_interface.
|
|
47
47
|
# Returns the bare generated filename (for the caller to add to each header's own includes
|
|
48
48
|
# list) or nil when the module has no typedefs or aggregate definitions to share.
|
|
49
|
-
def generate_partial_types(name:, partial:, c_module:, output_path:, includes: [], include_guard: nil)
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
49
|
+
def generate_partial_types(name:, partial:, c_module:, output_path:, includes: [], following_includes: [], include_guard: nil)
|
|
50
|
+
log_partial_progress( 'Generating shared Partial types for', name, partial )
|
|
51
|
+
|
|
52
|
+
# The module's name, not the test's: two modules Partialed in the same test file must not
|
|
53
|
+
# collide on one shared types header filename
|
|
54
|
+
return @generator_partials.generate_types(
|
|
55
|
+
name: partial, c_module: c_module, output_path: output_path, includes: includes,
|
|
56
|
+
following_includes: following_includes, include_guard: include_guard
|
|
54
57
|
)
|
|
55
|
-
@loginator.log( msg )
|
|
56
|
-
|
|
57
|
-
arg_hash = {
|
|
58
|
-
:name => partial, # Module name, not test name -- two modules Partialed in the same
|
|
59
|
-
# test file must not collide on one shared types header filename
|
|
60
|
-
:c_module => c_module,
|
|
61
|
-
:output_path => output_path,
|
|
62
|
-
:includes => includes,
|
|
63
|
-
:include_guard => include_guard
|
|
64
|
-
}
|
|
65
|
-
|
|
66
|
-
return @generator_partials.generate_types( **arg_hash )
|
|
67
58
|
end
|
|
68
59
|
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
filename: partial # Partial module name, not filename
|
|
74
|
-
)
|
|
75
|
-
@loginator.log( msg )
|
|
60
|
+
# The mockable interface header for a Partial module. Everything but the test's name passes
|
|
61
|
+
# through to GeneratorPartials#generate_interface.
|
|
62
|
+
def generate_partial_interface(test:, partial:, **generation)
|
|
63
|
+
log_partial_progress( 'Generating Partial mockable interface for', test, partial )
|
|
76
64
|
|
|
77
|
-
|
|
78
|
-
:test => test,
|
|
79
|
-
:name => partial,
|
|
80
|
-
:function_declarations => function_declarations,
|
|
81
|
-
:includes => includes,
|
|
82
|
-
:c_module => c_module,
|
|
83
|
-
:output_path => output_path,
|
|
84
|
-
:include_guard => include_guard
|
|
85
|
-
}
|
|
86
|
-
|
|
87
|
-
return @generator_partials.generate_interface( **arg_hash )
|
|
65
|
+
return @generator_partials.generate_interface( name: partial, **generation )
|
|
88
66
|
end
|
|
89
67
|
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
source_includes:,
|
|
95
|
-
header_includes:,
|
|
96
|
-
c_module:,
|
|
97
|
-
input_filepath:,
|
|
98
|
-
output_path:,
|
|
99
|
-
include_guard: nil
|
|
100
|
-
)
|
|
68
|
+
# The implementation header and source for a Partial module, carry plan included. Everything
|
|
69
|
+
# but the test's name passes through to GeneratorPartials#generate_implementation.
|
|
70
|
+
def generate_partial_implementation(test:, partial:, **generation)
|
|
71
|
+
log_partial_progress( 'Generating Partial implementation for', test, partial )
|
|
101
72
|
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
module_name: test,
|
|
105
|
-
filename: partial # Partial module name, not filename
|
|
106
|
-
)
|
|
107
|
-
@loginator.log( msg )
|
|
73
|
+
return @generator_partials.generate_implementation( name: partial, **generation )
|
|
74
|
+
end
|
|
108
75
|
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
:name => partial,
|
|
113
|
-
:source_includes => source_includes,
|
|
114
|
-
:header_includes => header_includes,
|
|
115
|
-
:c_module => c_module,
|
|
116
|
-
:output_path => output_path,
|
|
117
|
-
:include_guard => include_guard
|
|
118
|
-
}
|
|
119
|
-
|
|
120
|
-
return @generator_partials.generate_implementation( **arg_hash )
|
|
76
|
+
# The class that writes each mock, which a mock's delta build record holds
|
|
77
|
+
def mock_generator_name
|
|
78
|
+
return @generator_mocks.generator_name
|
|
121
79
|
end
|
|
122
80
|
|
|
123
81
|
def generate_mock(context:, mock:, test:, input_filepath:, output_path:, mock_root:, folder: nil, overrides: {})
|
|
@@ -479,6 +437,11 @@ class Generator
|
|
|
479
437
|
return crash_results( backtrace, arg_hash, shell_result, test_cases, explanation )
|
|
480
438
|
end
|
|
481
439
|
|
|
440
|
+
def log_partial_progress(operation, test, partial)
|
|
441
|
+
# `filename` is the Partial module's name, not a filename
|
|
442
|
+
@loginator.log( @reportinator.generate_module_progress( operation: operation, module_name: test, filename: partial ) )
|
|
443
|
+
end
|
|
444
|
+
|
|
482
445
|
def log_crash(executable, shell_result, backtrace, explanation)
|
|
483
446
|
return @helper.log_explained_crash( executable, explanation ) if explanation
|
|
484
447
|
|
|
@@ -47,36 +47,6 @@ class GeneratorHelper
|
|
|
47
47
|
@loginator.log( notice, Verbosity::ERRORS, LogLabels::CRASH )
|
|
48
48
|
end
|
|
49
49
|
|
|
50
|
-
# A "redeclaration"/"redefinition"/"conflicting types"/"previous definition" family
|
|
51
|
-
# of compiler errors mentioning a header this test also mocks or Partializes is a
|
|
52
|
-
# strong signal that the real header's own content reached this compile a second,
|
|
53
|
-
# unmocked way -- substitution only ever replaces what a test's own #include
|
|
54
|
-
# directives name directly, so a module reaching the same real header through some
|
|
55
|
-
# other, unrelated #include chain slips past it entirely, and the genuine and
|
|
56
|
-
# substituted copies of the same declarations collide in the one compiled
|
|
57
|
-
# translation unit. Different compilers word this differently -- gcc's own
|
|
58
|
-
# "conflicting types for" and clang's "redefinition of"/"previous definition is
|
|
59
|
-
# here" are both real, observed wordings for the same underlying constraint
|
|
60
|
-
# violation, not a hypothetical spread to guard against.
|
|
61
|
-
#
|
|
62
|
-
# `mocked_headers` maps a real header's own basename to its real, resolved path --
|
|
63
|
-
# exactly the substitution knowledge a test's own mocks/Partials configuration
|
|
64
|
-
# already carries, cross-referenced here against whichever file paths the compiler's
|
|
65
|
-
# own error text happens to mention.
|
|
66
|
-
def explain_possible_mock_partial_collision(output:, mocked_headers:)
|
|
67
|
-
return nil if output.nil?
|
|
68
|
-
return nil unless output.match?(/redeclaration of|redefinition of|conflicting types|previous definition/i)
|
|
69
|
-
|
|
70
|
-
mentioned = output.scan( /([^\s"]+\.h):\d+:\d+/ ).flatten.uniq
|
|
71
|
-
|
|
72
|
-
culprit = mocked_headers.find do |basename, real_path|
|
|
73
|
-
mentioned.any? { |m| File.basename( m ) == basename && File.expand_path( m ) == File.expand_path( real_path ) }
|
|
74
|
-
end
|
|
75
|
-
return nil if culprit.nil?
|
|
76
|
-
|
|
77
|
-
return collision_notice( *culprit )
|
|
78
|
-
end
|
|
79
|
-
|
|
80
50
|
### Private ###
|
|
81
51
|
|
|
82
52
|
private
|
|
@@ -133,18 +103,4 @@ class GeneratorHelper
|
|
|
133
103
|
return "> Consider configuring :project ↳ :use_backtrace to use the :gdb option to find the cause (see documentation).\n"
|
|
134
104
|
end
|
|
135
105
|
|
|
136
|
-
|
|
137
|
-
def collision_notice(basename, real_path)
|
|
138
|
-
notice = "This looks like '#{basename}' is mocked or Partialized for this test, but its " \
|
|
139
|
-
"real content ('#{real_path}') is also reaching compilation through a second " \
|
|
140
|
-
"unmocked #include chain.\n"
|
|
141
|
-
notice += "> The cause is most likely a transitive #include chain through an unrelated " \
|
|
142
|
-
"header brought about by C convention quirks in search paths and #include guards.\n"
|
|
143
|
-
notice += "> Consider investigating the #include chain and modifying your source or " \
|
|
144
|
-
"Partializing/mocking the problematic header (without necessarily using it) to " \
|
|
145
|
-
"break the transitive #include chain.\n"
|
|
146
|
-
|
|
147
|
-
return notice
|
|
148
|
-
end
|
|
149
|
-
|
|
150
106
|
end
|
|
@@ -15,6 +15,11 @@ class GeneratorMocks
|
|
|
15
15
|
return CMock.new(config)
|
|
16
16
|
end
|
|
17
17
|
|
|
18
|
+
# The class that writes each mock. A plugin such as FFF puts its own in CMock's place.
|
|
19
|
+
def generator_name
|
|
20
|
+
return CMock.name
|
|
21
|
+
end
|
|
22
|
+
|
|
18
23
|
def build_configuration( output_path, overrides: {} )
|
|
19
24
|
config = @configurator.get_cmock_config
|
|
20
25
|
config[:mock_path] = output_path
|