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
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
# Dependency Cache Schema Versions
|
|
2
|
+
|
|
3
|
+
This file records each version of the delta build dependency cache's schema: what a
|
|
4
|
+
cache of that version holds, and why the version was raised. Add a section here whenever
|
|
5
|
+
a version changes.
|
|
6
|
+
|
|
7
|
+
## Each pipeline's version
|
|
8
|
+
|
|
9
|
+
Test and release builds each have a version of their own, since a change to one build's
|
|
10
|
+
layout leaves the other's cache valid. Both are in `dependency_cache_store.rb`:
|
|
11
|
+
|
|
12
|
+
- **`CACHE_SCHEMA_VERSION`** is every test pipeline's: `test` and each plugin's own
|
|
13
|
+
context, such as `gcov`.
|
|
14
|
+
- **`RELEASE_CACHE_SCHEMA_VERSION`** is the release build's.
|
|
15
|
+
|
|
16
|
+
`Dependinator.cache_schema_version` chooses one by the pipeline's identifier. A change
|
|
17
|
+
to the file's shape raises both versions. A change to one build's layout raises only that
|
|
18
|
+
build's version. Up to version 3 the two were one, and a section below names its
|
|
19
|
+
pipelines when its version is only one build's.
|
|
20
|
+
|
|
21
|
+
## When the version changes
|
|
22
|
+
|
|
23
|
+
The version changes in either of two cases:
|
|
24
|
+
|
|
25
|
+
- **The file's shape changes.** A field is added, removed, renamed, or reinterpreted in a
|
|
26
|
+
way an older Ceedling would misread.
|
|
27
|
+
- **The build layout changes.** Cache keys are build paths, so a release that moves where
|
|
28
|
+
a build puts its output changes that build's version even when the file's shape is
|
|
29
|
+
unchanged. Otherwise an old entry could vouch for a path that now holds a different
|
|
30
|
+
target's output.
|
|
31
|
+
|
|
32
|
+
An optional field an older reader safely ignores needs no new version.
|
|
33
|
+
|
|
34
|
+
## How a version is read
|
|
35
|
+
|
|
36
|
+
`DependencyCacheStore#load` compares a cache's `schema_version` with its pipeline's
|
|
37
|
+
current one:
|
|
38
|
+
|
|
39
|
+
- **Equal.** The cache is used. Malformed entries and entries whose target is gone are
|
|
40
|
+
dropped one at a time.
|
|
41
|
+
- **Earlier**, from 1 up to the current version minus 1. The cache comes from an earlier
|
|
42
|
+
build layout. It is set aside, and the first build rebuilds everything once. A notice
|
|
43
|
+
advises `ceedling clobber` to remove output the old layout left on disk, which gcov
|
|
44
|
+
reports would otherwise still read.
|
|
45
|
+
- **Anything else**, missing or newer. The cache is treated as absent, with a warning,
|
|
46
|
+
and the build rebuilds everything.
|
|
47
|
+
|
|
48
|
+
## The cache file
|
|
49
|
+
|
|
50
|
+
Each pipeline, such as test or release, has its own cache file,
|
|
51
|
+
`<build_root>/cache/.<identifier>.dep_cache.json`. It is one JSON object:
|
|
52
|
+
|
|
53
|
+
```json
|
|
54
|
+
{
|
|
55
|
+
"schema_version": 4,
|
|
56
|
+
"hash_algorithm": "sha256",
|
|
57
|
+
"entries": {
|
|
58
|
+
"<target path>": {
|
|
59
|
+
"self_hash": "<hex digest>",
|
|
60
|
+
"meta_hash": "<hex digest> or null",
|
|
61
|
+
"deps": { "<dependency path>": "<hex digest>" },
|
|
62
|
+
"outputs": { "<output path>": "<hex digest>" }
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
- **`hash_algorithm`** names the digest every hash uses. A cache with another algorithm
|
|
69
|
+
is treated as absent.
|
|
70
|
+
- **`entries`** maps each tracked target's absolute, real-cased path to what its last
|
|
71
|
+
fresh build saw:
|
|
72
|
+
- `self_hash`, the target's own content;
|
|
73
|
+
- `meta_hash`, the hash of the target's build inputs that aren't files, such as a tool's
|
|
74
|
+
command line, or null;
|
|
75
|
+
- `deps`, each dependency file's content hash;
|
|
76
|
+
- `outputs`, present only for a step that produces files a later run trusts, each
|
|
77
|
+
output's content hash.
|
|
78
|
+
|
|
79
|
+
## Versions
|
|
80
|
+
|
|
81
|
+
### 4: each test's own root (1.2.3, test pipelines only)
|
|
82
|
+
|
|
83
|
+
**Contents:** unchanged from version 3.
|
|
84
|
+
|
|
85
|
+
**Why:** the test build layout changed. A test's name is its path, so one test's
|
|
86
|
+
directory below a shared base could also be a subdirectory of another test's, and the two
|
|
87
|
+
tests' files mixed (#1439). Each test's own directory below the mocks, Partials,
|
|
88
|
+
preprocessing, output, and dependencies directories gained a closing `_t_` segment after
|
|
89
|
+
the test's name, and its executable and linker map moved with its objects. Keys naming
|
|
90
|
+
the old paths name places no build reads any more. A release build's paths didn't move,
|
|
91
|
+
so its caches stay at version 3.
|
|
92
|
+
|
|
93
|
+
### 3: shortened build roots (1.2.3)
|
|
94
|
+
|
|
95
|
+
**Contents:** unchanged from version 2.
|
|
96
|
+
|
|
97
|
+
**Why:** the build layout changed. A build file below a long configured `:paths` root
|
|
98
|
+
moved below the root's short `_<name>_<hash>` marker, in place of the root's whole
|
|
99
|
+
location and any `_up_` climb to it (#1387). Keys naming the old paths name places no
|
|
100
|
+
build reads any more.
|
|
101
|
+
|
|
102
|
+
### 2: placement by project path (1.2.2)
|
|
103
|
+
|
|
104
|
+
**Contents:** unchanged from version 1.
|
|
105
|
+
|
|
106
|
+
**Why:** the build layout changed. Each test's output moved below the test's path from the
|
|
107
|
+
project root. Each object, preprocessed file, and dependencies file moved below its
|
|
108
|
+
source's path from the project root, with `_up_`, `_abs_`, `_unc_`, and `_ceedling_` for
|
|
109
|
+
paths outside it. A different test's new name could reuse an old directory, so no old
|
|
110
|
+
entry could be trusted.
|
|
111
|
+
|
|
112
|
+
### 1: the first cache (1.2.0)
|
|
113
|
+
|
|
114
|
+
**Contents:** `schema_version`, `hash_algorithm`, and `entries` with `self_hash`,
|
|
115
|
+
`meta_hash`, and `deps`. `outputs` was added during the 1.2.0 prereleases, before 1.2.0
|
|
116
|
+
shipped, as an optional field older readers ignore, so it needed no new version.
|
|
117
|
+
|
|
118
|
+
**Why:** content-hash tracking replaced timestamp-based rebuild decisions.
|
|
@@ -2,29 +2,29 @@
|
|
|
2
2
|
|
|
3
3
|
This subsystem answers one question for any expensive step in either the test or release pipeline: has anything this target depends on changed since it last built successfully? It answers using content hashes rather than timestamps, so neither pipeline ever duplicates work that doesn't need to be done.
|
|
4
4
|
|
|
5
|
-
It is not itself a pipeline with sequential stages the way `test_invoker`/`release_invoker` are. It
|
|
5
|
+
It is not itself a pipeline with sequential stages the way `test_invoker`/`release_invoker` are. It’s a service both pipelines call into, over and over, as a pure oracle. It never decides *when* to run a build step or *what order* steps happen in -- that’s each pipeline’s own stage list -- it only answers, at the moment a step is about to run, whether that build step actually needs to run.
|
|
6
6
|
|
|
7
|
-
## The subsystem
|
|
7
|
+
## The subsystem’s shape
|
|
8
8
|
|
|
9
9
|
Two classes matter most, and everything else exists to serve them:
|
|
10
10
|
|
|
11
|
-
- **`Dependinator`** is the thin, Ceedling-specific facade every pipeline actually talks to. Every method it has except one is a one-line passthrough to `DependencyTracker` below; what it actually owns is the convention for where a given pipeline
|
|
12
|
-
- **`DependencyTracker`** is the actual engine, and it
|
|
11
|
+
- **`Dependinator`** is the thin, Ceedling-specific facade every pipeline actually talks to. Every method it has except one is a one-line passthrough to `DependencyTracker` below; what it actually owns is the convention for where a given pipeline’s cache file lives on disk, keyed by a symbolic identifier (`:test`, `:release`, or a plugin’s own symbol), and the vocabulary translation at `flush` time from the tracker’s own `prune:` parameter to the pipeline-facing `refresh_dependencies:` (see below). Its whole reason for existing is so pipeline code speaks in build verbs -- register this, ask if that’s stale, mark this fresh -- and never has to know anything about cache file paths or tracker internals.
|
|
12
|
+
- **`DependencyTracker`** is the actual engine, and it’s deliberately generic and application-agnostic -- nothing in it knows what a "test" or a "release" is. It holds this run’s registrations in memory and a loaded cache of the previous run’s hashes, and its whole job is answering staleness queries against the two.
|
|
13
13
|
|
|
14
14
|
`DependencyTracker`, in turn, composes six narrowly-scoped collaborators, each doing exactly one job and nothing else. Four serve every run:
|
|
15
15
|
|
|
16
16
|
- `DependencyHasher` decides what makes two things count as "the same."
|
|
17
17
|
- `DependencyPathNormalizer` decides what makes two spellings of a path count as "the same target."
|
|
18
18
|
- `DependencyCacheStore` owns the on-disk cache file itself.
|
|
19
|
-
- `GccDependencyParser` turns a compiler
|
|
19
|
+
- `GccDependencyParser` turns a compiler’s own dependency output into something registerable.
|
|
20
20
|
|
|
21
21
|
The other two, `DependencyDebugTree` and `DependencyDiffer`, serve only the troubleshooting aid described last. The sections below cover each in turn.
|
|
22
22
|
|
|
23
23
|
## The `register` → `stale?` → `mark_fresh` idiom
|
|
24
24
|
|
|
25
|
-
Every call site in both pipelines, regardless of what expensive thing it
|
|
25
|
+
Every call site in both pipelines, regardless of what expensive thing it’s guarding -- a preprocessor subprocess, a mock generation, a real compiler or linker invocation -- follows the same three-part shape. `register` tells the tracker what a target depends on: its antecedent files, and a `meta` value carrying anything else that should count toward staleness even though it isn't a file at all -- compile flags, `-D` defines, search paths, a toolchain version string, a coverage-on-or-off flag. An object file’s target is the `.o` itself; its files are its source plus whatever headers it actually pulled in; its meta is the flags and defines that, if they change, should force a recompile even though the source file itself didn't change a byte.
|
|
26
26
|
|
|
27
|
-
`register` is additive on purpose. Calling it more than once for the same target unions the file lists and merges the meta rather than replacing what came before, so a target
|
|
27
|
+
`register` is additive on purpose. Calling it more than once for the same target unions the file lists and merges the meta rather than replacing what came before, so a target’s dependencies can be built up incrementally across more than one call site without either caller needing full knowledge of what the other already supplied. This is exactly what lets a step register its source file and known flags in one call, then separately register the dependencies its tool discovered, described next.
|
|
28
28
|
|
|
29
29
|
### Dependencies discovered by the tool
|
|
30
30
|
|
|
@@ -32,38 +32,40 @@ A step can't know every file it depends on until its tool has run, since the hea
|
|
|
32
32
|
|
|
33
33
|
Two sources supply these files:
|
|
34
34
|
|
|
35
|
-
- **A compile
|
|
36
|
-
- **A preprocessing run
|
|
35
|
+
- **A compile’s `.d` file.** `-MMD -MF` writes gcc’s own dependency output, in Makefile dialect, and `register_gcc_deps_file` (or `register_gcc_deps_string`, for content already in hand) parses it with `GccDependencyParser` and `register`s each target it describes with that target’s dependency list. A single `.d` file can describe more than one target at once; it’s a small manifest, not just one file’s dependency list.
|
|
36
|
+
- **A preprocessing run’s line markers.** Two stages of the test pipeline preprocess each test file. Stage 4 runs it with `-fdirectives-only`, following its `#include`s, including headers a mock stand-in includes. Stage 11 fully expands it, reading every header it reaches. Each output’s line markers name every file it entered. The pipeline registers the project files among them (`Preprocessinator#preprocessed_dependencies`), so editing a header the test reaches reruns the step. Such a header’s macro can decide which mocks the test needs (stage 4) or which test cases it has (stage 11). System headers are left out. So are generated files below the build root, such as stand-ins and the mocks that replace them, which derive from project files and would only ever look changed.
|
|
37
37
|
|
|
38
38
|
### Fresh, stale, and invalidated
|
|
39
39
|
|
|
40
|
-
Once a target
|
|
40
|
+
Once a target’s inputs are registered, `stale?` is a pure question with no side effects, and `mark_fresh` is the write that happens after a real (re)build succeeds, recording new hashes for the target itself, its meta, and every currently-existing dependency. A dependency that’s gone missing is simply left out of what gets recorded -- `stale?` already treats a missing dependency as stale on its own, so there’s nothing to gain by recording anything else about it. `stale?` weighs only the dependencies registered this run, though. One dropped from the list leaves every remaining dependency as it was, so the drop goes unseen. A target whose dependency list can shrink while the rest stay unchanged -- a link, when a source or library leaves the build -- also registers the list itself as meta, so a shorter list is a meta change. A link’s dependencies include the library files `LibraryResolver` finds for its `:libraries` entries, and those the Dependencies plugin publishes in `LIBRARIES_LINK_FILES`. `invalidate` is the explicit override: it drops a target’s cache entry outright, so its next `stale?` answers true whatever the hashes say, while leaving this run’s registrations alone.
|
|
41
41
|
|
|
42
|
-
Some steps also produce a file beside their target that a later run trusts, such as a test
|
|
42
|
+
Some steps also produce a file beside their target that a later run trusts, such as a test’s cached results or a test file’s cached build directives. These are a target’s `outputs`, registered after the step produces them and before `mark_fresh`, which records their hashes in the target’s cache entry. A fresh target vouches for those outputs: `stale?` reads them from the cache entry, not this run’s registrations, and treats the target as stale when any one is missing or altered. Damage to a trusted artifact then costs one rerun of the step that wrote it. Throughout, only a regular file counts as present. A directory named as a dependency, as a truncated `.d` file can do, reads as missing rather than being hashed.
|
|
43
43
|
|
|
44
44
|
## What makes two things "the same"
|
|
45
45
|
|
|
46
46
|
Two decisions make this whole scheme trustworthy rather than merely convenient, and both trade a little efficiency for a lot of certainty.
|
|
47
47
|
|
|
48
|
-
`DependencyHasher` hashes a file
|
|
48
|
+
`DependencyHasher` hashes a file’s exact on-disk bytes, whitespace included, with no format-aware normalization at all. A file unchanged since before the build began is hashed once a build, keyed by its size and modification time, since many targets share one dependency. Anything modified as the build began or since is hashed every time. Whitespace isn't reliably cosmetic: it’s syntactically meaningful in YAML, and it can even change whether a C macro’s line continuation is recognized. The two ways a hash-based staleness check can be wrong aren't equally bad, either. Reporting something stale when it isn't just costs a wasted rebuild. Reporting it fresh when it isn't means shipping a build that silently doesn't reflect its own source -- exactly the failure this whole subsystem exists to prevent. The same hasher also canonicalizes a `meta` value before hashing it. Hash-key order and Symbol-vs-String keys never matter as a result, while array element order is still preserved, since the order of a flags or defines list can itself be meaningful.
|
|
49
49
|
|
|
50
50
|
`DependencyPathNormalizer` solves a narrower but equally important problem. It resolves a path to its real, on-disk casing before that path is ever used as a cache key. A `#include "Foo.h"` written one way and a file that actually exists on disk as `foo.h` can then never be mistaken for two different targets -- nor can the same real file assembled from project configuration two different ways.
|
|
51
51
|
|
|
52
52
|
## The on-disk cache
|
|
53
53
|
|
|
54
|
-
Each pipeline identifier gets exactly one JSON cache file of its own, never shared with any other identifier. Test and release builds each get their own, and a plugin introducing a third pipeline would get a third, just by choosing its own identifier. This isn't incidental. It
|
|
54
|
+
Each pipeline identifier gets exactly one JSON cache file of its own, never shared with any other identifier. Test and release builds each get their own, and a plugin introducing a third pipeline would get a third, just by choosing its own identifier. This isn't incidental. It’s what makes the pruning behavior described below safe at all -- a shared cache would mean a full test run’s prune could silently evict every cached release entry along with it.
|
|
55
55
|
|
|
56
|
-
Loading that cache is deliberately forgiving in one direction and strict in another. Any structural surprise in the file as a whole degrades the entire store to empty rather than raising. A missing cache, malformed cache, or incompatible version simply triggers a full rebuild instead of a hard failure. A single malformed *entry* within an otherwise-good file, similarly, only drops that one entry (i.e. requires a rebuild step). On every load, entries whose target has since been deleted from disk are pruned, automatically and unconditionally. This pruning is always safe, even during a partial run that only touches a handful of targets, because it only ever removes an entry once its target is confirmed gone from disk -- never merely unregistered this run. That
|
|
56
|
+
Loading that cache is deliberately forgiving in one direction and strict in another. Any structural surprise in the file as a whole degrades the entire store to empty rather than raising. A missing cache, malformed cache, or incompatible version simply triggers a full rebuild instead of a hard failure. A single malformed *entry* within an otherwise-good file, similarly, only drops that one entry (i.e. requires a rebuild step). On every load, entries whose target has since been deleted from disk are pruned, automatically and unconditionally. This pruning is always safe, even during a partial run that only touches a handful of targets, because it only ever removes an entry once its target is confirmed gone from disk -- never merely unregistered this run. That’s exactly what distinguishes it from the opt-in pruning described next. Persisting the cache back out is done via a write-to-temp-file-then-rename, so a reader can never observe a half-written cache.
|
|
57
|
+
|
|
58
|
+
The cache’s schema version also marks the build layout. Its keys are build paths, so a release that moves where a build puts its output bumps the version even when the file’s shape is unchanged. [CACHE_SCHEMA.md](CACHE_SCHEMA.md) records each version, what it holds, and why it was raised. A cache from an earlier version is set aside like any other incompatible one, so the first build after upgrading rebuilds everything once, and no target can trust an old directory that a different test’s new name happens to reuse. Its warning says so and advises `ceedling clobber`. The old store’s entries go with it, so nothing in the cache refers to the old layout. Only the old files stay on disk, where gcov’s coverage reports would still read them until `clobber` removes them.
|
|
57
59
|
|
|
58
60
|
## `refresh_dependencies`: the special feature
|
|
59
61
|
|
|
60
|
-
A normal `flush` just persists whatever this run registered and learned. Passing `refresh_dependencies: true` additionally drops every cache entry whose target was *not* registered at some point during this run, before persisting. In effect, this treats this run
|
|
62
|
+
A normal `flush` just persists whatever this run registered and learned. Passing `refresh_dependencies: true` additionally drops every cache entry whose target was *not* registered at some point during this run, before persisting. In effect, this treats this run’s registrations as the complete, authoritative set of everything that should still have a cache entry at all. That’s exactly correct for a run that’s guaranteed to have touched every target that matters, such as a full `test:all` or a full release build. It’s exactly wrong for anything less than that. A single test file, `test:pattern`, `test:path`, or the ad hoc single-file `release:compile:`/`release:assemble:` tasks would each, if this were set true, silently wipe out cache entries for every target the partial run simply didn't happen to touch -- forcing an unnecessary full rebuild on the next real run. Both pipelines are careful to set it only when they can actually make that guarantee.
|
|
61
63
|
|
|
62
64
|
## Debugging a stale/fresh surprise
|
|
63
65
|
|
|
64
66
|
Separately from anything either pipeline does on a normal run, this subsystem carries an opt-in troubleshooting aid for a human trying to understand *why* something did or didn't rebuild. Setting the `CEEDLING_DEP_DEBUG` developer-only environment variable turns on a tiered snapshot mechanism, off by default. `CEEDLING_DEP_DEBUG=meta` captures just the canonicalized meta a target was judged against. `CEEDLING_DEP_DEBUG=full` additionally captures the actual content of the target and its dependencies at the moment they were last marked fresh. Both tiers write into a human-readable file tree alongside the cache, capped in size per file so one enormous generated header can't silently balloon that tree.
|
|
65
67
|
|
|
66
|
-
Those snapshots exist to back one thing: `DependencyTracker#diagnose`, an always-available "explain yourself" query that reports which of a target
|
|
68
|
+
Those snapshots exist to back one thing: `DependencyTracker#diagnose`, an always-available "explain yourself" query that reports which of a target’s self-hash, meta-hash, dependency hashes, or output hashes changed. `diagnose` runs regardless of whether `CEEDLING_DEP_DEBUG` is set. Without a snapshot to compare against, it can still report *that* a given hash changed, but not *what* changed. With one available, from a run where the matching tier was active, it produces an actual before/after diff instead.
|
|
67
69
|
|
|
68
70
|
`DependencyDebugTree` writes and reads those snapshots, and `DependencyDiffer` turns a snapshot and the live content into that diff. The differ uses the `diff-lcs` gem, a development-only dependency that an installed release gem does not require. Without it, the explanation degrades to a plain before/after dump rather than failing.
|
|
69
71
|
|
|
@@ -11,9 +11,9 @@ require 'ceedling/dependencies/dependency_hasher'
|
|
|
11
11
|
|
|
12
12
|
# Loads, validates, and persists DependencyTracker's on-disk cache file.
|
|
13
13
|
#
|
|
14
|
-
# The persisted shape is a single JSON object:
|
|
14
|
+
# The persisted shape is a single JSON object (each version is recorded in CACHE_SCHEMA.md):
|
|
15
15
|
# {
|
|
16
|
-
# "schema_version":
|
|
16
|
+
# "schema_version": 3,
|
|
17
17
|
# "hash_algorithm": "sha256",
|
|
18
18
|
# "entries": {
|
|
19
19
|
# "<target path>": {
|
|
@@ -55,27 +55,34 @@ require 'ceedling/dependencies/dependency_hasher'
|
|
|
55
55
|
# only when it knows a run's registrations were comprehensive.
|
|
56
56
|
class DependencyCacheStore
|
|
57
57
|
|
|
58
|
-
|
|
58
|
+
# Cache keys are build paths, so a change to where a build puts its output changes the
|
|
59
|
+
# schema too. A release build's layout changes apart from a test build's, so each kind of
|
|
60
|
+
# pipeline has a version of its own: CACHE_SCHEMA_VERSION for every test pipeline, and
|
|
61
|
+
# RELEASE_CACHE_SCHEMA_VERSION for a release build. CACHE_SCHEMA.md records each version
|
|
62
|
+
# and why it was raised.
|
|
63
|
+
CACHE_SCHEMA_VERSION = 4 unless const_defined?(:CACHE_SCHEMA_VERSION, false)
|
|
64
|
+
RELEASE_CACHE_SCHEMA_VERSION = 3 unless const_defined?(:RELEASE_CACHE_SCHEMA_VERSION, false)
|
|
59
65
|
|
|
60
66
|
constructor :file_wrapper, :loginator
|
|
61
67
|
|
|
62
|
-
# Loads and validates `store_path`, returning
|
|
68
|
+
# Loads and validates `store_path` against its pipeline's `schema_version`, returning
|
|
63
69
|
# `{ 'schema_version', 'hash_algorithm', 'entries', 'pruned' }`. `entries`
|
|
64
70
|
# is always a Hash of target path => entry Hash, with any invalid or
|
|
65
71
|
# deleted-target entries dropped. `pruned` is the list of target paths
|
|
66
72
|
# dropped this load (malformed or deleted) -- callers use it to also clean
|
|
67
73
|
# up any DependencyDebugTree data for those same targets, so the debug
|
|
68
74
|
# tree doesn't outlive the cache entries it exists to explain.
|
|
69
|
-
def load(store_path)
|
|
70
|
-
return empty_store unless @file_wrapper.exist?( store_path )
|
|
75
|
+
def load(store_path, schema_version: CACHE_SCHEMA_VERSION)
|
|
76
|
+
return empty_store( schema_version ) unless @file_wrapper.exist?( store_path )
|
|
71
77
|
|
|
72
78
|
raw = @file_wrapper.read( store_path )
|
|
73
79
|
parsed = JSON.parse( raw )
|
|
74
80
|
|
|
75
|
-
return degrade( store_path, "does not contain a JSON object" ) unless parsed.is_a?( Hash )
|
|
76
|
-
return
|
|
77
|
-
return degrade( store_path, "has an incompatible or missing
|
|
78
|
-
return degrade( store_path, "
|
|
81
|
+
return degrade( store_path, schema_version, "does not contain a JSON object" ) unless parsed.is_a?( Hash )
|
|
82
|
+
return upgrade( store_path, schema_version ) if earlier_layout?( parsed['schema_version'], schema_version )
|
|
83
|
+
return degrade( store_path, schema_version, "has an incompatible or missing schema_version" ) unless parsed['schema_version'] == schema_version
|
|
84
|
+
return degrade( store_path, schema_version, "has an incompatible or missing hash_algorithm" ) unless parsed['hash_algorithm'] == DependencyHasher::HASH_ALGORITHM
|
|
85
|
+
return degrade( store_path, schema_version, "is missing its entries object" ) unless parsed['entries'].is_a?( Hash )
|
|
79
86
|
|
|
80
87
|
valid_entries = {}
|
|
81
88
|
pruned = []
|
|
@@ -83,7 +90,7 @@ class DependencyCacheStore
|
|
|
83
90
|
if !valid_entry?( entry )
|
|
84
91
|
@loginator.log(
|
|
85
92
|
"Dependency cache entry for '#{target}' in #{store_path} is malformed -- dropping just that entry.",
|
|
86
|
-
Verbosity::COMPLAIN
|
|
93
|
+
Verbosity::COMPLAIN
|
|
87
94
|
)
|
|
88
95
|
pruned << target
|
|
89
96
|
elsif !@file_wrapper.exist?( target )
|
|
@@ -98,25 +105,26 @@ class DependencyCacheStore
|
|
|
98
105
|
end
|
|
99
106
|
|
|
100
107
|
{
|
|
101
|
-
'schema_version' =>
|
|
108
|
+
'schema_version' => schema_version,
|
|
102
109
|
'hash_algorithm' => DependencyHasher::HASH_ALGORITHM,
|
|
103
110
|
'entries' => valid_entries,
|
|
104
111
|
'pruned' => pruned
|
|
105
112
|
}
|
|
106
113
|
|
|
107
114
|
rescue JSON::ParserError => e
|
|
108
|
-
degrade( store_path, "is not valid JSON (#{e.message})" )
|
|
115
|
+
degrade( store_path, schema_version, "is not valid JSON (#{e.message})" )
|
|
109
116
|
end
|
|
110
117
|
|
|
111
|
-
# Persists `entries` (a Hash of target path => entry Hash) to `store_path
|
|
118
|
+
# Persists `entries` (a Hash of target path => entry Hash) to `store_path`, as of its
|
|
119
|
+
# pipeline's `schema_version`.
|
|
112
120
|
# Writes to a temp file in the same directory and renames into place so a
|
|
113
121
|
# reader never observes a partially-written cache file, even if two
|
|
114
122
|
# Ceedling invocations somehow raced on the same project.
|
|
115
|
-
def persist(store_path, entries)
|
|
123
|
+
def persist(store_path, entries, schema_version: CACHE_SCHEMA_VERSION)
|
|
116
124
|
@file_wrapper.mkdir( @file_wrapper.dirname( store_path ) )
|
|
117
125
|
|
|
118
126
|
payload = {
|
|
119
|
-
'schema_version' =>
|
|
127
|
+
'schema_version' => schema_version,
|
|
120
128
|
'hash_algorithm' => DependencyHasher::HASH_ALGORITHM,
|
|
121
129
|
'entries' => entries
|
|
122
130
|
}
|
|
@@ -129,16 +137,30 @@ class DependencyCacheStore
|
|
|
129
137
|
### Private ###
|
|
130
138
|
private
|
|
131
139
|
|
|
132
|
-
def empty_store
|
|
133
|
-
{ 'schema_version' =>
|
|
140
|
+
def empty_store(schema_version)
|
|
141
|
+
{ 'schema_version' => schema_version, 'hash_algorithm' => DependencyHasher::HASH_ALGORITHM, 'entries' => {}, 'pruned' => [] }
|
|
134
142
|
end
|
|
135
143
|
|
|
136
|
-
def degrade(store_path, reason)
|
|
144
|
+
def degrade(store_path, schema_version, reason)
|
|
137
145
|
@loginator.log(
|
|
138
146
|
"Dependency cache #{store_path} #{reason} -- treating it as absent (full rebuild for tracked targets).",
|
|
139
|
-
Verbosity::COMPLAIN
|
|
147
|
+
Verbosity::COMPLAIN
|
|
140
148
|
)
|
|
141
|
-
empty_store
|
|
149
|
+
empty_store( schema_version )
|
|
150
|
+
end
|
|
151
|
+
|
|
152
|
+
def earlier_layout?(version, schema_version)
|
|
153
|
+
return version.is_a?( Integer ) && version.between?( 1, schema_version - 1 )
|
|
154
|
+
end
|
|
155
|
+
|
|
156
|
+
# An earlier build layout leaves its output where this build no longer looks
|
|
157
|
+
def upgrade(store_path, schema_version)
|
|
158
|
+
@loginator.log(
|
|
159
|
+
"Dependency cache #{store_path} comes from an earlier Ceedling build layout -- rebuilding everything once. " \
|
|
160
|
+
"Run `ceedling clobber` to remove any orphaned build output left in the old layout.",
|
|
161
|
+
Verbosity::COMPLAIN
|
|
162
|
+
)
|
|
163
|
+
empty_store( schema_version )
|
|
142
164
|
end
|
|
143
165
|
|
|
144
166
|
def valid_entry?(entry)
|
|
@@ -30,8 +30,18 @@ class DependencyHasher
|
|
|
30
30
|
HASH_ALGORITHM = 'sha256'.freeze unless const_defined?(:HASH_ALGORITHM, false)
|
|
31
31
|
DIGEST_RE = /\A[0-9a-f]{64}\z/.freeze unless const_defined?(:DIGEST_RE, false)
|
|
32
32
|
|
|
33
|
+
# The coarsest file timestamp a filesystem keeps (FAT's two seconds), so a file modified as
|
|
34
|
+
# the build began never counts as older than it
|
|
35
|
+
TIMESTAMP_TICK_S = 2
|
|
36
|
+
|
|
33
37
|
constructor :file_wrapper
|
|
34
38
|
|
|
39
|
+
def setup
|
|
40
|
+
@digests = {}
|
|
41
|
+
@digests_lock = Mutex.new
|
|
42
|
+
@unchanged_before = Time.now - TIMESTAMP_TICK_S
|
|
43
|
+
end
|
|
44
|
+
|
|
35
45
|
# SHA-256 hex digest of a file's exact on-disk bytes.
|
|
36
46
|
#
|
|
37
47
|
# Read via `read_binary` rather than `read`: Ruby's default text-mode read
|
|
@@ -62,8 +72,22 @@ class DependencyHasher
|
|
|
62
72
|
# reflect the source -- exactly the failure this class exists to prevent.
|
|
63
73
|
# Any normalization narrows the margin between those two outcomes in
|
|
64
74
|
# exchange for skipping some rebuilds; that trade isn't worth it here.
|
|
75
|
+
#
|
|
76
|
+
# A file unchanged since before the build began hashes once a build, keyed by its size and
|
|
77
|
+
# modification time. Many targets share one dependency, as every test executable shares a
|
|
78
|
+
# library it links. A file modified as the build began or since, as anything the build
|
|
79
|
+
# writes is, hashes afresh every time: a timestamp is too coarse to show a rewrite within
|
|
80
|
+
# one tick.
|
|
65
81
|
def hash_of_file(path)
|
|
66
|
-
|
|
82
|
+
status = @file_wrapper.stat( path )
|
|
83
|
+
return digest_of( path ) unless memoizable?( status )
|
|
84
|
+
|
|
85
|
+
key = [path, status.size, status.mtime]
|
|
86
|
+
@digests_lock.synchronize { return @digests[key] if @digests.key?( key ) }
|
|
87
|
+
|
|
88
|
+
digest = digest_of( path )
|
|
89
|
+
@digests_lock.synchronize { @digests[key] = digest }
|
|
90
|
+
return digest
|
|
67
91
|
end
|
|
68
92
|
|
|
69
93
|
# SHA-256 hex digest of a canonicalized `meta` value, or nil for nil/empty
|
|
@@ -91,4 +115,14 @@ class DependencyHasher
|
|
|
91
115
|
end
|
|
92
116
|
end
|
|
93
117
|
|
|
118
|
+
private
|
|
119
|
+
|
|
120
|
+
def digest_of(path)
|
|
121
|
+
return Digest::SHA256.hexdigest( @file_wrapper.read_binary( path ) )
|
|
122
|
+
end
|
|
123
|
+
|
|
124
|
+
def memoizable?(status)
|
|
125
|
+
return !status.nil? && status.mtime < @unchanged_before
|
|
126
|
+
end
|
|
127
|
+
|
|
94
128
|
end
|
|
@@ -8,6 +8,7 @@
|
|
|
8
8
|
require 'time'
|
|
9
9
|
require 'ceedling/constants'
|
|
10
10
|
require 'ceedling/exceptions'
|
|
11
|
+
require 'ceedling/dependencies/dependency_cache_store'
|
|
11
12
|
|
|
12
13
|
# A pure query module for content-hash-based rebuild staleness -- not a build
|
|
13
14
|
# scheduler. Ceedling's existing Rake-based, multithreaded, conditionally-
|
|
@@ -67,6 +68,7 @@ class DependencyTracker
|
|
|
67
68
|
def setup()
|
|
68
69
|
@mutex = Mutex.new
|
|
69
70
|
@store_path = nil
|
|
71
|
+
@schema_version = DependencyCacheStore::CACHE_SCHEMA_VERSION
|
|
70
72
|
@debug_root = nil
|
|
71
73
|
@debug_tier = DEBUG_TIERS[:none]
|
|
72
74
|
@relationships = {}
|
|
@@ -86,14 +88,18 @@ class DependencyTracker
|
|
|
86
88
|
# deleted from disk -- see DependencyCacheStore#load) have their
|
|
87
89
|
# DependencyDebugTree data pruned too, so the debug tree never outlives
|
|
88
90
|
# the cache entries it exists to explain.
|
|
89
|
-
|
|
91
|
+
#
|
|
92
|
+
# `schema_version` is the version the cache's pipeline reads and writes (see
|
|
93
|
+
# CACHE_SCHEMA.md).
|
|
94
|
+
def open(store_path:, schema_version: DependencyCacheStore::CACHE_SCHEMA_VERSION, debug_tier: nil)
|
|
90
95
|
@store_path = store_path
|
|
96
|
+
@schema_version = schema_version
|
|
91
97
|
@debug_root = debug_root_for( store_path )
|
|
92
98
|
@debug_tier = resolve_debug_tier( debug_tier )
|
|
93
99
|
|
|
94
100
|
@mutex.synchronize do
|
|
95
101
|
@relationships = {}
|
|
96
|
-
@cache = @dependency_cache_store.load( @store_path )
|
|
102
|
+
@cache = @dependency_cache_store.load( @store_path, schema_version: @schema_version )
|
|
97
103
|
( @cache['pruned'] || [] ).each { |target| @dependency_debug_tree.prune( @debug_root, target ) }
|
|
98
104
|
end
|
|
99
105
|
end
|
|
@@ -249,7 +255,7 @@ class DependencyTracker
|
|
|
249
255
|
@cache['entries'].dup
|
|
250
256
|
end
|
|
251
257
|
|
|
252
|
-
@dependency_cache_store.persist( @store_path, entries )
|
|
258
|
+
@dependency_cache_store.persist( @store_path, entries, schema_version: @schema_version )
|
|
253
259
|
end
|
|
254
260
|
|
|
255
261
|
# Explains why `target` is (or was last found to be) stale: which of
|
|
@@ -5,6 +5,9 @@
|
|
|
5
5
|
# SPDX-License-Identifier: MIT
|
|
6
6
|
# =========================================================================
|
|
7
7
|
|
|
8
|
+
require 'ceedling/constants'
|
|
9
|
+
require 'ceedling/dependencies/dependency_cache_store'
|
|
10
|
+
|
|
8
11
|
# Ceedling-specific adapter between the build pipeline and the generic,
|
|
9
12
|
# application-agnostic DependencyTracker -- owns the tracker's lifecycle
|
|
10
13
|
# (where its cache file lives, when it's opened and flushed) so pipeline
|
|
@@ -26,12 +29,21 @@ class Dependinator
|
|
|
26
29
|
File.join( PROJECT_BUILD_DEPENDENCIES_CACHE_PATH, ".#{identifier}.#{CACHE_FILENAME}" )
|
|
27
30
|
end
|
|
28
31
|
|
|
32
|
+
# The schema version of a pipeline's cache (see CACHE_SCHEMA.md). A release build places
|
|
33
|
+
# its files apart from any test's own root, so its layout and version change on their own.
|
|
34
|
+
# Every other pipeline is a test build's.
|
|
35
|
+
def self.cache_schema_version(identifier)
|
|
36
|
+
return DependencyCacheStore::RELEASE_CACHE_SCHEMA_VERSION if identifier == RELEASE_SYM
|
|
37
|
+
|
|
38
|
+
return DependencyCacheStore::CACHE_SCHEMA_VERSION
|
|
39
|
+
end
|
|
40
|
+
|
|
29
41
|
# `identifier` isolates one pipeline's cache from another's -- sharing a single
|
|
30
42
|
# cache file between, say, test and release builds would make a full test:all
|
|
31
43
|
# run's pruning flush (see `flush`) silently evict every cached release entry,
|
|
32
44
|
# and vice versa, since pruning drops anything not registered in the current run.
|
|
33
45
|
def open(identifier: :test)
|
|
34
|
-
@dependency_tracker.open( store_path: self.class.cache_store_path( identifier ) )
|
|
46
|
+
@dependency_tracker.open( store_path: self.class.cache_store_path( identifier ), schema_version: self.class.cache_schema_version( identifier ) )
|
|
35
47
|
end
|
|
36
48
|
|
|
37
49
|
def register(target, files: [], meta: {}, outputs: [])
|