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
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
|
|
22
22
|
|
|
23
23
|
<link rel="icon" href="../../assets/images/favicon.png">
|
|
24
|
-
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.
|
|
24
|
+
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.2">
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
|
|
@@ -4433,7 +4433,7 @@ C handling will likely have failings and gaps.</p>
|
|
|
4433
4433
|
<li>Runs your source code under test through the preprocessor to:<ol>
|
|
4434
4434
|
<li>Handle <code>#ifdef</code> blocks and strip comments.</li>
|
|
4435
4435
|
<li>Collect the <code>#include</code> directives.</li>
|
|
4436
|
-
<li>Expand decorator macros (e.g. <code>STATICINLINE</code>) in function
|
|
4436
|
+
<li>Expand decorator macros (e.g. <code>STATICINLINE</code>) in function and variable declarations.</li>
|
|
4437
4437
|
</ol>
|
|
4438
4438
|
</li>
|
|
4439
4439
|
<li>Lexes the code under test to collect its individual C language elements
|
|
@@ -4443,16 +4443,21 @@ C handling will likely have failings and gaps.</p>
|
|
|
4443
4443
|
<li>Reconstructed with the <code>#include</code> directives from (1) and elements
|
|
4444
4444
|
from (2).</li>
|
|
4445
4445
|
<li>Reorganized and slightly altered so the C elements can be accessed by
|
|
4446
|
-
assertions and mocks in your test cases.
|
|
4447
|
-
<code>static</code> and <code>inline</code>. Variables are stripped of <code>static</code>
|
|
4446
|
+
assertions and mocks in your test cases. Selected functions are stripped
|
|
4447
|
+
of <code>static</code>, <code>extern</code> and <code>inline</code>. Variables are stripped of <code>static</code>
|
|
4448
|
+
and <code>extern</code>ed.</li>
|
|
4449
|
+
<li>In the implementation source, accompanied by what the selected functions
|
|
4450
|
+
rely on. That includes prototypes of functions defined elsewhere or left
|
|
4451
|
+
out, and the header helpers the functions use
|
|
4452
|
+
(<a href="conventions.html#what-a-partial-carries-from-your-module">details</a>).</li>
|
|
4448
4453
|
</ol>
|
|
4449
4454
|
</li>
|
|
4450
4455
|
<li>Structures the test build to omit the original source file from the
|
|
4451
|
-
resulting test executable. Generated Partials
|
|
4452
|
-
|
|
4453
|
-
<li>Maps the
|
|
4454
|
-
original
|
|
4455
|
-
|
|
4456
|
+
resulting test executable. Generated Partials stand in for the original C
|
|
4457
|
+
code from which the Partials are derived.</li>
|
|
4458
|
+
<li>Maps the functions and carried items in generated Partials back to their
|
|
4459
|
+
original filepaths and line numbers (using C's <code>#line</code> directive) for
|
|
4460
|
+
correct test coverage reporting.</li>
|
|
4456
4461
|
</ol>
|
|
4457
4462
|
<div class="admonition tip">
|
|
4458
4463
|
<p class="admonition-title">Walk-through example</p>
|
|
@@ -4476,7 +4481,7 @@ demonstration of Test Partials and Mock Partials.</p>
|
|
|
4476
4481
|
</tr>
|
|
4477
4482
|
<tr>
|
|
4478
4483
|
<td>Testable source</td>
|
|
4479
|
-
<td><ul><li>Defines functions</li><li>Defines <code>static</code>-less variables</li></ul></td>
|
|
4484
|
+
<td><ul><li>Defines functions</li><li>Defines <code>static</code>-less variables</li><li>Carries what the functions rely on</li></ul></td>
|
|
4480
4485
|
<td><code>ceedling_partial_<module>_impl.c</code></td>
|
|
4481
4486
|
</tr>
|
|
4482
4487
|
<tr>
|
|
@@ -4484,10 +4489,23 @@ demonstration of Test Partials and Mock Partials.</p>
|
|
|
4484
4489
|
<td><ul><li>Declares function signatures</li></ul></td>
|
|
4485
4490
|
<td><code>ceedling_partial_<module>_interface.h</code></td>
|
|
4486
4491
|
</tr>
|
|
4492
|
+
<tr>
|
|
4493
|
+
<td>Mockable header extras</td>
|
|
4494
|
+
<td><ul><li>Keeps the rest of your header for the code that includes it</li></ul></td>
|
|
4495
|
+
<td><code>ceedling_partial_<module>_extras.h</code></td>
|
|
4496
|
+
</tr>
|
|
4487
4497
|
</tbody>
|
|
4488
4498
|
</table>
|
|
4489
4499
|
<p>Ceedling uses CMock to generate mocks from Partials interface header files
|
|
4490
|
-
just as it does for any other mockable header files
|
|
4500
|
+
just as it does for any other mockable header files. An interface header holds
|
|
4501
|
+
only declarations Ceedling has already resolved, with no inline bodies, so CMock
|
|
4502
|
+
reads it as generated, without the preprocessing other mocked headers get.</p>
|
|
4503
|
+
<p>A module your test mocks but doesn't test can also get an extras header. It
|
|
4504
|
+
keeps your header's helpers, <code>static</code> variables, and other declarations the
|
|
4505
|
+
mock leaves out
|
|
4506
|
+
(<a href="conventions.html#what-a-mock-partial-keeps-from-your-header">details</a>), and
|
|
4507
|
+
exists only when it keeps something. The interface header includes it, and
|
|
4508
|
+
CMock never reads it.</p>
|
|
4491
4509
|
<div class="admonition danger">
|
|
4492
4510
|
<p class="admonition-title">Do not directly access generated Partials files</p>
|
|
4493
4511
|
<p>You as the test author will never directly interact with generated
|
|
@@ -4565,7 +4583,7 @@ incorporate them into your tests except with the accompanying macros.</p>
|
|
|
4565
4583
|
<script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.a7633da7.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
|
|
4566
4584
|
|
|
4567
4585
|
|
|
4568
|
-
<script src="../../assets/javascripts/bundle.
|
|
4586
|
+
<script src="../../assets/javascripts/bundle.a5f9d56c.min.js"></script>
|
|
4569
4587
|
|
|
4570
4588
|
|
|
4571
4589
|
</body>
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
|
|
22
22
|
|
|
23
23
|
<link rel="icon" href="../../assets/images/favicon.png">
|
|
24
|
-
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.
|
|
24
|
+
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.2">
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
|
|
@@ -1597,6 +1597,34 @@
|
|
|
1597
1597
|
</ul>
|
|
1598
1598
|
</nav>
|
|
1599
1599
|
|
|
1600
|
+
</li>
|
|
1601
|
+
|
|
1602
|
+
<li class="md-nav__item">
|
|
1603
|
+
<a href="#a-variable-declared-together-with-its-type" class="md-nav__link">
|
|
1604
|
+
<span class="md-ellipsis">
|
|
1605
|
+
|
|
1606
|
+
A variable declared together with its type
|
|
1607
|
+
|
|
1608
|
+
</span>
|
|
1609
|
+
</a>
|
|
1610
|
+
|
|
1611
|
+
<nav class="md-nav" aria-label="A variable declared together with its type">
|
|
1612
|
+
<ul class="md-nav__list">
|
|
1613
|
+
|
|
1614
|
+
<li class="md-nav__item">
|
|
1615
|
+
<a href="#partial_type-and-partial_local_type-macros-to-name-a-type" class="md-nav__link">
|
|
1616
|
+
<span class="md-ellipsis">
|
|
1617
|
+
|
|
1618
|
+
PARTIAL_TYPE() and PARTIAL_LOCAL_TYPE() macros to name a type
|
|
1619
|
+
|
|
1620
|
+
</span>
|
|
1621
|
+
</a>
|
|
1622
|
+
|
|
1623
|
+
</li>
|
|
1624
|
+
|
|
1625
|
+
</ul>
|
|
1626
|
+
</nav>
|
|
1627
|
+
|
|
1600
1628
|
</li>
|
|
1601
1629
|
|
|
1602
1630
|
</ul>
|
|
@@ -4419,6 +4447,34 @@
|
|
|
4419
4447
|
</ul>
|
|
4420
4448
|
</nav>
|
|
4421
4449
|
|
|
4450
|
+
</li>
|
|
4451
|
+
|
|
4452
|
+
<li class="md-nav__item">
|
|
4453
|
+
<a href="#a-variable-declared-together-with-its-type" class="md-nav__link">
|
|
4454
|
+
<span class="md-ellipsis">
|
|
4455
|
+
|
|
4456
|
+
A variable declared together with its type
|
|
4457
|
+
|
|
4458
|
+
</span>
|
|
4459
|
+
</a>
|
|
4460
|
+
|
|
4461
|
+
<nav class="md-nav" aria-label="A variable declared together with its type">
|
|
4462
|
+
<ul class="md-nav__list">
|
|
4463
|
+
|
|
4464
|
+
<li class="md-nav__item">
|
|
4465
|
+
<a href="#partial_type-and-partial_local_type-macros-to-name-a-type" class="md-nav__link">
|
|
4466
|
+
<span class="md-ellipsis">
|
|
4467
|
+
|
|
4468
|
+
PARTIAL_TYPE() and PARTIAL_LOCAL_TYPE() macros to name a type
|
|
4469
|
+
|
|
4470
|
+
</span>
|
|
4471
|
+
</a>
|
|
4472
|
+
|
|
4473
|
+
</li>
|
|
4474
|
+
|
|
4475
|
+
</ul>
|
|
4476
|
+
</nav>
|
|
4477
|
+
|
|
4422
4478
|
</li>
|
|
4423
4479
|
|
|
4424
4480
|
</ul>
|
|
@@ -4523,6 +4579,16 @@ generated <code>_impl.h</code> header. Including any <code>TEST_PARTIAL_*_MODULE
|
|
|
4523
4579
|
that <code>extern</code> declaration into scope, causing the variable to accessible in
|
|
4524
4580
|
test code directly by its <strong>original name</strong> — no renaming or helper macro is
|
|
4525
4581
|
required.</p>
|
|
4582
|
+
<p>A variable your module declares <code>extern</code> but never defines lives somewhere
|
|
4583
|
+
else. The generated <code>_impl.h</code> header declares it <code>extern</code>. By default, the
|
|
4584
|
+
generated <code>_impl.c</code> file gives it a weak definition. A real definition, from a
|
|
4585
|
+
module your test links or from the test file itself, takes precedence over the
|
|
4586
|
+
weak one. When nothing else defines the variable, the weak definition stands in.
|
|
4587
|
+
Weak definitions need a GCC-compatible compiler, such as GCC or Clang. The
|
|
4588
|
+
<a href="../../configuration/reference/partials.html#extern_variables"><code>:partials</code> ↳ <code>:extern_variables</code></a>
|
|
4589
|
+
setting can leave the definition to your test instead, and describes the
|
|
4590
|
+
exceptions. A variable your module defines is written where your module
|
|
4591
|
+
defines it.</p>
|
|
4526
4592
|
<h3 id="partial-file-scoped-static-variable-example">Partial file-scoped static variable example</h3>
|
|
4527
4593
|
<p>Extending the sensor module with a file-scoped error counter:</p>
|
|
4528
4594
|
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="c1">// sensor.c -----------------------------------------------</span>
|
|
@@ -4542,7 +4608,7 @@ required.</p>
|
|
|
4542
4608
|
</code></pre></div>
|
|
4543
4609
|
<p>Ceedling strips <code>static</code> when generating the test Partial:</p>
|
|
4544
4610
|
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="c1">// ceedling_partial_sensor_impl.c (generated) ---------------</span>
|
|
4545
|
-
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="c1">// `static` stripped
|
|
4611
|
+
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="c1">// `static` stripped, giving it external linkage</span>
|
|
4546
4612
|
<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a><span class="kt">uint32_t</span><span class="w"> </span><span class="n">g_error_count</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span>
|
|
4547
4613
|
<a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a><span class="c1">// ...</span>
|
|
4548
4614
|
<a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a><span class="kt">int</span><span class="w"> </span><span class="nf">Sensor_ReadCelsius</span><span class="p">(</span><span class="kt">void</span><span class="p">)</span>
|
|
@@ -4607,7 +4673,7 @@ statement so that source line mappings for coverage reporting remain accurate.</
|
|
|
4607
4673
|
both to module scope without renaming would produce a duplicate symbol error
|
|
4608
4674
|
at compilation.</p>
|
|
4609
4675
|
<p>Ceedling resolves this by prepending a prefix of <code>partial_</code> and the containing
|
|
4610
|
-
function
|
|
4676
|
+
function’s name to each promoted variable’s name:</p>
|
|
4611
4677
|
<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>partial_<function_name>_<variable_name>
|
|
4612
4678
|
</code></pre></div>
|
|
4613
4679
|
<p>Example renaming:</p>
|
|
@@ -4720,6 +4786,105 @@ compile time. It cannot be used with a runtime string or a variable holding a
|
|
|
4720
4786
|
function name. Both arguments must be literal tokens that match the original
|
|
4721
4787
|
C identifiers exactly (the function name and the variable name as they appear
|
|
4722
4788
|
in the source file).</p>
|
|
4789
|
+
<h2 id="a-variable-declared-together-with-its-type">A variable declared together with its type</h2>
|
|
4790
|
+
<p>A Partial reads a statement that defines a type and declares a variable as two
|
|
4791
|
+
things. Embedded modules often keep private state this way, as in
|
|
4792
|
+
<code>static struct { int count; } s_ctx;</code> or <code>static enum { IDLE, RUN } s_state;</code>.
|
|
4793
|
+
The Partial defines the type once, in its generated types header, and declares
|
|
4794
|
+
and defines each variable by the type’s name. A test reaches the variable, the
|
|
4795
|
+
type’s members and an anonymous enum’s values as it does any other.</p>
|
|
4796
|
+
<p>The Partial names the type after its first variable. Each name takes the
|
|
4797
|
+
module’s name and the variable’s, and a function-scoped <code>static</code> adds its
|
|
4798
|
+
function’s name:</p>
|
|
4799
|
+
<div class="highlight"><pre><span></span><code><a id="__codelineno-10-1" name="__codelineno-10-1" href="#__codelineno-10-1"></a>ceedling_partial_<module>_<variable>_t
|
|
4800
|
+
<a id="__codelineno-10-2" name="__codelineno-10-2" href="#__codelineno-10-2"></a>ceedling_partial_<module>_<function>_<variable>_t
|
|
4801
|
+
</code></pre></div>
|
|
4802
|
+
<table>
|
|
4803
|
+
<thead>
|
|
4804
|
+
<tr>
|
|
4805
|
+
<th>Declaration</th>
|
|
4806
|
+
<th>Module</th>
|
|
4807
|
+
<th>Function</th>
|
|
4808
|
+
<th>Type name</th>
|
|
4809
|
+
</tr>
|
|
4810
|
+
</thead>
|
|
4811
|
+
<tbody>
|
|
4812
|
+
<tr>
|
|
4813
|
+
<td><code>static struct { int count; } s_ctx;</code></td>
|
|
4814
|
+
<td><code>ticker</code></td>
|
|
4815
|
+
<td></td>
|
|
4816
|
+
<td><code>ceedling_partial_ticker_s_ctx_t</code></td>
|
|
4817
|
+
</tr>
|
|
4818
|
+
<tr>
|
|
4819
|
+
<td><code>struct pair { int a; } g_p1, g_p2;</code></td>
|
|
4820
|
+
<td><code>ticker</code></td>
|
|
4821
|
+
<td></td>
|
|
4822
|
+
<td><code>ceedling_partial_ticker_g_p1_t</code></td>
|
|
4823
|
+
</tr>
|
|
4824
|
+
<tr>
|
|
4825
|
+
<td><code>static struct { int n; } last;</code></td>
|
|
4826
|
+
<td><code>ticker</code></td>
|
|
4827
|
+
<td><code>ticker_get</code></td>
|
|
4828
|
+
<td><code>ceedling_partial_ticker_ticker_get_last_t</code></td>
|
|
4829
|
+
</tr>
|
|
4830
|
+
</tbody>
|
|
4831
|
+
</table>
|
|
4832
|
+
<p>The module’s name is its name alone, without a directory. A character a C
|
|
4833
|
+
identifier can't hold is written as <code>_</code>, so module <code>my-sensor</code> gives
|
|
4834
|
+
<code>ceedling_partial_my_sensor_…</code>. Variables declared in one statement share one
|
|
4835
|
+
type, named for the first of them, as <code>g_p1</code> and <code>g_p2</code> do above.</p>
|
|
4836
|
+
<p>A tagged type keeps its tag at file scope, so <code>struct pair</code> still names it. A
|
|
4837
|
+
tag a function defines takes the type’s name as its tag instead, since the tag
|
|
4838
|
+
could otherwise collide with another at file scope. A struct member sharing a
|
|
4839
|
+
promoted variable’s name is renamed with it, in the type and wherever the
|
|
4840
|
+
function uses it.</p>
|
|
4841
|
+
<h3 id="partial_type-and-partial_local_type-macros-to-name-a-type"><code>PARTIAL_TYPE()</code> and <code>PARTIAL_LOCAL_TYPE()</code> macros to name a type</h3>
|
|
4842
|
+
<p><code>ceedling.h</code> builds these names for you. Use them to declare another object of
|
|
4843
|
+
the type, such as a copy of a module’s state saved before a call.</p>
|
|
4844
|
+
<div class="highlight"><pre><span></span><code><a id="__codelineno-11-1" name="__codelineno-11-1" href="#__codelineno-11-1"></a><span class="n">PARTIAL_TYPE</span><span class="p">(</span><span class="n">module</span><span class="p">,</span><span class="w"> </span><span class="n">variable</span><span class="p">)</span>
|
|
4845
|
+
<a id="__codelineno-11-2" name="__codelineno-11-2" href="#__codelineno-11-2"></a><span class="c1">// Expands to: ceedling_partial_<module>_<variable>_t</span>
|
|
4846
|
+
<a id="__codelineno-11-3" name="__codelineno-11-3" href="#__codelineno-11-3"></a>
|
|
4847
|
+
<a id="__codelineno-11-4" name="__codelineno-11-4" href="#__codelineno-11-4"></a><span class="n">PARTIAL_LOCAL_TYPE</span><span class="p">(</span><span class="n">module</span><span class="p">,</span><span class="w"> </span><span class="n">function</span><span class="p">,</span><span class="w"> </span><span class="n">variable</span><span class="p">)</span>
|
|
4848
|
+
<a id="__codelineno-11-5" name="__codelineno-11-5" href="#__codelineno-11-5"></a><span class="c1">// Expands to: ceedling_partial_<module>_<function>_<variable>_t</span>
|
|
4849
|
+
</code></pre></div>
|
|
4850
|
+
<p>Like <code>PARTIAL_LOCAL_VAR()</code>, each macro pastes its arguments into one identifier.
|
|
4851
|
+
Each argument is a literal identifier spelled as the module spells it.</p>
|
|
4852
|
+
<div class="highlight"><pre><span></span><code><a id="__codelineno-12-1" name="__codelineno-12-1" href="#__codelineno-12-1"></a><span class="c1">// ticker.c -----------------------------------------------</span>
|
|
4853
|
+
<a id="__codelineno-12-2" name="__codelineno-12-2" href="#__codelineno-12-2"></a><span class="k">static</span><span class="w"> </span><span class="k">struct</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="n">count</span><span class="p">;</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="n">s_ctx</span><span class="p">;</span>
|
|
4854
|
+
<a id="__codelineno-12-3" name="__codelineno-12-3" href="#__codelineno-12-3"></a>
|
|
4855
|
+
<a id="__codelineno-12-4" name="__codelineno-12-4" href="#__codelineno-12-4"></a><span class="kt">int</span><span class="w"> </span><span class="nf">ticker_get</span><span class="p">(</span><span class="kt">void</span><span class="p">)</span>
|
|
4856
|
+
<a id="__codelineno-12-5" name="__codelineno-12-5" href="#__codelineno-12-5"></a><span class="p">{</span>
|
|
4857
|
+
<a id="__codelineno-12-6" name="__codelineno-12-6" href="#__codelineno-12-6"></a><span class="w"> </span><span class="k">static</span><span class="w"> </span><span class="k">struct</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="n">n</span><span class="p">;</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="n">last</span><span class="p">;</span>
|
|
4858
|
+
<a id="__codelineno-12-7" name="__codelineno-12-7" href="#__codelineno-12-7"></a><span class="w"> </span><span class="n">last</span><span class="p">.</span><span class="n">n</span><span class="o">++</span><span class="p">;</span>
|
|
4859
|
+
<a id="__codelineno-12-8" name="__codelineno-12-8" href="#__codelineno-12-8"></a><span class="w"> </span><span class="n">s_ctx</span><span class="p">.</span><span class="n">count</span><span class="o">++</span><span class="p">;</span>
|
|
4860
|
+
<a id="__codelineno-12-9" name="__codelineno-12-9" href="#__codelineno-12-9"></a><span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="n">last</span><span class="p">.</span><span class="n">n</span><span class="p">;</span>
|
|
4861
|
+
<a id="__codelineno-12-10" name="__codelineno-12-10" href="#__codelineno-12-10"></a><span class="p">}</span>
|
|
4862
|
+
</code></pre></div>
|
|
4863
|
+
<div class="highlight"><pre><span></span><code><a id="__codelineno-13-1" name="__codelineno-13-1" href="#__codelineno-13-1"></a><span class="c1">// test_ticker.c ------------------------------------------</span>
|
|
4864
|
+
<a id="__codelineno-13-2" name="__codelineno-13-2" href="#__codelineno-13-2"></a><span class="cp">#include</span><span class="w"> </span><span class="cpf">"unity.h"</span>
|
|
4865
|
+
<a id="__codelineno-13-3" name="__codelineno-13-3" href="#__codelineno-13-3"></a><span class="cp">#include</span><span class="w"> </span><span class="cpf">"ceedling.h"</span>
|
|
4866
|
+
<a id="__codelineno-13-4" name="__codelineno-13-4" href="#__codelineno-13-4"></a><span class="cp">#include TEST_PARTIAL_PUBLIC_MODULE(ticker)</span>
|
|
4867
|
+
<a id="__codelineno-13-5" name="__codelineno-13-5" href="#__codelineno-13-5"></a>
|
|
4868
|
+
<a id="__codelineno-13-6" name="__codelineno-13-6" href="#__codelineno-13-6"></a><span class="kt">void</span><span class="w"> </span><span class="nf">test_ticker_get_counts_each_call</span><span class="p">(</span><span class="kt">void</span><span class="p">)</span>
|
|
4869
|
+
<a id="__codelineno-13-7" name="__codelineno-13-7" href="#__codelineno-13-7"></a><span class="p">{</span>
|
|
4870
|
+
<a id="__codelineno-13-8" name="__codelineno-13-8" href="#__codelineno-13-8"></a><span class="w"> </span><span class="n">PARTIAL_TYPE</span><span class="p">(</span><span class="n">ticker</span><span class="p">,</span><span class="w"> </span><span class="n">s_ctx</span><span class="p">)</span><span class="w"> </span><span class="n">before</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">s_ctx</span><span class="p">;</span>
|
|
4871
|
+
<a id="__codelineno-13-9" name="__codelineno-13-9" href="#__codelineno-13-9"></a><span class="w"> </span><span class="n">PARTIAL_LOCAL_TYPE</span><span class="p">(</span><span class="n">ticker</span><span class="p">,</span><span class="w"> </span><span class="n">ticker_get</span><span class="p">,</span><span class="w"> </span><span class="n">last</span><span class="p">)</span><span class="w"> </span><span class="n">step</span><span class="p">;</span>
|
|
4872
|
+
<a id="__codelineno-13-10" name="__codelineno-13-10" href="#__codelineno-13-10"></a>
|
|
4873
|
+
<a id="__codelineno-13-11" name="__codelineno-13-11" href="#__codelineno-13-11"></a><span class="w"> </span><span class="n">ticker_get</span><span class="p">();</span>
|
|
4874
|
+
<a id="__codelineno-13-12" name="__codelineno-13-12" href="#__codelineno-13-12"></a><span class="w"> </span><span class="n">step</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">PARTIAL_LOCAL_VAR</span><span class="p">(</span><span class="n">ticker_get</span><span class="p">,</span><span class="w"> </span><span class="n">last</span><span class="p">);</span>
|
|
4875
|
+
<a id="__codelineno-13-13" name="__codelineno-13-13" href="#__codelineno-13-13"></a>
|
|
4876
|
+
<a id="__codelineno-13-14" name="__codelineno-13-14" href="#__codelineno-13-14"></a><span class="w"> </span><span class="n">TEST_ASSERT_EQUAL_INT</span><span class="p">(</span><span class="n">before</span><span class="p">.</span><span class="n">count</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="n">s_ctx</span><span class="p">.</span><span class="n">count</span><span class="p">);</span>
|
|
4877
|
+
<a id="__codelineno-13-15" name="__codelineno-13-15" href="#__codelineno-13-15"></a><span class="w"> </span><span class="n">TEST_ASSERT_EQUAL_INT</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="n">step</span><span class="p">.</span><span class="n">n</span><span class="p">);</span>
|
|
4878
|
+
<a id="__codelineno-13-16" name="__codelineno-13-16" href="#__codelineno-13-16"></a><span class="p">}</span>
|
|
4879
|
+
</code></pre></div>
|
|
4880
|
+
<div class="admonition tip">
|
|
4881
|
+
<p class="admonition-title">When a macro names nothing</p>
|
|
4882
|
+
<p>A misspelled argument builds a name nothing declares, and the compiler
|
|
4883
|
+
will report an error with that mysterious name. With Partials enabled,
|
|
4884
|
+
Ceedling recognizes a name that one of these macros or <code>PARTIAL_LOCAL_VAR()</code>
|
|
4885
|
+
builds from a compilation error. It explains how to correct the macro’s
|
|
4886
|
+
arguments and lists the names your test’s Partials provide.</p>
|
|
4887
|
+
</div>
|
|
4723
4888
|
<p><br/><br/></p>
|
|
4724
4889
|
|
|
4725
4890
|
|
|
@@ -4791,7 +4956,7 @@ in the source file).</p>
|
|
|
4791
4956
|
<script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.a7633da7.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
|
|
4792
4957
|
|
|
4793
4958
|
|
|
4794
|
-
<script src="../../assets/javascripts/bundle.
|
|
4959
|
+
<script src="../../assets/javascripts/bundle.a5f9d56c.min.js"></script>
|
|
4795
4960
|
|
|
4796
4961
|
|
|
4797
4962
|
</body>
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
|
|
22
22
|
|
|
23
23
|
<link rel="icon" href="../assets/images/favicon.png">
|
|
24
|
-
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.
|
|
24
|
+
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.2">
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
|
|
@@ -4679,7 +4679,7 @@ and details on how everything fits together.</p>
|
|
|
4679
4679
|
<script id="__config" type="application/json">{"annotate": null, "base": "..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.a7633da7.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
|
|
4680
4680
|
|
|
4681
4681
|
|
|
4682
|
-
<script src="../assets/javascripts/bundle.
|
|
4682
|
+
<script src="../assets/javascripts/bundle.a5f9d56c.min.js"></script>
|
|
4683
4683
|
|
|
4684
4684
|
|
|
4685
4685
|
</body>
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
|
|
22
22
|
|
|
23
23
|
<link rel="icon" href="../assets/images/favicon.png">
|
|
24
|
-
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.
|
|
24
|
+
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.2">
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
|
|
@@ -4508,7 +4508,7 @@ to be reported to the developer at the command line.</p>
|
|
|
4508
4508
|
<script id="__config" type="application/json">{"annotate": null, "base": "..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.a7633da7.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
|
|
4509
4509
|
|
|
4510
4510
|
|
|
4511
|
-
<script src="../assets/javascripts/bundle.
|
|
4511
|
+
<script src="../assets/javascripts/bundle.a5f9d56c.min.js"></script>
|
|
4512
4512
|
|
|
4513
4513
|
|
|
4514
4514
|
</body>
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
|
|
22
22
|
|
|
23
23
|
<link rel="icon" href="../assets/images/favicon.png">
|
|
24
|
-
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.
|
|
24
|
+
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.2">
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
|
|
@@ -4492,7 +4492,7 @@ executables and tallying all the test results.</p>
|
|
|
4492
4492
|
<script id="__config" type="application/json">{"annotate": null, "base": "..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.a7633da7.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
|
|
4493
4493
|
|
|
4494
4494
|
|
|
4495
|
-
<script src="../assets/javascripts/bundle.
|
|
4495
|
+
<script src="../assets/javascripts/bundle.a5f9d56c.min.js"></script>
|
|
4496
4496
|
|
|
4497
4497
|
|
|
4498
4498
|
</body>
|
|
@@ -23,8 +23,9 @@
|
|
|
23
23
|
|
|
24
24
|
require 'spec_helper'
|
|
25
25
|
require 'spec_integration_helper'
|
|
26
|
+
require 'file_tree_helper'
|
|
26
27
|
require 'actionator'
|
|
27
|
-
require 'ceedling/file_wrapper'
|
|
28
|
+
require 'ceedling/filesystem/file_wrapper'
|
|
28
29
|
|
|
29
30
|
describe 'Actionator file operations (integration)' do
|
|
30
31
|
include IntegrationSpecHelpers
|
|
@@ -144,6 +145,95 @@ describe 'Actionator file operations (integration)' do
|
|
|
144
145
|
])
|
|
145
146
|
end
|
|
146
147
|
end
|
|
148
|
+
|
|
149
|
+
# Status lines follow a sorted listing of full paths, so a file sorts ahead of the
|
|
150
|
+
# contents of a directory named like it
|
|
151
|
+
it 'reports files in sorted path order' do
|
|
152
|
+
with_source_tree({ 'tree/a/b.c' => 'b', 'tree/a.c' => 'a', 'tree/a-z.c' => 'z' }) do |dir|
|
|
153
|
+
actionator = build_actionator( dir )
|
|
154
|
+
|
|
155
|
+
actionator.copy_directory( 'tree', File.join( dir, 'out' ), force: true )
|
|
156
|
+
|
|
157
|
+
expect(@loginator.lines).to eq([
|
|
158
|
+
' create out',
|
|
159
|
+
' create out/a-z.c',
|
|
160
|
+
' create out/a.c',
|
|
161
|
+
' create out/a/b.c',
|
|
162
|
+
])
|
|
163
|
+
end
|
|
164
|
+
end
|
|
165
|
+
|
|
166
|
+
it 'leaves hidden files and hidden directories out' do
|
|
167
|
+
with_source_tree({ 'tree/keep.c' => 'k', 'tree/.rspec' => 'r', 'tree/.hidden/x.c' => 'x' }) do |dir|
|
|
168
|
+
actionator = build_actionator( dir )
|
|
169
|
+
|
|
170
|
+
actionator.copy_directory( 'tree', File.join( dir, 'out' ), force: true )
|
|
171
|
+
|
|
172
|
+
expect(Dir.children( File.join( dir, 'out' ) )).to eq( ['keep.c'] )
|
|
173
|
+
end
|
|
174
|
+
end
|
|
175
|
+
|
|
176
|
+
it 'never enters a hidden directory, so nothing inside one stops the copy' do
|
|
177
|
+
with_source_tree({ 'tree/keep.c' => 'k', 'tree/.venv/x.c' => 'x' }) do |dir|
|
|
178
|
+
begin
|
|
179
|
+
File.symlink( File.join( dir, 'nowhere' ), File.join( dir, 'tree', '.venv', 'dangling.c' ) )
|
|
180
|
+
rescue NotImplementedError, SystemCallError => e
|
|
181
|
+
skip "symlinks are unavailable here (#{e.class})"
|
|
182
|
+
end
|
|
183
|
+
actionator = build_actionator( dir )
|
|
184
|
+
|
|
185
|
+
actionator.copy_directory( 'tree', File.join( dir, 'out' ), force: true )
|
|
186
|
+
|
|
187
|
+
expect(Dir.children( File.join( dir, 'out' ) )).to eq( ['keep.c'] )
|
|
188
|
+
end
|
|
189
|
+
end
|
|
190
|
+
|
|
191
|
+
it 'copies a file below a directory named with glob metacharacters' do
|
|
192
|
+
with_source_tree({ 'tree/dir[1]/a{b}.c' => 'odd' }) do |dir|
|
|
193
|
+
actionator = build_actionator( dir )
|
|
194
|
+
|
|
195
|
+
actionator.copy_directory( 'tree', File.join( dir, 'out' ), force: true )
|
|
196
|
+
|
|
197
|
+
expect(File.read( File.join( dir, 'out', 'dir[1]', 'a{b}.c' ) )).to eq( 'odd' )
|
|
198
|
+
end
|
|
199
|
+
end
|
|
200
|
+
|
|
201
|
+
# GH #1376: the tree is listed and classified without lstat, and a linked directory's
|
|
202
|
+
# contents are copied
|
|
203
|
+
it 'descends a linked directory' do
|
|
204
|
+
with_source_tree({ 'elsewhere/inner.c' => 'inner', 'tree/keep.c' => 'k' }) do |dir|
|
|
205
|
+
begin
|
|
206
|
+
File.symlink( File.join( dir, 'elsewhere' ), File.join( dir, 'tree', 'linked' ) )
|
|
207
|
+
rescue NotImplementedError, SystemCallError => e
|
|
208
|
+
skip "symlinks are unavailable here (#{e.class})"
|
|
209
|
+
end
|
|
210
|
+
actionator = build_actionator( dir )
|
|
211
|
+
|
|
212
|
+
actionator.copy_directory( 'tree', File.join( dir, 'out' ), force: true )
|
|
213
|
+
|
|
214
|
+
expect(File.read( File.join( dir, 'out', 'linked', 'inner.c' ) )).to eq( 'inner' )
|
|
215
|
+
end
|
|
216
|
+
end
|
|
217
|
+
|
|
218
|
+
it 'copies every file as a file when lstat reports files as directories' do
|
|
219
|
+
with_source_tree({ 'tree/unity.c' => 'u', 'tree/sub/unity.h' => 'h' }) do |dir|
|
|
220
|
+
actionator = build_actionator( dir )
|
|
221
|
+
allow(File).to receive(:lstat).and_wrap_original do |original, path, *rest|
|
|
222
|
+
status = original.call( path, *rest )
|
|
223
|
+
path.to_s.include?( '/tree/' ) ? FileTreeHelper::LyingStat.new( status ) : status
|
|
224
|
+
end
|
|
225
|
+
|
|
226
|
+
begin
|
|
227
|
+
actionator.copy_directory( 'tree', File.join( dir, 'out' ), force: true )
|
|
228
|
+
ensure
|
|
229
|
+
# The temporary directory is removed by an lstat-based remover
|
|
230
|
+
allow(File).to receive(:lstat).and_call_original
|
|
231
|
+
end
|
|
232
|
+
|
|
233
|
+
expect(File.file?( File.join( dir, 'out', 'unity.c' ) )).to be true
|
|
234
|
+
expect(File.file?( File.join( dir, 'out', 'sub', 'unity.h' ) )).to be true
|
|
235
|
+
end
|
|
236
|
+
end
|
|
147
237
|
end
|
|
148
238
|
|
|
149
239
|
describe 'copy_file' do
|