ceedling 1.1.10 → 1.2.0

data/spec/system/support/gcov_common_test_cases.rb

@@ -98,24 +98,6 @@ module GcovCommonTestCases
     end
   end
 
-  # :fail_under_* documents a 1-100 range; 0 was previously silently accepted as a
-  # threshold that could never actually fail (0% coverage is always >= 0).
-  def project_with_gcov_fail_under_line_rejects_zero
-    @c.with_context do
-      Dir.chdir @proj_name do
-        prep_project_yml_for_coverage
-        @c.merge_project_yml_for_test( { :gcov => { :gcovr => { :fail_under_line => 0 } } } )
-        FileUtils.cp test_asset_path("example_file.h"), 'src/'
-        FileUtils.cp test_asset_path("example_file.c"), 'src/'
-        FileUtils.cp test_asset_path("test_example_file_success.c"), 'test/'
-
-        output = @c.ceedling_build_exec("gcov:all")
-        expect(@c.last_exit_status).to_not eq(0)
-        expect(output).to match(/:fail_under_line.*must be an integer percentage/)
-      end
-    end
-  end
-
   # TODO: Restore this test when the :abort_on_uncovered option is restored in the Gcov plugin
   # def project_with_gcov_fail_because_of_uncovered_files
   #   @c.with_context do
@@ -190,7 +172,7 @@ module GcovCommonTestCases
         prep_project_yml_for_coverage
         FileUtils.cp test_asset_path("example_file.h"), 'src/'
         FileUtils.cp test_asset_path("example_file.c"), 'src/'
-        FileUtils.cp test_asset_path("test_example_file_boom.c"), 'test/'
+        FileUtils.cp test_asset_path("test_nosanitize_boom.c"), 'test/'
 
         output = @c.ceedling_build_exec("gcov:all")
         expect(@c.last_exit_status).to eq(1) # Since a test explodes, Ceedling exits with error
@@ -224,7 +206,7 @@ module GcovCommonTestCases
           expect(output).to match(/Generating HTML coverage report in 'build\/artifacts\/gcov\/gcovr\/'\.\.\./)
           expect(File.exist?('build/artifacts/gcov/gcovr/GcovCoverageResults.html')).to eq true
         end
-        if @gcov_reports.include? :modulegenerator
+        if @gcov_reports.include? :reportgenerator
           expect(output).to match(/Generating HtmlBasic coverage report in 'build\/artifacts\/gcov\/ReportGenerator\/'\.\.\./)
           expect(File.exist?('build/artifacts/gcov/ReportGenerator/summary.htm')).to eq true
         end
@@ -274,6 +256,55 @@ module GcovCommonTestCases
     end
   end
 
+  # Modified condition/decision coverage is gated twice, and both gates raise: gcovr must
+  # support reporting it and GCC must support emitting it. That is why no system test
+  # covered it before -- it cannot run on most toolchains, and ungated it would simply fail
+  # there. The group including this case requires both versions, so reaching a successful
+  # build is itself the assertion that both halves agreed.
+  def project_with_gcov_mcdc_coverage
+    @c.with_context do
+      Dir.chdir @proj_name do
+        prep_project_yml_for_coverage
+        @c.merge_project_yml_for_test( { :gcov => { :mcdc => true } } )
+        FileUtils.cp test_asset_path("example_file.h"), 'src/'
+        FileUtils.cp test_asset_path("example_file.c"), 'src/'
+        FileUtils.cp test_asset_path("test_example_file_success.c"), 'test/'
+
+        output = @c.ceedling_build_exec("gcov:all --verbosity=obnoxious")
+
+        expect(@c.last_exit_status).to eq(0)
+
+        # GCC emits the condition data; a build without this flag never produced any.
+        expect(output).to match(/-fcondition-coverage/)
+      end
+    end
+  end
+
+  # Guards the quiet half of the plugin's version handling. A `:min_version` arg-table
+  # entry is dropped silently below its minimum, so a build still succeeds with the feature
+  # simply absent. Asserting the flag on the command line is what distinguishes "the
+  # feature ran" from "the build did not complain" -- the group including this case
+  # requires the gcovr version that supports it, so an absent flag is a real defect here
+  # rather than an older toolchain.
+  def gcovr_merge_mode_functions_reaches_the_command_line
+    @c.with_context do
+      Dir.chdir @proj_name do
+        prep_project_yml_for_coverage
+        FileUtils.cp test_asset_path("example_file.h"), 'src/'
+        FileUtils.cp test_asset_path("example_file.c"), 'src/'
+        FileUtils.cp test_asset_path("test_example_file_success.c"), 'test/'
+
+        output = @c.ceedling_build_exec("gcov:all --verbosity=obnoxious")
+
+        expect(@c.last_exit_status).to eq(0)
+
+        if @gcov_reports.include? :gcovr
+          expect(output).to match(/--merge-mode-functions/)
+        end
+      end
+    end
+  end
+
   def create_html_report_with_gcovr_config_file_overrides_default
     @c.with_context do
       Dir.chdir @proj_name do
@@ -307,8 +338,8 @@ module GcovCommonTestCases
 
         output = @c.ceedling_build_exec("gcov:all --verbosity=obnoxious")
         if @gcov_reports.include? :gcovr
-          # Config file honored (fix applied): strict mode exits non-zero on duplicate functions.
-          # Config file overridden by Ceedling CLI (bug): merge-use-line-max exits 0.
+          # The config file's strict mode exits non-zero on duplicate functions. A Ceedling
+          # command line overriding the config file would exit 0 under merge-use-line-max.
           expect(@c.last_exit_status).not_to eq(0)
 
           # No `--exclude` should appear on the gcovr command line when a config file is in use.
@@ -318,13 +349,98 @@ module GcovCommonTestCases
     end
   end
 
+  # #1159 -- :custom_args: is the escape hatch for whatever gcovr flag Ceedling has no
+  # named option for (the issue's own request: limiting gcovr's search root). Also
+  # confirms it still applies alongside a :config_file: (unlike every other :gcovr:
+  # option, which config_file_in_use? defers to the file instead) -- it's meant to
+  # keep working right alongside a config file, not be silently dropped by it.
+  # A JaCoCo report names the JaCoCo report DTD and has a <report> root element
+  def create_gcovr_jacoco_report
+    @c.with_context do
+      Dir.chdir @proj_name do
+        prep_project_yml_for_coverage
+        FileUtils.cp test_asset_path("example_file.h"), 'src/'
+        FileUtils.cp test_asset_path("example_file.c"), 'src/'
+        FileUtils.cp test_asset_path("test_example_file_success.c"), 'test/'
+        @c.merge_project_yml_for_test( { :gcov => { :reports => ['JaCoCo'], :gcovr => { :jacoco_pretty => true } } } )
+
+        output = @c.ceedling_build_exec("gcov:all")
+
+        expect(@c.last_exit_status).to eq(0)
+        expect(output).to match(/Generating JaCoCo XML coverage report in 'build\/artifacts\/gcov\/gcovr\/'\.\.\./)
+
+        report = File.read('build/artifacts/gcov/gcovr/GcovCoverageJaCoCo.xml')
+        expect(report).to match(%r{<!DOCTYPE \w+ SYSTEM 'https://www\.jacoco\.org/.+/report\.dtd'>})
+        expect(report).to match(/<report\b[^>]*>/)
+        expect(report).to include('example_file.c')
+      end
+    end
+  end
+
+  # An LCOV info file records each source file between SF: and end_of_record, under its test name
+  def create_gcovr_lcov_report
+    @c.with_context do
+      Dir.chdir @proj_name do
+        prep_project_yml_for_coverage
+        FileUtils.cp test_asset_path("example_file.h"), 'src/'
+        FileUtils.cp test_asset_path("example_file.c"), 'src/'
+        FileUtils.cp test_asset_path("test_example_file_success.c"), 'test/'
+        @c.merge_project_yml_for_test( { :gcov => { :reports => ['lcov'], :gcovr => { :lcov_test_name => 'ceedling_suite' } } } )
+
+        output = @c.ceedling_build_exec("gcov:all")
+
+        expect(@c.last_exit_status).to eq(0)
+        expect(output).to match(/Generating LCOV coverage report in 'build\/artifacts\/gcov\/gcovr\/'\.\.\./)
+
+        report = File.read('build/artifacts/gcov/gcovr/GcovCoverage.lcov')
+        expect(report).to include('TN:ceedling_suite')
+        expect(report).to match(/^SF:.*example_file\.c$/)
+        expect(report).to include('end_of_record')
+      end
+    end
+  end
+
+  def create_html_report_with_gcovr_custom_args
+    @c.with_context do
+      Dir.chdir @proj_name do
+        prep_project_yml_for_coverage
+        FileUtils.cp test_asset_path("example_file.h"), 'src/'
+        FileUtils.cp test_asset_path("example_file.c"), 'src/'
+        FileUtils.cp test_asset_path("test_example_file_success.c"), 'test/'
+
+        # gcovr's own config file format is flat `key = value` -- no `[section]`
+        # header (confirmed against the real tool; a `[gcovr]` header, despite
+        # appearing in some older examples elsewhere, is invalid and gcovr rejects
+        # it outright).
+        File.write('gcovr.cfg', "merge-mode-functions = merge-use-line-max\n")
+
+        @c.merge_project_yml_for_test({
+          :gcov => {
+            :gcovr => {
+              :config_file => 'gcovr.cfg',
+              :custom_args => ['--gcov-executable', 'gcov']
+            }
+          }
+        })
+
+        output = @c.ceedling_build_exec("gcov:all --verbosity=obnoxious")
+        if @gcov_reports.include? :gcovr
+          expect(@c.last_exit_status).to eq(0)
+          # Custom arg appears on the actual invoked gcovr command line, even
+          # though a :config_file: is also in use.
+          expect(output).to match(/"--gcov-executable" "gcov"/)
+        end
+      end
+    end
+  end
+
   def create_html_report_from_crashing_test_with_backtrace_enabled
     @c.with_context do
       Dir.chdir @proj_name do
         prep_project_yml_for_coverage
         FileUtils.cp test_asset_path("example_file.h"), 'src/'
         FileUtils.cp test_asset_path("example_file.c"), 'src/'
-        FileUtils.cp test_asset_path("test_example_file_crash_sigsegv.c"), 'test/'
+        FileUtils.cp test_asset_path("test_nosanitize_crash_sigsegv.c"), 'test/'
 
         @c.merge_project_yml_for_test({:project => { :use_backtrace => :gdb }})
 
@@ -332,9 +448,9 @@ module GcovCommonTestCases
         expect(@c.last_exit_status).to eq(1) # Ceedling should exit with error because of failed test due to crash
         expect(output).to match(/crashed/i)
         expect(output).to match(/Unit test failures/)
-        expect(File.exist?('./build/gcov/results/test_example_file_crash_sigsegv.fail'))
-        output_rd = File.read('./build/gcov/results/test_example_file_crash_sigsegv.fail')
-        expect(output_rd =~ /test_add_numbers_will_fail \(\) at test\/test_example_file_crash_sigsegv.c\:\d+/ )
+        expect(File.exist?('./build/gcov/results/test_nosanitize_crash_sigsegv.fail'))
+        output_rd = read_spec_file('./build/gcov/results/test_nosanitize_crash_sigsegv.fail')
+        expect(output_rd =~ /test_add_numbers_will_fail \(\) at test\/test_nosanitize_crash_sigsegv.c\:\d+/ )
         expect(output).to match(/TESTED:\s+2/)
         expect(output).to match(/PASSED:\s+(?:0|1)/)
         expect(output).to match(/FAILED:\s+(?:1|2)/)
@@ -344,7 +460,7 @@ module GcovCommonTestCases
           expect(output).to match(/Generating HTML coverage report in 'build\/artifacts\/gcov\/gcovr\/'\.\.\./)
           expect(File.exist?('build/artifacts/gcov/gcovr/GcovCoverageResults.html')).to eq true
         end
-        if @gcov_reports.include? :modulegenerator
+        if @gcov_reports.include? :reportgenerator
           expect(output).to match(/Generating HtmlBasic coverage report in 'build\/artifacts\/gcov\/ReportGenerator\/'\.\.\./)
           expect(File.exist?('build/artifacts/gcov/ReportGenerator/summary.htm')).to eq true
         end
@@ -358,7 +474,7 @@ module GcovCommonTestCases
         prep_project_yml_for_coverage
         FileUtils.cp test_asset_path("example_file.h"), 'src/'
         FileUtils.cp test_asset_path("example_file.c"), 'src/'
-        FileUtils.cp test_asset_path("test_example_file_crash_sigsegv.c"), 'test/'
+        FileUtils.cp test_asset_path("test_nosanitize_crash_sigsegv.c"), 'test/'
 
         @c.merge_project_yml_for_test({:project => { :use_backtrace => :gdb }})
 
@@ -366,9 +482,9 @@ module GcovCommonTestCases
         expect(@c.last_exit_status).to eq(1) # Ceedling should exit with error because of failed test due to crash
         expect(output).to match(/Test Case Crashed/i)
         expect(output).to match(/Unit test failures/)
-        expect(File.exist?('./build/gcov/results/test_example_file_crash_sigsegv.fail'))
-        output_rd = File.read('./build/gcov/results/test_example_file_crash_sigsegv.fail')
-        expect(output_rd =~ /test_add_numbers_will_fail \(\) at test\/test_example_file_crash_sigsegv.c\:\d+/ )
+        expect(File.exist?('./build/gcov/results/test_nosanitize_crash_sigsegv.fail'))
+        output_rd = read_spec_file('./build/gcov/results/test_nosanitize_crash_sigsegv.fail')
+        expect(output_rd =~ /test_add_numbers_will_fail \(\) at test\/test_nosanitize_crash_sigsegv.c\:\d+/ )
         expect(output).to match(/TESTED:\s+1/)
         expect(output).to match(/PASSED:\s+0/)
         expect(output).to match(/FAILED:\s+1/)
@@ -379,7 +495,7 @@ module GcovCommonTestCases
           expect(output).to match(/Generating HTML coverage report in 'build\/artifacts\/gcov\/gcovr\/'\.\.\./)
           expect(File.exist?('build/artifacts/gcov/gcovr/GcovCoverageResults.html')).to eq true
         end
-        if @gcov_reports.include? :modulegenerator
+        if @gcov_reports.include? :reportgenerator
           expect(output).to match(/Generating HtmlBasic coverage report in 'build\/artifacts\/gcov\/ReportGenerator\/'\.\.\./)
           expect(File.exist?('build/artifacts/gcov/ReportGenerator/summary.htm')).to eq true
         end
@@ -393,20 +509,20 @@ module GcovCommonTestCases
         prep_project_yml_for_coverage
         FileUtils.cp test_asset_path("example_file.h"), 'src/'
         FileUtils.cp test_asset_path("example_file.c"), 'src/'
-        FileUtils.cp test_asset_path("test_example_file_crash_sigsegv.c"), 'test/'
+        FileUtils.cp test_asset_path("test_nosanitize_crash_sigsegv.c"), 'test/'
 
         add_test_case = "\nvoid test_difference_between_two_numbers(void)\n"\
                         "{\n" \
                         "  TEST_ASSERT_EQUAL_INT(0, difference_between_numbers(1,1));\n" \
                         "}\n"
 
-        updated_test_file = File.read('test/test_example_file_crash_sigsegv.c').split("\n")
+        updated_test_file = read_spec_file('test/test_nosanitize_crash_sigsegv.c').split("\n")
         updated_test_file.insert(updated_test_file.length(), add_test_case)
-        File.write('test/test_example_file_crash_sigsegv.c', updated_test_file.join("\n"), mode: 'w')
+        File.write('test/test_nosanitize_crash_sigsegv.c', updated_test_file.join("\n"), mode: 'w')
 
         output = @c.ceedling_build_exec("gcov:all --exclude_test_case=test_add_numbers_will_fail")
         expect(@c.last_exit_status).to eq(0)
-        expect(File.exist?('./build/gcov/results/test_example_file_crash_sigsegv.pass'))
+        expect(File.exist?('./build/gcov/results/test_nosanitize_crash_sigsegv.pass'))
         expect(output).to match(/TESTED:\s+2/)
         expect(output).to match(/PASSED:\s+2/)
         expect(output).to match(/FAILED:\s+0/)
@@ -417,7 +533,7 @@ module GcovCommonTestCases
           expect(output).to match(/Generating HTML coverage report in 'build\/artifacts\/gcov\/gcovr\/'\.\.\./)
           expect(File.exist?('build/artifacts/gcov/gcovr/GcovCoverageResults.html')).to eq true
         end
-        if @gcov_reports.include? :modulegenerator
+        if @gcov_reports.include? :reportgenerator
           expect(output).to match(/Generating HtmlBasic coverage report in 'build\/artifacts\/gcov\/ReportGenerator\/'\.\.\./)
           expect(File.exist?('build/artifacts/gcov/ReportGenerator/summary.htm')).to eq true
         end
@@ -493,6 +609,26 @@ module GcovCommonTestCases
     end
   end
 
+  # An untested source's defines resolve as a tested source's do, so a :gcov matcher naming
+  # the source supplies what it needs to compile
+  def project_with_gcov_untested_sources_compiled_with_matched_defines
+    @c.with_context do
+      Dir.chdir @proj_name do
+        prep_project_yml_for_coverage
+        add_gcov_option("untested_sources", ":compile")
+        @c.merge_project_yml_for_test( { :defines => { :gcov => { 'needs_define' => ['UNTESTED_SOURCE_REQUIRED'] } } } )
+        FileUtils.cp test_asset_path("example_file.h"), 'src/'
+        FileUtils.cp test_asset_path("example_file.c"), 'src/'
+        FileUtils.cp test_asset_path("test_example_file_success.c"), 'test/'
+        File.write( 'src/needs_define.c', "#ifndef UNTESTED_SOURCE_REQUIRED\n#error UNTESTED_SOURCE_REQUIRED is not defined\n#endif\nint needs_define(void) { return 1; }\n" )
+
+        output = @c.ceedling_build_exec("gcov:untested_sources")
+        expect(@c.last_exit_status).to eq(0), output
+        expect(File.exist?('build/gcov/out/needs_define.o')).to eq true
+      end
+    end
+  end
+
   def project_with_gcov_untested_sources_standalone_task
     @c.with_context do
       Dir.chdir @proj_name do

data/spec/system/support/gcov_helpers.rb

@@ -29,14 +29,14 @@ module GcovHelpers
   end
 
   def prep_project_yml_for_coverage
-    FileUtils.cp test_asset_path("project.yml"), "project.yml"
+    FileUtils.cp feature_asset_path("project.yml"), "project.yml"
     @c.uncomment_project_yml_option_for_test("- gcov")
     @c.comment_project_yml_option_for_test("- gcovr") unless @gcov_reports.include? :gcovr
     @c.uncomment_project_yml_option_for_test("- ReportGenerator") if @gcov_reports.include? :reportgenerator
   end
 
   def _add_gcov_section_in_project(project_file_path, name, values)
-    project_file_contents = File.readlines(project_file_path)
+    project_file_contents = readlines_spec_file(project_file_path)
     name_index = project_file_contents.index(":gcov:\n")
 
     if name_index.nil?
@@ -55,7 +55,7 @@ module GcovHelpers
   end
 
   def _add_gcov_option_in_project(project_file_path, option, value)
-    project_file_contents = File.readlines(project_file_path)
+    project_file_contents = readlines_spec_file(project_file_path)
     option_index = project_file_contents.index(":gcov:\n")
 
     if option_index.nil?

data/spec/system/support/gcov_partials_test_cases.rb

@@ -19,11 +19,11 @@ module GcovPartialsTestCases
       :gcov    => { :reports => ['Cobertura'] }
     })
 
-    output = @c.ceedling_build_exec("gcov:all")
+    @c.ceedling_build_exec("gcov:all")
     expect(@c.last_exit_status).to eq(0)
 
     cobertura_path = File.join('build', 'artifacts', 'gcov', 'gcovr', 'GcovCoverageCobertura.xml')
-    doc = REXML::Document.new(File.read(cobertura_path))
+    doc = REXML::Document.new(read_spec_file(cobertura_path))
 
     doc.elements.to_a("//class[@filename='#{source_relpath}']/lines/line").each_with_object({}) do |el, h|
       h[el.attributes['number'].to_i] = el.attributes['hits'].to_i
@@ -113,4 +113,50 @@ module GcovPartialsTestCases
       end
     end
   end
+
+  # Coverage reporting has to tell two same-basename modules apart. A Partial replaces one
+  # module, so the other keeps reporting its own coverage. Matching on basename alone drops
+  # both, and the module nobody Partialized disappears from the report.
+  def gcov_partials_coverage_same_named_modules
+    @c.with_context do
+      Dir.chdir @proj_name do
+        prep_project_yml_for_coverage
+
+        asset_base = test_asset_path("same_named_modules")
+        ['uart', 'spi'].each do |driver|
+          FileUtils.mkdir_p "include/drivers/#{driver}"
+          FileUtils.mkdir_p "src/drivers/#{driver}"
+          FileUtils.cp "#{asset_base}/include/drivers/#{driver}/config.h", "include/drivers/#{driver}/"
+          FileUtils.cp "#{asset_base}/src/drivers/#{driver}/config.c",     "src/drivers/#{driver}/"
+        end
+        FileUtils.cp "#{asset_base}/test/test_uart_config_partial_only.c", 'test/'
+
+        @c.merge_project_yml_for_test({
+          :project => { :use_partials => true },
+          :paths   => { :include => ['include/**'] }
+        })
+
+        # The console summary is what remapping feeds. Only the uart module is Partialized,
+        # so the spi module keeps reporting against its own source. Both must appear.
+        output = @c.ceedling_build_exec("gcov:all")
+        expect(@c.last_exit_status).to eq(0)
+
+        # Two same-named modules carry enough trailing path in the summary to tell them
+        # apart -- one directory here, which is all it takes.
+        #
+        # The figures identify each module. The spi module runs through its own public
+        # function, which reaches all three of its lines. The uart module is reached only
+        # through its Partial, which carries that module's two private functions, and the
+        # test calls one of them.
+        #
+        # Deduplicated: some gcov versions repeat a file's own statistic line after its
+        # per-file block.
+        reported = output.to_s.scan(%r{^(\S*config\.c) \| Lines executed:([\d.]+)% of (\d+)}).uniq
+
+        expect( reported ).to include(['spi/config.c', '100.00', '3'])
+        expect( reported ).to include(['uart/config.c', '50.00', '2'])
+        expect( reported.length ).to eq(2)
+      end
+    end
+  end
 end

data/spec/system/support/sanitize_common_test_cases.rb

@@ -0,0 +1,222 @@
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
+
+require 'json'
+require_relative 'sanitize_helpers'
+
+module SanitizeCommonTestCases
+  include SanitizeHelpers
+
+  def project_build_tasks_plugins_help_for_sanitize
+    @c.with_context do
+      Dir.chdir @proj_name do
+        prep_project_yml_for_sanitize
+        output = @c.ceedling_appcmd_exec("help")
+        expect(@c.last_exit_status).to eq(0)
+        expect(output).to match(/ceedling sanitize:\*/i)
+        expect(output).to match(/ceedling sanitize:all/i)
+      end
+    end
+  end
+
+  def run_sanitize_on_clean_tests
+    @c.with_context do
+      Dir.chdir @proj_name do
+        prep_project_yml_for_sanitize
+        prep_sanitize_sources("test_example_file_success.c")
+
+        output = @c.ceedling_build_exec("sanitize:all")
+        expect(@c.last_exit_status).to eq(0)
+        expect(output).to match(/SANITIZE: .*OVERALL TEST SUMMARY/)
+        expect(output).not_to match(/Sanitizers found/)
+        expect(Dir.glob('build/artifacts/sanitize/sanitize/*.log')).to be_empty
+      end
+    end
+  end
+
+  # The plugin builds in its own context, apart from test builds
+  def run_sanitize_build_removed_by_clobber
+    @c.with_context do
+      Dir.chdir @proj_name do
+        prep_project_yml_for_sanitize
+        prep_sanitize_sources("test_example_file_success.c")
+
+        @c.ceedling_build_exec("sanitize:all")
+        expect(Dir.glob('build/sanitize/**/*').select { |path| File.file?( path ) }).not_to be_empty
+
+        @c.ceedling_build_exec("clobber")
+        expect(@c.last_exit_status).to eq(0)
+        expect(Dir.glob('build/sanitize/**/*').select { |path| File.file?( path ) }).to be_empty
+        expect(Dir.glob('build/artifacts/sanitize/**/*').select { |path| File.file?( path ) }).to be_empty
+        expect(Dir.glob('build/cache/.*.dep_cache.json')).to be_empty
+      end
+    end
+  end
+
+  # A halt is a crash, named by its finding, with the sanitizer's report kept in a log
+  def run_sanitize_names_an_asan_finding
+    @c.with_context do
+      Dir.chdir @proj_name do
+        prep_project_yml_for_sanitize
+        prep_sanitize_sources("test_nosanitize_heap_buffer_overflow.c")
+
+        output = @c.ceedling_build_exec("sanitize:all")
+        expect(@c.last_exit_status).to eq(1)
+        expect(output).to match(/test_writes_past_its_buffer.*\n.*AddressSanitizer heap-buffer-overflow at \S*test_nosanitize_heap_buffer_overflow\.c:\d+/)
+        expect(output).to match(/Sanitizers found 1 problem in 1 test/)
+        expect(read_spec_file('build/artifacts/sanitize/sanitize/test_nosanitize_heap_buffer_overflow.log')).to match(/ERROR: AddressSanitizer: heap-buffer-overflow/)
+      end
+    end
+  end
+
+  def run_sanitize_names_a_ubsan_finding
+    @c.with_context do
+      Dir.chdir @proj_name do
+        prep_project_yml_for_sanitize
+        FileUtils.cp test_asset_path("test_nosanitize_ub_shift_overflow.c"), 'test/'
+
+        output = @c.ceedling_build_exec("sanitize:all")
+        expect(@c.last_exit_status).to eq(1)
+        expect(output).to match(/test_shift_overflow.*\n.*UndefinedBehaviorSanitizer left shift of 128 by 24 places/)
+      end
+    end
+  end
+
+  # A crash no sanitizer reported keeps its own message, with no finding made up for it
+  # The first finding halts the main run, so only the second test case's backtrace rerun
+  # reaches the second finding. Both are counted and reported.
+  def run_sanitize_counts_a_finding_only_a_rerun_reaches
+    @c.with_context do
+      Dir.chdir @proj_name do
+        prep_project_yml_for_sanitize
+        @c.merge_project_yml_for_test({ :sanitize => { :reports => [:sarif] } })
+        FileUtils.cp test_asset_path("test_nosanitize_two_findings.c"), 'test/'
+
+        output = @c.ceedling_build_exec("sanitize:all")
+        expect(@c.last_exit_status).to eq(1)
+        expect(output).to match(/AddressSanitizer heap-buffer-overflow at /)
+        expect(output).to match(/UndefinedBehaviorSanitizer .* at /)
+        expect(output).to match(%r{Sanitizers found 2 problems in 1 test\. See the reports in build/artifacts/sanitize/sanitize: sanitize\.sarif\.})
+
+        sarif = JSON.parse(read_spec_file('build/artifacts/sanitize/sanitize/sanitize.sarif'))
+        expect(sarif['runs'].first['results'].map { |result| result['ruleId'] }).to contain_exactly(
+          'address/heap-buffer-overflow', 'undefined/undefined-behavior'
+        )
+      end
+    end
+  end
+
+  def run_sanitize_leaves_a_plain_crash_alone
+    @c.with_context do
+      Dir.chdir @proj_name do
+        prep_project_yml_for_sanitize
+        prep_sanitize_sources("test_nosanitize_crash_assert.c")
+
+        output = @c.ceedling_build_exec("sanitize:all")
+        expect(@c.last_exit_status).to eq(1)
+        expect(output).to match(/Test case crashed/)
+        expect(output).not_to match(/Sanitizers found/)
+      end
+    end
+  end
+
+  # A leak is found at exit, after every test case passed, so it is a finding, not a crash
+  def run_sanitize_reports_a_leak_as_a_finding
+    @c.with_context do
+      Dir.chdir @proj_name do
+        prep_project_yml_for_sanitize
+        prep_sanitize_sources("test_nosanitize_leak.c")
+
+        output = @c.ceedling_build_exec("sanitize:all")
+        expect(@c.last_exit_status).to eq(1)
+        expect(output).not_to match(/crashed/i)
+        expect(output).to match(/PASSED:\s+2/)
+        expect(output).to match(/test_nosanitize_leak: LeakSanitizer memory-leak at /)
+        expect(output).to match(/Sanitizers found 1 problem in 1 test/)
+      end
+    end
+  end
+
+  def run_sanitize_leak_with_fail_build_disabled
+    @c.with_context do
+      Dir.chdir @proj_name do
+        prep_project_yml_for_sanitize
+        @c.merge_project_yml_for_test({ :sanitize => { :fail_build => false } })
+        prep_sanitize_sources("test_nosanitize_leak.c")
+
+        output = @c.ceedling_build_exec("sanitize:all")
+        expect(@c.last_exit_status).to eq(0)
+        expect(output).to match(/test_nosanitize_leak: LeakSanitizer memory-leak at /)
+        expect(output).not_to match(/Sanitizers found/)
+      end
+    end
+  end
+
+  def run_sanitize_writes_structured_reports
+    @c.with_context do
+      Dir.chdir @proj_name do
+        prep_project_yml_for_sanitize
+        @c.merge_project_yml_for_test({ :sanitize => { :reports => [:json, :sarif] } })
+        prep_sanitize_sources("test_nosanitize_heap_buffer_overflow.c")
+
+        @c.ceedling_build_exec("sanitize:all")
+
+        json = JSON.parse(read_spec_file('build/artifacts/sanitize/sanitize/sanitize.json'))
+        expect(json['findings'].first).to include('sanitizer' => 'address', 'kind' => 'heap-buffer-overflow')
+
+        sarif = JSON.parse(read_spec_file('build/artifacts/sanitize/sanitize/sanitize.sarif'))
+        expect(sarif['runs'].first['results'].first['ruleId']).to eq('address/heap-buffer-overflow')
+      end
+    end
+  end
+
+  # :test_builds instruments ordinary test: builds as well
+  def run_sanitize_instruments_test_builds_when_asked
+    @c.with_context do
+      Dir.chdir @proj_name do
+        prep_project_yml_for_sanitize
+        @c.merge_project_yml_for_test({ :sanitize => { :test_builds => true } })
+        prep_sanitize_sources("test_nosanitize_heap_buffer_overflow.c")
+
+        output = @c.ceedling_build_exec("test:all")
+        expect(@c.last_exit_status).to eq(1)
+        expect(output).to match(/AddressSanitizer heap-buffer-overflow/)
+      end
+    end
+  end
+
+  # Ordinary test: builds are left alone by default
+  def run_sanitize_leaves_test_builds_alone
+    @c.with_context do
+      Dir.chdir @proj_name do
+        prep_project_yml_for_sanitize
+        prep_sanitize_sources("test_nosanitize_heap_buffer_overflow.c")
+
+        output = @c.ceedling_build_exec("test:all")
+        expect(output).not_to match(/Sanitizer/)
+      end
+    end
+  end
+
+  # A sanitizer-instrumented executable can't run under Valgrind
+  def run_valgrind_refuses_sanitizer_flags
+    @c.with_context do
+      Dir.chdir @proj_name do
+        prep_project_yml_for_sanitize
+        @c.uncomment_project_yml_option_for_test("- valgrind")
+        @c.merge_project_yml_for_test({ :flags => { :test => { :compile => { :* => ['-fsanitize=address'] } } } })
+        prep_sanitize_sources("test_example_file_success.c")
+
+        output = @c.ceedling_build_exec("valgrind:all")
+        expect(@c.last_exit_status).to eq(1)
+        expect(output).to match(/Valgrind cannot run a test executable built with sanitizers/)
+        expect(output).to match(/`-fsanitize=address`/)
+      end
+    end
+  end
+
+end

data/spec/system/support/sanitize_helpers.rb

@@ -0,0 +1,27 @@
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
+
+require 'fileutils'
+
+module SanitizeHelpers
+
+  # sanitizers_available? and leak_detection_available? live in spec_system_helper.rb beside
+  # the other tool probes, paired with their "requires ..." shared contexts.
+
+  def prep_project_yml_for_sanitize
+    FileUtils.cp feature_asset_path("project.yml"), "project.yml"
+    @c.uncomment_project_yml_option_for_test("- sanitize")
+  end
+
+  # The module every sanitize fixture tests, plus the fixtures named
+  def prep_sanitize_sources(*fixtures)
+    FileUtils.cp test_asset_path("example_file.h"), 'src/'
+    FileUtils.cp test_asset_path("example_file.c"), 'src/'
+    fixtures.each { |fixture| FileUtils.cp test_asset_path(fixture), 'test/' }
+  end
+
+end