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
|
@@ -5,8 +5,10 @@
|
|
|
5
5
|
# SPDX-License-Identifier: MIT
|
|
6
6
|
# =========================================================================
|
|
7
7
|
|
|
8
|
+
require 'set'
|
|
8
9
|
require 'ceedling/constants'
|
|
9
10
|
require 'ceedling/exceptions'
|
|
11
|
+
require 'ceedling/filesystem/file_path_utils'
|
|
10
12
|
require 'ceedling/test_invoker/test_invoker_types'
|
|
11
13
|
require 'ceedling/test_invoker/test_pipeline_helpers'
|
|
12
14
|
|
|
@@ -29,26 +31,68 @@ class TestBuildExecutor
|
|
|
29
31
|
:dependinator,
|
|
30
32
|
:gcc_dependency_parser,
|
|
31
33
|
:quote_include_isolator,
|
|
32
|
-
:
|
|
34
|
+
:test_substitutions,
|
|
35
|
+
:build_step_doctor,
|
|
36
|
+
:library_resolver,
|
|
37
|
+
:mock_locator,
|
|
38
|
+
:test_search_paths
|
|
33
39
|
)
|
|
34
40
|
|
|
41
|
+
# The endings a header copy and its mock take while set aside, which no header search finds
|
|
42
|
+
HELD_COPY_SUFFIX = '.held'
|
|
43
|
+
HELD_MOCK_SUFFIX = '.held_mock'
|
|
44
|
+
|
|
45
|
+
# Before stage 4: sets aside each copy of a header in a test's mock root, and the mock beside
|
|
46
|
+
# it, under names no search finds. Under :treat_inlines :include, CMock and an FFF fake write a
|
|
47
|
+
# copy of a mock's header beside it. Stage 4 preprocesses the test through its mock root before
|
|
48
|
+
# any mock is planned, so a copy would stand in for its header there. CMock's mock includes the
|
|
49
|
+
# header by a text that may reach only the copy, so stage 4 places a stand-in in the mock's
|
|
50
|
+
# place, as on a first build. A copy is a header with its mock beside it, since no build
|
|
51
|
+
# removes a mock. No test's mock root lies below another's, so a root holds its own test's files.
|
|
52
|
+
def stage_hold_header_copies(state)
|
|
53
|
+
run_mock_roots( state ).each do |root|
|
|
54
|
+
each_copy( root ) do |copy|
|
|
55
|
+
mock = mock_beside( copy )
|
|
56
|
+
@file_wrapper.mv( copy, copy + HELD_COPY_SUFFIX )
|
|
57
|
+
@file_wrapper.mv( mock, mock + HELD_MOCK_SUFFIX )
|
|
58
|
+
end
|
|
59
|
+
end
|
|
60
|
+
end
|
|
61
|
+
|
|
62
|
+
# Before stage 9: puts back every mock set aside before stage 4, over the stand-in stage 4
|
|
63
|
+
# placed, and the copies a current mock writes, and removes every other copy. The mock root
|
|
64
|
+
# stays on the test's search path, with or without mocks, so a copy that outlives its mock
|
|
65
|
+
# shadows the header.
|
|
66
|
+
def stage_prune_header_copies(state)
|
|
67
|
+
keep = mock_files( state.mocks_list ) + header_copies( state.mocks_list )
|
|
68
|
+
|
|
69
|
+
run_mock_roots( state ).each do |root|
|
|
70
|
+
restore_held_copies( root, keep )
|
|
71
|
+
each_copy( root ) { |copy| @file_wrapper.rm_f( copy ) unless keep.include?( copy ) }
|
|
72
|
+
end
|
|
73
|
+
end
|
|
74
|
+
|
|
35
75
|
# Stage 9: Preprocess header files to be mocked.
|
|
76
|
+
#
|
|
77
|
+
# A Partial mock is left out. CMock reads its generated interface header itself.
|
|
78
|
+
#
|
|
79
|
+
# Each header is read through its test's Partial directories and header paths, as the compiler
|
|
80
|
+
# finds real headers. The mock root holds CMock's copies of headers, which stage 10 brings up
|
|
81
|
+
# to date only after this stage. The headers a mocked header's full expansion entered are its
|
|
82
|
+
# dependencies.
|
|
36
83
|
def stage_preprocess_mocks(state)
|
|
37
|
-
directives_only
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
84
|
+
directives_only = @configurator.test_build_preprocess_directives_only_available
|
|
85
|
+
extras = (@configurator.cmock_treat_inlines == :include)
|
|
86
|
+
mocks = state.mocks_list.reject { |mock| mock.details.partial }
|
|
87
|
+
preprocess_paths = test_mock_preprocess_paths( mocks )
|
|
88
|
+
skipped = 0
|
|
89
|
+
|
|
90
|
+
# Each remaining mock's target is registered and its staleness settled first. That
|
|
91
|
+
# staleness gates both parallel batches below, and settling it runs no subprocess.
|
|
92
|
+
mocks.each do |mock|
|
|
44
93
|
details = mock.details
|
|
45
94
|
testable = mock.testable
|
|
46
95
|
|
|
47
|
-
# A Partial mock's own generated header is already free of inline function
|
|
48
|
-
# bodies, so it never needs this extra pass regardless of what the project
|
|
49
|
-
# configures for CMock's own mocks of real headers elsewhere.
|
|
50
|
-
extras = !details.partial && (@configurator.cmock_treat_inlines == :include)
|
|
51
|
-
|
|
52
96
|
target = @file_path_utils.form_preprocessed_file_filepath( details.source, testable.name )
|
|
53
97
|
|
|
54
98
|
@dependinator.register(
|
|
@@ -57,13 +101,19 @@ class TestBuildExecutor
|
|
|
57
101
|
meta: {
|
|
58
102
|
flags: testable.preprocess_flags,
|
|
59
103
|
defines: testable.preprocess_defines,
|
|
60
|
-
search_paths: testable.
|
|
104
|
+
search_paths: preprocess_paths[testable.name],
|
|
61
105
|
extras: extras,
|
|
62
|
-
tools: [
|
|
106
|
+
tools: [
|
|
107
|
+
@configurator.tools_test_bare_includes_preprocessor,
|
|
108
|
+
@configurator.tools_test_file_directives_only_preprocessor,
|
|
109
|
+
@configurator.tools_test_file_full_preprocessor
|
|
110
|
+
],
|
|
63
111
|
preprocess_force_fallback: @configurator.test_build_preprocess_force_fallback
|
|
64
112
|
}
|
|
65
113
|
)
|
|
66
114
|
|
|
115
|
+
register_previous_expansion( target, mock )
|
|
116
|
+
|
|
67
117
|
mock.preprocessed_target = target
|
|
68
118
|
mock.stale = @dependinator.stale?( target )
|
|
69
119
|
|
|
@@ -81,7 +131,7 @@ class TestBuildExecutor
|
|
|
81
131
|
log_skip_summary( task: "mock preprocessing", count: skipped, noun: "mocks" )
|
|
82
132
|
|
|
83
133
|
# Generate directive-only preprocessor output if available
|
|
84
|
-
@batchinator.exec(workload: :compile, things:
|
|
134
|
+
@batchinator.exec(workload: :compile, things: mocks) do |mock|
|
|
85
135
|
next unless mock.stale
|
|
86
136
|
|
|
87
137
|
details = mock.details
|
|
@@ -93,29 +143,22 @@ class TestBuildExecutor
|
|
|
93
143
|
filepath: filepath,
|
|
94
144
|
test: name,
|
|
95
145
|
flags: testable.preprocess_flags,
|
|
96
|
-
include_paths:
|
|
146
|
+
include_paths: preprocess_paths[name],
|
|
97
147
|
vendor_paths: vendor_search_paths(),
|
|
98
148
|
defines: testable.preprocess_defines
|
|
99
149
|
}
|
|
100
150
|
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
if _filepath.nil?
|
|
104
|
-
msg = "Failed to generate directive-only preprocessor output (fallback methods will be used) for #{filepath}"
|
|
105
|
-
@loginator.log( msg, Verbosity::COMPLAIN )
|
|
106
|
-
end
|
|
107
|
-
|
|
108
|
-
mock.directives_only_filepath = _filepath
|
|
151
|
+
# Nil when the preprocessor fails. Preprocessinator logs the warning.
|
|
152
|
+
mock.directives_only_filepath = @preprocessinator.generate_directives_only_output( **arg_hash )
|
|
109
153
|
end if directives_only
|
|
110
154
|
|
|
111
155
|
# Preprocess and assemble header files to be mocked
|
|
112
|
-
@batchinator.exec(workload: :compile, things:
|
|
156
|
+
@batchinator.exec(workload: :compile, things: mocks) do |mock|
|
|
113
157
|
next unless mock.stale
|
|
114
158
|
|
|
115
159
|
details = mock.details
|
|
116
160
|
testable = mock.testable
|
|
117
161
|
directives_only_filepath = mock.directives_only_filepath
|
|
118
|
-
extras = !details.partial && (@configurator.cmock_treat_inlines == :include)
|
|
119
162
|
|
|
120
163
|
arg_hash = {
|
|
121
164
|
test: testable.name,
|
|
@@ -123,14 +166,16 @@ class TestBuildExecutor
|
|
|
123
166
|
directives_only_filepath: directives_only_filepath,
|
|
124
167
|
fallback: directives_only_fallback?( directives_only, directives_only_filepath ),
|
|
125
168
|
flags: testable.preprocess_flags,
|
|
126
|
-
include_paths: testable.
|
|
169
|
+
include_paths: preprocess_paths[testable.name],
|
|
127
170
|
vendor_paths: vendor_search_paths(),
|
|
128
171
|
defines: testable.preprocess_defines,
|
|
129
|
-
extras: extras
|
|
172
|
+
extras: extras,
|
|
173
|
+
include_search: @mock_locator.header_search( testable )
|
|
130
174
|
}
|
|
131
175
|
|
|
132
176
|
@preprocessinator.preprocess_mockable_header_file( **arg_hash )
|
|
133
177
|
|
|
178
|
+
register_preprocessed_dependencies( mock.preprocessed_target, full_expansion( mock ) )
|
|
134
179
|
@dependinator.mark_fresh( mock.preprocessed_target )
|
|
135
180
|
end
|
|
136
181
|
end
|
|
@@ -140,17 +185,22 @@ class TestBuildExecutor
|
|
|
140
185
|
# get_cmock_config, not project_config_hash[:cmock]: project_config_hash is
|
|
141
186
|
# flattened -- CMock's own settings live there as individual top-level keys
|
|
142
187
|
# like :cmock_mock_prefix, not as a :cmock section -- so this is the only
|
|
143
|
-
# place that still holds CMock's configuration as a single value to compare.
|
|
144
|
-
|
|
188
|
+
# place that still holds CMock's configuration as a single value to compare. Verbosity
|
|
189
|
+
# changes only what CMock prints, and Generator sets it anew for each mock. The class
|
|
190
|
+
# that writes the mock is recorded too, since a plugin such as FFF can take CMock's place.
|
|
191
|
+
cmock_meta = @configurator.get_cmock_config.except( :verbosity )
|
|
192
|
+
generator = @generator.mock_generator_name
|
|
193
|
+
produced = mock_files( state.mocks_list )
|
|
145
194
|
skipped = 0
|
|
146
195
|
|
|
147
196
|
@batchinator.exec(workload: :compile, things: state.mocks_list) do |mock|
|
|
148
197
|
details = mock.details
|
|
149
198
|
testable = mock.testable
|
|
150
199
|
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
200
|
+
placement = @mock_locator.placement( mocks_root: testable.paths[:mocks], subdir: details.path, include_path: details.include_path )
|
|
201
|
+
output_path = placement.directory
|
|
202
|
+
# The compiler reaches a climbing folder's mock only through CMock's root
|
|
203
|
+
@mock_locator.search_directories( placement ).each { |dir| @file_wrapper.mkdir( dir ) }
|
|
154
204
|
|
|
155
205
|
# `details.input` -- not the stage 9 preprocessed target -- is the
|
|
156
206
|
# correct antecedent here: it's exactly what CMock reads, whether or not
|
|
@@ -159,16 +209,24 @@ class TestBuildExecutor
|
|
|
159
209
|
# `details.name` (a String), not `mock.name` (the Symbol key T2 carried
|
|
160
210
|
# the same value in for hash lookups) -- needed here as a real filename.
|
|
161
211
|
target = File.join( output_path, details.name + EXTENSION_CORE_SOURCE )
|
|
162
|
-
mock_header = File.join( output_path, details.name +
|
|
212
|
+
mock_header = File.join( output_path, details.name + mock_header_extension( details ) )
|
|
163
213
|
|
|
164
214
|
# CMock writes `mock_header` in the same call as `target`, so the mock vouches for
|
|
165
215
|
# it as an output. Stage 4 places a stand-in at this exact path when no file is
|
|
166
216
|
# there or an earlier stand-in is out of date (StandinHeaderinator), independent of
|
|
167
217
|
# this mock's antecedents. The recorded hash catches a stand-in in the mock's place
|
|
168
218
|
# and regenerates the mock.
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
219
|
+
#
|
|
220
|
+
# CMock names the mock by its folder, which an #include can change while the mock's
|
|
221
|
+
# place stays. A mock with no folder records nil, since a record holding no folder
|
|
222
|
+
# can't tell it from one named by a folder the record never held. A respelling of the
|
|
223
|
+
# real header's #include (MockLocator#header_respelling) follows the test's search
|
|
224
|
+
# paths, which CMock's configuration doesn't hold. Both are recorded too.
|
|
225
|
+
meta = { cmock: cmock_meta, generator: generator, folder: placement.folder }
|
|
226
|
+
meta[:header_include] = details.header_include if details.header_include
|
|
227
|
+
@dependinator.register( target, files: [details.input], meta: meta, outputs: [mock_header] )
|
|
228
|
+
|
|
229
|
+
unless @dependinator.stale?( target ) or missing_header_copy?( details, output_path, produced )
|
|
172
230
|
msg = @reportinator.generate_module_progress(
|
|
173
231
|
operation: 'Skipping mock generation for',
|
|
174
232
|
module_name: testable.name,
|
|
@@ -182,8 +240,9 @@ class TestBuildExecutor
|
|
|
182
240
|
# A Partial mock's own generated header is already free of inline function
|
|
183
241
|
# bodies -- CMock's own inline handling has nothing to do on it and is
|
|
184
242
|
# skipped for this one mock, independent of whatever the project configures
|
|
185
|
-
# for CMock's own mocks of real headers elsewhere in the same test suite.
|
|
186
|
-
|
|
243
|
+
# for CMock's own mocks of real headers elsewhere in the same test suite. The helpers a
|
|
244
|
+
# mock-only Partial keeps sit in its extras header, whose #include CMock skips.
|
|
245
|
+
overrides = details.partial ? { treat_inlines: :exclude } : header_include_overrides( details.header_include )
|
|
187
246
|
|
|
188
247
|
arg_hash = {
|
|
189
248
|
context: state.context,
|
|
@@ -191,10 +250,12 @@ class TestBuildExecutor
|
|
|
191
250
|
test: testable.name,
|
|
192
251
|
input_filepath: details.input,
|
|
193
252
|
output_path: output_path,
|
|
194
|
-
|
|
253
|
+
mock_root: placement.root,
|
|
254
|
+
folder: placement.folder,
|
|
195
255
|
overrides: overrides
|
|
196
256
|
}
|
|
197
257
|
|
|
258
|
+
discard_header_copy( details, output_path, produced ) unless details.partial
|
|
198
259
|
@generator.generate_mock( **arg_hash )
|
|
199
260
|
|
|
200
261
|
@dependinator.mark_fresh( target )
|
|
@@ -226,7 +287,7 @@ class TestBuildExecutor
|
|
|
226
287
|
# `compile_pass.call( test_file_pairs )` fully drains (Parallel.map blocks until
|
|
227
288
|
# every thread in that call is done) before `compile_pass.call( other_pairs )`
|
|
228
289
|
# even starts. That's what makes apply_sibling_isolation's unguarded writes to
|
|
229
|
-
# testable.search_paths/
|
|
290
|
+
# testable.search_paths/header_isolation safe: the only thread that ever
|
|
230
291
|
# writes them is the one compiling that test's own file, in the first batch, and
|
|
231
292
|
# every thread reading them afterward starts only once that write has already
|
|
232
293
|
# happened. Merging or reordering these two calls -- e.g. to parallelize them
|
|
@@ -260,25 +321,32 @@ class TestBuildExecutor
|
|
|
260
321
|
end
|
|
261
322
|
end
|
|
262
323
|
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
# dependency in its own right (see isolate_sibling_headers) -- nothing past
|
|
269
|
-
# this point still needs it to exist.
|
|
270
|
-
state.testables.each_value do |testable|
|
|
271
|
-
next if testable.isolated_headers_path.nil?
|
|
272
|
-
@quote_include_isolator.release( testable.isolated_headers_path )
|
|
324
|
+
begin
|
|
325
|
+
compile_pass.call( test_file_pairs )
|
|
326
|
+
compile_pass.call( other_pairs )
|
|
327
|
+
ensure
|
|
328
|
+
release_header_isolations( state )
|
|
273
329
|
end
|
|
274
330
|
|
|
275
331
|
log_skip_summary( task: "compilation", count: skipped, noun: "objects" )
|
|
276
332
|
end
|
|
277
333
|
|
|
334
|
+
# Any isolated sibling-header copy staged for a testable during either compile batch
|
|
335
|
+
# was scoped to this one build and is never a tracked dependency in its own right (see
|
|
336
|
+
# isolate_sibling_headers). Nothing past the compile stage still needs it, whether the
|
|
337
|
+
# stage finished or failed.
|
|
338
|
+
def release_header_isolations(state)
|
|
339
|
+
state.testables.each_value do |testable|
|
|
340
|
+
next if testable.header_isolation.nil?
|
|
341
|
+
@quote_include_isolator.release( testable.header_isolation.dir )
|
|
342
|
+
end
|
|
343
|
+
end
|
|
344
|
+
|
|
278
345
|
# Stage 16: Link test executables.
|
|
279
346
|
def stage_build_executables(state)
|
|
280
347
|
lib_args = convert_libraries_to_arguments()
|
|
281
|
-
lib_paths =
|
|
348
|
+
lib_paths = @library_resolver.search_path_arguments()
|
|
349
|
+
libraries = @library_resolver.link_files( test_library_entries() )
|
|
282
350
|
skipped = 0
|
|
283
351
|
|
|
284
352
|
@batchinator.exec(workload: :compile, things: state.testables) do |_, testable|
|
|
@@ -287,10 +355,14 @@ class TestBuildExecutor
|
|
|
287
355
|
link_flags = testable.link_flags
|
|
288
356
|
tool, link_flags = resolve_link_tool( context: state.context, tool: @configurator.tools_test_linker, flags: link_flags, executable: testable.executable )
|
|
289
357
|
|
|
358
|
+
# Staleness checks only the files registered here, so an object or library dropped from
|
|
359
|
+
# the link (a source deleted, excluded, or moved out of the configured paths) changes
|
|
360
|
+
# nothing they see. The object and library lists as meta do change.
|
|
361
|
+
objects = testable.objects.to_a
|
|
290
362
|
@dependinator.register(
|
|
291
363
|
testable.executable,
|
|
292
|
-
files:
|
|
293
|
-
meta: { flags: link_flags, lib_args: lib_args, lib_paths: lib_paths, tools: [tool] }
|
|
364
|
+
files: objects + libraries,
|
|
365
|
+
meta: { flags: link_flags, lib_args: lib_args, lib_paths: lib_paths, tools: [tool], objects: objects, libraries: libraries }
|
|
294
366
|
)
|
|
295
367
|
stale = @dependinator.stale?( testable.executable )
|
|
296
368
|
|
|
@@ -303,7 +375,8 @@ class TestBuildExecutor
|
|
|
303
375
|
flags: link_flags,
|
|
304
376
|
lib_args: lib_args,
|
|
305
377
|
lib_paths: lib_paths,
|
|
306
|
-
tool: tool
|
|
378
|
+
tool: tool,
|
|
379
|
+
testable: testable
|
|
307
380
|
}
|
|
308
381
|
|
|
309
382
|
generate_executable( **arg_hash )
|
|
@@ -380,11 +453,9 @@ class TestBuildExecutor
|
|
|
380
453
|
|
|
381
454
|
@batchinator.exec(workload: :test, things: state.testables) do |_, testable|
|
|
382
455
|
begin
|
|
383
|
-
# `paths[:results]` is
|
|
384
|
-
#
|
|
385
|
-
#
|
|
386
|
-
# must be test-specific too, matching clean_test_results' own `test + '.*'`
|
|
387
|
-
# naming below.
|
|
456
|
+
# `paths[:results]` is the directory of the test's name, which every test beside
|
|
457
|
+
# it shares, so the marker's own filename must be test-specific too, matching
|
|
458
|
+
# clean_test_results' own `test + '.*'` naming below.
|
|
388
459
|
fixture_target = File.join( testable.paths[:results], "#{File.basename( testable.name )}.fixture_run" )
|
|
389
460
|
|
|
390
461
|
fixture_tool = resolve_fixture_tool( context: state.context, tool: @configurator.tools_test_fixture, test_name: testable.name, target: fixture_target )
|
|
@@ -483,8 +554,11 @@ class TestBuildExecutor
|
|
|
483
554
|
}
|
|
484
555
|
end
|
|
485
556
|
|
|
486
|
-
|
|
487
|
-
|
|
557
|
+
# A failed link goes to the build step doctor before it is raised
|
|
558
|
+
def generate_executable(context:, build_path:, executable:, objects:, flags:, lib_args:, lib_paths:, tool:, testable:)
|
|
559
|
+
inputs = { tool: tool, objects: objects, executable: executable, flags: flags, lib_args: lib_args, lib_paths: lib_paths, testable: testable }
|
|
560
|
+
|
|
561
|
+
@build_step_doctor.attend( step: :link, inputs: inputs ) do
|
|
488
562
|
@generator.generate_executable_file(
|
|
489
563
|
tool,
|
|
490
564
|
context,
|
|
@@ -495,37 +569,6 @@ class TestBuildExecutor
|
|
|
495
569
|
lib_args,
|
|
496
570
|
lib_paths
|
|
497
571
|
)
|
|
498
|
-
rescue ShellException => ex
|
|
499
|
-
if ex.shell_result[:output].match?(/symbol/i)
|
|
500
|
-
notice = "If the linker reports missing symbols, the following may be to blame:\n" +
|
|
501
|
-
" 1. This test lacks #include statements corresponding to needed source files (see note below).\n" +
|
|
502
|
-
" 2. Project file paths omit source files corresponding to #include statements in this test.\n" +
|
|
503
|
-
" 3. Complex macros, #ifdefs, etc. have obscured correct #include statements in this test.\n" +
|
|
504
|
-
" 4. Your project is attempting to mix C++ and C file extensions (not supported).\n"
|
|
505
|
-
if @configurator.project_use_mocks
|
|
506
|
-
notice += " 5. This test does not #include needed mocks (that triggers their generation).\n"
|
|
507
|
-
end
|
|
508
|
-
|
|
509
|
-
notice += "\n"
|
|
510
|
-
notice += "NOTE: A test file directs the build of a test executable with #include statements:\n" +
|
|
511
|
-
" * By convention, Ceedling assumes header filenames correspond to source filenames.\n" +
|
|
512
|
-
" * Which code files to compile and link are determined by #include statements.\n"
|
|
513
|
-
if @configurator.project_use_mocks
|
|
514
|
-
notice += " * An #include statement convention directs the generation of mocks from header files.\n"
|
|
515
|
-
end
|
|
516
|
-
|
|
517
|
-
notice += "\n"
|
|
518
|
-
notice += "OPTIONS:\n" +
|
|
519
|
-
" 1. Doublecheck this test's #include statements.\n" +
|
|
520
|
-
" 2. Simplify complex macros or fully specify symbols for this test in :project ↳ :defines.\n" +
|
|
521
|
-
" 3. If no header file corresponds to the needed source file, use the TEST_SOURCE_FILE()\n" +
|
|
522
|
-
" build directive macro in this test to inject a source file into the build.\n\n" +
|
|
523
|
-
"See the docs on conventions, paths, preprocessing, compilation symbols, and build directive macros.\n\n"
|
|
524
|
-
|
|
525
|
-
@loginator.log( notice, Verbosity::COMPLAIN, LogLabels::NOTICE )
|
|
526
|
-
end
|
|
527
|
-
|
|
528
|
-
raise ex
|
|
529
572
|
end
|
|
530
573
|
end
|
|
531
574
|
|
|
@@ -546,41 +589,146 @@ class TestBuildExecutor
|
|
|
546
589
|
end
|
|
547
590
|
|
|
548
591
|
def convert_libraries_to_arguments()
|
|
549
|
-
args = (
|
|
592
|
+
args = test_library_entries()
|
|
550
593
|
if (defined? LIBRARIES_FLAG)
|
|
551
594
|
args.map! { |v| LIBRARIES_FLAG.gsub( /\$\{1\}/, v ) }
|
|
552
595
|
end
|
|
553
596
|
return args
|
|
554
597
|
end
|
|
555
598
|
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
599
|
+
private
|
|
600
|
+
|
|
601
|
+
# The :libraries entries a test links, whatever form each takes
|
|
602
|
+
def test_library_entries()
|
|
603
|
+
return ((@configurator.project_config_hash[:libraries_test] || []) + ((defined? LIBRARIES_SYSTEM) ? LIBRARIES_SYSTEM : [])).flatten
|
|
604
|
+
end
|
|
605
|
+
|
|
606
|
+
# Each test's mock preprocess paths by its name, composed once for all its mocks
|
|
607
|
+
def test_mock_preprocess_paths(mocks)
|
|
608
|
+
paths = {}
|
|
609
|
+
mocks.each { |mock| paths[mock.testable.name] ||= @test_search_paths.mock_preprocess_paths( mock.testable ) }
|
|
561
610
|
return paths
|
|
562
611
|
end
|
|
563
612
|
|
|
564
|
-
|
|
613
|
+
# Where stage 9 writes a mocked header's full expansion. Its line markers name each file it entered.
|
|
614
|
+
def full_expansion(mock)
|
|
615
|
+
return @file_path_utils.form_preprocessed_file_full_expansion_filepath( mock.details.source, mock.testable.name )
|
|
616
|
+
end
|
|
565
617
|
|
|
566
|
-
#
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
#
|
|
573
|
-
#
|
|
574
|
-
#
|
|
575
|
-
def
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
return
|
|
618
|
+
# Registers the headers the previous run's expansion entered, so an edit to one makes the target stale
|
|
619
|
+
def register_previous_expansion(target, mock)
|
|
620
|
+
expansion = full_expansion( mock )
|
|
621
|
+
register_preprocessed_dependencies( target, expansion ) if @file_wrapper.exist?( expansion )
|
|
622
|
+
end
|
|
623
|
+
|
|
624
|
+
# Where CMock under :treat_inlines :include, or an FFF fake, writes a copy of the header it
|
|
625
|
+
# reads: beside the mock, named as that header. Nil where a mock's own file is at that path
|
|
626
|
+
# (`produced`), as when a real header is named like another mock, or the input itself is.
|
|
627
|
+
def header_copy(details, output_path, produced)
|
|
628
|
+
copy = File.join( output_path, File.basename( details.input ) )
|
|
629
|
+
return (produced.include?( copy ) or copy == details.input) ? nil : copy
|
|
630
|
+
end
|
|
631
|
+
|
|
632
|
+
# Whether a mock under :treat_inlines :include is missing its copy. The mock would then include
|
|
633
|
+
# the header itself, inline function bodies and all.
|
|
634
|
+
def missing_header_copy?(details, output_path, produced)
|
|
635
|
+
return false if details.partial or @configurator.cmock_treat_inlines != :include
|
|
636
|
+
|
|
637
|
+
copy = header_copy( details, output_path, produced )
|
|
638
|
+
return (!copy.nil? and !@file_wrapper.exist?( copy ))
|
|
639
|
+
end
|
|
640
|
+
|
|
641
|
+
# A generation without :include writes no copy, and an earlier one would stay for the mock's
|
|
642
|
+
# #include to reach. One under :include writes a current copy in the same call that needs it.
|
|
643
|
+
def discard_header_copy(details, output_path, produced)
|
|
644
|
+
copy = header_copy( details, output_path, produced )
|
|
645
|
+
@file_wrapper.rm_f( copy ) if copy and @file_wrapper.exist?( copy )
|
|
646
|
+
end
|
|
647
|
+
|
|
648
|
+
# Every mock's source and header, where stage 10 writes them
|
|
649
|
+
def mock_files(mocks)
|
|
650
|
+
return mocks.each_with_object( Set.new ) do |mock, files|
|
|
651
|
+
directory = mock_directory( mock )
|
|
652
|
+
[EXTENSION_CORE_SOURCE, mock_header_extension( mock.details )].each { |ext| files << File.join( directory, mock.details.name + ext ) }
|
|
653
|
+
end
|
|
654
|
+
end
|
|
655
|
+
|
|
656
|
+
# The extension of a mock's header, the one its #include names, as CMock names the mock by
|
|
657
|
+
# its header's own extension
|
|
658
|
+
def mock_header_extension(details)
|
|
659
|
+
ext = File.extname( details.include_path.to_s )
|
|
660
|
+
return ext.empty? ? EXTENSION_CORE_HEADER : ext
|
|
661
|
+
end
|
|
662
|
+
|
|
663
|
+
# Where each non-Partial mock's copy of its header goes under :treat_inlines :include
|
|
664
|
+
def header_copies(mocks)
|
|
665
|
+
return mocks.each_with_object( Set.new ) do |mock, copies|
|
|
666
|
+
copies << File.join( mock_directory( mock ), File.basename( mock.details.input ) ) unless mock.details.partial
|
|
667
|
+
end
|
|
668
|
+
end
|
|
669
|
+
|
|
670
|
+
def mock_directory(mock)
|
|
671
|
+
details = mock.details
|
|
672
|
+
return @mock_locator.placement( mocks_root: mock.testable.paths[:mocks], subdir: details.path, include_path: details.include_path ).directory
|
|
673
|
+
end
|
|
674
|
+
|
|
675
|
+
# Yields each copy below `root`, a header with its mock beside it
|
|
676
|
+
def each_copy(root)
|
|
677
|
+
headers = root_headers( root )
|
|
678
|
+
listed = headers.to_set
|
|
679
|
+
headers.each do |path|
|
|
680
|
+
yield( path ) if listed.include?( mock_beside( path ) )
|
|
681
|
+
end
|
|
682
|
+
end
|
|
683
|
+
|
|
684
|
+
# Puts each mock set aside below `root` back, and each copy where `keep` names it, removing
|
|
685
|
+
# the other copies
|
|
686
|
+
def restore_held_copies(root, keep)
|
|
687
|
+
each_held( root, HELD_MOCK_SUFFIX ) { |held, mock| @file_wrapper.mv( held, mock ) }
|
|
688
|
+
each_held( root, HELD_COPY_SUFFIX ) do |held, copy|
|
|
689
|
+
keep.include?( copy ) ? @file_wrapper.mv( held, copy ) : @file_wrapper.rm_f( held )
|
|
690
|
+
end
|
|
691
|
+
end
|
|
692
|
+
|
|
693
|
+
# Yields each file set aside below `root` with `suffix`, and its own path
|
|
694
|
+
def each_held(root, suffix)
|
|
695
|
+
@file_wrapper.directory_listing( FilePathUtils.glob( root, '**', "*#{suffix}" ) ).each do |path|
|
|
696
|
+
yield( path, path.delete_suffix( suffix ) )
|
|
697
|
+
end
|
|
698
|
+
end
|
|
699
|
+
|
|
700
|
+
# The header of the mock CMock writes beside a copy of the header at `path`, with the header's
|
|
701
|
+
# own extension. A header named as its own mock, with no prefix or suffix, has none.
|
|
702
|
+
def mock_beside(path)
|
|
703
|
+
ext = File.extname( path )
|
|
704
|
+
mock = File.join( File.dirname( path ), @configurator.cmock_mock_prefix + File.basename( path, ext ) + @configurator.cmock_mock_suffix + ext )
|
|
705
|
+
return mock == path ? nil : mock
|
|
706
|
+
end
|
|
707
|
+
|
|
708
|
+
# The mock root of each test this run builds
|
|
709
|
+
def run_mock_roots(state)
|
|
710
|
+
return state.testables.each_value.filter_map { |testable| testable.paths[:mocks] }.uniq
|
|
711
|
+
end
|
|
712
|
+
|
|
713
|
+
# Every header below a mock root
|
|
714
|
+
def root_headers(root)
|
|
715
|
+
return @configurator.extension_header.flat_map do |ext|
|
|
716
|
+
@file_wrapper.directory_listing( FilePathUtils.glob( root, '**', "*#{ext}" ) )
|
|
717
|
+
end
|
|
718
|
+
end
|
|
719
|
+
|
|
720
|
+
# The settings that have a mock include its real header by `header_include` in place of
|
|
721
|
+
# CMock's own text. `:orig_header_include` is Ceedling's, which CMock ignores and an FFF
|
|
722
|
+
# fake reads. CMock keeps its own text under an :orig_header_include_fmt that takes no
|
|
723
|
+
# respelling. It keeps it under :treat_inlines :include too, where its text reaches the copy
|
|
724
|
+
# of the header it writes beside the mock. A fake writes no format.
|
|
725
|
+
def header_include_overrides(header_include)
|
|
726
|
+
return {} if header_include.nil?
|
|
727
|
+
|
|
728
|
+
overrides = { orig_header_include: header_include }
|
|
729
|
+
return overrides if @configurator.cmock_treat_inlines == :include or !@mock_locator.respellable_format?
|
|
730
|
+
|
|
731
|
+
return overrides.merge( orig_header_include_fmt: @mock_locator.header_include_line( header_include ) )
|
|
584
732
|
end
|
|
585
733
|
|
|
586
734
|
# Compile a single C or assembly source file into an object file. Returns
|
|
@@ -589,10 +737,9 @@ class TestBuildExecutor
|
|
|
589
737
|
#
|
|
590
738
|
# A test file's own C compile (only) gets one extra check: isolate_sibling_headers
|
|
591
739
|
# inspects its freshly-written .d file for a real header sharing a directory with
|
|
592
|
-
# one this test mocks
|
|
593
|
-
# it finds one. A failure
|
|
594
|
-
#
|
|
595
|
-
# before it's raised, in case it's explainable as this same class of collision.
|
|
740
|
+
# one this test mocks under inline handling, and retries with corrected search paths if
|
|
741
|
+
# it finds one. A failure still standing afterward, with nothing to isolate or a
|
|
742
|
+
# retry that failed too, goes to the build step doctor before it is raised.
|
|
596
743
|
#
|
|
597
744
|
# Any other source sharing a directory with a header mocked under inline shadowing
|
|
598
745
|
# compiles from an isolated copy instead (compile_isolated_source).
|
|
@@ -608,7 +755,7 @@ class TestBuildExecutor
|
|
|
608
755
|
context: context, operation: OPERATION_COMPILE_SYM, tool: @configurator.tools_test_compiler,
|
|
609
756
|
flags: flags, defines: defines, module_name: test, source: source, object: object
|
|
610
757
|
)
|
|
611
|
-
stale = register_and_check_object_staleness( object: object, source: source, dependencies: dependencies, flags: flags, defines: defines, search_paths: search_paths, tool: tool )
|
|
758
|
+
stale = register_and_check_object_staleness( object: object, source: source, dependencies: dependencies, flags: flags, defines: defines, search_paths: search_paths, tool: tool, isolation: testable.header_isolation )
|
|
612
759
|
|
|
613
760
|
unless stale
|
|
614
761
|
# A skipped compile still needs this test's search paths corrected the same
|
|
@@ -666,41 +813,21 @@ class TestBuildExecutor
|
|
|
666
813
|
# the shell-out exits (a raw miss here silently drops this compile's discovered
|
|
667
814
|
# header dependencies -- self-correcting into one extra recompile next run, but
|
|
668
815
|
# worth riding out directly).
|
|
669
|
-
|
|
816
|
+
if @file_wrapper.exist_with_retry?( dependencies )
|
|
817
|
+
restore_isolated_dependencies( testable, dependencies )
|
|
818
|
+
@dependinator.register_gcc_deps_file( dependencies )
|
|
819
|
+
end
|
|
670
820
|
|
|
671
821
|
# Only the test file's own compile is ever checked here directly -- every other
|
|
672
822
|
# object in the same test's build already sees whatever search paths that check
|
|
673
823
|
# settled on (see stage_build_objects's own two-pass split).
|
|
674
824
|
if source == testable.filepath && @file_wrapper.exist_with_retry?( dependencies )
|
|
675
825
|
isolation = apply_sibling_isolation( testable: testable, dependencies_filepath: dependencies )
|
|
676
|
-
|
|
677
|
-
if isolation
|
|
678
|
-
# A throwaway retry: its own .d file is never registered, so the attempt
|
|
679
|
-
# registered just above -- real headers, real paths -- remains the lasting
|
|
680
|
-
# record of this object's antecedents. The isolated copy is always freshly,
|
|
681
|
-
# fully derived from those same tracked files, so it can never itself go
|
|
682
|
-
# stale independently and needs no tracking of its own.
|
|
683
|
-
retry_arg_hash = arg_hash.merge(
|
|
684
|
-
search_paths: tailor_search_paths( search_paths: isolation[:search_paths], filepath: source ),
|
|
685
|
-
dependencies: dependencies + '.isolated_retry'
|
|
686
|
-
)
|
|
687
|
-
|
|
688
|
-
begin
|
|
689
|
-
@generator.generate_object_file_c( **retry_arg_hash )
|
|
690
|
-
compile_failure = nil
|
|
691
|
-
rescue ShellException => ex
|
|
692
|
-
compile_failure = ex
|
|
693
|
-
end
|
|
694
|
-
end
|
|
826
|
+
compile_failure = compile_isolated_retry( arg_hash: arg_hash, isolation: isolation ) if isolation
|
|
695
827
|
end
|
|
696
828
|
|
|
697
829
|
if compile_failure
|
|
698
|
-
|
|
699
|
-
output: compile_failure.shell_result[:output],
|
|
700
|
-
mocked_headers: mocked_and_partialized_headers( testable )
|
|
701
|
-
)
|
|
702
|
-
@loginator.log( notice, Verbosity::ERRORS, LogLabels::NOTICE ) if notice
|
|
703
|
-
|
|
830
|
+
diagnose_compile_failure( compile_failure, arg_hash: arg_hash, testable: testable )
|
|
704
831
|
raise compile_failure
|
|
705
832
|
end
|
|
706
833
|
|
|
@@ -710,7 +837,7 @@ class TestBuildExecutor
|
|
|
710
837
|
context: context, operation: OPERATION_ASSEMBLE_SYM, tool: @configurator.tools_test_assembler,
|
|
711
838
|
flags: flags, defines: defines, module_name: test, source: source, object: object
|
|
712
839
|
)
|
|
713
|
-
stale = register_and_check_object_staleness( object: object, source: source, dependencies: dependencies, flags: flags, defines: defines, search_paths: search_paths, tool: tool )
|
|
840
|
+
stale = register_and_check_object_staleness( object: object, source: source, dependencies: dependencies, flags: flags, defines: defines, search_paths: search_paths, tool: tool, isolation: testable.header_isolation )
|
|
714
841
|
|
|
715
842
|
return log_compile_skip( test: test, source: source ) unless stale
|
|
716
843
|
|
|
@@ -770,6 +897,31 @@ class TestBuildExecutor
|
|
|
770
897
|
return nil
|
|
771
898
|
end
|
|
772
899
|
|
|
900
|
+
# A throwaway retry with the isolation's search paths. Its .d file is never
|
|
901
|
+
# registered, so the first attempt's, with real headers and real paths, stays the
|
|
902
|
+
# lasting record of this object's antecedents. The isolated copy is always freshly
|
|
903
|
+
# derived from those same tracked files, so it never goes stale on its own. Returns
|
|
904
|
+
# the retry's failure, or nil when it compiles.
|
|
905
|
+
def compile_isolated_retry(arg_hash:, isolation:)
|
|
906
|
+
retry_arg_hash = arg_hash.merge(
|
|
907
|
+
search_paths: tailor_search_paths( search_paths: isolation[:search_paths], filepath: arg_hash[:source] ),
|
|
908
|
+
dependencies: arg_hash[:dependencies] + '.isolated_retry'
|
|
909
|
+
)
|
|
910
|
+
|
|
911
|
+
@generator.generate_object_file_c( **retry_arg_hash )
|
|
912
|
+
return nil
|
|
913
|
+
rescue ShellException => ex
|
|
914
|
+
return ex
|
|
915
|
+
end
|
|
916
|
+
|
|
917
|
+
# The doctor sees the first attempt's .d file, whose paths are the real headers,
|
|
918
|
+
# whichever attempt produced the failure
|
|
919
|
+
def diagnose_compile_failure(failure, arg_hash:, testable:)
|
|
920
|
+
inputs = arg_hash.slice( :tool, :source, :object, :search_paths, :flags, :defines, :dependencies )
|
|
921
|
+
|
|
922
|
+
@build_step_doctor.diagnose( step: :compile, output: failure.shell_result[:output], inputs: inputs.merge( testable: testable ) )
|
|
923
|
+
end
|
|
924
|
+
|
|
773
925
|
# Compiles a source from a copy staged alone, returning any compile failure.
|
|
774
926
|
#
|
|
775
927
|
# With no real header beside the copy, its quoted #include of `header` reaches CMock's
|
|
@@ -854,7 +1006,7 @@ class TestBuildExecutor
|
|
|
854
1006
|
# skipped one share, so search_paths reads the same way regardless of which one
|
|
855
1007
|
# happened this run. Returns whatever isolate_sibling_headers itself returned.
|
|
856
1008
|
# BARRIER INVARIANT (see also stage_build_objects's own note): the writes below to
|
|
857
|
-
# testable.search_paths/
|
|
1009
|
+
# testable.search_paths/header_isolation are completely unguarded -- no mutex --
|
|
858
1010
|
# which is only safe because this method is only ever called while compiling a
|
|
859
1011
|
# test's own file, and stage_build_objects's two-pass split guarantees every other
|
|
860
1012
|
# object belonging to that same test compiles in a later, separate batch that starts
|
|
@@ -866,8 +1018,8 @@ class TestBuildExecutor
|
|
|
866
1018
|
isolation = isolate_sibling_headers( testable: testable, dependencies_filepath: dependencies_filepath )
|
|
867
1019
|
return nil if isolation.nil?
|
|
868
1020
|
|
|
869
|
-
testable.search_paths
|
|
870
|
-
testable.
|
|
1021
|
+
testable.search_paths = isolation[:search_paths]
|
|
1022
|
+
testable.header_isolation = isolation[:isolation]
|
|
871
1023
|
|
|
872
1024
|
isolation
|
|
873
1025
|
end
|
|
@@ -880,33 +1032,36 @@ class TestBuildExecutor
|
|
|
880
1032
|
# it, mocked/Partialized or not, which is enough to know where that risk exists
|
|
881
1033
|
# even though it says nothing about whether any given occurrence actually won.
|
|
882
1034
|
#
|
|
883
|
-
#
|
|
884
|
-
#
|
|
885
|
-
#
|
|
886
|
-
#
|
|
887
|
-
#
|
|
888
|
-
#
|
|
889
|
-
#
|
|
890
|
-
#
|
|
1035
|
+
# Isolation can only redirect a quoted #include to a file of the same name earlier on the
|
|
1036
|
+
# search path. CMock writes one for each header it mocks under `:treat_inlines: :include`,
|
|
1037
|
+
# and nothing else does, so only those headers are considered (see
|
|
1038
|
+
# TestSubstitutions#shadowed_headers).
|
|
1039
|
+
#
|
|
1040
|
+
# For each such header, any other file sharing its real directory in that dependency
|
|
1041
|
+
# list, that itself actually #includes the real header by name, is staged, alone, into
|
|
1042
|
+
# an isolated directory -- with nothing else there for its own #include of the real
|
|
1043
|
+
# header to find, that #include is forced through the search paths that list CMock's
|
|
1044
|
+
# copy first. Actually #including the real header is the deciding signal, not mere
|
|
1045
|
+
# co-residency: most real projects keep every header in one shared directory as a
|
|
1046
|
+
# matter of ordinary convention, so "shares a directory" alone would flag nearly every
|
|
891
1047
|
# file in the project. Only one level deep: a directory elsewhere in the same
|
|
892
|
-
# dependency list that shares no header with any of
|
|
893
|
-
#
|
|
894
|
-
#
|
|
895
|
-
#
|
|
1048
|
+
# dependency list that shares no header with any of those mocks is shaped the same way,
|
|
1049
|
+
# but nothing designates which of its occupants should win, so nothing there is acted
|
|
1050
|
+
# on. Should the compilation fail with a collision there, the build step doctor's
|
|
1051
|
+
# shared-directory diagnosis explains it.
|
|
896
1052
|
#
|
|
897
|
-
# Returns nil when nothing needs isolating; otherwise a hash of the search
|
|
898
|
-
#
|
|
899
|
-
#
|
|
1053
|
+
# Returns nil when nothing needs isolating; otherwise a hash of the search paths to
|
|
1054
|
+
# compile with (isolation directory listed first) and the isolation itself, for the
|
|
1055
|
+
# caller to track and eventually clean up.
|
|
900
1056
|
def isolate_sibling_headers(testable:, dependencies_filepath:)
|
|
901
|
-
mocked_headers =
|
|
1057
|
+
mocked_headers = @test_substitutions.shadowed_headers( testable )
|
|
902
1058
|
return nil if mocked_headers.empty?
|
|
903
1059
|
|
|
904
1060
|
parsed = @gcc_dependency_parser.parse( @file_wrapper.read( dependencies_filepath ) )
|
|
905
1061
|
dependencies = parsed.values.flatten.uniq
|
|
906
1062
|
by_directory = dependencies.group_by { |dep| File.dirname( dep ) }
|
|
907
1063
|
|
|
908
|
-
isolated
|
|
909
|
-
mocked_dirs = mocked_headers.values.map { |real_path| File.dirname( real_path ) }.uniq
|
|
1064
|
+
isolated = []
|
|
910
1065
|
|
|
911
1066
|
mocked_headers.each_value do |real_path|
|
|
912
1067
|
next unless dependencies.include?( real_path )
|
|
@@ -929,69 +1084,13 @@ class TestBuildExecutor
|
|
|
929
1084
|
end
|
|
930
1085
|
end
|
|
931
1086
|
|
|
932
|
-
# Any other directory in this same reachable set holding more than one file is
|
|
933
|
-
# shaped the same way a mocked header's own directory is -- but with no
|
|
934
|
-
# designated substitute among its occupants, there's nothing to safely isolate.
|
|
935
|
-
# Ceedling's own generated/vendor directories are exempt: a mocks output
|
|
936
|
-
# directory or a vendor framework's own source directory routinely holds
|
|
937
|
-
# several co-resident files as a matter of course, never a same-directory
|
|
938
|
-
# quote-include shortcut risk the way a real project header directory is.
|
|
939
|
-
generated_dirs = generated_content_dirs( testable )
|
|
940
|
-
|
|
941
|
-
by_directory.each do |dir, files|
|
|
942
|
-
next if mocked_dirs.include?( dir )
|
|
943
|
-
next if generated_dirs.any? { |gd| dir.start_with?( gd ) }
|
|
944
|
-
|
|
945
|
-
files.uniq.combination( 2 ).each do |a, b|
|
|
946
|
-
msg = "'#{a}' sits alongside '#{b}' at a nesting depth beyond what automated sibling-header " \
|
|
947
|
-
"isolation provides. If this test's build fails with a redeclaration or conflicting types " \
|
|
948
|
-
"error, the include ordering and path structure leading to '#{a}' or '#{b}' is worth investigating."
|
|
949
|
-
@loginator.log( msg, Verbosity::COMPLAIN, LogLabels::NOTICE )
|
|
950
|
-
end
|
|
951
|
-
end
|
|
952
|
-
|
|
953
1087
|
return nil if isolated.empty?
|
|
954
1088
|
|
|
955
|
-
|
|
956
|
-
|
|
957
|
-
|
|
958
|
-
end
|
|
959
|
-
|
|
960
|
-
# `{ basename => real path }` for every real header this test substitutes -- CMock
|
|
961
|
-
# mocks of a real header, and Partials -- cross-referenced elsewhere against
|
|
962
|
-
# whatever a test's own compile actually reached. A mock Partial's own `source` is
|
|
963
|
-
# its own generated interface header, not a real project header, and is excluded.
|
|
964
|
-
def mocked_and_partialized_headers(testable)
|
|
965
|
-
headers = {}
|
|
966
|
-
|
|
967
|
-
(testable.mocks || {}).each_value do |details|
|
|
968
|
-
next if details.partial
|
|
969
|
-
headers[File.basename( details.source )] = details.source if details.source
|
|
970
|
-
end
|
|
971
|
-
|
|
972
|
-
testable.partials.configs.each_value do |config|
|
|
973
|
-
filepath = config.header.filepath
|
|
974
|
-
headers[File.basename( filepath )] = filepath if filepath
|
|
975
|
-
end
|
|
1089
|
+
# Each copy names its original through #line, so diagnostics, __FILE__, debug info and
|
|
1090
|
+
# coverage data report the original
|
|
1091
|
+
isolation = @quote_include_isolator.isolate( parent: testable.paths[:build], files: isolated.uniq, preserve_location: true )
|
|
976
1092
|
|
|
977
|
-
|
|
978
|
-
end
|
|
979
|
-
|
|
980
|
-
# Directory roots holding only Ceedling's own generated or vendored content for this
|
|
981
|
-
# test -- never real project headers, so co-residency there is routine, not a
|
|
982
|
-
# same-directory quote-include risk. A test's own Partials output directory
|
|
983
|
-
# routinely holds several generated headers side by side (a types header, an
|
|
984
|
-
# interface header, and more, one set per Partialized module), exactly the same
|
|
985
|
-
# shape as the mocks output directory.
|
|
986
|
-
def generated_content_dirs(testable)
|
|
987
|
-
[
|
|
988
|
-
testable.paths[:mocks],
|
|
989
|
-
testable.paths[:partials],
|
|
990
|
-
PROJECT_BUILD_VENDOR_UNITY_PATH,
|
|
991
|
-
PROJECT_BUILD_VENDOR_CMOCK_PATH,
|
|
992
|
-
PROJECT_BUILD_VENDOR_CEXCEPTION_PATH,
|
|
993
|
-
@configurator.project_build_vendor_ceedling_path
|
|
994
|
-
].compact
|
|
1093
|
+
{ search_paths: [isolation.dir] + testable.search_paths, isolation: isolation }
|
|
995
1094
|
end
|
|
996
1095
|
|
|
997
1096
|
# Registers `object`'s antecedents (its source file, plus whatever headers
|
|
@@ -1001,12 +1100,37 @@ class TestBuildExecutor
|
|
|
1001
1100
|
# if headers changed, that's exactly what makes this stale. Nothing has just
|
|
1002
1101
|
# written that file, so one look suffices: a clean build has none, and a missed
|
|
1003
1102
|
# one leaves the object stale, forcing a recompile.
|
|
1004
|
-
|
|
1005
|
-
|
|
1103
|
+
#
|
|
1104
|
+
# A header isolation's directory takes a new name every build, so an object compiled
|
|
1105
|
+
# with it weighs the isolated originals in its place (see isolation_meta).
|
|
1106
|
+
def register_and_check_object_staleness(object:, source:, dependencies:, flags:, defines:, search_paths:, tool:, isolation: nil)
|
|
1107
|
+
meta = dependency_meta( flags: flags, defines: defines, tools: [tool], **isolation_meta( search_paths, isolation ) )
|
|
1108
|
+
|
|
1109
|
+
@dependinator.register( object, files: [source], meta: meta )
|
|
1006
1110
|
@dependinator.register_gcc_deps_file( dependencies ) if @file_wrapper.exist?( dependencies )
|
|
1007
1111
|
@dependinator.stale?( object )
|
|
1008
1112
|
end
|
|
1009
1113
|
|
|
1114
|
+
# The search paths and isolated originals an object's staleness weighs.
|
|
1115
|
+
#
|
|
1116
|
+
# The isolated originals stand in for the isolation directory, so a change to which
|
|
1117
|
+
# files are isolated still rebuilds the object while the directory's own name never
|
|
1118
|
+
# counts. The originals' contents are tracked through the object's restored .d file.
|
|
1119
|
+
def isolation_meta(search_paths, isolation)
|
|
1120
|
+
return { search_paths: search_paths } unless isolation && search_paths.include?( isolation.dir )
|
|
1121
|
+
|
|
1122
|
+
return { search_paths: search_paths - [isolation.dir], isolated: isolation.copies.keys.sort }
|
|
1123
|
+
end
|
|
1124
|
+
|
|
1125
|
+
# Rewrites a compile's .d file to name each isolated original in place of its copy.
|
|
1126
|
+
# The copies are removed once the compile stage ends, so a .d file naming one would
|
|
1127
|
+
# read as a vanished dependency on the next build.
|
|
1128
|
+
def restore_isolated_dependencies(testable, dependencies)
|
|
1129
|
+
return if testable.header_isolation.nil?
|
|
1130
|
+
|
|
1131
|
+
@quote_include_isolator.restore_dependencies( testable.header_isolation, dependencies )
|
|
1132
|
+
end
|
|
1133
|
+
|
|
1010
1134
|
# Each framework/support source needs its own vendor path (and, for CMock and a
|
|
1011
1135
|
# support file, other frameworks' vendor paths too, when those frameworks are also in
|
|
1012
1136
|
# play) spliced in ahead of a test's ordinary search paths -- the vendor sources
|