ceedling 1.2.1 → 1.2.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/GIT_COMMIT_SHA +1 -1
- data/README.md +11 -9
- data/Rakefile +2 -1
- data/assets/features/ceedling +1 -1
- data/assets/fixtures/test_source_file_duplicate_basenames/test_calc_typo.c +14 -0
- data/assets/fixtures/tests_with_duplicate_test_names/test_foo.c +21 -0
- data/assets/fixtures/tests_with_partials_coverage/src/private_macro.c +7 -0
- data/assets/fixtures/tests_with_partials_coverage/src/private_macro.h +5 -0
- data/assets/fixtures/tests_with_partials_coverage/src/tally.c +13 -0
- data/assets/fixtures/tests_with_partials_coverage/src/tally.h +4 -0
- data/assets/fixtures/tests_with_partials_coverage/test/test_private_macro.c +10 -0
- data/assets/fixtures/tests_with_partials_coverage/test/test_tally.c +9 -0
- data/bin/actionator.rb +6 -12
- data/bin/app_cfg.rb +14 -1
- data/bin/ceedling +13 -3
- data/bin/cli.rb +25 -6
- data/bin/cli_handler.rb +113 -73
- data/bin/cli_helper.rb +51 -78
- data/bin/installation_selector.rb +81 -0
- data/bin/launchinator.rb +69 -0
- data/bin/mixin_resolvinator.rb +26 -36
- data/bin/objects.yml +13 -0
- data/bin/path_validator.rb +25 -29
- data/bin/versionator.rb +47 -48
- data/ceedling.gemspec +19 -15
- data/docs/BreakingChanges.md +86 -1
- data/docs/Changelog.md +145 -3
- data/docs/KnownIssues.md +179 -6
- data/docs/ReleaseNotes.md +13 -0
- data/examples/wondrous_forest/README.md +29 -1
- data/examples/wondrous_forest/src/ForestUnits.h +23 -0
- data/examples/wondrous_forest/src/RainGauge.c +59 -0
- data/examples/wondrous_forest/src/RainGauge.h +39 -0
- data/examples/wondrous_forest/src/RainTipIsr.c +17 -0
- data/examples/wondrous_forest/src/RainTipIsr.h +14 -0
- data/examples/wondrous_forest/test/TestRainGauge.c +126 -0
- data/lib/ceedling/build_log_writer.rb +33 -0
- data/lib/ceedling/c_extractor/README.md +15 -7
- data/lib/ceedling/c_extractor/c_extractor.rb +25 -14
- data/lib/ceedling/c_extractor/c_extractor_code_text.rb +84 -54
- data/lib/ceedling/c_extractor/c_extractor_constants.rb +18 -7
- data/lib/ceedling/c_extractor/c_extractor_declarations.rb +319 -283
- data/lib/ceedling/c_extractor/c_extractor_declarator.rb +285 -0
- data/lib/ceedling/c_extractor/c_extractor_defined_type.rb +111 -0
- data/lib/ceedling/c_extractor/c_extractor_definitions.rb +174 -121
- data/lib/ceedling/c_extractor/c_extractor_functions.rb +191 -162
- data/lib/ceedling/c_extractor/c_extractor_preprocessing.rb +46 -55
- data/lib/ceedling/c_extractor/c_extractor_statement.rb +30 -0
- data/lib/ceedling/c_extractor/c_extractor_types.rb +63 -41
- data/lib/ceedling/c_extractor/c_module_edits.rb +48 -0
- data/lib/ceedling/c_identifier.rb +21 -0
- data/lib/ceedling/ceedling.h +8 -0
- data/lib/ceedling/config/build_root_policy.rb +70 -0
- data/lib/ceedling/config/configurator.rb +18 -19
- data/lib/ceedling/config/configurator_builder.rb +75 -28
- data/lib/ceedling/config/configurator_paths_validator.rb +179 -0
- data/lib/ceedling/config/configurator_plugins.rb +1 -1
- data/lib/ceedling/config/configurator_setup.rb +44 -33
- data/lib/ceedling/config/configurator_validator.rb +1 -110
- data/lib/ceedling/constants.rb +5 -1
- data/lib/ceedling/defaults.rb +35 -5
- data/lib/ceedling/dependencies/CACHE_SCHEMA.md +118 -0
- data/lib/ceedling/dependencies/README.md +18 -16
- data/lib/ceedling/dependencies/dependency_cache_store.rb +43 -21
- data/lib/ceedling/dependencies/dependency_hasher.rb +35 -1
- data/lib/ceedling/dependencies/dependency_tracker.rb +9 -3
- data/lib/ceedling/dependencies/dependinator.rb +13 -1
- data/lib/ceedling/diagnostics/DOCTOR.md +142 -0
- data/lib/ceedling/diagnostics/README.md +5 -0
- data/lib/ceedling/diagnostics/build_step_doctor.rb +110 -0
- data/lib/ceedling/diagnostics/duplicate_symbol_specialist.rb +108 -0
- data/lib/ceedling/diagnostics/guidance_phrases.rb +30 -0
- data/lib/ceedling/diagnostics/header_collision_guidance.rb +56 -0
- data/lib/ceedling/diagnostics/header_collision_specialist.rb +152 -0
- data/lib/ceedling/diagnostics/include_depth_specialist.rb +132 -0
- data/lib/ceedling/diagnostics/missing_symbol_specialist.rb +111 -0
- data/lib/ceedling/diagnostics/partial_name_specialist.rb +134 -0
- data/lib/ceedling/diagnostics/toolchain_output.rb +44 -0
- data/lib/ceedling/filename_extension.rb +7 -1
- data/lib/ceedling/filesystem/FILE_TREE.md +253 -0
- data/lib/ceedling/filesystem/PATH_HANDLING.md +360 -0
- data/lib/ceedling/filesystem/README.md +46 -0
- data/lib/ceedling/filesystem/build_roots.rb +105 -0
- data/lib/ceedling/filesystem/build_subpath.rb +187 -0
- data/lib/ceedling/filesystem/destination_collision.rb +25 -0
- data/lib/ceedling/{file_finder.rb → filesystem/file_finder.rb} +177 -156
- data/lib/ceedling/filesystem/file_finder_helper.rb +154 -0
- data/lib/ceedling/filesystem/file_path_collection_utils.rb +183 -0
- data/lib/ceedling/{file_path_utils.rb → filesystem/file_path_utils.rb} +200 -167
- data/lib/ceedling/{file_system_wrapper.rb → filesystem/file_system_wrapper.rb} +6 -5
- data/lib/ceedling/filesystem/file_tree.rb +241 -0
- data/lib/ceedling/{file_wrapper.rb → filesystem/file_wrapper.rb} +149 -65
- data/lib/ceedling/filesystem/path_exclusions.rb +30 -0
- data/lib/ceedling/{path_matcher.rb → filesystem/path_matcher.rb} +48 -23
- data/lib/ceedling/{path_mirror.rb → filesystem/path_mirror.rb} +19 -18
- data/lib/ceedling/filesystem/path_spellings.rb +55 -0
- data/lib/ceedling/filesystem/project_paths.rb +184 -0
- data/lib/ceedling/filesystem/test_build_layout.rb +114 -0
- data/lib/ceedling/filesystem/win_long_paths.rb +153 -0
- data/lib/ceedling/filesystem/win_path_limit.rb +83 -0
- data/lib/ceedling/filesystem/win_path_prober.rb +52 -0
- data/lib/ceedling/filesystem/working_dir.rb +40 -0
- data/lib/ceedling/generators/generator.rb +32 -70
- data/lib/ceedling/generators/generator_helper.rb +0 -44
- data/lib/ceedling/generators/generator_mocks.rb +5 -0
- data/lib/ceedling/generators/generator_partials.rb +306 -244
- data/lib/ceedling/generators/generator_test_results_backtrace.rb +7 -7
- data/lib/ceedling/generators/generator_test_runner.rb +5 -8
- data/lib/ceedling/generators/partial_header_writer.rb +95 -0
- data/lib/ceedling/generators/partial_source_writer.rb +137 -0
- data/lib/ceedling/handoff.rb +121 -0
- data/lib/ceedling/includes/header_search.rb +225 -0
- data/lib/ceedling/includes/include_factory.rb +9 -12
- data/lib/ceedling/includes/include_pathinator.rb +112 -33
- data/lib/ceedling/includes/includes.rb +150 -38
- data/lib/ceedling/installation.rb +92 -0
- data/lib/ceedling/library_resolver.rb +99 -0
- data/lib/ceedling/objects.yml +112 -6
- data/lib/ceedling/partials/README.md +110 -16
- data/lib/ceedling/partials/carry_plan.rb +71 -0
- data/lib/ceedling/partials/definition_head.rb +74 -0
- data/lib/ceedling/partials/include_groups.rb +37 -0
- data/lib/ceedling/partials/interface_extras.rb +25 -0
- data/lib/ceedling/partials/partializer.rb +603 -124
- data/lib/ceedling/partials/partializer_config.rb +8 -1
- data/lib/ceedling/partials/partializer_helper.rb +851 -145
- data/lib/ceedling/partials/partializer_reconciler.rb +174 -0
- data/lib/ceedling/partials/partializer_utils.rb +89 -109
- data/lib/ceedling/partials/partials.rb +153 -10
- data/lib/ceedling/partials/type_macros.rb +126 -0
- data/lib/ceedling/plugins/report_log_writer_plugin.rb +3 -5
- data/lib/ceedling/preprocess/README.md +43 -33
- data/lib/ceedling/preprocess/preprocessinator.rb +100 -186
- data/lib/ceedling/preprocess/preprocessinator_code_finder.rb +65 -72
- data/lib/ceedling/preprocess/preprocessinator_file_assembler.rb +32 -76
- data/lib/ceedling/preprocess/preprocessinator_includes_handler.rb +1 -1
- data/lib/ceedling/preprocess/preprocessinator_line_marker_includes_extractor.rb +1 -1
- data/lib/ceedling/preprocess/preprocessinator_reconstructor.rb +51 -14
- data/lib/ceedling/rake_app/rakefile_component_resolver.rb +10 -17
- data/lib/ceedling/rakefile.rb +15 -1
- data/lib/ceedling/rakefiles/base/tasks_base.rake +1 -1
- data/lib/ceedling/rakefiles/release/rules_release.rake +4 -7
- data/lib/ceedling/release_invoker/release_build_executor.rb +33 -44
- data/lib/ceedling/release_invoker/release_build_planner.rb +14 -6
- data/lib/ceedling/reportinator.rb +3 -4
- data/lib/ceedling/setupinator.rb +104 -87
- data/lib/ceedling/test_context_extractor.rb +5 -1
- data/lib/ceedling/test_invoker/HEADER_COLLISIONS.md +21 -7
- data/lib/ceedling/test_invoker/PIPELINE.md +62 -19
- data/lib/ceedling/test_invoker/README.md +1 -1
- data/lib/ceedling/test_invoker/derived_search_path_notices.rb +45 -0
- data/lib/ceedling/test_invoker/mock_locator.rb +175 -10
- data/lib/ceedling/test_invoker/partial_files_preprocessinator.rb +181 -0
- data/lib/ceedling/test_invoker/partials_manager.rb +271 -302
- data/lib/ceedling/test_invoker/standin_headerinator.rb +19 -17
- data/lib/ceedling/test_invoker/test_bare_includes_extractinator.rb +26 -3
- data/lib/ceedling/test_invoker/test_build_executor.rb +358 -234
- data/lib/ceedling/test_invoker/test_build_planner.rb +46 -33
- data/lib/ceedling/test_invoker/test_build_setup.rb +43 -18
- data/lib/ceedling/test_invoker/test_build_validations.rb +35 -47
- data/lib/ceedling/test_invoker/test_derived_search_paths.rb +189 -0
- data/lib/ceedling/test_invoker/test_file_preprocessinator.rb +2 -3
- data/lib/ceedling/test_invoker/test_includes_reconcilinator.rb +1 -1
- data/lib/ceedling/test_invoker/test_invoker.rb +6 -1
- data/lib/ceedling/test_invoker/test_invoker_types.rb +28 -20
- data/lib/ceedling/test_invoker/test_pipeline_helpers.rb +6 -4
- data/lib/ceedling/test_invoker/test_pipeline_manager.rb +25 -8
- data/lib/ceedling/test_invoker/test_runner_generatinator.rb +31 -3
- data/lib/ceedling/test_invoker/test_search_paths.rb +30 -8
- data/lib/ceedling/test_invoker/test_source_file_directive_resolver.rb +40 -20
- data/lib/ceedling/test_invoker/test_substitutions.rb +72 -0
- data/lib/ceedling/tools/shell_quoting.rb +45 -0
- data/lib/ceedling/{tool_executor.rb → tools/tool_executor.rb} +9 -3
- data/lib/ceedling/tools/tool_quoting.rb +79 -0
- data/lib/ceedling/{tool_validator.rb → tools/tool_validator.rb} +18 -7
- data/lib/ceedling/yaml_wrapper.rb +3 -2
- data/lib/version.rb +1 -1
- data/plugins/bullseye/bullseye.rake +1 -3
- data/plugins/bullseye/config/defaults_bullseye.rb +1 -1
- data/plugins/bullseye/lib/bullseye.rb +24 -9
- data/plugins/command_hooks/lib/command_hooks.rb +1 -1
- data/plugins/cppcheck/config/defaults_cppcheck.rb +1 -1
- data/plugins/dependencies/config/defaults.yml +6 -6
- data/plugins/dependencies/dependencies.rake +4 -1
- data/plugins/dependencies/lib/dependencies.rb +18 -8
- data/plugins/dependencies/lib/dependency_spec.rb +17 -5
- data/plugins/fff/lib/fff.rb +79 -46
- data/plugins/fff/lib/fff_mock_generator.rb +12 -9
- data/plugins/fff/spec/fff_cmock_wrapper_spec.rb +262 -0
- data/plugins/fff/spec/fff_mock_header_generator_spec.rb +9 -0
- data/plugins/fff/spec/fff_mock_source_generator_spec.rb +20 -0
- data/plugins/gcov/config/defaults_gcov.rb +1 -1
- data/plugins/gcov/lib/console_reportinator.rb +28 -36
- data/plugins/gcov/lib/gcov.rb +9 -2
- data/plugins/gcov/lib/gcovr_reportinator.rb +8 -40
- data/plugins/gcov/lib/gcovr_thresholds.rb +74 -0
- data/plugins/gcov/lib/reportgenerator_reportinator.rb +3 -2
- data/plugins/module_generator/lib/module_generator.rb +3 -3
- data/plugins/report_tests_teamcity_stdout/lib/report_tests_teamcity_stdout.rb +53 -80
- data/plugins/sanitize/lib/sanitize_records.rb +3 -6
- data/plugins/valgrind/lib/valgrind.rb +14 -7
- data/site-local/404.html +2 -2
- data/site-local/assets/javascripts/{bundle.c21346df.min.js → bundle.a5f9d56c.min.js} +1 -1
- data/site-local/assets/javascripts/{bundle.c21346df.min.js.map → bundle.a5f9d56c.min.js.map} +2 -2
- data/site-local/configuration/environment-vars.html +2 -2
- data/site-local/configuration/global-collections.html +3 -3
- data/site-local/configuration/index.html +2 -2
- data/site-local/configuration/loading.html +2 -2
- data/site-local/configuration/mixins.html +2 -2
- data/site-local/configuration/parallel-builds.html +2 -2
- data/site-local/configuration/project-file.html +2 -2
- data/site-local/configuration/reference/cexception.html +2 -2
- data/site-local/configuration/reference/cmock.html +7 -3
- data/site-local/configuration/reference/defines.html +2 -2
- data/site-local/configuration/reference/environment.html +2 -2
- data/site-local/configuration/reference/extension.html +2 -2
- data/site-local/configuration/reference/files.html +65 -12
- data/site-local/configuration/reference/flags.html +2 -2
- data/site-local/configuration/reference/index.html +2 -2
- data/site-local/configuration/reference/libraries.html +23 -5
- data/site-local/configuration/reference/mixins.html +2 -2
- data/site-local/configuration/reference/partials.html +84 -2
- data/site-local/configuration/reference/paths.html +36 -8
- data/site-local/configuration/reference/plugins.html +2 -2
- data/site-local/configuration/reference/project.html +264 -12
- data/site-local/configuration/reference/release-build.html +4 -2
- data/site-local/configuration/reference/test-build.html +2 -2
- data/site-local/configuration/reference/test-runner.html +2 -2
- data/site-local/configuration/reference/tools.html +58 -4
- data/site-local/configuration/reference/unity.html +2 -2
- data/site-local/configuration/which-ceedling.html +379 -19
- data/site-local/development/index.html +2 -2
- data/site-local/development/plugins/configuration.html +2 -2
- data/site-local/development/plugins/index.html +2 -2
- data/site-local/development/plugins/plugin-subclass.html +5 -4
- data/site-local/development/plugins/rake-tasks.html +2 -2
- data/site-local/development/releases.html +7 -3
- data/site-local/development/workflow.html +50 -45
- data/site-local/getting-started/builds.html +4 -2
- data/site-local/getting-started/command-line.html +58 -6
- data/site-local/getting-started/example-projects/cipher-quest.html +2 -2
- data/site-local/getting-started/example-projects/index.html +2 -2
- data/site-local/getting-started/example-projects/temp-sensor.html +2 -2
- data/site-local/getting-started/example-projects/wondrous-forest.html +10 -2
- data/site-local/getting-started/index.html +2 -2
- data/site-local/getting-started/installation.html +2 -2
- data/site-local/getting-started/quick-start.html +2 -2
- data/site-local/help.html +2 -2
- data/site-local/index.html +2 -2
- data/site-local/overview/build-system.html +2 -2
- data/site-local/overview/index.html +2 -2
- data/site-local/overview/test-environments.html +2 -2
- data/site-local/overview/tools-and-frameworks.html +2 -2
- data/site-local/plugins/beep.html +2 -2
- data/site-local/plugins/bullseye/index.html +45 -38
- data/site-local/plugins/bullseye/licensing.html +2 -2
- data/site-local/plugins/command-hooks.html +4 -4
- data/site-local/plugins/compile-commands-json-db.html +2 -2
- data/site-local/plugins/cppcheck.html +2 -2
- data/site-local/plugins/dependencies.html +8 -5
- data/site-local/plugins/fff.html +58 -13
- data/site-local/plugins/gcov/examples.html +2 -2
- data/site-local/plugins/gcov/gcovr.html +23 -14
- data/site-local/plugins/gcov/index.html +2 -2
- data/site-local/plugins/gcov/overview.html +2 -2
- data/site-local/plugins/gcov/reportgenerator.html +18 -14
- data/site-local/plugins/gcov/reporting.html +2 -2
- data/site-local/plugins/gcov/setup.html +4 -3
- data/site-local/plugins/gcov/tool-versions.html +2 -2
- data/site-local/plugins/gcov/troubleshooting.html +2 -2
- data/site-local/plugins/index.html +2 -2
- data/site-local/plugins/module-generator.html +2 -2
- data/site-local/plugins/report-build-warnings-log.html +2 -2
- data/site-local/plugins/report-tests-gtestlike-stdout.html +2 -2
- data/site-local/plugins/report-tests-ide-stdout.html +2 -2
- data/site-local/plugins/report-tests-log-factory.html +2 -2
- data/site-local/plugins/report-tests-pretty-stdout.html +2 -2
- data/site-local/plugins/report-tests-raw-output-log.html +5 -3
- data/site-local/plugins/report-tests-teamcity-stdout.html +8 -5
- data/site-local/plugins/sanitize.html +9 -8
- data/site-local/plugins/valgrind.html +10 -9
- data/site-local/project/index.html +2 -2
- data/site-local/project/release-history.html +2 -2
- data/site-local/project/sbom.html +2 -2
- data/site-local/project/upgrade.html +5 -2
- data/site-local/reference/build-directives.html +2 -2
- data/site-local/reference/command-line.html +11 -4
- data/site-local/reference/environment-vars.html +2 -2
- data/site-local/reference/gcov-plugin.html +2 -2
- data/site-local/reference/global-collections.html +12 -12
- data/site-local/reference/index.html +2 -2
- data/site-local/reference/partials-macros.html +47 -2
- data/site-local/reference/project-configuration.html +2 -2
- data/site-local/sitemap.xml.gz +0 -0
- data/site-local/snapshot/examples/cipher_quest/index.html +2 -2
- data/site-local/snapshot/examples/temp_sensor/index.html +2 -2
- data/site-local/snapshot/examples/wondrous_forest/index.html +72 -15
- data/site-local/snapshot/plugins/bullseye/config/defaults_bullseye.rb +1 -1
- data/site-local/snapshot/plugins/gcov/config/defaults_gcov.rb +1 -1
- data/site-local/testing-guide/build-directives.html +2 -2
- data/site-local/testing-guide/conventions.html +113 -15
- data/site-local/testing-guide/frameworks.html +2 -2
- data/site-local/testing-guide/index.html +2 -2
- data/site-local/testing-guide/partials/configuration.html +31 -4
- data/site-local/testing-guide/partials/conventions.html +509 -8
- data/site-local/testing-guide/partials/directives.html +4 -3
- data/site-local/testing-guide/partials/example.html +2 -2
- data/site-local/testing-guide/partials/index.html +2 -2
- data/site-local/testing-guide/partials/overview.html +30 -12
- data/site-local/testing-guide/partials/variables.html +169 -4
- data/site-local/testing-guide/test-cases.html +2 -2
- data/site-local/testing-guide/test-sample.html +2 -2
- data/site-local/testing-guide/test-suite-anatomy.html +2 -2
- data/spec/integration/actionator_file_operations_spec.rb +91 -1
- data/spec/integration/build_step_doctor_spec.rb +270 -0
- data/spec/integration/c_extractor_composition_spec.rb +254 -4
- data/spec/integration/compile_commands_json_db_spec.rb +1 -1
- data/spec/integration/configurator_validation_spec.rb +1 -1
- data/spec/integration/dependencies/dependency_tracker_cache_hardening_spec.rb +26 -0
- data/spec/integration/dependencies/dependency_tracker_core_spec.rb +22 -0
- data/spec/integration/includes_extraction_spec.rb +27 -14
- data/spec/integration/launcher_handoff_spec.rb +297 -0
- data/spec/integration/mixin_loading_spec.rb +1 -1
- data/spec/integration/module_generator_spec.rb +3 -3
- data/spec/integration/nested_test_artifacts_spec.rb +99 -0
- data/spec/integration/partial_files_preprocessing_spec.rb +128 -0
- data/spec/integration/partials_carry_spec.rb +520 -0
- data/spec/integration/partials_declarations_spec.rb +655 -0
- data/spec/integration/partials_fallback_preprocessing_spec.rb +65 -0
- data/spec/integration/partials_function_pointers_spec.rb +277 -0
- data/spec/integration/partials_header_composition_spec.rb +268 -35
- data/spec/integration/partials_macro_decorators_spec.rb +267 -0
- data/spec/integration/partials_module_resolution_spec.rb +33 -23
- data/spec/integration/partials_symbol_linkage_spec.rb +13 -0
- data/spec/integration/path_intake_scenarios_spec.rb +101 -0
- data/spec/integration/path_length_reporting_spec.rb +64 -0
- data/spec/integration/path_scenarios_spec.rb +399 -0
- data/spec/integration/quote_include_isolator_spec.rb +57 -1
- data/spec/integration/report_build_warnings_log_spec.rb +1 -1
- data/spec/integration/report_tests_log_factory_spec.rb +1 -1
- data/spec/integration/test_build_parallel_barrier_spec.rb +1 -1
- data/spec/integration/test_executable_manifest_spec.rb +1 -1
- data/spec/integration/test_includes_extractinator_spec.rb +69 -3
- data/spec/integration/test_naming_spec.rb +201 -0
- data/spec/integration/test_source_file_checks_spec.rb +168 -0
- data/spec/integration/tool_executor_spec.rb +1 -1
- data/spec/integration/tool_validator_spec.rb +3 -3
- data/spec/integration/upgrade_docs_spec.rb +84 -0
- data/spec/integration/vendor_copy_transient_io_retry_spec.rb +74 -5
- data/spec/integration/win_long_paths_probe_spec.rb +46 -0
- data/spec/integration/win_path_limit_spec.rb +53 -0
- data/spec/integration/windows_registry_query_tool_spec.rb +41 -0
- data/spec/support/file_tree_helper.rb +88 -0
- data/spec/support/integration/configurator_integration_helper.rb +14 -9
- data/spec/support/integration/dependency_tracker_integration_helper.rb +1 -1
- data/spec/support/integration/partial_files_harness.rb +181 -0
- data/spec/support/integration/partials_generation_integration_helper.rb +239 -143
- data/spec/support/integration/path_scenario_harness.rb +175 -0
- data/spec/support/integration/spec_integration_helper.rb +9 -4
- data/spec/support/integration/test_includes_harness.rb +69 -37
- data/spec/support/integration/tool_executor_integration_helper.rb +14 -2
- data/spec/support/spec_helper.rb +2 -0
- data/spec/support/system/spec_system_helper.rb +7 -6
- data/spec/support/system/system_context.rb +21 -3
- data/spec/support/working_dir_tracking.rb +49 -0
- data/spec/system/build_output_mirroring_spec.rb +2 -2
- data/spec/system/bullseye_deployment_spec.rb +2 -0
- data/spec/system/conditional_mock_includes_spec.rb +1 -1
- data/spec/system/delta_builds_spec.rb +163 -23
- data/spec/system/encoding_stress_spec.rb +4 -4
- data/spec/system/example_wondrous_forest_spec.rb +2 -2
- data/spec/system/gcov_deployment_spec.rb +3 -0
- data/spec/system/header_include_path_validation_spec.rb +4 -4
- data/spec/system/header_search_paths_spec.rb +1083 -0
- data/spec/system/launcher_handoff_spec.rb +82 -0
- data/spec/system/mock_include_folders_spec.rb +212 -0
- data/spec/system/mockable_header_reassembly_spec.rb +184 -0
- data/spec/system/parent_directory_reference_spec.rb +5 -3
- data/spec/system/partials_carry_spec.rb +581 -0
- data/spec/system/partials_delta_builds_spec.rb +280 -0
- data/spec/system/partials_function_pointers_spec.rb +106 -0
- data/spec/system/partials_macro_decorators_spec.rb +127 -0
- data/spec/system/partials_module_disambiguation_spec.rb +125 -0
- data/spec/system/path_handling_probes_spec.rb +196 -0
- data/spec/system/pinned_thread_count_spec.rb +4 -4
- data/spec/system/preprocessing_fallback_conditionals_spec.rb +1 -1
- data/spec/system/preprocessing_parameterized_tests_spec.rb +1 -1
- data/spec/system/rake_release_task_path_disambiguation_spec.rb +6 -6
- data/spec/system/rake_test_task_path_disambiguation_spec.rb +85 -0
- data/spec/system/short_build_paths_spec.rb +87 -0
- data/spec/system/sibling_header_collision_spec.rb +30 -6
- data/spec/system/special_path_characters_spec.rb +86 -0
- data/spec/system/support/bullseye_common_test_cases.rb +42 -0
- data/spec/system/support/common_test_cases.rb +23 -21
- data/spec/system/support/gcov_common_test_cases.rb +37 -9
- data/spec/system/support/gcov_partials_test_cases.rb +48 -0
- data/spec/system/support/sanitize_common_test_cases.rb +2 -2
- data/spec/system/support/valgrind_common_test_cases.rb +12 -12
- data/spec/system/test_build_layout_spec.rb +209 -0
- data/spec/system/test_pipeline_stop_points_spec.rb +4 -4
- data/spec/system/test_runner_system_include_spec.rb +1 -1
- data/spec/system/test_source_file_directive_spec.rb +64 -5
- data/spec/units/bin/actionator_spec.rb +14 -17
- data/spec/units/bin/app_cfg_spec.rb +37 -0
- data/spec/units/bin/cli_handler_spec.rb +282 -6
- data/spec/units/bin/cli_helper_spec.rb +116 -45
- data/spec/units/bin/installation_selector_spec.rb +114 -0
- data/spec/units/bin/launchinator_spec.rb +171 -0
- data/spec/units/bin/path_validator_spec.rb +10 -0
- data/spec/units/bin/versionator_spec.rb +38 -6
- data/spec/units/build_log_writer_spec.rb +57 -0
- data/spec/units/c_extractor/c_extractor_code_text_spec.rb +67 -10
- data/spec/units/c_extractor/c_extractor_declarations_spec.rb +501 -4
- data/spec/units/c_extractor/c_extractor_declarator_spec.rb +245 -0
- data/spec/units/c_extractor/c_extractor_defined_type_spec.rb +45 -0
- data/spec/units/c_extractor/c_extractor_definitions_spec.rb +163 -3
- data/spec/units/c_extractor/c_extractor_functions_spec.rb +462 -21
- data/spec/units/c_extractor/c_extractor_preprocessing_spec.rb +39 -0
- data/spec/units/c_extractor/c_extractor_spec.rb +4 -4
- data/spec/units/c_extractor/c_extractor_types_spec.rb +163 -0
- data/spec/units/c_identifier_spec.rb +35 -0
- data/spec/units/config/build_root_policy_spec.rb +61 -0
- data/spec/units/config/configurator_builder_spec.rb +61 -6
- data/spec/units/config/configurator_paths_validator_spec.rb +292 -0
- data/spec/units/config/configurator_setup_spec.rb +80 -68
- data/spec/units/config/configurator_spec.rb +54 -6
- data/spec/units/config/configurator_validator_spec.rb +1 -172
- data/spec/units/dependencies/dependency_cache_store_spec.rb +98 -2
- data/spec/units/dependencies/dependency_debug_tree_spec.rb +1 -1
- data/spec/units/dependencies/dependency_hasher_spec.rb +42 -1
- data/spec/units/dependencies/dependency_path_normalizer_spec.rb +1 -1
- data/spec/units/dependencies/dependency_tracker_spec.rb +28 -1
- data/spec/units/dependencies/dependinator_spec.rb +17 -2
- data/spec/units/diagnostics/build_step_doctor_spec.rb +170 -0
- data/spec/units/diagnostics/duplicate_symbol_specialist_spec.rb +117 -0
- data/spec/units/diagnostics/header_collision_specialist_spec.rb +267 -0
- data/spec/units/diagnostics/include_depth_specialist_spec.rb +137 -0
- data/spec/units/diagnostics/missing_symbol_specialist_spec.rb +154 -0
- data/spec/units/diagnostics/partial_name_specialist_spec.rb +129 -0
- data/spec/units/diagnostics/toolchain_output_spec.rb +86 -0
- data/spec/units/encodinator_spec.rb +3 -4
- data/spec/units/filename_extension_spec.rb +11 -0
- data/spec/units/filesystem/build_roots_spec.rb +131 -0
- data/spec/units/filesystem/build_subpath_spec.rb +235 -0
- data/spec/units/filesystem/destination_collision_spec.rb +30 -0
- data/spec/units/{file_finder_helper_spec.rb → filesystem/file_finder_helper_spec.rb} +126 -1
- data/spec/units/filesystem/file_finder_spec.rb +845 -0
- data/spec/units/{file_path_collection_utils_spec.rb → filesystem/file_path_collection_utils_spec.rb} +181 -1
- data/spec/units/{file_path_utils_spec.rb → filesystem/file_path_utils_spec.rb} +435 -185
- data/spec/units/filesystem/file_system_wrapper_spec.rb +33 -0
- data/spec/units/filesystem/file_tree_spec.rb +511 -0
- data/spec/units/filesystem/file_tree_windows_spec.rb +78 -0
- data/spec/units/{file_wrapper_spec.rb → filesystem/file_wrapper_spec.rb} +286 -18
- data/spec/units/{path_matcher_spec.rb → filesystem/path_matcher_spec.rb} +48 -1
- data/spec/units/{path_mirror_spec.rb → filesystem/path_mirror_spec.rb} +32 -4
- data/spec/units/filesystem/project_paths_spec.rb +147 -0
- data/spec/units/filesystem/test_build_layout_spec.rb +216 -0
- data/spec/units/filesystem/win_long_paths_spec.rb +204 -0
- data/spec/units/filesystem/win_path_prober_spec.rb +158 -0
- data/spec/units/filesystem/working_dir_spec.rb +71 -0
- data/spec/units/generators/generator_helper_spec.rb +0 -60
- data/spec/units/generators/generator_mocks_spec.rb +13 -0
- data/spec/units/generators/generator_partials_spec.rb +656 -55
- data/spec/units/generators/generator_spec.rb +38 -6
- data/spec/units/generators/generator_test_results_backtrace_spec.rb +50 -46
- data/spec/units/generators/generator_test_results_spec.rb +1 -1
- data/spec/units/generators/generator_test_runner_spec.rb +9 -5
- data/spec/units/generators/partial_source_writer_spec.rb +129 -0
- data/spec/units/handoff_spec.rb +205 -0
- data/spec/units/includes/header_search_spec.rb +406 -0
- data/spec/units/includes/include_factory_spec.rb +23 -6
- data/spec/units/includes/include_pathinator_spec.rb +118 -8
- data/spec/units/includes/include_spec.rb +14 -0
- data/spec/units/includes/includes_spec.rb +176 -19
- data/spec/units/installation_spec.rb +228 -0
- data/spec/units/library_resolver_spec.rb +157 -0
- data/spec/units/loginator_spec.rb +31 -0
- data/spec/units/mock_locator_spec.rb +275 -6
- data/spec/units/partials/include_groups_spec.rb +42 -0
- data/spec/units/partials/partializer_config_spec.rb +32 -0
- data/spec/units/partials/partializer_helper_carry_spec.rb +661 -0
- data/spec/units/partials/partializer_helper_interface_extras_spec.rb +396 -0
- data/spec/units/partials/partializer_helper_spec.rb +529 -277
- data/spec/units/partials/partializer_reconciler_spec.rb +661 -0
- data/spec/units/partials/partializer_spec.rb +1579 -270
- data/spec/units/partials/partializer_utils_spec.rb +269 -232
- data/spec/units/partials/partials_rename_spec.rb +160 -0
- data/spec/units/partials_manager_spec.rb +561 -251
- data/spec/units/plugins/bullseye_spec.rb +49 -2
- data/spec/units/plugins/console_reportinator_spec.rb +73 -26
- data/spec/units/plugins/dependencies_spec.rb +33 -7
- data/spec/units/plugins/dependency_spec_spec.rb +17 -0
- data/spec/units/plugins/gcov_spec.rb +28 -3
- data/spec/units/plugins/gcovr_reportinator_spec.rb +19 -47
- data/spec/units/plugins/gcovr_thresholds_spec.rb +95 -0
- data/spec/units/plugins/module_generator_spec.rb +5 -5
- data/spec/units/plugins/report_build_warnings_log_spec.rb +3 -3
- data/spec/units/plugins/report_log_writer_plugin_spec.rb +10 -1
- data/spec/units/plugins/report_tests_raw_output_log_spec.rb +13 -2
- data/spec/units/plugins/report_tests_teamcity_stdout_spec.rb +77 -3
- data/spec/units/plugins/reportgenerator_reportinator_spec.rb +52 -4
- data/spec/units/plugins/sanitize_records_spec.rb +3 -1
- data/spec/units/plugins/sanitize_spec.rb +1 -1
- data/spec/units/plugins/valgrind_spec.rb +23 -8
- data/spec/units/preprocess/preprocessinator_code_finder_spec.rb +73 -10
- data/spec/units/preprocess/preprocessinator_comment_stripper_spec.rb +1 -1
- data/spec/units/preprocess/preprocessinator_file_assembler_spec.rb +125 -37
- data/spec/units/preprocess/preprocessinator_includes_handler_spec.rb +15 -0
- data/spec/units/preprocess/preprocessinator_reconstructor_spec.rb +197 -0
- data/spec/units/preprocess/preprocessinator_spec.rb +153 -95
- data/spec/units/rake_app/rakefile_component_resolver_spec.rb +21 -0
- data/spec/units/release_build_executor_spec.rb +53 -14
- data/spec/units/release_build_planner_spec.rb +15 -3
- data/spec/units/reportinator_spec.rb +5 -5
- data/spec/units/setupinator_spec.rb +51 -0
- data/spec/units/standin_headerinator_spec.rb +55 -9
- data/spec/units/test_build_executor_spec.rb +842 -166
- data/spec/units/test_build_planner_spec.rb +205 -15
- data/spec/units/test_build_setup_spec.rb +179 -30
- data/spec/units/test_context_extractor_spec.rb +36 -2
- data/spec/units/test_derived_search_paths_spec.rb +259 -0
- data/spec/units/test_file_preprocessinator_spec.rb +17 -1
- data/spec/units/test_includes_extractinator_spec.rb +61 -9
- data/spec/units/test_invoker/objects_wiring_spec.rb +24 -4
- data/spec/units/test_invoker/partial_files_preprocessinator_spec.rb +264 -0
- data/spec/units/test_invoker/test_substitutions_spec.rb +122 -0
- data/spec/units/test_invoker_spec.rb +14 -1
- data/spec/units/test_invoker_types_spec.rb +8 -7
- data/spec/units/test_pipeline_manager_spec.rb +54 -13
- data/spec/units/test_runner_generatinator_spec.rb +93 -1
- data/spec/units/test_search_paths_spec.rb +73 -5
- data/spec/units/test_source_file_directive_resolver_spec.rb +38 -7
- data/spec/units/tools/default_tools_quoting_spec.rb +117 -0
- data/spec/units/tools/shell_quoting_spec.rb +76 -0
- data/spec/units/{tool_executor_helper_spec.rb → tools/tool_executor_helper_spec.rb} +1 -1
- data/spec/units/{tool_executor_spec.rb → tools/tool_executor_spec.rb} +27 -1
- data/spec/units/{tool_validator_spec.rb → tools/tool_validator_spec.rb} +110 -1
- data/spec/units/windows_registry_query_tool_spec.rb +53 -0
- data/spec/units/yaml_wrapper_spec.rb +11 -0
- metadata +265 -36
- data/lib/ceedling/file_finder_helper.rb +0 -127
- data/lib/ceedling/file_path_collection_utils.rb +0 -164
- data/spec/units/file_finder_spec.rb +0 -495
- /data/lib/ceedling/{tool_executor_helper.rb → tools/tool_executor_helper.rb} +0 -0
data/docs/Changelog.md
CHANGED
|
@@ -8,6 +8,148 @@ This changelog is complemented by three other documents:
|
|
|
8
8
|
1. 💔 **[Breaking Changes](BreakingChanges.md)** for a list of impacts to existing Ceedling projects.
|
|
9
9
|
1. 🐛 **[Known Issues](KnownIssues.md)** for a list of presently known problems and limitations.
|
|
10
10
|
|
|
11
|
+
Each release has its own section, listing only what changed in that release.
|
|
12
|
+
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
# [1.2.3] — 2026-11-20
|
|
16
|
+
|
|
17
|
+
## 💪 Fixed
|
|
18
|
+
|
|
19
|
+
- [#1385](https://github.com/ThrowTheSwitch/Ceedling/issues/1385) Fixed the [Bullseye plugin’s](https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/bullseye/) `report:bullseye` task including Unity, generated test runners, and test files in its HTML and XML reports when run on the same command line as a fresh `bullseye:` build, as in `ceedling bullseye:all report:bullseye`. Its reports now leave out the same sources as automatic reports. With no coverage file yet, it reports that and writes nothing, rather than failing with a license hint.
|
|
20
|
+
- Fixed one long build path being reported several times, once for each step that created or wrote it. Ceedling now reports each path once.
|
|
21
|
+
- Fixed a flood of notices about headers sharing a directory being logged once for every pair of them, on every build and for every test, whether or not anything failed. A directory of 40 headers gave 780 lines. The guidance now appears only when a compilation fails with what looks like a redeclaration or conflicting types, once for each directory holding a header the compiler names, and explains how the collision can arise and how to resolve it.
|
|
22
|
+
- [#1387](https://github.com/ThrowTheSwitch/Ceedling/issues/1387) Fixed long configured paths lengthening every build path below them ([#1370](https://github.com/ThrowTheSwitch/Ceedling/issues/1370)). A `:paths` root far outside the project, such as a vendor’s include directory, or nested deep inside it, is now spelled in build paths by a short `_<name>_<hash>` name, and everything below it keeps its path. Short roots such as `src/` are unchanged. `build/build_roots.yml` lists each shortened root ([build output](https://docs.throwtheswitch.org/Ceedling/1.2.0/testing-guide/conventions/#test-names-build-output)). The first build after upgrading rebuilds everything once.
|
|
23
|
+
- [#1391](https://github.com/ThrowTheSwitch/Ceedling/issues/1391) Fixed a [delta build](https://docs.throwtheswitch.org/Ceedling/1.2.0/getting-started/builds/) reusing a test’s [Partials](https://docs.throwtheswitch.org/Ceedling/1.2.0/testing-guide/partials/) after the test changed which functions it selects, such as `TEST_PARTIAL_PUBLIC_MODULE` to `TEST_PARTIAL_ALL_MODULE`. A change that rewrote only the preprocessed copies a Partial is made from, such as toggling [`:test_build` ↳ `:preprocess_force_fallback`](https://docs.throwtheswitch.org/Ceedling/1.2.0/configuration/reference/test-build/#preprocess_force_fallback), was missed the same way. A Partial now regenerates when either changes.
|
|
24
|
+
- [#1408](https://github.com/ThrowTheSwitch/Ceedling/issues/1408) Fixed a [delta build](https://docs.throwtheswitch.org/Ceedling/1.2.0/getting-started/builds/) recompiling some of a test’s objects on every run when Ceedling isolated a header beside one the test mocks. Nothing had changed, but each build gave the isolated copy a directory with a new name. A rebuild now weighs the original headers, so it compiles only what changed, and compiler messages about an isolated header name the original. Isolation also now runs only where it can help, for a mocked header with `:cmock` ↳ `:treat_inlines: :include`. With other mocks and with [Partials](https://docs.throwtheswitch.org/Ceedling/1.2.0/testing-guide/partials/) it changed nothing, so its notice and second compile no longer appear there.
|
|
25
|
+
- [#1425](https://github.com/ThrowTheSwitch/Ceedling/issues/1425) Fixed a [delta build](https://docs.throwtheswitch.org/Ceedling/1.2.0/getting-started/builds/) regenerating every mock when only `--verbosity` changed, and keeping every mock when the [FFF plugin](https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/fff/) was turned on or off. A test rewritten for the other generator failed to compile until a clobber. Verbosity no longer counts as a change to a mock, and switching generators regenerates each one. The first build after upgrading regenerates every mock once.
|
|
26
|
+
- [#1428](https://github.com/ThrowTheSwitch/Ceedling/issues/1428) Fixed a [delta build](https://docs.throwtheswitch.org/Ceedling/1.2.0/getting-started/builds/) ignoring edits to a mocked header after `:cmock` ↳ `:treat_inlines` changed from `:include` to `:exclude`. The copy of the header CMock wrote beside the mock stayed, and the build compiled against it until a clobber. A mock generated again now removes that copy.
|
|
27
|
+
- [#1434](https://github.com/ThrowTheSwitch/Ceedling/issues/1434) Fixed a [delta build](https://docs.throwtheswitch.org/Ceedling/1.2.0/getting-started/builds/) ignoring edits to a header a test stopped mocking, with `:cmock` ↳ `:treat_inlines: :include`. The copy of the header CMock wrote beside the mock stayed in the test’s mock directory, which remains on the test’s search paths, and the build compiled against it until a clobber. With `:use_test_preprocessor` set to `:tests` or `:all`, the build stopped instead, reporting ``Found no file `build/test/mocks/test/test_c/drivers/foo.h` in search paths.`` Collecting a test’s `#include`s with test preprocessing also read the copy of a header the test still mocks, missing an edit to it that changes which other mocks the test needs. Each build now removes the copies no current mock names and keeps copies out of `#include` collection.
|
|
28
|
+
- [#1435](https://github.com/ThrowTheSwitch/Ceedling/issues/1435) Fixed an [FFF](https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/fff/) fake of a header holding an inline function failing to compile with `:cmock` ↳ `:treat_inlines: :include`, reporting a redefinition of the function. The fake included the original header, which defines the function the fake defines too. A fake now writes a copy of the header without its inline function bodies beside itself and includes that, as a mock does.
|
|
29
|
+
- [#1440](https://github.com/ThrowTheSwitch/Ceedling/issues/1440) Fixed an [FFF](https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/fff/) fake of a header with an extension other than `.h`, such as `.hpp`, failing to build. A fake of `drivers/foox.hpp` was written as `drivers/mock_foox.hpp.h` and `drivers/mock_foox.hpp.c`, so a test including `drivers/mock_foox.hpp` stopped with ``Found no file `drivers/mock_foox.c` in search paths.``, or with a missing-file error from the compiler under test preprocessing. A fake is now named as CMock names a mock, `drivers/mock_foox.hpp` and `drivers/mock_foox.c`. A CMock mock of such a header also no longer logs `Failed to generate directive-only preprocessor output` under test preprocessing, since its stand-in now takes the header’s own extension.
|
|
30
|
+
- [#1438](https://github.com/ThrowTheSwitch/Ceedling/issues/1438) Fixed a [delta build](https://docs.throwtheswitch.org/Ceedling/1.2.0/getting-started/builds/) with mock preprocessing (`:use_test_preprocessor` set to `:mocks` or `:all`) generating a mock from an out-of-date reading of a header the mocked header includes. An edit to that header alone left the mock as it was. With `:cmock` ↳ `:treat_inlines: :include`, mock preprocessing could also read the copy of that header CMock wrote beside another mock. The mock kept the declarations the old header selected, and the test failed to build until a clobber. Mock preprocessing now reads each header the mocked header includes as the compiler finds it, and an edit to any of them regenerates the mock. The first build after upgrading preprocesses every mocked header once.
|
|
31
|
+
- [#1433](https://github.com/ThrowTheSwitch/Ceedling/issues/1433) Fixed a mocked header that includes a header beside itself failing to build when an earlier search path holds a same-named header. With `lib/motor.h` including `"config.h"` and `src/hw/config.h` reached first, the header Ceedling prepares for CMock under mock preprocessing named `lib/config.h`, which nothing resolves from the build directory. The build stopped with `fatal error: lib/config.h: No such file or directory`. A test’s runner, CMock’s copy of a header under `:cmock` ↳ `:treat_inlines: :include`, and a Partial’s generated files could also include the same-named header in place of the one beside the includer. Each now includes such a header by its absolute path wherever no search path reaches it.
|
|
32
|
+
- [#1439](https://github.com/ThrowTheSwitch/Ceedling/issues/1439) Fixed a test whose mock or [Partial](https://docs.throwtheswitch.org/Ceedling/1.2.0/testing-guide/partials/) lies in a folder named like another test nested below it failing to build once that test exists. With `test/test_c.c` including `"test_x/mock_qux.h"` and `test/test_c/test_x.c` added, `test:test_c` stopped with ``Found no file `test_x/mock_qux.c` in search paths.``, and a Partial failed to link. A mock of the nested test could also overwrite the other test’s same-named mock. Each test’s own build directories now end in `_t_` after its name, so no test’s directory lies inside another’s ([build output](https://docs.throwtheswitch.org/Ceedling/1.2.0/testing-guide/conventions/#test-names-build-output)). A test’s executable and linker map move with its objects (see [Breaking Changes](BreakingChanges.md)). The first test build after upgrading rebuilds every test once. Release builds are unaffected.
|
|
33
|
+
- Fixed a hand-written source named with the mock prefix failing to build into a test. A fake such as `src/fakes/mock_spi.c`, linked through `TEST_SOURCE_FILE("mock_spi.c")`, stopped the build with ``Found no file `mock_spi.c` in search paths.``, since Ceedling looked for it only among the test’s generated mocks. A name with the [Partial](https://docs.throwtheswitch.org/Ceedling/1.2.0/testing-guide/partials/) prefix failed the same way. A test’s own generated mock still comes first.
|
|
34
|
+
- [#1415](https://github.com/ThrowTheSwitch/Ceedling/issues/1415) Fixed a header that only [`:files` ↳ `:include`](https://docs.throwtheswitch.org/Ceedling/1.2.0/configuration/reference/files/#files-include) supplies being impossible to mock since 1.2.0. The build stopped with ``Found no file `sensor.h` in search paths.`` When a test names such a header, Ceedling now adds the directory its `#include` implies to that test’s search paths, after every configured one, and logs it. For a header outside the working directory, a bare name such as `"mock_socket.h"` gets no directory, and the build’s error suggests an `#include` that references the parent folder.
|
|
35
|
+
- [#1418](https://github.com/ThrowTheSwitch/Ceedling/issues/1418) Fixed a mock or `#include` naming a header by a directory below a search path, as in `#include "drivers/mock_foo.h"` with `src/` listed, stopping the build with ``Found no file `drivers/foo.h` in search paths.`` Ceedling now finds a test’s headers as the compiler does, joining each search path with the path the `#include` names ([search paths](https://docs.throwtheswitch.org/Ceedling/1.2.0/configuration/reference/paths/#paths-include)). A build with `:cmock` ↳ `:treat_inlines: :include` also no longer reports “Multiple files matched” for CMock’s copy of a mocked header.
|
|
36
|
+
- Fixed a mock included through a folder, as in `#include "drivers/mock_foo.h"`, failing to compile when a search path lists only its header’s own directory, as `src/drivers/**` does. The mock included its header as `"drivers/foo.h"`, which no search path reached. A mock now includes its header by the text a search path reaches it by, here `"foo.h"`.
|
|
37
|
+
- Fixed an [FFF](https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/fff/) fake including its header by filename alone, even where its `#include` named a folder. With `lib/` and `src/**` listed, a fake included as `drivers/mock_foo.h` included `src/hw/drivers/foo.h` in place of `lib/drivers/foo.h`, the header `drivers/foo.h` names. A fake now includes its header as a mock does.
|
|
38
|
+
|
|
39
|
+
### Partials
|
|
40
|
+
|
|
41
|
+
- [#1427](https://github.com/ThrowTheSwitch/Ceedling/issues/1427) Fixed a mock [Partial](https://docs.throwtheswitch.org/Ceedling/1.2.0/testing-guide/partials/) stopping the build when its configuration named a function its module declares but doesn’t define, as `MOCK_PARTIAL_PUBLIC_MODULE(port)` with `MOCK_PARTIAL_CONFIG(port, -port_write)` does. The build reported ``references function 'port_write' which does not exist``, though `port.h` declares it and `port.c` defines it. The check knew only the functions a module defines, and a mock of public functions alone, or any mock of a header-only module, reads no definitions from a source. A mock’s configuration can now name any function its module declares, except an `inline` one whose body is in another header, which no mock can replace.
|
|
42
|
+
- [#1384](https://github.com/ThrowTheSwitch/Ceedling/issues/1384) Fixed a [Partial](https://docs.throwtheswitch.org/Ceedling/1.2.0/testing-guide/partials/) leaving out what its selected functions rely on. A test calling an inline function whose external definition the module’s source provides, with a declaration such as `extern inline int f(void);` or `int f(void);`, failed to link. Selected code calling a function the module only declares, a function the test subtracted to stub, or a `static inline` helper from the module header failed to compile. A Partial now carries those prototypes and the helpers its selected code uses ([what a Partial carries](https://docs.throwtheswitch.org/Ceedling/1.2.0/testing-guide/partials/conventions/#what-a-partial-carries-from-your-module)). A mock Partial also no longer mocks such a function, which defined it twice.
|
|
43
|
+
- Fixed a [Partial](https://docs.throwtheswitch.org/Ceedling/1.2.0/testing-guide/partials/) defining a variable its module declares `extern`, which failed to link against the real definition with GCC 10 and later. By default, a Partial now writes a weak definition that the real one overrides (see _Added_); this behavior is optional.
|
|
44
|
+
- Fixed tested and mocked [Partials](https://docs.throwtheswitch.org/Ceedling/1.2.0/testing-guide/partials/) dropping part of a function’s return type in certain circumstances. `struct point *f(void)` lost `struct point`, `uint8_t *` lost `uint8_t`, `unsigned long` became `long`, and `const` was stripped.
|
|
45
|
+
- Fixed a [Partial’s](https://docs.throwtheswitch.org/Ceedling/1.2.0/testing-guide/partials/) implementation header declaring a variable twice when the module’s header declares it and its source defines it, which `-Wredundant-decls` reports.
|
|
46
|
+
- [#1397](https://github.com/ThrowTheSwitch/Ceedling/issues/1397) Fixed a [Partial](https://docs.throwtheswitch.org/Ceedling/1.2.0/testing-guide/partials/) failing to compile for a module that declares a function pointer without a typedef for its type. A function taking or returning one, and a variable holding one, an array of them or a pointer to an array, now generate correctly whether tested or mocked. A variable whose array size, initializer or string holds a pointer in parentheses, as in `sizeof(*p)`, is no longer named after that pointer. A function returning a function pointer no longer stops Ceedling with an internal error, and a defined function whose name a Partial can’t read stops the build with a message naming it ([function pointers](https://docs.throwtheswitch.org/Ceedling/1.2.0/testing-guide/partials/conventions/#function-pointers)).
|
|
47
|
+
- [#1399](https://github.com/ThrowTheSwitch/Ceedling/issues/1399) Fixed a [Partial](https://docs.throwtheswitch.org/Ceedling/1.2.0/testing-guide/partials/) taking a struct, union, or enum variable for a type. A variable such as `struct ops g_ops = { 1 };`, or an array of them, went into the Partial’s types header, which defined it twice or failed to compile. A function returning a pointer to a struct, followed by a stray `;`, was taken for a type the same way. A type with an attribute after its closing brace, as in `} __attribute__((packed));`, was taken for a variable instead and never reached the types header.
|
|
48
|
+
- [#1400](https://github.com/ThrowTheSwitch/Ceedling/issues/1400) Fixed a [Partial](https://docs.throwtheswitch.org/Ceedling/1.2.0/testing-guide/partials/) misreading several kinds of variable declaration, which left a variable without an extern or wrote one that failed to compile or link. Every variable of a compound declaration now gets an extern, as `g_y` does in `int g_x = 0, g_y;`. A name holding `$` reads whole. A type spelled with `typeof(…)`, `_Atomic(…)`, `_Alignas(…)`, or `_BitInt(…)`, or with `_Bool`, `_Atomic`, `_Thread_local`, or `_Complex`, keeps its spelling. An extern keeps its variable’s asm label, as in `int g_s __asm__("g_symbol");`. Under [fallback preprocessing](https://docs.throwtheswitch.org/Ceedling/1.2.0/testing-guide/conventions/#fallback-test-build-preprocessing), which remains a best effort, a comment inside a declaration no longer garbles it or stops a Partial reading the rest of the file.
|
|
49
|
+
- [#1402](https://github.com/ThrowTheSwitch/Ceedling/issues/1402) Fixed a [Partial](https://docs.throwtheswitch.org/Ceedling/1.2.0/testing-guide/partials/) failing to compile for a module whose source includes its own header and then a header that uses the module header’s types or macros. The Partial wrote every include it carries ahead of the module’s types, so the later header met a type or macro not yet defined. A Partial now writes its includes in the order the module’s source compiles them. A mocked Partial’s header among them keeps its place too.
|
|
50
|
+
- [#1404](https://github.com/ThrowTheSwitch/Ceedling/issues/1404) Fixed a [Partial](https://docs.throwtheswitch.org/Ceedling/1.2.0/testing-guide/partials/) misreading a declaration with a C23 attribute. A variable that one leads, as in `[[maybe_unused]] static int count;`, got an extern that failed to compile, and so did a variable whose name one follows. A function that one leads, as in `[[nodiscard]] static int f(void) { … }`, was never read, and neither was anything after it in the file. Each now reads whole, and its attribute keeps its place in the Partial.
|
|
51
|
+
- [#1401](https://github.com/ThrowTheSwitch/Ceedling/issues/1401) Fixed a [Partial](https://docs.throwtheswitch.org/Ceedling/1.2.0/testing-guide/partials/) failing to compile for a module that declares a variable together with its type, as in `static struct { int count; } s_ctx;` or `struct pair { int a; } g_p1, g_p2;`. The Partial repeated the type’s body in the variable’s extern and in its definition. It now defines the type once, in its types header, and names it for the variable ([a variable declared together with its type](https://docs.throwtheswitch.org/Ceedling/1.2.0/testing-guide/partials/variables/#a-variable-declared-together-with-its-type)). A function-scoped `static` of this form is promoted with its type. A member’s array size and the first variable of such a compound declaration, which the body used to lose, now read correctly.
|
|
52
|
+
- Fixed a [Partial](https://docs.throwtheswitch.org/Ceedling/1.2.0/testing-guide/partials/) reading a forward declaration, as in `struct node;`, as a variable. It wrote `extern struct node;`, which fails a build treating warnings as errors. A Partial now writes the declaration as the module does.
|
|
53
|
+
- Fixed a [Partial](https://docs.throwtheswitch.org/Ceedling/1.2.0/testing-guide/partials/) renaming more than a promoted function-scoped `static` variable. A member or tag of the same name, as in `p->count`, now keeps its spelling, unless a struct the function defines holds the name. So does the text of a comment or string, apart from an asm template’s `%[count]`.
|
|
54
|
+
- [#1395](https://github.com/ThrowTheSwitch/Ceedling/issues/1395) Fixed a [Partial](https://docs.throwtheswitch.org/Ceedling/1.2.0/testing-guide/partials/) failing to compile for a module whose `static` comes from a macro, as `#define PRIVATE static` or `#define STATICINLINE static inline` gives. A selected function failed with “static declaration follows non-static declaration”, and a variable got an extern such as `extern PRIVATE int counter;`. A Partial now writes each from its expanded declaration, and every line of a function’s body keeps its place. A variable a macro such as `#define EXTERN extern` declares gets its weak definition too.
|
|
55
|
+
- Fixed a [Partial](https://docs.throwtheswitch.org/Ceedling/1.2.0/testing-guide/partials/) dropping an attribute a macro writes after a type’s closing brace, as in `struct pk { char c; int i; } PACKED;` or `struct pk { char c; int i; } PACKED inst;`. The Partial’s copy of the type compiled unpacked with only a warning, so its size disagreed with the module’s. A Partial now keeps the macro with the type.
|
|
56
|
+
- Fixed a [delta build](https://docs.throwtheswitch.org/Ceedling/1.2.0/getting-started/builds/) reusing a [Partial](https://docs.throwtheswitch.org/Ceedling/1.2.0/testing-guide/partials/) after a header its module includes changed, such as the header that defines `PRIVATE`. A Partial now regenerates when any project header its module’s preprocessing read changes.
|
|
57
|
+
- Fixed a tested [Partial](https://docs.throwtheswitch.org/Ceedling/1.2.0/testing-guide/partials/) running the real `static inline` functions of a module the test mocks as a Partial named by directory, as `MOCK_PARTIAL_PUBLIC_MODULE_AT(hw, port)` names one. Since 1.2.0 the tested Partial included that module’s real header in place of its mock’s. A module named by directory is now matched by its header’s path.
|
|
58
|
+
- Fixed a module both tested and mocked as [Partials](https://docs.throwtheswitch.org/Ceedling/1.2.0/testing-guide/partials/) in one test failing to compile when its source never includes its own header. The Partial’s implementation never included its mock’s interface, so a tested function calling a mocked one called it undeclared.
|
|
59
|
+
|
|
60
|
+
### Preprocessing
|
|
61
|
+
|
|
62
|
+
- [#1423](https://github.com/ThrowTheSwitch/Ceedling/issues/1423) Fixed a mock `#include` that climbs with `..` stopping a test built with [test preprocessing](https://docs.throwtheswitch.org/Ceedling/1.2.0/configuration/reference/project/#use_test_preprocessor). `#include "../x/mock_foo.h"` for `inc/x/foo.h` with `inc/**` listed stopped the build with ``Found no file `../x/foo.h` in search paths.``, though it built without test preprocessing. The mock is now found as the `#include` reaches it from the test file’s directory.
|
|
63
|
+
- [#1424](https://github.com/ThrowTheSwitch/Ceedling/issues/1424) Fixed a mock `#include` without a folder being dropped beside a same-named mock `#include` with one, as `#include "mock_task.h"` is beside `#include "other/mock_task.h"`. The first mock was never generated, and the test failed to compile. Both mocks are now generated. Two `#include`s of one header’s mock still give it one mock, named by the `#include` with more path.
|
|
64
|
+
- [#1426](https://github.com/ThrowTheSwitch/Ceedling/issues/1426) Fixed a header with two same-named `#include`s, one without a folder and one with, losing one of them in the copy Ceedling prepares for CMock and in a test’s own `#include` list. A mocked `lib/motor.h` that includes `"config.h"` and `"app/config.h"` failed to compile with `:cmock` ↳ `:treat_inlines: :include`. Both `#include`s are now kept, in either order. The notice about an `#include` that several files satisfy no longer counts a file another `#include` took.
|
|
65
|
+
- [#1420](https://github.com/ThrowTheSwitch/Ceedling/issues/1420) Fixed a mock in a test built with [test preprocessing](https://docs.throwtheswitch.org/Ceedling/1.2.0/configuration/reference/project/#use_test_preprocessor) taking its name from its header’s mirrored directory instead of the `#include` the test wrote. Since 1.2.0, `#include "mock_task.h"` for `rtos/include/task.h` with `rtos/**` listed defined `include_mock_task_Init()` and its siblings. That mock now defines `mock_task_Init()` and its siblings, as a build without test preprocessing does. A test that calls `include_mock_task_Verify()` directly must now call `mock_task_Verify()`. A mock whose `#include` changes its folder is now regenerated.
|
|
66
|
+
- Fixed a mocked header losing a function declaration that follows an empty macro definition, such as `#define CMSIS_DEPRECATED`, with `:cmock` ↳ `:treat_inlines: :include`. In the header Ceedling prepares for CMock, the declaration could be joined onto the `#define`, so no mock was generated for that function.
|
|
67
|
+
- Fixed a mid-line `_Pragma()` being joined into the code around it when Ceedling reassembled a preprocessed file, giving `int a; #pragma pack(1) int b;` on one line.
|
|
68
|
+
- Fixed a header’s include guard going unrecognized behind a leading comment longer than 2,048 bytes, such as a license. A header prepared for CMock with `:treat_inlines: :include` got a generated guard instead and repeated the original guard’s `#define` as an ordinary macro, and a [Partial](https://docs.throwtheswitch.org/Ceedling/1.2.0/testing-guide/partials/) of such a header could not suppress the original header, risking `redefinition` errors. A guard-shaped `#ifndef`/`#define` pair inside a comment is no longer taken for the guard.
|
|
69
|
+
- Fixed a system header such as `<stdint.h>` being included twice in a header Ceedling prepares for CMock or a Partial, when the compiler’s own copy of that header includes another of the same name.
|
|
70
|
+
|
|
71
|
+
## 🌟 Added
|
|
72
|
+
|
|
73
|
+
- More and better guidance on compilation and linking failures that point to common root causes. More cases are covered with more complete explanations and consistent wording. Failure matching is expanded to help across a variety of toolchains. A test whose Partials macro, such as `PARTIAL_LOCAL_VAR()`, builds a name nothing declares gets guidance on the macro’s arguments. An `#include` nested too deeply ([#691](https://github.com/ThrowTheSwitch/Ceedling/issues/691)) gets guidance at preprocessing or compilation. It names a header that includes its own filename and finds itself first.
|
|
74
|
+
- [#699](https://github.com/ThrowTheSwitch/Ceedling/issues/699) Added a check of each tool’s quoting when Ceedling validates its configuration ([tool definitions](https://docs.throwtheswitch.org/Ceedling/1.2.0/configuration/reference/tools/#tool-definition-configurable-elements)). A quote that `:executable` or an argument leaves open fails validation and names the entry. A typographic quote such as `”`, often pasted from a web page, draws a warning, and it is named as the likely cause of a quote left open. Before, a quote left open paired with one in a later argument. The build then failed with an unrelated error, such as `no input files`, or ran with corrupted paths.
|
|
75
|
+
- Added `PARTIAL_TYPE()` and `PARTIAL_LOCAL_TYPE()` to `ceedling.h`. Each names the type a [Partial](https://docs.throwtheswitch.org/Ceedling/1.2.0/testing-guide/partials/) gives a variable declared together with its type, so a test can declare another object of that type, such as a saved copy of a module’s state ([Partials macros](https://docs.throwtheswitch.org/Ceedling/1.2.0/reference/partials-macros/#variable-type-names)).
|
|
76
|
+
- [#1386](https://github.com/ThrowTheSwitch/Ceedling/issues/1386) Added [`:project` ↳ `:win_path_limit`](https://docs.throwtheswitch.org/Ceedling/1.2.0/configuration/reference/project/#win_path_limit) for Windows. `:classic`, the default, keeps Windows’ 260-character limit and now also flags a directory Ceedling creates past 248 characters. `:long_paths` and `:auto` stop long path logging warnings/errors on a host with long paths enabled, after checking once that Ruby can work with long paths. If that check fails, the new optional [`:windows_registry_query`](https://docs.throwtheswitch.org/Ceedling/1.2.0/configuration/reference/tools/#windows_registry_query) tool reads the host’s registry setting to name the cause. On Ruby before 4.0, which can create long paths but not list them, `:auto` keeps the classic limit, and `:long_paths` warns once about what can fail. The setting changes only what Ceedling reports.
|
|
77
|
+
- Added [`:partials` ↳ `:suppress_redundant_decls`](https://docs.throwtheswitch.org/Ceedling/1.2.0/configuration/reference/partials/#suppress_redundant_decls). Enabled by default, it wraps the prototypes a [Partial](https://docs.throwtheswitch.org/Ceedling/1.2.0/testing-guide/partials/) carries in GCC diagnostic pragmas, so `-Wredundant-decls` stays quiet where a carried prototype repeats a header’s declaration.
|
|
78
|
+
- Added [`:partials` ↳ `:extern_variables`](https://docs.throwtheswitch.org/Ceedling/1.2.0/configuration/reference/partials/#extern_variables) for a variable a module declares `extern` but never defines. `:weak`, the default, writes a weak definition in the [Partial](https://docs.throwtheswitch.org/Ceedling/1.2.0/testing-guide/partials/), so a test built with GCC or Clang links whether or not it links the defining module. `:test` writes none, leaving the definition to the test.
|
|
79
|
+
|
|
80
|
+
## ⚠️ Changed
|
|
81
|
+
|
|
82
|
+
- A mocked [Partial’s](https://docs.throwtheswitch.org/Ceedling/1.2.0/testing-guide/partials/) generated header is no longer preprocessed for mocking. CMock reads it as generated, so the work was never used. The `pre_mock_preprocess` and `post_mock_preprocess` plugin hooks, and the [Command Hooks plugin’s](https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/command-hooks/) hooks of the same names, no longer run for one.
|
|
83
|
+
|
|
84
|
+
---
|
|
85
|
+
|
|
86
|
+
# [1.2.2] — 2026-10-31
|
|
87
|
+
|
|
88
|
+
## 💪 Fixed
|
|
89
|
+
|
|
90
|
+
- Fixed the [Valgrind plugin](https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/valgrind/) writing no report, and reporting a crash, for any test below its test root. The [Raw Output Log plugin](https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/report-tests-raw-output-log/) failed to write such a test’s log.
|
|
91
|
+
- Fixed [`:use_backtrace: :gdb`](https://docs.throwtheswitch.org/Ceedling/1.2.0/configuration/reference/project/#use_backtrace) logs of same-named tests sharing one file, and every log collecting crashes from earlier builds. A crash summary pointed to a log whose first trace could be stale. Each test now has its own logs, and each holds only the latest crash.
|
|
92
|
+
- Fixed [TeamCity plugin](https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/report-tests-teamcity-stdout/) naming the suites of same-named tests alike. A suite is now named by its test’s path, and escaped as TeamCity requires.
|
|
93
|
+
- [#1369](https://github.com/ThrowTheSwitch/Ceedling/issues/1369) Fixed [TeamCity](https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/report-tests-teamcity-stdout/) test names and failure details going out unescaped. A test path or case name holding `'`, `|`, `[`, `]`, or a line break broke the service message, and TeamCity misread or dropped the test’s result.
|
|
94
|
+
- Fixed checking of [`TEST_SOURCE_FILE()`](https://docs.throwtheswitch.org/Ceedling/1.2.0/testing-guide/build-directives/#test_source_file) entries:
|
|
95
|
+
- Each test now checks only its own entries, removing unnecessarily duplicated checks yielding a test build speedup.
|
|
96
|
+
- A misspelled entry now stops the build with an error naming its own test. Previously, the error could name another test, and with [`:use_test_preprocessor`](https://docs.throwtheswitch.org/Ceedling/1.2.0/configuration/reference/project/#use_test_preprocessor) `:none` or `:mocks` the entry went unchecked (see [Breaking Changes](BreakingChanges.md)).
|
|
97
|
+
- An entry using `..` is no longer rejected with test preprocessing on.
|
|
98
|
+
- A “Multiple files matched” notice now prints once a build, not once for every lookup that makes the same choice.
|
|
99
|
+
- Fixed a [delta build](https://docs.throwtheswitch.org/Ceedling/1.2.0/getting-started/builds/) keeping a test executable or release artifact after a source file left the build — deleted, excluded through `:files`, or moved outside `:paths` — while every other object was unchanged. A test kept passing on the removed code, even with `--force-test-rerun`, and a release artifact kept it. A link now rebuilds whenever its list of objects changes.
|
|
100
|
+
- [#1365](https://github.com/ThrowTheSwitch/Ceedling/issues/1365) Fixed a project that selects another Ceedling installation — through [`:project` ↳ `:which_ceedling`](https://docs.throwtheswitch.org/Ceedling/1.2.0/configuration/which-ceedling/), `WHICH_CEEDLING`, or a `vendor/ceedling/` copy — running on a mix of both installations’ code. Across versions it failed outright: a 1.2.1 `ceedling` could not run a project vendoring 1.2.0. A development checkout selected this way silently ran partly on the gem’s code. Each command now runs whole in the installation it selects (see _Changed_).
|
|
101
|
+
- Fixed [`ceedling version`](https://docs.throwtheswitch.org/Ceedling/1.2.0/getting-started/command-line/#ceedling-version) reporting the launcher’s version number for the application and ignoring a project’s `:which_ceedling`. It now reads your project file and takes `--project` and `--mixin`.
|
|
102
|
+
- Fixed `ceedling new`, `ceedling example`, and `ceedling examples` running the launcher’s code with the installation `WHICH_CEEDLING` selects, and `new` recording the launcher’s version in `:ceedling_version:`. `docs` ignored the selection. It now exports the selected installation’s documentation, or the launcher’s with a notice when the selected installation holds none, as a `--local` copy does not.
|
|
103
|
+
- Fixed `ceedling upgrade` run inside a `--local` project deleting the project’s vendored Ceedling and then failing to copy from it (see [Breaking Changes](BreakingChanges.md)).
|
|
104
|
+
- [#1371](https://github.com/ThrowTheSwitch/Ceedling/issues/1371) Fixed `ceedling upgrade` never refreshing documentation that `new --docs` or `example --docs` exported since 1.1.0. It now replaces only what the export wrote, and leaves your own files in `docs/`. Previously, a project exported by 1.0.x lost all of `docs/`.
|
|
105
|
+
- Fixed a `--local` project’s `./ceedling` failing since 1.1.0 with “`vendor/ceedling/vendor/unity/test/targets` does not exist”. Vendoring now copies Unity’s built-in mixins. Re-vendor an existing project with `ceedling upgrade`.
|
|
106
|
+
- Fixed the `./ceedling` launch script splitting arguments that contain spaces, such as `--test-case="adds two"` or an inline YAML `--mixin`.
|
|
107
|
+
- Fixed backslashes in a `WHICH_CEEDLING` or `:which_ceedling` path going unconverted.
|
|
108
|
+
- [#1366](https://github.com/ThrowTheSwitch/Ceedling/issues/1366) Fixed the [gcov plugin](https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/gcov/gcovr/#fail_under_decision) repeating gcovr’s first coverage threshold message for every violated `:fail_under_*` threshold, and losing the others. Each violated threshold is now its own build failure, with gcovr’s own message. From gcovr 8.7, `:fail_under_decision` also checks condition coverage, which `:mcdc` produces.
|
|
109
|
+
- [#1368](https://github.com/ThrowTheSwitch/Ceedling/issues/1368) Fixed a [delta build](https://docs.throwtheswitch.org/Ceedling/1.2.0/getting-started/builds/) not relinking a test or release when a library it links changes. A link now depends on the library files its [`:libraries`](https://docs.throwtheswitch.org/Ceedling/1.2.0/configuration/reference/libraries/) entries name on `:paths` ↳ `:libraries`, and on the libraries the Dependencies plugin builds.
|
|
110
|
+
- Fixed a [Unity helper](https://docs.throwtheswitch.org/Ceedling/1.2.0/configuration/reference/cmock/#unity_helper_path) named by its header compiling that header instead of the source beside it. A helper written with backslashes was also included in mocks by its whole path.
|
|
111
|
+
- [#1377](https://github.com/ThrowTheSwitch/Ceedling/issues/1377) Fixed the [FFF plugin](https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/fff/#cmock-configuration) leaving out the headers that `:cmock` ↳ `:includes_c_pre_header`, `:includes_c_post_header`, and `:includes_h_pre_orig_header` name, so a fake could fail to compile where a mock of the same header compiled. Fakes now include them where CMock does. A [Unity helper](https://docs.throwtheswitch.org/Ceedling/1.2.0/configuration/reference/cmock/#unity_helper_path) is now included in a fake’s source, as in a mock’s.
|
|
112
|
+
- Fixed the [Dependencies plugin](https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/dependencies/) placing an absolute artifact or include path below its `:artifact` path, and `:build_lib` writing its list files into the working directory.
|
|
113
|
+
|
|
114
|
+
### Path handling
|
|
115
|
+
|
|
116
|
+
The bulk of the fixes that follow are the consequence of funneling all path handling through common hygiene, standardized path creation beneath the project build root, and handling for a variety edge cases. While extensive, this list of fixes addresses problems most projects never encountered.
|
|
117
|
+
|
|
118
|
+
- [#1376](https://github.com/ThrowTheSwitch/Ceedling/issues/1376) Fixed the copy of Unity, CMock, and CException into the build directory failing when Ruby reports a vendored file as a directory, as it can for a Ruby installation on a Windows network share with Data Deduplication. The copy left a directory where the file belongs, and every later build failed on it. Ceedling now tells files from directories without that misreport, and replaces any entry of the wrong type with a notice. `ceedling new --local`, `upgrade`, and `example` list what they copy the same way. This is best effort, since Ceedling cannot vouch for every filesystem (see [Known Issues](KnownIssues.md)).
|
|
119
|
+
- [#1364](https://github.com/ThrowTheSwitch/Ceedling/issues/1364) Fixed test builds stopping with “Ambiguous file reference” when a test file’s name ended another test file’s path, such as `test/test_calc.c` beside `test/unit/test_calc.c`. It stopped `test:all`, a test named by its full path, and plugin builds such as `gcov:all`. Each test is now properly [named by its path from the project root](https://docs.throwtheswitch.org/Ceedling/1.2.0/testing-guide/conventions/#test-names-build-output), and its build finds its own source by that name.
|
|
120
|
+
- Fixed two test files sharing one build name, so that one silently replaced the other: tests under overlapping `:paths` ↳ `:test` roots (e.g. `test/**` and `test/unit/**`), the same layout under two roots, or a `:files` ↳ `:test` test outside every root. Since 1.2.0, the error above hid it.
|
|
121
|
+
- Fixed a directory of tests named like a test beside it, such as `test/test_foo/` beside `test/test_foo.c`, making a mock both tests use ambiguous.
|
|
122
|
+
- [#1373](https://github.com/ThrowTheSwitch/Ceedling/issues/1373) Fixed tests failing to run under a path holding an apostrophe or a space. Every case reported a crash, or the build stopped. The default tools that run a test executable, and the tools for the CppCheck, Dependencies, and Valgrind plugins now quote the paths they name.
|
|
123
|
+
- [#1370](https://github.com/ThrowTheSwitch/Ceedling/issues/1370) Fixed mocking a header found below a `:paths` root such as `../**` beside headers far outside the project, such as `C:/Keil_v5/…`. The mock was written outside the build directory, and the build stopped with “Found no file … in search paths”. Ceedling now compares paths by the directories they name, not by their text.
|
|
124
|
+
- Fixed same-named sources in one build sharing one object, so that one silently replaced the other. This happened with release sources below two roots (e.g. `src/foo.c` and `lib/foo.c`), sources below nested roots (`src/util.c` and `src/legacy/util.c`), sources named by `:files`, gcov and Bullseye untested sources, and sources the Dependencies plugin’s `:build_lib` compiles. Each now builds to its own object (see _Changed_). Two sources that would still build to one file stop the build with an error naming both.
|
|
125
|
+
- Fixed a `:paths` entry written as `./src/**`, as an absolute path, or through a symlink not matching the same directories written as `src/**`. A header below such a root missed the source beside it, and its mock missed its directory.
|
|
126
|
+
- Fixed a `:paths` root such as `../**` or `./**` collecting the build directory’s own generated mocks, runners, and objects.
|
|
127
|
+
- Fixed a `:files` glob such as `+:**/*.c` collecting the build directory’s own mocks, runners, and vendored Unity and CMock sources, which stopped a release build. A `:files` glob now adds nothing from the build directory.
|
|
128
|
+
- Fixed a `:files` glob such as `+:**/*.c`, or a source root holding the test root, collecting test files into a release build, which then stopped compiling them. A `:files` revision also no longer adds a test file to the source collection.
|
|
129
|
+
- Fixed a `-:` `:paths` entry naming a directory that does not exist, such as one below the build root before a first build, failing validation. It now logs a warning, or nothing below the build root.
|
|
130
|
+
- Fixed `:project` ↳ `:build_root: .` letting `clobber` delete the project’s own `test/` directory. Such a build root is now refused (see [Breaking Changes](BreakingChanges.md)).
|
|
131
|
+
- Fixed `~` in a configured path naming a directory called `~`. It now names your home directory in `:paths`, `:files`, `:project` ↳ `:build_root`, every `*_path` setting, tool executables, mixins, `--project`, `--logfile`, `:which_ceedling`, `WHICH_CEEDLING`, plugin load paths, and the Dependencies plugin’s paths.
|
|
132
|
+
- Fixed `-L` linker arguments repeating `:paths` ↳ `:libraries` entries as written, decorators and globs included (see _Changed_).
|
|
133
|
+
- Fixed a [`TEST_INCLUDE_PATH()`](https://docs.throwtheswitch.org/Ceedling/1.2.0/testing-guide/build-directives/#test_include_path) written differently from its `:paths` entry, such as with `./`, ranking its headers last among same-named candidates.
|
|
134
|
+
- Fixed `test:` tasks naming a test with `./` or a leading `..`, such as `ceedling test:../tests/test_x`.
|
|
135
|
+
- Fixed mocks failing to compile in three cases: a mock whose `#include` folder shares the test file’s name, two same-named mocks told apart only by their `#include` folders, and a mock `#include` spelling more path than its header’s directory with [`:cmock` ↳ `:mock_name_include_folder`](https://docs.throwtheswitch.org/Ceedling/1.2.0/configuration/reference/cmock/#mock_name_include_folder) disabled.
|
|
136
|
+
- Fixed an absolute [`:release_build` ↳ `:output`](https://docs.throwtheswitch.org/Ceedling/1.2.0/configuration/reference/release-build/#output) placed below the release build directory. It now names the release itself, with its map file beside it.
|
|
137
|
+
- Fixed the log directory and plugin load paths ignoring inline Ruby string expansion and backslashes when read before configuration loads.
|
|
138
|
+
- Fixed a test in a project directory named `_up_` or `_abs_` sharing a build name with a test outside the project.
|
|
139
|
+
|
|
140
|
+
## ⚠️ Changed
|
|
141
|
+
|
|
142
|
+
- Each test’s build output, results, and logs now sit beneath [its path from the project root](https://docs.throwtheswitch.org/Ceedling/1.2.0/testing-guide/conventions/#test-names-build-output). `test/unit/test_calc.c`, once `unit/test_calc`, is now `test/unit/test_calc`, and a test at its root gains its root (e.g. `build/artifacts/valgrind/test/test_calc.log`). The first build after upgrading rebuilds everything once and logs a warning saying so. Run `ceedling clobber` to remove the output left in the old layout, which [coverage reports](https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/gcov/) would otherwise still read. See [Breaking Changes](BreakingChanges.md).
|
|
143
|
+
- A command that selects another Ceedling installation now runs in that installation’s own process, handed off by the `ceedling` command you run. Both sides log a notice naming both versions. Every command except `version` hands off this way, adding about 0.2 seconds. See [Which Ceedling](https://docs.throwtheswitch.org/Ceedling/1.2.0/configuration/which-ceedling/) and [Breaking Changes](BreakingChanges.md).
|
|
144
|
+
- A 1.2.2 application loaded by an older launcher into its own process warns and restarts in its own process.
|
|
145
|
+
- Each object, preprocessed file, and dependencies file now sits below its build directory at its source’s path from the project root. In test `test/test_uart`, `src/drivers/uart.c` builds to `build/test/out/test/test_uart/src/drivers/uart.o`, and a release builds it to `build/release/out/src/drivers/uart.o`. A source outside the project gains `_up_` for each `..` (e.g. `_up_/shared/src/crc.o`), and a file of the running Ceedling installation outside the project sits below `_ceedling_`. Mocks, runners, and vendored frameworks keep their places. The first build after upgrading recompiles each moved object once. See [Breaking Changes](BreakingChanges.md).
|
|
146
|
+
- A `-:` `:paths` entry now removes the directory it names and every directory below it, unless an additive entry names one of them more closely, as `+:src/legacy/keep` does beside `-:src/legacy`. See [Breaking Changes](BreakingChanges.md).
|
|
147
|
+
- A `:paths` or `:files` entry within the build root now logs a warning, and no entry collects from the directories Ceedling and its plugins create, such as `build/test/` or `build/vendor/`. See [Breaking Changes](BreakingChanges.md).
|
|
148
|
+
- `-L` linker arguments now name the directories `:paths` ↳ `:libraries` entries collect, as any `:paths` entry does. An entry that collects no existing directory adds no `-L` argument.
|
|
149
|
+
- Copying Unity, CMock, and CException into the build directory (for short paths and to alleviate possible network filesystem issues with a shared gem installation) retries a file only on an error that clears on its own, such as another program holding the file open, and fails at once on any other. Vendored files are always writable by their owner.
|
|
150
|
+
- `ceedling new --local`, `upgrade`, and `example` now copy the contents of a linked directory within a Ceedling installation, and stop on a link loop.
|
|
151
|
+
- Ceedling’s file and path code moved to `lib/ceedling/filesystem/`. A third-party plugin that requires one of its files directly must name the new path (see [Breaking Changes](BreakingChanges.md)). Plugin development currently makes no guarantees as to the location of internal Ceedling resources.
|
|
152
|
+
|
|
11
153
|
---
|
|
12
154
|
|
|
13
155
|
# [1.2.1] — 2026-10-24
|
|
@@ -118,7 +260,7 @@ The new [Sanitize plugin](https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins
|
|
|
118
260
|
[#1110](https://github.com/ThrowTheSwitch/Ceedling/issues/1110) A dependency can now list the programs it builds under [`:artifacts` ↳ `:executables`](https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/dependencies/#executables) for tools rather than libraries. A release build or [`dependencies:make`](https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/dependencies/#ceedling-dependenciesmake) builds them when missing, test builds do not wait on them, and they are never linked. [`dependencies:deploy`](https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/dependencies/#ceedling-dependenciesdeploy) copies them, along with [dynamic libraries](https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/dependencies/#dynamic_libraries), to a new optional [`:paths` ↳ `:deploy`](https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/dependencies/#working-paths) folder, by default beside the release executable.
|
|
119
261
|
|
|
120
262
|
### Build warnings plugin context, deduplication, and filtering
|
|
121
|
-
The [Build Warnings Log plugin](https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/report-build-warnings-log/) now logs each GCC or Clang warning with the lines that explain it — the function or include context before it along with the source line, caret, and any note after it. Each distinct warning is logged once per build context, so a header
|
|
263
|
+
The [Build Warnings Log plugin](https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/report-build-warnings-log/) now logs each GCC or Clang warning with the lines that explain it — the function or include context before it along with the source line, caret, and any note after it. Each distinct warning is logged once per build context, so a header’s warning appears once rather than once per file including it, and compiler summary lines are left out. New [`:patterns`](https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/report-build-warnings-log/#patterns) and [`:excludes`](https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/report-build-warnings-log/#excludes) settings optionally take regular expressions that replace the default match of any line mentioning “warning” and optionally drop warnings you have already accepted or prevent false positives.
|
|
122
264
|
|
|
123
265
|
### Build warnings plugin SARIF and JSON reports
|
|
124
266
|
The [Build Warnings Log plugin](https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/report-build-warnings-log/#reports) can now write its warnings as [SARIF](https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/report-build-warnings-log/#sarif-report) and [JSON](https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/report-build-warnings-log/#json-report) reports alongside, or instead of, its plain [text log](https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/report-build-warnings-log/#text-report). SARIF, the standard format for static analysis results, lets GitHub code scanning, Azure DevOps, SonarQube, Jenkins, and IDE viewers show each warning on the line it concerns. The [JSON report](https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/report-build-warnings-log/#json-report) lists each warning’s file, line, column, severity, flag, message, and context for scripts. The new [`:reports`](https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/report-build-warnings-log/#reports) setting selects any of `:text`, `:sarif`, and `:json`, and defaults to `:text`. The structured reports are written for every build context that ran a build step, even without warnings, so a CI step always finds its file.
|
|
@@ -206,10 +348,10 @@ Note: 1.2.0 includes all bug fixes for 1.1.x.
|
|
|
206
348
|
- [#1076](https://github.com/ThrowTheSwitch/Ceedling/issues/1076) Fixed a second [`dependencies:fetch`](https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/dependencies/#ceedling-dependenciesfetch), or a [`dependencies:make`](https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/dependencies/#ceedling-dependenciesmake) after a fetch, failing because `git clone` ran into the already-populated folder. A dependency whose fetch path holds files now counts as fetched, and [`dependencies:clean`](https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/dependencies/#ceedling-dependenciesclean) allows a fresh fetch. [Working paths](https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/dependencies/#working-paths) are no longer created ahead of fetching, which made a clone into a fetch path containing the build path fail.
|
|
207
349
|
- [#1110](https://github.com/ThrowTheSwitch/Ceedling/issues/1110) Fixed [`dependencies:deploy`](https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/dependencies/#ceedling-dependenciesdeploy) trying to copy a file named for the dependency rather than its dynamic libraries. It now copies every [dynamic library](https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/dependencies/#dynamic_libraries) from the artifact path beside the release executable.
|
|
208
350
|
- Fixed a [`:tar_gzip`](https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/dependencies/#fetching-dependencies) fetch from an absolute Windows path failing with "Cannot connect to D: resolve failed" where GNU tar, as Git for Windows provides, came first on the path. GNU tar reads a path beginning with a drive letter as a remote host, so `tar` now reads the archive on its standard input.
|
|
209
|
-
- Fixed a dependency
|
|
351
|
+
- Fixed a dependency’s [`:environment`](https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/dependencies/#environment-variables) variables lasting for the rest of the run, reaching every later dependency and Ceedling itself. They now apply only while that dependency’s commands run. An entry not of the form `NAME=value`, `NAME+=value`, or `NAME-=value` now stops the build rather than being ignored. Text after `+=` and `-=` now keeps its leading space, so an appended flag can carry the delimiter it needs.
|
|
210
352
|
- Fixed a dependency without [`:artifacts`](https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/dependencies/#artifacts) crashing the build. Configuration problems now stop the build with a message naming the dependency: a missing name, a name without letters or digits, two names sharing a task name, an unknown [fetch method](https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/dependencies/#fetching-dependencies), or a fetch method missing its `:source` or `:executable`.
|
|
211
353
|
- Fixed an [`:includes`](https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/dependencies/#includes) glob under [`:artifacts`](https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/dependencies/#artifacts) expanding against the working directory rather than the artifact path, and joining every directory it found into one path.
|
|
212
|
-
- Fixed [`:build_lib`](https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/dependencies/#building-dependencies) depending on the process working directory, and miscomputing where to copy its library when the `:artifact` path was absolute or climbed with `..`. The [`:deps_compiler`](https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/dependencies/#custom-tools) tool now receives its search paths and defines as `${5}` and `${6}`, like Ceedling
|
|
354
|
+
- Fixed [`:build_lib`](https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/dependencies/#building-dependencies) depending on the process working directory, and miscomputing where to copy its library when the `:artifact` path was absolute or climbed with `..`. The [`:deps_compiler`](https://docs.throwtheswitch.org/Ceedling/1.2.0/plugins/dependencies/#custom-tools) tool now receives its search paths and defines as `${5}` and `${6}`, like Ceedling’s own [compilers](https://docs.throwtheswitch.org/Ceedling/1.2.0/configuration/reference/tools/#tool-element-runtime-substitution-notational-substitution).
|
|
213
355
|
|
|
214
356
|
### Valgrind & Cppcheck plugins
|
|
215
357
|
|
data/docs/KnownIssues.md
CHANGED
|
@@ -6,6 +6,8 @@ Known issues are complemented by three other documents:
|
|
|
6
6
|
1. 🪵 **[Changelog](Changelog.md)** for a structured list of additions, fixes, changes, and removals.
|
|
7
7
|
1. 💔 **[Breaking Changes](BreakingChanges.md)** for a list of impacts to existing Ceedling projects.
|
|
8
8
|
|
|
9
|
+
Each release has its own section, listing every issue known to affect it. An issue that persists appears again in each later release. A section for an earlier release closes by naming what a later release resolved. Before 1.2.0, a section covers a whole minor version.
|
|
10
|
+
|
|
9
11
|
---
|
|
10
12
|
|
|
11
13
|
## All versions
|
|
@@ -14,37 +16,196 @@ Known issues are complemented by three other documents:
|
|
|
14
16
|
|
|
15
17
|
---
|
|
16
18
|
|
|
19
|
+
## 1.2.3 — 2026-11-20
|
|
20
|
+
|
|
21
|
+
Ceedling 1.2.x requires Ruby 3+ but only unofficially supports Ruby 4.
|
|
22
|
+
|
|
23
|
+
1. The new internal pipeline as of 1.0.0 that allows builds to be parallelized and configured per-test-executable can mean a fair amount of duplication of steps. A header file may be mocked identically multiple times. The same source file may be compiled identically multiple times. Delta builds (as of 1.2.0) offer considerable build time savings as do the speedup gains due to parallelization as of 1.0.0. Future releases will optimize away duplication of build steps.
|
|
24
|
+
1. An `#include` directive must resolve through your project’s configured search paths, as your compiler resolves it, or name a header that `:files` ↳ `:include` adds. A path that would resolve outside your configured search paths (e.g. via relative paths beyond search paths or excessive `..` parent-directory segments) is rejected with a clear, specific error rather than silently causing a confusing downstream build failure.
|
|
25
|
+
1. With test preprocessing enabled, a test file’s `#include` of a mock whose name comes from a macro defined only in a header, as in `#include MOCK_HEADER` with `MOCK_HEADER` defined in another header, cannot be found. Define the macro under `:defines` ↳ `:test` so the test file sees it directly.
|
|
26
|
+
1. Fallback preprocessing remains a best effort with no guarantees. It is used where your toolchain’s preprocessor does not support `-fdirectives-only` or where you force it with `:test_build` ↳ `:preprocess_force_fallback`. Its handling of conditional compilation is limited and may not resolve the same branches your compiler would. Macro expansion is not supported at all.
|
|
27
|
+
1. Delta builds track a library only when they find its file on `:paths` ↳ `:libraries`, or the Dependencies plugin builds it. An “untracked” library found only among your toolchain’s internal search paths, or through a `-L` written into `:flags`, relinks nothing when it changes. Run `ceedling clobber` after such a library changes.
|
|
28
|
+
1. On Linux and macOS, a test, source, or build path holding `"`, `$`, a backtick, or `\` can still break the commands Ceedling runs. So can any path in a tool you define with an unquoted `${1}`. Quote your own tools’ paths, as [`:tools`](https://docs.throwtheswitch.org/Ceedling/1.2.0/configuration/reference/tools/) describes.
|
|
29
|
+
1. Paths for `TEST_SOURCE_FILE(...)` remain relative to **_project root_** — that is, from where you execute `ceedling` at the command line. If you move source files or change your directory structure, `TEST_SOURCE_FILE(...)` calls referencing moved files will need to be updated.
|
|
30
|
+
1. The `ceedling` command of an installation before 1.2.2, such as a 1.2.1 gem, loads a 1.2.3 application that a project selects into its own process. The 1.2.3 application restarts itself in its own process. `new`, `example`, `examples`, `upgrade`, `docs`, and `help` without a project never load the application, so they still run on the older installation’s code. Upgrade the Ceedling whose `ceedling` command you run, typically the gem, to 1.2.3.
|
|
31
|
+
1. The `ceedling` command you run parses your command line before it hands off to the installation a project selects. It rejects an option that only the selected installation knows. Run the selected installation’s own launcher instead, such as a `--local` project’s `./ceedling` launch script from the project root (`.\ceedling.cmd` on Windows).
|
|
32
|
+
1. A mock `#include` written relative to the test file that climbs with `..` to a directory the mock search paths do not reach, such as `#include "../src/drivers/mock_foo.h"`, fails to compile, as in earlier releases. Include the mock relative to a search path instead, such as `#include "drivers/mock_foo.h"`.
|
|
33
|
+
1. On Windows, deep project layouts can still produce build paths near Windows’ 260-character limit. A long `:paths` root is shortened in build paths ([#1387](https://github.com/ThrowTheSwitch/Ceedling/issues/1387)), but a project’s own location, long test names, and deep directories below a root are not. A source outside every `:paths` root, such as one named by `TEST_INCLUDE_PATH()` or `:files`, keeps its whole path, with each `..` written as `_up_/`. Ceedling warns as a path nears the limit. On a host with long paths enabled, [`:project` ↳ `:win_path_limit`](https://docs.throwtheswitch.org/Ceedling/1.2.0/configuration/reference/project/#win_path_limit) can lift that limit.
|
|
34
|
+
1. On Windows with long paths enabled, Ruby before 4.0 creates, reads, and writes files past 260 characters, but can’t list a directory that deep. Ceedling’s directory scans can fail in such a build directory, and `clean` and `clobber` can leave it behind. Delete it by hand (`rmdir /s /q build`), or use Ruby 4.0.
|
|
35
|
+
1. Ceedling finds a mock’s header through your configured search paths, not through the directories your toolchain searches on its own. To mock a system header such as glibc’s `sys/socket.h`, list the directory that holds its folder, such as `/usr/include/x86_64-linux-gnu/`, in `:paths` ↳ `:include`, or name the header in `:files` ↳ `:include`. Then include it by its folder, as in `#include "sys/mock_socket.h"`.
|
|
36
|
+
1. A header that only `:files` ↳ `:include` supplies gets a search path when a test file includes it in quotes, and the whole test build then reaches it. A test that reaches it only through another header or a source file, through `#include <…>`, or through an `#include` whose name a macro gives, finds it only through your configured search paths.
|
|
37
|
+
1. With `:cmock` ↳ `:treat_inlines: :include` and no mock preprocessing, as with `:project` ↳ `:use_test_preprocessor: :none` or `:tests`, CMock copies a mocked header beside its mock as the header is written. An `#include` in it that reaches its header only from the original header’s own directory then fails to compile, as `#include "types.h"` beside `src/drivers/foo.h` does with only `src/` listed. Listing that directory, as a glob such as `src/**` does, or preprocessing mocks with `:mocks` or `:all`, works around it.
|
|
38
|
+
|
|
39
|
+
### Partials
|
|
40
|
+
|
|
41
|
+
1. A module whose header protects itself with `#pragma once` instead of a traditional `#ifndef` include guard can still hit a `redefinition` or `conflicting types` error, if any other header your module uses reaches that header in turn. Ceedling suppresses the real header by defining its include guard, and `#pragma once` provides no guard to define. A mock of such a header keeps only its `extern` declarations and prototypes, leaving its helpers and `static` variables behind. Converting the module’s header to a traditional include guard works around both.
|
|
42
|
+
1. A module header that `#include`s another header after its own types, where that header uses them, fails in a Partial with an `unknown type name` error. A Partial writes a module header’s own includes ahead of its types. Including that other header from the module’s source instead, after the module’s header, works around it.
|
|
43
|
+
1. A module source that reaches its own header only through another header, where that header uses the module’s types, fails in a Partial with an `unknown type name` error. When a source never includes its module’s header itself, a Partial writes the module’s types after the source’s includes. Including the module’s header directly from its source, ahead of the other header, works around it.
|
|
44
|
+
1. A module that one test both tests and mocks keeps its header’s helpers and `static` variables in its own Partial only. Another Partial in that test that includes the module’s header gets the mock’s interface in its place, which leaves them out, so its code that uses them fails to compile or link. Ceedling logs a notice naming what the other Partials use. Testing the module in a test file of its own, and only mocking it in this one, works around it.
|
|
45
|
+
1. A type created by a macro invocation rather than written out — the list and queue building macros in `sys/queue.h`, for instance — is not recognized as a type, and a Partial using one fails to compile with an `unknown type name` error.
|
|
46
|
+
1. A function-scoped `static` with a macro after its name, as in `static int count UNUSED;`, is promoted under the macro’s name, and the generated Partial fails to compile. Writing the macro ahead of the type, as in `static UNUSED int count;`, works around it.
|
|
47
|
+
1. A function-scoped `static` of an anonymous enum, as in `static enum { IDLE, RUN } mode;`, is promoted with its values, which then share file scope with the module’s other names. A value named like another of them fails to compile. Renaming the value, or naming the enum’s type at file scope, works around it.
|
|
48
|
+
1. A function returning a struct that takes parameters, followed by a stray `;` after its body, as in `struct ops make(int n) { … };`, is taken for a type definition and written to the Partial’s types header. Removing the stray `;` works around it.
|
|
49
|
+
1. A variable with an asm label and, ahead of its name, a macro taking a word argument, as in `int MY_ALIGN(N) g asm("g_sym");`, is read as a function named after the macro.
|
|
50
|
+
1. A macro the module retires with `#undef` is carried into the generated Partial anyway, so the name stays visible to your test file and can collide with another macro of the same name.
|
|
51
|
+
1. Exposing a module’s file-scope variables and functions removes what kept their names private to that module. Two Partialized modules in one test file that each use the same name for a file-scope variable collide at link time.
|
|
52
|
+
1. Partials cannot generate a module that text-only fallback preprocessing is unable to resolve — a module with an `#include` naming a macro, or with a type behind a conditional expression that cannot be evaluated without a real preprocessor. Ceedling stops the build and names the file and line rather than generating something subtly wrong. Fallback preprocessing is only used where your compiler does not support `-fdirectives-only`, older Apple Clang releases most notably, or where you force it with `:test_build` ↳ `:preprocess_force_fallback`.
|
|
53
|
+
|
|
54
|
+
---
|
|
55
|
+
|
|
56
|
+
## 1.2.2 — 2026-10-31
|
|
57
|
+
|
|
58
|
+
Ceedling 1.2.x requires Ruby 3+ but only unofficially supports Ruby 4.
|
|
59
|
+
|
|
60
|
+
1. The new internal pipeline as of 1.0.0 that allows builds to be parallelized and configured per-test-executable can mean a fair amount of duplication of steps. A header file may be mocked identically multiple times. The same source file may be compiled identically multiple times. Delta builds (as of 1.2.0) offer considerable build time savings as do the speedup gains due to parallelization as of 1.0.0. Future releases will optimize away duplication of build steps.
|
|
61
|
+
1. An `#include` directive must resolve to a file within your project’s configured `:paths` search collection. A path that would resolve outside your configured search paths (e.g. via relative paths beyond search paths or excessive `..` parent-directory segments) is now rejected with a clear, specific error rather than silently causing a confusing downstream build failure.
|
|
62
|
+
1. With test preprocessing enabled, a test file’s `#include` of a mock whose name comes from a macro defined only in a header, as in `#include MOCK_HEADER` with `MOCK_HEADER` defined in another header, cannot be found. Define the macro under `:defines` ↳ `:test` so the test file sees it directly.
|
|
63
|
+
1. Fallback preprocessing remains a best effort with no guarantees. It is used where your toolchain’s preprocessor does not support `-fdirectives-only` or where you force it with `:test_build` ↳ `:preprocess_force_fallback`. Its handling of conditional compilation is limited and may not resolve the same branches your compiler would. Macro expansion is not supported at all.
|
|
64
|
+
1. Delta builds track a library only when they find its file on `:paths` ↳ `:libraries`, or the Dependencies plugin builds it. An “untracked” library found only among your toolchain’s internal search paths, or through a `-L` written into `:flags`, relinks nothing when it changes. Run `ceedling clobber` after such a library changes.
|
|
65
|
+
1. On Linux and macOS, a test, source, or build path holding `"`, `$`, a backtick, or `\` can still break the commands Ceedling runs. So can any path in a tool you define with an unquoted `${1}`. Quote your own tools’ paths, as [`:tools`](https://docs.throwtheswitch.org/Ceedling/1.2.0/configuration/reference/tools/) describes.
|
|
66
|
+
1. Paths for `TEST_SOURCE_FILE(...)` remain relative to **_project root_** — that is, from where you execute `ceedling` at the command line. If you move source files or change your directory structure, `TEST_SOURCE_FILE(...)` calls referencing moved files will need to be updated.
|
|
67
|
+
1. The `ceedling` command of an installation before 1.2.2, such as a 1.2.1 gem, loads a 1.2.2 application that a project selects into its own process. The 1.2.2 application restarts itself in its own process. `new`, `example`, `examples`, `upgrade`, `docs`, and `help` without a project never load the application, so they still run on the older installation’s code. Upgrade the Ceedling whose `ceedling` command you run, typically the gem, to 1.2.2.
|
|
68
|
+
1. The `ceedling` command you run parses your command line before it hands off to the installation a project selects. It rejects an option that only the selected installation knows. Run the selected installation’s own launcher instead, such as a `--local` project’s `./ceedling` launch script from the project root (`.\ceedling.cmd` on Windows).
|
|
69
|
+
1. A mock `#include` written relative to the test file that climbs with `..` to a directory the mock search paths do not reach, such as `#include "../src/drivers/mock_foo.h"`, fails to compile, as in earlier releases. Include the mock relative to a search path instead, such as `#include "drivers/mock_foo.h"`.
|
|
70
|
+
1. On Windows, a source far outside the project lengthens its build paths, since each `..` in its path from the project adds `_up_/`. Ceedling warns as a path nears Windows’ 260-character limit.
|
|
71
|
+
1. With `:bullseye` ↳ `:report_task: TRUE`, a `report:bullseye` task on the same command line as a fresh `bullseye:` build writes HTML and XML reports that include Unity, generated test runners, and test files. Run `report:bullseye` again, or run it as its own command after the build ([#1385](https://github.com/ThrowTheSwitch/Ceedling/issues/1385)).
|
|
72
|
+
1. A test whose build logs “Isolated ‘…’ into its own directory” recompiles some of its objects on every build, though nothing changed. Each build gives the isolated header’s copy a directory with a new name, and those objects track it. Builds stay correct, and no setting avoids the recompiles. The isolation helps only with `:cmock` ↳ `:treat_inlines: :include`. With other mocks and with Partials it changes nothing ([#1408](https://github.com/ThrowTheSwitch/Ceedling/issues/1408)).
|
|
73
|
+
1. A mock or `#include` that names a header by a directory below a search path, as in `#include "drivers/mock_foo.h"` with `src/` listed, stops the build with ``Found no file `drivers/foo.h` in search paths.`` A glob such as `src/**`, which lists every directory below `src/`, works around it.
|
|
74
|
+
1. A header that only `:files` ↳ `:include` supplies can’t be mocked. The build stops with ``Found no file `…` in search paths.`` Listing the header’s directory in `:paths` ↳ `:include` works around it.
|
|
75
|
+
|
|
76
|
+
### Partials
|
|
77
|
+
|
|
78
|
+
1. A module whose header protects itself with `#pragma once` instead of a traditional `#ifndef` include guard can still hit a `redefinition` or `conflicting types` error, if any other header your module uses reaches that header in turn. Ceedling suppresses the real header by defining its include guard, and `#pragma once` provides no guard to define. Converting the module’s header to a traditional include guard works around it.
|
|
79
|
+
1. A module whose source includes its own header and then a header that uses the module header’s types or macros fails in a Partial with an `unknown type name` or `undeclared` error. A Partial writes every include it carries ahead of the module’s types. Moving those types and macros into a header of their own, which each header using them includes directly, works around it.
|
|
80
|
+
1. A module header that `#include`s another header after its own types, where that header uses them, fails in a Partial with an `unknown type name` error. A Partial writes a module header’s own includes ahead of its types. Moving those types into a header of their own, which each header using them includes directly, works around it.
|
|
81
|
+
1. A type created by a macro invocation rather than written out — the list and queue building macros in `sys/queue.h`, for instance — is not recognized as a type, and a Partial using one fails to compile with an `unknown type name` error.
|
|
82
|
+
1. A `struct`, `union`, or `enum` written directly on a variable, as in `static struct { int depth; } slot;`, is treated as a variable alone. The generated Partial states the type twice and fails to compile. Define the type on its own, then declare the variable by the type’s name.
|
|
83
|
+
1. A `struct`, `union`, or `enum` named but not defined, as in `struct node;`, is reproduced in the generated Partial as an invalid declaration. Builds treating warnings as errors fail on it.
|
|
84
|
+
1. A declaration that a C23 attribute leads, as in `[[maybe_unused]] static int count;`, is misread, and the generated Partial fails to compile. GCC’s spelling of the attribute after the name, as in `static int count __attribute__((unused));`, works around it.
|
|
85
|
+
1. A function-scoped `static` with a macro after its name, as in `static int count UNUSED;`, is promoted under the macro’s name, and the generated Partial fails to compile. Writing the macro ahead of the type, as in `static UNUSED int count;`, works around it.
|
|
86
|
+
1. A type with a macro after its closing brace, as in `struct pk { char c; int i; } PACKED;`, is taken for a variable named after the macro, so the type never reaches the Partial’s types header. Writing the macro ahead of the tag, as in `struct PACKED pk { … };`, works around it.
|
|
87
|
+
1. A function returning a struct that takes parameters, followed by a stray `;` after its body, as in `struct ops make(int n) { … };`, is taken for a type definition and written to the Partial’s types header. Removing the stray `;` works around it.
|
|
88
|
+
1. A variable with an asm label and, ahead of its name, a macro taking a word argument, as in `int MY_ALIGN(N) g asm("g_sym");`, is read as a function named after the macro.
|
|
89
|
+
1. A macro the module retires with `#undef` is carried into the generated Partial anyway, so the name stays visible to your test file and can collide with another macro of the same name.
|
|
90
|
+
1. Exposing a module’s file-scope variables and functions removes what kept their names private to that module. Two Partialized modules in one test file that each use the same name for a file-scope variable collide at link time.
|
|
91
|
+
1. Partials cannot generate a module that text-only fallback preprocessing is unable to resolve — a module with an `#include` naming a macro, or with a type behind a conditional expression that cannot be evaluated without a real preprocessor. Ceedling stops the build and names the file and line rather than generating something subtly wrong. Fallback preprocessing is only used where your compiler does not support `-fdirectives-only`, older Apple Clang releases most notably, or where you force it with `:test_build` ↳ `:preprocess_force_fallback`.
|
|
92
|
+
|
|
93
|
+
Resolved in 1.2.3: `report:bullseye` reports including framework and test sources when run beside a fresh `bullseye:` build, a Partial misreading a declaration that a C23 attribute leads, a Partial failing for a module whose source includes its own header before a header that uses its types, an isolated header recompiling a test’s objects on every build, a Partial failing for a variable declared together with its type, a Partial reproducing a forward declaration such as `struct node;` as an invalid declaration, a Partial losing an attribute a macro writes after a type’s closing brace, a header named by a directory below a search path not being found, and a header only `:files` ↳ `:include` supplies not being mockable.
|
|
94
|
+
|
|
95
|
+
---
|
|
96
|
+
|
|
97
|
+
## 1.2.1 — 2026-10-24
|
|
98
|
+
|
|
99
|
+
Ceedling 1.2.x requires Ruby 3+ but only unofficially supports Ruby 4.
|
|
100
|
+
|
|
101
|
+
1. The new internal pipeline as of 1.0.0 that allows builds to be parallelized and configured per-test-executable can mean a fair amount of duplication of steps. A header file may be mocked identically multiple times. The same source file may be compiled identically multiple times. Delta builds (as of 1.2.0) offer considerable build time savings as do the speedup gains due to parallelization as of 1.0.0. Future releases will optimize away duplication of build steps.
|
|
102
|
+
1. An `#include` directive must resolve to a file within your project’s configured `:paths` search collection. A path that would resolve outside your configured search paths (e.g. via relative paths beyond search paths or excessive `..` parent-directory segments) is now rejected with a clear, specific error rather than silently causing a confusing downstream build failure.
|
|
103
|
+
1. With test preprocessing enabled, a test file’s `#include` of a mock whose name comes from a macro defined only in a header, as in `#include MOCK_HEADER` with `MOCK_HEADER` defined in another header, cannot be found. Define the macro under `:defines` ↳ `:test` so the test file sees it directly.
|
|
104
|
+
1. Fallback preprocessing remains a best effort with no guarantees. It is used where your toolchain’s preprocessor does not support `-fdirectives-only` or where you force it with `:test_build` ↳ `:preprocess_force_fallback`. Its handling of conditional compilation is limited and may not resolve the same branches your compiler would. Macro expansion is not supported at all.
|
|
105
|
+
1. Delta builds track the libraries a test or release links only by their `-l` and `-L` arguments, not their contents. A library rebuilt or replaced under the same name, such as one the Dependencies plugin builds, relinks nothing. Tests report results against the old library, and a release keeps it. Run `ceedling clobber` after a library changes ([#1368](https://github.com/ThrowTheSwitch/Ceedling/issues/1368)).
|
|
106
|
+
1. A test can't run when its file name, its directory below its test root, or the build root holds a space, an apostrophe, or another character the shell reads, such as `&`, `;`, `(`, or `|`. Every case reports a crash, or the build stops. Paths the cppcheck, Dependencies, and Valgrind tools name break the same way. Rename the file or directory, or quote the test fixture’s executable: `:tools` ↳ `:test_fixture` ↳ `:executable: '"${1}"'` ([#1373](https://github.com/ThrowTheSwitch/Ceedling/issues/1373)).
|
|
107
|
+
1. Paths for `TEST_SOURCE_FILE(...)` remain relative to **_project root_** — that is, from where you execute `ceedling` at the command line. If you move source files or change your directory structure, `TEST_SOURCE_FILE(...)` calls referencing moved files will need to be updated.
|
|
108
|
+
1. The `ceedling` command loads the application of the installation a project selects — through `:project` ↳ `:which_ceedling`, `WHICH_CEEDLING`, or a `vendor/ceedling/` copy — into its own process, where the two installations’ code mixes. For example, the 1.2.1 gem’s `ceedling` command fails in a project vendoring 1.2.0, and a development checkout selected this way runs partly on the gem’s code. Upgrade the Ceedling whose `ceedling` command you run, typically the gem, to 1.2.2 ([#1365](https://github.com/ThrowTheSwitch/Ceedling/issues/1365)).
|
|
109
|
+
1. A `--local` project’s `./ceedling` fails with “`vendor/ceedling/vendor/unity/test/targets` does not exist”, because vendoring leaves out Unity’s built-in mixins. Running the project with the gem’s `ceedling` command works around it.
|
|
110
|
+
1. A mocked header found below a `:paths` root such as `../**`, beside headers far outside the project, has its mock written outside the build directory, and the build stops with “Found no file … in search paths”. Give those headers’ own directories as roots instead of `..` ([#1370](https://github.com/ThrowTheSwitch/Ceedling/issues/1370)).
|
|
111
|
+
1. Same-named sources in one build can share one object, so that one replaces the other. This happens with release sources below two roots, sources below nested roots, and sources named by `:files`. Rename one of them.
|
|
112
|
+
1. `:project` ↳ `:build_root: .` lets `clobber` delete the project’s own `test/` directory. Give the build a directory of its own, such as `build`.
|
|
113
|
+
1. Where Windows Data Deduplication has optimized the gem’s files, as on a deduplicated network share holding your Ruby installation, Ruby’s `File.lstat` can report such a file as a directory. Ruby can mistake the reparse point that deduplication leaves on the file for a directory. A copy that trusts `lstat`, as Ceedling 1.2.0 and earlier did, makes a directory in `build/vendor/` where the file belongs. Ceedling 1.2.1 removes such a directory only when it stands in for `unity.c`, `cmock.c`, or `CException.c`. One standing in for any other vendored file, such as `unity.h`, fails every build. Delete `build/vendor/` and rebuild ([#1376](https://github.com/ThrowTheSwitch/Ceedling/issues/1376)).
|
|
114
|
+
1. A `-:` `:paths` entry removes only the directory it names, not the directories below it. Add a `-:` entry for each, or use a glob such as `-:src/legacy/**`.
|
|
115
|
+
1. `~` in a configured path names a directory called `~`, not your home directory. Write the full path instead.
|
|
116
|
+
1. A `:files` glob such as `+:**/*.c` collects the build directory’s own mocks, runners, and vendored Unity and CMock sources, and test files, and a release build then stops compiling them. Write the glob below your own source directories, such as `+:src/**/*.c`. A source root holding the test root also collects test files into a release build; add a `-:` `:files` entry for them.
|
|
117
|
+
1. With `:bullseye` ↳ `:report_task: TRUE`, a `report:bullseye` task on the same command line as a fresh `bullseye:` build writes HTML and XML reports that include Unity, generated test runners, and test files. Run `report:bullseye` again, or run it as its own command after the build ([#1385](https://github.com/ThrowTheSwitch/Ceedling/issues/1385)).
|
|
118
|
+
1. A test whose build logs “Isolated ‘…’ into its own directory” recompiles some of its objects on every build, though nothing changed. Each build gives the isolated header’s copy a directory with a new name, and those objects track it. Builds stay correct, and no setting avoids the recompiles. The isolation helps only with `:cmock` ↳ `:treat_inlines: :include`. With other mocks and with Partials it changes nothing ([#1408](https://github.com/ThrowTheSwitch/Ceedling/issues/1408)).
|
|
119
|
+
1. A mock or `#include` that names a header by a directory below a search path, as in `#include "drivers/mock_foo.h"` with `src/` listed, stops the build with ``Found no file `drivers/foo.h` in search paths.`` A glob such as `src/**`, which lists every directory below `src/`, works around it.
|
|
120
|
+
1. A header that only `:files` ↳ `:include` supplies can’t be mocked. The build stops with ``Found no file `…` in search paths.`` Listing the header’s directory in `:paths` ↳ `:include` works around it.
|
|
121
|
+
|
|
122
|
+
### Partials
|
|
123
|
+
|
|
124
|
+
1. A module whose header protects itself with `#pragma once` instead of a traditional `#ifndef` include guard can still hit a `redefinition` or `conflicting types` error, if any other header your module uses reaches that header in turn. Ceedling suppresses the real header by defining its include guard, and `#pragma once` provides no guard to define. Converting the module’s header to a traditional include guard works around it.
|
|
125
|
+
1. A module whose source includes its own header and then a header that uses the module header’s types or macros fails in a Partial with an `unknown type name` or `undeclared` error. A Partial writes every include it carries ahead of the module’s types. Moving those types and macros into a header of their own, which each header using them includes directly, works around it.
|
|
126
|
+
1. A module header that `#include`s another header after its own types, where that header uses them, fails in a Partial with an `unknown type name` error. A Partial writes a module header’s own includes ahead of its types. Moving those types into a header of their own, which each header using them includes directly, works around it.
|
|
127
|
+
1. A type created by a macro invocation rather than written out — the list and queue building macros in `sys/queue.h`, for instance — is not recognized as a type, and a Partial using one fails to compile with an `unknown type name` error.
|
|
128
|
+
1. A `struct`, `union`, or `enum` written directly on a variable, as in `static struct { int depth; } slot;`, is treated as a variable alone. The generated Partial states the type twice and fails to compile. Define the type on its own, then declare the variable by the type’s name.
|
|
129
|
+
1. A `struct`, `union`, or `enum` named but not defined, as in `struct node;`, is reproduced in the generated Partial as an invalid declaration. Builds treating warnings as errors fail on it.
|
|
130
|
+
1. A declaration that a C23 attribute leads, as in `[[maybe_unused]] static int count;`, is misread, and the generated Partial fails to compile. GCC’s spelling of the attribute after the name, as in `static int count __attribute__((unused));`, works around it.
|
|
131
|
+
1. A function-scoped `static` with a macro after its name, as in `static int count UNUSED;`, is promoted under the macro’s name, and the generated Partial fails to compile. Writing the macro ahead of the type, as in `static UNUSED int count;`, works around it.
|
|
132
|
+
1. A type with a macro after its closing brace, as in `struct pk { char c; int i; } PACKED;`, is taken for a variable named after the macro, so the type never reaches the Partial’s types header. Writing the macro ahead of the tag, as in `struct PACKED pk { … };`, works around it.
|
|
133
|
+
1. A function returning a struct that takes parameters, followed by a stray `;` after its body, as in `struct ops make(int n) { … };`, is taken for a type definition and written to the Partial’s types header. Removing the stray `;` works around it.
|
|
134
|
+
1. A variable with an asm label and, ahead of its name, a macro taking a word argument, as in `int MY_ALIGN(N) g asm("g_sym");`, is read as a function named after the macro.
|
|
135
|
+
1. A macro the module retires with `#undef` is carried into the generated Partial anyway, so the name stays visible to your test file and can collide with another macro of the same name.
|
|
136
|
+
1. Exposing a module’s file-scope variables and functions removes what kept their names private to that module. Two Partialized modules in one test file that each use the same name for a file-scope variable collide at link time.
|
|
137
|
+
1. Partials cannot generate a module that text-only fallback preprocessing is unable to resolve — a module with an `#include` naming a macro, or with a type behind a conditional expression that cannot be evaluated without a real preprocessor. Ceedling stops the build and names the file and line rather than generating something subtly wrong. Fallback preprocessing is only used where your compiler does not support `-fdirectives-only`, older Apple Clang releases most notably, or where you force it with `:test_build` ↳ `:preprocess_force_fallback`.
|
|
138
|
+
|
|
139
|
+
Resolved in 1.2.2: the mixing of two installations’ code, `./ceedling` failing in a `--local` project, delta builds not relinking a changed library, most shell characters in a path stopping a test from running, and the path handling problems above: mocks written outside the build directory, same-named sources sharing an object, `clobber` emptying a project under a `.` build root, `-:` entries keeping the directories below them, and `~`. Also resolved: a directory left in `build/vendor/` for a file `lstat` misreported failing every build. The [Changelog](Changelog.md) lists every other fix since this release.
|
|
140
|
+
|
|
141
|
+
Resolved in 1.2.3: `report:bullseye` reports including framework and test sources when run beside a fresh `bullseye:` build, a Partial misreading a declaration that a C23 attribute leads, a Partial failing for a module whose source includes its own header before a header that uses its types, an isolated header recompiling a test’s objects on every build, a Partial failing for a variable declared together with its type, a Partial reproducing a forward declaration such as `struct node;` as an invalid declaration, a Partial losing an attribute a macro writes after a type’s closing brace, a header named by a directory below a search path not being found, and a header only `:files` ↳ `:include` supplies not being mockable.
|
|
142
|
+
|
|
143
|
+
---
|
|
144
|
+
|
|
17
145
|
## 1.2.0 — 2026-10-21
|
|
18
146
|
|
|
19
|
-
Ceedling 1.2.
|
|
147
|
+
Ceedling 1.2.x requires Ruby 3+ but only unofficially supports Ruby 4.
|
|
20
148
|
|
|
21
149
|
1. The new internal pipeline as of 1.0.0 that allows builds to be parallelized and configured per-test-executable can mean a fair amount of duplication of steps. A header file may be mocked identically multiple times. The same source file may be compiled identically multiple times. Delta builds (as of 1.2.0) offer considerable build time savings as do the speedup gains due to parallelization as of 1.0.0. Future releases will optimize away duplication of build steps.
|
|
22
|
-
1. An `#include` directive must resolve to a file within your project
|
|
150
|
+
1. An `#include` directive must resolve to a file within your project’s configured `:paths` search collection. A path that would resolve outside your configured search paths (e.g. via relative paths beyond search paths or excessive `..` parent-directory segments) is now rejected with a clear, specific error rather than silently causing a confusing downstream build failure.
|
|
23
151
|
1. With test preprocessing enabled, a test file’s `#include` of a mock whose name comes from a macro defined only in a header, as in `#include MOCK_HEADER` with `MOCK_HEADER` defined in another header, cannot be found. Define the macro under `:defines` ↳ `:test` so the test file sees it directly.
|
|
24
152
|
1. Fallback preprocessing remains a best effort with no guarantees. It is used where your toolchain’s preprocessor does not support `-fdirectives-only` or where you force it with `:test_build` ↳ `:preprocess_force_fallback`. Its handling of conditional compilation is limited and may not resolve the same branches your compiler would. Macro expansion is not supported at all.
|
|
153
|
+
1. Delta builds track the libraries a test or release links only by their `-l` and `-L` arguments, not their contents. A library rebuilt or replaced under the same name, such as one the Dependencies plugin builds, relinks nothing. Tests report results against the old library, and a release keeps it. Run `ceedling clobber` after a library changes ([#1368](https://github.com/ThrowTheSwitch/Ceedling/issues/1368)).
|
|
154
|
+
1. A test can't run when its file name, its directory below its test root, or the build root holds a space, an apostrophe, or another character the shell reads, such as `&`, `;`, `(`, or `|`. Every case reports a crash, or the build stops. Paths the cppcheck, Dependencies, and Valgrind tools name break the same way. Rename the file or directory, or quote the test fixture’s executable: `:tools` ↳ `:test_fixture` ↳ `:executable: '"${1}"'` ([#1373](https://github.com/ThrowTheSwitch/Ceedling/issues/1373)).
|
|
25
155
|
1. Paths for `TEST_SOURCE_FILE(...)` remain relative to **_project root_** — that is, from where you execute `ceedling` at the command line. If you move source files or change your directory structure, `TEST_SOURCE_FILE(...)` calls referencing moved files will need to be updated.
|
|
156
|
+
1. The `ceedling` command loads the application of the installation a project selects — through `:project` ↳ `:which_ceedling`, `WHICH_CEEDLING`, or a `vendor/ceedling/` copy — into its own process, where the two installations’ code mixes. For example, the 1.2.1 gem’s `ceedling` command fails in a project vendoring 1.2.0, and a development checkout selected this way runs partly on the gem’s code. Upgrade the Ceedling whose `ceedling` command you run, typically the gem, to 1.2.2 ([#1365](https://github.com/ThrowTheSwitch/Ceedling/issues/1365)).
|
|
157
|
+
1. A `--local` project’s `./ceedling` fails with “`vendor/ceedling/vendor/unity/test/targets` does not exist”, because vendoring leaves out Unity’s built-in mixins. Running the project with the gem’s `ceedling` command works around it.
|
|
158
|
+
1. A mocked header found below a `:paths` root such as `../**`, beside headers far outside the project, has its mock written outside the build directory, and the build stops with “Found no file … in search paths”. Give those headers’ own directories as roots instead of `..` ([#1370](https://github.com/ThrowTheSwitch/Ceedling/issues/1370)).
|
|
159
|
+
1. Same-named sources in one build can share one object, so that one replaces the other. This happens with release sources below two roots, sources below nested roots, and sources named by `:files`. Rename one of them.
|
|
160
|
+
1. `:project` ↳ `:build_root: .` lets `clobber` delete the project’s own `test/` directory. Give the build a directory of its own, such as `build`.
|
|
161
|
+
1. Where Windows Data Deduplication has optimized the gem’s files, as on a deduplicated network share holding your Ruby installation, Ruby’s `File.lstat` can report such a file as a directory. Ruby can mistake the reparse point that deduplication leaves on the file for a directory. Ceedling copies Unity, CMock, and CException into the build directory with Ruby’s `FileUtils.cp_r`, which classifies each entry with `lstat`. Told that a file is a directory, `cp_r` makes a directory of that name in `build/vendor/` and fails reading the file as one, and every later build fails on that directory. Install Ruby and the gem on a local drive, or exclude them from deduplication ([#1376](https://github.com/ThrowTheSwitch/Ceedling/issues/1376)).
|
|
162
|
+
1. A `-:` `:paths` entry removes only the directory it names, not the directories below it. Add a `-:` entry for each, or use a glob such as `-:src/legacy/**`.
|
|
163
|
+
1. `~` in a configured path names a directory called `~`, not your home directory. Write the full path instead.
|
|
164
|
+
1. A `:files` glob such as `+:**/*.c` collects the build directory’s own mocks, runners, and vendored Unity and CMock sources, and test files, and a release build then stops compiling them. Write the glob below your own source directories, such as `+:src/**/*.c`. A source root holding the test root also collects test files into a release build; add a `-:` `:files` entry for them.
|
|
165
|
+
1. With `:bullseye` ↳ `:report_task: TRUE`, a `report:bullseye` task on the same command line as a fresh `bullseye:` build writes HTML and XML reports that include Unity, generated test runners, and test files. Run `report:bullseye` again, or run it as its own command after the build ([#1385](https://github.com/ThrowTheSwitch/Ceedling/issues/1385)).
|
|
166
|
+
1. A test whose build logs “Isolated ‘…’ into its own directory” recompiles some of its objects on every build, though nothing changed. Each build gives the isolated header’s copy a directory with a new name, and those objects track it. Builds stay correct, and no setting avoids the recompiles. The isolation helps only with `:cmock` ↳ `:treat_inlines: :include`. With other mocks and with Partials it changes nothing ([#1408](https://github.com/ThrowTheSwitch/Ceedling/issues/1408)).
|
|
167
|
+
1. A mock or `#include` that names a header by a directory below a search path, as in `#include "drivers/mock_foo.h"` with `src/` listed, stops the build with ``Found no file `drivers/foo.h` in search paths.`` A glob such as `src/**`, which lists every directory below `src/`, works around it.
|
|
168
|
+
1. A header that only `:files` ↳ `:include` supplies can’t be mocked. The build stops with ``Found no file `…` in search paths.`` Listing the header’s directory in `:paths` ↳ `:include` works around it.
|
|
26
169
|
|
|
27
170
|
### Partials
|
|
28
171
|
|
|
29
172
|
1. A module whose header protects itself with `#pragma once` instead of a traditional `#ifndef` include guard can still hit a `redefinition` or `conflicting types` error, if any other header your module uses reaches that header in turn. Ceedling suppresses the real header by defining its include guard, and `#pragma once` provides no guard to define. Converting the module’s header to a traditional include guard works around it.
|
|
173
|
+
1. A module whose source includes its own header and then a header that uses the module header’s types or macros fails in a Partial with an `unknown type name` or `undeclared` error. A Partial writes every include it carries ahead of the module’s types. Moving those types and macros into a header of their own, which each header using them includes directly, works around it.
|
|
174
|
+
1. A module header that `#include`s another header after its own types, where that header uses them, fails in a Partial with an `unknown type name` error. A Partial writes a module header’s own includes ahead of its types. Moving those types into a header of their own, which each header using them includes directly, works around it.
|
|
30
175
|
1. A type created by a macro invocation rather than written out — the list and queue building macros in `sys/queue.h`, for instance — is not recognized as a type, and a Partial using one fails to compile with an `unknown type name` error.
|
|
31
|
-
1. A `struct`, `union`, or `enum` written directly on a variable, as in `static struct { int depth; } slot;`, is treated as a variable alone. The generated Partial states the type twice and fails to compile.
|
|
176
|
+
1. A `struct`, `union`, or `enum` written directly on a variable, as in `static struct { int depth; } slot;`, is treated as a variable alone. The generated Partial states the type twice and fails to compile. Define the type on its own, then declare the variable by the type’s name.
|
|
32
177
|
1. A `struct`, `union`, or `enum` named but not defined, as in `struct node;`, is reproduced in the generated Partial as an invalid declaration. Builds treating warnings as errors fail on it.
|
|
178
|
+
1. A declaration that a C23 attribute leads, as in `[[maybe_unused]] static int count;`, is misread, and the generated Partial fails to compile. GCC’s spelling of the attribute after the name, as in `static int count __attribute__((unused));`, works around it.
|
|
179
|
+
1. A function-scoped `static` with a macro after its name, as in `static int count UNUSED;`, is promoted under the macro’s name, and the generated Partial fails to compile. Writing the macro ahead of the type, as in `static UNUSED int count;`, works around it.
|
|
180
|
+
1. A type with a macro after its closing brace, as in `struct pk { char c; int i; } PACKED;`, is taken for a variable named after the macro, so the type never reaches the Partial’s types header. Writing the macro ahead of the tag, as in `struct PACKED pk { … };`, works around it.
|
|
181
|
+
1. A function returning a struct that takes parameters, followed by a stray `;` after its body, as in `struct ops make(int n) { … };`, is taken for a type definition and written to the Partial’s types header. Removing the stray `;` works around it.
|
|
182
|
+
1. A variable with an asm label and, ahead of its name, a macro taking a word argument, as in `int MY_ALIGN(N) g asm("g_sym");`, is read as a function named after the macro.
|
|
33
183
|
1. A macro the module retires with `#undef` is carried into the generated Partial anyway, so the name stays visible to your test file and can collide with another macro of the same name.
|
|
34
184
|
1. Exposing a module’s file-scope variables and functions removes what kept their names private to that module. Two Partialized modules in one test file that each use the same name for a file-scope variable collide at link time.
|
|
35
185
|
1. Partials cannot generate a module that text-only fallback preprocessing is unable to resolve — a module with an `#include` naming a macro, or with a type behind a conditional expression that cannot be evaluated without a real preprocessor. Ceedling stops the build and names the file and line rather than generating something subtly wrong. Fallback preprocessing is only used where your compiler does not support `-fdirectives-only`, older Apple Clang releases most notably, or where you force it with `:test_build` ↳ `:preprocess_force_fallback`.
|
|
36
186
|
|
|
187
|
+
Resolved in 1.2.2: the mixing of two installations’ code, `./ceedling` failing in a `--local` project, delta builds not relinking a changed library, most shell characters in a path stopping a test from running, and the path handling problems above: mocks written outside the build directory, same-named sources sharing an object, `clobber` emptying a project under a `.` build root, `-:` entries keeping the directories below them, and `~`. Also resolved: frameworks vendor copying failing on files `lstat` misreports as directories. The [Changelog](Changelog.md) lists every other fix since this release.
|
|
188
|
+
|
|
189
|
+
Resolved in 1.2.3: `report:bullseye` reports including framework and test sources when run beside a fresh `bullseye:` build, a Partial misreading a declaration that a C23 attribute leads, a Partial failing for a module whose source includes its own header before a header that uses its types, an isolated header recompiling a test’s objects on every build, a Partial failing for a variable declared together with its type, a Partial reproducing a forward declaration such as `struct node;` as an invalid declaration, a Partial losing an attribute a macro writes after a type’s closing brace, a header named by a directory below a search path not being found, and a header only `:files` ↳ `:include` supplies not being mockable.
|
|
190
|
+
|
|
191
|
+
---
|
|
192
|
+
|
|
37
193
|
## 1.1.x — 2026-07-16
|
|
38
194
|
|
|
195
|
+
Covers 1.1.0 through 1.1.10 as known by 1.1.10. An item may not apply to every patch release.
|
|
196
|
+
|
|
39
197
|
1. The new internal pipeline as of 1.0.0 that allows builds to be parallelized and configured per-test-executable can mean a fair amount of duplication of steps. A header file may be mocked identically multiple times. The same source file may be compiled identically multiple times. The speed gains due to parallelization help make up for this. Future releases will concentrate on optimizing away duplication of build steps.
|
|
40
198
|
1. While header file search paths are now customizable per executable, this currently only applies to the search paths the compiler uses. Distinguishing test files or header files of the same name in different directories for test runner and mock generation respectively continues to rely on educated guesses in Ceedling code.
|
|
41
199
|
1. All header files needed for test compilation must be within the `:includes` path collection. Relative paths in include directives that extend outside the path collection will cause build problems.
|
|
42
200
|
1. Any path for a C file specified with `TEST_SOURCE_FILE(...)` is in relation to **_project root_** — that is, from where you execute `ceedling` at the command line. If you move source files or change your directory structure, many of your `TEST_SOURCE_FILE(...)` calls may need to be updated. A more flexible and dynamic approach to path handling will come in a future update.
|
|
43
201
|
1. In certain combinations of conditional preprocessing blocks with dependent symbols defined in another file, Ceedling can silently fail to extract computed includes (e.g. `#include SOME_MACRO()`).
|
|
44
|
-
1. The automatic vendor copying of Unity, CMock, and CException into a project
|
|
202
|
+
1. The automatic vendor copying of Unity, CMock, and CException into a project’s build directory can intermittently fail with a file/directory type error, most often under antivirus/EDR file locking, cloud-sync filter drivers, or two concurrent Ceedling invocations racing the same destination. Deleting `build/` (or reinstalling the gem) and rebuilding works around it.
|
|
45
203
|
1. The Bullseye code coverage plugin has been temporarily disabled as of 1.0.0. The makers of Bullseye have generously provided a license for development, and the plugin will be available in 1.2.0.
|
|
46
204
|
1. On Windows, a test file whose name contains _install_, _setup_, _update_, or _patch_ can build a test executable that the Installer Detection feature of User Account Control (UAC) will not run without administrator privileges. Toolchains that embed a manifest requesting the invoker’s privileges, such as MSYS2’s MinGW-w64 GCC with its default manifest installed, avoid this. Otherwise, avoid these words in test filenames.
|
|
47
|
-
1.
|
|
205
|
+
1. A test can't run when its file name or the build root holds a space, an apostrophe, or another character the shell reads, such as `&`, `;`, `(`, or `|`. Every case reports a crash, or the build stops. Paths the cppcheck, Dependencies, and Valgrind tools name break the same way. Rename the file, or quote the test fixture’s executable: `:tools` ↳ `:test_fixture` ↳ `:executable: '"${1}"'` ([#1373](https://github.com/ThrowTheSwitch/Ceedling/issues/1373)).
|
|
206
|
+
1. A release isn't relinked when only a library it links changes, since it depends only on its objects. Test builds relink every time. Run `ceedling clobber` after a library changes ([#1368](https://github.com/ThrowTheSwitch/Ceedling/issues/1368)).
|
|
207
|
+
1. A `--local` project’s `./ceedling` fails with “`vendor/ceedling/vendor/unity/test/targets` does not exist”, because vendoring leaves out Unity’s built-in mixins. Running the project with the gem’s `ceedling` command works around it.
|
|
208
|
+
1. Ceedling depends on the `erb` gem. Published `erb` versions include those affected by CVE-2026-41316, a flaw in how ERB reconstructs a template object from serialized data. Ceedling never reconstructs a template object this way, so Ceedling itself is not exposed. Dependency and security scanners may still flag the `erb` gem because the dependency is present. The `erb` dependency will be removed entirely as of 1.2.0 for multiple reasons beyond eliminating any false positive flags of the security issue.
|
|
48
209
|
|
|
49
210
|
### Partials
|
|
50
211
|
|
|
@@ -52,13 +213,22 @@ Ceedling 1.2.0 requires Ruby 3+ but only unoficially supports Ruby 4.
|
|
|
52
213
|
1. User includes (`#include "path/user.h"`) from source C files lose their relative path when Partial and mock header files are generated from source. Compilation failures can result from certain uncommon cases involving headers of the same names in different directories and a source file including both such headers.
|
|
53
214
|
1. Partial directive macros accept only a bare module name — a filename stem with no path. A project holding two modules of the same name in different directories cannot say which of them a Partial is for, and Ceedling resolves the name the way a compiler resolves a header, selecting the first match among the ordered search paths. Path-qualified Partial macros will arrive in 1.2.0.
|
|
54
215
|
1. A module whose header protects itself with `#pragma once` instead of a traditional `#ifndef` include guard can still hit a `redefinition` or `conflicting types` error, if any other header your module uses reaches that header in turn. Ceedling suppresses the real header by defining its include guard, and `#pragma once` provides no guard to define. Converting the module’s header to a traditional include guard works around it.
|
|
216
|
+
1. A module whose source includes its own header and then a header that uses the module header’s types or macros fails in a Partial with an `unknown type name` or `undeclared` error. A Partial writes every include it carries ahead of the module’s types. Moving those types and macros into a header of their own, which each header using them includes directly, works around it.
|
|
217
|
+
1. A module header that `#include`s another header after its own types, where that header uses them, fails in a Partial with an `unknown type name` error. A Partial writes a module header’s own includes ahead of its types. Moving those types into a header of their own, which each header using them includes directly, works around it.
|
|
55
218
|
1. A type created by a macro invocation rather than written out — the list and queue building macros in `sys/queue.h`, for instance — is not recognized as a type, and a Partial using one fails to compile with an `unknown type name` error.
|
|
56
|
-
1. A `struct`, `union`, or `enum` written directly on a variable, as in `static struct { int depth; } slot;`, is treated as a variable alone. The generated Partial states the type twice and fails to compile.
|
|
219
|
+
1. A `struct`, `union`, or `enum` written directly on a variable, as in `static struct { int depth; } slot;`, is treated as a variable alone. The generated Partial states the type twice and fails to compile. Define the type on its own, then declare the variable by the type’s name.
|
|
57
220
|
1. A `struct`, `union`, or `enum` named but not defined, as in `struct node;`, is reproduced in the generated Partial as an invalid declaration. Builds treating warnings as errors fail on it.
|
|
221
|
+
1. A declaration that a C23 attribute leads, as in `[[maybe_unused]] static int count;`, is misread, and the generated Partial fails to compile. GCC’s spelling of the attribute after the name, as in `static int count __attribute__((unused));`, works around it.
|
|
222
|
+
1. A function-scoped `static` with a macro after its name, as in `static int count UNUSED;`, is promoted under the macro’s name, and the generated Partial fails to compile. Writing the macro ahead of the type, as in `static UNUSED int count;`, works around it.
|
|
223
|
+
1. A type with a macro after its closing brace, as in `struct pk { char c; int i; } PACKED;`, is taken for a variable named after the macro, so the type never reaches the Partial’s types header. Writing the macro ahead of the tag, as in `struct PACKED pk { … };`, works around it.
|
|
224
|
+
1. A function returning a struct that takes parameters, followed by a stray `;` after its body, as in `struct ops make(int n) { … };`, is taken for a type definition and written to the Partial’s types header. Removing the stray `;` works around it.
|
|
225
|
+
1. A variable with an asm label and, ahead of its name, a macro taking a word argument, as in `int MY_ALIGN(N) g asm("g_sym");`, is read as a function named after the macro.
|
|
58
226
|
1. A macro the module retires with `#undef` is carried into the generated Partial anyway, so the name stays visible to your test file and can collide with another macro of the same name.
|
|
59
227
|
1. Exposing a module’s file-scope variables and functions removes what kept their names private to that module. Two Partialized modules in one test file that each use the same name for a file-scope variable collide at link time.
|
|
60
228
|
1. A source line can be joined to the line before it in a generated Partial when its line number happens to match the last line of a header the source included. Two adjacent `#define`s, for instance, become one line, and the build fails with `stray '#' in program`.
|
|
61
229
|
|
|
230
|
+
Resolved in 1.2.3: a Partial misreading a declaration that a C23 attribute leads, a Partial failing for a module whose source includes its own header before a header that uses its types, a Partial failing for a variable declared together with its type, a Partial reproducing a forward declaration such as `struct node;` as an invalid declaration, and a Partial losing an attribute a macro writes after a type’s closing brace.
|
|
231
|
+
|
|
62
232
|
---
|
|
63
233
|
|
|
64
234
|
## 1.0.0 — 2025-01-01
|
|
@@ -72,3 +242,6 @@ Ceedling 1.2.0 requires Ruby 3+ but only unoficially supports Ruby 4.
|
|
|
72
242
|
1. Ceedling’s many test preprocessing improvements are not presently able to preserve Unity’s special `TEST_CASE()` and `TEST_RANGE()` features. However, preprocessing of test files is much less frequently needed than preprocessing of mockable header files. Test preprocessing can now be configured to enable only one or the other. As such, these advanced Unity features can still be used in even sophisticated projects.
|
|
73
243
|
1. The Bullseye code coverage plugin has been temporarily disabled until a license can be procured that will allow updates and improvements.
|
|
74
244
|
1. On Windows, a test file whose name contains _install_, _setup_, _update_, or _patch_ can build a test executable that the Installer Detection feature of User Account Control (UAC) will not run without administrator privileges. Toolchains that embed a manifest requesting the invoker’s privileges, such as MSYS2’s MinGW-w64 GCC with its default manifest installed, avoid this. Otherwise, avoid these words in test filenames.
|
|
245
|
+
1. A test can't run when its file name or the build root holds a space, an apostrophe, or another character the shell reads, such as `&`, `;`, `(`, or `|`. Every case reports a crash, or the build stops. Paths the Dependencies plugin’s tools name break the same way. Rename the file, or quote the test fixture’s executable: `:tools` ↳ `:test_fixture` ↳ `:executable: '"${1}"'` ([#1373](https://github.com/ThrowTheSwitch/Ceedling/issues/1373)).
|
|
246
|
+
|
|
247
|
+
Resolved in 1.1.0: test preprocessing losing Unity’s `TEST_CASE()` and `TEST_RANGE()`.
|