ceedling 0.28.2 → 0.28.3

data/lib/ceedling/version.rb

@@ -2,7 +2,7 @@
 module Ceedling
   module Version
     # @private
-    GEM = "0.28.2"
+    GEM = "0.28.3"
     # @private
     CEEDLING = GEM
     # @private

data/out.fail

@@ -0,0 +1,21 @@
+---
+:source:
+  :path: some/place
+  :file: test_example.c
+:successes: []
+:failures:
+- :test: test_one
+  :line: 257
+  :message: ''
+- :test: test_two
+  :line: 269
+  :message: ''
+:ignores: []
+:counts:
+  :total: 2
+  :passed: 0
+  :failed: 2
+  :ignored: 0
+:stdout:
+- Verbose output one
+- Verbous output two

data/plugins/beep/README.md

@@ -0,0 +1,22 @@
+ceedling-beep
+=============
+
+This is a simple plugin that just beeps at the end of a build and/or test sequence. Are you getting too distracted surfing
+the internet, chatting with coworkers, or swordfighting while it's building or testing? The friendly beep will let you know
+it's time to pay attention again.
+
+This plugin has very few configuration options. At this time it can beep on completion of a task and/or on an error condition.
+For each of these, you can configure the method that it should beep.
+
+```
+:tools:
+  :beep_on_done: :bell
+  :beep_on_error: :bell
+```
+
+Each of these have the following options:
+
+  - :bell - this option uses the ASCII bell character out stdout
+  - :speaker_test - this uses the linux speaker-test command if installed
+
+Very likely, we'll be adding to this list if people find this to be useful.

data/plugins/beep/lib/beep.rb

@@ -0,0 +1,40 @@
+require 'ceedling/plugin'
+require 'ceedling/constants'
+
+class Beep < Plugin
+
+  attr_reader :config
+
+  def setup
+    @config = {
+      :on_done  => ((defined? TOOLS_BEEP_ON_DONE)  ? TOOLS_BEEP_ON_DONE  : :bell  ),
+      :on_error => ((defined? TOOLS_BEEP_ON_ERROR) ? TOOLS_BEEP_ON_ERROR : :bell  ),
+    }
+  end
+
+  def post_build
+    beep @config[:on_done]
+  end
+
+  def post_error
+    beep @config[:on_error]
+  end
+
+  private
+
+  def beep(method = :none)
+    case method
+    when :bell
+      if (SystemWrapper.windows?)
+        puts "echo '\007'"
+      else
+        puts "echo -ne '\007'"
+      end
+    when :speaker_test
+      `speaker-test -t sine -f 1000 -l 1`
+    else
+      #do nothing with illegal or :none
+    end
+  end
+end
+

data/plugins/bullseye/bullseye.rake

@@ -1,4 +1,3 @@
-
 directory(BULLSEYE_BUILD_OUTPUT_PATH)
 directory(BULLSEYE_RESULTS_PATH)
 directory(BULLSEYE_ARTIFACTS_PATH)
@@ -9,21 +8,23 @@ CLEAN.include(File.join(BULLSEYE_RESULTS_PATH, '*'))
 CLEAN.include(File.join(BULLSEYE_DEPENDENCIES_PATH, '*'))
 
 CLOBBER.include(File.join(BULLSEYE_BUILD_PATH, '**/*'))
-
+PLUGINS_BULLSEYE_LIB_PATH = 'C:\\tools\\BullseyeCoverage\\lib' if not defined?(PLUGINS_BULLSEYE_LIB_PATH)
 
 rule(/#{BULLSEYE_BUILD_OUTPUT_PATH}\/#{'.+\\'+EXTENSION_OBJECT}$/ => [
-    proc do |task_name|
-      @ceedling[:file_finder].find_compilation_input_file(task_name)
-    end
-  ]) do |object|
+       proc do |task_name|
+         @ceedling[:file_finder].find_compilation_input_file(task_name)
+       end
+     ]) do |object|
 
-  if (File.basename(object.source) =~ /^(#{PROJECT_TEST_FILE_PREFIX}|#{CMOCK_MOCK_PREFIX}|#{BULLSEYE_IGNORE_SOURCES.join('|')})/i)
+  if File.basename(object.source) =~ /^(#{PROJECT_TEST_FILE_PREFIX}|#{CMOCK_MOCK_PREFIX}|#{BULLSEYE_IGNORE_SOURCES.join('|')})/i
     @ceedling[:generator].generate_object_file(
       TOOLS_BULLSEYE_COMPILER,
+      OPERATION_COMPILE_SYM,
       BULLSEYE_SYM,
       object.source,
       object.name,
-      @ceedling[:file_path_utils].form_test_build_list_filepath( object.name ) )
+      @ceedling[:file_path_utils].form_test_build_list_filepath(object.name)
+    )
   else
     @ceedling[BULLSEYE_SYM].generate_coverage_object_file(object.source, object.name)
   end
@@ -36,39 +37,41 @@ rule(/#{BULLSEYE_BUILD_OUTPUT_PATH}\/#{'.+\\'+EXTENSION_EXECUTABLE}$/) do |bin_f
     BULLSEYE_SYM,
     bin_file.prerequisites,
     bin_file.name,
-    @ceedling[:file_path_utils].form_test_build_map_filepath(bin_file.name))
+    @ceedling[:file_path_utils].form_test_build_map_filepath(bin_file.name)
+  )
 end
 
 rule(/#{BULLSEYE_RESULTS_PATH}\/#{'.+\\'+EXTENSION_TESTPASS}$/ => [
-     proc do |task_name|
-       @ceedling[:file_path_utils].form_test_executable_filepath(task_name)
-     end
-  ]) do |test_result|
+       proc do |task_name|
+         @ceedling[:file_path_utils].form_test_executable_filepath(task_name)
+       end
+     ]) do |test_result|
   @ceedling[:generator].generate_test_results(TOOLS_BULLSEYE_FIXTURE, BULLSEYE_SYM, test_result.source, test_result.name)
 end
 
 rule(/#{BULLSEYE_DEPENDENCIES_PATH}\/#{'.+\\'+EXTENSION_DEPENDENCIES}$/ => [
-    proc do |task_name|
-      @ceedling[:file_finder].find_compilation_input_file(task_name)
-    end
-  ]) do |dep|
+       proc do |task_name|
+         @ceedling[:file_finder].find_compilation_input_file(task_name)
+       end
+     ]) do |dep|
   @ceedling[:generator].generate_dependencies_file(
     TOOLS_TEST_DEPENDENCIES_GENERATOR,
     BULLSEYE_SYM,
     dep.source,
     File.join(BULLSEYE_BUILD_OUTPUT_PATH, File.basename(dep.source).ext(EXTENSION_OBJECT) ),
-    dep.name)
+    dep.name
+  )
 end
 
 task :directories => [BULLSEYE_BUILD_OUTPUT_PATH, BULLSEYE_RESULTS_PATH, BULLSEYE_DEPENDENCIES_PATH, BULLSEYE_ARTIFACTS_PATH]
 
 namespace BULLSEYE_SYM do
+  task source_coverage: COLLECTION_ALL_SOURCE.pathmap("#{BULLSEYE_BUILD_OUTPUT_PATH}/%n#{@ceedling[:configurator].extension_object}")
 
-  task :source_coverage => COLLECTION_ALL_SOURCE.pathmap("#{BULLSEYE_BUILD_OUTPUT_PATH}/%n#{@ceedling[:configurator].extension_object}")
-
-  desc "Run code coverage for all tests"
-  task :all => [:directories] do
+  desc 'Run code coverage for all tests'
+  task all: [:directories] do
     @ceedling[:configurator].replace_flattened_config(@ceedling[BULLSEYE_SYM].config)
+    @ceedling[BULLSEYE_SYM].enableBullseye(true)
     @ceedling[:test_invoker].setup_and_invoke(COLLECTION_ALL_TESTS, BULLSEYE_SYM)
     @ceedling[:configurator].restore_config
   end
@@ -82,43 +85,46 @@ namespace BULLSEYE_SYM do
     @ceedling[:streaminator].stdout_puts( message )
   end
   
-  desc "Run tests by matching regular expression pattern."
-  task :pattern, [:regex] => [:directories] do |t, args|
+  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)
+    if !matches.empty?
       @ceedling[:configurator].replace_flattened_config(@ceedling[BULLSEYE_SYM].config)
-      @ceedling[:test_invoker].setup_and_invoke(matches, BULLSEYE_SYM, {:force_run => false})
+      @ceedling[BULLSEYE_SYM].enableBullseye(true)
+      @ceedling[:test_invoker].setup_and_invoke(matches, BULLSEYE_SYM, force_run: false)
       @ceedling[:configurator].restore_config
     else
       @ceedling[:streaminator].stdout_puts("\nFound no tests matching pattern /#{args.regex}/.")
     end
   end
 
-  desc "Run tests whose test path contains [dir] or [dir] substring."
-  task :path, [:dir] => [:directories] do |t, args|
+  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(/\\/, '/'))
+      matches << test if File.dirname(test).include?(args.dir.tr('\\', '/'))
     end
   
-    if (matches.size > 0)
+    if !matches.empty?
       @ceedling[:configurator].replace_flattened_config(@ceedling[BULLSEYE_SYM].config)
-      @ceedling[:test_invoker].setup_and_invoke(matches, BULLSEYE_SYM, {:force_run => false})
+      @ceedling[BULLSEYE_SYM].enableBullseye(true)
+      @ceedling[:test_invoker].setup_and_invoke(matches, BULLSEYE_SYM, force_run: false)
       @ceedling[:configurator].restore_config
     else
       @ceedling[:streaminator].stdout_puts("\nFound no tests including the given path or path component.")
     end
   end
 
-  desc "Run code coverage for changed files"
-  task :delta => [:directories] do
+  desc 'Run code coverage for changed files'
+  task delta: [:directories] do
     @ceedling[:configurator].replace_flattened_config(@ceedling[BULLSEYE_SYM].config)
+    @ceedling[BULLSEYE_SYM].enableBullseye(true)
     @ceedling[:test_invoker].setup_and_invoke(COLLECTION_ALL_TESTS, BULLSEYE_SYM, {:force_run => false})
     @ceedling[:configurator].restore_config
   end
@@ -128,12 +134,13 @@ namespace BULLSEYE_SYM do
   rule(/^#{BULLSEYE_TASK_ROOT}\S+$/ => [
       proc do |task_name|
         test = task_name.sub(/#{BULLSEYE_TASK_ROOT}/, '')
-        test = "#{PROJECT_TEST_FILE_PREFIX}#{test}" if not (test.start_with?(PROJECT_TEST_FILE_PREFIX))
+        test = "#{PROJECT_TEST_FILE_PREFIX}#{test}" unless test.start_with?(PROJECT_TEST_FILE_PREFIX)
         @ceedling[:file_finder].find_test_from_file_path(test)
       end
   ]) do |test|
     @ceedling[:rake_wrapper][:directories].invoke
     @ceedling[:configurator].replace_flattened_config(@ceedling[BULLSEYE_SYM].config)
+    @ceedling[BULLSEYE_SYM].enableBullseye(true)
     @ceedling[:test_invoker].setup_and_invoke([test.source], BULLSEYE_SYM)
     @ceedling[:configurator].restore_config
   end
@@ -144,6 +151,7 @@ if PROJECT_USE_DEEP_DEPENDENCIES
 namespace REFRESH_SYM do
   task BULLSEYE_SYM do
     @ceedling[:configurator].replace_flattened_config(@ceedling[BULLSEYE_SYM].config)
+    @ceedling[BULLSEYE_SYM].enableBullseye(true)
     @ceedling[:test_invoker].refresh_deep_dependencies
     @ceedling[:configurator].restore_config
   end
@@ -154,9 +162,8 @@ namespace UTILS_SYM do
   
   desc "Open Bullseye code coverage browser"
   task BULLSEYE_SYM do
-    command = @ceedling[:tool_executor].build_command_line(TOOLS_BULLSEYE_BROWSER)
+    command = @ceedling[:tool_executor].build_command_line(TOOLS_BULLSEYE_BROWSER, [])
     @ceedling[:tool_executor].exec(command[:line], command[:options])
   end
   
 end
-

data/plugins/bullseye/config/defaults.yml

@@ -1,5 +1,9 @@
 ---
 
+:bullseye:
+  :auto_license: TRUE
+:plugins:
+  :bullseye_lib_path: []
 :paths:
   :bullseye_toolchain_include: []
 

data/plugins/bullseye/lib/bullseye.rb

@@ -41,10 +41,11 @@ class Bullseye < Plugin
     compile_command  = 
       @ceedling[:tool_executor].build_command_line(
         TOOLS_BULLSEYE_COMPILER,
+        @ceedling[:flaginator].flag_down( OPERATION_COMPILE_SYM, BULLSEYE_SYM, source ),
         source,
         object,
         @ceedling[:file_path_utils].form_test_build_list_filepath( object ) )
-    coverage_command = @ceedling[:tool_executor].build_command_line(TOOLS_BULLSEYE_INSTRUMENTATION, compile_command[:line] )
+    coverage_command = @ceedling[:tool_executor].build_command_line(TOOLS_BULLSEYE_INSTRUMENTATION, [], compile_command[:line] )
 
     shell_result     = @ceedling[:tool_executor].exec( coverage_command[:line], coverage_command[:options] )
     
@@ -59,7 +60,7 @@ class Bullseye < Plugin
       @result_list << arg_hash[:result_file]
     end
   end
-    
+
   def post_build
     return if (not @ceedling[:task_invoker].invoked?(/^#{BULLSEYE_TASK_ROOT}/))
 
@@ -79,7 +80,7 @@ class Bullseye < Plugin
     # coverage results
     return if (verify_coverage_file() == false)
     if (@ceedling[:task_invoker].invoked?(/^#{BULLSEYE_TASK_ROOT}(all|delta)/))
-      command      = @ceedling[:tool_executor].build_command_line(TOOLS_BULLSEYE_REPORT_COVSRC)
+      command      = @ceedling[:tool_executor].build_command_line(TOOLS_BULLSEYE_REPORT_COVSRC, [])
       shell_result = @ceedling[:tool_executor].exec(command[:line], command[:options])
       report_coverage_results_all(shell_result[:output])
     else
@@ -105,7 +106,25 @@ class Bullseye < Plugin
     shell_result = @ceedling[:tool_executor].exec(command[:line], command[:options])
     report_coverage_results_all(shell_result[:output])
   end
+  
+  def enableBullseye(enable)
+    if BULLSEYE_AUTO_LICENSE
+      if (enable)
+        args = ['push', 'on']
+        @ceedling[:streaminator].stdout_puts("Enabling Bullseye")
+      else
+        args = ['pop']
+        @ceedling[:streaminator].stdout_puts("Reverting Bullseye to previous state")
+      end
 
+      args.each do |arg| 
+        command = @ceedling[:tool_executor].build_command_line(TOOLS_BULLSEYE_BUILD_ENABLE_DISABLE, [], arg)
+        shell_result = @ceedling[:tool_executor].exec(command[:line], command[:options])
+      end
+
+    end
+  end
+  
   private ###################################
 
   def report_coverage_results_all(coverage)
@@ -137,7 +156,7 @@ class Bullseye < Plugin
     coverage_sources.delete_if {|item| item =~ /#{BULLSEYE_IGNORE_SOURCES.join('|')}#{EXTENSION_SOURCE}$/}
 
     coverage_sources.each do |source|
-      command          = @ceedling[:tool_executor].build_command_line(TOOLS_BULLSEYE_REPORT_COVFN, source)
+      command          = @ceedling[:tool_executor].build_command_line(TOOLS_BULLSEYE_REPORT_COVFN, [], source)
       shell_results    = @ceedling[:tool_executor].exec(command[:line], command[:options])
       coverage_results = shell_results[:output].deep_clone
       coverage_results.sub!(/.*\n.*\n/,'') # Remove the Bullseye tool banner
@@ -168,5 +187,8 @@ end
 # end blocks always executed following rake run
 END {
   # cache our input configurations to use in comparison upon next execution
-  @ceedling[:cacheinator].cache_test_config( @ceedling[:setupinator].config_hash ) if (@ceedling[:task_invoker].invoked?(/^#{BULLSEYE_TASK_ROOT}/))
+  if (@ceedling[:task_invoker].invoked?(/^#{BULLSEYE_TASK_ROOT}/))
+    @ceedling[:cacheinator].cache_test_config( @ceedling[:setupinator].config_hash ) 
+    @ceedling[BULLSEYE_SYM].enableBullseye(false)
+  end
 }

data/plugins/command_hooks/lib/command_hooks.rb

@@ -23,6 +23,8 @@ class CommandHooks < Plugin
       :post_release              => ((defined? TOOLS_POST_RELEASE)              ? TOOLS_POST_RELEASE              : nil ),
       :pre_build                 => ((defined? TOOLS_PRE_BUILD)                 ? TOOLS_PRE_BUILD                 : nil ),
       :post_build                => ((defined? TOOLS_POST_BUILD)                ? TOOLS_POST_BUILD                : nil ),
+      :post_build                => ((defined? TOOLS_POST_BUILD)                ? TOOLS_POST_BUILD                : nil ),
+      :post_error                => ((defined? TOOLS_POST_ERROR)                ? TOOLS_POST_ERROR                : nil ),
     }
     @plugin_root = File.expand_path(File.join(File.dirname(__FILE__), '..'))
   end
@@ -43,6 +45,7 @@ class CommandHooks < Plugin
   def post_release;                        run_hook(:post_release                                      ); end
   def pre_build;                           run_hook(:pre_build                                         ); end
   def post_build;                          run_hook(:post_build                                        ); end
+  def post_error;                          run_hook(:post_error                                        ); end
 
   private
 

data/plugins/gcov/README.md

@@ -1,9 +1,42 @@
 ceedling-gcov
 =============
 
-Plugin for integrating GNU GCov code coverage tool into Ceedling projects
+Plugin for integrating GNU GCov code coverage tool into Ceedling projects.
+Currently only designed for the gcov command (like LCOV for example). In the
+future we could configure this to work with other code coverage tools.
+
+
+This plugin currently uses `gcovr` to generate HTML reports as a utility. The
+normal gcov plugin _must_ be run first for this report to generate.
+
+Gcovr can be installed via pip like so:
+
+```
+pip install gcovr
+```
+
+There are two types of gcovr HTML reports that can be configured in your
+`project.yml`. To create a basic HTML report with only the overall file
+information use the following config. 
+
+```
+:gcov:
+  :html_report_type: basic
+```
+To create a detailed HTML report with line by line breakdown of the coverage use
+the following config.
+
+```
+:gcov:
+  :html_report_type: detailed
+```
+
+These reports will be found in `build/artifacts/gcov`.
+
+
 
 # To-Do list
 
 - Generate overall report (combined statistics from all files with coverage)
 - Generate coverage output files
+- Easier option override for better customisation 

data/plugins/gcov/config/defaults.yml

@@ -36,7 +36,7 @@
     :arguments:
         - -p
         - -b
-        - -e "'^vendor.*|^build.*|^test.*|^lib.*'"
+        - -e "${1}"
         - --html
         - -r .
         - -o GcovCoverageResults.html
@@ -46,7 +46,7 @@
     :arguments:
         - -p
         - -b
-        - -e "'^vendor.*|^build.*|^test.*|^lib.*'"
+        - -e "${1}"
         - --html
         - -r .
         - -o  "$": GCOV_ARTIFACTS_FILE
@@ -56,7 +56,7 @@
     :arguments:
         - -p
         - -b
-        - -e "'^vendor.*|^build.*|^test.*|^lib.*'"
+        - -e "${1}"
         - --html
         - --html-details
         - -r .