ceedling 1.0.0 → 1.1.0

data/lib/ceedling/config/configurator_validator.rb

@@ -0,0 +1,203 @@
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
+
+require 'rubygems'
+require 'rake' # for ext()
+require 'ceedling/constants'
+require 'ceedling/file_path_utils'  # for glob handling class methods
+
+
+class ConfiguratorValidator
+  
+  constructor :config_walkinator, :file_wrapper, :loginator, :system_wrapper, :reportinator, :tool_validator
+
+  # Walk into config hash verify existence of data at key depth
+  def exists?(config, *keys)
+    hash, _  = @config_walkinator.fetch_value( *keys, hash:config )
+    exist = !hash.nil?
+
+    if (not exist)
+      walk = @reportinator.generate_config_walk( keys )
+      @loginator.log( "Required config file entry #{walk} does not exist.", Verbosity::ERRORS )    
+    end
+    
+    return exist
+  end
+
+  # Walk into config hash. verify existence of path(s) at given key depth.
+  # Paths are either full simple paths or a simple portion of a path up to a glob.
+  def validate_path_list(config, *keys)
+    exist = true
+    list, depth = @config_walkinator.fetch_value( *keys, hash:config )
+
+    # Return early if we couldn't walk into hash and find a value
+    return false if (list.nil?)
+    
+    list.each do |path|
+      # Trim add/subtract notation & glob specifiers
+      _path = FilePathUtils::no_decorators( path )
+
+      next if _path.empty? # Path begins with or is entirely a glob, skip it
+
+      # If (partial) path does not exist, complain
+      if (not @file_wrapper.exist?( _path ))
+        walk = @reportinator.generate_config_walk( keys, depth )
+        @loginator.log( "Config path #{walk} => '#{_path}' does not exist in the filesystem.", Verbosity::ERRORS ) 
+        exist = false
+      end 
+    end
+    
+    return exist
+  end
+
+
+  # Validate :paths entries, exercising each entry as Ceedling directory glob (variation of Ruby glob)
+  def validate_paths_entries(config, key)
+    valid = true
+    keys = [:paths, key]
+    walk = @reportinator.generate_config_walk( keys )
+
+    list, _ = @config_walkinator.fetch_value( *keys, hash:config )
+
+    # Return early if we couldn't walk into hash and find a value
+    return false if (list.nil?)
+    
+    list.each do |path|
+      dirs = [] # Working list
+
+      # Trim add/subtract notation
+      _path = FilePathUtils::no_aggregation_decorators( path )
+
+      if @file_wrapper.exist?( _path ) and !@file_wrapper.directory?( _path )
+        # Path is a simple filepath (not a directory)
+        warning = "#{walk} => '#{_path}' is a filepath and will be ignored (FYI :paths is directory-oriented while :files is file-oriented)"
+        @loginator.log( warning, Verbosity::COMPLAIN )
+
+        next # Skip to next path
+      end
+
+      # Expand paths using Ruby's Dir.glob()
+      #  - A simple path will yield that path
+      #  - A path glob will expand to one or more paths
+      _reformed = FilePathUtils::reform_subdirectory_glob( _path )
+      @file_wrapper.directory_listing( _reformed ).each do |entry|
+        # For each result, add it to the working list *if* it's a directory
+        dirs << entry if @file_wrapper.directory?(entry)
+      end
+      
+      # Handle edge case of subdirectories glob but not subdirectories
+      # (Containing parent directory will still exist)
+      next if dirs.empty? and _path =~ /\/\*{1,2}$/
+
+      # Path did not work -- must be malformed glob or glob referencing path that does not exist.
+      # (An earlier step validates all simple directory paths).
+      if dirs.empty?
+        error = "#{walk} => '#{_path}' yielded no directories -- matching glob is malformed or directories do not exist"
+        @loginator.log( error, Verbosity::ERRORS )
+        valid = false
+      end
+    end
+    
+    return valid
+  end
+
+
+  # Validate :files entries, exercising each entry as FileList glob
+  def validate_files_entries(config, key)
+    valid = true
+    keys = [:files, key]
+    walk = @reportinator.generate_config_walk( keys )
+
+    list, _ = @config_walkinator.fetch_value( *keys, hash:config )
+
+    # Return early if we couldn't walk into hash and find a value
+    return false if (list.nil?)
+    
+    list.each do |path|
+      # Trim add/subtract notation
+      _path = FilePathUtils::no_aggregation_decorators( path )
+
+      if @file_wrapper.exist?( _path ) and @file_wrapper.directory?( _path )
+        # Path is a simple directory path (and is naturally ignored by FileList without a glob pattern)
+        warning = "#{walk} => '#{_path}' is a directory path and will be ignored (FYI :files is file-oriented while :paths is directory-oriented)"
+        @loginator.log( warning, Verbosity::COMPLAIN )
+
+        next # Skip to next path
+      end      
+
+      filelist = @file_wrapper.instantiate_file_list(_path)
+
+      # If file list is empty, complain
+      if (filelist.size == 0)
+        error = "#{walk} => '#{_path}' yielded no files -- matching glob is malformed or files do not exist"
+        @loginator.log( error, Verbosity::ERRORS ) 
+        valid = false
+      end 
+    end
+    
+    return valid
+  end
+
+
+  # Simple path verification
+  def validate_filepath_simple(path, *keys)
+    validate_path = path
+    
+    if (not @file_wrapper.exist?(validate_path))
+      walk = @reportinator.generate_config_walk( keys, keys.size )
+      @loginator.log("Config path '#{validate_path}' associated with #{walk} does not exist in the filesystem.", Verbosity::ERRORS ) 
+      return false
+    end 
+    
+    return true
+  end
+   
+  def validate_tool(config:, key:, respect_optional:true)
+    # Get tool
+    walk = [:tools, key]
+    tool, _ = @config_walkinator.fetch_value( *walk, hash:config )
+
+    arg_hash = {
+      tool: tool,
+      name: @reportinator.generate_config_walk( walk ),
+      extension: config[:extension][:executable],
+      respect_optional: respect_optional
+    }
+  
+    return @tool_validator.validate( **arg_hash )
+  end
+
+
+  def validate_matcher(matcher)
+    case matcher
+    
+    # Handle regex-based matcher
+    when /\/.+\//
+      # Ensure regex is well-formed by trying to compile it
+      begin
+        Regexp.compile( matcher[1..-2] )
+      rescue Exception => ex
+        # Re-raise with our own message formatting
+        raise "invalid regular expression:: #{ex.message}"
+      end
+    
+    # Handle wildcard / substring matchers
+    else
+      # Strip out allowed characters
+      invalid = matcher.gsub( /[a-z0-9 \/\.\-_\*]/i, '' )
+
+      # If there's any characters left, then we found invalid characters
+      if invalid.length() > 0
+        # Format invalid characters into a printable list with no duplicates
+        _invalid = invalid.chars.uniq.map{|c| "'#{c}'"}.join( ', ')
+
+        raise "invalid substring or wilcard characters #{_invalid}"
+      end
+    end
+  end
+
+end

data/lib/ceedling/constants.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
 # =========================================================================
 
@@ -26,18 +26,21 @@ VERBOSITY_OPTIONS = {
 
 # Label + decorator options for logging
 class LogLabels
-  NONE       =  0  # Override logic and settings with no label and no decoration
-  AUTO       =  1  # Default labeling and decorators
-  NOTICE     =  2  # decorator + 'NOTICE:'
-  WARNING    =  3  # decorator + 'WARNING:'
-  ERROR      =  4  # decorator + 'ERROR:'
-  EXCEPTION  =  5  # decorator + 'EXCEPTION:'
-  CONSTRUCT  =  6  # decorator only
-  RUN        =  7  # decorator only
-  CRASH      =  8  # decorator only
-  PASS       =  9  # decorator only
-  FAIL       = 10  # decorator only
-  TITLE      = 11  # decorator only
+  NONE          =  0  # Override logic and settings with no label and no decoration
+  AUTO          =  1  # Default labeling and decorators
+  NOTICE        =  2  # decorator + 'NOTICE:'
+  WARNING       =  3  # decorator + 'WARNING:'
+  ERROR         =  4  # decorator + 'ERROR:'
+  EXCEPTION     =  5  # decorator + 'EXCEPTION:'
+  CONSTRUCT     =  6  # decorator only
+  RUN           =  7  # decorator only
+  CRASH         =  8  # decorator only
+  PASS          =  9  # decorator only
+  FAIL          = 10  # decorator only
+  TITLE         = 11  # decorator only
+  DOCUMENTATION = 12  # decorator only
+  COMMERCIAL    = 13  # decorator only
+  REQUEST       = 14  # decorator only
 
   # Verbosity levels ERRORS – DEBUG default to certain labels or lack thereof
   # The above label constants are available to override Loginator's default AUTO level as needed
@@ -65,20 +68,61 @@ class StdErrRedirect
   TCSH = :tcsh
 end
 
+EXTENSION_WIN_EXE     = '.exe'
+EXTENSION_NONWIN_EXE  = '.out'
+
+# Vendor frameworks, generated mocks, generated runners are always .c files
+EXTENSION_CORE_HEADER = '.h'
+EXTENSION_CORE_SOURCE = '.c'
+
+CEEDLING_HEADER_FILENAME = 'ceedling.h'
+CEEDLING_HEADER_FILEPATH = CEEDLING_HEADER_FILENAME # lib/ceedling/
+PARTIAL_FILENAME_PREFIX  = 'ceedling_partial_'
+
+class PATTERNS
+  GLOB = /[\*\?\{\}\[\]]/
+
+  RUBY_STRING_REPLACEMENT = /#\{.+\}/
+  TOOL_EXECUTOR_ARGUMENT_REPLACEMENT = /(\$\{(\d+)\})/
+
+  TEST_STDOUT_STATISTICS  = /\n-+\s*(\d+)\s+Tests\s+(\d+)\s+Failures\s+(\d+)\s+Ignored\s+(OK|FAIL)\s*/i
+
+  USER_INCLUDE_DIRECTIVE_FILENAME = /#\s*include\s+\"\s*([\/\w\.\-]+)\s*\"/
+  SYSTEM_INCLUDE_DIRECTIVE_FILENAME = /#\s*include\s+<\s*([\/\w\.\-]+)\s*>/
+
+  TEST_SOURCE_FILE  = /TEST_SOURCE_FILE\s*\(\s*\"\s*([^"]+)\s*\"\s*\)/
+  TEST_INCLUDE_PATH = /TEST_INCLUDE_PATH\s*\(\s*\"\s*([^"]+)\s*\"\s*\)/
+
+  # Unity's TEST_CASE()/TEST_RANGE()/TEST_MATRIX() are positional marker macros.
+  # Unity's runner generator only honors one when it sits (whitespace only in between) 
+  # directly ahead of the `void test_Foo(...)` it configures.
+  # Captures one or more stacked calls (group 1) plus the name of the function they 
+  # immediately precede (group 2). So, callers can re-associate the macro text with its 
+  # function after preprocessing has separated them.
+  # The non-greedy `\(.*?\)` shares Unity's own limitation of not handling nested parens
+  # in macro arguments (see generate_test_runner.rb's identical fragment) -- parity, not a gap.
+  TEST_CASE_DIRECTIVE = /((?:[ \t]*(?:TEST_CASE|TEST_RANGE|TEST_MATRIX)\s*\(.*?\)\s*)+)void\s+(\w+)\s*\(/m
+
+  PARTIAL_IMPL_FILENAME = /\A#{PARTIAL_FILENAME_PREFIX}.+_impl#{Regexp.escape(EXTENSION_CORE_SOURCE)}\z/
+end
+
 GIT_COMMIT_SHA_FILENAME = 'GIT_COMMIT_SHA'
 
 # Escaped newline literal (literally double-slash-n) for "encoding" multiline strings as single string
 NEWLINE_TOKEN = '\\n'
 
+MIXIN_SIGIL_INLINE_YAML = '='
+MIXIN_SIGIL_FILEPATH    = '@'
+
 DEFAULT_PROJECT_FILENAME = 'project.yml'
 DEFAULT_BUILD_LOGS_PATH = 'logs'
 
+DOCS_SITE_LOCAL_PATH = 'site-local'
+
 GENERATED_DIR_PATH = [['vendor', 'ceedling'], 'src', "test", ['test', 'support'], 'build'].each{|p| File.join(*p)}
 
-EXTENSION_WIN_EXE     = '.exe'
-EXTENSION_NONWIN_EXE  = '.out'
-# Vendor frameworks, generated mocks, generated runners are always .c files
-EXTENSION_CORE_SOURCE = '.c' 
+# String used in generated include guards
+CEEDLING_GENERATED = 'CEEDLING_GENERATED'
 
 PREPROCESS_SYM = :preprocess
 
@@ -95,10 +139,6 @@ UNITY_C_FILE           = 'unity.c'
 UNITY_H_FILE           = 'unity.h'
 UNITY_INTERNALS_H_FILE = 'unity_internals.h'
 
-# Do-nothing macros defined in unity.h for extra build context to be used by build tools like Ceedling
-UNITY_TEST_SOURCE_FILE  = 'TEST_SOURCE_FILE'
-UNITY_TEST_INCLUDE_PATH = 'TEST_INCLUDE_PATH'
-
 RUNNER_BUILD_CMDLINE_ARGS_DEFINE = 'UNITY_USE_COMMAND_LINE_ARGS'
 
 CMOCK_SYM       = :cmock
@@ -131,21 +171,21 @@ OPERATION_COMPILE_SYM     = :compile    unless defined?(OPERATION_COMPILE_SYM)
 OPERATION_ASSEMBLE_SYM    = :assemble   unless defined?(OPERATION_ASSEMBLE_SYM)
 OPERATION_LINK_SYM        = :link       unless defined?(OPERATION_LINK_SYM)
 
+PREPROCESS_STANDINS_DIR  = 'standins'
 PREPROCESS_FULL_EXPANSION_DIR  = 'full_expansion'
 PREPROCESS_DIRECTIVES_ONLY_DIR = 'directives_only'
+PREPROCESS_RAW_DIRECTIVES_ONLY_DIR = 'directives_only/raw'
 
-# Match presence of any glob pattern characters
-GLOB_PATTERN = /[\*\?\{\}\[\]]/
-RUBY_STRING_REPLACEMENT_PATTERN = /#\{.+\}/
-TOOL_EXECUTOR_ARGUMENT_REPLACEMENT_PATTERN = /(\$\{(\d+)\})/
-TEST_STDOUT_STATISTICS_PATTERN  = /\n-+\s*(\d+)\s+Tests\s+(\d+)\s+Failures\s+(\d+)\s+Ignored\s+(OK|FAIL)\s*/i
+BUILD_OUT_DIR          = 'out'
+BUILD_RESULTS_DIR      = 'results'
+BUILD_DEPENDENCIES_DIR = 'dependencies'
 
 NULL_FILE_PATH = '/dev/null'
 
 TESTS_BASE_PATH   = TEST_ROOT_NAME
 RELEASE_BASE_PATH = RELEASE_ROOT_NAME
 
-VENDORS_FILES = %w(unity UnityHelper cmock CException).freeze
+VENDORS_FILES = %w(unity UnityHelper cmock CException ceedling).freeze
 
 # Ruby Here
 UNITY_TEST_RESULTS_TEMPLATE = <<~UNITY_TEST_RESULTS

data/lib/ceedling/defaults.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
 # =========================================================================
 
@@ -73,15 +73,19 @@ DEFAULT_TEST_FIXTURE_SIMPLE_BACKTRACE_TOOL = {
     ].freeze
   }
 
-DEFAULT_TEST_SHALLOW_INCLUDES_PREPROCESSOR_TOOL = {
+
+# Extracts all dependencies as make-style rules.
+# We use this to extract a bare list includes (user + system) from files.
+DEFAULT_TEST_BARE_INCLUDES_PREPROCESSOR_TOOL = {
   :executable => FilePathUtils.os_executable_ext('gcc').freeze,
-  :name => 'default_test_shallow_includes_preprocessor'.freeze,
+  :name => 'default_test_bare_includes_preprocessor'.freeze,
   :optional => false.freeze,
   :arguments => [
     '-E'.freeze,             # Run only through preprocessor stage with its output
-    '-MM'.freeze,            # Output make rule + suppress header files found in system header directories
+    '-M'.freeze,             # Output make rule of dependencies including system includes
     '-MG'.freeze,            # Assume missing header files are generated files (do not discard)
     '-MP'.freeze,            # Create make "phony" rules for each include dependency
+    "-I\"${4}\"".freeze,     # Per-test shallow includes essential search paths (e.g. Ceedling vendor path)
     "-D\"${2}\"".freeze,     # Per-test executable defines
     "-DGNU_COMPILER".freeze, # OSX clang
     '-nostdinc'.freeze,      # Ignore standard include paths
@@ -90,40 +94,25 @@ DEFAULT_TEST_SHALLOW_INCLUDES_PREPROCESSOR_TOOL = {
     ].freeze
   }
 
-DEFAULT_TEST_NESTED_INCLUDES_PREPROCESSOR_TOOL = {
-  :executable => FilePathUtils.os_executable_ext('gcc').freeze,
-  :name => 'default_test_nested_includes_preprocessor'.freeze,
-  :optional => false.freeze,
-  :arguments => [
-    '-E'.freeze,             # Run only through preprocessor stage with its output
-    '-MM'.freeze,            # Output make rule + suppress header files found in system header directories
-    '-MG'.freeze,            # Assume missing header files are generated files (do not discard)
-    '-H'.freeze,             # Also output #include list with depth
-    "-I\"${2}\"".freeze,     # Per-test executable search paths
-    "-D\"${3}\"".freeze,     # Per-test executable defines
-    "-DGNU_COMPILER".freeze, # OSX clang
-    '-nostdinc'.freeze,      # Ignore standard include paths
-    "-x c".freeze,           # Force C language
-    "\"${1}\"".freeze
-    ].freeze
-  }
-
+# Fully expands a given file through the preprocessor
+# Processes #ifdefs, expands macros, etc.
 DEFAULT_TEST_FILE_FULL_PREPROCESSOR_TOOL = {
   :executable => FilePathUtils.os_executable_ext('gcc').freeze,
   :name => 'default_test_file_full_preprocessor'.freeze,
   :optional => false.freeze,
   :arguments => [
     '-E'.freeze,
-    "-I\"${4}\"".freeze, # Per-test executable search paths
-    "-D\"${3}\"".freeze, # Per-test executable defines
+    "-I\"${4}\"".freeze,     # Per-test executable search paths
+    "-D\"${3}\"".freeze,     # Per-test executable defines
     "-DGNU_COMPILER".freeze, # OSX clang
-    # '-nostdinc'.freeze, # disabled temporarily due to stdio access violations on OSX
     "-x c".freeze,           # Force C language
     "\"${1}\"".freeze,
     "-o \"${2}\"".freeze
     ].freeze
   }
 
+# Expands a given file through the preprocessor, preserving directives (macros, includes, etc.).
+# Can be used to extract includes (differentiating system and user indludes) and non-code directives.
 DEFAULT_TEST_FILE_DIRECTIVES_ONLY_PREPROCESSOR_TOOL = {
   :executable => FilePathUtils.os_executable_ext('gcc').freeze,
   :name => 'default_test_file_directives_only_preprocessor'.freeze,
@@ -133,7 +122,6 @@ DEFAULT_TEST_FILE_DIRECTIVES_ONLY_PREPROCESSOR_TOOL = {
     "-I\"${4}\"".freeze, # Per-test executable search paths
     "-D\"${3}\"".freeze, # Per-test executable defines
     "-DGNU_COMPILER".freeze, # OSX clang
-    # '-nostdinc'.freeze, # disabled temporarily due to stdio access violations on OSX
     "-x c".freeze,           # Force C language
     "-fdirectives-only",     # Only preprocess directives
     "\"${1}\"".freeze,
@@ -141,33 +129,6 @@ DEFAULT_TEST_FILE_DIRECTIVES_ONLY_PREPROCESSOR_TOOL = {
     ].freeze
   }
 
-# Disable the -MD flag for OSX LLVM Clang, since unsupported
-if RUBY_PLATFORM =~ /darwin/ && `gcc --version 2> /dev/null` =~ /Apple LLVM version .* \(clang/m # OSX w/LLVM Clang
-  MD_FLAG = '' # Clang doesn't support the -MD flag
-else
-  MD_FLAG = '-MD'
-end
-
-DEFAULT_TEST_DEPENDENCIES_GENERATOR_TOOL = {
-  :executable => FilePathUtils.os_executable_ext('gcc').freeze,
-  :name => 'default_test_dependencies_generator'.freeze,
-  :optional => false.freeze,
-  :arguments => [
-    '-E'.freeze,
-    "-I\"${5}\"".freeze, # Per-test executable search paths
-    "-D\"${4}\"".freeze, # Per-test executable defines
-    "-DGNU_COMPILER".freeze,
-    "-MT \"${3}\"".freeze,
-    '-MM'.freeze,
-    MD_FLAG.freeze,
-    '-MG'.freeze,
-    "-MF \"${2}\"".freeze,
-    "-x c".freeze, # Force C language
-    "-c \"${1}\"".freeze,
-    # '-nostdinc'.freeze,
-    ].freeze
-  }
-
 DEFAULT_RELEASE_DEPENDENCIES_GENERATOR_TOOL = {
   :executable => FilePathUtils.os_executable_ext('gcc').freeze,
   :name => 'default_release_dependencies_generator'.freeze,
@@ -181,12 +142,11 @@ DEFAULT_RELEASE_DEPENDENCIES_GENERATOR_TOOL = {
     "-DGNU_COMPILER".freeze,
     "-MT \"${3}\"".freeze,
     '-MM'.freeze,
-    MD_FLAG.freeze,
+    '-MD'.freeze,
     '-MG'.freeze,
     "-MF \"${2}\"".freeze,
     "-x c".freeze, # Force C language
     "-c \"${1}\"".freeze,
-    # '-nostdinc'.freeze,
     ].freeze
   }
 
@@ -269,16 +229,12 @@ DEFAULT_TOOLS_TEST_ASSEMBLER = {
 
 DEFAULT_TOOLS_TEST_PREPROCESSORS = {
   :tools => {
-    :test_shallow_includes_preprocessor      => DEFAULT_TEST_SHALLOW_INCLUDES_PREPROCESSOR_TOOL,
-    :test_nested_includes_preprocessor       => DEFAULT_TEST_NESTED_INCLUDES_PREPROCESSOR_TOOL,
-    :test_file_full_preprocessor             => DEFAULT_TEST_FILE_FULL_PREPROCESSOR_TOOL,
-    :test_file_directives_only_preprocessor  => DEFAULT_TEST_FILE_DIRECTIVES_ONLY_PREPROCESSOR_TOOL,
-    }
-  }
-
-DEFAULT_TOOLS_TEST_DEPENDENCIES = {
-  :tools => {
-    :test_dependencies_generator => DEFAULT_TEST_DEPENDENCIES_GENERATOR_TOOL,
+    # Extracts include directives as make-style depenedencies
+    :test_bare_includes_preprocessor  => DEFAULT_TEST_BARE_INCLUDES_PREPROCESSOR_TOOL,
+    # Fully expands a given file through the preprocessor
+    :test_file_full_preprocessor              => DEFAULT_TEST_FILE_FULL_PREPROCESSOR_TOOL,
+    # Expands a given file through the preprocessor, preserving directives (macros, includes, etc.)
+    :test_file_directives_only_preprocessor   => DEFAULT_TEST_FILE_DIRECTIVES_ONLY_PREPROCESSOR_TOOL,
     }
   }
 
@@ -307,12 +263,13 @@ DEFAULT_RELEASE_TARGET_NAME = 'project'
 DEFAULT_CEEDLING_PROJECT_CONFIG = {
   :project => {
     # :build_root must be set by user
-    :use_mocks => false,
+    :name => '',
+    :use_mocks => true,
     :use_exceptions => false,
+    :use_partials => false,
+    :use_test_preprocessor => :none,
     :compile_threads => 1,
     :test_threads => 1,
-    :use_test_preprocessor => :none,
-    :use_deep_preprocessor => :none,
     :test_file_prefix => 'test_',
     :release_build => false,
     :use_backtrace => :simple
@@ -325,8 +282,12 @@ DEFAULT_CEEDLING_PROJECT_CONFIG = {
     },
 
   :test_build => {
-    :use_assembly => false
-    },
+    :use_assembly => false,
+    # Force fallback text-based preprocessing regardless of preprocessor capability.
+    # Primarily useful for testing the fallback path and for toolchains that report
+    # false support for -fdirectives-only. Default: false (use preprocessor when available).
+    :preprocess_force_fallback => false,
+  },
 
   # Unlike other top-level entries, :environment is an array (of hashes) to preserve order
   :environment => [],
@@ -447,7 +408,7 @@ DEFAULT_TESTS_RESULTS_REPORT_TEMPLATE = %q{
 % ignored        = hash[:results][:counts][:ignored]
 % failed         = hash[:results][:counts][:failed]
 % stdout_count   = hash[:results][:counts][:stdout]
-% header_prepend = ((hash[:header].length > 0) ? "#{hash[:header]}: " : '')
+% header_prepend = ((hash[:context] != TEST_SYM) ? "#{hash[:context].to_s.upcase}: " : '')
 % banner_width   = 25 + header_prepend.length # widest message
 
 % if (stdout_count > 0)

data/lib/ceedling/defineinator.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
 # =========================================================================
 
@@ -22,6 +22,8 @@
 #     - TEST
 #     - PLATFORM_B
 
+require 'ceedling/encodinator'
+
 class Defineinator
 
   constructor :configurator, :loginator, :config_matchinator
@@ -66,7 +68,7 @@ class Defineinator
       test_def = File.basename(filepath, '.*').strip
 
       # Replace any non-ASCII characters with underscores
-      test_def = test_def.encode("ASCII", "UTF-8", invalid: :replace, undef: :replace, replace: "_")
+      test_def = test_def.clean_encoding('_')
 
       # Replace all non-alphanumeric characters (including spaces/punctuation but excluding underscores) with underscores
       test_def.gsub!(/[^0-9a-z_]/i, '_')

data/lib/ceedling/dependinator.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/lib/ceedling/encodinator.rb

@@ -0,0 +1,26 @@
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
+
+# Patch the string class so that we have a nice shortcut for cleaning string encodings
+class String
+  def clean_encoding(safe_char = '')
+    begin
+      # Clean up any oddball characters in an otherwise ASCII document
+      encoding_options = {
+        :invalid           => :replace,  # Replace invalid byte sequences
+        :undef             => :replace,  # Replace anything not defined in ASCII
+        :replace           => safe_char, # Use a safe character for those replacements
+        :universal_newline => true       # Always break lines with \n
+      }
+    
+      return self.encode("ASCII", **encoding_options).encode('UTF-8', **encoding_options)
+    rescue 
+      raise "String contains characters that can't be represented in standard ASCII / UTF-8."
+    end 
+    self 
+  end
+end

data/lib/ceedling/erb_wrapper.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/lib/ceedling/exceptions.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
 # =========================================================================
 
@@ -13,6 +13,22 @@ class CeedlingException < RuntimeError
 end
 
 
+class YamlLoadException < CeedlingException
+
+  attr_reader :reason, :source, :original_error
+
+  # reason: :syntax (malformed YAML), :unsafe (Psych safe_load rejected a disallowed type),
+  #         :incompatible (installed Psych's safe_load interface doesn't support a required
+  #         feature/argument), :not_found (source file doesn't exist)
+  def initialize(reason:, source:, original_error:, message:)
+    @reason         = reason
+    @source         = source
+    @original_error = original_error
+    super( message )
+  end
+end
+
+
 class ShellException < CeedlingException
 
   attr_reader :shell_result
@@ -33,12 +49,16 @@ class ShellException < CeedlingException
       _message = "#{name} terminated with exit code [#{shell_result[:exit_code]}]"
 
       if !shell_result[:output].empty?
-        _message += " and output >>\n#{shell_result[:output].strip()}"
+        _message += " and output ⏩️\n#{shell_result[:output].strip()}"
+      end
+
+      if !message.empty?
+        _message += "\n#{message}"
       end
 
     # Otherwise, just report the exception message
     else
-      _message = "#{name} encountered an error with output >>\n#{message}"
+      _message = "#{name} encountered an error with output ⏩️\n#{message}"
     end
 
     # Hand the message off to parent Exception