ceedling 1.2.1 → 1.2.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/GIT_COMMIT_SHA +1 -1
- data/README.md +11 -9
- data/Rakefile +2 -1
- data/assets/features/ceedling +1 -1
- data/assets/fixtures/test_source_file_duplicate_basenames/test_calc_typo.c +14 -0
- data/assets/fixtures/tests_with_duplicate_test_names/test_foo.c +21 -0
- 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/bin/actionator.rb +6 -12
- data/bin/app_cfg.rb +14 -1
- data/bin/ceedling +13 -3
- data/bin/cli.rb +25 -6
- data/bin/cli_handler.rb +113 -73
- data/bin/cli_helper.rb +51 -78
- data/bin/installation_selector.rb +81 -0
- data/bin/launchinator.rb +69 -0
- data/bin/mixin_resolvinator.rb +26 -36
- data/bin/objects.yml +13 -0
- data/bin/path_validator.rb +25 -29
- data/bin/versionator.rb +47 -48
- data/ceedling.gemspec +19 -15
- data/docs/BreakingChanges.md +86 -1
- data/docs/Changelog.md +145 -3
- data/docs/KnownIssues.md +179 -6
- data/docs/ReleaseNotes.md +13 -0
- 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/build_log_writer.rb +33 -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/build_root_policy.rb +70 -0
- data/lib/ceedling/config/configurator.rb +18 -19
- data/lib/ceedling/config/configurator_builder.rb +75 -28
- data/lib/ceedling/config/configurator_paths_validator.rb +179 -0
- data/lib/ceedling/config/configurator_plugins.rb +1 -1
- data/lib/ceedling/config/configurator_setup.rb +44 -33
- data/lib/ceedling/config/configurator_validator.rb +1 -110
- data/lib/ceedling/constants.rb +5 -1
- data/lib/ceedling/defaults.rb +35 -5
- data/lib/ceedling/dependencies/CACHE_SCHEMA.md +118 -0
- data/lib/ceedling/dependencies/README.md +18 -16
- data/lib/ceedling/dependencies/dependency_cache_store.rb +43 -21
- data/lib/ceedling/dependencies/dependency_hasher.rb +35 -1
- 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/filename_extension.rb +7 -1
- data/lib/ceedling/filesystem/FILE_TREE.md +253 -0
- data/lib/ceedling/filesystem/PATH_HANDLING.md +360 -0
- data/lib/ceedling/filesystem/README.md +46 -0
- data/lib/ceedling/filesystem/build_roots.rb +105 -0
- data/lib/ceedling/filesystem/build_subpath.rb +187 -0
- data/lib/ceedling/filesystem/destination_collision.rb +25 -0
- data/lib/ceedling/{file_finder.rb → filesystem/file_finder.rb} +177 -156
- data/lib/ceedling/filesystem/file_finder_helper.rb +154 -0
- data/lib/ceedling/filesystem/file_path_collection_utils.rb +183 -0
- data/lib/ceedling/{file_path_utils.rb → filesystem/file_path_utils.rb} +200 -167
- data/lib/ceedling/{file_system_wrapper.rb → filesystem/file_system_wrapper.rb} +6 -5
- data/lib/ceedling/filesystem/file_tree.rb +241 -0
- data/lib/ceedling/{file_wrapper.rb → filesystem/file_wrapper.rb} +149 -65
- data/lib/ceedling/filesystem/path_exclusions.rb +30 -0
- data/lib/ceedling/{path_matcher.rb → filesystem/path_matcher.rb} +48 -23
- data/lib/ceedling/{path_mirror.rb → filesystem/path_mirror.rb} +19 -18
- data/lib/ceedling/filesystem/path_spellings.rb +55 -0
- data/lib/ceedling/filesystem/project_paths.rb +184 -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/filesystem/working_dir.rb +40 -0
- data/lib/ceedling/generators/generator.rb +32 -70
- 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 +306 -244
- data/lib/ceedling/generators/generator_test_results_backtrace.rb +7 -7
- 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/handoff.rb +121 -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 +112 -33
- data/lib/ceedling/includes/includes.rb +150 -38
- data/lib/ceedling/installation.rb +92 -0
- data/lib/ceedling/library_resolver.rb +99 -0
- data/lib/ceedling/objects.yml +112 -6
- 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 +603 -124
- data/lib/ceedling/partials/partializer_config.rb +8 -1
- 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/plugins/report_log_writer_plugin.rb +3 -5
- 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 +32 -76
- data/lib/ceedling/preprocess/preprocessinator_includes_handler.rb +1 -1
- data/lib/ceedling/preprocess/preprocessinator_line_marker_includes_extractor.rb +1 -1
- data/lib/ceedling/preprocess/preprocessinator_reconstructor.rb +51 -14
- data/lib/ceedling/rake_app/rakefile_component_resolver.rb +10 -17
- data/lib/ceedling/rakefile.rb +15 -1
- data/lib/ceedling/rakefiles/base/tasks_base.rake +1 -1
- data/lib/ceedling/rakefiles/release/rules_release.rake +4 -7
- data/lib/ceedling/release_invoker/release_build_executor.rb +33 -44
- data/lib/ceedling/release_invoker/release_build_planner.rb +14 -6
- data/lib/ceedling/reportinator.rb +3 -4
- data/lib/ceedling/setupinator.rb +104 -87
- data/lib/ceedling/test_context_extractor.rb +5 -1
- data/lib/ceedling/test_invoker/HEADER_COLLISIONS.md +21 -7
- data/lib/ceedling/test_invoker/PIPELINE.md +62 -19
- 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 +175 -10
- data/lib/ceedling/test_invoker/partial_files_preprocessinator.rb +181 -0
- data/lib/ceedling/test_invoker/partials_manager.rb +271 -302
- data/lib/ceedling/test_invoker/standin_headerinator.rb +19 -17
- data/lib/ceedling/test_invoker/test_bare_includes_extractinator.rb +26 -3
- data/lib/ceedling/test_invoker/test_build_executor.rb +358 -234
- data/lib/ceedling/test_invoker/test_build_planner.rb +46 -33
- data/lib/ceedling/test_invoker/test_build_setup.rb +43 -18
- data/lib/ceedling/test_invoker/test_build_validations.rb +35 -47
- data/lib/ceedling/test_invoker/test_derived_search_paths.rb +189 -0
- data/lib/ceedling/test_invoker/test_file_preprocessinator.rb +2 -3
- data/lib/ceedling/test_invoker/test_includes_reconcilinator.rb +1 -1
- data/lib/ceedling/test_invoker/test_invoker.rb +6 -1
- data/lib/ceedling/test_invoker/test_invoker_types.rb +28 -20
- data/lib/ceedling/test_invoker/test_pipeline_helpers.rb +6 -4
- 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_source_file_directive_resolver.rb +40 -20
- data/lib/ceedling/test_invoker/test_substitutions.rb +72 -0
- data/lib/ceedling/tools/shell_quoting.rb +45 -0
- data/lib/ceedling/{tool_executor.rb → tools/tool_executor.rb} +9 -3
- data/lib/ceedling/tools/tool_quoting.rb +79 -0
- data/lib/ceedling/{tool_validator.rb → tools/tool_validator.rb} +18 -7
- data/lib/ceedling/yaml_wrapper.rb +3 -2
- data/lib/version.rb +1 -1
- data/plugins/bullseye/bullseye.rake +1 -3
- data/plugins/bullseye/config/defaults_bullseye.rb +1 -1
- data/plugins/bullseye/lib/bullseye.rb +24 -9
- data/plugins/command_hooks/lib/command_hooks.rb +1 -1
- data/plugins/cppcheck/config/defaults_cppcheck.rb +1 -1
- data/plugins/dependencies/config/defaults.yml +6 -6
- data/plugins/dependencies/dependencies.rake +4 -1
- data/plugins/dependencies/lib/dependencies.rb +18 -8
- data/plugins/dependencies/lib/dependency_spec.rb +17 -5
- data/plugins/fff/lib/fff.rb +79 -46
- data/plugins/fff/lib/fff_mock_generator.rb +12 -9
- data/plugins/fff/spec/fff_cmock_wrapper_spec.rb +262 -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/config/defaults_gcov.rb +1 -1
- data/plugins/gcov/lib/console_reportinator.rb +28 -36
- data/plugins/gcov/lib/gcov.rb +9 -2
- data/plugins/gcov/lib/gcovr_reportinator.rb +8 -40
- data/plugins/gcov/lib/gcovr_thresholds.rb +74 -0
- data/plugins/gcov/lib/reportgenerator_reportinator.rb +3 -2
- data/plugins/module_generator/lib/module_generator.rb +3 -3
- data/plugins/report_tests_teamcity_stdout/lib/report_tests_teamcity_stdout.rb +53 -80
- data/plugins/sanitize/lib/sanitize_records.rb +3 -6
- data/plugins/valgrind/lib/valgrind.rb +14 -7
- 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 +7 -3
- 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 +65 -12
- 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 +23 -5
- 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 +36 -8
- data/site-local/configuration/reference/plugins.html +2 -2
- data/site-local/configuration/reference/project.html +264 -12
- data/site-local/configuration/reference/release-build.html +4 -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 +58 -4
- data/site-local/configuration/reference/unity.html +2 -2
- data/site-local/configuration/which-ceedling.html +379 -19
- 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 +7 -3
- data/site-local/development/workflow.html +50 -45
- data/site-local/getting-started/builds.html +4 -2
- data/site-local/getting-started/command-line.html +58 -6
- 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 +8 -5
- data/site-local/plugins/fff.html +58 -13
- data/site-local/plugins/gcov/examples.html +2 -2
- data/site-local/plugins/gcov/gcovr.html +23 -14
- 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 +4 -3
- 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 +5 -3
- data/site-local/plugins/report-tests-teamcity-stdout.html +8 -5
- data/site-local/plugins/sanitize.html +9 -8
- data/site-local/plugins/valgrind.html +10 -9
- 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 +5 -2
- data/site-local/reference/build-directives.html +2 -2
- data/site-local/reference/command-line.html +11 -4
- 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/snapshot/plugins/bullseye/config/defaults_bullseye.rb +1 -1
- data/site-local/snapshot/plugins/gcov/config/defaults_gcov.rb +1 -1
- data/site-local/testing-guide/build-directives.html +2 -2
- data/site-local/testing-guide/conventions.html +113 -15
- 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/actionator_file_operations_spec.rb +91 -1
- data/spec/integration/build_step_doctor_spec.rb +270 -0
- data/spec/integration/c_extractor_composition_spec.rb +254 -4
- data/spec/integration/compile_commands_json_db_spec.rb +1 -1
- data/spec/integration/configurator_validation_spec.rb +1 -1
- data/spec/integration/dependencies/dependency_tracker_cache_hardening_spec.rb +26 -0
- data/spec/integration/dependencies/dependency_tracker_core_spec.rb +22 -0
- data/spec/integration/includes_extraction_spec.rb +27 -14
- data/spec/integration/launcher_handoff_spec.rb +297 -0
- data/spec/integration/mixin_loading_spec.rb +1 -1
- data/spec/integration/module_generator_spec.rb +3 -3
- data/spec/integration/nested_test_artifacts_spec.rb +99 -0
- 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 +33 -23
- data/spec/integration/partials_symbol_linkage_spec.rb +13 -0
- data/spec/integration/path_intake_scenarios_spec.rb +101 -0
- data/spec/integration/path_length_reporting_spec.rb +64 -0
- data/spec/integration/path_scenarios_spec.rb +399 -0
- data/spec/integration/quote_include_isolator_spec.rb +57 -1
- data/spec/integration/report_build_warnings_log_spec.rb +1 -1
- data/spec/integration/report_tests_log_factory_spec.rb +1 -1
- data/spec/integration/test_build_parallel_barrier_spec.rb +1 -1
- data/spec/integration/test_executable_manifest_spec.rb +1 -1
- data/spec/integration/test_includes_extractinator_spec.rb +69 -3
- data/spec/integration/test_naming_spec.rb +201 -0
- data/spec/integration/test_source_file_checks_spec.rb +168 -0
- data/spec/integration/tool_executor_spec.rb +1 -1
- data/spec/integration/tool_validator_spec.rb +3 -3
- data/spec/integration/upgrade_docs_spec.rb +84 -0
- data/spec/integration/vendor_copy_transient_io_retry_spec.rb +74 -5
- 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/file_tree_helper.rb +88 -0
- data/spec/support/integration/configurator_integration_helper.rb +14 -9
- data/spec/support/integration/dependency_tracker_integration_helper.rb +1 -1
- data/spec/support/integration/partial_files_harness.rb +181 -0
- data/spec/support/integration/partials_generation_integration_helper.rb +239 -143
- data/spec/support/integration/path_scenario_harness.rb +175 -0
- data/spec/support/integration/spec_integration_helper.rb +9 -4
- data/spec/support/integration/test_includes_harness.rb +69 -37
- data/spec/support/integration/tool_executor_integration_helper.rb +14 -2
- data/spec/support/spec_helper.rb +2 -0
- data/spec/support/system/spec_system_helper.rb +7 -6
- data/spec/support/system/system_context.rb +21 -3
- data/spec/support/working_dir_tracking.rb +49 -0
- data/spec/system/build_output_mirroring_spec.rb +2 -2
- data/spec/system/bullseye_deployment_spec.rb +2 -0
- data/spec/system/conditional_mock_includes_spec.rb +1 -1
- data/spec/system/delta_builds_spec.rb +163 -23
- 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 +3 -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/launcher_handoff_spec.rb +82 -0
- data/spec/system/mock_include_folders_spec.rb +212 -0
- data/spec/system/mockable_header_reassembly_spec.rb +184 -0
- data/spec/system/parent_directory_reference_spec.rb +5 -3
- 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 +196 -0
- data/spec/system/pinned_thread_count_spec.rb +4 -4
- data/spec/system/preprocessing_fallback_conditionals_spec.rb +1 -1
- data/spec/system/preprocessing_parameterized_tests_spec.rb +1 -1
- data/spec/system/rake_release_task_path_disambiguation_spec.rb +6 -6
- data/spec/system/rake_test_task_path_disambiguation_spec.rb +85 -0
- data/spec/system/short_build_paths_spec.rb +87 -0
- data/spec/system/sibling_header_collision_spec.rb +30 -6
- data/spec/system/special_path_characters_spec.rb +86 -0
- data/spec/system/support/bullseye_common_test_cases.rb +42 -0
- data/spec/system/support/common_test_cases.rb +23 -21
- data/spec/system/support/gcov_common_test_cases.rb +37 -9
- data/spec/system/support/gcov_partials_test_cases.rb +48 -0
- data/spec/system/support/sanitize_common_test_cases.rb +2 -2
- data/spec/system/support/valgrind_common_test_cases.rb +12 -12
- data/spec/system/test_build_layout_spec.rb +209 -0
- data/spec/system/test_pipeline_stop_points_spec.rb +4 -4
- data/spec/system/test_runner_system_include_spec.rb +1 -1
- data/spec/system/test_source_file_directive_spec.rb +64 -5
- data/spec/units/bin/actionator_spec.rb +14 -17
- data/spec/units/bin/app_cfg_spec.rb +37 -0
- data/spec/units/bin/cli_handler_spec.rb +282 -6
- data/spec/units/bin/cli_helper_spec.rb +116 -45
- data/spec/units/bin/installation_selector_spec.rb +114 -0
- data/spec/units/bin/launchinator_spec.rb +171 -0
- data/spec/units/bin/path_validator_spec.rb +10 -0
- data/spec/units/bin/versionator_spec.rb +38 -6
- data/spec/units/build_log_writer_spec.rb +57 -0
- 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/build_root_policy_spec.rb +61 -0
- data/spec/units/config/configurator_builder_spec.rb +61 -6
- data/spec/units/config/configurator_paths_validator_spec.rb +292 -0
- data/spec/units/config/configurator_setup_spec.rb +80 -68
- data/spec/units/config/configurator_spec.rb +54 -6
- data/spec/units/config/configurator_validator_spec.rb +1 -172
- data/spec/units/dependencies/dependency_cache_store_spec.rb +98 -2
- data/spec/units/dependencies/dependency_debug_tree_spec.rb +1 -1
- data/spec/units/dependencies/dependency_hasher_spec.rb +42 -1
- data/spec/units/dependencies/dependency_path_normalizer_spec.rb +1 -1
- data/spec/units/dependencies/dependency_tracker_spec.rb +28 -1
- 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/filename_extension_spec.rb +11 -0
- data/spec/units/filesystem/build_roots_spec.rb +131 -0
- data/spec/units/filesystem/build_subpath_spec.rb +235 -0
- data/spec/units/filesystem/destination_collision_spec.rb +30 -0
- data/spec/units/{file_finder_helper_spec.rb → filesystem/file_finder_helper_spec.rb} +126 -1
- data/spec/units/filesystem/file_finder_spec.rb +845 -0
- data/spec/units/{file_path_collection_utils_spec.rb → filesystem/file_path_collection_utils_spec.rb} +181 -1
- data/spec/units/{file_path_utils_spec.rb → filesystem/file_path_utils_spec.rb} +435 -185
- data/spec/units/filesystem/file_system_wrapper_spec.rb +33 -0
- data/spec/units/filesystem/file_tree_spec.rb +511 -0
- data/spec/units/filesystem/file_tree_windows_spec.rb +78 -0
- data/spec/units/{file_wrapper_spec.rb → filesystem/file_wrapper_spec.rb} +286 -18
- data/spec/units/{path_matcher_spec.rb → filesystem/path_matcher_spec.rb} +48 -1
- data/spec/units/{path_mirror_spec.rb → filesystem/path_mirror_spec.rb} +32 -4
- data/spec/units/filesystem/project_paths_spec.rb +147 -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/filesystem/working_dir_spec.rb +71 -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 +38 -6
- data/spec/units/generators/generator_test_results_backtrace_spec.rb +50 -46
- data/spec/units/generators/generator_test_results_spec.rb +1 -1
- 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/handoff_spec.rb +205 -0
- data/spec/units/includes/header_search_spec.rb +406 -0
- data/spec/units/includes/include_factory_spec.rb +23 -6
- data/spec/units/includes/include_pathinator_spec.rb +118 -8
- data/spec/units/includes/include_spec.rb +14 -0
- data/spec/units/includes/includes_spec.rb +176 -19
- data/spec/units/installation_spec.rb +228 -0
- data/spec/units/library_resolver_spec.rb +157 -0
- data/spec/units/loginator_spec.rb +31 -0
- data/spec/units/mock_locator_spec.rb +275 -6
- data/spec/units/partials/include_groups_spec.rb +42 -0
- data/spec/units/partials/partializer_config_spec.rb +32 -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 +1579 -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 +561 -251
- data/spec/units/plugins/bullseye_spec.rb +49 -2
- data/spec/units/plugins/console_reportinator_spec.rb +73 -26
- data/spec/units/plugins/dependencies_spec.rb +33 -7
- data/spec/units/plugins/dependency_spec_spec.rb +17 -0
- data/spec/units/plugins/gcov_spec.rb +28 -3
- data/spec/units/plugins/gcovr_reportinator_spec.rb +19 -47
- data/spec/units/plugins/gcovr_thresholds_spec.rb +95 -0
- data/spec/units/plugins/module_generator_spec.rb +5 -5
- data/spec/units/plugins/report_build_warnings_log_spec.rb +3 -3
- data/spec/units/plugins/report_log_writer_plugin_spec.rb +10 -1
- data/spec/units/plugins/report_tests_raw_output_log_spec.rb +13 -2
- data/spec/units/plugins/report_tests_teamcity_stdout_spec.rb +77 -3
- data/spec/units/plugins/reportgenerator_reportinator_spec.rb +52 -4
- data/spec/units/plugins/sanitize_records_spec.rb +3 -1
- data/spec/units/plugins/sanitize_spec.rb +1 -1
- data/spec/units/plugins/valgrind_spec.rb +23 -8
- data/spec/units/preprocess/preprocessinator_code_finder_spec.rb +73 -10
- data/spec/units/preprocess/preprocessinator_comment_stripper_spec.rb +1 -1
- 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/rake_app/rakefile_component_resolver_spec.rb +21 -0
- data/spec/units/release_build_executor_spec.rb +53 -14
- data/spec/units/release_build_planner_spec.rb +15 -3
- data/spec/units/reportinator_spec.rb +5 -5
- data/spec/units/setupinator_spec.rb +51 -0
- data/spec/units/standin_headerinator_spec.rb +55 -9
- data/spec/units/test_build_executor_spec.rb +842 -166
- data/spec/units/test_build_planner_spec.rb +205 -15
- data/spec/units/test_build_setup_spec.rb +179 -30
- data/spec/units/test_context_extractor_spec.rb +36 -2
- data/spec/units/test_derived_search_paths_spec.rb +259 -0
- data/spec/units/test_file_preprocessinator_spec.rb +17 -1
- data/spec/units/test_includes_extractinator_spec.rb +61 -9
- data/spec/units/test_invoker/objects_wiring_spec.rb +24 -4
- 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_spec.rb +14 -1
- 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/test_source_file_directive_resolver_spec.rb +38 -7
- data/spec/units/tools/default_tools_quoting_spec.rb +117 -0
- 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} +27 -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
- data/spec/units/yaml_wrapper_spec.rb +11 -0
- metadata +265 -36
- data/lib/ceedling/file_finder_helper.rb +0 -127
- data/lib/ceedling/file_path_collection_utils.rb +0 -164
- data/spec/units/file_finder_spec.rb +0 -495
- /data/lib/ceedling/{tool_executor_helper.rb → tools/tool_executor_helper.rb} +0 -0
|
@@ -88,37 +88,40 @@ class PathMatcher
|
|
|
88
88
|
query_segments = segments(query)
|
|
89
89
|
return query unless query_segments.include?('..')
|
|
90
90
|
|
|
91
|
-
|
|
92
|
-
raise CeedlingException.new(
|
|
93
|
-
"Relative path reference '..' in '#{query}' has no file context to resolve against here."
|
|
94
|
-
)
|
|
95
|
-
end
|
|
91
|
+
require_anchor!(query, anchor)
|
|
96
92
|
|
|
97
93
|
# segments() strips the empty string a leading "/" splits off, so a Unix
|
|
98
94
|
# absolute anchor's own "/"-ness has to be remembered separately here and
|
|
99
95
|
# reapplied below -- otherwise the result quietly turns into a relative-looking
|
|
100
96
|
# path carrying the same text minus its leading "/".
|
|
101
|
-
|
|
97
|
+
absolute = anchor.start_with?('/')
|
|
102
98
|
resolved = segments(anchor)
|
|
103
|
-
|
|
104
|
-
# A `..` beyond a relative anchor's own segments names a directory above it, as a
|
|
105
|
-
# project's paths outside its own root do (`../shared`), so it stays in the result.
|
|
106
|
-
# Nothing lies above an absolute anchor's root.
|
|
107
|
-
query_segments.each do |segment|
|
|
108
|
-
if segment != '..'
|
|
109
|
-
resolved << segment
|
|
110
|
-
elsif !resolved.empty? and resolved.last != '..'
|
|
111
|
-
resolved.pop
|
|
112
|
-
elsif anchor_was_absolute
|
|
113
|
-
raise CeedlingException.new("Relative path reference '..' in '#{query}' climbs above the filesystem root.")
|
|
114
|
-
else
|
|
115
|
-
resolved << '..'
|
|
116
|
-
end
|
|
117
|
-
end
|
|
99
|
+
query_segments.each { |segment| step(resolved, segment, query, absolute) }
|
|
118
100
|
|
|
119
101
|
joined = resolved.join('/')
|
|
120
|
-
|
|
102
|
+
absolute ? "/#{joined}" : joined
|
|
103
|
+
end
|
|
104
|
+
|
|
105
|
+
def self.require_anchor!(query, anchor)
|
|
106
|
+
return unless anchor.nil?
|
|
107
|
+
|
|
108
|
+
raise CeedlingException.new( "Relative path reference '..' in '#{query}' has no file context to resolve against here." )
|
|
109
|
+
end
|
|
110
|
+
private_class_method :require_anchor!
|
|
111
|
+
|
|
112
|
+
# Applies one query segment to the segments resolved so far. A `..` beyond a relative
|
|
113
|
+
# anchor's own segments names a directory above it, as a project's paths outside its own
|
|
114
|
+
# root do (`../shared`), so it stays in the result. Nothing lies above an absolute
|
|
115
|
+
# anchor's root.
|
|
116
|
+
def self.step(resolved, segment, query, absolute)
|
|
117
|
+
return resolved << segment if segment != '..'
|
|
118
|
+
return resolved.pop if !resolved.empty? and resolved.last != '..'
|
|
119
|
+
|
|
120
|
+
raise CeedlingException.new("Relative path reference '..' in '#{query}' climbs above the filesystem root.") if absolute
|
|
121
|
+
|
|
122
|
+
resolved << '..'
|
|
121
123
|
end
|
|
124
|
+
private_class_method :step
|
|
122
125
|
|
|
123
126
|
# Two filepaths correspond if the shorter one's path segments equal the longer
|
|
124
127
|
# one's own trailing segments, exactly, in order -- checked without regard for
|
|
@@ -131,6 +134,27 @@ class PathMatcher
|
|
|
131
134
|
tail_matches?(shorter, longer)
|
|
132
135
|
end
|
|
133
136
|
|
|
137
|
+
# What remains of `path` above `tail`'s segments: `.` when nothing does, and nil when
|
|
138
|
+
# `path` doesn't end in `tail`. A leading `/`, `//` share, or drive letter stays.
|
|
139
|
+
def self.strip_tail(path, tail)
|
|
140
|
+
path_segments = segments(path)
|
|
141
|
+
tail_segments = segments(tail)
|
|
142
|
+
return nil if tail_segments.empty? or !tail_matches?(tail_segments, path_segments)
|
|
143
|
+
|
|
144
|
+
return rooted(path, path_segments[0...-tail_segments.length])
|
|
145
|
+
end
|
|
146
|
+
|
|
147
|
+
# `rest`, the segments of `path` that remain, joined under `path`'s own root
|
|
148
|
+
def self.rooted(path, rest)
|
|
149
|
+
drive = path[/\A[A-Za-z]:(?=[\\\/])/]
|
|
150
|
+
return "#{drive}/#{rest.drop(1).join('/')}" if drive
|
|
151
|
+
return "//#{rest.join('/')}" if path.match?(%r{\A[\\/]{2}[^\\/]})
|
|
152
|
+
return "/#{rest.join('/')}" if path.start_with?('/', '\\')
|
|
153
|
+
|
|
154
|
+
return rest.empty? ? '.' : rest.join('/')
|
|
155
|
+
end
|
|
156
|
+
private_class_method :rooted
|
|
157
|
+
|
|
134
158
|
# A Unix absolute path or one beginning with a Windows drive letter
|
|
135
159
|
def self.absolute?(path)
|
|
136
160
|
path.start_with?('/') || path.match?( /\A[A-Za-z]:[\\\/]/ )
|
|
@@ -138,8 +162,9 @@ class PathMatcher
|
|
|
138
162
|
|
|
139
163
|
### Private ###
|
|
140
164
|
|
|
165
|
+
# A `.` segment names nothing, so it is dropped with the empty ones
|
|
141
166
|
def self.segments(path)
|
|
142
|
-
path.split(/[\\\/]/).reject
|
|
167
|
+
path.split(/[\\\/]/).reject { |segment| segment.empty? || segment == '.' }
|
|
143
168
|
end
|
|
144
169
|
private_class_method :segments
|
|
145
170
|
|
|
@@ -5,7 +5,8 @@
|
|
|
5
5
|
# SPDX-License-Identifier: MIT
|
|
6
6
|
# =========================================================================
|
|
7
7
|
|
|
8
|
-
require 'ceedling/file_path_utils'
|
|
8
|
+
require 'ceedling/filesystem/file_path_utils'
|
|
9
|
+
require 'ceedling/filesystem/project_paths'
|
|
9
10
|
|
|
10
11
|
# Answers the question build output asks when it wants to avoid same-basename
|
|
11
12
|
# collisions: given a resolved file and the raw (still possibly glob/decorator-laden)
|
|
@@ -23,12 +24,13 @@ class PathMirror
|
|
|
23
24
|
end
|
|
24
25
|
|
|
25
26
|
# Strips decorators and glob specifiers from each entry in `roots`, dropping any that
|
|
26
|
-
# end up empty. A caller mirroring many files against the same `roots` list -- a whole
|
|
27
|
+
# end up empty and every `-:` exclusion, which names no place a file lives below. A caller mirroring many files against the same `roots` list -- a whole
|
|
27
28
|
# build's worth of sources against one project's configured paths, say -- can compute
|
|
28
29
|
# this once and feed the result to `relative_subdir_from_clean_roots` for every file,
|
|
29
30
|
# rather than every file's own call re-parsing the same still-decorated list from scratch.
|
|
30
31
|
def self.clean_roots(roots)
|
|
31
32
|
roots
|
|
33
|
+
.select { |root| FilePathUtils.add_path?(root) }
|
|
32
34
|
.map { |root| FilePathUtils.no_decorators(root) }
|
|
33
35
|
.reject(&:empty?)
|
|
34
36
|
end
|
|
@@ -38,12 +40,13 @@ class PathMirror
|
|
|
38
40
|
# fallback for placing build output but hides the difference from a caller deciding
|
|
39
41
|
# whether a path belongs to a configured tree at all.
|
|
40
42
|
def self.relative_subdir_if_rooted(filepath, roots)
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
return nil unless clean.any? { |root| file_dir == root || file_dir.start_with?( root + '/' ) }
|
|
43
|
+
return relative_subdir_if_rooted_in_clean_roots( filepath, clean_roots( roots ) )
|
|
44
|
+
end
|
|
45
45
|
|
|
46
|
-
|
|
46
|
+
# As `relative_subdir_if_rooted`, but takes roots already reduced by `clean_roots`, or
|
|
47
|
+
# canonical roots such as configuration's mirror roots
|
|
48
|
+
def self.relative_subdir_if_rooted_in_clean_roots(filepath, clean_roots)
|
|
49
|
+
return containing_subdir( File.dirname( filepath ), clean_roots )
|
|
47
50
|
end
|
|
48
51
|
|
|
49
52
|
# A path as lowercased segments, split on either separator. One spelling for every caller
|
|
@@ -56,18 +59,16 @@ class PathMirror
|
|
|
56
59
|
# As `relative_subdir`, but takes roots already reduced by `clean_roots` instead of
|
|
57
60
|
# raw, possibly glob/decorator-laden `:paths` entries.
|
|
58
61
|
def self.relative_subdir_from_clean_roots(filepath, clean_roots)
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
matching_roots = clean_roots.select do |root|
|
|
62
|
-
file_dir == root || file_dir.start_with?(root + '/')
|
|
63
|
-
end
|
|
64
|
-
|
|
65
|
-
return '' if matching_roots.empty?
|
|
66
|
-
|
|
67
|
-
best_root = matching_roots.max_by(&:length)
|
|
68
|
-
return '' if file_dir == best_root
|
|
62
|
+
return containing_subdir( File.dirname( filepath ), clean_roots ) || ''
|
|
63
|
+
end
|
|
69
64
|
|
|
70
|
-
|
|
65
|
+
# The directories from the most specific root truly containing `dir` down to it, or nil
|
|
66
|
+
# when no root does. Roots and `dir` are compared as places, however each is spelled, so
|
|
67
|
+
# the result never climbs out of its root.
|
|
68
|
+
def self.containing_subdir(dir, clean_roots)
|
|
69
|
+
subdirs = clean_roots.map { |root| ProjectPaths.subdir_below( root, dir ) }.compact
|
|
70
|
+
return subdirs.min_by( &:length )
|
|
71
71
|
end
|
|
72
|
+
private_class_method :containing_subdir
|
|
72
73
|
|
|
73
74
|
end
|
|
@@ -0,0 +1,55 @@
|
|
|
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 'set'
|
|
9
|
+
require 'ceedling/filesystem/project_paths'
|
|
10
|
+
|
|
11
|
+
# A place reached through a symlink has two spellings: as listed and as it really is.
|
|
12
|
+
# Collection compares places by both, and measures how far one lies below another.
|
|
13
|
+
module PathSpellings
|
|
14
|
+
|
|
15
|
+
# A path as compared: Windows compares paths without regard to case
|
|
16
|
+
def self.key(path)
|
|
17
|
+
return ProjectPaths::WINDOWS ? path.downcase : path
|
|
18
|
+
end
|
|
19
|
+
|
|
20
|
+
# Both spellings of each of `paths`, as compared, so either reaches it
|
|
21
|
+
def self.of(paths)
|
|
22
|
+
return Set.new( paths.flat_map { |path| [ProjectPaths.absolute( path ), ProjectPaths.real_absolute( path )] }.map { |path| key( path ) } )
|
|
23
|
+
end
|
|
24
|
+
|
|
25
|
+
# How many directories above a place, by any of `spellings` of it, the nearest one in
|
|
26
|
+
# `spelled` lies: 0 for the place itself, or infinity for none
|
|
27
|
+
def self.nearer(spellings, spelled)
|
|
28
|
+
return Float::INFINITY if spelled.empty?
|
|
29
|
+
|
|
30
|
+
return spellings.map { |path| distance( path, spelled ) }.min
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
# `paths`, found below `base`, respelled below the base's real path
|
|
34
|
+
def self.through_real(paths, base)
|
|
35
|
+
real = ProjectPaths.real_absolute( base )
|
|
36
|
+
return paths if base == real
|
|
37
|
+
|
|
38
|
+
return paths.map { |path| ProjectPaths.same?( path, base ) || ProjectPaths.starts_with?( path, "#{base}/" ) ? real + path[base.length..] : path }
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
def self.distance(path, spelled)
|
|
42
|
+
steps = 0
|
|
43
|
+
loop do
|
|
44
|
+
return steps if spelled.include?( key( path ) )
|
|
45
|
+
|
|
46
|
+
parent = File.dirname( path )
|
|
47
|
+
return Float::INFINITY if parent == path
|
|
48
|
+
|
|
49
|
+
path = parent
|
|
50
|
+
steps += 1
|
|
51
|
+
end
|
|
52
|
+
end
|
|
53
|
+
private_class_method :distance
|
|
54
|
+
|
|
55
|
+
end
|
|
@@ -0,0 +1,184 @@
|
|
|
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 'pathname'
|
|
9
|
+
require 'rbconfig'
|
|
10
|
+
require 'ceedling/filesystem/working_dir'
|
|
11
|
+
|
|
12
|
+
# One spelling for every path a project names.
|
|
13
|
+
#
|
|
14
|
+
# A place can be written many ways: relative or absolute, with `./`, `..`, `~`, backslashes,
|
|
15
|
+
# or through a symlink. Intake spells each path once, relative to the working directory
|
|
16
|
+
# (`canonical`). Comparisons then use whole directories, never text prefixes (`contains?`).
|
|
17
|
+
# BuildSubpath places build files from these spellings.
|
|
18
|
+
#
|
|
19
|
+
# Pure functions over strings, except where a function says it reads the disk, and no
|
|
20
|
+
# dependency on DIY, so the launcher in bin/ shares it.
|
|
21
|
+
module ProjectPaths
|
|
22
|
+
|
|
23
|
+
DECORATOR = /\A[+-]:/
|
|
24
|
+
WINDOWS = (RbConfig::CONFIG['host_os'] =~ /mswin|mingw|msys|ucrt/i) ? true : false
|
|
25
|
+
|
|
26
|
+
# What `absolute` makes of a path, which `clean_absolute?` finds already so: rooted, `C:/`
|
|
27
|
+
# on Windows, and free of `.`/`..` segments, doubled `/`, and backslashes. Windows'
|
|
28
|
+
# File.expand_path also lengthens a short `~` name and drops a trailing dot or space.
|
|
29
|
+
ROOTED = WINDOWS ? %r{\A[A-Z]:/} : %r{\A/}
|
|
30
|
+
ROOT_LENGTH = WINDOWS ? 3 : 1
|
|
31
|
+
UNCLEAN = WINDOWS ? %r{//|/\.\.?(?:/|\z)|\\|~|[. ](?:/|\z)} : %r{//|/\.\.?(?:/|\z)|\\}
|
|
32
|
+
|
|
33
|
+
@lock = Mutex.new
|
|
34
|
+
@absolutes = {}
|
|
35
|
+
|
|
36
|
+
# The working directory with every symlink resolved, read once (see WorkingDir)
|
|
37
|
+
def self.working_dir
|
|
38
|
+
return WorkingDir.path
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
# A path written as a project file writes it, in Ceedling's form: trimmed, `/`-separated,
|
|
42
|
+
# with no trailing separator, and `~` read as the home directory. A `+:`/`-:` decorator is
|
|
43
|
+
# kept. `~user` is left as written.
|
|
44
|
+
def self.standardize(path)
|
|
45
|
+
path = path.to_s.strip.tr( '\\', '/' )
|
|
46
|
+
decorator = path[DECORATOR] || ''
|
|
47
|
+
path = expand_home( path.delete_prefix( decorator ).strip )
|
|
48
|
+
path = path.sub( %r{/+\z}, '' ) unless path.match?( %r{\A(?:[A-Za-z]:)?/+\z} )
|
|
49
|
+
return decorator + path
|
|
50
|
+
end
|
|
51
|
+
|
|
52
|
+
# `path` as an absolute path, its `..` and `.` resolved against the working directory
|
|
53
|
+
# without reading the disk. A drive letter is upper case. Remembered for each working
|
|
54
|
+
# directory and home directory, since a build compares the same few roots many times.
|
|
55
|
+
def self.absolute(path)
|
|
56
|
+
return path if clean_absolute?( path )
|
|
57
|
+
|
|
58
|
+
key = [working_dir, Dir.home, path.to_s]
|
|
59
|
+
cached = @lock.synchronize { @absolutes[key] }
|
|
60
|
+
return cached unless cached.nil?
|
|
61
|
+
|
|
62
|
+
absolute = absolute_of( path ).freeze
|
|
63
|
+
return @lock.synchronize { @absolutes[key] = absolute }
|
|
64
|
+
end
|
|
65
|
+
|
|
66
|
+
# The one spelling intake records for `path`: relative to the working directory, with the
|
|
67
|
+
# symlinks along its existing part resolved. A path with no relative form (another drive,
|
|
68
|
+
# a UNC share) stays absolute. Reads the disk.
|
|
69
|
+
def self.canonical(path)
|
|
70
|
+
return relative( real_absolute( path ) )
|
|
71
|
+
end
|
|
72
|
+
|
|
73
|
+
# `absolute` with the symlinks along its existing part resolved. Reads the disk.
|
|
74
|
+
def self.real_absolute(path)
|
|
75
|
+
return real( absolute( path ) )
|
|
76
|
+
end
|
|
77
|
+
|
|
78
|
+
# `absolute` relative to the working directory, or absolute when it has no relative form.
|
|
79
|
+
# The working directory itself is `.`.
|
|
80
|
+
def self.relative(absolute)
|
|
81
|
+
return absolute if unc?( absolute )
|
|
82
|
+
|
|
83
|
+
# Most paths lie below the working directory, which needs no Pathname walk
|
|
84
|
+
return '.' if same?( absolute, working_dir )
|
|
85
|
+
return absolute[(working_dir.length + 1)..] if clean_absolute?( absolute ) and starts_with?( absolute, "#{working_dir}/" )
|
|
86
|
+
|
|
87
|
+
return Pathname.new( absolute ).relative_path_from( Pathname.new( working_dir ) ).to_s
|
|
88
|
+
rescue ::ArgumentError
|
|
89
|
+
return absolute
|
|
90
|
+
end
|
|
91
|
+
|
|
92
|
+
# Whether `path` is `root` or lies below it, compared as whole directories. Windows folds case.
|
|
93
|
+
def self.contains?(root, path)
|
|
94
|
+
return !subdir_below( root, path ).nil?
|
|
95
|
+
end
|
|
96
|
+
|
|
97
|
+
# The directories from `root` down to `path`: '' for `root` itself, or nil when `path`
|
|
98
|
+
# doesn't lie below `root`. Never holds `..`, and is never absolute.
|
|
99
|
+
def self.subdir_below(root, path)
|
|
100
|
+
base = absolute( root )
|
|
101
|
+
full = absolute( path )
|
|
102
|
+
return '' if same?( base, full )
|
|
103
|
+
|
|
104
|
+
prefix = base.end_with?( '/' ) ? base : "#{base}/"
|
|
105
|
+
return nil unless starts_with?( full, prefix )
|
|
106
|
+
|
|
107
|
+
return full[prefix.length..]
|
|
108
|
+
end
|
|
109
|
+
|
|
110
|
+
# A path's segments, `.` and empty segments dropped
|
|
111
|
+
def self.segments(path)
|
|
112
|
+
return path.to_s.split( %r{[\\/]} ).reject { |segment| segment.empty? || segment == '.' }
|
|
113
|
+
end
|
|
114
|
+
|
|
115
|
+
def self.absolute?(path)
|
|
116
|
+
return path.start_with?( '/' ) || path.match?( %r{\A[A-Za-z]:/} )
|
|
117
|
+
end
|
|
118
|
+
|
|
119
|
+
# A Windows share. Elsewhere a doubled leading separator is the filesystem root.
|
|
120
|
+
def self.unc?(path)
|
|
121
|
+
return WINDOWS && path.start_with?( '//' )
|
|
122
|
+
end
|
|
123
|
+
|
|
124
|
+
# Whether two spellings are the same text, folding case on Windows
|
|
125
|
+
def self.same?(a, b)
|
|
126
|
+
return WINDOWS ? a.casecmp?( b ) : a == b
|
|
127
|
+
end
|
|
128
|
+
|
|
129
|
+
def self.starts_with?(path, prefix)
|
|
130
|
+
return WINDOWS ? path.downcase.start_with?( prefix.downcase ) : path.start_with?( prefix )
|
|
131
|
+
end
|
|
132
|
+
|
|
133
|
+
# Already absolute as `absolute` would spell it: rooted (with an upper case drive on
|
|
134
|
+
# Windows), with no `.` or `..` segment, doubled or trailing `/`, backslash, or surrounding
|
|
135
|
+
# space. On Windows, File.expand_path also lengthens a short `~` name and drops a trailing
|
|
136
|
+
# dot or space, so a segment with any of those is never clean.
|
|
137
|
+
def self.clean_absolute?(path)
|
|
138
|
+
return false unless path.is_a?( String ) and path.match?( ROOTED )
|
|
139
|
+
return false if path.match?( UNCLEAN ) or path != path.strip
|
|
140
|
+
|
|
141
|
+
return path.length == ROOT_LENGTH || !path.end_with?( '/' )
|
|
142
|
+
end
|
|
143
|
+
|
|
144
|
+
# A `~user` path names a directory of that name, which File.expand_path would read as the
|
|
145
|
+
# user's home (or raise for no such user). A share's `..` never leaves the share.
|
|
146
|
+
def self.absolute_of(path)
|
|
147
|
+
path = standardize( path )
|
|
148
|
+
return unc_absolute( path ) if unc?( path )
|
|
149
|
+
|
|
150
|
+
path = "./#{path}" if path.start_with?( '~' )
|
|
151
|
+
return File.expand_path( path, working_dir ).squeeze( '/' ).sub( /\A[a-z](?=:)/ ) { |drive| drive.upcase }
|
|
152
|
+
end
|
|
153
|
+
|
|
154
|
+
def self.unc_absolute(path)
|
|
155
|
+
server, share, *rest = path.split( '/' ).reject { |segment| segment.empty? || segment == '.' }
|
|
156
|
+
kept = rest.each_with_object( [] ) { |segment, resolved| segment == '..' ? resolved.pop : resolved.push( segment ) }
|
|
157
|
+
return "//#{[server, share, *kept].compact.join( '/' )}"
|
|
158
|
+
end
|
|
159
|
+
|
|
160
|
+
def self.expand_home(path)
|
|
161
|
+
return path unless path == '~' || path.start_with?( '~/' )
|
|
162
|
+
|
|
163
|
+
return Dir.home + path.delete_prefix( '~' )
|
|
164
|
+
end
|
|
165
|
+
|
|
166
|
+
# The real path of the longest existing part of `absolute`, with the rest appended
|
|
167
|
+
def self.real(absolute)
|
|
168
|
+
return File.realpath( absolute ) if File.exist?( absolute )
|
|
169
|
+
|
|
170
|
+
existing = absolute
|
|
171
|
+
missing = []
|
|
172
|
+
until File.exist?( existing ) || existing == File.dirname( existing )
|
|
173
|
+
missing.unshift( File.basename( existing ) )
|
|
174
|
+
existing = File.dirname( existing )
|
|
175
|
+
end
|
|
176
|
+
|
|
177
|
+
return absolute unless File.exist?( existing )
|
|
178
|
+
|
|
179
|
+
return File.join( File.realpath( existing ), *missing )
|
|
180
|
+
end
|
|
181
|
+
|
|
182
|
+
private_class_method :clean_absolute?, :absolute_of, :unc_absolute, :expand_home, :real
|
|
183
|
+
|
|
184
|
+
end
|
|
@@ -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
|