ceedling 1.0.0 → 1.1.0

data/spec/manual/stress_test.rb

@@ -1,7 +1,7 @@
 # =========================================================================
 #   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
 # =========================================================================
 

data/spec/support/other_target.yml

@@ -1,7 +1,7 @@
 # =========================================================================
 #   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
 # =========================================================================
 

data/spec/support/spec_helper.rb

@@ -0,0 +1,20 @@
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
+
+require 'require_all'
+require 'constructor'
+
+RSpec.configure do |config|
+  config.raise_errors_for_deprecations!
+end
+
+here = File.dirname(__FILE__)
+
+$: << File.join(here, '../../bin')
+$: << File.join(here, '../../lib')
+$: << File.join(here, '../../vendor/cmock/lib')
+$: << File.join(here, '../../vendor/unity/auto')

data/spec/support/system/gem_dir_layout.rb

@@ -0,0 +1,20 @@
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
+
+class GemDirLayout
+  attr_reader :gem_dir_base_name
+
+  def initialize(install_dir)
+    @gem_dir_base_name = "gems"
+    @d = File.join install_dir, @gem_dir_base_name
+    FileUtils.mkdir_p @d
+  end
+
+  def install_dir; convert_slashes(@d)  end
+  def bin;         File.join(@d, 'bin') end
+  def lib;         File.join(@d, 'lib') end
+end

data/spec/support/system/spec_system_helper.rb

@@ -0,0 +1,206 @@
+# =========================================================================
+#   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'
+require 'tmpdir'
+require 'open3'
+require 'ceedling/yaml_wrapper'
+require 'spec_helper'
+require 'deep_merge'
+
+require_relative 'system_test_output'
+require_relative 'gem_dir_layout'
+require_relative 'system_context'
+require_relative '../../system/support/common_test_cases'
+
+module CeedlingSystemSpecHelpers
+  SYSTEM_TESTS_LABEL = "Ceedling System Tests"
+
+  # Helper method to convert method name to readable description
+  def test_case(method_name)
+    description = method_name.to_s.gsub('_', ' ').capitalize
+    it(description) { send(method_name) }
+  end
+end
+
+# Top-level DSL wrapper — replaces `describe "Ceedling System Tests" do` in each spec file.
+# Must be a top-level def (not inside a module) because config.extend only injects methods
+# into the RSpec example group DSL (inside describe blocks), not into main:Object where
+# the outermost describe call in each spec file is made.
+def ceedling_system_tests(&block)
+  describe(CeedlingSystemSpecHelpers::SYSTEM_TESTS_LABEL, &block)
+end
+
+# Extend RSpec's DSL to include our helper above, and add system-test failure diagnostics
+RSpec.configure do |config|
+  config.extend CeedlingSystemSpecHelpers
+
+  # Announce artifact preservation policy before any test runs so the developer knows
+  # what will be kept. Two debug modes are available via CEEDLING_SYSTEM_TEST_KEEP:
+  #   'failures' — set by `specs:system:debug` (CI batch mode via run-system-tests action):
+  #                only failing project directories and logs are preserved.
+  #   'all'      — set by `spec:system:debug:<name>` (individual dev debug and the CI locale
+  #                test job): all artifacts — pass and fail — are preserved for inspection.
+  # Normal mode (env var unset): all temporary files are deleted silently.
+  config.before(:suite) do
+    case ENV[SystemContext::SYSTEM_TEST_KEEP_ENV]
+    when 'all'
+      # Individual spec debug mode (and CI locale test): preserve everything for inspection.
+      $stdout.puts "\n[System Tests] Artifact preservation: ALL (pass + fail)"
+      $stdout.puts "  Pass project dirs: systests/proj/pass/"
+      $stdout.puts "  Fail project dirs: systests/proj/fail/"
+      $stdout.puts "  Pass logs:         systests/systest.pass.*.log"
+      $stdout.puts "  Fail logs:         systests/systest.fail.*.log\n\n"
+    when 'failures'
+      # CI batch debug mode: preserve only failures; passing dirs are deleted immediately.
+      $stdout.puts "\n[System Tests] Artifact preservation: FAILURES ONLY"
+      $stdout.puts "  Fail project dirs: systests/proj/fail/"
+      $stdout.puts "  Fail logs:         systests/systest.fail.*.log"
+      $stdout.puts "  Passing artifacts deleted immediately.\n\n"
+    end
+
+    # Build and install the Ceedling gem once for the entire suite.
+    # All describe blocks reuse this shared installation via SystemContext#deploy_gem,
+    # eliminating redundant `bundle install` calls (one per describe group previously).
+    SystemContext.setup_shared_gem!
+  end
+
+  config.after(:suite) do
+    SystemContext.cleanup_shared_gem!
+  end
+
+  # Exclude any line that does NOT contain "system" and ends with .rb from backtraces
+  # This helps reduce RSpec backtrace noise that is irrelevant to system test failures
+  config.backtrace_formatter.exclusion_patterns = [
+    /\A(?!.*system.*\.rb)/
+  ]
+
+  # Rebuild the full description from the group hierarchy using " :: " as separator.
+  # example.full_description concatenates with spaces, which is unreadable at 3-4 levels deep.
+  format_description = lambda do |example|
+    groups = example.example_group.parent_groups.reverse.drop(1)
+    parts  = groups.map(&:description).reject(&:empty?)
+    parts << example.description               unless example.description.empty?
+    parts.join(' :: ')
+  end
+
+  config.after(:each) do |example|
+    is_failure  = !example.exception.nil?
+    # 'all' mode (individual spec debug): log every test — pass and fail.
+    # 'failures' mode (CI batch debug): log only failures.
+    # Normal mode (env var unset): log nothing.
+    is_keep_all = (ENV[SystemContext::SYSTEM_TEST_KEEP_ENV] == 'all')
+
+    next if !is_failure && !is_keep_all
+    next unless defined?(@c) && @c.respond_to?(:raw_output) && !@c.raw_output.nil?
+
+    test_name =
+      example.full_description
+             # Remove "ceedling" and "system test(s)" from the test name as redundant in the log filename
+             .gsub(/^ceedling/i, '')
+             .gsub(/system tests?/i, '')
+             .gsub(/systests?/i, '')
+             # Replace non-filesystem-safe chars with underscores
+             .gsub(/[^a-zA-Z0-9_-]/, '_')
+             # Collapse runs of underscores into a single underscore
+             .squeeze('_')
+             # Strip leading/trailing underscores
+             .gsub(/\A_+|_+\z/, '')
+             # Truncate long names by keeping the last 120 chars (preserves the specific end of the name).
+             # String#slice(negative, length) returns nil when the string is shorter than the offset;
+             # use a conditional instead.
+             # After slicing, strip any partial leading word
+             # (e.g. "s_" from "Project's" -> "Project_s_" when the cut lands mid-segment).
+             .then { |s| s.length > 120 ? s[-120..].sub(/\A[^_]*_+/, '') : s }
+
+    timestamp   = Time.now.utc.strftime('%Y%m%dT%H%M%SZ')
+    # Centralize all system test result logs so CI can upload one directory as an artifact.
+    results_dir = File.join(Dir.pwd, 'systests')
+    FileUtils.mkdir_p(results_dir)
+
+    result_tag = is_failure ? 'fail' : 'pass'
+    log_path   = File.join(results_dir, "systest.#{result_tag}.#{test_name}.#{timestamp}.log")
+
+    log_content = ""
+    log_content << "Command: `#{@c.last_cmd}`\n\n" if @c.respond_to?(:last_cmd) && !@c.last_cmd.nil?
+    log_content << @c.raw_output.to_s
+    File.write(log_path, log_content)
+
+    if is_failure
+      @c.mark_failed! if @c.respond_to?(:mark_failed!)
+
+      $stderr.puts "\n" + ("=" * 72)
+      $stderr.puts "FAILED: #{format_description.call(example)}"
+      $stderr.puts "Temp dir: #{@c.dir}"
+      $stderr.puts "Log file: #{log_path}"
+      if @c.respond_to?(:console_summary) && !@c.console_summary.nil?
+        $stderr.puts "-" * 72
+        $stderr.puts @c.console_summary
+      end
+      $stderr.puts "=" * 72 + "\n"
+    end
+  end
+end
+
+def test_asset_path(asset_file_name)
+  File.join(File.dirname(__FILE__), '..', '..', '..', 'assets', asset_file_name)
+end
+
+def unique_proj_name(prefix)
+  safe = RSpec.current_example.description
+    .downcase
+    .gsub(/[^a-z0-9]+/, '_')
+    .gsub(/\A_+|_+\z/, '')
+    .slice(0, 60)
+  "#{prefix}_#{safe}"
+end
+
+def convert_slashes(path)
+  if RUBY_PLATFORM.downcase.match(/mingw|win32/)
+    path.gsub("/","\\")
+  else
+    path
+  end
+end
+
+# Generic tool availability probe.
+# cmd is a complete shell command string — the named probes below own their
+# own arguments, redirects, etc.
+def tool_available?(cmd)
+  `#{cmd}`
+  $?.exitstatus == 0
+rescue
+  false
+end
+
+def gdb_available?
+  tool_available?('gdb --version 2>&1')
+end
+
+def valgrind_available?
+  tool_available?('valgrind --version 2>&1')
+end
+
+RSpec.shared_context "requires gdb" do
+  before :all do
+    @gdb_available = gdb_available?
+  end
+
+  before do
+    skip "gdb is not installed or not in PATH" unless @gdb_available
+  end
+end
+
+RSpec.shared_context "requires valgrind" do
+  before :all do
+    @valgrind_available = valgrind_available?
+  end
+
+  before do
+    skip "valgrind is not installed or not in PATH" unless @valgrind_available
+  end
+end

data/spec/support/system/system_context.rb

@@ -0,0 +1,310 @@
+# =========================================================================
+#   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'
+require 'ceedling/encodinator'
+require_relative 'gem_dir_layout'
+
+class SystemContext
+  class VerificationFailed < RuntimeError; end
+  class InvalidBackupEnv < RuntimeError; end
+
+  attr_reader :dir, :gem, :console_summary, :raw_output, :last_exit_status, :last_cmd
+
+  SYSTEM_TEST_KEEP_ENV = 'CEEDLING_SYSTEM_TEST_KEEP'
+
+  # Shared gem installation — built once by setup_shared_gem!, reused by every deploy_gem call.
+  # Eliminates redundant `bundle install` runs (one per describe group → one per suite).
+  @@shared_gem_dir = nil
+  @@shared_gem     = nil
+
+  def self.setup_shared_gem!
+    return if @@shared_gem_dir
+
+    shared_dir = Dir.mktmpdir('ceedling_test_gem_')
+    shared_gem = GemDirLayout.new(shared_dir)
+
+    git_repo = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '..'))
+    File.write(
+      File.join(shared_dir, 'Gemfile'),
+      [
+        %Q{source "http://rubygems.org/"},
+        %Q{gem "rake"},
+        %Q{gem "constructor"},
+        %Q{gem "diy"},
+        %Q{gem "thor"},
+        %Q{gem "deep_merge"},
+        %Q{gem "unicode-display_width"},
+        %Q{gem "ceedling", :path => '#{git_repo}'}
+      ].join("\n")
+    )
+
+    Dir.chdir(shared_dir) do
+      saved = ENV.to_hash
+      begin
+        %w{BUNDLE_GEMFILE BUNDLE_BIN_PATH RUBYOPT}.each { |k| ENV.delete(k) }
+        deploy_output  = `bundle config set --local path '#{shared_gem.install_dir}' 2>&1`
+        deploy_output += `bundle install 2>&1`
+        raise VerificationFailed, "bundle install failed:\n#{deploy_output}" unless $?.success?
+
+        verify = `bundle exec ruby -S ceedling version 2>&1`
+        unless $?.success?
+          raise VerificationFailed,
+            "Ceedling does not appear to be installed or ready for use.\n" \
+            "Output:\n#{verify}"
+        end
+      rescue
+        FileUtils.rm_rf(shared_dir)
+        raise
+      ensure
+        ENV.replace(saved)
+      end
+    end
+
+    @@shared_gem_dir = shared_dir
+    @@shared_gem     = shared_gem
+  end
+
+  def self.cleanup_shared_gem!
+    FileUtils.rm_rf(@@shared_gem_dir) if @@shared_gem_dir
+    @@shared_gem_dir = nil
+    @@shared_gem     = nil
+  end
+
+  def initialize
+    if ENV[SYSTEM_TEST_KEEP_ENV]
+      # In either debug mode ('failures' or 'all'), root the temp dir inside systests/proj/
+      # so that done! can rename it to pass/ or fail/ on the same filesystem without a
+      # cross-device copy. The specific subdir (pass/ or fail/) is determined by done!.
+      base = File.join(Dir.pwd, 'systests', 'proj')
+      FileUtils.mkdir_p(base)
+      @dir = Dir.mktmpdir(nil, base)
+    else
+      @dir = Dir.mktmpdir
+    end
+    @gem = GemDirLayout.new(@dir)
+  end
+
+  def done!
+    if keep_all? || (keep_failures_only? && @failed)
+      # 'all' mode: preserve pass and fail artifacts for post-run inspection.
+      # 'failures' mode: preserve only failing artifacts; passing dirs are discarded
+      # immediately to avoid accumulating thousands of files during a full CI run
+      # (each --local project copies the entire Ceedling source tree).
+      subdir = @failed ? 'fail' : 'pass'
+      dest   = File.join(File.dirname(@dir), subdir, File.basename(@dir))
+      FileUtils.mkdir_p(File.dirname(dest))
+      FileUtils.mv(@dir, dest)
+      $stderr.puts "Test artifacts saved: #{dest}"
+    else
+      FileUtils.rm_rf(@dir)
+    end
+  end
+
+  # Called by the RSpec after(:each) hook on failure so done! routes this context to fail/.
+  def mark_failed!
+    @failed = true
+  end
+
+  def deploy_gem
+    raise VerificationFailed,
+      "Shared gem not initialized — ensure SystemContext.setup_shared_gem! " \
+      "is called before running system specs (see spec_system_helper.rb before(:suite))" \
+      unless @@shared_gem
+    @gem = @@shared_gem
+  end
+
+  # Does a few things:
+  #   - Configures the environment.
+  #   - Runs the command from the temporary context directory.
+  #   - Restores everything to where it was when finished.
+  def context_exec(cmd, *args)
+    with_context do
+      `#{args.unshift(cmd).join(" ")}`
+    end
+  end
+
+  def with_context
+    Dir.chdir @dir do |current_dir|
+      with_constrained_env do
+        # Point bundle exec to the shared Gemfile so it works from any project directory.
+        # constrain_env removes BUNDLE_GEMFILE; we re-set it here within the constrained scope.
+        ENV['BUNDLE_GEMFILE'] = File.join(@@shared_gem_dir, 'Gemfile') if @@shared_gem_dir
+        ENV['RUBYLIB'] = @gem.lib
+        ENV['RUBYPATH'] = @gem.bin
+
+        ENV['LANG'] = 'en_US.UTF-8'
+        ENV['LANGUAGE'] = 'en_US.UTF-8'
+        ENV['LC_ALL'] = 'en_US.UTF-8'
+
+        yield
+      end
+    end
+  end
+
+  ############################################################
+  # Functions for manipulating environment settings during tests:
+  def backup_env
+    @_env = ENV.to_hash
+  end
+
+  def reduce_env(destroy_keys=[])
+    ENV.keys.each {|k| ENV.delete(k) if destroy_keys.include?(k) }
+  end
+
+  def constrain_env
+    destroy_keys = %w{BUNDLE_GEMFILE BUNDLE_BIN_PATH RUBYOPT}
+    reduce_env(destroy_keys)
+  end
+
+  def restore_env
+    if @_env
+      # delete environment variables we've added since we started
+      ENV.to_hash.each_pair {|k,v| ENV.delete(k) unless @_env.include?(k) }
+
+      # restore environment variables we've modified since we started
+      @_env.each_pair {|k,v| ENV[k] = v}
+    else
+      raise InvalidBackupEnv.new
+    end
+  end
+
+  def with_constrained_env
+    begin
+      backup_env
+      constrain_env
+      yield
+    ensure
+      restore_env
+    end
+  end
+
+  ############################################################
+  # Functions for manipulating project.yml files during tests:
+  def merge_project_yml_for_test(settings, show_final=false)
+    yaml_wrapper = YamlWrapper.new
+    project_hash = yaml_wrapper.load('project.yml')
+    project_hash.deep_merge!(settings)
+    puts "\n\n#{project_hash.to_yaml}\n\n" if show_final
+    yaml_wrapper.dump('project.yml', project_hash)
+  end
+
+  def append_project_yml_for_test(new_args)
+    fake_prj_yml= "#{File.read('project.yml')}\n#{new_args}"
+    File.write('project.yml', fake_prj_yml, mode: 'w')
+  end
+
+  def uncomment_project_yml_option_for_test(option)
+    fake_prj_yml= File.read('project.yml').gsub(/\##{option}/,option)
+    File.write('project.yml', fake_prj_yml, mode: 'w')
+  end
+
+  def comment_project_yml_option_for_test(option)
+    fake_prj_yml= File.read('project.yml').gsub(/#{option}/,"##{option}")
+    File.write('project.yml', fake_prj_yml, mode: 'w')
+  end
+
+  ############################################################
+  # Ceedling command execution with structured failure reporting:
+
+  # For build/test (Rake tasks): Routes through the Ceedling CLI application command `build`
+  # This is the only command that accepts --verbosity.
+  def ceedling_build_exec(*args)
+    cmd = "bundle exec ruby -S ceedling build --verbosity=debug #{args.join(' ')}".strip
+    stdout, stderr, status = Open3.capture3(cmd)
+
+    @last_cmd         = cmd
+    @last_exit_status = status.exitstatus
+    # Captured subprocess output carries whatever raw bytes the child process wrote; under
+    # a non-UTF-8 default external encoding those bytes are read back tagged with that
+    # encoding regardless of their actual content, so any project source content the
+    # subprocess echoes (verbose logging, compiler output, etc.) can make later regex
+    # matching against this string raise. Sanitize once here, the same way Ceedling itself
+    # sanitizes file content it scans.
+    @raw_output       = (stdout + stderr).clean_encoding
+    @console_summary  = compose_failure_report(stdout, stderr)
+
+    SystemTestOutput.new(@raw_output)
+  end
+
+  # All other Ceedling CLI application commands other than `build`
+  # (new, upgrade, version, help, examples, example, etc.)
+  def ceedling_appcmd_exec(*args)
+    cmd = "bundle exec ruby -S ceedling #{args.join(' ')}".strip
+    stdout, stderr, status = Open3.capture3(cmd)
+
+    @last_cmd         = cmd
+    @last_exit_status = status.exitstatus
+    @raw_output       = (stdout + stderr).clean_encoding
+    @console_summary  = compose_failure_report(stdout, stderr)
+
+    SystemTestOutput.new(@raw_output)
+  end
+
+  private
+
+  # True when running the full suite in CI batch debug mode: keep only failing artifacts.
+  # Set by `specs:system:debug` rake task via CEEDLING_SYSTEM_TEST_KEEP='failures'.
+  def keep_failures_only?
+    ENV[SYSTEM_TEST_KEEP_ENV] == 'failures'
+  end
+
+  # True when running an individual spec in developer debug mode: keep all artifacts.
+  # Set by `spec:system:debug:<name>` rake tasks via CEEDLING_SYSTEM_TEST_KEEP='all'.
+  # Also used by the CI locale test job (spec:system:debug:preprocessing_locale).
+  def keep_all?
+    ENV[SYSTEM_TEST_KEEP_ENV] == 'all'
+  end
+
+  def compose_failure_report(stdout, stderr)
+    sections = []
+
+    error_lines     = stdout.lines.select { |l| l.include?('ERROR') }
+    exception_lines = stdout.lines.select { |l| l.include?('EXCEPTION') }
+
+    unless error_lines.empty? && exception_lines.empty?
+      sections << ">> ERRORS & EXCEPTIONS"
+      sections.concat(error_lines)
+      sections.concat(exception_lines)
+    end
+
+    unless stderr.strip.empty?
+      sections << ">> STDERR"
+      sections << stderr.strip
+    end
+
+    label = 'FAILED TEST SUMMARY'
+    failed_block = extract_section(stdout, label)
+    unless failed_block.empty?
+      sections << ">> #{label}"
+      sections.concat(failed_block)
+    end
+
+    label = 'OVERALL TEST SUMMARY'
+    overall_block = extract_section(stdout, label)
+    unless overall_block.empty?
+      sections << ">> #{label}"
+      sections.concat(overall_block)
+    end
+
+    sections.join("\n")
+  end
+
+  def extract_section(output, banner)
+    lines = output.lines
+    idx   = lines.index { |l| l.include?(banner) }
+    return [] unless idx
+
+    # Skip the banner line and any following pure-separator lines
+    start = idx + 1
+    start += 1 while start < lines.length && lines[start].strip.match?(/\A[-=]+\z/)
+
+    # Collect contiguous non-blank lines
+    lines[start..].take_while { |l| !l.strip.empty? }
+  end
+  ############################################################
+end

data/spec/support/system/system_test_output.rb

@@ -0,0 +1,28 @@
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
+
+# Wraps Ceedling command output to control how it appears in RSpec assertion failure messages.
+# RSpec formats the "actual" value via #inspect. For large outputs this class returns a
+# sentinel string so failures show only the expected pattern/substring, not thousands of lines.
+# For small outputs (≤1000 characters or ≤12 lines) the real content is shown inline so
+# short failures are immediately readable without consulting a log file.
+# All RSpec string matchers (match, include) continue to work unchanged at every call site.
+class SystemTestOutput
+  def initialize(output)
+    @output = output
+  end
+
+  def match(pattern) = @output.match(pattern)
+  def include?(str)  = @output.include?(str)
+  def to_s           = @output
+  def to_str         = @output
+  def inspect
+    # Show actual output when it is small enough to read inline; suppress it otherwise.
+    return @output.inspect if @output.length <= 1000 || @output.count("\n") <= 12
+    '(<Ceedling build output> -- See log file)'
+  end
+end

data/spec/support/target.yml

@@ -1,7 +1,7 @@
 # =========================================================================
 #   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
 # =========================================================================
 

data/spec/system/cppcheck_deployment_spec.rb

@@ -0,0 +1,49 @@
+# =========================================================================
+#   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'
+require_relative 'support/cppcheck_common_test_cases'
+
+ceedling_system_tests do
+  describe "Cppcheck" do
+    include CppcheckCommonTestCases
+
+    before :all do
+      @cppcheck_available = begin
+        `cppcheck --version 2>&1`
+        $?.exitstatus == 0
+      rescue
+        false
+      end
+
+      @c = SystemContext.new
+      @c.deploy_gem
+    end
+
+    after :all do
+      @c.done!
+    end
+
+    before { @proj_name = unique_proj_name("cppcheck") }
+
+    describe "Basic operations" do
+      before do
+        skip "cppcheck is not installed or not in PATH" unless @cppcheck_available
+        @c.with_context do
+          @c.ceedling_appcmd_exec("new --local #{@proj_name}")
+        end
+      end
+
+      test_case :project_build_tasks_plugins_help_for_cppcheck
+      test_case :can_run_cppcheck_on_whole_project
+      test_case :can_run_cppcheck_on_single_file
+      test_case :can_list_cppcheck_suppression_files
+      test_case :can_create_xml_report
+      test_case :can_create_text_report
+    end
+  end
+end