ceedling 0.31.1 → 1.0.1

data/lib/ceedling/task_invoker.rb

@@ -1,15 +1,23 @@
-require 'ceedling/par_map'
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
 
 class TaskInvoker
 
   attr_accessor :first_run
 
-  constructor :dependinator, :rake_utils, :rake_wrapper, :project_config_manager
+  constructor :dependinator, :build_batchinator, :rake_utils, :rake_wrapper
 
   def setup
     @test_regexs = [/^#{TEST_ROOT_NAME}:/]
     @release_regexs = [/^#{RELEASE_ROOT_NAME}(:|$)/]
     @first_run = true
+
+    # Alias for brevity
+    @batchinator = @build_batchinator
   end
   
   def add_test_task_regex(regex)
@@ -46,75 +54,15 @@ class TaskInvoker
     return @rake_utils.task_invoked?(regex)
   end
 
-  def reset_rake_task_for_changed_defines(file)
-    if !(file =~ /#{VENDORS_FILES.map{|ignore| '\b' + ignore.ext(File.extname(file)) + '\b'}.join('|')}$/)
-      @rake_wrapper[file].clear_actions if @first_run == false && @project_config_manager.test_defines_changed
-      @rake_wrapper[file].reenable if @first_run == false && @project_config_manager.test_defines_changed
+  def invoke_test_objects(test:, objects:)
+    @batchinator.exec(workload: :compile, things: objects) do |object|
+      # Encode context with concatenated compilation target: <test name>+<object file>
+      @rake_wrapper["#{test}+#{object}"].invoke
     end
   end
 
-  def invoke_test_mocks(mocks)
-    @dependinator.enhance_mock_dependencies( mocks )
-    mocks.each { |mock|
-      reset_rake_task_for_changed_defines( mock )
-      @rake_wrapper[mock].invoke
-    }
-  end
-  
-  def invoke_test_runner(runner)
-    @dependinator.enhance_runner_dependencies( runner )
-    reset_rake_task_for_changed_defines( runner )
-    @rake_wrapper[runner].invoke
-  end
-
-  def invoke_test_shallow_include_lists(files)
-    @dependinator.enhance_shallow_include_lists_dependencies( files )
-    par_map(PROJECT_COMPILE_THREADS, files) do |file|
-      reset_rake_task_for_changed_defines( file )
-      @rake_wrapper[file].invoke
-    end
-  end
-
-  def invoke_test_preprocessed_files(files)
-    @dependinator.enhance_preprocesed_file_dependencies( files )
-    par_map(PROJECT_COMPILE_THREADS, files) do |file|
-      reset_rake_task_for_changed_defines( file )
-      @rake_wrapper[file].invoke
-    end
-  end
-
-  def invoke_test_dependencies_files(files)
-    @dependinator.enhance_dependencies_dependencies( files )
-    par_map(PROJECT_COMPILE_THREADS, files) do |file|
-      reset_rake_task_for_changed_defines( file )
-      @rake_wrapper[file].invoke
-    end
-  end
-
-  def invoke_test_objects(objects)
-    par_map(PROJECT_COMPILE_THREADS, objects) do |object|
-      reset_rake_task_for_changed_defines( object )
-      @rake_wrapper[object].invoke
-    end
-  end
-
-  def invoke_test_executable(file)
-    @rake_wrapper[file].invoke
-  end
-
-  def invoke_test_results(result)
-    @dependinator.enhance_results_dependencies( result )
-    @rake_wrapper[result].invoke
-  end
-
-  def invoke_release_dependencies_files(files)
-    par_map(PROJECT_COMPILE_THREADS, files) do |file|
-      @rake_wrapper[file].invoke
-    end
-  end
-  
   def invoke_release_objects(objects)
-    par_map(PROJECT_COMPILE_THREADS, objects) do |object|
+    @batchinator.exec(workload: :compile, things: objects) do |object|
       @rake_wrapper[object].invoke
     end
   end

data/lib/ceedling/tasks_base.rake

@@ -1,44 +1,25 @@
+# =========================================================================
+#   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'
 require 'ceedling/file_path_utils'
-require 'ceedling/version'
-
-desc "Display build environment version info."
-task :version do
-  puts "   Ceedling:: #{Ceedling::Version::CEEDLING}"
-  puts "      Unity:: #{Ceedling::Version::UNITY}"
-  puts "      CMock:: #{Ceedling::Version::CMOCK}"
-  puts " CException:: #{Ceedling::Version::CEXCEPTION}"
-end
-
-desc "Set verbose output (silent:[#{Verbosity::SILENT}] - obnoxious:[#{Verbosity::OBNOXIOUS}])."
-task :verbosity, :level do |t, args|
-  verbosity_level = args.level.to_i
 
-  if (PROJECT_USE_MOCKS)
-    # don't store verbosity level in setupinator's config hash, use a copy;
-    # otherwise, the input configuration will change and trigger entire project rebuilds
-    hash = @ceedling[:setupinator].config_hash[:cmock].clone
-    hash[:verbosity] = verbosity_level
-
-    @ceedling[:cmock_builder].manufacture( hash )
+# Set Rake verbosity using global constant verbosity set before Rake is loaded
+if !!defined?(PROJECT_VERBOSITY)
+  verbose(PROJECT_VERBOSITY >= Verbosity::OBNOXIOUS)
+  if PROJECT_VERBOSITY >= Verbosity::OBNOXIOUS
+    Rake.application.options.silent = false
+    Rake.application.options.suppress_backtrace_pattern = nil
   end
-
-  @ceedling[:configurator].project_verbosity = verbosity_level
-
-  # control rake's verbosity with new setting
-  verbose( ((verbosity_level >= Verbosity::OBNOXIOUS) ? true : false) )
 end
 
-desc "Enable logging"
-task :logging do
-  @ceedling[:configurator].project_logging = true
-end
-
-# non advertised debug task
+# Non-advertised debug task
 task :debug do
-  Rake::Task[:verbosity].invoke(Verbosity::DEBUG)
   Rake.application.options.trace = true
-  @ceedling[:configurator].project_debug = true
 end
 
 # non advertised sanity checking task
@@ -47,65 +28,7 @@ task :sanity_checks, :level do |t, args|
   @ceedling[:configurator].sanity_checks = check_level
 end
 
-# non advertised catch for calling upgrade in the wrong place
-task :upgrade do
-  puts "WARNING: You're currently IN your project directory. Take a step out and try"
-  puts "again if you'd like to perform an upgrade."
-end
-
-# list expanded environment variables
-if (not ENVIRONMENT.empty?)
-desc "List all configured environment variables."
-task :environment do
-  env_list = []
-  ENVIRONMENT.each do |env|
-    env.each_key do |key|
-      name = key.to_s.upcase
-	  env_list.push(" - #{name}: \"#{env[key]}\"")
-    end
-  end
-  env_list.sort.each do |env_line|
-	puts env_line
-  end
-end
-end
-
-namespace :options do
-
-  COLLECTION_PROJECT_OPTIONS.each do |option_path|
-    option = File.basename(option_path, '.yml')
-
-    desc "Merge #{option} project options."
-    task option.to_sym do
-      hash = @ceedling[:project_config_manager].merge_options( @ceedling[:setupinator].config_hash, option_path )
-      @ceedling[:setupinator].do_setup( hash )
-      if @ceedling[:configurator].project_release_build
-        load(File.join(CEEDLING_LIB, 'ceedling', 'rules_release.rake'))
-      end
-    end
-  end
-
-  # This is to give nice errors when typing options
-  rule /^options:.*/ do |t, args|
-    filename = t.to_s.split(':')[-1] + '.yml'
-    filelist = COLLECTION_PROJECT_OPTIONS.map{|s| File.basename(s) }
-    @ceedling[:file_finder].find_file_from_list(filename, filelist, :error)
-  end
-
-  # This will output the fully-merged tools options to their own project.yml file
-  desc "Export tools options to a new project file"
-  task :export, :filename do |t, args|
-    outfile = args.filename || 'tools.yml'
-    toolcfg = {}
-    @ceedling[:configurator].project_config_hash.each_pair do |k,v|
-      toolcfg[k] = v if (k.to_s[0..5] == 'tools_')
-    end
-    File.open(outfile,'w') {|f| f << toolcfg.to_yaml({:indentation => 2})}
-  end
-end
-
-
-# do not present task if there's no plugins
+# Do not present task if there's no plugins
 if (not PLUGINS_ENABLED.empty?)
 desc "Execute plugin result summaries (no build triggering)."
 task :summary do

data/lib/ceedling/tasks_filesystem.rake

@@ -1,3 +1,9 @@
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
 
 # rather than require 'rake/clean' & try to override, we replicate for finer control
 CLEAN   = Rake::FileList["**/*~", "**/*.bak"]
@@ -16,13 +22,12 @@ CLOBBER.include(File.join(PROJECT_BUILD_ARTIFACTS_ROOT, '**/*'))
 CLOBBER.include(File.join(PROJECT_BUILD_TESTS_ROOT, '**/*'))
 CLOBBER.include(File.join(PROJECT_BUILD_RELEASE_ROOT, '**/*'))
 CLOBBER.include(File.join(PROJECT_LOG_PATH, '**/*'))
-CLOBBER.include(File.join(PROJECT_TEMP_PATH, '**/*'))
 
 # just in case they're using git, let's make sure we allow them to preserved the build directory if desired.
 CLOBBER.exclude(File.join(TESTS_BASE_PATH), '**/.gitkeep')
 
 # because of cmock config, mock path can optionally exist apart from standard test build paths
-CLOBBER.include(File.join(CMOCK_MOCK_PATH, '*'))
+CLOBBER.include(File.join(CMOCK_MOCK_PATH, '*')) if PROJECT_USE_MOCKS
 
 REMOVE_FILE_PROC = Proc.new { |fn| rm_r fn rescue nil }
 
@@ -31,80 +36,61 @@ desc "Delete all build artifacts and temporary products."
 task(:clean) do
   # because :clean is a prerequisite for :clobber, intelligently display the progress message
   if (not @ceedling[:task_invoker].invoked?(/^clobber$/))
-    @ceedling[:streaminator].stdout_puts("\nCleaning build artifacts...\n(For large projects, this task may take a long time to complete)\n\n")
-  end
-  begin
-    CLEAN.each { |fn| REMOVE_FILE_PROC.call(fn) }
-  rescue
+    @ceedling[:loginator].log("\nCleaning build artifacts...\n(For large projects, this task may take a long time to complete)\n\n")
   end
+  CLEAN.each { |fn| REMOVE_FILE_PROC.call(fn) }
 end
 
 # redefine clobber so we can override how it advertises itself
 desc "Delete all generated files (and build artifacts)."
 task(:clobber => [:clean]) do
-  @ceedling[:streaminator].stdout_puts("\nClobbering all generated files...\n(For large projects, this task may take a long time to complete)\n\n")
-  begin
-    CLOBBER.each { |fn| REMOVE_FILE_PROC.call(fn) }
-    @ceedling[:rake_wrapper][:directories].invoke
-    @ceedling[:dependinator].touch_force_rebuild_files
-  rescue
-  end
+  @ceedling[:loginator].log("\nClobbering all generated files...\n(For large projects, this task may take a long time to complete)\n\n")
+  CLOBBER.each { |fn| REMOVE_FILE_PROC.call(fn) }
 end
 
 # create a directory task for each of the paths, so we know how to build them
 PROJECT_BUILD_PATHS.each { |path| directory(path) }
 
+# create a single prepare task which collects all release and test prerequisites
+task :prepare => [:directories]
+
 # create a single directory task which verifies all the others get built
 task :directories => PROJECT_BUILD_PATHS
 
-# when the force file doesn't exist, it probably means we clobbered or are on a fresh
-# install. In either case, stuff was deleted, so assume we want to rebuild it all
-file @ceedling[:configurator].project_test_force_rebuild_filepath do
-  unless File.exists?(@ceedling[:configurator].project_test_force_rebuild_filepath)
-    @ceedling[:dependinator].touch_force_rebuild_files
-  end
-end
-
 # list paths discovered at load time
 namespace :paths do
-  standard_paths = ['test','source','include']
+  standard_paths = ['test', 'source', 'include', 'support']
+
   paths = @ceedling[:setupinator].config_hash[:paths].keys.map{|n| n.to_s.downcase}
-  paths = (paths + standard_paths).uniq
+  
   paths.each do |name|
-    path_list = Object.const_get("COLLECTION_PATHS_#{name.upcase}")
-
-    if (path_list.size != 0) || (standard_paths.include?(name))
-      desc "List all collected #{name} paths."
-      task(name.to_sym) { puts "#{name} paths:"; path_list.sort.each {|path| puts " - #{path}" } }
+    desc "List all collected #{name} paths." if standard_paths.include?(name)
+    task(name.to_sym) do
+      path_list = Object.const_get("COLLECTION_PATHS_#{name.upcase}")
+      puts "#{name.capitalize} paths:#{' None' if path_list.size == 0}"
+      if path_list.size > 0
+        path_list.sort.each {|path| puts " - #{path}" }
+        puts "Path count: #{path_list.size}"
+      end
     end
   end
-
 end
 
 
 # list files & file counts discovered at load time
 namespace :files do
-
-  categories = [
-    ['test',    COLLECTION_ALL_TESTS],
-    ['source',  COLLECTION_ALL_SOURCE],
-    ['include', COLLECTION_ALL_HEADERS],
-    ['support', COLLECTION_ALL_SUPPORT]
-  ]
-
-  using_assembly = (defined?(TEST_BUILD_USE_ASSEMBLY) && TEST_BUILD_USE_ASSEMBLY) ||
-                   (defined?(RELEASE_BUILD_USE_ASSEMBLY) && RELEASE_BUILD_USE_ASSEMBLY)
-  categories << ['assembly', COLLECTION_ALL_ASSEMBLY] if using_assembly
+  categories = ['tests', 'source', 'assembly', 'headers', 'support']
 
   categories.each do |category|
-    name       = category[0]
-    collection = category[1]
-
-    desc "List all collected #{name} files."
-    task(name.to_sym) do
-      puts "#{name} files:"
-      collection.sort.each { |filepath| puts " - #{filepath}" }
-      puts "file count: #{collection.size}"
+    desc "List all collected #{category.chomp('s')} files."
+    task(category.chomp('s').to_sym) do
+      files_list = Object.const_get("COLLECTION_ALL_#{category.upcase}")
+      puts "#{category.chomp('s').capitalize} files:#{' None' if files_list.size == 0}"
+      if files_list.size > 0
+        files_list.sort.each { |filepath| puts " - #{filepath}" }
+        puts "File count: #{files_list.size}"
+        puts "Note: This list sourced only from your project file, not from any build directive macros in test files."
+      end
     end
   end
 

data/lib/ceedling/tasks_release.rake

@@ -1,30 +1,43 @@
+# =========================================================================
+#   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'
 require 'ceedling/file_path_utils'
 
 
 desc "Build release target."
-task RELEASE_SYM => [:directories] do
-  header = "Release build '#{File.basename(PROJECT_RELEASE_BUILD_TARGET)}'"
-  @ceedling[:streaminator].stdout_puts("\n\n#{header}\n#{'-' * header.length}")  
+task RELEASE_SYM => [:prepare] do
+  header = "Release build '#{File.basename( PROJECT_RELEASE_BUILD_TARGET )}'"
+
+  banner = @ceedling[:reportinator].generate_banner( header )
+
+  @ceedling[:loginator].log( banner )
   
   begin
     @ceedling[:plugin_manager].pre_release
 
     core_objects  = []
-    extra_objects = @ceedling[:file_path_utils].form_release_build_c_objects_filelist( COLLECTION_RELEASE_ARTIFACT_EXTRA_LINK_OBJECTS )
+    extra_objects = @ceedling[:file_path_utils].form_release_build_objects_filelist( COLLECTION_RELEASE_ARTIFACT_EXTRA_LINK_OBJECTS )
 
-    @ceedling[:project_config_manager].process_release_config_change
-    core_objects.concat( @ceedling[:release_invoker].setup_and_invoke_c_objects( COLLECTION_ALL_SOURCE ) )
-  
-    # if assembler use isn't enabled, COLLECTION_ALL_ASSEMBLY is empty array & nothing happens
-    core_objects.concat( @ceedling[:release_invoker].setup_and_invoke_asm_objects( COLLECTION_ALL_ASSEMBLY ) )
+    core_objects.concat( @ceedling[:release_invoker].setup_and_invoke_objects( COLLECTION_RELEASE_BUILD_INPUT ) )
   
-    # if we're using libraries, we need to add those to our collection as well
+    # If we're using libraries, we need to add those to our collection as well
     library_objects = (defined? LIBRARIES_RELEASE && !LIBRARIES_RELEASE.empty?) ? LIBRARIES_RELEASE.flatten.compact : []
     file( PROJECT_RELEASE_BUILD_TARGET => (core_objects + extra_objects + library_objects) )
-    Rake::Task[PROJECT_RELEASE_BUILD_TARGET].invoke
+    Rake::Task[PROJECT_RELEASE_BUILD_TARGET].invoke()
+
+  rescue StandardError => ex
+    @ceedling[:application].register_build_failure
+
+    @ceedling[:loginator].log( ex.message, Verbosity::ERRORS, LogLabels::EXCEPTION )
+
+    # Debug backtrace (only if debug verbosity)
+    @ceedling[:loginator].log_debug_backtrace( ex )
   ensure
     @ceedling[:plugin_manager].post_release  
   end
 end
-

data/lib/ceedling/tasks_tests.rake

@@ -1,60 +1,69 @@
-require 'ceedling/constants'
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
 
-task :test_deps => [:directories]
+require 'ceedling/constants'
 
-task :test => [:test_deps] do
+task :test => [:prepare] do
   Rake.application['test:all'].invoke
 end
 
 namespace TEST_SYM do
 
+  TOOL_COLLECTION_TEST_TASKS = {
+    :test_compiler  => TOOLS_TEST_COMPILER,
+    :test_assembler => TOOLS_TEST_ASSEMBLER,
+    :test_linker    => TOOLS_TEST_LINKER,
+    :test_fixture   => TOOLS_TEST_FIXTURE
+  }
+
   desc "Run all unit tests (also just 'test' works)."
-  task :all => [:test_deps] do
-    @ceedling[:test_invoker].setup_and_invoke(COLLECTION_ALL_TESTS)
+  task :all => [:prepare] do
+    @ceedling[:test_invoker].setup_and_invoke(
+      tests:COLLECTION_ALL_TESTS,
+      options:{:force_run => true, :build_only => false}.merge(TOOL_COLLECTION_TEST_TASKS))
   end
 
-  desc "Run single test ([*] real test or source file name, no path)."
+  desc "Run single test ([*] test or source file name, no path)."
   task :* do
-    message = "\nOops! '#{TEST_ROOT_NAME}:*' isn't a real task. " +
+    message = "Oops! '#{TEST_ROOT_NAME}:*' isn't a real task. " +
               "Use a real test or source file name (no path) in place of the wildcard.\n" +
-              "Example: rake #{TEST_ROOT_NAME}:foo.c\n\n"
-
-    @ceedling[:streaminator].stdout_puts( message )
-  end
+              "Example: `ceedling #{TEST_ROOT_NAME}:foo.c`"
 
-  desc "Run tests for changed files."
-  task :delta => [:test_deps] do
-    @ceedling[:test_invoker].setup_and_invoke(COLLECTION_ALL_TESTS, TEST_SYM, {:force_run => false})
+    @ceedling[:loginator].log( message, Verbosity::ERRORS )
   end
 
   desc "Just build tests without running."
-  task :build_only => [:test_deps] do
-    @ceedling[:test_invoker].setup_and_invoke(COLLECTION_ALL_TESTS, TEST_SYM, {:build_only => true})
+  task :build_only => [:prepare] do
+    @ceedling[:test_invoker].setup_and_invoke(tests:COLLECTION_ALL_TESTS, options:{:build_only => true}.merge(TOOL_COLLECTION_TEST_TASKS))
   end
 
   desc "Run tests by matching regular expression pattern."
-  task :pattern, [:regex] => [:test_deps] do |t, args|
+  task :pattern, [:regex] => [:prepare] do |t, args|
     matches = []
 
     COLLECTION_ALL_TESTS.each { |test| matches << test if (test =~ /#{args.regex}/) }
 
     if (matches.size > 0)
-      @ceedling[:test_invoker].setup_and_invoke(matches, TEST_SYM, {:force_run => false})
+      @ceedling[:test_invoker].setup_and_invoke(tests:matches, options:{:force_run => false}.merge(TOOL_COLLECTION_TEST_TASKS))
     else
-      @ceedling[:streaminator].stdout_puts("\nFound no tests matching pattern /#{args.regex}/.")
+      @ceedling[:loginator].log( "Found no tests matching pattern /#{args.regex}/", Verbosity::ERRORS )
     end
   end
 
   desc "Run tests whose test path contains [dir] or [dir] substring."
-  task :path, [:dir] => [:test_deps] do |t, args|
+  task :path, [:dir] => [:prepare] do |t, args|
     matches = []
 
     COLLECTION_ALL_TESTS.each { |test| matches << test if File.dirname(test).include?(args.dir.gsub(/\\/, '/')) }
 
     if (matches.size > 0)
-      @ceedling[:test_invoker].setup_and_invoke(matches, TEST_SYM, {:force_run => false})
+      @ceedling[:test_invoker].setup_and_invoke(tests:matches, options:{:force_run => false}.merge(TOOL_COLLECTION_TEST_TASKS))
     else
-      @ceedling[:streaminator].stdout_puts("\nFound no tests including the given path or path component.")
+      @ceedling[:loginator].log( "Found no tests including the given path or path component", Verbosity::ERRORS )
     end
   end