ceedling 1.2.2 → 1.2.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/GIT_COMMIT_SHA +1 -1
- data/README.md +1 -1
- data/assets/fixtures/tests_with_partials_coverage/src/private_macro.c +7 -0
- data/assets/fixtures/tests_with_partials_coverage/src/private_macro.h +5 -0
- data/assets/fixtures/tests_with_partials_coverage/src/tally.c +13 -0
- data/assets/fixtures/tests_with_partials_coverage/src/tally.h +4 -0
- data/assets/fixtures/tests_with_partials_coverage/test/test_private_macro.c +10 -0
- data/assets/fixtures/tests_with_partials_coverage/test/test_tally.c +9 -0
- data/docs/BreakingChanges.md +16 -0
- data/docs/Changelog.md +71 -0
- data/docs/KnownIssues.md +91 -4
- data/examples/wondrous_forest/README.md +29 -1
- data/examples/wondrous_forest/src/ForestUnits.h +23 -0
- data/examples/wondrous_forest/src/RainGauge.c +59 -0
- data/examples/wondrous_forest/src/RainGauge.h +39 -0
- data/examples/wondrous_forest/src/RainTipIsr.c +17 -0
- data/examples/wondrous_forest/src/RainTipIsr.h +14 -0
- data/examples/wondrous_forest/test/TestRainGauge.c +126 -0
- data/lib/ceedling/c_extractor/README.md +15 -7
- data/lib/ceedling/c_extractor/c_extractor.rb +25 -14
- data/lib/ceedling/c_extractor/c_extractor_code_text.rb +84 -54
- data/lib/ceedling/c_extractor/c_extractor_constants.rb +18 -7
- data/lib/ceedling/c_extractor/c_extractor_declarations.rb +319 -283
- data/lib/ceedling/c_extractor/c_extractor_declarator.rb +285 -0
- data/lib/ceedling/c_extractor/c_extractor_defined_type.rb +111 -0
- data/lib/ceedling/c_extractor/c_extractor_definitions.rb +174 -121
- data/lib/ceedling/c_extractor/c_extractor_functions.rb +191 -162
- data/lib/ceedling/c_extractor/c_extractor_preprocessing.rb +46 -55
- data/lib/ceedling/c_extractor/c_extractor_statement.rb +30 -0
- data/lib/ceedling/c_extractor/c_extractor_types.rb +63 -41
- data/lib/ceedling/c_extractor/c_module_edits.rb +48 -0
- data/lib/ceedling/c_identifier.rb +21 -0
- data/lib/ceedling/ceedling.h +8 -0
- data/lib/ceedling/config/configurator.rb +4 -3
- data/lib/ceedling/config/configurator_builder.rb +17 -0
- data/lib/ceedling/config/configurator_setup.rb +29 -5
- data/lib/ceedling/constants.rb +5 -1
- data/lib/ceedling/defaults.rb +31 -1
- data/lib/ceedling/dependencies/CACHE_SCHEMA.md +118 -0
- data/lib/ceedling/dependencies/README.md +1 -1
- data/lib/ceedling/dependencies/dependency_cache_store.rb +30 -25
- data/lib/ceedling/dependencies/dependency_tracker.rb +9 -3
- data/lib/ceedling/dependencies/dependinator.rb +13 -1
- data/lib/ceedling/diagnostics/DOCTOR.md +142 -0
- data/lib/ceedling/diagnostics/README.md +5 -0
- data/lib/ceedling/diagnostics/build_step_doctor.rb +110 -0
- data/lib/ceedling/diagnostics/duplicate_symbol_specialist.rb +108 -0
- data/lib/ceedling/diagnostics/guidance_phrases.rb +30 -0
- data/lib/ceedling/diagnostics/header_collision_guidance.rb +56 -0
- data/lib/ceedling/diagnostics/header_collision_specialist.rb +152 -0
- data/lib/ceedling/diagnostics/include_depth_specialist.rb +132 -0
- data/lib/ceedling/diagnostics/missing_symbol_specialist.rb +111 -0
- data/lib/ceedling/diagnostics/partial_name_specialist.rb +134 -0
- data/lib/ceedling/diagnostics/toolchain_output.rb +44 -0
- data/lib/ceedling/filesystem/PATH_HANDLING.md +83 -27
- data/lib/ceedling/filesystem/README.md +6 -1
- data/lib/ceedling/filesystem/build_roots.rb +105 -0
- data/lib/ceedling/filesystem/build_subpath.rb +110 -25
- data/lib/ceedling/filesystem/file_finder.rb +76 -110
- data/lib/ceedling/filesystem/file_finder_helper.rb +33 -11
- data/lib/ceedling/filesystem/file_path_utils.rb +113 -91
- data/lib/ceedling/filesystem/file_wrapper.rb +105 -28
- data/lib/ceedling/filesystem/path_matcher.rb +21 -0
- data/lib/ceedling/filesystem/test_build_layout.rb +114 -0
- data/lib/ceedling/filesystem/win_long_paths.rb +153 -0
- data/lib/ceedling/filesystem/win_path_limit.rb +83 -0
- data/lib/ceedling/filesystem/win_path_prober.rb +52 -0
- data/lib/ceedling/generators/generator.rb +27 -64
- data/lib/ceedling/generators/generator_helper.rb +0 -44
- data/lib/ceedling/generators/generator_mocks.rb +5 -0
- data/lib/ceedling/generators/generator_partials.rb +305 -243
- data/lib/ceedling/generators/generator_test_runner.rb +5 -8
- data/lib/ceedling/generators/partial_header_writer.rb +95 -0
- data/lib/ceedling/generators/partial_source_writer.rb +137 -0
- data/lib/ceedling/includes/header_search.rb +225 -0
- data/lib/ceedling/includes/include_factory.rb +9 -12
- data/lib/ceedling/includes/include_pathinator.rb +53 -31
- data/lib/ceedling/includes/includes.rb +149 -37
- data/lib/ceedling/objects.yml +89 -4
- data/lib/ceedling/partials/README.md +110 -16
- data/lib/ceedling/partials/carry_plan.rb +71 -0
- data/lib/ceedling/partials/definition_head.rb +74 -0
- data/lib/ceedling/partials/include_groups.rb +37 -0
- data/lib/ceedling/partials/interface_extras.rb +25 -0
- data/lib/ceedling/partials/partializer.rb +599 -120
- data/lib/ceedling/partials/partializer_config.rb +5 -0
- data/lib/ceedling/partials/partializer_helper.rb +851 -145
- data/lib/ceedling/partials/partializer_reconciler.rb +174 -0
- data/lib/ceedling/partials/partializer_utils.rb +89 -109
- data/lib/ceedling/partials/partials.rb +153 -10
- data/lib/ceedling/partials/type_macros.rb +126 -0
- data/lib/ceedling/preprocess/README.md +43 -33
- data/lib/ceedling/preprocess/preprocessinator.rb +100 -186
- data/lib/ceedling/preprocess/preprocessinator_code_finder.rb +65 -72
- data/lib/ceedling/preprocess/preprocessinator_file_assembler.rb +31 -75
- data/lib/ceedling/preprocess/preprocessinator_reconstructor.rb +51 -14
- data/lib/ceedling/setupinator.rb +16 -3
- data/lib/ceedling/test_invoker/HEADER_COLLISIONS.md +21 -7
- data/lib/ceedling/test_invoker/PIPELINE.md +57 -16
- data/lib/ceedling/test_invoker/README.md +1 -1
- data/lib/ceedling/test_invoker/derived_search_path_notices.rb +45 -0
- data/lib/ceedling/test_invoker/mock_locator.rb +116 -9
- data/lib/ceedling/test_invoker/partial_files_preprocessinator.rb +181 -0
- data/lib/ceedling/test_invoker/partials_manager.rb +265 -308
- data/lib/ceedling/test_invoker/standin_headerinator.rb +8 -15
- data/lib/ceedling/test_invoker/test_bare_includes_extractinator.rb +26 -3
- data/lib/ceedling/test_invoker/test_build_executor.rb +338 -198
- data/lib/ceedling/test_invoker/test_build_planner.rb +13 -19
- data/lib/ceedling/test_invoker/test_build_setup.rb +26 -6
- data/lib/ceedling/test_invoker/test_build_validations.rb +23 -20
- data/lib/ceedling/test_invoker/test_derived_search_paths.rb +189 -0
- data/lib/ceedling/test_invoker/test_file_preprocessinator.rb +1 -2
- data/lib/ceedling/test_invoker/test_includes_reconcilinator.rb +1 -1
- data/lib/ceedling/test_invoker/test_invoker_types.rb +28 -20
- data/lib/ceedling/test_invoker/test_pipeline_helpers.rb +5 -3
- data/lib/ceedling/test_invoker/test_pipeline_manager.rb +25 -8
- data/lib/ceedling/test_invoker/test_runner_generatinator.rb +31 -3
- data/lib/ceedling/test_invoker/test_search_paths.rb +30 -8
- data/lib/ceedling/test_invoker/test_substitutions.rb +72 -0
- data/lib/ceedling/tools/shell_quoting.rb +45 -0
- data/lib/ceedling/tools/tool_quoting.rb +79 -0
- data/lib/ceedling/{tool_validator.rb → tools/tool_validator.rb} +18 -7
- data/lib/version.rb +1 -1
- data/plugins/bullseye/bullseye.rake +1 -3
- data/plugins/bullseye/lib/bullseye.rb +15 -2
- data/plugins/command_hooks/lib/command_hooks.rb +1 -1
- data/plugins/fff/lib/fff.rb +42 -15
- data/plugins/fff/lib/fff_mock_generator.rb +12 -9
- data/plugins/fff/spec/fff_cmock_wrapper_spec.rb +134 -0
- data/plugins/fff/spec/fff_mock_header_generator_spec.rb +9 -0
- data/plugins/fff/spec/fff_mock_source_generator_spec.rb +20 -0
- data/plugins/gcov/lib/console_reportinator.rb +25 -19
- data/plugins/gcov/lib/reportgenerator_reportinator.rb +2 -1
- data/site-local/404.html +2 -2
- data/site-local/assets/javascripts/{bundle.c21346df.min.js → bundle.a5f9d56c.min.js} +1 -1
- data/site-local/assets/javascripts/{bundle.c21346df.min.js.map → bundle.a5f9d56c.min.js.map} +2 -2
- data/site-local/configuration/environment-vars.html +2 -2
- data/site-local/configuration/global-collections.html +3 -3
- data/site-local/configuration/index.html +2 -2
- data/site-local/configuration/loading.html +2 -2
- data/site-local/configuration/mixins.html +2 -2
- data/site-local/configuration/parallel-builds.html +2 -2
- data/site-local/configuration/project-file.html +2 -2
- data/site-local/configuration/reference/cexception.html +2 -2
- data/site-local/configuration/reference/cmock.html +5 -2
- data/site-local/configuration/reference/defines.html +2 -2
- data/site-local/configuration/reference/environment.html +2 -2
- data/site-local/configuration/reference/extension.html +2 -2
- data/site-local/configuration/reference/files.html +56 -9
- data/site-local/configuration/reference/flags.html +2 -2
- data/site-local/configuration/reference/index.html +2 -2
- data/site-local/configuration/reference/libraries.html +2 -2
- data/site-local/configuration/reference/mixins.html +2 -2
- data/site-local/configuration/reference/partials.html +84 -2
- data/site-local/configuration/reference/paths.html +7 -2
- data/site-local/configuration/reference/plugins.html +2 -2
- data/site-local/configuration/reference/project.html +247 -5
- data/site-local/configuration/reference/release-build.html +2 -2
- data/site-local/configuration/reference/test-build.html +2 -2
- data/site-local/configuration/reference/test-runner.html +2 -2
- data/site-local/configuration/reference/tools.html +49 -4
- data/site-local/configuration/reference/unity.html +2 -2
- data/site-local/configuration/which-ceedling.html +2 -2
- data/site-local/development/index.html +2 -2
- data/site-local/development/plugins/configuration.html +2 -2
- data/site-local/development/plugins/index.html +2 -2
- data/site-local/development/plugins/plugin-subclass.html +5 -4
- data/site-local/development/plugins/rake-tasks.html +2 -2
- data/site-local/development/releases.html +2 -2
- data/site-local/development/workflow.html +2 -2
- data/site-local/getting-started/builds.html +2 -2
- data/site-local/getting-started/command-line.html +2 -2
- data/site-local/getting-started/example-projects/cipher-quest.html +2 -2
- data/site-local/getting-started/example-projects/index.html +2 -2
- data/site-local/getting-started/example-projects/temp-sensor.html +2 -2
- data/site-local/getting-started/example-projects/wondrous-forest.html +10 -2
- data/site-local/getting-started/index.html +2 -2
- data/site-local/getting-started/installation.html +2 -2
- data/site-local/getting-started/quick-start.html +2 -2
- data/site-local/help.html +2 -2
- data/site-local/index.html +2 -2
- data/site-local/overview/build-system.html +2 -2
- data/site-local/overview/index.html +2 -2
- data/site-local/overview/test-environments.html +2 -2
- data/site-local/overview/tools-and-frameworks.html +2 -2
- data/site-local/plugins/beep.html +2 -2
- data/site-local/plugins/bullseye/index.html +45 -38
- data/site-local/plugins/bullseye/licensing.html +2 -2
- data/site-local/plugins/command-hooks.html +4 -4
- data/site-local/plugins/compile-commands-json-db.html +2 -2
- data/site-local/plugins/cppcheck.html +2 -2
- data/site-local/plugins/dependencies.html +2 -2
- data/site-local/plugins/fff.html +16 -2
- data/site-local/plugins/gcov/examples.html +2 -2
- data/site-local/plugins/gcov/gcovr.html +8 -2
- data/site-local/plugins/gcov/index.html +2 -2
- data/site-local/plugins/gcov/overview.html +2 -2
- data/site-local/plugins/gcov/reportgenerator.html +18 -14
- data/site-local/plugins/gcov/reporting.html +2 -2
- data/site-local/plugins/gcov/setup.html +2 -2
- data/site-local/plugins/gcov/tool-versions.html +2 -2
- data/site-local/plugins/gcov/troubleshooting.html +2 -2
- data/site-local/plugins/index.html +2 -2
- data/site-local/plugins/module-generator.html +2 -2
- data/site-local/plugins/report-build-warnings-log.html +2 -2
- data/site-local/plugins/report-tests-gtestlike-stdout.html +2 -2
- data/site-local/plugins/report-tests-ide-stdout.html +2 -2
- data/site-local/plugins/report-tests-log-factory.html +2 -2
- data/site-local/plugins/report-tests-pretty-stdout.html +2 -2
- data/site-local/plugins/report-tests-raw-output-log.html +2 -2
- data/site-local/plugins/report-tests-teamcity-stdout.html +2 -2
- data/site-local/plugins/sanitize.html +2 -2
- data/site-local/plugins/valgrind.html +2 -2
- data/site-local/project/index.html +2 -2
- data/site-local/project/release-history.html +2 -2
- data/site-local/project/sbom.html +2 -2
- data/site-local/project/upgrade.html +2 -2
- data/site-local/reference/build-directives.html +2 -2
- data/site-local/reference/command-line.html +2 -2
- data/site-local/reference/environment-vars.html +2 -2
- data/site-local/reference/gcov-plugin.html +2 -2
- data/site-local/reference/global-collections.html +12 -12
- data/site-local/reference/index.html +2 -2
- data/site-local/reference/partials-macros.html +47 -2
- data/site-local/reference/project-configuration.html +2 -2
- data/site-local/sitemap.xml.gz +0 -0
- data/site-local/snapshot/examples/cipher_quest/index.html +2 -2
- data/site-local/snapshot/examples/temp_sensor/index.html +2 -2
- data/site-local/snapshot/examples/wondrous_forest/index.html +72 -15
- data/site-local/testing-guide/build-directives.html +2 -2
- data/site-local/testing-guide/conventions.html +67 -22
- data/site-local/testing-guide/frameworks.html +2 -2
- data/site-local/testing-guide/index.html +2 -2
- data/site-local/testing-guide/partials/configuration.html +31 -4
- data/site-local/testing-guide/partials/conventions.html +509 -8
- data/site-local/testing-guide/partials/directives.html +4 -3
- data/site-local/testing-guide/partials/example.html +2 -2
- data/site-local/testing-guide/partials/index.html +2 -2
- data/site-local/testing-guide/partials/overview.html +30 -12
- data/site-local/testing-guide/partials/variables.html +169 -4
- data/site-local/testing-guide/test-cases.html +2 -2
- data/site-local/testing-guide/test-sample.html +2 -2
- data/site-local/testing-guide/test-suite-anatomy.html +2 -2
- data/spec/integration/build_step_doctor_spec.rb +270 -0
- data/spec/integration/c_extractor_composition_spec.rb +254 -4
- data/spec/integration/includes_extraction_spec.rb +27 -14
- data/spec/integration/nested_test_artifacts_spec.rb +1 -1
- data/spec/integration/partial_files_preprocessing_spec.rb +128 -0
- data/spec/integration/partials_carry_spec.rb +520 -0
- data/spec/integration/partials_declarations_spec.rb +655 -0
- data/spec/integration/partials_fallback_preprocessing_spec.rb +65 -0
- data/spec/integration/partials_function_pointers_spec.rb +277 -0
- data/spec/integration/partials_header_composition_spec.rb +268 -35
- data/spec/integration/partials_macro_decorators_spec.rb +267 -0
- data/spec/integration/partials_module_resolution_spec.rb +26 -19
- data/spec/integration/partials_symbol_linkage_spec.rb +13 -0
- data/spec/integration/path_length_reporting_spec.rb +64 -0
- data/spec/integration/path_scenarios_spec.rb +80 -3
- data/spec/integration/quote_include_isolator_spec.rb +56 -0
- data/spec/integration/test_build_parallel_barrier_spec.rb +1 -1
- data/spec/integration/test_includes_extractinator_spec.rb +70 -5
- data/spec/integration/test_naming_spec.rb +6 -3
- data/spec/integration/test_source_file_checks_spec.rb +5 -3
- data/spec/integration/tool_executor_spec.rb +1 -1
- data/spec/integration/tool_validator_spec.rb +2 -2
- data/spec/integration/win_long_paths_probe_spec.rb +46 -0
- data/spec/integration/win_path_limit_spec.rb +53 -0
- data/spec/integration/windows_registry_query_tool_spec.rb +41 -0
- data/spec/support/integration/configurator_integration_helper.rb +8 -3
- data/spec/support/integration/partial_files_harness.rb +181 -0
- data/spec/support/integration/partials_generation_integration_helper.rb +237 -141
- data/spec/support/integration/path_scenario_harness.rb +4 -2
- data/spec/support/integration/spec_integration_helper.rb +8 -3
- data/spec/support/integration/test_includes_harness.rb +56 -35
- data/spec/support/integration/tool_executor_integration_helper.rb +14 -2
- data/spec/system/bullseye_deployment_spec.rb +2 -0
- data/spec/system/delta_builds_spec.rb +26 -12
- data/spec/system/encoding_stress_spec.rb +4 -4
- data/spec/system/example_wondrous_forest_spec.rb +2 -2
- data/spec/system/gcov_deployment_spec.rb +2 -0
- data/spec/system/header_include_path_validation_spec.rb +4 -4
- data/spec/system/header_search_paths_spec.rb +1083 -0
- data/spec/system/mock_include_folders_spec.rb +121 -0
- data/spec/system/mockable_header_reassembly_spec.rb +184 -0
- data/spec/system/partials_carry_spec.rb +581 -0
- data/spec/system/partials_delta_builds_spec.rb +280 -0
- data/spec/system/partials_function_pointers_spec.rb +106 -0
- data/spec/system/partials_macro_decorators_spec.rb +127 -0
- data/spec/system/partials_module_disambiguation_spec.rb +125 -0
- data/spec/system/path_handling_probes_spec.rb +16 -12
- data/spec/system/pinned_thread_count_spec.rb +4 -4
- data/spec/system/preprocessing_fallback_conditionals_spec.rb +1 -1
- data/spec/system/short_build_paths_spec.rb +87 -0
- data/spec/system/sibling_header_collision_spec.rb +30 -6
- data/spec/system/support/bullseye_common_test_cases.rb +42 -0
- data/spec/system/support/common_test_cases.rb +2 -2
- data/spec/system/support/gcov_partials_test_cases.rb +48 -0
- data/spec/system/test_build_layout_spec.rb +209 -0
- data/spec/system/test_source_file_directive_spec.rb +35 -5
- data/spec/units/c_extractor/c_extractor_code_text_spec.rb +67 -10
- data/spec/units/c_extractor/c_extractor_declarations_spec.rb +501 -4
- data/spec/units/c_extractor/c_extractor_declarator_spec.rb +245 -0
- data/spec/units/c_extractor/c_extractor_defined_type_spec.rb +45 -0
- data/spec/units/c_extractor/c_extractor_definitions_spec.rb +163 -3
- data/spec/units/c_extractor/c_extractor_functions_spec.rb +462 -21
- data/spec/units/c_extractor/c_extractor_preprocessing_spec.rb +39 -0
- data/spec/units/c_extractor/c_extractor_spec.rb +4 -4
- data/spec/units/c_extractor/c_extractor_types_spec.rb +163 -0
- data/spec/units/c_identifier_spec.rb +35 -0
- data/spec/units/config/configurator_builder_spec.rb +24 -0
- data/spec/units/config/configurator_setup_spec.rb +72 -4
- data/spec/units/config/configurator_spec.rb +27 -1
- data/spec/units/dependencies/dependency_cache_store_spec.rb +68 -3
- data/spec/units/dependencies/dependency_tracker_spec.rb +25 -0
- data/spec/units/dependencies/dependinator_spec.rb +17 -2
- data/spec/units/diagnostics/build_step_doctor_spec.rb +170 -0
- data/spec/units/diagnostics/duplicate_symbol_specialist_spec.rb +117 -0
- data/spec/units/diagnostics/header_collision_specialist_spec.rb +267 -0
- data/spec/units/diagnostics/include_depth_specialist_spec.rb +137 -0
- data/spec/units/diagnostics/missing_symbol_specialist_spec.rb +154 -0
- data/spec/units/diagnostics/partial_name_specialist_spec.rb +129 -0
- data/spec/units/diagnostics/toolchain_output_spec.rb +86 -0
- data/spec/units/encodinator_spec.rb +3 -4
- data/spec/units/filesystem/build_roots_spec.rb +131 -0
- data/spec/units/filesystem/build_subpath_spec.rb +113 -0
- data/spec/units/filesystem/file_finder_helper_spec.rb +80 -0
- data/spec/units/filesystem/file_finder_spec.rb +242 -58
- data/spec/units/filesystem/file_path_utils_spec.rb +251 -118
- data/spec/units/filesystem/file_wrapper_spec.rb +191 -6
- data/spec/units/filesystem/path_matcher_spec.rb +36 -0
- data/spec/units/filesystem/test_build_layout_spec.rb +216 -0
- data/spec/units/filesystem/win_long_paths_spec.rb +204 -0
- data/spec/units/filesystem/win_path_prober_spec.rb +158 -0
- data/spec/units/generators/generator_helper_spec.rb +0 -60
- data/spec/units/generators/generator_mocks_spec.rb +13 -0
- data/spec/units/generators/generator_partials_spec.rb +656 -55
- data/spec/units/generators/generator_spec.rb +26 -0
- data/spec/units/generators/generator_test_runner_spec.rb +9 -5
- data/spec/units/generators/partial_source_writer_spec.rb +129 -0
- data/spec/units/includes/header_search_spec.rb +406 -0
- data/spec/units/includes/include_factory_spec.rb +22 -5
- data/spec/units/includes/include_pathinator_spec.rb +77 -13
- data/spec/units/includes/include_spec.rb +14 -0
- data/spec/units/includes/includes_spec.rb +176 -19
- data/spec/units/loginator_spec.rb +31 -0
- data/spec/units/mock_locator_spec.rb +199 -5
- data/spec/units/partials/include_groups_spec.rb +42 -0
- data/spec/units/partials/partializer_config_spec.rb +25 -0
- data/spec/units/partials/partializer_helper_carry_spec.rb +661 -0
- data/spec/units/partials/partializer_helper_interface_extras_spec.rb +396 -0
- data/spec/units/partials/partializer_helper_spec.rb +529 -277
- data/spec/units/partials/partializer_reconciler_spec.rb +661 -0
- data/spec/units/partials/partializer_spec.rb +1578 -270
- data/spec/units/partials/partializer_utils_spec.rb +269 -232
- data/spec/units/partials/partials_rename_spec.rb +160 -0
- data/spec/units/partials_manager_spec.rb +554 -261
- data/spec/units/plugins/bullseye_spec.rb +34 -0
- data/spec/units/plugins/console_reportinator_spec.rb +58 -9
- data/spec/units/plugins/report_tests_teamcity_stdout_spec.rb +1 -1
- data/spec/units/plugins/reportgenerator_reportinator_spec.rb +51 -3
- data/spec/units/preprocess/preprocessinator_code_finder_spec.rb +73 -10
- data/spec/units/preprocess/preprocessinator_file_assembler_spec.rb +125 -37
- data/spec/units/preprocess/preprocessinator_includes_handler_spec.rb +15 -0
- data/spec/units/preprocess/preprocessinator_reconstructor_spec.rb +197 -0
- data/spec/units/preprocess/preprocessinator_spec.rb +153 -95
- data/spec/units/setupinator_spec.rb +51 -0
- data/spec/units/standin_headerinator_spec.rb +27 -11
- data/spec/units/test_build_executor_spec.rb +780 -166
- data/spec/units/test_build_planner_spec.rb +116 -28
- data/spec/units/test_build_setup_spec.rb +83 -18
- data/spec/units/test_context_extractor_spec.rb +11 -2
- data/spec/units/test_derived_search_paths_spec.rb +259 -0
- data/spec/units/test_includes_extractinator_spec.rb +56 -8
- data/spec/units/test_invoker/objects_wiring_spec.rb +20 -3
- data/spec/units/test_invoker/partial_files_preprocessinator_spec.rb +264 -0
- data/spec/units/test_invoker/test_substitutions_spec.rb +122 -0
- data/spec/units/test_invoker_types_spec.rb +8 -7
- data/spec/units/test_pipeline_manager_spec.rb +54 -13
- data/spec/units/test_runner_generatinator_spec.rb +93 -1
- data/spec/units/test_search_paths_spec.rb +73 -5
- data/spec/units/{default_tools_quoting_spec.rb → tools/default_tools_quoting_spec.rb} +39 -5
- data/spec/units/tools/shell_quoting_spec.rb +76 -0
- data/spec/units/{tool_executor_helper_spec.rb → tools/tool_executor_helper_spec.rb} +1 -1
- data/spec/units/{tool_executor_spec.rb → tools/tool_executor_spec.rb} +1 -1
- data/spec/units/{tool_validator_spec.rb → tools/tool_validator_spec.rb} +110 -1
- data/spec/units/windows_registry_query_tool_spec.rb +53 -0
- metadata +161 -16
- /data/lib/ceedling/{tool_executor.rb → tools/tool_executor.rb} +0 -0
- /data/lib/ceedling/{tool_executor_helper.rb → tools/tool_executor_helper.rb} +0 -0
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
# =========================================================================
|
|
7
7
|
|
|
8
8
|
require 'ceedling/constants'
|
|
9
|
+
require 'ceedling/includes/includes'
|
|
9
10
|
require 'ceedling/test_invoker/test_pipeline_helpers'
|
|
10
11
|
|
|
11
12
|
# Stages 12 and 13: each test's Unity runner. Stage 12 parses test case names from the
|
|
@@ -32,7 +33,8 @@ class TestRunnerGeneratinator
|
|
|
32
33
|
:batchinator,
|
|
33
34
|
:generator,
|
|
34
35
|
:test_context_extractor,
|
|
35
|
-
:dependinator
|
|
36
|
+
:dependinator,
|
|
37
|
+
:mock_locator
|
|
36
38
|
)
|
|
37
39
|
|
|
38
40
|
def setup()
|
|
@@ -80,7 +82,7 @@ class TestRunnerGeneratinator
|
|
|
80
82
|
@generator.generate_test_runner(
|
|
81
83
|
context: state.context,
|
|
82
84
|
mocks: @context_extractor.lookup_mock_header_includes_list( testable.filepath ),
|
|
83
|
-
includes:
|
|
85
|
+
includes: runner_includes( testable ),
|
|
84
86
|
test_filepath: testable.filepath,
|
|
85
87
|
input_filepath: testable.runner.input_filepath,
|
|
86
88
|
runner_filepath: testable.runner.output_filepath
|
|
@@ -98,8 +100,34 @@ class TestRunnerGeneratinator
|
|
|
98
100
|
unity: @configurator.get_unity_config,
|
|
99
101
|
test_preprocessor_tests: @configurator.project_use_test_preprocessor_tests,
|
|
100
102
|
mocks: @context_extractor.lookup_mock_header_includes_list( testable.filepath ).map( &:filepath ),
|
|
101
|
-
includes:
|
|
103
|
+
includes: runner_includes( testable ).map { |include| include.include_path || include.filepath }
|
|
102
104
|
}
|
|
103
105
|
end
|
|
104
106
|
|
|
107
|
+
# The test's #includes as its runner writes them. A user #include is spelled as the text
|
|
108
|
+
# through which the test's search paths find its header first, its filename whenever that
|
|
109
|
+
# does, so the runner includes the header the test does (see Include#spelled_by). One whose
|
|
110
|
+
# header no search path reaches, whether preprocessing entered it or it sits beside the test,
|
|
111
|
+
# is spelled by that header's absolute path, unless the header is in the build root. One whose
|
|
112
|
+
# header isn't found keeps its filename. Both stages' staleness checks and the runner itself
|
|
113
|
+
# ask, and each test's list is settled by then, so it is spelled once.
|
|
114
|
+
def runner_includes(testable)
|
|
115
|
+
return testable.runner.includes ||= spelled_includes( testable )
|
|
116
|
+
end
|
|
117
|
+
|
|
118
|
+
# A preprocessed test's #includes hold the paths the compiler found their headers by. Without
|
|
119
|
+
# test preprocessing they are as written, beside the test file first.
|
|
120
|
+
def spelled_includes(testable)
|
|
121
|
+
search = @mock_locator.header_search( testable )
|
|
122
|
+
resolved = @configurator.project_use_test_preprocessor_tests
|
|
123
|
+
from = File.dirname( testable.filepath )
|
|
124
|
+
|
|
125
|
+
return @context_extractor.lookup_nonmock_header_includes_list( testable.filepath ).map do |include|
|
|
126
|
+
next include if include.is_a?( SystemInclude )
|
|
127
|
+
|
|
128
|
+
spelled = include.spelled_by( search, from: from, resolved: resolved )
|
|
129
|
+
spelled.equal?( include ) ? UserInclude.new( include.filepath ) : UserInclude.new( include.filepath, include_path: spelled.include_path )
|
|
130
|
+
end
|
|
131
|
+
end
|
|
132
|
+
|
|
105
133
|
end
|
|
@@ -7,21 +7,37 @@
|
|
|
7
7
|
|
|
8
8
|
# A test's compiler search paths, in the order the compiler searches them. Generated
|
|
9
9
|
# directories come first, so a test's mocks and Partials shadow the real headers they
|
|
10
|
-
# stand in for, then TEST_INCLUDE_PATH() entries, then the project's configured paths
|
|
10
|
+
# stand in for, then TEST_INCLUDE_PATH() entries, then the project's configured paths,
|
|
11
|
+
# then the directories the test's #includes imply for headers no search path lists.
|
|
11
12
|
class TestSearchPaths
|
|
12
13
|
|
|
13
14
|
constructor :configurator, :include_pathinator, :test_context_extractor
|
|
14
15
|
|
|
15
|
-
# `
|
|
16
|
-
#
|
|
17
|
-
def compose(
|
|
18
|
-
|
|
16
|
+
# `mock_search_paths` are the test's mocks' mirrored directories, which sit right after
|
|
17
|
+
# the flat mock root. They default to the Testable's own.
|
|
18
|
+
def compose(testable, mock_search_paths = testable.mock_search_paths)
|
|
19
|
+
filepath = testable.filepath
|
|
20
|
+
return (generated_paths( filepath, testable.paths, mock_search_paths ) + configured_paths( filepath ) + testable.derived_search_paths).uniq
|
|
21
|
+
end
|
|
22
|
+
|
|
23
|
+
# The paths a test's real headers are found through: its search paths without the
|
|
24
|
+
# directories its mocks and Partials are generated in
|
|
25
|
+
def header_paths(testable)
|
|
26
|
+
return (configured_paths( testable.filepath ) + testable.derived_search_paths).uniq
|
|
27
|
+
end
|
|
28
|
+
|
|
29
|
+
# The paths mock preprocessing reads a mocked header through: the header paths with the test's
|
|
30
|
+
# Partial directories ahead of them, as `compose` orders them. Partials are generated before mocks
|
|
31
|
+
# are preprocessed, so they are current then. The mock directories hold CMock's copies of headers,
|
|
32
|
+
# which mock generation brings up to date only afterward, so they are left out.
|
|
33
|
+
def mock_preprocess_paths(testable)
|
|
34
|
+
return (partial_paths( testable.filepath, testable.paths ) + header_paths( testable )).uniq
|
|
19
35
|
end
|
|
20
36
|
|
|
21
37
|
# Sets a test's mock search paths and composes its search paths around them. `lock`
|
|
22
38
|
# guards the write, since other threads read the Testable.
|
|
23
39
|
def assign_mock_search_paths(testable, mock_search_paths, lock)
|
|
24
|
-
paths = compose( testable
|
|
40
|
+
paths = compose( testable, mock_search_paths )
|
|
25
41
|
lock.synchronize do
|
|
26
42
|
testable.mock_search_paths = mock_search_paths
|
|
27
43
|
testable.search_paths = paths
|
|
@@ -35,8 +51,14 @@ class TestSearchPaths
|
|
|
35
51
|
_paths = []
|
|
36
52
|
_paths << paths[:mocks] if paths[:mocks]
|
|
37
53
|
_paths += mock_search_paths
|
|
38
|
-
_paths
|
|
39
|
-
|
|
54
|
+
return _paths + partial_paths( filepath, paths )
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
# The Partials root, then each Partialized module's own directory below it
|
|
58
|
+
def partial_paths(filepath, paths)
|
|
59
|
+
return [] unless paths[:partials]
|
|
60
|
+
|
|
61
|
+
return [paths[:partials]] + partial_search_paths( filepath, paths )
|
|
40
62
|
end
|
|
41
63
|
|
|
42
64
|
# TEST_INCLUDE_PATH() entries, then the project's configured paths
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
# =========================================================================
|
|
2
|
+
# Ceedling - Test-Centered Build System for C
|
|
3
|
+
# ThrowTheSwitch.org
|
|
4
|
+
# Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
|
|
5
|
+
# SPDX-License-Identifier: MIT
|
|
6
|
+
# =========================================================================
|
|
7
|
+
|
|
8
|
+
require 'ceedling/constants'
|
|
9
|
+
|
|
10
|
+
# Knows which real headers a test substitutes and where Ceedling's own content lives.
|
|
11
|
+
#
|
|
12
|
+
# Sibling-header isolation and the build step doctor's collision diagnoses both weigh a
|
|
13
|
+
# test's reachable headers against these answers (see HEADER_COLLISIONS.md). The class
|
|
14
|
+
# keeps no state, so one instance serves every thread.
|
|
15
|
+
class TestSubstitutions
|
|
16
|
+
|
|
17
|
+
constructor :configurator
|
|
18
|
+
|
|
19
|
+
# `{ basename => real path }` for every real header this test substitutes: each
|
|
20
|
+
# CMock mock of a real header, and each Partialized module's header. A mock Partial's
|
|
21
|
+
# `source` is its generated interface header, not a project header, so it is left out.
|
|
22
|
+
def real_headers(testable)
|
|
23
|
+
return mocked_headers( testable ).merge( partialized_headers( testable ) )
|
|
24
|
+
end
|
|
25
|
+
|
|
26
|
+
# `{ basename => real path }` for every mocked header CMock also writes under its own
|
|
27
|
+
# name. With `:treat_inlines: :include`, CMock writes an inline-stripped copy of each real
|
|
28
|
+
# header it mocks into the mocks directory, ahead of the real header on the search path.
|
|
29
|
+
# These are the only headers a quoted #include can reach in place of the real one.
|
|
30
|
+
def shadowed_headers(testable)
|
|
31
|
+
return {} unless @configurator.project_use_mocks
|
|
32
|
+
return {} unless @configurator.cmock_treat_inlines == :include
|
|
33
|
+
|
|
34
|
+
return mocked_headers( testable )
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
# Whether `real_path` is a header this test Partializes, rather than mocks
|
|
38
|
+
def partialized?(testable, real_path)
|
|
39
|
+
return partialized_headers( testable ).value?( real_path )
|
|
40
|
+
end
|
|
41
|
+
|
|
42
|
+
# Directory roots holding only Ceedling's generated or vendored content for this test.
|
|
43
|
+
# Several files routinely share each one, such as a Partial's types, interface, and
|
|
44
|
+
# implementation headers, so sharing a directory there is no quote-include risk.
|
|
45
|
+
def generated_dirs(testable)
|
|
46
|
+
return [
|
|
47
|
+
testable.paths[:mocks],
|
|
48
|
+
testable.paths[:partials],
|
|
49
|
+
PROJECT_BUILD_VENDOR_UNITY_PATH,
|
|
50
|
+
PROJECT_BUILD_VENDOR_CMOCK_PATH,
|
|
51
|
+
PROJECT_BUILD_VENDOR_CEXCEPTION_PATH,
|
|
52
|
+
@configurator.project_build_vendor_ceedling_path
|
|
53
|
+
].compact
|
|
54
|
+
end
|
|
55
|
+
|
|
56
|
+
### Private ###
|
|
57
|
+
|
|
58
|
+
private
|
|
59
|
+
|
|
60
|
+
def mocked_headers(testable)
|
|
61
|
+
sources = (testable.mocks || {}).each_value.reject( &:partial ).filter_map( &:source )
|
|
62
|
+
return by_basename( sources )
|
|
63
|
+
end
|
|
64
|
+
|
|
65
|
+
def partialized_headers(testable)
|
|
66
|
+
return by_basename( testable.partials.configs.each_value.filter_map { |config| config.header.filepath } )
|
|
67
|
+
end
|
|
68
|
+
|
|
69
|
+
def by_basename(filepaths)
|
|
70
|
+
return filepaths.to_h { |filepath| [File.basename( filepath ), filepath] }
|
|
71
|
+
end
|
|
72
|
+
end
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# =========================================================================
|
|
2
|
+
# Ceedling - Test-Centered Build System for C
|
|
3
|
+
# ThrowTheSwitch.org
|
|
4
|
+
# Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
|
|
5
|
+
# SPDX-License-Identifier: MIT
|
|
6
|
+
# =========================================================================
|
|
7
|
+
|
|
8
|
+
require 'ceedling/constants'
|
|
9
|
+
|
|
10
|
+
# Reads the quoting in one piece of a command line as the shell running it will.
|
|
11
|
+
#
|
|
12
|
+
# A tool's command reaches the shell as one string, so a quote one piece leaves open pairs
|
|
13
|
+
# with a quote in a later piece and the command's words shift. A typographic quote looks
|
|
14
|
+
# like a quote but is an ordinary character to every shell.
|
|
15
|
+
module ShellQuoting
|
|
16
|
+
|
|
17
|
+
TYPOGRAPHIC = %w[“ ” „ ‟ ‘ ’ ‚ ‛ « » ‹ ›].freeze
|
|
18
|
+
|
|
19
|
+
# Each alternative consumes one escaped character or one closed span, in that order, so a
|
|
20
|
+
# quote matched alone is one that never closes. A backslash escapes the character after
|
|
21
|
+
# it, except inside single quotes.
|
|
22
|
+
SPANS = /\\.|"(?:\\.|[^"\\])*"|'[^']*'|["']/m
|
|
23
|
+
|
|
24
|
+
# cmd.exe treats a single quote as an ordinary character
|
|
25
|
+
WINDOWS_SPANS = /\\.|"(?:\\.|[^"\\])*"|"/m
|
|
26
|
+
|
|
27
|
+
# The quote character `text` leaves open, or nil when every quote closes
|
|
28
|
+
def self.unclosed(text, windows:)
|
|
29
|
+
return scannable( text ).scan( windows ? WINDOWS_SPANS : SPANS ).find { |span| span == '"' or span == "'" }
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# The distinct typographic quotes in `text`, in the order they first appear
|
|
33
|
+
def self.typographic(text)
|
|
34
|
+
return scannable( text ).each_char.select { |char| TYPOGRAPHIC.include?( char ) }.uniq
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
# `text` with invalid bytes replaced and everything from its first Ruby expansion through
|
|
38
|
+
# its last removed, since an expansion's own quotes are Ruby's, not the shell's. A quote
|
|
39
|
+
# between two expansions goes unread, so a mistake there is missed rather than invented.
|
|
40
|
+
def self.scannable(text)
|
|
41
|
+
return text.scrub.gsub( PATTERNS::RUBY_STRING_REPLACEMENT, '' )
|
|
42
|
+
end
|
|
43
|
+
private_class_method :scannable
|
|
44
|
+
|
|
45
|
+
end
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
# =========================================================================
|
|
2
|
+
# Ceedling - Test-Centered Build System for C
|
|
3
|
+
# ThrowTheSwitch.org
|
|
4
|
+
# Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
|
|
5
|
+
# SPDX-License-Identifier: MIT
|
|
6
|
+
# =========================================================================
|
|
7
|
+
|
|
8
|
+
require 'ceedling/tools/shell_quoting'
|
|
9
|
+
|
|
10
|
+
# Finds the quoting problems in a tool definition, one entry at a time.
|
|
11
|
+
#
|
|
12
|
+
# Each entry that reaches the shell must close its own quotes, since a quote left open pairs
|
|
13
|
+
# with one in a later entry. A typographic quote is only a warning, since it may be meant
|
|
14
|
+
# literally, as in a string a define holds.
|
|
15
|
+
module ToolQuoting
|
|
16
|
+
|
|
17
|
+
# `error` is false for a warning
|
|
18
|
+
Finding = Struct.new( :field, :message, :error, keyword_init: true ) do
|
|
19
|
+
# An executable whose quote is unclosed names no file that can be looked for
|
|
20
|
+
def unclosed_executable?
|
|
21
|
+
return (error and field == :executable)
|
|
22
|
+
end
|
|
23
|
+
end
|
|
24
|
+
|
|
25
|
+
# The findings for `tool`'s :executable and arguments, in order
|
|
26
|
+
def self.findings(tool, name:, windows:)
|
|
27
|
+
return entries( tool ).filter_map { |field, text| finding( name, field, text, windows ) }
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
# Each [field, text] pair the command line is built from
|
|
31
|
+
def self.entries(tool)
|
|
32
|
+
arguments = [tool[:arguments]].flatten.flat_map { |element| expanded( element ) }
|
|
33
|
+
entries = [[:executable, tool[:executable]]] + arguments.map { |argument| [:arguments, argument] }
|
|
34
|
+
|
|
35
|
+
return entries.select { |_, text| text.is_a?( String ) }
|
|
36
|
+
end
|
|
37
|
+
|
|
38
|
+
# The text one argument contributes, as ToolExecutor expands it. A string is itself the
|
|
39
|
+
# text. A hash contributes its first key, the substitution string, and each string among
|
|
40
|
+
# that key's values. Anything else adds nothing to the command line.
|
|
41
|
+
def self.expanded(element)
|
|
42
|
+
return [element] if element.is_a?( String )
|
|
43
|
+
return [] unless element.is_a?( Hash ) and element.any?
|
|
44
|
+
|
|
45
|
+
substitution, values = element.first
|
|
46
|
+
return [substitution.to_s, *[values].flatten.grep( String )]
|
|
47
|
+
end
|
|
48
|
+
|
|
49
|
+
def self.finding(name, field, text, windows)
|
|
50
|
+
location = "#{name} ↳ :#{field} ➡️ `#{text}`"
|
|
51
|
+
quote = ShellQuoting.unclosed( text, windows: windows )
|
|
52
|
+
typographic = ShellQuoting.typographic( text )
|
|
53
|
+
|
|
54
|
+
return unclosed( location, field, quote, typographic ) if quote
|
|
55
|
+
return nil if typographic.empty?
|
|
56
|
+
|
|
57
|
+
message = "#{location} holds #{phrase( typographic )} Use \" or ' unless the characters are meant literally."
|
|
58
|
+
return Finding.new( field: field, message: message, error: false )
|
|
59
|
+
end
|
|
60
|
+
|
|
61
|
+
# An unclosed quote's error names any typographic quote as its likely cause
|
|
62
|
+
def self.unclosed(location, field, quote, typographic)
|
|
63
|
+
subject = (field == :executable) ? 'executable' : 'argument'
|
|
64
|
+
message = "#{location} leaves a #{quote} quote unclosed. Enclose the #{subject} with #{quote} quotes."
|
|
65
|
+
message += " It holds #{phrase( typographic )} Replace it with #{quote}." if typographic.any?
|
|
66
|
+
|
|
67
|
+
return Finding.new( field: field, message: message, error: true )
|
|
68
|
+
end
|
|
69
|
+
|
|
70
|
+
# The typographic quotes found, and what a shell makes of them
|
|
71
|
+
def self.phrase(typographic)
|
|
72
|
+
return "#{typographic.first}, a typographic quote that a shell treats as an ordinary character." if typographic.one?
|
|
73
|
+
|
|
74
|
+
return "#{typographic.join( ' ' )}, typographic quotes that a shell treats as ordinary characters."
|
|
75
|
+
end
|
|
76
|
+
|
|
77
|
+
private_class_method :entries, :expanded, :finding, :unclosed, :phrase
|
|
78
|
+
|
|
79
|
+
end
|
|
@@ -9,13 +9,15 @@ require 'rake' # For ext()
|
|
|
9
9
|
require 'ceedling/constants'
|
|
10
10
|
require 'ceedling/filename_extension'
|
|
11
11
|
require 'ceedling/exceptions'
|
|
12
|
+
require 'ceedling/tools/tool_quoting'
|
|
12
13
|
|
|
13
14
|
# Confirms a tool's configuration can run before a build depends on it.
|
|
14
15
|
#
|
|
15
|
-
# A tool is valid when its executable
|
|
16
|
-
#
|
|
17
|
-
#
|
|
18
|
-
#
|
|
16
|
+
# A tool is valid when its executable and each argument close the quotes they open, its
|
|
17
|
+
# executable can be found and its stderr redirect is a known option. The executable is an
|
|
18
|
+
# explicit path or a bare name searched on PATH, and either may omit the extension its file
|
|
19
|
+
# carries on disk. An executable built at run time, from an argument or a Ruby expansion,
|
|
20
|
+
# is left for the shell to resolve.
|
|
19
21
|
class ToolValidator
|
|
20
22
|
|
|
21
23
|
constructor :file_wrapper, :loginator, :system_wrapper, :ruby_expandinator
|
|
@@ -63,9 +65,11 @@ class ToolValidator
|
|
|
63
65
|
name = tool[:name] if name.nil? or name.empty?
|
|
64
66
|
extension ||= default_extension()
|
|
65
67
|
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
68
|
+
# Every check runs, so a tool with several problems reports each. An executable whose
|
|
69
|
+
# quote is unclosed can't be found, and saying so would only repeat the quoting error.
|
|
70
|
+
findings = ToolQuoting.findings( tool, name:name, windows:@system_wrapper.windows? )
|
|
71
|
+
valid = validate_quoting( findings, boom )
|
|
72
|
+
valid &= validate_executable( tool:tool, name:name, extension:extension, respect_optional:respect_optional, boom:boom ) unless findings.any?( &:unclosed_executable? )
|
|
69
73
|
return valid & validate_stderr_redirect( tool:tool, name:name, boom:boom )
|
|
70
74
|
end
|
|
71
75
|
|
|
@@ -73,6 +77,13 @@ class ToolValidator
|
|
|
73
77
|
|
|
74
78
|
private
|
|
75
79
|
|
|
80
|
+
# An unclosed quote fails validation, and a typographic quote only warns
|
|
81
|
+
def validate_quoting(findings, boom)
|
|
82
|
+
findings.reject( &:error ).each { |finding| @loginator.log( finding.message, Verbosity::COMPLAIN ) }
|
|
83
|
+
|
|
84
|
+
return findings.select( &:error ).map { |finding| fail_validation( finding.message, boom ) }.all?
|
|
85
|
+
end
|
|
86
|
+
|
|
76
87
|
def validate_executable(tool:, name:, extension:, respect_optional:, boom:)
|
|
77
88
|
command = tool[:executable]
|
|
78
89
|
executable = ToolValidator.executable_from( command )
|
data/lib/version.rb
CHANGED
|
@@ -21,7 +21,7 @@ module Ceedling
|
|
|
21
21
|
# Target version for the current release cycle. Maintained by hand, one edit
|
|
22
22
|
# per minor or major cycle. Never edited to match a release tag. The release
|
|
23
23
|
# pipeline rewrites this line from the tag that triggered it.
|
|
24
|
-
BASE = '1.2.
|
|
24
|
+
BASE = '1.2.3'
|
|
25
25
|
|
|
26
26
|
# Marker for a build the release pipeline did not produce. That pipeline
|
|
27
27
|
# empties this line, so a published gem reports a bare version while a local
|
|
@@ -131,9 +131,7 @@ namespace BULLSEYE_REPORT_NAMESPACE_SYM do
|
|
|
131
131
|
|
|
132
132
|
desc "Generate coverage reports (Note: a #{BULLSEYE_SYM}: task must be executed first)"
|
|
133
133
|
task BULLSEYE_SYM do
|
|
134
|
-
@ceedling[:bullseye].
|
|
135
|
-
# Does nothing unless :xml_report names a format
|
|
136
|
-
@ceedling[:bullseye].generate_xml_report()
|
|
134
|
+
@ceedling[:bullseye].generate_coverage_reports()
|
|
137
135
|
end
|
|
138
136
|
|
|
139
137
|
end
|
|
@@ -311,8 +311,21 @@ class Bullseye < Plugin
|
|
|
311
311
|
end
|
|
312
312
|
end
|
|
313
313
|
|
|
314
|
+
# Generates the HTML and XML reports from the coverage file on disk.
|
|
315
|
+
# Called externally by plugin Rakefile (report:bullseye).
|
|
316
|
+
#
|
|
317
|
+
# Rake runs a report task on the command line before post_build, so this applies the
|
|
318
|
+
# report exclusions itself. A fresh coverage file has none yet.
|
|
319
|
+
def generate_coverage_reports()
|
|
320
|
+
return if (verify_coverage_file() == false)
|
|
321
|
+
|
|
322
|
+
apply_report_exclusions()
|
|
323
|
+
generate_html_report()
|
|
324
|
+
generate_xml_report()
|
|
325
|
+
end
|
|
326
|
+
|
|
314
327
|
# Generates a full interactive HTML coverage report to the artifacts directory.
|
|
315
|
-
# Called
|
|
328
|
+
# Called by post_build and generate_coverage_reports.
|
|
316
329
|
def generate_html_report()
|
|
317
330
|
begin
|
|
318
331
|
@ceedling[:tool_validator].validate( tool: TOOLS_BULLSEYE_REPORT_COVHTML, boom: true )
|
|
@@ -329,7 +342,7 @@ class Bullseye < Plugin
|
|
|
329
342
|
end
|
|
330
343
|
|
|
331
344
|
# Generates a machine-readable coverage report for CI tooling.
|
|
332
|
-
# Called
|
|
345
|
+
# Called by post_build and generate_coverage_reports.
|
|
333
346
|
# Does nothing unless :xml_report names a format.
|
|
334
347
|
def generate_xml_report()
|
|
335
348
|
format = @project_config[:bullseye_xml_report]
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
require 'ceedling/constants'
|
|
9
9
|
require 'ceedling/exceptions'
|
|
10
10
|
require 'ceedling/plugins/plugin'
|
|
11
|
-
require 'ceedling/tool_executor'
|
|
11
|
+
require 'ceedling/tools/tool_executor'
|
|
12
12
|
|
|
13
13
|
COMMAND_HOOKS_ROOT_NAME = 'command_hooks'.freeze
|
|
14
14
|
COMMAND_HOOKS_SYM = COMMAND_HOOKS_ROOT_NAME.to_sym
|
data/plugins/fff/lib/fff.rb
CHANGED
|
@@ -59,26 +59,30 @@ class FffCMockWrapper
|
|
|
59
59
|
end
|
|
60
60
|
|
|
61
61
|
def generate_mock(header_file_to_mock, folder=nil)
|
|
62
|
-
module_name = File.basename(header_file_to_mock, '
|
|
62
|
+
module_name = File.basename(header_file_to_mock, '.*')
|
|
63
63
|
puts( "Creating fake functions for #{module_name}..." ) unless @verbosity < 2
|
|
64
64
|
mock_name = @cm_config.mock_prefix + module_name + @cm_config.mock_suffix
|
|
65
65
|
|
|
66
66
|
# Parse the header file so we know what to mock.
|
|
67
67
|
parsed_header = @cm_parser.parse(module_name, File.read(header_file_to_mock))
|
|
68
68
|
|
|
69
|
-
|
|
69
|
+
path = "#{mock_path_for( folder )}/#{mock_name}"
|
|
70
|
+
write_fake( path, header_file_to_mock, mock_name, parsed_header, folder )
|
|
71
|
+
write_header_copy( File.join( File.dirname( path ), File.basename( header_file_to_mock ) ), parsed_header )
|
|
70
72
|
end
|
|
71
73
|
|
|
72
|
-
# The name for a fake's guard and control functions, as CMock forms it.
|
|
73
|
-
#
|
|
74
|
-
#
|
|
75
|
-
#
|
|
76
|
-
#
|
|
74
|
+
# The name for a fake's guard and control functions, as CMock forms it. Every name has the
|
|
75
|
+
# characters a C identifier can't hold turned to `_`, as Unity's TypeSanitizer does. That is
|
|
76
|
+
# Unity's rule, not CIdentifier's, since the runner Unity generates must call the very names
|
|
77
|
+
# this forms. With :mock_name_include_folder, the folder below the mock root comes first, so
|
|
78
|
+
# two same-named fakes stay distinct and match the runner's calls. A leading ./ is dropped.
|
|
77
79
|
def c_name_for(mock_name, folder)
|
|
78
80
|
mock_folder = [@cm_config.subdir, folder].compact
|
|
79
|
-
|
|
81
|
+
identity = mock_name
|
|
82
|
+
if @cm_config.mock_name_include_folder && !mock_folder.empty?
|
|
83
|
+
identity = File.join( *mock_folder, '' ).sub( %r{\A(?:\.[/\\])+}, '' ) + mock_name
|
|
84
|
+
end
|
|
80
85
|
|
|
81
|
-
identity = File.join( *mock_folder, '' ).sub( %r{\A(?:\.[/\\])+}, '' ) + mock_name
|
|
82
86
|
return identity.gsub( %r{[-/\\.,\s]}, '_' )
|
|
83
87
|
end
|
|
84
88
|
|
|
@@ -91,16 +95,39 @@ class FffCMockWrapper
|
|
|
91
95
|
return @cm_config.subdir ? "#{mock_path}/#{@cm_config.subdir}" : mock_path
|
|
92
96
|
end
|
|
93
97
|
|
|
94
|
-
# Writes the fake's header and source at `path`, which ends in the mock's name
|
|
95
|
-
|
|
98
|
+
# Writes the fake's header and source at `path`, which ends in the mock's name. The header
|
|
99
|
+
# takes the original header's extension, as CMock's mock does. `folder` is the one its
|
|
100
|
+
# #include names, which names the fake's C identifiers and through which the fake includes
|
|
101
|
+
# the original header.
|
|
102
|
+
def write_fake(path, header_file, mock_name, parsed_header, folder)
|
|
103
|
+
module_name = File.basename( header_file, '.*' )
|
|
104
|
+
module_ext = File.extname( header_file )
|
|
105
|
+
c_name = c_name_for( mock_name, folder )
|
|
96
106
|
FileUtils.mkdir_p( File.dirname( path ) )
|
|
97
107
|
|
|
98
|
-
puts( "Creating fake functions: #{path}
|
|
99
|
-
File.write( "#{path}
|
|
100
|
-
@includes_h_pre_orig_header, @includes_h_post_orig_header, c_name: c_name ) )
|
|
108
|
+
puts( "Creating fake functions: #{path}#{module_ext} and #{path}.c" ) unless @verbosity < 3
|
|
109
|
+
File.write( "#{path}#{module_ext}", FffMockGenerator.create_mock_header( module_name, mock_name, parsed_header,
|
|
110
|
+
@includes_h_pre_orig_header, @includes_h_post_orig_header, c_name: c_name, header_include: header_include( module_name, module_ext, folder ) ) )
|
|
101
111
|
|
|
102
112
|
File.write( "#{path}.c", FffMockGenerator.create_mock_source( mock_name, parsed_header,
|
|
103
|
-
@includes_c_pre_header, @includes_c_post_header, c_name: c_name ) )
|
|
113
|
+
@includes_c_pre_header, @includes_c_post_header, c_name: c_name, mock_header: "#{mock_name}#{module_ext}" ) )
|
|
114
|
+
end
|
|
115
|
+
|
|
116
|
+
# Under :treat_inlines :include, the header's text without its inline bodies, written beside
|
|
117
|
+
# the fake as CMock writes it beside a mock. The fake's #include reaches this copy, so the
|
|
118
|
+
# header's inline definitions never meet the fake's.
|
|
119
|
+
def write_header_copy(path, parsed_header)
|
|
120
|
+
return unless @cm_config.treat_inlines == :include
|
|
121
|
+
|
|
122
|
+
File.write( path, parsed_header[:normalized_source] )
|
|
123
|
+
end
|
|
124
|
+
|
|
125
|
+
# The text a fake includes the original header by: the folder its #include names and the
|
|
126
|
+
# header's filename, as CMock writes it, or Ceedling's respelling where the test's search
|
|
127
|
+
# paths reach the header only by another spelling (:orig_header_include)
|
|
128
|
+
def header_include(module_name, module_ext, folder)
|
|
129
|
+
respelled = @cm_config.respond_to?( :orig_header_include ) ? @cm_config.orig_header_include : nil
|
|
130
|
+
return respelled || File.join( *[folder].compact, "#{module_name}#{module_ext}" )
|
|
104
131
|
end
|
|
105
132
|
|
|
106
133
|
# Joins include lists, each named once, as #include operands. A name holding `<` is
|
|
@@ -23,14 +23,15 @@ class FffMockGenerator
|
|
|
23
23
|
class << self
|
|
24
24
|
|
|
25
25
|
# `c_name` names the include guard and control functions. It differs from the file's
|
|
26
|
-
# `mock_name` when the mock is named by the folder its #include names.
|
|
26
|
+
# `mock_name` when the mock is named by the folder its #include names. `header_include` is
|
|
27
|
+
# the text the original header is included by.
|
|
27
28
|
def create_mock_header(module_name, mock_name, parsed_header, pre_includes=nil,
|
|
28
|
-
post_includes=nil, c_name: mock_name)
|
|
29
|
+
post_includes=nil, c_name: mock_name, header_include: "#{module_name}.h")
|
|
29
30
|
output = StringIO.new
|
|
30
31
|
write_opening_include_guard(c_name, output)
|
|
31
32
|
output.puts
|
|
32
33
|
write_extra_includes(pre_includes, output)
|
|
33
|
-
write_header_includes(
|
|
34
|
+
write_header_includes(header_include, output)
|
|
34
35
|
write_extra_includes(post_includes, output)
|
|
35
36
|
output.puts
|
|
36
37
|
write_typedefs(parsed_header, output)
|
|
@@ -43,11 +44,13 @@ class FffMockGenerator
|
|
|
43
44
|
output.string
|
|
44
45
|
end
|
|
45
46
|
|
|
47
|
+
# `mock_header` is the fake's header by the name the source includes it, which carries the
|
|
48
|
+
# original header's extension.
|
|
46
49
|
def create_mock_source (mock_name, parsed_header, pre_includes=nil,
|
|
47
|
-
post_includes=nil, c_name: mock_name)
|
|
50
|
+
post_includes=nil, c_name: mock_name, mock_header: "#{mock_name}.h")
|
|
48
51
|
output = StringIO.new
|
|
49
52
|
write_extra_includes(pre_includes, output)
|
|
50
|
-
write_source_includes(
|
|
53
|
+
write_source_includes(mock_header, output)
|
|
51
54
|
write_extra_includes(post_includes, output)
|
|
52
55
|
output.puts
|
|
53
56
|
write_function_definitions(parsed_header, output)
|
|
@@ -65,10 +68,10 @@ class FffMockGenerator
|
|
|
65
68
|
output.puts "#define #{mock_name}_H"
|
|
66
69
|
end
|
|
67
70
|
|
|
68
|
-
def write_header_includes(
|
|
71
|
+
def write_header_includes(header_include, output)
|
|
69
72
|
output.puts %{#include "fff.h"}
|
|
70
73
|
output.puts %{#include "fff_unity_helper.h"}
|
|
71
|
-
output.puts %{#include "#{
|
|
74
|
+
output.puts %{#include "#{header_include}"}
|
|
72
75
|
end
|
|
73
76
|
|
|
74
77
|
def write_typedefs(parsed_header, output)
|
|
@@ -95,10 +98,10 @@ class FffMockGenerator
|
|
|
95
98
|
|
|
96
99
|
# Source file generation functions.
|
|
97
100
|
|
|
98
|
-
def write_source_includes (
|
|
101
|
+
def write_source_includes (mock_header, output)
|
|
99
102
|
output.puts "#include <string.h>"
|
|
100
103
|
output.puts %{#include "fff.h"}
|
|
101
|
-
output.puts %{#include "#{
|
|
104
|
+
output.puts %{#include "#{mock_header}"}
|
|
102
105
|
end
|
|
103
106
|
|
|
104
107
|
def write_function_definitions(parsed_header, output)
|