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,76 @@
|
|
|
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 'spec_helper'
|
|
9
|
+
require 'ceedling/tools/shell_quoting'
|
|
10
|
+
|
|
11
|
+
describe ShellQuoting do
|
|
12
|
+
describe '.unclosed' do
|
|
13
|
+
# The last case is two mistakes that balance once joined, which is why a tool's entries
|
|
14
|
+
# are each read on their own
|
|
15
|
+
{
|
|
16
|
+
'no quotes' => '-g',
|
|
17
|
+
'a closed double-quoted span' => '-I"${5}"',
|
|
18
|
+
'a closed single-quoted span' => "-DNAME='a b'",
|
|
19
|
+
'an escaped quote inside double quotes' => '-D"GREETING=\"hi\""',
|
|
20
|
+
'an escaped quote outside quotes' => '-DQ=\"',
|
|
21
|
+
'a single quote inside double quotes' => %q{-I"o'neil"},
|
|
22
|
+
'a double quote inside single quotes' => %q{-D'Q="'},
|
|
23
|
+
'an escaped replacement operator' => '"\${1}"',
|
|
24
|
+
"a Ruby expansion's own quotes" => %q{#{ENV['CC_FLAGS']} -c},
|
|
25
|
+
'an even count of mismatched quotes' => "-I\"a\u201d -I\"b\u201d"
|
|
26
|
+
}.each do |description, text|
|
|
27
|
+
it "finds nothing open in #{description}" do
|
|
28
|
+
expect( ShellQuoting.unclosed( text, windows: false ) ).to be_nil
|
|
29
|
+
end
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
{
|
|
33
|
+
'an unclosed double quote' => ['-I"src', '"'],
|
|
34
|
+
'an unclosed single quote' => ["-DNAME='a", "'"],
|
|
35
|
+
'a backslash before the closing quote' => ['-I"C:\\inc\\"', '"'],
|
|
36
|
+
"a straight quote closed by a typographic one" => ["-I\"${5}\u201d", '"']
|
|
37
|
+
}.each do |description, (text, open)|
|
|
38
|
+
it "finds #{open} open in #{description}" do
|
|
39
|
+
expect( ShellQuoting.unclosed( text, windows: false ) ).to eq( open )
|
|
40
|
+
end
|
|
41
|
+
end
|
|
42
|
+
|
|
43
|
+
# cmd.exe reads a single quote as an ordinary character
|
|
44
|
+
it 'ignores a single quote on Windows' do
|
|
45
|
+
expect( ShellQuoting.unclosed( "C:/Users/O'Brien/cc", windows: true ) ).to be_nil
|
|
46
|
+
end
|
|
47
|
+
|
|
48
|
+
it 'still finds an unclosed double quote on Windows' do
|
|
49
|
+
expect( ShellQuoting.unclosed( %q{-I"o'neil}, windows: true ) ).to eq( '"' )
|
|
50
|
+
end
|
|
51
|
+
|
|
52
|
+
it 'reads text holding invalid bytes' do
|
|
53
|
+
expect( ShellQuoting.unclosed( "-I\"\xFF", windows: false ) ).to eq( '"' )
|
|
54
|
+
end
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
describe '.typographic' do
|
|
58
|
+
ShellQuoting::TYPOGRAPHIC.each do |quote|
|
|
59
|
+
it "finds #{quote}" do
|
|
60
|
+
expect( ShellQuoting.typographic( "-I#{quote}src#{quote}" ) ).to eq( [quote] )
|
|
61
|
+
end
|
|
62
|
+
end
|
|
63
|
+
|
|
64
|
+
it 'lists each distinct quote once, in order of appearance' do
|
|
65
|
+
expect( ShellQuoting.typographic( "\u201ca\u201d \u201cb\u201d" ) ).to eq( ["\u201c", "\u201d"] )
|
|
66
|
+
end
|
|
67
|
+
|
|
68
|
+
it 'finds none in straight quoting' do
|
|
69
|
+
expect( ShellQuoting.typographic( %q{-I"a" -D'b'} ) ).to eq( [] )
|
|
70
|
+
end
|
|
71
|
+
|
|
72
|
+
it 'reads text holding invalid bytes' do
|
|
73
|
+
expect( ShellQuoting.typographic( "\xFF\u201d" ) ).to eq( ["\u201d"] )
|
|
74
|
+
end
|
|
75
|
+
end
|
|
76
|
+
end
|
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
|
|
8
8
|
require 'spec_helper'
|
|
9
9
|
require 'ceedling/constants'
|
|
10
|
-
require 'ceedling/tool_validator'
|
|
10
|
+
require 'ceedling/tools/tool_validator'
|
|
11
11
|
require 'ceedling/ruby_expandinator'
|
|
12
12
|
require 'ceedling/filename_extension'
|
|
13
13
|
require 'ceedling/exceptions'
|
|
@@ -336,4 +336,113 @@ describe ToolValidator do
|
|
|
336
336
|
expect( validate( tool('gcc') ) ).to be(true)
|
|
337
337
|
end
|
|
338
338
|
end
|
|
339
|
+
|
|
340
|
+
# Which quotes open and close is ShellQuoting's to decide, and its spec covers the rules.
|
|
341
|
+
# Here, which entries are checked and what each finding does.
|
|
342
|
+
describe 'quoting' do
|
|
343
|
+
before(:each) { exists( '/usr/bin/gcc' ) }
|
|
344
|
+
|
|
345
|
+
# A typographic quote ends an otherwise straight-quoted path, as copied from a web page
|
|
346
|
+
let(:pasted) { "-I\"${5}”" }
|
|
347
|
+
|
|
348
|
+
it 'logs an unclosed quote in an argument and returns false' do
|
|
349
|
+
expect(@loginator).to receive(:log).with(
|
|
350
|
+
"my_tool ↳ :arguments ➡️ `-I\"src` leaves a \" quote unclosed. Enclose the argument with \" quotes.", Verbosity::ERRORS
|
|
351
|
+
)
|
|
352
|
+
expect( validate( tool('gcc', :arguments => ['-g', '-I"src']) ) ).to be(false)
|
|
353
|
+
end
|
|
354
|
+
|
|
355
|
+
it 'raises on an unclosed quote under boom' do
|
|
356
|
+
expect { validate( tool('gcc', :arguments => ['-I"src']), boom: true ) }.to raise_error(CeedlingException, /leaves a " quote unclosed/)
|
|
357
|
+
end
|
|
358
|
+
|
|
359
|
+
it 'names a typographic quote as the likely cause of an unclosed one' do
|
|
360
|
+
expect(@loginator).to receive(:log).with(
|
|
361
|
+
"my_tool ↳ :arguments ➡️ `#{pasted}` leaves a \" quote unclosed. Enclose the argument with \" quotes. " \
|
|
362
|
+
"It holds ”, a typographic quote that a shell treats as an ordinary character. Replace it with \".", Verbosity::ERRORS
|
|
363
|
+
)
|
|
364
|
+
validate( tool('gcc', :arguments => [pasted]) )
|
|
365
|
+
end
|
|
366
|
+
|
|
367
|
+
# Closing quotes here would pair with an opening one in the next entry
|
|
368
|
+
it 'checks each argument on its own' do
|
|
369
|
+
expect( validate( tool('gcc', :arguments => ['-DMSG="a', 'b"']) ) ).to be(false)
|
|
370
|
+
end
|
|
371
|
+
|
|
372
|
+
it 'warns on a typographic quote in closed quoting and leaves the tool valid' do
|
|
373
|
+
expect(@loginator).to receive(:log).with(
|
|
374
|
+
"my_tool ↳ :arguments ➡️ `-D“x”` holds “ ”, typographic quotes that a shell treats as ordinary characters. " \
|
|
375
|
+
"Use \" or ' unless the characters are meant literally.", Verbosity::COMPLAIN
|
|
376
|
+
)
|
|
377
|
+
expect( validate( tool('gcc', :arguments => ["-D“x”"]) ) ).to be(true)
|
|
378
|
+
end
|
|
379
|
+
|
|
380
|
+
it "checks a hash argument's substitution string and values" do
|
|
381
|
+
expect( validate( tool('gcc', :arguments => [{ pasted => 'COLLECTION_PATHS' }]) ) ).to be(false)
|
|
382
|
+
expect( validate( tool('gcc', :arguments => [{ '-I"$"' => ['a', ['-D"b']] }]) ) ).to be(false)
|
|
383
|
+
end
|
|
384
|
+
|
|
385
|
+
it 'checks a substitution string given as a symbol' do
|
|
386
|
+
expect( validate( tool('gcc', :arguments => [{ :'-I"$' => 'COLLECTION_PATHS' }]) ) ).to be(false)
|
|
387
|
+
end
|
|
388
|
+
|
|
389
|
+
# ToolExecutor expands only a hash's first key, and only strings among its values
|
|
390
|
+
it 'checks only what a hash argument adds to the command line' do
|
|
391
|
+
expect( validate( tool('gcc', :arguments => [{ '-I"$"' => ['a', 8], '-D"b' => 'c' }]) ) ).to be(true)
|
|
392
|
+
end
|
|
393
|
+
|
|
394
|
+
# ToolExecutor drops an argument that is neither a string nor a hash
|
|
395
|
+
it 'skips a symbol argument' do
|
|
396
|
+
expect( validate( tool('gcc', :arguments => [:'-I"src']) ) ).to be(true)
|
|
397
|
+
end
|
|
398
|
+
|
|
399
|
+
it "reads past a Ruby expansion's own quotes" do
|
|
400
|
+
expect( validate( tool('gcc', :arguments => ['-D"NAME=#{ENV[\'USER\']}"']) ) ).to be(true)
|
|
401
|
+
end
|
|
402
|
+
|
|
403
|
+
it 'warns on a typographic quote in :executable and still looks for its file' do
|
|
404
|
+
expect(@loginator).to receive(:log).with(/:executable ➡️ `“cc”` holds “ ”/, Verbosity::COMPLAIN)
|
|
405
|
+
expect(@loginator).to receive(:log).with(/`“cc”` does not exist/, Verbosity::ERRORS)
|
|
406
|
+
expect( validate( tool("“cc”") ) ).to be(false)
|
|
407
|
+
end
|
|
408
|
+
|
|
409
|
+
it 'logs the warnings for a tool before raising on its error under boom' do
|
|
410
|
+
expect(@loginator).to receive(:log).with(/holds ”/, Verbosity::COMPLAIN)
|
|
411
|
+
expect { validate( tool('gcc', :arguments => ["-D\"x”\"", '-I"src']), boom: true ) }.to raise_error(CeedlingException, /`-I"src`/)
|
|
412
|
+
end
|
|
413
|
+
|
|
414
|
+
it 'checks an argument inside a nested list, as a YAML alias makes' do
|
|
415
|
+
expect( validate( tool('gcc', :arguments => [['-g', ['-I"src']]]) ) ).to be(false)
|
|
416
|
+
end
|
|
417
|
+
|
|
418
|
+
it 'checks an optional tool' do
|
|
419
|
+
expect( validate( tool('gcc', :optional => true, :arguments => ['-I"src']), respect_optional: true ) ).to be(false)
|
|
420
|
+
end
|
|
421
|
+
|
|
422
|
+
it 'reports an unclosed executable once, without looking for its file' do
|
|
423
|
+
expect(@file_wrapper).to_not receive(:exist?)
|
|
424
|
+
expect(@loginator).to receive(:log).once.with(
|
|
425
|
+
"my_tool ↳ :executable ➡️ `\"Code Cruncher”` leaves a \" quote unclosed. Enclose the executable with \" quotes. " \
|
|
426
|
+
"It holds ”, a typographic quote that a shell treats as an ordinary character. Replace it with \".", Verbosity::ERRORS
|
|
427
|
+
)
|
|
428
|
+
expect( validate( tool("\"Code Cruncher”") ) ).to be(false)
|
|
429
|
+
end
|
|
430
|
+
|
|
431
|
+
it 'reports every unclosed entry, and the other checks too' do
|
|
432
|
+
expect(@loginator).to receive(:log).with(/:arguments ➡️ `-I"a`/, Verbosity::ERRORS)
|
|
433
|
+
expect(@loginator).to receive(:log).with(/:arguments ➡️ `-I"b`/, Verbosity::ERRORS)
|
|
434
|
+
expect(@loginator).to receive(:log).with(/:stderr_redirect/, Verbosity::ERRORS)
|
|
435
|
+
validate( tool('gcc', :arguments => ['-I"a', '-I"b'], :stderr_redirect => :bogus) )
|
|
436
|
+
end
|
|
437
|
+
|
|
438
|
+
it 'reads a single quote as an ordinary character on Windows' do
|
|
439
|
+
allow(@system_wrapper).to receive(:windows?).and_return(true)
|
|
440
|
+
exists( '/usr/bin/gcc.exe' )
|
|
441
|
+
expect( validate( tool('gcc', :arguments => ["-IC:/Users/O'Brien"]) ) ).to be(true)
|
|
442
|
+
end
|
|
443
|
+
|
|
444
|
+
it 'passes arguments that are not strings' do
|
|
445
|
+
expect( validate( tool('gcc', :arguments => [8, nil]) ) ).to be(true)
|
|
446
|
+
end
|
|
447
|
+
end
|
|
339
448
|
end
|
|
@@ -0,0 +1,53 @@
|
|
|
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 'spec_helper'
|
|
9
|
+
require 'ceedling/defaults'
|
|
10
|
+
require 'ceedling/tools/tool_executor'
|
|
11
|
+
require 'ceedling/ruby_expandinator'
|
|
12
|
+
require 'ceedling/filesystem/win_long_paths'
|
|
13
|
+
|
|
14
|
+
# The default tool the long path probe reads the Windows registry with. Commands are built
|
|
15
|
+
# by a real ToolExecutor and never run, so this runs on every OS.
|
|
16
|
+
# spec/integration/windows_registry_query_tool_spec.rb runs it on Windows.
|
|
17
|
+
describe 'Default Windows registry query tool' do
|
|
18
|
+
before(:each) do
|
|
19
|
+
helper = double('tool_executor_helper').as_null_object
|
|
20
|
+
allow(helper).to receive(:osify_path_separators) { |path| path }
|
|
21
|
+
system_wrapper = double('system_wrapper').as_null_object
|
|
22
|
+
allow(system_wrapper).to receive(:constants_include?).and_return( false )
|
|
23
|
+
|
|
24
|
+
@tool_executor = ToolExecutor.new(
|
|
25
|
+
{
|
|
26
|
+
:tool_executor_helper => helper,
|
|
27
|
+
:loginator => double('loginator').as_null_object,
|
|
28
|
+
:verbosinator => double('verbosinator').as_null_object,
|
|
29
|
+
:system_wrapper => system_wrapper,
|
|
30
|
+
:ruby_expandinator => RubyExpandinator.new
|
|
31
|
+
}
|
|
32
|
+
)
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
# Configuration hands Ceedling an unfrozen copy of each default tool
|
|
36
|
+
def tool
|
|
37
|
+
return Marshal.load( Marshal.dump( DEFAULT_WINDOWS_REGISTRY_QUERY_TOOL ) )
|
|
38
|
+
end
|
|
39
|
+
|
|
40
|
+
it 'is optional, so a missing reg.exe never stops a build' do
|
|
41
|
+
expect( DEFAULT_WINDOWS_REGISTRY_QUERY_TOOL[:optional] ).to be true
|
|
42
|
+
end
|
|
43
|
+
|
|
44
|
+
it 'queries one value below one key, its backslashes intact' do
|
|
45
|
+
line = @tool_executor.build_command_line( tool, [], WinLongPaths::REGISTRY_KEY, WinLongPaths::REGISTRY_VALUE )[:line]
|
|
46
|
+
|
|
47
|
+
expect( line ).to eq( "#{FilePathUtils.os_executable_ext( 'reg' )} query \"HKLM\\SYSTEM\\CurrentControlSet\\Control\\FileSystem\" /v LongPathsEnabled" )
|
|
48
|
+
end
|
|
49
|
+
|
|
50
|
+
it 'is named for its log lines and errors' do
|
|
51
|
+
expect( @tool_executor.build_command_line( tool, [], 'HKLM\\X', 'Y' )[:name] ).to eq( 'default_windows_registry_query' )
|
|
52
|
+
end
|
|
53
|
+
end
|