ceedling 1.1.10 → 1.2.1

data/spec/system/support/common_test_cases.rb

@@ -6,14 +6,28 @@
 # =========================================================================
 
 require 'rbconfig'
+require 'ceedling/file_wrapper'
+require 'ceedling/yaml_wrapper'
 
 module CommonSystemTestCases
+  def yaml_wrapper_for_test
+    file_wrapper = FileWrapper.new({
+      :loginator    => double('loginator').as_null_object,
+      :verbosinator => double('verbosinator').as_null_object
+    })
+    YamlWrapper.new({ file_wrapper: file_wrapper })
+  end
+
+  # The `(\.dev)?` is not optional decoration. lib/version.rb appends that marker
+  # to every build the release pipeline did not produce, and these specs deploy
+  # the in-tree gem, so the suite normally sees it. A release build clears the
+  # marker, and the assertion has to hold either way.
   def can_report_version_no_git_commit_sha
     @c.with_context do
       # Version without Git commit short SHA file in project
       output = @c.ceedling_appcmd_exec("version")
       expect(@c.last_exit_status).to eq(0)
-      expect(output).to match(/Ceedling => \d\.\d\.\d\n/)
+      expect(output).to match(/Ceedling => \d+\.\d+\.\d+(\.dev)?\n/)
     end
   end
 
@@ -27,7 +41,7 @@ module CommonSystemTestCases
     @c.with_context do
       output = @c.ceedling_appcmd_exec("version")
       expect(@c.last_exit_status).to eq(0)
-      expect(output).to match(/Ceedling => \d\.\d\.\d----{-@\n/)
+      expect(output).to match(/Ceedling => \d+\.\d+\.\d+(\.dev)?----{-@\n/)
     end
   end
 
@@ -60,7 +74,6 @@ module CommonSystemTestCases
         expect(File.exist?("project.yml")).to eq true
         expect(File.exist?("src")).to eq true
         expect(File.exist?("test")).to eq true
-        all_docs = Dir["vendor/ceedling/docs/*.pdf"].length + Dir["vendor/ceedling/docs/*.md"].length
       end
     end
   end
@@ -71,8 +84,8 @@ module CommonSystemTestCases
       FileUtils.rm_rf("#{@proj_name}/test/support")
 
       updated_prj_yml = []
-      File.read("#{@proj_name}/project.yml").split("\n").each do |line|
-        updated_prj_yml.append(line) unless line =~ /support/
+      read_spec_file("#{@proj_name}/project.yml").split("\n").each do |line|
+        updated_prj_yml.append(line) unless /support/.match?(line)
       end
       File.write("#{@proj_name}/project.yml", updated_prj_yml.join("\n"), mode: 'w')
 
@@ -102,6 +115,29 @@ module CommonSystemTestCases
     end
   end
 
+  # A vendored project carries third-party source, so it must carry that source's
+  # licenses. Each is asserted by exact filename because capitalization is what breaks
+  # this: a glob for `license.txt` finds `LICENSE.txt` only where the filesystem is
+  # case insensitive, so Unity's, CMock's, and DIY's licenses reached macOS projects and
+  # not Linux ones. fff's arrives by a different route, the whole plugins/ tree being
+  # copied rather than selected subdirectories of it.
+  def contains_vendored_licenses
+    @c.with_context do
+      Dir.chdir @proj_name do
+        [
+          'vendor/ceedling/license.txt',
+          'vendor/ceedling/vendor/unity/LICENSE.txt',
+          'vendor/ceedling/vendor/cmock/LICENSE.txt',
+          'vendor/ceedling/vendor/c_exception/license.txt',
+          'vendor/ceedling/vendor/diy/LICENSE.txt',
+          'vendor/ceedling/plugins/fff/vendor/fff/LICENSE'
+        ].each do |license|
+          expect(File.exist?(license)).to eq(true), "expected vendored license #{license}"
+        end
+      end
+    end
+  end
+
   def does_not_contain_a_vendor_directory
     @c.with_context do
       Dir.chdir @proj_name do
@@ -132,18 +168,29 @@ module CommonSystemTestCases
   end
 
   def test_project_success
+    windows = /mingw|win32/.match?(RUBY_PLATFORM.downcase)
+
     @c.with_context do
       Dir.chdir @proj_name do
         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/'
 
+        # The starter project names test executables `.out`. Without it, Windows' own `.exe` applies.
+        @c.remove_project_yml_option_for_test( :extension, :executable ) if windows
+
         output = @c.ceedling_build_exec("test:all")
         expect(@c.last_exit_status).to eq(0) # Since a test either pass or are ignored, we return success here
         expect(output).to match(/TESTED:\s+\d/)
         expect(output).to match(/PASSED:\s+\d/)
         expect(output).to match(/FAILED:\s+\d/)
         expect(output).to match(/IGNORED:\s+\d/)
+
+        # Windows' Installer Detection reads a manifest beside each test executable
+        if windows
+          manifests = Dir.glob('build/test/out/test_example_file_success/*.manifest')
+          expect(manifests).to eq(['build/test/out/test_example_file_success/test_example_file_success.exe.manifest'])
+        end
       end
     end
   end
@@ -548,6 +595,39 @@ module CommonSystemTestCases
     end
   end
 
+  # A project can use Partials for some modules while other, unrelated tests keep
+  # mocking a plain `static inline` function through CMock's own :treat_inlines
+  # option -- the two mechanisms don't need to agree project-wide, since each
+  # mock's own configuration is independent of what any other test in the project
+  # is doing.
+  def test_project_partials_enabled_still_allows_plain_treat_inlines_mocking
+    @c.with_context do
+      Dir.chdir @proj_name do
+        FileUtils.cp test_asset_path("partial_all_module.h"), 'src/'
+        FileUtils.cp test_asset_path("test_partial_all_module.c"), 'test/'
+        FileUtils.cp test_asset_path("plain_inline_module.h"), 'src/'
+        FileUtils.cp test_asset_path("test_plain_inline_module.c"), 'test/'
+
+        settings = {
+          :project => {
+            :use_partials          => true,
+            :use_test_preprocessor => :all
+          },
+          :cmock => {
+            :treat_inlines => :include
+          }
+        }
+        @c.merge_project_yml_for_test(settings)
+
+        output = @c.ceedling_build_exec("test:all")
+        expect(@c.last_exit_status).to eq(0) # Successful build and tests
+        expect(output).to match(/TESTED:\s+2/)
+        expect(output).to match(/PASSED:\s+2/)
+        expect(output).to match(/FAILED:\s+0/)
+      end
+    end
+  end
+
   def test_project_fail
     @c.with_context do
       Dir.chdir @proj_name do
@@ -604,7 +684,7 @@ module CommonSystemTestCases
       Dir.chdir @proj_name do
         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("test:all")
         expect(@c.last_exit_status).to eq(1) # Since a test explodes, we return error here
@@ -792,7 +872,7 @@ module CommonSystemTestCases
       Dir.chdir @proj_name do
         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 => :none }})
 
@@ -813,7 +893,7 @@ module CommonSystemTestCases
       Dir.chdir @proj_name do
         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 => :none }})
 
@@ -821,9 +901,9 @@ module CommonSystemTestCases
         expect(@c.last_exit_status).to eq(1) # Test should fail because of crash
         expect(output).to match(/Test Executable Crashed/i)
         expect(output).to match(/Unit test failures/)
-        expect(File.exist?('./build/test/results/test_example_file_crash_sigsegv.fail'))
-        output_rd = File.read('./build/test/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/test/results/test_nosanitize_crash_sigsegv.fail')).to be(true)
+        output_rd = read_spec_file('./build/test/results/test_nosanitize_crash_sigsegv.fail')
+        expect(output_rd =~ /test_add_numbers_will_fail \(\) at test\/test_nosanitize_crash_sigsegv.c\:\d+/ )
       end
     end
   end
@@ -836,7 +916,7 @@ module CommonSystemTestCases
       Dir.chdir @proj_name do
         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 }})
 
@@ -844,17 +924,17 @@ module CommonSystemTestCases
         expect(@c.last_exit_status).to eq(1) # Test should fail because of crash
         expect(output).to match(/Test Case Crashed/i)
         expect(output).to match(/Unit test failures/)
-        expect(File.exist?('./build/test/results/test_example_file_crash_sigsegv.fail'))
-        output_rd = File.read('./build/test/results/test_example_file_crash_sigsegv.fail')
+        expect(File.exist?('./build/test/results/test_nosanitize_crash_sigsegv.fail')).to be(true)
+        output_rd = read_spec_file('./build/test/results/test_nosanitize_crash_sigsegv.fail')
         expect(output_rd).to match(/Test case crashed/)
         expect(output_rd).to match(/SIGSEGV/i)
         expect(output).to match(/TESTED:\s+2/)
         expect(output).to match(/PASSED:\s+(?:0|1)/)
         expect(output).to match(/FAILED:\s+(?:1|2)/)
         expect(output).to match(/IGNORED:\s+0/)
-        log_path = './build/logs/test/test_example_file_crash_sigsegv/test_add_numbers_will_fail.gdb.log'
+        log_path = './build/logs/test/test_nosanitize_crash_sigsegv/test_add_numbers_will_fail.gdb.log'
         expect(File.exist?(log_path)).to be(true)
-        expect(File.read(log_path)).to match(/SIGSEGV|Segmentation fault/i)
+        expect(read_spec_file(log_path)).to match(/SIGSEGV|Segmentation fault/i)
         expect(output).to match(/test_add_numbers_will_fail\.gdb\.log/)
       end
     end
@@ -867,7 +947,7 @@ module CommonSystemTestCases
       Dir.chdir @proj_name do
         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 }})
 
@@ -875,17 +955,17 @@ module CommonSystemTestCases
         expect(@c.last_exit_status).to eq(1) # Test should fail because of crash
         expect(output).to match(/Test Case Crashed/i)
         expect(output).to match(/Unit test failures/)
-        expect(File.exist?('./build/test/results/test_example_file_crash_sigsegv.fail'))
-        output_rd = File.read('./build/test/results/test_example_file_crash_sigsegv.fail')
+        expect(File.exist?('./build/test/results/test_nosanitize_crash_sigsegv.fail')).to be(true)
+        output_rd = read_spec_file('./build/test/results/test_nosanitize_crash_sigsegv.fail')
         expect(output_rd).to match(/Test case crashed/)
         expect(output_rd).to match(/SIGSEGV/i)
         expect(output).to match(/TESTED:\s+1/)
         expect(output).to match(/PASSED:\s+(?:0|1)/)
         expect(output).to match(/FAILED:\s+(?:1|2)/)
         expect(output).to match(/IGNORED:\s+0/)
-        log_path = './build/logs/test/test_example_file_crash_sigsegv/test_add_numbers_will_fail.gdb.log'
+        log_path = './build/logs/test/test_nosanitize_crash_sigsegv/test_add_numbers_will_fail.gdb.log'
         expect(File.exist?(log_path)).to be(true)
-        expect(File.read(log_path)).to match(/SIGSEGV|Segmentation fault/i)
+        expect(read_spec_file(log_path)).to match(/SIGSEGV|Segmentation fault/i)
         expect(output).to match(/test_add_numbers_will_fail\.gdb\.log/)
       end
     end
@@ -898,7 +978,7 @@ module CommonSystemTestCases
       Dir.chdir @proj_name do
         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 }})
 
@@ -906,17 +986,17 @@ module CommonSystemTestCases
         expect(@c.last_exit_status).to eq(1) # Test should fail because of crash
         expect(output).to match(/Test Case Crashed/i)
         expect(output).to match(/Unit test failures/)
-        expect(File.exist?('./build/test/results/test_example_file_crash_sigsegv.fail'))
-        output_rd = File.read('./build/test/results/test_example_file_crash_sigsegv.fail')
+        expect(File.exist?('./build/test/results/test_nosanitize_crash_sigsegv.fail')).to be(true)
+        output_rd = read_spec_file('./build/test/results/test_nosanitize_crash_sigsegv.fail')
         expect(output_rd).to match(/Test case crashed/)
         expect(output_rd).to match(/SIGSEGV/i)
         expect(output).to match(/TESTED:\s+1/)
         expect(output).to match(/PASSED:\s+(?:0|1)/)
         expect(output).to match(/FAILED:\s+(?:1|2)/)
         expect(output).to match(/IGNORED:\s+0/)
-        log_path = './build/logs/test/test_example_file_crash_sigsegv/test_add_numbers_will_fail.gdb.log'
+        log_path = './build/logs/test/test_nosanitize_crash_sigsegv/test_add_numbers_will_fail.gdb.log'
         expect(File.exist?(log_path)).to be(true)
-        expect(File.read(log_path)).to match(/SIGSEGV|Segmentation fault/i)
+        expect(read_spec_file(log_path)).to match(/SIGSEGV|Segmentation fault/i)
         expect(output).to match(/test_add_numbers_will_fail\.gdb\.log/)
       end
     end
@@ -931,7 +1011,7 @@ module CommonSystemTestCases
       Dir.chdir @proj_name do
         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_assert.c"), 'test/'
+        FileUtils.cp test_asset_path("test_nosanitize_crash_assert.c"), 'test/'
 
         @c.merge_project_yml_for_test({:project => { :use_backtrace => :gdb }})
 
@@ -941,12 +1021,20 @@ module CommonSystemTestCases
         expect(output).to match(/Unit test failures/)
         expect(output).to match(/SIGABRT/i)
         expect(output).to match(/Assertion/i)
-        log_path = './build/logs/test/test_example_file_crash_assert/test_add_numbers_triggers_assert.gdb.log'
+        log_path = './build/logs/test/test_nosanitize_crash_assert/test_add_numbers_triggers_assert.gdb.log'
         expect(File.exist?(log_path)).to be(true)
         # Windwos gdb output for an assertion failure can be quite different from Linux.
-        # Windows gdb reports do not seem to cite the signal "SIGABRT" and may be quite brief, 
+        # Windows gdb reports do not seem to cite the signal "SIGABRT" and may be quite brief,
         # only citing an assertion failure.
-        expect(File.read(log_path)).to match(/SIGABRT|abort|assert/i)
+        #
+        # A bare "assert" alternative here is a false-positive trap: this test case's own
+        # name is `test_add_numbers_triggers_assert`, and do_gdb writes that name into the
+        # log's own header line regardless of whether gdb produced anything useful. A gdb
+        # that cannot attach at all (e.g. lost macOS codesigning trust) writes a log whose
+        # only "assert" is that header -- matching a bare substring and passing this
+        # assertion despite gdb reporting nothing real. Requiring "fail" near "Assertion"
+        # anchors the match to an actual assertion-failure report instead.
+        expect(read_spec_file(log_path)).to match(/SIGABRT|Aborted|Assertion.{0,100}fail/i)
         expect(output).to match(/test_add_numbers_triggers_assert\.gdb\.log/)
         expect(output).to match(/TESTED:\s+2/)
         expect(output).to match(/FAILED:\s+(?:1|2)/)
@@ -963,7 +1051,7 @@ module CommonSystemTestCases
       Dir.chdir @proj_name do
         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 => :simple }})
 
@@ -986,7 +1074,7 @@ module CommonSystemTestCases
       Dir.chdir @proj_name do
         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_assert.c"), 'test/'
+        FileUtils.cp test_asset_path("test_nosanitize_crash_assert.c"), 'test/'
 
         @c.merge_project_yml_for_test({:project => { :use_backtrace => :simple }})
 
@@ -1012,7 +1100,7 @@ module CommonSystemTestCases
       Dir.chdir @proj_name do
         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_with_param.c"), 'test/'
+        FileUtils.cp test_asset_path("test_nosanitize_crash_sigsegv_with_param.c"), 'test/'
 
         @c.merge_project_yml_for_test({
           :project => { :use_backtrace => :simple },
@@ -1028,9 +1116,9 @@ module CommonSystemTestCases
         expect(output).to match(/FAILED:\s+1/)
         expect(output).to match(/IGNORED:\s+0/)
 
-        result_file = './build/test/results/test_example_file_crash_sigsegv_with_param.fail'
+        result_file = './build/test/results/test_nosanitize_crash_sigsegv_with_param.fail'
         expect(File.exist?(result_file)).to be(true)
-        results = YamlWrapper.new.load(result_file)
+        results = yaml_wrapper_for_test.load(result_file)
 
         # Only the truly crashing test is reported as a failure/crash
         expect(results[:failures].map { |f| f[:test] }).to eq(['test_add_numbers_will_fail'])
@@ -1055,7 +1143,7 @@ module CommonSystemTestCases
       Dir.chdir @proj_name do
         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_with_param.c"), 'test/'
+        FileUtils.cp test_asset_path("test_nosanitize_crash_sigsegv_with_param.c"), 'test/'
 
         @c.merge_project_yml_for_test({
           :project => { :use_backtrace => :gdb },
@@ -1070,9 +1158,9 @@ module CommonSystemTestCases
         expect(output).to match(/FAILED:\s+1/)
         expect(output).to match(/IGNORED:\s+0/)
 
-        result_file = './build/test/results/test_example_file_crash_sigsegv_with_param.fail'
+        result_file = './build/test/results/test_nosanitize_crash_sigsegv_with_param.fail'
         expect(File.exist?(result_file)).to be(true)
-        results = YamlWrapper.new.load(result_file)
+        results = yaml_wrapper_for_test.load(result_file)
 
         # Only the truly crashing test is reported as a failure/crash
         expect(results[:failures].map { |f| f[:test] }).to eq(['test_add_numbers_will_fail'])
@@ -1086,9 +1174,45 @@ module CommonSystemTestCases
           'test_difference_between_numbers_is_correct(0, 0, 0)'
         )
 
-        log_path = './build/logs/test/test_example_file_crash_sigsegv_with_param/test_add_numbers_will_fail.gdb.log'
+        log_path = './build/logs/test/test_nosanitize_crash_sigsegv_with_param/test_add_numbers_will_fail.gdb.log'
         expect(File.exist?(log_path)).to be(true)
-        expect(File.read(log_path)).to match(/SIGSEGV|Segmentation fault/i)
+        expect(read_spec_file(log_path)).to match(/SIGSEGV|Segmentation fault/i)
+      end
+    end
+  end
+
+  # Validates the inverse of the other five gdb system tests: when gdb is
+  # installed but cannot actually attach to a process (the exact macOS
+  # codesigning-trust-loss scenario those five tests gate around and skip on),
+  # Ceedling detects this at build startup and automatically falls back to
+  # :simple backtraces rather than leaving :use_backtrace: :gdb configured but
+  # non-functional. See ConfiguratorSetup#validate_gdb_attach_capability.
+  def crash_gdb_hobbled_falls_back_to_simple
+    @c.with_context do
+      Dir.chdir @proj_name do
+        FileUtils.cp test_asset_path("example_file.h"), 'src/'
+        FileUtils.cp test_asset_path("example_file.c"), 'src/'
+        FileUtils.cp test_asset_path("test_nosanitize_crash_sigsegv.c"), 'test/'
+
+        @c.merge_project_yml_for_test({:project => { :use_backtrace => :gdb }})
+
+        output = @c.ceedling_build_exec("test:all")
+        expect(@c.last_exit_status).to eq(1) # Test should fail because of crash
+
+        # Ceedling detected the hobbled gdb and downgraded automatically
+        expect(output).to match(/:use_backtrace.*is ':gdb'/)
+        expect(output).to match(/could not attach to a probe process/i)
+        expect(output).to match(/Falling back to ':simple'/i)
+
+        # The crash is reported the :simple way, not the :gdb way
+        expect(output).to match(/Test Case Crashed/i)
+        expect(output).to match(/Unit test failures/)
+        expect(output).to match(/TESTED:\s+2/)
+        expect(output).to match(/FAILED:\s+(?:1|2)/)
+        expect(output).to match(/IGNORED:\s+0/)
+
+        # do_gdb never ran, so no .gdb.log was ever written
+        expect(Dir.glob('./build/logs/**/*.gdb.log')).to be_empty
       end
     end
   end
@@ -1138,7 +1262,7 @@ module CommonSystemTestCases
   def crash_simple_ubsan_diagnostic_retry_disagrees_with_main_fixture
     @c.with_context do
       Dir.chdir @proj_name do
-        FileUtils.cp test_asset_path("test_example_file_ub_shift_overflow.c"), 'test/'
+        FileUtils.cp test_asset_path("test_nosanitize_ub_shift_overflow.c"), 'test/'
         FileUtils.cp test_asset_path("run_with_ubsan.rb"), 'test/'
 
         @c.merge_project_yml_for_test({
@@ -1191,8 +1315,8 @@ module CommonSystemTestCases
 
         add_line = false
         updated_test_file = []
-        File.read(File.join('test','test_example_file_success.c')).split("\n").each do |line|
-          if line =~ /#include "unity.h"/
+        read_spec_file(File.join('test','test_example_file_success.c')).split("\n").each do |line|
+          if /#include "unity.h"/.match?(line)
             add_line = true
             updated_test_file.append(line)
           else

data/spec/system/support/cppcheck_common_test_cases.rb

@@ -95,4 +95,84 @@ module CppcheckCommonTestCases
     end
   end
 
+  # Cppcheck only runs as part of generating a report. With none configured this
+  # task previously analyzed nothing and said nothing.
+  def warns_when_no_reports_configured
+    @c.with_context do
+      Dir.chdir @proj_name do
+        prep_project_yml_for_cppcheck(reports: [])
+        FileUtils.cp test_asset_path("example_file.h"), 'src/'
+        FileUtils.cp test_asset_path("example_file.c"), 'src/'
+
+        output = @c.ceedling_build_exec("cppcheck:all")
+
+        expect(@c.last_exit_status).to eq(0)
+        expect(output).to match(/No Cppcheck reports are configured/i)
+      end
+    end
+  end
+
+  def reports_findings_by_severity
+    @c.with_context do
+      Dir.chdir @proj_name do
+        prep_project_yml_for_cppcheck(reports: [:xml])
+        copy_cppcheck_findings_fixture
+
+        output = @c.ceedling_build_exec("cppcheck:all")
+
+        expect(@c.last_exit_status).to eq(0)
+        expect(output).to match(/Cppcheck findings:.*error/i)
+      end
+    end
+  end
+
+  def fail_build_breaks_build_on_matching_severity
+    @c.with_context do
+      Dir.chdir @proj_name do
+        prep_project_yml_for_cppcheck(reports: [])
+        @c.merge_project_yml_for_test({ cppcheck: { fail_build: true } })
+        copy_cppcheck_findings_fixture
+
+        output = @c.ceedling_build_exec("cppcheck:all")
+
+        expect(@c.last_exit_status).to eq(1)
+        expect(output).to match(/matching :cppcheck.*:fail_build_severities/i)
+        # :fail_build implies an XML report, so the evidence is on disk.
+        expect(File.exist?('build/artifacts/cppcheck/CppcheckReport.xml')).to eq(true)
+      end
+    end
+  end
+
+  def fail_build_passes_when_no_matching_severity
+    @c.with_context do
+      Dir.chdir @proj_name do
+        prep_project_yml_for_cppcheck(reports: [])
+        @c.merge_project_yml_for_test({
+          cppcheck: { fail_build: true, fail_build_severities: ['portability'] }
+        })
+        copy_cppcheck_findings_fixture
+
+        output = @c.ceedling_build_exec("cppcheck:all")
+
+        expect(@c.last_exit_status).to eq(0)
+        expect(output).to match(/Cppcheck findings:/i)
+      end
+    end
+  end
+
+  # Listing suppression files needs no Cppcheck executable. Same defect class as
+  # issue #1252 in the Gcov plugin.
+  def suppression_file_listing_needs_no_cppcheck
+    @c.with_context do
+      Dir.chdir @proj_name do
+        prep_project_yml_for_cppcheck(reports: [:text])
+
+        output = @c.ceedling_appcmd_exec("files:cppcheck")
+
+        expect(@c.last_exit_status).to eq(0)
+        expect(output).to match(/Cppcheck suppression files/i)
+      end
+    end
+  end
+
 end

data/spec/system/support/cppcheck_helpers.rb

@@ -9,17 +9,19 @@ require 'fileutils'
 
 module CppcheckHelpers
 
-  def cppcheck_available?
-    begin
-      `cppcheck --version 2>&1`
-      $?.exitstatus == 0
-    rescue
-      false
-    end
+  # cppcheck_available? lives in spec_system_helper.rb beside the other tool probes,
+  # paired with the "requires cppcheck" shared context.
+
+  # Copies a source Cppcheck reports exactly one error-severity finding for.
+  # See assets/fixtures/cppcheck_findings/findings.c.
+  def copy_cppcheck_findings_fixture
+    asset_base = test_asset_path('cppcheck_findings')
+    FileUtils.cp "#{asset_base}/findings.h", 'src/'
+    FileUtils.cp "#{asset_base}/findings.c", 'src/'
   end
 
   def prep_project_yml_for_cppcheck(reports: [:text])
-    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("- cppcheck")
     @c.merge_project_yml_for_test({cppcheck: {reports: reports}})
   end