ceedling 0.31.1 → 1.0.1

data/lib/ceedling/defineinator.rb

@@ -0,0 +1,90 @@
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
+
+# :defines:
+#   :test:
+#     :*:                                # Define TEST during compilation of all files for all test executables
+#       - TEST
+#     :Model:                            # Define PLATFORM_B during compilation of any test executable with Model in its filename
+#       - -PLATFORM_B
+#   :unity:
+#     - UNITY_INCLUDE_PRINT_FORMATTED    # Define Unity configuration symbols during all test compilation
+#     - UNITY_FLOAT_PRECISION=0.001f     # ...
+#   :release:
+#     - COM=Serial                       # Define COM for compilation of all files during release build
+
+# :defines:
+#   :test:                               # Equivalent to [test]['*'] -- i.e. same defines for all test executables
+#     - TEST
+#     - PLATFORM_B
+
+require 'ceedling/encodinator'
+
+class Defineinator
+
+  constructor :configurator, :loginator, :config_matchinator
+
+  def setup
+    @topkey = :defines
+  end
+
+  def defines_defined?(context:)
+    return @config_matchinator.config_include?(primary:@topkey, secondary:context)
+  end
+
+  # Defaults to inspecting configurations beneath top-level :defines
+  # (But, we can also lookup defines symbol lists within framework configurations--:unity, :cmock, :cexception)
+  def defines(topkey:@topkey, subkey:, filepath:nil, default:[])
+    defines = @config_matchinator.get_config(primary:topkey, secondary:subkey)
+
+    if defines == nil then return default
+    # Flatten to handle list-nested YAML aliasing (should have already been flattened during validation)
+    elsif defines.is_a?(Array) then return defines.flatten
+    elsif defines.is_a?(Hash)
+      arg_hash = {
+        hash: defines,
+        filepath: filepath,
+        section: topkey,
+        context: subkey
+      }
+
+      return @config_matchinator.matches?(**arg_hash)
+    end
+
+    # Handle unexpected config element type
+    return []
+  end
+
+  # Optionally create a command line compilation symbol that is a test file's sanitized/converted name
+  def generate_test_definition(filepath:)
+    defines = []
+
+    if @configurator.defines_use_test_definition
+      # Get filename with no path or extension
+      test_def = File.basename(filepath, '.*').strip
+
+      # Replace any non-ASCII characters with underscores
+      test_def = test_def.clean_enoding('_')
+
+      # Replace all non-alphanumeric characters (including spaces/punctuation but excluding underscores) with underscores
+      test_def.gsub!(/[^0-9a-z_]/i, '_')
+
+      # Convert to all caps
+      test_def.upcase!
+
+      # Add leading and trailiing underscores unless they already exist
+      test_def = test_def.start_with?('_') ? test_def : ('_' + test_def)
+      test_def = test_def.end_with?('_') ? test_def : (test_def + '_')
+
+      # Add the test filename as a #define symbol to the array
+      defines << test_def
+    end
+
+    return defines
+  end
+
+end

data/lib/ceedling/dependinator.rb

@@ -1,97 +1,31 @@
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
 
 class Dependinator
 
-  constructor :configurator, :project_config_manager, :test_includes_extractor, :file_path_utils, :rake_wrapper, :file_wrapper
-
-  def touch_force_rebuild_files
-    @file_wrapper.touch( @configurator.project_test_force_rebuild_filepath )
-    @file_wrapper.touch( @configurator.project_release_force_rebuild_filepath ) if (@configurator.project_release_build)
-  end
-
+  constructor :configurator, :test_context_extractor, :file_path_utils, :rake_wrapper, :file_wrapper
 
 
   def load_release_object_deep_dependencies(dependencies_list)
     dependencies_list.each do |dependencies_file|
-      if File.exists?(dependencies_file)
+      if File.exist?(dependencies_file)
         @rake_wrapper.load_dependencies( dependencies_file )
       end
     end
   end
 
 
-  def enhance_release_file_dependencies(files)
-    files.each do |filepath|
-      @rake_wrapper[filepath].enhance( [@configurator.project_release_force_rebuild_filepath] ) if (@project_config_manager.release_config_changed)
-    end
-  end
-
-
-
   def load_test_object_deep_dependencies(files_list)
     dependencies_list = @file_path_utils.form_test_dependencies_filelist(files_list)
     dependencies_list.each do |dependencies_file|
-      if File.exists?(dependencies_file)
+      if File.exist?(dependencies_file)
         @rake_wrapper.load_dependencies(dependencies_file)
       end
     end
   end
 
-
-  def enhance_runner_dependencies(runner_filepath)
-    @rake_wrapper[runner_filepath].enhance( [@configurator.project_test_force_rebuild_filepath] ) if (@project_config_manager.test_config_changed ||
-      @project_config_manager.test_defines_changed)
-  end
-
-
-  def enhance_shallow_include_lists_dependencies(include_lists)
-    include_lists.each do |include_list_filepath|
-      @rake_wrapper[include_list_filepath].enhance( [@configurator.project_test_force_rebuild_filepath] ) if (@project_config_manager.test_config_changed ||
-        @project_config_manager.test_defines_changed)
-    end
-  end
-
-
-  def enhance_preprocesed_file_dependencies(files)
-    files.each do |filepath|
-      @rake_wrapper[filepath].enhance( [@configurator.project_test_force_rebuild_filepath] ) if (@project_config_manager.test_config_changed ||
-        @project_config_manager.test_defines_changed)
-    end
-  end
-
-
-  def enhance_mock_dependencies(mocks_list)
-    # if input configuration or ceedling changes, make sure these guys get rebuilt
-    mocks_list.each do |mock_filepath|
-      @rake_wrapper[mock_filepath].enhance( [@configurator.project_test_force_rebuild_filepath] ) if (@project_config_manager.test_config_changed ||
-        @project_config_manager.test_defines_changed)
-      @rake_wrapper[mock_filepath].enhance( @configurator.cmock_unity_helper )                    if (@configurator.cmock_unity_helper)
-    end
-  end
-
-
-  def enhance_dependencies_dependencies(dependencies)
-    dependencies.each do |dependencies_filepath|
-      @rake_wrapper[dependencies_filepath].enhance( [@configurator.project_test_force_rebuild_filepath] ) if (@project_config_manager.test_config_changed ||
-        @project_config_manager.test_defines_changed)
-    end
-  end
-
-
-  def enhance_test_build_object_dependencies(objects)
-    objects.each do |object_filepath|
-      @rake_wrapper[object_filepath].enhance( [@configurator.project_test_force_rebuild_filepath] ) if (@project_config_manager.test_config_changed ||
-        @project_config_manager.test_defines_changed)
-    end
-  end
-
-
-  def enhance_results_dependencies(result_filepath)
-    @rake_wrapper[result_filepath].enhance( [@configurator.project_test_force_rebuild_filepath] ) if @project_config_manager.test_config_changed
-  end
-
-
-  def enhance_test_executable_dependencies(test, objects)
-    @rake_wrapper[ @file_path_utils.form_test_executable_filepath(test) ].enhance( objects )
-  end
-
 end

data/lib/ceedling/encodinator.rb

@@ -0,0 +1,26 @@
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-25 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,9 +1,16 @@
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
+
 require 'erb'
 
 class ErbWrapper
   def generate_file(template, data, output_file)
     File.open(output_file, "w") do |f|
-      f << ERB.new(template, 0, "<>").result(binding)
+      f << ERB.new(template, trim_mode: "<>").result(binding)
     end
   end
 end

data/lib/ceedling/exceptions.rb

@@ -0,0 +1,47 @@
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
+
+require 'ceedling/constants'
+
+
+class CeedlingException < RuntimeError
+  # Nothing at the moment
+end
+
+
+class ShellException < CeedlingException
+
+  attr_reader :shell_result
+
+  def initialize(shell_result:{}, name:, message:'')
+    @shell_result = shell_result
+
+    _message = ''
+    
+    # Most shell exceptions will be from build compilation and linking.
+    # The formatting of these messages should place the tool output on its own
+    # lines without any other surrounding characters.
+    # This formatting maximizes the ability of IDEs to parse, highlight, and make 
+    # actionable the build errors that appear within their terminal windows.
+
+    # If shell results exist, report the exit code...
+    if !shell_result.empty?
+      _message = "#{name} terminated with exit code [#{shell_result[:exit_code]}]"
+
+      if !shell_result[:output].empty?
+        _message += " and output >>\n#{shell_result[:output].strip()}"
+      end
+
+    # Otherwise, just report the exception message
+    else
+      _message = "#{name} encountered an error with output >>\n#{message}"
+    end
+
+    # Hand the message off to parent Exception
+    super( _message )
+  end
+end

data/lib/ceedling/file_finder.rb

@@ -1,149 +1,183 @@
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
+
 require 'rubygems'
 require 'rake' # for adding ext() method to string
-require 'thread'
-
+require 'ceedling/exceptions'
 
 class FileFinder
-  SEMAPHORE = Mutex.new
 
   constructor :configurator, :file_finder_helper, :cacheinator, :file_path_utils, :file_wrapper, :yaml_wrapper
 
-  def prepare_search_sources
-    @all_test_source_and_header_file_collection =
-      @configurator.collection_all_tests +
-      @configurator.collection_all_source +
-      @configurator.collection_all_headers
-  end
 
+  def find_header_input_for_mock(mock_name)
+    # Mock name => <mock prefix><header filename without extension>
+    # Examples: 'Mockfoo' or 'mock_Bar'
+    # Note: In some rare cases, a mock name may include a dot (ex. Sensor.44) because of versioning file naming convention
+    #       Be careful about assuming the end of the name has any sort of file extension
 
-  def find_header_file(mock_file)
-    header = File.basename(mock_file).sub(/#{@configurator.cmock_mock_prefix}/, '').ext(@configurator.extension_header)
+    header = mock_name.sub(/#{@configurator.cmock_mock_prefix}/, '') + @configurator.extension_header
 
-    found_path = @file_finder_helper.find_file_in_collection(header, @configurator.collection_all_headers, :error)
+    found_path = @file_finder_helper.find_file_in_collection(header, @configurator.collection_all_headers, :error, mock_name)
 
     return found_path
   end
 
 
-  def find_header_input_for_mock_file(mock_file)
-    found_path = find_header_file(mock_file)
-    mock_input = found_path
-
-    if (@configurator.project_use_test_preprocessor)
-      mock_input = @cacheinator.diff_cached_test_file( @file_path_utils.form_preprocessed_file_filepath( found_path ) )
-    end
+  # Find test filepath from another filepath (e.g. test executable with same base name, a/path/test_foo.exe)
+  def find_test_file_from_filepath(filepath)
+    # Strip filepath down to filename and remove file extension
+    name = File.basename( filepath ).ext('')
 
-    return mock_input
+    return find_test_file_from_name( name )
   end
 
 
-  def find_source_from_test(test, complain)
-    test_prefix  = @configurator.project_test_file_prefix
-    source_paths = @configurator.collection_all_source
-
-    source = File.basename(test).sub(/#{test_prefix}/, '')
-
-    # we don't blow up if a test file has no corresponding source file
-    return @file_finder_helper.find_file_in_collection(source, source_paths, complain)
-  end
-
+  # Find test filepath from only the base name of a test file (e.g. 'test_foo')
+  def find_test_file_from_name(name)
+    test_file = name + @configurator.extension_source
 
-  def find_test_from_runner_path(runner_path)
-    extension_source = @configurator.extension_source
-
-    test_file = File.basename(runner_path).sub(/#{@configurator.test_runner_file_suffix}#{'\\'+extension_source}/, extension_source)
-
-    found_path = @file_finder_helper.find_file_in_collection(test_file, @configurator.collection_all_tests, :error)
+    found_path = @file_finder_helper.find_file_in_collection(test_file, @configurator.collection_all_tests, :error, name)
 
     return found_path
   end
 
 
-  def find_test_input_for_runner_file(runner_path)
-    found_path   = find_test_from_runner_path(runner_path)
-    runner_input = found_path
-
-    if (@configurator.project_use_test_preprocessor)
-      runner_input = @cacheinator.diff_cached_test_file( @file_path_utils.form_preprocessed_file_filepath( found_path ) )
-    end
-
-    return runner_input
-  end
-
+  def find_build_input_file(filepath:, complain: :error, context:)
+    release = (context == RELEASE_SYM)
 
-  def find_test_from_file_path(file_path)
-    test_file = File.basename(file_path).ext(@configurator.extension_source)
+    found_file = nil
 
-    found_path = @file_finder_helper.find_file_in_collection(test_file, @configurator.collection_all_tests, :error)
+    # Strip off file extension
+    source_file = File.basename(filepath).ext('')
 
-    return found_path
-  end
+    # We only collect files that already exist when we start up.
+    # FileLists can produce undesired results for dynamically generated files depending on when they're accessed.
+    # So collect mocks and runners separately and right now.
+    # Assume that project configuration options will have already filtered out any files that should not be searched for.
+
+    # Note: We carefully add file extensions below with string addition instead of using .ext()
+    #       Some legacy files can include naming conventions like <name>.##.<ext> for versioning.
+    #       If we use .ext() below we'll clobber the dotted portion of the filename
+
+    # Generated test runners
+    if (!release) and (source_file =~ /^#{@configurator.project_test_file_prefix}.+#{@configurator.test_runner_file_suffix}$/)
+      _source_file = source_file + EXTENSION_CORE_SOURCE
+      found_file =
+        @file_finder_helper.find_file_in_collection(
+          _source_file,
+          @file_wrapper.directory_listing( File.join(@configurator.project_test_runners_path, '*') ),
+          complain,
+          filepath)
+
+    # Generated mocks
+    elsif (!release) and (source_file =~ /^#{@configurator.cmock_mock_prefix}/)
+      _source_file = source_file + EXTENSION_CORE_SOURCE
+      found_file =
+        @file_finder_helper.find_file_in_collection(
+          _source_file,
+          @file_wrapper.directory_listing( File.join(@configurator.cmock_mock_path, '**/*') ),
+          complain,
+          filepath)
+
+    # Vendor framework sources (unity.c, cmock.c, cexception.c, etc.)
+    # Note: Taking a small chance by mixing test and release frameworks without smart checks on test/release build
+    elsif (@configurator.collection_vendor_framework_sources.include?(source_file.ext(EXTENSION_CORE_SOURCE)))
+      _source_file = source_file + EXTENSION_CORE_SOURCE
+      found_file =
+        @file_finder_helper.find_file_in_collection(
+          _source_file,
+          @configurator.collection_existing_test_build_input,
+          complain,
+          filepath)
 
+    end
 
-  def find_test_or_source_or_header_file(file_path)
-    file = File.basename(file_path)
-    return @file_finder_helper.find_file_in_collection(file, @all_test_source_and_header_file_collection, :error)
-  end
+    if !found_file.nil?
+      return found_file
+    end
 
+    #
+    # Above we can confidently rely on the complain parameter passed to file_finder_helper because
+    # we know the specific type of file being searched for.
+    #
+    # Below we ignore file misses because of lgoical complexities of searching for potentially either 
+    # assmebly or C files, including C files that may not exist (counterparts to header files by convention).
+    # We save the existence handling until the end.
+    #
+
+    # Assembly files for release build 
+    if release and @configurator.release_build_use_assembly
+      _source_file = source_file + @configurator.extension_assembly
+      found_file =
+        @file_finder_helper.find_file_in_collection(
+          _source_file,
+          @configurator.collection_release_build_input,
+          :ignore,
+          filepath)
+
+    # Assembly files for test build 
+    elsif (!release) and @configurator.test_build_use_assembly
+      _source_file = source_file + @configurator.extension_assembly
+      found_file =
+        @file_finder_helper.find_file_in_collection(
+          _source_file,
+          @configurator.collection_existing_test_build_input,
+          :ignore,
+          filepath)
+    end
 
-  def find_compilation_input_file(file_path, complain=:error, release=false)
-    found_file = nil
+    if !found_file.nil?
+        return found_file
+    end
 
-    source_file = File.basename(file_path).ext(@configurator.extension_source)
+    # Release build C files
+    if release
+      _source_file = source_file + @configurator.extension_source
+      found_file =
+        @file_finder_helper.find_file_in_collection(
+          _source_file,
+          @configurator.collection_release_build_input,
+          :ignore,
+          filepath)
+        
+    # Test build C files
+    else
+      _source_file = source_file + @configurator.extension_source
+      found_file =
+        @file_finder_helper.find_file_in_collection(
+          _source_file,
+          @configurator.collection_existing_test_build_input,
+          :ignore,
+          filepath)
+    end
 
-    # We only collect files that already exist when we start up.
-    # FileLists can produce undesired results for dynamically generated files depending on when they're accessed.
-    # So collect mocks and runners separately and right now.
+    if found_file.nil?
+      _source_file += " or #{_source_file.ext(@configurator.extension_assembly)}" if @configurator.release_build_use_assembly
+      @file_finder_helper.handle_missing_file(_source_file, complain)
+    end
 
-    SEMAPHORE.synchronize {
-
-      if (source_file =~ /#{@configurator.test_runner_file_suffix}/)
-        found_file =
-          @file_finder_helper.find_file_in_collection(
-            source_file,
-            @file_wrapper.directory_listing( File.join(@configurator.project_test_runners_path, '*') ),
-            complain)
-
-      elsif (@configurator.project_use_mocks and (source_file =~ /#{@configurator.cmock_mock_prefix}/))
-        found_file =
-          @file_finder_helper.find_file_in_collection(
-            source_file,
-            @file_wrapper.directory_listing( File.join(@configurator.cmock_mock_path, '*') ),
-            complain)
-
-      elsif release
-        found_file =
-          @file_finder_helper.find_file_in_collection(
-            source_file,
-            @configurator.collection_release_existing_compilation_input,
-            complain)
-      else
-        temp_complain = (defined?(TEST_BUILD_USE_ASSEMBLY) && TEST_BUILD_USE_ASSEMBLY) ? :ignore : complain
-        found_file =
-          @file_finder_helper.find_file_in_collection(
-            source_file,
-            @configurator.collection_all_existing_compilation_input,
-            temp_complain)
-        found_file ||= find_assembly_file(file_path, false) if (defined?(TEST_BUILD_USE_ASSEMBLY) && TEST_BUILD_USE_ASSEMBLY)
-      end
-    }
     return found_file
   end
 
 
-  def find_source_file(file_path, complain)
-    source_file = File.basename(file_path).ext(@configurator.extension_source)
-    return @file_finder_helper.find_file_in_collection(source_file, @configurator.collection_all_source, complain)
+  def find_source_file(filepath, complain = :error)
+    source_file = File.basename(filepath).ext(@configurator.extension_source)
+    return @file_finder_helper.find_file_in_collection(source_file, @configurator.collection_all_source, complain, filepath)
   end
 
 
-  def find_assembly_file(file_path, complain = :error)
-    assembly_file = File.basename(file_path).ext(@configurator.extension_assembly)
-    return @file_finder_helper.find_file_in_collection(assembly_file, @configurator.collection_all_assembly, complain)
+  def find_assembly_file(filepath, complain = :error)
+    assembly_file = File.basename(filepath).ext(@configurator.extension_assembly)
+    return @file_finder_helper.find_file_in_collection(assembly_file, @configurator.collection_all_assembly, complain, filepath)
   end
 
-  def find_file_from_list(file_path, file_list, complain)
-    return @file_finder_helper.find_file_in_collection(file_path, file_list, complain)
+  def find_file_from_list(filepath, file_list, complain)
+    return @file_finder_helper.find_file_in_collection(filepath, file_list, complain, filepath)
   end
 end