ceedling 0.27.0 → 0.28.1

data/config/test_environment.rb

@@ -5,7 +5,6 @@
   'test',
   'vendor/behaviors/lib',
   'vendor/hardmock/lib',
-  'vendor/constructor/lib',
   'vendor/deep_merge/lib',
 ].each do |dir|
   $LOAD_PATH.unshift( File.join( File.expand_path(File.dirname(__FILE__) + "/../"), dir) )

data/examples/blinky/project.yml

@@ -14,7 +14,7 @@
 #You'll have to specify these
 :environment:
   - :mcu: atmega328p
-  - :f_cpu: 16000000UL 
+  - :f_cpu: 16000000UL
   - :serial_port: COM8  #change this to the serial port you are using!!!
   - :objcopy: avr-objcopy
   # Uncomment these lines if you are using windows and don't have these tools in your path

data/examples/temp_sensor/project.yml

@@ -60,11 +60,17 @@
 :tools_test_linker:
   :arguments:
     - -lm
+:tools_gcov_linker:
+  :arguments:
+    - -lm
+#:gcov:
+#  :html_report_type: basic
 
 :plugins:
   :load_paths:
     - vendor/ceedling/plugins
   :enabled:
     - stdout_pretty_tests_report
-    #- stdout_ide_tests_report
+    - module_generator
+    - gcov
 ...

data/examples/temp_sensor/rakefile.rb

@@ -1,4 +1,6 @@
 PROJECT_CEEDLING_ROOT = "vendor/ceedling"
-load "#{PROJECT_CEEDLING_ROOT}/lib/ceedling/rakefile.rb"
+load "#{PROJECT_CEEDLING_ROOT}/lib/ceedling.rb"
+
+Ceedling.load_project
 
 task :default => %w[ test:all release ]

data/lib/ceedling/build_invoker_utils.rb

@@ -1,10 +1,22 @@
 require 'ceedling/constants'
 
-
+##
+# Utilities for raiser and reporting errors during building.
 class BuildInvokerUtils
 
   constructor :configurator, :streaminator
-  
+ 
+  ##
+  # Processes exceptions and tries to display a useful message for the user.
+  #
+  # ==== Attriboops...utes
+  #
+  # * _exception_:  The exception given by a rescue statement.
+  # * _context_:    A symbol representing where in the build the exception
+  # occurs. 
+  # * _test_build_: A bool to signify if the exception occurred while building
+  # from test or source.
+  #
   def process_exception(exception, context, test_build=true)
     if (exception.message =~ /Don't know how to build task '(.+)'/i)
       error_header  = "ERROR: Rake could not find file referenced in source"

data/lib/ceedling/configurator.rb

@@ -107,7 +107,8 @@ class Configurator
     cmock[:unity_helper] = false                     if (cmock[:unity_helper].nil?)
 
     if (cmock[:unity_helper])
-      cmock[:includes] << File.basename(cmock[:unity_helper])
+      cmock[:unity_helper] = [cmock[:unity_helper]] if cmock[:unity_helper].is_a? String
+      cmock[:includes] += cmock[:unity_helper].map{|helper| File.basename(helper) }
       cmock[:includes].uniq!
     end
 
@@ -327,6 +328,7 @@ class Configurator
 
   def insert_rake_plugins(plugins)
     plugins.each do |plugin|
+      # TODO needs a duplicate guard
       @project_config_hash[:project_rakefile_component_files] << plugin
     end
   end

data/lib/ceedling/configurator_builder.rb

@@ -392,10 +392,12 @@ class ConfiguratorBuilder
 
     # if we're using mocks & a unity helper is defined & that unity helper includes a source file component (not only a header of macros),
     # then link in the unity_helper object file too
-    if ( in_hash[:project_use_mocks] and
-         in_hash[:cmock_unity_helper] and
-         @file_wrapper.exist?(in_hash[:cmock_unity_helper].ext(in_hash[:extension_source])) )
-      objects << File.basename(in_hash[:cmock_unity_helper])
+    if ( in_hash[:project_use_mocks] and in_hash[:cmock_unity_helper] )
+      in_hash[:cmock_unity_helper].each do |helper|
+        if @file_wrapper.exist?(helper.ext(in_hash[:extension_source]))
+          objects << File.basename(helper)
+        end
+      end
     end
 
     # no build paths here so plugins can remap if necessary (i.e. path mapping happens at runtime)

data/lib/ceedling/configurator_setup.rb

@@ -76,7 +76,11 @@ class ConfiguratorSetup
     validation = []
 
     validation << @configurator_validator.validate_filepath(config, :project, :build_root)
-    validation << @configurator_validator.validate_filepath(config, :cmock, :unity_helper) if config[:cmock][:unity_helper]
+    if config[:cmock][:unity_helper]
+      config[:cmock][:unity_helper].each do |path|
+        validation << @configurator_validator.validate_filepath_simple( path, :cmock, :unity_helper ) 
+      end
+    end
 
     config[:project][:options_paths].each do |path|
       validation << @configurator_validator.validate_filepath_simple( path, :project, :options_paths )

data/lib/ceedling/defaults.rb

@@ -183,6 +183,8 @@ DEFAULT_RELEASE_LINKER_TOOL = {
   :arguments => [
     "\"${1}\"".freeze,
     "-o \"${2}\"".freeze,
+    "".freeze,
+    "${4}".freeze
     ].freeze
   }
 
@@ -311,7 +313,8 @@ DEFAULT_CEEDLING_CONFIG = {
 
     :cmock => {
       :vendor_path => CEEDLING_VENDOR,
-      :defines => []
+      :defines => [],
+      :includes => []
     },
 
     :cexception => {
@@ -344,7 +347,7 @@ DEFAULT_CEEDLING_CONFIG = {
     :release_dependencies_generator => { :arguments => [] },
 
     :plugins => {
-      :load_paths => CEEDLING_PLUGINS,
+      :load_paths => [], #XXX this is injected twice as of now so removed til better handling is found CEEDLING_PLUGINS,
       :enabled => [],
     }
   }.freeze

data/lib/ceedling/dependinator.rb

@@ -52,7 +52,7 @@ class Dependinator
     # 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)
-      @rake_wrapper[mock_filepath].enhance( [@configurator.cmock_unity_helper] )                  if (@configurator.cmock_unity_helper)
+      @rake_wrapper[mock_filepath].enhance( @configurator.cmock_unity_helper )                    if (@configurator.cmock_unity_helper)
     end
   end
 

data/lib/ceedling/file_path_utils.rb

@@ -19,11 +19,10 @@ class FilePathUtils
 
   ######### class methods ##########
 
-  # standardize path to use '/' path separator & begin with './' & have no trailing path separator
+  # standardize path to use '/' path separator & have no trailing path separator
   def self.standardize(path)
     path.strip!
     path.gsub!(/\\/, '/')
-    path.gsub!(/^((\+|-):)?/, '')
     path.chomp!('/')
     return path
   end

data/lib/ceedling/generator_test_results.rb

@@ -1,7 +1,6 @@
 require 'rubygems'
 require 'rake' # for .ext()
 require 'ceedling/constants'
-
  
 class GeneratorTestResults
 
@@ -80,7 +79,9 @@ class GeneratorTestResults
     
     # collect up test results minus and extra output
     elements = (line.strip.split(':'))[1..-1]
-    return {:test => elements[1], :line => elements[0].to_i, :message => (elements[3..-1].join(':')).strip}, stdout
+
+    return {:test => elements[1], :line => elements[0].to_i, :message => (elements[3..-1].join(':')).strip}, stdout if elements.size >= 3
+    return {:test => '???', :line => -1, :message => nil} #fallback safe option. TODO better handling
   end
 
 end

data/lib/ceedling/generator_test_results_sanity_checker.rb

@@ -11,8 +11,9 @@ class GeneratorTestResultsSanityChecker
   
     # do no sanity checking if it's disabled
     return if (@configurator.sanity_checks == TestResultsSanityChecks::NONE)
-  
-    ceedling_ignores_count   = results[:ignores].size
+    raise "results nil or empty" if results.nil? || results.empty?
+
+    ceedling_ignores_count   = results[:ignores].size 
     ceedling_failures_count  = results[:failures].size
     ceedling_tests_summation = (ceedling_ignores_count + ceedling_failures_count + results[:successes].size)
 
@@ -45,7 +46,7 @@ class GeneratorTestResultsSanityChecker
 
   private
   
- def sanity_check_warning(file, message)
+  def sanity_check_warning(file, message)
     unless defined?(CEEDLING_IGNORE_SANITY_CHECK)
       notice = "\n" + 
                "ERROR: Internal sanity check for test fixture '#{file.ext(@configurator.extension_executable)}' finds that #{message}\n" +

data/lib/ceedling/project_file_loader.rb

@@ -9,9 +9,11 @@ class ProjectFileLoader
 
   def setup
     @main_file = nil
+    @mixin_files = []
     @user_file = nil
 
     @main_project_filepath = ''
+    @mixin_project_filepaths = []
     @user_project_filepath = ''
   end
 
@@ -26,6 +28,16 @@ class ProjectFileLoader
       @user_project_filepath = DEFAULT_CEEDLING_USER_PROJECT_FILE
     end
 
+    # next check for mixin project files by looking for environment variable
+    mixin_filepaths = @system_wrapper.env_get('CEEDLING_MIXIN_PROJECT_FILES')
+    if ( not mixin_filepaths.nil? )
+      mixin_filepaths.split(File::PATH_SEPARATOR).each do |filepath|
+        if ( @file_wrapper.exist?(filepath) )
+          @mixin_project_filepaths.push(filepath)
+        end
+      end
+    end
+
     # next check for main project file by looking for environment variable and then default location on disk;
     # blow up if we don't find this guy -- like, he's so totally important
     main_filepath = @system_wrapper.env_get('CEEDLING_MAIN_PROJECT_FILE')
@@ -42,6 +54,9 @@ class ProjectFileLoader
     end
 
     @main_file = File.basename( @main_project_filepath )
+    @mixin_project_filepaths.each do |filepath|
+      @mixin_files.push(File.basename( filepath ))
+    end
     @user_file = File.basename( @user_project_filepath ) if ( not @user_project_filepath.empty? )
   end
 
@@ -64,16 +79,18 @@ class ProjectFileLoader
   end
 
   def load_project_config
-    config_hash = {}
-    # if there's no user project file, then just provide hash from project file
-    if (@user_project_filepath.empty?)
-      config_hash = @yaml_wrapper.load(@main_project_filepath)
-    # if there is a user project file, load it too and merge it on top of the project file,
-    # superseding anything that's common between them
-    else
-      main_hash = @yaml_wrapper.load(@main_project_filepath)
+    config_hash = @yaml_wrapper.load(@main_project_filepath)
+
+    # if there are mixin project files, then use them
+    @mixin_project_filepaths.each do |filepath|
+      mixin = @yaml_wrapper.load(filepath)
+      config_hash = yaml_merger( config_hash, mixin )
+    end
+
+    # if there's a user project file, then use it
+    if ( not @user_project_filepath.empty? )
       user_hash = @yaml_wrapper.load(@user_project_filepath)
-      config_hash = yaml_merger( main_hash, user_hash )
+      config_hash = yaml_merger( config_hash, user_hash )
     end
 
     return config_hash

data/lib/ceedling/rakefile.rb

@@ -9,12 +9,14 @@ CEEDLING_RELEASE = File.join(CEEDLING_ROOT, 'release')
 $LOAD_PATH.unshift( CEEDLING_LIB )
 $LOAD_PATH.unshift( File.join(CEEDLING_VENDOR, 'unity/auto') )
 $LOAD_PATH.unshift( File.join(CEEDLING_VENDOR, 'diy/lib') )
-$LOAD_PATH.unshift( File.join(CEEDLING_VENDOR, 'constructor/lib') )
 $LOAD_PATH.unshift( File.join(CEEDLING_VENDOR, 'cmock/lib') )
 $LOAD_PATH.unshift( File.join(CEEDLING_VENDOR, 'deep_merge/lib') )
 
 require 'rake'
 
+#Let's make sure we remember the task descriptions in case we need them
+Rake::TaskManager.record_task_metadata = true
+
 require 'diy'
 require 'constructor'
 
@@ -58,6 +60,9 @@ verbose(false)
 
 # end block always executed following rake run
 END {
+  $stdout.flush unless $stdout.nil?
+  $stderr.flush unless $stderr.nil?
+
   # cache our input configurations to use in comparison upon next execution
   @ceedling[:cacheinator].cache_test_config( @ceedling[:setupinator].config_hash )    if (@ceedling[:task_invoker].test_invoked?)
   @ceedling[:cacheinator].cache_release_config( @ceedling[:setupinator].config_hash ) if (@ceedling[:task_invoker].release_invoked?)
@@ -73,6 +78,8 @@ END {
     # tell all our plugins the build is done and process results
     @ceedling[:plugin_manager].post_build
     @ceedling[:plugin_manager].print_plugin_failures
-    exit(1) if (@ceedling[:plugin_manager].plugins_failed? && !@ceedling[:setupinator].config_hash[:graceful_fail]) 
+    exit(1) if (@ceedling[:plugin_manager].plugins_failed? && !@ceedling[:setupinator].config_hash[:graceful_fail])
+  else
+    puts "ERROR: Ceedling Failed"
   end
 }

data/lib/ceedling/release_invoker.rb

@@ -64,7 +64,7 @@ class ReleaseInvoker
   end
 
   def sort_objects_and_libraries(both)
-    extension = "\\" + (EXTENSION_SUBPROJECTS || ".LIBRARY")
+    extension = "\\" + ((defined? EXTENSION_SUBPROJECTS) ? EXTENSION_SUBPROJECTS : ".LIBRARY")
     sorted_objects = both.group_by {|v| v.match(/.+#{extension}$/) ? :libraries : :objects }
     libraries = sorted_objects[:libraries] || []
     objects   = sorted_objects[:objects]   || []

data/lib/ceedling/reportinator.rb

@@ -1,6 +1,23 @@
-
+##
+# Pretifies reports
 class Reportinator
 
+  ##
+  # Generates a banner for a message based on the length of the message or a
+  # given width.
+  # ==== Attributes
+  #
+  # * _message_:  The message to put.
+  # * _width_:    The width of the message. If nil the size of the banner is
+  # determined by the length of the message.
+  #
+  # ==== Examples
+  #
+  #    rp = Reportinator.new
+  #    rp.generate_banner("Hello world!") => "------------\nHello world!\n------------\n" 
+  #    rp.generate_banner("Hello world!", 3) => "---\nHello world!\n---\n" 
+  #
+  #
   def generate_banner(message, width=nil)
     dash_count = ((width.nil?) ? message.strip.length : width)
     return "#{'-' * dash_count}\n#{message}\n#{'-' * dash_count}\n"

data/lib/ceedling/system_utils.rb

@@ -6,14 +6,20 @@ class Object
 end
 
 
+##
+# Class containing system utility funcions.
 class SystemUtils
 
   constructor :system_wrapper
 
+  ##
+  # Sets up the class. 
   def setup
     @tcsh_shell = nil
   end
 
+  ##
+  # Checks the system shell to see if it a tcsh shell.
   def tcsh_shell?
     # once run a single time, return state determined at that execution
     return @tcsh_shell if not @tcsh_shell.nil?
@@ -28,5 +34,4 @@ class SystemUtils
   
     return @tcsh_shell
   end
-
 end

data/lib/ceedling/system_wrapper.rb

@@ -68,7 +68,8 @@ class SystemWrapper
   end
 
   def ruby_success
-    return ($exit_code == 0) && ($!.nil? || $!.is_a?(SystemExit) && $!.success?)
+    # We are successful if we've never had an exit code that went boom (either because it's empty or it was 0)
+    return ($exit_code.nil? || ($exit_code == 0)) && ($!.nil? || $!.is_a?(SystemExit) && $!.success?)
   end
 
   def constants_include?(item)

data/lib/ceedling/target_loader.rb

@@ -13,10 +13,10 @@ module TargetLoader
 
     targets = config[:targets]
     unless targets[:targets_directory]
-      raise NoDirectory("No targets directory specified.")
+      raise NoDirectory.new("No targets directory specified.")
     end
     unless targets[:default_target]
-      raise NoDefault("No default target specified.")
+      raise NoDefault.new("No default target specified.")
     end
 
     target_path = lambda {|name| File.join(targets[:targets_directory], name + ".yml")}

data/lib/ceedling/tasks_filesystem.rake

@@ -33,14 +33,20 @@ task(:clean) do
   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
-  CLEAN.each { |fn| REMOVE_FILE_PROC.call(fn) }
+  begin
+    CLEAN.each { |fn| REMOVE_FILE_PROC.call(fn) }
+  rescue
+  end
 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")
-  CLOBBER.each { |fn| REMOVE_FILE_PROC.call(fn) }
+  begin
+    CLOBBER.each { |fn| REMOVE_FILE_PROC.call(fn) }
+  rescue
+  end
 end
 
 

data/lib/ceedling/tool_executor_helper.rb

@@ -1,25 +1,41 @@
 require 'ceedling/constants' # for Verbosity enumeration & $stderr redirect enumeration
 
+##
+# Helper functions for the tool executor
 class ToolExecutorHelper
 
   constructor :streaminator, :system_utils, :system_wrapper
 
+  ##
+  # Returns the stderr redirection based on the config and logging.
+  # ==== Attributes
+  #
+  # * _tool_config_:  A hash containing config information.
+  # * _logging_:  A boolean representing if logging is enabled or not.
+  #
   def stderr_redirection(tool_config, logging)
     # if there's no logging enabled, return :stderr_redirect unmodified
     return tool_config[:stderr_redirect] if (not logging)
-    
+
     # if there is logging enabled but the redirect is a custom value (not enum), return the custom string
     return tool_config[:stderr_redirect] if (tool_config[:stderr_redirect].class == String)
- 
+
     # if logging is enabled but there's no custom string, return the AUTO enumeration so $stderr goes into the log
     return StdErrRedirect::AUTO
   end
 
+
+  ##
+  # Returns the background execution prepend based on the config.
+  # ==== Attributes
+  #
+  # * _tool_config_:  A hash containing config information.
+  #
   def background_exec_cmdline_prepend(tool_config)
-    return nil if (tool_config[:background_exec].nil?)
-    
+    return nil if (tool_config.nil? || tool_config[:background_exec].nil?)
+
     config_exec = tool_config[:background_exec]
-    
+
     if ((config_exec == BackgroundExec::AUTO) and (@system_wrapper.windows?))
       return 'start'
     end
@@ -31,26 +47,37 @@ class ToolExecutorHelper
     return nil
   end
 
+
+  ##
+  # Modifies an executables path based on platform.
+  # ==== Attributes
+  #
+  # * _executable_:  The executable's path.
+  #
   def osify_path_separators(executable)
     return executable.gsub(/\//, '\\') if (@system_wrapper.windows?)
     return executable
   end
-  
+
+  ##
+  # Returns the stderr redirect append based on the config.
+  # ==== Attributes
+  #
+  # * _tool_config_:  A hash containing config information.
+  #
   def stderr_redirect_cmdline_append(tool_config)
-    return nil if (tool_config[:stderr_redirect].nil?)
-    
+    return nil if (tool_config.nil? || tool_config[:stderr_redirect].nil?)
+
     config_redirect = tool_config[:stderr_redirect]
     redirect        = StdErrRedirect::NONE
-    
+
     if (config_redirect == StdErrRedirect::AUTO)
        if (@system_wrapper.windows?)
          redirect = StdErrRedirect::WIN
+       elsif (@system_utils.tcsh_shell?)
+         redirect = StdErrRedirect::TCSH
        else
-         if (@system_utils.tcsh_shell?)
-           redirect = StdErrRedirect::TCSH
-         else
-           redirect = StdErrRedirect::UNIX           
-         end
+         redirect = StdErrRedirect::UNIX
        end
     end
 
@@ -64,11 +91,17 @@ class ToolExecutorHelper
     end
   end
 
+  ##
+  # Returns the background execution append based on the config.
+  # ==== Attributes
+  #
+  # * _tool_config_:  A hash containing config information.
+  #
   def background_exec_cmdline_append(tool_config)
-    return nil if (tool_config[:background_exec].nil?)
+    return nil if (tool_config.nil? || tool_config[:background_exec].nil?)
 
     config_exec = tool_config[:background_exec]
-    
+
     # if :auto & windows, then we already prepended 'start' and should append nothing
     return nil if ((config_exec == BackgroundExec::AUTO) and (@system_wrapper.windows?))
 
@@ -77,26 +110,43 @@ class ToolExecutorHelper
 
     # if explicitly Unix, then append '&'
     return '&' if (config_exec == BackgroundExec::UNIX)
-    
+
+  # * _command_str_:  A hash containing config information.
     # all other cases, including :none, :win, & anything unrecognized, append nothing
     return nil
   end
 
-  # if command succeeded and we have verbosity cranked up, spill our guts
+  ##
+  # Outputs success results if command succeeded and we have verbosity cranked up.
+  # ==== Attributes
+  #
+  # * _command_str_:  The command ran.
+  # * _shell_results_:  The outputs of the command including exit code and
+  # output.
+  # * _boom_:  A boolean representing if a non zero result is erroneous.
+  #
   def print_happy_results(command_str, shell_result, boom=true)
     if ((shell_result[:exit_code] == 0) or ((shell_result[:exit_code] != 0) and not boom))
       output  = "> Shell executed command:\n"
-      output += "#{command_str}\n"
+      output += "'#{command_str}'\n"
       output += "> Produced output:\n"             if (not shell_result[:output].empty?)
       output += "#{shell_result[:output].strip}\n" if (not shell_result[:output].empty?)
       output += "> And exited with status: [#{shell_result[:exit_code]}].\n" if (shell_result[:exit_code] != 0)
       output += "\n"
-  
+
       @streaminator.stdout_puts(output, Verbosity::OBNOXIOUS)
     end
   end
 
-  # if command failed and we have verbosity set to minimum error level, spill our guts
+  ##
+  # Outputs failures results if command failed and we have verbosity set to minimum error level.
+  # ==== Attributes
+  #
+  # * _command_str_:  The command ran.
+  # * _shell_results_:  The outputs of the command including exit code and
+  # output.
+  # * _boom_:  A boolean representing if a non zero result is erroneous.
+  #
   def print_error_results(command_str, shell_result, boom=true)
     if ((shell_result[:exit_code] != 0) and boom)
       output  = "ERROR: Shell command failed.\n"
@@ -111,5 +161,4 @@ class ToolExecutorHelper
       @streaminator.stderr_puts(output, Verbosity::ERRORS)
     end
   end
-  
 end