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
|
@@ -34,15 +34,16 @@ class ReleaseBuildPlanner
|
|
|
34
34
|
def plan(state, files: nil)
|
|
35
35
|
tailor_release_tools()
|
|
36
36
|
|
|
37
|
-
sources
|
|
37
|
+
# A link-only name is no source of its own. Placed apart from the sources, one naming
|
|
38
|
+
# the object a source builds to joins it rather than colliding with it.
|
|
39
|
+
sources, link_only =
|
|
38
40
|
if files.nil?
|
|
39
|
-
@configurator.collection_release_build_input
|
|
40
|
-
@configurator.collection_release_artifact_extra_link_objects
|
|
41
|
+
[@configurator.collection_release_build_input, @configurator.collection_release_artifact_extra_link_objects]
|
|
41
42
|
else
|
|
42
|
-
files.dup
|
|
43
|
+
[files.dup, []]
|
|
43
44
|
end
|
|
44
45
|
|
|
45
|
-
state.objects =
|
|
46
|
+
state.objects = release_objects( sources, link_only )
|
|
46
47
|
state.compile_flags = @flaginator.flag_down( context: RELEASE_SYM, operation: OPERATION_COMPILE_SYM )
|
|
47
48
|
state.assemble_flags = @flaginator.flag_down( context: RELEASE_SYM, operation: OPERATION_ASSEMBLE_SYM )
|
|
48
49
|
state.link_flags = @flaginator.flag_down( context: RELEASE_SYM, operation: OPERATION_LINK_SYM )
|
|
@@ -52,6 +53,13 @@ class ReleaseBuildPlanner
|
|
|
52
53
|
|
|
53
54
|
private
|
|
54
55
|
|
|
56
|
+
def release_objects(sources, link_only)
|
|
57
|
+
objects = @file_path_utils.form_release_build_objects_filelist( sources ).to_a
|
|
58
|
+
return objects if link_only.empty?
|
|
59
|
+
|
|
60
|
+
return (objects + @file_path_utils.form_release_build_objects_filelist( link_only ).to_a).uniq
|
|
61
|
+
end
|
|
62
|
+
|
|
55
63
|
# Shared libraries and static archives need compiler/linker argument tags
|
|
56
64
|
# (-fPIC, -shared, or swapping the linker for `ar` outright) that a plain
|
|
57
65
|
# executable target doesn't -- derived once per build from the release
|
|
@@ -73,7 +81,7 @@ class ReleaseBuildPlanner
|
|
|
73
81
|
when '.a'
|
|
74
82
|
compiler[:arguments] << '-fPIC' unless compiler[:arguments].include?('-fPIC')
|
|
75
83
|
linker[:executable] = 'ar'
|
|
76
|
-
linker[:arguments] = ['rcs', '${2}', '${1}']
|
|
84
|
+
linker[:arguments] = ['rcs', '"${2}"', '"${1}"']
|
|
77
85
|
end
|
|
78
86
|
end
|
|
79
87
|
|
|
@@ -129,10 +129,9 @@ class Reportinator
|
|
|
129
129
|
# Sanitze -- ensure it's a string and strip any filename extension
|
|
130
130
|
_module_name = module_name.to_s().ext('')
|
|
131
131
|
|
|
132
|
-
# If filename is the module name, don't add the module label. A
|
|
133
|
-
#
|
|
134
|
-
#
|
|
135
|
-
# own last segment is weighed against filename's bare basename.
|
|
132
|
+
# If filename is the module name, don't add the module label. A test's name is
|
|
133
|
+
# its path from the project root (e.g. `test/adc/TestFoo`), so only its last
|
|
134
|
+
# segment is weighed against filename's bare basename.
|
|
136
135
|
label = (File.basename(filename).ext('') == File.basename(_module_name)) ? '' : "#{_module_name}::"
|
|
137
136
|
return generate_progress("#{operation} #{label}#{filename}")
|
|
138
137
|
end
|
data/lib/ceedling/setupinator.rb
CHANGED
|
@@ -7,6 +7,29 @@
|
|
|
7
7
|
|
|
8
8
|
class Setupinator
|
|
9
9
|
|
|
10
|
+
# Configurator steps that fill out the configuration from user configuration and defaults,
|
|
11
|
+
# in the order they run:
|
|
12
|
+
# - Unity and CMock values that tie vendor tool configurations together
|
|
13
|
+
# - The Partials configuration reference for dependency-tracker meta
|
|
14
|
+
# - Test runner generation settings
|
|
15
|
+
# - Exceptions, enabled automagically by CMock settings
|
|
16
|
+
# - Environment variables again, before configuration that may reference them by inline
|
|
17
|
+
# Ruby string expansion
|
|
18
|
+
# - Paths, flags, and defines expanded, then paths standardized
|
|
19
|
+
# - Unity helpers, included in mocks by their standardized filenames
|
|
20
|
+
COMPLETION_STEPS = %i[populate_unity_config populate_cmock_config populate_partials_config populate_test_runner_generation_config
|
|
21
|
+
populate_exceptions_config eval_environment_variables eval_paths eval_flags eval_defines standardize_paths populate_cmock_helpers].freeze
|
|
22
|
+
|
|
23
|
+
# Configurator settings taken from the command line, each by its application
|
|
24
|
+
# configuration key: test case filters, whether the requested tasks build tests or a
|
|
25
|
+
# release (which decides what build/vendor needs), and forced test re-execution
|
|
26
|
+
COMMAND_LINE_SETTINGS = { include_test_case: :include_test_case, exclude_test_case: :exclude_test_case,
|
|
27
|
+
test_build_tasks: :test_build_tasks?, release_build_tasks: :release_build_tasks?, force_test_rerun: :force_test_rerun }.freeze
|
|
28
|
+
|
|
29
|
+
# The application objects setup uses, taken from the object hash rather than a DIY
|
|
30
|
+
# constructor, which validates aspects of setup
|
|
31
|
+
COLLABORATORS = %i[configurator loginator reportinator plugin_manager plugin_reportinator test_runner_manager file_wrapper win_path_prober file_path_utils].freeze
|
|
32
|
+
|
|
10
33
|
attr_reader :config_hash
|
|
11
34
|
|
|
12
35
|
def setup
|
|
@@ -26,36 +49,39 @@ class Setupinator
|
|
|
26
49
|
def ceedling=(value)
|
|
27
50
|
# Capture application objects hash as instance variable
|
|
28
51
|
@ceedling = value
|
|
29
|
-
|
|
30
|
-
# Get our dependencies from object hash rather than DIY constructor
|
|
31
|
-
# This is a shortcut / validates aspects of our setup
|
|
32
|
-
@configurator = value[:configurator]
|
|
33
|
-
@loginator = value[:loginator]
|
|
34
|
-
@reportinator = value[:reportinator]
|
|
35
|
-
@plugin_manager = value[:plugin_manager]
|
|
36
|
-
@plugin_reportinator = value[:plugin_reportinator]
|
|
37
|
-
@test_runner_manager = value[:test_runner_manager]
|
|
52
|
+
COLLABORATORS.each { |name| instance_variable_set( "@#{name}", value[name] ) }
|
|
38
53
|
end
|
|
39
54
|
|
|
40
55
|
|
|
41
56
|
# Load up all the constants and accessors our rake files, objects, & external scripts will need.
|
|
57
|
+
# Each numbered step's order matters.
|
|
42
58
|
def do_setup( app_cfg )
|
|
43
59
|
@config_hash = app_cfg[:project_config]
|
|
44
60
|
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
61
|
+
apply_command_line( app_cfg ) # 1.
|
|
62
|
+
prepare_essential_configuration() # 1.
|
|
63
|
+
plugins_paths_hash = handle_base_configuration( app_cfg ) # 2.
|
|
64
|
+
handle_plugins( plugins_paths_hash ) # 3.
|
|
65
|
+
assemble_defaults( plugins_paths_hash ) # 4.
|
|
66
|
+
complete_configuration( app_cfg ) # 5.
|
|
67
|
+
validate_final_configuration() # 6.
|
|
68
|
+
|
|
69
|
+
build_configuration( app_cfg ) # 7.
|
|
70
|
+
|
|
71
|
+
load_plugins() # 8.
|
|
72
|
+
end
|
|
48
73
|
|
|
49
|
-
# Set special purpose test case filters (from command line)
|
|
50
|
-
@configurator.include_test_case = app_cfg[:include_test_case]
|
|
51
|
-
@configurator.exclude_test_case = app_cfg[:exclude_test_case]
|
|
52
74
|
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
75
|
+
### Private
|
|
76
|
+
|
|
77
|
+
private
|
|
78
|
+
|
|
79
|
+
##
|
|
80
|
+
## 1. Miscellaneous handling and essential configuration prep
|
|
81
|
+
##
|
|
56
82
|
|
|
57
|
-
|
|
58
|
-
@configurator.
|
|
83
|
+
def apply_command_line(app_cfg)
|
|
84
|
+
COMMAND_LINE_SETTINGS.each { |setting, key| @configurator.public_send( "#{setting}=", app_cfg[key] ) }
|
|
59
85
|
|
|
60
86
|
# Verbosity handling
|
|
61
87
|
@configurator.set_verbosity()
|
|
@@ -63,7 +89,9 @@ class Setupinator
|
|
|
63
89
|
# Logging configuration
|
|
64
90
|
@loginator.set_logfile( app_cfg[:log_filepath] )
|
|
65
91
|
@configurator.project_logging = @loginator.project_logging
|
|
92
|
+
end
|
|
66
93
|
|
|
94
|
+
def prepare_essential_configuration
|
|
67
95
|
log_step( 'Validating configuration contains minimum required sections', heading: false )
|
|
68
96
|
|
|
69
97
|
# Complain early about anything essential that's missing
|
|
@@ -72,39 +100,44 @@ class Setupinator
|
|
|
72
100
|
# Merge any needed runtime settings into user configuration
|
|
73
101
|
@configurator.merge_ceedling_runtime_config( config_hash, CEEDLING_RUNTIME_CONFIG.deep_clone )
|
|
74
102
|
|
|
75
|
-
|
|
76
|
-
log_step( 'Processing Partials configuration', heading: false, verbosity: Verbosity::NORMAL )
|
|
77
|
-
# Set configuration settings derived from enabling partials
|
|
78
|
-
@configurator.set_partials_derived_config( config_hash )
|
|
79
|
-
end
|
|
103
|
+
return unless config_hash[:project][:use_partials]
|
|
80
104
|
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
105
|
+
log_step( 'Processing Partials configuration', heading: false, verbosity: Verbosity::NORMAL )
|
|
106
|
+
# Set configuration settings derived from enabling partials
|
|
107
|
+
@configurator.set_partials_derived_config( config_hash )
|
|
108
|
+
end
|
|
84
109
|
|
|
110
|
+
##
|
|
111
|
+
## 2. Handle basic configuration
|
|
112
|
+
##
|
|
113
|
+
|
|
114
|
+
def handle_base_configuration(app_cfg)
|
|
85
115
|
log_step( 'Base configuration handling', heading: false )
|
|
86
116
|
|
|
87
117
|
# Evaluate environment vars before plugin configurations that might reference with inline Ruby string expansion
|
|
88
118
|
@configurator.eval_environment_variables( config_hash )
|
|
89
119
|
|
|
90
120
|
# Standardize paths and add to Ruby load paths
|
|
91
|
-
|
|
121
|
+
return @configurator.prepare_plugins_load_paths( app_cfg[:ceedling_plugins_path], config_hash )
|
|
122
|
+
end
|
|
92
123
|
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
124
|
+
##
|
|
125
|
+
## 3. Plugin Handling
|
|
126
|
+
##
|
|
96
127
|
|
|
128
|
+
def handle_plugins(plugins_paths_hash)
|
|
97
129
|
log_step( 'Plugin Handling' )
|
|
98
130
|
|
|
99
|
-
# Plugin handling
|
|
100
131
|
@configurator.discover_plugins( plugins_paths_hash, config_hash )
|
|
101
132
|
@configurator.merge_config_plugins( config_hash )
|
|
102
133
|
@configurator.populate_plugins_config( plugins_paths_hash, config_hash )
|
|
134
|
+
end
|
|
103
135
|
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
136
|
+
##
|
|
137
|
+
## 4. Collect and apply defaults to user configuration
|
|
138
|
+
##
|
|
107
139
|
|
|
140
|
+
def assemble_defaults(plugins_paths_hash)
|
|
108
141
|
log_step( 'Assembling Default Settings' )
|
|
109
142
|
|
|
110
143
|
# Assemble defaults
|
|
@@ -115,37 +148,20 @@ class Setupinator
|
|
|
115
148
|
|
|
116
149
|
# Set any missing essential or plugin values in configuration with assembled default values
|
|
117
150
|
@configurator.populate_with_defaults( config_hash, defaults_hash )
|
|
151
|
+
end
|
|
118
152
|
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
153
|
+
##
|
|
154
|
+
## 5. Fill out / modify remaining configuration from user configuration + defaults
|
|
155
|
+
##
|
|
122
156
|
|
|
157
|
+
def complete_configuration(app_cfg)
|
|
123
158
|
log_step( 'Completing Project Configuration' )
|
|
124
159
|
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
# Populate CMock configuration with values to tie vendor tool configurations together
|
|
129
|
-
@configurator.populate_cmock_config( config_hash )
|
|
130
|
-
|
|
131
|
-
# Populate Partials configuration reference for dependency-tracker meta
|
|
132
|
-
@configurator.populate_partials_config( config_hash )
|
|
133
|
-
|
|
134
|
-
# Configure test runner generation
|
|
135
|
-
@configurator.populate_test_runner_generation_config( config_hash )
|
|
136
|
-
|
|
137
|
-
# Automagically enable use of exceptions based on CMock settings
|
|
138
|
-
@configurator.populate_exceptions_config( config_hash )
|
|
139
|
-
|
|
140
|
-
# Evaluate environment vars again before subsequent configurations that might reference with inline Ruby string expansion
|
|
141
|
-
@configurator.eval_environment_variables( config_hash )
|
|
142
|
-
|
|
143
|
-
# Standardize values and expand inline Ruby string substitutions
|
|
144
|
-
@configurator.eval_paths( config_hash )
|
|
145
|
-
@configurator.eval_flags( config_hash )
|
|
146
|
-
@configurator.eval_defines( config_hash )
|
|
147
|
-
@configurator.standardize_paths( config_hash )
|
|
160
|
+
COMPLETION_STEPS.each { |step| @configurator.public_send( step, config_hash ) }
|
|
161
|
+
complete_tools_and_runners( app_cfg )
|
|
162
|
+
end
|
|
148
163
|
|
|
164
|
+
def complete_tools_and_runners(app_cfg)
|
|
149
165
|
# Fill out any missing tool config value
|
|
150
166
|
@configurator.populate_tools_config( config_hash )
|
|
151
167
|
|
|
@@ -163,57 +179,58 @@ class Setupinator
|
|
|
163
179
|
# Configure test runner build & runtime options
|
|
164
180
|
@test_runner_manager.configure_build_options( config_hash )
|
|
165
181
|
@test_runner_manager.configure_runtime_options( app_cfg[:include_test_case], app_cfg[:exclude_test_case] )
|
|
182
|
+
end
|
|
166
183
|
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
184
|
+
##
|
|
185
|
+
## 6. Validate configuration
|
|
186
|
+
##
|
|
170
187
|
|
|
188
|
+
def validate_final_configuration
|
|
171
189
|
log_step( 'Validating final project configuration', heading: false )
|
|
172
190
|
|
|
173
191
|
@configurator.validate_final( config_hash )
|
|
192
|
+
end
|
|
174
193
|
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
# Skip logging this step as the end user doesn't care about this internal preparation
|
|
194
|
+
##
|
|
195
|
+
## 7. Build configuration
|
|
196
|
+
##
|
|
180
197
|
|
|
181
|
-
|
|
198
|
+
# Partially flatten config + build Configurator accessors and globals. FileWrapper
|
|
199
|
+
# reports path lengths from the first file a command touches, before any configuration
|
|
200
|
+
# exists, so it learns the Windows path limit, and the prober that decides it, here. The
|
|
201
|
+
# long configured roots build paths shorten are written to the build root and logged.
|
|
202
|
+
def build_configuration(app_cfg)
|
|
182
203
|
@configurator.build( app_cfg[:ceedling_lib_path], app_cfg[:logging_path], config_hash, :environment )
|
|
204
|
+
@file_wrapper.configure_win_path_limit( mode: @configurator.project_win_path_limit, prober: @win_path_prober )
|
|
205
|
+
@file_path_utils.publish_build_roots.each { |root, marker| @loginator.log( "#{marker} ➡️ #{root}", Verbosity::DEBUG ) }
|
|
206
|
+
end
|
|
183
207
|
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
208
|
+
##
|
|
209
|
+
## 8. Final plugins handling
|
|
210
|
+
##
|
|
187
211
|
|
|
212
|
+
def load_plugins
|
|
188
213
|
# Detailed logging already happend for plugin processing
|
|
189
214
|
log_step( 'Loading Plugins' )
|
|
190
215
|
|
|
191
216
|
@configurator.insert_rake_plugins( @configurator.rake_plugins )
|
|
192
|
-
|
|
217
|
+
|
|
193
218
|
# Merge in any environment variables that plugins specify after the main build
|
|
194
219
|
@plugin_manager.load_programmatic_plugins( @configurator.programmatic_plugins, @ceedling ) do |env|
|
|
195
220
|
# Evaluate environment vars that plugins may have added
|
|
196
221
|
@configurator.eval_environment_variables( env )
|
|
197
222
|
@configurator.build_supplement( config_hash, env )
|
|
198
223
|
end
|
|
199
|
-
|
|
224
|
+
|
|
200
225
|
# Inject dependencies for plugin needs
|
|
201
226
|
@plugin_reportinator.set_system_objects( @ceedling )
|
|
202
227
|
end
|
|
203
228
|
|
|
204
|
-
|
|
205
|
-
### Private
|
|
206
|
-
|
|
207
|
-
private
|
|
208
|
-
|
|
209
229
|
# Neaten up a build step with progress message and some scope encapsulation
|
|
210
230
|
def log_step(msg, heading: true, verbosity: Verbosity::OBNOXIOUS )
|
|
211
|
-
@loginator.lazy( verbosity ) do
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
else # Progress message
|
|
215
|
-
"\n" + @reportinator.generate_progress( @loginator.decorate( msg, LogLabels::CONSTRUCT ) )
|
|
216
|
-
end
|
|
231
|
+
@loginator.lazy( verbosity ) do
|
|
232
|
+
decorated = @loginator.decorate( msg, LogLabels::CONSTRUCT )
|
|
233
|
+
heading ? @reportinator.generate_heading( decorated ) : "\n" + @reportinator.generate_progress( decorated )
|
|
217
234
|
end
|
|
218
235
|
end
|
|
219
236
|
|
|
@@ -7,9 +7,10 @@
|
|
|
7
7
|
|
|
8
8
|
require 'ceedling/exceptions'
|
|
9
9
|
require 'ceedling/partials/partials'
|
|
10
|
-
require 'ceedling/file_path_utils'
|
|
10
|
+
require 'ceedling/filesystem/file_path_utils'
|
|
11
11
|
require 'ceedling/generators/generator_test_runner' # From lib/ not vendor/unity/auto
|
|
12
12
|
require 'ceedling/encodinator'
|
|
13
|
+
require 'ceedling/filesystem/project_paths'
|
|
13
14
|
|
|
14
15
|
class TestContextExtractor
|
|
15
16
|
|
|
@@ -304,9 +305,12 @@ class TestContextExtractor
|
|
|
304
305
|
end
|
|
305
306
|
end
|
|
306
307
|
|
|
308
|
+
# Each path is recorded in the one spelling collections use, so its headers are never
|
|
309
|
+
# collected a second time under another
|
|
307
310
|
def ingest_build_directive_include_paths(filepath, include_paths)
|
|
308
311
|
return if include_paths.empty?
|
|
309
312
|
|
|
313
|
+
include_paths = include_paths.map { |path| ProjectPaths.canonical( path ) }
|
|
310
314
|
key = form_file_key( filepath )
|
|
311
315
|
|
|
312
316
|
@lock.synchronize do
|
|
@@ -1,22 +1,31 @@
|
|
|
1
1
|
# Sibling-Header Isolation and Reactive Collision Guidance
|
|
2
2
|
|
|
3
|
-
A mock or a Partial exists to substitute one header's content for another. That substitution only ever sees what a test file's own `#include` directives name directly -- it has no visibility into a module's full, transitive `#include` closure. A module reaching the *same real header* a second way, through some other, unrelated `#include` chain, can slip right past the substitution: the mock or Partial still gets generated and still gets `#include`d, but the real header's own content ends up in the compile too, unmocked.
|
|
3
|
+
A mock or a Partial exists to substitute one header's content for another. That substitution only ever sees what a test file's own `#include` directives name directly -- it has no visibility into a module's full, transitive `#include` closure. A module reaching the *same real header* a second way, through some other, unrelated `#include` chain, can slip right past the substitution: the mock or Partial still gets generated and still gets `#include`d, but the real header's own content ends up in the compile too, unmocked. `TestBuildExecutor` prevents this gap where it can, and the build step doctor explains a collision that prevention can't resolve.
|
|
4
4
|
|
|
5
5
|
## Why it happens: quote-include's same-directory rule
|
|
6
6
|
|
|
7
|
-
C's `#include "..."` form checks the *including file's own directory* before it ever consults a search path (`-I`). A mock or Partial substitutes a header by relying on search-path order -- the mocks/Partials directory is listed ahead of the real header
|
|
7
|
+
C's `#include "..."` form checks the *including file's own directory* before it ever consults a search path (`-I`). A mock or Partial substitutes a header by relying on search-path order -- the mocks/Partials directory is listed ahead of the search path that reaches the real header, so an ordinary `#include "the_header.h"` finds the substitute first. That ordering means nothing, though, to a *different* file that happens to live in the same directory as the real header and does its own `#include "the_header.h"`: that file's own directory is checked first, finds the real header sitting right beside it, and never consults `-I` at all. Nothing about this is a Ceedling bug in the ordinary sense -- it's C's own quote-include resolution rule, doing exactly what it's specified to do, in a situation Ceedling's substitution scheme didn't account for.
|
|
8
8
|
|
|
9
9
|
Every remedy below works the same way: a file is copied alone into a fresh directory, where its quoted `#include` has no neighbor to find. `QuoteIncludeIsolator` (`lib/ceedling/quote_include_isolator.rb`) owns that staging, its release, and mapping a copy's path back to its original.
|
|
10
10
|
|
|
11
|
+
A copy is a tool for compiling, never a dependency. Its directory takes a new name every time and is removed afterward, so dependency tracking records the original wherever a copy was used. An unchanged rebuild then compiles nothing, and an edit to an original rebuilds what reached it through a copy.
|
|
12
|
+
|
|
11
13
|
## Prevention: `isolate_sibling_headers`
|
|
12
14
|
|
|
13
15
|
Right after a test file's own compile, its freshly-written `.d` dependency file already reveals every real header reachable from it -- including a header whose content only got *reached*, not necessarily *used* (gcc's dependency output is guard-blind: a header still counts as a dependency even when its content was fully skipped by an already-satisfied include guard). For prevention, that's enough: knowing two files merely *could* collide is all a fix needs, since it doesn't have to resolve which copy would actually win.
|
|
14
16
|
|
|
15
|
-
|
|
17
|
+
Isolation can redirect a quoted `#include` only to a file of the same name earlier on the search path. CMock writes one for each header it mocks under `:cmock` ↳ `:treat_inlines: :include`: an inline-stripped copy in the mocks directory. Nothing else does, so isolation considers only those headers (`TestSubstitutions#shadowed_headers`). With other mocks and with Partials, a sibling's quoted `#include` would find the real header through the search paths anyway.
|
|
18
|
+
|
|
19
|
+
`isolate_sibling_headers` (in `TestBuildExecutor`) parses that `.d` file and checks, for each of those headers, whether the same directory also holds some other header the test's compile reached and that quote-includes it by name. Any it finds get staged, together, into one new directory of their own via `QuoteIncludeIsolator#isolate` -- copied there alone, with nothing else beside them, so their own `#include` of the real header can no longer take the same-directory shortcut and gets forced through search paths instead, where CMock's copy is listed first. Each copy opens with `#line 1 "<original path>"`, so diagnostics, `__FILE__`, debug info and coverage data name the original header. The test's own object then recompiles with that isolation directory prepended to its search paths.
|
|
20
|
+
|
|
21
|
+
Isolation acts only one level deep, and only around a header CMock copies. A directory elsewhere in the same dependency list can hold several headers the test reaches, none of them mocked or Partialized. It is shaped the same way, but nothing designates which occupant should win, so isolation leaves it alone and logs nothing. If the compilation then fails with a collision there, the doctor's shared-directory diagnosis explains it (see below).
|
|
16
22
|
|
|
17
|
-
|
|
23
|
+
The isolated directory this produces is a *throwaway*: it's always freshly, fully derived from files already tracked by the dependency tracker, so it can never itself go stale independently and needs no tracking of its own. The test's own retry compile writes to a separate dependencies path that's never registered -- only the original attempt's own `.d` file (real headers, real paths) is what the dependency tracker keeps, unchanged. The directory itself is scoped to this one test's whole build, not to a single object: every other object in the same test needs to see the same corrected search paths, which is why `stage_build_objects` compiles a test's own file in a batch fully completed before any other object in that test starts (a real barrier, since `Batchinator#exec` blocks until every item in a batch finishes -- without it, another object could finish compiling with the original, uncorrected paths before the fix landed). The testable keeps the whole isolation, its directory and its copies, in `header_isolation`. The directory is removed once, after both batches of the whole build finish or when a compile fails.
|
|
18
24
|
|
|
19
|
-
|
|
25
|
+
Every later object compiled with the isolation directory keeps it out of its dependencies two ways:
|
|
26
|
+
|
|
27
|
+
- Its staleness meta records its search paths without the directory, plus the isolated originals under `isolated:`. A change to which files are isolated rebuilds the object, while the directory's own name never counts.
|
|
28
|
+
- `QuoteIncludeIsolator#restore_dependencies` rewrites its `.d` file to name each original in place of its copy before it is registered. An edit to an original then rebuilds every object that reached it through the copy.
|
|
20
29
|
|
|
21
30
|
`extract_bare_includes` (`preprocess/preprocessinator_includes_handler.rb`) stages an isolated copy for an unrelated reason -- limiting a preprocessor scan to a file's own top-level `#include`s -- using the same `QuoteIncludeIsolator` this mechanism does; see its own comment there for that story.
|
|
22
31
|
|
|
@@ -36,6 +45,11 @@ A source under test can sit beside a header its test mocks and quote-include it
|
|
|
36
45
|
|
|
37
46
|
## What isolation can't fix: Partials, and the reactive fallback
|
|
38
47
|
|
|
39
|
-
CMock's own mock generation, when `:treat_inlines: :include` is configured, produces a same-basename shadow of the real header -- a safe replacement sharing the real header's own filename and include guard, which is exactly what gives an isolated sibling's own `#include` something to fall through to on `-I`. Partials generates *distinctly-named* files instead; there's never a same-basename replacement waiting on a search path for an isolated sibling to find. When a Partial's own generated content and its module's real, un-Partialized header both reach one compile, isolation has structurally nothing to redirect -- the collision is a straightforward `redeclaration`/`conflicting types`/`previous definition` compile error, and it stays one no matter how the search paths are arranged.
|
|
48
|
+
CMock's own mock generation, when `:treat_inlines: :include` is configured, produces a same-basename shadow of the real header -- a safe replacement sharing the real header's own filename and include guard, which is exactly what gives an isolated sibling's own `#include` something to fall through to on `-I`. Partials generates *distinctly-named* files instead; there's never a same-basename replacement waiting on a search path for an isolated sibling to find, so isolation never runs for a Partialized header. When a Partial's own generated content and its module's real, un-Partialized header both reach one compile, isolation has structurally nothing to redirect -- the collision is a straightforward `redeclaration`/`conflicting types`/`previous definition` compile error, and it stays one no matter how the search paths are arranged.
|
|
49
|
+
|
|
50
|
+
`HeaderCollisionSpecialist` (`lib/ceedling/diagnostics/`) is the deliberate fallback, for this case and for any other collision isolation doesn't resolve. When a test's compilation fails, `TestBuildExecutor` hands its output and inputs to the build step doctor (see `diagnostics/DOCTOR.md`). The specialist matches the redeclaration and conflicting-types wordings of many toolchains, then examines the case two ways. Each logs a notice at `ERRORS` verbosity before the compiler's error is raised:
|
|
51
|
+
|
|
52
|
+
- **A substituted header colliding with its real content.** The output names a real header this test mocks or Partializes. The notice explains how the real content can arrive through a second `#include` chain, and how to break it.
|
|
53
|
+
- **A collision in a shared directory.** The output names a header whose directory holds other headers this test reaches, none of them substituted and none of them Ceedling's own. The first compilation attempt's `.d` file decides what the test reaches. A toolchain that writes no `.d` file leaves the directory's listing instead. One notice is logged per such directory, naming only the headers the compiler named. It explains the quote-include rule, isolation's limits, and how to make each declaration arrive once.
|
|
40
54
|
|
|
41
|
-
|
|
55
|
+
Both read the same failure, so one compilation can draw both notices.
|