ceedling 0.20.3 → 0.21.0

data/plugins/gcov/README.md

@@ -0,0 +1,9 @@
+ceedling-gcov
+=============
+
+Plugin for integrating GNU GCov code coverage tool into Ceedling projects
+
+# To-Do list
+
+- Generate overall report (combined statistics from all files with coverage)
+- Generate coverage output files

data/plugins/gcov/{template.erb → assets/template.erb}

@@ -1,7 +1,7 @@
 % function_string = hash[:coverage][:functions].to_s
 % branch_string   = hash[:coverage][:branches].to_s
 % format_string   = "%#{[function_string.length, branch_string.length].max}i"
-<%=@ceedling[:plugin_reportinator].generate_banner("#{BULLSEYE_ROOT_NAME.upcase}: CODE COVERAGE SUMMARY")%>
+<%=@ceedling[:plugin_reportinator].generate_banner("#{GCOV_ROOT_NAME.upcase}: CODE COVERAGE SUMMARY")%>
 % if (!hash[:coverage][:functions].nil?)
 FUNCTIONS: <%=sprintf(format_string, hash[:coverage][:functions])%>%
 % else

data/plugins/gcov/{defaults.yml → config/defaults.yml}

@@ -30,5 +30,14 @@
       - -b
       - -o "$": GCOV_BUILD_OUTPUT_PATH
       - "\"${1}\""
-
+  :gcov_post_report:
+    :executable: gcovr
+    :optional: TRUE
+    :arguments:
+        - -p
+        - -b
+        - -e '^vendor.*|^build.*|^test.*|^lib.*'
+        - --html
+        - -r .
+        - -o GcovCoverageResults.html
 ...

data/plugins/gcov/gcov.rake

@@ -20,6 +20,7 @@ rule(/#{GCOV_BUILD_OUTPUT_PATH}\/#{'.+\\'+EXTENSION_OBJECT}$/ => [
   if (File.basename(object.source) =~ /^(#{PROJECT_TEST_FILE_PREFIX}|#{CMOCK_MOCK_PREFIX}|#{GCOV_IGNORE_SOURCES.join('|')})/i)
     @ceedling[:generator].generate_object_file(
       TOOLS_GCOV_COMPILER,
+      OPERATION_COMPILE_SYM,
       GCOV_SYM,
       object.source,
       object.name,
@@ -78,18 +79,18 @@ namespace GCOV_SYM do
     message = "\nOops! '#{GCOV_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 #{GCOV_ROOT_NAME}:foo.c\n\n"
-  
+
     @ceedling[:streaminator].stdout_puts( message )
   end
-  
+
   desc "Run tests by matching regular expression pattern."
   task :pattern, [:regex] => [:directories] do |t, args|
     matches = []
-    
+
     COLLECTION_ALL_TESTS.each do |test|
       matches << test if test =~ /#{args.regex}/
     end
-  
+
     if (matches.size > 0)
       @ceedling[:configurator].replace_flattened_config(@ceedling[GCOV_SYM].config)
       @ceedling[:test_invoker].setup_and_invoke(matches, GCOV_SYM, {:force_run => false})
@@ -102,11 +103,11 @@ namespace GCOV_SYM do
   desc "Run tests whose test path contains [dir] or [dir] substring."
   task :path, [:dir] => [:directories] do |t, args|
     matches = []
-    
+
     COLLECTION_ALL_TESTS.each do |test|
       matches << test if File.dirname(test).include?(args.dir.gsub(/\\/, '/'))
     end
-  
+
     if (matches.size > 0)
       @ceedling[:configurator].replace_flattened_config(@ceedling[GCOV_SYM].config)
       @ceedling[:test_invoker].setup_and_invoke(matches, GCOV_SYM, {:force_run => false})
@@ -122,7 +123,7 @@ namespace GCOV_SYM do
     @ceedling[:test_invoker].setup_and_invoke(COLLECTION_ALL_TESTS, GCOV_SYM, {:force_run => false})
     @ceedling[:configurator].restore_config
   end
-  
+
   # use a rule to increase efficiency for large projects
   # gcov test tasks by regex
   rule(/^#{GCOV_TASK_ROOT}\S+$/ => [
@@ -137,7 +138,7 @@ namespace GCOV_SYM do
     @ceedling[:test_invoker].setup_and_invoke([test.source], GCOV_SYM)
     @ceedling[:configurator].restore_config
   end
-  
+
 end
 
 if PROJECT_USE_DEEP_DEPENDENCIES
@@ -150,3 +151,14 @@ namespace REFRESH_SYM do
 end
 end
 
+namespace UTILS_SYM do
+  
+  desc "Create gcov code coverage html report"
+  task GCOV_SYM do
+    command = @ceedling[:tool_executor].build_command_line(TOOLS_GCOV_POST_REPORT, [])
+    puts 'Creating html report of gcov results...'
+    @ceedling[:tool_executor].exec(command[:line], command[:options])
+  end
+  
+end
+

data/plugins/gcov/{gcov.rb → lib/gcov.rb}

@@ -19,8 +19,8 @@ class Gcov < Plugin
   attr_reader :config
 
   def setup
-    @result_list = []  
-  
+    @result_list = []
+
     @config = {
       :project_test_build_output_path     => GCOV_BUILD_OUTPUT_PATH,
       :project_test_results_path          => GCOV_RESULTS_PATH,
@@ -28,14 +28,16 @@ class Gcov < Plugin
       :defines_test                       => DEFINES_TEST + ['CODE_COVERAGE'],
       :collection_defines_test_and_vendor => COLLECTION_DEFINES_TEST_AND_VENDOR + ['CODE_COVERAGE']
       }
-    
-    @coverage_template_all = @ceedling[:file_wrapper].read( File.join( PLUGINS_GCOV_PATH, 'template.erb') )
+
+    @plugin_root = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+    @coverage_template_all = @ceedling[:file_wrapper].read( File.join( @plugin_root, 'assets/template.erb') )
   end
 
   def generate_coverage_object_file(source, object)
-    compile_command = 
+    compile_command =
       @ceedling[:tool_executor].build_command_line(
         TOOLS_GCOV_COMPILER,
+        @ceedling[:flaginator].flag_down( OPERATION_COMPILE_SYM, GCOV_SYM, source),
         source,
         object,
         @ceedling[:file_path_utils].form_test_build_list_filepath( object ) )
@@ -45,12 +47,12 @@ class Gcov < Plugin
 
   def post_test_fixture_execute(arg_hash)
     result_file = arg_hash[:result_file]
-  
+
     if ((result_file =~ /#{GCOV_RESULTS_PATH}/) and (not @result_list.include?(result_file)))
       @result_list << arg_hash[:result_file]
     end
   end
-    
+
   def post_build
     return if (not @ceedling[:task_invoker].invoked?(/^#{GCOV_TASK_ROOT}/))
 
@@ -60,18 +62,14 @@ class Gcov < Plugin
       :header => GCOV_ROOT_NAME.upcase,
       :results => results
     }
-    
+
     @ceedling[:plugin_reportinator].run_test_results_report(hash) do
       message = ''
       message = 'Unit test failures.' if (results[:counts][:failed] > 0)
       message
     end
-    
-    if (@ceedling[:task_invoker].invoked?(/^#{GCOV_TASK_ROOT}(all|delta)/))
-      report_coverage_results_summary(@ceedling[:test_invoker].sources)
-    else
-      report_per_file_coverage_results(@ceedling[:test_invoker].sources)
-    end
+
+    report_per_file_coverage_results(@ceedling[:test_invoker].sources)
   end
 
   def summary
@@ -85,19 +83,10 @@ class Gcov < Plugin
     }
 
     @ceedling[:plugin_reportinator].run_test_results_report(hash)
-    
-    # coverage results
-    # command = @ceedling[:tool_executor].build_command_line(TOOLS_GCOV_REPORT_COVSRC)
-    # shell_result = @ceedling[:tool_executor].exec(command[:line], command[:options])
-    # report_coverage_results_all(shell_result[:output])
   end
 
   private ###################################
 
-  def report_coverage_results_summary(sources)
-
-  end
-
   def report_per_file_coverage_results(sources)
     banner = @ceedling[:plugin_reportinator].generate_banner "#{GCOV_ROOT_NAME.upcase}: CODE COVERAGE SUMMARY"
     @ceedling[:streaminator].stdout_puts "\n" + banner
@@ -108,7 +97,7 @@ class Gcov < Plugin
 
     coverage_sources.each do |source|
       basename         = File.basename(source)
-      command          = @ceedling[:tool_executor].build_command_line(TOOLS_GCOV_REPORT, basename)
+      command          = @ceedling[:tool_executor].build_command_line(TOOLS_GCOV_REPORT, [], [basename])
       shell_results    = @ceedling[:tool_executor].exec(command[:line], command[:options])
       coverage_results = shell_results[:output]
 

data/plugins/module_generator/module_generator.rake

@@ -3,12 +3,12 @@ namespace :module do
 
   desc "Generate module (source, header and test files)"
     task :create, :module_path do |t, args|
-    @ceedling[:module_generator].create(args[:module_path])
+    args[:module_path].split(/,/).each {|v| @ceedling[:module_generator].create(v) }
   end
 
   desc "Destroy module (source, header and test files)"
   task :destroy, :module_path do |t, args|
-    @ceedling[:module_generator].create(args[:module_path], {:destroy => true})
+    args[:module_path].split(/,/).each {|v| @ceedling[:module_generator].create(v, {:destroy => true}) }
   end
-  
+
 end

data/plugins/warnings_report/lib/warnings_report.rb

@@ -0,0 +1,69 @@
+require 'ceedling/plugin'
+require 'ceedling/constants'
+
+class WarningsReport < Plugin
+  def setup
+    @stderr_redirect = nil
+    @log_paths = {}
+  end
+
+  def pre_compile_execute(arg_hash)
+    # at beginning of compile, override tool's stderr_redirect so we can parse $stderr + $stdout
+    set_stderr_redirect(arg_hash)
+  end
+
+  def post_compile_execute(arg_hash)
+    # after compilation, grab output for parsing/logging, restore stderr_redirect, log warning if it exists
+    output = arg_hash[:shell_result][:output]
+    restore_stderr_redirect(arg_hash)
+    write_warning_log(arg_hash[:context], output)
+  end
+
+  def pre_link_execute(arg_hash)
+    # at beginning of link, override tool's stderr_redirect so we can parse $stderr + $stdout
+    set_stderr_redirect(arg_hash)
+  end
+
+  def post_link_execute(arg_hash)
+    # after linking, grab output for parsing/logging, restore stderr_redirect, log warning if it exists
+    output = arg_hash[:shell_result][:output]
+    restore_stderr_redirect(arg_hash)
+    write_warning_log(arg_hash[:context], output)
+  end
+
+  private
+
+  def set_stderr_redirect(hash)
+    @stderr_redirect = hash[:tool][:stderr_redirect]
+    hash[:tool][:stderr_redirect] = StdErrRedirect::AUTO
+  end
+
+  def restore_stderr_redirect(hash)
+    hash[:tool][:stderr_redirect] = @stderr_redirect
+  end
+
+  def write_warning_log(context, output)
+    # if $stderr/$stdout contain "warning", log it
+    if output =~ /warning/i
+      # generate a log path & file io write flags
+      logging = generate_log_path(context)
+      @ceedling[:file_wrapper].write(logging[:path], output + "\n", logging[:flags]) unless logging.nil?
+    end
+  end
+
+  def generate_log_path(context)
+    # if path has already been generated, return it & 'append' file io flags (append to log)
+    return { path: @log_paths[context], flags: 'a' } unless @log_paths[context].nil?
+
+    # first time through, generate path & 'write' file io flags (create new log)
+    base_path = File.join(PROJECT_BUILD_ARTIFACTS_ROOT, context.to_s)
+    file_path = File.join(base_path, 'warnings.log')
+
+    if @ceedling[:file_wrapper].exist?(base_path)
+      @log_paths[context] = file_path
+      return { path: file_path, flags: 'w' }
+    end
+
+    nil
+  end
+end

data/plugins/xml_tests_report/lib/xml_tests_report.rb

@@ -0,0 +1,108 @@
+require 'ceedling/plugin'
+require 'ceedling/constants'
+
+class XmlTestsReport < Plugin
+  def setup
+    @results_list = {}
+    @test_counter = 0
+  end
+
+  def post_test_fixture_execute(arg_hash)
+    context = arg_hash[:context]
+
+    @results_list[context] = [] if @results_list[context].nil?
+
+    @results_list[context] << arg_hash[:result_file]
+  end
+
+  def post_build
+    @results_list.each_key do |context|
+      results = @ceedling[:plugin_reportinator].assemble_test_results(@results_list[context])
+
+      file_path = File.join(PROJECT_BUILD_ARTIFACTS_ROOT, context.to_s, 'report.xml')
+
+      @ceedling[:file_wrapper].open(file_path, 'w') do |f|
+        @test_counter = 1
+        write_results(results, f)
+      end
+    end
+  end
+
+  private
+
+  def write_results(results, stream)
+    write_header(stream)
+    write_failures(results[:failures], stream)
+    write_tests(results[:successes], stream, 'SuccessfulTests')
+    write_tests(results[:ignores], stream, 'IgnoredTests')
+    write_statistics(results[:counts], stream)
+    write_footer(stream)
+  end
+
+  def write_header(stream)
+    stream.puts "<?xml version='1.0' encoding='utf-8' ?>"
+    stream.puts '<TestRun>'
+  end
+
+  def write_failures(results, stream)
+    if results.size.zero?
+      stream.puts "\t<FailedTests/>"
+      return
+    end
+
+    stream.puts "\t<FailedTests>"
+
+    results.each do |result|
+      result[:collection].each do |item|
+        filename = File.join(result[:source][:path], result[:source][:file])
+
+        stream.puts "\t\t<Test id=\"#{@test_counter}\">"
+        stream.puts "\t\t\t<Name>#{filename}::#{item[:test]}</Name>"
+        stream.puts "\t\t\t<FailureType>Assertion</FailureType>"
+        stream.puts "\t\t\t<Location>"
+        stream.puts "\t\t\t\t<File>#{filename}</File>"
+        stream.puts "\t\t\t\t<Line>#{item[:line]}</Line>"
+        stream.puts "\t\t\t</Location>"
+        stream.puts "\t\t\t<Message>#{item[:message]}</Message>"
+        stream.puts "\t\t</Test>"
+        @test_counter += 1
+      end
+    end
+
+    stream.puts "\t</FailedTests>"
+  end
+
+  def write_tests(results, stream, tag)
+    if results.size.zero?
+      stream.puts "\t<#{tag}/>"
+      return
+    end
+
+    stream.puts "\t<#{tag}>"
+
+    results.each do |result|
+      result[:collection].each do |item|
+        stream.puts "\t\t<Test id=\"#{@test_counter}\">"
+        stream.puts "\t\t\t<Name>#{File.join(result[:source][:path], result[:source][:file])}::#{item[:test]}</Name>"
+        stream.puts "\t\t</Test>"
+        @test_counter += 1
+      end
+    end
+
+    stream.puts "\t</#{tag}>"
+  end
+
+  def write_statistics(counts, stream)
+    stream.puts "\t<Statistics>"
+    stream.puts "\t\t<Tests>#{counts[:total]}</Tests>"
+    stream.puts "\t\t<Ignores>#{counts[:ignored]}</Ignores>"
+    stream.puts "\t\t<FailuresTotal>#{counts[:failed]}</FailuresTotal>"
+    stream.puts "\t\t<Errors>0</Errors>"
+    stream.puts "\t\t<Failures>#{counts[:failed]}</Failures>"
+    stream.puts "\t</Statistics>"
+  end
+
+  def write_footer(stream)
+    stream.puts '</TestRun>'
+  end
+end

data/spec/spec_system_helper.rb

@@ -151,7 +151,7 @@ module CeedlingTestCases
   def contains_documentation
     @c.with_context do
       Dir.chdir @proj_name do
-        expect(Dir["vendor/ceedling/docs/*.pdf"].length).to eq 4
+        expect(Dir["vendor/ceedling/docs/*.pdf"].length).to be >= 4
       end
     end
   end

data/vendor/c_exception/lib/CException.h

@@ -72,7 +72,7 @@ extern volatile CEXCEPTION_FRAME_T CExceptionFrames[];
     {                                                               \
         jmp_buf *PrevFrame, NewFrame;                               \
         unsigned int MY_ID = CEXCEPTION_GET_ID;                     \
-        PrevFrame = CExceptionFrames[CEXCEPTION_GET_ID].pFrame;     \
+        PrevFrame = CExceptionFrames[MY_ID].pFrame;                 \
         CExceptionFrames[MY_ID].pFrame = (jmp_buf*)(&NewFrame);     \
         CExceptionFrames[MY_ID].Exception = CEXCEPTION_NONE;        \
         CEXCEPTION_HOOK_START_TRY;                                  \

data/vendor/c_exception/vendor/unity/auto/generate_module.rb

@@ -2,7 +2,7 @@
 #   Unity Project - A Test Framework for C
 #   Copyright (c) 2007 Mike Karlesky, Mark VanderVoord, Greg Williams
 #   [Released under MIT License. Please refer to license.txt for details]
-# ========================================== 
+# ==========================================
 
 # This script creates all the files with start code necessary for a new module.
 # A simple module only requires a source file, header file, and test file.
@@ -32,20 +32,20 @@ HELP_TEXT = [ "\nGENERATE MODULE\n-------- ------",
 
 #Built in patterns
 PATTERNS = { 'src' => {''         => { :inc => [] } },
-             'dh'  => {'Driver'   => { :inc => ['%1$sHardware.h'] }, 
-                       'Hardware' => { :inc => [] } 
+             'dh'  => {'Driver'   => { :inc => ['%1$sHardware.h'] },
+                       'Hardware' => { :inc => [] }
                       },
-             'dih' => {'Driver'   => { :inc => ['%1$sHardware.h', '%1$sInterrupt.h'] }, 
+             'dih' => {'Driver'   => { :inc => ['%1$sHardware.h', '%1$sInterrupt.h'] },
                        'Interrupt'=> { :inc => ['%1$sHardware.h'] },
-                       'Hardware' => { :inc => [] } 
+                       'Hardware' => { :inc => [] }
                       },
-             'mch' => {'Model'    => { :inc => [] }, 
+             'mch' => {'Model'    => { :inc => [] },
                        'Conductor'=> { :inc => ['%1$sModel.h', '%1$sHardware.h'] },
-                       'Hardware' => { :inc => [] } 
+                       'Hardware' => { :inc => [] }
                       },
-             'mvp' => {'Model'    => { :inc => [] }, 
+             'mvp' => {'Model'    => { :inc => [] },
                        'Presenter'=> { :inc => ['%1$sModel.h', '%1$sView.h'] },
-                       'View'     => { :inc => [] } 
+                       'View'     => { :inc => [] }
                       }
            }
 
@@ -63,7 +63,7 @@ void tearDown(void)
 
 void test_%1$s_NeedToImplement(void)
 {
-    TEST_IGNORE();
+    TEST_IGNORE_MESSAGE("Need to Implement %1$s");
 }
 ]
 
@@ -91,7 +91,7 @@ ARGV.each do |arg|
     when /^(\w+)/
       raise "ERROR: You can't have more than one Module name specified!" unless @module_name.nil?
       @module_name = arg
-    when /^-(h|-help)/ 
+    when /^-(h|-help)/
       puts HELP_TEXT
       exit
     else
@@ -126,7 +126,7 @@ end
 @includes.merge!(@extra_inc) unless @extra_inc.nil?
 
 #create triad definition
-TRIAD = [ { :ext => '.c', :path => @path_src,        :template => TEMPLATE_SRC, :inc => :src, :boilerplate => @boilerplates[:src] }, 
+TRIAD = [ { :ext => '.c', :path => @path_src,        :template => TEMPLATE_SRC, :inc => :src, :boilerplate => @boilerplates[:src] },
           { :ext => '.h', :path => @path_inc,        :template => TEMPLATE_INC, :inc => :inc, :boilerplate => @boilerplates[:inc] },
           { :ext => '.c', :path => @path_tst+'Test', :template => TEMPLATE_TST, :inc => :tst, :boilerplate => @boilerplates[:tst] },
         ]
@@ -159,7 +159,7 @@ if @destroy
     file = filespec[:path]
     if File.exist?(file)
       if @update_svn
-        `svn delete \"#{file}\" --force` 
+        `svn delete \"#{file}\" --force`
         puts "File #{file} deleted and removed from source control"
       else
         FileUtils.remove(file)
@@ -182,13 +182,13 @@ end
 files.each_with_index do |file, i|
   File.open(file[:path], 'w') do |f|
     f.write(file[:boilerplate] % [file[:name]]) unless file[:boilerplate].nil?
-    f.write(file[:template] % [ file[:name], 
-                                file[:includes].map{|f| "#include \"#{f}\"\n"}.join, 
+    f.write(file[:template] % [ file[:name],
+                                file[:includes].map{|f| "#include \"#{f}\"\n"}.join,
                                 file[:name].upcase ]
            )
   end
   if (@update_svn)
-    `svn add \"#{file[:path]}\"` 
+    `svn add \"#{file[:path]}\"`
     if $?.exitstatus == 0
       puts "File #{file[:path]} created and added to source control"
     else