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
|
@@ -0,0 +1,661 @@
|
|
|
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
|
+
# What a Partial carries forward beyond the functions a test selected.
|
|
9
|
+
#
|
|
10
|
+
# A Partial's implementation source holds the selected functions. The module's code also
|
|
11
|
+
# relied on declarations of functions defined elsewhere and on small header helpers. These
|
|
12
|
+
# examples state which of those PartializerHelper#plan_carry keeps, and why. Each builds the
|
|
13
|
+
# module from real extractor structs, so origin and decorators read as production sets them.
|
|
14
|
+
|
|
15
|
+
require 'spec_helper'
|
|
16
|
+
require 'ceedling/partials/partializer_helper'
|
|
17
|
+
require 'ceedling/partials/partials'
|
|
18
|
+
require 'ceedling/c_extractor/c_extractor_types'
|
|
19
|
+
|
|
20
|
+
describe PartializerHelper do
|
|
21
|
+
before(:each) do
|
|
22
|
+
@helper = described_class.new(
|
|
23
|
+
{
|
|
24
|
+
:partializer_utils => double( 'PartializerUtils' ),
|
|
25
|
+
:c_extractor_declarations => double( 'CExtractorDeclarations' ),
|
|
26
|
+
:parsing_parcels => double( 'ParsingParcels' ),
|
|
27
|
+
:loginator => double( 'Loginator' ).as_null_object
|
|
28
|
+
}
|
|
29
|
+
)
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# ---- builders --------------------------------------------------------------
|
|
33
|
+
|
|
34
|
+
def decl(signature, origin: :source)
|
|
35
|
+
name = signature[/(\w+)\s*\(/, 1]
|
|
36
|
+
decorators = signature.split( /\s+/ ).take_while { |t| %w[static inline extern __inline __inline__].include?( t ) }
|
|
37
|
+
CExtractorTypes::CFunctionDeclaration.new(
|
|
38
|
+
name: name, signature: signature, decorators: decorators,
|
|
39
|
+
signature_stripped: signature.sub( /\A(?:(?:static|inline|extern)\s+)+/, '' ), origin: origin
|
|
40
|
+
)
|
|
41
|
+
end
|
|
42
|
+
|
|
43
|
+
def defn(code_block, origin: :source, expanded_body: nil, line_num: 1)
|
|
44
|
+
signature = code_block[/\A[^{]*/].strip
|
|
45
|
+
name = signature[/(\w+)\s*\(/, 1]
|
|
46
|
+
decorators = signature.split( /\s+/ ).take_while { |t| %w[static inline extern __inline __inline__].include?( t ) }
|
|
47
|
+
CExtractorTypes::CFunctionDefinition.new(
|
|
48
|
+
name: name, signature: signature, decorators: decorators, code_block: code_block,
|
|
49
|
+
body: code_block[/\{.*\}/m], expanded_body: expanded_body, origin: origin,
|
|
50
|
+
line_num: line_num, source_filepath: (origin == :header ? 'src/engine.h' : 'src/engine.c')
|
|
51
|
+
)
|
|
52
|
+
end
|
|
53
|
+
|
|
54
|
+
def var(text, decorators: [])
|
|
55
|
+
CExtractorTypes::CVariableDeclaration.new( name: text[/(\w+)\s*(?:=|;|\[)/, 1], text: text, decorators: decorators )
|
|
56
|
+
end
|
|
57
|
+
|
|
58
|
+
# A macro definition or a bare macro invocation
|
|
59
|
+
def statement(text)
|
|
60
|
+
CExtractorTypes::CStatement.new( text: text )
|
|
61
|
+
end
|
|
62
|
+
|
|
63
|
+
def c_module(*items)
|
|
64
|
+
CExtractorTypes::CModule.new(
|
|
65
|
+
function_definitions: items.grep( CExtractorTypes::CFunctionDefinition ),
|
|
66
|
+
function_declarations: items.grep( CExtractorTypes::CFunctionDeclaration ),
|
|
67
|
+
variable_declarations: items.grep( CExtractorTypes::CVariableDeclaration ),
|
|
68
|
+
element_sequence: items
|
|
69
|
+
)
|
|
70
|
+
end
|
|
71
|
+
|
|
72
|
+
# Selected testable functions arrive transformed, as extract_implementation_functions returns them
|
|
73
|
+
def selected(*definitions)
|
|
74
|
+
definitions.map { |d| Partials.manufacture_function_definition( name: d.name, signature: d.signature_stripped, code_block: d.code_block ) }
|
|
75
|
+
end
|
|
76
|
+
|
|
77
|
+
def mocked(*names)
|
|
78
|
+
names.map { |n| Partials.manufacture_function_declaration( name: n, signature: "void #{n}(void)" ) }
|
|
79
|
+
end
|
|
80
|
+
|
|
81
|
+
def plan(mod, impl: [], interface: [], fallback: false, header_guarded: true)
|
|
82
|
+
@helper.plan_carry( c_module: mod, impl: impl, interface: interface, fallback: fallback, header_guarded: header_guarded )
|
|
83
|
+
end
|
|
84
|
+
|
|
85
|
+
def carried_prototypes(result)
|
|
86
|
+
result.prototypes.map { |c| c.item.signature }
|
|
87
|
+
end
|
|
88
|
+
|
|
89
|
+
def carried_helpers(result)
|
|
90
|
+
result.helpers.keys
|
|
91
|
+
end
|
|
92
|
+
|
|
93
|
+
# ---- externals: a module declares a function it doesn't define -------------
|
|
94
|
+
|
|
95
|
+
context 'external functions' do
|
|
96
|
+
it 'carries a prototype for a function defined elsewhere' do
|
|
97
|
+
get = defn( 'int engine_get(void) { return board_tick(); }' )
|
|
98
|
+
tick = decl( 'int board_tick(void);', origin: :header )
|
|
99
|
+
|
|
100
|
+
result = plan( c_module( tick, get ), impl: selected( get ) )
|
|
101
|
+
|
|
102
|
+
expect( carried_prototypes( result ) ).to eq( ['int board_tick(void);'] )
|
|
103
|
+
expect( result.prototypes.first.reason ).to eq( 'external: no body in module' )
|
|
104
|
+
end
|
|
105
|
+
|
|
106
|
+
# The prototype's whole job is to make this file hold the external definition, so an
|
|
107
|
+
# inline prototype can't depend on a use
|
|
108
|
+
it 'carries an extern inline prototype that nothing calls' do
|
|
109
|
+
get = defn( 'int engine_get(void) { return 1; }' )
|
|
110
|
+
twice = decl( 'extern inline int engine_get_twice(void);' )
|
|
111
|
+
|
|
112
|
+
result = plan( c_module( twice, get ), impl: selected( get ) )
|
|
113
|
+
|
|
114
|
+
expect( carried_prototypes( result ) ).to eq( ['extern inline int engine_get_twice(void);'] )
|
|
115
|
+
end
|
|
116
|
+
|
|
117
|
+
# C99 gives the external definition to a file declaring the function `extern` or without
|
|
118
|
+
# `inline`, so such a prototype can't depend on a use either
|
|
119
|
+
it 'carries a plain prototype of an inline function another header defines, unused' do
|
|
120
|
+
get = defn( 'int engine_get(void) { return 1; }' )
|
|
121
|
+
twice = decl( 'extern int engine_get_twice(void);' )
|
|
122
|
+
twice.inline_elsewhere = true
|
|
123
|
+
|
|
124
|
+
result = plan( c_module( twice, get ), impl: selected( get ) )
|
|
125
|
+
|
|
126
|
+
expect( carried_prototypes( result ) ).to eq( ['extern int engine_get_twice(void);'] )
|
|
127
|
+
end
|
|
128
|
+
|
|
129
|
+
it 'carries no prototype that nothing kept calls' do
|
|
130
|
+
get = defn( 'int engine_get(void) { return 1; }' )
|
|
131
|
+
unused = decl( 'int board_reset(void);', origin: :header )
|
|
132
|
+
|
|
133
|
+
expect( carried_prototypes( plan( c_module( unused, get ), impl: selected( get ) ) ) ).to be_empty
|
|
134
|
+
end
|
|
135
|
+
|
|
136
|
+
# The expanded body shows what the compiler calls. A macro that renames the call leaves no
|
|
137
|
+
# reference, and a carried prototype would only meet that macro again and break.
|
|
138
|
+
it 'carries no prototype whose call a macro replaced' do
|
|
139
|
+
get = defn( 'void *engine_buf(void) { return pool_alloc(4); }', expanded_body: '{ return pool_alloc_dbg((4),12); }' )
|
|
140
|
+
alloc = decl( 'void *pool_alloc(unsigned n);', origin: :header )
|
|
141
|
+
|
|
142
|
+
expect( carried_prototypes( plan( c_module( alloc, get ), impl: selected( get ) ) ) ).to be_empty
|
|
143
|
+
end
|
|
144
|
+
|
|
145
|
+
it 'counts a function whose address a body takes' do
|
|
146
|
+
get = defn( 'int engine_get(void) { return register_cb(&board_tick); }' )
|
|
147
|
+
tick = decl( 'int board_tick(void);', origin: :header )
|
|
148
|
+
|
|
149
|
+
expect( carried_prototypes( plan( c_module( tick, get ), impl: selected( get ) ) ) ).to eq( ['int board_tick(void);'] )
|
|
150
|
+
end
|
|
151
|
+
|
|
152
|
+
it 'counts a function a body passes by name as a callback' do
|
|
153
|
+
get = defn( 'int engine_start(void) { return register_cb(board_tick); }' )
|
|
154
|
+
tick = decl( 'int board_tick(void);', origin: :header )
|
|
155
|
+
|
|
156
|
+
expect( carried_prototypes( plan( c_module( tick, get ), impl: selected( get ) ) ) ).to eq( ['int board_tick(void);'] )
|
|
157
|
+
end
|
|
158
|
+
|
|
159
|
+
it 'never carries a static prototype without a body' do
|
|
160
|
+
get = defn( 'int engine_get(void) { return orphan(); }' )
|
|
161
|
+
orphan = decl( 'static int orphan(void);' )
|
|
162
|
+
|
|
163
|
+
expect( carried_prototypes( plan( c_module( orphan, get ), impl: selected( get ) ) ) ).to be_empty
|
|
164
|
+
end
|
|
165
|
+
|
|
166
|
+
it 'carries identical prototypes once' do
|
|
167
|
+
get = defn( 'int engine_get(void) { return board_tick(); }' )
|
|
168
|
+
in_header = decl( 'int board_tick(void);', origin: :header )
|
|
169
|
+
in_source = decl( 'int board_tick(void);', origin: :source )
|
|
170
|
+
|
|
171
|
+
result = plan( c_module( in_header, in_source, get ), impl: selected( get ) )
|
|
172
|
+
|
|
173
|
+
expect( result.prototypes.map( &:item ) ).to eq( [in_header] )
|
|
174
|
+
end
|
|
175
|
+
|
|
176
|
+
it 'carries compatible prototypes written differently, each as written' do
|
|
177
|
+
get = defn( 'int engine_get(void) { return board_tick(); }' )
|
|
178
|
+
plain = decl( 'int board_tick(void);', origin: :header )
|
|
179
|
+
extern = decl( 'extern int board_tick(void);', origin: :source )
|
|
180
|
+
|
|
181
|
+
expect( carried_prototypes( plan( c_module( plain, extern, get ), impl: selected( get ) ) ) )
|
|
182
|
+
.to eq( ['int board_tick(void);', 'extern int board_tick(void);'] )
|
|
183
|
+
end
|
|
184
|
+
end
|
|
185
|
+
|
|
186
|
+
# ---- selected functions are handled as they always were --------------------
|
|
187
|
+
|
|
188
|
+
context 'selected functions' do
|
|
189
|
+
it 'carries no prototype of a function selected to test' do
|
|
190
|
+
get = defn( 'int engine_get(void) { return 1; }' )
|
|
191
|
+
report = defn( 'int engine_report(void) { return engine_get() + 1; }' )
|
|
192
|
+
proto = decl( 'int engine_get(void);', origin: :header )
|
|
193
|
+
|
|
194
|
+
expect( carried_prototypes( plan( c_module( proto, get, report ), impl: selected( get, report ) ) ) ).to be_empty
|
|
195
|
+
end
|
|
196
|
+
|
|
197
|
+
it 'carries no prototype of a function selected to mock' do
|
|
198
|
+
get = defn( 'int engine_get(void) { engine_log(); return 1; }' )
|
|
199
|
+
log = defn( 'void engine_log(void) { }' )
|
|
200
|
+
prot = decl( 'void engine_log(void);', origin: :header )
|
|
201
|
+
|
|
202
|
+
result = plan( c_module( prot, log, get ), impl: selected( get ), interface: mocked( 'engine_log' ) )
|
|
203
|
+
|
|
204
|
+
expect( carried_prototypes( result ) ).to be_empty
|
|
205
|
+
end
|
|
206
|
+
|
|
207
|
+
it 'carries nothing for a selected static forward declaration' do
|
|
208
|
+
helper = defn( 'static int helper(void) { return 41; }' )
|
|
209
|
+
get = defn( 'int engine_get(void) { return helper() + 1; }' )
|
|
210
|
+
fwd = decl( 'static int helper(void);' )
|
|
211
|
+
|
|
212
|
+
result = plan( c_module( fwd, get, helper ), impl: selected( get, helper ) )
|
|
213
|
+
|
|
214
|
+
expect( carried_prototypes( result ) ).to be_empty
|
|
215
|
+
expect( carried_helpers( result ) ).to be_empty
|
|
216
|
+
end
|
|
217
|
+
|
|
218
|
+
# A header helper the test selects is written as a selected function, so carrying it too
|
|
219
|
+
# would define it twice
|
|
220
|
+
it 'carries neither the body nor the prototypes of a header helper selected to test' do
|
|
221
|
+
clamp = defn( 'static inline int clamp(int v) { return v > 9 ? 9 : v; }', origin: :header )
|
|
222
|
+
fwd = decl( 'static inline int clamp(int v);', origin: :header )
|
|
223
|
+
get = defn( 'int engine_get(void) { return clamp(12); }' )
|
|
224
|
+
|
|
225
|
+
result = plan( c_module( fwd, clamp, get ), impl: selected( get, clamp ) )
|
|
226
|
+
|
|
227
|
+
expect( carried_helpers( result ) ).to be_empty
|
|
228
|
+
expect( carried_prototypes( result ) ).to be_empty
|
|
229
|
+
end
|
|
230
|
+
end
|
|
231
|
+
|
|
232
|
+
# ---- left out: the module defines it, but the test didn't select it --------
|
|
233
|
+
|
|
234
|
+
context 'left-out functions' do
|
|
235
|
+
it 'carries the prototype of a left-out function, so a test stub links' do
|
|
236
|
+
poll = defn( 'int engine_poll(void) { return 1; }' )
|
|
237
|
+
report = defn( 'int engine_report(void) { return engine_poll() + 1; }' )
|
|
238
|
+
proto = decl( 'int engine_poll(void);', origin: :header )
|
|
239
|
+
|
|
240
|
+
result = plan( c_module( proto, poll, report ), impl: selected( report ) )
|
|
241
|
+
|
|
242
|
+
expect( carried_prototypes( result ) ).to eq( ['int engine_poll(void);'] )
|
|
243
|
+
expect( result.prototypes.first.reason ).to eq( 'left out: body not selected' )
|
|
244
|
+
end
|
|
245
|
+
|
|
246
|
+
it 'carries no prototype of a left-out function nothing kept calls' do
|
|
247
|
+
poll = defn( 'int engine_poll(void) { return 1; }' )
|
|
248
|
+
get = defn( 'int engine_get(void) { return 1; }' )
|
|
249
|
+
proto = decl( 'int engine_poll(void);', origin: :header )
|
|
250
|
+
|
|
251
|
+
expect( carried_prototypes( plan( c_module( proto, poll, get ), impl: selected( get ) ) ) ).to be_empty
|
|
252
|
+
end
|
|
253
|
+
|
|
254
|
+
it 'carries no static prototype of an unselected source function' do
|
|
255
|
+
raw = defn( 'static void raw_write(void) { }' )
|
|
256
|
+
get = defn( 'int engine_get(void) { raw_write(); return 1; }' )
|
|
257
|
+
proto = decl( 'static void raw_write(void);', origin: :header )
|
|
258
|
+
|
|
259
|
+
expect( carried_prototypes( plan( c_module( proto, raw, get ), impl: selected( get ) ) ) ).to be_empty
|
|
260
|
+
end
|
|
261
|
+
|
|
262
|
+
it 'carries no inline prototype whose body was left out' do
|
|
263
|
+
fast = defn( 'int fast(void) { return 1; }' )
|
|
264
|
+
get = defn( 'int engine_get(void) { return fast(); }' )
|
|
265
|
+
proto = decl( 'extern inline int fast(void);' )
|
|
266
|
+
|
|
267
|
+
expect( carried_prototypes( plan( c_module( proto, fast, get ), impl: selected( get ) ) ) ).to be_empty
|
|
268
|
+
end
|
|
269
|
+
|
|
270
|
+
it 'carries the prototype but not the body of a plain function defined in the header' do
|
|
271
|
+
plain = defn( 'int plain(void) { return 1; }', origin: :header )
|
|
272
|
+
proto = decl( 'int plain(void);', origin: :header )
|
|
273
|
+
get = defn( 'int engine_get(void) { return plain(); }' )
|
|
274
|
+
|
|
275
|
+
result = plan( c_module( proto, plain, get ), impl: selected( get ) )
|
|
276
|
+
|
|
277
|
+
expect( carried_prototypes( result ) ).to eq( ['int plain(void);'] )
|
|
278
|
+
expect( carried_helpers( result ) ).to be_empty
|
|
279
|
+
end
|
|
280
|
+
end
|
|
281
|
+
|
|
282
|
+
# ---- helpers: static or inline bodies in the header --------------------------
|
|
283
|
+
|
|
284
|
+
context 'header helpers' do
|
|
285
|
+
let(:clamp) { defn( 'static inline int clamp(int v) { return v > 9 ? 9 : v; }', origin: :header, line_num: 7 ) }
|
|
286
|
+
|
|
287
|
+
it 'carries a helper a selected body calls, with its reason' do
|
|
288
|
+
get = defn( 'int engine_get(void) { return clamp(12); }' )
|
|
289
|
+
|
|
290
|
+
result = plan( c_module( clamp, get ), impl: selected( get ) )
|
|
291
|
+
|
|
292
|
+
expect( carried_helpers( result ) ).to eq( ['clamp'] )
|
|
293
|
+
expect( result.helpers['clamp'].reason ).to eq( 'helper: referenced by `engine_get`' )
|
|
294
|
+
end
|
|
295
|
+
|
|
296
|
+
# A carried helper stays static inline and private to the implementation source
|
|
297
|
+
it 'carries the helper as written, with its location' do
|
|
298
|
+
get = defn( 'int engine_get(void) { return clamp(12); }' )
|
|
299
|
+
|
|
300
|
+
helper = plan( c_module( clamp, get ), impl: selected( get ) ).helper( 'clamp' )
|
|
301
|
+
|
|
302
|
+
expect( helper.code_block ).to eq( 'static inline int clamp(int v) { return v > 9 ? 9 : v; }' )
|
|
303
|
+
expect( helper.line_num ).to eq( 7 )
|
|
304
|
+
expect( helper.source_filepath ).to eq( 'src/engine.h' )
|
|
305
|
+
end
|
|
306
|
+
|
|
307
|
+
it 'carries no helper that nothing kept references' do
|
|
308
|
+
get = defn( 'int engine_get(void) { return 1; }' )
|
|
309
|
+
|
|
310
|
+
expect( carried_helpers( plan( c_module( clamp, get ), impl: selected( get ) ) ) ).to be_empty
|
|
311
|
+
end
|
|
312
|
+
|
|
313
|
+
# A helper's prototypes travel with its body, so a helper left behind takes them with it
|
|
314
|
+
it 'carries no prototype of a referenced helper it leaves behind' do
|
|
315
|
+
twice = defn( 'inline int twice(void) { return 2; }', origin: :header )
|
|
316
|
+
fwd = decl( 'int twice(void);', origin: :header )
|
|
317
|
+
get = defn( 'int engine_get(void) { return twice(); }' )
|
|
318
|
+
|
|
319
|
+
result = plan( c_module( fwd, twice, get ), impl: selected( get ), header_guarded: false )
|
|
320
|
+
|
|
321
|
+
expect( carried_prototypes( result ) ).to be_empty
|
|
322
|
+
end
|
|
323
|
+
|
|
324
|
+
it 'carries a carried helper\'s prototypes, static ones included' do
|
|
325
|
+
fwd = decl( 'static inline int clamp(int v);', origin: :header )
|
|
326
|
+
get = defn( 'int engine_get(void) { return clamp(12); }' )
|
|
327
|
+
|
|
328
|
+
expect( carried_prototypes( plan( c_module( fwd, clamp, get ), impl: selected( get ) ) ) )
|
|
329
|
+
.to eq( ['static inline int clamp(int v);'] )
|
|
330
|
+
end
|
|
331
|
+
|
|
332
|
+
# C99 gives a plain inline function its external definition through an extern inline
|
|
333
|
+
# prototype, so that prototype travels with the helper
|
|
334
|
+
it 'carries the source extern inline prototype of a plain inline helper' do
|
|
335
|
+
twice = defn( 'inline int engine_get_twice(void) { return 42; }', origin: :header )
|
|
336
|
+
proto = decl( 'extern inline int engine_get_twice(void);', origin: :source )
|
|
337
|
+
get = defn( 'int engine_get(void) { return engine_get_twice(); }' )
|
|
338
|
+
|
|
339
|
+
result = plan( c_module( twice, proto, get ), impl: selected( get ) )
|
|
340
|
+
|
|
341
|
+
expect( carried_helpers( result ) ).to eq( ['engine_get_twice'] )
|
|
342
|
+
expect( carried_prototypes( result ) ).to eq( ['extern inline int engine_get_twice(void);'] )
|
|
343
|
+
end
|
|
344
|
+
|
|
345
|
+
it 'ignores a helper name inside a string literal' do
|
|
346
|
+
get = defn( 'const char *engine_name(void) { return "clamp(1)"; }' )
|
|
347
|
+
|
|
348
|
+
expect( carried_helpers( plan( c_module( clamp, get ), impl: selected( get ) ) ) ).to be_empty
|
|
349
|
+
end
|
|
350
|
+
|
|
351
|
+
# A quote inside a character literal starts no string, so the call between two of them counts
|
|
352
|
+
it 'reads past a quote inside a character literal' do
|
|
353
|
+
get = defn( %q{int engine_mark(void) { return '"' + clamp(1) + '"'; }} )
|
|
354
|
+
|
|
355
|
+
expect( carried_helpers( plan( c_module( clamp, get ), impl: selected( get ) ) ) ).to eq( ['clamp'] )
|
|
356
|
+
end
|
|
357
|
+
|
|
358
|
+
# A member or a local that shares a helper's name is not a use of the helper
|
|
359
|
+
it 'ignores a member access with a helper\'s name' do
|
|
360
|
+
size = defn( 'static inline int size(const buf_t *b) { return b->len; }', origin: :header )
|
|
361
|
+
get = defn( 'int engine_len(const buf_t *b) { return b->size(b) + b . size; }' )
|
|
362
|
+
|
|
363
|
+
expect( carried_helpers( plan( c_module( size, get ), impl: selected( get ) ) ) ).to be_empty
|
|
364
|
+
end
|
|
365
|
+
|
|
366
|
+
it 'ignores a local variable that shares a helper\'s name' do
|
|
367
|
+
get = defn( 'int engine_get(void) { int clamp = 3; return clamp; }' )
|
|
368
|
+
|
|
369
|
+
expect( carried_helpers( plan( c_module( clamp, get ), impl: selected( get ) ) ) ).to be_empty
|
|
370
|
+
end
|
|
371
|
+
|
|
372
|
+
it 'ignores a local pointer that shares a helper\'s name' do
|
|
373
|
+
get = defn( 'int engine_get(const int *v) { const int *clamp = v; return *clamp; }' )
|
|
374
|
+
|
|
375
|
+
expect( carried_helpers( plan( c_module( clamp, get ), impl: selected( get ) ) ) ).to be_empty
|
|
376
|
+
end
|
|
377
|
+
|
|
378
|
+
it 'ignores a loop variable that shares a helper\'s name' do
|
|
379
|
+
get = defn( 'int engine_sum(void) { int s = 0; for (int clamp = 0; clamp < 3; clamp++) { s += clamp; } return s; }' )
|
|
380
|
+
|
|
381
|
+
expect( carried_helpers( plan( c_module( clamp, get ), impl: selected( get ) ) ) ).to be_empty
|
|
382
|
+
end
|
|
383
|
+
|
|
384
|
+
it 'ignores a parameter that shares a helper\'s name' do
|
|
385
|
+
get = defn( 'int engine_get(int clamp) { return 1 && clamp; }' )
|
|
386
|
+
|
|
387
|
+
expect( carried_helpers( plan( c_module( clamp, get ), impl: selected( get ) ) ) ).to be_empty
|
|
388
|
+
end
|
|
389
|
+
|
|
390
|
+
# A bitwise and reads like taking an address, but the operand is still the parameter
|
|
391
|
+
it 'ignores a parameter after a bitwise and' do
|
|
392
|
+
get = defn( 'int engine_mask(int clamp) { return 0x0F & clamp; }' )
|
|
393
|
+
|
|
394
|
+
expect( carried_helpers( plan( c_module( clamp, get ), impl: selected( get ) ) ) ).to be_empty
|
|
395
|
+
end
|
|
396
|
+
|
|
397
|
+
it 'ignores a struct tag that shares a helper\'s name' do
|
|
398
|
+
get = defn( 'int engine_size(void) { return (int)sizeof(struct clamp); }' )
|
|
399
|
+
|
|
400
|
+
expect( carried_helpers( plan( c_module( clamp, get ), impl: selected( get ) ) ) ).to be_empty
|
|
401
|
+
end
|
|
402
|
+
|
|
403
|
+
it 'ignores a helper name inside a comment' do
|
|
404
|
+
get = defn( "int engine_get(void) { /* clamp(v) later */ return 1; // or clamp(v) now\n}" )
|
|
405
|
+
|
|
406
|
+
expect( carried_helpers( plan( c_module( clamp, get ), impl: selected( get ) ) ) ).to be_empty
|
|
407
|
+
end
|
|
408
|
+
|
|
409
|
+
it 'counts a helper a body passes as a callback' do
|
|
410
|
+
cmp = defn( 'static inline int cmp(const void *a, const void *b) { return *(const int *)a - *(const int *)b; }', origin: :header )
|
|
411
|
+
get = defn( 'void engine_sort(int *v) { qsort(v, 4, sizeof(int), cmp); }' )
|
|
412
|
+
|
|
413
|
+
expect( carried_helpers( plan( c_module( cmp, get ), impl: selected( get ) ) ) ).to eq( ['cmp'] )
|
|
414
|
+
end
|
|
415
|
+
|
|
416
|
+
it 'counts a helper a body names in a designated initializer' do
|
|
417
|
+
add = defn( 'static inline int op_add(int a, int b) { return a + b; }', origin: :header )
|
|
418
|
+
get = defn( 'int engine_apply(void) { ops_t ops = { .fn = op_add }; return ops.fn(1, 2); }' )
|
|
419
|
+
|
|
420
|
+
expect( carried_helpers( plan( c_module( add, get ), impl: selected( get ) ) ) ).to eq( ['op_add'] )
|
|
421
|
+
end
|
|
422
|
+
|
|
423
|
+
it 'counts a helper whose name a quote in a comment does not hide' do
|
|
424
|
+
get = defn( "int engine_get(void) { /* don't */ return clamp(12); }" )
|
|
425
|
+
|
|
426
|
+
expect( carried_helpers( plan( c_module( clamp, get ), impl: selected( get ) ) ) ).to eq( ['clamp'] )
|
|
427
|
+
end
|
|
428
|
+
|
|
429
|
+
it 'counts a helper whose address a body takes' do
|
|
430
|
+
get = defn( 'int engine_get(void) { return apply(&clamp, 12); }' )
|
|
431
|
+
|
|
432
|
+
expect( carried_helpers( plan( c_module( clamp, get ), impl: selected( get ) ) ) ).to eq( ['clamp'] )
|
|
433
|
+
end
|
|
434
|
+
|
|
435
|
+
it 'matches a helper name only as a whole word' do
|
|
436
|
+
get = defn( 'int engine_get(void) { return clamp_count; }' )
|
|
437
|
+
|
|
438
|
+
expect( carried_helpers( plan( c_module( clamp, get ), impl: selected( get ) ) ) ).to be_empty
|
|
439
|
+
end
|
|
440
|
+
|
|
441
|
+
it 'finds a call that a macro hides, through the expanded body' do
|
|
442
|
+
get = defn( 'int engine_get(int v) { return CLAMP(v); }', expanded_body: '{ return clamp(v); }' )
|
|
443
|
+
|
|
444
|
+
expect( carried_helpers( plan( c_module( clamp, get ), impl: selected( get ) ) ) ).to eq( ['clamp'] )
|
|
445
|
+
end
|
|
446
|
+
|
|
447
|
+
it 'follows helpers that call helpers' do
|
|
448
|
+
bound = defn( 'static inline int bound(int v) { return clamp(v); }', origin: :header )
|
|
449
|
+
get = defn( 'int engine_get(void) { return bound(12); }' )
|
|
450
|
+
|
|
451
|
+
result = plan( c_module( clamp, bound, get ), impl: selected( get ) )
|
|
452
|
+
|
|
453
|
+
expect( carried_helpers( result ) ).to contain_exactly( 'bound', 'clamp' )
|
|
454
|
+
expect( result.helpers['clamp'].reason ).to eq( 'helper: referenced by `bound`' )
|
|
455
|
+
end
|
|
456
|
+
|
|
457
|
+
it 'follows a chain of helpers in the order each reaches the next' do
|
|
458
|
+
bound = defn( 'static inline int bound(int v) { return clamp(v); }', origin: :header )
|
|
459
|
+
scale = defn( 'static inline int scale(int v) { return bound(v * 2); }', origin: :header )
|
|
460
|
+
get = defn( 'int engine_get(void) { return scale(3); }' )
|
|
461
|
+
|
|
462
|
+
result = plan( c_module( clamp, bound, scale, get ), impl: selected( get ) )
|
|
463
|
+
|
|
464
|
+
expect( carried_helpers( result ) ).to eq( ['scale', 'bound', 'clamp'] )
|
|
465
|
+
expect( result.helpers['bound'].reason ).to eq( 'helper: referenced by `scale`' )
|
|
466
|
+
end
|
|
467
|
+
|
|
468
|
+
it 'carries a helper that calls itself once' do
|
|
469
|
+
walk = defn( 'static inline int walk(int n) { return n ? walk(n - 1) : 0; }', origin: :header )
|
|
470
|
+
get = defn( 'int engine_get(void) { return walk(3); }' )
|
|
471
|
+
|
|
472
|
+
expect( carried_helpers( plan( c_module( walk, get ), impl: selected( get ) ) ) ).to eq( ['walk'] )
|
|
473
|
+
end
|
|
474
|
+
|
|
475
|
+
it 'carries helpers that call each other once each' do
|
|
476
|
+
even = defn( 'static inline int is_even(int n) { return n ? is_odd(n - 1) : 1; }', origin: :header )
|
|
477
|
+
odd = defn( 'static inline int is_odd(int n) { return n ? is_even(n - 1) : 0; }', origin: :header )
|
|
478
|
+
get = defn( 'int engine_get(void) { return is_even(4); }' )
|
|
479
|
+
|
|
480
|
+
result = plan( c_module( even, odd, get ), impl: selected( get ) )
|
|
481
|
+
|
|
482
|
+
expect( carried_helpers( result ) ).to eq( ['is_even', 'is_odd'] )
|
|
483
|
+
expect( result.helpers['is_odd'].reason ).to eq( 'helper: referenced by `is_even`' )
|
|
484
|
+
end
|
|
485
|
+
|
|
486
|
+
it 'counts a reference from a variable written into the implementation source' do
|
|
487
|
+
table = var( 'int (*filters[1])(int) = { clamp };' )
|
|
488
|
+
get = defn( 'int engine_get(void) { return 1; }' )
|
|
489
|
+
|
|
490
|
+
expect( carried_helpers( plan( c_module( clamp, table, get ), impl: selected( get ) ) ) ).to eq( ['clamp'] )
|
|
491
|
+
end
|
|
492
|
+
|
|
493
|
+
it 'counts a reference from a bare macro invocation' do
|
|
494
|
+
call = statement( 'REGISTER(clamp)' )
|
|
495
|
+
get = defn( 'int engine_get(void) { return 1; }' )
|
|
496
|
+
mod = c_module( clamp, call, get )
|
|
497
|
+
mod.macro_invocations << call
|
|
498
|
+
|
|
499
|
+
expect( carried_helpers( plan( mod, impl: selected( get ) ) ) ).to eq( ['clamp'] )
|
|
500
|
+
end
|
|
501
|
+
|
|
502
|
+
it 'carries no helper selected for mocking' do
|
|
503
|
+
get = defn( 'int engine_get(void) { return clamp(12); }' )
|
|
504
|
+
|
|
505
|
+
expect( carried_helpers( plan( c_module( clamp, get ), impl: selected( get ), interface: mocked( 'clamp' ) ) ) ).to be_empty
|
|
506
|
+
end
|
|
507
|
+
|
|
508
|
+
it 'treats a static body in the source as left out, not as a helper' do
|
|
509
|
+
local = defn( 'static int local(void) { return 1; }', origin: :source )
|
|
510
|
+
get = defn( 'int engine_get(void) { return local(); }' )
|
|
511
|
+
|
|
512
|
+
expect( carried_helpers( plan( c_module( local, get ), impl: selected( get ) ) ) ).to be_empty
|
|
513
|
+
end
|
|
514
|
+
end
|
|
515
|
+
|
|
516
|
+
# ---- a module header without a guard ------------------------------------------
|
|
517
|
+
|
|
518
|
+
context 'a module header without an include guard' do
|
|
519
|
+
let(:clamp) { defn( 'static inline int clamp(int v) { return v; }', origin: :header ) }
|
|
520
|
+
|
|
521
|
+
# Another include may pull in the real header, whose helpers would then collide
|
|
522
|
+
it 'carries no referenced helper and names it as skipped' do
|
|
523
|
+
get = defn( 'int engine_get(void) { return clamp(1); }' )
|
|
524
|
+
|
|
525
|
+
result = plan( c_module( clamp, get ), impl: selected( get ), header_guarded: false )
|
|
526
|
+
|
|
527
|
+
expect( carried_helpers( result ) ).to be_empty
|
|
528
|
+
expect( result.skipped.map { |s| [s.item, s.kind] } ).to eq( [['clamp', :unguarded_helper]] )
|
|
529
|
+
end
|
|
530
|
+
|
|
531
|
+
it 'names no unreferenced helper' do
|
|
532
|
+
get = defn( 'int engine_get(void) { return 1; }' )
|
|
533
|
+
|
|
534
|
+
expect( plan( c_module( clamp, get ), impl: selected( get ), header_guarded: false ).skipped ).to be_empty
|
|
535
|
+
end
|
|
536
|
+
|
|
537
|
+
it 'still carries external prototypes' do
|
|
538
|
+
tick = decl( 'int board_tick(void);', origin: :header )
|
|
539
|
+
get = defn( 'int engine_get(void) { return board_tick(); }' )
|
|
540
|
+
|
|
541
|
+
expect( carried_prototypes( plan( c_module( tick, get ), impl: selected( get ), header_guarded: false ) ) )
|
|
542
|
+
.to eq( ['int board_tick(void);'] )
|
|
543
|
+
end
|
|
544
|
+
end
|
|
545
|
+
|
|
546
|
+
# ---- fallback preprocessing may leave alternatives behind ---------------------
|
|
547
|
+
|
|
548
|
+
context 'under fallback preprocessing' do
|
|
549
|
+
it 'carries neither of two conflicting prototypes and names the function' do
|
|
550
|
+
a = decl( 'int board_tick(int);', origin: :header )
|
|
551
|
+
b = decl( 'long board_tick(int);', origin: :header )
|
|
552
|
+
get = defn( 'int engine_get(void) { return (int)board_tick(1); }' )
|
|
553
|
+
|
|
554
|
+
result = plan( c_module( a, b, get ), impl: selected( get ), fallback: true )
|
|
555
|
+
|
|
556
|
+
expect( carried_prototypes( result ) ).to be_empty
|
|
557
|
+
expect( result.skipped.map { |s| [s.item, s.kind] } ).to eq( [['board_tick', :prototype_conflict]] )
|
|
558
|
+
end
|
|
559
|
+
|
|
560
|
+
it 'carries compatible prototypes' do
|
|
561
|
+
a = decl( 'int board_tick(void);', origin: :header )
|
|
562
|
+
b = decl( 'extern int board_tick(void);', origin: :source )
|
|
563
|
+
get = defn( 'int engine_get(void) { return board_tick(); }' )
|
|
564
|
+
|
|
565
|
+
expect( carried_prototypes( plan( c_module( a, b, get ), impl: selected( get ), fallback: true ) ).size ).to eq( 2 )
|
|
566
|
+
end
|
|
567
|
+
|
|
568
|
+
it 'carries neither of two different bodies for a referenced helper and names it' do
|
|
569
|
+
one = defn( 'static inline int clamp(int v) { return v > 9 ? 9 : v; }', origin: :header )
|
|
570
|
+
two = defn( 'static inline int clamp(int v) { return v > 5 ? 5 : v; }', origin: :header )
|
|
571
|
+
get = defn( 'int engine_get(void) { return clamp(12); }' )
|
|
572
|
+
|
|
573
|
+
result = plan( c_module( one, two, get ), impl: selected( get ), fallback: true )
|
|
574
|
+
|
|
575
|
+
expect( carried_helpers( result ) ).to be_empty
|
|
576
|
+
expect( result.skipped.map { |s| [s.item, s.kind] } ).to eq( [['clamp', :helper_conflict]] )
|
|
577
|
+
end
|
|
578
|
+
|
|
579
|
+
it 'names no conflicting helper that nothing references' do
|
|
580
|
+
one = defn( 'static inline int clamp(int v) { return 9; }', origin: :header )
|
|
581
|
+
two = defn( 'static inline int clamp(int v) { return 5; }', origin: :header )
|
|
582
|
+
get = defn( 'int engine_get(void) { return 1; }' )
|
|
583
|
+
|
|
584
|
+
expect( plan( c_module( one, two, get ), impl: selected( get ), fallback: true ).skipped ).to be_empty
|
|
585
|
+
end
|
|
586
|
+
|
|
587
|
+
# Expansion is unreliable under fallback, so a macro definition's text counts as kept code
|
|
588
|
+
it 'finds a helper named only in a macro definition' do
|
|
589
|
+
clamp = defn( 'static inline int clamp(int v) { return v; }', origin: :header )
|
|
590
|
+
get = defn( 'int engine_get(int v) { return CLAMP(v); }' )
|
|
591
|
+
mod = c_module( clamp, get )
|
|
592
|
+
mod.macro_definitions << statement( '#define CLAMP(x) clamp(x)' )
|
|
593
|
+
|
|
594
|
+
expect( carried_helpers( plan( mod, impl: selected( get ), fallback: true ) ) ).to eq( ['clamp'] )
|
|
595
|
+
expect( carried_helpers( plan( mod, impl: selected( get ), fallback: false ) ) ).to be_empty
|
|
596
|
+
end
|
|
597
|
+
end
|
|
598
|
+
|
|
599
|
+
# ---- the running example from the design ---------------------------------------
|
|
600
|
+
|
|
601
|
+
it 'plans the running example' do
|
|
602
|
+
board_count = var( 'int board_count;', decorators: ['extern'] )
|
|
603
|
+
tick = decl( 'int board_tick(void);', origin: :header )
|
|
604
|
+
raw_proto = decl( 'static void raw_write(void);', origin: :header )
|
|
605
|
+
clamp = defn( 'static inline int clamp(int v) { return v > 9 ? 9 : v; }', origin: :header )
|
|
606
|
+
log_raw = defn( 'static inline void log_raw(void) { raw_write(); }', origin: :header )
|
|
607
|
+
get_proto = decl( 'int engine_get(void);', origin: :header )
|
|
608
|
+
poll_proto = decl( 'int engine_poll(void);', origin: :header )
|
|
609
|
+
twice = decl( 'extern inline int engine_get_twice(void);' )
|
|
610
|
+
raw = defn( 'static void raw_write(void) { }' )
|
|
611
|
+
get = defn( 'int engine_get(void) { return clamp(board_tick()); }' )
|
|
612
|
+
poll = defn( 'int engine_poll(void) { return engine_get(); }' )
|
|
613
|
+
|
|
614
|
+
mod = c_module( board_count, tick, raw_proto, clamp, log_raw, get_proto, poll_proto, twice, raw, get, poll )
|
|
615
|
+
result = plan( mod, impl: selected( get ) )
|
|
616
|
+
|
|
617
|
+
expect( carried_prototypes( result ) ).to contain_exactly(
|
|
618
|
+
'int board_tick(void);', 'extern inline int engine_get_twice(void);'
|
|
619
|
+
)
|
|
620
|
+
expect( carried_helpers( result ) ).to eq( ['clamp'] )
|
|
621
|
+
expect( result.skipped ).to be_empty
|
|
622
|
+
end
|
|
623
|
+
end
|
|
624
|
+
|
|
625
|
+
describe Partials::CarryPlan do
|
|
626
|
+
let(:proto) { CExtractorTypes::CFunctionDeclaration.new( name: 'tick', signature: 'int tick(void);' ) }
|
|
627
|
+
|
|
628
|
+
# The generator walks element_sequence, which holds the very objects the plan chose
|
|
629
|
+
it 'recognizes a carried prototype by identity, not by equal content' do
|
|
630
|
+
plan = described_class.new
|
|
631
|
+
plan.add_prototype( proto, 'external: no body in module' )
|
|
632
|
+
|
|
633
|
+
expect( plan.prototype?( proto ) ).to be( true )
|
|
634
|
+
expect( plan.prototype?( proto.dup ) ).to be( false )
|
|
635
|
+
end
|
|
636
|
+
|
|
637
|
+
it 'records a prototype once' do
|
|
638
|
+
plan = described_class.new
|
|
639
|
+
2.times { plan.add_prototype( proto, 'external: no body in module' ) }
|
|
640
|
+
|
|
641
|
+
expect( plan.prototypes.size ).to eq( 1 )
|
|
642
|
+
end
|
|
643
|
+
|
|
644
|
+
it 'keeps the first reason for a helper' do
|
|
645
|
+
plan = described_class.new
|
|
646
|
+
helper = Partials.manufacture_function_definition( name: 'clamp', signature: 'int clamp(int v)', code_block: '' )
|
|
647
|
+
plan.add_helper( helper, 'helper: referenced by `a`' )
|
|
648
|
+
plan.add_helper( helper, 'helper: referenced by `b`' )
|
|
649
|
+
|
|
650
|
+
expect( plan.helpers['clamp'].reason ).to eq( 'helper: referenced by `a`' )
|
|
651
|
+
expect( plan.helper( 'clamp' ) ).to equal( helper )
|
|
652
|
+
expect( plan.helper( 'other' ) ).to be_nil
|
|
653
|
+
end
|
|
654
|
+
|
|
655
|
+
it 'records a skipped name once per kind' do
|
|
656
|
+
plan = described_class.new
|
|
657
|
+
2.times { plan.skip( 'clamp', :unguarded_helper ) }
|
|
658
|
+
|
|
659
|
+
expect( plan.skipped.map { |s| [s.item, s.kind] } ).to eq( [['clamp', :unguarded_helper]] )
|
|
660
|
+
end
|
|
661
|
+
end
|