ceedling 1.0.1 → 1.1.0

data/spec/system/deployment_as_gem_spec.rb

@@ -1,14 +1,14 @@
 # =========================================================================
 #   Ceedling - Test-Centered Build System for C
 #   ThrowTheSwitch.org
-#   Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
 #   SPDX-License-Identifier: MIT
 # =========================================================================
 
 require 'spec_system_helper'
 
-describe "Ceedling" do
-  include CeedlingTestCases
+ceedling_system_tests do
+  include CommonSystemTestCases
 
   before :all do
     @c = SystemContext.new
@@ -20,57 +20,95 @@ describe "Ceedling" do
     @c.done!
   end
 
-  before { @proj_name = "fake_project" }
-  after { @c.with_context { FileUtils.rm_rf @proj_name } }
+  before { @proj_name = unique_proj_name("gem") }
 
-  describe "deployed as a gem" do
+  describe "Deployed as a gem" do
     before do
       FileUtils.rm_rf( 'GIT_COMMIT_SHA' )
       @c.with_context do
-        `bundle exec ruby -S ceedling new #{@proj_name} 2>&1`
+        @c.ceedling_appcmd_exec("new #{@proj_name}")
       end
     end
 
-    it { can_report_version_no_git_commit_sha }
-    it { can_report_version_with_git_commit_sha }
-    it { can_create_projects }
-    it { does_not_contain_a_vendor_directory }
-    it { can_fetch_non_project_help }
-    it { can_fetch_project_help }
-    it { can_test_projects_with_success }
-    it { can_test_projects_with_success_test_alias }
-    it { can_test_projects_with_test_name_replaced_defines_with_success }
-    it { can_test_projects_unity_parameterized_test_cases_with_success }
-    #it { can_test_projects_unity_parameterized_test_cases_with_preprocessor_with_success }
-    it { can_test_projects_with_preprocessing_for_test_files_symbols_undefined }
-    it { can_test_projects_with_preprocessing_for_test_files_symbols_defined }
-    it { can_test_projects_with_preprocessing_for_mocks_success }
-    it { can_test_projects_with_preprocessing_for_mocks_intentional_build_failure }
-    it { can_test_projects_with_preprocessing_all }
-    it { can_test_projects_with_success_default }
-    it { can_test_projects_with_unity_exec_time }
-    it { can_test_projects_with_test_and_vendor_defines_with_success }
-    it { can_test_projects_with_fail }
-    it { can_test_projects_with_fail_alias }
-    it { can_test_projects_with_fail_default }
-    it { can_test_projects_with_compile_error }
-    it { can_test_projects_with_both_mock_and_real_header }
-    it { can_test_projects_with_success_when_space_appears_between_hash_and_include }
-    it { can_test_projects_with_named_verbosity }
-    it { can_test_projects_with_numerical_verbosity }
-    it { uses_report_tests_raw_output_log_plugin }
-    it { test_run_of_projects_fail_because_of_crash_without_report }
-    it { test_run_of_projects_fail_because_of_crash_with_report }
-    it { execute_all_test_cases_from_crashing_test_runner_and_return_test_report_with_failue }
-    it { execute_and_collect_debug_logs_from_crashing_test_case_defined_by_test_case_argument_with_enabled_debug }
-    it { execute_and_collect_debug_logs_from_crashing_test_case_defined_by_exclude_test_case_argument_with_enabled_debug }
-    it { confirm_if_notification_for_cmdline_args_not_enabled_is_disabled }
-    it { can_run_single_test_with_full_test_case_name_from_test_file_with_success }
-    it { can_run_single_test_with_partial_test_case_name_from_test_file_with_success }
-    it { exclude_test_case_name_filter_works_and_only_one_test_case_is_executed }
-    it { none_of_test_is_executed_if_test_case_name_passed_does_not_fit_defined_in_test_file }
-    it { none_of_test_is_executed_if_test_case_name_and_exclude_test_case_name_is_the_same }
-    it { run_one_testcase_from_one_test_file_when_test_case_name_is_passed }
-  end
+    describe "Version reporting" do
+      test_case :can_report_version_no_git_commit_sha
+      test_case :can_report_version_with_git_commit_sha
+    end
+
+    describe "Project creation" do
+      test_case :can_create_projects
+      test_case :does_not_contain_a_vendor_directory
+    end
 
+    describe "Help system" do
+      test_case :application_commands_help
+      test_case :project_build_tasks_plugins_help
+    end
+
+    describe "Basic test project execution" do
+      test_case :test_project_success
+      test_case :test_project_with_test_all_alias
+      test_case :test_project_success_default_task
+      test_case :test_project_fail
+      test_case :test_project_fail_alias
+      test_case :test_project_fail_default
+      test_case :test_project_with_compile_error
+      test_case :project_with_test_file_directly_including_source_file
+    end
+
+    describe "Test builds with preprocessing" do
+      test_case :test_project_preprocessing_undefined_symbols
+      test_case :test_project_preprocessing_defined_symbols
+      test_case :test_project_with_preprocessing_for_mocks
+      test_case :test_project_with_preprocessing_for_missing_mock
+      test_case :test_project_with_preprocessing_all
+    end
+
+    describe "Defines and configuration" do
+      test_case :test_project_with_per_file_defines
+      test_case :test_project_with_test_and_vendor_defines
+      test_case :test_project_with_both_mock_and_real_header
+    end
+
+    describe "Unity features" do
+      test_case :test_project_unity_parameterized_test_cases
+      test_case :test_project_preprocessed_unity_parameterized_test_cases
+      test_case :test_project_with_unity_exec_time
+    end
+
+    describe "Edge case parsing" do
+      test_case :space_between_hash_and_include_is_valid
+    end
+
+    describe "Verbosity and output" do
+      test_case :test_project_with_named_verbosity
+      test_case :test_project_with_numerical_verbosity
+      test_case :report_tests_raw_output_log_plugin
+    end
+
+    describe "Crash handling" do
+      test_case :crash_none_reports_executable_crashed
+      test_case :crash_none_writes_fail_results_file
+      test_case :crash_simple_sigsegv_all_test_cases
+      test_case :crash_simple_sigabrt_assert_failure
+    end
+
+    describe "Backtrace with GDB" do
+      include_context "requires gdb"
+
+      test_case :crash_gdb_sigsegv_all_test_cases
+      test_case :crash_gdb_sigsegv_targets_test_case_filter
+      test_case :crash_gdb_sigsegv_excludes_test_case_filter
+      test_case :crash_gdb_sigabrt_assert_failure
+    end
+
+    describe "Test filtering" do
+      test_case :run_single_test_with_full_name_filter
+      test_case :run_single_test_with_partial_name_filter
+      test_case :exclusion_filter_leaves_one_test_case
+      test_case :no_tests_run_when_filter_matches_nothing
+      test_case :no_tests_run_when_filter_and_exclusion_cancel
+      test_case :run_one_test_case_with_name_filter
+    end
+  end
 end

data/spec/system/deployment_as_vendor_spec.rb

@@ -7,8 +7,8 @@
 
 require 'spec_system_helper'
 
-describe "Ceedling" do
-  include CeedlingTestCases
+ceedling_system_tests do
+  include CommonSystemTestCases
 
   before :all do
     @c = SystemContext.new
@@ -21,103 +21,165 @@ describe "Ceedling" do
     @c.done!
   end
 
-  before { @proj_name = "fake_project" }
-  after { @c.with_context { FileUtils.rm_rf @proj_name } }
+  before { @proj_name = unique_proj_name("vendor") }
 
-  describe "deployed in a project's `vendor` directory." do
+  describe "Deployed in a project's `vendor` directory" do
     before do
       # Ensure version commit file is cleaned up
       FileUtils.rm_rf( 'GIT_COMMIT_SHA' )
       @c.with_context do
-        `bundle exec ruby -S ceedling new --local --docs #{@proj_name} 2>&1`
+        @c.ceedling_appcmd_exec("new --local --docs #{@proj_name}")
       end
     end
 
-    it { can_report_version_no_git_commit_sha }
-    it { can_report_version_with_git_commit_sha }
-    it { can_create_projects }
-    it { contains_a_vendor_directory }
-    it { contains_documentation }
-    it { can_fetch_non_project_help }
-    it { can_fetch_project_help }
-    it { can_test_projects_with_success }
-    it { can_test_projects_with_success_test_alias }
-    it { can_test_projects_with_test_name_replaced_defines_with_success }
-    it { can_test_projects_unity_parameterized_test_cases_with_success }
-    #it { can_test_projects_unity_parameterized_test_cases_with_preprocessor_with_success }
-    it { can_test_projects_with_preprocessing_for_test_files_symbols_undefined }
-    it { can_test_projects_with_preprocessing_for_test_files_symbols_defined }
-    it { can_test_projects_with_preprocessing_for_mocks_success }
-    it { can_test_projects_with_preprocessing_for_mocks_intentional_build_failure }
-    it { can_test_projects_with_preprocessing_all }
-    it { can_test_projects_with_success_default }
-    it { can_test_projects_with_unity_exec_time }
-    it { can_test_projects_with_test_and_vendor_defines_with_success }
-    it { can_test_projects_with_fail }
-    it { can_test_projects_with_fail_alias }
-    it { can_test_projects_with_fail_default }
-    it { can_test_projects_with_compile_error }
-    it { can_test_projects_with_both_mock_and_real_header }
-    it { can_test_projects_with_success_when_space_appears_between_hash_and_include }
-    it { can_test_projects_with_named_verbosity }
-    it { can_test_projects_with_numerical_verbosity }
-    it { uses_report_tests_raw_output_log_plugin }
-    it { test_run_of_projects_fail_because_of_crash_without_report }
-    it { test_run_of_projects_fail_because_of_crash_with_report }
-    it { execute_all_test_cases_from_crashing_test_runner_and_return_test_report_with_failue }
-    it { execute_and_collect_debug_logs_from_crashing_test_case_defined_by_test_case_argument_with_enabled_debug }
-    it { execute_and_collect_debug_logs_from_crashing_test_case_defined_by_exclude_test_case_argument_with_enabled_debug }
-    it { confirm_if_notification_for_cmdline_args_not_enabled_is_disabled }
-    it { can_run_single_test_with_full_test_case_name_from_test_file_with_success }
-    it { can_run_single_test_with_partial_test_case_name_from_test_file_with_success }
-    it { exclude_test_case_name_filter_works_and_only_one_test_case_is_executed }
-    it { none_of_test_is_executed_if_test_case_name_passed_does_not_fit_defined_in_test_file }
-    it { none_of_test_is_executed_if_test_case_name_and_exclude_test_case_name_is_the_same }
-    it { run_one_testcase_from_one_test_file_when_test_case_name_is_passed }
+    describe "Version reporting" do
+      test_case :can_report_version_no_git_commit_sha
+      test_case :can_report_version_with_git_commit_sha
+    end
+
+    describe "Project creation" do
+      test_case :can_create_projects
+      test_case :contains_a_vendor_directory
+      test_case :contains_documentation
+    end
+
+    describe "Help system" do
+      test_case :application_commands_help
+      test_case :project_build_tasks_plugins_help
+    end
+
+    describe "Basic test execution" do
+      test_case :test_project_success
+      test_case :test_project_with_test_all_alias
+      test_case :test_project_success_default_task
+      test_case :test_project_fail
+      test_case :test_project_fail_alias
+      test_case :test_project_fail_default
+      test_case :test_project_with_compile_error
+      test_case :project_with_test_file_directly_including_source_file
+    end
+
+    describe "Test builds with preprocessing" do
+      test_case :test_project_preprocessing_undefined_symbols
+      test_case :test_project_preprocessing_defined_symbols
+      test_case :test_project_with_preprocessing_for_mocks
+      test_case :test_project_with_preprocessing_for_missing_mock
+      test_case :test_project_with_preprocessing_all
+    end
+
+    describe "Defines and configuration" do
+      test_case :test_project_with_per_file_defines
+      test_case :test_project_with_test_and_vendor_defines
+      test_case :test_project_with_both_mock_and_real_header
+    end
+
+    describe "Unity features" do
+      test_case :test_project_unity_parameterized_test_cases
+      test_case :test_project_preprocessed_unity_parameterized_test_cases
+      test_case :test_project_with_unity_exec_time
+    end
+
+    describe "Edge cases parsing" do
+      test_case :space_between_hash_and_include_is_valid
+    end
+
+    describe "Verbosity and output" do
+      test_case :test_project_with_named_verbosity
+      test_case :test_project_with_numerical_verbosity
+      test_case :report_tests_raw_output_log_plugin
+    end
+
+    describe "Crash handling" do
+      test_case :crash_none_reports_executable_crashed
+      test_case :crash_none_writes_fail_results_file
+      test_case :crash_simple_sigsegv_all_test_cases
+      test_case :crash_simple_sigabrt_assert_failure
+    end
+
+    describe "Backtrace with GDB" do
+      include_context "requires gdb"
+
+      test_case :crash_gdb_sigsegv_all_test_cases
+      test_case :crash_gdb_sigsegv_targets_test_case_filter
+      test_case :crash_gdb_sigsegv_excludes_test_case_filter
+      test_case :crash_gdb_sigabrt_assert_failure
+    end
+
+    describe "Test filtering" do
+      test_case :run_single_test_with_full_name_filter
+      test_case :run_single_test_with_partial_name_filter
+      test_case :exclusion_filter_leaves_one_test_case
+      test_case :no_tests_run_when_filter_matches_nothing
+      test_case :no_tests_run_when_filter_and_exclusion_cancel
+      test_case :run_one_test_case_with_name_filter
+    end
   end
 
-  describe "deployed in a project's `vendor` directory with git support." do
+  describe "Deployed in a project's `vendor` directory with Git support" do
     before do
       @c.with_context do
-        `bundle exec ruby -S ceedling new --local --docs --gitsupport #{@proj_name} 2>&1`
+        @c.ceedling_appcmd_exec("new --local --docs --gitsupport #{@proj_name}")
       end
     end
 
-    it { can_create_projects }
-    it { has_git_support }
-    it { contains_a_vendor_directory }
-    it { contains_documentation }
-    it { can_test_projects_with_success }
+    describe "Project creation" do
+      test_case :can_create_projects
+      test_case :has_git_support
+      test_case :contains_a_vendor_directory
+      test_case :contains_documentation
+    end
+
+    describe "Basic test execution" do
+      test_case :test_project_success
+      test_case :project_with_test_file_directly_including_source_file
+    end
   end
 
-  describe "deployed in a project's `vendor` directory without docs." do
+  describe "Deployed in a project's `vendor` directory without docs" do
     before do
       @c.with_context do
-        `bundle exec ruby -S ceedling new --local #{@proj_name} 2>&1`
+        @c.ceedling_appcmd_exec("new --local #{@proj_name}")
       end
     end
 
-    it { can_create_projects }
-    it { contains_a_vendor_directory }
-    it { does_not_contain_documentation }
-    it { can_fetch_non_project_help }
-    it { can_fetch_project_help }
-    it { can_test_projects_with_success }
-    it { can_test_projects_with_success_test_alias }
-    it { can_test_projects_with_test_name_replaced_defines_with_success }
-    it { can_test_projects_unity_parameterized_test_cases_with_success }
-    it { can_test_projects_with_preprocessing_for_test_files_symbols_undefined }
-    it { can_test_projects_with_preprocessing_for_test_files_symbols_defined }
-    it { can_test_projects_with_preprocessing_for_mocks_success }
-    it { can_test_projects_with_preprocessing_for_mocks_intentional_build_failure }
-    it { can_test_projects_with_preprocessing_all }
-    it { can_test_projects_with_success_default }
-    it { can_test_projects_with_unity_exec_time }
-    it { can_test_projects_with_test_and_vendor_defines_with_success }
-    it { can_test_projects_with_fail }
-    it { can_test_projects_with_fail_alias }
-    it { can_test_projects_with_fail_default }
-    it { can_test_projects_with_compile_error }
-  end
+    describe "Project creation" do
+      test_case :can_create_projects
+      test_case :contains_a_vendor_directory
+      test_case :does_not_contain_documentation
+    end
 
-end
+    describe "Help system" do
+      test_case :application_commands_help
+      test_case :project_build_tasks_plugins_help
+    end
+
+    describe "Basic test execution" do
+      test_case :test_project_success
+      test_case :test_project_with_test_all_alias
+      test_case :test_project_success_default_task
+      test_case :test_project_fail
+      test_case :test_project_fail_alias
+      test_case :test_project_fail_default
+      test_case :test_project_with_compile_error
+      test_case :project_with_test_file_directly_including_source_file
+    end
+
+    describe "Test builds with preprocessing" do
+      test_case :test_project_preprocessing_undefined_symbols
+      test_case :test_project_preprocessing_defined_symbols
+      test_case :test_project_with_preprocessing_for_mocks
+      test_case :test_project_with_preprocessing_for_missing_mock
+      test_case :test_project_with_preprocessing_all
+    end
+
+    describe "Defines and configuration" do
+      test_case :test_project_with_per_file_defines
+      test_case :test_project_with_test_and_vendor_defines
+    end
+
+    describe "Unity features" do
+      test_case :test_project_unity_parameterized_test_cases
+      test_case :test_project_with_unity_exec_time
+    end
+  end
+end

data/spec/system/encoding_stress_spec.rb

@@ -0,0 +1,153 @@
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
+
+require 'spec_system_helper'
+
+# 'C' (aka POSIX) is the stress pick: it's the one locale guaranteed present on every
+# POSIX system (no locale-gen required), and it's the locale under which Ruby's
+# Encoding.default_external resolves to US-ASCII on Linux rather than UTF-8. That gap
+# between "source files are UTF-8" and "platform default encoding is 7-bit ASCII" is
+# the condition this spec exists to stress: any code path that reads or scans file
+# content without accounting for the platform default encoding is exposed here in a way
+# it would not be under this repo's normal UTF-8 test locale (en_US.UTF-8, forced by
+# SystemContext#with_context for every other system spec).
+ENCODING_STRESS_LOCALE = (ENV.fetch('LC_ALL', nil) || ENV.fetch('LANG', nil) || 'C').freeze
+
+ceedling_system_tests do
+  before :all do
+    @c = SystemContext.new
+    @c.deploy_gem
+  end
+
+  after :all do
+    @c.done!
+  end
+
+  before :all do
+    skip "Default-encoding stress testing is only supported on Linux" unless RUBY_PLATFORM.include?('linux')
+  end
+
+  # spec/system/**/*_spec.rb files are swept by two things: this file's own dedicated
+  # `spec:system:debug:encoding_stress` rake task (invoked by the tests-linux-encoding-stress
+  # CI job with LC_ALL=C set), and the blanket `specs:system` task that every other CI job
+  # also runs. This file is only meaningful under the former -- explicitly opt in rather than
+  # inferring intent from the ambient encoding, since runner images vary in what a "C" locale
+  # resolves to (see the canary below).
+  before :all do
+    skip "Only meaningful when run via the dedicated encoding-stress rake task (LC_ALL=C)" unless ENV['LC_ALL'] == 'C'
+  end
+
+  # with_context forces LC_ALL/LANG/LANGUAGE to en_US.UTF-8; override to the stress
+  # locale immediately before each Ceedling invocation so Ceedling's own Ruby process
+  # runs under a non-UTF-8 default external encoding, not just any spawned subprocess.
+  def stress_encoding!
+    ENV['LC_ALL']   = ENCODING_STRESS_LOCALE
+    ENV['LANG']     = ENCODING_STRESS_LOCALE
+    ENV['LANGUAGE'] = ENCODING_STRESS_LOCALE
+  end
+
+  # Canary: proves this job is actually exercising a non-UTF-8 default encoding before
+  # trusting any "pass" from the example-project cases below. Without this, a future
+  # Ruby release or Linux runner image that changes how default_external is resolved
+  # from LC_ALL/LANG could silently turn this whole file into a no-op that always passes
+  # against an effectively UTF-8 environment -- a false positive for encoding coverage.
+  describe "Sanity check: the default-encoding stress condition is real" do
+    it "confirms Ruby's default external encoding is non-UTF-8, and that naive reads of planted non-ASCII content fail without an encoding-safety guard" do
+      # Encoding.default_external is resolved once at Ruby process startup from the
+      # ambient LC_ALL/LANG at that time (the CI job sets LC_ALL=C/LANG=C before `rake`
+      # runs) and does not change if ENV is mutated afterward -- so this reflects the
+      # actual condition every other case in this file runs under.
+      # Assert non-UTF-8 rather than a specific codeset name: different distros/glibc
+      # versions can spell a POSIX/'C' locale's codeset differently (US-ASCII,
+      # ANSI_X3.4-1968, etc.), and pinning to one exact string is itself a source of
+      # false failures across runner images.
+      expect(Encoding.default_external.name).not_to eq('UTF-8'),
+        "Expected the '#{ENCODING_STRESS_LOCALE}' locale to resolve Ruby's default " \
+        "external encoding to something other than UTF-8 on this platform, but got " \
+        "#{Encoding.default_external.name.inspect}. If Ruby or this runner image " \
+        "changed how default_external is derived from LC_ALL, the rest of this file's " \
+        "passes may be false positives."
+
+      # Confirm the planted non-ASCII comment (examples/temp_sensor/test/TestMain.c)
+      # actually breaks *naive*, unguarded string processing under this default --
+      # proving the stress condition has teeth, not just that the encoding name matches.
+      # This is the same failure mode (`invalid byte sequence`) that encoding-safety
+      # guards elsewhere in Ceedling's source-scanning code exist to prevent.
+      non_ascii_fixture = File.expand_path('../../../examples/temp_sensor/test/TestMain.c', __FILE__)
+      expect {
+        File.read(non_ascii_fixture).match(/test/)
+      }.to raise_error(ArgumentError, /invalid byte sequence/)
+    end
+  end
+
+  describe "Command: `ceedling example temp_sensor` under '#{ENCODING_STRESS_LOCALE}' default encoding" do
+    before do
+      @c.with_context { @c.ceedling_appcmd_exec("example temp_sensor") }
+    end
+
+    it "tests with preprocessing enabled" do
+      @c.with_context do
+        stress_encoding!
+        Dir.chdir "temp_sensor" do
+          @c.merge_project_yml_for_test({ :project => { :use_test_preprocessor => :all } })
+          output = @c.ceedling_build_exec("test:all")
+          expect(@c.last_exit_status).to eq(0)
+          expect(output).to match(/TESTED:\s+86/)
+          expect(output).to match(/PASSED:\s+86/)
+        end
+      end
+    end
+
+    it "tests with preprocessing disabled" do
+      @c.with_context do
+        stress_encoding!
+        Dir.chdir "temp_sensor" do
+          @c.merge_project_yml_for_test({ :project => { :use_test_preprocessor => :none } })
+          output = @c.ceedling_build_exec("test:all")
+          expect(@c.last_exit_status).to eq(0)
+          # One fewer test than the preprocessing-enabled case: without preprocessing,
+          # raw-source test-case discovery doesn't expand a conditional-compilation-gated
+          # test that the preprocessed path does.
+          expect(output).to match(/TESTED:\s+85/)
+          expect(output).to match(/PASSED:\s+85/)
+        end
+      end
+    end
+  end
+
+  describe "Command: `ceedling example wondrous_forest` under '#{ENCODING_STRESS_LOCALE}' default encoding" do
+    before do
+      @c.with_context { @c.ceedling_appcmd_exec("example wondrous_forest") }
+    end
+
+    it "tests with standard preprocessing" do
+      @c.with_context do
+        stress_encoding!
+        Dir.chdir "wondrous_forest" do
+          @c.merge_project_yml_for_test({ :test_build => { :preprocess_force_fallback => false } })
+          output = @c.ceedling_build_exec("test:all")
+          expect(@c.last_exit_status).to eq(0)
+          expect(output).to match(/TESTED:\s+65/)
+          expect(output).to match(/PASSED:\s+65/)
+        end
+      end
+    end
+
+    it "tests with fallback preprocessing" do
+      @c.with_context do
+        stress_encoding!
+        Dir.chdir "wondrous_forest" do
+          @c.merge_project_yml_for_test({ :test_build => { :preprocess_force_fallback => true } })
+          output = @c.ceedling_build_exec("test:all")
+          expect(@c.last_exit_status).to eq(0)
+          expect(output).to match(/TESTED:\s+65/)
+          expect(output).to match(/PASSED:\s+65/)
+        end
+      end
+    end
+  end
+end